@cratis/scene.blueprint.approvals 0.0.0-stage → 4.53.1

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 './approvalsQueries';
+export * from './approvalsParts';
+export * from './approvalsScreenSet';
+export * from './templates';
+export * from './screens';
+export * from './navigation';
+export * from './manifest';
+export * from './blueprint';
+export * from './approvalsApplication';

package/manifest.ts

@@ -0,0 +1,44 @@
+// 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 { approvalsBlueprintName } from './packageName';
+import { approvalsScreenDefinitions } from './approvalsScreenSet';
+import { approvalsDialogTemplates, approvalsScreenTemplates } from './templates';
+
+const description = 'Requests and approvals: an approver\'s inbox, my requests, a new-request wizard, request pages with their approval chain and the request types an organisation offers.';
+
+/**
+ * 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 approvalsBlueprintManifest: ScenePackage = {
+    name: approvalsBlueprintName,
+    version: '1.0.0',
+    kind: PackageKind.Blueprint,
+    dependencies: [{ name: 'Cratis.Blueprint.Default', versionRange: '^1.0.0' }],
+    components: [],
+    layouts: [],
+    screenTemplates: approvalsScreenTemplates.map(template => template.name),
+    dialogTemplates: approvalsDialogTemplates.map(template => template.name),
+    themes: [],
+    displayName: 'Approvals and Requests',
+    description,
+    module: '@cratis/scene.blueprint.approvals',
+    license: 'MIT',
+    licenseUrl: 'https://github.com/Cratis/Scene/blob/main/LICENSE',
+    sampleData: [
+        { id: 'approvals-general', title: 'Approvals · General', locale: 'en-GB', path: 'sampleData/approvals-general.json' },
+        { id: 'approvals-nordic', title: 'Approvals · Nordic', locale: 'nb-NO', path: 'sampleData/approvals-nordic.json' },
+    ],
+    blueprint: {
+        domain: 'approvals',
+        description,
+        thumbnail: 'thumbnails/approvals.svg',
+        screenSet: approvalsScreenDefinitions.map(({ name, title, description: screenDescription, template, parent, order }) => ({
+            name, title, description: screenDescription, template, ...(parent === undefined ? {} : { parent }), ...(order === undefined ? {} : { order }),
+        })),
+        defaultSampleData: 'approvals-general',
+    },
+};

package/navigation.ts

@@ -0,0 +1,54 @@
+// 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 { approvalsScreenDefinitions } from './approvalsScreenSet';
+
+/** The module the blueprint's screens live in, and so the first segment of every screen's qualified name. */
+export const approvalsModule = 'approvals';
+
+/**
+ * The application structure the screen set implies: one module, `approvals`, a feature for each screen and the sub-features beneath it (`approvals.requests.new`
+ * is the `new` feature of `requests`). Derived from the screen names, so a screen added to the set is part of the structure without a second edit.
+ */
+export const approvalsStructure: ApplicationStructure = (() => {
+    interface Node { id: string; name: string; features: Node[]; slices: never[] }
+    const root: Node = { id: approvalsModule, name: 'Approvals', features: [], slices: [] };
+    for (const screen of approvalsScreenDefinitions) {
+        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 four
+ * places of an approvals application: Inbox, My requests, All requests and Templates (for administrators).
+ */
+export const approvalsNavigation: NavigationModel = {
+    application: {
+        logo: { image: '', title: 'Approvals' },
+        regions: [{ region: NavigationRegionKind.Topbar, items: [{ id: 'approvals', title: 'Approvals', target: { module: approvalsModule } }] }],
+    },
+    modules: [{
+        module: approvalsModule,
+        regions: [{
+            region: NavigationRegionKind.Sidebar,
+            mode: NavigationRegionMode.Override,
+            items: [
+                { id: 'inbox', title: 'Inbox', target: { module: approvalsModule, feature: 'inbox' } },
+                { id: 'requests', title: 'My requests', target: { module: approvalsModule, feature: 'requests' } },
+                { id: 'all', title: 'All requests', target: { module: approvalsModule, feature: 'all' } },
+                { id: 'templates', title: 'Templates', target: { module: approvalsModule, feature: 'templates' } },
+            ],
+        }],
+    }],
+};

package/package.json

@@ -1,6 +1,80 @@
 {
-  "name": "@cratis/scene.blueprint.approvals",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+    "name": "@cratis/scene.blueprint.approvals",
+    "version": "4.53.1",
+    "description": "Requests and approvals: an inbox, my requests, a request wizard, request pages with their approval chain and the request types an organisation offers.",
+    "keywords": [
+        "cratis",
+        "scene",
+        "react",
+        "ui",
+        "blueprint",
+        "approvals"
+    ],
+    "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.53.1",
+        "@cratis/scene.engine": "4.53.1",
+        "@cratis/scene.model": "4.53.1",
+        "@cratis/scene.react": "4.53.1"
+    },
+    "devDependencies": {
+        "@cratis/scene.blueprint.default": "4.53.1",
+        "@cratis/scene.engine": "4.53.1",
+        "@cratis/scene.model": "4.53.1",
+        "@cratis/scene.react": "4.53.1",
+        "@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 approvalsBlueprintName = 'Cratis.Blueprint.Approvals';