@norskvideo/ctl-product-template-schema 0.1.32 → 0.1.34

package/index.d.ts

@@ -59,6 +59,10 @@ export declare const ProductTemplateHostTlsSchema: z.ZodObject<{
     services: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
 export type ProductTemplateHostTls = z.infer<typeof ProductTemplateHostTlsSchema>;
+export declare const ProductTemplateWorkdirSchema: z.ZodObject<{
+    services: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type ProductTemplateWorkdir = z.infer<typeof ProductTemplateWorkdirSchema>;
 export declare const ProductTemplateAcceleratorSchema: z.ZodEnum<{
     none: "none";
     nvidia: "nvidia";
@@ -146,6 +150,16 @@ export declare const ProductTemplateMigrationSchema: z.ZodObject<{
     }>;
 }, z.core.$strip>;
 export type ProductTemplateMigration = z.infer<typeof ProductTemplateMigrationSchema>;
+export declare const PRODUCT_TEMPLATE_WORKLOAD_ROLES: readonly ["viewer", "operator", "builder"];
+export declare const ProductTemplateWorkloadSchema: z.ZodObject<{
+    role: z.ZodEnum<{
+        viewer: "viewer";
+        operator: "operator";
+        builder: "builder";
+    }>;
+    on: z.ZodLiteral<"product">;
+}, z.core.$strip>;
+export type ProductTemplateWorkload = z.infer<typeof ProductTemplateWorkloadSchema>;
 export declare const ProductTemplateManifestSchema: z.ZodObject<{
     productTemplateSchemaVersion: z.ZodLiteral<1>;
     productName: z.ZodString;
@@ -320,9 +334,20 @@ export declare const ProductTemplateManifestSchema: z.ZodObject<{
             configPath: z.ZodString;
         }, z.core.$strict>]>>;
     }, z.core.$strict>>>;
+    workdir: z.ZodOptional<z.ZodObject<{
+        services: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
     hostTls: z.ZodOptional<z.ZodObject<{
         services: z.ZodArray<z.ZodString>;
     }, z.core.$strip>>;
+    workload: z.ZodOptional<z.ZodObject<{
+        role: z.ZodEnum<{
+            viewer: "viewer";
+            operator: "operator";
+            builder: "builder";
+        }>;
+        on: z.ZodLiteral<"product">;
+    }, z.core.$strip>>;
     migration: z.ZodOptional<z.ZodObject<{
         strategy: z.ZodEnum<{
             overlap: "overlap";
@@ -558,9 +583,20 @@ export declare const ProductTemplateMaterialsSchema: z.ZodObject<{
                 configPath: z.ZodString;
             }, z.core.$strict>]>>;
         }, z.core.$strict>>>;
+        workdir: z.ZodOptional<z.ZodObject<{
+            services: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
         hostTls: z.ZodOptional<z.ZodObject<{
             services: z.ZodArray<z.ZodString>;
         }, z.core.$strip>>;
+        workload: z.ZodOptional<z.ZodObject<{
+            role: z.ZodEnum<{
+                viewer: "viewer";
+                operator: "operator";
+                builder: "builder";
+            }>;
+            on: z.ZodLiteral<"product">;
+        }, z.core.$strip>>;
         migration: z.ZodOptional<z.ZodObject<{
             strategy: z.ZodEnum<{
                 overlap: "overlap";

package/index.js

@@ -204,6 +204,21 @@ export const ProductTemplateHostTlsSchema = z
     }),
 })
     .meta({ id: "ProductTemplateHostTls", outputId: "ProductTemplateHostTls" });
+// The instance working directory, handed to a product's own services. WHY THIS
+// EXISTS: it is the one per-instance store that survives a relaunch (a named
+// volume does not: relaunch tears down with `down -v`), and the runner mounts
+// it at /data only into media and studio. A product whose own service keeps
+// state -- a relay's state file and site key -- or writes files the engine must
+// read (assets, recordings) needs the same directory at the same path. A
+// product relying on it declares the runner capability `service-workdir`,
+// since an older runner would ignore the field and lose the state.
+export const ProductTemplateWorkdirSchema = z
+    .object({
+    services: z.array(z.string().min(1)).min(1).meta({
+        description: "Compose services that get the instance working directory, read-write at /data -- the same directory, at the same path, that media and studio have -- with NORSK_WORKDIR=/data. Each must be a service in the template's own compose.yml. It survives relaunch, restart and runner upgrade; only `instance delete --purge` removes it.",
+    }),
+})
+    .meta({ id: "ProductTemplateWorkdir", outputId: "ProductTemplateWorkdir" });
 // Placement requirements guidance (requirements-authoring.md). Each dimension
 // the placer reasons over — capacity (vCPUs), cores, GPU, capabilities, host
 // ports — is optionally declared with a `mode`:
@@ -304,6 +319,16 @@ export const ProductTemplateMigrationSchema = z
     }),
 })
     .meta({ id: "ProductTemplateMigration", outputId: "ProductTemplateMigration" });
+// The roles a template may declare for its instances' workload: at most
+// builder, since registering a template takes builder and that registration is
+// the consent. Built-in names only, whose meaning every host agrees on.
+export const PRODUCT_TEMPLATE_WORKLOAD_ROLES = ["viewer", "operator", "builder"];
+export const ProductTemplateWorkloadSchema = z
+    .object({
+    role: z.enum(PRODUCT_TEMPLATE_WORKLOAD_ROLES),
+    on: z.literal("product"),
+})
+    .meta({ id: "ProductTemplateWorkload", outputId: "ProductTemplateWorkload" });
 export const ProductTemplateManifestSchema = z
     .object({
     productTemplateSchemaVersion: z.literal(1),
@@ -350,9 +375,15 @@ export const ProductTemplateManifestSchema = z
         description: "Host-port bindings whose value rides a product-template parameter. Opt-in per launch via the param value: absent = closed, 'auto' = allocate a free port from `preferred`, number = use it. When opened the port is published as a managed host binding and surfaced to the containers via compose interpolation. Alongside the per-param scalars the runner sets NORSK_ALLOCATED_PORTS: a JSON object keyed by param, each value {port, protocol, service?}, describing every opened port ('{}' when none opted in; unset when nothing is declared) — so a product needing the allocation as data maps one var instead of folding scalars into JSON via interpolation.",
     }),
     logs: ProductTemplateLogsSchema.optional(),
+    workdir: ProductTemplateWorkdirSchema.optional().meta({
+        description: "Mount the instance working directory at /data into the named compose services, as media and studio always have it -- for a product's own service that keeps state across relaunch or shares files with the engine. Absent = not mounted. Declare the runner capability `service-workdir` alongside it.",
+    }),
     hostTls: ProductTemplateHostTlsSchema.optional().meta({
         description: "Mount the host's TLS certificate and key, read-only, into the named compose services — for a product that serves TLS itself. Copied per launch, so a rotated certificate is picked up on relaunch. Absent = nothing mounted.",
     }),
+    workload: ProductTemplateWorkloadSchema.optional().meta({
+        description: "The role each instance's own workload (`urn:norsk:workload:instance:<id>`) holds on its product (`product/<productName>`), granted when it launches, whoever launches it — for an instance that creates or manages its product's other instances (a capture launching recorders). At most `builder`: registering a template takes builder, and that registration is the consent. Absent = the workload holds nothing it was not passed at launch. An older ctl ignores it, and its instances hold nothing.",
+    }),
     migration: ProductTemplateMigrationSchema.optional().meta({
         description: "How a running instance may be moved between nodes. `strategy` is the strongest promise the product keeps: `overlap` (target started, then source stopped — both may produce briefly), `stopThenStart` (the default when absent — target prepared but not started, source stopped, target started), or `handover` (the job speaks the worker's migration socket and hands over at an exact position). A migrate request may down-grade to a safer strategy but never up-grade past the declaration. Only the manager reads this; the worker never does.",
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-product-template-schema",
-  "version": "0.1.32",
+  "version": "0.1.34",
   "type": "module",
   "exports": {
     ".": {