@cratis/scene.blueprint.default 4.30.0 → 4.32.0

package/dist/cjs/foundation/foundationComponentMetadata.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var scene_react = require('@cratis/scene.react');
+var ComponentName = require('../ComponentName.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The category, icon, keywords and picker badge of every foundation component (CMP1), keyed by bare component name.
+ * The names are those of `ComponentName`; the metadata of the rest of the package lives in `defaultBlueprintComponentMetadata`.
+ */ const foundationComponentMetadata = {
+    [ComponentName.ComponentName.EmptyState]: scene_react.componentMetadata('Empty state', scene_model.ComponentCategory.Feedback, 'inbox', [
+        'no data',
+        'nothing',
+        'blank slate',
+        'zero state'
+    ]),
+    [ComponentName.ComponentName.StatCard]: scene_react.componentMetadata('Stat card', scene_model.ComponentCategory.DataDisplay, 'gauge', [
+        'kpi',
+        'metric',
+        'figure',
+        'number',
+        'dashboard'
+    ]),
+    [ComponentName.ComponentName.TrendChip]: scene_react.componentMetadata('Trend chip', scene_model.ComponentCategory.DataDisplay, 'trending-up', [
+        'delta',
+        'change',
+        'arrow',
+        'comparison'
+    ]),
+    [ComponentName.ComponentName.StatusChip]: scene_react.componentMetadata('Status chip', scene_model.ComponentCategory.DataDisplay, 'badge-check', [
+        'badge',
+        'state',
+        'tag',
+        'label'
+    ])
+};
+
+exports.foundationComponentMetadata = foundationComponentMetadata;
+//# sourceMappingURL=foundationComponentMetadata.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"foundationComponentMetadata.js","sources":["../../../foundation/foundationComponentMetadata.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 { ComponentCategory } from '@cratis/scene.model';\nimport { ComponentMetadata, componentMetadata as m } from '@cratis/scene.react';\nimport { ComponentName } from '../ComponentName';\n\n/**\n * The category, icon, keywords and picker badge of every foundation component (CMP1), keyed by bare component name.\n * The names are those of `ComponentName`; the metadata of the rest of the package lives in `defaultBlueprintComponentMetadata`.\n */\nexport const foundationComponentMetadata: Record<string, ComponentMetadata> = {\n    [ComponentName.EmptyState]: m('Empty state', ComponentCategory.Feedback, 'inbox', ['no data', 'nothing', 'blank slate', 'zero state']),\n    [ComponentName.StatCard]: m('Stat card', ComponentCategory.DataDisplay, 'gauge', ['kpi', 'metric', 'figure', 'number', 'dashboard']),\n    [ComponentName.TrendChip]: m('Trend chip', ComponentCategory.DataDisplay, 'trending-up', ['delta', 'change', 'arrow', 'comparison']),\n    [ComponentName.StatusChip]: m('Status chip', ComponentCategory.DataDisplay, 'badge-check', ['badge', 'state', 'tag', 'label']),\n};\n"],"names":["foundationComponentMetadata","ComponentName","EmptyState","m","ComponentCategory","Feedback","StatCard","DataDisplay","TrendChip","StatusChip"],"mappings":";;;;;;AAAA;AACA;AAMA;;;UAIaA,2BAAAA,GAAiE;IAC1E,CAACC,2BAAAA,CAAcC,UAAU,GAAGC,8BAAE,aAAA,EAAeC,6BAAAA,CAAkBC,QAAQ,EAAE,OAAA,EAAS;AAAC,QAAA,SAAA;AAAW,QAAA,SAAA;AAAW,QAAA,aAAA;AAAe,QAAA;AAAa,KAAA,CAAA;IACrI,CAACJ,2BAAAA,CAAcK,QAAQ,GAAGH,8BAAE,WAAA,EAAaC,6BAAAA,CAAkBG,WAAW,EAAE,OAAA,EAAS;AAAC,QAAA,KAAA;AAAO,QAAA,QAAA;AAAU,QAAA,QAAA;AAAU,QAAA,QAAA;AAAU,QAAA;AAAY,KAAA,CAAA;IACnI,CAACN,2BAAAA,CAAcO,SAAS,GAAGL,8BAAE,YAAA,EAAcC,6BAAAA,CAAkBG,WAAW,EAAE,aAAA,EAAe;AAAC,QAAA,OAAA;AAAS,QAAA,QAAA;AAAU,QAAA,OAAA;AAAS,QAAA;AAAa,KAAA,CAAA;IACnI,CAACN,2BAAAA,CAAcQ,UAAU,GAAGN,8BAAE,aAAA,EAAeC,6BAAAA,CAAkBG,WAAW,EAAE,aAAA,EAAe;AAAC,QAAA,OAAA;AAAS,QAAA,OAAA;AAAS,QAAA,KAAA;AAAO,QAAA;AAAQ,KAAA;AACjI;;"}

package/dist/cjs/foundation/foundationDescriptors.js

@@ -0,0 +1,232 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var scene_react = require('@cratis/scene.react');
+var ComponentName = require('../ComponentName.js');
+var packageName = require('../packageName.js');
+var ComponentState = require('./ComponentState.js');
+var formatting = require('./formatting.js');
+var PermissionRule = require('./PermissionRule.js');
+var StatusChip = require('./StatusChip.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** Data properties take what a screen binds them to: a query's result, a data context or another component's output. */ const bindable = [
+    scene_model.BindingSourceKind.DataContext,
+    scene_model.BindingSourceKind.QueryResult,
+    scene_model.BindingSourceKind.ComponentProperty
+];
+const text = (path, label, group, description, extra = {})=>({
+        path,
+        label,
+        group,
+        valueType: scene_model.PropertyValueType.String,
+        ...group === 'Data' ? {
+            acceptedBindingKinds: bindable
+        } : {},
+        ...description === undefined ? {} : {
+            description
+        },
+        ...extra
+    });
+const number = (path, label, group, description, extra = {})=>({
+        path,
+        label,
+        group,
+        valueType: scene_model.PropertyValueType.Number,
+        editorKind: scene_model.PropertyEditorKind.Number,
+        ...group === 'Data' ? {
+            acceptedBindingKinds: bindable
+        } : {},
+        ...description === undefined ? {} : {
+            description
+        },
+        ...extra
+    });
+const flag = (path, label, group, description, extra = {})=>({
+        path,
+        label,
+        group,
+        valueType: scene_model.PropertyValueType.Boolean,
+        editorKind: scene_model.PropertyEditorKind.Boolean,
+        ...description === undefined ? {} : {
+            description
+        },
+        ...extra
+    });
+const choice = (path, label, group, values, defaultValue, description)=>({
+        path,
+        label,
+        group,
+        valueType: scene_model.PropertyValueType.Enum,
+        editorKind: scene_model.PropertyEditorKind.Enum,
+        default: defaultValue,
+        choices: Object.entries(values).map(([value, name])=>({
+                value,
+                label: name
+            })),
+        ...description === undefined ? {} : {
+            description
+        }
+    });
+const list = (path, label, group, itemLabel, properties, description)=>({
+        path,
+        label,
+        group,
+        valueType: scene_model.PropertyValueType.Collection,
+        default: [],
+        item: {
+            label: itemLabel,
+            properties
+        },
+        ...description === undefined ? {} : {
+            description
+        }
+    });
+const rule = (path, label, description)=>choice(path, label, 'Permissions', {
+        [PermissionRule.PermissionRule.Enabled]: 'Enabled',
+        [PermissionRule.PermissionRule.Disabled]: 'Disabled',
+        [PermissionRule.PermissionRule.Hidden]: 'Hidden'
+    }, PermissionRule.PermissionRule.Enabled, description);
+/** The properties every data-showing foundation component shares: the standard states (spec Part B 1.4) and the cross-cutting rules of 1.5. */ const standardStateProperties = [
+    choice('state', 'Preview state', 'State', {
+        [ComponentState.ComponentState.Ready]: 'Ready',
+        [ComponentState.ComponentState.Loading]: 'Loading',
+        [ComponentState.ComponentState.Empty]: 'Empty',
+        [ComponentState.ComponentState.Error]: 'Error',
+        [ComponentState.ComponentState.NoPermission]: 'No permission',
+        [ComponentState.ComponentState.Partial]: 'Partial'
+    }, ComponentState.ComponentState.Ready, 'Forces a state so each can be designed and previewed; empty means the state follows the bound data.'),
+    text('error', 'Error message', 'State', 'The message of the error state; setting it puts the component in that state.'),
+    flag('loading', 'Loading', 'State', 'Shows the skeleton while the data has not answered.'),
+    flag('forbidden', 'Not allowed', 'State', 'Shows the no-permission state, which explains what is missing and shows no data.'),
+    text('permissionSubject', 'What access is missing', 'State', 'Names what the user cannot see in the no-permission message.'),
+    {
+        path: 'failedRegions',
+        label: 'Failed regions',
+        group: 'State',
+        valueType: scene_model.PropertyValueType.Json,
+        editorKind: scene_model.PropertyEditorKind.StringList,
+        default: [],
+        description: 'The parts that failed to load; any entry puts the component in the partial state.'
+    },
+    text('emptyHeadline', 'Empty headline', 'State'),
+    text('emptyHint', 'Empty hint', 'State'),
+    text('emptyActionLabel', 'Empty action', 'State', 'The primary action offered when there is nothing to show.'),
+    rule('actionPermission', 'Empty action permission', 'Whether the empty state offers its action, refuses it with a reason, or does not render it.'),
+    text('label', 'Label', 'Accessibility', 'The accessible name of the region.'),
+    text('locale', 'Locale', 'Content', 'The locale dates, numbers and currency are formatted in; empty follows the document.'),
+    choice('density', 'Density', 'Appearance', {
+        comfortable: 'Comfortable',
+        compact: 'Compact'
+    }, 'comfortable'),
+    {
+        path: 'strings',
+        label: 'Text overrides',
+        group: 'Content',
+        valueType: scene_model.PropertyValueType.Object,
+        editorKind: scene_model.PropertyEditorKind.StringMap,
+        description: 'Replaces the text the component says itself, for localization.'
+    }
+];
+const key = (name)=>scene_react.componentRegistryKey(packageName.defaultBlueprintName, name);
+const formats = {
+    [formatting.NumberFormat.Number]: 'Number',
+    [formatting.NumberFormat.Currency]: 'Currency',
+    [formatting.NumberFormat.Percent]: 'Percent',
+    [formatting.NumberFormat.Compact]: 'Compact'
+};
+/** What can be edited on the foundation components (Part B 4). Each declares the shape of its data, never values (SD1). */ const foundationDescriptors = [
+    {
+        component: key(ComponentName.ComponentName.EmptyState),
+        displayName: 'Empty state',
+        description: 'An icon, a headline, a hint and one primary action; embeddable in any region.',
+        properties: [
+            text('headline', 'Headline', 'Content', undefined, {
+                default: 'Nothing here yet'
+            }),
+            text('hint', 'Hint', 'Content'),
+            text('icon', 'Icon', 'Appearance'),
+            text('actionLabel', 'Primary action', 'Behavior', 'The label of the one action the state offers; its behaviors say what it does.'),
+            rule('actionPermission', 'Action permission', 'Whether the action works, refuses with a reason, or is not rendered.'),
+            text('locale', 'Locale', 'Content'),
+            {
+                path: 'strings',
+                label: 'Text overrides',
+                group: 'Content',
+                valueType: scene_model.PropertyValueType.Object,
+                editorKind: scene_model.PropertyEditorKind.StringMap
+            }
+        ]
+    },
+    {
+        component: key(ComponentName.ComponentName.StatCard),
+        displayName: 'Stat card',
+        description: 'One key figure with its label, trend and the period the trend is compared to.',
+        properties: [
+            text('label', 'Label', 'Content', 'What the figure measures.', {
+                constraints: {
+                    required: true
+                }
+            }),
+            number('value', 'Value', 'Data', 'The figure; bind it to a query result.'),
+            choice('format', 'Format', 'Appearance', formats, formatting.NumberFormat.Number),
+            text('currency', 'Currency', 'Appearance', 'The ISO 4217 code when the format is currency.'),
+            number('fractionDigits', 'Fraction digits', 'Appearance'),
+            number('change', 'Change', 'Data', 'How much the figure moved, as a percentage; bind it to a query result.'),
+            choice('goodDirection', 'Good direction', 'Appearance', {
+                up: 'Up is good',
+                down: 'Down is good'
+            }, 'up', 'Which movement is good: a falling response time is.'),
+            text('comparison', 'Compared to', 'Content', 'The period the change is compared to, for example "last month".'),
+            ...standardStateProperties.filter((property)=>property.path !== 'label')
+        ]
+    },
+    {
+        component: key(ComponentName.ComponentName.TrendChip),
+        displayName: 'Trend chip',
+        description: 'A change drawn as a direction, a magnitude and whether the movement is good.',
+        properties: [
+            number('change', 'Change', 'Data', 'The movement; bind it to a query result.'),
+            choice('format', 'Format', 'Appearance', formats, formatting.NumberFormat.Percent),
+            choice('goodDirection', 'Good direction', 'Appearance', {
+                up: 'Up is good',
+                down: 'Down is good'
+            }, 'up'),
+            text('comparison', 'Compared to', 'Content'),
+            text('locale', 'Locale', 'Content'),
+            {
+                path: 'strings',
+                label: 'Text overrides',
+                group: 'Content',
+                valueType: scene_model.PropertyValueType.Object,
+                editorKind: scene_model.PropertyEditorKind.StringMap
+            }
+        ]
+    },
+    {
+        component: key(ComponentName.ComponentName.StatusChip),
+        displayName: 'Status chip',
+        description: 'A status shown as a semantic color, an icon and its text; the text is always shown.',
+        properties: [
+            text('status', 'Status', 'Data', 'The status text; bind it to a query result.', {
+                constraints: {
+                    required: true
+                }
+            }),
+            choice('tone', 'Tone', 'Appearance', {
+                [StatusChip.StatusTone.Success]: 'Success',
+                [StatusChip.StatusTone.Warning]: 'Warning',
+                [StatusChip.StatusTone.Danger]: 'Danger',
+                [StatusChip.StatusTone.Info]: 'Info',
+                [StatusChip.StatusTone.Neutral]: 'Neutral'
+            }, StatusChip.StatusTone.Neutral, 'The tone picks the icon and the theme color.')
+        ]
+    }
+];
+
+exports.bindable = bindable;
+exports.foundationDescriptors = foundationDescriptors;
+exports.list = list;
+exports.standardStateProperties = standardStateProperties;
+//# sourceMappingURL=foundationDescriptors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"foundationDescriptors.js","sources":["../../../foundation/foundationDescriptors.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 { BindingSourceKind, ComponentDescriptor, PropertyDescriptor, PropertyEditorKind, PropertyValueType } from '@cratis/scene.model';\nimport { componentRegistryKey } from '@cratis/scene.react';\nimport { ComponentName } from '../ComponentName';\nimport { defaultBlueprintName } from '../packageName';\nimport { ComponentState } from './ComponentState';\nimport { NumberFormat } from './formatting';\nimport { PermissionRule } from './PermissionRule';\nimport { StatusTone } from './StatusChip';\n\n/** Data properties take what a screen binds them to: a query's result, a data context or another component's output. */\nexport const bindable = [BindingSourceKind.DataContext, BindingSourceKind.QueryResult, BindingSourceKind.ComponentProperty];\n\nconst text = (path: string, label: string, group: string, description?: string, extra: Partial<PropertyDescriptor> = {}): PropertyDescriptor =>\n    ({ path, label, group, valueType: PropertyValueType.String, ...(group === 'Data' ? { acceptedBindingKinds: bindable } : {}), ...(description === undefined ? {} : { description }), ...extra });\n\nconst number = (path: string, label: string, group: string, description?: string, extra: Partial<PropertyDescriptor> = {}): PropertyDescriptor =>\n    ({ path, label, group, valueType: PropertyValueType.Number, editorKind: PropertyEditorKind.Number, ...(group === 'Data' ? { acceptedBindingKinds: bindable } : {}), ...(description === undefined ? {} : { description }), ...extra });\n\nconst flag = (path: string, label: string, group: string, description?: string, extra: Partial<PropertyDescriptor> = {}): PropertyDescriptor =>\n    ({ path, label, group, valueType: PropertyValueType.Boolean, editorKind: PropertyEditorKind.Boolean, ...(description === undefined ? {} : { description }), ...extra });\n\nconst choice = (path: string, label: string, group: string, values: Record<string, string>, defaultValue: string, description?: string): PropertyDescriptor =>\n    ({\n        path, label, group, valueType: PropertyValueType.Enum, editorKind: PropertyEditorKind.Enum, default: defaultValue,\n        choices: Object.entries(values).map(([value, name]) => ({ value, label: name })), ...(description === undefined ? {} : { description }),\n    });\n\nexport const list = (path: string, label: string, group: string, itemLabel: string, properties: PropertyDescriptor[], description?: string): PropertyDescriptor =>\n    ({ path, label, group, valueType: PropertyValueType.Collection, default: [], item: { label: itemLabel, properties }, ...(description === undefined ? {} : { description }) });\n\nconst rule = (path: string, label: string, description: string): PropertyDescriptor =>\n    choice(path, label, 'Permissions', { [PermissionRule.Enabled]: 'Enabled', [PermissionRule.Disabled]: 'Disabled', [PermissionRule.Hidden]: 'Hidden' }, PermissionRule.Enabled, description);\n\n/** The properties every data-showing foundation component shares: the standard states (spec Part B 1.4) and the cross-cutting rules of 1.5. */\nexport const standardStateProperties: PropertyDescriptor[] = [\n    choice('state', 'Preview state', 'State', {\n        [ComponentState.Ready]: 'Ready', [ComponentState.Loading]: 'Loading', [ComponentState.Empty]: 'Empty',\n        [ComponentState.Error]: 'Error', [ComponentState.NoPermission]: 'No permission', [ComponentState.Partial]: 'Partial',\n    }, ComponentState.Ready, 'Forces a state so each can be designed and previewed; empty means the state follows the bound data.'),\n    text('error', 'Error message', 'State', 'The message of the error state; setting it puts the component in that state.'),\n    flag('loading', 'Loading', 'State', 'Shows the skeleton while the data has not answered.'),\n    flag('forbidden', 'Not allowed', 'State', 'Shows the no-permission state, which explains what is missing and shows no data.'),\n    text('permissionSubject', 'What access is missing', 'State', 'Names what the user cannot see in the no-permission message.'),\n    { path: 'failedRegions', label: 'Failed regions', group: 'State', valueType: PropertyValueType.Json, editorKind: PropertyEditorKind.StringList, default: [], description: 'The parts that failed to load; any entry puts the component in the partial state.' },\n    text('emptyHeadline', 'Empty headline', 'State'),\n    text('emptyHint', 'Empty hint', 'State'),\n    text('emptyActionLabel', 'Empty action', 'State', 'The primary action offered when there is nothing to show.'),\n    rule('actionPermission', 'Empty action permission', 'Whether the empty state offers its action, refuses it with a reason, or does not render it.'),\n    text('label', 'Label', 'Accessibility', 'The accessible name of the region.'),\n    text('locale', 'Locale', 'Content', 'The locale dates, numbers and currency are formatted in; empty follows the document.'),\n    choice('density', 'Density', 'Appearance', { comfortable: 'Comfortable', compact: 'Compact' }, 'comfortable'),\n    { path: 'strings', label: 'Text overrides', group: 'Content', valueType: PropertyValueType.Object, editorKind: PropertyEditorKind.StringMap, description: 'Replaces the text the component says itself, for localization.' },\n];\n\nconst key = (name: ComponentName) => componentRegistryKey(defaultBlueprintName, name);\n\nconst formats = { [NumberFormat.Number]: 'Number', [NumberFormat.Currency]: 'Currency', [NumberFormat.Percent]: 'Percent', [NumberFormat.Compact]: 'Compact' };\n\n/** What can be edited on the foundation components (Part B 4). Each declares the shape of its data, never values (SD1). */\nexport const foundationDescriptors: ComponentDescriptor[] = [\n    {\n        component: key(ComponentName.EmptyState),\n        displayName: 'Empty state',\n        description: 'An icon, a headline, a hint and one primary action; embeddable in any region.',\n        properties: [\n            text('headline', 'Headline', 'Content', undefined, { default: 'Nothing here yet' }),\n            text('hint', 'Hint', 'Content'),\n            text('icon', 'Icon', 'Appearance'),\n            text('actionLabel', 'Primary action', 'Behavior', 'The label of the one action the state offers; its behaviors say what it does.'),\n            rule('actionPermission', 'Action permission', 'Whether the action works, refuses with a reason, or is not rendered.'),\n            text('locale', 'Locale', 'Content'),\n            { path: 'strings', label: 'Text overrides', group: 'Content', valueType: PropertyValueType.Object, editorKind: PropertyEditorKind.StringMap },\n        ],\n    },\n    {\n        component: key(ComponentName.StatCard),\n        displayName: 'Stat card',\n        description: 'One key figure with its label, trend and the period the trend is compared to.',\n        properties: [\n            text('label', 'Label', 'Content', 'What the figure measures.', { constraints: { required: true } }),\n            number('value', 'Value', 'Data', 'The figure; bind it to a query result.'),\n            choice('format', 'Format', 'Appearance', formats, NumberFormat.Number),\n            text('currency', 'Currency', 'Appearance', 'The ISO 4217 code when the format is currency.'),\n            number('fractionDigits', 'Fraction digits', 'Appearance'),\n            number('change', 'Change', 'Data', 'How much the figure moved, as a percentage; bind it to a query result.'),\n            choice('goodDirection', 'Good direction', 'Appearance', { up: 'Up is good', down: 'Down is good' }, 'up', 'Which movement is good: a falling response time is.'),\n            text('comparison', 'Compared to', 'Content', 'The period the change is compared to, for example \"last month\".'),\n            ...standardStateProperties.filter(property => property.path !== 'label'),\n        ],\n    },\n    {\n        component: key(ComponentName.TrendChip),\n        displayName: 'Trend chip',\n        description: 'A change drawn as a direction, a magnitude and whether the movement is good.',\n        properties: [\n            number('change', 'Change', 'Data', 'The movement; bind it to a query result.'),\n            choice('format', 'Format', 'Appearance', formats, NumberFormat.Percent),\n            choice('goodDirection', 'Good direction', 'Appearance', { up: 'Up is good', down: 'Down is good' }, 'up'),\n            text('comparison', 'Compared to', 'Content'),\n            text('locale', 'Locale', 'Content'),\n            { path: 'strings', label: 'Text overrides', group: 'Content', valueType: PropertyValueType.Object, editorKind: PropertyEditorKind.StringMap },\n        ],\n    },\n    {\n        component: key(ComponentName.StatusChip),\n        displayName: 'Status chip',\n        description: 'A status shown as a semantic color, an icon and its text; the text is always shown.',\n        properties: [\n            text('status', 'Status', 'Data', 'The status text; bind it to a query result.', { constraints: { required: true } }),\n            choice('tone', 'Tone', 'Appearance', {\n                [StatusTone.Success]: 'Success', [StatusTone.Warning]: 'Warning', [StatusTone.Danger]: 'Danger', [StatusTone.Info]: 'Info', [StatusTone.Neutral]: 'Neutral',\n            }, StatusTone.Neutral, 'The tone picks the icon and the theme color.'),\n        ],\n    },\n];\n\n"],"names":["bindable","BindingSourceKind","DataContext","QueryResult","ComponentProperty","text","path","label","group","description","extra","valueType","PropertyValueType","String","acceptedBindingKinds","undefined","number","Number","editorKind","PropertyEditorKind","flag","Boolean","choice","values","defaultValue","Enum","default","choices","Object","entries","map","value","name","list","itemLabel","properties","Collection","item","rule","PermissionRule","Enabled","Disabled","Hidden","standardStateProperties","ComponentState","Ready","Loading","Empty","Error","NoPermission","Partial","Json","StringList","comfortable","compact","StringMap","key","componentRegistryKey","defaultBlueprintName","formats","NumberFormat","Currency","Percent","Compact","foundationDescriptors","component","ComponentName","EmptyState","displayName","StatCard","constraints","required","up","down","filter","property","TrendChip","StatusChip","StatusTone","Success","Warning","Danger","Info","Neutral"],"mappings":";;;;;;;;;;;AAAA;AACA;AAWA,yHACO,MAAMA,QAAAA,GAAW;AAACC,IAAAA,6BAAAA,CAAkBC,WAAW;AAAED,IAAAA,6BAAAA,CAAkBE,WAAW;AAAEF,IAAAA,6BAAAA,CAAkBG;;AAEzG,MAAMC,IAAAA,GAAO,CAACC,IAAAA,EAAcC,KAAAA,EAAeC,KAAAA,EAAeC,aAAsBC,KAAAA,GAAqC,EAAE,IAClH;AAAEJ,QAAAA,IAAAA;AAAMC,QAAAA,KAAAA;AAAOC,QAAAA,KAAAA;AAAOG,QAAAA,SAAAA,EAAWC,8BAAkBC,MAAM;AAAE,QAAA,GAAIL,UAAU,MAAA,GAAS;YAAEM,oBAAAA,EAAsBd;AAAS,SAAA,GAAI,EAAE;QAAG,GAAIS,WAAAA,KAAgBM,SAAAA,GAAY,EAAC,GAAI;AAAEN,YAAAA;SAAa;AAAG,QAAA,GAAGC;KAAM,CAAA;AAEjM,MAAMM,MAAAA,GAAS,CAACV,IAAAA,EAAcC,KAAAA,EAAeC,KAAAA,EAAeC,aAAsBC,KAAAA,GAAqC,EAAE,IACpH;AAAEJ,QAAAA,IAAAA;AAAMC,QAAAA,KAAAA;AAAOC,QAAAA,KAAAA;AAAOG,QAAAA,SAAAA,EAAWC,8BAAkBK,MAAM;AAAEC,QAAAA,UAAAA,EAAYC,+BAAmBF,MAAM;AAAE,QAAA,GAAIT,UAAU,MAAA,GAAS;YAAEM,oBAAAA,EAAsBd;AAAS,SAAA,GAAI,EAAE;QAAG,GAAIS,WAAAA,KAAgBM,SAAAA,GAAY,EAAC,GAAI;AAAEN,YAAAA;SAAa;AAAG,QAAA,GAAGC;KAAM,CAAA;AAExO,MAAMU,IAAAA,GAAO,CAACd,IAAAA,EAAcC,KAAAA,EAAeC,KAAAA,EAAeC,aAAsBC,KAAAA,GAAqC,EAAE,IAClH;AAAEJ,QAAAA,IAAAA;AAAMC,QAAAA,KAAAA;AAAOC,QAAAA,KAAAA;AAAOG,QAAAA,SAAAA,EAAWC,8BAAkBS,OAAO;AAAEH,QAAAA,UAAAA,EAAYC,+BAAmBE,OAAO;QAAE,GAAIZ,WAAAA,KAAgBM,SAAAA,GAAY,EAAC,GAAI;AAAEN,YAAAA;SAAa;AAAG,QAAA,GAAGC;KAAM,CAAA;AAEzK,MAAMY,MAAAA,GAAS,CAAChB,IAAAA,EAAcC,KAAAA,EAAeC,OAAee,MAAAA,EAAgCC,YAAAA,EAAsBf,eAC7G;AACGH,QAAAA,IAAAA;AAAMC,QAAAA,KAAAA;AAAOC,QAAAA,KAAAA;AAAOG,QAAAA,SAAAA,EAAWC,8BAAkBa,IAAI;AAAEP,QAAAA,UAAAA,EAAYC,+BAAmBM,IAAI;QAAEC,OAAAA,EAASF,YAAAA;QACrGG,OAAAA,EAASC,MAAAA,CAAOC,OAAO,CAACN,MAAAA,CAAAA,CAAQO,GAAG,CAAC,CAAC,CAACC,KAAAA,EAAOC,IAAAA,CAAK,IAAM;AAAED,gBAAAA,KAAAA;gBAAOxB,KAAAA,EAAOyB;aAAK,CAAA,CAAA;QAAK,GAAIvB,WAAAA,KAAgBM,SAAAA,GAAY,EAAC,GAAI;AAAEN,YAAAA;;KAC7H,CAAA;AAEG,MAAMwB,OAAO,CAAC3B,IAAAA,EAAcC,OAAeC,KAAAA,EAAe0B,SAAAA,EAAmBC,UAAAA,EAAkC1B,WAAAA,IACjH;AAAEH,QAAAA,IAAAA;AAAMC,QAAAA,KAAAA;AAAOC,QAAAA,KAAAA;AAAOG,QAAAA,SAAAA,EAAWC,8BAAkBwB,UAAU;AAAEV,QAAAA,OAAAA,EAAS,EAAE;QAAEW,IAAAA,EAAM;YAAE9B,KAAAA,EAAO2B,SAAAA;AAAWC,YAAAA;AAAW,SAAA;QAAG,GAAI1B,WAAAA,KAAgBM,SAAAA,GAAY,EAAC,GAAI;AAAEN,YAAAA;;AAAe,KAAA;AAE/K,MAAM6B,IAAAA,GAAO,CAAChC,IAAAA,EAAcC,KAAAA,EAAeE,cACvCa,MAAAA,CAAOhB,IAAAA,EAAMC,OAAO,aAAA,EAAe;QAAE,CAACgC,6BAAAA,CAAeC,OAAO,GAAG,SAAA;QAAW,CAACD,6BAAAA,CAAeE,QAAQ,GAAG,UAAA;QAAY,CAACF,6BAAAA,CAAeG,MAAM,GAAG;KAAS,EAAGH,6BAAAA,CAAeC,OAAO,EAAE/B,WAAAA,CAAAA;AAElL,gJACO,MAAMkC,uBAAAA,GAAgD;IACzDrB,MAAAA,CAAO,OAAA,EAAS,iBAAiB,OAAA,EAAS;QACtC,CAACsB,6BAAAA,CAAeC,KAAK,GAAG,OAAA;QAAS,CAACD,6BAAAA,CAAeE,OAAO,GAAG,SAAA;QAAW,CAACF,6BAAAA,CAAeG,KAAK,GAAG,OAAA;QAC9F,CAACH,6BAAAA,CAAeI,KAAK,GAAG,OAAA;QAAS,CAACJ,6BAAAA,CAAeK,YAAY,GAAG,eAAA;QAAiB,CAACL,6BAAAA,CAAeM,OAAO,GAAG;KAC/G,EAAGN,6BAAAA,CAAeC,KAAK,EAAE,qGAAA,CAAA;IACzBxC,IAAAA,CAAK,OAAA,EAAS,iBAAiB,OAAA,EAAS,8EAAA,CAAA;IACxCe,IAAAA,CAAK,SAAA,EAAW,WAAW,OAAA,EAAS,qDAAA,CAAA;IACpCA,IAAAA,CAAK,WAAA,EAAa,eAAe,OAAA,EAAS,kFAAA,CAAA;IAC1Cf,IAAAA,CAAK,mBAAA,EAAqB,0BAA0B,OAAA,EAAS,8DAAA,CAAA;AAC7D,IAAA;QAAEC,IAAAA,EAAM,eAAA;QAAiBC,KAAAA,EAAO,gBAAA;QAAkBC,KAAAA,EAAO,OAAA;AAASG,QAAAA,SAAAA,EAAWC,8BAAkBuC,IAAI;AAAEjC,QAAAA,UAAAA,EAAYC,+BAAmBiC,UAAU;AAAE1B,QAAAA,OAAAA,EAAS,EAAE;QAAEjB,WAAAA,EAAa;AAAoF,KAAA;AAC9PJ,IAAAA,IAAAA,CAAK,iBAAiB,gBAAA,EAAkB,OAAA,CAAA;AACxCA,IAAAA,IAAAA,CAAK,aAAa,YAAA,EAAc,OAAA,CAAA;IAChCA,IAAAA,CAAK,kBAAA,EAAoB,gBAAgB,OAAA,EAAS,2DAAA,CAAA;AAClDiC,IAAAA,IAAAA,CAAK,oBAAoB,yBAAA,EAA2B,6FAAA,CAAA;IACpDjC,IAAAA,CAAK,OAAA,EAAS,SAAS,eAAA,EAAiB,oCAAA,CAAA;IACxCA,IAAAA,CAAK,QAAA,EAAU,UAAU,SAAA,EAAW,sFAAA,CAAA;IACpCiB,MAAAA,CAAO,SAAA,EAAW,WAAW,YAAA,EAAc;QAAE+B,WAAAA,EAAa,aAAA;QAAeC,OAAAA,EAAS;KAAU,EAAG,aAAA,CAAA;AAC/F,IAAA;QAAEhD,IAAAA,EAAM,SAAA;QAAWC,KAAAA,EAAO,gBAAA;QAAkBC,KAAAA,EAAO,SAAA;AAAWG,QAAAA,SAAAA,EAAWC,8BAAkBgB,MAAM;AAAEV,QAAAA,UAAAA,EAAYC,+BAAmBoC,SAAS;QAAE9C,WAAAA,EAAa;AAAiE;;AAG/N,MAAM+C,GAAAA,GAAM,CAACxB,IAAAA,GAAwByB,gCAAAA,CAAqBC,gCAAAA,EAAsB1B,IAAAA,CAAAA;AAEhF,MAAM2B,OAAAA,GAAU;IAAE,CAACC,uBAAAA,CAAa3C,MAAM,GAAG,QAAA;IAAU,CAAC2C,uBAAAA,CAAaC,QAAQ,GAAG,UAAA;IAAY,CAACD,uBAAAA,CAAaE,OAAO,GAAG,SAAA;IAAW,CAACF,uBAAAA,CAAaG,OAAO,GAAG;AAAU,CAAA;AAE7J,4HACO,MAAMC,qBAAAA,GAA+C;AACxD,IAAA;QACIC,SAAAA,EAAWT,GAAAA,CAAIU,4BAAcC,UAAU,CAAA;QACvCC,WAAAA,EAAa,aAAA;QACb3D,WAAAA,EAAa,+EAAA;QACb0B,UAAAA,EAAY;YACR9B,IAAAA,CAAK,UAAA,EAAY,UAAA,EAAY,SAAA,EAAWU,SAAAA,EAAW;gBAAEW,OAAAA,EAAS;AAAmB,aAAA,CAAA;AACjFrB,YAAAA,IAAAA,CAAK,QAAQ,MAAA,EAAQ,SAAA,CAAA;AACrBA,YAAAA,IAAAA,CAAK,QAAQ,MAAA,EAAQ,YAAA,CAAA;YACrBA,IAAAA,CAAK,aAAA,EAAe,kBAAkB,UAAA,EAAY,+EAAA,CAAA;AAClDiC,YAAAA,IAAAA,CAAK,oBAAoB,mBAAA,EAAqB,sEAAA,CAAA;AAC9CjC,YAAAA,IAAAA,CAAK,UAAU,QAAA,EAAU,SAAA,CAAA;AACzB,YAAA;gBAAEC,IAAAA,EAAM,SAAA;gBAAWC,KAAAA,EAAO,gBAAA;gBAAkBC,KAAAA,EAAO,SAAA;AAAWG,gBAAAA,SAAAA,EAAWC,8BAAkBgB,MAAM;AAAEV,gBAAAA,UAAAA,EAAYC,+BAAmBoC;AAAU;AAC/I;AACL,KAAA;AACA,IAAA;QACIU,SAAAA,EAAWT,GAAAA,CAAIU,4BAAcG,QAAQ,CAAA;QACrCD,WAAAA,EAAa,WAAA;QACb3D,WAAAA,EAAa,+EAAA;QACb0B,UAAAA,EAAY;YACR9B,IAAAA,CAAK,OAAA,EAAS,OAAA,EAAS,SAAA,EAAW,2BAAA,EAA6B;gBAAEiE,WAAAA,EAAa;oBAAEC,QAAAA,EAAU;AAAK;AAAE,aAAA,CAAA;YACjGvD,MAAAA,CAAO,OAAA,EAAS,SAAS,MAAA,EAAQ,wCAAA,CAAA;AACjCM,YAAAA,MAAAA,CAAO,QAAA,EAAU,QAAA,EAAU,YAAA,EAAcqC,OAAAA,EAASC,wBAAa3C,MAAM,CAAA;YACrEZ,IAAAA,CAAK,UAAA,EAAY,YAAY,YAAA,EAAc,gDAAA,CAAA;AAC3CW,YAAAA,MAAAA,CAAO,kBAAkB,iBAAA,EAAmB,YAAA,CAAA;YAC5CA,MAAAA,CAAO,QAAA,EAAU,UAAU,MAAA,EAAQ,wEAAA,CAAA;YACnCM,MAAAA,CAAO,eAAA,EAAiB,kBAAkB,YAAA,EAAc;gBAAEkD,EAAAA,EAAI,YAAA;gBAAcC,IAAAA,EAAM;AAAe,aAAA,EAAG,IAAA,EAAM,qDAAA,CAAA;YAC1GpE,IAAAA,CAAK,YAAA,EAAc,eAAe,SAAA,EAAW,iEAAA,CAAA;AAC1CsC,YAAAA,GAAAA,uBAAAA,CAAwB+B,MAAM,CAACC,CAAAA,QAAAA,GAAYA,QAAAA,CAASrE,IAAI,KAAK,OAAA;AACnE;AACL,KAAA;AACA,IAAA;QACI2D,SAAAA,EAAWT,GAAAA,CAAIU,4BAAcU,SAAS,CAAA;QACtCR,WAAAA,EAAa,YAAA;QACb3D,WAAAA,EAAa,8EAAA;QACb0B,UAAAA,EAAY;YACRnB,MAAAA,CAAO,QAAA,EAAU,UAAU,MAAA,EAAQ,0CAAA,CAAA;AACnCM,YAAAA,MAAAA,CAAO,QAAA,EAAU,QAAA,EAAU,YAAA,EAAcqC,OAAAA,EAASC,wBAAaE,OAAO,CAAA;YACtExC,MAAAA,CAAO,eAAA,EAAiB,kBAAkB,YAAA,EAAc;gBAAEkD,EAAAA,EAAI,YAAA;gBAAcC,IAAAA,EAAM;aAAe,EAAG,IAAA,CAAA;AACpGpE,YAAAA,IAAAA,CAAK,cAAc,aAAA,EAAe,SAAA,CAAA;AAClCA,YAAAA,IAAAA,CAAK,UAAU,QAAA,EAAU,SAAA,CAAA;AACzB,YAAA;gBAAEC,IAAAA,EAAM,SAAA;gBAAWC,KAAAA,EAAO,gBAAA;gBAAkBC,KAAAA,EAAO,SAAA;AAAWG,gBAAAA,SAAAA,EAAWC,8BAAkBgB,MAAM;AAAEV,gBAAAA,UAAAA,EAAYC,+BAAmBoC;AAAU;AAC/I;AACL,KAAA;AACA,IAAA;QACIU,SAAAA,EAAWT,GAAAA,CAAIU,4BAAcW,UAAU,CAAA;QACvCT,WAAAA,EAAa,aAAA;QACb3D,WAAAA,EAAa,qFAAA;QACb0B,UAAAA,EAAY;YACR9B,IAAAA,CAAK,QAAA,EAAU,QAAA,EAAU,MAAA,EAAQ,6CAAA,EAA+C;gBAAEiE,WAAAA,EAAa;oBAAEC,QAAAA,EAAU;AAAK;AAAE,aAAA,CAAA;YAClHjD,MAAAA,CAAO,MAAA,EAAQ,QAAQ,YAAA,EAAc;gBACjC,CAACwD,qBAAAA,CAAWC,OAAO,GAAG,SAAA;gBAAW,CAACD,qBAAAA,CAAWE,OAAO,GAAG,SAAA;gBAAW,CAACF,qBAAAA,CAAWG,MAAM,GAAG,QAAA;gBAAU,CAACH,qBAAAA,CAAWI,IAAI,GAAG,MAAA;gBAAQ,CAACJ,qBAAAA,CAAWK,OAAO,GAAG;aACtJ,EAAGL,qBAAAA,CAAWK,OAAO,EAAE,8CAAA;AAC1B;AACL;;;;;;"}

package/dist/cjs/foundation/foundationSamples.js

@@ -0,0 +1,71 @@
+'use strict';
+
+var scene_react = require('@cratis/scene.react');
+var ComponentName = require('../ComponentName.js');
+var packageName = require('../packageName.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const foundationSamples = {
+    [ComponentName.ComponentName.EmptyState]: {
+        properties: {
+            headline: 'No invoices yet',
+            hint: 'Invoices you create appear here.',
+            icon: 'file',
+            actionLabel: 'New invoice'
+        },
+        data: [],
+        stateful: false
+    },
+    [ComponentName.ComponentName.StatCard]: {
+        properties: {
+            label: 'Open pipeline',
+            value: 1234567,
+            format: 'currency',
+            currency: 'USD',
+            change: 12.5,
+            comparison: 'last month',
+            locale: 'en-US'
+        },
+        data: [
+            '$1,234,567'
+        ],
+        stateful: true
+    },
+    [ComponentName.ComponentName.TrendChip]: {
+        properties: {
+            change: -3.2,
+            goodDirection: 'down',
+            comparison: 'last week',
+            locale: 'en-US'
+        },
+        data: [],
+        stateful: false
+    },
+    [ComponentName.ComponentName.StatusChip]: {
+        properties: {
+            status: 'Awaiting approval',
+            tone: 'warning'
+        },
+        data: [],
+        stateful: false
+    }
+};
+/** A scene element for a foundation component, populated with its sample unless properties are given, with the state forced when asked. */ function foundationElement(name, properties, state) {
+    const sample = foundationSamples[name];
+    return {
+        id: `${name}-sample`,
+        componentName: scene_react.componentRegistryKey(packageName.defaultBlueprintName, name),
+        properties: {
+            ...properties ?? sample?.properties ?? {},
+            ...state === undefined ? {} : {
+                state
+            }
+        },
+        slots: {}
+    };
+}
+
+exports.foundationElement = foundationElement;
+exports.foundationSamples = foundationSamples;
+//# sourceMappingURL=foundationSamples.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"foundationSamples.js","sources":["../../../foundation/foundationSamples.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';\nimport { componentRegistryKey } from '@cratis/scene.react';\nimport { ComponentName } from '../ComponentName';\nimport { defaultBlueprintName } from '../packageName';\nimport { ComponentState } from './ComponentState';\n\n/**\n * What a story or a specification feeds each foundation component to see it populated.\n *\n * These are design-time and test-time values, never part of what a component is: a component declares the shape of its data\n * and a screen binds it to a query (spec SD1). The domain blueprints supply real preview data as sample-data packs; this is\n * only enough to draw each component in each state.\n */\nexport interface FoundationSample {\n    /** The properties that make the component populated. */\n    properties: Record<string, unknown>;\n\n    /** Text that only appears when the component shows its data, so a specification can prove the no-permission state shows none of it. */\n    data: string[];\n\n    /** Whether the component shows data and so owns the five standard states; chips and the empty state themselves do not. */\n    stateful: boolean;\n}\n\nexport const foundationSamples: Record<string, FoundationSample> = {\n    [ComponentName.EmptyState]: { properties: { headline: 'No invoices yet', hint: 'Invoices you create appear here.', icon: 'file', actionLabel: 'New invoice' }, data: [], stateful: false },\n    [ComponentName.StatCard]: { properties: { label: 'Open pipeline', value: 1234567, format: 'currency', currency: 'USD', change: 12.5, comparison: 'last month', locale: 'en-US' }, data: ['$1,234,567'], stateful: true },\n    [ComponentName.TrendChip]: { properties: { change: -3.2, goodDirection: 'down', comparison: 'last week', locale: 'en-US' }, data: [], stateful: false },\n    [ComponentName.StatusChip]: { properties: { status: 'Awaiting approval', tone: 'warning' }, data: [], stateful: false },\n};\n\n/** A scene element for a foundation component, populated with its sample unless properties are given, with the state forced when asked. */\nexport function foundationElement(name: string, properties?: Record<string, unknown>, state?: ComponentState): ExternalComponent {\n    const sample = foundationSamples[name];\n    return {\n        id: `${name}-sample`,\n        componentName: componentRegistryKey(defaultBlueprintName, name),\n        properties: { ...(properties ?? sample?.properties ?? {}), ...(state === undefined ? {} : { state }) },\n        slots: {},\n    } as unknown as ExternalComponent;\n}\n"],"names":["foundationSamples","ComponentName","EmptyState","properties","headline","hint","icon","actionLabel","data","stateful","StatCard","label","value","format","currency","change","comparison","locale","TrendChip","goodDirection","StatusChip","status","tone","foundationElement","name","state","sample","id","componentName","componentRegistryKey","defaultBlueprintName","undefined","slots"],"mappings":";;;;;;AAAA;AACA;MA0BaA,iBAAAA,GAAsD;IAC/D,CAACC,2BAAAA,CAAcC,UAAU,GAAG;QAAEC,UAAAA,EAAY;YAAEC,QAAAA,EAAU,iBAAA;YAAmBC,IAAAA,EAAM,kCAAA;YAAoCC,IAAAA,EAAM,MAAA;YAAQC,WAAAA,EAAa;AAAc,SAAA;AAAGC,QAAAA,IAAAA,EAAM,EAAE;QAAEC,QAAAA,EAAU;AAAM,KAAA;IACzL,CAACR,2BAAAA,CAAcS,QAAQ,GAAG;QAAEP,UAAAA,EAAY;YAAEQ,KAAAA,EAAO,eAAA;YAAiBC,KAAAA,EAAO,OAAA;YAASC,MAAAA,EAAQ,UAAA;YAAYC,QAAAA,EAAU,KAAA;YAAOC,MAAAA,EAAQ,IAAA;YAAMC,UAAAA,EAAY,YAAA;YAAcC,MAAAA,EAAQ;AAAQ,SAAA;QAAGT,IAAAA,EAAM;AAAC,YAAA;AAAa,SAAA;QAAEC,QAAAA,EAAU;AAAK,KAAA;IACvN,CAACR,2BAAAA,CAAciB,SAAS,GAAG;QAAEf,UAAAA,EAAY;AAAEY,YAAAA,MAAAA,EAAQ,IAAC;YAAKI,aAAAA,EAAe,MAAA;YAAQH,UAAAA,EAAY,WAAA;YAAaC,MAAAA,EAAQ;AAAQ,SAAA;AAAGT,QAAAA,IAAAA,EAAM,EAAE;QAAEC,QAAAA,EAAU;AAAM,KAAA;IACtJ,CAACR,2BAAAA,CAAcmB,UAAU,GAAG;QAAEjB,UAAAA,EAAY;YAAEkB,MAAAA,EAAQ,mBAAA;YAAqBC,IAAAA,EAAM;AAAU,SAAA;AAAGd,QAAAA,IAAAA,EAAM,EAAE;QAAEC,QAAAA,EAAU;AAAM;AAC1H;AAEA,4IACO,SAASc,iBAAAA,CAAkBC,IAAY,EAAErB,UAAoC,EAAEsB,KAAsB,EAAA;IACxG,MAAMC,MAAAA,GAAS1B,iBAAiB,CAACwB,IAAAA,CAAK;IACtC,OAAO;QACHG,EAAAA,EAAI,CAAA,EAAGH,IAAAA,CAAK,OAAO,CAAC;AACpBI,QAAAA,aAAAA,EAAeC,iCAAqBC,gCAAAA,EAAsBN,IAAAA,CAAAA;QAC1DrB,UAAAA,EAAY;AAAE,YAAA,GAAIA,UAAAA,IAAcuB,MAAAA,EAAQvB,UAAAA,IAAc,EAAE;YAAG,GAAIsB,KAAAA,KAAUM,SAAAA,GAAY,EAAC,GAAI;AAAEN,gBAAAA;;AAAS,SAAA;AACrGO,QAAAA,KAAAA,EAAO;AACX,KAAA;AACJ;;;"}

package/dist/cjs/foundation/foundationStrings.js

@@ -0,0 +1,105 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Every piece of text the foundation components say themselves, as opposed to text a screen author or a bound query
+ * supplies. Nothing is hard-coded in a component (spec Part B 1.5): a component reads its text from here, merged with
+ * the `strings` property of the element, so an application localizes by supplying a table - and a bound string
+ * (a `{name}` placeholder is replaced by the values the component passes) arrives the same way any other property does.
+ */ const foundationStrings = {
+    loading: 'Loading',
+    emptyHeadline: 'Nothing here yet',
+    emptyHint: 'There is nothing to show for now.',
+    errorHeadline: 'This could not be loaded',
+    errorHint: 'Something went wrong while loading. Try again in a moment.',
+    retry: 'Try again',
+    noPermissionHeadline: 'You do not have access',
+    noPermissionHint: 'Ask an administrator to grant you access to {subject}.',
+    noPermissionSubject: 'this content',
+    partialHeadline: 'Some parts could not be loaded',
+    partialHint: 'The unavailable parts are: {regions}.',
+    disabledNoPermission: 'You do not have permission to do this',
+    trendUp: 'up {value}',
+    trendDown: 'down {value}',
+    trendFlat: 'unchanged',
+    trendComparison: 'compared to {period}',
+    statusSuccess: 'Success',
+    statusWarning: 'Warning',
+    statusDanger: 'Problem',
+    statusInfo: 'Information',
+    statusNeutral: 'Status',
+    chartNoData: 'No data to chart',
+    chartDataTable: 'Chart data',
+    chartSeries: 'Series',
+    chartCategory: 'Category',
+    filterAdd: 'Add condition',
+    filterAddGroup: 'Add group',
+    filterRemove: 'Remove condition',
+    filterRemoveGroup: 'Remove group',
+    filterMatchAll: 'Match all (AND)',
+    filterMatchAny: 'Match any (OR)',
+    filterField: 'Field',
+    filterOperator: 'Operator',
+    filterValue: 'Value',
+    filterClear: 'Clear filters',
+    filterSummary: '{count} active filters',
+    columnsChoose: 'Columns',
+    columnsLocked: 'always shown',
+    columnsReset: 'Show all columns',
+    viewsLabel: 'Saved views',
+    viewsDefault: 'All items',
+    viewsSave: 'Save current view',
+    viewsManage: 'Manage views',
+    checklistProgress: '{done} of {total} complete',
+    checklistOwner: 'Owner',
+    checklistDue: 'Due',
+    activityEmpty: 'No activity yet',
+    avatarOverflow: '{count} more',
+    avatarPeople: '{count} people',
+    uploadDrop: 'Drop files here or',
+    uploadBrowse: 'Browse files',
+    uploadRemove: 'Remove {name}',
+    uploadTooLarge: '{name} is larger than {limit}',
+    uploadWrongType: '{name} is not an accepted file type',
+    uploadUploading: 'Uploading',
+    uploadDone: 'Uploaded',
+    uploadFailed: 'Upload failed',
+    approvalPending: 'Pending',
+    approvalCurrent: 'Awaiting decision',
+    approvalApproved: 'Approved',
+    approvalRejected: 'Rejected',
+    approvalSkipped: 'Skipped',
+    approvalChain: 'Approval chain',
+    orgExpand: 'Expand {name}',
+    orgCollapse: 'Collapse {name}',
+    orgReports: '{count} reports',
+    matrixAllowed: 'Allowed',
+    matrixDenied: 'Not allowed',
+    matrixGrant: 'Grant {permission} to {role}',
+    matrixReadOnly: 'Read-only'
+};
+/**
+ * The foundation strings with the element's own `strings` property laid over them.
+ *
+ * Only string values of known names are taken, so a typo in an application's table falls back to the default text
+ * rather than rendering nothing.
+ */ function readFoundationStrings(element) {
+    const supplied = element.properties.strings;
+    const result = {
+        ...foundationStrings
+    };
+    if (typeof supplied !== 'object' || supplied === null || Array.isArray(supplied)) return result;
+    for (const [name, value] of Object.entries(supplied)){
+        if (name in foundationStrings && typeof value === 'string') result[name] = value;
+    }
+    return result;
+}
+/** Replaces each `{name}` in a string with the value of the same name, leaving an unknown placeholder visible rather than blank. */ function formatText(text, values = {}) {
+    return text.replace(/\{(\w+)\}/g, (placeholder, name)=>name in values ? String(values[name]) : placeholder);
+}
+
+exports.formatText = formatText;
+exports.foundationStrings = foundationStrings;
+exports.readFoundationStrings = readFoundationStrings;
+//# sourceMappingURL=foundationStrings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"foundationStrings.js","sources":["../../../foundation/foundationStrings.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/**\n * Every piece of text the foundation components say themselves, as opposed to text a screen author or a bound query\n * supplies. Nothing is hard-coded in a component (spec Part B 1.5): a component reads its text from here, merged with\n * the `strings` property of the element, so an application localizes by supplying a table - and a bound string\n * (a `{name}` placeholder is replaced by the values the component passes) arrives the same way any other property does.\n */\nexport const foundationStrings = {\n    loading: 'Loading',\n    emptyHeadline: 'Nothing here yet',\n    emptyHint: 'There is nothing to show for now.',\n    errorHeadline: 'This could not be loaded',\n    errorHint: 'Something went wrong while loading. Try again in a moment.',\n    retry: 'Try again',\n    noPermissionHeadline: 'You do not have access',\n    noPermissionHint: 'Ask an administrator to grant you access to {subject}.',\n    noPermissionSubject: 'this content',\n    partialHeadline: 'Some parts could not be loaded',\n    partialHint: 'The unavailable parts are: {regions}.',\n    disabledNoPermission: 'You do not have permission to do this',\n    trendUp: 'up {value}',\n    trendDown: 'down {value}',\n    trendFlat: 'unchanged',\n    trendComparison: 'compared to {period}',\n    statusSuccess: 'Success',\n    statusWarning: 'Warning',\n    statusDanger: 'Problem',\n    statusInfo: 'Information',\n    statusNeutral: 'Status',\n    chartNoData: 'No data to chart',\n    chartDataTable: 'Chart data',\n    chartSeries: 'Series',\n    chartCategory: 'Category',\n    filterAdd: 'Add condition',\n    filterAddGroup: 'Add group',\n    filterRemove: 'Remove condition',\n    filterRemoveGroup: 'Remove group',\n    filterMatchAll: 'Match all (AND)',\n    filterMatchAny: 'Match any (OR)',\n    filterField: 'Field',\n    filterOperator: 'Operator',\n    filterValue: 'Value',\n    filterClear: 'Clear filters',\n    filterSummary: '{count} active filters',\n    columnsChoose: 'Columns',\n    columnsLocked: 'always shown',\n    columnsReset: 'Show all columns',\n    viewsLabel: 'Saved views',\n    viewsDefault: 'All items',\n    viewsSave: 'Save current view',\n    viewsManage: 'Manage views',\n    checklistProgress: '{done} of {total} complete',\n    checklistOwner: 'Owner',\n    checklistDue: 'Due',\n    activityEmpty: 'No activity yet',\n    avatarOverflow: '{count} more',\n    avatarPeople: '{count} people',\n    uploadDrop: 'Drop files here or',\n    uploadBrowse: 'Browse files',\n    uploadRemove: 'Remove {name}',\n    uploadTooLarge: '{name} is larger than {limit}',\n    uploadWrongType: '{name} is not an accepted file type',\n    uploadUploading: 'Uploading',\n    uploadDone: 'Uploaded',\n    uploadFailed: 'Upload failed',\n    approvalPending: 'Pending',\n    approvalCurrent: 'Awaiting decision',\n    approvalApproved: 'Approved',\n    approvalRejected: 'Rejected',\n    approvalSkipped: 'Skipped',\n    approvalChain: 'Approval chain',\n    orgExpand: 'Expand {name}',\n    orgCollapse: 'Collapse {name}',\n    orgReports: '{count} reports',\n    matrixAllowed: 'Allowed',\n    matrixDenied: 'Not allowed',\n    matrixGrant: 'Grant {permission} to {role}',\n    matrixReadOnly: 'Read-only',\n} as const;\n\n/** The name of one of the foundation strings. */\nexport type FoundationStringName = keyof typeof foundationStrings;\n\n/** The text table a foundation component works with. */\nexport type FoundationStrings = Record<FoundationStringName, string>;\n\n/**\n * The foundation strings with the element's own `strings` property laid over them.\n *\n * Only string values of known names are taken, so a typo in an application's table falls back to the default text\n * rather than rendering nothing.\n */\nexport function readFoundationStrings(element: ExternalComponent): FoundationStrings {\n    const supplied = element.properties.strings;\n    const result: FoundationStrings = { ...foundationStrings };\n    if (typeof supplied !== 'object' || supplied === null || Array.isArray(supplied)) return result;\n\n    for (const [name, value] of Object.entries(supplied as Record<string, unknown>)) {\n        if (name in foundationStrings && typeof value === 'string') result[name as FoundationStringName] = value;\n    }\n\n    return result;\n}\n\n/** Replaces each `{name}` in a string with the value of the same name, leaving an unknown placeholder visible rather than blank. */\nexport function formatText(text: string, values: Record<string, string | number> = {}): string {\n    return text.replace(/\\{(\\w+)\\}/g, (placeholder, name: string) => (name in values ? String(values[name]) : placeholder));\n}\n"],"names":["foundationStrings","loading","emptyHeadline","emptyHint","errorHeadline","errorHint","retry","noPermissionHeadline","noPermissionHint","noPermissionSubject","partialHeadline","partialHint","disabledNoPermission","trendUp","trendDown","trendFlat","trendComparison","statusSuccess","statusWarning","statusDanger","statusInfo","statusNeutral","chartNoData","chartDataTable","chartSeries","chartCategory","filterAdd","filterAddGroup","filterRemove","filterRemoveGroup","filterMatchAll","filterMatchAny","filterField","filterOperator","filterValue","filterClear","filterSummary","columnsChoose","columnsLocked","columnsReset","viewsLabel","viewsDefault","viewsSave","viewsManage","checklistProgress","checklistOwner","checklistDue","activityEmpty","avatarOverflow","avatarPeople","uploadDrop","uploadBrowse","uploadRemove","uploadTooLarge","uploadWrongType","uploadUploading","uploadDone","uploadFailed","approvalPending","approvalCurrent","approvalApproved","approvalRejected","approvalSkipped","approvalChain","orgExpand","orgCollapse","orgReports","matrixAllowed","matrixDenied","matrixGrant","matrixReadOnly","readFoundationStrings","element","supplied","properties","strings","result","Array","isArray","name","value","Object","entries","formatText","text","values","replace","placeholder","String"],"mappings":";;AAAA;AACA;AAIA;;;;;UAMaA,iBAAAA,GAAoB;IAC7BC,OAAAA,EAAS,SAAA;IACTC,aAAAA,EAAe,kBAAA;IACfC,SAAAA,EAAW,mCAAA;IACXC,aAAAA,EAAe,0BAAA;IACfC,SAAAA,EAAW,4DAAA;IACXC,KAAAA,EAAO,WAAA;IACPC,oBAAAA,EAAsB,wBAAA;IACtBC,gBAAAA,EAAkB,wDAAA;IAClBC,mBAAAA,EAAqB,cAAA;IACrBC,eAAAA,EAAiB,gCAAA;IACjBC,WAAAA,EAAa,uCAAA;IACbC,oBAAAA,EAAsB,uCAAA;IACtBC,OAAAA,EAAS,YAAA;IACTC,SAAAA,EAAW,cAAA;IACXC,SAAAA,EAAW,WAAA;IACXC,eAAAA,EAAiB,sBAAA;IACjBC,aAAAA,EAAe,SAAA;IACfC,aAAAA,EAAe,SAAA;IACfC,YAAAA,EAAc,SAAA;IACdC,UAAAA,EAAY,aAAA;IACZC,aAAAA,EAAe,QAAA;IACfC,WAAAA,EAAa,kBAAA;IACbC,cAAAA,EAAgB,YAAA;IAChBC,WAAAA,EAAa,QAAA;IACbC,aAAAA,EAAe,UAAA;IACfC,SAAAA,EAAW,eAAA;IACXC,cAAAA,EAAgB,WAAA;IAChBC,YAAAA,EAAc,kBAAA;IACdC,iBAAAA,EAAmB,cAAA;IACnBC,cAAAA,EAAgB,iBAAA;IAChBC,cAAAA,EAAgB,gBAAA;IAChBC,WAAAA,EAAa,OAAA;IACbC,cAAAA,EAAgB,UAAA;IAChBC,WAAAA,EAAa,OAAA;IACbC,WAAAA,EAAa,eAAA;IACbC,aAAAA,EAAe,wBAAA;IACfC,aAAAA,EAAe,SAAA;IACfC,aAAAA,EAAe,cAAA;IACfC,YAAAA,EAAc,kBAAA;IACdC,UAAAA,EAAY,aAAA;IACZC,YAAAA,EAAc,WAAA;IACdC,SAAAA,EAAW,mBAAA;IACXC,WAAAA,EAAa,cAAA;IACbC,iBAAAA,EAAmB,4BAAA;IACnBC,cAAAA,EAAgB,OAAA;IAChBC,YAAAA,EAAc,KAAA;IACdC,aAAAA,EAAe,iBAAA;IACfC,cAAAA,EAAgB,cAAA;IAChBC,YAAAA,EAAc,gBAAA;IACdC,UAAAA,EAAY,oBAAA;IACZC,YAAAA,EAAc,cAAA;IACdC,YAAAA,EAAc,eAAA;IACdC,cAAAA,EAAgB,+BAAA;IAChBC,eAAAA,EAAiB,qCAAA;IACjBC,eAAAA,EAAiB,WAAA;IACjBC,UAAAA,EAAY,UAAA;IACZC,YAAAA,EAAc,eAAA;IACdC,eAAAA,EAAiB,SAAA;IACjBC,eAAAA,EAAiB,mBAAA;IACjBC,gBAAAA,EAAkB,UAAA;IAClBC,gBAAAA,EAAkB,UAAA;IAClBC,eAAAA,EAAiB,SAAA;IACjBC,aAAAA,EAAe,gBAAA;IACfC,SAAAA,EAAW,eAAA;IACXC,WAAAA,EAAa,iBAAA;IACbC,UAAAA,EAAY,iBAAA;IACZC,aAAAA,EAAe,SAAA;IACfC,YAAAA,EAAc,aAAA;IACdC,WAAAA,EAAa,8BAAA;IACbC,cAAAA,EAAgB;AACpB;AAQA;;;;;IAMO,SAASC,qBAAAA,CAAsBC,OAA0B,EAAA;AAC5D,IAAA,MAAMC,QAAAA,GAAWD,OAAAA,CAAQE,UAAU,CAACC,OAAO;AAC3C,IAAA,MAAMC,MAAAA,GAA4B;AAAE,QAAA,GAAG5E;AAAkB,KAAA;IACzD,IAAI,OAAOyE,aAAa,QAAA,IAAYA,QAAAA,KAAa,QAAQI,KAAAA,CAAMC,OAAO,CAACL,QAAAA,CAAAA,EAAW,OAAOG,MAAAA;IAEzF,KAAK,MAAM,CAACG,IAAAA,EAAMC,KAAAA,CAAM,IAAIC,MAAAA,CAAOC,OAAO,CAACT,QAAAA,CAAAA,CAAsC;QAC7E,IAAIM,IAAAA,IAAQ/E,qBAAqB,OAAOgF,KAAAA,KAAU,UAAUJ,MAAM,CAACG,KAA6B,GAAGC,KAAAA;AACvG,IAAA;IAEA,OAAOJ,MAAAA;AACX;AAEA,qIACO,SAASO,UAAAA,CAAWC,IAAY,EAAEC,MAAAA,GAA0C,EAAE,EAAA;AACjF,IAAA,OAAOD,IAAAA,CAAKE,OAAO,CAAC,YAAA,EAAc,CAACC,WAAAA,EAAaR,IAAAA,GAAkBA,IAAAA,IAAQM,MAAAA,GAASG,MAAAA,CAAOH,MAAM,CAACN,KAAK,CAAA,GAAIQ,WAAAA,CAAAA;AAC9G;;;;"}

package/dist/cjs/index.js

@@ -54,6 +54,21 @@ var Logo = require('./shell/Logo.js');
 var UserMenu = require('./shell/UserMenu.js');
 var ThemeSwitcher = require('./shell/ThemeSwitcher.js');
 var LayoutModeSwitcher = require('./shell/LayoutModeSwitcher.js');
+var foundationStrings = require('./foundation/foundationStrings.js');
+var ComponentState = require('./foundation/ComponentState.js');
+var PermissionRule = require('./foundation/PermissionRule.js');
+var formatting = require('./foundation/formatting.js');
+var FoundationIcon = require('./foundation/FoundationIcon.js');
+var ActionButton = require('./foundation/ActionButton.js');
+var StateFrame = require('./foundation/StateFrame.js');
+var EmptyState = require('./foundation/EmptyState.js');
+var TrendChip = require('./foundation/TrendChip.js');
+var StatusChip = require('./foundation/StatusChip.js');
+var StatCard = require('./foundation/StatCard.js');
+var foundationDescriptors = require('./foundation/foundationDescriptors.js');
+var foundationComponentMetadata = require('./foundation/foundationComponentMetadata.js');
+var foundationSamples = require('./foundation/foundationSamples.js');
+var FoundationStates = require('./foundation/FoundationStates.js');
 var blueprintThemeCompatibility = require('./themes/blueprintThemeCompatibility.js');
 var light = require('./themes/light.js');
 var dark = require('./themes/dark.js');
@@ -217,6 +232,43 @@ exports.Logo = Logo.Logo;
 exports.UserMenu = UserMenu.UserMenu;
 exports.ThemeSwitcher = ThemeSwitcher.ThemeSwitcher;
 exports.LayoutModeSwitcher = LayoutModeSwitcher.LayoutModeSwitcher;
+exports.formatText = foundationStrings.formatText;
+exports.foundationStrings = foundationStrings.foundationStrings;
+exports.readFoundationStrings = foundationStrings.readFoundationStrings;
+exports.ComponentState = ComponentState.ComponentState;
+exports.componentStates = ComponentState.componentStates;
+exports.readComponentState = ComponentState.readComponentState;
+exports.PermissionRule = PermissionRule.PermissionRule;
+exports.readPermissionRule = PermissionRule.readPermissionRule;
+exports.NumberFormat = formatting.NumberFormat;
+exports.formatDate = formatting.formatDate;
+exports.formatNumber = formatting.formatNumber;
+exports.isRightToLeft = formatting.isRightToLeft;
+exports.readLocale = formatting.readLocale;
+exports.readNumberFormat = formatting.readNumberFormat;
+exports.FoundationIcon = FoundationIcon.FoundationIcon;
+exports.isFoundationIcon = FoundationIcon.isFoundationIcon;
+exports.ActionButton = ActionButton.ActionButton;
+exports.EmptyStateView = StateFrame.EmptyStateView;
+exports.FoundationFrame = StateFrame.FoundationFrame;
+exports.EmptyState = EmptyState.EmptyState;
+exports.TrendChip = TrendChip.TrendChip;
+exports.TrendChipView = TrendChip.TrendChipView;
+exports.trendDirection = TrendChip.trendDirection;
+exports.trendOutcome = TrendChip.trendOutcome;
+exports.StatusChip = StatusChip.StatusChip;
+exports.StatusTone = StatusChip.StatusTone;
+exports.readStatusTone = StatusChip.readStatusTone;
+exports.statusToneIcons = StatusChip.statusToneIcons;
+exports.StatCard = StatCard.StatCard;
+exports.bindable = foundationDescriptors.bindable;
+exports.foundationDescriptors = foundationDescriptors.foundationDescriptors;
+exports.list = foundationDescriptors.list;
+exports.standardStateProperties = foundationDescriptors.standardStateProperties;
+exports.foundationComponentMetadata = foundationComponentMetadata.foundationComponentMetadata;
+exports.foundationElement = foundationSamples.foundationElement;
+exports.foundationSamples = foundationSamples.foundationSamples;
+exports.FoundationStates = FoundationStates.FoundationStates;
 exports.blueprintThemeCompatibility = blueprintThemeCompatibility.blueprintThemeCompatibility;
 exports.lightTheme = light.lightTheme;
 exports.darkTheme = dark.darkTheme;

package/dist/cjs/index.js.map

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

package/dist/cjs/themes/dark.js

@@ -32,7 +32,15 @@ var blueprintThemeCompatibility = require('./blueprintThemeCompatibility.js');
         'highlight.background': '#232a45',
         'highlight.color': '#c7ccff',
         'content.borderRadius': '0.5rem',
-        'focus.ring': '0 0 0 2px rgb(129 140 248 / 0.45)'
+        'focus.ring': '0 0 0 2px rgb(129 140 248 / 0.45)',
+        'status.successColor': '#86efac',
+        'status.successBackground': '#14301f',
+        'status.warningColor': '#fcd34d',
+        'status.warningBackground': '#33290f',
+        'status.dangerColor': '#fca5a5',
+        'status.dangerBackground': '#3a1616',
+        'status.infoColor': '#93c5fd',
+        'status.infoBackground': '#162a4a'
     }
 };