@cratis/scene.blueprint.default 4.12.0 → 4.13.0

package/gallery/authTemplates.ts

@@ -7,6 +7,7 @@ import { SlotName } from '../layouts';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, card, externalComponent, text } from './elements';
 import { field, formActions } from './widgets';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The six screens that stand between someone and the application: sign in, register, forgotten password,
@@ -47,6 +48,7 @@ export const loginTemplate: ScreenTemplate = {
     },
     displayName: 'Sign in',
     description: 'Email and password beside the branding panel.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Register. */
@@ -69,6 +71,7 @@ export const registerTemplate: ScreenTemplate = {
     },
     displayName: 'Register',
     description: 'Account creation with a password strength meter and the terms checkbox.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Forgotten password: ask for the address. */
@@ -88,6 +91,7 @@ export const forgotPasswordTemplate: ScreenTemplate = {
     },
     displayName: 'Forgotten password',
     description: 'One field and one button - the whole point is that it asks for nothing else.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** New password: the other end of the link. */
@@ -108,6 +112,7 @@ export const newPasswordTemplate: ScreenTemplate = {
     },
     displayName: 'New password',
     description: 'Where a reset link lands: choose it, confirm it, done.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Verification: the code from the email. */
@@ -128,6 +133,7 @@ export const verificationTemplate: ScreenTemplate = {
     },
     displayName: 'Verification',
     description: 'The code step, with the progress indicator that tells you how much is left.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Lock screen: the session is still there, the person has to prove they are. */
@@ -148,6 +154,7 @@ export const lockScreenTemplate: ScreenTemplate = {
     },
     displayName: 'Lock screen',
     description: 'One person, one password, and no way to lose what was open.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The six authentication templates. */

package/gallery/dialogTemplates.ts

@@ -5,6 +5,7 @@ import { DialogTemplate } from '@cratis/scene.model';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, card, externalComponent, panel, text } from './elements';
 import { field } from './widgets';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The three dialog shapes an application repeats: confirm something destructive, capture a short form, and
@@ -32,6 +33,7 @@ export const confirmDialogTemplate: DialogTemplate = {
     },
     displayName: 'Confirmation dialog',
     description: 'One question with the consequence spelled out, and a way back.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Form: a short capture that does not deserve a page of its own. */
@@ -51,6 +53,7 @@ export const formDialogTemplate: DialogTemplate = {
     },
     displayName: 'Form dialog',
     description: 'A handful of fields captured without leaving the page underneath.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Detail: a record shown over the list it came from. */
@@ -73,6 +76,7 @@ export const detailDialogTemplate: DialogTemplate = {
     },
     displayName: 'Detail dialog',
     description: 'A record over the list it came from, with a route to the full page.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The dialog templates this blueprint provides. */

package/gallery/nesting.ts

@@ -7,6 +7,7 @@ import { SlotName, column, slotLeaf } from '../layouts';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, externalComponent } from './elements';
 import { pageHeader } from './widgets';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * A worked three-level chain, from the application layout down to a slice.
@@ -36,6 +37,7 @@ export const moduleWorkspaceTemplate: ScreenTemplate = {
     },
     displayName: 'Module workspace',
     description: 'Module level: fits the application layout content slot and offers a body for one feature.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /**
@@ -56,6 +58,7 @@ export const featureSectionTemplate: ScreenTemplate = {
     },
     displayName: 'Feature section',
     description: 'Feature level: fits a module workspace body slot and brings the action toolbar.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /**
@@ -76,6 +79,7 @@ export const sliceSectionTemplate: ScreenTemplate = {
     },
     displayName: 'Slice section',
     description: 'Slice level: fits a feature section body slot and hosts one behavior.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The chain, outermost first - what a spec walks to prove `fitsSlot` resolves at every level. */

package/gallery/statusTemplates.ts

@@ -7,6 +7,7 @@ import { SlotName } from '../layouts';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, card, externalComponent, panel, text } from './elements';
 import { widget } from './widgets';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The four screens that are not part of anyone's plan: a server error, a refusal, a wrong address, and the
@@ -37,6 +38,7 @@ export const errorTemplate: ScreenTemplate = {
     },
     displayName: 'Error',
     description: 'A server-side failure, said plainly, with a way onward.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Signed in, and still not allowed. */
@@ -59,6 +61,7 @@ export const accessDeniedTemplate: ScreenTemplate = {
     },
     displayName: 'Access denied',
     description: 'A refusal that distinguishes "not signed in" from "not allowed".',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** No such address. */
@@ -79,6 +82,7 @@ export const notFoundTemplate: ScreenTemplate = {
     },
     displayName: 'Not found',
     description: 'A wrong address, with a search box rather than a dead end.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The page that has to do the selling. */
@@ -112,6 +116,7 @@ export const landingTemplate: ScreenTemplate = {
     },
     displayName: 'Landing',
     description: 'The marketing front door, with its own navigation because it has no application chrome.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The four status and marketing templates. */

package/gallery/supportTemplates.ts

@@ -6,6 +6,7 @@ import { SlotName } from '../layouts';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, card, externalComponent, text } from './elements';
 import { field, formActions, pageHeader, table, widget } from './widgets';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The five shapes an application needs that are not the CRUD loop: documentation, the signed-in user's own
@@ -40,6 +41,7 @@ export const documentationTemplate: ScreenTemplate = {
     },
     displayName: 'Documentation',
     description: 'Prose with a table of contents beside it.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Profile settings: the signed-in user editing their own account. */
@@ -67,6 +69,7 @@ export const profileSettingsTemplate: ScreenTemplate = {
     },
     displayName: 'Profile settings',
     description: 'The signed-in user editing their own name, photo, password and notifications.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** User management: administering everybody else. */
@@ -99,6 +102,7 @@ export const userManagementTemplate: ScreenTemplate = {
     },
     displayName: 'User management',
     description: 'The people table, with roles, status and an invitation action.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Invoice: a printable document, which is a different shape from a screen. */
@@ -135,6 +139,7 @@ export const invoiceTemplate: ScreenTemplate = {
     },
     displayName: 'Invoice',
     description: 'A printable document: parties, line items and totals.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** Help: the answers, and a way to ask when they are not there. */
@@ -158,6 +163,7 @@ export const helpTemplate: ScreenTemplate = {
     },
     displayName: 'Help',
     description: 'Searchable answers with a route to a human.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The five support templates. */

package/gallery/workspaceTemplates.ts

@@ -6,6 +6,7 @@ import { SlotName, column, grid, slotLeaf } from '../layouts';
 import { TemplateSlotName } from './TemplateSlotName';
 import { button, card, externalComponent, text } from './elements';
 import { emptyState, field, formActions, pageHeader, statCard, table, widget } from './widgets';
+import { defaultBlueprintTemplateProvenance, sakaiCompositionProvenance } from '../templateProvenance';
 
 /**
  * The five workhorse shapes inside an application shell: a dashboard, a list, a detail, a form and the
@@ -88,6 +89,7 @@ export const dashboardTemplate: ScreenTemplate = {
     },
     displayName: 'Dashboard',
     description: 'Four stat cards over two columns of widgets - the composition every template line opens with.',
+    metadata: { ...sakaiCompositionProvenance },
 };
 
 /** The list: a filter toolbar, a real table, and the row actions a list needs. */
@@ -125,6 +127,7 @@ export const crudListTemplate: ScreenTemplate = {
     },
     displayName: 'List',
     description: 'A searchable table with a header, primary action and row data.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The detail: a summary panel beside the record's own sections. */
@@ -155,6 +158,7 @@ export const detailViewTemplate: ScreenTemplate = {
     },
     displayName: 'Detail',
     description: 'One record: a header with actions, its sections, and a summary panel.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The form: fields, grouped, with the actions that close them. */
@@ -178,6 +182,7 @@ export const formPageTemplate: ScreenTemplate = {
     },
     displayName: 'Form',
     description: 'A grouped form with the field types an application actually uses.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The empty state: what a list looks like before anything exists, designed rather than apologized for. */
@@ -192,6 +197,7 @@ export const emptyTemplate: ScreenTemplate = {
     },
     displayName: 'Empty state',
     description: 'The designed empty state for a list that has nothing in it yet.',
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };
 
 /** The five workspace templates. */

package/index.ts

@@ -10,3 +10,4 @@ export * from './shell';
 export * from './themes';
 export * from './defaultBlueprintComponents';
 export * from './defaultBlueprint';
+export * from './templateProvenance';

package/layouts/appShell.ts

@@ -5,6 +5,7 @@ import { FlowArrangement, HeightSizeClass, Layout, WidthSizeClass } from '@crati
 import { LayoutName } from './LayoutName';
 import { SlotName } from './SlotName';
 import { column, row, slotLeaf } from './flowBuilders';
+import { sakaiCompositionProvenance } from '../templateProvenance';
 
 /**
  * The tree at a regular width and height: a topbar across the top, the sidebar column beside the main
@@ -103,4 +104,5 @@ export const appShellLayout: Layout = {
         { name: SlotName.ConfigPanel },
     ],
     arrangement: appShellArrangement,
+    metadata: { ...sakaiCompositionProvenance },
 };

package/layouts/fullPage.ts

@@ -5,6 +5,7 @@ import { FlowArrangement, Layout, WidthSizeClass } from '@cratis/scene.model';
 import { LayoutName } from './LayoutName';
 import { SlotName } from './SlotName';
 import { column, row, slotLeaf } from './flowBuilders';
+import { defaultBlueprintTemplateProvenance } from '../templateProvenance';
 
 /**
  * The tree at a regular width: the branding aside beside the content, with the configurator over both.
@@ -45,4 +46,5 @@ export const fullPageLayout: Layout = {
     name: LayoutName.FullPage,
     slots: [{ name: SlotName.Aside }, { name: SlotName.Content }, { name: SlotName.ConfigPanel }],
     arrangement: fullPageArrangement,
+    metadata: { ...defaultBlueprintTemplateProvenance },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.blueprint.default",
-    "version": "4.12.0",
+    "version": "4.13.0",
     "description": "The default blueprint: application shell layouts, the screen and dialog templates that go inside them, the components that fill their slots, and two themes.",
     "keywords": [
         "cratis",
@@ -54,14 +54,14 @@
         "build-storybook": "storybook build"
     },
     "dependencies": {
-        "@cratis/scene.engine": "4.12.0",
-        "@cratis/scene.model": "4.12.0",
-        "@cratis/scene.react": "4.12.0"
+        "@cratis/scene.engine": "4.13.0",
+        "@cratis/scene.model": "4.13.0",
+        "@cratis/scene.react": "4.13.0"
     },
     "devDependencies": {
-        "@cratis/scene.engine": "4.12.0",
-        "@cratis/scene.model": "4.12.0",
-        "@cratis/scene.react": "4.12.0",
+        "@cratis/scene.engine": "4.13.0",
+        "@cratis/scene.model": "4.13.0",
+        "@cratis/scene.react": "4.13.0",
         "@primereact/core": "11.2.0",
         "@primereact/headless": "11.2.0",
         "@primeuix/themes": "^3.0.1",

package/templateProvenance.ts

@@ -0,0 +1,37 @@
+// 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, and against the
+ * PrimeReact and Cratis Components packages this blueprint depends on - the same dependencies its manifest
+ * declares, with the ranges the templates were verified against. `describeTemplateCatalog` checks every
+ * template against them, and this package's specs prove each one comes out compatible.
+ */
+export const defaultBlueprintTemplateProvenance: Pick<TemplateMetadata, 'compatibility' | 'attribution' | 'license' | 'licenseUrl'> = {
+    compatibility: {
+        scene: '^4.13.0',
+        packages: [
+            { name: 'PrimeReact', versionRange: '^11.0.0' },
+            { name: 'Cratis.Components', versionRange: '^3.0.0' },
+        ],
+    },
+    attribution: { author: 'Cratis', url: 'https://github.com/Cratis/Scene/tree/main/Source/JavaScript/blueprint.default' },
+    license: 'MIT',
+    licenseUrl: 'https://github.com/Cratis/Scene/blob/main/LICENSE',
+};
+
+/**
+ * The provenance of the shell and the dashboard, whose arrangement follows PrimeTek's free Sakai template.
+ * The arrangement is followed; no Sakai source or asset is part of this package.
+ */
+export const sakaiCompositionProvenance: Pick<TemplateMetadata, 'compatibility' | 'attribution' | 'license' | 'licenseUrl'> = {
+    ...defaultBlueprintTemplateProvenance,
+    attribution: {
+        ...defaultBlueprintTemplateProvenance.attribution!,
+        notice: "Arrangement follows PrimeTek's Sakai React template (https://github.com/primefaces/sakai-react, MIT).",
+    },
+};