@cratis/scene.react 4.23.0 → 4.25.0

package/dist/esm/packages/describeComponents.js

@@ -0,0 +1,61 @@
+import { componentIcon } from '@cratis/scene.model';
+import { componentRegistryKey } from './ScenePackageBundle.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** A `ComponentMetadata` entry in one line: what a package's metadata table is made of. */ function componentMetadata(displayName, category, icon, keywords = [], badge, designMode) {
+    return {
+        displayName,
+        category,
+        icon,
+        keywords,
+        ...badge === undefined ? {} : {
+            badge
+        },
+        ...designMode === undefined ? {} : {
+            designMode
+        }
+    };
+}
+/**
+ * Builds the descriptors a bundle ships: the ones written by hand with the package's component metadata merged in, plus a descriptor with
+ * no editable properties for every component the metadata names that nobody described - such a component still has a name, a
+ * category and a place in a picker. A hand-written descriptor keeps everything it already says; metadata only fills in what it
+ * leaves out.
+ *
+ * The component list is the metadata table's own, so a component the table forgets has no descriptor and `validateComponentMetadata`
+ * reports it (CMP1); one the table names but the manifest does not declare is reported by `validatePackageBundle`.
+ */ function describeComponents(packageName, described, metadata) {
+    const describedKeys = new Set(described.map((descriptor)=>descriptor.component));
+    const bare = Object.keys(metadata).map((name)=>componentRegistryKey(packageName, name)).filter((key)=>!describedKeys.has(key)).map((key)=>({
+            component: key,
+            properties: []
+        }));
+    return [
+        ...described,
+        ...bare
+    ].map((descriptor)=>withMetadata(descriptor, metadata[descriptor.component.slice(packageName.length + 1)]));
+}
+function withMetadata(descriptor, metadata) {
+    if (!metadata) return descriptor;
+    return {
+        ...descriptor,
+        displayName: descriptor.displayName ?? metadata.displayName ?? descriptor.component.slice(descriptor.component.indexOf(':') + 1),
+        category: descriptor.category ?? metadata.category,
+        ...descriptor.icon === undefined && metadata.icon !== undefined ? {
+            icon: componentIcon(metadata.icon)
+        } : {},
+        ...descriptor.keywords === undefined && metadata.keywords !== undefined ? {
+            keywords: metadata.keywords
+        } : {},
+        ...descriptor.badge === undefined && metadata.badge !== undefined ? {
+            badge: metadata.badge
+        } : {},
+        ...descriptor.designMode === undefined && metadata.designMode !== undefined ? {
+            designMode: metadata.designMode
+        } : {}
+    };
+}
+
+export { componentMetadata, describeComponents };
+//# sourceMappingURL=describeComponents.js.map

package/dist/esm/packages/describeComponents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describeComponents.js","sources":["../../../packages/describeComponents.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ComponentDescriptor, ComponentDesignModeDescriptor, componentIcon } from '@cratis/scene.model';\nimport { componentRegistryKey } from './ScenePackageBundle';\n\n/**\n * What a package says about one of its components for a picker, besides what can be edited: the data of CMP1 and the picker's\n * rows. Written once per package as a table keyed by the bare component name.\n */\nexport interface ComponentMetadata {\n    /** The name a picker shows. Absent keeps the one the component's descriptor has, or the bare name. */\n    displayName?: string;\n\n    /** One of `ComponentCategory`, or a category of the package's own. */\n    category: string;\n\n    /** The key of the icon in the built-in icon library (`componentIcon`). */\n    icon?: string;\n\n    /** Words the picker's filter matches besides the name. */\n    keywords?: string[];\n\n    /** An explicit two-letter badge; absent means derived from the name. */\n    badge?: string;\n\n    /** How the component is edited directly on the design surface. */\n    designMode?: ComponentDesignModeDescriptor;\n}\n\n/** A `ComponentMetadata` entry in one line: what a package's metadata table is made of. */\nexport function componentMetadata(\n    displayName: string,\n    category: string,\n    icon: string,\n    keywords: string[] = [],\n    badge?: string,\n    designMode?: ComponentDesignModeDescriptor\n): ComponentMetadata {\n    return { displayName, category, icon, keywords, ...(badge === undefined ? {} : { badge }), ...(designMode === undefined ? {} : { designMode }) };\n}\n\n/**\n * Builds the descriptors a bundle ships: the ones written by hand with the package's component metadata merged in, plus a descriptor with\n * no editable properties for every component the metadata names that nobody described - such a component still has a name, a\n * category and a place in a picker. A hand-written descriptor keeps everything it already says; metadata only fills in what it\n * leaves out.\n *\n * The component list is the metadata table's own, so a component the table forgets has no descriptor and `validateComponentMetadata`\n * reports it (CMP1); one the table names but the manifest does not declare is reported by `validatePackageBundle`.\n */\nexport function describeComponents(\n    packageName: string,\n    described: readonly ComponentDescriptor[],\n    metadata: Readonly<Record<string, ComponentMetadata>>\n): ComponentDescriptor[] {\n    const describedKeys = new Set(described.map(descriptor => descriptor.component));\n    const bare = Object.keys(metadata)\n        .map(name => componentRegistryKey(packageName, name))\n        .filter(key => !describedKeys.has(key))\n        .map((key): ComponentDescriptor => ({ component: key, properties: [] }));\n\n    return [...described, ...bare].map(descriptor => withMetadata(descriptor, metadata[descriptor.component.slice(packageName.length + 1)]));\n}\n\nfunction withMetadata(descriptor: ComponentDescriptor, metadata: ComponentMetadata | undefined): ComponentDescriptor {\n    if (!metadata) return descriptor;\n\n    return {\n        ...descriptor,\n        displayName: descriptor.displayName ?? metadata.displayName ?? descriptor.component.slice(descriptor.component.indexOf(':') + 1),\n        category: descriptor.category ?? metadata.category,\n        ...(descriptor.icon === undefined && metadata.icon !== undefined ? { icon: componentIcon(metadata.icon) } : {}),\n        ...(descriptor.keywords === undefined && metadata.keywords !== undefined ? { keywords: metadata.keywords } : {}),\n        ...(descriptor.badge === undefined && metadata.badge !== undefined ? { badge: metadata.badge } : {}),\n        ...(descriptor.designMode === undefined && metadata.designMode !== undefined ? { designMode: metadata.designMode } : {}),\n    };\n}\n"],"names":["componentMetadata","displayName","category","icon","keywords","badge","designMode","undefined","describeComponents","packageName","described","metadata","describedKeys","Set","map","descriptor","component","bare","Object","keys","name","componentRegistryKey","filter","key","has","properties","withMetadata","slice","length","indexOf","componentIcon"],"mappings":";;;AAAA;AACA;AA6BA,4FACO,SAASA,iBAAAA,CACZC,WAAmB,EACnBC,QAAgB,EAChBC,IAAY,EACZC,QAAAA,GAAqB,EAAE,EACvBC,KAAc,EACdC,UAA0C,EAAA;IAE1C,OAAO;AAAEL,QAAAA,WAAAA;AAAaC,QAAAA,QAAAA;AAAUC,QAAAA,IAAAA;AAAMC,QAAAA,QAAAA;QAAU,GAAIC,KAAAA,KAAUE,SAAAA,GAAY,EAAC,GAAI;AAAEF,YAAAA;SAAO;QAAG,GAAIC,UAAAA,KAAeC,SAAAA,GAAY,EAAC,GAAI;AAAED,YAAAA;;AAAc,KAAA;AACnJ;AAEA;;;;;;;;AAQC,IACM,SAASE,kBAAAA,CACZC,WAAmB,EACnBC,SAAyC,EACzCC,QAAqD,EAAA;IAErD,MAAMC,aAAAA,GAAgB,IAAIC,GAAAA,CAAIH,SAAAA,CAAUI,GAAG,CAACC,CAAAA,UAAAA,GAAcA,UAAAA,CAAWC,SAAS,CAAA,CAAA;IAC9E,MAAMC,IAAAA,GAAOC,MAAAA,CAAOC,IAAI,CAACR,QAAAA,CAAAA,CACpBG,GAAG,CAACM,CAAAA,IAAAA,GAAQC,oBAAAA,CAAqBZ,WAAAA,EAAaW,IAAAA,CAAAA,CAAAA,CAC9CE,MAAM,CAACC,CAAAA,GAAAA,GAAO,CAACX,aAAAA,CAAcY,GAAG,CAACD,GAAAA,CAAAA,CAAAA,CACjCT,GAAG,CAAC,CAACS,GAAAA,IAA8B;YAAEP,SAAAA,EAAWO,GAAAA;AAAKE,YAAAA,UAAAA,EAAY;SAAG,CAAA,CAAA;IAEzE,OAAO;AAAIf,QAAAA,GAAAA,SAAAA;AAAcO,QAAAA,GAAAA;AAAK,KAAA,CAACH,GAAG,CAACC,CAAAA,UAAAA,GAAcW,YAAAA,CAAaX,YAAYJ,QAAQ,CAACI,UAAAA,CAAWC,SAAS,CAACW,KAAK,CAAClB,WAAAA,CAAYmB,MAAM,GAAG,CAAA,CAAA,CAAG,CAAA,CAAA;AAC1I;AAEA,SAASF,YAAAA,CAAaX,UAA+B,EAAEJ,QAAuC,EAAA;IAC1F,IAAI,CAACA,UAAU,OAAOI,UAAAA;IAEtB,OAAO;AACH,QAAA,GAAGA,UAAU;AACbd,QAAAA,WAAAA,EAAac,WAAWd,WAAW,IAAIU,QAAAA,CAASV,WAAW,IAAIc,UAAAA,CAAWC,SAAS,CAACW,KAAK,CAACZ,UAAAA,CAAWC,SAAS,CAACa,OAAO,CAAC,GAAA,CAAA,GAAO,CAAA,CAAA;AAC9H3B,QAAAA,QAAAA,EAAUa,UAAAA,CAAWb,QAAQ,IAAIS,QAAAA,CAAST,QAAQ;AAClD,QAAA,GAAIa,WAAWZ,IAAI,KAAKI,aAAaI,QAAAA,CAASR,IAAI,KAAKI,SAAAA,GAAY;YAAEJ,IAAAA,EAAM2B,aAAAA,CAAcnB,SAASR,IAAI;AAAE,SAAA,GAAI,EAAE;AAC9G,QAAA,GAAIY,WAAWX,QAAQ,KAAKG,aAAaI,QAAAA,CAASP,QAAQ,KAAKG,SAAAA,GAAY;AAAEH,YAAAA,QAAAA,EAAUO,SAASP;AAAS,SAAA,GAAI,EAAE;AAC/G,QAAA,GAAIW,WAAWV,KAAK,KAAKE,aAAaI,QAAAA,CAASN,KAAK,KAAKE,SAAAA,GAAY;AAAEF,YAAAA,KAAAA,EAAOM,SAASN;AAAM,SAAA,GAAI,EAAE;AACnG,QAAA,GAAIU,WAAWT,UAAU,KAAKC,aAAaI,QAAAA,CAASL,UAAU,KAAKC,SAAAA,GAAY;AAAED,YAAAA,UAAAA,EAAYK,SAASL;AAAW,SAAA,GAAI;AACzH,KAAA;AACJ;;"}

package/dist/esm/packages/designModes.d.ts

@@ -0,0 +1,10 @@
+import { ComponentDesignModeDescriptor } from '@cratis/scene.model';
+export declare const itemEditableRule = "item.editable";
+export declare const itemInheritedReason = "item.inherited";
+export interface NavigationDesignModeOptions {
+    itemsPath?: string;
+    sidebar?: boolean;
+}
+export declare function navigationDesignMode(options?: NavigationDesignModeOptions): ComponentDesignModeDescriptor;
+export declare function toolbarDesignMode(): ComponentDesignModeDescriptor;
+//# sourceMappingURL=designModes.d.ts.map

package/dist/esm/packages/designModes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"designModes.d.ts","sourceRoot":"","sources":["../../../packages/designModes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,6BAA6B,EAAuC,MAAM,qBAAqB,CAAC;AAGzG,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAGhD,eAAO,MAAM,mBAAmB,mBAAmB,CAAC;AAWpD,MAAM,WAAW,2BAA2B;IAExC,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAQD,wBAAgB,oBAAoB,CAAC,OAAO,GAAE,2BAAgC,GAAG,6BAA6B,CAoB7G;AAMD,wBAAgB,iBAAiB,IAAI,6BAA6B,CAajE"}

package/dist/esm/packages/designModes.js

@@ -0,0 +1,140 @@
+import { componentIcon } from '@cratis/scene.model';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The rule that says an item may be changed (not inherited), interpreted by the package's design-time bundle. */ const itemEditableRule = 'item.editable';
+/** The rule that says why an inherited item may not be changed. */ const itemInheritedReason = 'item.inherited';
+const mutating = (action, compact)=>({
+        id: action.id,
+        icon: componentIcon(action.icon),
+        title: action.title,
+        ...compact === true ? {
+            compact: true
+        } : {},
+        availability: action.availability ?? itemEditableRule,
+        readOnlyReason: itemInheritedReason
+    });
+/**
+ * The design mode of a component made of navigation items (a topbar, a sidebar, a navigation bar): add an item, and on a selected
+ * item rename it, choose its target and rendering slot, move it earlier or later, duplicate it, delete it, and - in a sidebar - add a
+ * sub-item (spec DM3). Pass the `itemsPath` of a component whose items are a `Collection` property; the target and slot buttons are
+ * left out of such a component unless `itemsPath` is absent, because only the navigation region's items have them.
+ */ function navigationDesignMode(options = {}) {
+    const { itemsPath, sidebar = false } = options;
+    const regionItems = itemsPath === undefined;
+    return {
+        ...itemsPath === undefined ? {} : {
+            itemsPath
+        },
+        addActions: [
+            {
+                id: 'addItem',
+                label: 'Add item',
+                icon: componentIcon('plus'),
+                ...itemsPath === undefined ? {} : {
+                    collectionPath: itemsPath
+                }
+            }
+        ],
+        itemToolbar: [
+            mutating({
+                id: 'rename',
+                icon: 'pencil',
+                title: 'Rename'
+            }, sidebar),
+            ...regionItems ? [
+                mutating({
+                    id: 'target',
+                    icon: 'link',
+                    title: 'Link target'
+                }, sidebar),
+                mutating({
+                    id: 'slot',
+                    icon: 'layout-panel-left',
+                    title: 'Rendering slot'
+                }, sidebar)
+            ] : [],
+            mutating({
+                id: 'moveEarlier',
+                icon: sidebar ? 'arrow-up' : 'arrow-left',
+                title: 'Move earlier'
+            }, sidebar),
+            mutating({
+                id: 'moveLater',
+                icon: sidebar ? 'arrow-down' : 'arrow-right',
+                title: 'Move later'
+            }, sidebar),
+            mutating({
+                id: 'duplicate',
+                icon: 'copy',
+                title: 'Duplicate'
+            }, sidebar),
+            mutating({
+                id: 'delete',
+                icon: 'trash',
+                title: 'Delete'
+            }, sidebar),
+            ...sidebar ? [
+                mutating({
+                    id: 'addSubItem',
+                    icon: 'corner-down-right',
+                    title: 'Add sub-item'
+                }, true)
+            ] : []
+        ]
+    };
+}
+/**
+ * The design mode of a toolbar: add a button, and on a selected button rename it, choose the slice it starts, set its emphasis,
+ * move it earlier or later, duplicate it, delete it (spec DM3). The buttons are the toolbar's own items, which the host resolves.
+ */ function toolbarDesignMode() {
+    return {
+        addActions: [
+            {
+                id: 'addButton',
+                label: 'Add button',
+                icon: componentIcon('plus')
+            }
+        ],
+        itemToolbar: [
+            mutating({
+                id: 'rename',
+                icon: 'pencil',
+                title: 'Rename'
+            }),
+            mutating({
+                id: 'slice',
+                icon: 'git-branch',
+                title: 'Choose slice'
+            }),
+            mutating({
+                id: 'emphasis',
+                icon: 'contrast',
+                title: 'Emphasis'
+            }),
+            mutating({
+                id: 'moveEarlier',
+                icon: 'arrow-left',
+                title: 'Move earlier'
+            }),
+            mutating({
+                id: 'moveLater',
+                icon: 'arrow-right',
+                title: 'Move later'
+            }),
+            mutating({
+                id: 'duplicate',
+                icon: 'copy',
+                title: 'Duplicate'
+            }),
+            mutating({
+                id: 'delete',
+                icon: 'trash',
+                title: 'Delete'
+            })
+        ]
+    };
+}
+
+export { itemEditableRule, itemInheritedReason, navigationDesignMode, toolbarDesignMode };
+//# sourceMappingURL=designModes.js.map

package/dist/esm/packages/designModes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"designModes.js","sources":["../../../packages/designModes.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ComponentDesignModeDescriptor, DesignModeItemAction, componentIcon } from '@cratis/scene.model';\n\n/** The rule that says an item may be changed (not inherited), interpreted by the package's design-time bundle. */\nexport const itemEditableRule = 'item.editable';\n\n/** The rule that says why an inherited item may not be changed. */\nexport const itemInheritedReason = 'item.inherited';\n\nconst mutating = (action: Omit<DesignModeItemAction, 'icon'> & { icon: string }, compact?: boolean): DesignModeItemAction => ({\n    id: action.id,\n    icon: componentIcon(action.icon),\n    title: action.title,\n    ...(compact === true ? { compact: true } : {}),\n    availability: action.availability ?? itemEditableRule,\n    readOnlyReason: itemInheritedReason,\n});\n\nexport interface NavigationDesignModeOptions {\n    /** The `Collection` property that holds the items; absent when the host resolves them (a topbar's or sidebar's navigation region). */\n    itemsPath?: string;\n\n    /** A sidebar's items nest, and its toolbar sits below the item in a compact two-row form (spec DM3, DM4). */\n    sidebar?: boolean;\n}\n\n/**\n * The design mode of a component made of navigation items (a topbar, a sidebar, a navigation bar): add an item, and on a selected\n * item rename it, choose its target and rendering slot, move it earlier or later, duplicate it, delete it, and - in a sidebar - add a\n * sub-item (spec DM3). Pass the `itemsPath` of a component whose items are a `Collection` property; the target and slot buttons are\n * left out of such a component unless `itemsPath` is absent, because only the navigation region's items have them.\n */\nexport function navigationDesignMode(options: NavigationDesignModeOptions = {}): ComponentDesignModeDescriptor {\n    const { itemsPath, sidebar = false } = options;\n    const regionItems = itemsPath === undefined;\n\n    return {\n        ...(itemsPath === undefined ? {} : { itemsPath }),\n        addActions: [{ id: 'addItem', label: 'Add item', icon: componentIcon('plus'), ...(itemsPath === undefined ? {} : { collectionPath: itemsPath }) }],\n        itemToolbar: [\n            mutating({ id: 'rename', icon: 'pencil', title: 'Rename' }, sidebar),\n            ...(regionItems ? [\n                mutating({ id: 'target', icon: 'link', title: 'Link target' }, sidebar),\n                mutating({ id: 'slot', icon: 'layout-panel-left', title: 'Rendering slot' }, sidebar),\n            ] : []),\n            mutating({ id: 'moveEarlier', icon: sidebar ? 'arrow-up' : 'arrow-left', title: 'Move earlier' }, sidebar),\n            mutating({ id: 'moveLater', icon: sidebar ? 'arrow-down' : 'arrow-right', title: 'Move later' }, sidebar),\n            mutating({ id: 'duplicate', icon: 'copy', title: 'Duplicate' }, sidebar),\n            mutating({ id: 'delete', icon: 'trash', title: 'Delete' }, sidebar),\n            ...(sidebar ? [mutating({ id: 'addSubItem', icon: 'corner-down-right', title: 'Add sub-item' }, true)] : []),\n        ],\n    };\n}\n\n/**\n * The design mode of a toolbar: add a button, and on a selected button rename it, choose the slice it starts, set its emphasis,\n * move it earlier or later, duplicate it, delete it (spec DM3). The buttons are the toolbar's own items, which the host resolves.\n */\nexport function toolbarDesignMode(): ComponentDesignModeDescriptor {\n    return {\n        addActions: [{ id: 'addButton', label: 'Add button', icon: componentIcon('plus') }],\n        itemToolbar: [\n            mutating({ id: 'rename', icon: 'pencil', title: 'Rename' }),\n            mutating({ id: 'slice', icon: 'git-branch', title: 'Choose slice' }),\n            mutating({ id: 'emphasis', icon: 'contrast', title: 'Emphasis' }),\n            mutating({ id: 'moveEarlier', icon: 'arrow-left', title: 'Move earlier' }),\n            mutating({ id: 'moveLater', icon: 'arrow-right', title: 'Move later' }),\n            mutating({ id: 'duplicate', icon: 'copy', title: 'Duplicate' }),\n            mutating({ id: 'delete', icon: 'trash', title: 'Delete' }),\n        ],\n    };\n}\n"],"names":["itemEditableRule","itemInheritedReason","mutating","action","compact","id","icon","componentIcon","title","availability","readOnlyReason","navigationDesignMode","options","itemsPath","sidebar","regionItems","undefined","addActions","label","collectionPath","itemToolbar","toolbarDesignMode"],"mappings":";;AAAA;AACA;AAIA,mHACO,MAAMA,gBAAAA,GAAmB;AAEhC,oEACO,MAAMC,mBAAAA,GAAsB;AAEnC,MAAMC,QAAAA,GAAW,CAACC,MAAAA,EAA+DC,OAAAA,IAA6C;AAC1HC,QAAAA,EAAAA,EAAIF,OAAOE,EAAE;QACbC,IAAAA,EAAMC,aAAAA,CAAcJ,OAAOG,IAAI,CAAA;AAC/BE,QAAAA,KAAAA,EAAOL,OAAOK,KAAK;AACnB,QAAA,GAAIJ,YAAY,IAAA,GAAO;YAAEA,OAAAA,EAAS;AAAK,SAAA,GAAI,EAAE;QAC7CK,YAAAA,EAAcN,MAAAA,CAAOM,YAAY,IAAIT,gBAAAA;QACrCU,cAAAA,EAAgBT;KACpB,CAAA;AAUA;;;;;AAKC,IACM,SAASU,oBAAAA,CAAqBC,OAAAA,GAAuC,EAAE,EAAA;AAC1E,IAAA,MAAM,EAAEC,SAAS,EAAEC,OAAAA,GAAU,KAAK,EAAE,GAAGF,OAAAA;AACvC,IAAA,MAAMG,cAAcF,SAAAA,KAAcG,SAAAA;IAElC,OAAO;QACH,GAAIH,SAAAA,KAAcG,SAAAA,GAAY,EAAC,GAAI;AAAEH,YAAAA;SAAW;QAChDI,UAAAA,EAAY;AAAC,YAAA;gBAAEZ,EAAAA,EAAI,SAAA;gBAAWa,KAAAA,EAAO,UAAA;AAAYZ,gBAAAA,IAAAA,EAAMC,aAAAA,CAAc,MAAA,CAAA;gBAAS,GAAIM,SAAAA,KAAcG,SAAAA,GAAY,EAAC,GAAI;oBAAEG,cAAAA,EAAgBN;;AAAa;AAAE,SAAA;QAClJO,WAAAA,EAAa;YACTlB,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,QAAA;gBAAUC,IAAAA,EAAM,QAAA;gBAAUE,KAAAA,EAAO;aAAS,EAAGM,OAAAA,CAAAA;eACxDC,WAAAA,GAAc;gBACdb,QAAAA,CAAS;oBAAEG,EAAAA,EAAI,QAAA;oBAAUC,IAAAA,EAAM,MAAA;oBAAQE,KAAAA,EAAO;iBAAc,EAAGM,OAAAA,CAAAA;gBAC/DZ,QAAAA,CAAS;oBAAEG,EAAAA,EAAI,MAAA;oBAAQC,IAAAA,EAAM,mBAAA;oBAAqBE,KAAAA,EAAO;iBAAiB,EAAGM,OAAAA;AAChF,aAAA,GAAG,EAAE;YACNZ,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,aAAA;AAAeC,gBAAAA,IAAAA,EAAMQ,UAAU,UAAA,GAAa,YAAA;gBAAcN,KAAAA,EAAO;aAAe,EAAGM,OAAAA,CAAAA;YAClGZ,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,WAAA;AAAaC,gBAAAA,IAAAA,EAAMQ,UAAU,YAAA,GAAe,aAAA;gBAAeN,KAAAA,EAAO;aAAa,EAAGM,OAAAA,CAAAA;YACjGZ,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,WAAA;gBAAaC,IAAAA,EAAM,MAAA;gBAAQE,KAAAA,EAAO;aAAY,EAAGM,OAAAA,CAAAA;YAChEZ,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,QAAA;gBAAUC,IAAAA,EAAM,OAAA;gBAASE,KAAAA,EAAO;aAAS,EAAGM,OAAAA,CAAAA;eACvDA,OAAAA,GAAU;gBAACZ,QAAAA,CAAS;oBAAEG,EAAAA,EAAI,YAAA;oBAAcC,IAAAA,EAAM,mBAAA;oBAAqBE,KAAAA,EAAO;iBAAe,EAAG,IAAA;AAAM,aAAA,GAAG;AAC5G;AACL,KAAA;AACJ;AAEA;;;AAGC,IACM,SAASa,iBAAAA,GAAAA;IACZ,OAAO;QACHJ,UAAAA,EAAY;AAAC,YAAA;gBAAEZ,EAAAA,EAAI,WAAA;gBAAaa,KAAAA,EAAO,YAAA;AAAcZ,gBAAAA,IAAAA,EAAMC,aAAAA,CAAc,MAAA;AAAQ;AAAE,SAAA;QACnFa,WAAAA,EAAa;YACTlB,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,QAAA;gBAAUC,IAAAA,EAAM,QAAA;gBAAUE,KAAAA,EAAO;AAAS,aAAA,CAAA;YACzDN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,OAAA;gBAASC,IAAAA,EAAM,YAAA;gBAAcE,KAAAA,EAAO;AAAe,aAAA,CAAA;YAClEN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,UAAA;gBAAYC,IAAAA,EAAM,UAAA;gBAAYE,KAAAA,EAAO;AAAW,aAAA,CAAA;YAC/DN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,aAAA;gBAAeC,IAAAA,EAAM,YAAA;gBAAcE,KAAAA,EAAO;AAAe,aAAA,CAAA;YACxEN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,WAAA;gBAAaC,IAAAA,EAAM,aAAA;gBAAeE,KAAAA,EAAO;AAAa,aAAA,CAAA;YACrEN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,WAAA;gBAAaC,IAAAA,EAAM,MAAA;gBAAQE,KAAAA,EAAO;AAAY,aAAA,CAAA;YAC7DN,QAAAA,CAAS;gBAAEG,EAAAA,EAAI,QAAA;gBAAUC,IAAAA,EAAM,OAAA;gBAASE,KAAAA,EAAO;AAAS,aAAA;AAC3D;AACL,KAAA;AACJ;;"}

package/dist/esm/packages/index.d.ts

@@ -23,6 +23,9 @@ export * from './PackageHostView';
 export * from './resolveDesignTimeHost';
 export * from './runDesignTimeAction';
 export * from './ScenePackageBundle';
+export * from './describeComponents';
+export * from './designModes';
+export * from './validateComponentMetadata';
 export * from './StandalonePackageHost';
 export * from './WebViewPackageHost';
 export * from './ComponentsUiLibraryContract';

package/dist/esm/packages/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/dist/esm/packages/index.js

@@ -23,6 +23,9 @@ export * from './PackageHostView';
 export * from './resolveDesignTimeHost';
 export * from './runDesignTimeAction';
 export * from './ScenePackageBundle';
+export * from './describeComponents';
+export * from './designModes';
+export * from './validateComponentMetadata';
 export * from './StandalonePackageHost';
 export * from './WebViewPackageHost';
 export * from './ComponentsUiLibraryContract';

package/dist/esm/packages/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/dist/esm/packages/validateComponentMetadata.d.ts

@@ -0,0 +1,4 @@
+import { SceneDiagnostic } from '@cratis/scene.model';
+import { ScenePackageBundle } from './ScenePackageBundle';
+export declare function validateComponentMetadata(bundle: ScenePackageBundle): SceneDiagnostic[];
+//# sourceMappingURL=validateComponentMetadata.d.ts.map

package/dist/esm/packages/validateComponentMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateComponentMetadata.d.ts","sourceRoot":"","sources":["../../../packages/validateComponentMetadata.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAwB,MAAM,sBAAsB,CAAC;AAShF,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,kBAAkB,GAAG,eAAe,EAAE,CAOvF"}

package/dist/esm/packages/validateComponentMetadata.js

@@ -0,0 +1,23 @@
+import { validateComponentDescriptors } from '@cratis/scene.engine';
+import { componentRegistryKey } from './ScenePackageBundle.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Checks the component metadata of a bundle (rule CMP1): every component its manifest declares or its registry holds is described
+ * and declares a category, and the design-mode and editor parameters of its descriptors are sound.
+ *
+ * This is not part of `validatePackageBundle`: that gates what a host loads, and a third-party package written before components
+ * had categories must still load. A designer and the in-repo packages' own specs run this one.
+ */ function validateComponentMetadata(bundle) {
+    const registered = new Set([
+        ...bundle.manifest.components.map((name)=>componentRegistryKey(bundle.manifest.name, name)),
+        ...Object.keys(bundle.components)
+    ]);
+    return validateComponentDescriptors(bundle.descriptors ?? [], [
+        ...registered
+    ]);
+}
+
+export { validateComponentMetadata };
+//# sourceMappingURL=validateComponentMetadata.js.map

package/dist/esm/packages/validateComponentMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateComponentMetadata.js","sources":["../../../packages/validateComponentMetadata.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { validateComponentDescriptors } from '@cratis/scene.engine';\nimport { SceneDiagnostic } from '@cratis/scene.model';\nimport { ScenePackageBundle, componentRegistryKey } from './ScenePackageBundle';\n\n/**\n * Checks the component metadata of a bundle (rule CMP1): every component its manifest declares or its registry holds is described\n * and declares a category, and the design-mode and editor parameters of its descriptors are sound.\n *\n * This is not part of `validatePackageBundle`: that gates what a host loads, and a third-party package written before components\n * had categories must still load. A designer and the in-repo packages' own specs run this one.\n */\nexport function validateComponentMetadata(bundle: ScenePackageBundle): SceneDiagnostic[] {\n    const registered = new Set([\n        ...bundle.manifest.components.map(name => componentRegistryKey(bundle.manifest.name, name)),\n        ...Object.keys(bundle.components),\n    ]);\n\n    return validateComponentDescriptors(bundle.descriptors ?? [], [...registered]);\n}\n"],"names":["validateComponentMetadata","bundle","registered","Set","manifest","components","map","name","componentRegistryKey","Object","keys","validateComponentDescriptors","descriptors"],"mappings":";;;AAAA;AACA;AAMA;;;;;;IAOO,SAASA,yBAAAA,CAA0BC,MAA0B,EAAA;IAChE,MAAMC,UAAAA,GAAa,IAAIC,GAAAA,CAAI;AACpBF,QAAAA,GAAAA,MAAAA,CAAOG,QAAQ,CAACC,UAAU,CAACC,GAAG,CAACC,CAAAA,IAAAA,GAAQC,oBAAAA,CAAqBP,MAAAA,CAAOG,QAAQ,CAACG,IAAI,EAAEA,IAAAA,CAAAA,CAAAA;WAClFE,MAAAA,CAAOC,IAAI,CAACT,MAAAA,CAAOI,UAAU;AACnC,KAAA,CAAA;AAED,IAAA,OAAOM,4BAAAA,CAA6BV,MAAAA,CAAOW,WAAW,IAAI,EAAE,EAAE;AAAIV,QAAAA,GAAAA;AAAW,KAAA,CAAA;AACjF;;"}