@fnndsc/menu 0.3.1 → 0.4.0

package/dist/pacs.js.map

@@ -1 +1 @@
-{"version":3,"file":"pacs.js","sourceRoot":"","sources":["../src/pacs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,uCAAuC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,sEAAsE;IACtE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,4EAA4E;IAC5E,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,6CAA6C;IAC7C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH,sCAAsC;AACtC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,4EAA4E;IAC5E,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CAClC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;CAClC,CAAC,CAAC;AAMH,iCAAiC;AACjC,MAAM,CAAC,MAAM,qBAAqB,GAAG,YAAqB,CAAC"}
+{"version":3,"file":"pacs.js","sourceRoot":"","sources":["../src/pacs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,uCAAuC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,sEAAsE;IACtE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,4EAA4E;IAC5E,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,6CAA6C;IAC7C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH,sCAAsC;AACtC,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,4EAA4E;IAC5E,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CAClC,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,2EAA2E;IAC3E,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB;;;;;;;OAOG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAGH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAU,CAAC;AAE3E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAEtF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,iEAAiE;IACjE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,gEAAgE;IAChE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,uBAAuB;IAC/B,sEAAsE;IACtE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,0DAA0D;IAC1D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B;;;;OAIG;IACH,UAAU,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC3C;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IACjC;;;;OAIG;IACH,UAAU,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC3C;;;;;;OAMG;IACH,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAUH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,kEAAkE;IAClE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;CACpB,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACnC,CAAC,CAAC;AAKH,yCAAyC;AACzC,MAAM,CAAC,MAAM,uBAAuB,GAAG,cAAuB,CAAC;AAE/D,iCAAiC;AACjC,MAAM,CAAC,MAAM,qBAAqB,GAAG,YAAqB,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,142 @@
+/**
+ * @file The plugin vocabulary: a registered plugin as a typed envelope payload.
+ *
+ * A plugin is the one-node case of the compute graph — everything a pipeline
+ * node is, without the pipeline around it. Its substance reached surfaces as
+ * a rendered manual for as long as `cat /bin/<plugin>` was the only way to
+ * ask, which meant nothing downstream could do anything with it: not a card,
+ * not a parameter list, not a form, not an export. This model is that same
+ * substance as data; the manual becomes one projection of it.
+ *
+ * Parameters are the payload that matters. They arrive complete or the model
+ * is wrong: a parameter list that quietly stops at a page boundary is worse
+ * than the paragraph it replaces, because a paragraph does not look
+ * authoritative.
+ *
+ * @module
+ */
+import { z } from 'zod';
+/**
+ * One declared parameter of a plugin.
+ *
+ * `default` is `unknown` because CUBE serves whatever the plugin declared —
+ * a string, a number, a boolean, or null for "no default" — and a surface
+ * renders it rather than computing on it.
+ */
+export declare const pluginParameterSchema: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodString;
+    optional: z.ZodBoolean;
+    default: z.ZodOptional<z.ZodUnknown>;
+    help: z.ZodOptional<z.ZodString>;
+    /** The flag as it is typed: `--name`, or the bare name for a positional. */
+    flag: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name: string;
+    optional: boolean;
+    flag: string;
+    default?: unknown;
+    help?: string | undefined;
+}, {
+    type: string;
+    name: string;
+    optional: boolean;
+    flag: string;
+    default?: unknown;
+    help?: string | undefined;
+}>;
+/**
+ * The `plugin.info` model: one registered plugin, whole.
+ *
+ * Identity, the authoring facts, and every declared parameter. What a
+ * surface draws from it — a one-node graph, a parameter table, an argument
+ * form — is the surface's business; the model carries no layout and no
+ * rendering.
+ */
+export declare const pluginInfoModelSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodString;
+    version: z.ZodString;
+    /** `ds`, `fs`, or `ts` — what the node consumes and produces. */
+    type: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    authors: z.ZodOptional<z.ZodString>;
+    /** Where the plugin's source or docs live, when it declared them. */
+    documentation: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    /**
+     * Every declared parameter, in the order CUBE serves them.
+     *
+     * Complete, always: the builder drains the collection rather than asking
+     * for a page and calling it the answer.
+     */
+    parameters: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        optional: z.ZodBoolean;
+        default: z.ZodOptional<z.ZodUnknown>;
+        help: z.ZodOptional<z.ZodString>;
+        /** The flag as it is typed: `--name`, or the bare name for a positional. */
+        flag: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        optional: boolean;
+        flag: string;
+        default?: unknown;
+        help?: string | undefined;
+    }, {
+        type: string;
+        name: string;
+        optional: boolean;
+        flag: string;
+        default?: unknown;
+        help?: string | undefined;
+    }>, "many">;
+    /** The `/bin` entry that runs it, so a surface can lower a click to a command. */
+    command: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name: string;
+    version: string;
+    parameters: {
+        type: string;
+        name: string;
+        optional: boolean;
+        flag: string;
+        default?: unknown;
+        help?: string | undefined;
+    }[];
+    id?: number | undefined;
+    title?: string | undefined;
+    command?: string | undefined;
+    description?: string | undefined;
+    authors?: string | undefined;
+    documentation?: string | undefined;
+    category?: string | undefined;
+}, {
+    type: string;
+    name: string;
+    version: string;
+    parameters: {
+        type: string;
+        name: string;
+        optional: boolean;
+        flag: string;
+        default?: unknown;
+        help?: string | undefined;
+    }[];
+    id?: number | undefined;
+    title?: string | undefined;
+    command?: string | undefined;
+    description?: string | undefined;
+    authors?: string | undefined;
+    documentation?: string | undefined;
+    category?: string | undefined;
+}>;
+export type PluginParameter = z.infer<typeof pluginParameterSchema>;
+export type PluginInfoModel = z.infer<typeof pluginInfoModelSchema>;
+/** The model's envelope kind. */
+export declare const PLUGIN_INFO_MODEL_KIND: "plugin.info";

package/dist/plugin.js

@@ -0,0 +1,67 @@
+/**
+ * @file The plugin vocabulary: a registered plugin as a typed envelope payload.
+ *
+ * A plugin is the one-node case of the compute graph — everything a pipeline
+ * node is, without the pipeline around it. Its substance reached surfaces as
+ * a rendered manual for as long as `cat /bin/<plugin>` was the only way to
+ * ask, which meant nothing downstream could do anything with it: not a card,
+ * not a parameter list, not a form, not an export. This model is that same
+ * substance as data; the manual becomes one projection of it.
+ *
+ * Parameters are the payload that matters. They arrive complete or the model
+ * is wrong: a parameter list that quietly stops at a page boundary is worse
+ * than the paragraph it replaces, because a paragraph does not look
+ * authoritative.
+ *
+ * @module
+ */
+import { z } from 'zod';
+/**
+ * One declared parameter of a plugin.
+ *
+ * `default` is `unknown` because CUBE serves whatever the plugin declared —
+ * a string, a number, a boolean, or null for "no default" — and a surface
+ * renders it rather than computing on it.
+ */
+export const pluginParameterSchema = z.object({
+    name: z.string(),
+    type: z.string(),
+    optional: z.boolean(),
+    default: z.unknown().optional(),
+    help: z.string().optional(),
+    /** The flag as it is typed: `--name`, or the bare name for a positional. */
+    flag: z.string(),
+});
+/**
+ * The `plugin.info` model: one registered plugin, whole.
+ *
+ * Identity, the authoring facts, and every declared parameter. What a
+ * surface draws from it — a one-node graph, a parameter table, an argument
+ * form — is the surface's business; the model carries no layout and no
+ * rendering.
+ */
+export const pluginInfoModelSchema = z.object({
+    id: z.number().optional(),
+    name: z.string(),
+    version: z.string(),
+    /** `ds`, `fs`, or `ts` — what the node consumes and produces. */
+    type: z.string(),
+    title: z.string().optional(),
+    description: z.string().optional(),
+    authors: z.string().optional(),
+    /** Where the plugin's source or docs live, when it declared them. */
+    documentation: z.string().optional(),
+    category: z.string().optional(),
+    /**
+     * Every declared parameter, in the order CUBE serves them.
+     *
+     * Complete, always: the builder drains the collection rather than asking
+     * for a page and calling it the answer.
+     */
+    parameters: z.array(pluginParameterSchema),
+    /** The `/bin` entry that runs it, so a surface can lower a click to a command. */
+    command: z.string().optional(),
+});
+/** The model's envelope kind. */
+export const PLUGIN_INFO_MODEL_KIND = 'plugin.info';
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,4EAA4E;IAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,iEAAiE;IACjE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,qEAAqE;IACrE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B;;;;;OAKG;IACH,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAC1C,kFAAkF;IAClF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAKH,iCAAiC;AACjC,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fnndsc/menu",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "The mise wire contract: envelope, session protocol, and result-model schemas that surfaces and the kernel both speak",
   "repository": {
     "type": "git",