@camstack/types 1.0.7 → 1.1.1

package/dist/types/models.d.ts

@@ -1,57 +1,187 @@
-import type { LabelDefinition, ClassMapDefinition } from './labels.js';
+import { z } from 'zod';
+import type { ClassMapDefinition, LabelDefinition } from './labels.js';
 export declare const MODEL_FORMATS: readonly ["onnx", "coreml", "openvino", "tflite", "pt"];
 export type ModelFormat = (typeof MODEL_FORMATS)[number];
 export type ModelOutputFormat = 'yolo' | 'ssd' | 'embedding' | 'classification' | 'ocr' | 'segmentation';
-export interface ModelFormatEntry {
-    readonly url: string;
-    readonly sizeMB: number;
-    /** Whether this format is a directory bundle (e.g., .mlpackage) rather than a single file */
-    readonly isDirectory?: boolean;
-    /**
-     * For directory formats: list of files relative to the directory root.
-     * The downloader fetches each file from `{url}/{file}` and saves to `{modelDir}/{file}`.
-     * If omitted for a directory format, the downloader probes HuggingFace API (slower).
-     */
-    readonly files?: readonly string[];
-    /** Runtime(s) that can use this format. If omitted, inferred from ModelFormat key */
-    readonly runtimes?: readonly ('node' | 'python')[];
-}
+/**
+ * Multi-file format payload.
+ *
+ * - Directory formats (`isDirectory: true`, e.g. `.mlpackage`): files
+ *   relative to the directory root — the downloader fetches each from
+ *   `{url}/{file}` into `{modelDir}/{file}`. If omitted, it probes the
+ *   HuggingFace API (slower).
+ * - Single-file formats (no `isDirectory`, e.g. OpenVINO IR): sibling
+ *   files fetched from the SAME remote directory as `url` and stored flat
+ *   alongside the main file — e.g. `['camstack-yolov9t.bin']` for the IR
+ *   weights next to `camstack-yolov9t.xml`.
+ */
+export declare const ModelFormatEntrySchema: z.ZodObject<{
+    url: z.ZodString;
+    sizeMB: z.ZodNumber;
+    isDirectory: z.ZodOptional<z.ZodBoolean>;
+    files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+    runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+        node: "node";
+        python: "python";
+    }>>>>;
+}, z.core.$strip>;
+export type ModelFormatEntry = z.infer<typeof ModelFormatEntrySchema>;
 /**
  * Extra file that must be downloaded alongside the model (e.g., labels JSON, dict.txt).
  * The downloader fetches from `url` and saves to `{modelsDir}/{filename}`.
  */
-export interface ModelExtraFile {
-    readonly url: string;
-    readonly filename: string;
-    readonly sizeMB: number;
-}
-export interface ModelCatalogEntry {
-    readonly id: string;
-    readonly name: string;
-    readonly description: string;
-    readonly formats: Partial<Readonly<Record<ModelFormat, ModelFormatEntry>>>;
-    readonly inputSize: {
-        readonly width: number;
-        readonly height: number;
-    };
-    readonly labels: readonly LabelDefinition[];
-    readonly inputLayout?: 'nchw' | 'nhwc';
-    readonly inputNormalization?: 'zero-one' | 'imagenet' | 'none';
-    readonly preprocessMode?: 'letterbox' | 'resize';
-    /**
-     * When true, the executor produces a landmark-aligned crop (similarity warp
-     * onto the canonical template) before this step runs, instead of a plain
-     * axis-aligned bbox crop. Required for face-recognition embedders (ArcFace):
-     * their embeddings are only discriminative on an aligned input. The face
-     * detector that produced the parent detail must emit 5 landmarks.
-     */
-    readonly faceAlignment?: boolean;
-    /**
-     * Auxiliary files required at runtime (labels JSON, charset dict, etc.).
-     * Downloaded into the same modelsDir alongside the model file.
-     */
-    readonly extraFiles?: readonly ModelExtraFile[];
-}
+export declare const ModelExtraFileSchema: z.ZodObject<{
+    url: z.ZodString;
+    filename: z.ZodString;
+    sizeMB: z.ZodNumber;
+}, z.core.$strip>;
+export type ModelExtraFile = z.infer<typeof ModelExtraFileSchema>;
+/**
+ * Per-format payload map. Modelled as an explicit object (one optional key
+ * per `ModelFormat`) rather than `z.record(enum, …)` — zod v4's enum-keyed
+ * record requires every key, but a catalog entry only ships a subset of
+ * formats.
+ */
+export declare const ModelFormatsSchema: z.ZodObject<{
+    onnx: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        sizeMB: z.ZodNumber;
+        isDirectory: z.ZodOptional<z.ZodBoolean>;
+        files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+        runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            node: "node";
+            python: "python";
+        }>>>>;
+    }, z.core.$strip>>;
+    coreml: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        sizeMB: z.ZodNumber;
+        isDirectory: z.ZodOptional<z.ZodBoolean>;
+        files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+        runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            node: "node";
+            python: "python";
+        }>>>>;
+    }, z.core.$strip>>;
+    openvino: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        sizeMB: z.ZodNumber;
+        isDirectory: z.ZodOptional<z.ZodBoolean>;
+        files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+        runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            node: "node";
+            python: "python";
+        }>>>>;
+    }, z.core.$strip>>;
+    tflite: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        sizeMB: z.ZodNumber;
+        isDirectory: z.ZodOptional<z.ZodBoolean>;
+        files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+        runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            node: "node";
+            python: "python";
+        }>>>>;
+    }, z.core.$strip>>;
+    pt: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        sizeMB: z.ZodNumber;
+        isDirectory: z.ZodOptional<z.ZodBoolean>;
+        files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+        runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+            node: "node";
+            python: "python";
+        }>>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ModelCatalogEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    formats: z.ZodObject<{
+        onnx: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            sizeMB: z.ZodNumber;
+            isDirectory: z.ZodOptional<z.ZodBoolean>;
+            files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+            runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                node: "node";
+                python: "python";
+            }>>>>;
+        }, z.core.$strip>>;
+        coreml: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            sizeMB: z.ZodNumber;
+            isDirectory: z.ZodOptional<z.ZodBoolean>;
+            files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+            runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                node: "node";
+                python: "python";
+            }>>>>;
+        }, z.core.$strip>>;
+        openvino: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            sizeMB: z.ZodNumber;
+            isDirectory: z.ZodOptional<z.ZodBoolean>;
+            files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+            runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                node: "node";
+                python: "python";
+            }>>>>;
+        }, z.core.$strip>>;
+        tflite: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            sizeMB: z.ZodNumber;
+            isDirectory: z.ZodOptional<z.ZodBoolean>;
+            files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+            runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                node: "node";
+                python: "python";
+            }>>>>;
+        }, z.core.$strip>>;
+        pt: z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            sizeMB: z.ZodNumber;
+            isDirectory: z.ZodOptional<z.ZodBoolean>;
+            files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+            runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                node: "node";
+                python: "python";
+            }>>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    inputSize: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>;
+    labels: z.ZodReadonly<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        category: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inputLayout: z.ZodOptional<z.ZodEnum<{
+        nchw: "nchw";
+        nhwc: "nhwc";
+    }>>;
+    inputNormalization: z.ZodOptional<z.ZodEnum<{
+        "zero-one": "zero-one";
+        imagenet: "imagenet";
+        none: "none";
+    }>>;
+    preprocessMode: z.ZodOptional<z.ZodEnum<{
+        letterbox: "letterbox";
+        resize: "resize";
+    }>>;
+    faceAlignment: z.ZodOptional<z.ZodBoolean>;
+    extraFiles: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodObject<{
+        url: z.ZodString;
+        filename: z.ZodString;
+        sizeMB: z.ZodNumber;
+    }, z.core.$strip>>>>;
+}, z.core.$strip>;
+export type ModelCatalogEntry = z.infer<typeof ModelCatalogEntrySchema>;
 export interface DetectionModel {
     readonly id: string;
     readonly name: string;
@@ -86,3 +216,174 @@ export interface CustomModelMetadata {
     readonly inputNormalization?: 'zero-one' | 'imagenet' | 'none';
     readonly outputFormat: ModelOutputFormat;
 }
+export declare const ConvertTargetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    format: z.ZodLiteral<"openvino">;
+    precisions: z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+        fp16: "fp16";
+        int8: "int8";
+    }>>>;
+}, z.core.$strip>, z.ZodObject<{
+    format: z.ZodLiteral<"coreml">;
+}, z.core.$strip>], "format">;
+export type ConvertTarget = z.infer<typeof ConvertTargetSchema>;
+export declare const ModelConvertMetadataSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    labels: z.ZodReadonly<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        category: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inputSize: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>;
+    inputLayout: z.ZodOptional<z.ZodEnum<{
+        nchw: "nchw";
+        nhwc: "nhwc";
+    }>>;
+    inputNormalization: z.ZodOptional<z.ZodEnum<{
+        "zero-one": "zero-one";
+        imagenet: "imagenet";
+        none: "none";
+    }>>;
+    preprocessMode: z.ZodOptional<z.ZodEnum<{
+        letterbox: "letterbox";
+        resize: "resize";
+    }>>;
+    outputFormat: z.ZodEnum<{
+        yolo: "yolo";
+        ssd: "ssd";
+        embedding: "embedding";
+        classification: "classification";
+        ocr: "ocr";
+        segmentation: "segmentation";
+    }>;
+    faceAlignment: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ModelConvertMetadata = z.infer<typeof ModelConvertMetadataSchema>;
+export declare const ConvertArtifactSchema: z.ZodObject<{
+    format: z.ZodEnum<{
+        onnx: "onnx";
+        coreml: "coreml";
+        openvino: "openvino";
+        tflite: "tflite";
+        pt: "pt";
+    }>;
+    precision: z.ZodOptional<z.ZodEnum<{
+        fp16: "fp16";
+        int8: "int8";
+    }>>;
+    sizeMB: z.ZodNumber;
+    validated: z.ZodBoolean;
+    files: z.ZodReadonly<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type ConvertArtifact = z.infer<typeof ConvertArtifactSchema>;
+export declare const ConvertResultSchema: z.ZodObject<{
+    entry: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodString;
+        formats: z.ZodObject<{
+            onnx: z.ZodOptional<z.ZodObject<{
+                url: z.ZodString;
+                sizeMB: z.ZodNumber;
+                isDirectory: z.ZodOptional<z.ZodBoolean>;
+                files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+                runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                    node: "node";
+                    python: "python";
+                }>>>>;
+            }, z.core.$strip>>;
+            coreml: z.ZodOptional<z.ZodObject<{
+                url: z.ZodString;
+                sizeMB: z.ZodNumber;
+                isDirectory: z.ZodOptional<z.ZodBoolean>;
+                files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+                runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                    node: "node";
+                    python: "python";
+                }>>>>;
+            }, z.core.$strip>>;
+            openvino: z.ZodOptional<z.ZodObject<{
+                url: z.ZodString;
+                sizeMB: z.ZodNumber;
+                isDirectory: z.ZodOptional<z.ZodBoolean>;
+                files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+                runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                    node: "node";
+                    python: "python";
+                }>>>>;
+            }, z.core.$strip>>;
+            tflite: z.ZodOptional<z.ZodObject<{
+                url: z.ZodString;
+                sizeMB: z.ZodNumber;
+                isDirectory: z.ZodOptional<z.ZodBoolean>;
+                files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+                runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                    node: "node";
+                    python: "python";
+                }>>>>;
+            }, z.core.$strip>>;
+            pt: z.ZodOptional<z.ZodObject<{
+                url: z.ZodString;
+                sizeMB: z.ZodNumber;
+                isDirectory: z.ZodOptional<z.ZodBoolean>;
+                files: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
+                runtimes: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodEnum<{
+                    node: "node";
+                    python: "python";
+                }>>>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        inputSize: z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>;
+        labels: z.ZodReadonly<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            category: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        inputLayout: z.ZodOptional<z.ZodEnum<{
+            nchw: "nchw";
+            nhwc: "nhwc";
+        }>>;
+        inputNormalization: z.ZodOptional<z.ZodEnum<{
+            "zero-one": "zero-one";
+            imagenet: "imagenet";
+            none: "none";
+        }>>;
+        preprocessMode: z.ZodOptional<z.ZodEnum<{
+            letterbox: "letterbox";
+            resize: "resize";
+        }>>;
+        faceAlignment: z.ZodOptional<z.ZodBoolean>;
+        extraFiles: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodObject<{
+            url: z.ZodString;
+            filename: z.ZodString;
+            sizeMB: z.ZodNumber;
+        }, z.core.$strip>>>>;
+    }, z.core.$strip>;
+    artifacts: z.ZodReadonly<z.ZodArray<z.ZodObject<{
+        format: z.ZodEnum<{
+            onnx: "onnx";
+            coreml: "coreml";
+            openvino: "openvino";
+            tflite: "tflite";
+            pt: "pt";
+        }>;
+        precision: z.ZodOptional<z.ZodEnum<{
+            fp16: "fp16";
+            int8: "int8";
+        }>>;
+        sizeMB: z.ZodNumber;
+        validated: z.ZodBoolean;
+        files: z.ZodReadonly<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type ConvertResult = z.infer<typeof ConvertResultSchema>;

package/dist/types/pipeline-step.d.ts

@@ -136,6 +136,8 @@ export interface MaskOutput {
     readonly mask: string;
     readonly maskWidth: number;
     readonly maskHeight: number;
+    /** Largest-connected-component bbox in mask-pixel space [x, y, w, h]. */
+    readonly maskBbox?: readonly [number, number, number, number];
 }
 /** Discriminated union for step output — use switch(output.kind) */
 export type StepOutput = DetectionsOutput | ClassificationsOutput | EmbeddingOutput | TextOutput | MaskOutput;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/types",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "description": "Shared types, interfaces, and model catalogs for the CamStack detection ecosystem",
   "keywords": [
     "camstack",