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

package/vendorsQueries.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 vendors 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 VendorsQuery = {
+    /** One row: the `locale` and `currency` the figures and dates are formatted in. */
+    Settings: 'VendorsSettings',
+    OnboardingColumns: 'OnboardingColumns',
+    OnboardingCards: 'OnboardingCards',
+    Kpis: 'VendorsKpis',
+    SpendByCategory: 'VendorsSpendByCategory',
+    OnTimeDelivery: 'VendorsOnTimeDelivery',
+    Activity: 'VendorsActivity',
+    FormErrors: 'VendorsFormErrors',
+} as const;
+
+/** The entities a template is made for. */
+export enum VendorsEntityKind {
+    Vendor = 'Vendor',
+}
+
+/** The read model (and so the shape) the records of each entity are queried from. */
+export const vendorsEntityPlural: Record<VendorsEntityKind, string> = {
+    [VendorsEntityKind.Vendor]: 'Vendors',
+};
+
+/**
+ * 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 vendorsQueriesOf = (entity: VendorsEntityKind) => ({
+    rows: vendorsEntityPlural[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(VendorsQuery.Settings, '0.locale') };
+export const currencyOfData = { ...localeOfData, currency: fromQuery(VendorsQuery.Settings, '0.currency') };

package/vendorsScreenSet.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 (`vendors.list.record` would be the `record` feature of `list`). */
+export interface VendorsScreenDefinition 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 vendorsScreenDefinitions: VendorsScreenDefinition[] = [
+    { name: 'vendors.list', title: 'Vendors', template: 'VendorsList', order: 0, description: 'Every vendor with what you spend with them and how they perform.' },
+    { name: 'vendors.record', title: 'Vendor', template: 'VendorPage', parent: 'vendors.list', description: 'One vendor: key facts, contacts, purchase orders, certificates and activity.' },
+    { name: 'vendors.onboarding', title: 'Onboarding', template: 'VendorsOnboardingBoard', order: 1, description: 'Vendors in a column for each onboarding step: prospect, in review, approved and active.' },
+    { name: 'vendors.performance', title: 'Performance', template: 'VendorsPerformance', order: 2, description: 'How vendors perform: spend, on-time delivery and the vendors to watch.' },
+];