@cratis/scene.model 4.22.1 → 4.24.0

package/editing/DiagnosticCode.ts

@@ -63,4 +63,10 @@ export enum DiagnosticCode {
     IncompatibleIconLibrary = 'incompatibleIconLibrary',
     IconCatalogUnavailable = 'iconCatalogUnavailable',
     IconNotVerified = 'iconNotVerified',
+
+    // Component metadata
+    ComponentCategoryMissing = 'componentCategoryMissing',
+    ComponentCategoryUnknown = 'componentCategoryUnknown',
+    ComponentDesignModeInvalid = 'componentDesignModeInvalid',
+    PropertyEditorOptionsInvalid = 'propertyEditorOptionsInvalid',
 }

package/index.ts

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

package/package.json

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

package/structure/ApplicationStructure.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 { ModuleNode } from './ModuleNode';
+
+/**
+ * A read-only description of which modules, features and slices an application has, and what kind each slice is.
+ *
+ * It is a reference input supplied by the host (Stage's converter, Studio); it is not persisted in a scene document.
+ * Ids are the dotted qualified ids already used by `DestinationReference`, for example `sales.orders.PlaceOrder`.
+ */
+export interface ApplicationStructure {
+    /** The modules of the application, in declaration order. */
+    modules: ModuleNode[];
+}
+
+export const ApplicationStructurePropertyNames: (keyof ApplicationStructure)[] = ['modules'];

package/structure/FeatureNode.ts

@@ -0,0 +1,23 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { SliceNode } from './SliceNode';
+
+/**
+ * A feature in the application hierarchy; features nest.
+ */
+export interface FeatureNode {
+    /** The feature identity, unique among its siblings; its qualified form is the dotted path from the module. */
+    id: string;
+
+    /** The display name. */
+    name: string;
+
+    /** The sub-features. */
+    features: FeatureNode[];
+
+    /** The slices that belong directly to this feature. */
+    slices: SliceNode[];
+}
+
+export const FeatureNodePropertyNames: (keyof FeatureNode)[] = ['id', 'name', 'features', 'slices'];

package/structure/ModuleNode.ts

@@ -0,0 +1,24 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { FeatureNode } from './FeatureNode';
+import { SliceNode } from './SliceNode';
+
+/**
+ * A module in the application hierarchy.
+ */
+export interface ModuleNode {
+    /** The module identity, unique in the application; the first segment of every qualified id below it. */
+    id: string;
+
+    /** The display name. */
+    name: string;
+
+    /** The module's top-level features, first feature first. */
+    features: FeatureNode[];
+
+    /** The slices that belong directly to the module, when it has any. */
+    slices?: SliceNode[];
+}
+
+export const ModuleNodePropertyNames: (keyof ModuleNode)[] = ['id', 'name', 'features', 'slices'];

package/structure/SliceKind.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.
+
+/**
+ * What kind of event-model slice a slice node is.
+ */
+export enum SliceKind {
+    /** A slice that accepts a command - user input that changes state. */
+    StateChange = 'StateChange',
+
+    /** A slice that projects state into a read model for display. */
+    StateView = 'StateView',
+
+    /** A slice that reacts to events without user input. */
+    Automation = 'Automation',
+}

package/structure/SliceNode.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { SliceKind } from './SliceKind';
+
+/**
+ * A slice in the application hierarchy.
+ */
+export interface SliceNode {
+    /** The slice identity, unique among the siblings of its feature or module; its qualified form is `module.feature.Slice`. */
+    id: string;
+
+    /** The display name. */
+    name: string;
+
+    /** Whether the slice is a state change, a state view or an automation. */
+    kind: SliceKind;
+}
+
+export const SliceNodePropertyNames: (keyof SliceNode)[] = ['id', 'name', 'kind'];

package/structure/index.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './SliceKind';
+export * from './SliceNode';
+export * from './FeatureNode';
+export * from './ModuleNode';
+export * from './ApplicationStructure';