@cratis/scene.react 4.28.0 → 4.29.0

package/dist/cjs/navigation/region/navigationDestinations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationDestinations.js","sources":["../../../../navigation/region/navigationDestinations.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, DestinationReference, NavigationRegionKind, NavigationModel } from '@cratis/scene.model';\nimport { ApplicationStructureIndex, EffectiveNavItem, effectiveNavigation } from '@cratis/scene.engine';\nimport { navigationItemDestination } from './navigationItemDestination';\n\nfunction flatten(items: EffectiveNavItem[]): EffectiveNavItem[] {\n    return items.flatMap(item => [item, ...flatten(item.children ?? [])]);\n}\n\n/**\n * Every destination the navigation of the application and of each module can lead to, once each: what a\n * `SceneNavigationHost` is given as `destinations` so deep links to a navigation item resolve, and an item that renders\n * into a nested outlet is placed with the screen that declares the outlet.\n */\nexport function navigationDestinations(\n    structure: ApplicationStructure | ApplicationStructureIndex,\n    navigation: NavigationModel,\n    screenFor?: (item: EffectiveNavItem) => string | undefined,\n): DestinationReference[] {\n    const index = structure instanceof ApplicationStructureIndex ? structure : new ApplicationStructureIndex(structure);\n    const modules = [undefined, ...index.structure.modules.map(module => module.id)];\n    const seen = new Set<string>();\n    const destinations: DestinationReference[] = [];\n\n    for (const module of modules) {\n        for (const region of [NavigationRegionKind.Topbar, NavigationRegionKind.Sidebar]) {\n            for (const item of flatten(effectiveNavigation(index, navigation, module, region).items)) {\n                const destination = navigationItemDestination(item, screenFor);\n                if (destination === undefined) continue;\n                const key = JSON.stringify(destination);\n                if (seen.has(key)) continue;\n                seen.add(key);\n                destinations.push(destination);\n            }\n        }\n    }\n\n    return destinations;\n}\n"],"names":["flatten","items","flatMap","item","children","navigationDestinations","structure","navigation","screenFor","index","ApplicationStructureIndex","modules","undefined","map","module","id","seen","Set","destinations","region","NavigationRegionKind","Topbar","Sidebar","effectiveNavigation","destination","navigationItemDestination","key","JSON","stringify","has","add","push"],"mappings":";;;;;;AAAA;AACA;AAMA,SAASA,QAAQC,KAAyB,EAAA;AACtC,IAAA,OAAOA,KAAAA,CAAMC,OAAO,CAACC,CAAAA,IAAAA,GAAQ;AAACA,YAAAA,IAAAA;eAASH,OAAAA,CAAQG,IAAAA,CAAKC,QAAQ,IAAI,EAAE;AAAE,SAAA,CAAA;AACxE;AAEA;;;;AAIC,IACM,SAASC,sBAAAA,CACZC,SAA2D,EAC3DC,UAA2B,EAC3BC,SAA0D,EAAA;AAE1D,IAAA,MAAMC,KAAAA,GAAQH,SAAAA,YAAqBI,sCAAAA,GAA4BJ,SAAAA,GAAY,IAAII,sCAAAA,CAA0BJ,SAAAA,CAAAA;AACzG,IAAA,MAAMK,OAAAA,GAAU;AAACC,QAAAA,SAAAA;WAAcH,KAAAA,CAAMH,SAAS,CAACK,OAAO,CAACE,GAAG,CAACC,CAAAA,MAAAA,GAAUA,MAAAA,CAAOC,EAAE;AAAE,KAAA;AAChF,IAAA,MAAMC,OAAO,IAAIC,GAAAA,EAAAA;AACjB,IAAA,MAAMC,eAAuC,EAAE;IAE/C,KAAK,MAAMJ,UAAUH,OAAAA,CAAS;AAC1B,QAAA,KAAK,MAAMQ,MAAAA,IAAU;AAACC,YAAAA,gCAAAA,CAAqBC,MAAM;AAAED,YAAAA,gCAAAA,CAAqBE;SAAQ,CAAE;YAC9E,KAAK,MAAMnB,QAAQH,OAAAA,CAAQuB,gCAAAA,CAAoBd,OAAOF,UAAAA,EAAYO,MAAAA,EAAQK,MAAAA,CAAAA,CAAQlB,KAAK,CAAA,CAAG;gBACtF,MAAMuB,WAAAA,GAAcC,oDAA0BtB,IAAAA,EAAMK,SAAAA,CAAAA;AACpD,gBAAA,IAAIgB,gBAAgBZ,SAAAA,EAAW;gBAC/B,MAAMc,GAAAA,GAAMC,IAAAA,CAAKC,SAAS,CAACJ,WAAAA,CAAAA;gBAC3B,IAAIR,IAAAA,CAAKa,GAAG,CAACH,GAAAA,CAAAA,EAAM;AACnBV,gBAAAA,IAAAA,CAAKc,GAAG,CAACJ,GAAAA,CAAAA;AACTR,gBAAAA,YAAAA,CAAaa,IAAI,CAACP,WAAAA,CAAAA;AACtB,YAAA;AACJ,QAAA;AACJ,IAAA;IAEA,OAAON,YAAAA;AACX;;"}

package/dist/cjs/navigation/region/navigationItemActive.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var scene_engine = require('@cratis/scene.engine');
+var navigationItemDestination = require('./navigationItemDestination.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Whether a navigation item is the one the page shows.
+ *
+ * An item is active when the screen it opens is the one in the slot it renders into: the primary region for the
+ * `content` slot, the nested outlet of that name otherwise. So several items can be active at once - each is shown in
+ * its own slot - and closing a slot's screen un-highlights its item. With `matchModule` - a topbar - an item that targets
+ * a module without a feature is also active while any screen of that module is in its slot.
+ *
+ * @param item The effective item.
+ * @param placement What the host currently shows.
+ * @param screenFor Names the screen an item opens; the feature the item resolves to when absent.
+ * @param matchModule Whether a module item is active on any screen of the module; a topbar's are, a sidebar's are not.
+ */ function navigationItemActive(item, placement, screenFor = navigationItemDestination.defaultScreenFor, matchModule = false) {
+    const screen = screenFor(item);
+    if (screen === undefined) return false;
+    const shown = item.slot === scene_engine.primarySlot ? placement.primaryScreen : placement.outlets[item.slot];
+    if (shown === undefined) return false;
+    if (shown === screen) return true;
+    const target = item.target;
+    return matchModule && target !== undefined && target.feature === undefined && shown.startsWith(`${target.module}.`);
+}
+
+exports.navigationItemActive = navigationItemActive;
+//# sourceMappingURL=navigationItemActive.js.map

package/dist/cjs/navigation/region/navigationItemActive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationItemActive.js","sources":["../../../../navigation/region/navigationItemActive.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 { EffectiveNavItem, primarySlot } from '@cratis/scene.engine';\nimport { defaultScreenFor } from './navigationItemDestination';\nimport { SceneNavigationContextValue } from '../SceneNavigationContext';\n\n/** Where the navigation host is: the part of {@link SceneNavigationContextValue} that says what is on the page. */\nexport type NavigationPlacement = Pick<SceneNavigationContextValue, 'primaryScreen' | 'outlets'>;\n\n/**\n * Whether a navigation item is the one the page shows.\n *\n * An item is active when the screen it opens is the one in the slot it renders into: the primary region for the\n * `content` slot, the nested outlet of that name otherwise. So several items can be active at once - each is shown in\n * its own slot - and closing a slot's screen un-highlights its item. With `matchModule` - a topbar - an item that targets\n * a module without a feature is also active while any screen of that module is in its slot.\n *\n * @param item The effective item.\n * @param placement What the host currently shows.\n * @param screenFor Names the screen an item opens; the feature the item resolves to when absent.\n * @param matchModule Whether a module item is active on any screen of the module; a topbar's are, a sidebar's are not.\n */\nexport function navigationItemActive(\n    item: EffectiveNavItem,\n    placement: NavigationPlacement,\n    screenFor: (item: EffectiveNavItem) => string | undefined = defaultScreenFor,\n    matchModule = false,\n): boolean {\n    const screen = screenFor(item);\n    if (screen === undefined) return false;\n\n    const shown = item.slot === primarySlot ? placement.primaryScreen : placement.outlets[item.slot];\n    if (shown === undefined) return false;\n    if (shown === screen) return true;\n\n    const target = item.target;\n    return matchModule && target !== undefined && target.feature === undefined && shown.startsWith(`${target.module}.`);\n}\n"],"names":["navigationItemActive","item","placement","screenFor","defaultScreenFor","matchModule","screen","undefined","shown","slot","primarySlot","primaryScreen","outlets","target","feature","startsWith","module"],"mappings":";;;;;AAAA;AACA;AASA;;;;;;;;;;;;IAaO,SAASA,oBAAAA,CACZC,IAAsB,EACtBC,SAA8B,EAC9BC,SAAAA,GAA4DC,0CAAgB,EAC5EC,WAAAA,GAAc,KAAK,EAAA;AAEnB,IAAA,MAAMC,SAASH,SAAAA,CAAUF,IAAAA,CAAAA;IACzB,IAAIK,MAAAA,KAAWC,WAAW,OAAO,KAAA;AAEjC,IAAA,MAAMC,KAAAA,GAAQP,IAAAA,CAAKQ,IAAI,KAAKC,wBAAAA,GAAcR,SAAAA,CAAUS,aAAa,GAAGT,SAAAA,CAAUU,OAAO,CAACX,IAAAA,CAAKQ,IAAI,CAAC;IAChG,IAAID,KAAAA,KAAUD,WAAW,OAAO,KAAA;IAChC,IAAIC,KAAAA,KAAUF,QAAQ,OAAO,IAAA;IAE7B,MAAMO,MAAAA,GAASZ,KAAKY,MAAM;AAC1B,IAAA,OAAOR,WAAAA,IAAeQ,MAAAA,KAAWN,SAAAA,IAAaM,MAAAA,CAAOC,OAAO,KAAKP,SAAAA,IAAaC,KAAAA,CAAMO,UAAU,CAAC,CAAA,EAAGF,MAAAA,CAAOG,MAAM,CAAC,CAAC,CAAC,CAAA;AACtH;;"}

package/dist/cjs/navigation/region/navigationItemDestination.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var scene_engine = require('@cratis/scene.engine');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The screen an item opens by default: the qualified id of the feature it resolves to. */ function defaultScreenFor(item) {
+    return item.target?.resolvedFeature;
+}
+/**
+ * Where activating a navigation item goes: its stable module/feature identity, the screen it opens, and the slot it
+ * renders into as the outlet - the primary `content` slot is the host's primary outlet.
+ *
+ * @param item The effective item.
+ * @param screenFor Names the screen an item opens; {@link defaultScreenFor} when absent.
+ * @returns The destination, or undefined when the item leads nowhere.
+ */ function navigationItemDestination(item, screenFor = defaultScreenFor) {
+    const screen = screenFor(item);
+    if (screen === undefined || item.target === undefined) return undefined;
+    const resolved = item.target.resolvedFeature;
+    const destination = {
+        kind: scene_model.DestinationKind.Outlet,
+        module: item.target.module,
+        screen
+    };
+    if (resolved !== undefined && resolved.startsWith(`${item.target.module}.`)) destination.feature = resolved.substring(item.target.module.length + 1);
+    if (item.slot !== scene_engine.primarySlot) destination.outlet = item.slot;
+    return destination;
+}
+
+exports.defaultScreenFor = defaultScreenFor;
+exports.navigationItemDestination = navigationItemDestination;
+//# sourceMappingURL=navigationItemDestination.js.map

package/dist/cjs/navigation/region/navigationItemDestination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationItemDestination.js","sources":["../../../../navigation/region/navigationItemDestination.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 { DestinationKind, DestinationReference } from '@cratis/scene.model';\nimport { EffectiveNavItem, primarySlot } from '@cratis/scene.engine';\n\n/** The screen an item opens by default: the qualified id of the feature it resolves to. */\nexport function defaultScreenFor(item: EffectiveNavItem): string | undefined {\n    return item.target?.resolvedFeature;\n}\n\n/**\n * Where activating a navigation item goes: its stable module/feature identity, the screen it opens, and the slot it\n * renders into as the outlet - the primary `content` slot is the host's primary outlet.\n *\n * @param item The effective item.\n * @param screenFor Names the screen an item opens; {@link defaultScreenFor} when absent.\n * @returns The destination, or undefined when the item leads nowhere.\n */\nexport function navigationItemDestination(item: EffectiveNavItem, screenFor: (item: EffectiveNavItem) => string | undefined = defaultScreenFor): DestinationReference | undefined {\n    const screen = screenFor(item);\n    if (screen === undefined || item.target === undefined) return undefined;\n\n    const resolved = item.target.resolvedFeature;\n    const destination: DestinationReference = { kind: DestinationKind.Outlet, module: item.target.module, screen };\n    if (resolved !== undefined && resolved.startsWith(`${item.target.module}.`)) destination.feature = resolved.substring(item.target.module.length + 1);\n    if (item.slot !== primarySlot) destination.outlet = item.slot;\n    return destination;\n}\n"],"names":["defaultScreenFor","item","target","resolvedFeature","navigationItemDestination","screenFor","screen","undefined","resolved","destination","kind","DestinationKind","Outlet","module","startsWith","feature","substring","length","slot","primarySlot","outlet"],"mappings":";;;;;AAAA;AACA;AAKA,4FACO,SAASA,gBAAAA,CAAiBC,IAAsB,EAAA;IACnD,OAAOA,IAAAA,CAAKC,MAAM,EAAEC,eAAAA;AACxB;AAEA;;;;;;;AAOC,IACM,SAASC,yBAAAA,CAA0BH,IAAsB,EAAEI,YAA4DL,gBAAgB,EAAA;AAC1I,IAAA,MAAMM,SAASD,SAAAA,CAAUJ,IAAAA,CAAAA;AACzB,IAAA,IAAIK,WAAWC,SAAAA,IAAaN,IAAAA,CAAKC,MAAM,KAAKK,WAAW,OAAOA,SAAAA;AAE9D,IAAA,MAAMC,QAAAA,GAAWP,IAAAA,CAAKC,MAAM,CAACC,eAAe;AAC5C,IAAA,MAAMM,WAAAA,GAAoC;AAAEC,QAAAA,IAAAA,EAAMC,4BAAgBC,MAAM;QAAEC,MAAAA,EAAQZ,IAAAA,CAAKC,MAAM,CAACW,MAAM;AAAEP,QAAAA;AAAO,KAAA;IAC7G,IAAIE,QAAAA,KAAaD,SAAAA,IAAaC,QAAAA,CAASM,UAAU,CAAC,CAAA,EAAGb,IAAAA,CAAKC,MAAM,CAACW,MAAM,CAAC,CAAC,CAAC,GAAGJ,WAAAA,CAAYM,OAAO,GAAGP,QAAAA,CAASQ,SAAS,CAACf,IAAAA,CAAKC,MAAM,CAACW,MAAM,CAACI,MAAM,GAAG,CAAA,CAAA;IAClJ,IAAIhB,IAAAA,CAAKiB,IAAI,KAAKC,wBAAAA,EAAaV,YAAYW,MAAM,GAAGnB,KAAKiB,IAAI;IAC7D,OAAOT,WAAAA;AACX;;;"}

package/dist/esm/index.js

@@ -35,6 +35,13 @@ export { CoreOutlet } from './navigation/CoreOutlet.js';
 export { SceneOutletContext, useSceneOutlets } from './navigation/SceneOutletContext.js';
 export { collectOutletOwners, outletComponentName } from './navigation/collectOutletOwners.js';
 export { placeInOutlet } from './navigation/placeInOutlet.js';
+export { SceneNavigationModelProvider, useSceneNavigationModel } from './navigation/region/SceneNavigationModelContext.js';
+export { defaultNavigationRegionClassNames } from './navigation/region/NavigationRegionClassNames.js';
+export { NavigationRegionView } from './navigation/region/NavigationRegionView.js';
+export { currentModuleOf } from './navigation/region/currentModuleOf.js';
+export { navigationItemActive } from './navigation/region/navigationItemActive.js';
+export { defaultScreenFor, navigationItemDestination } from './navigation/region/navigationItemDestination.js';
+export { navigationDestinations } from './navigation/region/navigationDestinations.js';
 export { IconAdapterRegistry, createIconAdapterRegistry } from './icons/IconAdapterRegistry.js';
 export { IconAdapterProvider, useIconAdapters } from './icons/IconAdapterContext.js';
 export { useIconGlyph } from './icons/useIconGlyph.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/navigation/SceneNavigationHost.d.ts

@@ -1,8 +1,10 @@
+import { ReactNode } from 'react';
 import { BindingScope } from '@cratis/scene.engine';
 import { DestinationReference, SceneElement } from '@cratis/scene.model';
 import { ComponentRegistry } from '../renderer';
 import { SceneHistory } from './SceneHistory';
 import { SceneRoute } from './SceneRoute';
+import { SceneNavigationModel } from './region/SceneNavigationModel';
 export interface SceneNavigationHostProps {
     screens: Record<string, SceneElement>;
     dialogs?: Record<string, SceneElement>;
@@ -11,7 +13,9 @@ export interface SceneNavigationHostProps {
     bindingScope?: BindingScope;
     history?: SceneHistory;
     destinations?: DestinationReference[];
+    navigationModel?: SceneNavigationModel;
+    frame?(content: ReactNode): ReactNode;
     routes?: SceneRoute[];
 }
-export declare function SceneNavigationHost({ screens, dialogs, initialScreen, registry, bindingScope, history, destinations, routes }: SceneNavigationHostProps): import("react").JSX.Element;
+export declare function SceneNavigationHost({ screens, dialogs, initialScreen, registry, bindingScope, history, destinations: authoredDestinations, routes, navigationModel, frame }: SceneNavigationHostProps): import("react").JSX.Element;
 //# sourceMappingURL=SceneNavigationHost.d.ts.map

package/dist/esm/navigation/SceneNavigationHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SceneNavigationHost.d.ts","sourceRoot":"","sources":["../../../navigation/SceneNavigationHost.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAM1C,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAM5B,OAAO,CAAC,EAAE,YAAY,CAAC;IAGvB,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAGtC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AASD,wBAAgB,mBAAmB,CAAC,EAAE,OAAO,EAAE,OAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAiB,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,wBAAwB,+BAkBjK"}
+{"version":3,"file":"SceneNavigationHost.d.ts","sourceRoot":"","sources":["../../../navigation/SceneNavigationHost.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAqB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAIrE,MAAM,WAAW,wBAAwB;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAM5B,OAAO,CAAC,EAAE,YAAY,CAAC;IAGvB,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAMtC,eAAe,CAAC,EAAE,oBAAoB,CAAC;IAMvC,KAAK,CAAC,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAGtC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AASD,wBAAgB,mBAAmB,CAAC,EAAE,OAAO,EAAE,OAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAiB,EAAE,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,wBAAwB,+BAwB/M"}

package/dist/esm/navigation/SceneNavigationHost.js

@@ -1,5 +1,5 @@
 import { jsx, jsxs } from 'react/jsx-runtime';
-import { useState, useMemo } from 'react';
+import { useMemo, useState } from 'react';
 import { SceneElementView } from '../SceneElementView.js';
 import { createMemorySceneHistory } from './createMemorySceneHistory.js';
 import { SceneNavigationProvider } from './SceneNavigationContext.js';
@@ -7,6 +7,8 @@ import { sceneRoutesFrom } from './sceneRoutesFrom.js';
 import { collectOutletOwners } from './collectOutletOwners.js';
 import { SceneOutletContext } from './SceneOutletContext.js';
 import { useSceneHistoryNavigation } from './useSceneHistoryNavigation.js';
+import { SceneNavigationModelProvider } from './region/SceneNavigationModelContext.js';
+import { navigationDestinations } from './region/navigationDestinations.js';
 
 /**
  * Executes Scene destinations against an in-memory rendered hierarchy: a destination into a nested outlet -
@@ -14,7 +16,11 @@ import { useSceneHistoryNavigation } from './useSceneHistoryNavigation.js';
  * depth; any other screen route replaces the primary region,
  * dialog destinations render dialog content over the screen that opened them, and external destinations
  * only report their resolved action. Every navigation is a history entry.
- */ function SceneNavigationHost({ screens, dialogs = {}, initialScreen, registry, bindingScope = {}, history, destinations, routes }) {
+ */ function SceneNavigationHost({ screens, dialogs = {}, initialScreen, registry, bindingScope = {}, history, destinations: authoredDestinations, routes, navigationModel, frame }) {
+    const destinations = useMemo(()=>authoredDestinations ?? (navigationModel ? navigationDestinations(navigationModel.structure, navigationModel.navigation, navigationModel.screenFor) : undefined), [
+        authoredDestinations,
+        navigationModel
+    ]);
     const [memoryHistory] = useState(()=>createMemorySceneHistory());
     const routeTable = useMemo(()=>routes ?? sceneRoutesFrom(Object.keys(screens), destinations), [
         destinations,
@@ -34,22 +40,23 @@ import { useSceneHistoryNavigation } from './useSceneHistoryNavigation.js';
     ]);
     const screen = screens[value.primaryScreen];
     const dialog = value.currentDialog ? dialogs[value.currentDialog] : undefined;
-    return /*#__PURE__*/ jsx(SceneNavigationProvider, {
+    const outlet = /*#__PURE__*/ jsx("div", {
+        "data-scene-outlet": value.primaryScreen === value.currentScreen ? value.currentOutlet ?? 'primary' : 'primary',
+        "data-scene-url": value.currentUrl,
+        children: screen && /*#__PURE__*/ jsx(SceneElementView, {
+            element: screen,
+            registry: registry,
+            dataContext: bindingScope.dataContext,
+            queryResults: bindingScope.queryResults,
+            componentOutputs: bindingScope.componentOutputs
+        })
+    });
+    const page = /*#__PURE__*/ jsx(SceneNavigationProvider, {
         value: value,
         children: /*#__PURE__*/ jsxs(SceneOutletContext.Provider, {
             value: outletContext,
             children: [
-                /*#__PURE__*/ jsx("div", {
-                    "data-scene-outlet": value.primaryScreen === value.currentScreen ? value.currentOutlet ?? 'primary' : 'primary',
-                    "data-scene-url": value.currentUrl,
-                    children: screen && /*#__PURE__*/ jsx(SceneElementView, {
-                        element: screen,
-                        registry: registry,
-                        dataContext: bindingScope.dataContext,
-                        queryResults: bindingScope.queryResults,
-                        componentOutputs: bindingScope.componentOutputs
-                    })
-                }),
+                frame ? frame(outlet) : outlet,
                 dialog && /*#__PURE__*/ jsx("div", {
                     role: "dialog",
                     "aria-modal": "true",
@@ -66,6 +73,10 @@ import { useSceneHistoryNavigation } from './useSceneHistoryNavigation.js';
             ]
         })
     });
+    return navigationModel ? /*#__PURE__*/ jsx(SceneNavigationModelProvider, {
+        model: navigationModel,
+        children: page
+    }) : page;
 }
 
 export { SceneNavigationHost };

package/dist/esm/navigation/SceneNavigationHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"SceneNavigationHost.js","sources":["../../../navigation/SceneNavigationHost.tsx"],"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 { useMemo, useState } from 'react';\nimport { BindingScope } from '@cratis/scene.engine';\nimport { DestinationReference, SceneElement } from '@cratis/scene.model';\nimport { SceneElementView } from '../SceneElementView';\nimport { ComponentRegistry } from '../renderer';\nimport { createMemorySceneHistory } from './createMemorySceneHistory';\nimport { SceneHistory } from './SceneHistory';\nimport { SceneNavigationProvider } from './SceneNavigationContext';\nimport { SceneRoute } from './SceneRoute';\nimport { sceneRoutesFrom } from './sceneRoutesFrom';\nimport { collectOutletOwners } from './collectOutletOwners';\nimport { SceneOutletContext } from './SceneOutletContext';\nimport { useSceneHistoryNavigation } from './useSceneHistoryNavigation';\n\nexport interface SceneNavigationHostProps {\n    screens: Record<string, SceneElement>;\n    dialogs?: Record<string, SceneElement>;\n    initialScreen: string;\n    registry: ComponentRegistry;\n    bindingScope?: BindingScope;\n\n    /**\n     * Where entries are recorded. `createBrowserSceneHistory()` drives the address bar, so deep links,\n     * refresh and back/forward work; the default is an in-memory history for embedded hosts.\n     */\n    history?: SceneHistory;\n\n    /** The destinations the application navigates to, so their route overrides can be deep linked. */\n    destinations?: DestinationReference[];\n\n    /** An explicit route table, used instead of the one derived from `screens` and `destinations`. */\n    routes?: SceneRoute[];\n}\n\n/**\n * Executes Scene destinations against an in-memory rendered hierarchy: a destination into a nested outlet -\n * one a screen declares with `core:outlet` - places its screen there and keeps the screens above it, to any\n * depth; any other screen route replaces the primary region,\n * dialog destinations render dialog content over the screen that opened them, and external destinations\n * only report their resolved action. Every navigation is a history entry.\n */\nexport function SceneNavigationHost({ screens, dialogs = {}, initialScreen, registry, bindingScope = {}, history, destinations, routes }: SceneNavigationHostProps) {\n    const [memoryHistory] = useState(() => createMemorySceneHistory());\n    const routeTable = useMemo(() => routes ?? sceneRoutesFrom(Object.keys(screens), destinations), [destinations, routes, screens]);\n    const outletOwners = useMemo(() => collectOutletOwners(screens), [screens]);\n    const value = useSceneHistoryNavigation(history ?? memoryHistory, routeTable, initialScreen, bindingScope, outletOwners, destinations);\n    const outletContext = useMemo(() => ({ screens, registry }), [registry, screens]);\n\n    const screen = screens[value.primaryScreen];\n    const dialog = value.currentDialog ? dialogs[value.currentDialog] : undefined;\n\n    return <SceneNavigationProvider value={value}><SceneOutletContext.Provider value={outletContext}>\n        <div data-scene-outlet={value.primaryScreen === value.currentScreen ? value.currentOutlet ?? 'primary' : 'primary'} data-scene-url={value.currentUrl}>\n            {screen && <SceneElementView element={screen} registry={registry} dataContext={bindingScope.dataContext} queryResults={bindingScope.queryResults} componentOutputs={bindingScope.componentOutputs} />}\n        </div>\n        {dialog && <div role='dialog' aria-modal='true' aria-label={value.currentDialog} data-scene-dialog={value.currentDialog}>\n            <SceneElementView element={dialog} registry={registry} dataContext={bindingScope.dataContext} queryResults={bindingScope.queryResults} componentOutputs={bindingScope.componentOutputs} />\n        </div>}\n    </SceneOutletContext.Provider></SceneNavigationProvider>;\n}\n"],"names":["SceneNavigationHost","screens","dialogs","initialScreen","registry","bindingScope","history","destinations","routes","memoryHistory","useState","createMemorySceneHistory","routeTable","useMemo","sceneRoutesFrom","Object","keys","outletOwners","collectOutletOwners","value","useSceneHistoryNavigation","outletContext","screen","primaryScreen","dialog","currentDialog","undefined","_jsx","SceneNavigationProvider","_jsxs","SceneOutletContext","Provider","div","data-scene-outlet","currentScreen","currentOutlet","data-scene-url","currentUrl","SceneElementView","element","dataContext","queryResults","componentOutputs","role","aria-modal","aria-label","data-scene-dialog"],"mappings":";;;;;;;;;;AAqCA;;;;;;IAOO,SAASA,mBAAAA,CAAoB,EAAEC,OAAO,EAAEC,OAAAA,GAAU,EAAE,EAAEC,aAAa,EAAEC,QAAQ,EAAEC,YAAAA,GAAe,EAAE,EAAEC,OAAO,EAAEC,YAAY,EAAEC,MAAM,EAA4B,EAAA;AAC9J,IAAA,MAAM,CAACC,aAAAA,CAAc,GAAGC,QAAAA,CAAS,IAAMC,wBAAAA,EAAAA,CAAAA;IACvC,MAAMC,UAAAA,GAAaC,QAAQ,IAAML,MAAAA,IAAUM,gBAAgBC,MAAAA,CAAOC,IAAI,CAACf,OAAAA,CAAAA,EAAUM,YAAAA,CAAAA,EAAe;AAACA,QAAAA,YAAAA;AAAcC,QAAAA,MAAAA;AAAQP,QAAAA;AAAQ,KAAA,CAAA;AAC/H,IAAA,MAAMgB,YAAAA,GAAeJ,OAAAA,CAAQ,IAAMK,mBAAAA,CAAoBjB,OAAAA,CAAAA,EAAU;AAACA,QAAAA;AAAQ,KAAA,CAAA;AAC1E,IAAA,MAAMkB,QAAQC,yBAAAA,CAA0Bd,OAAAA,IAAWG,eAAeG,UAAAA,EAAYT,aAAAA,EAAeE,cAAcY,YAAAA,EAAcV,YAAAA,CAAAA;IACzH,MAAMc,aAAAA,GAAgBR,OAAAA,CAAQ,KAAO;AAAEZ,YAAAA,OAAAA;AAASG,YAAAA;AAAS,SAAA,CAAA,EAAI;AAACA,QAAAA,QAAAA;AAAUH,QAAAA;AAAQ,KAAA,CAAA;AAEhF,IAAA,MAAMqB,MAAAA,GAASrB,OAAO,CAACkB,KAAAA,CAAMI,aAAa,CAAC;IAC3C,MAAMC,MAAAA,GAASL,MAAMM,aAAa,GAAGvB,OAAO,CAACiB,KAAAA,CAAMM,aAAa,CAAC,GAAGC,SAAAA;AAEpE,IAAA,qBAAOC,GAAA,CAACC,uBAAAA,EAAAA;QAAwBT,KAAAA,EAAOA,KAAAA;gCAAOU,IAAA,CAACC,mBAAmBC,QAAQ,EAAA;YAACZ,KAAAA,EAAOE,aAAAA;;8BAC9EM,GAAA,CAACK,KAAAA,EAAAA;oBAAIC,mBAAAA,EAAmBd,KAAAA,CAAMI,aAAa,KAAKJ,KAAAA,CAAMe,aAAa,GAAGf,KAAAA,CAAMgB,aAAa,IAAI,SAAA,GAAY,SAAA;AAAWC,oBAAAA,gBAAAA,EAAgBjB,MAAMkB,UAAU;AAC/If,oBAAAA,QAAAA,EAAAA,MAAAA,kBAAUK,GAAA,CAACW,gBAAAA,EAAAA;wBAAiBC,OAAAA,EAASjB,MAAAA;wBAAQlB,QAAAA,EAAUA,QAAAA;AAAUoC,wBAAAA,WAAAA,EAAanC,aAAamC,WAAW;AAAEC,wBAAAA,YAAAA,EAAcpC,aAAaoC,YAAY;AAAEC,wBAAAA,gBAAAA,EAAkBrC,aAAaqC;;;AAEpLlB,gBAAAA,MAAAA,kBAAUG,GAAA,CAACK,KAAAA,EAAAA;oBAAIW,IAAAA,EAAK,QAAA;oBAASC,YAAAA,EAAW,MAAA;AAAOC,oBAAAA,YAAAA,EAAY1B,MAAMM,aAAa;AAAEqB,oBAAAA,mBAAAA,EAAmB3B,MAAMM,aAAa;AACnH,oBAAA,QAAA,gBAAAE,GAAA,CAACW,gBAAAA,EAAAA;wBAAiBC,OAAAA,EAASf,MAAAA;wBAAQpB,QAAAA,EAAUA,QAAAA;AAAUoC,wBAAAA,WAAAA,EAAanC,aAAamC,WAAW;AAAEC,wBAAAA,YAAAA,EAAcpC,aAAaoC,YAAY;AAAEC,wBAAAA,gBAAAA,EAAkBrC,aAAaqC;;;;;;AAGlL;;"}
+{"version":3,"file":"SceneNavigationHost.js","sources":["../../../navigation/SceneNavigationHost.tsx"],"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 { ReactNode, useMemo, useState } from 'react';\nimport { BindingScope } from '@cratis/scene.engine';\nimport { DestinationReference, SceneElement } from '@cratis/scene.model';\nimport { SceneElementView } from '../SceneElementView';\nimport { ComponentRegistry } from '../renderer';\nimport { createMemorySceneHistory } from './createMemorySceneHistory';\nimport { SceneHistory } from './SceneHistory';\nimport { SceneNavigationProvider } from './SceneNavigationContext';\nimport { SceneRoute } from './SceneRoute';\nimport { sceneRoutesFrom } from './sceneRoutesFrom';\nimport { collectOutletOwners } from './collectOutletOwners';\nimport { SceneOutletContext } from './SceneOutletContext';\nimport { useSceneHistoryNavigation } from './useSceneHistoryNavigation';\nimport { SceneNavigationModel } from './region/SceneNavigationModel';\nimport { SceneNavigationModelProvider } from './region/SceneNavigationModelContext';\nimport { navigationDestinations } from './region/navigationDestinations';\n\nexport interface SceneNavigationHostProps {\n    screens: Record<string, SceneElement>;\n    dialogs?: Record<string, SceneElement>;\n    initialScreen: string;\n    registry: ComponentRegistry;\n    bindingScope?: BindingScope;\n\n    /**\n     * Where entries are recorded. `createBrowserSceneHistory()` drives the address bar, so deep links,\n     * refresh and back/forward work; the default is an in-memory history for embedded hosts.\n     */\n    history?: SceneHistory;\n\n    /** The destinations the application navigates to, so their route overrides can be deep linked. */\n    destinations?: DestinationReference[];\n\n    /**\n     * The application's structure and navigation. Navigation regions rendered inside the host (`NavigationRegionView`) read it,\n     * and - when `destinations` is not given - the destinations of every navigation item become the deep-linkable ones.\n     */\n    navigationModel?: SceneNavigationModel;\n\n    /**\n     * Wraps the primary outlet in the application's chrome - a topbar, a sidebar, a toolbar. The chrome is part of the host,\n     * so it stays mounted while the screens inside it change and navigation regions keep their state.\n     */\n    frame?(content: ReactNode): ReactNode;\n\n    /** An explicit route table, used instead of the one derived from `screens` and `destinations`. */\n    routes?: SceneRoute[];\n}\n\n/**\n * Executes Scene destinations against an in-memory rendered hierarchy: a destination into a nested outlet -\n * one a screen declares with `core:outlet` - places its screen there and keeps the screens above it, to any\n * depth; any other screen route replaces the primary region,\n * dialog destinations render dialog content over the screen that opened them, and external destinations\n * only report their resolved action. Every navigation is a history entry.\n */\nexport function SceneNavigationHost({ screens, dialogs = {}, initialScreen, registry, bindingScope = {}, history, destinations: authoredDestinations, routes, navigationModel, frame }: SceneNavigationHostProps) {\n    const destinations = useMemo(\n        () => authoredDestinations ?? (navigationModel ? navigationDestinations(navigationModel.structure, navigationModel.navigation, navigationModel.screenFor) : undefined),\n        [authoredDestinations, navigationModel]);\n    const [memoryHistory] = useState(() => createMemorySceneHistory());\n    const routeTable = useMemo(() => routes ?? sceneRoutesFrom(Object.keys(screens), destinations), [destinations, routes, screens]);\n    const outletOwners = useMemo(() => collectOutletOwners(screens), [screens]);\n    const value = useSceneHistoryNavigation(history ?? memoryHistory, routeTable, initialScreen, bindingScope, outletOwners, destinations);\n    const outletContext = useMemo(() => ({ screens, registry }), [registry, screens]);\n\n    const screen = screens[value.primaryScreen];\n    const dialog = value.currentDialog ? dialogs[value.currentDialog] : undefined;\n\n    const outlet = <div data-scene-outlet={value.primaryScreen === value.currentScreen ? value.currentOutlet ?? 'primary' : 'primary'} data-scene-url={value.currentUrl}>\n        {screen && <SceneElementView element={screen} registry={registry} dataContext={bindingScope.dataContext} queryResults={bindingScope.queryResults} componentOutputs={bindingScope.componentOutputs} />}\n    </div>;\n    const page = <SceneNavigationProvider value={value}><SceneOutletContext.Provider value={outletContext}>\n        {frame ? frame(outlet) : outlet}\n        {dialog && <div role='dialog' aria-modal='true' aria-label={value.currentDialog} data-scene-dialog={value.currentDialog}>\n            <SceneElementView element={dialog} registry={registry} dataContext={bindingScope.dataContext} queryResults={bindingScope.queryResults} componentOutputs={bindingScope.componentOutputs} />\n        </div>}\n    </SceneOutletContext.Provider></SceneNavigationProvider>;\n\n    return navigationModel ? <SceneNavigationModelProvider model={navigationModel}>{page}</SceneNavigationModelProvider> : page;\n}\n"],"names":["SceneNavigationHost","screens","dialogs","initialScreen","registry","bindingScope","history","destinations","authoredDestinations","routes","navigationModel","frame","useMemo","navigationDestinations","structure","navigation","screenFor","undefined","memoryHistory","useState","createMemorySceneHistory","routeTable","sceneRoutesFrom","Object","keys","outletOwners","collectOutletOwners","value","useSceneHistoryNavigation","outletContext","screen","primaryScreen","dialog","currentDialog","outlet","_jsx","div","data-scene-outlet","currentScreen","currentOutlet","data-scene-url","currentUrl","SceneElementView","element","dataContext","queryResults","componentOutputs","page","SceneNavigationProvider","_jsxs","SceneOutletContext","Provider","role","aria-modal","aria-label","data-scene-dialog","SceneNavigationModelProvider","model"],"mappings":";;;;;;;;;;;;AAoDA;;;;;;AAMC,IACM,SAASA,mBAAAA,CAAoB,EAAEC,OAAO,EAAEC,OAAAA,GAAU,EAAE,EAAEC,aAAa,EAAEC,QAAQ,EAAEC,YAAAA,GAAe,EAAE,EAAEC,OAAO,EAAEC,YAAAA,EAAcC,oBAAoB,EAAEC,MAAM,EAAEC,eAAe,EAAEC,KAAK,EAA4B,EAAA;AAC5M,IAAA,MAAMJ,eAAeK,OAAAA,CACjB,IAAMJ,oBAAAA,KAAyBE,kBAAkBG,sBAAAA,CAAuBH,eAAAA,CAAgBI,SAAS,EAAEJ,gBAAgBK,UAAU,EAAEL,gBAAgBM,SAAS,CAAA,GAAIC,SAAQ,CAAA,EACpK;AAACT,QAAAA,oBAAAA;AAAsBE,QAAAA;AAAgB,KAAA,CAAA;AAC3C,IAAA,MAAM,CAACQ,aAAAA,CAAc,GAAGC,QAAAA,CAAS,IAAMC,wBAAAA,EAAAA,CAAAA;IACvC,MAAMC,UAAAA,GAAaT,QAAQ,IAAMH,MAAAA,IAAUa,gBAAgBC,MAAAA,CAAOC,IAAI,CAACvB,OAAAA,CAAAA,EAAUM,YAAAA,CAAAA,EAAe;AAACA,QAAAA,YAAAA;AAAcE,QAAAA,MAAAA;AAAQR,QAAAA;AAAQ,KAAA,CAAA;AAC/H,IAAA,MAAMwB,YAAAA,GAAeb,OAAAA,CAAQ,IAAMc,mBAAAA,CAAoBzB,OAAAA,CAAAA,EAAU;AAACA,QAAAA;AAAQ,KAAA,CAAA;AAC1E,IAAA,MAAM0B,QAAQC,yBAAAA,CAA0BtB,OAAAA,IAAWY,eAAeG,UAAAA,EAAYlB,aAAAA,EAAeE,cAAcoB,YAAAA,EAAclB,YAAAA,CAAAA;IACzH,MAAMsB,aAAAA,GAAgBjB,OAAAA,CAAQ,KAAO;AAAEX,YAAAA,OAAAA;AAASG,YAAAA;AAAS,SAAA,CAAA,EAAI;AAACA,QAAAA,QAAAA;AAAUH,QAAAA;AAAQ,KAAA,CAAA;AAEhF,IAAA,MAAM6B,MAAAA,GAAS7B,OAAO,CAAC0B,KAAAA,CAAMI,aAAa,CAAC;IAC3C,MAAMC,MAAAA,GAASL,MAAMM,aAAa,GAAG/B,OAAO,CAACyB,KAAAA,CAAMM,aAAa,CAAC,GAAGhB,SAAAA;AAEpE,IAAA,MAAMiB,uBAASC,GAAA,CAACC,KAAAA,EAAAA;QAAIC,mBAAAA,EAAmBV,KAAAA,CAAMI,aAAa,KAAKJ,KAAAA,CAAMW,aAAa,GAAGX,KAAAA,CAAMY,aAAa,IAAI,SAAA,GAAY,SAAA;AAAWC,QAAAA,gBAAAA,EAAgBb,MAAMc,UAAU;AAC9JX,QAAAA,QAAAA,EAAAA,MAAAA,kBAAUK,GAAA,CAACO,gBAAAA,EAAAA;YAAiBC,OAAAA,EAASb,MAAAA;YAAQ1B,QAAAA,EAAUA,QAAAA;AAAUwC,YAAAA,WAAAA,EAAavC,aAAauC,WAAW;AAAEC,YAAAA,YAAAA,EAAcxC,aAAawC,YAAY;AAAEC,YAAAA,gBAAAA,EAAkBzC,aAAayC;;;AAErL,IAAA,MAAMC,qBAAOZ,GAAA,CAACa,uBAAAA,EAAAA;QAAwBrB,KAAAA,EAAOA,KAAAA;gCAAOsB,IAAA,CAACC,mBAAmBC,QAAQ,EAAA;YAACxB,KAAAA,EAAOE,aAAAA;;AACnFlB,gBAAAA,KAAAA,GAAQA,MAAMuB,MAAAA,CAAAA,GAAUA,MAAAA;AACxBF,gBAAAA,MAAAA,kBAAUG,GAAA,CAACC,KAAAA,EAAAA;oBAAIgB,IAAAA,EAAK,QAAA;oBAASC,YAAAA,EAAW,MAAA;AAAOC,oBAAAA,YAAAA,EAAY3B,MAAMM,aAAa;AAAEsB,oBAAAA,mBAAAA,EAAmB5B,MAAMM,aAAa;AACnH,oBAAA,QAAA,gBAAAE,GAAA,CAACO,gBAAAA,EAAAA;wBAAiBC,OAAAA,EAASX,MAAAA;wBAAQ5B,QAAAA,EAAUA,QAAAA;AAAUwC,wBAAAA,WAAAA,EAAavC,aAAauC,WAAW;AAAEC,wBAAAA,YAAAA,EAAcxC,aAAawC,YAAY;AAAEC,wBAAAA,gBAAAA,EAAkBzC,aAAayC;;;;;;AAI9K,IAAA,OAAOpC,gCAAkByB,GAAA,CAACqB,4BAAAA,EAAAA;QAA6BC,KAAAA,EAAO/C,eAAAA;AAAkBqC,QAAAA,QAAAA,EAAAA;AAAuCA,KAAAA,CAAAA,GAAAA,IAAAA;AAC3H;;"}

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

@@ -19,4 +19,12 @@ export * from './CoreOutlet';
 export * from './SceneOutletContext';
 export * from './collectOutletOwners';
 export * from './placeInOutlet';
+export * from './region/SceneNavigationModel';
+export * from './region/SceneNavigationModelContext';
+export * from './region/NavigationRegionClassNames';
+export * from './region/NavigationRegionView';
+export * from './region/currentModuleOf';
+export * from './region/navigationItemActive';
+export * from './region/navigationItemDestination';
+export * from './region/navigationDestinations';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,iCAAiC,CAAC"}

package/dist/esm/navigation/index.js

@@ -19,4 +19,12 @@ export * from './CoreOutlet';
 export * from './SceneOutletContext';
 export * from './collectOutletOwners';
 export * from './placeInOutlet';
+export * from './region/SceneNavigationModel';
+export * from './region/SceneNavigationModelContext';
+export * from './region/NavigationRegionClassNames';
+export * from './region/NavigationRegionView';
+export * from './region/currentModuleOf';
+export * from './region/navigationItemActive';
+export * from './region/navigationItemDestination';
+export * from './region/navigationDestinations';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,iCAAiC,CAAC"}

package/dist/esm/navigation/region/NavigationRegionClassNames.d.ts

@@ -0,0 +1,12 @@
+export interface NavigationRegionClassNames {
+    root: string;
+    list: string;
+    item: string;
+    link: string;
+    icon: string;
+    label: string;
+    toggle: string;
+    submenu: string;
+}
+export declare const defaultNavigationRegionClassNames: NavigationRegionClassNames;
+//# sourceMappingURL=NavigationRegionClassNames.d.ts.map

package/dist/esm/navigation/region/NavigationRegionClassNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationRegionClassNames.d.ts","sourceRoot":"","sources":["../../../../navigation/region/NavigationRegionClassNames.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,0BAA0B;IAEvC,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,MAAM,CAAC;IAGb,KAAK,EAAE,MAAM,CAAC;IAGd,MAAM,EAAE,MAAM,CAAC;IAGf,OAAO,EAAE,MAAM,CAAC;CACnB;AAGD,eAAO,MAAM,iCAAiC,EAAE,0BAS/C,CAAC"}

package/dist/esm/navigation/region/NavigationRegionClassNames.js

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The class names a {@link NavigationRegionView} puts on its nodes. The renderer carries no look of its own: a package
+ * gives the nodes its vocabulary (`blueprint.default` uses its `layout-menu` classes) and a stylesheet does the rest.
+ * State is always on data attributes as well - `data-active`, `data-expanded`, `data-read-only`, `data-origin`.
+ */ /** The class names used when a host passes none. */ const defaultNavigationRegionClassNames = {
+    root: 'scene-nav',
+    list: 'scene-nav-list',
+    item: 'scene-nav-item',
+    link: 'scene-nav-link',
+    icon: 'scene-nav-icon',
+    label: 'scene-nav-label',
+    toggle: 'scene-nav-toggle',
+    submenu: 'scene-nav-submenu'
+};
+
+export { defaultNavigationRegionClassNames };
+//# sourceMappingURL=NavigationRegionClassNames.js.map

package/dist/esm/navigation/region/NavigationRegionClassNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationRegionClassNames.js","sources":["../../../../navigation/region/NavigationRegionClassNames.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/**\n * The class names a {@link NavigationRegionView} puts on its nodes. The renderer carries no look of its own: a package\n * gives the nodes its vocabulary (`blueprint.default` uses its `layout-menu` classes) and a stylesheet does the rest.\n * State is always on data attributes as well - `data-active`, `data-expanded`, `data-read-only`, `data-origin`.\n */\nexport interface NavigationRegionClassNames {\n    /** The `nav` landmark. */\n    root: string;\n\n    /** Each list of items. */\n    list: string;\n\n    /** Each item's `li`. */\n    item: string;\n\n    /** The link of an item. */\n    link: string;\n\n    /** The icon of an item. */\n    icon: string;\n\n    /** The title of an item. */\n    label: string;\n\n    /** The button that expands or collapses an item's sub-items. */\n    toggle: string;\n\n    /** The list of an item's sub-items. */\n    submenu: string;\n}\n\n/** The class names used when a host passes none. */\nexport const defaultNavigationRegionClassNames: NavigationRegionClassNames = {\n    root: 'scene-nav',\n    list: 'scene-nav-list',\n    item: 'scene-nav-item',\n    link: 'scene-nav-link',\n    icon: 'scene-nav-icon',\n    label: 'scene-nav-label',\n    toggle: 'scene-nav-toggle',\n    submenu: 'scene-nav-submenu',\n};\n"],"names":["defaultNavigationRegionClassNames","root","list","item","link","icon","label","toggle","submenu"],"mappings":"AAAA;AACA;AAGA;;;;AAIC,yDA4BM,MAAMA,iCAAAA,GAAgE;IACzEC,IAAAA,EAAM,WAAA;IACNC,IAAAA,EAAM,gBAAA;IACNC,IAAAA,EAAM,gBAAA;IACNC,IAAAA,EAAM,gBAAA;IACNC,IAAAA,EAAM,gBAAA;IACNC,KAAAA,EAAO,iBAAA;IACPC,MAAAA,EAAQ,kBAAA;IACRC,OAAAA,EAAS;AACb;;"}

package/dist/esm/navigation/region/NavigationRegionView.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from 'react';
+import { DestinationReference, NavigationRegionKind } from '@cratis/scene.model';
+import { EffectiveNavItem } from '@cratis/scene.engine';
+import { NavigationRegionClassNames } from './NavigationRegionClassNames';
+import { SceneNavigationModel } from './SceneNavigationModel';
+export interface NavigationRegionViewProps {
+    region: NavigationRegionKind;
+    module?: string;
+    application?: boolean;
+    model?: SceneNavigationModel;
+    expand?: 'active' | 'all';
+    label?: string;
+    classNames?: Partial<NavigationRegionClassNames>;
+    renderIcon?(icon: string): ReactNode;
+    renderAdornment?(item: EffectiveNavItem): ReactNode;
+    hrefFor?(destination: DestinationReference, url: string | undefined): string | undefined;
+    onActivate?(item: EffectiveNavItem, destination: DestinationReference): void;
+}
+export declare function NavigationRegionView({ region, module, application, model: modelProp, label, expand, classNames, renderIcon, renderAdornment, hrefFor, onActivate }: NavigationRegionViewProps): import("react").JSX.Element;
+//# sourceMappingURL=NavigationRegionView.d.ts.map

package/dist/esm/navigation/region/NavigationRegionView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationRegionView.d.ts","sourceRoot":"","sources":["../../../../navigation/region/NavigationRegionView.tsx"],"names":[],"mappings":"AAGA,OAAO,EAA6B,SAAS,EAAyC,MAAM,OAAO,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAsB,MAAM,qBAAqB,CAAC;AACrG,OAAO,EAA6B,gBAAgB,EAAkD,MAAM,sBAAsB,CAAC;AAKnI,OAAO,EAAE,0BAA0B,EAAqC,MAAM,8BAA8B,CAAC;AAC7G,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAM9D,MAAM,WAAW,yBAAyB;IAEtC,MAAM,EAAE,oBAAoB,CAAC;IAM7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,WAAW,CAAC,EAAE,OAAO,CAAC;IAGtB,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAM7B,MAAM,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;IAG1B,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,UAAU,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAMjD,UAAU,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAMrC,eAAe,CAAC,CAAC,IAAI,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAGpD,OAAO,CAAC,CAAC,WAAW,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;IAGzF,UAAU,CAAC,CAAC,IAAI,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAChF;AAyBD,wBAAgB,oBAAoB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,WAAmB,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,yBAAyB,+BAkJhN"}