@noetic-tools/types 2.1.1 → 2.3.0

package/dist/deprecated.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Deprecated aliases from the "memory layer" era of the framework.
+ *
+ * The layer system assembles the model's *context window* — recall, budget
+ * allocation, history projection, the item-append pipeline — so it is named
+ * after context, not memory. Every name below still resolves to its
+ * replacement; nothing here changes behaviour.
+ *
+ * These are scheduled for removal in the next major of `@noetic-tools/types`.
+ */
+import type { ContextConfig, ContextData, ContextLayer, ContextLayerHooks, InferContext, InferContextShape } from './types/context-layer.js';
+import type { ContextScope, LayerCallModelRequest } from './types/context-scope.js';
+import type { LayerTraceSpan } from './types/observability.js';
+import type { ToolContextDeclaration } from './types/tool.js';
+import type { ToolContext } from './types/tool-context.js';
+/** @public @deprecated Renamed to {@link ContextLayer}. */
+export type MemoryLayer<TState = unknown> = ContextLayer<TState>;
+/** @public @deprecated Renamed to {@link ContextLayerHooks}. */
+export type MemoryHooks<TState = unknown> = ContextLayerHooks<TState>;
+/** @public @deprecated Renamed to {@link ContextConfig}. */
+export type MemoryConfig<TLayers extends readonly ContextLayer[] = readonly ContextLayer[]> = ContextConfig<TLayers>;
+/** @public @deprecated Renamed to {@link ContextData}. */
+export type ContextMemory = ContextData;
+/** @public @deprecated Renamed to {@link InferContext}. */
+export type InferMemory<T extends {
+    readonly _shape: unknown;
+}> = InferContext<T>;
+/** @public @deprecated Renamed to {@link InferContextShape}. */
+export type InferMemoryShape<T extends readonly ContextLayer[]> = InferContextShape<T>;
+/** @public @deprecated Renamed to {@link ContextScope}. */
+export type MemoryScope = ContextScope;
+/** @public @deprecated Renamed to {@link LayerCallModelRequest}. */
+export type MemoryCallModelRequest = LayerCallModelRequest;
+/** @public @deprecated Renamed to {@link LayerTraceSpan}. */
+export type MemoryTraceSpan = LayerTraceSpan;
+/** @public @deprecated Renamed to {@link ToolContext}. */
+export type ToolMemory = ToolContext;
+/** @public @deprecated Renamed to {@link ToolContextDeclaration}. */
+export type ToolMemoryDeclaration<TState = unknown> = ToolContextDeclaration<TState>;

package/dist/index.d.ts

@@ -2,21 +2,23 @@
  * @noetic-tools/types — foundational type contracts and primitives shared
  * across the Noetic framework.
  */
+export * from './deprecated.js';
 export * from './errors/noetic-config-error.js';
 export * from './errors/noetic-error.js';
 export * from './schemas/item.js';
+export * from './schemas/workflow.js';
 export * from './types/channel.js';
 export * from './types/common.js';
 export * from './types/context.js';
+export * from './types/context-layer.js';
 export * from './types/context-parts/item-log.js';
 export * from './types/context-parts/layer-usage.js';
+export * from './types/context-scope.js';
 export * from './types/detached.js';
 export * from './types/error.js';
 export * from './types/fs-adapter.js';
 export * from './types/harness-result.js';
 export * from './types/items.js';
-export * from './types/memory.js';
-export * from './types/memory-context.js';
 export * from './types/observability.js';
 export * from './types/output-codec.js';
 export * from './types/runtime.js';

package/dist/index.js

@@ -2,21 +2,23 @@
  * @noetic-tools/types — foundational type contracts and primitives shared
  * across the Noetic framework.
  */
+export * from './deprecated.js';
 export * from './errors/noetic-config-error.js';
 export * from './errors/noetic-error.js';
 export * from './schemas/item.js';
+export * from './schemas/workflow.js';
 export * from './types/channel.js';
 export * from './types/common.js';
 export * from './types/context.js';
+export * from './types/context-layer.js';
 export * from './types/context-parts/item-log.js';
 export * from './types/context-parts/layer-usage.js';
+export * from './types/context-scope.js';
 export * from './types/detached.js';
 export * from './types/error.js';
 export * from './types/fs-adapter.js';
 export * from './types/harness-result.js';
 export * from './types/items.js';
-export * from './types/memory.js';
-export * from './types/memory-context.js';
 export * from './types/observability.js';
 export * from './types/output-codec.js';
 export * from './types/runtime.js';

package/dist/schemas/item.d.ts

@@ -24,7 +24,7 @@ export declare const ItemSchema: z.ZodCustom<Item, Item>;
 type ItemSchemaCategory = keyof Required<ItemSchemaExtensions>;
 export declare function mergeExtensions(a: ItemSchemaExtensions | undefined, b: ItemSchemaExtensions | undefined): ItemSchemaExtensions;
 /**
- * @public Runtime item validator with optional tool, memory-layer, and harness extension schemas.
+ * @public Runtime item validator with optional tool, context-layer, and harness extension schemas.
  *
  * Extension schemas are pure shape validators (gate, not normalizer): on
  * match the original value is returned unchanged, including fields the schema

package/dist/schemas/item.js

@@ -97,7 +97,7 @@ function schemaMismatch(category) {
     });
 }
 /**
- * @public Runtime item validator with optional tool, memory-layer, and harness extension schemas.
+ * @public Runtime item validator with optional tool, context-layer, and harness extension schemas.
  *
  * Extension schemas are pure shape validators (gate, not normalizer): on
  * match the original value is returned unchanged, including fields the schema

package/dist/schemas/workflow.d.ts

@@ -0,0 +1,297 @@
+/**
+ * Zod schemas for JSON-serialisable workflow definitions.
+ *
+ * A `WorkflowDocument` is a portable, JSON-safe representation of a noetic
+ * step tree. It covers every step kind. The `run` node carries its body as a
+ * code STRING (not an in-process closure) dispatched through a subprocess
+ * adapter, keeping the document JSON-safe. The hydrator in
+ * `@noetic-tools/core` (`builders/workflow-hydrator.ts`) converts a validated
+ * document back into live `Step` objects via the existing builders.
+ */
+import { z } from 'zod';
+import type { SubHarnessKind } from '../types/sub-harness.js';
+interface UntilAnyPredicate {
+    kind: 'any';
+    predicates: UntilPredicate[];
+}
+interface UntilAllPredicate {
+    kind: 'all';
+    predicates: UntilPredicate[];
+}
+/** @public Discriminated union of named until predicates usable in JSON workflows. */
+export type UntilPredicate = {
+    kind: 'maxSteps';
+    n: number;
+} | {
+    kind: 'maxCost';
+    usd: number;
+} | {
+    kind: 'maxDuration';
+    ms: number;
+} | {
+    kind: 'noToolCalls';
+} | {
+    kind: 'outputContains';
+    marker: string;
+} | {
+    kind: 'outputEquals';
+    sentinel: string;
+} | {
+    kind: 'converged';
+    threshold?: number;
+} | UntilAnyPredicate | UntilAllPredicate;
+/** @public Zod schema validating a named `until` predicate (including `any`/`all` combinators). */
+export declare const UntilPredicateSchema: z.ZodType<UntilPredicate>;
+/** @public ESM literal enum for merge strategies. */
+export declare const MergeStrategy: {
+    readonly Last: 'last';
+    readonly First: 'first';
+    readonly Concat: 'concat';
+};
+/** @public Named merge strategy for fork nodes. */
+export type MergeStrategy = (typeof MergeStrategy)[keyof typeof MergeStrategy];
+/** @public Zod schema for the named merge strategy used by `fork` nodes. */
+export declare const MergeStrategySchema: z.ZodEnum<{
+    concat: "concat";
+    first: "first";
+    last: "last";
+}>;
+declare const ModelParamsSchema: z.ZodObject<{
+    temperature: z.ZodOptional<z.ZodNumber>;
+    topP: z.ZodOptional<z.ZodNumber>;
+    maxTokens: z.ZodOptional<z.ZodNumber>;
+    stopSequences: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * A uniform tool entry on an `llm` node. Every entry is an object keyed by
+ * `type`:
+ *   - A CLIENT tool is `{ type: "<registered-tool-name>" }`. The hydrator
+ *     resolves `type` against the tool registry; `parameters` (if present) is
+ *     ignored — client tools receive their call args from the model at runtime.
+ *   - A SERVER tool is `{ type: "openrouter:web_search" | "openrouter:web_fetch",
+ *     parameters?: {...} }`. The provider executes it; `parameters` keys are
+ *     camelCase (e.g. `maxResults`, `searchContextSize`) — the SDK re-serialises
+ *     them and silently drops unknown keys.
+ *
+ * Server vs client is decided by the `type` value (a reserved `openrouter:*`
+ * server-tool literal vs an arbitrary tool name), not by the entry's shape.
+ */
+declare const LlmToolEntrySchema: z.ZodObject<{
+    type: z.ZodString;
+    parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+/** Retry policy for a `run` node, mirroring `RetryPolicy` in `@noetic-tools/types`. */
+declare const RetryPolicySchema: z.ZodObject<{
+    maxAttempts: z.ZodNumber;
+    backoff: z.ZodEnum<{
+        exponential: "exponential";
+        fixed: "fixed";
+        linear: "linear";
+    }>;
+    initialDelay: z.ZodNumber;
+    maxDelay: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+declare const HarnessSettingsSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    permissionMode: z.ZodOptional<z.ZodEnum<{
+        acceptEdits: "acceptEdits";
+        bypassPermissions: "bypassPermissions";
+        default: "default";
+        plan: "plan";
+    }>>;
+    maxTurns: z.ZodOptional<z.ZodNumber>;
+    allowedTools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    extra: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+declare const HarnessSessionPolicySchema: z.ZodObject<{
+    reuse: z.ZodOptional<z.ZodString>;
+    onComplete: z.ZodOptional<z.ZodEnum<{
+        destroy: "destroy";
+        detach: "detach";
+        stop: "stop";
+    }>>;
+}, z.core.$strip>;
+interface WorkflowNodeBase {
+    id: string;
+}
+/**
+ * A reference to a streaming `OutputCodec` for an `llm` node's structured
+ * output. The hydrator resolves `library` from `HydrationContext.uiLibraries`
+ * to a live codec (e.g. `openUi(myLibrary)` from `@noetic-tools/openui`), the
+ * same registry-resolution pattern sub-harness nodes use for adapters. Kept a
+ * *reference* because a codec is a runtime object, not JSON-expressible.
+ */
+export interface OutputCodecRef {
+    /** The codec dialect. Only `'openui'` is defined today. */
+    codec: 'openui';
+    /** Registry key resolved from `HydrationContext.uiLibraries`. */
+    library: string;
+}
+export interface LlmWorkflowNode extends WorkflowNodeBase {
+    kind: 'llm';
+    model?: string;
+    instructions: string;
+    /**
+     * Tool entries. Every entry is an object `{ type, parameters? }`. A CLIENT
+     * tool is `{ type: "<registered-tool-name>" }` (resolved from the registry);
+     * a SERVER tool is `{ type: "openrouter:web_search" | "openrouter:web_fetch",
+     * parameters?: {...} }` (executed by the provider). Client vs server is
+     * decided by the `type` value.
+     */
+    tools?: z.infer<typeof LlmToolEntrySchema>[];
+    params?: z.infer<typeof ModelParamsSchema>;
+    /** Streaming output-codec reference, resolved from `HydrationContext.uiLibraries`. */
+    output?: OutputCodecRef;
+}
+export interface ToolWorkflowNode extends WorkflowNodeBase {
+    kind: 'tool';
+    toolName: string;
+    args?: Record<string, unknown>;
+}
+/**
+ * A node that runs a serialised code body. Unlike the programmatic `step.run`
+ * (which carries a closure), the JSON form carries `execute` as a code STRING.
+ * The code is never eval'd in-process (Cloudflare Workers forbid eval); it is
+ * dispatched through a subprocess adapter (`ctx.subprocess`, or a named adapter
+ * resolved by ref). Execution therefore requires a subprocess adapter capable
+ * of running the code and returning its stdout.
+ */
+export interface RunWorkflowNode extends WorkflowNodeBase {
+    kind: 'run';
+    /** Source code executed in the subprocess. Receives the step input on stdin. */
+    execute: string;
+    /** Optional retry policy applied to the step. */
+    retry?: z.infer<typeof RetryPolicySchema>;
+    /** Named subprocess adapter ref; defaults to `ctx.subprocess` when omitted. */
+    subprocess?: string;
+}
+export interface BranchRoute {
+    match: string;
+    target: WorkflowNode;
+}
+export interface BranchWorkflowNode extends WorkflowNodeBase {
+    kind: 'branch';
+    routes: BranchRoute[];
+    default?: WorkflowNode;
+}
+export interface ForkWorkflowNode extends WorkflowNodeBase {
+    kind: 'fork';
+    mode: 'race' | 'all' | 'settle';
+    /**
+     * Static fan-out: one child per entry. Mutually exclusive with `each` —
+     * supply exactly one.
+     */
+    paths?: WorkflowNode[];
+    /**
+     * Dynamic fan-out: instantiate this body template once per item of a
+     * runtime-produced array (data-dependent N). Mutually exclusive with `paths`.
+     */
+    each?: WorkflowNode;
+    /**
+     * Selector key into the fork input (parsed as JSON) locating the array to
+     * fan out over. When omitted, the input string itself is parsed as a JSON
+     * array. Only meaningful with `each`.
+     */
+    over?: string;
+    merge?: MergeStrategy;
+    concurrency?: number;
+}
+export interface SpawnWorkflowNode extends WorkflowNodeBase {
+    kind: 'spawn';
+    child: WorkflowNode;
+    timeout?: number;
+    /**
+     * Memory layers the child runs with, by registered name (resolved from
+     * `HydrationContext.layers`, like `provide`). Omit to inherit the parent's
+     * layers — the default spawn behaviour. Naming layers here REPLACES the
+     * inherited set for the child, so list every layer the child needs.
+     */
+    layers?: string[];
+}
+export interface ProvideWorkflowNode extends WorkflowNodeBase {
+    kind: 'provide';
+    child: WorkflowNode;
+    layers: string[];
+}
+export interface LoopWorkflowNode extends WorkflowNodeBase {
+    kind: 'loop';
+    body: WorkflowNode;
+    until: UntilPredicate;
+    maxIterations?: number;
+}
+export interface SequenceWorkflowNode extends WorkflowNodeBase {
+    kind: 'sequence';
+    steps: WorkflowNode[];
+}
+export interface EveryWorkflowNode extends WorkflowNodeBase {
+    kind: 'every';
+    step: WorkflowNode;
+    ms: number;
+    onError?: 'continue' | 'fail';
+}
+/**
+ * A node that delegates a turn to a coding-agent harness. `kind` is the harness
+ * id (e.g. `claude-code`); the hydrator resolves the matching adapter from the
+ * workflow's harness registry.
+ */
+export interface SubHarnessWorkflowNode extends WorkflowNodeBase {
+    kind: SubHarnessKind;
+    prompt: string;
+    instructions?: string;
+    settings?: z.infer<typeof HarnessSettingsSchema>;
+    session?: z.infer<typeof HarnessSessionPolicySchema>;
+}
+/**
+ * A node that runs another workflow document as a sub-step. The document is
+ * either inline or a named reference resolved from `HydrationContext.workflows`
+ * at execution time. Supply exactly one of `document` / `ref`.
+ */
+export interface SubflowWorkflowNode extends WorkflowNodeBase {
+    kind: 'subflow';
+    /** Inline sub-workflow. Mutually exclusive with `ref`. */
+    document?: WorkflowDocument;
+    /** Named sub-workflow resolved from `HydrationContext.workflows`. Mutually exclusive with `document`. */
+    ref?: string;
+    /** Literal input passed to the sub-workflow; defaults to the node's runtime input. */
+    input?: string;
+}
+/** @public Discriminated union of all JSON-serialisable workflow node kinds. */
+export type WorkflowNode = LlmWorkflowNode | ToolWorkflowNode | RunWorkflowNode | BranchWorkflowNode | ForkWorkflowNode | SpawnWorkflowNode | ProvideWorkflowNode | LoopWorkflowNode | SequenceWorkflowNode | EveryWorkflowNode | SubflowWorkflowNode | SubHarnessWorkflowNode;
+/** @public Zod schema validating a single `WorkflowNode` (any JSON-safe kind). */
+export declare const WorkflowNodeSchema: z.ZodType<WorkflowNode>;
+/** @public Top-level envelope for a JSON workflow definition. */
+export interface WorkflowDocument {
+    version: 1;
+    root: WorkflowNode;
+}
+/** @public Zod schema validating a complete `WorkflowDocument`. */
+export declare const WorkflowDocumentSchema: z.ZodType<WorkflowDocument>;
+/** Validates a candidate workflow document. Throws `ZodError` on invalid input. */
+export declare function validateWorkflow(input: unknown): WorkflowDocument;
+/** Walks a workflow tree depth-first, yielding each node. */
+export declare function walkWorkflow(node: WorkflowNode): Iterable<WorkflowNode>;
+/** A flattened, JSON-safe view of a workflow tree: its nodes and parent→child edges. */
+export interface WorkflowGraph {
+    nodes: Array<{
+        id: string;
+        kind: WorkflowNode['kind'];
+    }>;
+    edges: Array<{
+        from: string;
+        to: string;
+    }>;
+}
+/**
+ * Flattens a workflow tree into a node + edge list — the static "potential
+ * paths" of the DAG, suitable for attaching to a trace span so observers can
+ * reconstruct the declared graph independent of which branches actually ran.
+ * `subflow` refs are leaves: their target documents resolve at hydration time.
+ */
+export declare function workflowGraph(root: WorkflowNode): WorkflowGraph;
+/**
+ * Returns the maximum depth of a workflow tree.
+ * Leaf nodes (`llm`, `tool`) have depth 0. Structural nodes add +1.
+ * A `subflow` ref counts as a leaf — depth does not see through named refs.
+ */
+export declare function workflowDepth(node: WorkflowNode): number;
+export {};