@naturali/sdk 0.78.5 → 0.78.6

package/dist/index.d.cts

@@ -2398,6 +2398,12 @@ type EvalRun = {
   item_count?: number;
   completed_count?: number;
   errored_count?: number;
+  /**
+   * The caller-owned key/value metadata supplied when the run was started, returned verbatim. Null when the run was started without any (a trigger-started run included — see `trigger_id` for that provenance). The server writes nothing here.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   started_at?: Date | null;
   finished_at?: Date | null;
   created_at?: Date;
@@ -2435,7 +2441,7 @@ type ExceptionItem = {
   /**
    * How the exception was filed
    */
-  kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'manual';
+  kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
   /**
    * Human-readable one-line summary
    */
@@ -3770,6 +3776,12 @@ type OrchestrationRun = {
   tool_context?: {
     [key: string]: string;
   } | null;
+  /**
+   * The caller-owned key/value metadata supplied at run creation, returned verbatim. Null when the run was started without any. The server writes nothing here and no key is reserved; the bag is never merged into `state`, so nothing in it reaches the graph.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   /**
    * Terminal node artifact(s) when the run has succeeded.
    */
@@ -3908,6 +3920,16 @@ type StartRunRequest = {
   tool_context?: {
     [key: string]: string;
   };
+  /**
+   * Caller-supplied key/value metadata attached to the run record for per-run attribution (e.g. which of your own tenants this run belongs to, or the dispatch batch that started it). Round-trips verbatim on every read of the run, on the list as well as the single read.
+   *
+   * The bag is caller-owned and no key is reserved: server-owned state (status, the pinned orchestration version, the trace, usage, artifacts, the run's own `input` and accumulated `state`) lives in its own top-level field and cannot be written from here.
+   *
+   * It is **not** merged into run state: no graph node sees it, and an `input_schema` never has to tolerate it — which is what makes it the place for an infrastructural label, rather than `input`. Keys are never transformed. It is not inherited by the child runs a `loop` or `sub_orchestration` node starts; each child carries whatever the graph gives it, which today is nothing.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
   /**
    * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "queued" and execute the run in the background.
    */
@@ -4419,6 +4441,12 @@ type Task = {
   payload?: {
     [key: string]: unknown;
   };
+  /**
+   * The caller-owned key/value metadata supplied when the task was created, returned verbatim. Null when the task was created without any. Unlike `payload` it is invisible to guards and to `payload_writes`, so it is the place for an attribution label rather than task data.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   /**
    * Server-owned. The result of the current state's last completed dispatch, overwritten on every dispatch. Read-only — exposed to transition guards and `on_complete`/`payload_writes` expressions as `task.last_result`, a namespace a caller cannot write.
    */
@@ -4498,6 +4526,16 @@ type CreateTaskRequest = {
   tool_context?: {
     [key: string]: string;
   };
+  /**
+   * Caller-supplied key/value metadata attached to the task record for attribution — which of your own tenants the task belongs to, the ticket that raised it, the import batch that created it. Round-trips verbatim on every read of the task, the list included, and survives every transition (a transition supplies no metadata of its own).
+   *
+   * The bag is caller-owned and no key is reserved: everything the engine decides about a task (`state`, `status`, `workflow_version`, `last_result`, `active_dispatch`, the automation fields) is a field of its own and cannot be written from here.
+   *
+   * Prefer this over `payload` for anything that is not task data: `payload` is read by every guard as `task.payload` and may be written by the workflow's declared `payload_writes`, so a label parked there is neither invisible to the state machine nor safe from it. A non-object is rejected with `400 VALIDATION_FAILED` and no task is created.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
 };
 type UpdateTaskRequest = {
   title?: string;
@@ -4795,7 +4833,7 @@ type Trigger = {
   project_id?: string;
   name?: string;
   description?: string | null;
-  type?: 'manual' | 'webhook' | 'schedule';
+  type?: 'manual' | 'webhook' | 'schedule' | 'event';
   target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
   /**
    * Public ID of the target resource (orchestration, agent, tool, or eval)
@@ -4815,6 +4853,10 @@ type Trigger = {
    * 5-field cron expression (UTC). Present only for schedule triggers
    */
   cron?: string | null;
+  /**
+   * Internal-event subscription pattern. Present only for event triggers: `*`, `prefix.*`, or an exact event name
+   */
+  event_pattern?: string | null;
   active?: boolean;
   /**
    * Optional boundary policy that further restricts firings
@@ -4836,7 +4878,7 @@ type TriggerWithSecret = Trigger & {
 type CreateTriggerRequest = {
   name: string;
   description?: string;
-  type: 'manual' | 'webhook' | 'schedule';
+  type: 'manual' | 'webhook' | 'schedule' | 'event';
   target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
   target_id: string;
   /**
@@ -4850,6 +4892,10 @@ type CreateTriggerRequest = {
    * 5-field cron expression (UTC). Required when type is schedule
    */
   cron?: string;
+  /**
+   * Internal-event subscription pattern. Required when type is event, rejected otherwise. `*` matches every event, `prefix.*` a namespace, or give an exact event name such as `documents.ingested`
+   */
+  event_pattern?: string;
   active?: boolean;
   policy_id?: string;
 };
@@ -4863,6 +4909,7 @@ type UpdateTriggerRequest = {
     [key: string]: unknown;
   } | null;
   cron?: string | null;
+  event_pattern?: string | null;
   active?: boolean;
   policy_id?: string | null;
 };
@@ -4881,7 +4928,7 @@ type TriggerFiring = {
   id?: string;
   trigger_id?: string;
   project_id?: string;
-  source?: 'manual' | 'webhook' | 'schedule';
+  source?: 'manual' | 'webhook' | 'schedule' | 'event';
   status?: 'pending' | 'running' | 'succeeded' | 'failed';
   input?: {
     [key: string]: unknown;
@@ -10398,6 +10445,14 @@ type StartEvalRunData = {
      * A terminal run of the same eval to compare against. The finished run's `aggregate_scores.baseline` reports per-scorer deltas over the item intersection. A run of a different eval is rejected with 400.
      */
     baseline_run_id?: string | null;
+    /**
+     * Caller-supplied key/value metadata attached to the run record for attribution — what this measurement was of (the commit or release candidate being scored, the CI job that asked for it). Round-trips verbatim on every read of the run, the list included.
+     *
+     * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
+     */
+    metadata?: {
+      [key: string]: unknown;
+    };
   };
   path: {
     /**
@@ -10603,7 +10658,7 @@ type ListExceptionsData = {
     /**
      * Filter by how the exception was filed
      */
-    kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'manual';
+    kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
     /**
      * Maximum number of results to return
      */
@@ -13490,7 +13545,7 @@ type StartOrchestrationRunData = {
 };
 type StartOrchestrationRunErrors = {
   /**
-   * Validation error
+   * Validation error (e.g. a `tool_context` key that cannot become a header, or `metadata` that is not a JSON object). No run is created.
    */
   400: unknown;
   /**
@@ -15615,7 +15670,7 @@ type ListTriggersData = {
     project_id: string;
   };
   query?: {
-    type?: 'manual' | 'webhook' | 'schedule';
+    type?: 'manual' | 'webhook' | 'schedule' | 'event';
     target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
     /**
      * Maximum number of results to return

package/dist/index.d.mts

@@ -2398,6 +2398,12 @@ type EvalRun = {
   item_count?: number;
   completed_count?: number;
   errored_count?: number;
+  /**
+   * The caller-owned key/value metadata supplied when the run was started, returned verbatim. Null when the run was started without any (a trigger-started run included — see `trigger_id` for that provenance). The server writes nothing here.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   started_at?: Date | null;
   finished_at?: Date | null;
   created_at?: Date;
@@ -2435,7 +2441,7 @@ type ExceptionItem = {
   /**
    * How the exception was filed
    */
-  kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'manual';
+  kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
   /**
    * Human-readable one-line summary
    */
@@ -3770,6 +3776,12 @@ type OrchestrationRun = {
   tool_context?: {
     [key: string]: string;
   } | null;
+  /**
+   * The caller-owned key/value metadata supplied at run creation, returned verbatim. Null when the run was started without any. The server writes nothing here and no key is reserved; the bag is never merged into `state`, so nothing in it reaches the graph.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   /**
    * Terminal node artifact(s) when the run has succeeded.
    */
@@ -3908,6 +3920,16 @@ type StartRunRequest = {
   tool_context?: {
     [key: string]: string;
   };
+  /**
+   * Caller-supplied key/value metadata attached to the run record for per-run attribution (e.g. which of your own tenants this run belongs to, or the dispatch batch that started it). Round-trips verbatim on every read of the run, on the list as well as the single read.
+   *
+   * The bag is caller-owned and no key is reserved: server-owned state (status, the pinned orchestration version, the trace, usage, artifacts, the run's own `input` and accumulated `state`) lives in its own top-level field and cannot be written from here.
+   *
+   * It is **not** merged into run state: no graph node sees it, and an `input_schema` never has to tolerate it — which is what makes it the place for an infrastructural label, rather than `input`. Keys are never transformed. It is not inherited by the child runs a `loop` or `sub_orchestration` node starts; each child carries whatever the graph gives it, which today is nothing.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
   /**
    * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "queued" and execute the run in the background.
    */
@@ -4419,6 +4441,12 @@ type Task = {
   payload?: {
     [key: string]: unknown;
   };
+  /**
+   * The caller-owned key/value metadata supplied when the task was created, returned verbatim. Null when the task was created without any. Unlike `payload` it is invisible to guards and to `payload_writes`, so it is the place for an attribution label rather than task data.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
   /**
    * Server-owned. The result of the current state's last completed dispatch, overwritten on every dispatch. Read-only — exposed to transition guards and `on_complete`/`payload_writes` expressions as `task.last_result`, a namespace a caller cannot write.
    */
@@ -4498,6 +4526,16 @@ type CreateTaskRequest = {
   tool_context?: {
     [key: string]: string;
   };
+  /**
+   * Caller-supplied key/value metadata attached to the task record for attribution — which of your own tenants the task belongs to, the ticket that raised it, the import batch that created it. Round-trips verbatim on every read of the task, the list included, and survives every transition (a transition supplies no metadata of its own).
+   *
+   * The bag is caller-owned and no key is reserved: everything the engine decides about a task (`state`, `status`, `workflow_version`, `last_result`, `active_dispatch`, the automation fields) is a field of its own and cannot be written from here.
+   *
+   * Prefer this over `payload` for anything that is not task data: `payload` is read by every guard as `task.payload` and may be written by the workflow's declared `payload_writes`, so a label parked there is neither invisible to the state machine nor safe from it. A non-object is rejected with `400 VALIDATION_FAILED` and no task is created.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
 };
 type UpdateTaskRequest = {
   title?: string;
@@ -4795,7 +4833,7 @@ type Trigger = {
   project_id?: string;
   name?: string;
   description?: string | null;
-  type?: 'manual' | 'webhook' | 'schedule';
+  type?: 'manual' | 'webhook' | 'schedule' | 'event';
   target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
   /**
    * Public ID of the target resource (orchestration, agent, tool, or eval)
@@ -4815,6 +4853,10 @@ type Trigger = {
    * 5-field cron expression (UTC). Present only for schedule triggers
    */
   cron?: string | null;
+  /**
+   * Internal-event subscription pattern. Present only for event triggers: `*`, `prefix.*`, or an exact event name
+   */
+  event_pattern?: string | null;
   active?: boolean;
   /**
    * Optional boundary policy that further restricts firings
@@ -4836,7 +4878,7 @@ type TriggerWithSecret = Trigger & {
 type CreateTriggerRequest = {
   name: string;
   description?: string;
-  type: 'manual' | 'webhook' | 'schedule';
+  type: 'manual' | 'webhook' | 'schedule' | 'event';
   target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
   target_id: string;
   /**
@@ -4850,6 +4892,10 @@ type CreateTriggerRequest = {
    * 5-field cron expression (UTC). Required when type is schedule
    */
   cron?: string;
+  /**
+   * Internal-event subscription pattern. Required when type is event, rejected otherwise. `*` matches every event, `prefix.*` a namespace, or give an exact event name such as `documents.ingested`
+   */
+  event_pattern?: string;
   active?: boolean;
   policy_id?: string;
 };
@@ -4863,6 +4909,7 @@ type UpdateTriggerRequest = {
     [key: string]: unknown;
   } | null;
   cron?: string | null;
+  event_pattern?: string | null;
   active?: boolean;
   policy_id?: string | null;
 };
@@ -4881,7 +4928,7 @@ type TriggerFiring = {
   id?: string;
   trigger_id?: string;
   project_id?: string;
-  source?: 'manual' | 'webhook' | 'schedule';
+  source?: 'manual' | 'webhook' | 'schedule' | 'event';
   status?: 'pending' | 'running' | 'succeeded' | 'failed';
   input?: {
     [key: string]: unknown;
@@ -10398,6 +10445,14 @@ type StartEvalRunData = {
      * A terminal run of the same eval to compare against. The finished run's `aggregate_scores.baseline` reports per-scorer deltas over the item intersection. A run of a different eval is rejected with 400.
      */
     baseline_run_id?: string | null;
+    /**
+     * Caller-supplied key/value metadata attached to the run record for attribution — what this measurement was of (the commit or release candidate being scored, the CI job that asked for it). Round-trips verbatim on every read of the run, the list included.
+     *
+     * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
+     */
+    metadata?: {
+      [key: string]: unknown;
+    };
   };
   path: {
     /**
@@ -10603,7 +10658,7 @@ type ListExceptionsData = {
     /**
      * Filter by how the exception was filed
      */
-    kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'manual';
+    kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
     /**
      * Maximum number of results to return
      */
@@ -13490,7 +13545,7 @@ type StartOrchestrationRunData = {
 };
 type StartOrchestrationRunErrors = {
   /**
-   * Validation error
+   * Validation error (e.g. a `tool_context` key that cannot become a header, or `metadata` that is not a JSON object). No run is created.
    */
   400: unknown;
   /**
@@ -15615,7 +15670,7 @@ type ListTriggersData = {
     project_id: string;
   };
   query?: {
-    type?: 'manual' | 'webhook' | 'schedule';
+    type?: 'manual' | 'webhook' | 'schedule' | 'event';
     target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
     /**
      * Maximum number of results to return

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturali/sdk",
-  "version": "0.78.5",
+  "version": "0.78.6",
   "description": "TypeScript SDK for the naturali.ai API, generated from its OpenAPI specs",
   "type": "module",
   "sideEffects": false,
@@ -37,7 +37,7 @@
     "tsx": "^4.23.1",
     "typescript": "~6.0.3",
     "vitest": "^4.1.10",
-    "@naturali/api": "0.78.5"
+    "@naturali/api": "0.78.6"
   },
   "scripts": {
     "generate": "tsx scripts/generate.ts",