@cratis/scene.blueprint.components 4.12.0 → 4.14.0

package/index.ts

@@ -10,3 +10,4 @@ export * from './templates';
 export * from './gallery';
 export * from './componentsBlueprintComponents';
 export * from './componentsBlueprint';
+export * from './templateProvenance';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.blueprint.components",
-    "version": "4.12.0",
+    "version": "4.14.0",
     "description": "A blueprint of Arc-bound screen and dialog templates: full pages built from Cratis Components composites, so a data list, a command form or a master-detail screen is a template rather than something you assemble.",
     "keywords": [
         "cratis",
@@ -52,19 +52,19 @@
     },
     "dependencies": {
         "@cratis/components": "^4.25.0",
-        "@cratis/scene.blueprint.default": "4.12.0",
-        "@cratis/scene.components": "4.12.0",
-        "@cratis/scene.engine": "4.12.0",
-        "@cratis/scene.model": "4.12.0",
-        "@cratis/scene.react": "4.12.0"
+        "@cratis/scene.blueprint.default": "4.14.0",
+        "@cratis/scene.components": "4.14.0",
+        "@cratis/scene.engine": "4.14.0",
+        "@cratis/scene.model": "4.14.0",
+        "@cratis/scene.react": "4.14.0"
     },
     "devDependencies": {
         "@cratis/components": "^4.25.0",
-        "@cratis/scene.blueprint.default": "4.12.0",
-        "@cratis/scene.components": "4.12.0",
-        "@cratis/scene.engine": "4.12.0",
-        "@cratis/scene.model": "4.12.0",
-        "@cratis/scene.react": "4.12.0",
+        "@cratis/scene.blueprint.default": "4.14.0",
+        "@cratis/scene.components": "4.14.0",
+        "@cratis/scene.engine": "4.14.0",
+        "@cratis/scene.model": "4.14.0",
+        "@cratis/scene.react": "4.14.0",
         "@primereact/core": "11.2.0",
         "@primereact/headless": "11.2.0",
         "@storybook/addon-links": "^10.6.1",

package/templateProvenance.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 { TemplateMetadata } from '@cratis/scene.model';
+
+/**
+ * The compatibility, attribution and license metadata every template this blueprint ships carries.
+ *
+ * Templates are written against the Scene model that introduced template provenance, against the default
+ * blueprint whose shell and slots they fill, and against the Cratis Components composites they are built from -
+ * the same dependencies the manifest declares. `describeTemplateCatalog` checks every template against them,
+ * and this package's specs prove each one comes out compatible.
+ */
+export const componentsBlueprintTemplateProvenance: Pick<TemplateMetadata, 'compatibility' | 'attribution' | 'license' | 'licenseUrl'> = {
+    compatibility: {
+        scene: '^4.13.0',
+        packages: [
+            { name: 'Cratis.Blueprint.Default', versionRange: '^1.0.0' },
+            { name: 'Cratis.Components', versionRange: '^3.0.0' },
+        ],
+    },
+    attribution: { author: 'Cratis', url: 'https://github.com/Cratis/Scene/tree/main/Source/JavaScript/blueprint.components' },
+    license: 'MIT',
+    licenseUrl: 'https://github.com/Cratis/Scene/blob/main/LICENSE',
+};

package/templates/commandTemplates.ts

@@ -6,6 +6,7 @@ import { SlotName, TemplateSlotName, column, slotLeaf } from '@cratis/scene.blue
 import { arcPageHeader, page, toolbar, toolbarButton, toolbarSeparator } from './elements';
 import { commandForm } from './formElements';
 import { SampleBindingName } from './SampleBindingName';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The write side: a page whose body is one command, and whose action bar submits it.
@@ -51,7 +52,7 @@ export const commandFormPageTemplate: ScreenTemplate = {
             ]),
         ],
     },
-    metadata: { type: 'Form', category: 'Business / Command', scopes: [TemplateScope.Slice] },
+    metadata: { ...componentsBlueprintTemplateProvenance, type: 'Form', category: 'Business / Command', scopes: [TemplateScope.Slice] },
     displayName: 'Command form page',
     description: 'A generated command form under a header that states the command, with its own action bar.',
 };

package/templates/dialogTemplates.ts

@@ -7,6 +7,7 @@ import { busyIndicatorDialog, commandDialog, dialog } from './dialogElements';
 import { icon } from './elements';
 import { calendarField, inputTextField, numberField, textAreaField } from './formElements';
 import { SampleBindingName } from './SampleBindingName';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The three dialog shapes an Arc application repeats: submit a command, confirm something destructive, and
@@ -53,6 +54,7 @@ export const commandDialogTemplate: DialogTemplate = {
     },
     displayName: 'Command dialog',
     description: 'A short capture whose confirm button submits the command and only closes when it succeeded.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -79,6 +81,7 @@ export const confirmDialogTemplate: DialogTemplate = {
     },
     displayName: 'Confirmation dialog',
     description: 'One question with the consequence spelled out, answered through Arc dialog context.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -99,6 +102,7 @@ export const busyDialogTemplate: DialogTemplate = {
     },
     displayName: 'Busy dialog',
     description: 'The blocking spinner shown while a long-running command is in flight, with wording chosen up front.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /** The dialog templates this blueprint provides. */

package/templates/editorTemplates.ts

@@ -6,6 +6,7 @@ import { SlotName, TemplateSlotName, column, row, slotLeaf } from '@cratis/scene
 import { filterPanel, objectContentEditor, objectNavigationalBar, schemaEditor, timeMachine } from './editorElements';
 import { arcPageHeader, errorBoundary, page, toolbar, toolbarButton, toolbarSeparator } from './elements';
 import { SampleBindingName } from './SampleBindingName';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The two inspection pages: one for a type's shape, one for an instance's content.
@@ -61,6 +62,7 @@ export const schemaEditorPageTemplate: ScreenTemplate = {
     },
     displayName: 'Schema editor page',
     description: "An event type's schema edited as a typed property tree, with the actions that evolve it.",
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -123,6 +125,7 @@ export const objectEditorPageTemplate: ScreenTemplate = {
     },
     displayName: 'Object editor page',
     description: 'One document edited against its schema, with its navigation trail and its version history.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /** The two editor-shaped templates. */

package/templates/listTemplates.ts

@@ -7,6 +7,7 @@ import { dataPage, invoiceColumns, invoiceTableOptions, observableDataTable } fr
 import { objectContentEditor, objectNavigationalBar, timeMachine } from './editorElements';
 import { arcPageHeader, page, toolbar, toolbarButton, toolbarGroup, toolbarSeparator } from './elements';
 import { SampleBindingName } from './SampleBindingName';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The three list shapes an Arc application repeats: a list, a live list, and a list with the selected
@@ -55,7 +56,7 @@ export const dataListPageTemplate: ScreenTemplate = {
         ],
         [TemplateSlotName.Body]: [dataPage('data-list-body', SampleBindingName.AllInvoices, invoiceTableOptions, invoiceColumns)],
     },
-    metadata: { type: 'List', category: 'Business / List', scopes: [TemplateScope.Slice] },
+    metadata: { ...componentsBlueprintTemplateProvenance, type: 'List', category: 'Business / List', scopes: [TemplateScope.Slice] },
     displayName: 'Data list page',
     description: 'A dataPage bound to one query, under a header that states the binding - the whole list screen in two elements.',
 };
@@ -88,7 +89,7 @@ export const observableDataListPageTemplate: ScreenTemplate = {
             ]),
         ],
     },
-    metadata: { type: 'List', category: 'Business / Live operations', scopes: [TemplateScope.Slice] },
+    metadata: { ...componentsBlueprintTemplateProvenance, type: 'List', category: 'Business / Live operations', scopes: [TemplateScope.Slice] },
     displayName: 'Observable data list page',
     description: 'A live list over an observable query, which re-renders when the read model changes on the server.',
 };
@@ -136,7 +137,7 @@ export const dataListWithDetailPageTemplate: ScreenTemplate = {
             ]),
         ],
     },
-    metadata: { type: 'Detail', category: 'Business / Master detail', scopes: [TemplateScope.Slice] },
+    metadata: { ...componentsBlueprintTemplateProvenance, type: 'Detail', category: 'Business / Master detail', scopes: [TemplateScope.Slice] },
     displayName: 'Data list with detail page',
     description: 'A dataPage beside a detail region showing the selected record document and its history.',
 };

package/templates/nesting.ts

@@ -7,6 +7,7 @@ import { invoiceColumns, invoiceTableOptions, observableDataTable } from './data
 import { filterPanel } from './editorElements';
 import { arcPageHeader, page, toolbar, toolbarButton, toolbarSeparator } from './elements';
 import { SampleBindingName } from './SampleBindingName';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * A worked three-level chain, from the application layout down to one behavior.
@@ -50,6 +51,7 @@ export const dataModulePageTemplate: ScreenTemplate = {
     },
     displayName: 'Data module page',
     description: 'Module level: fits the application layout content slot and offers a body for one feature.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -80,6 +82,7 @@ export const dataFeatureSectionTemplate: ScreenTemplate = {
     },
     displayName: 'Data feature section',
     description: 'Feature level: fits a module page body slot, brings the action toolbar and a live view.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -112,6 +115,7 @@ export const commandSliceSectionTemplate: ScreenTemplate = {
     },
     displayName: 'Command slice section',
     description: 'Slice level: fits a feature section primary slot and hosts one command behavior.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /** The chain, outermost first - what a spec walks to prove `fitsSlot` resolves at every level. */

package/templates/workspaceTemplates.ts

@@ -9,6 +9,7 @@ import { objectContentEditor, timeMachine } from './editorElements';
 import { arcPageHeader, page } from './elements';
 import { SampleBindingName } from './SampleBindingName';
 import { TableOptions } from './TableOptions';
+import { componentsBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The two whole-workspace shapes: a master-detail arrangement, and a dashboard of data widgets.
@@ -82,6 +83,7 @@ export const masterDetailPageTemplate: ScreenTemplate = {
     },
     displayName: 'Master-detail page',
     description: 'A queried list in the larger column with the selected record and its history in the narrower one.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /**
@@ -157,6 +159,7 @@ export const dashboardPageTemplate: ScreenTemplate = {
     },
     displayName: 'Dashboard page',
     description: 'A row of query-backed widgets over a wide and a narrow column, each bound to its own query.',
+    metadata: { ...componentsBlueprintTemplateProvenance },
 };
 
 /** The two workspace-shaped templates. */