@cratis/scene.model 4.23.0 → 4.25.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/package.json

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

package/screens/TemplateMetadata.ts

@@ -3,6 +3,7 @@
 
 import { TemplateAttribution } from './TemplateAttribution';
 import { TemplateCompatibility } from './TemplateCompatibility';
+import { SliceKind } from '../structure';
 
 /** The application hierarchy at which a reusable template is selected. */
 export enum TemplateScope {
@@ -14,7 +15,7 @@ export enum TemplateScope {
 }
 
 /**
- * Optional semantic and browsing metadata. Type and category are open strings so packages can
+ * Semantic and browsing metadata. Category is required for blueprint templates and recommended for own templates. Type and category are open strings so packages can
  * introduce their own vocabulary without a Scene release. Category never determines applicability.
  */
 export interface TemplateMetadata {
@@ -32,8 +33,14 @@ export interface TemplateMetadata {
     license?: string;
     /** An absolute `https` URL to the license terms. */
     licenseUrl?: string;
+    /**
+     * For a template that applies at {@link TemplateScope.Slice}, the slice kinds it applies to. Absent uses the
+     * structural default: a dialog template applies to state change slices, a screen template to every kind that
+     * presents something. Declaring slice kinds without scopes makes the default scope Slice.
+     */
+    sliceKinds?: SliceKind[];
 }
 
 export const TemplateMetadataPropertyNames: (keyof TemplateMetadata)[] = [
-    'type', 'category', 'scopes', 'compatibility', 'attribution', 'license', 'licenseUrl',
+    'type', 'category', 'scopes', 'compatibility', 'attribution', 'license', 'licenseUrl', 'sliceKinds',
 ];

package/screens/TemplateReference.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/** Where a referenced template comes from. */
+export enum TemplateReferenceSource {
+    /** A template the user created in the workspace. */
+    Own = 'Own',
+    /** A template shipped by a blueprint package, referenced by blueprint name, template name and version range. */
+    Blueprint = 'Blueprint',
+}
+
+/**
+ * How a module, feature or slice refers to the template it uses: an own template by name, or a blueprint
+ * template by blueprint, name and the version range of the blueprint it was chosen from.
+ */
+export interface TemplateReference {
+    /** Whether the template is the user's own or comes from a blueprint. */
+    source: TemplateReferenceSource;
+    /** The template's name - within the workspace for an own template, within the blueprint for a blueprint template. */
+    id: string;
+    /** The blueprint package name. Present exactly when `source` is {@link TemplateReferenceSource.Blueprint}. */
+    blueprint?: string;
+    /**
+     * The semver range of the blueprint the reference accepts, such as `^1.2.0`. Defaults to the caret range of the
+     * installed blueprint version when a reference is created; absent means any version. Only meaningful for a blueprint reference.
+     */
+    version?: string;
+}
+
+export const TemplateReferencePropertyNames: (keyof TemplateReference)[] = ['source', 'id', 'blueprint', 'version'];

package/screens/index.ts

@@ -8,3 +8,4 @@ export * from './DialogTemplate';
 export * from './TemplateAttribution';
 export * from './TemplateCompatibility';
 export * from './TemplateMetadata';
+export * from './TemplateReference';