@cratis/scene.engine 4.25.0 → 4.27.0

package/dist/cjs/navigation/effectiveNavigation.js

@@ -0,0 +1,133 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var ApplicationStructureIndex = require('../structure/ApplicationStructureIndex.js');
+var NavigationItemOrigin = require('./NavigationItemOrigin.js');
+var NavigationSourcesKind = require('./NavigationSourcesKind.js');
+var navigationRegions = require('./navigationRegions.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Resolves the items a navigation region effectively shows, for the application or for one module.
+ *
+ * - Application (no `module`): the application items, editable, `defined here`.
+ * - `inherit` (the default at a module): the application items, read-only; the module's own items are cleared.
+ * - `extend`: the application items, read-only, followed by the module's items.
+ * - `override`: the module's items only.
+ *
+ * Each item carries its `origin`, whether it is `readOnly`, a `reason`, and its target resolved against the
+ * structure: a module target goes to the module's first feature. Sub-items belong to the sidebar; a topbar is flat
+ * and its sub-items are ignored. This is the one function React renderers, Stage, Studio design mode and Studio
+ * preview call; nothing re-implements it.
+ *
+ * The C# engine (`EffectiveNavigation.Resolve`) returns the same result; both are asserted against
+ * `navigation-inheritance-fixtures.json` and `navigation-targets-fixtures.json`.
+ *
+ * @param structure The modules, features and slices of the application.
+ * @param navigation The application and module regions.
+ * @param module The module to resolve for; undefined for the application.
+ * @param region Which region to resolve.
+ */ function effectiveNavigation(structure, navigation, module, region) {
+    const index = structure instanceof ApplicationStructureIndex.ApplicationStructureIndex ? structure : new ApplicationStructureIndex.ApplicationStructureIndex(structure);
+    const applicationOwned = navigationRegions.applicationItems(navigation.application, region);
+    if (module === undefined) {
+        return {
+            region,
+            sources: {
+                kind: NavigationSourcesKind.NavigationSourcesKind.DefinedHere,
+                label: 'defined here'
+            },
+            items: applicationOwned.map((item)=>resolveItem(index, region, item, NavigationItemOrigin.NavigationItemOrigin.Application, false, 'Defined here.'))
+        };
+    }
+    const mode = navigationRegions.modeOfModuleRegion(navigation, module, region);
+    const moduleOwned = navigationRegions.findNavigationRegion(navigationRegions.findModuleNavigation(navigation, module)?.regions, region)?.items ?? [];
+    const name = index.findModule(module)?.name ?? module;
+    const inherited = ()=>applicationOwned.map((item)=>resolveItem(index, region, item, NavigationItemOrigin.NavigationItemOrigin.Application, true, 'Inherited from the application; edit it there.'));
+    const own = ()=>moduleOwned.map((item)=>resolveItem(index, region, item, NavigationItemOrigin.NavigationItemOrigin.Module, false, `Defined in ${name}.`));
+    switch(mode){
+        case scene_model.NavigationRegionMode.Extend:
+            return {
+                region,
+                module,
+                mode,
+                sources: sourcesOf(NavigationSourcesKind.NavigationSourcesKind.Extended, name),
+                items: [
+                    ...inherited(),
+                    ...own()
+                ]
+            };
+        case scene_model.NavigationRegionMode.Override:
+            return {
+                region,
+                module,
+                mode,
+                sources: sourcesOf(NavigationSourcesKind.NavigationSourcesKind.Overridden, name),
+                items: own()
+            };
+        default:
+            return {
+                region,
+                module,
+                mode: scene_model.NavigationRegionMode.Inherit,
+                sources: sourcesOf(NavigationSourcesKind.NavigationSourcesKind.Inherited, name),
+                items: inherited()
+            };
+    }
+}
+function sourcesOf(kind, moduleName) {
+    switch(kind){
+        case NavigationSourcesKind.NavigationSourcesKind.Extended:
+            return {
+                kind,
+                label: `Application + ${moduleName}`
+            };
+        case NavigationSourcesKind.NavigationSourcesKind.Overridden:
+            return {
+                kind,
+                label: `${moduleName} only`
+            };
+        default:
+            return {
+                kind: NavigationSourcesKind.NavigationSourcesKind.Inherited,
+                label: 'inherited'
+            };
+    }
+}
+function resolveItem(index, region, item, origin, readOnly, reason) {
+    const resolved = {
+        id: item.id,
+        title: item.title,
+        slot: item.slot ?? navigationRegions.primarySlot,
+        origin,
+        readOnly,
+        reason
+    };
+    if (item.icon !== undefined) resolved.icon = item.icon;
+    const target = resolveTarget(index, item);
+    if (target) resolved.target = target;
+    if (region === scene_model.NavigationRegionKind.Sidebar && item.children && item.children.length > 0) {
+        resolved.children = item.children.map((child)=>resolveItem(index, region, child, origin, readOnly, reason));
+    }
+    return resolved;
+}
+function resolveTarget(index, item) {
+    const module = item.target?.module;
+    if (!module) return undefined;
+    const target = {
+        module
+    };
+    const feature = item.target?.feature;
+    if (feature) {
+        target.feature = feature;
+        if (index.findFeature(`${module}.${feature}`)) target.resolvedFeature = `${module}.${feature}`;
+    } else {
+        const first = index.firstFeatureId(module);
+        if (first !== undefined) target.resolvedFeature = first;
+    }
+    return target;
+}
+
+exports.effectiveNavigation = effectiveNavigation;
+//# sourceMappingURL=effectiveNavigation.js.map

package/dist/cjs/navigation/effectiveNavigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"effectiveNavigation.js","sources":["../../../navigation/effectiveNavigation.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 { ApplicationStructure, NavigationModel, NavigationRegionKind, NavigationRegionMode, NavItem } from '@cratis/scene.model';\nimport { ApplicationStructureIndex } from '../structure';\nimport { EffectiveNavigationRegion } from './EffectiveNavigationRegion';\nimport { EffectiveNavItem } from './EffectiveNavItem';\nimport { NavigationItemOrigin } from './NavigationItemOrigin';\nimport { NavigationSources } from './NavigationSources';\nimport { NavigationSourcesKind } from './NavigationSourcesKind';\nimport { applicationItems, findModuleNavigation, findNavigationRegion, modeOfModuleRegion, primarySlot } from './navigationRegions';\nimport { ResolvedNavigationTarget } from './ResolvedNavigationTarget';\n\n/**\n * Resolves the items a navigation region effectively shows, for the application or for one module.\n *\n * - Application (no `module`): the application items, editable, `defined here`.\n * - `inherit` (the default at a module): the application items, read-only; the module's own items are cleared.\n * - `extend`: the application items, read-only, followed by the module's items.\n * - `override`: the module's items only.\n *\n * Each item carries its `origin`, whether it is `readOnly`, a `reason`, and its target resolved against the\n * structure: a module target goes to the module's first feature. Sub-items belong to the sidebar; a topbar is flat\n * and its sub-items are ignored. This is the one function React renderers, Stage, Studio design mode and Studio\n * preview call; nothing re-implements it.\n *\n * The C# engine (`EffectiveNavigation.Resolve`) returns the same result; both are asserted against\n * `navigation-inheritance-fixtures.json` and `navigation-targets-fixtures.json`.\n *\n * @param structure The modules, features and slices of the application.\n * @param navigation The application and module regions.\n * @param module The module to resolve for; undefined for the application.\n * @param region Which region to resolve.\n */\nexport function effectiveNavigation(\n    structure: ApplicationStructure | ApplicationStructureIndex,\n    navigation: NavigationModel,\n    module: string | undefined,\n    region: NavigationRegionKind,\n): EffectiveNavigationRegion {\n    const index = structure instanceof ApplicationStructureIndex ? structure : new ApplicationStructureIndex(structure);\n    const applicationOwned = applicationItems(navigation.application, region);\n\n    if (module === undefined) {\n        return {\n            region,\n            sources: { kind: NavigationSourcesKind.DefinedHere, label: 'defined here' },\n            items: applicationOwned.map(item => resolveItem(index, region, item, NavigationItemOrigin.Application, false, 'Defined here.')),\n        };\n    }\n\n    const mode = modeOfModuleRegion(navigation, module, region);\n    const moduleOwned = findNavigationRegion(findModuleNavigation(navigation, module)?.regions, region)?.items ?? [];\n    const name = index.findModule(module)?.name ?? module;\n    const inherited = (): EffectiveNavItem[] => applicationOwned.map(item => resolveItem(index, region, item, NavigationItemOrigin.Application, true, 'Inherited from the application; edit it there.'));\n    const own = (): EffectiveNavItem[] => moduleOwned.map(item => resolveItem(index, region, item, NavigationItemOrigin.Module, false, `Defined in ${name}.`));\n\n    switch (mode) {\n        case NavigationRegionMode.Extend:\n            return { region, module, mode, sources: sourcesOf(NavigationSourcesKind.Extended, name), items: [...inherited(), ...own()] };\n        case NavigationRegionMode.Override:\n            return { region, module, mode, sources: sourcesOf(NavigationSourcesKind.Overridden, name), items: own() };\n        default:\n            return { region, module, mode: NavigationRegionMode.Inherit, sources: sourcesOf(NavigationSourcesKind.Inherited, name), items: inherited() };\n    }\n}\n\nfunction sourcesOf(kind: NavigationSourcesKind, moduleName: string): NavigationSources {\n    switch (kind) {\n        case NavigationSourcesKind.Extended: return { kind, label: `Application + ${moduleName}` };\n        case NavigationSourcesKind.Overridden: return { kind, label: `${moduleName} only` };\n        default: return { kind: NavigationSourcesKind.Inherited, label: 'inherited' };\n    }\n}\n\nfunction resolveItem(index: ApplicationStructureIndex, region: NavigationRegionKind, item: NavItem, origin: NavigationItemOrigin, readOnly: boolean, reason: string): EffectiveNavItem {\n    const resolved: EffectiveNavItem = { id: item.id, title: item.title, slot: item.slot ?? primarySlot, origin, readOnly, reason };\n    if (item.icon !== undefined) resolved.icon = item.icon;\n\n    const target = resolveTarget(index, item);\n    if (target) resolved.target = target;\n\n    if (region === NavigationRegionKind.Sidebar && item.children && item.children.length > 0) {\n        resolved.children = item.children.map(child => resolveItem(index, region, child, origin, readOnly, reason));\n    }\n\n    return resolved;\n}\n\nfunction resolveTarget(index: ApplicationStructureIndex, item: NavItem): ResolvedNavigationTarget | undefined {\n    const module = item.target?.module;\n    if (!module) return undefined;\n\n    const target: ResolvedNavigationTarget = { module };\n    const feature = item.target?.feature;\n    if (feature) {\n        target.feature = feature;\n        if (index.findFeature(`${module}.${feature}`)) target.resolvedFeature = `${module}.${feature}`;\n    } else {\n        const first = index.firstFeatureId(module);\n        if (first !== undefined) target.resolvedFeature = first;\n    }\n\n    return target;\n}\n"],"names":["effectiveNavigation","structure","navigation","module","region","index","ApplicationStructureIndex","applicationOwned","applicationItems","application","undefined","sources","kind","NavigationSourcesKind","DefinedHere","label","items","map","item","resolveItem","NavigationItemOrigin","Application","mode","modeOfModuleRegion","moduleOwned","findNavigationRegion","findModuleNavigation","regions","name","findModule","inherited","own","Module","NavigationRegionMode","Extend","sourcesOf","Extended","Override","Overridden","Inherit","Inherited","moduleName","origin","readOnly","reason","resolved","id","title","slot","primarySlot","icon","target","resolveTarget","NavigationRegionKind","Sidebar","children","length","child","feature","findFeature","resolvedFeature","first","firstFeatureId"],"mappings":";;;;;;;;AAAA;AACA;AAYA;;;;;;;;;;;;;;;;;;;;IAqBO,SAASA,mBAAAA,CACZC,SAA2D,EAC3DC,UAA2B,EAC3BC,MAA0B,EAC1BC,MAA4B,EAAA;AAE5B,IAAA,MAAMC,KAAAA,GAAQJ,SAAAA,YAAqBK,mDAAAA,GAA4BL,SAAAA,GAAY,IAAIK,mDAAAA,CAA0BL,SAAAA,CAAAA;AACzG,IAAA,MAAMM,gBAAAA,GAAmBC,kCAAAA,CAAiBN,UAAAA,CAAWO,WAAW,EAAEL,MAAAA,CAAAA;AAElE,IAAA,IAAID,WAAWO,SAAAA,EAAW;QACtB,OAAO;AACHN,YAAAA,MAAAA;YACAO,OAAAA,EAAS;AAAEC,gBAAAA,IAAAA,EAAMC,4CAAsBC,WAAW;gBAAEC,KAAAA,EAAO;AAAe,aAAA;AAC1EC,YAAAA,KAAAA,EAAOT,gBAAAA,CAAiBU,GAAG,CAACC,CAAAA,IAAAA,GAAQC,WAAAA,CAAYd,KAAAA,EAAOD,MAAAA,EAAQc,IAAAA,EAAME,yCAAAA,CAAqBC,WAAW,EAAE,KAAA,EAAO,eAAA,CAAA;AAClH,SAAA;AACJ,IAAA;IAEA,MAAMC,IAAAA,GAAOC,oCAAAA,CAAmBrB,UAAAA,EAAYC,MAAAA,EAAQC,MAAAA,CAAAA;IACpD,MAAMoB,WAAAA,GAAcC,uCAAqBC,sCAAAA,CAAqBxB,UAAAA,EAAYC,SAASwB,OAAAA,EAASvB,MAAAA,CAAAA,EAASY,SAAS,EAAE;AAChH,IAAA,MAAMY,IAAAA,GAAOvB,KAAAA,CAAMwB,UAAU,CAAC1B,SAASyB,IAAAA,IAAQzB,MAAAA;AAC/C,IAAA,MAAM2B,SAAAA,GAAY,IAA0BvB,gBAAAA,CAAiBU,GAAG,CAACC,CAAAA,IAAAA,GAAQC,WAAAA,CAAYd,KAAAA,EAAOD,MAAAA,EAAQc,IAAAA,EAAME,yCAAAA,CAAqBC,WAAW,EAAE,IAAA,EAAM,gDAAA,CAAA,CAAA;IAClJ,MAAMU,GAAAA,GAAM,IAA0BP,WAAAA,CAAYP,GAAG,CAACC,CAAAA,IAAAA,GAAQC,YAAYd,KAAAA,EAAOD,MAAAA,EAAQc,MAAME,yCAAAA,CAAqBY,MAAM,EAAE,KAAA,EAAO,CAAC,WAAW,EAAEJ,IAAAA,CAAK,CAAC,CAAC,CAAA,CAAA;IAExJ,OAAQN,IAAAA;AACJ,QAAA,KAAKW,iCAAqBC,MAAM;YAC5B,OAAO;AAAE9B,gBAAAA,MAAAA;AAAQD,gBAAAA,MAAAA;AAAQmB,gBAAAA,IAAAA;gBAAMX,OAAAA,EAASwB,SAAAA,CAAUtB,2CAAAA,CAAsBuB,QAAQ,EAAER,IAAAA,CAAAA;gBAAOZ,KAAAA,EAAO;AAAIc,oBAAAA,GAAAA,SAAAA,EAAAA;AAAgBC,oBAAAA,GAAAA,GAAAA;AAAM;AAAC,aAAA;AAC/H,QAAA,KAAKE,iCAAqBI,QAAQ;YAC9B,OAAO;AAAEjC,gBAAAA,MAAAA;AAAQD,gBAAAA,MAAAA;AAAQmB,gBAAAA,IAAAA;gBAAMX,OAAAA,EAASwB,SAAAA,CAAUtB,2CAAAA,CAAsByB,UAAU,EAAEV,IAAAA,CAAAA;gBAAOZ,KAAAA,EAAOe,GAAAA;AAAM,aAAA;AAC5G,QAAA;YACI,OAAO;AAAE3B,gBAAAA,MAAAA;AAAQD,gBAAAA,MAAAA;AAAQmB,gBAAAA,IAAAA,EAAMW,iCAAqBM,OAAO;gBAAE5B,OAAAA,EAASwB,SAAAA,CAAUtB,2CAAAA,CAAsB2B,SAAS,EAAEZ,IAAAA,CAAAA;gBAAOZ,KAAAA,EAAOc,SAAAA;AAAY,aAAA;AACnJ;AACJ;AAEA,SAASK,SAAAA,CAAUvB,IAA2B,EAAE6B,UAAkB,EAAA;IAC9D,OAAQ7B,IAAAA;AACJ,QAAA,KAAKC,4CAAsBuB,QAAQ;YAAE,OAAO;AAAExB,gBAAAA,IAAAA;gBAAMG,KAAAA,EAAO,CAAC,cAAc,EAAE0B,UAAAA,CAAAA;AAAa,aAAA;AACzF,QAAA,KAAK5B,4CAAsByB,UAAU;YAAE,OAAO;AAAE1B,gBAAAA,IAAAA;gBAAMG,KAAAA,EAAO,CAAA,EAAG0B,UAAAA,CAAW,KAAK;AAAE,aAAA;AAClF,QAAA;YAAS,OAAO;AAAE7B,gBAAAA,IAAAA,EAAMC,4CAAsB2B,SAAS;gBAAEzB,KAAAA,EAAO;AAAY,aAAA;AAChF;AACJ;AAEA,SAASI,WAAAA,CAAYd,KAAgC,EAAED,MAA4B,EAAEc,IAAa,EAAEwB,MAA4B,EAAEC,QAAiB,EAAEC,MAAc,EAAA;AAC/J,IAAA,MAAMC,QAAAA,GAA6B;AAAEC,QAAAA,EAAAA,EAAI5B,KAAK4B,EAAE;AAAEC,QAAAA,KAAAA,EAAO7B,KAAK6B,KAAK;QAAEC,IAAAA,EAAM9B,IAAAA,CAAK8B,IAAI,IAAIC,6BAAAA;AAAaP,QAAAA,MAAAA;AAAQC,QAAAA,QAAAA;AAAUC,QAAAA;AAAO,KAAA;IAC9H,IAAI1B,IAAAA,CAAKgC,IAAI,KAAKxC,SAAAA,EAAWmC,SAASK,IAAI,GAAGhC,KAAKgC,IAAI;IAEtD,MAAMC,MAAAA,GAASC,cAAc/C,KAAAA,EAAOa,IAAAA,CAAAA;IACpC,IAAIiC,MAAAA,EAAQN,QAAAA,CAASM,MAAM,GAAGA,MAAAA;AAE9B,IAAA,IAAI/C,MAAAA,KAAWiD,gCAAAA,CAAqBC,OAAO,IAAIpC,IAAAA,CAAKqC,QAAQ,IAAIrC,IAAAA,CAAKqC,QAAQ,CAACC,MAAM,GAAG,CAAA,EAAG;AACtFX,QAAAA,QAAAA,CAASU,QAAQ,GAAGrC,IAAAA,CAAKqC,QAAQ,CAACtC,GAAG,CAACwC,CAAAA,KAAAA,GAAStC,WAAAA,CAAYd,KAAAA,EAAOD,MAAAA,EAAQqD,KAAAA,EAAOf,QAAQC,QAAAA,EAAUC,MAAAA,CAAAA,CAAAA;AACvG,IAAA;IAEA,OAAOC,QAAAA;AACX;AAEA,SAASO,aAAAA,CAAc/C,KAAgC,EAAEa,IAAa,EAAA;IAClE,MAAMf,MAAAA,GAASe,IAAAA,CAAKiC,MAAM,EAAEhD,MAAAA;IAC5B,IAAI,CAACA,QAAQ,OAAOO,SAAAA;AAEpB,IAAA,MAAMyC,MAAAA,GAAmC;AAAEhD,QAAAA;AAAO,KAAA;IAClD,MAAMuD,OAAAA,GAAUxC,IAAAA,CAAKiC,MAAM,EAAEO,OAAAA;AAC7B,IAAA,IAAIA,OAAAA,EAAS;AACTP,QAAAA,MAAAA,CAAOO,OAAO,GAAGA,OAAAA;AACjB,QAAA,IAAIrD,MAAMsD,WAAW,CAAC,CAAA,EAAGxD,MAAAA,CAAO,CAAC,EAAEuD,OAAAA,CAAAA,CAAS,CAAA,EAAGP,MAAAA,CAAOS,eAAe,GAAG,CAAA,EAAGzD,MAAAA,CAAO,CAAC,EAAEuD,OAAAA,CAAAA,CAAS;IAClG,CAAA,MAAO;QACH,MAAMG,KAAAA,GAAQxD,KAAAA,CAAMyD,cAAc,CAAC3D,MAAAA,CAAAA;AACnC,QAAA,IAAI0D,KAAAA,KAAUnD,SAAAA,EAAWyC,MAAAA,CAAOS,eAAe,GAAGC,KAAAA;AACtD,IAAA;IAEA,OAAOV,MAAAA;AACX;;"}

package/dist/cjs/navigation/navigationEdits.js

@@ -0,0 +1,230 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var NavigationEditKind = require('./NavigationEditKind.js');
+var navigationRegions = require('./navigationRegions.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const noMode = 'The application is the base of the navigation and has no region mode.';
+const logoLevel = 'The logo is defined at the application level only.';
+const flatTopbar = 'A topbar is flat; only a sidebar item has sub-items.';
+/**
+ * Plans a change of a module region's mode. Switching to `inherit` clears the module's items (NAV3); switching from
+ * `inherit` to `override` with `copy` first copies the application's items so the module starts from them (NAV5).
+ * @param navigation The navigation as it is.
+ * @param module The module whose region changes; the application has no mode and is refused.
+ * @param region The region.
+ * @param mode The mode to switch to.
+ * @param options `copy` copies the application items when switching from inherit to override.
+ */ function switchRegionMode(navigation, module, region, mode, options = {}) {
+    if (module === undefined) return {
+        edits: [],
+        rejected: noMode
+    };
+    const current = navigationRegions.modeOfModuleRegion(navigation, module, region);
+    if (current === mode) return {
+        edits: []
+    };
+    const setMode = {
+        kind: NavigationEditKind.NavigationEditKind.SetRegionMode,
+        module,
+        region,
+        mode
+    };
+    if (mode === scene_model.NavigationRegionMode.Inherit) {
+        return {
+            edits: [
+                {
+                    kind: NavigationEditKind.NavigationEditKind.SetRegionItems,
+                    module,
+                    region,
+                    items: []
+                },
+                setMode
+            ]
+        };
+    }
+    if (mode === scene_model.NavigationRegionMode.Override && current === scene_model.NavigationRegionMode.Inherit && options.copy === true) {
+        return {
+            edits: [
+                {
+                    kind: NavigationEditKind.NavigationEditKind.SetRegionItems,
+                    module,
+                    region,
+                    items: structuredClone(navigationRegions.applicationItems(navigation.application, region))
+                },
+                setMode
+            ]
+        };
+    }
+    return {
+        edits: [
+            setMode
+        ]
+    };
+}
+/**
+ * Plans adding an item to a region, after the ones already there. Adding to an inheriting module region first
+ * switches it to `extend` (NAV6), so the application's items stay and the new item follows them.
+ * @param navigation The navigation as it is.
+ * @param module The module that gets the item; undefined for the application.
+ * @param region The region.
+ * @param item The item to add.
+ * @param parent The id of the item it becomes a sub-item of; sidebar only.
+ */ function addNavItem(navigation, module, region, item, parent) {
+    if (parent !== undefined && region !== scene_model.NavigationRegionKind.Sidebar) return {
+        edits: [],
+        rejected: flatTopbar
+    };
+    const own = ownItems(navigation, module, region);
+    const ids = navigationRegions.collectItemIds(own, region);
+    if (ids.includes(item.id)) return {
+        edits: [],
+        rejected: `Navigation item id '${item.id}' is already used in this region.`
+    };
+    if (parent !== undefined && !ids.includes(parent)) return {
+        edits: [],
+        rejected: `There is no item '${parent}' to add a sub-item to.`
+    };
+    const add = {
+        kind: NavigationEditKind.NavigationEditKind.AddItem,
+        module,
+        region,
+        item: structuredClone(item)
+    };
+    if (parent !== undefined) add.parent = parent;
+    if (module !== undefined && navigationRegions.modeOfModuleRegion(navigation, module, region) === scene_model.NavigationRegionMode.Inherit) {
+        return {
+            edits: [
+                {
+                    kind: NavigationEditKind.NavigationEditKind.SetRegionMode,
+                    module,
+                    region,
+                    mode: scene_model.NavigationRegionMode.Extend
+                },
+                add
+            ]
+        };
+    }
+    return {
+        edits: [
+            add
+        ]
+    };
+}
+/**
+ * Plans setting the logo. The logo is defined at the application level only, so a module is refused.
+ * @param navigation The navigation as it is.
+ * @param module The module asking; only undefined (the application) is allowed.
+ * @param logo The logo.
+ */ function setApplicationLogo(navigation, module, logo) {
+    return module === undefined ? {
+        edits: [
+            {
+                kind: NavigationEditKind.NavigationEditKind.SetLogo,
+                logo: {
+                    ...logo
+                }
+            }
+        ]
+    } : {
+        edits: [],
+        rejected: logoLevel
+    };
+}
+/**
+ * Applies navigation edits to a copy of the model. Either every edit applies, or none does.
+ * @param navigation The navigation as it is; never changed.
+ * @param edits The edits, in order.
+ */ function applyNavigationEdits(navigation, edits) {
+    const model = structuredClone(navigation);
+    for (const edit of edits){
+        const rejected = apply(model, edit);
+        if (rejected !== undefined) return {
+            applied: false,
+            model: navigation,
+            rejected
+        };
+    }
+    return {
+        applied: true,
+        model
+    };
+}
+function ownItems(navigation, module, region) {
+    return module === undefined ? navigationRegions.applicationItems(navigation.application, region) : navigationRegions.findNavigationRegion(navigationRegions.findModuleNavigation(navigation, module)?.regions, region)?.items ?? [];
+}
+function regionOf(model, module, region) {
+    let regions;
+    if (module === undefined) {
+        regions = model.application.regions;
+    } else {
+        let block = navigationRegions.findModuleNavigation(model, module);
+        if (!block) {
+            block = {
+                module,
+                regions: []
+            };
+            model.modules.push(block);
+        }
+        regions = block.regions;
+    }
+    let found = navigationRegions.findNavigationRegion(regions, region);
+    if (!found) {
+        found = {
+            region,
+            items: []
+        };
+        regions.push(found);
+    }
+    return found;
+}
+function apply(model, edit) {
+    switch(edit.kind){
+        case NavigationEditKind.NavigationEditKind.SetRegionMode:
+            if (edit.module === undefined) return noMode;
+            regionOf(model, edit.module, edit.region).mode = edit.mode;
+            return undefined;
+        case NavigationEditKind.NavigationEditKind.SetRegionItems:
+            regionOf(model, edit.module, edit.region).items = structuredClone(edit.items ?? []);
+            return undefined;
+        case NavigationEditKind.NavigationEditKind.AddItem:
+            {
+                const target = regionOf(model, edit.module, edit.region);
+                const item = structuredClone(edit.item);
+                if (navigationRegions.collectItemIds(target.items, target.region).includes(item.id)) return `Navigation item id '${item.id}' is already used in this region.`;
+                if (edit.parent === undefined) {
+                    target.items.push(item);
+                    return undefined;
+                }
+                if (target.region !== scene_model.NavigationRegionKind.Sidebar) return flatTopbar;
+                const owner = findItem(target.items, edit.parent);
+                if (!owner) return `There is no item '${edit.parent}' to add a sub-item to.`;
+                (owner.children ??= []).push(item);
+                return undefined;
+            }
+        case NavigationEditKind.NavigationEditKind.SetLogo:
+            if (edit.module !== undefined) return logoLevel;
+            model.application.logo = {
+                ...edit.logo
+            };
+            return undefined;
+        default:
+            return `'${String(edit.kind)}' is not a navigation edit.`;
+    }
+}
+function findItem(items, id) {
+    for (const item of items){
+        if (item.id === id) return item;
+        const nested = findItem(item.children ?? [], id);
+        if (nested) return nested;
+    }
+    return undefined;
+}
+
+exports.addNavItem = addNavItem;
+exports.applyNavigationEdits = applyNavigationEdits;
+exports.setApplicationLogo = setApplicationLogo;
+exports.switchRegionMode = switchRegionMode;
+//# sourceMappingURL=navigationEdits.js.map

package/dist/cjs/navigation/navigationEdits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationEdits.js","sources":["../../../navigation/navigationEdits.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 { ApplicationLogo, NavigationModel, NavigationRegion, NavigationRegionKind, NavigationRegionMode, NavItem } from '@cratis/scene.model';\nimport { NavigationEdit } from './NavigationEdit';\nimport { NavigationEditKind } from './NavigationEditKind';\nimport { NavigationEditOutcome } from './NavigationEditOutcome';\nimport { NavigationEditPlan } from './NavigationEditPlan';\nimport { applicationItems, collectItemIds, findModuleNavigation, findNavigationRegion, modeOfModuleRegion } from './navigationRegions';\n\nconst noMode = 'The application is the base of the navigation and has no region mode.';\nconst logoLevel = 'The logo is defined at the application level only.';\nconst flatTopbar = 'A topbar is flat; only a sidebar item has sub-items.';\n\n/**\n * Plans a change of a module region's mode. Switching to `inherit` clears the module's items (NAV3); switching from\n * `inherit` to `override` with `copy` first copies the application's items so the module starts from them (NAV5).\n * @param navigation The navigation as it is.\n * @param module The module whose region changes; the application has no mode and is refused.\n * @param region The region.\n * @param mode The mode to switch to.\n * @param options `copy` copies the application items when switching from inherit to override.\n */\nexport function switchRegionMode(\n    navigation: NavigationModel,\n    module: string | undefined,\n    region: NavigationRegionKind,\n    mode: NavigationRegionMode,\n    options: { copy?: boolean } = {},\n): NavigationEditPlan {\n    if (module === undefined) return { edits: [], rejected: noMode };\n\n    const current = modeOfModuleRegion(navigation, module, region);\n    if (current === mode) return { edits: [] };\n\n    const setMode: NavigationEdit = { kind: NavigationEditKind.SetRegionMode, module, region, mode };\n    if (mode === NavigationRegionMode.Inherit) {\n        return { edits: [{ kind: NavigationEditKind.SetRegionItems, module, region, items: [] }, setMode] };\n    }\n\n    if (mode === NavigationRegionMode.Override && current === NavigationRegionMode.Inherit && options.copy === true) {\n        return { edits: [{ kind: NavigationEditKind.SetRegionItems, module, region, items: structuredClone(applicationItems(navigation.application, region)) }, setMode] };\n    }\n\n    return { edits: [setMode] };\n}\n\n/**\n * Plans adding an item to a region, after the ones already there. Adding to an inheriting module region first\n * switches it to `extend` (NAV6), so the application's items stay and the new item follows them.\n * @param navigation The navigation as it is.\n * @param module The module that gets the item; undefined for the application.\n * @param region The region.\n * @param item The item to add.\n * @param parent The id of the item it becomes a sub-item of; sidebar only.\n */\nexport function addNavItem(\n    navigation: NavigationModel,\n    module: string | undefined,\n    region: NavigationRegionKind,\n    item: NavItem,\n    parent?: string,\n): NavigationEditPlan {\n    if (parent !== undefined && region !== NavigationRegionKind.Sidebar) return { edits: [], rejected: flatTopbar };\n\n    const own = ownItems(navigation, module, region);\n    const ids = collectItemIds(own, region);\n    if (ids.includes(item.id)) return { edits: [], rejected: `Navigation item id '${item.id}' is already used in this region.` };\n    if (parent !== undefined && !ids.includes(parent)) return { edits: [], rejected: `There is no item '${parent}' to add a sub-item to.` };\n\n    const add: NavigationEdit = { kind: NavigationEditKind.AddItem, module, region, item: structuredClone(item) };\n    if (parent !== undefined) add.parent = parent;\n    if (module !== undefined && modeOfModuleRegion(navigation, module, region) === NavigationRegionMode.Inherit) {\n        return { edits: [{ kind: NavigationEditKind.SetRegionMode, module, region, mode: NavigationRegionMode.Extend }, add] };\n    }\n\n    return { edits: [add] };\n}\n\n/**\n * Plans setting the logo. The logo is defined at the application level only, so a module is refused.\n * @param navigation The navigation as it is.\n * @param module The module asking; only undefined (the application) is allowed.\n * @param logo The logo.\n */\nexport function setApplicationLogo(navigation: NavigationModel, module: string | undefined, logo: ApplicationLogo): NavigationEditPlan {\n    void navigation;\n    return module === undefined ? { edits: [{ kind: NavigationEditKind.SetLogo, logo: { ...logo } }] } : { edits: [], rejected: logoLevel };\n}\n\n/**\n * Applies navigation edits to a copy of the model. Either every edit applies, or none does.\n * @param navigation The navigation as it is; never changed.\n * @param edits The edits, in order.\n */\nexport function applyNavigationEdits(navigation: NavigationModel, edits: NavigationEdit[]): NavigationEditOutcome {\n    const model = structuredClone(navigation);\n    for (const edit of edits) {\n        const rejected = apply(model, edit);\n        if (rejected !== undefined) return { applied: false, model: navigation, rejected };\n    }\n\n    return { applied: true, model };\n}\n\nfunction ownItems(navigation: NavigationModel, module: string | undefined, region: NavigationRegionKind): NavItem[] {\n    return module === undefined\n        ? applicationItems(navigation.application, region)\n        : findNavigationRegion(findModuleNavigation(navigation, module)?.regions, region)?.items ?? [];\n}\n\nfunction regionOf(model: NavigationModel, module: string | undefined, region: NavigationRegionKind): NavigationRegion {\n    let regions: NavigationRegion[];\n    if (module === undefined) {\n        regions = model.application.regions;\n    } else {\n        let block = findModuleNavigation(model, module);\n        if (!block) {\n            block = { module, regions: [] };\n            model.modules.push(block);\n        }\n\n        regions = block.regions;\n    }\n\n    let found = findNavigationRegion(regions, region);\n    if (!found) {\n        found = { region, items: [] };\n        regions.push(found);\n    }\n\n    return found;\n}\n\nfunction apply(model: NavigationModel, edit: NavigationEdit): string | undefined {\n    switch (edit.kind) {\n        case NavigationEditKind.SetRegionMode:\n            if (edit.module === undefined) return noMode;\n            regionOf(model, edit.module, edit.region!).mode = edit.mode;\n            return undefined;\n        case NavigationEditKind.SetRegionItems:\n            regionOf(model, edit.module, edit.region!).items = structuredClone(edit.items ?? []);\n            return undefined;\n        case NavigationEditKind.AddItem: {\n            const target = regionOf(model, edit.module, edit.region!);\n            const item = structuredClone(edit.item!);\n            if (collectItemIds(target.items, target.region).includes(item.id)) return `Navigation item id '${item.id}' is already used in this region.`;\n            if (edit.parent === undefined) {\n                target.items.push(item);\n                return undefined;\n            }\n\n            if (target.region !== NavigationRegionKind.Sidebar) return flatTopbar;\n            const owner = findItem(target.items, edit.parent);\n            if (!owner) return `There is no item '${edit.parent}' to add a sub-item to.`;\n            (owner.children ??= []).push(item);\n            return undefined;\n        }\n        case NavigationEditKind.SetLogo:\n            if (edit.module !== undefined) return logoLevel;\n            model.application.logo = { ...edit.logo! };\n            return undefined;\n        default:\n            return `'${String((edit as NavigationEdit).kind)}' is not a navigation edit.`;\n    }\n}\n\nfunction findItem(items: NavItem[], id: string): NavItem | undefined {\n    for (const item of items) {\n        if (item.id === id) return item;\n        const nested = findItem(item.children ?? [], id);\n        if (nested) return nested;\n    }\n\n    return undefined;\n}\n"],"names":["noMode","logoLevel","flatTopbar","switchRegionMode","navigation","module","region","mode","options","undefined","edits","rejected","current","modeOfModuleRegion","setMode","kind","NavigationEditKind","SetRegionMode","NavigationRegionMode","Inherit","SetRegionItems","items","Override","copy","structuredClone","applicationItems","application","addNavItem","item","parent","NavigationRegionKind","Sidebar","own","ownItems","ids","collectItemIds","includes","id","add","AddItem","Extend","setApplicationLogo","logo","SetLogo","applyNavigationEdits","model","edit","apply","applied","findNavigationRegion","findModuleNavigation","regions","regionOf","block","modules","push","found","target","owner","findItem","children","String","nested"],"mappings":";;;;;;AAAA;AACA;AASA,MAAMA,MAAAA,GAAS,uEAAA;AACf,MAAMC,SAAAA,GAAY,oDAAA;AAClB,MAAMC,UAAAA,GAAa,sDAAA;AAEnB;;;;;;;;AAQC,IACM,SAASC,gBAAAA,CACZC,UAA2B,EAC3BC,MAA0B,EAC1BC,MAA4B,EAC5BC,IAA0B,EAC1BC,OAAAA,GAA8B,EAAE,EAAA;IAEhC,IAAIH,MAAAA,KAAWI,WAAW,OAAO;AAAEC,QAAAA,KAAAA,EAAO,EAAE;QAAEC,QAAAA,EAAUX;AAAO,KAAA;IAE/D,MAAMY,OAAAA,GAAUC,oCAAAA,CAAmBT,UAAAA,EAAYC,MAAAA,EAAQC,MAAAA,CAAAA;IACvD,IAAIM,OAAAA,KAAYL,MAAM,OAAO;AAAEG,QAAAA,KAAAA,EAAO;AAAG,KAAA;AAEzC,IAAA,MAAMI,OAAAA,GAA0B;AAAEC,QAAAA,IAAAA,EAAMC,sCAAmBC,aAAa;AAAEZ,QAAAA,MAAAA;AAAQC,QAAAA,MAAAA;AAAQC,QAAAA;AAAK,KAAA;IAC/F,IAAIA,IAAAA,KAASW,gCAAAA,CAAqBC,OAAO,EAAE;QACvC,OAAO;YAAET,KAAAA,EAAO;AAAC,gBAAA;AAAEK,oBAAAA,IAAAA,EAAMC,sCAAmBI,cAAc;AAAEf,oBAAAA,MAAAA;AAAQC,oBAAAA,MAAAA;AAAQe,oBAAAA,KAAAA,EAAO;AAAG,iBAAA;AAAGP,gBAAAA;AAAQ;AAAC,SAAA;AACtG,IAAA;IAEA,IAAIP,IAAAA,KAASW,gCAAAA,CAAqBI,QAAQ,IAAIV,OAAAA,KAAYM,gCAAAA,CAAqBC,OAAO,IAAIX,OAAAA,CAAQe,IAAI,KAAK,IAAA,EAAM;QAC7G,OAAO;YAAEb,KAAAA,EAAO;AAAC,gBAAA;AAAEK,oBAAAA,IAAAA,EAAMC,sCAAmBI,cAAc;AAAEf,oBAAAA,MAAAA;AAAQC,oBAAAA,MAAAA;AAAQe,oBAAAA,KAAAA,EAAOG,eAAAA,CAAgBC,kCAAAA,CAAiBrB,UAAAA,CAAWsB,WAAW,EAAEpB,MAAAA,CAAAA;AAAS,iBAAA;AAAGQ,gBAAAA;AAAQ;AAAC,SAAA;AACrK,IAAA;IAEA,OAAO;QAAEJ,KAAAA,EAAO;AAACI,YAAAA;AAAQ;AAAC,KAAA;AAC9B;AAEA;;;;;;;;IASO,SAASa,UAAAA,CACZvB,UAA2B,EAC3BC,MAA0B,EAC1BC,MAA4B,EAC5BsB,IAAa,EACbC,MAAe,EAAA;AAEf,IAAA,IAAIA,WAAWpB,SAAAA,IAAaH,MAAAA,KAAWwB,gCAAAA,CAAqBC,OAAO,EAAE,OAAO;AAAErB,QAAAA,KAAAA,EAAO,EAAE;QAAEC,QAAAA,EAAUT;AAAW,KAAA;IAE9G,MAAM8B,GAAAA,GAAMC,QAAAA,CAAS7B,UAAAA,EAAYC,MAAAA,EAAQC,MAAAA,CAAAA;IACzC,MAAM4B,GAAAA,GAAMC,iCAAeH,GAAAA,EAAK1B,MAAAA,CAAAA;AAChC,IAAA,IAAI4B,IAAIE,QAAQ,CAACR,IAAAA,CAAKS,EAAE,GAAG,OAAO;AAAE3B,QAAAA,KAAAA,EAAO,EAAE;AAAEC,QAAAA,QAAAA,EAAU,CAAC,oBAAoB,EAAEiB,KAAKS,EAAE,CAAC,iCAAiC;AAAE,KAAA;AAC3H,IAAA,IAAIR,WAAWpB,SAAAA,IAAa,CAACyB,IAAIE,QAAQ,CAACP,SAAS,OAAO;AAAEnB,QAAAA,KAAAA,EAAO,EAAE;AAAEC,QAAAA,QAAAA,EAAU,CAAC,kBAAkB,EAAEkB,MAAAA,CAAO,uBAAuB;AAAE,KAAA;AAEtI,IAAA,MAAMS,GAAAA,GAAsB;AAAEvB,QAAAA,IAAAA,EAAMC,sCAAmBuB,OAAO;AAAElC,QAAAA,MAAAA;AAAQC,QAAAA,MAAAA;AAAQsB,QAAAA,IAAAA,EAAMJ,eAAAA,CAAgBI,IAAAA;AAAM,KAAA;AAC5G,IAAA,IAAIC,MAAAA,KAAWpB,SAAAA,EAAW6B,GAAAA,CAAIT,MAAM,GAAGA,MAAAA;IACvC,IAAIxB,MAAAA,KAAWI,aAAaI,oCAAAA,CAAmBT,UAAAA,EAAYC,QAAQC,MAAAA,CAAAA,KAAYY,gCAAAA,CAAqBC,OAAO,EAAE;QACzG,OAAO;YAAET,KAAAA,EAAO;AAAC,gBAAA;AAAEK,oBAAAA,IAAAA,EAAMC,sCAAmBC,aAAa;AAAEZ,oBAAAA,MAAAA;AAAQC,oBAAAA,MAAAA;AAAQC,oBAAAA,IAAAA,EAAMW,iCAAqBsB;AAAO,iBAAA;AAAGF,gBAAAA;AAAI;AAAC,SAAA;AACzH,IAAA;IAEA,OAAO;QAAE5B,KAAAA,EAAO;AAAC4B,YAAAA;AAAI;AAAC,KAAA;AAC1B;AAEA;;;;;AAKC,IACM,SAASG,kBAAAA,CAAmBrC,UAA2B,EAAEC,MAA0B,EAAEqC,IAAqB,EAAA;AAE7G,IAAA,OAAOrC,WAAWI,SAAAA,GAAY;QAAEC,KAAAA,EAAO;AAAC,YAAA;AAAEK,gBAAAA,IAAAA,EAAMC,sCAAmB2B,OAAO;gBAAED,IAAAA,EAAM;AAAE,oBAAA,GAAGA;AAAK;AAAE;AAAE;KAAC,GAAI;AAAEhC,QAAAA,KAAAA,EAAO,EAAE;QAAEC,QAAAA,EAAUV;AAAU,KAAA;AAC1I;AAEA;;;;AAIC,IACM,SAAS2C,oBAAAA,CAAqBxC,UAA2B,EAAEM,KAAuB,EAAA;AACrF,IAAA,MAAMmC,QAAQrB,eAAAA,CAAgBpB,UAAAA,CAAAA;IAC9B,KAAK,MAAM0C,QAAQpC,KAAAA,CAAO;QACtB,MAAMC,QAAAA,GAAWoC,MAAMF,KAAAA,EAAOC,IAAAA,CAAAA;QAC9B,IAAInC,QAAAA,KAAaF,WAAW,OAAO;YAAEuC,OAAAA,EAAS,KAAA;YAAOH,KAAAA,EAAOzC,UAAAA;AAAYO,YAAAA;AAAS,SAAA;AACrF,IAAA;IAEA,OAAO;QAAEqC,OAAAA,EAAS,IAAA;AAAMH,QAAAA;AAAM,KAAA;AAClC;AAEA,SAASZ,QAAAA,CAAS7B,UAA2B,EAAEC,MAA0B,EAAEC,MAA4B,EAAA;AACnG,IAAA,OAAOD,MAAAA,KAAWI,SAAAA,GACZgB,kCAAAA,CAAiBrB,UAAAA,CAAWsB,WAAW,EAAEpB,MAAAA,CAAAA,GACzC2C,sCAAAA,CAAqBC,sCAAAA,CAAqB9C,UAAAA,EAAYC,MAAAA,CAAAA,EAAS8C,OAAAA,EAAS7C,MAAAA,CAAAA,EAASe,SAAS,EAAE;AACtG;AAEA,SAAS+B,QAAAA,CAASP,KAAsB,EAAExC,MAA0B,EAAEC,MAA4B,EAAA;IAC9F,IAAI6C,OAAAA;AACJ,IAAA,IAAI9C,WAAWI,SAAAA,EAAW;QACtB0C,OAAAA,GAAUN,KAAAA,CAAMnB,WAAW,CAACyB,OAAO;IACvC,CAAA,MAAO;QACH,IAAIE,KAAAA,GAAQH,uCAAqBL,KAAAA,EAAOxC,MAAAA,CAAAA;AACxC,QAAA,IAAI,CAACgD,KAAAA,EAAO;YACRA,KAAAA,GAAQ;AAAEhD,gBAAAA,MAAAA;AAAQ8C,gBAAAA,OAAAA,EAAS;AAAG,aAAA;YAC9BN,KAAAA,CAAMS,OAAO,CAACC,IAAI,CAACF,KAAAA,CAAAA;AACvB,QAAA;AAEAF,QAAAA,OAAAA,GAAUE,MAAMF,OAAO;AAC3B,IAAA;IAEA,IAAIK,KAAAA,GAAQP,uCAAqBE,OAAAA,EAAS7C,MAAAA,CAAAA;AAC1C,IAAA,IAAI,CAACkD,KAAAA,EAAO;QACRA,KAAAA,GAAQ;AAAElD,YAAAA,MAAAA;AAAQe,YAAAA,KAAAA,EAAO;AAAG,SAAA;AAC5B8B,QAAAA,OAAAA,CAAQI,IAAI,CAACC,KAAAA,CAAAA;AACjB,IAAA;IAEA,OAAOA,KAAAA;AACX;AAEA,SAAST,KAAAA,CAAMF,KAAsB,EAAEC,IAAoB,EAAA;AACvD,IAAA,OAAQA,KAAK/B,IAAI;AACb,QAAA,KAAKC,sCAAmBC,aAAa;AACjC,YAAA,IAAI6B,IAAAA,CAAKzC,MAAM,KAAKI,SAAAA,EAAW,OAAOT,MAAAA;YACtCoD,QAAAA,CAASP,KAAAA,EAAOC,IAAAA,CAAKzC,MAAM,EAAEyC,IAAAA,CAAKxC,MAAM,CAAA,CAAGC,IAAI,GAAGuC,IAAAA,CAAKvC,IAAI;YAC3D,OAAOE,SAAAA;AACX,QAAA,KAAKO,sCAAmBI,cAAc;AAClCgC,YAAAA,QAAAA,CAASP,KAAAA,EAAOC,IAAAA,CAAKzC,MAAM,EAAEyC,IAAAA,CAAKxC,MAAM,CAAA,CAAGe,KAAK,GAAGG,eAAAA,CAAgBsB,IAAAA,CAAKzB,KAAK,IAAI,EAAE,CAAA;YACnF,OAAOZ,SAAAA;AACX,QAAA,KAAKO,sCAAmBuB,OAAO;AAAE,YAAA;AAC7B,gBAAA,MAAMkB,SAASL,QAAAA,CAASP,KAAAA,EAAOC,KAAKzC,MAAM,EAAEyC,KAAKxC,MAAM,CAAA;gBACvD,MAAMsB,IAAAA,GAAOJ,eAAAA,CAAgBsB,IAAAA,CAAKlB,IAAI,CAAA;gBACtC,IAAIO,gCAAAA,CAAesB,OAAOpC,KAAK,EAAEoC,OAAOnD,MAAM,CAAA,CAAE8B,QAAQ,CAACR,IAAAA,CAAKS,EAAE,CAAA,EAAG,OAAO,CAAC,oBAAoB,EAAET,KAAKS,EAAE,CAAC,iCAAiC,CAAC;gBAC3I,IAAIS,IAAAA,CAAKjB,MAAM,KAAKpB,SAAAA,EAAW;oBAC3BgD,MAAAA,CAAOpC,KAAK,CAACkC,IAAI,CAAC3B,IAAAA,CAAAA;oBAClB,OAAOnB,SAAAA;AACX,gBAAA;AAEA,gBAAA,IAAIgD,OAAOnD,MAAM,KAAKwB,gCAAAA,CAAqBC,OAAO,EAAE,OAAO7B,UAAAA;AAC3D,gBAAA,MAAMwD,QAAQC,QAAAA,CAASF,MAAAA,CAAOpC,KAAK,EAAEyB,KAAKjB,MAAM,CAAA;gBAChD,IAAI,CAAC6B,KAAAA,EAAO,OAAO,CAAC,kBAAkB,EAAEZ,IAAAA,CAAKjB,MAAM,CAAC,uBAAuB,CAAC;AAC3E6B,gBAAAA,CAAAA,MAAME,QAAQ,KAAK,EAAE,EAAEL,IAAI,CAAC3B,IAAAA,CAAAA;gBAC7B,OAAOnB,SAAAA;AACX,YAAA;AACA,QAAA,KAAKO,sCAAmB2B,OAAO;AAC3B,YAAA,IAAIG,IAAAA,CAAKzC,MAAM,KAAKI,SAAAA,EAAW,OAAOR,SAAAA;YACtC4C,KAAAA,CAAMnB,WAAW,CAACgB,IAAI,GAAG;AAAE,gBAAA,GAAGI,KAAKJ;AAAM,aAAA;YACzC,OAAOjC,SAAAA;AACX,QAAA;YACI,OAAO,CAAC,CAAC,EAAEoD,MAAAA,CAAO,IAACf,CAAwB/B,IAAI,CAAA,CAAE,2BAA2B,CAAC;AACrF;AACJ;AAEA,SAAS4C,QAAAA,CAAStC,KAAgB,EAAEgB,EAAU,EAAA;IAC1C,KAAK,MAAMT,QAAQP,KAAAA,CAAO;AACtB,QAAA,IAAIO,IAAAA,CAAKS,EAAE,KAAKA,EAAAA,EAAI,OAAOT,IAAAA;AAC3B,QAAA,MAAMkC,SAASH,QAAAA,CAAS/B,IAAAA,CAAKgC,QAAQ,IAAI,EAAE,EAAEvB,EAAAA,CAAAA;AAC7C,QAAA,IAAIyB,QAAQ,OAAOA,MAAAA;AACvB,IAAA;IAEA,OAAOrD,SAAAA;AACX;;;;;"}

package/dist/cjs/navigation/navigationRegions.js

@@ -0,0 +1,42 @@
+'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.
+/** The regions in the order every result lists them. */ const navigationRegionOrder = [
+    scene_model.NavigationRegionKind.Topbar,
+    scene_model.NavigationRegionKind.Sidebar
+];
+/** The slot an item renders into when it names none: the primary outlet. */ const primarySlot = 'content';
+/**
+ * Finds the items a level defines for a region.
+ * @param regions The regions of the application or of a module.
+ * @param region The region to look for.
+ */ function findNavigationRegion(regions, region) {
+    return regions?.find((candidate)=>candidate.region === region);
+}
+/** Finds what a module declares; undefined when it declares nothing. */ function findModuleNavigation(navigation, module) {
+    return navigation.modules.find((candidate)=>candidate.module === module);
+}
+/** The mode of a module's region: `inherit` when the module does not declare the region or its mode. */ function modeOfModuleRegion(navigation, module, region) {
+    return findNavigationRegion(findModuleNavigation(navigation, module)?.regions, region)?.mode ?? scene_model.NavigationRegionMode.Inherit;
+}
+/** The application-level items of a region. */ function applicationItems(application, region) {
+    return findNavigationRegion(application.regions, region)?.items ?? [];
+}
+/** Every id in a list of items, depth first. Sub-items count only in the sidebar. */ function collectItemIds(items, region) {
+    return items.flatMap((item)=>[
+            item.id,
+            ...region === scene_model.NavigationRegionKind.Sidebar ? collectItemIds(item.children ?? [], region) : []
+        ]);
+}
+
+exports.applicationItems = applicationItems;
+exports.collectItemIds = collectItemIds;
+exports.findModuleNavigation = findModuleNavigation;
+exports.findNavigationRegion = findNavigationRegion;
+exports.modeOfModuleRegion = modeOfModuleRegion;
+exports.navigationRegionOrder = navigationRegionOrder;
+exports.primarySlot = primarySlot;
+//# sourceMappingURL=navigationRegions.js.map

package/dist/cjs/navigation/navigationRegions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationRegions.js","sources":["../../../navigation/navigationRegions.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 { ApplicationNavigation, ModuleNavigation, NavigationModel, NavigationRegion, NavigationRegionKind, NavigationRegionMode, NavItem } from '@cratis/scene.model';\n\n/** The regions in the order every result lists them. */\nexport const navigationRegionOrder: NavigationRegionKind[] = [NavigationRegionKind.Topbar, NavigationRegionKind.Sidebar];\n\n/** The slot an item renders into when it names none: the primary outlet. */\nexport const primarySlot = 'content';\n\n/**\n * Finds the items a level defines for a region.\n * @param regions The regions of the application or of a module.\n * @param region The region to look for.\n */\nexport function findNavigationRegion(regions: NavigationRegion[] | undefined, region: NavigationRegionKind): NavigationRegion | undefined {\n    return regions?.find(candidate => candidate.region === region);\n}\n\n/** Finds what a module declares; undefined when it declares nothing. */\nexport function findModuleNavigation(navigation: NavigationModel, module: string): ModuleNavigation | undefined {\n    return navigation.modules.find(candidate => candidate.module === module);\n}\n\n/** The mode of a module's region: `inherit` when the module does not declare the region or its mode. */\nexport function modeOfModuleRegion(navigation: NavigationModel, module: string, region: NavigationRegionKind): NavigationRegionMode {\n    return findNavigationRegion(findModuleNavigation(navigation, module)?.regions, region)?.mode ?? NavigationRegionMode.Inherit;\n}\n\n/** The application-level items of a region. */\nexport function applicationItems(application: ApplicationNavigation, region: NavigationRegionKind): NavItem[] {\n    return findNavigationRegion(application.regions, region)?.items ?? [];\n}\n\n/** Every id in a list of items, depth first. Sub-items count only in the sidebar. */\nexport function collectItemIds(items: NavItem[], region: NavigationRegionKind): string[] {\n    return items.flatMap(item => [item.id, ...(region === NavigationRegionKind.Sidebar ? collectItemIds(item.children ?? [], region) : [])]);\n}\n"],"names":["navigationRegionOrder","NavigationRegionKind","Topbar","Sidebar","primarySlot","findNavigationRegion","regions","region","find","candidate","findModuleNavigation","navigation","module","modules","modeOfModuleRegion","mode","NavigationRegionMode","Inherit","applicationItems","application","items","collectItemIds","flatMap","item","id","children"],"mappings":";;;;AAAA;AACA;AAIA,yDACO,MAAMA,qBAAAA,GAAgD;AAACC,IAAAA,gCAAAA,CAAqBC,MAAM;AAAED,IAAAA,gCAAAA,CAAqBE;;AAEhH,6EACO,MAAMC,WAAAA,GAAc;AAE3B;;;;AAIC,IACM,SAASC,oBAAAA,CAAqBC,OAAuC,EAAEC,MAA4B,EAAA;AACtG,IAAA,OAAOD,SAASE,IAAAA,CAAKC,CAAAA,SAAAA,GAAaA,SAAAA,CAAUF,MAAM,KAAKA,MAAAA,CAAAA;AAC3D;AAEA,yEACO,SAASG,oBAAAA,CAAqBC,UAA2B,EAAEC,MAAc,EAAA;IAC5E,OAAOD,UAAAA,CAAWE,OAAO,CAACL,IAAI,CAACC,CAAAA,SAAAA,GAAaA,SAAAA,CAAUG,MAAM,KAAKA,MAAAA,CAAAA;AACrE;AAEA,yGACO,SAASE,kBAAAA,CAAmBH,UAA2B,EAAEC,MAAc,EAAEL,MAA4B,EAAA;IACxG,OAAOF,oBAAAA,CAAqBK,qBAAqBC,UAAAA,EAAYC,MAAAA,CAAAA,EAASN,SAASC,MAAAA,CAAAA,EAASQ,IAAAA,IAAQC,iCAAqBC,OAAO;AAChI;AAEA,gDACO,SAASC,gBAAAA,CAAiBC,WAAkC,EAAEZ,MAA4B,EAAA;AAC7F,IAAA,OAAOF,qBAAqBc,WAAAA,CAAYb,OAAO,EAAEC,MAAAA,CAAAA,EAASa,SAAS,EAAE;AACzE;AAEA,sFACO,SAASC,cAAAA,CAAeD,KAAgB,EAAEb,MAA4B,EAAA;AACzE,IAAA,OAAOa,KAAAA,CAAME,OAAO,CAACC,CAAAA,IAAAA,GAAQ;AAACA,YAAAA,IAAAA,CAAKC,EAAE;eAAMjB,MAAAA,KAAWN,gCAAAA,CAAqBE,OAAO,GAAGkB,cAAAA,CAAeE,IAAAA,CAAKE,QAAQ,IAAI,EAAE,EAAElB,MAAAA,CAAAA,GAAU;AAAI,SAAA,CAAA;AAC3I;;;;;;;;"}

package/dist/cjs/sampleData/SampleRandom.js

@@ -0,0 +1,77 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The pseudo-random generator behind generated sample data. The C# engine implements the identical
+ * algorithm, and both are asserted against golden rows in `sample-data-resolution-fixtures.json`.
+ *
+ * Algorithm (all arithmetic on unsigned 32-bit integers, wrapping):
+ *
+ * - `hash32(x)`: `x = (x ^ (x >>> 16)) * 0x85EBCA6B; x = (x ^ (x >>> 13)) * 0xC2B2AE35; return x ^ (x >>> 16)`.
+ * - `splitmix32(state)`: `state += 0x9E3779B9`, then `hash32(state)`.
+ * - `fnv1a32(text)`: FNV-1a over the UTF-8 bytes of the text (offset basis `0x811C9DC5`, prime `0x01000193`).
+ * - The generator is xoshiro128** seeded with four consecutive `splitmix32` outputs of the seed.
+ * - `nextInt(bound)` is `next() % bound`.
+ * - Row `i` of a shape named `S` generated with seed `n` uses its own generator seeded with
+ *   `hash32((n ^ fnv1a32(S)) + (i + 1) * 0x9E3779B9)`, so a row never depends on how many rows are asked for.
+ */ function hash32(value) {
+    let x = value >>> 0;
+    x = Math.imul(x ^ x >>> 16, 0x85EBCA6B) >>> 0;
+    x = Math.imul(x ^ x >>> 13, 0xC2B2AE35) >>> 0;
+    return (x ^ x >>> 16) >>> 0;
+}
+/** FNV-1a (32-bit) over the UTF-8 bytes of a string. */ function fnv1a32(text) {
+    let hash = 0x811C9DC5;
+    for (const byte of new TextEncoder().encode(text)){
+        hash = Math.imul(hash ^ byte, 0x01000193) >>> 0;
+    }
+    return hash;
+}
+/** The seed of the generator for one row of one shape. */ function rowSeed(seed, shapeName, rowIndex) {
+    return hash32(((seed ^ fnv1a32(shapeName)) >>> 0) + Math.imul(rowIndex + 1, 0x9E3779B9) >>> 0);
+}
+/** xoshiro128** with splitmix32 seeding. */ class SampleRandom {
+    s0;
+    s1;
+    s2;
+    s3;
+    constructor(seed){
+        let state = seed >>> 0;
+        const step = ()=>{
+            state = state + 0x9E3779B9 >>> 0;
+            return hash32(state);
+        };
+        this.s0 = step();
+        this.s1 = step();
+        this.s2 = step();
+        this.s3 = step();
+        if ((this.s0 | this.s1 | this.s2 | this.s3) === 0) this.s0 = 1;
+    }
+    /** The next unsigned 32-bit value. */ next() {
+        const result = Math.imul(rotateLeft(Math.imul(this.s1, 5) >>> 0, 7), 9) >>> 0;
+        const t = this.s1 << 9 >>> 0;
+        this.s2 = (this.s2 ^ this.s0) >>> 0;
+        this.s3 = (this.s3 ^ this.s1) >>> 0;
+        this.s1 = (this.s1 ^ this.s2) >>> 0;
+        this.s0 = (this.s0 ^ this.s3) >>> 0;
+        this.s2 = (this.s2 ^ t) >>> 0;
+        this.s3 = rotateLeft(this.s3, 11);
+        return result;
+    }
+    /** A value in `[0, bound)`; zero when the bound is zero. */ nextInt(bound) {
+        return bound <= 0 ? 0 : this.next() % bound;
+    }
+    /** One element of a non-empty list. */ pick(items) {
+        return items[this.nextInt(items.length)];
+    }
+}
+function rotateLeft(value, bits) {
+    return (value << bits | value >>> 32 - bits) >>> 0;
+}
+
+exports.SampleRandom = SampleRandom;
+exports.fnv1a32 = fnv1a32;
+exports.hash32 = hash32;
+exports.rowSeed = rowSeed;
+//# sourceMappingURL=SampleRandom.js.map

package/dist/cjs/sampleData/SampleRandom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SampleRandom.js","sources":["../../../sampleData/SampleRandom.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * The pseudo-random generator behind generated sample data. The C# engine implements the identical\n * algorithm, and both are asserted against golden rows in `sample-data-resolution-fixtures.json`.\n *\n * Algorithm (all arithmetic on unsigned 32-bit integers, wrapping):\n *\n * - `hash32(x)`: `x = (x ^ (x >>> 16)) * 0x85EBCA6B; x = (x ^ (x >>> 13)) * 0xC2B2AE35; return x ^ (x >>> 16)`.\n * - `splitmix32(state)`: `state += 0x9E3779B9`, then `hash32(state)`.\n * - `fnv1a32(text)`: FNV-1a over the UTF-8 bytes of the text (offset basis `0x811C9DC5`, prime `0x01000193`).\n * - The generator is xoshiro128** seeded with four consecutive `splitmix32` outputs of the seed.\n * - `nextInt(bound)` is `next() % bound`.\n * - Row `i` of a shape named `S` generated with seed `n` uses its own generator seeded with\n *   `hash32((n ^ fnv1a32(S)) + (i + 1) * 0x9E3779B9)`, so a row never depends on how many rows are asked for.\n */\nexport function hash32(value: number): number {\n    let x = value >>> 0;\n    x = Math.imul(x ^ (x >>> 16), 0x85EBCA6B) >>> 0;\n    x = Math.imul(x ^ (x >>> 13), 0xC2B2AE35) >>> 0;\n    return (x ^ (x >>> 16)) >>> 0;\n}\n\n/** FNV-1a (32-bit) over the UTF-8 bytes of a string. */\nexport function fnv1a32(text: string): number {\n    let hash = 0x811C9DC5;\n    for (const byte of new TextEncoder().encode(text)) {\n        hash = Math.imul(hash ^ byte, 0x01000193) >>> 0;\n    }\n    return hash;\n}\n\n/** The seed of the generator for one row of one shape. */\nexport function rowSeed(seed: number, shapeName: string, rowIndex: number): number {\n    return hash32((((seed ^ fnv1a32(shapeName)) >>> 0) + Math.imul(rowIndex + 1, 0x9E3779B9)) >>> 0);\n}\n\n/** xoshiro128** with splitmix32 seeding. */\nexport class SampleRandom {\n    private s0: number;\n    private s1: number;\n    private s2: number;\n    private s3: number;\n\n    constructor(seed: number) {\n        let state = seed >>> 0;\n        const step = () => {\n            state = (state + 0x9E3779B9) >>> 0;\n            return hash32(state);\n        };\n        this.s0 = step();\n        this.s1 = step();\n        this.s2 = step();\n        this.s3 = step();\n        if ((this.s0 | this.s1 | this.s2 | this.s3) === 0) this.s0 = 1;\n    }\n\n    /** The next unsigned 32-bit value. */\n    next(): number {\n        const result = Math.imul(rotateLeft(Math.imul(this.s1, 5) >>> 0, 7), 9) >>> 0;\n        const t = (this.s1 << 9) >>> 0;\n        this.s2 = (this.s2 ^ this.s0) >>> 0;\n        this.s3 = (this.s3 ^ this.s1) >>> 0;\n        this.s1 = (this.s1 ^ this.s2) >>> 0;\n        this.s0 = (this.s0 ^ this.s3) >>> 0;\n        this.s2 = (this.s2 ^ t) >>> 0;\n        this.s3 = rotateLeft(this.s3, 11);\n        return result;\n    }\n\n    /** A value in `[0, bound)`; zero when the bound is zero. */\n    nextInt(bound: number): number {\n        return bound <= 0 ? 0 : this.next() % bound;\n    }\n\n    /** One element of a non-empty list. */\n    pick<T>(items: readonly T[]): T {\n        return items[this.nextInt(items.length)];\n    }\n}\n\nfunction rotateLeft(value: number, bits: number): number {\n    return ((value << bits) | (value >>> (32 - bits))) >>> 0;\n}\n"],"names":["hash32","value","x","Math","imul","fnv1a32","text","hash","byte","TextEncoder","encode","rowSeed","seed","shapeName","rowIndex","SampleRandom","s0","s1","s2","s3","state","step","next","result","rotateLeft","t","nextInt","bound","pick","items","length","bits"],"mappings":";;AAAA;AACA;AAEA;;;;;;;;;;;;;IAcO,SAASA,MAAAA,CAAOC,KAAa,EAAA;AAChC,IAAA,IAAIC,IAAID,KAAAA,KAAU,CAAA;AAClBC,IAAAA,CAAAA,GAAIC,KAAKC,IAAI,CAACF,CAAAA,GAAKA,CAAAA,KAAM,IAAK,UAAA,CAAA,KAAgB,CAAA;AAC9CA,IAAAA,CAAAA,GAAIC,KAAKC,IAAI,CAACF,CAAAA,GAAKA,CAAAA,KAAM,IAAK,UAAA,CAAA,KAAgB,CAAA;AAC9C,IAAA,OAAO,CAACA,CAAAA,GAAKA,CAAAA,KAAM,EAAE,MAAO,CAAA;AAChC;AAEA,yDACO,SAASG,OAAAA,CAAQC,IAAY,EAAA;AAChC,IAAA,IAAIC,IAAAA,GAAO,UAAA;AACX,IAAA,KAAK,MAAMC,IAAAA,IAAQ,IAAIC,WAAAA,EAAAA,CAAcC,MAAM,CAACJ,IAAAA,CAAAA,CAAO;AAC/CC,QAAAA,IAAAA,GAAOJ,IAAAA,CAAKC,IAAI,CAACG,IAAAA,GAAOC,MAAM,UAAA,CAAA,KAAgB,CAAA;AAClD,IAAA;IACA,OAAOD,IAAAA;AACX;AAEA,2DACO,SAASI,OAAAA,CAAQC,IAAY,EAAEC,SAAiB,EAAEC,QAAgB,EAAA;AACrE,IAAA,OAAOd,OAAO,CAAE,CAACY,OAAOP,OAAAA,CAAQQ,SAAAA,CAAS,MAAO,CAAA,IAAKV,IAAAA,CAAKC,IAAI,CAACU,QAAAA,GAAW,GAAG,UAAA,CAAA,KAAiB,CAAA,CAAA;AAClG;AAEA,6CACO,MAAMC,YAAAA,CAAAA;IACDC,EAAAA;IACAC,EAAAA;IACAC,EAAAA;IACAC,EAAAA;AAER,IAAA,WAAA,CAAYP,IAAY,CAAE;AACtB,QAAA,IAAIQ,QAAQR,IAAAA,KAAS,CAAA;AACrB,QAAA,MAAMS,IAAAA,GAAO,IAAA;YACTD,KAAAA,GAASA,QAAQ,UAAA,KAAgB,CAAA;AACjC,YAAA,OAAOpB,MAAAA,CAAOoB,KAAAA,CAAAA;AAClB,QAAA,CAAA;QACA,IAAI,CAACJ,EAAE,GAAGK,IAAAA,EAAAA;QACV,IAAI,CAACJ,EAAE,GAAGI,IAAAA,EAAAA;QACV,IAAI,CAACH,EAAE,GAAGG,IAAAA,EAAAA;QACV,IAAI,CAACF,EAAE,GAAGE,IAAAA,EAAAA;QACV,IAAK,CAAA,IAAI,CAACL,EAAE,GAAG,IAAI,CAACC,EAAE,GAAG,IAAI,CAACC,EAAE,GAAG,IAAI,CAACC,EAAC,MAAO,CAAA,EAAG,IAAI,CAACH,EAAE,GAAG,CAAA;AACjE,IAAA;AAEA,2CACAM,IAAAA,GAAe;AACX,QAAA,MAAMC,MAAAA,GAASpB,IAAAA,CAAKC,IAAI,CAACoB,WAAWrB,IAAAA,CAAKC,IAAI,CAAC,IAAI,CAACa,EAAE,EAAE,CAAA,CAAA,KAAO,CAAA,EAAG,IAAI,CAAA,CAAA,KAAO,CAAA;AAC5E,QAAA,MAAMQ,IAAI,IAAK,CAACR,EAAE,IAAI,CAAA,KAAO,CAAA;AAC7B,QAAA,IAAI,CAACC,EAAE,GAAI,CAAA,IAAI,CAACA,EAAE,GAAG,IAAI,CAACF,EAAE,MAAM,CAAA;AAClC,QAAA,IAAI,CAACG,EAAE,GAAI,CAAA,IAAI,CAACA,EAAE,GAAG,IAAI,CAACF,EAAE,MAAM,CAAA;AAClC,QAAA,IAAI,CAACA,EAAE,GAAI,CAAA,IAAI,CAACA,EAAE,GAAG,IAAI,CAACC,EAAE,MAAM,CAAA;AAClC,QAAA,IAAI,CAACF,EAAE,GAAI,CAAA,IAAI,CAACA,EAAE,GAAG,IAAI,CAACG,EAAE,MAAM,CAAA;QAClC,IAAI,CAACD,EAAE,GAAG,CAAC,IAAI,CAACA,EAAE,GAAGO,CAAAA,MAAO,CAAA;AAC5B,QAAA,IAAI,CAACN,EAAE,GAAGK,WAAW,IAAI,CAACL,EAAE,EAAE,EAAA,CAAA;QAC9B,OAAOI,MAAAA;AACX,IAAA;iEAGAG,OAAAA,CAAQC,KAAa,EAAU;AAC3B,QAAA,OAAOA,SAAS,CAAA,GAAI,CAAA,GAAI,IAAI,CAACL,IAAI,EAAA,GAAKK,KAAAA;AAC1C,IAAA;4CAGAC,IAAAA,CAAQC,KAAmB,EAAK;QAC5B,OAAOA,KAAK,CAAC,IAAI,CAACH,OAAO,CAACG,KAAAA,CAAMC,MAAM,CAAA,CAAE;AAC5C,IAAA;AACJ;AAEA,SAASN,UAAAA,CAAWvB,KAAa,EAAE8B,IAAY,EAAA;IAC3C,OAAQ,CAAA,KAAC9B,IAAS8B,OAAS9B,KAAAA,KAAW,EAAA,GAAK8B,IAAK,MAAO,CAAA;AAC3D;;;;;"}

package/dist/cjs/sampleData/describeSampleDataCatalog.js

@@ -0,0 +1,61 @@
+'use strict';
+
+var validateSampleDataPackages = require('./validateSampleDataPackages.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The separator between blueprint and pack in a label (`CRM · Nordic SMB`). */ const sampleDataLabelSeparator = ' \u00b7 ';
+/** The name of the generated entry. */ const generatedSampleDataName = 'Generic (typed by field kind)';
+/**
+ * Describes the sample data selector's content: the generated entry first, then the author's own packs, then
+ * each blueprint's packs grouped by the blueprint's display name (falling back to its package name). A pack
+ * whose title already starts with `<Blueprint> · ` shows the rest as its name, so `CRM · Nordic SMB` under
+ * `CRM` is `Nordic SMB`. Same own-first, then Blueprints menu pattern as the template picker (spec §11).
+ *
+ * @param sources The packages and the packs they ship (only their `sampleData` references are listed).
+ * @param ownPacks The author's own packs (id, title, locale).
+ * @param activePack The selection's active pack id, if any.
+ */ function describeSampleDataCatalog(sources, ownPacks = [], activePack) {
+    const entry = (id, name, label, locale)=>({
+            id,
+            isGenerated: false,
+            name,
+            label,
+            locale,
+            selected: id === activePack
+        });
+    const blueprints = [];
+    for (const source of sources){
+        const references = source.manifest.sampleData ?? [];
+        if (references.length === 0) continue;
+        const group = groupName(source.manifest);
+        const prefix = `${group}${sampleDataLabelSeparator}`;
+        blueprints.push({
+            blueprint: group,
+            packs: references.map((reference)=>{
+                const name = reference.title.startsWith(prefix) ? reference.title.slice(prefix.length) : reference.title;
+                return entry(reference.id, name, `${group}${sampleDataLabelSeparator}${name}`, reference.locale);
+            })
+        });
+    }
+    return {
+        generated: {
+            id: '',
+            isGenerated: true,
+            name: generatedSampleDataName,
+            label: generatedSampleDataName,
+            selected: activePack === undefined || activePack === null || activePack === ''
+        },
+        own: ownPacks.map((pack)=>entry(pack.id, pack.title, pack.title, pack.locale)),
+        blueprints,
+        problems: validateSampleDataPackages.validateSampleDataPackages(sources)
+    };
+}
+function groupName(manifest) {
+    return manifest.displayName !== undefined && manifest.displayName.trim() !== '' ? manifest.displayName : manifest.name;
+}
+
+exports.describeSampleDataCatalog = describeSampleDataCatalog;
+exports.generatedSampleDataName = generatedSampleDataName;
+exports.sampleDataLabelSeparator = sampleDataLabelSeparator;
+//# sourceMappingURL=describeSampleDataCatalog.js.map

package/dist/cjs/sampleData/describeSampleDataCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describeSampleDataCatalog.js","sources":["../../../sampleData/describeSampleDataCatalog.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 { SampleDataPackReference, ScenePackage } from '@cratis/scene.model';\nimport { SampleDataPackSource } from './SampleDataPackSource';\nimport { validateSampleDataPackages } from './validateSampleDataPackages';\n\n/** The separator between blueprint and pack in a label (`CRM · Nordic SMB`). */\nexport const sampleDataLabelSeparator = ' \\u00b7 ';\n\n/** One entry of the sample data selector. */\nexport interface SampleDataCatalogEntry {\n    /** The pack identity a selection stores as `activePack`; empty for the generated entry. */\n    id: string;\n\n    /** Whether this is the generated entry, the choice that stores no active pack. */\n    isGenerated: boolean;\n\n    /** The pack's name within its group (`Nordic SMB`). */\n    name: string;\n\n    /** The full label (`CRM · Nordic SMB`, or just the name for generated and own packs). */\n    label: string;\n\n    /** The locale tag, absent for the generated entry. */\n    locale?: string;\n\n    /** Whether it is the active pack (the generated entry is selected when no pack is active). */\n    selected: boolean;\n}\n\n/** A blueprint's packs, one group of the Blueprints submenu. */\nexport interface SampleDataCatalogGroup {\n    /** The blueprint's display name (`CRM`). */\n    blueprint: string;\n\n    packs: SampleDataCatalogEntry[];\n}\n\n/** The selector's content: generated, the author's own sets, then blueprint groups. */\nexport interface SampleDataCatalog {\n    /** `Generic (typed by field kind)`. */\n    generated: SampleDataCatalogEntry;\n\n    /** The author's own data sets, in the order given. */\n    own: SampleDataCatalogEntry[];\n\n    /** Blueprints that ship at least one pack, in package order; blueprints with none are not listed. */\n    blueprints: SampleDataCatalogGroup[];\n\n    /** Problems found validating what the packages ship. */\n    problems: string[];\n}\n\n/** The name of the generated entry. */\nexport const generatedSampleDataName = 'Generic (typed by field kind)';\n\n/**\n * Describes the sample data selector's content: the generated entry first, then the author's own packs, then\n * each blueprint's packs grouped by the blueprint's display name (falling back to its package name). A pack\n * whose title already starts with `<Blueprint> · ` shows the rest as its name, so `CRM · Nordic SMB` under\n * `CRM` is `Nordic SMB`. Same own-first, then Blueprints menu pattern as the template picker (spec §11).\n *\n * @param sources The packages and the packs they ship (only their `sampleData` references are listed).\n * @param ownPacks The author's own packs (id, title, locale).\n * @param activePack The selection's active pack id, if any.\n */\nexport function describeSampleDataCatalog(\n    sources: readonly SampleDataPackSource[],\n    ownPacks: readonly Pick<SampleDataPackReference, 'id' | 'title' | 'locale'>[] = [],\n    activePack?: string,\n): SampleDataCatalog {\n    const entry = (id: string, name: string, label: string, locale: string): SampleDataCatalogEntry => ({\n        id, isGenerated: false, name, label, locale, selected: id === activePack,\n    });\n\n    const blueprints: SampleDataCatalogGroup[] = [];\n    for (const source of sources) {\n        const references = source.manifest.sampleData ?? [];\n        if (references.length === 0) continue;\n        const group = groupName(source.manifest);\n        const prefix = `${group}${sampleDataLabelSeparator}`;\n        blueprints.push({\n            blueprint: group,\n            packs: references.map(reference => {\n                const name = reference.title.startsWith(prefix) ? reference.title.slice(prefix.length) : reference.title;\n                return entry(reference.id, name, `${group}${sampleDataLabelSeparator}${name}`, reference.locale);\n            }),\n        });\n    }\n\n    return {\n        generated: {\n            id: '',\n            isGenerated: true,\n            name: generatedSampleDataName,\n            label: generatedSampleDataName,\n            selected: activePack === undefined || activePack === null || activePack === '',\n        },\n        own: ownPacks.map(pack => entry(pack.id, pack.title, pack.title, pack.locale)),\n        blueprints,\n        problems: validateSampleDataPackages(sources),\n    };\n}\n\nfunction groupName(manifest: ScenePackage): string {\n    return manifest.displayName !== undefined && manifest.displayName.trim() !== '' ? manifest.displayName : manifest.name;\n}\n"],"names":["sampleDataLabelSeparator","generatedSampleDataName","describeSampleDataCatalog","sources","ownPacks","activePack","entry","id","name","label","locale","isGenerated","selected","blueprints","source","references","manifest","sampleData","length","group","groupName","prefix","push","blueprint","packs","map","reference","title","startsWith","slice","generated","undefined","own","pack","problems","validateSampleDataPackages","displayName","trim"],"mappings":";;;;AAAA;AACA;AAMA,iFACO,MAAMA,wBAAAA,GAA2B;AA8CxC,wCACO,MAAMC,uBAAAA,GAA0B;AAEvC;;;;;;;;;IAUO,SAASC,yBAAAA,CACZC,OAAwC,EACxCC,QAAAA,GAAgF,EAAE,EAClFC,UAAmB,EAAA;AAEnB,IAAA,MAAMC,QAAQ,CAACC,EAAAA,EAAYC,IAAAA,EAAcC,KAAAA,EAAeC,UAA4C;AAChGH,YAAAA,EAAAA;YAAII,WAAAA,EAAa,KAAA;AAAOH,YAAAA,IAAAA;AAAMC,YAAAA,KAAAA;AAAOC,YAAAA,MAAAA;AAAQE,YAAAA,QAAAA,EAAUL,EAAAA,KAAOF;SAClE,CAAA;AAEA,IAAA,MAAMQ,aAAuC,EAAE;IAC/C,KAAK,MAAMC,UAAUX,OAAAA,CAAS;AAC1B,QAAA,MAAMY,aAAaD,MAAAA,CAAOE,QAAQ,CAACC,UAAU,IAAI,EAAE;QACnD,IAAIF,UAAAA,CAAWG,MAAM,KAAK,CAAA,EAAG;QAC7B,MAAMC,KAAAA,GAAQC,SAAAA,CAAUN,MAAAA,CAAOE,QAAQ,CAAA;QACvC,MAAMK,MAAAA,GAAS,CAAA,EAAGF,KAAAA,CAAAA,EAAQnB,wBAAAA,CAAAA,CAA0B;AACpDa,QAAAA,UAAAA,CAAWS,IAAI,CAAC;YACZC,SAAAA,EAAWJ,KAAAA;YACXK,KAAAA,EAAOT,UAAAA,CAAWU,GAAG,CAACC,CAAAA,SAAAA,GAAAA;AAClB,gBAAA,MAAMlB,OAAOkB,SAAAA,CAAUC,KAAK,CAACC,UAAU,CAACP,MAAAA,CAAAA,GAAUK,SAAAA,CAAUC,KAAK,CAACE,KAAK,CAACR,MAAAA,CAAOH,MAAM,CAAA,GAAIQ,UAAUC,KAAK;gBACxG,OAAOrB,KAAAA,CAAMoB,SAAAA,CAAUnB,EAAE,EAAEC,IAAAA,EAAM,CAAA,EAAGW,KAAAA,CAAAA,EAAQnB,wBAAAA,CAAAA,EAA2BQ,IAAAA,CAAAA,CAAM,EAAEkB,SAAAA,CAAUhB,MAAM,CAAA;AACnG,YAAA,CAAA;AACJ,SAAA,CAAA;AACJ,IAAA;IAEA,OAAO;QACHoB,SAAAA,EAAW;YACPvB,EAAAA,EAAI,EAAA;YACJI,WAAAA,EAAa,IAAA;YACbH,IAAAA,EAAMP,uBAAAA;YACNQ,KAAAA,EAAOR,uBAAAA;AACPW,YAAAA,QAAAA,EAAUP,UAAAA,KAAe0B,SAAAA,IAAa1B,UAAAA,KAAe,IAAA,IAAQA,UAAAA,KAAe;AAChF,SAAA;AACA2B,QAAAA,GAAAA,EAAK5B,SAASqB,GAAG,CAACQ,CAAAA,IAAAA,GAAQ3B,MAAM2B,IAAAA,CAAK1B,EAAE,EAAE0B,IAAAA,CAAKN,KAAK,EAAEM,IAAAA,CAAKN,KAAK,EAAEM,KAAKvB,MAAM,CAAA,CAAA;AAC5EG,QAAAA,UAAAA;AACAqB,QAAAA,QAAAA,EAAUC,qDAAAA,CAA2BhC,OAAAA;AACzC,KAAA;AACJ;AAEA,SAASiB,UAAUJ,QAAsB,EAAA;AACrC,IAAA,OAAOA,QAAAA,CAASoB,WAAW,KAAKL,SAAAA,IAAaf,SAASoB,WAAW,CAACC,IAAI,EAAA,KAAO,EAAA,GAAKrB,QAAAA,CAASoB,WAAW,GAAGpB,SAASR,IAAI;AAC1H;;;;"}