@treasuryspatial/plugin-manifest 0.1.3

package/README.md

@@ -0,0 +1,7 @@
+# @treasuryspatial/plugin-manifest
+
+Contracts for:
+- `PluginManifest` (plugin-owned)
+- `ToolManifest` (product-owned)
+
+This package is intentionally small and stable; it is consumed by all frontends.

package/dist/gh/inputsToManifest.d.ts

@@ -0,0 +1,16 @@
+import type { DefinitionManifest, ManifestVersion, UiSchema } from "../index";
+import type { GhInputSchema } from "./types";
+export type GhManifestBuildOptions = {
+    definitionId: string;
+    sessionId: string;
+    fileName?: string;
+    fileHash?: string;
+    fileSize?: number;
+    endpoints?: Record<string, string>;
+    manifestVersion?: ManifestVersion;
+    schemaVersion?: ManifestVersion;
+    uiSchemaOverride?: UiSchema;
+    defaultPanelTitle?: string;
+};
+export declare function buildDefinitionManifestFromGhInputs(inputs: GhInputSchema, options: GhManifestBuildOptions): DefinitionManifest;
+//# sourceMappingURL=inputsToManifest.d.ts.map

package/dist/gh/inputsToManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputsToManifest.d.ts","sourceRoot":"","sources":["../../src/gh/inputsToManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAc,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC1F,OAAO,KAAK,EAAgB,aAAa,EAAiB,MAAM,SAAS,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAAG;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAqGF,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,sBAAsB,GAC9B,kBAAkB,CAwBpB"}

package/dist/gh/inputsToManifest.js

@@ -0,0 +1,116 @@
+const DEFAULT_MANIFEST_VERSION = "1.0.0";
+const DEFAULT_SCHEMA_VERSION = "1.0.0";
+const DEFAULT_PANEL_ID = "parameters";
+const DEFAULT_TAB_ID = "controls";
+const slugifyId = (value) => value
+    .toLowerCase()
+    .replace(/[^a-z0-9._-]+/g, "-")
+    .replace(/^-+|-+$/g, "")
+    .slice(0, 64) || DEFAULT_PANEL_ID;
+const toOptionType = (options) => {
+    if (!options || options.length === 0)
+        return "string";
+    const sample = options.find((opt) => opt.value !== undefined)?.value;
+    if (typeof sample === "number")
+        return "number";
+    if (typeof sample === "boolean")
+        return "boolean";
+    return "string";
+};
+const buildPropertySchema = (field) => {
+    const schema = {
+        type: field.type === "enum" ? toOptionType(field.options) : field.type,
+    };
+    if (field.label)
+        schema.title = field.label;
+    if (field.description)
+        schema.description = field.description;
+    if (field.default !== undefined)
+        schema.default = field.default;
+    if (field.min !== undefined)
+        schema.minimum = field.min;
+    if (field.max !== undefined)
+        schema.maximum = field.max;
+    if (field.step !== undefined)
+        schema.multipleOf = field.step;
+    if (field.options && field.options.length > 0)
+        schema.enum = field.options.map((opt) => opt.value);
+    return schema;
+};
+const buildRequestSchema = (inputs) => {
+    const properties = {};
+    const required = [];
+    inputs.fields.forEach((field) => {
+        properties[field.key] = buildPropertySchema(field);
+        if (field.required)
+            required.push(field.key);
+    });
+    const schema = {
+        $schema: "https://json-schema.org/draft/2020-12/schema",
+        type: "object",
+        properties,
+        additionalProperties: false,
+    };
+    if (required.length > 0)
+        schema.required = required;
+    return schema;
+};
+const buildDefaults = (inputs) => {
+    const defaults = {};
+    inputs.fields.forEach((field) => {
+        if (field.default !== undefined) {
+            defaults[field.key] = field.default;
+        }
+    });
+    return defaults;
+};
+const buildUiSchema = (inputs, defaultPanelTitle) => {
+    const groups = new Map();
+    inputs.fields.forEach((field) => {
+        const group = field.group?.trim() || DEFAULT_PANEL_ID;
+        const existing = groups.get(group) ?? [];
+        existing.push(field);
+        groups.set(group, existing);
+    });
+    const panels = Array.from(groups.entries()).map(([groupName, fields], index) => {
+        const id = slugifyId(groupName);
+        return {
+            id,
+            title: groupName === DEFAULT_PANEL_ID ? defaultPanelTitle ?? "parameters" : groupName,
+            tab: DEFAULT_TAB_ID,
+            order: index + 1,
+            fields: fields.map((field) => field.key),
+        };
+    });
+    return {
+        uiVersion: "1.0.0",
+        tabs: [{ id: DEFAULT_TAB_ID, label: "controls", order: 1 }],
+        panels,
+        layout: {
+            defaultPanelId: panels[0]?.id ?? DEFAULT_PANEL_ID,
+            panelOrder: panels.map((panel) => panel.id),
+        },
+    };
+};
+export function buildDefinitionManifestFromGhInputs(inputs, options) {
+    const manifestVersion = options.manifestVersion ?? DEFAULT_MANIFEST_VERSION;
+    const schemaVersion = options.schemaVersion ?? DEFAULT_SCHEMA_VERSION;
+    const requestSchema = buildRequestSchema(inputs);
+    const defaults = buildDefaults(inputs);
+    const uiSchema = options.uiSchemaOverride ?? buildUiSchema(inputs, options.defaultPanelTitle);
+    return {
+        manifestVersion,
+        schemaVersion,
+        definitionId: options.definitionId,
+        sessionId: options.sessionId,
+        fileName: options.fileName,
+        fileHash: options.fileHash,
+        fileSize: options.fileSize,
+        endpoints: options.endpoints,
+        schemas: {
+            request: requestSchema,
+            ui: uiSchema,
+        },
+        defaults,
+    };
+}

package/dist/gh/types.d.ts

@@ -0,0 +1,23 @@
+export type GhInputFieldType = "number" | "integer" | "boolean" | "string" | "enum";
+export type GhInputOption = {
+    value: string | number | boolean;
+    label: string;
+};
+export type GhInputField = {
+    key: string;
+    label?: string;
+    type: GhInputFieldType;
+    min?: number;
+    max?: number;
+    step?: number;
+    options?: GhInputOption[];
+    default?: unknown;
+    group?: string;
+    description?: string;
+    required?: boolean;
+};
+export type GhInputSchema = {
+    version?: string;
+    fields: GhInputField[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/gh/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/gh/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEpF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC"}

package/dist/gh/types.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+export type ManifestVersion = `${number}.${number}.${number}`;
+export type PluginReleaseId = string;
+export type JsonSchema = Record<string, unknown>;
+export type UiSchema = Record<string, unknown>;
+export type PluginEndpointId = string;
+export type TaggingConfig = {
+    roleKey?: string;
+    roleKeys?: string[];
+    geometryRole?: string;
+    renderRole?: string;
+    idKey?: string;
+    packetKey?: string;
+    layerKey?: string;
+    materialKey?: string;
+};
+export type PluginManifest = {
+    manifestVersion: ManifestVersion;
+    schemaVersion: ManifestVersion;
+    pluginId: string;
+    routeId: string;
+    releaseId: PluginReleaseId;
+    endpoints: Record<PluginEndpointId, string>;
+    schemas: {
+        request: JsonSchema;
+        response?: JsonSchema;
+        ui?: UiSchema;
+    };
+    defaults: unknown;
+    presets?: Array<{
+        id: string;
+        label: string;
+        patch?: unknown;
+        params?: unknown;
+    }>;
+    capabilities?: {
+        supportsDebug?: boolean;
+        returnsPackets?: boolean;
+        returnsRenderMeshes?: boolean;
+    };
+    tagging?: TaggingConfig;
+    extensions?: Record<string, unknown>;
+};
+export type DefinitionManifest = {
+    manifestVersion: ManifestVersion;
+    schemaVersion: ManifestVersion;
+    definitionId: string;
+    sessionId: string;
+    fileName?: string;
+    fileHash?: string;
+    fileSize?: number;
+    endpoints?: Record<PluginEndpointId, string>;
+    schemas: {
+        request: JsonSchema;
+        response?: JsonSchema;
+        ui?: UiSchema;
+    };
+    defaults: unknown;
+    presets?: Array<{
+        id: string;
+        label: string;
+        patch?: unknown;
+        params?: unknown;
+    }>;
+    capabilities?: {
+        supportsDebug?: boolean;
+        returnsPackets?: boolean;
+        returnsRenderMeshes?: boolean;
+    };
+    tagging?: TaggingConfig;
+    extensions?: Record<string, unknown>;
+};
+export type ToolManifest = {
+    toolId: string;
+    label: string;
+    pipeline: Array<{
+        pluginId: string;
+        endpoint: PluginEndpointId;
+        parameterScope: string;
+    }>;
+    panels: Array<{
+        id: string;
+        title: string;
+        schemaRef: {
+            pluginId: string;
+            pointer: string;
+        };
+    }>;
+    actions?: Array<{
+        id: string;
+        label: string;
+        kind: "compute";
+        stage: string;
+    } | {
+        id: string;
+        label: string;
+        kind: "viewer";
+        method: string;
+    }>;
+    extensions?: Record<string, unknown>;
+};
+export type { GhInputField, GhInputFieldType, GhInputOption, GhInputSchema } from "./gh/types";
+export { buildDefinitionManifestFromGhInputs } from "./gh/inputsToManifest";
+export type { ManifestSchemas } from "./schemas";
+export { loadSchemas, schemaUrls } from "./schemas";
+export { createDefaultManifestValidator, createManifestValidator } from "./validate";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAC9D,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/C,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,eAAe,CAAC;IACjC,aAAa,EAAE,eAAe,CAAC;IAE/B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,eAAe,CAAC;IAE3B,SAAS,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAE5C,OAAO,EAAE;QACP,OAAO,EAAE,UAAU,CAAC;QACpB,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,EAAE,CAAC,EAAE,QAAQ,CAAC;KACf,CAAC;IAEF,QAAQ,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC,CAAC;IAEH,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;KAC/B,CAAC;IAEF,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,EAAE,eAAe,CAAC;IACjC,aAAa,EAAE,eAAe,CAAC;IAE/B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAE7C,OAAO,EAAE;QACP,OAAO,EAAE,UAAU,CAAC;QACpB,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,EAAE,CAAC,EAAE,QAAQ,CAAC;KACf,CAAC;IAEF,QAAQ,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC,CAAC;IAEH,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;KAC/B,CAAC;IAEF,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IAEd,QAAQ,EAAE,KAAK,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,gBAAgB,CAAC;QAC3B,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC,CAAC;IAEH,MAAM,EAAE,KAAK,CAAC;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;KAClD,CAAC,CAAC;IAEH,OAAO,CAAC,EAAE,KAAK,CACX;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAC7D;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAChE,CAAC;IAEF,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC,CAAC;AAEF,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC/F,OAAO,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAC5E,YAAY,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,8BAA8B,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { buildDefinitionManifestFromGhInputs } from "./gh/inputsToManifest";
+export { loadSchemas, schemaUrls } from "./schemas";
+export { createDefaultManifestValidator, createManifestValidator } from "./validate";

package/dist/schemas.d.ts

@@ -0,0 +1,14 @@
+export type ManifestSchemas = {
+    pluginManifest: unknown;
+    definitionManifest: unknown;
+    uiSchema: unknown;
+    toolManifest: unknown;
+};
+export declare const schemaUrls: {
+    pluginManifest: string;
+    definitionManifest: string;
+    uiSchema: string;
+    toolManifest: string;
+};
+export declare function loadSchemas(): Promise<ManifestSchemas>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;CAKtB,CAAC;AAgBF,wBAAsB,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC,CAS5D"}

package/dist/schemas.js

@@ -0,0 +1,27 @@
+export const schemaUrls = {
+    pluginManifest: new URL("../schema/plugin-manifest.schema.json", import.meta.url).toString(),
+    definitionManifest: new URL("../schema/definition-manifest.schema.json", import.meta.url).toString(),
+    uiSchema: new URL("../schema/ui.schema.json", import.meta.url).toString(),
+    toolManifest: new URL("../schema/tool-manifest.schema.json", import.meta.url).toString(),
+};
+async function loadJson(url) {
+    if (typeof fetch === "function") {
+        const res = await fetch(url);
+        if (!res.ok) {
+            throw new Error(`Failed to load schema ${url}: ${res.status} ${res.statusText}`);
+        }
+        return res.json();
+    }
+    const { readFile } = await import("node:fs/promises");
+    const data = await readFile(new URL(url), "utf-8");
+    return JSON.parse(data);
+}
+export async function loadSchemas() {
+    const [pluginManifest, definitionManifest, uiSchema, toolManifest] = await Promise.all([
+        loadJson(schemaUrls.pluginManifest),
+        loadJson(schemaUrls.definitionManifest),
+        loadJson(schemaUrls.uiSchema),
+        loadJson(schemaUrls.toolManifest),
+    ]);
+    return { pluginManifest, definitionManifest, uiSchema, toolManifest };
+}

package/dist/validate.d.ts

@@ -0,0 +1,14 @@
+import type { ManifestSchemas } from "./schemas";
+export type ValidationResult = {
+    valid: boolean;
+    errors?: string[];
+};
+export type ManifestValidator = {
+    validatePluginManifest: (value: unknown) => ValidationResult;
+    validateDefinitionManifest: (value: unknown) => ValidationResult;
+    validateUiSchema: (value: unknown) => ValidationResult;
+    validateToolManifest: (value: unknown) => ValidationResult;
+};
+export declare function createManifestValidator(schemas: ManifestSchemas): ManifestValidator;
+export declare function createDefaultManifestValidator(): Promise<ManifestValidator>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAGjD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,sBAAsB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,gBAAgB,CAAC;IAC7D,0BAA0B,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,gBAAgB,CAAC;IACjE,gBAAgB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,gBAAgB,CAAC;IACvD,oBAAoB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,gBAAgB,CAAC;CAC5D,CAAC;AAiBF,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,eAAe,GAAG,iBAAiB,CAcnF;AAED,wBAAsB,8BAA8B,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAGjF"}

package/dist/validate.js

@@ -0,0 +1,33 @@
+import Ajv from "ajv";
+import { loadSchemas } from "./schemas";
+function formatErrors(errors) {
+    if (!errors || errors.length === 0)
+        return [];
+    return errors.map((error) => `${error.instancePath || "<root>"} ${error.message ?? "is invalid"}`.trim());
+}
+function buildValidator(ajv, schemaKey) {
+    return (value) => {
+        const valid = ajv.validate(schemaKey, value);
+        if (valid) {
+            return { valid: true };
+        }
+        return { valid: false, errors: formatErrors(ajv.errors) };
+    };
+}
+export function createManifestValidator(schemas) {
+    const ajv = new Ajv({ allErrors: true, strict: false });
+    ajv.addSchema(schemas.pluginManifest, "plugin-manifest");
+    ajv.addSchema(schemas.definitionManifest, "definition-manifest");
+    ajv.addSchema(schemas.uiSchema, "ui-schema");
+    ajv.addSchema(schemas.toolManifest, "tool-manifest");
+    return {
+        validatePluginManifest: buildValidator(ajv, "plugin-manifest"),
+        validateDefinitionManifest: buildValidator(ajv, "definition-manifest"),
+        validateUiSchema: buildValidator(ajv, "ui-schema"),
+        validateToolManifest: buildValidator(ajv, "tool-manifest"),
+    };
+}
+export async function createDefaultManifestValidator() {
+    const schemas = await loadSchemas();
+    return createManifestValidator(schemas);
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@treasuryspatial/plugin-manifest",
+  "version": "0.1.3",
+  "type": "module",
+  "license": "UNLICENSED",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "schema"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc -b --pretty false --noEmit"
+  }
+}

package/schema/definition-manifest.schema.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://base2.design/schema/definition-manifest.schema.json",
+  "title": "Base2 Composer Definition Manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "manifestVersion",
+    "schemaVersion",
+    "definitionId",
+    "sessionId",
+    "schemas",
+    "defaults"
+  ],
+  "properties": {
+    "manifestVersion": { "$ref": "#/$defs/semver" },
+    "schemaVersion": { "$ref": "#/$defs/semver" },
+    "definitionId": { "type": "string", "minLength": 1 },
+    "sessionId": { "type": "string", "minLength": 1 },
+    "fileName": { "type": "string" },
+    "fileHash": { "type": "string" },
+    "fileSize": { "type": "integer", "minimum": 0 },
+    "endpoints": {
+      "type": "object",
+      "propertyNames": { "$ref": "#/$defs/id" },
+      "additionalProperties": { "type": "string", "minLength": 1 }
+    },
+    "schemas": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["request"],
+      "properties": {
+        "request": { "$ref": "#/$defs/jsonSchema" },
+        "response": { "$ref": "#/$defs/jsonSchema" },
+        "ui": { "$ref": "#/$defs/uiSchema" }
+      }
+    },
+    "defaults": {},
+    "presets": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "label"],
+        "properties": {
+          "id": { "$ref": "#/$defs/id" },
+          "label": { "type": "string" },
+          "patch": {},
+          "params": {}
+        }
+      }
+    },
+    "capabilities": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "supportsDebug": { "type": "boolean" },
+        "returnsPackets": { "type": "boolean" },
+        "returnsRenderMeshes": { "type": "boolean" }
+      }
+    },
+    "tagging": { "$ref": "#/$defs/tagging" },
+    "extensions": {
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "semver": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]+$"
+    },
+    "jsonSchema": {
+      "oneOf": [
+        { "type": "object" },
+        { "type": "boolean" }
+      ]
+    },
+    "uiSchema": {
+      "type": "object"
+    },
+    "tagging": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "roleKey": { "type": "string", "minLength": 1 },
+        "roleKeys": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "geometryRole": { "type": "string", "minLength": 1 },
+        "renderRole": { "type": "string", "minLength": 1 },
+        "idKey": { "type": "string", "minLength": 1 },
+        "packetKey": { "type": "string", "minLength": 1 },
+        "layerKey": { "type": "string", "minLength": 1 },
+        "materialKey": { "type": "string", "minLength": 1 }
+      }
+    }
+  }
+}

package/schema/plugin-manifest.schema.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://base2.design/schema/plugin-manifest.schema.json",
+  "title": "Base2 Composer Plugin Manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "manifestVersion",
+    "schemaVersion",
+    "pluginId",
+    "routeId",
+    "releaseId",
+    "endpoints",
+    "schemas",
+    "defaults"
+  ],
+  "properties": {
+    "manifestVersion": { "$ref": "#/$defs/semver" },
+    "schemaVersion": { "$ref": "#/$defs/semver" },
+    "pluginId": { "type": "string", "minLength": 1 },
+    "routeId": { "type": "string", "minLength": 1 },
+    "releaseId": { "type": "string", "minLength": 1 },
+    "endpoints": {
+      "type": "object",
+      "propertyNames": { "$ref": "#/$defs/id" },
+      "additionalProperties": { "type": "string", "minLength": 1 }
+    },
+    "schemas": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["request"],
+      "properties": {
+        "request": { "$ref": "#/$defs/jsonSchema" },
+        "response": { "$ref": "#/$defs/jsonSchema" },
+        "ui": { "$ref": "#/$defs/uiSchema" }
+      }
+    },
+    "defaults": {},
+    "presets": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "label"],
+        "properties": {
+          "id": { "$ref": "#/$defs/id" },
+          "label": { "type": "string" },
+          "patch": {},
+          "params": {}
+        }
+      }
+    },
+    "capabilities": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "supportsDebug": { "type": "boolean" },
+        "returnsPackets": { "type": "boolean" },
+        "returnsRenderMeshes": { "type": "boolean" }
+      }
+    },
+    "tagging": { "$ref": "#/$defs/tagging" },
+    "extensions": {
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "semver": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]+$"
+    },
+    "jsonSchema": {
+      "oneOf": [
+        { "type": "object" },
+        { "type": "boolean" }
+      ]
+    },
+    "uiSchema": {
+      "type": "object"
+    },
+    "tagging": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "roleKey": { "type": "string", "minLength": 1 },
+        "roleKeys": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "geometryRole": { "type": "string", "minLength": 1 },
+        "renderRole": { "type": "string", "minLength": 1 },
+        "idKey": { "type": "string", "minLength": 1 },
+        "packetKey": { "type": "string", "minLength": 1 },
+        "layerKey": { "type": "string", "minLength": 1 },
+        "materialKey": { "type": "string", "minLength": 1 }
+      }
+    }
+  }
+}

package/schema/tool-manifest.schema.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://base2.design/schema/tool-manifest.schema.json",
+  "title": "Composer Tool Manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["toolId", "label", "pipeline", "panels"],
+  "properties": {
+    "toolId": { "$ref": "#/$defs/id" },
+    "label": { "type": "string" },
+    "pipeline": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/pipelineStep" }
+    },
+    "panels": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/panelRef" }
+    },
+    "actions": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/action" }
+    },
+    "extensions": {
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]+$"
+    },
+    "pipelineStep": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["pluginId", "endpoint", "parameterScope"],
+      "properties": {
+        "pluginId": { "$ref": "#/$defs/id" },
+        "endpoint": { "$ref": "#/$defs/id" },
+        "parameterScope": { "type": "string" }
+      }
+    },
+    "panelRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "schemaRef"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "title": { "type": "string" },
+        "schemaRef": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["pluginId", "pointer"],
+          "properties": {
+            "pluginId": { "$ref": "#/$defs/id" },
+            "pointer": { "type": "string" }
+          }
+        }
+      }
+    },
+    "action": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["id", "label", "kind", "stage"],
+          "properties": {
+            "id": { "$ref": "#/$defs/id" },
+            "label": { "type": "string" },
+            "kind": { "const": "compute" },
+            "stage": { "type": "string" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["id", "label", "kind", "method"],
+          "properties": {
+            "id": { "$ref": "#/$defs/id" },
+            "label": { "type": "string" },
+            "kind": { "const": "viewer" },
+            "method": { "type": "string" }
+          }
+        }
+      ]
+    }
+  }
+}

package/schema/ui.schema.json

@@ -0,0 +1,217 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://base2.design/schema/ui.schema.json",
+  "title": "Composer UI Schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "uiVersion": { "$ref": "#/$defs/semver" },
+    "tabs": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/tab" }
+    },
+    "panels": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/panel" }
+    },
+    "layout": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "defaultPanelId": { "$ref": "#/$defs/id" },
+        "panelOrder": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/id" }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "semver": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]+$"
+    },
+    "tab": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "label"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "label": { "type": "string" },
+        "order": { "type": "integer" },
+        "description": { "type": "string" }
+      }
+    },
+    "panel": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "title": { "type": "string" },
+        "tab": { "$ref": "#/$defs/id" },
+        "order": { "type": "integer" },
+        "description": { "type": "string" },
+        "fields": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/fieldRef" }
+        },
+        "sections": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/section" }
+        }
+      }
+    },
+    "section": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "title", "fields"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "title": { "type": "string" },
+        "description": { "type": "string" },
+        "fields": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/fieldRef" }
+        }
+      }
+    },
+    "fieldRef": {
+      "oneOf": [
+        { "type": "string" },
+        { "$ref": "#/$defs/field" }
+      ]
+    },
+    "field": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key"],
+      "properties": {
+        "key": { "type": "string" },
+        "label": { "type": "string" },
+        "control": {
+          "type": "string",
+          "enum": ["range", "number", "toggle", "select", "color", "text", "textarea", "file", "action", "array", "oneOf"]
+        },
+        "min": { "type": "number" },
+        "max": { "type": "number" },
+        "step": { "type": "number" },
+        "unit": { "type": "string" },
+        "placeholder": { "type": "string" },
+        "rows": { "type": "integer", "minimum": 1 },
+        "helpText": { "type": "string" },
+        "options": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["value", "label"],
+            "properties": {
+              "value": { "type": ["string", "number", "boolean"] },
+              "label": { "type": "string" }
+            }
+          }
+        },
+        "visibleWhen": { "$ref": "#/$defs/expr" },
+        "disabledWhen": { "$ref": "#/$defs/expr" },
+        "itemLabel": { "type": "string" },
+        "itemDefaults": {},
+        "itemFields": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/fieldRef" }
+        },
+        "fields": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/fieldRef" }
+        },
+        "minItems": { "type": "integer", "minimum": 0 },
+        "maxItems": { "type": "integer", "minimum": 0 },
+        "variants": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/variant" }
+        },
+        "discriminator": { "type": "string" },
+        "effects": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "onChange": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/effect" }
+            }
+          }
+        },
+        "actionId": { "$ref": "#/$defs/id" }
+      }
+    },
+    "variant": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "label", "fields"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "label": { "type": "string" },
+        "fields": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/fieldRef" }
+        }
+      }
+    },
+    "effect": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "path"],
+      "properties": {
+        "kind": { "type": "string", "enum": ["set", "patch"] },
+        "path": { "type": "string" },
+        "value": {},
+        "when": { "$ref": "#/$defs/expr" }
+      }
+    },
+    "expr": {
+      "oneOf": [
+        { "$ref": "#/$defs/compare" },
+        { "$ref": "#/$defs/logic" }
+      ]
+    },
+    "compare": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "path": { "type": "string" },
+        "key": { "type": "string" },
+        "truthy": {},
+        "equals": {},
+        "notEquals": {},
+        "gt": { "type": "number" },
+        "gte": { "type": "number" },
+        "lt": { "type": "number" },
+        "lte": { "type": "number" },
+        "in": { "type": "array" }
+      },
+      "anyOf": [
+        { "required": ["path"] },
+        { "required": ["key"] }
+      ]
+    },
+    "logic": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "all": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/expr" }
+        },
+        "any": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/expr" }
+        },
+        "not": { "$ref": "#/$defs/expr" }
+      }
+    }
+  }
+}