@cratis/scene.model 4.26.0 → 4.27.0

package/exposure/InstanceContribution.ts

@@ -31,6 +31,13 @@ export interface InstanceContribution {
 
     /** The items a collection property gets from this instance, in order. */
     items?: ContributedItem[];
+
+    /**
+     * For a collection: hide the items the owner and the levels above put in it, so only this instance's own items
+     * remain. The hidden items stay where they are and come back when this is cleared. It needs the `replace`
+     * operation to be exposed.
+     */
+    replaceOwnerItems?: boolean;
 }
 
-export const InstanceContributionPropertyNames: (keyof InstanceContribution)[] = ['instance', 'component', 'path', 'value', 'items'];
+export const InstanceContributionPropertyNames: (keyof InstanceContribution)[] = ['instance', 'component', 'path', 'value', 'items', 'replaceOwnerItems'];

package/index.ts

@@ -19,3 +19,4 @@ export * from './descriptors';
 export * from './exposure';
 export * from './editing';
 export * from './structure';
+export * from './navigation';

package/navigation/ApplicationLogo.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * The application's logo. It is defined at the application level only; a module shows it locked.
+ */
+export interface ApplicationLogo {
+    /** The image reference. */
+    image: string;
+
+    /** The application name shown with or instead of the image. */
+    title: string;
+}
+
+export const ApplicationLogoPropertyNames: (keyof ApplicationLogo)[] = ['image', 'title'];

package/navigation/ApplicationNavigation.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ApplicationLogo } from './ApplicationLogo';
+import { NavigationRegion } from './NavigationRegion';
+
+/**
+ * The application-level navigation: the base every module inherits, extends or overrides.
+ */
+export interface ApplicationNavigation {
+    /** The regions the application defines items for. */
+    regions: NavigationRegion[];
+
+    /** The application logo. */
+    logo?: ApplicationLogo;
+}
+
+export const ApplicationNavigationPropertyNames: (keyof ApplicationNavigation)[] = ['regions', 'logo'];

package/navigation/ModuleNavigation.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { NavigationRegion } from './NavigationRegion';
+
+/**
+ * The navigation a module declares for the regions it changes. A region it does not declare inherits the application's.
+ */
+export interface ModuleNavigation {
+    /** The module identity. */
+    module: string;
+
+    /** The regions the module changes. */
+    regions: NavigationRegion[];
+}
+
+export const ModuleNavigationPropertyNames: (keyof ModuleNavigation)[] = ['module', 'regions'];

package/navigation/NavItem.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { DestinationReference } from '../common';
+
+/**
+ * One item of a navigation region.
+ */
+export interface NavItem {
+    /** The item identity, unique in its region at the level that owns it. */
+    id: string;
+
+    /** The text shown for the item. */
+    title: string;
+
+    /** Qualified icon reference, when the item has one. */
+    icon?: string;
+
+    /**
+     * What the item navigates to: `module`, and optionally `feature` (a dotted path inside the module). A module
+     * without a feature goes to the module's first feature.
+     */
+    target?: DestinationReference;
+
+    /** The rendering slot - an outlet id - the target renders into; `content`, the primary outlet, when absent. */
+    slot?: string;
+
+    /** The sub-items; only a sidebar item has them. */
+    children?: NavItem[];
+}
+
+export const NavItemPropertyNames: (keyof NavItem)[] = ['id', 'title', 'icon', 'target', 'slot', 'children'];

package/navigation/NavigationModel.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ApplicationNavigation } from './ApplicationNavigation';
+import { ModuleNavigation } from './ModuleNavigation';
+
+/**
+ * All the navigation an application declares: its own regions and the regions each module changes.
+ */
+export interface NavigationModel {
+    /** The application-level navigation. */
+    application: ApplicationNavigation;
+
+    /** The per-module navigation; a module that is not listed inherits everything. */
+    modules: ModuleNavigation[];
+}
+
+export const NavigationModelPropertyNames: (keyof NavigationModel)[] = ['application', 'modules'];

package/navigation/NavigationRegion.ts

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { NavigationRegionKind } from './NavigationRegionKind';
+import { NavigationRegionMode } from './NavigationRegionMode';
+import { NavItem } from './NavItem';
+
+/**
+ * The items one level (the application or a module) defines for one navigation region.
+ */
+export interface NavigationRegion {
+    /** Which region the items belong to. */
+    region: NavigationRegionKind;
+
+    /**
+     * How a module's items relate to the application's. Absent at the application level, which is the base, and
+     * meaning `inherit` at a module.
+     */
+    mode?: NavigationRegionMode;
+
+    /** The items, in order. */
+    items: NavItem[];
+}
+
+export const NavigationRegionPropertyNames: (keyof NavigationRegion)[] = ['region', 'mode', 'items'];

package/navigation/NavigationRegionKind.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * The navigation regions an application shell has.
+ */
+export enum NavigationRegionKind {
+    /** The flat strip along the top. */
+    Topbar = 'topbar',
+
+    /** The side list, whose items may have sub-items. */
+    Sidebar = 'sidebar',
+}

package/navigation/NavigationRegionMode.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * How a module's region relates to the application's items for the same region.
+ */
+export enum NavigationRegionMode {
+    /** Effective items are the application items; the module's own items are cleared. */
+    Inherit = 'inherit',
+
+    /** Effective items are the application items followed by the module's items. */
+    Extend = 'extend',
+
+    /** Effective items are the module's items only. */
+    Override = 'override',
+}

package/navigation/index.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './NavigationRegionKind';
+export * from './NavigationRegionMode';
+export * from './NavItem';
+export * from './NavigationRegion';
+export * from './ApplicationLogo';
+export * from './ApplicationNavigation';
+export * from './ModuleNavigation';
+export * from './NavigationModel';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.model",
-    "version": "4.26.0",
+    "version": "4.27.0",
     "description": "The TypeScript mirror of Cratis.Scene.Model — the platform-agnostic Screen object model.",
     "keywords": [
         "cratis",