@cratis/scene.engine 4.2.0 → 4.3.0

package/dist/cjs/editing/DescriptorCatalog.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var layoutTypeDescriptors = require('./layoutTypeDescriptors.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Builds a catalog from the component descriptors of the active packages, plus the built-in layout types.
+ *
+ * When two descriptors name the same component the later one wins, which is the same override-priority rule
+ * the profile's package order already means for components.
+ */ function createDescriptorCatalog(componentDescriptors = []) {
+    const byComponent = new Map();
+    for (const descriptor of componentDescriptors)byComponent.set(descriptor.component, descriptor);
+    return {
+        components: [
+            ...byComponent.values()
+        ],
+        layoutTypes: layoutTypeDescriptors.layoutTypeDescriptors
+    };
+}
+/**
+ * Finds the descriptor of a component by the name an element carries.
+ *
+ * An exact match wins. Otherwise a bare name (`dataTable`) finds the one descriptor whose component ends in
+ * `:dataTable`; a bare name that several packages describe has no single answer, so it finds none.
+ */ function findComponentDescriptor(catalog, componentName) {
+    const exact = catalog.components.find((descriptor)=>descriptor.component === componentName);
+    if (exact) return exact;
+    const matches = catalog.components.filter((descriptor)=>descriptor.component.endsWith(`:${componentName}`));
+    return matches.length === 1 ? matches[0] : undefined;
+}
+/**
+ * Finds the descriptor of a layout type.
+ */ function findLayoutTypeDescriptor(catalog, type) {
+    return catalog.layoutTypes.find((descriptor)=>descriptor.type === type);
+}
+
+exports.createDescriptorCatalog = createDescriptorCatalog;
+exports.findComponentDescriptor = findComponentDescriptor;
+exports.findLayoutTypeDescriptor = findLayoutTypeDescriptor;
+//# sourceMappingURL=DescriptorCatalog.js.map

package/dist/cjs/editing/DescriptorCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DescriptorCatalog.js","sources":["../../../editing/DescriptorCatalog.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ComponentDescriptor, LayoutTypeDescriptor } from '@cratis/scene.model';\nimport { layoutTypeDescriptors } from './layoutTypeDescriptors';\n\n/**\n * Everything an editor knows how to describe: the component descriptors packages contribute, and the layout types\n * the model itself defines.\n *\n * It is a derived view over what packages ship - not a registry anything registers into. Build one from the\n * descriptors of the packages a profile lists, and rebuild it when the list changes.\n */\nexport interface DescriptorCatalog {\n    components: ComponentDescriptor[];\n    layoutTypes: LayoutTypeDescriptor[];\n}\n\n/**\n * Builds a catalog from the component descriptors of the active packages, plus the built-in layout types.\n *\n * When two descriptors name the same component the later one wins, which is the same override-priority rule\n * the profile's package order already means for components.\n */\nexport function createDescriptorCatalog(componentDescriptors: ComponentDescriptor[] = []): DescriptorCatalog {\n    const byComponent = new Map<string, ComponentDescriptor>();\n    for (const descriptor of componentDescriptors) byComponent.set(descriptor.component, descriptor);\n\n    return { components: [...byComponent.values()], layoutTypes: layoutTypeDescriptors };\n}\n\n/**\n * Finds the descriptor of a component by the name an element carries.\n *\n * An exact match wins. Otherwise a bare name (`dataTable`) finds the one descriptor whose component ends in\n * `:dataTable`; a bare name that several packages describe has no single answer, so it finds none.\n */\nexport function findComponentDescriptor(catalog: DescriptorCatalog, componentName: string): ComponentDescriptor | undefined {\n    const exact = catalog.components.find(descriptor => descriptor.component === componentName);\n    if (exact) return exact;\n\n    const matches = catalog.components.filter(descriptor => descriptor.component.endsWith(`:${componentName}`));\n    return matches.length === 1 ? matches[0] : undefined;\n}\n\n/**\n * Finds the descriptor of a layout type.\n */\nexport function findLayoutTypeDescriptor(catalog: DescriptorCatalog, type: string): LayoutTypeDescriptor | undefined {\n    return catalog.layoutTypes.find(descriptor => descriptor.type === type);\n}\n"],"names":["createDescriptorCatalog","componentDescriptors","byComponent","Map","descriptor","set","component","components","values","layoutTypes","layoutTypeDescriptors","findComponentDescriptor","catalog","componentName","exact","find","matches","filter","endsWith","length","undefined","findLayoutTypeDescriptor","type"],"mappings":";;;;AAAA;AACA;AAiBA;;;;;AAKC,IACM,SAASA,uBAAAA,CAAwBC,oBAAAA,GAA8C,EAAE,EAAA;AACpF,IAAA,MAAMC,cAAc,IAAIC,GAAAA,EAAAA;IACxB,KAAK,MAAMC,cAAcH,oBAAAA,CAAsBC,WAAAA,CAAYG,GAAG,CAACD,UAAAA,CAAWE,SAAS,EAAEF,UAAAA,CAAAA;IAErF,OAAO;QAAEG,UAAAA,EAAY;AAAIL,YAAAA,GAAAA,WAAAA,CAAYM,MAAM;AAAG,SAAA;QAAEC,WAAAA,EAAaC;AAAsB,KAAA;AACvF;AAEA;;;;;AAKC,IACM,SAASC,uBAAAA,CAAwBC,OAA0B,EAAEC,aAAqB,EAAA;IACrF,MAAMC,KAAAA,GAAQF,OAAAA,CAAQL,UAAU,CAACQ,IAAI,CAACX,CAAAA,UAAAA,GAAcA,UAAAA,CAAWE,SAAS,KAAKO,aAAAA,CAAAA;AAC7E,IAAA,IAAIC,OAAO,OAAOA,KAAAA;AAElB,IAAA,MAAME,UAAUJ,OAAAA,CAAQL,UAAU,CAACU,MAAM,CAACb,CAAAA,UAAAA,GAAcA,UAAAA,CAAWE,SAAS,CAACY,QAAQ,CAAC,CAAC,CAAC,EAAEL,aAAAA,CAAAA,CAAe,CAAA,CAAA;AACzG,IAAA,OAAOG,QAAQG,MAAM,KAAK,IAAIH,OAAO,CAAC,EAAE,GAAGI,SAAAA;AAC/C;AAEA;;AAEC,IACM,SAASC,wBAAAA,CAAyBT,OAA0B,EAAEU,IAAY,EAAA;IAC7E,OAAOV,OAAAA,CAAQH,WAAW,CAACM,IAAI,CAACX,CAAAA,UAAAA,GAAcA,UAAAA,CAAWkB,IAAI,KAAKA,IAAAA,CAAAA;AACtE;;;;"}

package/dist/cjs/editing/EditSession.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var exposureGrants = require('./exposureGrants.js');
+var indexDocument = require('./indexDocument.js');
+var inspect = require('./inspect.js');
+var resolveEffectiveConfiguration = require('./resolveEffectiveConfiguration.js');
+var resolveTemplateChain = require('./resolveTemplateChain.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Everything an edit needs to decide whether it is allowed, worked out once against the document as it was.
+ */ class EditSession {
+    document;
+    context;
+    index;
+    chain;
+    grants;
+    configuration;
+    constructor(document, context){
+        this.document = document;
+        this.context = context;
+        this.index = indexDocument.indexDocument(document);
+        this.chain = resolveTemplateChain.resolveTemplateChain(document, context.scope);
+        this.grants = exposureGrants.computeExposureGrants(this.chain, context.catalog);
+        this.configuration = resolveEffectiveConfiguration.resolveEffectiveConfiguration(this.chain, document.instanceContributions, context.catalog);
+    }
+    /** The instance id the scope contributes as, or `undefined` when the scope was not found. */ get scopeInstance() {
+        return this.chain.levels.at(-1)?.instance;
+    }
+    /** What the scope's instance may configure on inherited components. */ get scopeGrants() {
+        return (this.scopeInstance === undefined ? undefined : this.grants.byInstance.get(this.scopeInstance)) ?? new Map();
+    }
+    /** Whether the scope itself owns the node. */ isLocal(record) {
+        return inspect.provenanceOf(record, this.chain, this.scopeGrants).kind === scene_model.ProvenanceKind.Local;
+    }
+    /** Where an inherited node comes from, for a message. */ sourceOf(record) {
+        return record.owner;
+    }
+}
+
+exports.EditSession = EditSession;
+//# sourceMappingURL=EditSession.js.map

package/dist/cjs/editing/EditSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditSession.js","sources":["../../../editing/EditSession.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 { ProvenanceKind, SceneDocument } from '@cratis/scene.model';\nimport { EditingContext } from './EditingContext';\nimport { DocumentIndex, NodeRecord } from './DocumentIndex';\nimport { ExposureGrant, ExposureGrants, computeExposureGrants } from './exposureGrants';\nimport { indexDocument } from './indexDocument';\nimport { provenanceOf } from './inspect';\nimport { resolveEffectiveConfiguration } from './resolveEffectiveConfiguration';\nimport { resolveTemplateChain } from './resolveTemplateChain';\nimport { TemplateChain } from './TemplateChain';\nimport { EffectiveConfiguration } from '@cratis/scene.model';\n\n/**\n * Everything an edit needs to decide whether it is allowed, worked out once against the document as it was.\n */\nexport class EditSession {\n    readonly index: DocumentIndex;\n    readonly chain: TemplateChain;\n    readonly grants: ExposureGrants;\n    readonly configuration: EffectiveConfiguration;\n\n    constructor(readonly document: SceneDocument, readonly context: EditingContext) {\n        this.index = indexDocument(document);\n        this.chain = resolveTemplateChain(document, context.scope);\n        this.grants = computeExposureGrants(this.chain, context.catalog);\n        this.configuration = resolveEffectiveConfiguration(this.chain, document.instanceContributions, context.catalog);\n    }\n\n    /** The instance id the scope contributes as, or `undefined` when the scope was not found. */\n    get scopeInstance(): string | undefined {\n        return this.chain.levels.at(-1)?.instance;\n    }\n\n    /** What the scope's instance may configure on inherited components. */\n    get scopeGrants(): Map<string, ExposureGrant> {\n        return (this.scopeInstance === undefined ? undefined : this.grants.byInstance.get(this.scopeInstance)) ?? new Map();\n    }\n\n    /** Whether the scope itself owns the node. */\n    isLocal(record: NodeRecord): boolean {\n        return provenanceOf(record, this.chain, this.scopeGrants).kind === ProvenanceKind.Local;\n    }\n\n    /** Where an inherited node comes from, for a message. */\n    sourceOf(record: NodeRecord): string {\n        return record.owner;\n    }\n}\n"],"names":["EditSession","index","chain","grants","configuration","context","document","indexDocument","resolveTemplateChain","scope","computeExposureGrants","catalog","resolveEffectiveConfiguration","instanceContributions","scopeInstance","levels","at","instance","scopeGrants","undefined","byInstance","get","Map","isLocal","record","provenanceOf","kind","ProvenanceKind","Local","sourceOf","owner"],"mappings":";;;;;;;;;AAAA;AACA;AAaA;;AAEC,IACM,MAAMA,WAAAA,CAAAA;;;IACAC,KAAAA;IACAC,KAAAA;IACAC,MAAAA;IACAC,aAAAA;AAET,IAAA,WAAA,CAAY,QAAgC,EAAWC,OAAuB,CAAE;aAA3DC,QAAAA,GAAAA,QAAAA;aAAkCD,OAAAA,GAAAA,OAAAA;QACnD,IAAI,CAACJ,KAAK,GAAGM,2BAAAA,CAAcD,QAAAA,CAAAA;AAC3B,QAAA,IAAI,CAACJ,KAAK,GAAGM,yCAAAA,CAAqBF,QAAAA,EAAUD,QAAQI,KAAK,CAAA;QACzD,IAAI,CAACN,MAAM,GAAGO,oCAAAA,CAAsB,IAAI,CAACR,KAAK,EAAEG,OAAAA,CAAQM,OAAO,CAAA;AAC/D,QAAA,IAAI,CAACP,aAAa,GAAGQ,2DAAAA,CAA8B,IAAI,CAACV,KAAK,EAAEI,QAAAA,CAASO,qBAAqB,EAAER,OAAAA,CAAQM,OAAO,CAAA;AAClH,IAAA;kGAGA,IAAIG,aAAAA,GAAoC;QACpC,OAAO,IAAI,CAACZ,KAAK,CAACa,MAAM,CAACC,EAAE,CAAC,EAAC,CAAA,EAAIC,QAAAA;AACrC,IAAA;4EAGA,IAAIC,WAAAA,GAA0C;QAC1C,OAAQ,CAAA,IAAI,CAACJ,aAAa,KAAKK,SAAAA,GAAYA,YAAY,IAAI,CAAChB,MAAM,CAACiB,UAAU,CAACC,GAAG,CAAC,IAAI,CAACP,aAAa,CAAA,KAAM,IAAIQ,GAAAA,EAAAA;AAClH,IAAA;mDAGAC,OAAAA,CAAQC,MAAkB,EAAW;AACjC,QAAA,OAAOC,oBAAAA,CAAaD,MAAAA,EAAQ,IAAI,CAACtB,KAAK,EAAE,IAAI,CAACgB,WAAW,CAAA,CAAEQ,IAAI,KAAKC,2BAAeC,KAAK;AAC3F,IAAA;8DAGAC,QAAAA,CAASL,MAAkB,EAAU;AACjC,QAAA,OAAOA,OAAOM,KAAK;AACvB,IAAA;AACJ;;"}

package/dist/cjs/editing/applyEdit.js

@@ -0,0 +1,83 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var diagnostics = require('./diagnostics.js');
+var EditSession = require('./EditSession.js');
+var exposureEdits = require('./exposureEdits.js');
+var instanceEdits = require('./instanceEdits.js');
+var layoutTypeEdits = require('./layoutTypeEdits.js');
+var pathAccess = require('./pathAccess.js');
+var propertyEdits = require('./propertyEdits.js');
+var structureEdits = require('./structureEdits.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+function run(session, edit, clone, diagnostics$1) {
+    const handle = (handler)=>handler(session, edit, clone, diagnostics$1);
+    switch(edit.kind){
+        case scene_model.SceneEditKind.SetProperty:
+            return handle(propertyEdits.applySetProperty);
+        case scene_model.SceneEditKind.ResetProperty:
+            return handle(propertyEdits.applyResetProperty);
+        case scene_model.SceneEditKind.ChangeLayoutType:
+            return handle(layoutTypeEdits.applyChangeLayoutType);
+        case scene_model.SceneEditKind.InsertNode:
+            return handle(structureEdits.applyInsertNode);
+        case scene_model.SceneEditKind.MoveNode:
+            return handle(structureEdits.applyMoveNode);
+        case scene_model.SceneEditKind.RemoveNode:
+            return handle(structureEdits.applyRemoveNode);
+        case scene_model.SceneEditKind.SetInstanceValue:
+            return handle(instanceEdits.applySetInstanceValue);
+        case scene_model.SceneEditKind.ResetInstanceValue:
+            return handle(instanceEdits.applyResetInstanceValue);
+        case scene_model.SceneEditKind.AddCollectionItem:
+            return handle(instanceEdits.applyAddCollectionItem);
+        case scene_model.SceneEditKind.RemoveCollectionItem:
+            return handle(instanceEdits.applyRemoveCollectionItem);
+        case scene_model.SceneEditKind.ReorderCollectionItem:
+            return handle(instanceEdits.applyReorderCollectionItem);
+        case scene_model.SceneEditKind.EditCollectionItem:
+            return handle(instanceEdits.applyEditCollectionItem);
+        case scene_model.SceneEditKind.ExposeProperty:
+            return handle(exposureEdits.applyExposeProperty);
+        case scene_model.SceneEditKind.UnexposeProperty:
+            return handle(exposureEdits.applyUnexposeProperty);
+        default:
+            diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.InvalidEdit, `'${edit.kind}' is not an edit this engine knows.`));
+    }
+}
+/**
+ * Applies one edit to a document.
+ *
+ * Pure and immutable: the document passed in is never changed, and the result is a new document. Edits are plain
+ * data, so a host can persist them and build undo and redo by keeping the documents either side. On any error the
+ * prior document comes back - the same object - together with the diagnostics, so a refused edit leaves nothing
+ * half done.
+ *
+ * What an edit may touch follows the editing scope. Nodes the scope owns are edited directly; inherited nodes are
+ * read-only, and their exposed properties are configured with the instance edits, which are checked against what
+ * each owner exposed.
+ *
+ * @param model The document to edit.
+ * @param edit What to do.
+ * @param context The catalog and the editing scope.
+ */ function applyEdit(model, edit, context) {
+    const session = new EditSession.EditSession(model, context);
+    const clone = pathAccess.cloneData(model);
+    const diagnostics$1 = [];
+    run(session, edit, clone, diagnostics$1);
+    if (diagnostics.hasErrors(diagnostics$1)) return {
+        model,
+        diagnostics: diagnostics$1,
+        applied: false
+    };
+    return {
+        model: clone,
+        diagnostics: diagnostics$1,
+        applied: true
+    };
+}
+
+exports.applyEdit = applyEdit;
+//# sourceMappingURL=applyEdit.js.map

package/dist/cjs/editing/applyEdit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyEdit.js","sources":["../../../editing/applyEdit.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 { DiagnosticCode, SceneDiagnostic, SceneDocument, SceneEdit, SceneEditKind } from '@cratis/scene.model';\nimport { errorDiagnostic, hasErrors } from './diagnostics';\nimport { EditOutcome } from './EditOutcome';\nimport { EditingContext } from './EditingContext';\nimport { EditSession } from './EditSession';\nimport { applyExposeProperty, applyUnexposeProperty } from './exposureEdits';\nimport {\n    applyAddCollectionItem, applyEditCollectionItem, applyRemoveCollectionItem, applyReorderCollectionItem,\n    applyResetInstanceValue, applySetInstanceValue,\n} from './instanceEdits';\nimport { applyChangeLayoutType } from './layoutTypeEdits';\nimport { cloneData } from './pathAccess';\nimport { applyResetProperty, applySetProperty } from './propertyEdits';\nimport { applyInsertNode, applyMoveNode, applyRemoveNode } from './structureEdits';\n\ntype Handler<TEdit extends SceneEdit> = (session: EditSession, edit: TEdit, clone: SceneDocument, diagnostics: SceneDiagnostic[]) => void;\n\nfunction run(session: EditSession, edit: SceneEdit, clone: SceneDocument, diagnostics: SceneDiagnostic[]): void {\n    const handle = <TEdit extends SceneEdit>(handler: Handler<TEdit>) => handler(session, edit as TEdit, clone, diagnostics);\n\n    switch (edit.kind) {\n        case SceneEditKind.SetProperty: return handle(applySetProperty);\n        case SceneEditKind.ResetProperty: return handle(applyResetProperty);\n        case SceneEditKind.ChangeLayoutType: return handle(applyChangeLayoutType);\n        case SceneEditKind.InsertNode: return handle(applyInsertNode);\n        case SceneEditKind.MoveNode: return handle(applyMoveNode);\n        case SceneEditKind.RemoveNode: return handle(applyRemoveNode);\n        case SceneEditKind.SetInstanceValue: return handle(applySetInstanceValue);\n        case SceneEditKind.ResetInstanceValue: return handle(applyResetInstanceValue);\n        case SceneEditKind.AddCollectionItem: return handle(applyAddCollectionItem);\n        case SceneEditKind.RemoveCollectionItem: return handle(applyRemoveCollectionItem);\n        case SceneEditKind.ReorderCollectionItem: return handle(applyReorderCollectionItem);\n        case SceneEditKind.EditCollectionItem: return handle(applyEditCollectionItem);\n        case SceneEditKind.ExposeProperty: return handle(applyExposeProperty);\n        case SceneEditKind.UnexposeProperty: return handle(applyUnexposeProperty);\n        default:\n            diagnostics.push(errorDiagnostic(DiagnosticCode.InvalidEdit, `'${(edit as { kind?: string }).kind}' is not an edit this engine knows.`));\n    }\n}\n\n/**\n * Applies one edit to a document.\n *\n * Pure and immutable: the document passed in is never changed, and the result is a new document. Edits are plain\n * data, so a host can persist them and build undo and redo by keeping the documents either side. On any error the\n * prior document comes back - the same object - together with the diagnostics, so a refused edit leaves nothing\n * half done.\n *\n * What an edit may touch follows the editing scope. Nodes the scope owns are edited directly; inherited nodes are\n * read-only, and their exposed properties are configured with the instance edits, which are checked against what\n * each owner exposed.\n *\n * @param model The document to edit.\n * @param edit What to do.\n * @param context The catalog and the editing scope.\n */\nexport function applyEdit(model: SceneDocument, edit: SceneEdit, context: EditingContext): EditOutcome {\n    const session = new EditSession(model, context);\n    const clone = cloneData(model);\n    const diagnostics: SceneDiagnostic[] = [];\n\n    run(session, edit, clone, diagnostics);\n\n    if (hasErrors(diagnostics)) return { model, diagnostics, applied: false };\n    return { model: clone, diagnostics, applied: true };\n}\n"],"names":["run","session","edit","clone","diagnostics","handle","handler","kind","SceneEditKind","SetProperty","applySetProperty","ResetProperty","applyResetProperty","ChangeLayoutType","applyChangeLayoutType","InsertNode","applyInsertNode","MoveNode","applyMoveNode","RemoveNode","applyRemoveNode","SetInstanceValue","applySetInstanceValue","ResetInstanceValue","applyResetInstanceValue","AddCollectionItem","applyAddCollectionItem","RemoveCollectionItem","applyRemoveCollectionItem","ReorderCollectionItem","applyReorderCollectionItem","EditCollectionItem","applyEditCollectionItem","ExposeProperty","applyExposeProperty","UnexposeProperty","applyUnexposeProperty","push","errorDiagnostic","DiagnosticCode","InvalidEdit","applyEdit","model","context","EditSession","cloneData","hasErrors","applied"],"mappings":";;;;;;;;;;;;AAAA;AACA;AAmBA,SAASA,IAAIC,OAAoB,EAAEC,IAAe,EAAEC,KAAoB,EAAEC,aAA8B,EAAA;AACpG,IAAA,MAAMC,SAAS,CAA0BC,OAAAA,GAA4BA,OAAAA,CAAQL,OAAAA,EAASC,MAAeC,KAAAA,EAAOC,aAAAA,CAAAA;AAE5G,IAAA,OAAQF,KAAKK,IAAI;AACb,QAAA,KAAKC,0BAAcC,WAAW;AAAE,YAAA,OAAOJ,MAAAA,CAAOK,8BAAAA,CAAAA;AAC9C,QAAA,KAAKF,0BAAcG,aAAa;AAAE,YAAA,OAAON,MAAAA,CAAOO,gCAAAA,CAAAA;AAChD,QAAA,KAAKJ,0BAAcK,gBAAgB;AAAE,YAAA,OAAOR,MAAAA,CAAOS,qCAAAA,CAAAA;AACnD,QAAA,KAAKN,0BAAcO,UAAU;AAAE,YAAA,OAAOV,MAAAA,CAAOW,8BAAAA,CAAAA;AAC7C,QAAA,KAAKR,0BAAcS,QAAQ;AAAE,YAAA,OAAOZ,MAAAA,CAAOa,4BAAAA,CAAAA;AAC3C,QAAA,KAAKV,0BAAcW,UAAU;AAAE,YAAA,OAAOd,MAAAA,CAAOe,8BAAAA,CAAAA;AAC7C,QAAA,KAAKZ,0BAAca,gBAAgB;AAAE,YAAA,OAAOhB,MAAAA,CAAOiB,mCAAAA,CAAAA;AACnD,QAAA,KAAKd,0BAAce,kBAAkB;AAAE,YAAA,OAAOlB,MAAAA,CAAOmB,qCAAAA,CAAAA;AACrD,QAAA,KAAKhB,0BAAciB,iBAAiB;AAAE,YAAA,OAAOpB,MAAAA,CAAOqB,oCAAAA,CAAAA;AACpD,QAAA,KAAKlB,0BAAcmB,oBAAoB;AAAE,YAAA,OAAOtB,MAAAA,CAAOuB,uCAAAA,CAAAA;AACvD,QAAA,KAAKpB,0BAAcqB,qBAAqB;AAAE,YAAA,OAAOxB,MAAAA,CAAOyB,wCAAAA,CAAAA;AACxD,QAAA,KAAKtB,0BAAcuB,kBAAkB;AAAE,YAAA,OAAO1B,MAAAA,CAAO2B,qCAAAA,CAAAA;AACrD,QAAA,KAAKxB,0BAAcyB,cAAc;AAAE,YAAA,OAAO5B,MAAAA,CAAO6B,iCAAAA,CAAAA;AACjD,QAAA,KAAK1B,0BAAc2B,gBAAgB;AAAE,YAAA,OAAO9B,MAAAA,CAAO+B,mCAAAA,CAAAA;AACnD,QAAA;AACIhC,YAAAA,aAAAA,CAAYiC,IAAI,CAACC,2BAAAA,CAAgBC,0BAAAA,CAAeC,WAAW,EAAE,CAAC,CAAC,EAAE,IAACtC,CAA2BK,IAAI,CAAC,mCAAmC,CAAC,CAAA,CAAA;AAC9I;AACJ;AAEA;;;;;;;;;;;;;;;AAeC,IACM,SAASkC,SAAAA,CAAUC,KAAoB,EAAExC,IAAe,EAAEyC,OAAuB,EAAA;IACpF,MAAM1C,OAAAA,GAAU,IAAI2C,uBAAAA,CAAYF,KAAAA,EAAOC,OAAAA,CAAAA;AACvC,IAAA,MAAMxC,QAAQ0C,oBAAAA,CAAUH,KAAAA,CAAAA;AACxB,IAAA,MAAMtC,gBAAiC,EAAE;IAEzCJ,GAAAA,CAAIC,OAAAA,EAASC,MAAMC,KAAAA,EAAOC,aAAAA,CAAAA;IAE1B,IAAI0C,qBAAAA,CAAU1C,gBAAc,OAAO;AAAEsC,QAAAA,KAAAA;AAAOtC,qBAAAA,aAAAA;QAAa2C,OAAAA,EAAS;AAAM,KAAA;IACxE,OAAO;QAAEL,KAAAA,EAAOvC,KAAAA;AAAOC,qBAAAA,aAAAA;QAAa2C,OAAAA,EAAS;AAAK,KAAA;AACtD;;"}

package/dist/cjs/editing/applyEffectiveConfiguration.js

@@ -0,0 +1,62 @@
+'use strict';
+
+var elementKind = require('../elementKind.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Returns the element tree a renderer should draw once effective configuration is applied: each configurable
+ * component carries its resolved properties.
+ *
+ * Pure, and structure-sharing - an element with nothing to change comes back as the same object, so a renderer
+ * that memoizes on identity does not redraw what did not change. There is no design-time flag here or anywhere
+ * downstream: a screen being edited and a screen being played go through this same function.
+ *
+ * @param element The element tree from the template or screen.
+ * @param configuration What {@link resolveEffectiveConfiguration} produced for the chain the tree sits in.
+ */ function applyEffectiveConfiguration(element, configuration) {
+    if (elementKind.isExternalComponent(element)) {
+        const resolved = configuration.components.find((candidate)=>candidate.component === element.id);
+        let changed = resolved !== undefined;
+        const slots = {};
+        for (const [name, children] of Object.entries(element.slots)){
+            const mapped = children.map((child)=>applyEffectiveConfiguration(child, configuration));
+            if (mapped.some((child, index)=>child !== children[index])) changed = true;
+            slots[name] = mapped;
+        }
+        const updated = {
+            ...element,
+            properties: resolved?.properties ?? element.properties,
+            slots
+        };
+        return changed ? updated : element;
+    }
+    if (elementKind.isContentControl(element)) {
+        const content = applyEffectiveConfiguration(element.content, configuration);
+        const updated = {
+            ...element,
+            content
+        };
+        return content === element.content ? element : updated;
+    }
+    if (elementKind.isItemsControl(element)) {
+        const itemTemplate = applyEffectiveConfiguration(element.itemTemplate, configuration);
+        const updated = {
+            ...element,
+            itemTemplate
+        };
+        return itemTemplate === element.itemTemplate ? element : updated;
+    }
+    if (elementKind.isPanel(element)) {
+        const children = element.children.map((child)=>applyEffectiveConfiguration(child, configuration));
+        const updated = {
+            ...element,
+            children
+        };
+        return children.some((child, index)=>child !== element.children[index]) ? updated : element;
+    }
+    return element;
+}
+
+exports.applyEffectiveConfiguration = applyEffectiveConfiguration;
+//# sourceMappingURL=applyEffectiveConfiguration.js.map

package/dist/cjs/editing/applyEffectiveConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyEffectiveConfiguration.js","sources":["../../../editing/applyEffectiveConfiguration.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 { ContentControl, EffectiveConfiguration, ExternalComponent, ItemsControl, Panel, SceneElement } from '@cratis/scene.model';\nimport { isContentControl, isExternalComponent, isItemsControl, isPanel } from '../elementKind';\n\n/**\n * Returns the element tree a renderer should draw once effective configuration is applied: each configurable\n * component carries its resolved properties.\n *\n * Pure, and structure-sharing - an element with nothing to change comes back as the same object, so a renderer\n * that memoizes on identity does not redraw what did not change. There is no design-time flag here or anywhere\n * downstream: a screen being edited and a screen being played go through this same function.\n *\n * @param element The element tree from the template or screen.\n * @param configuration What {@link resolveEffectiveConfiguration} produced for the chain the tree sits in.\n */\nexport function applyEffectiveConfiguration(element: SceneElement, configuration: EffectiveConfiguration): SceneElement {\n    if (isExternalComponent(element)) {\n        const resolved = configuration.components.find(candidate => candidate.component === element.id);\n        let changed = resolved !== undefined;\n\n        const slots: typeof element.slots = {};\n        for (const [name, children] of Object.entries(element.slots)) {\n            const mapped = children.map(child => applyEffectiveConfiguration(child, configuration));\n            if (mapped.some((child, index) => child !== children[index])) changed = true;\n            slots[name] = mapped;\n        }\n\n        const updated: ExternalComponent = { ...element, properties: resolved?.properties ?? element.properties, slots };\n        return changed ? updated : element;\n    }\n\n    if (isContentControl(element)) {\n        const content = applyEffectiveConfiguration(element.content, configuration);\n        const updated: ContentControl = { ...element, content };\n        return content === element.content ? element : updated;\n    }\n\n    if (isItemsControl(element)) {\n        const itemTemplate = applyEffectiveConfiguration(element.itemTemplate, configuration);\n        const updated: ItemsControl = { ...element, itemTemplate };\n        return itemTemplate === element.itemTemplate ? element : updated;\n    }\n\n    if (isPanel(element)) {\n        const children = element.children.map(child => applyEffectiveConfiguration(child, configuration));\n        const updated: Panel = { ...element, children };\n        return children.some((child, index) => child !== element.children[index]) ? updated : element;\n    }\n\n    return element;\n}\n"],"names":["applyEffectiveConfiguration","element","configuration","isExternalComponent","resolved","components","find","candidate","component","id","changed","undefined","slots","name","children","Object","entries","mapped","map","child","some","index","updated","properties","isContentControl","content","isItemsControl","itemTemplate","isPanel"],"mappings":";;;;AAAA;AACA;AAKA;;;;;;;;;;AAUC,IACM,SAASA,2BAAAA,CAA4BC,OAAqB,EAAEC,aAAqC,EAAA;AACpG,IAAA,IAAIC,gCAAoBF,OAAAA,CAAAA,EAAU;AAC9B,QAAA,MAAMG,QAAAA,GAAWF,aAAAA,CAAcG,UAAU,CAACC,IAAI,CAACC,CAAAA,SAAAA,GAAaA,SAAAA,CAAUC,SAAS,KAAKP,OAAAA,CAAQQ,EAAE,CAAA;AAC9F,QAAA,IAAIC,UAAUN,QAAAA,KAAaO,SAAAA;AAE3B,QAAA,MAAMC,QAA8B,EAAC;QACrC,KAAK,MAAM,CAACC,IAAAA,EAAMC,QAAAA,CAAS,IAAIC,OAAOC,OAAO,CAACf,OAAAA,CAAQW,KAAK,CAAA,CAAG;AAC1D,YAAA,MAAMK,SAASH,QAAAA,CAASI,GAAG,CAACC,CAAAA,KAAAA,GAASnB,4BAA4BmB,KAAAA,EAAOjB,aAAAA,CAAAA,CAAAA;YACxE,IAAIe,MAAAA,CAAOG,IAAI,CAAC,CAACD,KAAAA,EAAOE,KAAAA,GAAUF,KAAAA,KAAUL,QAAQ,CAACO,KAAAA,CAAM,CAAA,EAAGX,OAAAA,GAAU,IAAA;YACxEE,KAAK,CAACC,KAAK,GAAGI,MAAAA;AAClB,QAAA;AAEA,QAAA,MAAMK,OAAAA,GAA6B;AAAE,YAAA,GAAGrB,OAAO;YAAEsB,UAAAA,EAAYnB,QAAAA,EAAUmB,UAAAA,IAActB,OAAAA,CAAQsB,UAAU;AAAEX,YAAAA;AAAM,SAAA;AAC/G,QAAA,OAAOF,UAAUY,OAAAA,GAAUrB,OAAAA;AAC/B,IAAA;AAEA,IAAA,IAAIuB,6BAAiBvB,OAAAA,CAAAA,EAAU;AAC3B,QAAA,MAAMwB,OAAAA,GAAUzB,2BAAAA,CAA4BC,OAAAA,CAAQwB,OAAO,EAAEvB,aAAAA,CAAAA;AAC7D,QAAA,MAAMoB,OAAAA,GAA0B;AAAE,YAAA,GAAGrB,OAAO;AAAEwB,YAAAA;AAAQ,SAAA;AACtD,QAAA,OAAOA,OAAAA,KAAYxB,OAAAA,CAAQwB,OAAO,GAAGxB,OAAAA,GAAUqB,OAAAA;AACnD,IAAA;AAEA,IAAA,IAAII,2BAAezB,OAAAA,CAAAA,EAAU;AACzB,QAAA,MAAM0B,YAAAA,GAAe3B,2BAAAA,CAA4BC,OAAAA,CAAQ0B,YAAY,EAAEzB,aAAAA,CAAAA;AACvE,QAAA,MAAMoB,OAAAA,GAAwB;AAAE,YAAA,GAAGrB,OAAO;AAAE0B,YAAAA;AAAa,SAAA;AACzD,QAAA,OAAOA,YAAAA,KAAiB1B,OAAAA,CAAQ0B,YAAY,GAAG1B,OAAAA,GAAUqB,OAAAA;AAC7D,IAAA;AAEA,IAAA,IAAIM,oBAAQ3B,OAAAA,CAAAA,EAAU;QAClB,MAAMa,QAAAA,GAAWb,QAAQa,QAAQ,CAACI,GAAG,CAACC,CAAAA,KAAAA,GAASnB,2BAAAA,CAA4BmB,KAAAA,EAAOjB,aAAAA,CAAAA,CAAAA;AAClF,QAAA,MAAMoB,OAAAA,GAAiB;AAAE,YAAA,GAAGrB,OAAO;AAAEa,YAAAA;AAAS,SAAA;AAC9C,QAAA,OAAOA,QAAAA,CAASM,IAAI,CAAC,CAACD,KAAAA,EAAOE,KAAAA,GAAUF,KAAAA,KAAUlB,OAAAA,CAAQa,QAAQ,CAACO,KAAAA,CAAM,CAAA,GAAIC,OAAAA,GAAUrB,OAAAA;AAC1F,IAAA;IAEA,OAAOA,OAAAA;AACX;;"}

package/dist/cjs/editing/collectComponents.js

@@ -0,0 +1,34 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+function isExternalComponentValue(value) {
+    const candidate = value;
+    return typeof candidate.id === 'string' && typeof candidate.componentName === 'string' && candidate.properties !== null && typeof candidate.properties === 'object';
+}
+/**
+ * Finds every external component anywhere inside a layout, template, dialog template or screen, each once by id.
+ *
+ * It scans the value's structure rather than following a fixed list of properties, so a component is found
+ * wherever the model keeps it - slot content, a flow leaf, a freeform placement, a panel's children, another
+ * component's slot. A freeform arrangement repeats an element across its size-class variants; the first copy
+ * is the one returned.
+ */ function collectComponents(owner) {
+    const found = new Map();
+    const visit = (value)=>{
+        if (value === null || typeof value !== 'object') return;
+        if (Array.isArray(value)) {
+            for (const item of value)visit(item);
+            return;
+        }
+        if (isExternalComponentValue(value) && !found.has(value.id)) found.set(value.id, value);
+        for (const child of Object.values(value))visit(child);
+    };
+    visit(owner);
+    return [
+        ...found.values()
+    ];
+}
+
+exports.collectComponents = collectComponents;
+//# sourceMappingURL=collectComponents.js.map

package/dist/cjs/editing/collectComponents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectComponents.js","sources":["../../../editing/collectComponents.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 { ExternalComponent } from '@cratis/scene.model';\n\nfunction isExternalComponentValue(value: object): value is ExternalComponent {\n    const candidate = value as Partial<ExternalComponent>;\n    return typeof candidate.id === 'string' && typeof candidate.componentName === 'string'\n        && candidate.properties !== null && typeof candidate.properties === 'object';\n}\n\n/**\n * Finds every external component anywhere inside a layout, template, dialog template or screen, each once by id.\n *\n * It scans the value's structure rather than following a fixed list of properties, so a component is found\n * wherever the model keeps it - slot content, a flow leaf, a freeform placement, a panel's children, another\n * component's slot. A freeform arrangement repeats an element across its size-class variants; the first copy\n * is the one returned.\n */\nexport function collectComponents(owner: unknown): ExternalComponent[] {\n    const found = new Map<string, ExternalComponent>();\n\n    const visit = (value: unknown): void => {\n        if (value === null || typeof value !== 'object') return;\n        if (Array.isArray(value)) {\n            for (const item of value) visit(item);\n            return;\n        }\n\n        if (isExternalComponentValue(value) && !found.has(value.id)) found.set(value.id, value);\n        for (const child of Object.values(value)) visit(child);\n    };\n\n    visit(owner);\n    return [...found.values()];\n}\n"],"names":["isExternalComponentValue","value","candidate","id","componentName","properties","collectComponents","owner","found","Map","visit","Array","isArray","item","has","set","child","Object","values"],"mappings":";;AAAA;AACA;AAIA,SAASA,yBAAyBC,KAAa,EAAA;AAC3C,IAAA,MAAMC,SAAAA,GAAYD,KAAAA;AAClB,IAAA,OAAO,OAAOC,SAAAA,CAAUC,EAAE,KAAK,QAAA,IAAY,OAAOD,SAAAA,CAAUE,aAAa,KAAK,QAAA,IACvEF,UAAUG,UAAU,KAAK,QAAQ,OAAOH,SAAAA,CAAUG,UAAU,KAAK,QAAA;AAC5E;AAEA;;;;;;;IAQO,SAASC,iBAAAA,CAAkBC,KAAc,EAAA;AAC5C,IAAA,MAAMC,QAAQ,IAAIC,GAAAA,EAAAA;AAElB,IAAA,MAAMC,QAAQ,CAACT,KAAAA,GAAAA;AACX,QAAA,IAAIA,KAAAA,KAAU,IAAA,IAAQ,OAAOA,KAAAA,KAAU,QAAA,EAAU;QACjD,IAAIU,KAAAA,CAAMC,OAAO,CAACX,KAAAA,CAAAA,EAAQ;YACtB,KAAK,MAAMY,IAAAA,IAAQZ,KAAAA,CAAOS,KAAAA,CAAMG,IAAAA,CAAAA;AAChC,YAAA;AACJ,QAAA;AAEA,QAAA,IAAIb,wBAAAA,CAAyBC,KAAAA,CAAAA,IAAU,CAACO,KAAAA,CAAMM,GAAG,CAACb,KAAAA,CAAME,EAAE,CAAA,EAAGK,KAAAA,CAAMO,GAAG,CAACd,KAAAA,CAAME,EAAE,EAAEF,KAAAA,CAAAA;AACjF,QAAA,KAAK,MAAMe,KAAAA,IAASC,MAAAA,CAAOC,MAAM,CAACjB,OAAQS,KAAAA,CAAMM,KAAAA,CAAAA;AACpD,IAAA,CAAA;IAEAN,KAAAA,CAAMH,KAAAA,CAAAA;IACN,OAAO;AAAIC,QAAAA,GAAAA,KAAAA,CAAMU,MAAM;AAAG,KAAA;AAC9B;;"}

package/dist/cjs/editing/describeNode.js

@@ -0,0 +1,63 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var DescriptorCatalog = require('./DescriptorCatalog.js');
+var diagnostics = require('./diagnostics.js');
+var pathAccess = require('./pathAccess.js');
+var layoutTypeDescriptors = require('./layoutTypeDescriptors.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const layoutTypes = new Set(Object.values(scene_model.LayoutType));
+/**
+ * Works out which descriptors apply to a node.
+ *
+ * A component takes its descriptor from the catalog by the name it carries; a layout node takes its layout type's;
+ * a placement and a template have their own fixed sets. A component nothing describes has no editable
+ * properties, and says so rather than failing.
+ */ function describeNode(record, catalog) {
+    const diagnostics$1 = [];
+    if (record.kind === scene_model.SceneNodeKind.Placement) return {
+        properties: layoutTypeDescriptors.placementProperties,
+        diagnostics: diagnostics$1
+    };
+    if (record.kind === scene_model.SceneNodeKind.ScreenTemplate || record.kind === scene_model.SceneNodeKind.DialogTemplate) return {
+        properties: layoutTypeDescriptors.templateProperties,
+        diagnostics: diagnostics$1
+    };
+    if (layoutTypes.has(record.typeId)) {
+        const descriptor = DescriptorCatalog.findLayoutTypeDescriptor(catalog, record.typeId);
+        return {
+            properties: descriptor?.properties ?? [],
+            capabilities: descriptor?.capabilities,
+            diagnostics: diagnostics$1
+        };
+    }
+    if (record.kind === scene_model.SceneNodeKind.Element && record.value.componentName !== undefined) {
+        const descriptor = DescriptorCatalog.findComponentDescriptor(catalog, record.typeId);
+        if (!descriptor) {
+            diagnostics$1.push(diagnostics.warningDiagnostic(scene_model.DiagnosticCode.MissingComponentDescriptor, `Nothing describes the component '${record.typeId}', so none of its properties can be edited.`, {
+                nodeId: record.id
+            }));
+        }
+        return {
+            properties: descriptor?.properties ?? [],
+            diagnostics: diagnostics$1
+        };
+    }
+    return {
+        properties: [],
+        diagnostics: diagnostics$1
+    };
+}
+/**
+ * Reads a descriptor's value from a node: from the property bag of a component, from the node itself otherwise.
+ */ function readNodeValue(record, path) {
+    const value = record.value;
+    const isComponent = record.kind === scene_model.SceneNodeKind.Element && value.componentName !== undefined;
+    return pathAccess.getValueAtPath(isComponent ? value.properties : value, path);
+}
+
+exports.describeNode = describeNode;
+exports.readNodeValue = readNodeValue;
+//# sourceMappingURL=describeNode.js.map

package/dist/cjs/editing/describeNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describeNode.js","sources":["../../../editing/describeNode.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    DiagnosticCode, LayoutCapabilities, LayoutType, PropertyDescriptor, SceneDiagnostic, SceneNodeKind,\n} from '@cratis/scene.model';\nimport { DescriptorCatalog, findComponentDescriptor, findLayoutTypeDescriptor } from './DescriptorCatalog';\nimport { NodeRecord } from './DocumentIndex';\nimport { warningDiagnostic } from './diagnostics';\nimport { getValueAtPath } from './pathAccess';\nimport { placementProperties, templateProperties } from './layoutTypeDescriptors';\n\n/**\n * What describes a node: its editable properties, and for a layout node what the type can do.\n */\nexport interface NodeDescription {\n    properties: PropertyDescriptor[];\n    capabilities?: LayoutCapabilities;\n    diagnostics: SceneDiagnostic[];\n}\n\nconst layoutTypes = new Set<string>(Object.values(LayoutType));\n\n/**\n * Works out which descriptors apply to a node.\n *\n * A component takes its descriptor from the catalog by the name it carries; a layout node takes its layout type's;\n * a placement and a template have their own fixed sets. A component nothing describes has no editable\n * properties, and says so rather than failing.\n */\nexport function describeNode(record: NodeRecord, catalog: DescriptorCatalog): NodeDescription {\n    const diagnostics: SceneDiagnostic[] = [];\n\n    if (record.kind === SceneNodeKind.Placement) return { properties: placementProperties, diagnostics };\n    if (record.kind === SceneNodeKind.ScreenTemplate || record.kind === SceneNodeKind.DialogTemplate) return { properties: templateProperties, diagnostics };\n\n    if (layoutTypes.has(record.typeId)) {\n        const descriptor = findLayoutTypeDescriptor(catalog, record.typeId);\n        return { properties: descriptor?.properties ?? [], capabilities: descriptor?.capabilities, diagnostics };\n    }\n\n    if (record.kind === SceneNodeKind.Element && (record.value as { componentName?: unknown }).componentName !== undefined) {\n        const descriptor = findComponentDescriptor(catalog, record.typeId);\n        if (!descriptor) {\n            diagnostics.push(warningDiagnostic(DiagnosticCode.MissingComponentDescriptor, `Nothing describes the component '${record.typeId}', so none of its properties can be edited.`, { nodeId: record.id }));\n        }\n\n        return { properties: descriptor?.properties ?? [], diagnostics };\n    }\n\n    return { properties: [], diagnostics };\n}\n\n/**\n * Reads a descriptor's value from a node: from the property bag of a component, from the node itself otherwise.\n */\nexport function readNodeValue(record: NodeRecord, path: string): unknown {\n    const value = record.value as Record<string, unknown>;\n    const isComponent = record.kind === SceneNodeKind.Element && value.componentName !== undefined;\n    return getValueAtPath(isComponent ? (value.properties as Record<string, unknown>) : value, path);\n}\n"],"names":["layoutTypes","Set","Object","values","LayoutType","describeNode","record","catalog","diagnostics","kind","SceneNodeKind","Placement","properties","placementProperties","ScreenTemplate","DialogTemplate","templateProperties","has","typeId","descriptor","findLayoutTypeDescriptor","capabilities","Element","value","componentName","undefined","findComponentDescriptor","push","warningDiagnostic","DiagnosticCode","MissingComponentDescriptor","nodeId","id","readNodeValue","path","isComponent","getValueAtPath"],"mappings":";;;;;;;;AAAA;AACA;AAoBA,MAAMA,WAAAA,GAAc,IAAIC,GAAAA,CAAYC,MAAAA,CAAOC,MAAM,CAACC,sBAAAA,CAAAA,CAAAA;AAElD;;;;;;AAMC,IACM,SAASC,YAAAA,CAAaC,MAAkB,EAAEC,OAA0B,EAAA;AACvE,IAAA,MAAMC,gBAAiC,EAAE;AAEzC,IAAA,IAAIF,OAAOG,IAAI,KAAKC,yBAAAA,CAAcC,SAAS,EAAE,OAAO;QAAEC,UAAAA,EAAYC,yCAAAA;AAAqBL,qBAAAA;AAAY,KAAA;AACnG,IAAA,IAAIF,MAAAA,CAAOG,IAAI,KAAKC,yBAAAA,CAAcI,cAAc,IAAIR,MAAAA,CAAOG,IAAI,KAAKC,yBAAAA,CAAcK,cAAc,EAAE,OAAO;QAAEH,UAAAA,EAAYI,wCAAAA;AAAoBR,qBAAAA;AAAY,KAAA;AAEvJ,IAAA,IAAIR,WAAAA,CAAYiB,GAAG,CAACX,MAAAA,CAAOY,MAAM,CAAA,EAAG;AAChC,QAAA,MAAMC,UAAAA,GAAaC,0CAAAA,CAAyBb,OAAAA,EAASD,MAAAA,CAAOY,MAAM,CAAA;QAClE,OAAO;YAAEN,UAAAA,EAAYO,UAAAA,EAAYP,cAAc,EAAE;AAAES,YAAAA,YAAAA,EAAcF,UAAAA,EAAYE,YAAAA;AAAcb,yBAAAA;AAAY,SAAA;AAC3G,IAAA;AAEA,IAAA,IAAIF,MAAAA,CAAOG,IAAI,KAAKC,yBAAAA,CAAcY,OAAO,IAAI,MAAChB,CAAOiB,KAAK,CAAiCC,aAAa,KAAKC,SAAAA,EAAW;AACpH,QAAA,MAAMN,UAAAA,GAAaO,yCAAAA,CAAwBnB,OAAAA,EAASD,MAAAA,CAAOY,MAAM,CAAA;AACjE,QAAA,IAAI,CAACC,UAAAA,EAAY;AACbX,YAAAA,aAAAA,CAAYmB,IAAI,CAACC,6BAAAA,CAAkBC,0BAAAA,CAAeC,0BAA0B,EAAE,CAAC,iCAAiC,EAAExB,MAAAA,CAAOY,MAAM,CAAC,2CAA2C,CAAC,EAAE;AAAEa,gBAAAA,MAAAA,EAAQzB,OAAO0B;AAAG,aAAA,CAAA,CAAA;AACtM,QAAA;QAEA,OAAO;YAAEpB,UAAAA,EAAYO,UAAAA,EAAYP,cAAc,EAAE;AAAEJ,yBAAAA;AAAY,SAAA;AACnE,IAAA;IAEA,OAAO;AAAEI,QAAAA,UAAAA,EAAY,EAAE;AAAEJ,qBAAAA;AAAY,KAAA;AACzC;AAEA;;AAEC,IACM,SAASyB,aAAAA,CAAc3B,MAAkB,EAAE4B,IAAY,EAAA;IAC1D,MAAMX,KAAAA,GAAQjB,OAAOiB,KAAK;IAC1B,MAAMY,WAAAA,GAAc7B,OAAOG,IAAI,KAAKC,0BAAcY,OAAO,IAAIC,KAAAA,CAAMC,aAAa,KAAKC,SAAAA;AACrF,IAAA,OAAOW,yBAAAA,CAAeD,WAAAA,GAAeZ,KAAAA,CAAMX,UAAU,GAA+BW,KAAAA,EAAOW,IAAAA,CAAAA;AAC/F;;;"}

package/dist/cjs/editing/diagnostics.js

@@ -0,0 +1,36 @@
+'use strict';
+
+var scene_model = require('@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.
+/**
+ * Builds an error diagnostic: the edit or resolution step that produced it did not happen.
+ */ function errorDiagnostic(code, message, context = {}) {
+    return {
+        code,
+        severity: scene_model.DiagnosticSeverity.Error,
+        message,
+        ...context
+    };
+}
+/**
+ * Builds a warning diagnostic: the work went ahead, and the author should know something about it.
+ */ function warningDiagnostic(code, message, context = {}) {
+    return {
+        code,
+        severity: scene_model.DiagnosticSeverity.Warning,
+        message,
+        ...context
+    };
+}
+/**
+ * Whether any diagnostic is an error.
+ */ function hasErrors(diagnostics) {
+    return diagnostics.some((diagnostic)=>diagnostic.severity === scene_model.DiagnosticSeverity.Error);
+}
+
+exports.errorDiagnostic = errorDiagnostic;
+exports.hasErrors = hasErrors;
+exports.warningDiagnostic = warningDiagnostic;
+//# sourceMappingURL=diagnostics.js.map

package/dist/cjs/editing/diagnostics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.js","sources":["../../../editing/diagnostics.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 { DiagnosticCode, DiagnosticSeverity, SceneDiagnostic } from '@cratis/scene.model';\n\n/**\n * The context a diagnostic can carry besides its code and message.\n */\nexport type DiagnosticContext = Partial<Omit<SceneDiagnostic, 'code' | 'severity' | 'message'>>;\n\n/**\n * Builds an error diagnostic: the edit or resolution step that produced it did not happen.\n */\nexport function errorDiagnostic(code: DiagnosticCode, message: string, context: DiagnosticContext = {}): SceneDiagnostic {\n    return { code, severity: DiagnosticSeverity.Error, message, ...context };\n}\n\n/**\n * Builds a warning diagnostic: the work went ahead, and the author should know something about it.\n */\nexport function warningDiagnostic(code: DiagnosticCode, message: string, context: DiagnosticContext = {}): SceneDiagnostic {\n    return { code, severity: DiagnosticSeverity.Warning, message, ...context };\n}\n\n/**\n * Whether any diagnostic is an error.\n */\nexport function hasErrors(diagnostics: SceneDiagnostic[]): boolean {\n    return diagnostics.some(diagnostic => diagnostic.severity === DiagnosticSeverity.Error);\n}\n"],"names":["errorDiagnostic","code","message","context","severity","DiagnosticSeverity","Error","warningDiagnostic","Warning","hasErrors","diagnostics","some","diagnostic"],"mappings":";;;;AAAA;AACA;AASA;;IAGO,SAASA,eAAAA,CAAgBC,IAAoB,EAAEC,OAAe,EAAEC,OAAAA,GAA6B,EAAE,EAAA;IAClG,OAAO;AAAEF,QAAAA,IAAAA;AAAMG,QAAAA,QAAAA,EAAUC,+BAAmBC,KAAK;AAAEJ,QAAAA,OAAAA;AAAS,QAAA,GAAGC;AAAQ,KAAA;AAC3E;AAEA;;IAGO,SAASI,iBAAAA,CAAkBN,IAAoB,EAAEC,OAAe,EAAEC,OAAAA,GAA6B,EAAE,EAAA;IACpG,OAAO;AAAEF,QAAAA,IAAAA;AAAMG,QAAAA,QAAAA,EAAUC,+BAAmBG,OAAO;AAAEN,QAAAA,OAAAA;AAAS,QAAA,GAAGC;AAAQ,KAAA;AAC7E;AAEA;;IAGO,SAASM,SAAAA,CAAUC,WAA8B,EAAA;IACpD,OAAOA,WAAAA,CAAYC,IAAI,CAACC,CAAAA,aAAcA,UAAAA,CAAWR,QAAQ,KAAKC,8BAAAA,CAAmBC,KAAK,CAAA;AAC1F;;;;"}

package/dist/cjs/editing/documentPaths.js

@@ -0,0 +1,45 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Reads the value at a document path.
+ */ function getAtPath(root, path) {
+    let current = root;
+    for (const key of path){
+        if (current === null || typeof current !== 'object') return undefined;
+        current = current[key];
+    }
+    return current;
+}
+/**
+ * Reads the array at a path, creating it - and any objects on the way - when it is not there yet. Mutates `root`,
+ * which callers hold a copy of.
+ */ function ensureArrayAt(root, path) {
+    let current = root;
+    path.forEach((key, position)=>{
+        if (current[key] === undefined) current[key] = position === path.length - 1 ? [] : {};
+        current = current[key];
+    });
+    return current;
+}
+/**
+ * The paths a change to `path` must be made at: the path itself and, for a node inside a freeform element, the same
+ * place in every other size-class variant's copy.
+ */ function mirroredPaths(mirror, path) {
+    if (!mirror || mirror.prefix.some((key, position)=>path[position] !== key)) return [
+        path
+    ];
+    return [
+        path,
+        ...mirror.others.map((other)=>[
+                ...other,
+                ...path.slice(mirror.prefix.length)
+            ])
+    ];
+}
+
+exports.ensureArrayAt = ensureArrayAt;
+exports.getAtPath = getAtPath;
+exports.mirroredPaths = mirroredPaths;
+//# sourceMappingURL=documentPaths.js.map

package/dist/cjs/editing/documentPaths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentPaths.js","sources":["../../../editing/documentPaths.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 { DocumentPath } from './DocumentIndex';\n\n/**\n * Reads the value at a document path.\n */\nexport function getAtPath(root: unknown, path: DocumentPath): unknown {\n    let current = root;\n    for (const key of path) {\n        if (current === null || typeof current !== 'object') return undefined;\n        current = (current as Record<string | number, unknown>)[key];\n    }\n\n    return current;\n}\n\n/**\n * Reads the array at a path, creating it - and any objects on the way - when it is not there yet. Mutates `root`,\n * which callers hold a copy of.\n */\nexport function ensureArrayAt(root: unknown, path: DocumentPath): unknown[] {\n    let current = root as Record<string | number, unknown>;\n    path.forEach((key, position) => {\n        if (current[key] === undefined) current[key] = position === path.length - 1 ? [] : {};\n        current = current[key] as Record<string | number, unknown>;\n    });\n\n    return current as unknown as unknown[];\n}\n\n/**\n * The paths a change to `path` must be made at: the path itself and, for a node inside a freeform element, the same\n * place in every other size-class variant's copy.\n */\nexport function mirroredPaths(mirror: { prefix: DocumentPath; others: DocumentPath[] } | undefined, path: DocumentPath): DocumentPath[] {\n    if (!mirror || mirror.prefix.some((key, position) => path[position] !== key)) return [path];\n    return [path, ...mirror.others.map(other => [...other, ...path.slice(mirror.prefix.length)])];\n}\n"],"names":["getAtPath","root","path","current","key","undefined","ensureArrayAt","forEach","position","length","mirroredPaths","mirror","prefix","some","others","map","other","slice"],"mappings":";;AAAA;AACA;AAIA;;AAEC,IACM,SAASA,SAAAA,CAAUC,IAAa,EAAEC,IAAkB,EAAA;AACvD,IAAA,IAAIC,OAAAA,GAAUF,IAAAA;IACd,KAAK,MAAMG,OAAOF,IAAAA,CAAM;AACpB,QAAA,IAAIC,OAAAA,KAAY,IAAA,IAAQ,OAAOA,OAAAA,KAAY,UAAU,OAAOE,SAAAA;QAC5DF,OAAAA,GAAWA,OAA4C,CAACC,GAAAA,CAAI;AAChE,IAAA;IAEA,OAAOD,OAAAA;AACX;AAEA;;;AAGC,IACM,SAASG,aAAAA,CAAcL,IAAa,EAAEC,IAAkB,EAAA;AAC3D,IAAA,IAAIC,OAAAA,GAAUF,IAAAA;IACdC,IAAAA,CAAKK,OAAO,CAAC,CAACH,GAAAA,EAAKI,QAAAA,GAAAA;AACf,QAAA,IAAIL,OAAO,CAACC,GAAAA,CAAI,KAAKC,SAAAA,EAAWF,OAAO,CAACC,GAAAA,CAAI,GAAGI,QAAAA,KAAaN,KAAKO,MAAM,GAAG,CAAA,GAAI,EAAE,GAAG,EAAC;QACpFN,OAAAA,GAAUA,OAAO,CAACC,GAAAA,CAAI;AAC1B,IAAA,CAAA,CAAA;IAEA,OAAOD,OAAAA;AACX;AAEA;;;AAGC,IACM,SAASO,aAAAA,CAAcC,MAAoE,EAAET,IAAkB,EAAA;AAClH,IAAA,IAAI,CAACS,MAAAA,IAAUA,MAAAA,CAAOC,MAAM,CAACC,IAAI,CAAC,CAACT,GAAAA,EAAKI,WAAaN,IAAI,CAACM,QAAAA,CAAS,KAAKJ,MAAM,OAAO;AAACF,QAAAA;AAAK,KAAA;IAC3F,OAAO;AAACA,QAAAA,IAAAA;AAASS,QAAAA,GAAAA,MAAAA,CAAOG,MAAM,CAACC,GAAG,CAACC,CAAAA,KAAAA,GAAS;AAAIA,gBAAAA,GAAAA,KAAAA;AAAUd,gBAAAA,GAAAA,IAAAA,CAAKe,KAAK,CAACN,MAAAA,CAAOC,MAAM,CAACH,MAAM;AAAE,aAAA;AAAE,KAAA;AACjG;;;;"}

package/dist/cjs/editing/exposureEdits.js

@@ -0,0 +1,106 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var DescriptorCatalog = require('./DescriptorCatalog.js');
+var diagnostics = require('./diagnostics.js');
+var exposureGrants = require('./exposureGrants.js');
+var pathAccess = require('./pathAccess.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+function ownsDeclaration(session, owner, diagnostics$1) {
+    const level = session.chain.levels.at(-1);
+    if (!level || level.owner !== owner) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.NodeNotEditable, `Exposure is declared by the layout or template that owns the component. '${owner}' is not what is being edited.`));
+        return false;
+    }
+    return true;
+}
+function validateExposure(session, property, diagnostics$1) {
+    const context = {
+        component: property.component,
+        path: property.path
+    };
+    const level = session.chain.levels.at(-1);
+    const reExposed = property.reExposes !== undefined;
+    if (!reExposed && !level.elements.some((candidate)=>candidate.id === property.component)) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.ExposureTargetMissing, `'${level.owner}' has no component '${property.component}'.`, context));
+        return false;
+    }
+    const grant = reExposed ? session.scopeGrants.get(exposureGrants.grantKey(property.component, property.path)) : undefined;
+    if (reExposed && (!grant || grant.owner !== property.reExposes)) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.ReExposureBroken, `'${property.reExposes}' does not expose '${property.path}' on '${property.component}' to '${level.owner}', so it cannot be passed on.`, context));
+        return false;
+    }
+    const element = level.elements.find((candidate)=>candidate.id === property.component);
+    const descriptor = grant ? grant.descriptor : DescriptorCatalog.findComponentDescriptor(session.context.catalog, element.componentName)?.properties.find((candidate)=>candidate.path === property.path);
+    if (!descriptor) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.ExposureTargetMissing, `There is no editable property '${property.path}' on '${property.component}'.`, context));
+        return false;
+    }
+    const operations = property.operations ?? [];
+    if (descriptor.valueType !== scene_model.PropertyValueType.Collection) {
+        if (operations.length > 0 || property.editableFields !== undefined) {
+            diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.InvalidEdit, `'${descriptor.label}' is not a collection, so operations and editable fields do not apply.`, context));
+            return false;
+        }
+        return true;
+    }
+    const known = Object.values(scene_model.CollectionOperation);
+    const unknown = operations.find((operation)=>!known.includes(operation));
+    if (unknown !== undefined) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.InvalidEdit, `'${unknown}' is not a collection operation.`, context));
+        return false;
+    }
+    const fields = descriptor.item?.properties.map((candidate)=>candidate.path) ?? [];
+    const unknownField = property.editableFields?.find((field)=>!fields.includes(field));
+    if (unknownField !== undefined) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.UnknownCollectionField, `Items of '${descriptor.label}' have no field '${unknownField}'.`, context));
+        return false;
+    }
+    if (grant && (operations.some((operation)=>!grant.operations.includes(operation)) || grant.editableFields !== undefined && (property.editableFields ?? fields).some((field)=>!grant.editableFields.includes(field)))) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.ExposureWidensOwner, `'${property.reExposes}' exposed less of '${descriptor.label}' than this re-exposes.`, context));
+        return false;
+    }
+    return true;
+}
+/**
+ * Applies an exposure declaration to a copy of the document.
+ *
+ * Exposure only narrows: the property has to be one the component's descriptor supports, a collection's
+ * operations and fields have to exist, and a re-exposure cannot grant more than the owner it passes on.
+ */ function applyExposeProperty(session, edit, clone, diagnostics) {
+    if (!ownsDeclaration(session, edit.owner, diagnostics) || !validateExposure(session, edit.property, diagnostics)) return;
+    let declaration = clone.exposures.find((candidate)=>candidate.owner === edit.owner);
+    if (!declaration) {
+        declaration = {
+            owner: edit.owner,
+            properties: []
+        };
+        clone.exposures.push(declaration);
+    }
+    const same = (candidate)=>candidate.component === edit.property.component && candidate.path === edit.property.path && candidate.reExposes === edit.property.reExposes;
+    const position = declaration.properties.findIndex(same);
+    if (position >= 0) declaration.properties[position] = pathAccess.cloneData(edit.property);
+    else declaration.properties.push(pathAccess.cloneData(edit.property));
+}
+/**
+ * Applies an exposure withdrawal to a copy of the document. Values already saved against it are not touched.
+ */ function applyUnexposeProperty(session, edit, clone, diagnostics$1) {
+    if (!ownsDeclaration(session, edit.owner, diagnostics$1)) return;
+    const declaration = clone.exposures.find((candidate)=>candidate.owner === edit.owner);
+    const remaining = declaration?.properties.filter((candidate)=>!(candidate.component === edit.component && candidate.path === edit.path));
+    if (!declaration || remaining.length === declaration.properties.length) {
+        diagnostics$1.push(diagnostics.errorDiagnostic(scene_model.DiagnosticCode.ExposureTargetMissing, `'${edit.owner}' does not expose '${edit.path}' on '${edit.component}'.`, {
+            component: edit.component,
+            path: edit.path
+        }));
+        return;
+    }
+    if (remaining.length === 0) clone.exposures.splice(clone.exposures.indexOf(declaration), 1);
+    else declaration.properties = remaining;
+}
+
+exports.applyExposeProperty = applyExposeProperty;
+exports.applyUnexposeProperty = applyUnexposeProperty;
+//# sourceMappingURL=exposureEdits.js.map