@sapiom/agent - npm Package Compare versions

Comparing version 0.6.7 to 0.7.0

CHANGELOG.md

 # @sapiom/orchestration
 
+## 0.7.0
+
+### Minor Changes
+
+- 3f96e37: Add optional authoring fields to the workflow SDK, surfaced by the harness canvas:
+
+  - `defineStep` gains `description` (a one-line summary of what the step does) and `capabilities` (the Sapiom capability ids the step declares it calls).
+  - `defineAgent` gains `description` (a one-line summary of the whole workflow).
+
+  All three are optional and flow through `buildManifest` into `AgentStepManifest` / `AgentManifest` as optional fields, so manifests emitted before this release keep validating unchanged. No runtime behavior change — the fields are read only by tooling (the canvas step inspector and workflow overview).
+
+### Patch Changes
+
+- Updated dependencies [5f875de]
+  - @sapiom/tools@0.22.1
+
 ## 0.6.7
@@ -4,0 +20,0 @@

dist/cjs/agent.d.ts

@@ -5,2 +5,3 @@ import type { StepDefinition } from './step.js';
     readonly name: string;
+    readonly description?: string;
     readonly entry: string;
@@ -7,0 +8,0 @@ readonly steps: Readonly<Record<string, StepDefinition<TShared>>>;

dist/cjs/build-manifest.js

@@ -20,2 +20,4 @@ "use strict";
             transitions: transitionsFor(step),
+            description: step.description ?? null,
+            capabilities: step.capabilities ?? [],
         };
@@ -26,2 +28,3 @@ }
         name: def.name,
+        description: def.description ?? null,
         entry: def.entry,
@@ -28,0 +31,0 @@ sdkVersion: opts.sdkVersion,

dist/cjs/manifest.d.ts

@@ -19,2 +19,4 @@ import { z } from 'zod/v4';
     readonly transitions: readonly ManifestTransition[];
+    readonly description?: string | null;
+    readonly capabilities?: readonly string[];
 }
@@ -24,2 +26,3 @@ export interface AgentManifest {
     readonly name: string;
+    readonly description?: string | null;
     readonly entry: string;
@@ -26,0 +29,0 @@ readonly sdkVersion: string;

dist/cjs/step.d.ts

@@ -26,2 +26,4 @@ import type { ZodType } from 'zod/v4';
     readonly timeoutMs?: number;
+    readonly description?: string;
+    readonly capabilities?: readonly string[];
     run(input: unknown, ctx: AgentExecutionContext<TShared>): Promise<NextStepDirective>;
@@ -40,2 +42,4 @@ }
     timeoutMs?: number;
+    description?: string;
+    capabilities?: readonly string[];
     run: (input: TIn, ctx: AgentExecutionContext<TShared>) => Promise<Allowed<Next, Term, CanFail, PauseDecl extends {
@@ -42,0 +46,0 @@ resumeStep: infer R extends string;

dist/cjs/step.js

@@ -13,4 +13,6 @@ "use strict";
         ...(def.timeoutMs !== undefined ? { timeoutMs: def.timeoutMs } : {}),
+        ...(def.description !== undefined ? { description: def.description } : {}),
+        ...(def.capabilities !== undefined ? { capabilities: def.capabilities } : {}),
         run: def.run,
     };
 }

dist/esm/agent.d.ts

@@ -5,2 +5,3 @@ import type { StepDefinition } from './step.js';
     readonly name: string;
+    readonly description?: string;
     readonly entry: string;
@@ -7,0 +8,0 @@ readonly steps: Readonly<Record<string, StepDefinition<TShared>>>;

dist/esm/build-manifest.js

@@ -15,2 +15,4 @@ import { zodToJsonSchema } from "./introspection.js";
             transitions: transitionsFor(step),
+            description: step.description ?? null,
+            capabilities: step.capabilities ?? [],
         };
@@ -21,2 +23,3 @@ }
         name: def.name,
+        description: def.description ?? null,
         entry: def.entry,
@@ -23,0 +26,0 @@ sdkVersion: opts.sdkVersion,

dist/esm/manifest.d.ts

@@ -19,2 +19,4 @@ import { z } from 'zod/v4';
     readonly transitions: readonly ManifestTransition[];
+    readonly description?: string | null;
+    readonly capabilities?: readonly string[];
 }
@@ -24,2 +26,3 @@ export interface AgentManifest {
     readonly name: string;
+    readonly description?: string | null;
     readonly entry: string;
@@ -26,0 +29,0 @@ readonly sdkVersion: string;

dist/esm/package.json

@@ -1,1 +0,1 @@
-{"type": "module"}
+{"type":"module"}

dist/esm/step.d.ts

@@ -26,2 +26,4 @@ import type { ZodType } from 'zod/v4';
     readonly timeoutMs?: number;
+    readonly description?: string;
+    readonly capabilities?: readonly string[];
     run(input: unknown, ctx: AgentExecutionContext<TShared>): Promise<NextStepDirective>;
@@ -40,2 +42,4 @@ }
     timeoutMs?: number;
+    description?: string;
+    capabilities?: readonly string[];
     run: (input: TIn, ctx: AgentExecutionContext<TShared>) => Promise<Allowed<Next, Term, CanFail, PauseDecl extends {
@@ -42,0 +46,0 @@ resumeStep: infer R extends string;

dist/esm/step.js

@@ -10,4 +10,6 @@ export function defineStep(def) {
         ...(def.timeoutMs !== undefined ? { timeoutMs: def.timeoutMs } : {}),
+        ...(def.description !== undefined ? { description: def.description } : {}),
+        ...(def.capabilities !== undefined ? { capabilities: def.capabilities } : {}),
         run: def.run,
     };
 }

package.json

 {
   "name": "@sapiom/agent",
-  "version": "0.6.7",
+  "version": "0.7.0",
   "description": "Versioned public contract for authoring Sapiom agents: types, directive constructors/guards, defineAgent, defineStep, InMemoryContextStore. Shared by customer agent definitions, the sandbox step-runner, and the engine.",
@@ -37,3 +37,3 @@ "license": "MIT",
   "dependencies": {
-    "@sapiom/tools": "^0.22.0"
+    "@sapiom/tools": "^0.22.1"
   },
@@ -65,3 +65,3 @@ "peerDependencies": {
     "build:esm": "tsc --project tsconfig.esm.json",
-    "build:esm-pkg": "echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build:esm-pkg": "node -e \"require('fs').writeFileSync('dist/esm/package.json',JSON.stringify({type:'module'}))\"",
     "clean": "rm -rf dist *.tsbuildinfo",
@@ -68,0 +68,0 @@ "dev": "tsc --watch --project tsconfig.cjs.json",

No alert changes

Improved metrics

Total package byte prevSize

189557

1.29%

Lines of code

1587

1.67%

Dependency changes

• Updated

  @sapiom/tools@^0.22.1