@norskvideo/ctl-sdk 0.1.57 → 0.1.58

package/fleet.d.ts

@@ -109,6 +109,16 @@ export interface FleetOptions {
     WebSocket?: new (url: string) => WebSocketLike;
     /** The page's origin, for a live operation's ws(s) URL; the page's own by default. */
     origin?: string;
+    /** The page's path, which says which instance it is (RFC 0008); its own by default. */
+    path?: string;
+}
+/** The dashboard instance a page is, and how it is configured (RFC 0008). */
+export interface FleetInstance {
+    name: string;
+    displayName: string;
+    /** `<product>/<name>`, for an instance of a product's definition. */
+    definition?: string;
+    parameters: Record<string, string>;
 }
 export interface Fleet {
     query(selection: FleetSelection): Promise<FleetDirectory>;
@@ -117,6 +127,8 @@ export interface Fleet {
     call<T = unknown>(runtimeId: string, operationId: string, input?: FleetCallInput): Promise<T>;
     /** Open a runtime's declared live operation. */
     live(runtimeId: string, operationId: string, handlers: FleetLiveHandlers, input?: FleetCallInput): Promise<FleetLive>;
+    /** Which instance this page is, and its parameters. */
+    instance(): Promise<FleetInstance>;
     state: {
         get<T = unknown>(key: string): Promise<FleetStateDocument<T> | undefined>;
         /** Write at `revision` (omit for a new key); a FleetStateConflict when

package/fleet.js

@@ -94,6 +94,13 @@ export function fleetClient(options = {}) {
             socket.addEventListener("close", () => handlers.onClose?.());
             return { send: (data) => socket.send(data), close: () => socket.close() };
         },
+        async instance() {
+            const path = options.path ?? globalThis.location?.pathname ?? "/";
+            const res = await doFetch(`${base}/instance?path=${encodeURIComponent(path)}`, { credentials: "same-origin" });
+            if (!res.ok)
+                throw new Error(`the dashboard instance answered ${res.status}`);
+            return (await res.json());
+        },
         state: {
             async get(key) {
                 const res = await doFetch(`${base}/state/${encodeURIComponent(key)}`, { credentials: "same-origin" });

package/manifest-schema.d.ts

@@ -9,7 +9,7 @@ declare const DefaultProductTemplateSchema: z.ZodObject<{
     url: z.ZodString;
 }, z.core.$strip>;
 export type DefaultProductTemplate = z.infer<typeof DefaultProductTemplateSchema>;
-declare const DefaultDashboardSchema: z.ZodObject<{
+export declare const DefaultDashboardSchema: z.ZodObject<{
     name: z.ZodString;
     displayName: z.ZodOptional<z.ZodString>;
     url: z.ZodString;
@@ -30,6 +30,16 @@ declare const DefaultDashboardSchema: z.ZodObject<{
             label: z.ZodString;
         }, z.core.$strip>], "kind">;
     }, z.core.$strip>], "mode">>;
+    instances: z.ZodOptional<z.ZodEnum<{
+        single: "single";
+        many: "many";
+    }>>;
+    parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        purpose: z.ZodString;
+        default: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type DefaultDashboard = z.infer<typeof DefaultDashboardSchema>;
 /** One product role (RFC 0003 D5a). The name rule is foundation's, so the
@@ -246,6 +256,16 @@ export declare const ManifestSchema: z.ZodObject<{
                 label: z.ZodString;
             }, z.core.$strip>], "kind">;
         }, z.core.$strip>], "mode">>;
+        instances: z.ZodOptional<z.ZodEnum<{
+            single: "single";
+            many: "many";
+        }>>;
+        parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            purpose: z.ZodString;
+            default: z.ZodOptional<z.ZodString>;
+            required: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>>;
     export: z.ZodOptional<z.ZodObject<{
         include: z.ZodDefault<z.ZodArray<z.ZodString>>;

package/manifest-schema.js

@@ -90,7 +90,7 @@ const DefaultProductTemplateSchema = z.object({
 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({
+export 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
@@ -113,6 +113,19 @@ const DefaultDashboardSchema = z.object({
     ])
         .optional()
         .meta({ description: "The hosting proposed; absent is a host of its own." }),
+    // RFC 0008: the entry is a definition, of one instance or many.
+    instances: z.enum(["single", "many"]).optional().meta({
+        description: "single (the default): one instance, made when the product is added. many: none until an operator makes them, each with its own parameters and host.",
+    }),
+    parameters: z
+        .array(z.object({
+        name: z.string().regex(/^[A-Z][A-Z0-9_]*$/, "upper-case letters, digits and underscores"),
+        purpose: z.string().min(1),
+        default: z.string().optional(),
+        required: z.boolean().optional(),
+    }))
+        .optional()
+        .meta({ description: "What each instance is asked for when it is made; the page reads its answers." }),
 });
 /** 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

package/package.json

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