@camstack/types 1.2.259 → 1.2.261

package/dist/capabilities/pipeline-executor.cap.d.ts

@@ -17,11 +17,11 @@ export declare const NativeCropRefSchema: z.ZodObject<{
         width: z.ZodNumber;
         height: z.ZodNumber;
         format: z.ZodEnum<{
-            rgb: "rgb";
-            gray: "gray";
             jpeg: "jpeg";
+            rgb: "rgb";
             bgr: "bgr";
             yuv420: "yuv420";
+            gray: "gray";
         }>;
         pts: z.ZodNumber;
         byteLength: z.ZodNumber;
@@ -52,9 +52,9 @@ export declare const FrameViewSpecSchema: z.ZodObject<{
         contain: "contain";
     }>;
     format: z.ZodEnum<{
+        jpeg: "jpeg";
         rgb: "rgb";
         gray: "gray";
-        jpeg: "jpeg";
     }>;
 }, z.core.$strip>;
 export type FrameViewSpec = z.infer<typeof FrameViewSpecSchema>;
@@ -77,10 +77,7 @@ export declare const FrameRefSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type FrameRef = z.infer<typeof FrameRefSchema>;
 declare const PipelineEngineChoiceSchema: z.ZodObject<{
-    runtime: z.ZodEnum<{
-        node: "node";
-        python: "python";
-    }>;
+    runtime: z.ZodLiteral<"python">;
     backend: z.ZodString;
     format: z.ZodEnum<{
         onnx: "onnx";
@@ -92,6 +89,26 @@ declare const PipelineEngineChoiceSchema: z.ZodObject<{
     }>;
     device: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * One pool's resolved provisioning (`getEffectiveTuning`). `numWorkers` is the
+ * knob that lifts a saturated pool (`inference-devices.md`); `concurrency` is
+ * per-worker in-flight requests. `deviceKey` echoes the pool asked about —
+ * `null` for the node-default pool.
+ */
+export declare const EffectiveTuningSchema: z.ZodObject<{
+    deviceKey: z.ZodNullable<z.ZodString>;
+    runtime: z.ZodString;
+    batchMode: z.ZodString;
+    windowMs: z.ZodNumber;
+    maxBatchSize: z.ZodNumber;
+    concurrency: z.ZodNumber;
+    numWorkers: z.ZodNumber;
+}, z.core.$strip>;
+export type EffectiveTuning = z.infer<typeof EffectiveTuningSchema>;
+/** Input of `getEffectiveTuning` — absent `deviceKey` ⇒ the node-default pool. */
+export interface EffectiveTuningInput {
+    readonly deviceKey?: string;
+}
 declare const EngineDeviceInfoSchema: z.ZodObject<{
     id: z.ZodString;
     label: z.ZodString;
@@ -99,10 +116,7 @@ declare const EngineDeviceInfoSchema: z.ZodObject<{
 }, z.core.$strip>;
 declare const AvailableEngineSchema: z.ZodObject<{
     engine: z.ZodObject<{
-        runtime: z.ZodEnum<{
-            node: "node";
-            python: "python";
-        }>;
+        runtime: z.ZodLiteral<"python">;
         backend: z.ZodString;
         format: z.ZodEnum<{
             onnx: "onnx";
@@ -148,10 +162,7 @@ declare const PipelineTemplateSchema: z.ZodObject<{
     createdAt: z.ZodString;
     updatedAt: z.ZodString;
     engine: z.ZodObject<{
-        runtime: z.ZodEnum<{
-            node: "node";
-            python: "python";
-        }>;
+        runtime: z.ZodLiteral<"python">;
         backend: z.ZodString;
         format: z.ZodEnum<{
             onnx: "onnx";
@@ -324,10 +335,7 @@ declare const PipelineSlotSchemaSchema: z.ZodObject<{
 declare const PipelineSchemaSchema: z.ZodObject<{
     availableEngines: z.ZodReadonly<z.ZodArray<z.ZodObject<{
         engine: z.ZodObject<{
-            runtime: z.ZodEnum<{
-                node: "node";
-                python: "python";
-            }>;
+            runtime: z.ZodLiteral<"python">;
             backend: z.ZodString;
             format: z.ZodEnum<{
                 onnx: "onnx";
@@ -347,10 +355,7 @@ declare const PipelineSchemaSchema: z.ZodObject<{
         defaultDevice: z.ZodString;
     }, z.core.$strip>>>;
     selectedEngine: z.ZodObject<{
-        runtime: z.ZodEnum<{
-            node: "node";
-            python: "python";
-        }>;
+        runtime: z.ZodLiteral<"python">;
         backend: z.ZodString;
         format: z.ZodEnum<{
             onnx: "onnx";
@@ -486,6 +491,7 @@ declare const PipelineValidationIssueSchema: z.ZodObject<{
     kind: z.ZodEnum<{
         "unknown-addon": "unknown-addon";
         "no-format-build": "no-format-build";
+        "unknown-device": "unknown-device";
     }>;
     detail: z.ZodString;
 }, z.core.$strip>;
@@ -496,6 +502,7 @@ declare const PipelineValidationResultSchema: z.ZodObject<{
         kind: z.ZodEnum<{
             "unknown-addon": "unknown-addon";
             "no-format-build": "no-format-build";
+            "unknown-device": "unknown-device";
         }>;
         detail: z.ZodString;
     }, z.core.$strip>>>;
@@ -528,10 +535,7 @@ export declare const pipelineExecutorCapability: {
     readonly mode: "singleton";
     readonly methods: {
         readonly getAvailableEngines: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodArray<z.ZodObject<{
-            runtime: z.ZodEnum<{
-                node: "node";
-                python: "python";
-            }>;
+            runtime: z.ZodLiteral<"python">;
             backend: z.ZodString;
             format: z.ZodEnum<{
                 onnx: "onnx";
@@ -544,10 +548,7 @@ export declare const pipelineExecutorCapability: {
             device: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>, import("./capability-definition.js").CapabilityMethodKind>;
         readonly getSelectedEngine: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodObject<{
-            runtime: z.ZodEnum<{
-                node: "node";
-                python: "python";
-            }>;
+            runtime: z.ZodLiteral<"python">;
             backend: z.ZodString;
             format: z.ZodEnum<{
                 onnx: "onnx";
@@ -560,10 +561,7 @@ export declare const pipelineExecutorCapability: {
             device: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
         readonly getDefaultSteps: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
-            runtime: z.ZodEnum<{
-                node: "node";
-                python: "python";
-            }>;
+            runtime: z.ZodLiteral<"python">;
             backend: z.ZodString;
             format: z.ZodEnum<{
                 onnx: "onnx";
@@ -691,10 +689,7 @@ export declare const pipelineExecutorCapability: {
         readonly getSchema: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodObject<{
             availableEngines: z.ZodReadonly<z.ZodArray<z.ZodObject<{
                 engine: z.ZodObject<{
-                    runtime: z.ZodEnum<{
-                        node: "node";
-                        python: "python";
-                    }>;
+                    runtime: z.ZodLiteral<"python">;
                     backend: z.ZodString;
                     format: z.ZodEnum<{
                         onnx: "onnx";
@@ -714,10 +709,7 @@ export declare const pipelineExecutorCapability: {
                 defaultDevice: z.ZodString;
             }, z.core.$strip>>>;
             selectedEngine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -817,9 +809,14 @@ export declare const pipelineExecutorCapability: {
          * `unknown-addon` and `no-format-build` are HARD issues); `substitutions`
          * is informational (a degraded-but-loadable model swap) and never
          * affects `ok`. Never throws.
+         *
+         * `deviceKey` validates against THAT device pool's format instead of the
+         * node default (D646) — the cheap question a pinned replay asks before it
+         * reads any media: can this (node, deviceKey) run exactly this model?
          */
         readonly validatePipeline: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             steps: z.ZodArray<z.ZodType<PipelineStepInputOutput, unknown, z.core.$ZodTypeInternals<PipelineStepInputOutput, unknown>>>;
+            deviceKey: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, z.ZodObject<{
             ok: z.ZodBoolean;
             issues: z.ZodReadonly<z.ZodArray<z.ZodObject<{
@@ -827,6 +824,7 @@ export declare const pipelineExecutorCapability: {
                 kind: z.ZodEnum<{
                     "unknown-addon": "unknown-addon";
                     "no-format-build": "no-format-build";
+                    "unknown-device": "unknown-device";
                 }>;
                 detail: z.ZodString;
             }, z.core.$strip>>>;
@@ -844,10 +842,7 @@ export declare const pipelineExecutorCapability: {
             createdAt: z.ZodString;
             updatedAt: z.ZodString;
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -865,10 +860,7 @@ export declare const pipelineExecutorCapability: {
             name: z.ZodString;
             steps: z.ZodReadonly<z.ZodArray<z.ZodType<PipelineTemplateStepOutput, unknown, z.core.$ZodTypeInternals<PipelineTemplateStepOutput, unknown>>>>;
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -886,10 +878,7 @@ export declare const pipelineExecutorCapability: {
             createdAt: z.ZodString;
             updatedAt: z.ZodString;
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -913,10 +902,7 @@ export declare const pipelineExecutorCapability: {
             createdAt: z.ZodString;
             updatedAt: z.ZodString;
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -969,12 +955,14 @@ export declare const pipelineExecutorCapability: {
         }, z.core.$strip>, "mutation">;
         /**
          * Stateless single-frame execution. Callers (runner, benchmark) pass
-         * the complete `engine` + `steps` tree; the executor holds no state
-         * about cameras or saved pipelines.
+         * the complete `steps` tree; the executor holds no state about cameras
+         * or saved pipelines. WHICH pool answers is the node's own engine, or the
+         * `deviceKey` pool when one is named.
          *
-         * `engine` is optional during the migration window to preserve the
-         * legacy call shape used by existing benchmark code; once all
-         * callers pass it explicitly we make it required.
+         * There is no `engine` field (D646). It existed for the benchmark and was
+         * honoured by swapping the SHARED provider's engine, factory and executor
+         * for the duration of the call, on a node serving live cameras. A caller
+         * that still sends the key has it stripped here and changes nothing.
          *
          * Exactly one of `frame`, `frameRef`, `frameHandle`, `imageBase64`,
          * `referenceImage` must be provided:
@@ -994,31 +982,15 @@ export declare const pipelineExecutorCapability: {
          *  - `referenceImage`: named file from the reference-image store.
          */
         readonly runPipeline: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
-            engine: z.ZodOptional<z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
-                backend: z.ZodString;
-                format: z.ZodEnum<{
-                    onnx: "onnx";
-                    coreml: "coreml";
-                    openvino: "openvino";
-                    tflite: "tflite";
-                    pt: "pt";
-                    gguf: "gguf";
-                }>;
-                device: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>>;
             steps: z.ZodArray<z.ZodType<PipelineStepInputOutput, unknown, z.core.$ZodTypeInternals<PipelineStepInputOutput, unknown>>>;
             frame: z.ZodOptional<z.ZodObject<{
                 data: z.ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>;
                 format: z.ZodEnum<{
-                    rgb: "rgb";
-                    gray: "gray";
                     jpeg: "jpeg";
+                    rgb: "rgb";
                     bgr: "bgr";
                     yuv420: "yuv420";
+                    gray: "gray";
                 }>;
                 width: z.ZodNumber;
                 height: z.ZodNumber;
@@ -1043,11 +1015,11 @@ export declare const pipelineExecutorCapability: {
                 width: z.ZodNumber;
                 height: z.ZodNumber;
                 format: z.ZodEnum<{
-                    rgb: "rgb";
-                    gray: "gray";
                     jpeg: "jpeg";
+                    rgb: "rgb";
                     bgr: "bgr";
                     yuv420: "yuv420";
+                    gray: "gray";
                 }>;
                 pts: z.ZodNumber;
                 byteLength: z.ZodNumber;
@@ -1072,11 +1044,11 @@ export declare const pipelineExecutorCapability: {
                     width: z.ZodNumber;
                     height: z.ZodNumber;
                     format: z.ZodEnum<{
-                        rgb: "rgb";
-                        gray: "gray";
                         jpeg: "jpeg";
+                        rgb: "rgb";
                         bgr: "bgr";
                         yuv420: "yuv420";
+                        gray: "gray";
                     }>;
                     pts: z.ZodNumber;
                     byteLength: z.ZodNumber;
@@ -1090,6 +1062,7 @@ export declare const pipelineExecutorCapability: {
                     h: z.ZodNumber;
                 }, z.core.$strip>;
             }, z.core.$strip>>;
+            replay: z.ZodOptional<z.ZodLiteral<true>>;
         }, z.core.$strip>, z.ZodCustom<FrameResult, FrameResult>, "mutation">;
         /**
          * Batched run — N raw frames packed into one cap call. The provider
@@ -1103,31 +1076,15 @@ export declare const pipelineExecutorCapability: {
          * N frames in one call to amortise per-call IPC overhead.
          */
         readonly runPipelineBatch: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
-            engine: z.ZodOptional<z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
-                backend: z.ZodString;
-                format: z.ZodEnum<{
-                    onnx: "onnx";
-                    coreml: "coreml";
-                    openvino: "openvino";
-                    tflite: "tflite";
-                    pt: "pt";
-                    gguf: "gguf";
-                }>;
-                device: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>>;
             steps: z.ZodArray<z.ZodType<PipelineStepInputOutput, unknown, z.core.$ZodTypeInternals<PipelineStepInputOutput, unknown>>>;
             frames: z.ZodArray<z.ZodObject<{
                 data: z.ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>;
                 format: z.ZodEnum<{
-                    rgb: "rgb";
-                    gray: "gray";
                     jpeg: "jpeg";
+                    rgb: "rgb";
                     bgr: "bgr";
                     yuv420: "yuv420";
+                    gray: "gray";
                 }>;
                 width: z.ZodNumber;
                 height: z.ZodNumber;
@@ -1152,8 +1109,8 @@ export declare const pipelineExecutorCapability: {
             height: z.ZodNumber;
             format: z.ZodEnum<{
                 rgb: "rgb";
-                gray: "gray";
                 bgr: "bgr";
+                gray: "gray";
             }>;
         }, z.core.$strip>, z.ZodObject<{
             frameId: z.ZodNumber;
@@ -1175,12 +1132,23 @@ export declare const pipelineExecutorCapability: {
         readonly uncacheFrame: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             frameId: z.ZodNumber;
         }, z.core.$strip>, z.ZodVoid, "mutation">;
-        /** Returns the effective pool tuning (resolved from user overrides + backend defaults). */
-        readonly getEffectiveTuning: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodObject<{
+        /**
+         * The effective provisioning of ONE pool of this node (operator override →
+         * the pool's own runtime row). `deviceKey` names the device pool; absent is
+         * the node-default pool. It answered only for the node default until
+         * D646, so a benchmark on `openvino:npu` recorded the onnx pool's tuning
+         * beside an NPU measurement.
+         */
+        readonly getEffectiveTuning: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            deviceKey: z.ZodNullable<z.ZodString>;
+            runtime: z.ZodString;
             batchMode: z.ZodString;
             windowMs: z.ZodNumber;
             maxBatchSize: z.ZodNumber;
             concurrency: z.ZodNumber;
+            numWorkers: z.ZodNumber;
         }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
         /**
          * List every EngineFactory currently loaded in this executor's RAM,
@@ -1190,10 +1158,7 @@ export declare const pipelineExecutorCapability: {
         readonly listLoadedEngines: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodReadonly<z.ZodArray<z.ZodObject<{
             engineKey: z.ZodString;
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -1209,7 +1174,6 @@ export declare const pipelineExecutorCapability: {
             inUseByCameras: z.ZodReadonly<z.ZodArray<z.ZodNumber>>;
             kind: z.ZodEnum<{
                 runtime: "runtime";
-                "warm-override": "warm-override";
                 "device-pool": "device-pool";
             }>;
             poolPid: z.ZodNullable<z.ZodNumber>;
@@ -1219,10 +1183,7 @@ export declare const pipelineExecutorCapability: {
         /** Warm up an engine without running a frame. No-op if already loaded. */
         readonly spinEngine: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";
@@ -1244,10 +1205,7 @@ export declare const pipelineExecutorCapability: {
          */
         readonly killEngine: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             engine: z.ZodObject<{
-                runtime: z.ZodEnum<{
-                    node: "node";
-                    python: "python";
-                }>;
+                runtime: z.ZodLiteral<"python">;
                 backend: z.ZodString;
                 format: z.ZodEnum<{
                     onnx: "onnx";