@cratis/scene.engine 4.2.0 → 4.3.0

package/dist/esm/editing/layoutTypeDescriptors.js

@@ -0,0 +1,421 @@
+import { PropertyValueType, Visibility, LayoutChildPlacement, LayoutType, HorizontalAlignment, VerticalAlignment, Orientation } 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.
+function choices(enumObject) {
+    return Object.values(enumObject).map((value)=>({
+            value,
+            label: value
+        }));
+}
+const spacing = (path, label, group)=>({
+        path,
+        label,
+        group,
+        valueType: PropertyValueType.Number,
+        default: 0,
+        constraints: {
+            minimum: 0
+        }
+    });
+const flowNodeProperties = [
+    {
+        path: 'grow',
+        label: 'Grow',
+        group: 'Layout',
+        valueType: PropertyValueType.Number,
+        description: 'How much of the free space in its container this node takes, relative to its siblings.',
+        constraints: {
+            minimum: 0
+        }
+    },
+    {
+        path: 'span',
+        label: 'Span',
+        group: 'Layout',
+        valueType: PropertyValueType.Number,
+        description: 'How many grid columns this node spans. Only meaningful inside a grid.',
+        constraints: {
+            minimum: 1,
+            integer: true
+        }
+    }
+];
+const flowContainerProperties = [
+    spacing('gap', 'Gap', 'Layout'),
+    ...flowNodeProperties
+];
+const panelProperties = [
+    {
+        path: 'name',
+        label: 'Name',
+        group: 'General',
+        valueType: PropertyValueType.String
+    },
+    {
+        path: 'visibility',
+        label: 'Visibility',
+        group: 'General',
+        valueType: PropertyValueType.Enum,
+        choices: choices(Visibility),
+        default: Visibility.Visible
+    },
+    {
+        path: 'isEnabled',
+        label: 'Enabled',
+        group: 'General',
+        valueType: PropertyValueType.Boolean,
+        default: true
+    },
+    {
+        path: 'opacity',
+        label: 'Opacity',
+        group: 'General',
+        valueType: PropertyValueType.Number,
+        default: 1,
+        constraints: {
+            minimum: 0,
+            maximum: 1
+        }
+    },
+    {
+        path: 'horizontalAlignment',
+        label: 'Horizontal alignment',
+        group: 'Layout',
+        valueType: PropertyValueType.Enum,
+        choices: choices(HorizontalAlignment)
+    },
+    {
+        path: 'verticalAlignment',
+        label: 'Vertical alignment',
+        group: 'Layout',
+        valueType: PropertyValueType.Enum,
+        choices: choices(VerticalAlignment)
+    },
+    {
+        path: 'zIndex',
+        label: 'Stacking order',
+        group: 'Layout',
+        valueType: PropertyValueType.Number,
+        default: 0,
+        constraints: {
+            integer: true
+        }
+    }
+];
+const orientation = {
+    path: 'orientation',
+    label: 'Orientation',
+    group: 'Layout',
+    valueType: PropertyValueType.Enum,
+    choices: choices(Orientation)
+};
+const panelChildren = {
+    acceptsChildren: true,
+    childPlacement: LayoutChildPlacement.Ordered,
+    supportsSizeClassVariants: false
+};
+/**
+ * The layout type -> capability matrix, as data. Every {@link LayoutType} has exactly one entry; the
+ * documentation's matrix is this table.
+ */ const layoutTypeDescriptors = [
+    {
+        type: LayoutType.FlowRow,
+        label: 'Row',
+        description: 'Reflows its children horizontally.',
+        capabilities: {
+            acceptsChildren: true,
+            childPlacement: LayoutChildPlacement.Ordered,
+            supportsGridSpan: false,
+            supportsSizeClassVariants: true,
+            convertibleTo: [
+                LayoutType.FlowColumn,
+                LayoutType.FlowGrid
+            ]
+        },
+        properties: flowContainerProperties
+    },
+    {
+        type: LayoutType.FlowColumn,
+        label: 'Column',
+        description: 'Reflows its children vertically.',
+        capabilities: {
+            acceptsChildren: true,
+            childPlacement: LayoutChildPlacement.Ordered,
+            supportsGridSpan: false,
+            supportsSizeClassVariants: true,
+            convertibleTo: [
+                LayoutType.FlowRow,
+                LayoutType.FlowGrid
+            ]
+        },
+        properties: flowContainerProperties
+    },
+    {
+        type: LayoutType.FlowGrid,
+        label: 'Grid',
+        description: 'Arranges its children in a grid; children can span columns.',
+        capabilities: {
+            acceptsChildren: true,
+            childPlacement: LayoutChildPlacement.Ordered,
+            supportsGridSpan: true,
+            supportsSizeClassVariants: true,
+            convertibleTo: [
+                LayoutType.FlowRow,
+                LayoutType.FlowColumn
+            ]
+        },
+        properties: [
+            ...flowContainerProperties,
+            {
+                path: 'columns',
+                label: 'Columns',
+                group: 'Layout',
+                valueType: PropertyValueType.Number,
+                constraints: {
+                    minimum: 1,
+                    integer: true
+                }
+            },
+            {
+                path: 'rows',
+                label: 'Rows',
+                group: 'Layout',
+                valueType: PropertyValueType.Number,
+                constraints: {
+                    minimum: 1,
+                    integer: true
+                }
+            }
+        ]
+    },
+    {
+        type: LayoutType.FlowLeaf,
+        label: 'Content',
+        description: 'Positions one element within a flow.',
+        capabilities: {
+            acceptsChildren: false,
+            maximumChildren: 1,
+            childPlacement: LayoutChildPlacement.None,
+            supportsGridSpan: true,
+            supportsSizeClassVariants: false,
+            convertibleTo: []
+        },
+        properties: flowNodeProperties
+    },
+    {
+        type: LayoutType.FlowSlotLeaf,
+        label: 'Slot',
+        description: 'Positions one of the layout\'s own named slots within its arrangement.',
+        capabilities: {
+            acceptsChildren: false,
+            childPlacement: LayoutChildPlacement.None,
+            supportsGridSpan: true,
+            supportsSizeClassVariants: false,
+            convertibleTo: []
+        },
+        properties: [
+            {
+                path: 'slotName',
+                label: 'Slot',
+                group: 'Layout',
+                valueType: PropertyValueType.String,
+                constraints: {
+                    required: true
+                }
+            },
+            ...flowNodeProperties
+        ]
+    },
+    {
+        type: LayoutType.Freeform,
+        label: 'Freeform',
+        description: 'Places each child at its own position and size, one variant per size class.',
+        capabilities: {
+            acceptsChildren: true,
+            childPlacement: LayoutChildPlacement.Positioned,
+            supportsGridSpan: false,
+            supportsSizeClassVariants: true,
+            convertibleTo: []
+        },
+        properties: []
+    },
+    {
+        type: LayoutType.StackPanel,
+        label: 'Stack panel',
+        description: 'Stacks its children in one direction with a fixed spacing.',
+        capabilities: {
+            ...panelChildren,
+            supportsGridSpan: false,
+            convertibleTo: [
+                LayoutType.WrapPanel,
+                LayoutType.DockPanel
+            ]
+        },
+        properties: [
+            ...panelProperties,
+            orientation,
+            spacing('spacing', 'Spacing', 'Layout')
+        ]
+    },
+    {
+        type: LayoutType.WrapPanel,
+        label: 'Wrap panel',
+        description: 'Lays children out along a line and wraps to the next when it is full.',
+        capabilities: {
+            ...panelChildren,
+            supportsGridSpan: false,
+            convertibleTo: [
+                LayoutType.StackPanel,
+                LayoutType.DockPanel
+            ]
+        },
+        properties: [
+            ...panelProperties,
+            orientation,
+            {
+                path: 'itemWidth',
+                label: 'Item width',
+                group: 'Layout',
+                valueType: PropertyValueType.Number,
+                constraints: {
+                    minimum: 0
+                }
+            },
+            {
+                path: 'itemHeight',
+                label: 'Item height',
+                group: 'Layout',
+                valueType: PropertyValueType.Number,
+                constraints: {
+                    minimum: 0
+                }
+            }
+        ]
+    },
+    {
+        type: LayoutType.DockPanel,
+        label: 'Dock panel',
+        description: 'Docks each child against an edge; the last child can fill what remains.',
+        capabilities: {
+            ...panelChildren,
+            supportsGridSpan: false,
+            convertibleTo: [
+                LayoutType.StackPanel,
+                LayoutType.WrapPanel
+            ]
+        },
+        properties: [
+            ...panelProperties,
+            {
+                path: 'lastChildFill',
+                label: 'Last child fills',
+                group: 'Layout',
+                valueType: PropertyValueType.Boolean,
+                default: true
+            }
+        ]
+    },
+    {
+        type: LayoutType.GridPanel,
+        label: 'Grid panel',
+        description: 'Positions children in rows and columns defined by the panel.',
+        capabilities: {
+            ...panelChildren,
+            supportsGridSpan: true,
+            convertibleTo: []
+        },
+        properties: [
+            ...panelProperties,
+            {
+                path: 'rows',
+                label: 'Rows',
+                group: 'Layout',
+                valueType: PropertyValueType.Object,
+                editorKind: 'gridDefinitions'
+            },
+            {
+                path: 'columns',
+                label: 'Columns',
+                group: 'Layout',
+                valueType: PropertyValueType.Object,
+                editorKind: 'gridDefinitions'
+            }
+        ]
+    },
+    {
+        type: LayoutType.Canvas,
+        label: 'Canvas',
+        description: 'Places each child at an absolute position.',
+        capabilities: {
+            acceptsChildren: true,
+            childPlacement: LayoutChildPlacement.Positioned,
+            supportsGridSpan: false,
+            supportsSizeClassVariants: false,
+            convertibleTo: []
+        },
+        properties: [
+            ...panelProperties,
+            {
+                path: 'extent',
+                label: 'Extent',
+                group: 'Layout',
+                valueType: PropertyValueType.Object,
+                editorKind: 'size'
+            }
+        ]
+    }
+];
+/**
+ * The editable properties of a placement within a freeform variant - an element's or a slot's position and size.
+ */ const placementProperties = [
+    {
+        path: 'x',
+        label: 'Left',
+        group: 'Placement',
+        valueType: PropertyValueType.Number
+    },
+    {
+        path: 'y',
+        label: 'Top',
+        group: 'Placement',
+        valueType: PropertyValueType.Number
+    },
+    {
+        path: 'width',
+        label: 'Width',
+        group: 'Placement',
+        valueType: PropertyValueType.Number,
+        constraints: {
+            minimum: 0
+        }
+    },
+    {
+        path: 'height',
+        label: 'Height',
+        group: 'Placement',
+        valueType: PropertyValueType.Number,
+        constraints: {
+            minimum: 0
+        }
+    }
+];
+/**
+ * The editable properties of a screen template or dialog template itself.
+ */ const templateProperties = [
+    {
+        path: 'displayName',
+        label: 'Display name',
+        group: 'General',
+        valueType: PropertyValueType.String
+    },
+    {
+        path: 'description',
+        label: 'Description',
+        group: 'General',
+        valueType: PropertyValueType.String
+    }
+];
+
+export { layoutTypeDescriptors, placementProperties, templateProperties };
+//# sourceMappingURL=layoutTypeDescriptors.js.map

package/dist/esm/editing/layoutTypeDescriptors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layoutTypeDescriptors.js","sources":["../../../editing/layoutTypeDescriptors.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 {\n    HorizontalAlignment, LayoutChildPlacement, LayoutType, LayoutTypeDescriptor, Orientation, PropertyChoice,\n    PropertyDescriptor, PropertyValueType, VerticalAlignment, Visibility,\n} from '@cratis/scene.model';\n\nfunction choices(enumObject: Record<string, string>): PropertyChoice[] {\n    return Object.values(enumObject).map(value => ({ value, label: value }));\n}\n\nconst spacing = (path: string, label: string, group: string): PropertyDescriptor => ({\n    path, label, group, valueType: PropertyValueType.Number, default: 0, constraints: { minimum: 0 },\n});\n\nconst flowNodeProperties: PropertyDescriptor[] = [\n    {\n        path: 'grow', label: 'Grow', group: 'Layout', valueType: PropertyValueType.Number,\n        description: 'How much of the free space in its container this node takes, relative to its siblings.',\n        constraints: { minimum: 0 },\n    },\n    {\n        path: 'span', label: 'Span', group: 'Layout', valueType: PropertyValueType.Number,\n        description: 'How many grid columns this node spans. Only meaningful inside a grid.',\n        constraints: { minimum: 1, integer: true },\n    },\n];\n\nconst flowContainerProperties: PropertyDescriptor[] = [spacing('gap', 'Gap', 'Layout'), ...flowNodeProperties];\n\nconst panelProperties: PropertyDescriptor[] = [\n    { path: 'name', label: 'Name', group: 'General', valueType: PropertyValueType.String },\n    { path: 'visibility', label: 'Visibility', group: 'General', valueType: PropertyValueType.Enum, choices: choices(Visibility), default: Visibility.Visible },\n    { path: 'isEnabled', label: 'Enabled', group: 'General', valueType: PropertyValueType.Boolean, default: true },\n    { path: 'opacity', label: 'Opacity', group: 'General', valueType: PropertyValueType.Number, default: 1, constraints: { minimum: 0, maximum: 1 } },\n    { path: 'horizontalAlignment', label: 'Horizontal alignment', group: 'Layout', valueType: PropertyValueType.Enum, choices: choices(HorizontalAlignment) },\n    { path: 'verticalAlignment', label: 'Vertical alignment', group: 'Layout', valueType: PropertyValueType.Enum, choices: choices(VerticalAlignment) },\n    { path: 'zIndex', label: 'Stacking order', group: 'Layout', valueType: PropertyValueType.Number, default: 0, constraints: { integer: true } },\n];\n\nconst orientation: PropertyDescriptor = {\n    path: 'orientation', label: 'Orientation', group: 'Layout', valueType: PropertyValueType.Enum, choices: choices(Orientation),\n};\n\nconst panelChildren = { acceptsChildren: true, childPlacement: LayoutChildPlacement.Ordered, supportsSizeClassVariants: false };\n\n/**\n * The layout type -> capability matrix, as data. Every {@link LayoutType} has exactly one entry; the\n * documentation's matrix is this table.\n */\nexport const layoutTypeDescriptors: LayoutTypeDescriptor[] = [\n    {\n        type: LayoutType.FlowRow,\n        label: 'Row',\n        description: 'Reflows its children horizontally.',\n        capabilities: {\n            acceptsChildren: true, childPlacement: LayoutChildPlacement.Ordered, supportsGridSpan: false,\n            supportsSizeClassVariants: true, convertibleTo: [LayoutType.FlowColumn, LayoutType.FlowGrid],\n        },\n        properties: flowContainerProperties,\n    },\n    {\n        type: LayoutType.FlowColumn,\n        label: 'Column',\n        description: 'Reflows its children vertically.',\n        capabilities: {\n            acceptsChildren: true, childPlacement: LayoutChildPlacement.Ordered, supportsGridSpan: false,\n            supportsSizeClassVariants: true, convertibleTo: [LayoutType.FlowRow, LayoutType.FlowGrid],\n        },\n        properties: flowContainerProperties,\n    },\n    {\n        type: LayoutType.FlowGrid,\n        label: 'Grid',\n        description: 'Arranges its children in a grid; children can span columns.',\n        capabilities: {\n            acceptsChildren: true, childPlacement: LayoutChildPlacement.Ordered, supportsGridSpan: true,\n            supportsSizeClassVariants: true, convertibleTo: [LayoutType.FlowRow, LayoutType.FlowColumn],\n        },\n        properties: [\n            ...flowContainerProperties,\n            { path: 'columns', label: 'Columns', group: 'Layout', valueType: PropertyValueType.Number, constraints: { minimum: 1, integer: true } },\n            { path: 'rows', label: 'Rows', group: 'Layout', valueType: PropertyValueType.Number, constraints: { minimum: 1, integer: true } },\n        ],\n    },\n    {\n        type: LayoutType.FlowLeaf,\n        label: 'Content',\n        description: 'Positions one element within a flow.',\n        capabilities: {\n            acceptsChildren: false, maximumChildren: 1, childPlacement: LayoutChildPlacement.None, supportsGridSpan: true,\n            supportsSizeClassVariants: false, convertibleTo: [],\n        },\n        properties: flowNodeProperties,\n    },\n    {\n        type: LayoutType.FlowSlotLeaf,\n        label: 'Slot',\n        description: 'Positions one of the layout\\'s own named slots within its arrangement.',\n        capabilities: {\n            acceptsChildren: false, childPlacement: LayoutChildPlacement.None, supportsGridSpan: true,\n            supportsSizeClassVariants: false, convertibleTo: [],\n        },\n        properties: [\n            { path: 'slotName', label: 'Slot', group: 'Layout', valueType: PropertyValueType.String, constraints: { required: true } },\n            ...flowNodeProperties,\n        ],\n    },\n    {\n        type: LayoutType.Freeform,\n        label: 'Freeform',\n        description: 'Places each child at its own position and size, one variant per size class.',\n        capabilities: {\n            acceptsChildren: true, childPlacement: LayoutChildPlacement.Positioned, supportsGridSpan: false,\n            supportsSizeClassVariants: true, convertibleTo: [],\n        },\n        properties: [],\n    },\n    {\n        type: LayoutType.StackPanel,\n        label: 'Stack panel',\n        description: 'Stacks its children in one direction with a fixed spacing.',\n        capabilities: { ...panelChildren, supportsGridSpan: false, convertibleTo: [LayoutType.WrapPanel, LayoutType.DockPanel] },\n        properties: [...panelProperties, orientation, spacing('spacing', 'Spacing', 'Layout')],\n    },\n    {\n        type: LayoutType.WrapPanel,\n        label: 'Wrap panel',\n        description: 'Lays children out along a line and wraps to the next when it is full.',\n        capabilities: { ...panelChildren, supportsGridSpan: false, convertibleTo: [LayoutType.StackPanel, LayoutType.DockPanel] },\n        properties: [\n            ...panelProperties,\n            orientation,\n            { path: 'itemWidth', label: 'Item width', group: 'Layout', valueType: PropertyValueType.Number, constraints: { minimum: 0 } },\n            { path: 'itemHeight', label: 'Item height', group: 'Layout', valueType: PropertyValueType.Number, constraints: { minimum: 0 } },\n        ],\n    },\n    {\n        type: LayoutType.DockPanel,\n        label: 'Dock panel',\n        description: 'Docks each child against an edge; the last child can fill what remains.',\n        capabilities: { ...panelChildren, supportsGridSpan: false, convertibleTo: [LayoutType.StackPanel, LayoutType.WrapPanel] },\n        properties: [\n            ...panelProperties,\n            { path: 'lastChildFill', label: 'Last child fills', group: 'Layout', valueType: PropertyValueType.Boolean, default: true },\n        ],\n    },\n    {\n        type: LayoutType.GridPanel,\n        label: 'Grid panel',\n        description: 'Positions children in rows and columns defined by the panel.',\n        capabilities: { ...panelChildren, supportsGridSpan: true, convertibleTo: [] },\n        properties: [\n            ...panelProperties,\n            { path: 'rows', label: 'Rows', group: 'Layout', valueType: PropertyValueType.Object, editorKind: 'gridDefinitions' },\n            { path: 'columns', label: 'Columns', group: 'Layout', valueType: PropertyValueType.Object, editorKind: 'gridDefinitions' },\n        ],\n    },\n    {\n        type: LayoutType.Canvas,\n        label: 'Canvas',\n        description: 'Places each child at an absolute position.',\n        capabilities: {\n            acceptsChildren: true, childPlacement: LayoutChildPlacement.Positioned, supportsGridSpan: false,\n            supportsSizeClassVariants: false, convertibleTo: [],\n        },\n        properties: [\n            ...panelProperties,\n            { path: 'extent', label: 'Extent', group: 'Layout', valueType: PropertyValueType.Object, editorKind: 'size' },\n        ],\n    },\n];\n\n/**\n * The editable properties of a placement within a freeform variant - an element's or a slot's position and size.\n */\nexport const placementProperties: PropertyDescriptor[] = [\n    { path: 'x', label: 'Left', group: 'Placement', valueType: PropertyValueType.Number },\n    { path: 'y', label: 'Top', group: 'Placement', valueType: PropertyValueType.Number },\n    { path: 'width', label: 'Width', group: 'Placement', valueType: PropertyValueType.Number, constraints: { minimum: 0 } },\n    { path: 'height', label: 'Height', group: 'Placement', valueType: PropertyValueType.Number, constraints: { minimum: 0 } },\n];\n\n/**\n * The editable properties of a screen template or dialog template itself.\n */\nexport const templateProperties: PropertyDescriptor[] = [\n    { path: 'displayName', label: 'Display name', group: 'General', valueType: PropertyValueType.String },\n    { path: 'description', label: 'Description', group: 'General', valueType: PropertyValueType.String },\n];\n"],"names":["choices","enumObject","Object","values","map","value","label","spacing","path","group","valueType","PropertyValueType","Number","default","constraints","minimum","flowNodeProperties","description","integer","flowContainerProperties","panelProperties","String","Enum","Visibility","Visible","Boolean","maximum","HorizontalAlignment","VerticalAlignment","orientation","Orientation","panelChildren","acceptsChildren","childPlacement","LayoutChildPlacement","Ordered","supportsSizeClassVariants","layoutTypeDescriptors","type","LayoutType","FlowRow","capabilities","supportsGridSpan","convertibleTo","FlowColumn","FlowGrid","properties","FlowLeaf","maximumChildren","None","FlowSlotLeaf","required","Freeform","Positioned","StackPanel","WrapPanel","DockPanel","GridPanel","editorKind","Canvas","placementProperties","templateProperties"],"mappings":";;AAAA;AACA;AAOA,SAASA,QAAQC,UAAkC,EAAA;IAC/C,OAAOC,MAAAA,CAAOC,MAAM,CAACF,UAAAA,CAAAA,CAAYG,GAAG,CAACC,CAAAA,SAAU;AAAEA,YAAAA,KAAAA;YAAOC,KAAAA,EAAOD;SAAM,CAAA,CAAA;AACzE;AAEA,MAAME,OAAAA,GAAU,CAACC,IAAAA,EAAcF,KAAAA,EAAeG,SAAuC;AACjFD,QAAAA,IAAAA;AAAMF,QAAAA,KAAAA;AAAOG,QAAAA,KAAAA;AAAOC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QAAEC,OAAAA,EAAS,CAAA;QAAGC,WAAAA,EAAa;YAAEC,OAAAA,EAAS;AAAE;KACnG,CAAA;AAEA,MAAMC,kBAAAA,GAA2C;AAC7C,IAAA;QACIR,IAAAA,EAAM,MAAA;QAAQF,KAAAA,EAAO,MAAA;QAAQG,KAAAA,EAAO,QAAA;AAAUC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QACjFK,WAAAA,EAAa,wFAAA;QACbH,WAAAA,EAAa;YAAEC,OAAAA,EAAS;AAAE;AAC9B,KAAA;AACA,IAAA;QACIP,IAAAA,EAAM,MAAA;QAAQF,KAAAA,EAAO,MAAA;QAAQG,KAAAA,EAAO,QAAA;AAAUC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QACjFK,WAAAA,EAAa,uEAAA;QACbH,WAAAA,EAAa;YAAEC,OAAAA,EAAS,CAAA;YAAGG,OAAAA,EAAS;AAAK;AAC7C;AACH,CAAA;AAED,MAAMC,uBAAAA,GAAgD;AAACZ,IAAAA,OAAAA,CAAQ,OAAO,KAAA,EAAO,QAAA,CAAA;AAAcS,IAAAA,GAAAA;AAAmB,CAAA;AAE9G,MAAMI,eAAAA,GAAwC;AAC1C,IAAA;QAAEZ,IAAAA,EAAM,MAAA;QAAQF,KAAAA,EAAO,MAAA;QAAQG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBU;AAAO,KAAA;AACrF,IAAA;QAAEb,IAAAA,EAAM,YAAA;QAAcF,KAAAA,EAAO,YAAA;QAAcG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBW,IAAI;AAAEtB,QAAAA,OAAAA,EAASA,OAAAA,CAAQuB,UAAAA,CAAAA;AAAaV,QAAAA,OAAAA,EAASU,WAAWC;AAAQ,KAAA;AAC1J,IAAA;QAAEhB,IAAAA,EAAM,WAAA;QAAaF,KAAAA,EAAO,SAAA;QAAWG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBc,OAAO;QAAEZ,OAAAA,EAAS;AAAK,KAAA;AAC7G,IAAA;QAAEL,IAAAA,EAAM,SAAA;QAAWF,KAAAA,EAAO,SAAA;QAAWG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QAAEC,OAAAA,EAAS,CAAA;QAAGC,WAAAA,EAAa;YAAEC,OAAAA,EAAS,CAAA;YAAGW,OAAAA,EAAS;AAAE;AAAE,KAAA;AAChJ,IAAA;QAAElB,IAAAA,EAAM,qBAAA;QAAuBF,KAAAA,EAAO,sBAAA;QAAwBG,KAAAA,EAAO,QAAA;AAAUC,QAAAA,SAAAA,EAAWC,kBAAkBW,IAAI;AAAEtB,QAAAA,OAAAA,EAASA,OAAAA,CAAQ2B,mBAAAA;AAAqB,KAAA;AACxJ,IAAA;QAAEnB,IAAAA,EAAM,mBAAA;QAAqBF,KAAAA,EAAO,oBAAA;QAAsBG,KAAAA,EAAO,QAAA;AAAUC,QAAAA,SAAAA,EAAWC,kBAAkBW,IAAI;AAAEtB,QAAAA,OAAAA,EAASA,OAAAA,CAAQ4B,iBAAAA;AAAmB,KAAA;AAClJ,IAAA;QAAEpB,IAAAA,EAAM,QAAA;QAAUF,KAAAA,EAAO,gBAAA;QAAkBG,KAAAA,EAAO,QAAA;AAAUC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QAAEC,OAAAA,EAAS,CAAA;QAAGC,WAAAA,EAAa;YAAEI,OAAAA,EAAS;AAAK;AAAE;AAC/I,CAAA;AAED,MAAMW,WAAAA,GAAkC;IACpCrB,IAAAA,EAAM,aAAA;IAAeF,KAAAA,EAAO,aAAA;IAAeG,KAAAA,EAAO,QAAA;AAAUC,IAAAA,SAAAA,EAAWC,kBAAkBW,IAAI;AAAEtB,IAAAA,OAAAA,EAASA,OAAAA,CAAQ8B,WAAAA;AACpH,CAAA;AAEA,MAAMC,aAAAA,GAAgB;IAAEC,eAAAA,EAAiB,IAAA;AAAMC,IAAAA,cAAAA,EAAgBC,qBAAqBC,OAAO;IAAEC,yBAAAA,EAA2B;AAAM,CAAA;AAE9H;;;UAIaC,qBAAAA,GAAgD;AACzD,IAAA;AACIC,QAAAA,IAAAA,EAAMC,WAAWC,OAAO;QACxBlC,KAAAA,EAAO,KAAA;QACPW,WAAAA,EAAa,oCAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,IAAA;AAAMC,YAAAA,cAAAA,EAAgBC,qBAAqBC,OAAO;YAAEO,gBAAAA,EAAkB,KAAA;YACvFN,yBAAAA,EAA2B,IAAA;YAAMO,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWK,UAAU;AAAEL,gBAAAA,UAAAA,CAAWM;AAAS;AAChG,SAAA;QACAC,UAAAA,EAAY3B;AAChB,KAAA;AACA,IAAA;AACImB,QAAAA,IAAAA,EAAMC,WAAWK,UAAU;QAC3BtC,KAAAA,EAAO,QAAA;QACPW,WAAAA,EAAa,kCAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,IAAA;AAAMC,YAAAA,cAAAA,EAAgBC,qBAAqBC,OAAO;YAAEO,gBAAAA,EAAkB,KAAA;YACvFN,yBAAAA,EAA2B,IAAA;YAAMO,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWC,OAAO;AAAED,gBAAAA,UAAAA,CAAWM;AAAS;AAC7F,SAAA;QACAC,UAAAA,EAAY3B;AAChB,KAAA;AACA,IAAA;AACImB,QAAAA,IAAAA,EAAMC,WAAWM,QAAQ;QACzBvC,KAAAA,EAAO,MAAA;QACPW,WAAAA,EAAa,6DAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,IAAA;AAAMC,YAAAA,cAAAA,EAAgBC,qBAAqBC,OAAO;YAAEO,gBAAAA,EAAkB,IAAA;YACvFN,yBAAAA,EAA2B,IAAA;YAAMO,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWC,OAAO;AAAED,gBAAAA,UAAAA,CAAWK;AAAW;AAC/F,SAAA;QACAE,UAAAA,EAAY;AACL3B,YAAAA,GAAAA,uBAAAA;AACH,YAAA;gBAAEX,IAAAA,EAAM,SAAA;gBAAWF,KAAAA,EAAO,SAAA;gBAAWG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;gBAAEE,WAAAA,EAAa;oBAAEC,OAAAA,EAAS,CAAA;oBAAGG,OAAAA,EAAS;AAAK;AAAE,aAAA;AACtI,YAAA;gBAAEV,IAAAA,EAAM,MAAA;gBAAQF,KAAAA,EAAO,MAAA;gBAAQG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;gBAAEE,WAAAA,EAAa;oBAAEC,OAAAA,EAAS,CAAA;oBAAGG,OAAAA,EAAS;AAAK;AAAE;AACnI;AACL,KAAA;AACA,IAAA;AACIoB,QAAAA,IAAAA,EAAMC,WAAWQ,QAAQ;QACzBzC,KAAAA,EAAO,SAAA;QACPW,WAAAA,EAAa,sCAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,KAAA;YAAOgB,eAAAA,EAAiB,CAAA;AAAGf,YAAAA,cAAAA,EAAgBC,qBAAqBe,IAAI;YAAEP,gBAAAA,EAAkB,IAAA;YACzGN,yBAAAA,EAA2B,KAAA;AAAOO,YAAAA,aAAAA,EAAe;AACrD,SAAA;QACAG,UAAAA,EAAY9B;AAChB,KAAA;AACA,IAAA;AACIsB,QAAAA,IAAAA,EAAMC,WAAWW,YAAY;QAC7B5C,KAAAA,EAAO,MAAA;QACPW,WAAAA,EAAa,wEAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,KAAA;AAAOC,YAAAA,cAAAA,EAAgBC,qBAAqBe,IAAI;YAAEP,gBAAAA,EAAkB,IAAA;YACrFN,yBAAAA,EAA2B,KAAA;AAAOO,YAAAA,aAAAA,EAAe;AACrD,SAAA;QACAG,UAAAA,EAAY;AACR,YAAA;gBAAEtC,IAAAA,EAAM,UAAA;gBAAYF,KAAAA,EAAO,MAAA;gBAAQG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBU,MAAM;gBAAEP,WAAAA,EAAa;oBAAEqC,QAAAA,EAAU;AAAK;AAAE,aAAA;AACtHnC,YAAAA,GAAAA;AACN;AACL,KAAA;AACA,IAAA;AACIsB,QAAAA,IAAAA,EAAMC,WAAWa,QAAQ;QACzB9C,KAAAA,EAAO,UAAA;QACPW,WAAAA,EAAa,6EAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,IAAA;AAAMC,YAAAA,cAAAA,EAAgBC,qBAAqBmB,UAAU;YAAEX,gBAAAA,EAAkB,KAAA;YAC1FN,yBAAAA,EAA2B,IAAA;AAAMO,YAAAA,aAAAA,EAAe;AACpD,SAAA;AACAG,QAAAA,UAAAA,EAAY;AAChB,KAAA;AACA,IAAA;AACIR,QAAAA,IAAAA,EAAMC,WAAWe,UAAU;QAC3BhD,KAAAA,EAAO,aAAA;QACPW,WAAAA,EAAa,4DAAA;QACbwB,YAAAA,EAAc;AAAE,YAAA,GAAGV,aAAa;YAAEW,gBAAAA,EAAkB,KAAA;YAAOC,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWgB,SAAS;AAAEhB,gBAAAA,UAAAA,CAAWiB;AAAU;AAAC,SAAA;QACvHV,UAAAA,EAAY;AAAI1B,YAAAA,GAAAA,eAAAA;AAAiBS,YAAAA,WAAAA;AAAatB,YAAAA,OAAAA,CAAQ,WAAW,SAAA,EAAW,QAAA;AAAU;AAC1F,KAAA;AACA,IAAA;AACI+B,QAAAA,IAAAA,EAAMC,WAAWgB,SAAS;QAC1BjD,KAAAA,EAAO,YAAA;QACPW,WAAAA,EAAa,uEAAA;QACbwB,YAAAA,EAAc;AAAE,YAAA,GAAGV,aAAa;YAAEW,gBAAAA,EAAkB,KAAA;YAAOC,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWe,UAAU;AAAEf,gBAAAA,UAAAA,CAAWiB;AAAU;AAAC,SAAA;QACxHV,UAAAA,EAAY;AACL1B,YAAAA,GAAAA,eAAAA;AACHS,YAAAA,WAAAA;AACA,YAAA;gBAAErB,IAAAA,EAAM,WAAA;gBAAaF,KAAAA,EAAO,YAAA;gBAAcG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;gBAAEE,WAAAA,EAAa;oBAAEC,OAAAA,EAAS;AAAE;AAAE,aAAA;AAC5H,YAAA;gBAAEP,IAAAA,EAAM,YAAA;gBAAcF,KAAAA,EAAO,aAAA;gBAAeG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;gBAAEE,WAAAA,EAAa;oBAAEC,OAAAA,EAAS;AAAE;AAAE;AACjI;AACL,KAAA;AACA,IAAA;AACIuB,QAAAA,IAAAA,EAAMC,WAAWiB,SAAS;QAC1BlD,KAAAA,EAAO,YAAA;QACPW,WAAAA,EAAa,yEAAA;QACbwB,YAAAA,EAAc;AAAE,YAAA,GAAGV,aAAa;YAAEW,gBAAAA,EAAkB,KAAA;YAAOC,aAAAA,EAAe;AAACJ,gBAAAA,UAAAA,CAAWe,UAAU;AAAEf,gBAAAA,UAAAA,CAAWgB;AAAU;AAAC,SAAA;QACxHT,UAAAA,EAAY;AACL1B,YAAAA,GAAAA,eAAAA;AACH,YAAA;gBAAEZ,IAAAA,EAAM,eAAA;gBAAiBF,KAAAA,EAAO,kBAAA;gBAAoBG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBc,OAAO;gBAAEZ,OAAAA,EAAS;AAAK;AAC5H;AACL,KAAA;AACA,IAAA;AACIyB,QAAAA,IAAAA,EAAMC,WAAWkB,SAAS;QAC1BnD,KAAAA,EAAO,YAAA;QACPW,WAAAA,EAAa,8DAAA;QACbwB,YAAAA,EAAc;AAAE,YAAA,GAAGV,aAAa;YAAEW,gBAAAA,EAAkB,IAAA;AAAMC,YAAAA,aAAAA,EAAe;AAAG,SAAA;QAC5EG,UAAAA,EAAY;AACL1B,YAAAA,GAAAA,eAAAA;AACH,YAAA;gBAAEZ,IAAAA,EAAM,MAAA;gBAAQF,KAAAA,EAAO,MAAA;gBAAQG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBT,MAAM;gBAAEwD,UAAAA,EAAY;AAAkB,aAAA;AACnH,YAAA;gBAAElD,IAAAA,EAAM,SAAA;gBAAWF,KAAAA,EAAO,SAAA;gBAAWG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBT,MAAM;gBAAEwD,UAAAA,EAAY;AAAkB;AAC5H;AACL,KAAA;AACA,IAAA;AACIpB,QAAAA,IAAAA,EAAMC,WAAWoB,MAAM;QACvBrD,KAAAA,EAAO,QAAA;QACPW,WAAAA,EAAa,4CAAA;QACbwB,YAAAA,EAAc;YACVT,eAAAA,EAAiB,IAAA;AAAMC,YAAAA,cAAAA,EAAgBC,qBAAqBmB,UAAU;YAAEX,gBAAAA,EAAkB,KAAA;YAC1FN,yBAAAA,EAA2B,KAAA;AAAOO,YAAAA,aAAAA,EAAe;AACrD,SAAA;QACAG,UAAAA,EAAY;AACL1B,YAAAA,GAAAA,eAAAA;AACH,YAAA;gBAAEZ,IAAAA,EAAM,QAAA;gBAAUF,KAAAA,EAAO,QAAA;gBAAUG,KAAAA,EAAO,QAAA;AAAUC,gBAAAA,SAAAA,EAAWC,kBAAkBT,MAAM;gBAAEwD,UAAAA,EAAY;AAAO;AAC/G;AACL;;AAGJ;;UAGaE,mBAAAA,GAA4C;AACrD,IAAA;QAAEpD,IAAAA,EAAM,GAAA;QAAKF,KAAAA,EAAO,MAAA;QAAQG,KAAAA,EAAO,WAAA;AAAaC,QAAAA,SAAAA,EAAWC,kBAAkBC;AAAO,KAAA;AACpF,IAAA;QAAEJ,IAAAA,EAAM,GAAA;QAAKF,KAAAA,EAAO,KAAA;QAAOG,KAAAA,EAAO,WAAA;AAAaC,QAAAA,SAAAA,EAAWC,kBAAkBC;AAAO,KAAA;AACnF,IAAA;QAAEJ,IAAAA,EAAM,OAAA;QAASF,KAAAA,EAAO,OAAA;QAASG,KAAAA,EAAO,WAAA;AAAaC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QAAEE,WAAAA,EAAa;YAAEC,OAAAA,EAAS;AAAE;AAAE,KAAA;AACtH,IAAA;QAAEP,IAAAA,EAAM,QAAA;QAAUF,KAAAA,EAAO,QAAA;QAAUG,KAAAA,EAAO,WAAA;AAAaC,QAAAA,SAAAA,EAAWC,kBAAkBC,MAAM;QAAEE,WAAAA,EAAa;YAAEC,OAAAA,EAAS;AAAE;AAAE;;AAG5H;;UAGa8C,kBAAAA,GAA2C;AACpD,IAAA;QAAErD,IAAAA,EAAM,aAAA;QAAeF,KAAAA,EAAO,cAAA;QAAgBG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBU;AAAO,KAAA;AACpG,IAAA;QAAEb,IAAAA,EAAM,aAAA;QAAeF,KAAAA,EAAO,aAAA;QAAeG,KAAAA,EAAO,SAAA;AAAWC,QAAAA,SAAAA,EAAWC,kBAAkBU;AAAO;;;"}

package/dist/esm/editing/layoutTypeEdits.d.ts

@@ -0,0 +1,4 @@
+import { ChangeLayoutTypeEdit, SceneDiagnostic, SceneDocument } from '@cratis/scene.model';
+import { EditSession } from './EditSession';
+export declare function applyChangeLayoutType(session: EditSession, edit: ChangeLayoutTypeEdit, clone: SceneDocument, diagnostics: SceneDiagnostic[]): void;
+//# sourceMappingURL=layoutTypeEdits.d.ts.map

package/dist/esm/editing/layoutTypeEdits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layoutTypeEdits.d.ts","sourceRoot":"","sources":["../../../editing/layoutTypeEdits.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,oBAAoB,EAA8D,eAAe,EAAE,aAAa,EAEnH,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AA4E5C,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,IAAI,CAgDlJ"}

package/dist/esm/editing/layoutTypeEdits.js

@@ -0,0 +1,139 @@
+import { LayoutType, FlowContainerKind, DiagnosticCode, SceneNodeKind, Orientation } from '@cratis/scene.model';
+import { errorDiagnostic, warningDiagnostic } from './diagnostics.js';
+import { findLayoutTypeDescriptor } from './DescriptorCatalog.js';
+import { mirroredPaths, getAtPath } from './documentPaths.js';
+import { cloneData } from './pathAccess.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const flowKinds = {
+    [LayoutType.FlowRow]: FlowContainerKind.Row,
+    [LayoutType.FlowColumn]: FlowContainerKind.Column,
+    [LayoutType.FlowGrid]: FlowContainerKind.Grid
+};
+const panelOwnProperties = {
+    [LayoutType.StackPanel]: [
+        'orientation',
+        'spacing'
+    ],
+    [LayoutType.WrapPanel]: [
+        'orientation',
+        'itemWidth',
+        'itemHeight'
+    ],
+    [LayoutType.DockPanel]: [
+        'lastChildFill'
+    ]
+};
+const allPanelOwn = [
+    'orientation',
+    'spacing',
+    'itemWidth',
+    'itemHeight',
+    'lastChildFill'
+];
+function isSet(node, property) {
+    return node[property] !== undefined && !(property === 'spacing' && node[property] === 0);
+}
+function convertFlow(source, to) {
+    const result = cloneData(source);
+    const lost = [];
+    const target = flowKinds[to];
+    if (source.kind === FlowContainerKind.Grid && target !== FlowContainerKind.Grid) {
+        for (const property of [
+            'columns',
+            'rows'
+        ]){
+            if (source[property] !== undefined) lost.push(property);
+            delete result[property];
+        }
+        const spans = result.children.filter((child)=>child.span !== undefined);
+        if (spans.length > 0) lost.push('span (on children)');
+        for (const child of spans)delete child.span;
+    }
+    result.kind = target;
+    return {
+        result,
+        lost
+    };
+}
+function convertPanel(source, to) {
+    const result = cloneData(source);
+    const keep = panelOwnProperties[to] ?? [];
+    const lost = allPanelOwn.filter((property)=>!keep.includes(property) && isSet(source, property));
+    for (const property of allPanelOwn.filter((candidate)=>!keep.includes(candidate)))delete result[property];
+    if (to === LayoutType.StackPanel) {
+        result.orientation ??= Orientation.Vertical;
+        result.spacing ??= 0;
+    } else if (to === LayoutType.WrapPanel) {
+        result.orientation ??= Orientation.Horizontal;
+    } else {
+        result.lastChildFill ??= true;
+    }
+    return {
+        result,
+        lost
+    };
+}
+/**
+ * Applies a layout type change to a copy of the document.
+ *
+ * A change must be one the layout type allows. Changes that keep everything - row to column, a dock panel to a
+ * stack panel - go ahead. Changes that would drop real values, such as a grid's columns and spans when it becomes a
+ * row, are refused with the list of what would be lost unless the edit accepts the loss, and then go ahead with a
+ * warning that lists the same.
+ */ function applyChangeLayoutType(session, edit, clone, diagnostics) {
+    const record = session.index.nodes.get(edit.nodeId);
+    if (!record) {
+        diagnostics.push(errorDiagnostic(DiagnosticCode.UnknownNode, `There is no node '${edit.nodeId}'.`, {
+            nodeId: edit.nodeId
+        }));
+        return;
+    }
+    if (record.kind !== SceneNodeKind.FlowNode && record.kind !== SceneNodeKind.Element) {
+        diagnostics.push(errorDiagnostic(DiagnosticCode.NotALayoutNode, `'${record.label}' is not a layout node.`, {
+            nodeId: edit.nodeId
+        }));
+        return;
+    }
+    if (!session.isLocal(record)) {
+        diagnostics.push(errorDiagnostic(DiagnosticCode.NodeNotEditable, `'${edit.nodeId}' is inherited from '${session.sourceOf(record)}' and cannot be changed here.`, {
+            nodeId: edit.nodeId
+        }));
+        return;
+    }
+    const descriptor = findLayoutTypeDescriptor(session.context.catalog, record.typeId);
+    if (!descriptor) {
+        diagnostics.push(errorDiagnostic(DiagnosticCode.NotALayoutNode, `'${record.label}' is not a layout node.`, {
+            nodeId: edit.nodeId
+        }));
+        return;
+    }
+    if (!descriptor.capabilities.convertibleTo.includes(edit.to)) {
+        diagnostics.push(errorDiagnostic(DiagnosticCode.LayoutTypeNotConvertible, `A ${descriptor.label.toLowerCase()} cannot be changed into '${edit.to}'.`, {
+            nodeId: edit.nodeId
+        }));
+        return;
+    }
+    const isFlow = record.kind === SceneNodeKind.FlowNode;
+    const conversion = isFlow ? convertFlow(record.value, edit.to) : convertPanel(record.value, edit.to);
+    if (conversion.lost.length > 0) {
+        const lost = conversion.lost.join(', ');
+        if (!edit.acceptLoss) {
+            diagnostics.push(errorDiagnostic(DiagnosticCode.LossyConversionNotAccepted, `Changing to '${edit.to}' would drop ${lost}. Accept the loss to go ahead.`, {
+                nodeId: edit.nodeId
+            }));
+            return;
+        }
+        diagnostics.push(warningDiagnostic(DiagnosticCode.LossyConversion, `Changed to '${edit.to}'; dropped ${lost}.`, {
+            nodeId: edit.nodeId
+        }));
+    }
+    for (const path of mirroredPaths(record.mirror, record.path)){
+        const holder = getAtPath(clone, path.slice(0, -1));
+        holder[path[path.length - 1]] = cloneData(conversion.result);
+    }
+}
+
+export { applyChangeLayoutType };
+//# sourceMappingURL=layoutTypeEdits.js.map

package/dist/esm/editing/layoutTypeEdits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layoutTypeEdits.js","sources":["../../../editing/layoutTypeEdits.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 {\n    ChangeLayoutTypeEdit, DiagnosticCode, FlowContainerKind, LayoutType, Orientation, SceneDiagnostic, SceneDocument,\n    SceneNodeKind,\n} from '@cratis/scene.model';\nimport { errorDiagnostic, warningDiagnostic } from './diagnostics';\nimport { findLayoutTypeDescriptor } from './DescriptorCatalog';\nimport { getAtPath, mirroredPaths } from './documentPaths';\nimport { EditSession } from './EditSession';\nimport { cloneData } from './pathAccess';\n\ntype Node = Record<string, unknown>;\n\ninterface Conversion {\n    result: Node;\n\n    /** Properties that held a real value and are gone after the conversion. */\n    lost: string[];\n}\n\nconst flowKinds: Partial<Record<LayoutType, FlowContainerKind>> = {\n    [LayoutType.FlowRow]: FlowContainerKind.Row,\n    [LayoutType.FlowColumn]: FlowContainerKind.Column,\n    [LayoutType.FlowGrid]: FlowContainerKind.Grid,\n};\n\nconst panelOwnProperties: Partial<Record<LayoutType, string[]>> = {\n    [LayoutType.StackPanel]: ['orientation', 'spacing'],\n    [LayoutType.WrapPanel]: ['orientation', 'itemWidth', 'itemHeight'],\n    [LayoutType.DockPanel]: ['lastChildFill'],\n};\n\nconst allPanelOwn = ['orientation', 'spacing', 'itemWidth', 'itemHeight', 'lastChildFill'];\n\nfunction isSet(node: Node, property: string): boolean {\n    return node[property] !== undefined && !(property === 'spacing' && node[property] === 0);\n}\n\nfunction convertFlow(source: Node, to: LayoutType): Conversion {\n    const result = cloneData(source);\n    const lost: string[] = [];\n    const target = flowKinds[to]!;\n\n    if (source.kind === FlowContainerKind.Grid && target !== FlowContainerKind.Grid) {\n        for (const property of ['columns', 'rows']) {\n            if (source[property] !== undefined) lost.push(property);\n            delete result[property];\n        }\n\n        const spans = (result.children as Node[]).filter(child => child.span !== undefined);\n        if (spans.length > 0) lost.push('span (on children)');\n        for (const child of spans) delete child.span;\n    }\n\n    result.kind = target;\n    return { result, lost };\n}\n\nfunction convertPanel(source: Node, to: LayoutType): Conversion {\n    const result = cloneData(source);\n    const keep = panelOwnProperties[to] ?? [];\n    const lost = allPanelOwn.filter(property => !keep.includes(property) && isSet(source, property));\n    for (const property of allPanelOwn.filter(candidate => !keep.includes(candidate))) delete result[property];\n\n    if (to === LayoutType.StackPanel) {\n        result.orientation ??= Orientation.Vertical;\n        result.spacing ??= 0;\n    } else if (to === LayoutType.WrapPanel) {\n        result.orientation ??= Orientation.Horizontal;\n    } else {\n        result.lastChildFill ??= true;\n    }\n\n    return { result, lost };\n}\n\n/**\n * Applies a layout type change to a copy of the document.\n *\n * A change must be one the layout type allows. Changes that keep everything - row to column, a dock panel to a\n * stack panel - go ahead. Changes that would drop real values, such as a grid's columns and spans when it becomes a\n * row, are refused with the list of what would be lost unless the edit accepts the loss, and then go ahead with a\n * warning that lists the same.\n */\nexport function applyChangeLayoutType(session: EditSession, edit: ChangeLayoutTypeEdit, clone: SceneDocument, diagnostics: SceneDiagnostic[]): void {\n    const record = session.index.nodes.get(edit.nodeId);\n    if (!record) {\n        diagnostics.push(errorDiagnostic(DiagnosticCode.UnknownNode, `There is no node '${edit.nodeId}'.`, { nodeId: edit.nodeId }));\n        return;\n    }\n\n    if (record.kind !== SceneNodeKind.FlowNode && record.kind !== SceneNodeKind.Element) {\n        diagnostics.push(errorDiagnostic(DiagnosticCode.NotALayoutNode, `'${record.label}' is not a layout node.`, { nodeId: edit.nodeId }));\n        return;\n    }\n\n    if (!session.isLocal(record)) {\n        diagnostics.push(errorDiagnostic(DiagnosticCode.NodeNotEditable, `'${edit.nodeId}' is inherited from '${session.sourceOf(record)}' and cannot be changed here.`, { nodeId: edit.nodeId }));\n        return;\n    }\n\n    const descriptor = findLayoutTypeDescriptor(session.context.catalog, record.typeId);\n    if (!descriptor) {\n        diagnostics.push(errorDiagnostic(DiagnosticCode.NotALayoutNode, `'${record.label}' is not a layout node.`, { nodeId: edit.nodeId }));\n        return;\n    }\n\n    if (!descriptor.capabilities.convertibleTo.includes(edit.to as LayoutType)) {\n        diagnostics.push(errorDiagnostic(DiagnosticCode.LayoutTypeNotConvertible, `A ${descriptor.label.toLowerCase()} cannot be changed into '${edit.to}'.`, { nodeId: edit.nodeId }));\n        return;\n    }\n\n    const isFlow = record.kind === SceneNodeKind.FlowNode;\n    const conversion = isFlow ? convertFlow(record.value as Node, edit.to as LayoutType) : convertPanel(record.value as Node, edit.to as LayoutType);\n\n    if (conversion.lost.length > 0) {\n        const lost = conversion.lost.join(', ');\n        if (!edit.acceptLoss) {\n            diagnostics.push(errorDiagnostic(\n                DiagnosticCode.LossyConversionNotAccepted,\n                `Changing to '${edit.to}' would drop ${lost}. Accept the loss to go ahead.`,\n                { nodeId: edit.nodeId }));\n            return;\n        }\n\n        diagnostics.push(warningDiagnostic(DiagnosticCode.LossyConversion, `Changed to '${edit.to}'; dropped ${lost}.`, { nodeId: edit.nodeId }));\n    }\n\n    for (const path of mirroredPaths(record.mirror, record.path)) {\n        const holder = getAtPath(clone, path.slice(0, -1)) as Record<string | number, unknown>;\n        holder[path[path.length - 1]] = cloneData(conversion.result);\n    }\n}\n"],"names":["flowKinds","LayoutType","FlowRow","FlowContainerKind","Row","FlowColumn","Column","FlowGrid","Grid","panelOwnProperties","StackPanel","WrapPanel","DockPanel","allPanelOwn","isSet","node","property","undefined","convertFlow","source","to","result","cloneData","lost","target","kind","push","spans","children","filter","child","span","length","convertPanel","keep","includes","candidate","orientation","Orientation","Vertical","spacing","Horizontal","lastChildFill","applyChangeLayoutType","session","edit","clone","diagnostics","record","index","nodes","get","nodeId","errorDiagnostic","DiagnosticCode","UnknownNode","SceneNodeKind","FlowNode","Element","NotALayoutNode","label","isLocal","NodeNotEditable","sourceOf","descriptor","findLayoutTypeDescriptor","context","catalog","typeId","capabilities","convertibleTo","LayoutTypeNotConvertible","toLowerCase","isFlow","conversion","value","join","acceptLoss","LossyConversionNotAccepted","warningDiagnostic","LossyConversion","path","mirroredPaths","mirror","holder","getAtPath","slice"],"mappings":";;;;;;AAAA;AACA;AAqBA,MAAMA,SAAAA,GAA4D;AAC9D,IAAA,CAACC,UAAAA,CAAWC,OAAO,GAAGC,kBAAkBC,GAAG;AAC3C,IAAA,CAACH,UAAAA,CAAWI,UAAU,GAAGF,kBAAkBG,MAAM;AACjD,IAAA,CAACL,UAAAA,CAAWM,QAAQ,GAAGJ,kBAAkBK;AAC7C,CAAA;AAEA,MAAMC,kBAAAA,GAA4D;IAC9D,CAACR,UAAAA,CAAWS,UAAU,GAAG;AAAC,QAAA,aAAA;AAAe,QAAA;AAAU,KAAA;IACnD,CAACT,UAAAA,CAAWU,SAAS,GAAG;AAAC,QAAA,aAAA;AAAe,QAAA,WAAA;AAAa,QAAA;AAAa,KAAA;IAClE,CAACV,UAAAA,CAAWW,SAAS,GAAG;AAAC,QAAA;AAAgB;AAC7C,CAAA;AAEA,MAAMC,WAAAA,GAAc;AAAC,IAAA,aAAA;AAAe,IAAA,SAAA;AAAW,IAAA,WAAA;AAAa,IAAA,YAAA;AAAc,IAAA;AAAgB,CAAA;AAE1F,SAASC,KAAAA,CAAMC,IAAU,EAAEC,QAAgB,EAAA;AACvC,IAAA,OAAOD,IAAI,CAACC,QAAAA,CAAS,KAAKC,SAAAA,IAAa,EAAED,QAAAA,KAAa,SAAA,IAAaD,IAAI,CAACC,QAAAA,CAAS,KAAK,CAAA,CAAA;AAC1F;AAEA,SAASE,WAAAA,CAAYC,MAAY,EAAEC,EAAc,EAAA;AAC7C,IAAA,MAAMC,SAASC,SAAAA,CAAUH,MAAAA,CAAAA;AACzB,IAAA,MAAMI,OAAiB,EAAE;IACzB,MAAMC,MAAAA,GAASxB,SAAS,CAACoB,EAAAA,CAAG;IAE5B,IAAID,MAAAA,CAAOM,IAAI,KAAKtB,iBAAAA,CAAkBK,IAAI,IAAIgB,MAAAA,KAAWrB,iBAAAA,CAAkBK,IAAI,EAAE;AAC7E,QAAA,KAAK,MAAMQ,QAAAA,IAAY;AAAC,YAAA,SAAA;AAAW,YAAA;SAAO,CAAE;AACxC,YAAA,IAAIG,MAAM,CAACH,QAAAA,CAAS,KAAKC,SAAAA,EAAWM,IAAAA,CAAKG,IAAI,CAACV,QAAAA,CAAAA;YAC9C,OAAOK,MAAM,CAACL,QAAAA,CAAS;AAC3B,QAAA;QAEA,MAAMW,KAAAA,GAAQ,MAACN,CAAOO,QAAQ,CAAYC,MAAM,CAACC,CAAAA,KAAAA,GAASA,KAAAA,CAAMC,IAAI,KAAKd,SAAAA,CAAAA;AACzE,QAAA,IAAIU,MAAMK,MAAM,GAAG,CAAA,EAAGT,IAAAA,CAAKG,IAAI,CAAC,oBAAA,CAAA;AAChC,QAAA,KAAK,MAAMI,KAAAA,IAASH,KAAAA,CAAO,OAAOG,MAAMC,IAAI;AAChD,IAAA;AAEAV,IAAAA,MAAAA,CAAOI,IAAI,GAAGD,MAAAA;IACd,OAAO;AAAEH,QAAAA,MAAAA;AAAQE,QAAAA;AAAK,KAAA;AAC1B;AAEA,SAASU,YAAAA,CAAad,MAAY,EAAEC,EAAc,EAAA;AAC9C,IAAA,MAAMC,SAASC,SAAAA,CAAUH,MAAAA,CAAAA;AACzB,IAAA,MAAMe,IAAAA,GAAOzB,kBAAkB,CAACW,EAAAA,CAAG,IAAI,EAAE;AACzC,IAAA,MAAMG,IAAAA,GAAOV,WAAAA,CAAYgB,MAAM,CAACb,CAAAA,QAAAA,GAAY,CAACkB,IAAAA,CAAKC,QAAQ,CAACnB,QAAAA,CAAAA,IAAaF,KAAAA,CAAMK,MAAAA,EAAQH,QAAAA,CAAAA,CAAAA;AACtF,IAAA,KAAK,MAAMA,QAAAA,IAAYH,WAAAA,CAAYgB,MAAM,CAACO,CAAAA,SAAAA,GAAa,CAACF,IAAAA,CAAKC,QAAQ,CAACC,SAAAA,CAAAA,CAAAA,CAAa,OAAOf,MAAM,CAACL,QAAAA,CAAS;IAE1G,IAAII,EAAAA,KAAOnB,UAAAA,CAAWS,UAAU,EAAE;QAC9BW,MAAAA,CAAOgB,WAAW,KAAKC,WAAAA,CAAYC,QAAQ;AAC3ClB,QAAAA,MAAAA,CAAOmB,OAAO,KAAK,CAAA;AACvB,IAAA,CAAA,MAAO,IAAIpB,EAAAA,KAAOnB,UAAAA,CAAWU,SAAS,EAAE;QACpCU,MAAAA,CAAOgB,WAAW,KAAKC,WAAAA,CAAYG,UAAU;IACjD,CAAA,MAAO;AACHpB,QAAAA,MAAAA,CAAOqB,aAAa,KAAK,IAAA;AAC7B,IAAA;IAEA,OAAO;AAAErB,QAAAA,MAAAA;AAAQE,QAAAA;AAAK,KAAA;AAC1B;AAEA;;;;;;;IAQO,SAASoB,qBAAAA,CAAsBC,OAAoB,EAAEC,IAA0B,EAAEC,KAAoB,EAAEC,WAA8B,EAAA;IACxI,MAAMC,MAAAA,GAASJ,QAAQK,KAAK,CAACC,KAAK,CAACC,GAAG,CAACN,IAAAA,CAAKO,MAAM,CAAA;AAClD,IAAA,IAAI,CAACJ,MAAAA,EAAQ;AACTD,QAAAA,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CAAgBC,cAAAA,CAAeC,WAAW,EAAE,CAAC,kBAAkB,EAAEV,IAAAA,CAAKO,MAAM,CAAC,EAAE,CAAC,EAAE;AAAEA,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AACzH,QAAA;AACJ,IAAA;IAEA,IAAIJ,MAAAA,CAAOvB,IAAI,KAAK+B,aAAAA,CAAcC,QAAQ,IAAIT,MAAAA,CAAOvB,IAAI,KAAK+B,aAAAA,CAAcE,OAAO,EAAE;AACjFX,QAAAA,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CAAgBC,cAAAA,CAAeK,cAAc,EAAE,CAAC,CAAC,EAAEX,MAAAA,CAAOY,KAAK,CAAC,uBAAuB,CAAC,EAAE;AAAER,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AACjI,QAAA;AACJ,IAAA;AAEA,IAAA,IAAI,CAACR,OAAAA,CAAQiB,OAAO,CAACb,MAAAA,CAAAA,EAAS;QAC1BD,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CAAgBC,cAAAA,CAAeQ,eAAe,EAAE,CAAC,CAAC,EAAEjB,IAAAA,CAAKO,MAAM,CAAC,qBAAqB,EAAER,OAAAA,CAAQmB,QAAQ,CAACf,MAAAA,CAAAA,CAAQ,6BAA6B,CAAC,EAAE;AAAEI,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AACvL,QAAA;AACJ,IAAA;IAEA,MAAMY,UAAAA,GAAaC,yBAAyBrB,OAAAA,CAAQsB,OAAO,CAACC,OAAO,EAAEnB,OAAOoB,MAAM,CAAA;AAClF,IAAA,IAAI,CAACJ,UAAAA,EAAY;AACbjB,QAAAA,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CAAgBC,cAAAA,CAAeK,cAAc,EAAE,CAAC,CAAC,EAAEX,MAAAA,CAAOY,KAAK,CAAC,uBAAuB,CAAC,EAAE;AAAER,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AACjI,QAAA;AACJ,IAAA;IAEA,IAAI,CAACY,UAAAA,CAAWK,YAAY,CAACC,aAAa,CAACnC,QAAQ,CAACU,IAAAA,CAAKzB,EAAE,CAAA,EAAiB;QACxE2B,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CAAgBC,cAAAA,CAAeiB,wBAAwB,EAAE,CAAC,EAAE,EAAEP,UAAAA,CAAWJ,KAAK,CAACY,WAAW,GAAG,yBAAyB,EAAE3B,KAAKzB,EAAE,CAAC,EAAE,CAAC,EAAE;AAAEgC,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AAC5K,QAAA;AACJ,IAAA;AAEA,IAAA,MAAMqB,MAAAA,GAASzB,MAAAA,CAAOvB,IAAI,KAAK+B,cAAcC,QAAQ;AACrD,IAAA,MAAMiB,UAAAA,GAAaD,MAAAA,GAASvD,WAAAA,CAAY8B,MAAAA,CAAO2B,KAAK,EAAU9B,IAAAA,CAAKzB,EAAE,CAAA,GAAkBa,YAAAA,CAAae,MAAAA,CAAO2B,KAAK,EAAU9B,KAAKzB,EAAE,CAAA;AAEjI,IAAA,IAAIsD,UAAAA,CAAWnD,IAAI,CAACS,MAAM,GAAG,CAAA,EAAG;AAC5B,QAAA,MAAMT,IAAAA,GAAOmD,UAAAA,CAAWnD,IAAI,CAACqD,IAAI,CAAC,IAAA,CAAA;QAClC,IAAI,CAAC/B,IAAAA,CAAKgC,UAAU,EAAE;AAClB9B,YAAAA,WAAAA,CAAYrB,IAAI,CAAC2B,eAAAA,CACbC,cAAAA,CAAewB,0BAA0B,EACzC,CAAC,aAAa,EAAEjC,IAAAA,CAAKzB,EAAE,CAAC,aAAa,EAAEG,IAAAA,CAAK,8BAA8B,CAAC,EAC3E;AAAE6B,gBAAAA,MAAAA,EAAQP,KAAKO;AAAO,aAAA,CAAA,CAAA;AAC1B,YAAA;AACJ,QAAA;AAEAL,QAAAA,WAAAA,CAAYrB,IAAI,CAACqD,iBAAAA,CAAkBzB,cAAAA,CAAe0B,eAAe,EAAE,CAAC,YAAY,EAAEnC,IAAAA,CAAKzB,EAAE,CAAC,WAAW,EAAEG,IAAAA,CAAK,CAAC,CAAC,EAAE;AAAE6B,YAAAA,MAAAA,EAAQP,KAAKO;AAAO,SAAA,CAAA,CAAA;AAC1I,IAAA;IAEA,KAAK,MAAM6B,QAAQC,aAAAA,CAAclC,MAAAA,CAAOmC,MAAM,EAAEnC,MAAAA,CAAOiC,IAAI,CAAA,CAAG;AAC1D,QAAA,MAAMG,SAASC,SAAAA,CAAUvC,KAAAA,EAAOmC,KAAKK,KAAK,CAAC,GAAG,EAAC,CAAA,CAAA;QAC/CF,MAAM,CAACH,IAAI,CAACA,IAAAA,CAAKjD,MAAM,GAAG,CAAA,CAAE,CAAC,GAAGV,SAAAA,CAAUoD,UAAAA,CAAWrD,MAAM,CAAA;AAC/D,IAAA;AACJ;;"}

package/dist/esm/editing/nodeIds.d.ts

@@ -0,0 +1,14 @@
+import { EditingScope } from '@cratis/scene.model';
+export declare function layoutNodeId(name: string): string;
+export declare function screenTemplateNodeId(name: string): string;
+export declare function dialogTemplateNodeId(name: string): string;
+export declare function screenNodeId(name: string): string;
+export declare function slotNodeId(ownerNodeId: string, slotName: string): string;
+export declare function elementNodeId(elementId: string): string;
+export declare function ownerArrangementId(ownerNodeId: string): string;
+export declare function flowNodeId(holderId: string, variant: string, indexPath: number[]): string;
+export declare function freeformNodeId(holderId: string): string;
+export declare function placementNodeId(holderId: string, variantIndex: number, key: string): string;
+export declare function scopeNodeId(scope: EditingScope): string;
+export declare function scopeInstanceId(scope: EditingScope): string;
+//# sourceMappingURL=nodeIds.d.ts.map

package/dist/esm/editing/nodeIds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeIds.d.ts","sourceRoot":"","sources":["../../../editing/nodeIds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAoB,MAAM,qBAAqB,CAAC;AAWrE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAKD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzD;AAKD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzD;AAKD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAKD,wBAAgB,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAExE;AAMD,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEvD;AAKD,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE9D;AAUD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAEzF;AAKD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEvD;AAKD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3F;AAKD,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAOvD;AAMD,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAO3D"}