@norskvideo/ctl-sdk 0.1.51 → 0.1.53

package/fleet.d.ts

@@ -0,0 +1,76 @@
+export interface FleetEndpoint {
+    transport: string;
+    address: string;
+    params: Record<string, string>;
+}
+/** What norsk-discovery holds. */
+export interface FleetResource {
+    name: string;
+    kind: string;
+    labels: Record<string, string>;
+    endpoints: FleetEndpoint[];
+}
+/** A runtime as the platform knows it: under norsk-mgr its job id,
+ *  production, replica and job name; under norsk-ctl alone its instance id
+ *  and product. */
+export interface FleetRuntime {
+    id: string;
+    namespace: string;
+    [field: string]: unknown;
+}
+export interface FleetItem {
+    runtime: FleetRuntime;
+    /** The platform's own registration of the runtime (`norsk.runtime`), with
+     *  its `norsk.state`. */
+    presence?: FleetResource;
+    entries: FleetResource[];
+}
+export interface FleetDirectory {
+    items: FleetItem[];
+    /** Whether discovery's replay has landed: before it, entries are partial. */
+    synced: boolean;
+}
+export interface FleetSelection {
+    /** The kinds to read, as literals. `norsk.runtime` lists runtimes by their
+     *  own registration. */
+    kind: string | readonly string[];
+    /** Every one present on an entry, with the same value. */
+    labels?: Readonly<Record<string, string>>;
+}
+export interface FleetWatchHandlers {
+    /** The whole current set, after the snapshot and after every change. */
+    onChange?: (items: FleetItem[]) => void;
+    onSynced?: (synced: boolean) => void;
+    /** The stream failed; the browser retries it. */
+    onError?: () => void;
+}
+export interface FleetWatch {
+    current(): FleetItem[];
+    synced(): boolean;
+    close(): void;
+}
+interface EventSourceLike {
+    addEventListener(name: string, listener: (e: {
+        data: string;
+    }) => void): void;
+    close(): void;
+}
+export interface FleetOptions {
+    /** Where the directory is: `/_fleet` on a dashboard host (the default),
+     *  `/api/v1/fleet` on the platform's own origin. */
+    base?: string;
+    fetch?: (url: string, init?: {
+        credentials?: "same-origin";
+    }) => Promise<Response>;
+    EventSource?: new (url: string, init?: {
+        withCredentials?: boolean;
+    }) => EventSourceLike;
+}
+export interface Fleet {
+    query(selection: FleetSelection): Promise<FleetDirectory>;
+    watch(selection: FleetSelection, handlers?: FleetWatchHandlers): FleetWatch;
+}
+export declare function fleetClient(options?: FleetOptions): Fleet;
+/** The directory on the page's own origin, as a dashboard host serves it. */
+export declare const fleet: Fleet;
+export {};

package/fleet.js

@@ -0,0 +1,70 @@
+// The directory, for a dashboard (RFC 0006 §4.5, task 122 K): the runtimes
+// the signed-in user may see, each with what discovery holds under it, read
+// from the page's own origin and filtered by the platform, never by the
+// dashboard.
+//
+// On a dashboard host the directory is `/_fleet/`; in a product's own UI or a
+// dashboard's dev loop it is the platform's API, `/api/v1/fleet/`. The calls
+// are the same either way.
+//
+// Name the kinds a call reads with literals: ctl-dev-kit's dashboard build
+// derives the registration's `uses` from them, and refuses one it cannot read.
+//
+// Browser-only, with no imports, so a dashboard's bundle carries nothing else.
+function queryString(selection) {
+    const kinds = typeof selection.kind === "string" ? [selection.kind] : [...selection.kind];
+    const params = new URLSearchParams({ kinds: kinds.join(",") });
+    const labels = Object.entries(selection.labels ?? {}).map(([k, v]) => `${k}=${v}`);
+    if (labels.length > 0)
+        params.set("labels", labels.join(","));
+    return params.toString();
+}
+export function fleetClient(options = {}) {
+    const base = (options.base ?? "/_fleet").replace(/\/+$/, "");
+    return {
+        async query(selection) {
+            const doFetch = options.fetch ?? ((url, init) => globalThis.fetch(url, init));
+            const res = await doFetch(`${base}/directory?${queryString(selection)}`, { credentials: "same-origin" });
+            if (!res.ok)
+                throw new Error(`the directory answered ${res.status}`);
+            return (await res.json());
+        },
+        watch(selection, handlers = {}) {
+            const Source = options.EventSource ?? globalThis.EventSource;
+            if (Source === undefined)
+                throw new Error("this environment has no EventSource");
+            const items = new Map();
+            let isSynced = false;
+            const source = new Source(`${base}/directory/watch?${queryString(selection)}`, { withCredentials: true });
+            const changed = () => handlers.onChange?.([...items.values()]);
+            const on = (name, apply) => source.addEventListener(name, (e) => apply(JSON.parse(e.data)));
+            on("snapshot", (data) => {
+                items.clear();
+                for (const item of data.items)
+                    items.set(item.runtime.id, item);
+                isSynced = data.synced;
+                changed();
+            });
+            on("upsert", (item) => {
+                items.set(item.runtime.id, item);
+                changed();
+            });
+            on("remove", (data) => {
+                items.delete(data.id);
+                changed();
+            });
+            on("synced", (data) => {
+                isSynced = data.synced;
+                handlers.onSynced?.(isSynced);
+            });
+            source.addEventListener("error", () => handlers.onError?.());
+            return {
+                current: () => [...items.values()],
+                synced: () => isSynced,
+                close: () => source.close(),
+            };
+        },
+    };
+}
+/** The directory on the page's own origin, as a dashboard host serves it. */
+export const fleet = fleetClient();

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.51",
+  "version": "0.1.53",
   "type": "module",
   "exports": {
     ".": {
@@ -15,6 +15,10 @@
       "types": "./components/index.d.ts",
       "default": "./components/index.js"
     },
+    "./fleet": {
+      "types": "./fleet.d.ts",
+      "default": "./fleet.js"
+    },
     "./frontend-spec": {
       "types": "./frontend-spec.d.ts",
       "default": "./frontend-spec.js"