@cratis/scene.model 4.56.0 → 4.58.0

package/package.json

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

package/profiles/ColorScheme.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/** Which colour scheme an application presents: always light, always dark, or following the viewer's system preference. */
+export enum ColorScheme {
+    /** Always the light variant of the theme. */
+    Light = 'Light',
+    /** Always the dark variant of the theme. */
+    Dark = 'Dark',
+    /** Follow the viewer's operating-system preference. */
+    System = 'System',
+}

package/profiles/ProfileAppearance.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 { ColorScheme } from './ColorScheme';
+
+/**
+ * How an application looks beyond the {@link UiProfile.theme} it selects: the colour scheme and the accent colour.
+ */
+export interface ProfileAppearance {
+    /** Whether the application is light, dark or follows the system. Absent leaves the theme's own default. */
+    colorScheme?: ColorScheme;
+
+    /** The accent colour as a CSS colour (for example `#4f46e5`). Absent keeps the theme's accent. */
+    accent?: string;
+}
+
+export const ProfileAppearancePropertyNames: (keyof ProfileAppearance)[] = ['colorScheme', 'accent'];

package/profiles/ProfileDefaults.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TemplateReference } from '../screens/TemplateReference';
+
+/**
+ * Application-wide authoring defaults that belong to the profile rather than to a screen.
+ */
+export interface ProfileDefaults {
+    /** The template a newly created screen starts from. Absent when new screens start without one. */
+    newScreenTemplate?: TemplateReference;
+}
+
+export const ProfileDefaultsPropertyNames: (keyof ProfileDefaults)[] = ['newScreenTemplate'];

package/profiles/RootTemplate.ts

@@ -0,0 +1,21 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TemplateReference } from '../screens/TemplateReference';
+
+/**
+ * The application's root template - its shell. The shell is either a layout or an application-scope screen template with the
+ * root role; this reference names it, pinned like any other template reference, and carries the shell's own configuration.
+ */
+export interface RootTemplate {
+    /** Which template is the shell: an own template, or a blueprint template with a version pin. */
+    template: TemplateReference;
+
+    /**
+     * The shell's own configurable items (for example `navigationMode` or `showFooter`), keyed by the shell's exposed option
+     * name. Absent when the profile leaves every option at the shell's default.
+     */
+    options?: Record<string, unknown>;
+}
+
+export const RootTemplatePropertyNames: (keyof RootTemplate)[] = ['template', 'options'];

package/profiles/UiProfile.ts

@@ -2,6 +2,9 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 import { SampleDataSelection } from '../sampleData';
+import { ProfileAppearance } from './ProfileAppearance';
+import { ProfileDefaults } from './ProfileDefaults';
+import { RootTemplate } from './RootTemplate';
 import { TargetSizeClass } from '../sizeClasses';
 
 /**
@@ -39,6 +42,7 @@ export interface UiProfile {
     /**
      * The name of the {@link Layout} this profile renders inside — the application's base navigational
      * shell, normally provided by a blueprint in `packages`. Absent when the profile does not select one.
+     * Legacy: still readable, superseded by {@link UiProfile.root}.
      */
     layout?: string;
 
@@ -55,6 +59,19 @@ export interface UiProfile {
      * part of a production build. Absent selects the blueprint's default pack, then generated data.
      */
     sampleData?: SampleDataSelection;
+
+    /**
+     * The application's root template (its shell): a template reference - own or blueprint, with a version pin - and the
+     * shell's own options. Supersedes {@link UiProfile.layout}; absent falls back to `layout` and then to the blueprint's
+     * default shell.
+     */
+    root?: RootTemplate;
+
+    /** The colour scheme and accent colour the application presents. Absent keeps the theme's defaults. */
+    appearance?: ProfileAppearance;
+
+    /** Application-wide authoring defaults such as the template new screens start from. Absent for none. */
+    defaults?: ProfileDefaults;
 }
 
 export const UiProfilePropertyNames: (keyof UiProfile)[] = [
@@ -65,4 +82,7 @@ export const UiProfilePropertyNames: (keyof UiProfile)[] = [
     'layout',
     'theme',
     'sampleData',
+    'root',
+    'appearance',
+    'defaults',
 ];

package/profiles/index.ts

@@ -3,3 +3,7 @@
 
 export * from './UiProfile';
 export * from './Theme';
+export * from './ColorScheme';
+export * from './ProfileAppearance';
+export * from './ProfileDefaults';
+export * from './RootTemplate';