@cratis/scene.blueprint.contracts 0.0.0-stage → 4.78.3

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# Cratis Scene
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Cratis Scene is an experimental UI model and runtime for developers building platform-independent,
+Screenplay-based user interfaces.
+
+**Describing a user interface without describing a platform** — Scene is the UI model of the Cratis
+model-first layer (experimental).
+
+The object model and runtime for Screenplay-based UIs: `Scene.Model` (platform-agnostic screens, layouts,
+forms, contribution points, ui profiles and themes), `Scene.Engine` (binding/resolution runtime), and
+`Scene.React` (the React renderer).
+
+## Packages / Deployables
+
+[![Nuget](https://img.shields.io/nuget/v/Cratis.Scene.Model?logo=nuget)](http://nuget.org/packages/Cratis.Scene.Model)
+[![NPM](https://img.shields.io/npm/v/@cratis/scene.model?label=@cratis/scene.model&logo=npm)](https://www.npmjs.com/package/@cratis/scene.model)
+[![NPM](https://img.shields.io/npm/v/@cratis/scene.engine?label=@cratis/scene.engine&logo=npm)](https://www.npmjs.com/package/@cratis/scene.engine)
+[![NPM](https://img.shields.io/npm/v/@cratis/scene.react?label=@cratis/scene.react&logo=npm)](https://www.npmjs.com/package/@cratis/scene.react)
+
+## Builds
+
+[![.NET Build](https://github.com/cratis/scene/actions/workflows/dotnet-build.yml/badge.svg)](https://github.com/cratis/scene/actions/workflows/dotnet-build.yml)
+[![JavaScript Build](https://github.com/cratis/scene/actions/workflows/javascript-build.yml/badge.svg)](https://github.com/cratis/scene/actions/workflows/javascript-build.yml)
+
+## Description
+
+Scene owns the *object model and runtime* half of the Screenplay stack. In the model-first pipeline,
+[Screenplay](https://github.com/Cratis/Screenplay) describes an event-sourced, CQRS system,
+[Stage](https://github.com/Cratis/Stage) renders it into a running application, and Scene is how that
+application's user interface is described — independently of any rendering platform.
+
+`Scene.Model` is the platform-agnostic
+C# object model that [Stage](https://github.com/Cratis/Stage) translates Screenplay's parsed language constructs into, and that [Studio](https://github.com/Cratis/Studio)'s
+design-time tooling reads and writes. `Scene.Engine` walks that graph, resolves bindings (data, action, form,
+navigation contribution) and drives whichever renderer is plugged in — it does not know React exists.
+`Scene.React` is one renderer implementing the abstract vocabulary against real React/DOM; sibling positions
+are reserved for future `Scene.Native` / `Scene.Desktop` renderers. Vendor and internal component packages
+(PrimeReact, internal widget libraries) are adapters plugging into the renderer contract, not part of it.
+
+The design-time editor built on top of this object model lives in Studio, not here — see
+[StudioIssues#156](https://github.com/Cratis/StudioIssues/issues/156).
+
+## Support
+
+Cratis is an open community, and we are glad to help users, teams evaluating the stack, and contributors.
+
+| Channel | Details |
+|---|---|
+| Discord | Join the community on [Discord](https://discord.gg/kt4AMpV8WV) for questions and discussions |
+| GitHub Issues | [Report bugs or request features](https://github.com/Cratis/Scene/issues) |
+| Documentation | Read the docs at [cratis.io](https://www.cratis.io) |
+
+## The Cratis ecosystem
+
+This project is part of [Cratis](https://www.cratis.io) — free, MIT-licensed tools for building event-sourced and CQRS applications.
+
+- **[Chronicle](https://github.com/Cratis/Chronicle)** — event-sourcing database and runtime. Orleans-based kernel, pluggable storage (MongoDB default; PostgreSQL, SQL Server, SQLite, in-memory), language-agnostic gRPC contracts. [Docs](https://www.cratis.io/chronicle/)
+- **Chronicle clients** — first-class [.NET SDK](https://github.com/Cratis/Chronicle), plus [TypeScript](https://github.com/Cratis/Chronicle.TypeScript), [Kotlin/Java](https://github.com/Cratis/Chronicle.Kotlin), and [Elixir](https://github.com/Cratis/Chronicle.Elixir); [Python](https://github.com/Cratis/Chronicle.Python) coming soon (pre-alpha). AI agents connect through the [Chronicle MCP server](https://github.com/Cratis/Chronicle.Mcp).
+- **[Arc](https://github.com/Cratis/Arc)** — opinionated CQRS framework for ASP.NET Core with commands, queries, validation, authorization, and TypeScript proxy generation. Works without event sourcing. [Docs](https://www.cratis.io/arc/)
+- **[Components](https://github.com/Cratis/Components)** — React components aligned with Arc patterns. [Docs](https://www.cratis.io/components/)
+- **[CLI](https://github.com/Cratis/cli) + Workbench** — inspect and diagnose Chronicle from the terminal or the browser. [Docs](https://www.cratis.io/cli/)
+- **Model-first layer (experimental)** — [Studio](https://github.com/Cratis/Studio), [Screenplay](https://github.com/Cratis/Screenplay), [Stage](https://github.com/Cratis/Stage), Scene (this repository), [Prologue](https://github.com/Cratis/Prologue)
+- **Supporting** — [Fundamentals](https://github.com/Cratis/Fundamentals), [Specifications](https://github.com/Cratis/Specifications), [Synopsis](https://github.com/Cratis/Synopsis), [Lens](https://github.com/Cratis/Lens), [Narrator](https://github.com/Cratis/Narrator), and free [AI tooling](https://github.com/Cratis/AI) (preview); [Ensemble](https://github.com/Cratis/Ensemble) coming soon (pre-release)
+- **[Samples](https://github.com/Cratis/Samples)** — runnable event sourcing and CQRS samples for the whole stack
+
+Everything Cratis publishes today is MIT licensed and free to use.
+
+---
+
+Part of the [Cratis](https://www.cratis.io) platform · [MIT](./LICENSE)

package/blueprint.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ScenePackageBundle } from '@cratis/scene.react';
+import { contractsBlueprintManifest } from './manifest';
+import { contractsScreens } from './screens';
+import { contractsDialogTemplates, contractsScreenTemplates } from './templates';
+
+/** This blueprint as a loadable bundle: the manifest names things, this provides them. It provides no component - every component is the foundation's. */
+export const contractsBlueprint: ScenePackageBundle = {
+    manifest: contractsBlueprintManifest,
+    components: {},
+    screenTemplates: contractsScreenTemplates,
+    dialogTemplates: contractsDialogTemplates,
+    screens: contractsScreens,
+};

package/blueprintCatalog.json

@@ -0,0 +1,107 @@
+{
+  "schema": 1,
+  "blueprints": [
+    {
+      "package": "Cratis.Blueprint.Contracts",
+      "version": "1.0.0",
+      "domain": "contracts",
+      "displayName": "Contracts",
+      "description": "Contracts for a legal or procurement team: a contract list, a contract page with its parties, obligations and amendments, a timeline of terms and an inbox for what needs review or signature.",
+      "thumbnail": "thumbnails/contracts.svg",
+      "license": "MIT",
+      "licenseUrl": "https://github.com/Cratis/Scene/blob/main/LICENSE",
+      "dependencies": [
+        {
+          "name": "Cratis.Blueprint.Default",
+          "versionRange": "^1.0.0"
+        }
+      ],
+      "screens": [
+        {
+          "name": "contracts.list",
+          "title": "Contracts",
+          "description": "Every contract with who it is with, when it ends and what it is worth.",
+          "template": "ContractsList",
+          "order": 0
+        },
+        {
+          "name": "contracts.record",
+          "title": "Contract",
+          "description": "One contract: key facts, parties, obligations, amendments and activity.",
+          "template": "ContractPage",
+          "parent": "contracts.list"
+        },
+        {
+          "name": "contracts.timeline",
+          "title": "Timeline",
+          "description": "Every live contract on a schedule, in a lane for each counterparty, with its notice dates.",
+          "template": "ContractsTimeline",
+          "order": 1
+        },
+        {
+          "name": "contracts.review",
+          "title": "Needs attention",
+          "description": "What needs your review, your signature or a renewal decision.",
+          "template": "ContractsReview",
+          "order": 2
+        }
+      ],
+      "templates": [
+        {
+          "name": "ContractsList",
+          "kind": "ScreenTemplate",
+          "displayName": "Contracts list",
+          "description": "Every contract with its counterparty, type, end date, value and status, filtered by status, type, owner and date.",
+          "type": "List",
+          "category": "Business / Contracts",
+          "thumbnail": "thumbnails/ContractsList.svg"
+        },
+        {
+          "name": "ContractPage",
+          "kind": "ScreenTemplate",
+          "displayName": "Contract page",
+          "description": "One contract: status, value, days to its end and notice period, its details, parties, obligations and amendments, and its activity.",
+          "type": "Detail",
+          "category": "Business / Contracts",
+          "thumbnail": "thumbnails/ContractPage.svg"
+        },
+        {
+          "name": "ContractsTimeline",
+          "kind": "ScreenTemplate",
+          "displayName": "Contracts timeline",
+          "description": "Every live contract as a bar from start to end in a lane for each counterparty, with how far through it is and the notice dates that matter.",
+          "type": "Timeline",
+          "category": "Business / Contracts",
+          "thumbnail": "thumbnails/ContractsTimeline.svg"
+        },
+        {
+          "name": "ContractsReview",
+          "kind": "ScreenTemplate",
+          "displayName": "Contracts review inbox",
+          "description": "What needs review, signature or a renewal decision: the queue grouped by day with unread told in words, the open message and its history.",
+          "type": "Inbox",
+          "category": "Business / Contracts",
+          "thumbnail": "thumbnails/ContractsReview.svg"
+        },
+        {
+          "name": "ContractsQuickCreateContract",
+          "kind": "DialogTemplate",
+          "displayName": "Contracts quick create contract",
+          "description": "A short form that creates one contract without leaving the page.",
+          "type": "Dialog",
+          "category": "Business / Contracts",
+          "thumbnail": "thumbnails/ContractsQuickCreateContract.svg"
+        }
+      ],
+      "sampleData": [
+        {
+          "id": "contracts-en",
+          "title": "Contracts · English",
+          "locale": "en-GB",
+          "path": "sampleData/contracts-en.json",
+          "default": true
+        }
+      ]
+    }
+  ]
+}

package/contractsApplication.ts

@@ -0,0 +1,28 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { UiProfile } from '@cratis/scene.model';
+import { ApplicationStructureIndex } from '@cratis/scene.engine';
+import { ApplicationDocument, CompositionOptions, defaultLayouts, previewProfile } from '@cratis/scene.blueprint.default';
+import { contractsNavigation, contractsStructure } from './navigation';
+import { contractsScreens } from './screens';
+import { contractsDialogTemplates, contractsScreenTemplates } from './templates';
+
+/** The id of the sample-data pack a new application starts with. */
+export const contractsDefaultSampleDataId = 'contracts-en';
+
+/**
+ * The example application of the blueprint: the foundation's layouts, the Contracts templates, the quick-create dialogs and their 4 screens, rendering against the
+ * foundation's packages with the default sample-data pack chosen. This is what a gallery previews and what the conformance fixture
+ * (`Samples/Contracts/contracts.play`) declares in Screenplay: the document, the structure and the navigation are the three things an application is made of.
+ */
+export function contractsApplication(sampleData: string = contractsDefaultSampleDataId): ApplicationDocument {
+    const profile: UiProfile = { ...previewProfile(undefined), name: 'Contracts', sampleData: { activePack: sampleData, mappings: [], bindings: [] } };
+    return { layouts: defaultLayouts, screenTemplates: contractsScreenTemplates, dialogTemplates: contractsDialogTemplates, screens: contractsScreens, uiProfiles: [profile] };
+}
+
+/** What a host composes the screens with: the application's logo, which the shell's topbar shows. */
+export const contractsComposition: CompositionOptions = { logo: contractsNavigation.application.logo };
+
+/** The structure and navigation the shell's regions show and the items' destinations resolve against. */
+export const contractsNavigationModel = () => ({ structure: new ApplicationStructureIndex(contractsStructure), navigation: contractsNavigation });

package/contractsParts.ts

@@ -0,0 +1,58 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import {
+    Behavior, BindingSourceKind, DialogTemplate, ExternalComponent, InteractionActionKind, InteractionTriggerKind, NavigateAction, OpenDialogAction, SceneElement, ScreenTemplate, TemplateMetadata, TemplateScope,
+} from '@cratis/scene.model';
+import { component, panel } from '@cratis/scene.blueprint.default';
+import { contractsTemplateProvenance } from './templateProvenance';
+
+export { component, panel };
+
+/** The category of every template of this blueprint (spec Part B 1.2: `Business / <domain>`). */
+export const contractsCategory = 'Business / Contracts';
+
+/** The package-relative thumbnail of a template. */
+export const thumbnailOf = (templateName: string): string => `thumbnails/${templateName}.svg`;
+
+/** The metadata of a screen template of this blueprint: provenance, a type from the vocabulary, the category, a thumbnail and the levels it applies at. */
+export const contractsMetadata = (name: string, type: 'Dashboard' | 'List' | 'Board' | 'Detail' | 'Form' | 'Dialog' | 'Workspace' | 'Calendar' | 'Timeline' | 'Inbox' | 'Profile' | 'Wizard', scopes: TemplateScope[]): TemplateMetadata =>
+    ({ ...contractsTemplateProvenance, type, category: contractsCategory, thumbnail: thumbnailOf(name), scopes });
+
+/** A button of the foundation: a verb, its emphasis, and the permission rule every action declares (spec Part B 1.5). */
+export const actionButton = (id: string, label: string, emphasis: 'primary' | 'secondary' | 'quiet' | 'danger', extra: Record<string, unknown> = {}, behaviors?: Behavior[]): ExternalComponent =>
+    ({ ...component(id, 'actionButton', { label, emphasis, permission: 'enabled', ...extra }), ...(behaviors ? { behaviors } : {}) });
+
+/** What pressing an element does: open the named dialog template over the page. */
+export const opensDialog = (dialogTemplate: string): Behavior[] =>
+    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.OpenDialog, dialogTemplate } as OpenDialogAction] }] }];
+
+/** What pressing an element does: go to the named screen. */
+export const goesTo = (screen: string): Behavior[] =>
+    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.Navigate, screen } as NavigateAction] }] }];
+
+/**
+ * What choosing a row of a list does: open the record page, handing it the chosen row's id. The list is single-selection, so choosing a row is
+ * opening it - the way a table of records works everywhere.
+ */
+export const opensRecordOnSelect = (listId: string, screen: string): Behavior[] => [{
+    bindings: [{
+        trigger: { kind: InteractionTriggerKind.Select },
+        actions: [{ kind: InteractionActionKind.Navigate, screen, arguments: [{ name: 'id', value: { kind: BindingSourceKind.ComponentProperty, componentId: listId, path: 'value' } }] } as NavigateAction],
+    }],
+}];
+
+/**
+ * What choosing a row of a list does: open the named dialog over the page - a side sheet with the row's detail, so the list stays where it was.
+ */
+export const opensDialogOnSelect = (dialogTemplate: string): Behavior[] =>
+    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Select }, actions: [{ kind: InteractionActionKind.OpenDialog, dialogTemplate } as OpenDialogAction] }] }];
+
+/** What a Cancel or Close control does: close the dialog it was opened from. */
+export const closesDialog = (): Behavior[] => [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.CloseDialog }] }] }];
+
+/** An element with the given behaviors attached. */
+export const withBehaviors = <T extends SceneElement>(element: T, behaviors: Behavior[]): T => ({ ...element, behaviors });
+
+export type ContractsScreenTemplate = ScreenTemplate;
+export type ContractsDialogTemplate = DialogTemplate;

package/contractsQueries.ts

@@ -0,0 +1,56 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { BindingExpression, BindingSourceKind } from '@cratis/scene.model';
+
+/**
+ * A property taken from a query result - never a value. A contracts template declares *where* its data comes from and the sample-data pack, or the real
+ * query, supplies the rows (spec SD1); `path` reaches into the result (`0.value` is the first row's `value`, an empty path is the whole result).
+ */
+export const fromQuery = (query: string, path = ''): BindingExpression => ({ kind: BindingSourceKind.QueryResult, query, path });
+
+/** The queries of the screens that are not a plain list. Each is a shape the sample-data pack supplies rows for. */
+export const ContractsQuery = {
+    /** One row: the `locale` and `currency` the figures and dates are formatted in. */
+    Settings: 'ContractsSettings',
+    ContractTimelineItems: 'ContractTimelineItems',
+    ContractTimelineColumns: 'ContractTimelineColumns',
+    ContractMessages: 'ContractMessages',
+    ContractMessageSections: 'ContractMessageSections',
+    ContractMessageValues: 'ContractMessageValues',
+    ContractMessageHistory: 'ContractMessageHistory',
+    FormErrors: 'ContractsFormErrors',
+} as const;
+
+/** The entities a template is made for. */
+export enum ContractsEntityKind {
+    Contract = 'Contract',
+}
+
+/** The read model (and so the shape) the records of each entity are queried from. */
+export const contractsEntityPlural: Record<ContractsEntityKind, string> = {
+    [ContractsEntityKind.Contract]: 'Contracts',
+};
+
+/**
+ * The queries one entity's templates bind to, named from the entity so a template never spells one out: the records, the columns and filter fields of the
+ * list, its saved views and column choices, the selection, the sections of the quick form, and what the record page shows.
+ */
+export const contractsQueriesOf = (entity: ContractsEntityKind) => ({
+    rows: contractsEntityPlural[entity],
+    columns: `${entity}Columns`,
+    filterFields: `${entity}FilterFields`,
+    views: `${entity}Views`,
+    columnChoices: `${entity}ColumnChoices`,
+    selection: `${entity}Selection`,
+    quickSections: `${entity}QuickSections`,
+    record: `${entity}Record`,
+    sections: `${entity}Sections`,
+    summary: `${entity}Summary`,
+    activity: `${entity}Activity`,
+    tabs: `${entity}Tabs`,
+});
+
+/** The locale and currency of the data, bound onto every component that formats a figure or a date. */
+export const localeOfData = { locale: fromQuery(ContractsQuery.Settings, '0.locale') };
+export const currencyOfData = { ...localeOfData, currency: fromQuery(ContractsQuery.Settings, '0.currency') };

package/contractsScreenSet.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 { BlueprintScreen } from '@cratis/scene.model';
+
+/** One ready-to-use screen: the qualified name that is also its place in the application (`contracts.list.record` would be the `record` feature of `list`). */
+export interface ContractsScreenDefinition extends BlueprintScreen {
+    template: string;
+    description: string;
+}
+
+/**
+ * The screens the blueprint brings, in navigation order. This one list is what the manifest's screen set, the `Screen` instances, the application structure
+ * and the navigation are all derived from, so they cannot disagree about which screens exist or where they sit.
+ */
+export const contractsScreenDefinitions: ContractsScreenDefinition[] = [
+    { name: 'contracts.list', title: 'Contracts', template: 'ContractsList', order: 0, description: 'Every contract with who it is with, when it ends and what it is worth.' },
+    { name: 'contracts.record', title: 'Contract', template: 'ContractPage', parent: 'contracts.list', description: 'One contract: key facts, parties, obligations, amendments and activity.' },
+    { name: 'contracts.timeline', title: 'Timeline', template: 'ContractsTimeline', order: 1, description: 'Every live contract on a schedule, in a lane for each counterparty, with its notice dates.' },
+    { name: 'contracts.review', title: 'Needs attention', template: 'ContractsReview', order: 2, description: 'What needs your review, your signature or a renewal decision.' },
+];

package/dist/cjs/blueprint.js

@@ -0,0 +1,19 @@
+'use strict';
+
+var manifest = require('./manifest.js');
+var index = require('./screens/index.js');
+var index$1 = require('./templates/index.js');
+var formTemplates = require('./templates/formTemplates.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** This blueprint as a loadable bundle: the manifest names things, this provides them. It provides no component - every component is the foundation's. */ const contractsBlueprint = {
+    manifest: manifest.contractsBlueprintManifest,
+    components: {},
+    screenTemplates: index$1.contractsScreenTemplates,
+    dialogTemplates: formTemplates.contractsDialogs,
+    screens: index.contractsScreens
+};
+
+exports.contractsBlueprint = contractsBlueprint;
+//# sourceMappingURL=blueprint.js.map

package/dist/cjs/blueprint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blueprint.js","sources":["../../blueprint.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ScenePackageBundle } from '@cratis/scene.react';\nimport { contractsBlueprintManifest } from './manifest';\nimport { contractsScreens } from './screens';\nimport { contractsDialogTemplates, contractsScreenTemplates } from './templates';\n\n/** This blueprint as a loadable bundle: the manifest names things, this provides them. It provides no component - every component is the foundation's. */\nexport const contractsBlueprint: ScenePackageBundle = {\n    manifest: contractsBlueprintManifest,\n    components: {},\n    screenTemplates: contractsScreenTemplates,\n    dialogTemplates: contractsDialogTemplates,\n    screens: contractsScreens,\n};\n"],"names":["contractsBlueprint","manifest","contractsBlueprintManifest","components","screenTemplates","contractsScreenTemplates","dialogTemplates","contractsDialogTemplates","screens","contractsScreens"],"mappings":";;;;;;;AAAA;AACA;AAOA,2JACO,MAAMA,kBAAAA,GAAyC;IAClDC,QAAAA,EAAUC,mCAAAA;AACVC,IAAAA,UAAAA,EAAY,EAAC;IACbC,eAAAA,EAAiBC,gCAAAA;IACjBC,eAAAA,EAAiBC,8BAAAA;IACjBC,OAAAA,EAASC;AACb;;"}

package/dist/cjs/contractsApplication.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var scene_engine = require('@cratis/scene.engine');
+var scene_blueprint_default = require('@cratis/scene.blueprint.default');
+var navigation = require('./navigation.js');
+var index = require('./screens/index.js');
+var index$1 = require('./templates/index.js');
+var formTemplates = require('./templates/formTemplates.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The id of the sample-data pack a new application starts with. */ const contractsDefaultSampleDataId = 'contracts-en';
+/**
+ * The example application of the blueprint: the foundation's layouts, the Contracts templates, the quick-create dialogs and their 4 screens, rendering against the
+ * foundation's packages with the default sample-data pack chosen. This is what a gallery previews and what the conformance fixture
+ * (`Samples/Contracts/contracts.play`) declares in Screenplay: the document, the structure and the navigation are the three things an application is made of.
+ */ function contractsApplication(sampleData = contractsDefaultSampleDataId) {
+    const profile = {
+        ...scene_blueprint_default.previewProfile(undefined),
+        name: 'Contracts',
+        sampleData: {
+            activePack: sampleData,
+            mappings: [],
+            bindings: []
+        }
+    };
+    return {
+        layouts: scene_blueprint_default.defaultLayouts,
+        screenTemplates: index$1.contractsScreenTemplates,
+        dialogTemplates: formTemplates.contractsDialogs,
+        screens: index.contractsScreens,
+        uiProfiles: [
+            profile
+        ]
+    };
+}
+/** What a host composes the screens with: the application's logo, which the shell's topbar shows. */ const contractsComposition = {
+    logo: navigation.contractsNavigation.application.logo
+};
+/** The structure and navigation the shell's regions show and the items' destinations resolve against. */ const contractsNavigationModel = ()=>({
+        structure: new scene_engine.ApplicationStructureIndex(navigation.contractsStructure),
+        navigation: navigation.contractsNavigation
+    });
+
+exports.contractsApplication = contractsApplication;
+exports.contractsComposition = contractsComposition;
+exports.contractsDefaultSampleDataId = contractsDefaultSampleDataId;
+exports.contractsNavigationModel = contractsNavigationModel;
+//# sourceMappingURL=contractsApplication.js.map

package/dist/cjs/contractsApplication.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractsApplication.js","sources":["../../contractsApplication.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { UiProfile } from '@cratis/scene.model';\nimport { ApplicationStructureIndex } from '@cratis/scene.engine';\nimport { ApplicationDocument, CompositionOptions, defaultLayouts, previewProfile } from '@cratis/scene.blueprint.default';\nimport { contractsNavigation, contractsStructure } from './navigation';\nimport { contractsScreens } from './screens';\nimport { contractsDialogTemplates, contractsScreenTemplates } from './templates';\n\n/** The id of the sample-data pack a new application starts with. */\nexport const contractsDefaultSampleDataId = 'contracts-en';\n\n/**\n * The example application of the blueprint: the foundation's layouts, the Contracts templates, the quick-create dialogs and their 4 screens, rendering against the\n * foundation's packages with the default sample-data pack chosen. This is what a gallery previews and what the conformance fixture\n * (`Samples/Contracts/contracts.play`) declares in Screenplay: the document, the structure and the navigation are the three things an application is made of.\n */\nexport function contractsApplication(sampleData: string = contractsDefaultSampleDataId): ApplicationDocument {\n    const profile: UiProfile = { ...previewProfile(undefined), name: 'Contracts', sampleData: { activePack: sampleData, mappings: [], bindings: [] } };\n    return { layouts: defaultLayouts, screenTemplates: contractsScreenTemplates, dialogTemplates: contractsDialogTemplates, screens: contractsScreens, uiProfiles: [profile] };\n}\n\n/** What a host composes the screens with: the application's logo, which the shell's topbar shows. */\nexport const contractsComposition: CompositionOptions = { logo: contractsNavigation.application.logo };\n\n/** The structure and navigation the shell's regions show and the items' destinations resolve against. */\nexport const contractsNavigationModel = () => ({ structure: new ApplicationStructureIndex(contractsStructure), navigation: contractsNavigation });\n"],"names":["contractsDefaultSampleDataId","contractsApplication","sampleData","profile","previewProfile","undefined","name","activePack","mappings","bindings","layouts","defaultLayouts","screenTemplates","contractsScreenTemplates","dialogTemplates","contractsDialogTemplates","screens","contractsScreens","uiProfiles","contractsComposition","logo","contractsNavigation","application","contractsNavigationModel","structure","ApplicationStructureIndex","contractsStructure","navigation"],"mappings":";;;;;;;;;AAAA;AACA;AASA,qEACO,MAAMA,4BAAAA,GAA+B;AAE5C;;;;AAIC,IACM,SAASC,oBAAAA,CAAqBC,UAAAA,GAAqBF,4BAA4B,EAAA;AAClF,IAAA,MAAMG,OAAAA,GAAqB;AAAE,QAAA,GAAGC,uCAAeC,SAAAA,CAAU;QAAEC,IAAAA,EAAM,WAAA;QAAaJ,UAAAA,EAAY;YAAEK,UAAAA,EAAYL,UAAAA;AAAYM,YAAAA,QAAAA,EAAU,EAAE;AAAEC,YAAAA,QAAAA,EAAU;AAAG;AAAE,KAAA;IACjJ,OAAO;QAAEC,OAAAA,EAASC,sCAAAA;QAAgBC,eAAAA,EAAiBC,gCAAAA;QAA0BC,eAAAA,EAAiBC,8BAAAA;QAA0BC,OAAAA,EAASC,sBAAAA;QAAkBC,UAAAA,EAAY;AAACf,YAAAA;AAAQ;AAAC,KAAA;AAC7K;AAEA,sGACO,MAAMgB,oBAAAA,GAA2C;IAAEC,IAAAA,EAAMC,8BAAAA,CAAoBC,WAAW,CAACF;AAAK;AAErG,0GACO,MAAMG,wBAAAA,GAA2B,KAAO;AAAEC,QAAAA,SAAAA,EAAW,IAAIC,sCAAAA,CAA0BC,6BAAAA,CAAAA;QAAqBC,UAAAA,EAAYN;AAAoB,KAAA;;;;;"}

package/dist/cjs/contractsParts.js

@@ -0,0 +1,151 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var scene_blueprint_default = require('@cratis/scene.blueprint.default');
+var templateProvenance = require('./templateProvenance.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The category of every template of this blueprint (spec Part B 1.2: `Business / <domain>`). */ const contractsCategory = 'Business / Contracts';
+/** The package-relative thumbnail of a template. */ const thumbnailOf = (templateName)=>`thumbnails/${templateName}.svg`;
+/** The metadata of a screen template of this blueprint: provenance, a type from the vocabulary, the category, a thumbnail and the levels it applies at. */ const contractsMetadata = (name, type, scopes)=>({
+        ...templateProvenance.contractsTemplateProvenance,
+        type,
+        category: contractsCategory,
+        thumbnail: thumbnailOf(name),
+        scopes
+    });
+/** A button of the foundation: a verb, its emphasis, and the permission rule every action declares (spec Part B 1.5). */ const actionButton = (id, label, emphasis, extra = {}, behaviors)=>({
+        ...scene_blueprint_default.component(id, 'actionButton', {
+            label,
+            emphasis,
+            permission: 'enabled',
+            ...extra
+        }),
+        ...behaviors ? {
+            behaviors
+        } : {}
+    });
+/** What pressing an element does: open the named dialog template over the page. */ const opensDialog = (dialogTemplate)=>[
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: scene_model.InteractionTriggerKind.Click
+                    },
+                    actions: [
+                        {
+                            kind: scene_model.InteractionActionKind.OpenDialog,
+                            dialogTemplate
+                        }
+                    ]
+                }
+            ]
+        }
+    ];
+/** What pressing an element does: go to the named screen. */ const goesTo = (screen)=>[
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: scene_model.InteractionTriggerKind.Click
+                    },
+                    actions: [
+                        {
+                            kind: scene_model.InteractionActionKind.Navigate,
+                            screen
+                        }
+                    ]
+                }
+            ]
+        }
+    ];
+/**
+ * What choosing a row of a list does: open the record page, handing it the chosen row's id. The list is single-selection, so choosing a row is
+ * opening it - the way a table of records works everywhere.
+ */ const opensRecordOnSelect = (listId, screen)=>[
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: scene_model.InteractionTriggerKind.Select
+                    },
+                    actions: [
+                        {
+                            kind: scene_model.InteractionActionKind.Navigate,
+                            screen,
+                            arguments: [
+                                {
+                                    name: 'id',
+                                    value: {
+                                        kind: scene_model.BindingSourceKind.ComponentProperty,
+                                        componentId: listId,
+                                        path: 'value'
+                                    }
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ]
+        }
+    ];
+/**
+ * What choosing a row of a list does: open the named dialog over the page - a side sheet with the row's detail, so the list stays where it was.
+ */ const opensDialogOnSelect = (dialogTemplate)=>[
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: scene_model.InteractionTriggerKind.Select
+                    },
+                    actions: [
+                        {
+                            kind: scene_model.InteractionActionKind.OpenDialog,
+                            dialogTemplate
+                        }
+                    ]
+                }
+            ]
+        }
+    ];
+/** What a Cancel or Close control does: close the dialog it was opened from. */ const closesDialog = ()=>[
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: scene_model.InteractionTriggerKind.Click
+                    },
+                    actions: [
+                        {
+                            kind: scene_model.InteractionActionKind.CloseDialog
+                        }
+                    ]
+                }
+            ]
+        }
+    ];
+/** An element with the given behaviors attached. */ const withBehaviors = (element, behaviors)=>({
+        ...element,
+        behaviors
+    });
+
+Object.defineProperty(exports, "component", {
+    enumerable: true,
+    get: function () { return scene_blueprint_default.component; }
+});
+Object.defineProperty(exports, "panel", {
+    enumerable: true,
+    get: function () { return scene_blueprint_default.panel; }
+});
+exports.actionButton = actionButton;
+exports.closesDialog = closesDialog;
+exports.contractsCategory = contractsCategory;
+exports.contractsMetadata = contractsMetadata;
+exports.goesTo = goesTo;
+exports.opensDialog = opensDialog;
+exports.opensDialogOnSelect = opensDialogOnSelect;
+exports.opensRecordOnSelect = opensRecordOnSelect;
+exports.thumbnailOf = thumbnailOf;
+exports.withBehaviors = withBehaviors;
+//# sourceMappingURL=contractsParts.js.map

package/dist/cjs/contractsParts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractsParts.js","sources":["../../contractsParts.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport {\n    Behavior, BindingSourceKind, DialogTemplate, ExternalComponent, InteractionActionKind, InteractionTriggerKind, NavigateAction, OpenDialogAction, SceneElement, ScreenTemplate, TemplateMetadata, TemplateScope,\n} from '@cratis/scene.model';\nimport { component, panel } from '@cratis/scene.blueprint.default';\nimport { contractsTemplateProvenance } from './templateProvenance';\n\nexport { component, panel };\n\n/** The category of every template of this blueprint (spec Part B 1.2: `Business / <domain>`). */\nexport const contractsCategory = 'Business / Contracts';\n\n/** The package-relative thumbnail of a template. */\nexport const thumbnailOf = (templateName: string): string => `thumbnails/${templateName}.svg`;\n\n/** The metadata of a screen template of this blueprint: provenance, a type from the vocabulary, the category, a thumbnail and the levels it applies at. */\nexport const contractsMetadata = (name: string, type: 'Dashboard' | 'List' | 'Board' | 'Detail' | 'Form' | 'Dialog' | 'Workspace' | 'Calendar' | 'Timeline' | 'Inbox' | 'Profile' | 'Wizard', scopes: TemplateScope[]): TemplateMetadata =>\n    ({ ...contractsTemplateProvenance, type, category: contractsCategory, thumbnail: thumbnailOf(name), scopes });\n\n/** A button of the foundation: a verb, its emphasis, and the permission rule every action declares (spec Part B 1.5). */\nexport const actionButton = (id: string, label: string, emphasis: 'primary' | 'secondary' | 'quiet' | 'danger', extra: Record<string, unknown> = {}, behaviors?: Behavior[]): ExternalComponent =>\n    ({ ...component(id, 'actionButton', { label, emphasis, permission: 'enabled', ...extra }), ...(behaviors ? { behaviors } : {}) });\n\n/** What pressing an element does: open the named dialog template over the page. */\nexport const opensDialog = (dialogTemplate: string): Behavior[] =>\n    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.OpenDialog, dialogTemplate } as OpenDialogAction] }] }];\n\n/** What pressing an element does: go to the named screen. */\nexport const goesTo = (screen: string): Behavior[] =>\n    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.Navigate, screen } as NavigateAction] }] }];\n\n/**\n * What choosing a row of a list does: open the record page, handing it the chosen row's id. The list is single-selection, so choosing a row is\n * opening it - the way a table of records works everywhere.\n */\nexport const opensRecordOnSelect = (listId: string, screen: string): Behavior[] => [{\n    bindings: [{\n        trigger: { kind: InteractionTriggerKind.Select },\n        actions: [{ kind: InteractionActionKind.Navigate, screen, arguments: [{ name: 'id', value: { kind: BindingSourceKind.ComponentProperty, componentId: listId, path: 'value' } }] } as NavigateAction],\n    }],\n}];\n\n/**\n * What choosing a row of a list does: open the named dialog over the page - a side sheet with the row's detail, so the list stays where it was.\n */\nexport const opensDialogOnSelect = (dialogTemplate: string): Behavior[] =>\n    [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Select }, actions: [{ kind: InteractionActionKind.OpenDialog, dialogTemplate } as OpenDialogAction] }] }];\n\n/** What a Cancel or Close control does: close the dialog it was opened from. */\nexport const closesDialog = (): Behavior[] => [{ bindings: [{ trigger: { kind: InteractionTriggerKind.Click }, actions: [{ kind: InteractionActionKind.CloseDialog }] }] }];\n\n/** An element with the given behaviors attached. */\nexport const withBehaviors = <T extends SceneElement>(element: T, behaviors: Behavior[]): T => ({ ...element, behaviors });\n\nexport type ContractsScreenTemplate = ScreenTemplate;\nexport type ContractsDialogTemplate = DialogTemplate;\n"],"names":["contractsCategory","thumbnailOf","templateName","contractsMetadata","name","type","scopes","contractsTemplateProvenance","category","thumbnail","actionButton","id","label","emphasis","extra","behaviors","component","permission","opensDialog","dialogTemplate","bindings","trigger","kind","InteractionTriggerKind","Click","actions","InteractionActionKind","OpenDialog","goesTo","screen","Navigate","opensRecordOnSelect","listId","Select","arguments","value","BindingSourceKind","ComponentProperty","componentId","path","opensDialogOnSelect","closesDialog","CloseDialog","withBehaviors","element"],"mappings":";;;;;;AAAA;AACA;AAUA,kGACO,MAAMA,iBAAAA,GAAoB;AAEjC,qDACO,MAAMC,WAAAA,GAAc,CAACC,YAAAA,GAAiC,CAAC,WAAW,EAAEA,YAAAA,CAAa,IAAI;AAE5F,4JACO,MAAMC,iBAAAA,GAAoB,CAACC,IAAAA,EAAcC,IAAAA,EAA8IC,UACzL;AAAE,QAAA,GAAGC,8CAA2B;AAAEF,QAAAA,IAAAA;QAAMG,QAAAA,EAAUR,iBAAAA;AAAmBS,QAAAA,SAAAA,EAAWR,WAAAA,CAAYG,IAAAA,CAAAA;AAAOE,QAAAA;AAAO,KAAA;AAE/G,0HACO,MAAMI,YAAAA,GAAe,CAACC,EAAAA,EAAYC,KAAAA,EAAeC,QAAAA,EAAwDC,KAAAA,GAAiC,EAAE,EAAEC,aAChJ;QAAE,GAAGC,iCAAAA,CAAUL,IAAI,cAAA,EAAgB;AAAEC,YAAAA,KAAAA;AAAOC,YAAAA,QAAAA;YAAUI,UAAAA,EAAY,SAAA;AAAW,YAAA,GAAGH;SAAM,CAAE;AAAE,QAAA,GAAIC,SAAAA,GAAY;AAAEA,YAAAA;AAAU,SAAA,GAAI;AAAI,KAAA;AAEnI,oFACO,MAAMG,WAAAA,GAAc,CAACC,cAAAA,GACxB;AAAC,QAAA;YAAEC,QAAAA,EAAU;AAAC,gBAAA;oBAAEC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBC;AAAM,qBAAA;oBAAGC,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBC,UAAU;AAAER,4BAAAA;AAAe;AAAsB;AAAC;AAAE;AAAC;;AAElK,8DACO,MAAMS,MAAAA,GAAS,CAACC,MAAAA,GACnB;AAAC,QAAA;YAAET,QAAAA,EAAU;AAAC,gBAAA;oBAAEC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBC;AAAM,qBAAA;oBAAGC,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBI,QAAQ;AAAED,4BAAAA;AAAO;AAAoB;AAAC;AAAE;AAAC;;AAEtJ;;;AAGC,IACM,MAAME,mBAAAA,GAAsB,CAACC,QAAgBH,MAAAA,GAA+B;AAAC,QAAA;YAChFT,QAAAA,EAAU;AAAC,gBAAA;oBACPC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBU;AAAO,qBAAA;oBAC/CR,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBI,QAAQ;AAAED,4BAAAA,MAAAA;4BAAQK,SAAAA,EAAW;AAAC,gCAAA;oCAAE9B,IAAAA,EAAM,IAAA;oCAAM+B,KAAAA,EAAO;AAAEb,wCAAAA,IAAAA,EAAMc,8BAAkBC,iBAAiB;wCAAEC,WAAAA,EAAaN,MAAAA;wCAAQO,IAAAA,EAAM;AAAQ;AAAE;AAAE;AAAC;AAAoB;AACxM;AAAE;AACN;;AAEA;;AAEC,IACM,MAAMC,mBAAAA,GAAsB,CAACrB,cAAAA,GAChC;AAAC,QAAA;YAAEC,QAAAA,EAAU;AAAC,gBAAA;oBAAEC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBU;AAAO,qBAAA;oBAAGR,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBC,UAAU;AAAER,4BAAAA;AAAe;AAAsB;AAAC;AAAE;AAAC;;AAEnK,iFACO,MAAMsB,YAAAA,GAAe,IAAkB;AAAC,QAAA;YAAErB,QAAAA,EAAU;AAAC,gBAAA;oBAAEC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBC;AAAM,qBAAA;oBAAGC,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBgB;AAAY;AAAE;AAAC;AAAE;AAAC;;AAEzK,qDACO,MAAMC,gBAAgB,CAAyBC,OAAAA,EAAY7B,aAA8B;AAAE,QAAA,GAAG6B,OAAO;AAAE7B,QAAAA;AAAU,KAAA;;;;;;;;;;;;;;;;;;;"}