@cratis/scene.blueprint.inventory 0.0.0-stage → 4.50.0

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 { inventoryBlueprintManifest } from './manifest';
+import { inventoryScreens } from './screens';
+import { inventoryDialogTemplates, inventoryScreenTemplates } 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 inventoryBlueprint: ScenePackageBundle = {
+    manifest: inventoryBlueprintManifest,
+    components: {},
+    screenTemplates: inventoryScreenTemplates,
+    dialogTemplates: inventoryDialogTemplates,
+    screens: inventoryScreens,
+};

package/blueprintCatalog.json

@@ -0,0 +1,190 @@
+{
+  "schema": 1,
+  "blueprints": [
+    {
+      "package": "Cratis.Blueprint.Inventory",
+      "version": "1.0.0",
+      "domain": "inventory",
+      "displayName": "Inventory and Assets",
+      "description": "Items, locations, movements and suppliers for a warehouse: a dashboard, item lists and cards, item pages, a location tree, stock adjustment and check in and out.",
+      "thumbnail": "thumbnails/inventory.svg",
+      "license": "MIT",
+      "licenseUrl": "https://github.com/Cratis/Scene/blob/main/LICENSE",
+      "dependencies": [
+        {
+          "name": "Cratis.Blueprint.Default",
+          "versionRange": "^1.0.0"
+        }
+      ],
+      "screens": [
+        {
+          "name": "inventory.dashboard",
+          "title": "Dashboard",
+          "description": "Low stock, stock value, top movers and recent movements.",
+          "template": "InventoryDashboard",
+          "order": 0
+        },
+        {
+          "name": "inventory.items",
+          "title": "Items",
+          "description": "Every item with its stock, low stock highlighted.",
+          "template": "InventoryItemList",
+          "order": 1
+        },
+        {
+          "name": "inventory.items.gallery",
+          "title": "Item gallery",
+          "description": "Every item as a card with its picture.",
+          "template": "InventoryItemGallery",
+          "parent": "inventory.items",
+          "order": 0
+        },
+        {
+          "name": "inventory.items.record",
+          "title": "Item",
+          "description": "One item with its stock by location, movement history and supplier.",
+          "template": "InventoryItemPage",
+          "parent": "inventory.items"
+        },
+        {
+          "name": "inventory.locations",
+          "title": "Locations",
+          "description": "The location tree beside what is stored in the chosen location.",
+          "template": "InventoryLocations",
+          "order": 2
+        },
+        {
+          "name": "inventory.movements",
+          "title": "Movements",
+          "description": "Every check in, check out, transfer and adjustment.",
+          "template": "InventoryMovementList",
+          "order": 3
+        },
+        {
+          "name": "inventory.movements.check",
+          "title": "Check in or out",
+          "description": "Scan or search an item and check it in or out, from a phone.",
+          "template": "InventoryCheckInOut",
+          "parent": "inventory.movements"
+        },
+        {
+          "name": "inventory.suppliers",
+          "title": "Suppliers",
+          "description": "The suppliers items are bought from.",
+          "template": "InventorySupplierList",
+          "order": 4
+        }
+      ],
+      "templates": [
+        {
+          "name": "InventoryDashboard",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory dashboard",
+          "description": "Low stock count, stock value, top movers, recent movements and the items to reorder.",
+          "type": "Dashboard",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryDashboard.svg"
+        },
+        {
+          "name": "InventoryItemList",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory items",
+          "description": "Items with sku, category, location, quantity and status, low stock highlighted, filtered by category, location and status.",
+          "type": "List",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryItemList.svg"
+        },
+        {
+          "name": "InventoryItemGallery",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory item gallery",
+          "description": "Items as cards with a picture, sku, quantity and status, low stock highlighted.",
+          "type": "List",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryItemGallery.svg"
+        },
+        {
+          "name": "InventoryItemPage",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory item page",
+          "description": "One item: key facts, its fields and supplier, its stock by location and its movement history.",
+          "type": "Detail",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryItemPage.svg"
+        },
+        {
+          "name": "InventoryLocations",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory locations",
+          "description": "The tree of locations beside what is stored in the chosen location.",
+          "type": "Workspace",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryLocations.svg"
+        },
+        {
+          "name": "InventoryMovementList",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory movements",
+          "description": "Check ins, check outs, transfers and adjustments with the item, quantity, location and who did it.",
+          "type": "List",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryMovementList.svg"
+        },
+        {
+          "name": "InventoryCheckInOut",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory check in and out",
+          "description": "A mobile-first form to scan or search for an item and check it in or out, with who has it and when it is due back.",
+          "type": "Form",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryCheckInOut.svg"
+        },
+        {
+          "name": "InventorySupplierList",
+          "kind": "ScreenTemplate",
+          "displayName": "Inventory suppliers",
+          "description": "Suppliers with their contact, the items they supply and their status.",
+          "type": "List",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventorySupplierList.svg"
+        },
+        {
+          "name": "InventoryAdjustStock",
+          "kind": "DialogTemplate",
+          "displayName": "Inventory quick create stock adjustment",
+          "description": "A short form that adjusts the stock of one item without leaving the page.",
+          "type": "Dialog",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryAdjustStock.svg"
+        },
+        {
+          "name": "InventoryQuickCreateItem",
+          "kind": "DialogTemplate",
+          "displayName": "Inventory quick create item",
+          "description": "A short form that creates one item without leaving the page.",
+          "type": "Dialog",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryQuickCreateItem.svg"
+        },
+        {
+          "name": "InventoryQuickCreateSupplier",
+          "kind": "DialogTemplate",
+          "displayName": "Inventory quick create supplier",
+          "description": "A short form that creates one supplier without leaving the page.",
+          "type": "Dialog",
+          "category": "Business / Inventory",
+          "thumbnail": "thumbnails/InventoryQuickCreateSupplier.svg"
+        }
+      ],
+      "sampleData": [
+        {
+          "id": "inventory-warehouse",
+          "title": "Inventory · Warehouse",
+          "locale": "en-GB",
+          "path": "sampleData/inventory-warehouse.json",
+          "default": true
+        }
+      ]
+    }
+  ]
+}

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 inventoryBlueprint = {
+    manifest: manifest.inventoryBlueprintManifest,
+    components: {},
+    screenTemplates: index$1.inventoryScreenTemplates,
+    dialogTemplates: formTemplates.inventoryQuickCreateDialogs,
+    screens: index.inventoryScreens
+};
+
+exports.inventoryBlueprint = inventoryBlueprint;
+//# 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 { inventoryBlueprintManifest } from './manifest';\nimport { inventoryScreens } from './screens';\nimport { inventoryDialogTemplates, inventoryScreenTemplates } 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 inventoryBlueprint: ScenePackageBundle = {\n    manifest: inventoryBlueprintManifest,\n    components: {},\n    screenTemplates: inventoryScreenTemplates,\n    dialogTemplates: inventoryDialogTemplates,\n    screens: inventoryScreens,\n};\n"],"names":["inventoryBlueprint","manifest","inventoryBlueprintManifest","components","screenTemplates","inventoryScreenTemplates","dialogTemplates","inventoryDialogTemplates","screens","inventoryScreens"],"mappings":";;;;;;;AAAA;AACA;AAOA,2JACO,MAAMA,kBAAAA,GAAyC;IAClDC,QAAAA,EAAUC,mCAAAA;AACVC,IAAAA,UAAAA,EAAY,EAAC;IACbC,eAAAA,EAAiBC,gCAAAA;IACjBC,eAAAA,EAAiBC,yCAAAA;IACjBC,OAAAA,EAASC;AACb;;"}

package/dist/cjs/index.js

@@ -0,0 +1,72 @@
+'use strict';
+
+var packageName = require('./packageName.js');
+var templateProvenance = require('./templateProvenance.js');
+var inventoryQueries = require('./inventoryQueries.js');
+var inventoryParts = require('./inventoryParts.js');
+var inventoryScreenSet = require('./inventoryScreenSet.js');
+var index = require('./templates/index.js');
+var index$1 = require('./screens/index.js');
+var navigation = require('./navigation.js');
+var manifest = require('./manifest.js');
+var blueprint = require('./blueprint.js');
+var inventoryApplication = require('./inventoryApplication.js');
+var scene_blueprint_default = require('@cratis/scene.blueprint.default');
+var formTemplates = require('./templates/formTemplates.js');
+var dashboardTemplate = require('./templates/dashboardTemplate.js');
+var listTemplates = require('./templates/listTemplates.js');
+var recordTemplates = require('./templates/recordTemplates.js');
+var locationsTemplate = require('./templates/locationsTemplate.js');
+
+
+
+exports.inventoryBlueprintName = packageName.inventoryBlueprintName;
+exports.inventoryTemplateProvenance = templateProvenance.inventoryTemplateProvenance;
+exports.InventoryEntityKind = inventoryQueries.InventoryEntityKind;
+exports.InventoryQuery = inventoryQueries.InventoryQuery;
+exports.currencyOfData = inventoryQueries.currencyOfData;
+exports.fromQuery = inventoryQueries.fromQuery;
+exports.inventoryEntityPlural = inventoryQueries.inventoryEntityPlural;
+exports.inventoryQueriesOf = inventoryQueries.inventoryQueriesOf;
+exports.localeOfData = inventoryQueries.localeOfData;
+exports.actionButton = inventoryParts.actionButton;
+exports.closesDialog = inventoryParts.closesDialog;
+exports.goesTo = inventoryParts.goesTo;
+exports.inventoryCategory = inventoryParts.inventoryCategory;
+exports.inventoryMetadata = inventoryParts.inventoryMetadata;
+exports.opensDialog = inventoryParts.opensDialog;
+exports.opensRecordOnSelect = inventoryParts.opensRecordOnSelect;
+exports.thumbnailOf = inventoryParts.thumbnailOf;
+exports.withBehaviors = inventoryParts.withBehaviors;
+exports.inventoryScreenDefinitions = inventoryScreenSet.inventoryScreenDefinitions;
+exports.inventoryScreenTemplates = index.inventoryScreenTemplates;
+exports.inventoryScreens = index$1.inventoryScreens;
+exports.inventoryModule = navigation.inventoryModule;
+exports.inventoryNavigation = navigation.inventoryNavigation;
+exports.inventoryStructure = navigation.inventoryStructure;
+exports.inventoryBlueprintManifest = manifest.inventoryBlueprintManifest;
+exports.inventoryBlueprint = blueprint.inventoryBlueprint;
+exports.inventoryApplication = inventoryApplication.inventoryApplication;
+exports.inventoryComposition = inventoryApplication.inventoryComposition;
+exports.inventoryDefaultSampleDataId = inventoryApplication.inventoryDefaultSampleDataId;
+exports.inventoryNavigationModel = inventoryApplication.inventoryNavigationModel;
+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.inventoryCheckInOutTemplate = formTemplates.inventoryCheckInOutTemplate;
+exports.inventoryDialogTemplates = formTemplates.inventoryQuickCreateDialogs;
+exports.inventoryFormTemplates = formTemplates.inventoryFormTemplates;
+exports.inventoryQuickCreateDialogs = formTemplates.inventoryQuickCreateDialogs;
+exports.inventoryDashboardTemplate = dashboardTemplate.inventoryDashboardTemplate;
+exports.inventoryItemGalleryTemplate = listTemplates.inventoryItemGalleryTemplate;
+exports.inventoryItemListTemplate = listTemplates.inventoryItemListTemplate;
+exports.inventoryMovementListTemplate = listTemplates.inventoryMovementListTemplate;
+exports.inventorySupplierListTemplate = listTemplates.inventorySupplierListTemplate;
+exports.inventoryItemPageTemplate = recordTemplates.inventoryItemPageTemplate;
+exports.inventoryLocationsTemplate = locationsTemplate.inventoryLocationsTemplate;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/inventoryApplication.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 inventoryDefaultSampleDataId = 'inventory-warehouse';
+/**
+ * The example application of the blueprint: the foundation's layouts, the Inventory and Assets templates and quick-create dialogs and its eight 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/Inventory/inventory.play`) declares in Screenplay: the document, the structure and the navigation are the three things an application is made of.
+ */ function inventoryApplication(sampleData = inventoryDefaultSampleDataId) {
+    const profile = {
+        ...scene_blueprint_default.previewProfile(undefined),
+        name: 'Inventory and Assets',
+        sampleData: {
+            activePack: sampleData,
+            mappings: [],
+            bindings: []
+        }
+    };
+    return {
+        layouts: scene_blueprint_default.defaultLayouts,
+        screenTemplates: index$1.inventoryScreenTemplates,
+        dialogTemplates: formTemplates.inventoryQuickCreateDialogs,
+        screens: index.inventoryScreens,
+        uiProfiles: [
+            profile
+        ]
+    };
+}
+/** What a host composes the screens with: the application's logo, which the shell's topbar shows. */ const inventoryComposition = {
+    logo: navigation.inventoryNavigation.application.logo
+};
+/** The structure and navigation the shell's regions show and the items' destinations resolve against. */ const inventoryNavigationModel = ()=>({
+        structure: new scene_engine.ApplicationStructureIndex(navigation.inventoryStructure),
+        navigation: navigation.inventoryNavigation
+    });
+
+exports.inventoryApplication = inventoryApplication;
+exports.inventoryComposition = inventoryComposition;
+exports.inventoryDefaultSampleDataId = inventoryDefaultSampleDataId;
+exports.inventoryNavigationModel = inventoryNavigationModel;
+//# sourceMappingURL=inventoryApplication.js.map

package/dist/cjs/inventoryApplication.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventoryApplication.js","sources":["../../inventoryApplication.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 { inventoryNavigation, inventoryStructure } from './navigation';\nimport { inventoryScreens } from './screens';\nimport { inventoryDialogTemplates, inventoryScreenTemplates } from './templates';\n\n/** The id of the sample-data pack a new application starts with. */\nexport const inventoryDefaultSampleDataId = 'inventory-warehouse';\n\n/**\n * The example application of the blueprint: the foundation's layouts, the Inventory and Assets templates and quick-create dialogs and its eight 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/Inventory/inventory.play`) declares in Screenplay: the document, the structure and the navigation are the three things an application is made of.\n */\nexport function inventoryApplication(sampleData: string = inventoryDefaultSampleDataId): ApplicationDocument {\n    const profile: UiProfile = { ...previewProfile(undefined), name: 'Inventory and Assets', sampleData: { activePack: sampleData, mappings: [], bindings: [] } };\n    return { layouts: defaultLayouts, screenTemplates: inventoryScreenTemplates, dialogTemplates: inventoryDialogTemplates, screens: inventoryScreens, uiProfiles: [profile] };\n}\n\n/** What a host composes the screens with: the application's logo, which the shell's topbar shows. */\nexport const inventoryComposition: CompositionOptions = { logo: inventoryNavigation.application.logo };\n\n/** The structure and navigation the shell's regions show and the items' destinations resolve against. */\nexport const inventoryNavigationModel = () => ({ structure: new ApplicationStructureIndex(inventoryStructure), navigation: inventoryNavigation });\n"],"names":["inventoryDefaultSampleDataId","inventoryApplication","sampleData","profile","previewProfile","undefined","name","activePack","mappings","bindings","layouts","defaultLayouts","screenTemplates","inventoryScreenTemplates","dialogTemplates","inventoryDialogTemplates","screens","inventoryScreens","uiProfiles","inventoryComposition","logo","inventoryNavigation","application","inventoryNavigationModel","structure","ApplicationStructureIndex","inventoryStructure","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,sBAAA;QAAwBJ,UAAAA,EAAY;YAAEK,UAAAA,EAAYL,UAAAA;AAAYM,YAAAA,QAAAA,EAAU,EAAE;AAAEC,YAAAA,QAAAA,EAAU;AAAG;AAAE,KAAA;IAC5J,OAAO;QAAEC,OAAAA,EAASC,sCAAAA;QAAgBC,eAAAA,EAAiBC,gCAAAA;QAA0BC,eAAAA,EAAiBC,yCAAAA;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/inventoryParts.js

@@ -0,0 +1,131 @@
+'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 inventoryCategory = 'Business / Inventory';
+/** 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 inventoryMetadata = (name, type, scopes)=>({
+        ...templateProvenance.inventoryTemplateProvenance,
+        type,
+        category: inventoryCategory,
+        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 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.goesTo = goesTo;
+exports.inventoryCategory = inventoryCategory;
+exports.inventoryMetadata = inventoryMetadata;
+exports.opensDialog = opensDialog;
+exports.opensRecordOnSelect = opensRecordOnSelect;
+exports.thumbnailOf = thumbnailOf;
+exports.withBehaviors = withBehaviors;
+//# sourceMappingURL=inventoryParts.js.map

package/dist/cjs/inventoryParts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventoryParts.js","sources":["../../inventoryParts.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 { inventoryTemplateProvenance } 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 inventoryCategory = 'Business / Inventory';\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 inventoryMetadata = (name: string, type: 'Dashboard' | 'List' | 'Board' | 'Detail' | 'Form' | 'Dialog' | 'Workspace', scopes: TemplateScope[]): TemplateMetadata =>\n    ({ ...inventoryTemplateProvenance, type, category: inventoryCategory, 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/** 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 InventoryScreenTemplate = ScreenTemplate;\nexport type InventoryDialogTemplate = DialogTemplate;\n"],"names":["inventoryCategory","thumbnailOf","templateName","inventoryMetadata","name","type","scopes","inventoryTemplateProvenance","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","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,EAAmFC,UAC9H;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,iFACO,MAAMC,YAAAA,GAAe,IAAkB;AAAC,QAAA;YAAEpB,QAAAA,EAAU;AAAC,gBAAA;oBAAEC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,mCAAuBC;AAAM,qBAAA;oBAAGC,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,kCAAsBe;AAAY;AAAE;AAAC;AAAE;AAAC;;AAEzK,qDACO,MAAMC,gBAAgB,CAAyBC,OAAAA,EAAY5B,aAA8B;AAAE,QAAA,GAAG4B,OAAO;AAAE5B,QAAAA;AAAU,KAAA;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/inventoryQueries.js

@@ -0,0 +1,72 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * A property taken from a query result - never a value. An Inventory 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).
+ */ const fromQuery = (query, path = '')=>({
+        kind: scene_model.BindingSourceKind.QueryResult,
+        query,
+        path
+    });
+/** The queries of the dashboard, the pages and the screens that are not a plain list. Each is a shape the sample-data pack supplies rows for. */ const InventoryQuery = {
+    /** One row: the `locale` the figures and dates are formatted in and the `currency` of the amounts. */ Settings: 'InventorySettings',
+    Kpis: 'InventoryKpis',
+    TopMovers: 'InventoryTopMovers',
+    LowStock: 'InventoryLowStock',
+    RecentMovements: 'RecentMovements',
+    RecordTabs: 'InventoryRecordTabs',
+    LocationNodes: 'LocationNodes',
+    LocationContents: 'LocationContents',
+    LocationContentColumns: 'LocationContentColumns',
+    FormErrors: 'InventoryFormErrors'
+};
+/** The Inventory entities a template is made for. */ var InventoryEntityKind = /*#__PURE__*/ function(InventoryEntityKind) {
+    InventoryEntityKind["Item"] = "Item";
+    InventoryEntityKind["Movement"] = "Movement";
+    InventoryEntityKind["Supplier"] = "Supplier";
+    return InventoryEntityKind;
+}({});
+/** The plural of each entity: the read model (and so the shape) its records are queried from. */ const inventoryEntityPlural = {
+    ["Item"]: 'Items',
+    ["Movement"]: 'Movements',
+    ["Supplier"]: 'Suppliers'
+};
+/**
+ * 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 full and the quick form, and the record the page shows.
+ */ const inventoryQueriesOf = (entity)=>({
+        rows: inventoryEntityPlural[entity],
+        columns: `${entity}Columns`,
+        filterFields: `${entity}FilterFields`,
+        views: `${entity}Views`,
+        columnChoices: `${entity}ColumnChoices`,
+        selection: `${entity}Selection`,
+        sections: `${entity}Sections`,
+        quickSections: `${entity}QuickSections`,
+        record: `${entity}Record`,
+        summary: `${entity}Summary`,
+        stockByLocation: `${entity}StockByLocation`,
+        movements: `${entity}Movements`,
+        activity: `${entity}Activity`,
+        tasks: `${entity}Tasks`
+    });
+/** The locale and currency of the data, bound onto every component that formats a figure or a date. */ const localeOfData = {
+    locale: fromQuery(InventoryQuery.Settings, '0.locale')
+};
+const currencyOfData = {
+    ...localeOfData,
+    currency: fromQuery(InventoryQuery.Settings, '0.currency')
+};
+
+exports.InventoryEntityKind = InventoryEntityKind;
+exports.InventoryQuery = InventoryQuery;
+exports.currencyOfData = currencyOfData;
+exports.fromQuery = fromQuery;
+exports.inventoryEntityPlural = inventoryEntityPlural;
+exports.inventoryQueriesOf = inventoryQueriesOf;
+exports.localeOfData = localeOfData;
+//# sourceMappingURL=inventoryQueries.js.map

package/dist/cjs/inventoryQueries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventoryQueries.js","sources":["../../inventoryQueries.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 { BindingExpression, BindingSourceKind } from '@cratis/scene.model';\n\n/**\n * A property taken from a query result - never a value. An Inventory template declares *where* its data comes from and the sample-data pack, or the real\n * 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).\n */\nexport const fromQuery = (query: string, path = ''): BindingExpression => ({ kind: BindingSourceKind.QueryResult, query, path });\n\n/** The queries of the dashboard, the pages and the screens that are not a plain list. Each is a shape the sample-data pack supplies rows for. */\nexport const InventoryQuery = {\n    /** One row: the `locale` the figures and dates are formatted in and the `currency` of the amounts. */\n    Settings: 'InventorySettings',\n    Kpis: 'InventoryKpis',\n    TopMovers: 'InventoryTopMovers',\n    LowStock: 'InventoryLowStock',\n    RecentMovements: 'RecentMovements',\n    RecordTabs: 'InventoryRecordTabs',\n    LocationNodes: 'LocationNodes',\n    LocationContents: 'LocationContents',\n    LocationContentColumns: 'LocationContentColumns',\n    FormErrors: 'InventoryFormErrors',\n} as const;\n\n/** The Inventory entities a template is made for. */\nexport enum InventoryEntityKind {\n    Item = 'Item',\n    Movement = 'Movement',\n    Supplier = 'Supplier',\n}\n\n/** The plural of each entity: the read model (and so the shape) its records are queried from. */\nexport const inventoryEntityPlural: Record<InventoryEntityKind, string> = {\n    [InventoryEntityKind.Item]: 'Items',\n    [InventoryEntityKind.Movement]: 'Movements',\n    [InventoryEntityKind.Supplier]: 'Suppliers',\n};\n\n/**\n * 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\n * list, its saved views and column choices, the selection, the sections of the full and the quick form, and the record the page shows.\n */\nexport const inventoryQueriesOf = (entity: InventoryEntityKind) => ({\n    rows: inventoryEntityPlural[entity],\n    columns: `${entity}Columns`,\n    filterFields: `${entity}FilterFields`,\n    views: `${entity}Views`,\n    columnChoices: `${entity}ColumnChoices`,\n    selection: `${entity}Selection`,\n    sections: `${entity}Sections`,\n    quickSections: `${entity}QuickSections`,\n    record: `${entity}Record`,\n    summary: `${entity}Summary`,\n    stockByLocation: `${entity}StockByLocation`,\n    movements: `${entity}Movements`,\n    activity: `${entity}Activity`,\n    tasks: `${entity}Tasks`,\n});\n\n/** The locale and currency of the data, bound onto every component that formats a figure or a date. */\nexport const localeOfData = { locale: fromQuery(InventoryQuery.Settings, '0.locale') };\nexport const currencyOfData = { ...localeOfData, currency: fromQuery(InventoryQuery.Settings, '0.currency') };\n"],"names":["fromQuery","query","path","kind","BindingSourceKind","QueryResult","InventoryQuery","Settings","Kpis","TopMovers","LowStock","RecentMovements","RecordTabs","LocationNodes","LocationContents","LocationContentColumns","FormErrors","InventoryEntityKind","inventoryEntityPlural","inventoryQueriesOf","entity","rows","columns","filterFields","views","columnChoices","selection","sections","quickSections","record","summary","stockByLocation","movements","activity","tasks","localeOfData","locale","currencyOfData","currency"],"mappings":";;;;AAAA;AACA;AAIA;;;UAIaA,SAAAA,GAAY,CAACC,OAAeC,IAAAA,GAAO,EAAE,IAAyB;AAAEC,QAAAA,IAAAA,EAAMC,8BAAkBC,WAAW;AAAEJ,QAAAA,KAAAA;AAAOC,QAAAA;AAAK,KAAA;AAE9H,kJACO,MAAMI,cAAAA,GAAiB;AAC1B,2GACAC,QAAAA,EAAU,mBAAA;IACVC,IAAAA,EAAM,eAAA;IACNC,SAAAA,EAAW,oBAAA;IACXC,QAAAA,EAAU,mBAAA;IACVC,eAAAA,EAAiB,iBAAA;IACjBC,UAAAA,EAAY,qBAAA;IACZC,aAAAA,EAAe,eAAA;IACfC,gBAAAA,EAAkB,kBAAA;IAClBC,sBAAAA,EAAwB,wBAAA;IACxBC,UAAAA,EAAY;AAChB;AAEA,sDACO,IAAKC,mBAAAA,iBAAAA,SAAAA,mBAAAA,EAAAA;;;;AAAAA,IAAAA,OAAAA,mBAAAA;AAIX,CAAA,CAAA,EAAA;AAED,kGACO,MAAMC,qBAAAA,GAA6D;AACtE,IAAA,CAAA,MAAA,GAA4B,OAAA;AAC5B,IAAA,CAAA,UAAA,GAAgC,WAAA;AAChC,IAAA,CAAA,UAAA,GAAgC;AACpC;AAEA;;;AAGC,IACM,MAAMC,kBAAAA,GAAqB,CAACC,UAAiC;QAChEC,IAAAA,EAAMH,qBAAqB,CAACE,MAAAA,CAAO;QACnCE,OAAAA,EAAS,CAAA,EAAGF,MAAAA,CAAO,OAAO,CAAC;QAC3BG,YAAAA,EAAc,CAAA,EAAGH,MAAAA,CAAO,YAAY,CAAC;QACrCI,KAAAA,EAAO,CAAA,EAAGJ,MAAAA,CAAO,KAAK,CAAC;QACvBK,aAAAA,EAAe,CAAA,EAAGL,MAAAA,CAAO,aAAa,CAAC;QACvCM,SAAAA,EAAW,CAAA,EAAGN,MAAAA,CAAO,SAAS,CAAC;QAC/BO,QAAAA,EAAU,CAAA,EAAGP,MAAAA,CAAO,QAAQ,CAAC;QAC7BQ,aAAAA,EAAe,CAAA,EAAGR,MAAAA,CAAO,aAAa,CAAC;QACvCS,MAAAA,EAAQ,CAAA,EAAGT,MAAAA,CAAO,MAAM,CAAC;QACzBU,OAAAA,EAAS,CAAA,EAAGV,MAAAA,CAAO,OAAO,CAAC;QAC3BW,eAAAA,EAAiB,CAAA,EAAGX,MAAAA,CAAO,eAAe,CAAC;QAC3CY,SAAAA,EAAW,CAAA,EAAGZ,MAAAA,CAAO,SAAS,CAAC;QAC/Ba,QAAAA,EAAU,CAAA,EAAGb,MAAAA,CAAO,QAAQ,CAAC;QAC7Bc,KAAAA,EAAO,CAAA,EAAGd,MAAAA,CAAO,KAAK;AAC1B,KAAA;AAEA,wGACO,MAAMe,YAAAA,GAAe;IAAEC,MAAAA,EAAQpC,SAAAA,CAAUM,cAAAA,CAAeC,QAAQ,EAAE,UAAA;AAAY;MACxE8B,cAAAA,GAAiB;AAAE,IAAA,GAAGF,YAAY;IAAEG,QAAAA,EAAUtC,SAAAA,CAAUM,cAAAA,CAAeC,QAAQ,EAAE,YAAA;AAAc;;;;;;;;"}