@treasuryspatial/panel-core 0.1.2

package/dist/buildPanelModel.d.ts

@@ -0,0 +1,28 @@
+import type { UiSchema } from "@treasuryspatial/plugin-manifest";
+import type { PanelBuildOptions, PanelLayout, TabModel } from "./types";
+type UiSchemaShape = {
+    uiVersion?: string;
+    tabs?: TabModel[];
+    panels?: Array<{
+        id: string;
+        title: string;
+        tab?: string;
+        order?: number;
+        description?: string;
+        fields?: Array<string | Record<string, unknown>>;
+        sections?: Array<{
+            id: string;
+            title: string;
+            description?: string;
+            fields: Array<string | Record<string, unknown>>;
+        }>;
+    }>;
+    layout?: {
+        defaultPanelId?: string;
+        panelOrder?: string[];
+    };
+};
+declare const normalizeUiSchema: (ui?: UiSchema) => UiSchemaShape | null;
+export declare function buildPanelModel(options: PanelBuildOptions): PanelLayout;
+export { normalizeUiSchema };
+//# sourceMappingURL=buildPanelModel.d.ts.map

package/dist/buildPanelModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildPanelModel.d.ts","sourceRoot":"","sources":["../src/buildPanelModel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE7E,OAAO,KAAK,EAAgC,iBAAiB,EAAE,WAAW,EAA4B,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEhI,KAAK,aAAa,GAAG;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACjD,QAAQ,CAAC,EAAE,KAAK,CAAC;YACf,EAAE,EAAE,MAAM,CAAC;YACX,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;SACjD,CAAC,CAAC;KACJ,CAAC,CAAC;IACH,MAAM,CAAC,EAAE;QACP,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACH,CAAC;AAsEF,QAAA,MAAM,iBAAiB,GAAI,KAAK,QAAQ,KAAG,aAAa,GAAG,IAI1D,CAAC;AAoNF,wBAAgB,eAAe,CAAC,OAAO,EAAE,iBAAiB,GAAG,WAAW,CAYvE;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/buildPanelModel.js

@@ -0,0 +1,266 @@
+const DEFAULT_PANEL_ID = "parameters";
+const DEFAULT_PANEL_TITLE = "parameters";
+const asRecord = (value) => {
+    if (!value || typeof value !== "object" || Array.isArray(value))
+        return null;
+    return value;
+};
+const parsePathSegments = (path) => {
+    if (!path)
+        return [];
+    const segments = [];
+    const parts = path.split(".");
+    for (const part of parts) {
+        if (!part)
+            continue;
+        const matches = part.matchAll(/([^[\]]+)|\[(\d+)\]/g);
+        for (const match of matches) {
+            if (match[1]) {
+                segments.push(match[1]);
+            }
+            else if (match[2]) {
+                segments.push(Number.parseInt(match[2], 10));
+            }
+        }
+    }
+    return segments;
+};
+const getValueByPath = (source, path) => {
+    if (!source)
+        return undefined;
+    const segments = parsePathSegments(path);
+    if (segments.length === 0)
+        return undefined;
+    let cursor = source;
+    for (const segment of segments) {
+        if (cursor == null)
+            return undefined;
+        if (typeof segment === "number") {
+            if (!Array.isArray(cursor))
+                return undefined;
+            cursor = cursor[segment];
+        }
+        else {
+            cursor = cursor[segment];
+        }
+    }
+    return cursor;
+};
+const resolveDefaultValue = (defaults, key, schemaDefault) => {
+    if (defaults) {
+        if (Object.prototype.hasOwnProperty.call(defaults, key)) {
+            return defaults[key];
+        }
+        const nested = getValueByPath(defaults, key);
+        if (nested !== undefined)
+            return nested;
+    }
+    return schemaDefault;
+};
+const extractDefaultsFromSchemaProps = (schemaProps) => {
+    const defaults = {};
+    Object.entries(schemaProps).forEach(([key, schema]) => {
+        if (Object.prototype.hasOwnProperty.call(schema, "default")) {
+            defaults[key] = schema.default;
+        }
+    });
+    return defaults;
+};
+const normalizeUiSchema = (ui) => {
+    const record = asRecord(ui);
+    if (!record)
+        return null;
+    return record;
+};
+const inferControl = (schema, uiField) => {
+    const override = uiField?.control;
+    if (override)
+        return override;
+    const schemaType = schema.type;
+    if (schema.oneOf)
+        return "oneOf";
+    if (schemaType === "array")
+        return "array";
+    if (schemaType === "boolean")
+        return "toggle";
+    if (schemaType === "string") {
+        if (schema.format === "color")
+            return "color";
+        return "text";
+    }
+    if (schema.enum)
+        return "select";
+    if (schemaType === "integer" || schemaType === "number") {
+        const hasRange = schema.minimum !== undefined || schema.maximum !== undefined;
+        return hasRange ? "range" : "number";
+    }
+    return "number";
+};
+const toOptions = (schema, uiField) => {
+    const options = uiField?.options ??
+        (Array.isArray(schema.enum)
+            ? schema.enum.map((value) => ({ value: value, label: String(value) }))
+            : undefined);
+    return options;
+};
+function buildFieldModel(key, schema, uiField, defaults) {
+    const label = uiField?.label ?? schema.title ?? key;
+    const control = inferControl(schema, uiField);
+    const base = {
+        key,
+        label,
+        control,
+        min: uiField?.min ?? schema.minimum,
+        max: uiField?.max ?? schema.maximum,
+        step: uiField?.step ?? schema.multipleOf,
+        unit: uiField?.unit,
+        placeholder: uiField?.placeholder,
+        rows: uiField?.rows,
+        helpText: uiField?.helpText ?? schema.description,
+        options: toOptions(schema, uiField),
+        visibleWhen: uiField?.visibleWhen,
+        disabledWhen: uiField?.disabledWhen,
+        effects: uiField?.effects,
+        actionId: uiField?.actionId,
+        defaultValue: resolveDefaultValue(defaults, key, schema.default),
+        schema,
+    };
+    if (control === "array") {
+        const itemSchema = asRecord(schema.items) ?? {};
+        const itemSchemaProps = getSchemaProperties(itemSchema);
+        const itemFieldRefs = (uiField?.itemFields ?? uiField?.fields);
+        const itemDefaultsFromSchema = extractDefaultsFromSchemaProps(itemSchemaProps);
+        const arrayDefault = resolveDefaultValue(defaults, key, schema.default);
+        const arrayDefaultItem = Array.isArray(arrayDefault) && arrayDefault.length > 0 && asRecord(arrayDefault[0])
+            ? arrayDefault[0]
+            : undefined;
+        const uiItemDefaults = asRecord(uiField?.itemDefaults);
+        const itemDefaults = {
+            ...itemDefaultsFromSchema,
+            ...(arrayDefaultItem ?? {}),
+            ...(uiItemDefaults ?? {}),
+        };
+        const resolvedItemFields = itemFieldRefs ?? Object.keys(itemSchemaProps).sort();
+        const itemFields = resolvedItemFields.length
+            ? buildPanelFields(resolvedItemFields, itemSchemaProps, itemDefaults)
+            : [];
+        return {
+            ...base,
+            itemFields,
+            itemDefaults,
+            itemLabel: uiField?.itemLabel,
+            minItems: uiField?.minItems ?? schema.minItems,
+            maxItems: uiField?.maxItems ?? schema.maxItems,
+        };
+    }
+    if (control === "oneOf") {
+        const oneOfSchemas = Array.isArray(schema.oneOf) ? schema.oneOf : [];
+        const uiVariants = uiField?.variants ?? [];
+        const variants = uiVariants.length > 0
+            ? uiVariants.map((variant, index) => {
+                const variantSchema = asRecord(oneOfSchemas[index]) ?? {};
+                const variantProps = getSchemaProperties(variantSchema);
+                const fieldRefs = variant.fields ??
+                    Object.keys(variantProps).sort();
+                const variantDefaults = extractDefaultsFromSchemaProps(variantProps);
+                return {
+                    id: variant.id ?? `option-${index + 1}`,
+                    label: variant.label ?? variant.id ?? `Option ${index + 1}`,
+                    fields: buildPanelFields(fieldRefs, variantProps, variantDefaults),
+                };
+            })
+            : oneOfSchemas.map((variantSchema, index) => {
+                const variantRecord = asRecord(variantSchema) ?? {};
+                const variantProps = getSchemaProperties(variantRecord);
+                const fieldRefs = Object.keys(variantProps).sort();
+                const variantDefaults = extractDefaultsFromSchemaProps(variantProps);
+                const title = variantRecord.title;
+                return {
+                    id: `option-${index + 1}`,
+                    label: title ?? `Option ${index + 1}`,
+                    fields: buildPanelFields(fieldRefs, variantProps, variantDefaults),
+                };
+            });
+        const discriminator = uiField?.discriminator ??
+            asRecord(schema.discriminator)?.propertyName;
+        return {
+            ...base,
+            variants,
+            discriminator,
+        };
+    }
+    return base;
+}
+;
+const getSchemaProperties = (schema) => {
+    const schemaObj = asRecord(schema);
+    if (!schemaObj)
+        return {};
+    const properties = schemaObj.properties;
+    if (!properties || typeof properties !== "object" || Array.isArray(properties))
+        return {};
+    return properties;
+};
+function buildPanelFields(fieldRefs, schemaProps, defaults) {
+    return fieldRefs
+        .map((fieldRef) => {
+        if (typeof fieldRef === "string") {
+            const schema = schemaProps[fieldRef] ?? {};
+            return buildFieldModel(fieldRef, schema, undefined, defaults);
+        }
+        const uiField = fieldRef;
+        const key = uiField.key;
+        if (!key)
+            return null;
+        const schema = schemaProps[key] ?? {};
+        return buildFieldModel(key, schema, uiField, defaults);
+    })
+        .filter((field) => Boolean(field));
+}
+const buildSections = (sections, schemaProps, defaults) => {
+    if (!sections)
+        return [];
+    return sections.map((section) => ({
+        id: section.id,
+        title: section.title,
+        description: section.description,
+        fields: buildPanelFields(section.fields, schemaProps, defaults),
+    }));
+};
+const buildPanelsFromUi = (ui, schemaProps, defaults) => {
+    if (!ui.panels || ui.panels.length === 0)
+        return [];
+    return ui.panels.map((panel) => {
+        const sections = buildSections(panel.sections, schemaProps, defaults);
+        const fields = panel.fields ? buildPanelFields(panel.fields, schemaProps, defaults) : [];
+        return {
+            id: panel.id,
+            title: panel.title,
+            tab: panel.tab,
+            order: panel.order,
+            description: panel.description,
+            fields: sections.length > 0 ? undefined : fields,
+            sections: sections.length > 0 ? sections : undefined,
+        };
+    });
+};
+const buildDefaultPanel = (schemaProps, defaults) => {
+    const keys = Object.keys(schemaProps).sort();
+    return {
+        id: DEFAULT_PANEL_ID,
+        title: DEFAULT_PANEL_TITLE,
+        fields: keys.map((key) => buildFieldModel(key, schemaProps[key] ?? {}, undefined, defaults)),
+    };
+};
+export function buildPanelModel(options) {
+    const schemaProps = getSchemaProperties(options.schema);
+    const ui = normalizeUiSchema(options.ui);
+    const panels = ui ? buildPanelsFromUi(ui, schemaProps, options.defaults) : [];
+    const resolvedPanels = panels.length > 0 ? panels : [buildDefaultPanel(schemaProps, options.defaults)];
+    return {
+        tabs: ui?.tabs,
+        panels: resolvedPanels,
+        layout: ui?.layout,
+    };
+}
+export { normalizeUiSchema };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { buildPanelModel, normalizeUiSchema } from "./buildPanelModel";
+export type { FieldControlType, FieldModel, PanelBuildOptions, PanelLayout, PanelModel, SectionModel, TabModel } from "./types";
+//# 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,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACvE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,iBAAiB,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export { buildPanelModel, normalizeUiSchema } from "./buildPanelModel";

package/dist/types.d.ts

@@ -0,0 +1,70 @@
+import type { JsonSchema, UiSchema } from "@treasuryspatial/plugin-manifest";
+export type PanelBuildOptions = {
+    schema: JsonSchema;
+    ui?: UiSchema;
+    defaults?: Record<string, unknown>;
+};
+export type PanelLayout = {
+    tabs?: TabModel[];
+    panels: PanelModel[];
+    layout?: {
+        defaultPanelId?: string;
+        panelOrder?: string[];
+    };
+};
+export type TabModel = {
+    id: string;
+    label: string;
+    order?: number;
+    description?: string;
+};
+export type PanelModel = {
+    id: string;
+    title: string;
+    tab?: string;
+    order?: number;
+    description?: string;
+    fields?: FieldModel[];
+    sections?: SectionModel[];
+};
+export type SectionModel = {
+    id: string;
+    title: string;
+    description?: string;
+    fields: FieldModel[];
+};
+export type FieldModel = {
+    key: string;
+    label: string;
+    control: FieldControlType;
+    min?: number;
+    max?: number;
+    step?: number;
+    unit?: string;
+    placeholder?: string;
+    rows?: number;
+    helpText?: string;
+    options?: Array<{
+        value: string | number | boolean;
+        label: string;
+    }>;
+    variants?: Array<{
+        id: string;
+        label: string;
+        fields: FieldModel[];
+    }>;
+    discriminator?: string;
+    itemFields?: FieldModel[];
+    itemDefaults?: unknown;
+    itemLabel?: string;
+    minItems?: number;
+    maxItems?: number;
+    visibleWhen?: unknown;
+    disabledWhen?: unknown;
+    effects?: unknown;
+    actionId?: string;
+    defaultValue?: unknown;
+    schema?: Record<string, unknown>;
+};
+export type FieldControlType = "range" | "number" | "toggle" | "select" | "color" | "text" | "textarea" | "file" | "action" | "array" | "oneOf";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE7E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,gBAAgB,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrE,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC,CAAC;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,UAAU,GACV,MAAM,GACN,QAAQ,GACR,OAAO,GACP,OAAO,CAAC"}

package/dist/types.js

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

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@treasuryspatial/panel-core",
+  "version": "0.1.2",
+  "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"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@treasuryspatial/plugin-manifest": "^0.1.2"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc -b --pretty false --noEmit"
+  }
+}