@norskvideo/ctl-sdk 0.1.52 → 0.1.53

package/manifest-schema.d.ts

@@ -9,6 +9,29 @@ declare const DefaultProductTemplateSchema: z.ZodObject<{
     url: z.ZodString;
 }, z.core.$strip>;
 export type DefaultProductTemplate = z.infer<typeof DefaultProductTemplateSchema>;
+declare const DefaultDashboardSchema: z.ZodObject<{
+    name: z.ZodString;
+    displayName: z.ZodOptional<z.ZodString>;
+    url: z.ZodString;
+    hosting: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"own">;
+    }, z.core.$strip>, z.ZodObject<{
+        mode: z.ZodLiteral<"shared">;
+        group: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        mode: z.ZodLiteral<"pattern">;
+        pattern: z.ZodString;
+        scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"production">;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"production-template">;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"label">;
+            label: z.ZodString;
+        }, z.core.$strip>], "kind">;
+    }, z.core.$strip>], "mode">>;
+}, z.core.$strip>;
+export type DefaultDashboard = z.infer<typeof DefaultDashboardSchema>;
 /** One product role (RFC 0003 D5a). The name rule is foundation's, so the
  *  runner that stamps it and the manifest that declares it cannot disagree. */
 declare const ProductRoleSchema: z.ZodObject<{
@@ -202,6 +225,28 @@ export declare const ManifestSchema: z.ZodObject<{
         name: z.ZodString;
         url: z.ZodString;
     }, z.core.$strip>>>;
+    defaultDashboards: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+        url: z.ZodString;
+        hosting: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"own">;
+        }, z.core.$strip>, z.ZodObject<{
+            mode: z.ZodLiteral<"shared">;
+            group: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            mode: z.ZodLiteral<"pattern">;
+            pattern: z.ZodString;
+            scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"production">;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"production-template">;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"label">;
+                label: z.ZodString;
+            }, z.core.$strip>], "kind">;
+        }, z.core.$strip>], "mode">>;
+    }, z.core.$strip>>>;
     export: z.ZodOptional<z.ZodObject<{
         include: z.ZodDefault<z.ZodArray<z.ZodString>>;
         exclude: z.ZodDefault<z.ZodArray<z.ZodString>>;

package/manifest-schema.js

@@ -82,6 +82,38 @@ const DefaultProductTemplateSchema = z.object({
         description: "Path on the product's HTTP surface that returns the product-template tar. Resolved against the product's base URL — relative paths only (no scheme/host).",
     }),
 });
+/** A fleet dashboard the product brings (norsk-ctl task 123, RFC 0006): a
+ *  static bundle its control plane serves, registered with norsk-mgr when the
+ *  product is added and replaced in place on every reload. The hosting is a
+ *  proposal: the operator's choice, once made, is kept. norsk-ctl serving
+ *  alone hosts no dashboards and ignores these. */
+const DashboardLabel = z
+    .string()
+    .regex(/^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$/, "one DNS label: lowercase letters, digits and hyphens, 1-63 chars");
+const DefaultDashboardSchema = z.object({
+    name: DashboardLabel.meta({ description: "The dashboard's name, and its host's label when it has one of its own." }),
+    displayName: z.string().min(1).optional(),
+    url: z
+        .string()
+        .regex(/^\/[^/]/, "a path on the product's own HTTP surface")
+        .meta({ description: "Path on the product's HTTP surface that returns the dashboard's bundle tar." }),
+    hosting: z
+        .discriminatedUnion("mode", [
+        z.object({ mode: z.literal("own") }),
+        z.object({ mode: z.literal("shared"), group: DashboardLabel }),
+        z.object({
+            mode: z.literal("pattern"),
+            pattern: z.string().min(1),
+            scope: z.discriminatedUnion("kind", [
+                z.object({ kind: z.literal("production") }),
+                z.object({ kind: z.literal("production-template") }),
+                z.object({ kind: z.literal("label"), label: z.string().min(1) }),
+            ]),
+        }),
+    ])
+        .optional()
+        .meta({ description: "The hosting proposed; absent is a host of its own." }),
+});
 /** Save-as-product-template file selection. When the runner exports a running
  *  instance's working directory into a new product template, it packs only files
  *  matching `include` and not matching `exclude` (glob patterns, relative to the
@@ -178,5 +210,8 @@ export const ManifestSchema = z.object({
     defaultProductTemplates: z.array(DefaultProductTemplateSchema).default([]).meta({
         description: "Product templates the runner auto-fetches at product-registration time. Each entry is GET'd against the product's base URL and stored under its `name` via the runner's product-template store. Lets a product offer 'zero-config' launch paths — operators add the product and immediately have a launchable product template without visiting configure.",
     }),
+    defaultDashboards: z.array(DefaultDashboardSchema).default([]).meta({
+        description: "Fleet dashboards the product brings: norsk-mgr fetches each bundle from the product at registration and on every reload, registers it as the product's, and removes it with the product. norsk-ctl serving alone ignores them.",
+    }),
     export: ExportSchema.optional(),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-sdk",
-  "version": "0.1.52",
+  "version": "0.1.53",
   "type": "module",
   "exports": {
     ".": {