@cratis/scene.model 4.6.0 → 4.8.0

package/layouts/Layout.ts

@@ -4,6 +4,7 @@
 import { Arrangement } from './Arrangement';
 import { Slot } from './Slot';
 import { Behavior } from '../interactions';
+import { TemplateMetadata } from '../screens/TemplateMetadata';
 
 /**
  * A named template of slots that a {@link Screen} fills with content. Mirrors Screenplay's `layout`
@@ -27,6 +28,9 @@ export interface Layout {
      * attached further out or further in.
      */
     behaviors?: Behavior[];
+
+    /** Optional browse metadata; ApplicationShell retains this existing Layout role. */
+    metadata?: TemplateMetadata;
 }
 
-export const LayoutPropertyNames: (keyof Layout)[] = ['name', 'slots', 'arrangement', 'behaviors'];
+export const LayoutPropertyNames: (keyof Layout)[] = ['name', 'slots', 'arrangement', 'behaviors', 'metadata'];

package/package.json

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

package/screens/DialogTemplate.ts

@@ -4,6 +4,7 @@
 import { SceneElement } from '../elements';
 import { Arrangement, Slot } from '../layouts';
 import { Behavior } from '../interactions';
+import { TemplateMetadata } from './TemplateMetadata';
 
 /**
  * A reusable dialog structure — the same idea as a {@link ScreenTemplate}, for content that opens over an
@@ -51,6 +52,9 @@ export interface DialogTemplate {
      * attached further out or further in.
      */
     behaviors?: Behavior[];
+
+    /** Optional semantic type, browse category and scope restrictions. */
+    metadata?: TemplateMetadata;
 }
 
 export const DialogTemplatePropertyNames: (keyof DialogTemplate)[] = [
@@ -61,4 +65,5 @@ export const DialogTemplatePropertyNames: (keyof DialogTemplate)[] = [
     'displayName',
     'description',
     'behaviors',
+    'metadata',
 ];

package/screens/ScreenTemplate.ts

@@ -4,6 +4,7 @@
 import { SceneElement } from '../elements';
 import { Arrangement, Slot } from '../layouts';
 import { Behavior } from '../interactions';
+import { TemplateMetadata } from './TemplateMetadata';
 
 /**
  * A reusable screen structure that fills a named slot on whatever contains it, and offers slots of its
@@ -63,6 +64,9 @@ export interface ScreenTemplate {
      * attached further out or further in.
      */
     behaviors?: Behavior[];
+
+    /** Optional semantic type, browse category and scope restrictions. */
+    metadata?: TemplateMetadata;
 }
 
 export const ScreenTemplatePropertyNames: (keyof ScreenTemplate)[] = [
@@ -74,4 +78,5 @@ export const ScreenTemplatePropertyNames: (keyof ScreenTemplate)[] = [
     'displayName',
     'description',
     'behaviors',
+    'metadata',
 ];

package/screens/TemplateMetadata.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/** The application hierarchy at which a reusable template is selected. */
+export enum TemplateScope {
+    Application = 'Application',
+    Module = 'Module',
+    Feature = 'Feature',
+    Subfeature = 'Subfeature',
+    Slice = 'Slice',
+}
+
+/**
+ * Optional semantic and browsing metadata. Type and category are open strings so packages can
+ * introduce their own vocabulary without a Scene release. Category never determines applicability.
+ */
+export interface TemplateMetadata {
+    /** Semantic role; built-in roles are ApplicationShell, Workspace, List, Detail, Form and Dialog. */
+    type?: string;
+    /** A package-defined browse category, preserved even when the host does not recognize it. */
+    category?: string;
+    /** Explicit scope restriction. Absent uses the structural role; an empty list allows no scope. */
+    scopes?: TemplateScope[];
+}
+
+export const TemplateMetadataPropertyNames: (keyof TemplateMetadata)[] = ['type', 'category', 'scopes'];

package/screens/index.ts

@@ -4,3 +4,4 @@
 export * from './Screen';
 export * from './ScreenTemplate';
 export * from './DialogTemplate';
+export * from './TemplateMetadata';