@cratis/scene.blueprint.default 4.31.0 → 4.32.0

package/dist/cjs/foundation/StatCard.js

@@ -0,0 +1,61 @@
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var ComponentState = require('./ComponentState.js');
+var StateFrame = require('./StateFrame.js');
+var TrendChip = require('./TrendChip.js');
+var formatting = require('./formatting.js');
+var foundationStrings = require('./foundationStrings.js');
+var elementProperties = require('../shell/elementProperties.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The `statCard` component: one key figure with its label, its trend and what the trend is compared to - the unit of a dashboard's
+ * `kpis` slot.
+ *
+ * The value is a bound number, never embedded in the component (a figure is data, not design); it is formatted for the locale as
+ * a number, currency, percent or compact. With no value the card is empty, and it shows all five standard states
+ * independently of its neighbours, so a dashboard whose one query failed still shows the other cards.
+ */ function StatCard({ element, interactions }) {
+    const value = element.properties.value;
+    const hasValue = typeof value === 'number';
+    const state = ComponentState.readComponentState(element, hasValue);
+    const locale = formatting.readLocale(element);
+    const label = elementProperties.readString(element, 'label');
+    const change = element.properties.change;
+    const currency = elementProperties.readOptionalString(element, 'currency');
+    return /*#__PURE__*/ jsxRuntime.jsx(StateFrame.FoundationFrame, {
+        element: element,
+        interactions: interactions,
+        name: "stat-card",
+        state: state,
+        skeleton: [
+            40,
+            70,
+            30
+        ],
+        children: state !== ComponentState.ComponentState.Loading && /*#__PURE__*/ jsxRuntime.jsxs(jsxRuntime.Fragment, {
+            children: [
+                /*#__PURE__*/ jsxRuntime.jsx("h3", {
+                    className: "foundation-stat-label",
+                    children: label
+                }),
+                /*#__PURE__*/ jsxRuntime.jsx("p", {
+                    className: "foundation-stat-value",
+                    children: hasValue ? formatting.formatNumber(value, locale, formatting.readNumberFormat(element), currency, typeof element.properties.fractionDigits === 'number' ? element.properties.fractionDigits : undefined) : ''
+                }),
+                typeof change === 'number' && /*#__PURE__*/ jsxRuntime.jsx(TrendChip.TrendChipView, {
+                    change: change,
+                    locale: locale,
+                    goodDirection: element.properties.goodDirection === 'down' ? 'down' : 'up',
+                    comparison: elementProperties.readOptionalString(element, 'comparison'),
+                    strings: foundationStrings.readFoundationStrings(element)
+                })
+            ]
+        })
+    });
+}
+
+exports.StatCard = StatCard;
+//# sourceMappingURL=StatCard.js.map

package/dist/cjs/foundation/StatCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatCard.js","sources":["../../../foundation/StatCard.tsx"],"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 { RegisteredComponentProps } from '@cratis/scene.react';\nimport { ComponentState, readComponentState } from './ComponentState';\nimport { FoundationFrame } from './StateFrame';\nimport { TrendChipView } from './TrendChip';\nimport { formatNumber, readLocale, readNumberFormat } from './formatting';\nimport { readFoundationStrings } from './foundationStrings';\nimport { readOptionalString, readString } from '../shell/elementProperties';\n\n/**\n * The `statCard` component: one key figure with its label, its trend and what the trend is compared to - the unit of a dashboard's\n * `kpis` slot.\n *\n * The value is a bound number, never embedded in the component (a figure is data, not design); it is formatted for the locale as\n * a number, currency, percent or compact. With no value the card is empty, and it shows all five standard states\n * independently of its neighbours, so a dashboard whose one query failed still shows the other cards.\n */\nexport function StatCard({ element, interactions }: RegisteredComponentProps) {\n    const value = element.properties.value;\n    const hasValue = typeof value === 'number';\n    const state = readComponentState(element, hasValue);\n    const locale = readLocale(element);\n    const label = readString(element, 'label');\n    const change = element.properties.change;\n    const currency = readOptionalString(element, 'currency');\n\n    return (\n        <FoundationFrame element={element} interactions={interactions}\n            name='stat-card' state={state} skeleton={[40, 70, 30]}>\n            {state !== ComponentState.Loading && (\n                <>\n                    <h3 className='foundation-stat-label'>{label}</h3>\n                    <p className='foundation-stat-value'>{hasValue ? formatNumber(value, locale, readNumberFormat(element), currency, typeof element.properties.fractionDigits === 'number' ? element.properties.fractionDigits : undefined) : ''}</p>\n                    {typeof change === 'number' && (\n                        <TrendChipView change={change} locale={locale} goodDirection={element.properties.goodDirection === 'down' ? 'down' : 'up'}\n                            comparison={readOptionalString(element, 'comparison')} strings={readFoundationStrings(element)} />\n                    )}\n                </>\n            )}\n        </FoundationFrame>\n    );\n}\n"],"names":["StatCard","element","interactions","value","properties","hasValue","state","readComponentState","locale","readLocale","label","readString","change","currency","readOptionalString","_jsx","FoundationFrame","name","skeleton","ComponentState","Loading","_jsxs","_Fragment","h3","className","p","formatNumber","readNumberFormat","fractionDigits","undefined","TrendChipView","goodDirection","comparison","strings","readFoundationStrings"],"mappings":";;;;;;;;;;AAAA;AACA;AAUA;;;;;;;AAOC,IACM,SAASA,QAAAA,CAAS,EAAEC,OAAO,EAAEC,YAAY,EAA4B,EAAA;AACxE,IAAA,MAAMC,KAAAA,GAAQF,OAAAA,CAAQG,UAAU,CAACD,KAAK;IACtC,MAAME,QAAAA,GAAW,OAAOF,KAAAA,KAAU,QAAA;IAClC,MAAMG,KAAAA,GAAQC,kCAAmBN,OAAAA,EAASI,QAAAA,CAAAA;AAC1C,IAAA,MAAMG,SAASC,qBAAAA,CAAWR,OAAAA,CAAAA;IAC1B,MAAMS,KAAAA,GAAQC,6BAAWV,OAAAA,EAAS,OAAA,CAAA;AAClC,IAAA,MAAMW,MAAAA,GAASX,OAAAA,CAAQG,UAAU,CAACQ,MAAM;IACxC,MAAMC,QAAAA,GAAWC,qCAAmBb,OAAAA,EAAS,UAAA,CAAA;AAE7C,IAAA,qBACIc,cAAA,CAACC,0BAAAA,EAAAA;QAAgBf,OAAAA,EAASA,OAAAA;QAASC,YAAAA,EAAcA,YAAAA;QAC7Ce,IAAAA,EAAK,WAAA;QAAYX,KAAAA,EAAOA,KAAAA;QAAOY,QAAAA,EAAU;AAAC,YAAA,EAAA;AAAI,YAAA,EAAA;AAAI,YAAA;AAAG,SAAA;kBACpDZ,KAAAA,KAAUa,6BAAAA,CAAeC,OAAO,kBAC7BC,eAAA,CAAAC,mBAAA,EAAA;;8BACIP,cAAA,CAACQ,IAAAA,EAAAA;oBAAGC,SAAAA,EAAU,uBAAA;AAAyBd,oBAAAA,QAAAA,EAAAA;;8BACvCK,cAAA,CAACU,GAAAA,EAAAA;oBAAED,SAAAA,EAAU,uBAAA;AAAyBnB,oBAAAA,QAAAA,EAAAA,QAAAA,GAAWqB,wBAAavB,KAAAA,EAAOK,MAAAA,EAAQmB,4BAAiB1B,OAAAA,CAAAA,EAAUY,QAAAA,EAAU,OAAOZ,OAAAA,CAAQG,UAAU,CAACwB,cAAc,KAAK,QAAA,GAAW3B,OAAAA,CAAQG,UAAU,CAACwB,cAAc,GAAGC,SAAAA,CAAAA,GAAa;;gBAC1N,OAAOjB,MAAAA,KAAW,0BACfG,cAAA,CAACe,uBAAAA,EAAAA;oBAAclB,MAAAA,EAAQA,MAAAA;oBAAQJ,MAAAA,EAAQA,MAAAA;AAAQuB,oBAAAA,aAAAA,EAAe9B,QAAQG,UAAU,CAAC2B,aAAa,KAAK,SAAS,MAAA,GAAS,IAAA;AACjHC,oBAAAA,UAAAA,EAAYlB,qCAAmBb,OAAAA,EAAS,YAAA,CAAA;AAAegC,oBAAAA,OAAAA,EAASC,uCAAAA,CAAsBjC,OAAAA;;;;;AAMlH;;"}

package/dist/cjs/foundation/StateFrame.js

@@ -0,0 +1,200 @@
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var elementProperties = require('../shell/elementProperties.js');
+var ActionButton = require('./ActionButton.js');
+var ComponentState = require('./ComponentState.js');
+var FoundationIcon = require('./FoundationIcon.js');
+var foundationStrings = require('./foundationStrings.js');
+var PermissionRule = require('./PermissionRule.js');
+var formatting = require('./formatting.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The accessible name of a region, from the element's `label` property. */ function regionLabel(element) {
+    return elementProperties.readOptionalString(element, 'label') ?? elementProperties.readOptionalString(element, 'title');
+}
+/**
+ * The root every foundation component renders, and the five standard states of spec Part B 1.4 in one place:
+ * a skeleton while loading (never a spinner alone), an explanation with the primary action when empty, a message with a
+ * retry on error, what is missing - and nothing of the data - when the user is not allowed, and the loaded part with a
+ * note naming what failed when only some regions did.
+ *
+ * The region carries an ARIA landmark role when it has a label, a `dir` is left to the document so right-to-left is
+ * inherited, and every piece of text comes from the strings table.
+ */ function FoundationFrame({ element, interactions, name, state, skeleton = [
+    60,
+    100,
+    80
+], children }) {
+    const strings = foundationStrings.readFoundationStrings(element);
+    const label = regionLabel(element);
+    const density = element.properties.density === 'compact' ? 'compact' : 'comfortable';
+    return /*#__PURE__*/ jsxRuntime.jsx("section", {
+        className: `foundation foundation-${name}`,
+        "data-scene-id": element.id,
+        "data-state": state,
+        "data-density": density,
+        lang: formatting.readLocale(element),
+        role: label ? 'region' : undefined,
+        "aria-label": label,
+        "aria-busy": state === ComponentState.ComponentState.Loading || undefined,
+        children: renderState(element, interactions, strings, state, skeleton, children)
+    });
+}
+function renderState(element, interactions, strings, state, skeleton, children) {
+    switch(state){
+        case ComponentState.ComponentState.Loading:
+            return /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                className: "foundation-skeleton",
+                role: "status",
+                children: [
+                    /*#__PURE__*/ jsxRuntime.jsx("span", {
+                        className: "foundation-visually-hidden",
+                        children: strings.loading
+                    }),
+                    skeleton.map((width, index)=>/*#__PURE__*/ jsxRuntime.jsx("span", {
+                            className: "foundation-skeleton-block",
+                            style: {
+                                width: `${width}%`
+                            },
+                            "aria-hidden": "true"
+                        }, index))
+                ]
+            });
+        case ComponentState.ComponentState.Empty:
+            return /*#__PURE__*/ jsxRuntime.jsx(EmptyStateView, {
+                element: element,
+                interactions: interactions,
+                strings: strings
+            });
+        case ComponentState.ComponentState.Error:
+            return /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                className: "foundation-message",
+                "data-tone": "danger",
+                role: "alert",
+                children: [
+                    /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                        name: "alert"
+                    }),
+                    /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                        className: "foundation-message-text",
+                        children: [
+                            /*#__PURE__*/ jsxRuntime.jsx("strong", {
+                                children: strings.errorHeadline
+                            }),
+                            /*#__PURE__*/ jsxRuntime.jsx("span", {
+                                children: typeof element.properties.error === 'string' && element.properties.error.length > 0 ? element.properties.error : strings.errorHint
+                            })
+                        ]
+                    }),
+                    /*#__PURE__*/ jsxRuntime.jsx(ActionButton.ActionButton, {
+                        emphasis: "secondary",
+                        disabledReason: strings.disabledNoPermission,
+                        onClick: interactions?.onClick,
+                        children: strings.retry
+                    })
+                ]
+            });
+        case ComponentState.ComponentState.NoPermission:
+            {
+                const subject = elementProperties.readOptionalString(element, 'permissionSubject') ?? strings.noPermissionSubject;
+                return /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                    className: "foundation-message",
+                    "data-tone": "neutral",
+                    role: "status",
+                    children: [
+                        /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                            name: "lock"
+                        }),
+                        /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                            className: "foundation-message-text",
+                            children: [
+                                /*#__PURE__*/ jsxRuntime.jsx("strong", {
+                                    children: strings.noPermissionHeadline
+                                }),
+                                /*#__PURE__*/ jsxRuntime.jsx("span", {
+                                    children: foundationStrings.formatText(strings.noPermissionHint, {
+                                        subject
+                                    })
+                                })
+                            ]
+                        })
+                    ]
+                });
+            }
+        case ComponentState.ComponentState.Partial:
+            return /*#__PURE__*/ jsxRuntime.jsxs(jsxRuntime.Fragment, {
+                children: [
+                    /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                        className: "foundation-message",
+                        "data-tone": "warning",
+                        role: "status",
+                        children: [
+                            /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                                name: "alert"
+                            }),
+                            /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                                className: "foundation-message-text",
+                                children: [
+                                    /*#__PURE__*/ jsxRuntime.jsx("strong", {
+                                        children: strings.partialHeadline
+                                    }),
+                                    elementProperties.readStrings(element, 'failedRegions').length > 0 && /*#__PURE__*/ jsxRuntime.jsx("span", {
+                                        children: foundationStrings.formatText(strings.partialHint, {
+                                            regions: elementProperties.readStrings(element, 'failedRegions').join(', ')
+                                        })
+                                    })
+                                ]
+                            }),
+                            /*#__PURE__*/ jsxRuntime.jsx(ActionButton.ActionButton, {
+                                emphasis: "secondary",
+                                disabledReason: strings.disabledNoPermission,
+                                onClick: interactions?.onClick,
+                                children: strings.retry
+                            })
+                        ]
+                    }),
+                    children
+                ]
+            });
+        default:
+            return /*#__PURE__*/ jsxRuntime.jsx(jsxRuntime.Fragment, {
+                children: children
+            });
+    }
+}
+/** What an empty region says: an icon, a headline, a hint and the primary action, with the action's permission rule applied. */ function EmptyStateView({ element, interactions, strings }) {
+    const icon = elementProperties.readOptionalString(element, 'emptyIcon') ?? elementProperties.readOptionalString(element, 'icon');
+    const actionLabel = elementProperties.readOptionalString(element, 'emptyActionLabel') ?? elementProperties.readOptionalString(element, 'actionLabel');
+    return /*#__PURE__*/ jsxRuntime.jsxs("div", {
+        className: "foundation-empty",
+        role: "status",
+        children: [
+            /*#__PURE__*/ jsxRuntime.jsx("span", {
+                className: "foundation-empty-icon",
+                children: /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                    name: icon ?? 'inbox'
+                })
+            }),
+            /*#__PURE__*/ jsxRuntime.jsx("strong", {
+                className: "foundation-empty-headline",
+                children: elementProperties.readOptionalString(element, 'emptyHeadline') ?? elementProperties.readOptionalString(element, 'headline') ?? strings.emptyHeadline
+            }),
+            /*#__PURE__*/ jsxRuntime.jsx("span", {
+                className: "foundation-empty-hint",
+                children: elementProperties.readOptionalString(element, 'emptyHint') ?? elementProperties.readOptionalString(element, 'hint') ?? strings.emptyHint
+            }),
+            actionLabel && /*#__PURE__*/ jsxRuntime.jsx(ActionButton.ActionButton, {
+                rule: PermissionRule.readPermissionRule(element, 'actionPermission'),
+                disabledReason: strings.disabledNoPermission,
+                onClick: interactions?.onClick,
+                children: actionLabel
+            })
+        ]
+    });
+}
+
+exports.EmptyStateView = EmptyStateView;
+exports.FoundationFrame = FoundationFrame;
+//# sourceMappingURL=StateFrame.js.map

package/dist/cjs/foundation/StateFrame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StateFrame.js","sources":["../../../foundation/StateFrame.tsx"],"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 { ReactNode } from 'react';\nimport { ExternalComponent } from '@cratis/scene.model';\nimport { RegisteredComponentProps } from '@cratis/scene.react';\nimport { readOptionalString, readStrings } from '../shell/elementProperties';\nimport { ActionButton } from './ActionButton';\nimport { ComponentState } from './ComponentState';\nimport { FoundationIcon, FoundationIconName } from './FoundationIcon';\nimport { FoundationStrings, formatText, readFoundationStrings } from './foundationStrings';\nimport { readPermissionRule } from './PermissionRule';\nimport { readLocale } from './formatting';\n\nexport interface FoundationFrameProps extends Pick<RegisteredComponentProps, 'element' | 'interactions'> {\n    /** The component's own class, added after `foundation`. */\n    name: string;\n\n    /** The state the component is in; compute it with `readComponentState`. */\n    state: ComponentState;\n\n    /** The shape of the skeleton, as the width of each block in percent; the skeleton keeps the footprint of the content. */\n    skeleton?: number[];\n\n    /** What the component draws when it is ready or partial. */\n    children?: ReactNode;\n}\n\n/** The accessible name of a region, from the element's `label` property. */\nfunction regionLabel(element: ExternalComponent): string | undefined {\n    return readOptionalString(element, 'label') ?? readOptionalString(element, 'title');\n}\n\n/**\n * The root every foundation component renders, and the five standard states of spec Part B 1.4 in one place:\n * a skeleton while loading (never a spinner alone), an explanation with the primary action when empty, a message with a\n * retry on error, what is missing - and nothing of the data - when the user is not allowed, and the loaded part with a\n * note naming what failed when only some regions did.\n *\n * The region carries an ARIA landmark role when it has a label, a `dir` is left to the document so right-to-left is\n * inherited, and every piece of text comes from the strings table.\n */\nexport function FoundationFrame({ element, interactions, name, state, skeleton = [60, 100, 80], children }: FoundationFrameProps) {\n    const strings = readFoundationStrings(element);\n    const label = regionLabel(element);\n    const density = element.properties.density === 'compact' ? 'compact' : 'comfortable';\n\n    return (\n        <section className={`foundation foundation-${name}`} data-scene-id={element.id} data-state={state} data-density={density}\n            lang={readLocale(element)} role={label ? 'region' : undefined} aria-label={label} aria-busy={state === ComponentState.Loading || undefined}>\n            {renderState(element, interactions, strings, state, skeleton, children)}\n        </section>\n    );\n}\n\nfunction renderState(element: ExternalComponent, interactions: RegisteredComponentProps['interactions'], strings: FoundationStrings, state: ComponentState, skeleton: number[], children: ReactNode) {\n    switch (state) {\n        case ComponentState.Loading:\n            return (\n                <div className='foundation-skeleton' role='status'>\n                    <span className='foundation-visually-hidden'>{strings.loading}</span>\n                    {skeleton.map((width, index) => <span key={index} className='foundation-skeleton-block' style={{ width: `${width}%` }} aria-hidden='true' />)}\n                </div>\n            );\n        case ComponentState.Empty:\n            return <EmptyStateView element={element} interactions={interactions} strings={strings} />;\n        case ComponentState.Error:\n            return (\n                <div className='foundation-message' data-tone='danger' role='alert'>\n                    <FoundationIcon name='alert' />\n                    <div className='foundation-message-text'>\n                        <strong>{strings.errorHeadline}</strong>\n                        <span>{typeof element.properties.error === 'string' && element.properties.error.length > 0 ? element.properties.error : strings.errorHint}</span>\n                    </div>\n                    <ActionButton emphasis='secondary' disabledReason={strings.disabledNoPermission} onClick={interactions?.onClick}>{strings.retry}</ActionButton>\n                </div>\n            );\n        case ComponentState.NoPermission: {\n            const subject = readOptionalString(element, 'permissionSubject') ?? strings.noPermissionSubject;\n            return (\n                <div className='foundation-message' data-tone='neutral' role='status'>\n                    <FoundationIcon name='lock' />\n                    <div className='foundation-message-text'>\n                        <strong>{strings.noPermissionHeadline}</strong>\n                        <span>{formatText(strings.noPermissionHint, { subject })}</span>\n                    </div>\n                </div>\n            );\n        }\n\n        case ComponentState.Partial:\n            return (\n                <>\n                    <div className='foundation-message' data-tone='warning' role='status'>\n                        <FoundationIcon name='alert' />\n                        <div className='foundation-message-text'>\n                            <strong>{strings.partialHeadline}</strong>\n                            {readStrings(element, 'failedRegions').length > 0 && <span>{formatText(strings.partialHint, { regions: readStrings(element, 'failedRegions').join(', ') })}</span>}\n                        </div>\n                        <ActionButton emphasis='secondary' disabledReason={strings.disabledNoPermission} onClick={interactions?.onClick}>{strings.retry}</ActionButton>\n                    </div>\n                    {children}\n                </>\n            );\n        default:\n            return <>{children}</>;\n    }\n}\n\n/** What an empty region says: an icon, a headline, a hint and the primary action, with the action's permission rule applied. */\nexport function EmptyStateView({ element, interactions, strings }: Pick<FoundationFrameProps, 'element' | 'interactions'> & { strings: FoundationStrings }) {\n    const icon = (readOptionalString(element, 'emptyIcon') ?? readOptionalString(element, 'icon')) as FoundationIconName | undefined;\n    const actionLabel = readOptionalString(element, 'emptyActionLabel') ?? readOptionalString(element, 'actionLabel');\n\n    return (\n        <div className='foundation-empty' role='status'>\n            <span className='foundation-empty-icon'><FoundationIcon name={icon ?? 'inbox'} /></span>\n            <strong className='foundation-empty-headline'>{readOptionalString(element, 'emptyHeadline') ?? readOptionalString(element, 'headline') ?? strings.emptyHeadline}</strong>\n            <span className='foundation-empty-hint'>{readOptionalString(element, 'emptyHint') ?? readOptionalString(element, 'hint') ?? strings.emptyHint}</span>\n            {actionLabel && (\n                <ActionButton rule={readPermissionRule(element, 'actionPermission')} disabledReason={strings.disabledNoPermission} onClick={interactions?.onClick}>{actionLabel}</ActionButton>\n            )}\n        </div>\n    );\n}\n\n"],"names":["regionLabel","element","readOptionalString","FoundationFrame","interactions","name","state","skeleton","children","strings","readFoundationStrings","label","density","properties","_jsx","section","className","data-scene-id","id","data-state","data-density","lang","readLocale","role","undefined","aria-label","aria-busy","ComponentState","Loading","renderState","_jsxs","div","span","loading","map","width","index","style","aria-hidden","Empty","EmptyStateView","Error","data-tone","FoundationIcon","strong","errorHeadline","error","length","errorHint","ActionButton","emphasis","disabledReason","disabledNoPermission","onClick","retry","NoPermission","subject","noPermissionSubject","noPermissionHeadline","formatText","noPermissionHint","Partial","_Fragment","partialHeadline","readStrings","partialHint","regions","join","icon","actionLabel","emptyHeadline","emptyHint","rule","readPermissionRule"],"mappings":";;;;;;;;;;;AAAA;AACA;AA2BA,6EACA,SAASA,WAAAA,CAAYC,OAA0B,EAAA;AAC3C,IAAA,OAAOC,oCAAAA,CAAmBD,OAAAA,EAAS,OAAA,CAAA,IAAYC,oCAAAA,CAAmBD,OAAAA,EAAS,OAAA,CAAA;AAC/E;AAEA;;;;;;;;AAQC,IACM,SAASE,eAAAA,CAAgB,EAAEF,OAAO,EAAEG,YAAY,EAAEC,IAAI,EAAEC,KAAK,EAAEC,QAAAA,GAAW;AAAC,IAAA,EAAA;AAAI,IAAA,GAAA;AAAK,IAAA;AAAG,CAAA,EAAEC,QAAQ,EAAwB,EAAA;AAC5H,IAAA,MAAMC,UAAUC,uCAAAA,CAAsBT,OAAAA,CAAAA;AACtC,IAAA,MAAMU,QAAQX,WAAAA,CAAYC,OAAAA,CAAAA;AAC1B,IAAA,MAAMW,UAAUX,OAAAA,CAAQY,UAAU,CAACD,OAAO,KAAK,YAAY,SAAA,GAAY,aAAA;AAEvE,IAAA,qBACIE,cAAA,CAACC,SAAAA,EAAAA;QAAQC,SAAAA,EAAW,CAAC,sBAAsB,EAAEX,IAAAA,CAAAA,CAAM;AAAEY,QAAAA,eAAAA,EAAehB,QAAQiB,EAAE;QAAEC,YAAAA,EAAYb,KAAAA;QAAOc,cAAAA,EAAcR,OAAAA;AAC7GS,QAAAA,IAAAA,EAAMC,qBAAAA,CAAWrB,OAAAA,CAAAA;AAAUsB,QAAAA,IAAAA,EAAMZ,QAAQ,QAAA,GAAWa,SAAAA;QAAWC,YAAAA,EAAYd,KAAAA;QAAOe,WAAAA,EAAWpB,KAAAA,KAAUqB,6BAAAA,CAAeC,OAAO,IAAIJ,SAAAA;AAChIK,QAAAA,QAAAA,EAAAA,WAAAA,CAAY5B,OAAAA,EAASG,YAAAA,EAAcK,OAAAA,EAASH,KAAAA,EAAOC,QAAAA,EAAUC,QAAAA;;AAG1E;AAEA,SAASqB,WAAAA,CAAY5B,OAA0B,EAAEG,YAAsD,EAAEK,OAA0B,EAAEH,KAAqB,EAAEC,QAAkB,EAAEC,QAAmB,EAAA;IAC/L,OAAQF,KAAAA;AACJ,QAAA,KAAKqB,8BAAeC,OAAO;AACvB,YAAA,qBACIE,eAAA,CAACC,KAAAA,EAAAA;gBAAIf,SAAAA,EAAU,qBAAA;gBAAsBO,IAAAA,EAAK,QAAA;;kCACtCT,cAAA,CAACkB,MAAAA,EAAAA;wBAAKhB,SAAAA,EAAU,4BAAA;AAA8BP,wBAAAA,QAAAA,EAAAA,OAAAA,CAAQwB;;AACrD1B,oBAAAA,QAAAA,CAAS2B,GAAG,CAAC,CAACC,KAAAA,EAAOC,sBAAUtB,cAAA,CAACkB,MAAAA,EAAAA;4BAAiBhB,SAAAA,EAAU,2BAAA;4BAA4BqB,KAAAA,EAAO;gCAAEF,KAAAA,EAAO,CAAA,EAAGA,KAAAA,CAAM,CAAC;AAAE,6BAAA;4BAAGG,aAAAA,EAAY;AAAxFF,yBAAAA,EAAAA,KAAAA,CAAAA;;;AAGvD,QAAA,KAAKT,8BAAeY,KAAK;AACrB,YAAA,qBAAOzB,cAAA,CAAC0B,cAAAA,EAAAA;gBAAevC,OAAAA,EAASA,OAAAA;gBAASG,YAAAA,EAAcA,YAAAA;gBAAcK,OAAAA,EAASA;;AAClF,QAAA,KAAKkB,8BAAec,KAAK;AACrB,YAAA,qBACIX,eAAA,CAACC,KAAAA,EAAAA;gBAAIf,SAAAA,EAAU,oBAAA;gBAAqB0B,WAAAA,EAAU,QAAA;gBAASnB,IAAAA,EAAK,OAAA;;kCACxDT,cAAA,CAAC6B,6BAAAA,EAAAA;wBAAetC,IAAAA,EAAK;;kCACrByB,eAAA,CAACC,KAAAA,EAAAA;wBAAIf,SAAAA,EAAU,yBAAA;;0CACXF,cAAA,CAAC8B,QAAAA,EAAAA;AAAQnC,gCAAAA,QAAAA,EAAAA,OAAAA,CAAQoC;;0CACjB/B,cAAA,CAACkB,MAAAA,EAAAA;0CAAM,OAAO/B,OAAAA,CAAQY,UAAU,CAACiC,KAAK,KAAK,QAAA,IAAY7C,OAAAA,CAAQY,UAAU,CAACiC,KAAK,CAACC,MAAM,GAAG,IAAI9C,OAAAA,CAAQY,UAAU,CAACiC,KAAK,GAAGrC,QAAQuC;;;;kCAEpIlC,cAAA,CAACmC,yBAAAA,EAAAA;wBAAaC,QAAAA,EAAS,WAAA;AAAYC,wBAAAA,cAAAA,EAAgB1C,QAAQ2C,oBAAoB;AAAEC,wBAAAA,OAAAA,EAASjD,YAAAA,EAAciD,OAAAA;AAAU5C,wBAAAA,QAAAA,EAAAA,OAAAA,CAAQ6C;;;;AAGtI,QAAA,KAAK3B,8BAAe4B,YAAY;AAAE,YAAA;AAC9B,gBAAA,MAAMC,OAAAA,GAAUtD,oCAAAA,CAAmBD,OAAAA,EAAS,mBAAA,CAAA,IAAwBQ,QAAQgD,mBAAmB;AAC/F,gBAAA,qBACI3B,eAAA,CAACC,KAAAA,EAAAA;oBAAIf,SAAAA,EAAU,oBAAA;oBAAqB0B,WAAAA,EAAU,SAAA;oBAAUnB,IAAAA,EAAK,QAAA;;sCACzDT,cAAA,CAAC6B,6BAAAA,EAAAA;4BAAetC,IAAAA,EAAK;;sCACrByB,eAAA,CAACC,KAAAA,EAAAA;4BAAIf,SAAAA,EAAU,yBAAA;;8CACXF,cAAA,CAAC8B,QAAAA,EAAAA;AAAQnC,oCAAAA,QAAAA,EAAAA,OAAAA,CAAQiD;;8CACjB5C,cAAA,CAACkB,MAAAA,EAAAA;8CAAM2B,4BAAAA,CAAWlD,OAAAA,CAAQmD,gBAAgB,EAAE;AAAEJ,wCAAAA;AAAQ,qCAAA;;;;;;AAItE,YAAA;AAEA,QAAA,KAAK7B,8BAAekC,OAAO;YACvB,qBACI/B,eAAA,CAAAgC,mBAAA,EAAA;;kCACIhC,eAAA,CAACC,KAAAA,EAAAA;wBAAIf,SAAAA,EAAU,oBAAA;wBAAqB0B,WAAAA,EAAU,SAAA;wBAAUnB,IAAAA,EAAK,QAAA;;0CACzDT,cAAA,CAAC6B,6BAAAA,EAAAA;gCAAetC,IAAAA,EAAK;;0CACrByB,eAAA,CAACC,KAAAA,EAAAA;gCAAIf,SAAAA,EAAU,yBAAA;;kDACXF,cAAA,CAAC8B,QAAAA,EAAAA;AAAQnC,wCAAAA,QAAAA,EAAAA,OAAAA,CAAQsD;;AAChBC,oCAAAA,6BAAAA,CAAY/D,OAAAA,EAAS,eAAA,CAAA,CAAiB8C,MAAM,GAAG,mBAAKjC,cAAA,CAACkB,MAAAA,EAAAA;kDAAM2B,4BAAAA,CAAWlD,OAAAA,CAAQwD,WAAW,EAAE;AAAEC,4CAAAA,OAAAA,EAASF,6BAAAA,CAAY/D,OAAAA,EAAS,eAAA,CAAA,CAAiBkE,IAAI,CAAC,IAAA;AAAM,yCAAA;;;;0CAE5JrD,cAAA,CAACmC,yBAAAA,EAAAA;gCAAaC,QAAAA,EAAS,WAAA;AAAYC,gCAAAA,cAAAA,EAAgB1C,QAAQ2C,oBAAoB;AAAEC,gCAAAA,OAAAA,EAASjD,YAAAA,EAAciD,OAAAA;AAAU5C,gCAAAA,QAAAA,EAAAA,OAAAA,CAAQ6C;;;;AAE7H9C,oBAAAA;;;AAGb,QAAA;YACI,qBAAOM,cAAA,CAAAgD,mBAAA,EAAA;AAAGtD,gBAAAA,QAAAA,EAAAA;;AAClB;AACJ;AAEA,iIACO,SAASgC,cAAAA,CAAe,EAAEvC,OAAO,EAAEG,YAAY,EAAEK,OAAO,EAA2F,EAAA;AACtJ,IAAA,MAAM2D,IAAAA,GAAQlE,oCAAAA,CAAmBD,OAAAA,EAAS,WAAA,CAAA,IAAgBC,qCAAmBD,OAAAA,EAAS,MAAA,CAAA;AACtF,IAAA,MAAMoE,WAAAA,GAAcnE,oCAAAA,CAAmBD,OAAAA,EAAS,kBAAA,CAAA,IAAuBC,qCAAmBD,OAAAA,EAAS,aAAA,CAAA;AAEnG,IAAA,qBACI6B,eAAA,CAACC,KAAAA,EAAAA;QAAIf,SAAAA,EAAU,kBAAA;QAAmBO,IAAAA,EAAK,QAAA;;0BACnCT,cAAA,CAACkB,MAAAA,EAAAA;gBAAKhB,SAAAA,EAAU,uBAAA;AAAwB,gBAAA,QAAA,gBAAAF,cAAA,CAAC6B,6BAAAA,EAAAA;AAAetC,oBAAAA,IAAAA,EAAM+D,IAAAA,IAAQ;;;0BACtEtD,cAAA,CAAC8B,QAAAA,EAAAA;gBAAO5B,SAAAA,EAAU,2BAAA;AAA6Bd,gBAAAA,QAAAA,EAAAA,oCAAAA,CAAmBD,SAAS,eAAA,CAAA,IAAoBC,oCAAAA,CAAmBD,OAAAA,EAAS,UAAA,CAAA,IAAeQ,QAAQ6D;;0BAClJxD,cAAA,CAACkB,MAAAA,EAAAA;gBAAKhB,SAAAA,EAAU,uBAAA;AAAyBd,gBAAAA,QAAAA,EAAAA,oCAAAA,CAAmBD,SAAS,WAAA,CAAA,IAAgBC,oCAAAA,CAAmBD,OAAAA,EAAS,MAAA,CAAA,IAAWQ,QAAQ8D;;AACnIF,YAAAA,WAAAA,kBACGvD,cAAA,CAACmC,yBAAAA,EAAAA;AAAauB,gBAAAA,IAAAA,EAAMC,kCAAmBxE,OAAAA,EAAS,kBAAA,CAAA;AAAqBkD,gBAAAA,cAAAA,EAAgB1C,QAAQ2C,oBAAoB;AAAEC,gBAAAA,OAAAA,EAASjD,YAAAA,EAAciD,OAAAA;AAAUgB,gBAAAA,QAAAA,EAAAA;;;;AAIpK;;;"}

package/dist/cjs/foundation/StatusChip.js

@@ -0,0 +1,64 @@
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var foundationStrings = require('./foundationStrings.js');
+var FoundationIcon = require('./FoundationIcon.js');
+var elementProperties = require('../shell/elementProperties.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The semantic tone of a status. */ var StatusTone = /*#__PURE__*/ function(StatusTone) {
+    StatusTone["Success"] = "success";
+    StatusTone["Warning"] = "warning";
+    StatusTone["Danger"] = "danger";
+    StatusTone["Info"] = "info";
+    StatusTone["Neutral"] = "neutral";
+    return StatusTone;
+}({});
+/** The icon each tone gets, so a status is told by shape as well as color (WCAG 1.4.1). */ const statusToneIcons = {
+    ["success"]: 'check',
+    ["warning"]: 'alert',
+    ["danger"]: 'close',
+    ["info"]: 'info',
+    ["neutral"]: 'circle'
+};
+/** Reads a tone, defaulting to Neutral. */ function readStatusTone(value) {
+    return Object.values(StatusTone).includes(value) ? value : "neutral";
+}
+/**
+ * The `statusChip` component: a status as a semantic color, an icon and its text.
+ *
+ * The text is always shown - the status of a record is never only a colored dot - and the tone picks the icon and the color from
+ * the theme's status tokens. A status the application names ("Awaiting approval") is its own `status` text; `tone` maps it onto
+ * one of the five tones.
+ */ function StatusChip({ element }) {
+    const tone = readStatusTone(element.properties.tone);
+    const strings = foundationStrings.readFoundationStrings(element);
+    const fallback = {
+        success: strings.statusSuccess,
+        warning: strings.statusWarning,
+        danger: strings.statusDanger,
+        info: strings.statusInfo,
+        neutral: strings.statusNeutral
+    }[tone];
+    const text = elementProperties.readString(element, 'status', elementProperties.readOptionalString(element, 'label') ?? fallback);
+    return /*#__PURE__*/ jsxRuntime.jsxs("span", {
+        className: "foundation foundation-chip foundation-status-chip",
+        "data-scene-id": element.id,
+        "data-tone": tone,
+        children: [
+            /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                name: statusToneIcons[tone]
+            }),
+            /*#__PURE__*/ jsxRuntime.jsx("span", {
+                children: text
+            })
+        ]
+    });
+}
+
+exports.StatusChip = StatusChip;
+exports.StatusTone = StatusTone;
+exports.readStatusTone = readStatusTone;
+exports.statusToneIcons = statusToneIcons;
+//# sourceMappingURL=StatusChip.js.map

package/dist/cjs/foundation/StatusChip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusChip.js","sources":["../../../foundation/StatusChip.tsx"],"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 { RegisteredComponentProps } from '@cratis/scene.react';\nimport { readFoundationStrings } from './foundationStrings';\nimport { FoundationIcon, FoundationIconName } from './FoundationIcon';\nimport { readOptionalString, readString } from '../shell/elementProperties';\n\n/** The semantic tone of a status. */\nexport enum StatusTone {\n    Success = 'success',\n    Warning = 'warning',\n    Danger = 'danger',\n    Info = 'info',\n    Neutral = 'neutral',\n}\n\n/** The icon each tone gets, so a status is told by shape as well as color (WCAG 1.4.1). */\nexport const statusToneIcons: Record<StatusTone, FoundationIconName> = {\n    [StatusTone.Success]: 'check',\n    [StatusTone.Warning]: 'alert',\n    [StatusTone.Danger]: 'close',\n    [StatusTone.Info]: 'info',\n    [StatusTone.Neutral]: 'circle',\n};\n\n/** Reads a tone, defaulting to Neutral. */\nexport function readStatusTone(value: unknown): StatusTone {\n    return (Object.values(StatusTone) as string[]).includes(value as string) ? (value as StatusTone) : StatusTone.Neutral;\n}\n\n/**\n * The `statusChip` component: a status as a semantic color, an icon and its text.\n *\n * The text is always shown - the status of a record is never only a colored dot - and the tone picks the icon and the color from\n * the theme's status tokens. A status the application names (\"Awaiting approval\") is its own `status` text; `tone` maps it onto\n * one of the five tones.\n */\nexport function StatusChip({ element }: RegisteredComponentProps) {\n    const tone = readStatusTone(element.properties.tone);\n    const strings = readFoundationStrings(element);\n    const fallback = { success: strings.statusSuccess, warning: strings.statusWarning, danger: strings.statusDanger, info: strings.statusInfo, neutral: strings.statusNeutral }[tone];\n    const text = readString(element, 'status', readOptionalString(element, 'label') ?? fallback);\n\n    return (\n        <span className='foundation foundation-chip foundation-status-chip' data-scene-id={element.id} data-tone={tone}>\n            <FoundationIcon name={statusToneIcons[tone]} />\n            <span>{text}</span>\n        </span>\n    );\n}\n"],"names":["StatusTone","statusToneIcons","readStatusTone","value","Object","values","includes","StatusChip","element","tone","properties","strings","readFoundationStrings","fallback","success","statusSuccess","warning","statusWarning","danger","statusDanger","info","statusInfo","neutral","statusNeutral","text","readString","readOptionalString","_jsxs","span","className","data-scene-id","id","data-tone","_jsx","FoundationIcon","name"],"mappings":";;;;;;;AAAA;AACA;AAOA,sCACO,IAAKA,UAAAA,iBAAAA,SAAAA,UAAAA,EAAAA;;;;;;AAAAA,IAAAA,OAAAA,UAAAA;AAMX,CAAA,CAAA,EAAA;AAED,4FACO,MAAMC,eAAAA,GAA0D;AACnE,IAAA,CAAA,SAAA,GAAsB,OAAA;AACtB,IAAA,CAAA,SAAA,GAAsB,OAAA;AACtB,IAAA,CAAA,QAAA,GAAqB,OAAA;AACrB,IAAA,CAAA,MAAA,GAAmB,MAAA;AACnB,IAAA,CAAA,SAAA,GAAsB;AAC1B;AAEA,4CACO,SAASC,cAAAA,CAAeC,KAAc,EAAA;AACzC,IAAA,OAAO,MAACC,CAAOC,MAAM,CAACL,UAAAA,CAAAA,CAAyBM,QAAQ,CAACH,KAAAA,CAAAA,GAAoBA,KAAAA,GAAAA,SAAAA;AAChF;AAEA;;;;;;AAMC,IACM,SAASI,UAAAA,CAAW,EAAEC,OAAO,EAA4B,EAAA;AAC5D,IAAA,MAAMC,IAAAA,GAAOP,cAAAA,CAAeM,OAAAA,CAAQE,UAAU,CAACD,IAAI,CAAA;AACnD,IAAA,MAAME,UAAUC,uCAAAA,CAAsBJ,OAAAA,CAAAA;AACtC,IAAA,MAAMK,QAAAA,GAAW;AAAEC,QAAAA,OAAAA,EAASH,QAAQI,aAAa;AAAEC,QAAAA,OAAAA,EAASL,QAAQM,aAAa;AAAEC,QAAAA,MAAAA,EAAQP,QAAQQ,YAAY;AAAEC,QAAAA,IAAAA,EAAMT,QAAQU,UAAU;AAAEC,QAAAA,OAAAA,EAASX,QAAQY;AAAc,KAAC,CAACd,IAAAA,CAAK;AACjL,IAAA,MAAMe,OAAOC,4BAAAA,CAAWjB,OAAAA,EAAS,QAAA,EAAUkB,oCAAAA,CAAmBlB,SAAS,OAAA,CAAA,IAAYK,QAAAA,CAAAA;AAEnF,IAAA,qBACIc,eAAA,CAACC,MAAAA,EAAAA;QAAKC,SAAAA,EAAU,mDAAA;AAAoDC,QAAAA,eAAAA,EAAetB,QAAQuB,EAAE;QAAEC,WAAAA,EAAWvB,IAAAA;;0BACtGwB,cAAA,CAACC,6BAAAA,EAAAA;gBAAeC,IAAAA,EAAMlC,eAAe,CAACQ,IAAAA;;0BACtCwB,cAAA,CAACL,MAAAA,EAAAA;AAAMJ,gBAAAA,QAAAA,EAAAA;;;;AAGnB;;;;;"}

package/dist/cjs/foundation/TrendChip.js

@@ -0,0 +1,93 @@
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var FoundationIcon = require('./FoundationIcon.js');
+var formatting = require('./formatting.js');
+var foundationStrings = require('./foundationStrings.js');
+var elementProperties = require('../shell/elementProperties.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The direction a change moved in. */ function trendDirection(change) {
+    return change > 0 ? 'up' : change < 0 ? 'down' : 'flat';
+}
+/** Whether a movement is good for a measure, given which direction is the good one. */ function trendOutcome(direction, goodDirection) {
+    return direction === 'flat' ? 'neutral' : direction === goodDirection ? 'good' : 'bad';
+}
+/** The tone each outcome is drawn in. */ const tones = {
+    good: 'success',
+    bad: 'danger',
+    neutral: 'neutral'
+};
+/**
+ * A change, drawn as an arrow, the change and what it is compared to.
+ *
+ * Color says whether the movement is good, but never alone: the arrow gives direction and a visually hidden sentence
+ * says all of it ("up 12.5% compared to last month"), so the chip reads the same without color.
+ */ function TrendChipView({ change, locale, goodDirection = 'up', comparison, format = formatting.NumberFormat.Percent, strings }) {
+    const direction = trendDirection(change);
+    const outcome = trendOutcome(direction, goodDirection);
+    const magnitude = formatting.formatNumber(Math.abs(change), locale, format);
+    const spoken = direction === 'flat' ? strings.trendFlat : foundationStrings.formatText(direction === 'up' ? strings.trendUp : strings.trendDown, {
+        value: magnitude
+    });
+    return /*#__PURE__*/ jsxRuntime.jsxs("span", {
+        className: "foundation-chip foundation-trend",
+        "data-tone": tones[outcome],
+        "data-direction": direction,
+        children: [
+            /*#__PURE__*/ jsxRuntime.jsx(FoundationIcon.FoundationIcon, {
+                name: direction === 'up' ? 'arrow-up' : direction === 'down' ? 'arrow-down' : 'minus'
+            }),
+            /*#__PURE__*/ jsxRuntime.jsx("span", {
+                "aria-hidden": "true",
+                children: direction === 'flat' ? magnitude : magnitude
+            }),
+            /*#__PURE__*/ jsxRuntime.jsxs("span", {
+                className: "foundation-visually-hidden",
+                children: [
+                    spoken,
+                    comparison ? ` ${foundationStrings.formatText(strings.trendComparison, {
+                        period: comparison
+                    })}` : ''
+                ]
+            }),
+            comparison && /*#__PURE__*/ jsxRuntime.jsx("span", {
+                className: "foundation-trend-comparison",
+                "aria-hidden": "true",
+                children: foundationStrings.formatText(strings.trendComparison, {
+                    period: comparison
+                })
+            })
+        ]
+    });
+}
+/**
+ * The `trendChip` component: a change with its direction, whether that is good, and what it is compared to.
+ *
+ * `change` is the movement as a number (a percentage by default), `goodDirection` says which way is good, and `comparison` names
+ * the period. Without a number the chip is empty, and then it draws nothing rather than an invented zero.
+ */ function TrendChip({ element }) {
+    const change = element.properties.change;
+    if (typeof change !== 'number') return undefined;
+    return /*#__PURE__*/ jsxRuntime.jsx("span", {
+        className: "foundation foundation-trend-chip",
+        "data-scene-id": element.id,
+        children: /*#__PURE__*/ jsxRuntime.jsx(TrendChipView, {
+            change: change,
+            locale: formatting.readLocale(element),
+            goodDirection: element.properties.goodDirection === 'down' ? 'down' : 'up',
+            comparison: elementProperties.readOptionalString(element, 'comparison'),
+            strings: foundationStrings.readFoundationStrings(element),
+            ...typeof element.properties.format === 'string' && Object.values(formatting.NumberFormat).includes(element.properties.format) ? {
+                format: element.properties.format
+            } : {}
+        })
+    });
+}
+
+exports.TrendChip = TrendChip;
+exports.TrendChipView = TrendChipView;
+exports.trendDirection = trendDirection;
+exports.trendOutcome = trendOutcome;
+//# sourceMappingURL=TrendChip.js.map

package/dist/cjs/foundation/TrendChip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TrendChip.js","sources":["../../../foundation/TrendChip.tsx"],"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 { RegisteredComponentProps } from '@cratis/scene.react';\nimport { FoundationIcon } from './FoundationIcon';\nimport { formatNumber, NumberFormat, readLocale } from './formatting';\nimport { formatText, readFoundationStrings } from './foundationStrings';\nimport { readOptionalString } from '../shell/elementProperties';\n\n/** The direction a measure moved. */\nexport type TrendDirection = 'up' | 'down' | 'flat';\n\n/** Whether a movement is good, bad or neither, which is independent of whether the number rose: falling response time is good. */\nexport type TrendOutcome = 'good' | 'bad' | 'neutral';\n\n/** The direction a change moved in. */\nexport function trendDirection(change: number): TrendDirection {\n    return change > 0 ? 'up' : change < 0 ? 'down' : 'flat';\n}\n\n/** Whether a movement is good for a measure, given which direction is the good one. */\nexport function trendOutcome(direction: TrendDirection, goodDirection: 'up' | 'down'): TrendOutcome {\n    return direction === 'flat' ? 'neutral' : direction === goodDirection ? 'good' : 'bad';\n}\n\n/** The tone each outcome is drawn in. */\nconst tones: Record<TrendOutcome, string> = { good: 'success', bad: 'danger', neutral: 'neutral' };\n\n/** The props of a trend chip drawn directly, as the stat card does. */\nexport interface TrendChipViewProps {\n    change: number;\n    locale: string;\n    goodDirection?: 'up' | 'down';\n    comparison?: string;\n    format?: NumberFormat;\n    strings: ReturnType<typeof readFoundationStrings>;\n}\n\n/**\n * A change, drawn as an arrow, the change and what it is compared to.\n *\n * Color says whether the movement is good, but never alone: the arrow gives direction and a visually hidden sentence\n * says all of it (\"up 12.5% compared to last month\"), so the chip reads the same without color.\n */\nexport function TrendChipView({ change, locale, goodDirection = 'up', comparison, format = NumberFormat.Percent, strings }: TrendChipViewProps) {\n    const direction = trendDirection(change);\n    const outcome = trendOutcome(direction, goodDirection);\n    const magnitude = formatNumber(Math.abs(change), locale, format);\n    const spoken = direction === 'flat' ? strings.trendFlat : formatText(direction === 'up' ? strings.trendUp : strings.trendDown, { value: magnitude });\n\n    return (\n        <span className='foundation-chip foundation-trend' data-tone={tones[outcome]} data-direction={direction}>\n            <FoundationIcon name={direction === 'up' ? 'arrow-up' : direction === 'down' ? 'arrow-down' : 'minus'} />\n            <span aria-hidden='true'>{direction === 'flat' ? magnitude : magnitude}</span>\n            <span className='foundation-visually-hidden'>{spoken}{comparison ? ` ${formatText(strings.trendComparison, { period: comparison })}` : ''}</span>\n            {comparison && <span className='foundation-trend-comparison' aria-hidden='true'>{formatText(strings.trendComparison, { period: comparison })}</span>}\n        </span>\n    );\n}\n\n/**\n * The `trendChip` component: a change with its direction, whether that is good, and what it is compared to.\n *\n * `change` is the movement as a number (a percentage by default), `goodDirection` says which way is good, and `comparison` names\n * the period. Without a number the chip is empty, and then it draws nothing rather than an invented zero.\n */\nexport function TrendChip({ element }: RegisteredComponentProps) {\n    const change = element.properties.change;\n    if (typeof change !== 'number') return undefined;\n\n    return (\n        <span className='foundation foundation-trend-chip' data-scene-id={element.id}>\n            <TrendChipView change={change} locale={readLocale(element)} goodDirection={element.properties.goodDirection === 'down' ? 'down' : 'up'}\n                comparison={readOptionalString(element, 'comparison')} strings={readFoundationStrings(element)}\n                {...(typeof element.properties.format === 'string' && (Object.values(NumberFormat) as string[]).includes(element.properties.format) ? { format: element.properties.format as NumberFormat } : {})} />\n        </span>\n    );\n}\n"],"names":["trendDirection","change","trendOutcome","direction","goodDirection","tones","good","bad","neutral","TrendChipView","locale","comparison","format","NumberFormat","Percent","strings","outcome","magnitude","formatNumber","Math","abs","spoken","trendFlat","formatText","trendUp","trendDown","value","_jsxs","span","className","data-tone","data-direction","_jsx","FoundationIcon","name","aria-hidden","trendComparison","period","TrendChip","element","properties","undefined","data-scene-id","id","readLocale","readOptionalString","readFoundationStrings","Object","values","includes"],"mappings":";;;;;;;;AAAA;AACA;AAcA,wCACO,SAASA,cAAAA,CAAeC,MAAc,EAAA;AACzC,IAAA,OAAOA,MAAAA,GAAS,CAAA,GAAI,IAAA,GAAOA,MAAAA,GAAS,IAAI,MAAA,GAAS,MAAA;AACrD;AAEA,wFACO,SAASC,YAAAA,CAAaC,SAAyB,EAAEC,aAA4B,EAAA;AAChF,IAAA,OAAOD,SAAAA,KAAc,MAAA,GAAS,SAAA,GAAYA,SAAAA,KAAcC,gBAAgB,MAAA,GAAS,KAAA;AACrF;AAEA,0CACA,MAAMC,KAAAA,GAAsC;IAAEC,IAAAA,EAAM,SAAA;IAAWC,GAAAA,EAAK,QAAA;IAAUC,OAAAA,EAAS;AAAU,CAAA;AAYjG;;;;;AAKC,IACM,SAASC,aAAAA,CAAc,EAAER,MAAM,EAAES,MAAM,EAAEN,aAAAA,GAAgB,IAAI,EAAEO,UAAU,EAAEC,MAAAA,GAASC,wBAAaC,OAAO,EAAEC,OAAO,EAAsB,EAAA;AAC1I,IAAA,MAAMZ,YAAYH,cAAAA,CAAeC,MAAAA,CAAAA;IACjC,MAAMe,OAAAA,GAAUd,aAAaC,SAAAA,EAAWC,aAAAA,CAAAA;AACxC,IAAA,MAAMa,YAAYC,uBAAAA,CAAaC,IAAAA,CAAKC,GAAG,CAACnB,SAASS,MAAAA,EAAQE,MAAAA,CAAAA;AACzD,IAAA,MAAMS,MAAAA,GAASlB,SAAAA,KAAc,MAAA,GAASY,OAAAA,CAAQO,SAAS,GAAGC,4BAAAA,CAAWpB,SAAAA,KAAc,IAAA,GAAOY,OAAAA,CAAQS,OAAO,GAAGT,OAAAA,CAAQU,SAAS,EAAE;QAAEC,KAAAA,EAAOT;AAAU,KAAA,CAAA;AAElJ,IAAA,qBACIU,eAAA,CAACC,MAAAA,EAAAA;QAAKC,SAAAA,EAAU,kCAAA;QAAmCC,WAAAA,EAAWzB,KAAK,CAACW,OAAAA,CAAQ;QAAEe,gBAAAA,EAAgB5B,SAAAA;;0BAC1F6B,cAAA,CAACC,6BAAAA,EAAAA;AAAeC,gBAAAA,IAAAA,EAAM/B,SAAAA,KAAc,IAAA,GAAO,UAAA,GAAaA,SAAAA,KAAc,SAAS,YAAA,GAAe;;0BAC9F6B,cAAA,CAACJ,MAAAA,EAAAA;gBAAKO,aAAAA,EAAY,MAAA;AAAQhC,gBAAAA,QAAAA,EAAAA,SAAAA,KAAc,SAASc,SAAAA,GAAYA;;0BAC7DU,eAAA,CAACC,MAAAA,EAAAA;gBAAKC,SAAAA,EAAU,4BAAA;;AAA8BR,oBAAAA,MAAAA;AAAQV,oBAAAA,UAAAA,GAAa,CAAC,CAAC,EAAEY,4BAAAA,CAAWR,OAAAA,CAAQqB,eAAe,EAAE;wBAAEC,MAAAA,EAAQ1B;AAAW,qBAAA,CAAA,CAAA,CAAI,GAAG;;;AACtIA,YAAAA,UAAAA,kBAAcqB,cAAA,CAACJ,MAAAA,EAAAA;gBAAKC,SAAAA,EAAU,6BAAA;gBAA8BM,aAAAA,EAAY,MAAA;0BAAQZ,4BAAAA,CAAWR,OAAAA,CAAQqB,eAAe,EAAE;oBAAEC,MAAAA,EAAQ1B;AAAW,iBAAA;;;;AAGtJ;AAEA;;;;;AAKC,IACM,SAAS2B,SAAAA,CAAU,EAAEC,OAAO,EAA4B,EAAA;AAC3D,IAAA,MAAMtC,MAAAA,GAASsC,OAAAA,CAAQC,UAAU,CAACvC,MAAM;IACxC,IAAI,OAAOA,MAAAA,KAAW,QAAA,EAAU,OAAOwC,SAAAA;AAEvC,IAAA,qBACIT,cAAA,CAACJ,MAAAA,EAAAA;QAAKC,SAAAA,EAAU,kCAAA;AAAmCa,QAAAA,eAAAA,EAAeH,QAAQI,EAAE;AACxE,QAAA,QAAA,gBAAAX,cAAA,CAACvB,aAAAA,EAAAA;YAAcR,MAAAA,EAAQA,MAAAA;AAAQS,YAAAA,MAAAA,EAAQkC,qBAAAA,CAAWL,OAAAA,CAAAA;AAAUnC,YAAAA,aAAAA,EAAemC,QAAQC,UAAU,CAACpC,aAAa,KAAK,SAAS,MAAA,GAAS,IAAA;AAC9HO,YAAAA,UAAAA,EAAYkC,qCAAmBN,OAAAA,EAAS,YAAA,CAAA;AAAexB,YAAAA,OAAAA,EAAS+B,uCAAAA,CAAsBP,OAAAA,CAAAA;AACrF,YAAA,GAAI,OAAOA,OAAAA,CAAQC,UAAU,CAAC5B,MAAM,KAAK,YAAY,MAACmC,CAAOC,MAAM,CAACnC,yBAA2BoC,QAAQ,CAACV,QAAQC,UAAU,CAAC5B,MAAM,CAAA,GAAI;gBAAEA,MAAAA,EAAQ2B,OAAAA,CAAQC,UAAU,CAAC5B;AAAuB,aAAA,GAAI;;;AAG9M;;;;;"}

package/dist/cjs/foundation/formatting.js

@@ -0,0 +1,85 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** How a number is presented. */ var NumberFormat = /*#__PURE__*/ function(NumberFormat) {
+    NumberFormat["Number"] = "number";
+    NumberFormat["Currency"] = "currency";
+    NumberFormat["Percent"] = "percent";
+    NumberFormat["Compact"] = "compact";
+    return NumberFormat;
+}({});
+/**
+ * The locale a component formats dates, numbers and currency in: the element's `locale`, else the document language, else the
+ * runtime's. Formatting never goes through a fixed locale, so the same screen reads correctly in every one.
+ */ function readLocale(element) {
+    const supplied = element.properties.locale;
+    if (typeof supplied === 'string' && supplied.length > 0) return supplied;
+    if (typeof document !== 'undefined' && document.documentElement.lang) return document.documentElement.lang;
+    return typeof navigator !== 'undefined' && navigator.language ? navigator.language : 'en';
+}
+/** Whether the locale reads right to left, so a component can mirror what direction-sensitive CSS cannot. */ function isRightToLeft(locale) {
+    try {
+        const info = new Intl.Locale(locale);
+        const direction = info.getTextInfo?.().direction ?? info.textInfo?.direction;
+        return direction === 'rtl';
+    } catch  {
+        return false;
+    }
+}
+/** Formats a number for a locale, as a plain number, currency, percent (the value is the percentage, 12.5 is 12.5%) or compact. */ function formatNumber(value, locale, format = "number", currency = 'USD', maximumFractionDigits) {
+    try {
+        switch(format){
+            case "currency":
+                return new Intl.NumberFormat(locale, {
+                    style: 'currency',
+                    currency,
+                    ...maximumFractionDigits === undefined ? {} : {
+                        maximumFractionDigits
+                    }
+                }).format(value);
+            case "percent":
+                return new Intl.NumberFormat(locale, {
+                    style: 'percent',
+                    maximumFractionDigits: maximumFractionDigits ?? 1
+                }).format(value / 100);
+            case "compact":
+                return new Intl.NumberFormat(locale, {
+                    notation: 'compact',
+                    maximumFractionDigits: maximumFractionDigits ?? 1
+                }).format(value);
+            default:
+                return new Intl.NumberFormat(locale, {
+                    maximumFractionDigits: maximumFractionDigits ?? 2
+                }).format(value);
+        }
+    } catch  {
+        return String(value);
+    }
+}
+/** Reads a number format name, defaulting to a plain number. */ function readNumberFormat(element, property = 'format') {
+    const value = element.properties[property];
+    return Object.values(NumberFormat).includes(value) ? value : "number";
+}
+/** Formats a date or an ISO 8601 date-time for a locale; a value that is not a date is returned as it was written. */ function formatDate(value, locale, withTime = false) {
+    const date = value instanceof Date ? value : typeof value === 'string' || typeof value === 'number' ? new Date(value) : undefined;
+    if (!date || Number.isNaN(date.getTime())) return typeof value === 'string' ? value : '';
+    try {
+        return new Intl.DateTimeFormat(locale, withTime ? {
+            dateStyle: 'medium',
+            timeStyle: 'short'
+        } : {
+            dateStyle: 'medium'
+        }).format(date);
+    } catch  {
+        return date.toISOString();
+    }
+}
+
+exports.NumberFormat = NumberFormat;
+exports.formatDate = formatDate;
+exports.formatNumber = formatNumber;
+exports.isRightToLeft = isRightToLeft;
+exports.readLocale = readLocale;
+exports.readNumberFormat = readNumberFormat;
+//# sourceMappingURL=formatting.js.map

package/dist/cjs/foundation/formatting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting.js","sources":["../../../foundation/formatting.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 { ExternalComponent } from '@cratis/scene.model';\n\n/** How a number is presented. */\nexport enum NumberFormat {\n    Number = 'number',\n    Currency = 'currency',\n    Percent = 'percent',\n    Compact = 'compact',\n}\n\n/**\n * The locale a component formats dates, numbers and currency in: the element's `locale`, else the document language, else the\n * runtime's. Formatting never goes through a fixed locale, so the same screen reads correctly in every one.\n */\nexport function readLocale(element: ExternalComponent): string {\n    const supplied = element.properties.locale;\n    if (typeof supplied === 'string' && supplied.length > 0) return supplied;\n    if (typeof document !== 'undefined' && document.documentElement.lang) return document.documentElement.lang;\n    return typeof navigator !== 'undefined' && navigator.language ? navigator.language : 'en';\n}\n\n/** Whether the locale reads right to left, so a component can mirror what direction-sensitive CSS cannot. */\nexport function isRightToLeft(locale: string): boolean {\n    try {\n        const info = new Intl.Locale(locale) as Intl.Locale & { getTextInfo?: () => { direction: string }; textInfo?: { direction: string } };\n        const direction = info.getTextInfo?.().direction ?? info.textInfo?.direction;\n        return direction === 'rtl';\n    } catch {\n        return false;\n    }\n}\n\n/** Formats a number for a locale, as a plain number, currency, percent (the value is the percentage, 12.5 is 12.5%) or compact. */\nexport function formatNumber(value: number, locale: string, format: NumberFormat = NumberFormat.Number, currency = 'USD', maximumFractionDigits?: number): string {\n    try {\n        switch (format) {\n            case NumberFormat.Currency:\n                return new Intl.NumberFormat(locale, { style: 'currency', currency, ...(maximumFractionDigits === undefined ? {} : { maximumFractionDigits }) }).format(value);\n            case NumberFormat.Percent:\n                return new Intl.NumberFormat(locale, { style: 'percent', maximumFractionDigits: maximumFractionDigits ?? 1 }).format(value / 100);\n            case NumberFormat.Compact:\n                return new Intl.NumberFormat(locale, { notation: 'compact', maximumFractionDigits: maximumFractionDigits ?? 1 }).format(value);\n            default:\n                return new Intl.NumberFormat(locale, { maximumFractionDigits: maximumFractionDigits ?? 2 }).format(value);\n        }\n    } catch {\n        return String(value);\n    }\n}\n\n/** Reads a number format name, defaulting to a plain number. */\nexport function readNumberFormat(element: ExternalComponent, property = 'format'): NumberFormat {\n    const value = element.properties[property];\n    return (Object.values(NumberFormat) as string[]).includes(value as string) ? (value as NumberFormat) : NumberFormat.Number;\n}\n\n/** Formats a date or an ISO 8601 date-time for a locale; a value that is not a date is returned as it was written. */\nexport function formatDate(value: unknown, locale: string, withTime = false): string {\n    const date = value instanceof Date ? value : typeof value === 'string' || typeof value === 'number' ? new Date(value) : undefined;\n    if (!date || Number.isNaN(date.getTime())) return typeof value === 'string' ? value : '';\n    try {\n        return new Intl.DateTimeFormat(locale, withTime ? { dateStyle: 'medium', timeStyle: 'short' } : { dateStyle: 'medium' }).format(date);\n    } catch {\n        return date.toISOString();\n    }\n}\n"],"names":["NumberFormat","readLocale","element","supplied","properties","locale","length","document","documentElement","lang","navigator","language","isRightToLeft","info","Intl","Locale","direction","getTextInfo","textInfo","formatNumber","value","format","currency","maximumFractionDigits","style","undefined","notation","String","readNumberFormat","property","Object","values","includes","formatDate","withTime","date","Date","Number","isNaN","getTime","DateTimeFormat","dateStyle","timeStyle","toISOString"],"mappings":";;AAAA;AACA;AAIA,kCACO,IAAKA,YAAAA,iBAAAA,SAAAA,YAAAA,EAAAA;;;;;AAAAA,IAAAA,OAAAA,YAAAA;AAKX,CAAA,CAAA,EAAA;AAED;;;IAIO,SAASC,UAAAA,CAAWC,OAA0B,EAAA;AACjD,IAAA,MAAMC,QAAAA,GAAWD,OAAAA,CAAQE,UAAU,CAACC,MAAM;AAC1C,IAAA,IAAI,OAAOF,QAAAA,KAAa,QAAA,IAAYA,SAASG,MAAM,GAAG,GAAG,OAAOH,QAAAA;AAChE,IAAA,IAAI,OAAOI,QAAAA,KAAa,WAAA,IAAeA,QAAAA,CAASC,eAAe,CAACC,IAAI,EAAE,OAAOF,QAAAA,CAASC,eAAe,CAACC,IAAI;IAC1G,OAAO,OAAOC,cAAc,WAAA,IAAeA,SAAAA,CAAUC,QAAQ,GAAGD,SAAAA,CAAUC,QAAQ,GAAG,IAAA;AACzF;AAEA,8GACO,SAASC,aAAAA,CAAcP,MAAc,EAAA;IACxC,IAAI;AACA,QAAA,MAAMQ,IAAAA,GAAO,IAAIC,IAAAA,CAAKC,MAAM,CAACV,MAAAA,CAAAA;AAC7B,QAAA,MAAMW,YAAYH,IAAAA,CAAKI,WAAW,KAAKD,SAAAA,IAAaH,IAAAA,CAAKK,QAAQ,EAAEF,SAAAA;AACnE,QAAA,OAAOA,SAAAA,KAAc,KAAA;AACzB,IAAA,CAAA,CAAE,OAAM;QACJ,OAAO,KAAA;AACX,IAAA;AACJ;AAEA,oIACO,SAASG,YAAAA,CAAaC,KAAa,EAAEf,MAAc,EAAEgB,MAAAA,GAAAA,QAA0C,EAAEC,QAAAA,GAAW,KAAK,EAAEC,qBAA8B,EAAA;IACpJ,IAAI;QACA,OAAQF,MAAAA;AACJ,YAAA,KAAA,UAAA;AACI,gBAAA,OAAO,IAAIP,IAAAA,CAAKd,YAAY,CAACK,MAAAA,EAAQ;oBAAEmB,KAAAA,EAAO,UAAA;AAAYF,oBAAAA,QAAAA;oBAAU,GAAIC,qBAAAA,KAA0BE,SAAAA,GAAY,EAAC,GAAI;AAAEF,wBAAAA;;AAAyB,iBAAA,CAAA,CAAGF,MAAM,CAACD,KAAAA,CAAAA;AAC5J,YAAA,KAAA,SAAA;AACI,gBAAA,OAAO,IAAIN,IAAAA,CAAKd,YAAY,CAACK,MAAAA,EAAQ;oBAAEmB,KAAAA,EAAO,SAAA;AAAWD,oBAAAA,qBAAAA,EAAuBA,qBAAAA,IAAyB;iBAAE,CAAA,CAAGF,MAAM,CAACD,KAAAA,GAAQ,GAAA,CAAA;AACjI,YAAA,KAAA,SAAA;AACI,gBAAA,OAAO,IAAIN,IAAAA,CAAKd,YAAY,CAACK,MAAAA,EAAQ;oBAAEqB,QAAAA,EAAU,SAAA;AAAWH,oBAAAA,qBAAAA,EAAuBA,qBAAAA,IAAyB;AAAE,iBAAA,CAAA,CAAGF,MAAM,CAACD,KAAAA,CAAAA;AAC5H,YAAA;AACI,gBAAA,OAAO,IAAIN,IAAAA,CAAKd,YAAY,CAACK,MAAAA,EAAQ;AAAEkB,oBAAAA,qBAAAA,EAAuBA,qBAAAA,IAAyB;AAAE,iBAAA,CAAA,CAAGF,MAAM,CAACD,KAAAA,CAAAA;AAC3G;AACJ,IAAA,CAAA,CAAE,OAAM;AACJ,QAAA,OAAOO,MAAAA,CAAOP,KAAAA,CAAAA;AAClB,IAAA;AACJ;AAEA,iEACO,SAASQ,iBAAiB1B,OAA0B,EAAE2B,WAAW,QAAQ,EAAA;AAC5E,IAAA,MAAMT,KAAAA,GAAQlB,OAAAA,CAAQE,UAAU,CAACyB,QAAAA,CAAS;AAC1C,IAAA,OAAO,MAACC,CAAOC,MAAM,CAAC/B,YAAAA,CAAAA,CAA2BgC,QAAQ,CAACZ,KAAAA,CAAAA,GAAoBA,KAAAA,GAAAA,QAAAA;AAClF;AAEA,uHACO,SAASa,UAAAA,CAAWb,KAAc,EAAEf,MAAc,EAAE6B,QAAAA,GAAW,KAAK,EAAA;AACvE,IAAA,MAAMC,IAAAA,GAAOf,KAAAA,YAAiBgB,IAAAA,GAAOhB,KAAAA,GAAQ,OAAOA,KAAAA,KAAU,QAAA,IAAY,OAAOA,KAAAA,KAAU,QAAA,GAAW,IAAIgB,IAAAA,CAAKhB,KAAAA,CAAAA,GAASK,SAAAA;AACxH,IAAA,IAAI,CAACU,IAAAA,IAAQE,MAAAA,CAAOC,KAAK,CAACH,IAAAA,CAAKI,OAAO,EAAA,CAAA,EAAK,OAAO,OAAOnB,KAAAA,KAAU,QAAA,GAAWA,KAAAA,GAAQ,EAAA;IACtF,IAAI;AACA,QAAA,OAAO,IAAIN,IAAAA,CAAK0B,cAAc,CAACnC,QAAQ6B,QAAAA,GAAW;YAAEO,SAAAA,EAAW,QAAA;YAAUC,SAAAA,EAAW;SAAQ,GAAI;YAAED,SAAAA,EAAW;AAAS,SAAA,CAAA,CAAGpB,MAAM,CAACc,IAAAA,CAAAA;AACpI,IAAA,CAAA,CAAE,OAAM;AACJ,QAAA,OAAOA,KAAKQ,WAAW,EAAA;AAC3B,IAAA;AACJ;;;;;;;"}