@cratis/scene.model 4.22.1 → 4.24.0

package/descriptors/ComponentCategory.ts

@@ -0,0 +1,40 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * The categories a component picker groups components under. Every component declares exactly one (rule CMP1).
+ *
+ * The set is open: a package may declare a category of its own, which a validation reports as a warning
+ * ({@link DiagnosticCode.ComponentCategoryUnknown}) rather than refusing, so a picker shows it as a group of its own.
+ * Matching is by the exact words below.
+ */
+export const ComponentCategory = {
+    /** Moves the user between places: topbar, sidebar, tabs, breadcrumbs, stepper. */
+    Navigation: 'Navigation',
+
+    /** Shows data: data table, list, card grid, board, timeline, stat card, chart. */
+    DataDisplay: 'Data display',
+
+    /** Takes a value from the user: text field, select, date picker, tag input, lookup. */
+    Input: 'Input',
+
+    /** Starts something: button, toolbar, menu, command bar. */
+    Actions: 'Actions',
+
+    /** Arranges other components: stack, grid, split pane, card, section. */
+    Layout: 'Layout',
+
+    /** Tells the user what happened or is happening: alert, toast, empty state, progress. */
+    Feedback: 'Feedback',
+
+    /** Appears over the page: dialog, side sheet, popover. */
+    Overlay: 'Overlay',
+
+    /** Collects a command's input: form, wizard, field group. */
+    Forms: 'Forms',
+} as const;
+
+export type ComponentCategory = (typeof ComponentCategory)[keyof typeof ComponentCategory];
+
+/** Every category this model defines, in the order a picker lists them. */
+export const componentCategories: readonly string[] = Object.values(ComponentCategory);

package/descriptors/ComponentDescriptor.ts

@@ -1,6 +1,8 @@
 // Copyright (c) Cratis. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+import { IconReference } from '../icons';
+import { ComponentDesignModeDescriptor } from './ComponentDesignModeDescriptor';
 import { DesignTimeActionDescriptor } from './DesignTimeActionDescriptor';
 import { PropertyDescriptor } from './PropertyDescriptor';
 
@@ -23,6 +25,25 @@ export interface ComponentDescriptor {
 
     description?: string;
 
+    /**
+     * The group a component picker lists the component under (rule CMP1: every component declares one). One of
+     * {@link ComponentCategory}, or a category the package adds. Optional in the type so a descriptor can be built up in steps;
+     * `validateComponentDescriptors` reports a component that ends without one.
+     */
+    category?: string;
+
+    /** The icon a picker shows for the component. */
+    icon?: IconReference;
+
+    /** Two letters a picker shows when it has no icon to draw. Absent means derive them from `displayName` (`componentBadge`). */
+    badge?: string;
+
+    /** Words a picker's filter matches besides the name and the category - "grid" for a data table. */
+    keywords?: string[];
+
+    /** How the component is edited directly on the design surface, as data. */
+    designMode?: ComponentDesignModeDescriptor;
+
     /** Names a specialised editor for the component as a whole, when its properties are not edited one by one. */
     editorKind?: string;
 
@@ -39,5 +60,5 @@ export interface ComponentDescriptor {
 }
 
 export const ComponentDescriptorPropertyNames: (keyof ComponentDescriptor)[] = [
-    'component', 'displayName', 'description', 'editorKind', 'properties', 'actions', 'previewKind', 'propertyDisplayKind',
+    'component', 'displayName', 'description', 'category', 'icon', 'badge', 'keywords', 'designMode', 'editorKind', 'properties', 'actions', 'previewKind', 'propertyDisplayKind',
 ];

package/descriptors/ComponentDesignModeDescriptor.ts

@@ -0,0 +1,76 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { IconReference } from '../icons';
+
+/**
+ * An affordance a designer shows on the design surface to add an item to a component (the "+ Add tab" button of a tab strip,
+ * the "Add item" of a toolbar).
+ */
+export interface DesignModeAddAction {
+    /** Stable identity, unique within the component. */
+    id: string;
+
+    /** The label the designer shows. */
+    label: string;
+
+    /** The icon the designer shows next to it. */
+    icon?: IconReference;
+
+    /**
+     * The `Collection` property of the component the new item is added to - the add is the ordinary `AddCollectionItem` edit. Absent,
+     * the item is added to the component's own items, which the host resolves (the navigation region of a topbar, the children of a
+     * toolbar).
+     */
+    collectionPath?: string;
+}
+
+/**
+ * One button of the toolbar a designer shows over a selected item of a component.
+ *
+ * `availability` and `readOnlyReason` are rule *names*, interpreted by the package's design-time bundle exactly like
+ * {@link DesignTimeActionDescriptor.availability}. The model carries no functions.
+ */
+export interface DesignModeItemAction {
+    /** Stable identity, unique within the component. */
+    id: string;
+
+    /** The icon of the button. */
+    icon: IconReference;
+
+    /** The tooltip and accessible name of the button. */
+    title: string;
+
+    /** The button is shown without its title, in a tight row. */
+    compact?: boolean;
+
+    /** Names the rule that decides whether the button is shown and enabled for an item. Absent means always. */
+    availability?: string;
+
+    /** Names the rule that says why a read-only (inherited) item hides or disables the button. */
+    readOnlyReason?: string;
+}
+
+/**
+ * How a component is edited directly on the design surface: where its items are and which affordances the designer offers for
+ * them. Plain data - a Visual Studio-style designer reads it without loading the component. Every edit it causes is a normal model edit
+ * (`AddCollectionItem`, `RemoveCollectionItem`, `ReorderCollectionItems`, `EditCollectionItem`), so undo, redo and the dirty state
+ * need nothing of their own.
+ */
+export interface ComponentDesignModeDescriptor {
+    /**
+     * The `Collection` property whose rows are the component's items. Absent when the items are not a property of the
+     * component but something the host resolves - the navigation items of a topbar, the children of a toolbar.
+     */
+    itemsPath?: string;
+
+    /** The "add" affordances. */
+    addActions: DesignModeAddAction[];
+
+    /** The buttons over a selected item. */
+    itemToolbar: DesignModeItemAction[];
+}
+
+export const DesignModeAddActionPropertyNames: (keyof DesignModeAddAction)[] = ['id', 'label', 'icon', 'collectionPath'];
+export const DesignModeItemActionPropertyNames: (keyof DesignModeItemAction)[] = ['id', 'icon', 'title', 'compact', 'availability', 'readOnlyReason'];
+export const ComponentDesignModeDescriptorPropertyNames: (keyof ComponentDesignModeDescriptor)[] = ['itemsPath', 'addActions', 'itemToolbar'];

package/descriptors/PropertyDescriptor.ts

@@ -5,6 +5,7 @@ import { BindingMode, BindingSourceKind } from '../common';
 import { CollectionItemDescriptor } from './CollectionItemDescriptor';
 import { PropertyChoice } from './PropertyChoice';
 import { PropertyConstraints } from './PropertyConstraints';
+import { PropertyEditorOptions } from './PropertyEditorOptions';
 import { PropertyValueType } from './PropertyValueType';
 
 /**
@@ -41,6 +42,9 @@ export interface PropertyDescriptor {
      */
     editorKind?: string;
 
+    /** The parameters of the named editor - multi-line, placeholder, unit, step, slice kinds, the reference filter. */
+    editorOptions?: PropertyEditorOptions;
+
     /** A sentence of help for the editor. */
     description?: string;
 
@@ -75,6 +79,6 @@ export interface PropertyDescriptor {
 }
 
 export const PropertyDescriptorPropertyNames: (keyof PropertyDescriptor)[] = [
-    'path', 'label', 'group', 'valueType', 'choices', 'default', 'constraints', 'editorKind', 'description', 'item', 'properties', 'open', 'readOnly',
+    'path', 'label', 'group', 'valueType', 'choices', 'default', 'constraints', 'editorKind', 'editorOptions', 'description', 'item', 'properties', 'open', 'readOnly',
     'output', 'acceptedBindingKinds', 'bindingMode',
 ];

package/descriptors/PropertyEditorKind.ts

@@ -2,7 +2,11 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 /**
- * The editor kinds for values that have no fields to describe, so a host can edit them without asking for JSON text.
+ * The editor ids Studio's property-editor registry resolves (spec section 8). A property names one in `editorKind`; a host that
+ * does not know the id falls back to the default editor for `valueType`, and a package may name ids of its own (they are strings).
+ * This vocabulary defines only the ids and, in {@link PropertyEditorOptions}, their parameters - the editors themselves belong to the host.
+ *
+ * It starts with the editors for values that have no fields to describe, so a host can edit them without asking for JSON text.
  *
  * A list of plain values is a `json` property - Scene keeps the array exactly as authored - whose `editorKind` says what
  * its entries are. A record whose keys are the author's own (a row of data, keyed by column) is an `object` property
@@ -23,6 +27,57 @@ export const PropertyEditorKind = {
 
     /** A record of words, numbers and flags under names the author chooses. */
     StringMap: 'stringMap',
+
+    /** A single line of text; `editorOptions.multiline` makes it a box, `editorOptions.placeholder` hints it. */
+    Text: 'text',
+
+    /** A number; `constraints.minimum`/`maximum` and `editorOptions.step`/`unit` shape it. */
+    Number: 'number',
+
+    /** A switch with a label. */
+    Boolean: 'boolean',
+
+    /** Up to four choices as segmented chips. */
+    Enum: 'enum',
+
+    /** Any number of choices as a dropdown with a filter. */
+    Select: 'select',
+
+    /** A theme token first, a custom colour second. */
+    Color: 'color',
+
+    /** An icon from a searchable grid. */
+    Icon: 'icon',
+
+    /** A list of simple items: add, remove, reorder rows. */
+    List: 'list',
+
+    /** The id of another model element, from a searchable dropdown restricted by `editorOptions.reference`. */
+    Reference: 'reference',
+
+    /** The target of a navigation item: a Module > Feature tree, shown as a breadcrumb when closed. */
+    NavigationTarget: 'navigationTarget',
+
+    /** One of the slots of the effective template, with a mini diagram of its position. */
+    RenderingSlot: 'renderingSlot',
+
+    /** A slice from the slice tree; `editorOptions.kinds` (for example `['StateChange']`) filters, the rest are listed disabled with a reason. */
+    Slice: 'slice',
+
+    /** How a region relates to what it inherits: `inherit`, `extend` or `override`, as a three-way control. */
+    InheritanceMode: 'inheritanceMode',
+
+    /** A reference to a template, chosen through the template picker. */
+    Template: 'template',
+
+    /** A reference to a sample data pack. */
+    SampleData: 'sampleData',
+
+    /** A field of the shape a component is bound to, typed by `editorOptions.fieldKinds`. */
+    Field: 'field',
+
+    /** The columns of a table: rows of `{ field, header, width, align, format }`. */
+    ColumnList: 'columnList',
 } as const;
 
 export type PropertyEditorKind = (typeof PropertyEditorKind)[keyof typeof PropertyEditorKind];

package/descriptors/PropertyEditorOptions.ts

@@ -0,0 +1,51 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * What a `reference` editor offers: the model elements of one kind, narrowed by a named rule.
+ */
+export interface ReferenceFilterDescriptor {
+    /** The kind of model element referenced: `screen`, `slice`, `template`, `shape`, `field` ... A host maps it to what it can list. */
+    target: string;
+
+    /** Narrows the target to these kinds (a slice is a `StateChange`, a `ReadModel` ...). Absent means every kind. */
+    kinds?: string[];
+
+    /** Names the rule that decides which candidates are offered, interpreted by the host - like `availability` of a design-time action. */
+    predicate?: string;
+}
+
+/**
+ * The parameters of a named editor, alongside `PropertyDescriptor.editorKind`: the bits a generic editor needs that are not a value
+ * constraint. Every field is optional and only the ones an editor documents are read.
+ */
+export interface PropertyEditorOptions {
+    /** `text`: a multi-line box instead of a single line. */
+    multiline?: boolean;
+
+    /** `text`: the hint shown while empty. */
+    placeholder?: string;
+
+    /** `number`: the unit shown after the value (`px`, `%`, `ms`). */
+    unit?: string;
+
+    /** `number`: the increment of a stepper. The range is `constraints.minimum` and `constraints.maximum`. */
+    step?: number;
+
+    /** `slice`: the slice kinds that can be chosen (`['StateChange']`); others are listed disabled with a reason. */
+    kinds?: string[];
+
+    /** `reference`: what can be referenced. Required by the `reference` editor. */
+    reference?: ReferenceFilterDescriptor;
+
+    /** `field`: the kinds of field offered (`string`, `number`, `boolean` ...). Absent means any. */
+    fieldKinds?: string[];
+
+    /** `color`: only theme tokens, no custom colour. */
+    tokensOnly?: boolean;
+}
+
+export const ReferenceFilterDescriptorPropertyNames: (keyof ReferenceFilterDescriptor)[] = ['target', 'kinds', 'predicate'];
+export const PropertyEditorOptionsPropertyNames: (keyof PropertyEditorOptions)[] = [
+    'multiline', 'placeholder', 'unit', 'step', 'kinds', 'reference', 'fieldKinds', 'tokensOnly',
+];

package/descriptors/componentIcon.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { IconReference } from '../icons';
+
+/**
+ * The icon library the built-in components' icons come from: the Lucide library package a Cratis host ships. A component's icon is an
+ * ordinary {@link IconReference}, so a host without that library shows the component's badge instead (see the component picker) and
+ * the icon diagnostics report it like any other icon.
+ */
+export const componentIconLibrary = 'Cratis.Icons.Lucide';
+
+/** The icon with this key in {@link componentIconLibrary}. */
+export function componentIcon(key: string): IconReference {
+    return { library: componentIconLibrary, key };
+}

package/descriptors/index.ts

@@ -3,6 +3,7 @@
 
 export * from './PropertyValueType';
 export * from './PropertyEditorKind';
+export * from './PropertyEditorOptions';
 export * from './PropertyChoice';
 export * from './PropertyConstraints';
 export * from './CollectionItemDescriptor';
@@ -10,6 +11,9 @@ export * from './DesignTimeActionDescriptor';
 export * from './DesignTimeActionPlacement';
 export * from './PackageDesignTimeMetadata';
 export * from './PropertyDescriptor';
+export * from './ComponentCategory';
+export * from './ComponentDesignModeDescriptor';
+export * from './componentIcon';
 export * from './ComponentDescriptor';
 export * from './CollectionOperation';
 export * from './LayoutType';

package/dist/cjs/descriptors/ComponentCategory.js

@@ -0,0 +1,25 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The categories a component picker groups components under. Every component declares exactly one (rule CMP1).
+ *
+ * The set is open: a package may declare a category of its own, which a validation reports as a warning
+ * ({@link DiagnosticCode.ComponentCategoryUnknown}) rather than refusing, so a picker shows it as a group of its own.
+ * Matching is by the exact words below.
+ */ const ComponentCategory = {
+    /** Moves the user between places: topbar, sidebar, tabs, breadcrumbs, stepper. */ Navigation: 'Navigation',
+    /** Shows data: data table, list, card grid, board, timeline, stat card, chart. */ DataDisplay: 'Data display',
+    /** Takes a value from the user: text field, select, date picker, tag input, lookup. */ Input: 'Input',
+    /** Starts something: button, toolbar, menu, command bar. */ Actions: 'Actions',
+    /** Arranges other components: stack, grid, split pane, card, section. */ Layout: 'Layout',
+    /** Tells the user what happened or is happening: alert, toast, empty state, progress. */ Feedback: 'Feedback',
+    /** Appears over the page: dialog, side sheet, popover. */ Overlay: 'Overlay',
+    /** Collects a command's input: form, wizard, field group. */ Forms: 'Forms'
+};
+/** Every category this model defines, in the order a picker lists them. */ const componentCategories = Object.values(ComponentCategory);
+
+exports.ComponentCategory = ComponentCategory;
+exports.componentCategories = componentCategories;
+//# sourceMappingURL=ComponentCategory.js.map

package/dist/cjs/descriptors/ComponentCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentCategory.js","sources":["../../../descriptors/ComponentCategory.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\n/**\n * The categories a component picker groups components under. Every component declares exactly one (rule CMP1).\n *\n * The set is open: a package may declare a category of its own, which a validation reports as a warning\n * ({@link DiagnosticCode.ComponentCategoryUnknown}) rather than refusing, so a picker shows it as a group of its own.\n * Matching is by the exact words below.\n */\nexport const ComponentCategory = {\n    /** Moves the user between places: topbar, sidebar, tabs, breadcrumbs, stepper. */\n    Navigation: 'Navigation',\n\n    /** Shows data: data table, list, card grid, board, timeline, stat card, chart. */\n    DataDisplay: 'Data display',\n\n    /** Takes a value from the user: text field, select, date picker, tag input, lookup. */\n    Input: 'Input',\n\n    /** Starts something: button, toolbar, menu, command bar. */\n    Actions: 'Actions',\n\n    /** Arranges other components: stack, grid, split pane, card, section. */\n    Layout: 'Layout',\n\n    /** Tells the user what happened or is happening: alert, toast, empty state, progress. */\n    Feedback: 'Feedback',\n\n    /** Appears over the page: dialog, side sheet, popover. */\n    Overlay: 'Overlay',\n\n    /** Collects a command's input: form, wizard, field group. */\n    Forms: 'Forms',\n} as const;\n\nexport type ComponentCategory = (typeof ComponentCategory)[keyof typeof ComponentCategory];\n\n/** Every category this model defines, in the order a picker lists them. */\nexport const componentCategories: readonly string[] = Object.values(ComponentCategory);\n"],"names":["ComponentCategory","Navigation","DataDisplay","Input","Actions","Layout","Feedback","Overlay","Forms","componentCategories","Object","values"],"mappings":";;AAAA;AACA;AAEA;;;;;;UAOaA,iBAAAA,GAAoB;AAC7B,uFACAC,UAAAA,EAAY,YAAA;AAEZ,uFACAC,WAAAA,EAAa,cAAA;AAEb,4FACAC,KAAAA,EAAO,OAAA;AAEP,iEACAC,OAAAA,EAAS,SAAA;AAET,8EACAC,MAAAA,EAAQ,QAAA;AAER,8FACAC,QAAAA,EAAU,UAAA;AAEV,+DACAC,OAAAA,EAAS,SAAA;AAET,kEACAC,KAAAA,EAAO;AACX;AAIA,4EACO,MAAMC,sBAAyCC,MAAAA,CAAOC,MAAM,CAACX,iBAAAA;;;"}

package/dist/cjs/descriptors/ComponentDescriptor.js

@@ -6,6 +6,11 @@ const ComponentDescriptorPropertyNames = [
     'component',
     'displayName',
     'description',
+    'category',
+    'icon',
+    'badge',
+    'keywords',
+    'designMode',
     'editorKind',
     'properties',
     'actions',

package/dist/cjs/descriptors/ComponentDescriptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComponentDescriptor.js","sources":["../../../descriptors/ComponentDescriptor.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 { DesignTimeActionDescriptor } from './DesignTimeActionDescriptor';\nimport { PropertyDescriptor } from './PropertyDescriptor';\n\n/**\n * What can be edited on one component a package provides.\n *\n * Packages contribute these alongside the components themselves (a bundle's `descriptors`), through the same\n * package mechanism that already carries components, layouts and themes - there is no second registry to keep in\n * step.\n */\nexport interface ComponentDescriptor {\n    /**\n     * The component this describes, as the package names it: `<package>:<bare name>`, the same key a bundle\n     * registers the component under (for example `Cratis.Components:dataTable`).\n     */\n    component: string;\n\n    /** A human-readable name for a palette or an inspector title. */\n    displayName?: string;\n\n    description?: string;\n\n    /** Names a specialised editor for the component as a whole, when its properties are not edited one by one. */\n    editorKind?: string;\n\n    properties: PropertyDescriptor[];\n\n    /** Package-provided design-time actions for this component. */\n    actions?: DesignTimeActionDescriptor[];\n\n    /** Names an optional package-provided preview renderer. */\n    previewKind?: string;\n\n    /** Names an optional package-provided property display renderer set. */\n    propertyDisplayKind?: string;\n}\n\nexport const ComponentDescriptorPropertyNames: (keyof ComponentDescriptor)[] = [\n    'component', 'displayName', 'description', 'editorKind', 'properties', 'actions', 'previewKind', 'propertyDisplayKind',\n];\n"],"names":["ComponentDescriptorPropertyNames"],"mappings":";;AAAA;AACA;MAuCaA,gCAAAA,GAAkE;AAC3E,IAAA,WAAA;AAAa,IAAA,aAAA;AAAe,IAAA,aAAA;AAAe,IAAA,YAAA;AAAc,IAAA,YAAA;AAAc,IAAA,SAAA;AAAW,IAAA,aAAA;AAAe,IAAA;;;"}
+{"version":3,"file":"ComponentDescriptor.js","sources":["../../../descriptors/ComponentDescriptor.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 { IconReference } from '../icons';\nimport { ComponentDesignModeDescriptor } from './ComponentDesignModeDescriptor';\nimport { DesignTimeActionDescriptor } from './DesignTimeActionDescriptor';\nimport { PropertyDescriptor } from './PropertyDescriptor';\n\n/**\n * What can be edited on one component a package provides.\n *\n * Packages contribute these alongside the components themselves (a bundle's `descriptors`), through the same\n * package mechanism that already carries components, layouts and themes - there is no second registry to keep in\n * step.\n */\nexport interface ComponentDescriptor {\n    /**\n     * The component this describes, as the package names it: `<package>:<bare name>`, the same key a bundle\n     * registers the component under (for example `Cratis.Components:dataTable`).\n     */\n    component: string;\n\n    /** A human-readable name for a palette or an inspector title. */\n    displayName?: string;\n\n    description?: string;\n\n    /**\n     * The group a component picker lists the component under (rule CMP1: every component declares one). One of\n     * {@link ComponentCategory}, or a category the package adds. Optional in the type so a descriptor can be built up in steps;\n     * `validateComponentDescriptors` reports a component that ends without one.\n     */\n    category?: string;\n\n    /** The icon a picker shows for the component. */\n    icon?: IconReference;\n\n    /** Two letters a picker shows when it has no icon to draw. Absent means derive them from `displayName` (`componentBadge`). */\n    badge?: string;\n\n    /** Words a picker's filter matches besides the name and the category - \"grid\" for a data table. */\n    keywords?: string[];\n\n    /** How the component is edited directly on the design surface, as data. */\n    designMode?: ComponentDesignModeDescriptor;\n\n    /** Names a specialised editor for the component as a whole, when its properties are not edited one by one. */\n    editorKind?: string;\n\n    properties: PropertyDescriptor[];\n\n    /** Package-provided design-time actions for this component. */\n    actions?: DesignTimeActionDescriptor[];\n\n    /** Names an optional package-provided preview renderer. */\n    previewKind?: string;\n\n    /** Names an optional package-provided property display renderer set. */\n    propertyDisplayKind?: string;\n}\n\nexport const ComponentDescriptorPropertyNames: (keyof ComponentDescriptor)[] = [\n    'component', 'displayName', 'description', 'category', 'icon', 'badge', 'keywords', 'designMode', 'editorKind', 'properties', 'actions', 'previewKind', 'propertyDisplayKind',\n];\n"],"names":["ComponentDescriptorPropertyNames"],"mappings":";;AAAA;AACA;MA4DaA,gCAAAA,GAAkE;AAC3E,IAAA,WAAA;AAAa,IAAA,aAAA;AAAe,IAAA,aAAA;AAAe,IAAA,UAAA;AAAY,IAAA,MAAA;AAAQ,IAAA,OAAA;AAAS,IAAA,UAAA;AAAY,IAAA,YAAA;AAAc,IAAA,YAAA;AAAc,IAAA,YAAA;AAAc,IAAA,SAAA;AAAW,IAAA,aAAA;AAAe,IAAA;;;"}

package/dist/cjs/descriptors/ComponentDesignModeDescriptor.js

@@ -0,0 +1,28 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const DesignModeAddActionPropertyNames = [
+    'id',
+    'label',
+    'icon',
+    'collectionPath'
+];
+const DesignModeItemActionPropertyNames = [
+    'id',
+    'icon',
+    'title',
+    'compact',
+    'availability',
+    'readOnlyReason'
+];
+const ComponentDesignModeDescriptorPropertyNames = [
+    'itemsPath',
+    'addActions',
+    'itemToolbar'
+];
+
+exports.ComponentDesignModeDescriptorPropertyNames = ComponentDesignModeDescriptorPropertyNames;
+exports.DesignModeAddActionPropertyNames = DesignModeAddActionPropertyNames;
+exports.DesignModeItemActionPropertyNames = DesignModeItemActionPropertyNames;
+//# sourceMappingURL=ComponentDesignModeDescriptor.js.map

package/dist/cjs/descriptors/ComponentDesignModeDescriptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentDesignModeDescriptor.js","sources":["../../../descriptors/ComponentDesignModeDescriptor.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 { IconReference } from '../icons';\n\n/**\n * An affordance a designer shows on the design surface to add an item to a component (the \"+ Add tab\" button of a tab strip,\n * the \"Add item\" of a toolbar).\n */\nexport interface DesignModeAddAction {\n    /** Stable identity, unique within the component. */\n    id: string;\n\n    /** The label the designer shows. */\n    label: string;\n\n    /** The icon the designer shows next to it. */\n    icon?: IconReference;\n\n    /**\n     * The `Collection` property of the component the new item is added to - the add is the ordinary `AddCollectionItem` edit. Absent,\n     * the item is added to the component's own items, which the host resolves (the navigation region of a topbar, the children of a\n     * toolbar).\n     */\n    collectionPath?: string;\n}\n\n/**\n * One button of the toolbar a designer shows over a selected item of a component.\n *\n * `availability` and `readOnlyReason` are rule *names*, interpreted by the package's design-time bundle exactly like\n * {@link DesignTimeActionDescriptor.availability}. The model carries no functions.\n */\nexport interface DesignModeItemAction {\n    /** Stable identity, unique within the component. */\n    id: string;\n\n    /** The icon of the button. */\n    icon: IconReference;\n\n    /** The tooltip and accessible name of the button. */\n    title: string;\n\n    /** The button is shown without its title, in a tight row. */\n    compact?: boolean;\n\n    /** Names the rule that decides whether the button is shown and enabled for an item. Absent means always. */\n    availability?: string;\n\n    /** Names the rule that says why a read-only (inherited) item hides or disables the button. */\n    readOnlyReason?: string;\n}\n\n/**\n * How a component is edited directly on the design surface: where its items are and which affordances the designer offers for\n * them. Plain data - a Visual Studio-style designer reads it without loading the component. Every edit it causes is a normal model edit\n * (`AddCollectionItem`, `RemoveCollectionItem`, `ReorderCollectionItems`, `EditCollectionItem`), so undo, redo and the dirty state\n * need nothing of their own.\n */\nexport interface ComponentDesignModeDescriptor {\n    /**\n     * The `Collection` property whose rows are the component's items. Absent when the items are not a property of the\n     * component but something the host resolves - the navigation items of a topbar, the children of a toolbar.\n     */\n    itemsPath?: string;\n\n    /** The \"add\" affordances. */\n    addActions: DesignModeAddAction[];\n\n    /** The buttons over a selected item. */\n    itemToolbar: DesignModeItemAction[];\n}\n\nexport const DesignModeAddActionPropertyNames: (keyof DesignModeAddAction)[] = ['id', 'label', 'icon', 'collectionPath'];\nexport const DesignModeItemActionPropertyNames: (keyof DesignModeItemAction)[] = ['id', 'icon', 'title', 'compact', 'availability', 'readOnlyReason'];\nexport const ComponentDesignModeDescriptorPropertyNames: (keyof ComponentDesignModeDescriptor)[] = ['itemsPath', 'addActions', 'itemToolbar'];\n"],"names":["DesignModeAddActionPropertyNames","DesignModeItemActionPropertyNames","ComponentDesignModeDescriptorPropertyNames"],"mappings":";;AAAA;AACA;MAwEaA,gCAAAA,GAAkE;AAAC,IAAA,IAAA;AAAM,IAAA,OAAA;AAAS,IAAA,MAAA;AAAQ,IAAA;;MAC1FC,iCAAAA,GAAoE;AAAC,IAAA,IAAA;AAAM,IAAA,MAAA;AAAQ,IAAA,OAAA;AAAS,IAAA,SAAA;AAAW,IAAA,cAAA;AAAgB,IAAA;;MACvHC,0CAAAA,GAAsF;AAAC,IAAA,WAAA;AAAa,IAAA,YAAA;AAAc,IAAA;;;;;"}

package/dist/cjs/descriptors/PropertyDescriptor.js

@@ -11,6 +11,7 @@ const PropertyDescriptorPropertyNames = [
     'default',
     'constraints',
     'editorKind',
+    'editorOptions',
     'description',
     'item',
     'properties',

package/dist/cjs/descriptors/PropertyDescriptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyDescriptor.js","sources":["../../../descriptors/PropertyDescriptor.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 { BindingMode, BindingSourceKind } from '../common';\nimport { CollectionItemDescriptor } from './CollectionItemDescriptor';\nimport { PropertyChoice } from './PropertyChoice';\nimport { PropertyConstraints } from './PropertyConstraints';\nimport { PropertyValueType } from './PropertyValueType';\n\n/**\n * Describes one editable property of a node: where it lives, what it is called, what it may hold and how a host\n * should edit it. A descriptor is plain data, so packages ship them and Studio reads them without loading a\n * component.\n */\nexport interface PropertyDescriptor {\n    /**\n     * Where the value lives. For an `ExternalComponent` it is a key (or dotted key path) in the element's\n     * `properties` bag; for a model-native node such as a flow container it is the node's own property name.\n     */\n    path: string;\n\n    /** The label an editor shows. */\n    label: string;\n\n    /** The editor section the property belongs to. */\n    group: string;\n\n    valueType: PropertyValueType;\n\n    /** The allowed values of an `Enum` property. */\n    choices?: PropertyChoice[];\n\n    /** The value in effect when none is set. */\n    default?: unknown;\n\n    constraints?: PropertyConstraints;\n\n    /**\n     * Names a specialised editor. A host maps the name to its own editor - an icon picker, a query binder - and\n     * falls back to the default editor for `valueType` when it does not know the name.\n     */\n    editorKind?: string;\n\n    /** A sentence of help for the editor. */\n    description?: string;\n\n    /** Describes the items of a `Collection` property. Required when `valueType` is `Collection`. */\n    item?: CollectionItemDescriptor;\n\n    /**\n     * Describes the fields of an `Object` property. A field's `path` is a single name relative to the object, and\n     * a field may itself be an `Object` or a `Collection`, so a structured value of any depth can be described.\n     * Without it an `Object` value is only editable through a specialised `editorKind`.\n     */\n    properties?: PropertyDescriptor[];\n\n    /**\n     * An `Object` property's value may carry fields `properties` does not describe. They are kept as they are and never\n     * edited. Without it a field the descriptor does not describe is refused. Use it when `properties` lists the fields an\n     * editor offers but the stored value may legitimately have more - a chart dataset, a record read from a sample.\n     */\n    open?: boolean;\n\n    /** The value is shown but never edited. */\n    readOnly?: boolean;\n\n    /** This property is emitted by the component and may be bound by other elements. */\n    output?: boolean;\n\n    /** Which binding source kinds may be assigned to this property. */\n    acceptedBindingKinds?: BindingSourceKind[];\n\n    /** The strongest binding mode the property supports. */\n    bindingMode?: BindingMode;\n}\n\nexport const PropertyDescriptorPropertyNames: (keyof PropertyDescriptor)[] = [\n    'path', 'label', 'group', 'valueType', 'choices', 'default', 'constraints', 'editorKind', 'description', 'item', 'properties', 'open', 'readOnly',\n    'output', 'acceptedBindingKinds', 'bindingMode',\n];\n"],"names":["PropertyDescriptorPropertyNames"],"mappings":";;AAAA;AACA;MA2EaA,+BAAAA,GAAgE;AACzE,IAAA,MAAA;AAAQ,IAAA,OAAA;AAAS,IAAA,OAAA;AAAS,IAAA,WAAA;AAAa,IAAA,SAAA;AAAW,IAAA,SAAA;AAAW,IAAA,aAAA;AAAe,IAAA,YAAA;AAAc,IAAA,aAAA;AAAe,IAAA,MAAA;AAAQ,IAAA,YAAA;AAAc,IAAA,MAAA;AAAQ,IAAA,UAAA;AACvI,IAAA,QAAA;AAAU,IAAA,sBAAA;AAAwB,IAAA;;;"}
+{"version":3,"file":"PropertyDescriptor.js","sources":["../../../descriptors/PropertyDescriptor.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 { BindingMode, BindingSourceKind } from '../common';\nimport { CollectionItemDescriptor } from './CollectionItemDescriptor';\nimport { PropertyChoice } from './PropertyChoice';\nimport { PropertyConstraints } from './PropertyConstraints';\nimport { PropertyEditorOptions } from './PropertyEditorOptions';\nimport { PropertyValueType } from './PropertyValueType';\n\n/**\n * Describes one editable property of a node: where it lives, what it is called, what it may hold and how a host\n * should edit it. A descriptor is plain data, so packages ship them and Studio reads them without loading a\n * component.\n */\nexport interface PropertyDescriptor {\n    /**\n     * Where the value lives. For an `ExternalComponent` it is a key (or dotted key path) in the element's\n     * `properties` bag; for a model-native node such as a flow container it is the node's own property name.\n     */\n    path: string;\n\n    /** The label an editor shows. */\n    label: string;\n\n    /** The editor section the property belongs to. */\n    group: string;\n\n    valueType: PropertyValueType;\n\n    /** The allowed values of an `Enum` property. */\n    choices?: PropertyChoice[];\n\n    /** The value in effect when none is set. */\n    default?: unknown;\n\n    constraints?: PropertyConstraints;\n\n    /**\n     * Names a specialised editor. A host maps the name to its own editor - an icon picker, a query binder - and\n     * falls back to the default editor for `valueType` when it does not know the name.\n     */\n    editorKind?: string;\n\n    /** The parameters of the named editor - multi-line, placeholder, unit, step, slice kinds, the reference filter. */\n    editorOptions?: PropertyEditorOptions;\n\n    /** A sentence of help for the editor. */\n    description?: string;\n\n    /** Describes the items of a `Collection` property. Required when `valueType` is `Collection`. */\n    item?: CollectionItemDescriptor;\n\n    /**\n     * Describes the fields of an `Object` property. A field's `path` is a single name relative to the object, and\n     * a field may itself be an `Object` or a `Collection`, so a structured value of any depth can be described.\n     * Without it an `Object` value is only editable through a specialised `editorKind`.\n     */\n    properties?: PropertyDescriptor[];\n\n    /**\n     * An `Object` property's value may carry fields `properties` does not describe. They are kept as they are and never\n     * edited. Without it a field the descriptor does not describe is refused. Use it when `properties` lists the fields an\n     * editor offers but the stored value may legitimately have more - a chart dataset, a record read from a sample.\n     */\n    open?: boolean;\n\n    /** The value is shown but never edited. */\n    readOnly?: boolean;\n\n    /** This property is emitted by the component and may be bound by other elements. */\n    output?: boolean;\n\n    /** Which binding source kinds may be assigned to this property. */\n    acceptedBindingKinds?: BindingSourceKind[];\n\n    /** The strongest binding mode the property supports. */\n    bindingMode?: BindingMode;\n}\n\nexport const PropertyDescriptorPropertyNames: (keyof PropertyDescriptor)[] = [\n    'path', 'label', 'group', 'valueType', 'choices', 'default', 'constraints', 'editorKind', 'editorOptions', 'description', 'item', 'properties', 'open', 'readOnly',\n    'output', 'acceptedBindingKinds', 'bindingMode',\n];\n"],"names":["PropertyDescriptorPropertyNames"],"mappings":";;AAAA;AACA;MA+EaA,+BAAAA,GAAgE;AACzE,IAAA,MAAA;AAAQ,IAAA,OAAA;AAAS,IAAA,OAAA;AAAS,IAAA,WAAA;AAAa,IAAA,SAAA;AAAW,IAAA,SAAA;AAAW,IAAA,aAAA;AAAe,IAAA,YAAA;AAAc,IAAA,eAAA;AAAiB,IAAA,aAAA;AAAe,IAAA,MAAA;AAAQ,IAAA,YAAA;AAAc,IAAA,MAAA;AAAQ,IAAA,UAAA;AACxJ,IAAA,QAAA;AAAU,IAAA,sBAAA;AAAwB,IAAA;;;"}

package/dist/cjs/descriptors/PropertyEditorKind.js

@@ -3,7 +3,11 @@
 // Copyright (c) Cratis. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 /**
- * The editor kinds for values that have no fields to describe, so a host can edit them without asking for JSON text.
+ * The editor ids Studio's property-editor registry resolves (spec section 8). A property names one in `editorKind`; a host that
+ * does not know the id falls back to the default editor for `valueType`, and a package may name ids of its own (they are strings).
+ * This vocabulary defines only the ids and, in {@link PropertyEditorOptions}, their parameters - the editors themselves belong to the host.
+ *
+ * It starts with the editors for values that have no fields to describe, so a host can edit them without asking for JSON text.
  *
  * A list of plain values is a `json` property - Scene keeps the array exactly as authored - whose `editorKind` says what
  * its entries are. A record whose keys are the author's own (a row of data, keyed by column) is an `object` property
@@ -13,7 +17,24 @@
     /** An ordered list of numbers. */ NumberList: 'numberList',
     /** One word, or an ordered list of words: a chart colour is one colour for the series or one for each point. */ StringOrList: 'stringOrList',
     /** One word, number or flag - a value whose type the author chooses, such as the selected value of a control whose options carry any of them. */ Scalar: 'scalar',
-    /** A record of words, numbers and flags under names the author chooses. */ StringMap: 'stringMap'
+    /** A record of words, numbers and flags under names the author chooses. */ StringMap: 'stringMap',
+    /** A single line of text; `editorOptions.multiline` makes it a box, `editorOptions.placeholder` hints it. */ Text: 'text',
+    /** A number; `constraints.minimum`/`maximum` and `editorOptions.step`/`unit` shape it. */ Number: 'number',
+    /** A switch with a label. */ Boolean: 'boolean',
+    /** Up to four choices as segmented chips. */ Enum: 'enum',
+    /** Any number of choices as a dropdown with a filter. */ Select: 'select',
+    /** A theme token first, a custom colour second. */ Color: 'color',
+    /** An icon from a searchable grid. */ Icon: 'icon',
+    /** A list of simple items: add, remove, reorder rows. */ List: 'list',
+    /** The id of another model element, from a searchable dropdown restricted by `editorOptions.reference`. */ Reference: 'reference',
+    /** The target of a navigation item: a Module > Feature tree, shown as a breadcrumb when closed. */ NavigationTarget: 'navigationTarget',
+    /** One of the slots of the effective template, with a mini diagram of its position. */ RenderingSlot: 'renderingSlot',
+    /** A slice from the slice tree; `editorOptions.kinds` (for example `['StateChange']`) filters, the rest are listed disabled with a reason. */ Slice: 'slice',
+    /** How a region relates to what it inherits: `inherit`, `extend` or `override`, as a three-way control. */ InheritanceMode: 'inheritanceMode',
+    /** A reference to a template, chosen through the template picker. */ Template: 'template',
+    /** A reference to a sample data pack. */ SampleData: 'sampleData',
+    /** A field of the shape a component is bound to, typed by `editorOptions.fieldKinds`. */ Field: 'field',
+    /** The columns of a table: rows of `{ field, header, width, align, format }`. */ ColumnList: 'columnList'
 };
 
 exports.PropertyEditorKind = PropertyEditorKind;

package/dist/cjs/descriptors/PropertyEditorKind.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyEditorKind.js","sources":["../../../descriptors/PropertyEditorKind.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\n/**\n * The editor kinds for values that have no fields to describe, so a host can edit them without asking for JSON text.\n *\n * A list of plain values is a `json` property - Scene keeps the array exactly as authored - whose `editorKind` says what\n * its entries are. A record whose keys are the author's own (a row of data, keyed by column) is an `object` property\n * with no `properties` and the `stringMap` kind. A host that does not know a kind falls back to its default editor.\n */\nexport const PropertyEditorKind = {\n    /** An ordered list of words. */\n    StringList: 'stringList',\n\n    /** An ordered list of numbers. */\n    NumberList: 'numberList',\n\n    /** One word, or an ordered list of words: a chart colour is one colour for the series or one for each point. */\n    StringOrList: 'stringOrList',\n\n    /** One word, number or flag - a value whose type the author chooses, such as the selected value of a control whose options carry any of them. */\n    Scalar: 'scalar',\n\n    /** A record of words, numbers and flags under names the author chooses. */\n    StringMap: 'stringMap',\n} as const;\n\nexport type PropertyEditorKind = (typeof PropertyEditorKind)[keyof typeof PropertyEditorKind];\n"],"names":["PropertyEditorKind","StringList","NumberList","StringOrList","Scalar","StringMap"],"mappings":";;AAAA;AACA;AAEA;;;;;;UAOaA,kBAAAA,GAAqB;AAC9B,qCACAC,UAAAA,EAAY,YAAA;AAEZ,uCACAC,UAAAA,EAAY,YAAA;AAEZ,qHACAC,YAAAA,EAAc,cAAA;AAEd,sJACAC,MAAAA,EAAQ,QAAA;AAER,gFACAC,SAAAA,EAAW;AACf;;"}
+{"version":3,"file":"PropertyEditorKind.js","sources":["../../../descriptors/PropertyEditorKind.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\n/**\n * The editor ids Studio's property-editor registry resolves (spec section 8). A property names one in `editorKind`; a host that\n * does not know the id falls back to the default editor for `valueType`, and a package may name ids of its own (they are strings).\n * This vocabulary defines only the ids and, in {@link PropertyEditorOptions}, their parameters - the editors themselves belong to the host.\n *\n * It starts with the editors for values that have no fields to describe, so a host can edit them without asking for JSON text.\n *\n * A list of plain values is a `json` property - Scene keeps the array exactly as authored - whose `editorKind` says what\n * its entries are. A record whose keys are the author's own (a row of data, keyed by column) is an `object` property\n * with no `properties` and the `stringMap` kind. A host that does not know a kind falls back to its default editor.\n */\nexport const PropertyEditorKind = {\n    /** An ordered list of words. */\n    StringList: 'stringList',\n\n    /** An ordered list of numbers. */\n    NumberList: 'numberList',\n\n    /** One word, or an ordered list of words: a chart colour is one colour for the series or one for each point. */\n    StringOrList: 'stringOrList',\n\n    /** One word, number or flag - a value whose type the author chooses, such as the selected value of a control whose options carry any of them. */\n    Scalar: 'scalar',\n\n    /** A record of words, numbers and flags under names the author chooses. */\n    StringMap: 'stringMap',\n\n    /** A single line of text; `editorOptions.multiline` makes it a box, `editorOptions.placeholder` hints it. */\n    Text: 'text',\n\n    /** A number; `constraints.minimum`/`maximum` and `editorOptions.step`/`unit` shape it. */\n    Number: 'number',\n\n    /** A switch with a label. */\n    Boolean: 'boolean',\n\n    /** Up to four choices as segmented chips. */\n    Enum: 'enum',\n\n    /** Any number of choices as a dropdown with a filter. */\n    Select: 'select',\n\n    /** A theme token first, a custom colour second. */\n    Color: 'color',\n\n    /** An icon from a searchable grid. */\n    Icon: 'icon',\n\n    /** A list of simple items: add, remove, reorder rows. */\n    List: 'list',\n\n    /** The id of another model element, from a searchable dropdown restricted by `editorOptions.reference`. */\n    Reference: 'reference',\n\n    /** The target of a navigation item: a Module > Feature tree, shown as a breadcrumb when closed. */\n    NavigationTarget: 'navigationTarget',\n\n    /** One of the slots of the effective template, with a mini diagram of its position. */\n    RenderingSlot: 'renderingSlot',\n\n    /** A slice from the slice tree; `editorOptions.kinds` (for example `['StateChange']`) filters, the rest are listed disabled with a reason. */\n    Slice: 'slice',\n\n    /** How a region relates to what it inherits: `inherit`, `extend` or `override`, as a three-way control. */\n    InheritanceMode: 'inheritanceMode',\n\n    /** A reference to a template, chosen through the template picker. */\n    Template: 'template',\n\n    /** A reference to a sample data pack. */\n    SampleData: 'sampleData',\n\n    /** A field of the shape a component is bound to, typed by `editorOptions.fieldKinds`. */\n    Field: 'field',\n\n    /** The columns of a table: rows of `{ field, header, width, align, format }`. */\n    ColumnList: 'columnList',\n} as const;\n\nexport type PropertyEditorKind = (typeof PropertyEditorKind)[keyof typeof PropertyEditorKind];\n"],"names":["PropertyEditorKind","StringList","NumberList","StringOrList","Scalar","StringMap","Text","Number","Boolean","Enum","Select","Color","Icon","List","Reference","NavigationTarget","RenderingSlot","Slice","InheritanceMode","Template","SampleData","Field","ColumnList"],"mappings":";;AAAA;AACA;AAEA;;;;;;;;;;UAWaA,kBAAAA,GAAqB;AAC9B,qCACAC,UAAAA,EAAY,YAAA;AAEZ,uCACAC,UAAAA,EAAY,YAAA;AAEZ,qHACAC,YAAAA,EAAc,cAAA;AAEd,sJACAC,MAAAA,EAAQ,QAAA;AAER,gFACAC,SAAAA,EAAW,WAAA;AAEX,kHACAC,IAAAA,EAAM,MAAA;AAEN,+FACAC,MAAAA,EAAQ,QAAA;AAER,kCACAC,OAAAA,EAAS,SAAA;AAET,kDACAC,IAAAA,EAAM,MAAA;AAEN,8DACAC,MAAAA,EAAQ,QAAA;AAER,wDACAC,KAAAA,EAAO,OAAA;AAEP,2CACAC,IAAAA,EAAM,MAAA;AAEN,8DACAC,IAAAA,EAAM,MAAA;AAEN,gHACAC,SAAAA,EAAW,WAAA;AAEX,wGACAC,gBAAAA,EAAkB,kBAAA;AAElB,4FACAC,aAAAA,EAAe,eAAA;AAEf,mJACAC,KAAAA,EAAO,OAAA;AAEP,gHACAC,eAAAA,EAAiB,iBAAA;AAEjB,0EACAC,QAAAA,EAAU,UAAA;AAEV,8CACAC,UAAAA,EAAY,YAAA;AAEZ,8FACAC,KAAAA,EAAO,OAAA;AAEP,sFACAC,UAAAA,EAAY;AAChB;;"}

package/dist/cjs/descriptors/PropertyEditorOptions.js

@@ -0,0 +1,25 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * What a `reference` editor offers: the model elements of one kind, narrowed by a named rule.
+ */ const ReferenceFilterDescriptorPropertyNames = [
+    'target',
+    'kinds',
+    'predicate'
+];
+const PropertyEditorOptionsPropertyNames = [
+    'multiline',
+    'placeholder',
+    'unit',
+    'step',
+    'kinds',
+    'reference',
+    'fieldKinds',
+    'tokensOnly'
+];
+
+exports.PropertyEditorOptionsPropertyNames = PropertyEditorOptionsPropertyNames;
+exports.ReferenceFilterDescriptorPropertyNames = ReferenceFilterDescriptorPropertyNames;
+//# sourceMappingURL=PropertyEditorOptions.js.map

package/dist/cjs/descriptors/PropertyEditorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyEditorOptions.js","sources":["../../../descriptors/PropertyEditorOptions.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\n/**\n * What a `reference` editor offers: the model elements of one kind, narrowed by a named rule.\n */\nexport interface ReferenceFilterDescriptor {\n    /** The kind of model element referenced: `screen`, `slice`, `template`, `shape`, `field` ... A host maps it to what it can list. */\n    target: string;\n\n    /** Narrows the target to these kinds (a slice is a `StateChange`, a `ReadModel` ...). Absent means every kind. */\n    kinds?: string[];\n\n    /** Names the rule that decides which candidates are offered, interpreted by the host - like `availability` of a design-time action. */\n    predicate?: string;\n}\n\n/**\n * The parameters of a named editor, alongside `PropertyDescriptor.editorKind`: the bits a generic editor needs that are not a value\n * constraint. Every field is optional and only the ones an editor documents are read.\n */\nexport interface PropertyEditorOptions {\n    /** `text`: a multi-line box instead of a single line. */\n    multiline?: boolean;\n\n    /** `text`: the hint shown while empty. */\n    placeholder?: string;\n\n    /** `number`: the unit shown after the value (`px`, `%`, `ms`). */\n    unit?: string;\n\n    /** `number`: the increment of a stepper. The range is `constraints.minimum` and `constraints.maximum`. */\n    step?: number;\n\n    /** `slice`: the slice kinds that can be chosen (`['StateChange']`); others are listed disabled with a reason. */\n    kinds?: string[];\n\n    /** `reference`: what can be referenced. Required by the `reference` editor. */\n    reference?: ReferenceFilterDescriptor;\n\n    /** `field`: the kinds of field offered (`string`, `number`, `boolean` ...). Absent means any. */\n    fieldKinds?: string[];\n\n    /** `color`: only theme tokens, no custom colour. */\n    tokensOnly?: boolean;\n}\n\nexport const ReferenceFilterDescriptorPropertyNames: (keyof ReferenceFilterDescriptor)[] = ['target', 'kinds', 'predicate'];\nexport const PropertyEditorOptionsPropertyNames: (keyof PropertyEditorOptions)[] = [\n    'multiline', 'placeholder', 'unit', 'step', 'kinds', 'reference', 'fieldKinds', 'tokensOnly',\n];\n"],"names":["ReferenceFilterDescriptorPropertyNames","PropertyEditorOptionsPropertyNames"],"mappings":";;AAAA;AACA;AAEA;;UA4CaA,sCAAAA,GAA8E;AAAC,IAAA,QAAA;AAAU,IAAA,OAAA;AAAS,IAAA;;MAClGC,kCAAAA,GAAsE;AAC/E,IAAA,WAAA;AAAa,IAAA,aAAA;AAAe,IAAA,MAAA;AAAQ,IAAA,MAAA;AAAQ,IAAA,OAAA;AAAS,IAAA,WAAA;AAAa,IAAA,YAAA;AAAc,IAAA;;;;"}

package/dist/cjs/descriptors/componentIcon.js

@@ -0,0 +1,19 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The icon library the built-in components' icons come from: the Lucide library package a Cratis host ships. A component's icon is an
+ * ordinary {@link IconReference}, so a host without that library shows the component's badge instead (see the component picker) and
+ * the icon diagnostics report it like any other icon.
+ */ const componentIconLibrary = 'Cratis.Icons.Lucide';
+/** The icon with this key in {@link componentIconLibrary}. */ function componentIcon(key) {
+    return {
+        library: componentIconLibrary,
+        key
+    };
+}
+
+exports.componentIcon = componentIcon;
+exports.componentIconLibrary = componentIconLibrary;
+//# sourceMappingURL=componentIcon.js.map

package/dist/cjs/descriptors/componentIcon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentIcon.js","sources":["../../../descriptors/componentIcon.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 { IconReference } from '../icons';\n\n/**\n * The icon library the built-in components' icons come from: the Lucide library package a Cratis host ships. A component's icon is an\n * ordinary {@link IconReference}, so a host without that library shows the component's badge instead (see the component picker) and\n * the icon diagnostics report it like any other icon.\n */\nexport const componentIconLibrary = 'Cratis.Icons.Lucide';\n\n/** The icon with this key in {@link componentIconLibrary}. */\nexport function componentIcon(key: string): IconReference {\n    return { library: componentIconLibrary, key };\n}\n"],"names":["componentIconLibrary","componentIcon","key","library"],"mappings":";;AAAA;AACA;AAIA;;;;IAKO,MAAMA,oBAAAA,GAAuB;AAEpC,+DACO,SAASC,aAAAA,CAAcC,GAAW,EAAA;IACrC,OAAO;QAAEC,OAAAA,EAASH,oBAAAA;AAAsBE,QAAAA;AAAI,KAAA;AAChD;;;"}

package/dist/cjs/editing/DiagnosticCode.js

@@ -57,6 +57,11 @@
     DiagnosticCode["IncompatibleIconLibrary"] = "incompatibleIconLibrary";
     DiagnosticCode["IconCatalogUnavailable"] = "iconCatalogUnavailable";
     DiagnosticCode["IconNotVerified"] = "iconNotVerified";
+    // Component metadata
+    DiagnosticCode["ComponentCategoryMissing"] = "componentCategoryMissing";
+    DiagnosticCode["ComponentCategoryUnknown"] = "componentCategoryUnknown";
+    DiagnosticCode["ComponentDesignModeInvalid"] = "componentDesignModeInvalid";
+    DiagnosticCode["PropertyEditorOptionsInvalid"] = "propertyEditorOptionsInvalid";
     return DiagnosticCode;
 }({});