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

package/dist/esm/templates/listTemplates.js

@@ -0,0 +1,163 @@
+import { TemplateScope, NotificationLevel, InteractionActionKind, InteractionTriggerKind } from '@cratis/scene.model';
+import { component, listScreenTemplate } from '@cratis/scene.blueprint.default';
+import { invoicingQueriesOf, localeOfData, fromQuery, InvoicingEntityKind } from '../invoicingQueries.js';
+import { withBehaviors, opensDialog, goesTo, actionButton, invoicingMetadata, opensRecordOnSelect, opensDialogOnSelect } from '../invoicingParts.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const listScopes = [
+    TemplateScope.Module,
+    TemplateScope.Feature
+];
+/** The Export button: it tells the user the export has started, which is what the shell does for a long-running action it does not wait on. */ const exportAction = (id)=>withBehaviors(actionButton(id, 'Export', 'secondary'), [
+        {
+            bindings: [
+                {
+                    trigger: {
+                        kind: InteractionTriggerKind.Click
+                    },
+                    actions: [
+                        {
+                            kind: InteractionActionKind.Notify,
+                            level: NotificationLevel.Info,
+                            message: {
+                                text: 'The export has started.'
+                            }
+                        }
+                    ]
+                }
+            ]
+        }
+    ]);
+/**
+ * One list: the foundation `ListScreen` with its header, toolbar, filters, list and bulk bar filled for an entity. The slots, arrangement and
+ * every behavior - sort, search, paging and selection in the address, the table collapsing to cards on a phone - are the foundation's.
+ */ function listTemplateOf(options) {
+    const queries = invoicingQueriesOf(options.entity);
+    const id = options.name;
+    const listId = `${id}-records`;
+    const primary = withBehaviors(actionButton(`${id}-primary`, options.primary.label, 'primary'), options.primary.dialog ? opensDialog(options.primary.dialog) : goesTo(options.primary.screen));
+    const list = component(listId, 'dataList', {
+        label: options.title,
+        rows: fromQuery(queries.rows),
+        columns: fromQuery(queries.columns),
+        titleField: options.titleField,
+        pageSize: options.cards ? 12 : 10,
+        urlKey: options.urlKey,
+        ...localeOfData,
+        rowActions: options.rowActions,
+        ...options.readOnly ? {} : {
+            selectionMode: options.recordScreen || options.recordDialog ? 'single' : 'multiple'
+        },
+        ...options.cards ? {
+            variant: 'cards',
+            ...options.cards.imageField ? {
+                imageField: options.cards.imageField
+            } : {}
+        } : {},
+        ...options.grouped ? {
+            variant: 'grouped',
+            groupBy: options.grouped.groupBy
+        } : {},
+        ...options.toneField ? {
+            toneField: options.toneField
+        } : {}
+    });
+    return {
+        name: options.name,
+        fitsSlot: 'content',
+        slots: listScreenTemplate.slots,
+        arrangement: listScreenTemplate.arrangement,
+        content: {
+            header: [
+                component(`${id}-header`, 'pageHeader', {
+                    title: options.title,
+                    subtitle: options.subtitle
+                }, {
+                    actions: [
+                        exportAction(`${id}-export`),
+                        primary
+                    ]
+                })
+            ],
+            toolbar: [
+                component(`${id}-search`, 'globalSearch', {
+                    placeholder: options.searchLabel,
+                    label: options.searchLabel,
+                    urlKey: `${options.urlKey}q`
+                }),
+                component(`${id}-views`, 'savedViewsMenu', {
+                    views: fromQuery(queries.views),
+                    savePermission: 'enabled',
+                    managePermission: 'enabled'
+                }),
+                component(`${id}-columns`, 'columnChooser', {
+                    columns: fromQuery(queries.columnChoices)
+                })
+            ],
+            filters: [
+                component(`${id}-filter`, 'filterBuilder', {
+                    fields: fromQuery(queries.filterFields),
+                    ...localeOfData
+                })
+            ],
+            list: [
+                options.recordScreen ? withBehaviors(list, opensRecordOnSelect(listId, options.recordScreen)) : options.recordDialog ? withBehaviors(list, opensDialogOnSelect(options.recordDialog)) : list
+            ],
+            bulkBar: options.recordScreen || options.recordDialog || options.readOnly ? [] : [
+                component(`${id}-bulk`, 'bulkBar', {
+                    selection: fromQuery(queries.selection),
+                    actions: options.bulkActions
+                })
+            ],
+            footer: []
+        },
+        displayName: options.displayName,
+        description: options.description,
+        metadata: invoicingMetadata(options.name, 'List', listScopes)
+    };
+}
+/** The invoices: every invoice with its customer, issue and due dates, amount and status. Choosing an invoice opens it. */ const invoicesListTemplate = listTemplateOf({
+    name: 'InvoicesList',
+    entity: InvoicingEntityKind.Invoice,
+    displayName: 'Invoices list',
+    description: 'Every invoice with its customer, issue and due dates, amount and status, filtered by customer, status and date.',
+    title: 'Invoices',
+    subtitle: 'Everything you have billed',
+    searchLabel: 'Search invoices',
+    urlKey: 'invoices',
+    primary: {
+        label: 'New invoice',
+        dialog: 'InvoicingQuickCreateInvoice'
+    },
+    rowActions: [
+        'Open',
+        'Send reminder'
+    ],
+    bulkActions: [],
+    titleField: 'number',
+    recordScreen: 'invoicing.record'
+});
+/** The payments: what came in, which invoice it settled, when and by what method. A record of what happened, which nobody edits. */ const paymentsListTemplate = listTemplateOf({
+    name: 'PaymentsList',
+    entity: InvoicingEntityKind.Payment,
+    displayName: 'Payments list',
+    description: 'The payments received with the invoice each settled, when and how, filtered by method and date.',
+    title: 'Payments',
+    subtitle: 'What has come in',
+    searchLabel: 'Search payments',
+    urlKey: 'payments',
+    primary: {
+        label: 'Open the invoices',
+        screen: 'invoicing.list'
+    },
+    rowActions: [
+        'Open invoice'
+    ],
+    bulkActions: [],
+    titleField: 'reference',
+    readOnly: true
+});
+
+export { invoicesListTemplate, paymentsListTemplate };
+//# sourceMappingURL=listTemplates.js.map

package/dist/esm/templates/listTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listTemplates.js","sources":["../../../templates/listTemplates.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 { InteractionActionKind, InteractionTriggerKind, NotificationLevel, NotifyAction, ScreenTemplate, TemplateScope } from '@cratis/scene.model';\nimport { listScreenTemplate } from '@cratis/scene.blueprint.default';\nimport { InvoicingEntityKind, fromQuery, invoicingQueriesOf, localeOfData } from '../invoicingQueries';\nimport { actionButton, component, goesTo, invoicingMetadata, opensDialog, opensDialogOnSelect, opensRecordOnSelect, withBehaviors } from '../invoicingParts';\n\nconst listScopes = [TemplateScope.Module, TemplateScope.Feature];\n\n/** The Export button: it tells the user the export has started, which is what the shell does for a long-running action it does not wait on. */\nconst exportAction = (id: string) => withBehaviors(actionButton(id, 'Export', 'secondary'), [{\n    bindings: [{\n        trigger: { kind: InteractionTriggerKind.Click },\n        actions: [{ kind: InteractionActionKind.Notify, level: NotificationLevel.Info, message: { text: 'The export has started.' } } as unknown as NotifyAction],\n    }],\n}]);\n\ninterface ListOptions {\n    name: string;\n    entity: InvoicingEntityKind;\n    displayName: string;\n    description: string;\n    title: string;\n    subtitle: string;\n    searchLabel: string;\n    urlKey: string;\n    /** The primary action of the header: a quick-create dialog to open, or a screen to go to. */\n    primary: { label: string; dialog?: string; screen?: string };\n    rowActions: string[];\n    bulkActions: string[];\n    titleField: string;\n    /** The screen a chosen row opens; the list then selects one row at a time. Absent, rows are selected many at a time for the bulk bar. */\n    recordScreen?: string;\n    /** The side sheet a chosen row opens instead of a record page; the list then selects one row at a time. */\n    recordDialog?: string;\n    /** Group the rows (`variant: grouped`) by this field. */\n    grouped?: { groupBy: string };\n    /** Rows are not selectable at all: a record of what happened, which nobody edits. */\n    readOnly?: boolean;\n    /** Show the records as cards, each with the picture its `imageField` names. */\n    cards?: { imageField?: string };\n    /** Tint a row by the tone in this field (always beside a status column that says the same in words). */\n    toneField?: string;\n}\n\n/**\n * One list: the foundation `ListScreen` with its header, toolbar, filters, list and bulk bar filled for an entity. The slots, arrangement and\n * every behavior - sort, search, paging and selection in the address, the table collapsing to cards on a phone - are the foundation's.\n */\nfunction listTemplateOf(options: ListOptions): ScreenTemplate {\n    const queries = invoicingQueriesOf(options.entity);\n    const id = options.name;\n    const listId = `${id}-records`;\n    const primary = withBehaviors(actionButton(`${id}-primary`, options.primary.label, 'primary'), options.primary.dialog ? opensDialog(options.primary.dialog) : goesTo(options.primary.screen!));\n    const list = component(listId, 'dataList', {\n        label: options.title, rows: fromQuery(queries.rows), columns: fromQuery(queries.columns), titleField: options.titleField, pageSize: options.cards ? 12 : 10, urlKey: options.urlKey, ...localeOfData,\n        rowActions: options.rowActions,\n        ...(options.readOnly ? {} : { selectionMode: options.recordScreen || options.recordDialog ? 'single' : 'multiple' }),\n        ...(options.cards ? { variant: 'cards', ...(options.cards.imageField ? { imageField: options.cards.imageField } : {}) } : {}),\n        ...(options.grouped ? { variant: 'grouped', groupBy: options.grouped.groupBy } : {}),\n        ...(options.toneField ? { toneField: options.toneField } : {}),\n    });\n\n    return {\n        name: options.name,\n        fitsSlot: 'content',\n        slots: listScreenTemplate.slots,\n        arrangement: listScreenTemplate.arrangement,\n        content: {\n            header: [component(`${id}-header`, 'pageHeader', { title: options.title, subtitle: options.subtitle }, { actions: [exportAction(`${id}-export`), primary] })],\n            toolbar: [\n                component(`${id}-search`, 'globalSearch', { placeholder: options.searchLabel, label: options.searchLabel, urlKey: `${options.urlKey}q` }),\n                component(`${id}-views`, 'savedViewsMenu', { views: fromQuery(queries.views), savePermission: 'enabled', managePermission: 'enabled' }),\n                component(`${id}-columns`, 'columnChooser', { columns: fromQuery(queries.columnChoices) }),\n            ],\n            filters: [component(`${id}-filter`, 'filterBuilder', { fields: fromQuery(queries.filterFields), ...localeOfData })],\n            list: [options.recordScreen ? withBehaviors(list, opensRecordOnSelect(listId, options.recordScreen)) : options.recordDialog ? withBehaviors(list, opensDialogOnSelect(options.recordDialog)) : list],\n            bulkBar: options.recordScreen || options.recordDialog || options.readOnly ? [] : [component(`${id}-bulk`, 'bulkBar', { selection: fromQuery(queries.selection), actions: options.bulkActions })],\n            footer: [],\n        },\n        displayName: options.displayName,\n        description: options.description,\n        metadata: invoicingMetadata(options.name, 'List', listScopes),\n    };\n}\n\n\n/** The invoices: every invoice with its customer, issue and due dates, amount and status. Choosing an invoice opens it. */\nexport const invoicesListTemplate = listTemplateOf({\n    name: 'InvoicesList',\n    entity: InvoicingEntityKind.Invoice, displayName: 'Invoices list', description: 'Every invoice with its customer, issue and due dates, amount and status, filtered by customer, status and date.', title: 'Invoices', subtitle: 'Everything you have billed', searchLabel: 'Search invoices', urlKey: 'invoices',\n    primary: { label: 'New invoice', dialog: 'InvoicingQuickCreateInvoice' },\n    rowActions: ['Open', 'Send reminder'], bulkActions: [],\n    titleField: 'number', recordScreen: 'invoicing.record'\n});\n\n/** The payments: what came in, which invoice it settled, when and by what method. A record of what happened, which nobody edits. */\nexport const paymentsListTemplate = listTemplateOf({\n    name: 'PaymentsList',\n    entity: InvoicingEntityKind.Payment, displayName: 'Payments list', description: 'The payments received with the invoice each settled, when and how, filtered by method and date.', title: 'Payments', subtitle: 'What has come in', searchLabel: 'Search payments', urlKey: 'payments',\n    primary: { label: 'Open the invoices', screen: 'invoicing.list' },\n    rowActions: ['Open invoice'], bulkActions: [],\n    titleField: 'reference',\n    readOnly: true\n});\n"],"names":["listScopes","TemplateScope","Module","Feature","exportAction","id","withBehaviors","actionButton","bindings","trigger","kind","InteractionTriggerKind","Click","actions","InteractionActionKind","Notify","level","NotificationLevel","Info","message","text","listTemplateOf","options","queries","invoicingQueriesOf","entity","name","listId","primary","label","dialog","opensDialog","goesTo","screen","list","component","title","rows","fromQuery","columns","titleField","pageSize","cards","urlKey","localeOfData","rowActions","readOnly","selectionMode","recordScreen","recordDialog","variant","imageField","grouped","groupBy","toneField","fitsSlot","slots","listScreenTemplate","arrangement","content","header","subtitle","toolbar","placeholder","searchLabel","views","savePermission","managePermission","columnChoices","filters","fields","filterFields","opensRecordOnSelect","opensDialogOnSelect","bulkBar","selection","bulkActions","footer","displayName","description","metadata","invoicingMetadata","invoicesListTemplate","InvoicingEntityKind","Invoice","paymentsListTemplate","Payment"],"mappings":";;;;;AAAA;AACA;AAOA,MAAMA,UAAAA,GAAa;AAACC,IAAAA,aAAAA,CAAcC,MAAM;AAAED,IAAAA,aAAAA,CAAcE;AAAQ,CAAA;AAEhE,gJACA,MAAMC,YAAAA,GAAe,CAACC,KAAeC,aAAAA,CAAcC,YAAAA,CAAaF,EAAAA,EAAI,QAAA,EAAU,WAAA,CAAA,EAAc;AAAC,QAAA;YACzFG,QAAAA,EAAU;AAAC,gBAAA;oBACPC,OAAAA,EAAS;AAAEC,wBAAAA,IAAAA,EAAMC,uBAAuBC;AAAM,qBAAA;oBAC9CC,OAAAA,EAAS;AAAC,wBAAA;AAAEH,4BAAAA,IAAAA,EAAMI,sBAAsBC,MAAM;AAAEC,4BAAAA,KAAAA,EAAOC,kBAAkBC,IAAI;4BAAEC,OAAAA,EAAS;gCAAEC,IAAAA,EAAM;AAA0B;AAAE;AAA6B;AAC7J;AAAE;AACN;AAAE,KAAA,CAAA;AA8BF;;;IAIA,SAASC,eAAeC,OAAoB,EAAA;IACxC,MAAMC,OAAAA,GAAUC,kBAAAA,CAAmBF,OAAAA,CAAQG,MAAM,CAAA;IACjD,MAAMpB,EAAAA,GAAKiB,QAAQI,IAAI;AACvB,IAAA,MAAMC,MAAAA,GAAS,CAAA,EAAGtB,EAAAA,CAAG,QAAQ,CAAC;AAC9B,IAAA,MAAMuB,OAAAA,GAAUtB,aAAAA,CAAcC,YAAAA,CAAa,CAAA,EAAGF,EAAAA,CAAG,QAAQ,CAAC,EAAEiB,OAAAA,CAAQM,OAAO,CAACC,KAAK,EAAE,SAAA,CAAA,EAAYP,OAAAA,CAAQM,OAAO,CAACE,MAAM,GAAGC,WAAAA,CAAYT,OAAAA,CAAQM,OAAO,CAACE,MAAM,CAAA,GAAIE,MAAAA,CAAOV,OAAAA,CAAQM,OAAO,CAACK,MAAM,CAAA,CAAA;IAC3L,MAAMC,IAAAA,GAAOC,SAAAA,CAAUR,MAAAA,EAAQ,UAAA,EAAY;AACvCE,QAAAA,KAAAA,EAAOP,QAAQc,KAAK;QAAEC,IAAAA,EAAMC,SAAAA,CAAUf,QAAQc,IAAI,CAAA;QAAGE,OAAAA,EAASD,SAAAA,CAAUf,QAAQgB,OAAO,CAAA;AAAGC,QAAAA,UAAAA,EAAYlB,QAAQkB,UAAU;QAAEC,QAAAA,EAAUnB,OAAAA,CAAQoB,KAAK,GAAG,EAAA,GAAK,EAAA;AAAIC,QAAAA,MAAAA,EAAQrB,QAAQqB,MAAM;AAAE,QAAA,GAAGC,YAAY;AACpMC,QAAAA,UAAAA,EAAYvB,QAAQuB,UAAU;AAC9B,QAAA,GAAIvB,OAAAA,CAAQwB,QAAQ,GAAG,EAAC,GAAI;AAAEC,YAAAA,aAAAA,EAAezB,QAAQ0B,YAAY,IAAI1B,OAAAA,CAAQ2B,YAAY,GAAG,QAAA,GAAW;SAAY;QACnH,GAAI3B,OAAAA,CAAQoB,KAAK,GAAG;YAAEQ,OAAAA,EAAS,OAAA;AAAS,YAAA,GAAI5B,OAAAA,CAAQoB,KAAK,CAACS,UAAU,GAAG;gBAAEA,UAAAA,EAAY7B,OAAAA,CAAQoB,KAAK,CAACS;AAAW,aAAA,GAAI;AAAI,SAAA,GAAI,EAAE;QAC5H,GAAI7B,OAAAA,CAAQ8B,OAAO,GAAG;YAAEF,OAAAA,EAAS,SAAA;YAAWG,OAAAA,EAAS/B,OAAAA,CAAQ8B,OAAO,CAACC;AAAQ,SAAA,GAAI,EAAE;QACnF,GAAI/B,OAAAA,CAAQgC,SAAS,GAAG;AAAEA,YAAAA,SAAAA,EAAWhC,QAAQgC;AAAU,SAAA,GAAI;AAC/D,KAAA,CAAA;IAEA,OAAO;AACH5B,QAAAA,IAAAA,EAAMJ,QAAQI,IAAI;QAClB6B,QAAAA,EAAU,SAAA;AACVC,QAAAA,KAAAA,EAAOC,mBAAmBD,KAAK;AAC/BE,QAAAA,WAAAA,EAAaD,mBAAmBC,WAAW;QAC3CC,OAAAA,EAAS;YACLC,MAAAA,EAAQ;AAACzB,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,OAAO,CAAC,EAAE,YAAA,EAAc;AAAE+B,oBAAAA,KAAAA,EAAOd,QAAQc,KAAK;AAAEyB,oBAAAA,QAAAA,EAAUvC,QAAQuC;iBAAS,EAAG;oBAAEhD,OAAAA,EAAS;wBAACT,YAAAA,CAAa,CAAA,EAAGC,EAAAA,CAAG,OAAO,CAAC,CAAA;AAAGuB,wBAAAA;AAAQ;AAAC,iBAAA;AAAG,aAAA;YAC7JkC,OAAAA,EAAS;AACL3B,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,OAAO,CAAC,EAAE,cAAA,EAAgB;AAAE0D,oBAAAA,WAAAA,EAAazC,QAAQ0C,WAAW;AAAEnC,oBAAAA,KAAAA,EAAOP,QAAQ0C,WAAW;AAAErB,oBAAAA,MAAAA,EAAQ,CAAA,EAAGrB,OAAAA,CAAQqB,MAAM,CAAC,CAAC;AAAE,iBAAA,CAAA;AACvIR,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,MAAM,CAAC,EAAE,gBAAA,EAAkB;oBAAE4D,KAAAA,EAAO3B,SAAAA,CAAUf,QAAQ0C,KAAK,CAAA;oBAAGC,cAAAA,EAAgB,SAAA;oBAAWC,gBAAAA,EAAkB;AAAU,iBAAA,CAAA;AACrIhC,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,QAAQ,CAAC,EAAE,eAAA,EAAiB;oBAAEkC,OAAAA,EAASD,SAAAA,CAAUf,QAAQ6C,aAAa;AAAE,iBAAA;AAC3F,aAAA;YACDC,OAAAA,EAAS;AAAClC,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,OAAO,CAAC,EAAE,eAAA,EAAiB;oBAAEiE,MAAAA,EAAQhC,SAAAA,CAAUf,QAAQgD,YAAY,CAAA;AAAG,oBAAA,GAAG3B;AAAa,iBAAA;AAAG,aAAA;YACnHV,IAAAA,EAAM;AAACZ,gBAAAA,OAAAA,CAAQ0B,YAAY,GAAG1C,aAAAA,CAAc4B,IAAAA,EAAMsC,mBAAAA,CAAoB7C,QAAQL,OAAAA,CAAQ0B,YAAY,CAAA,CAAA,GAAK1B,OAAAA,CAAQ2B,YAAY,GAAG3C,aAAAA,CAAc4B,MAAMuC,mBAAAA,CAAoBnD,OAAAA,CAAQ2B,YAAY,CAAA,CAAA,GAAKf;AAAK,aAAA;YACpMwC,OAAAA,EAASpD,OAAAA,CAAQ0B,YAAY,IAAI1B,OAAAA,CAAQ2B,YAAY,IAAI3B,OAAAA,CAAQwB,QAAQ,GAAG,EAAE,GAAG;AAACX,gBAAAA,SAAAA,CAAU,CAAA,EAAG9B,EAAAA,CAAG,KAAK,CAAC,EAAE,SAAA,EAAW;oBAAEsE,SAAAA,EAAWrC,SAAAA,CAAUf,QAAQoD,SAAS,CAAA;AAAG9D,oBAAAA,OAAAA,EAASS,QAAQsD;AAAY,iBAAA;AAAG,aAAA;AAChMC,YAAAA,MAAAA,EAAQ;AACZ,SAAA;AACAC,QAAAA,WAAAA,EAAaxD,QAAQwD,WAAW;AAChCC,QAAAA,WAAAA,EAAazD,QAAQyD,WAAW;AAChCC,QAAAA,QAAAA,EAAUC,iBAAAA,CAAkB3D,OAAAA,CAAQI,IAAI,EAAE,MAAA,EAAQ1B,UAAAA;AACtD,KAAA;AACJ;AAGA,4HACO,MAAMkF,oBAAAA,GAAuB7D,cAAAA,CAAe;IAC/CK,IAAAA,EAAM,cAAA;AACND,IAAAA,MAAAA,EAAQ0D,oBAAoBC,OAAO;IAAEN,WAAAA,EAAa,eAAA;IAAiBC,WAAAA,EAAa,iHAAA;IAAmH3C,KAAAA,EAAO,UAAA;IAAYyB,QAAAA,EAAU,4BAAA;IAA8BG,WAAAA,EAAa,iBAAA;IAAmBrB,MAAAA,EAAQ,UAAA;IACtSf,OAAAA,EAAS;QAAEC,KAAAA,EAAO,aAAA;QAAeC,MAAAA,EAAQ;AAA8B,KAAA;IACvEe,UAAAA,EAAY;AAAC,QAAA,MAAA;AAAQ,QAAA;AAAgB,KAAA;AAAE+B,IAAAA,WAAAA,EAAa,EAAE;IACtDpC,UAAAA,EAAY,QAAA;IAAUQ,YAAAA,EAAc;AACxC,CAAA;AAEA,qIACO,MAAMqC,oBAAAA,GAAuBhE,cAAAA,CAAe;IAC/CK,IAAAA,EAAM,cAAA;AACND,IAAAA,MAAAA,EAAQ0D,oBAAoBG,OAAO;IAAER,WAAAA,EAAa,eAAA;IAAiBC,WAAAA,EAAa,iGAAA;IAAmG3C,KAAAA,EAAO,UAAA;IAAYyB,QAAAA,EAAU,kBAAA;IAAoBG,WAAAA,EAAa,iBAAA;IAAmBrB,MAAAA,EAAQ,UAAA;IAC5Qf,OAAAA,EAAS;QAAEC,KAAAA,EAAO,mBAAA;QAAqBI,MAAAA,EAAQ;AAAiB,KAAA;IAChEY,UAAAA,EAAY;AAAC,QAAA;AAAe,KAAA;AAAE+B,IAAAA,WAAAA,EAAa,EAAE;IAC7CpC,UAAAA,EAAY,WAAA;IACZM,QAAAA,EAAU;AACd,CAAA;;"}

package/dist/esm/templates/recordTemplates.d.ts

@@ -0,0 +1,3 @@
+import { ScreenTemplate } from '@cratis/scene.model';
+export declare const invoicePageTemplate: ScreenTemplate;
+//# sourceMappingURL=recordTemplates.d.ts.map

package/dist/esm/templates/recordTemplates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordTemplates.d.ts","sourceRoot":"","sources":["../../../templates/recordTemplates.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAiB,MAAM,qBAAqB,CAAC;AAiEpE,eAAO,MAAM,mBAAmB,gBAU9B,CAAC"}

package/dist/esm/templates/recordTemplates.js

@@ -0,0 +1,142 @@
+import { TemplateScope } from '@cratis/scene.model';
+import { recordPageTemplate, component } from '@cratis/scene.blueprint.default';
+import { localeOfData, fromQuery, currencyOfData, invoicingQueriesOf, InvoicingEntityKind } from '../invoicingQueries.js';
+import { invoicingMetadata, withBehaviors, goesTo, actionButton, opensDialog } from '../invoicingParts.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * One record page: the foundation `RecordPage` with the record's own title, its status and key facts at the top, its fields and the lists that belong to it in the
+ * main region, and the activity beside it. What it shows is the record the list handed it the id of.
+ */ function recordPageOf(options) {
+    const queries = invoicingQueriesOf(options.entity);
+    const id = options.name;
+    return {
+        name: options.name,
+        fitsSlot: 'content',
+        slots: recordPageTemplate.slots,
+        arrangement: recordPageTemplate.arrangement,
+        content: {
+            header: [
+                component(`${id}-header`, 'pageHeader', {
+                    title: fromQuery(queries.record, `0.${options.titleField}`),
+                    subtitle: fromQuery(queries.record, '0.summary')
+                }, {
+                    actions: [
+                        withBehaviors(actionButton(`${id}-back`, options.backLabel, 'secondary'), goesTo(options.backScreen)),
+                        ...options.actions.map((action)=>withBehaviors(actionButton(`${id}-${action.id}`, action.label, action.emphasis), action.dialog ? opensDialog(action.dialog) : goesTo(action.screen)))
+                    ]
+                })
+            ],
+            summary: [
+                component(`${id}-status`, 'statusChip', {
+                    status: fromQuery(queries.summary, '0.status'),
+                    tone: fromQuery(queries.summary, '0.tone')
+                }),
+                ...options.facts.map((fact)=>component(`${id}-${fact.id}`, 'statCard', {
+                        label: fact.label,
+                        value: fromQuery(queries.summary, `0.${fact.field}`),
+                        ...fact.format ? {
+                            format: fact.format
+                        } : {},
+                        ...currencyOfData
+                    }))
+            ],
+            tabs: [
+                component(`${id}-tabs`, 'tabSet', {
+                    tabs: fromQuery(queries.tabs),
+                    urlKey: 'tab',
+                    label: `${options.displayName} sections`
+                })
+            ],
+            main: [
+                component(`${id}-form`, 'formScreenBody', {
+                    mode: 'readOnly',
+                    sections: fromQuery(queries.sections),
+                    values: fromQuery(queries.record, '0'),
+                    ...currencyOfData
+                }),
+                ...options.extras.map((extra)=>component(`${id}-${extra.key.toLowerCase()}`, 'dataList', {
+                        label: extra.label,
+                        rows: fromQuery(`${options.entity}${extra.key}`),
+                        columns: fromQuery(`${options.entity}${extra.key}Columns`),
+                        titleField: extra.titleField,
+                        pageSize: extra.pageSize ?? 8,
+                        ...currencyOfData
+                    }))
+            ],
+            related: [],
+            activity: [
+                component(`${id}-activity`, 'activityFeed', {
+                    label: 'Activity',
+                    entries: fromQuery(queries.activity),
+                    ...localeOfData
+                })
+            ],
+            aside: []
+        },
+        displayName: options.displayName,
+        description: options.description,
+        metadata: invoicingMetadata(options.name, 'Detail', [
+            TemplateScope.Feature,
+            TemplateScope.Subfeature
+        ])
+    };
+}
+/** The invoice page: the invoice number as its title, its status, total, paid amount and balance due at the top, its fields, lines and payments in the main region, and the activity beside it. */ const invoicePageTemplate = recordPageOf({
+    name: 'InvoicePage',
+    entity: InvoicingEntityKind.Invoice,
+    displayName: 'Invoice page',
+    description: 'One invoice: status, total, paid and balance due, its details, lines and payments, and its activity.',
+    titleField: 'number',
+    backScreen: 'invoicing.list',
+    backLabel: 'Back to invoices',
+    facts: [
+        {
+            id: 'total',
+            label: 'Invoice total',
+            field: 'total',
+            format: 'currency'
+        },
+        {
+            id: 'paid',
+            label: 'Paid',
+            field: 'paid',
+            format: 'currency'
+        },
+        {
+            id: 'balance',
+            label: 'Balance due',
+            field: 'balance',
+            format: 'currency'
+        },
+        {
+            id: 'days',
+            label: 'Days to due date',
+            field: 'daysToDue'
+        }
+    ],
+    extras: [
+        {
+            key: 'Lines',
+            label: 'Invoice lines',
+            titleField: 'description'
+        },
+        {
+            key: 'Payments',
+            label: 'Payments',
+            titleField: 'reference'
+        }
+    ],
+    actions: [
+        {
+            id: 'pay',
+            label: 'Record payment',
+            emphasis: 'primary',
+            dialog: 'InvoicingRecordPayment'
+        }
+    ]
+});
+
+export { invoicePageTemplate };
+//# sourceMappingURL=recordTemplates.js.map

package/dist/esm/templates/recordTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordTemplates.js","sources":["../../../templates/recordTemplates.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 { ScreenTemplate, TemplateScope } from '@cratis/scene.model';\nimport { recordPageTemplate } from '@cratis/scene.blueprint.default';\nimport { InvoicingEntityKind, currencyOfData, fromQuery, localeOfData, invoicingQueriesOf } from '../invoicingQueries';\nimport { actionButton, component, goesTo, invoicingMetadata, opensDialog, withBehaviors } from '../invoicingParts';\n\ninterface Fact { id: string; label: string; field: string; format?: 'currency' | 'percent' }\ninterface Extra { key: string; label: string; titleField: string; pageSize?: number }\ninterface Action { id: string; label: string; emphasis: 'primary' | 'secondary' | 'quiet' | 'danger'; dialog?: string; screen?: string }\n\ninterface RecordOptions {\n    name: string;\n    entity: InvoicingEntityKind;\n    displayName: string;\n    description: string;\n    titleField: string;\n    backScreen: string;\n    backLabel: string;\n    facts: Fact[];\n    extras: Extra[];\n    actions: Action[];\n}\n\n/**\n * One record page: the foundation `RecordPage` with the record's own title, its status and key facts at the top, its fields and the lists that belong to it in the\n * main region, and the activity beside it. What it shows is the record the list handed it the id of.\n */\nfunction recordPageOf(options: RecordOptions): ScreenTemplate {\n    const queries = invoicingQueriesOf(options.entity);\n    const id = options.name;\n    return {\n        name: options.name,\n        fitsSlot: 'content',\n        slots: recordPageTemplate.slots,\n        arrangement: recordPageTemplate.arrangement,\n        content: {\n            header: [component(`${id}-header`, 'pageHeader', { title: fromQuery(queries.record, `0.${options.titleField}`), subtitle: fromQuery(queries.record, '0.summary') }, {\n                actions: [\n                    withBehaviors(actionButton(`${id}-back`, options.backLabel, 'secondary'), goesTo(options.backScreen)),\n                    ...options.actions.map(action => withBehaviors(actionButton(`${id}-${action.id}`, action.label, action.emphasis), action.dialog ? opensDialog(action.dialog) : goesTo(action.screen!))),\n                ],\n            })],\n            summary: [\n                component(`${id}-status`, 'statusChip', { status: fromQuery(queries.summary, '0.status'), tone: fromQuery(queries.summary, '0.tone') }),\n                ...options.facts.map(fact => component(`${id}-${fact.id}`, 'statCard', {\n                    label: fact.label, value: fromQuery(queries.summary, `0.${fact.field}`), ...(fact.format ? { format: fact.format } : {}), ...currencyOfData,\n                })),\n            ],\n            tabs: [component(`${id}-tabs`, 'tabSet', { tabs: fromQuery(queries.tabs), urlKey: 'tab', label: `${options.displayName} sections` })],\n            main: [\n                component(`${id}-form`, 'formScreenBody', { mode: 'readOnly', sections: fromQuery(queries.sections), values: fromQuery(queries.record, '0'), ...currencyOfData }),\n                ...options.extras.map(extra => component(`${id}-${extra.key.toLowerCase()}`, 'dataList', {\n                    label: extra.label, rows: fromQuery(`${options.entity}${extra.key}`), columns: fromQuery(`${options.entity}${extra.key}Columns`), titleField: extra.titleField, pageSize: extra.pageSize ?? 8, ...currencyOfData,\n                })),\n            ],\n            related: [],\n            activity: [component(`${id}-activity`, 'activityFeed', { label: 'Activity', entries: fromQuery(queries.activity), ...localeOfData })],\n            aside: [],\n        },\n        displayName: options.displayName,\n        description: options.description,\n        metadata: invoicingMetadata(options.name, 'Detail', [TemplateScope.Feature, TemplateScope.Subfeature]),\n    };\n}\n\n/** The invoice page: the invoice number as its title, its status, total, paid amount and balance due at the top, its fields, lines and payments in the main region, and the activity beside it. */\nexport const invoicePageTemplate = recordPageOf({\n    name: 'InvoicePage', entity: InvoicingEntityKind.Invoice, displayName: 'Invoice page', description: 'One invoice: status, total, paid and balance due, its details, lines and payments, and its activity.', titleField: 'number', backScreen: 'invoicing.list', backLabel: 'Back to invoices',\n    facts: [\n        { id: 'total', label: 'Invoice total', field: 'total', format: 'currency' },\n        { id: 'paid', label: 'Paid', field: 'paid', format: 'currency' },\n        { id: 'balance', label: 'Balance due', field: 'balance', format: 'currency' },\n        { id: 'days', label: 'Days to due date', field: 'daysToDue' },\n    ],\n    extras: [{ key: 'Lines', label: 'Invoice lines', titleField: 'description' }, { key: 'Payments', label: 'Payments', titleField: 'reference' }],\n    actions: [{ id: 'pay', label: 'Record payment', emphasis: 'primary', dialog: 'InvoicingRecordPayment' }],\n});\n"],"names":["recordPageOf","options","queries","invoicingQueriesOf","entity","id","name","fitsSlot","slots","recordPageTemplate","arrangement","content","header","component","title","fromQuery","record","titleField","subtitle","actions","withBehaviors","actionButton","backLabel","goesTo","backScreen","map","action","label","emphasis","dialog","opensDialog","screen","summary","status","tone","facts","fact","value","field","format","currencyOfData","tabs","urlKey","displayName","main","mode","sections","values","extras","extra","key","toLowerCase","rows","columns","pageSize","related","activity","entries","localeOfData","aside","description","metadata","invoicingMetadata","TemplateScope","Feature","Subfeature","invoicePageTemplate","InvoicingEntityKind","Invoice"],"mappings":";;;;;AAAA;AACA;AAwBA;;;IAIA,SAASA,aAAaC,OAAsB,EAAA;IACxC,MAAMC,OAAAA,GAAUC,kBAAAA,CAAmBF,OAAAA,CAAQG,MAAM,CAAA;IACjD,MAAMC,EAAAA,GAAKJ,QAAQK,IAAI;IACvB,OAAO;AACHA,QAAAA,IAAAA,EAAML,QAAQK,IAAI;QAClBC,QAAAA,EAAU,SAAA;AACVC,QAAAA,KAAAA,EAAOC,mBAAmBD,KAAK;AAC/BE,QAAAA,WAAAA,EAAaD,mBAAmBC,WAAW;QAC3CC,OAAAA,EAAS;YACLC,MAAAA,EAAQ;AAACC,gBAAAA,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,OAAO,CAAC,EAAE,YAAA,EAAc;oBAAES,KAAAA,EAAOC,SAAAA,CAAUb,QAAQc,MAAM,EAAE,CAAC,EAAE,EAAEf,OAAAA,CAAQgB,UAAU,CAAA,CAAE,CAAA;oBAAGC,QAAAA,EAAUH,SAAAA,CAAUb,OAAAA,CAAQc,MAAM,EAAE,WAAA;iBAAa,EAAG;oBAChKG,OAAAA,EAAS;AACLC,wBAAAA,aAAAA,CAAcC,YAAAA,CAAa,CAAA,EAAGhB,EAAAA,CAAG,KAAK,CAAC,EAAEJ,OAAAA,CAAQqB,SAAS,EAAE,WAAA,CAAA,EAAcC,MAAAA,CAAOtB,OAAAA,CAAQuB,UAAU,CAAA,CAAA;AAChGvB,wBAAAA,GAAAA,OAAAA,CAAQkB,OAAO,CAACM,GAAG,CAACC,CAAAA,MAAAA,GAAUN,aAAAA,CAAcC,YAAAA,CAAa,CAAA,EAAGhB,EAAAA,CAAG,CAAC,EAAEqB,OAAOrB,EAAE,CAAA,CAAE,EAAEqB,MAAAA,CAAOC,KAAK,EAAED,MAAAA,CAAOE,QAAQ,GAAGF,MAAAA,CAAOG,MAAM,GAAGC,WAAAA,CAAYJ,MAAAA,CAAOG,MAAM,CAAA,GAAIN,MAAAA,CAAOG,OAAOK,MAAM,CAAA,CAAA;AACtL;AACL,iBAAA;AAAG,aAAA;YACHC,OAAAA,EAAS;AACLnB,gBAAAA,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,OAAO,CAAC,EAAE,YAAA,EAAc;oBAAE4B,MAAAA,EAAQlB,SAAAA,CAAUb,OAAAA,CAAQ8B,OAAO,EAAE,UAAA,CAAA;oBAAaE,IAAAA,EAAMnB,SAAAA,CAAUb,OAAAA,CAAQ8B,OAAO,EAAE,QAAA;AAAU,iBAAA,CAAA;AAClI/B,gBAAAA,GAAAA,OAAAA,CAAQkC,KAAK,CAACV,GAAG,CAACW,CAAAA,IAAAA,GAAQvB,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,CAAC,EAAE+B,IAAAA,CAAK/B,EAAE,CAAA,CAAE,EAAE,UAAA,EAAY;AACnEsB,wBAAAA,KAAAA,EAAOS,KAAKT,KAAK;wBAAEU,KAAAA,EAAOtB,SAAAA,CAAUb,QAAQ8B,OAAO,EAAE,CAAC,EAAE,EAAEI,IAAAA,CAAKE,KAAK,CAAA,CAAE,CAAA;wBAAG,GAAIF,IAAAA,CAAKG,MAAM,GAAG;AAAEA,4BAAAA,MAAAA,EAAQH,KAAKG;AAAO,yBAAA,GAAI,EAAE;AAAG,wBAAA,GAAGC;AACjI,qBAAA,CAAA;AACH,aAAA;YACDC,IAAAA,EAAM;AAAC5B,gBAAAA,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,KAAK,CAAC,EAAE,QAAA,EAAU;oBAAEoC,IAAAA,EAAM1B,SAAAA,CAAUb,QAAQuC,IAAI,CAAA;oBAAGC,MAAAA,EAAQ,KAAA;AAAOf,oBAAAA,KAAAA,EAAO,CAAA,EAAG1B,OAAAA,CAAQ0C,WAAW,CAAC,SAAS;AAAE,iBAAA;AAAG,aAAA;YACrIC,IAAAA,EAAM;AACF/B,gBAAAA,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,KAAK,CAAC,EAAE,gBAAA,EAAkB;oBAAEwC,IAAAA,EAAM,UAAA;oBAAYC,QAAAA,EAAU/B,SAAAA,CAAUb,QAAQ4C,QAAQ,CAAA;oBAAGC,MAAAA,EAAQhC,SAAAA,CAAUb,OAAAA,CAAQc,MAAM,EAAE,GAAA,CAAA;AAAM,oBAAA,GAAGwB;AAAe,iBAAA,CAAA;AAC5JvC,gBAAAA,GAAAA,OAAAA,CAAQ+C,MAAM,CAACvB,GAAG,CAACwB,CAAAA,QAASpC,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,CAAC,EAAE4C,KAAAA,CAAMC,GAAG,CAACC,WAAW,EAAA,CAAA,CAAI,EAAE,UAAA,EAAY;AACrFxB,wBAAAA,KAAAA,EAAOsB,MAAMtB,KAAK;AAAEyB,wBAAAA,IAAAA,EAAMrC,UAAU,CAAA,EAAGd,OAAAA,CAAQG,MAAM,CAAA,EAAG6C,KAAAA,CAAMC,GAAG,CAAA,CAAE,CAAA;wBAAGG,OAAAA,EAAStC,SAAAA,CAAU,GAAGd,OAAAA,CAAQG,MAAM,GAAG6C,KAAAA,CAAMC,GAAG,CAAC,OAAO,CAAC,CAAA;AAAGjC,wBAAAA,UAAAA,EAAYgC,MAAMhC,UAAU;wBAAEqC,QAAAA,EAAUL,KAAAA,CAAMK,QAAQ,IAAI,CAAA;AAAG,wBAAA,GAAGd;AACtM,qBAAA,CAAA;AACH,aAAA;AACDe,YAAAA,OAAAA,EAAS,EAAE;YACXC,QAAAA,EAAU;AAAC3C,gBAAAA,SAAAA,CAAU,CAAA,EAAGR,EAAAA,CAAG,SAAS,CAAC,EAAE,cAAA,EAAgB;oBAAEsB,KAAAA,EAAO,UAAA;oBAAY8B,OAAAA,EAAS1C,SAAAA,CAAUb,QAAQsD,QAAQ,CAAA;AAAG,oBAAA,GAAGE;AAAa,iBAAA;AAAG,aAAA;AACrIC,YAAAA,KAAAA,EAAO;AACX,SAAA;AACAhB,QAAAA,WAAAA,EAAa1C,QAAQ0C,WAAW;AAChCiB,QAAAA,WAAAA,EAAa3D,QAAQ2D,WAAW;AAChCC,QAAAA,QAAAA,EAAUC,iBAAAA,CAAkB7D,OAAAA,CAAQK,IAAI,EAAE,QAAA,EAAU;AAACyD,YAAAA,aAAAA,CAAcC,OAAO;AAAED,YAAAA,aAAAA,CAAcE;AAAW,SAAA;AACzG,KAAA;AACJ;AAEA,oMACO,MAAMC,mBAAAA,GAAsBlE,YAAAA,CAAa;IAC5CM,IAAAA,EAAM,aAAA;AAAeF,IAAAA,MAAAA,EAAQ+D,oBAAoBC,OAAO;IAAEzB,WAAAA,EAAa,cAAA;IAAgBiB,WAAAA,EAAa,sGAAA;IAAwG3C,UAAAA,EAAY,QAAA;IAAUO,UAAAA,EAAY,gBAAA;IAAkBF,SAAAA,EAAW,kBAAA;IAC3Qa,KAAAA,EAAO;AACH,QAAA;YAAE9B,EAAAA,EAAI,OAAA;YAASsB,KAAAA,EAAO,eAAA;YAAiBW,KAAAA,EAAO,OAAA;YAASC,MAAAA,EAAQ;AAAW,SAAA;AAC1E,QAAA;YAAElC,EAAAA,EAAI,MAAA;YAAQsB,KAAAA,EAAO,MAAA;YAAQW,KAAAA,EAAO,MAAA;YAAQC,MAAAA,EAAQ;AAAW,SAAA;AAC/D,QAAA;YAAElC,EAAAA,EAAI,SAAA;YAAWsB,KAAAA,EAAO,aAAA;YAAeW,KAAAA,EAAO,SAAA;YAAWC,MAAAA,EAAQ;AAAW,SAAA;AAC5E,QAAA;YAAElC,EAAAA,EAAI,MAAA;YAAQsB,KAAAA,EAAO,kBAAA;YAAoBW,KAAAA,EAAO;AAAY;AAC/D,KAAA;IACDU,MAAAA,EAAQ;AAAC,QAAA;YAAEE,GAAAA,EAAK,OAAA;YAASvB,KAAAA,EAAO,eAAA;YAAiBV,UAAAA,EAAY;AAAc,SAAA;AAAG,QAAA;YAAEiC,GAAAA,EAAK,UAAA;YAAYvB,KAAAA,EAAO,UAAA;YAAYV,UAAAA,EAAY;AAAY;AAAE,KAAA;IAC9IE,OAAAA,EAAS;AAAC,QAAA;YAAEd,EAAAA,EAAI,KAAA;YAAOsB,KAAAA,EAAO,gBAAA;YAAkBC,QAAAA,EAAU,SAAA;YAAWC,MAAAA,EAAQ;AAAyB;AAAE;AAC5G,CAAA;;"}