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

package/index.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.
+
+export * from './packageName';
+export * from './templateProvenance';
+export * from './contractsQueries';
+export * from './contractsParts';
+export * from './contractsScreenSet';
+export * from './templates';
+export * from './screens';
+export * from './navigation';
+export * from './manifest';
+export * from './blueprint';
+export * from './contractsApplication';

package/manifest.ts

@@ -0,0 +1,41 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { PackageKind, ScenePackage } from '@cratis/scene.model';
+import { contractsBlueprintName } from './packageName';
+import { contractsScreenDefinitions } from './contractsScreenSet';
+import { contractsDialogTemplates, contractsScreenTemplates } from './templates';
+
+const 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.';
+
+/**
+ * This blueprint's declaration. A domain blueprint depends on the foundation set (`Cratis.Blueprint.Default`) and reuses its layouts, slots,
+ * components and themes - it ships none of its own - and adds what is specific to the domain: templates, a ready-to-use screen set, sample data
+ * and thumbnails. The package `version` is the blueprint's version: it is what a template reference pins and what "update available" compares.
+ */
+export const contractsBlueprintManifest: ScenePackage = {
+    name: contractsBlueprintName,
+    version: '1.0.0',
+    kind: PackageKind.Blueprint,
+    dependencies: [{ name: 'Cratis.Blueprint.Default', versionRange: '^1.0.0' }],
+    components: [],
+    layouts: [],
+    screenTemplates: contractsScreenTemplates.map(template => template.name),
+    dialogTemplates: contractsDialogTemplates.map(template => template.name),
+    themes: [],
+    displayName: 'Contracts',
+    description,
+    module: '@cratis/scene.blueprint.contracts',
+    license: 'MIT',
+    licenseUrl: 'https://github.com/Cratis/Scene/blob/main/LICENSE',
+    sampleData: [{ id: 'contracts-en', title: 'Contracts · English', locale: 'en-GB', path: 'sampleData/contracts-en.json', description: 'English contract data: twelve contracts from draft to expired, one contract\'s parties, obligations and amendments, the terms on a timeline and the review queue.', columns: ['Contract', 'Title', 'Counterparty', 'Ends', 'Value'], statusColumn: 'Status', statuses: { good: ['Active'], pending: ['Draft', 'In review', 'Expiring'], bad: ['Expired', 'Terminated'] } }],
+    blueprint: {
+        domain: 'contracts',
+        description,
+        thumbnail: 'thumbnails/contracts.svg',
+        screenSet: contractsScreenDefinitions.map(({ name, title, description: screenDescription, template, parent, order }) => ({
+            name, title, description: screenDescription, template, ...(parent === undefined ? {} : { parent }), ...(order === undefined ? {} : { order }),
+        })),
+        defaultSampleData: 'contracts-en',
+    },
+};

package/navigation.ts

@@ -0,0 +1,53 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ApplicationStructure, NavigationModel, NavigationRegionKind, NavigationRegionMode } from '@cratis/scene.model';
+import { contractsScreenDefinitions } from './contractsScreenSet';
+
+/** The module the blueprint's screens live in, and so the first segment of every screen's qualified name. */
+export const contractsModule = 'contracts';
+
+/**
+ * The application structure the screen set implies: one module, `contracts`, a feature for each screen and the sub-features beneath it (`contracts.record` is the
+ * `record` feature of the module). Derived from the screen names, so a screen added to the set is part of the structure without a second edit.
+ */
+export const contractsStructure: ApplicationStructure = (() => {
+    interface Node { id: string; name: string; features: Node[]; slices: never[] }
+    const root: Node = { id: contractsModule, name: 'Contracts', features: [], slices: [] };
+    for (const screen of contractsScreenDefinitions) {
+        let parent = root;
+        for (const id of screen.name.split('.').slice(1)) {
+            let node = parent.features.find(candidate => candidate.id === id);
+            if (!node) {
+                node = { id, name: screen.title, features: [], slices: [] };
+                parent.features.push(node);
+            }
+            parent = node;
+        }
+    }
+
+    return { modules: [{ id: root.id, name: root.name, features: root.features }] } as unknown as ApplicationStructure;
+})();
+
+/**
+ * The navigation of the application the blueprint is: the topbar names the module, and the module's sidebar - which overrides the application's - lists
+ * the places a team goes: Contracts, Timeline, Needs attention.
+ */
+export const contractsNavigation: NavigationModel = {
+    application: {
+        logo: { image: '', title: 'Contracts' },
+        regions: [{ region: NavigationRegionKind.Topbar, items: [{ id: 'contracts', title: 'Contracts', target: { module: contractsModule } }] }],
+    },
+    modules: [{
+        module: contractsModule,
+        regions: [{
+            region: NavigationRegionKind.Sidebar,
+            mode: NavigationRegionMode.Override,
+            items: [
+                { id: 'list', title: 'Contracts', target: { module: contractsModule, feature: 'list' } },
+                { id: 'timeline', title: 'Timeline', target: { module: contractsModule, feature: 'timeline' } },
+                { id: 'review', title: 'Needs attention', target: { module: contractsModule, feature: 'review' } },
+            ],
+        }],
+    }],
+};

package/package.json

@@ -1,6 +1,80 @@
 {
-  "name": "@cratis/scene.blueprint.contracts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+    "name": "@cratis/scene.blueprint.contracts",
+    "version": "4.71.0",
+    "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.",
+    "keywords": [
+        "cratis",
+        "scene",
+        "react",
+        "ui",
+        "blueprint",
+        "contracts"
+    ],
+    "author": "Cratis",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Cratis/Scene.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist",
+        "sampleData",
+        "thumbnails",
+        "blueprintCatalog.json",
+        "**/*.ts",
+        "**/*.tsx",
+        "!**/for_*/**"
+    ],
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "dist/esm/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/esm/index.d.ts",
+            "require": "./dist/cjs/index.js",
+            "import": "./dist/esm/index.js"
+        }
+    },
+    "scripts": {
+        "prepare": "yarn g:build",
+        "clean": "yarn g:clean",
+        "build": "yarn g:build",
+        "lint": "yarn g:lint",
+        "lint:ci": "yarn g:lint:ci",
+        "test": "yarn g:test",
+        "test:browser": "yarn g:test --config ./vitest.browser.config.mts",
+        "ci": "yarn g:ci",
+        "up": "yarn g:up"
+    },
+    "dependencies": {
+        "@cratis/scene.blueprint.default": "4.71.0",
+        "@cratis/scene.engine": "4.71.0",
+        "@cratis/scene.model": "4.71.0",
+        "@cratis/scene.react": "4.71.0"
+    },
+    "devDependencies": {
+        "@cratis/scene.blueprint.default": "4.71.0",
+        "@cratis/scene.engine": "4.71.0",
+        "@cratis/scene.model": "4.71.0",
+        "@cratis/scene.react": "4.71.0",
+        "@primereact/core": "11.2.0",
+        "@primereact/headless": "11.2.0",
+        "primeicons": "8.0.2",
+        "primereact": "11.2.0",
+        "react": "^19.3.0",
+        "react-dom": "^19.3.0"
+    },
+    "peerDependencies": {
+        "@cratis/components": "^4.1.1",
+        "@primereact/core": "^11.0.0",
+        "@primereact/headless": "^11.0.0",
+        "primeicons": "^8.0.0",
+        "primereact": "^11.0.0",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0"
+    }
 }

package/packageName.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/** The name this blueprint is known by inside a `ui profile`; every component registry key is built from it. */
+export const contractsBlueprintName = 'Cratis.Blueprint.Contracts';