@cratis/scene.engine 4.25.0 → 4.27.0

package/dist/cjs/sampleData/findSampleDataSet.js

@@ -0,0 +1,18 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Finds the set of a pack that supplies rows for a read model or shape. An explicit mapping whose read model is
+ * the target wins; otherwise a set whose shape has the target's name (compared exactly, case-sensitively).
+ */ function findSampleDataSet(pack, target, mappings = []) {
+    for (const mapping of mappings){
+        if (mapping.readModel !== target) continue;
+        const mapped = (pack.sets ?? []).find((set)=>set.shape === mapping.shape);
+        if (mapped !== undefined) return mapped;
+    }
+    return (pack.sets ?? []).find((set)=>set.shape === target);
+}
+
+exports.findSampleDataSet = findSampleDataSet;
+//# sourceMappingURL=findSampleDataSet.js.map

package/dist/cjs/sampleData/findSampleDataSet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findSampleDataSet.js","sources":["../../../sampleData/findSampleDataSet.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 { SampleDataMapping, SampleDataPack, SampleDataSet } from '@cratis/scene.model';\n\n/**\n * Finds the set of a pack that supplies rows for a read model or shape. An explicit mapping whose read model is\n * the target wins; otherwise a set whose shape has the target's name (compared exactly, case-sensitively).\n */\nexport function findSampleDataSet(pack: SampleDataPack, target: string, mappings: readonly SampleDataMapping[] = []): SampleDataSet | undefined {\n    for (const mapping of mappings) {\n        if (mapping.readModel !== target) continue;\n        const mapped = (pack.sets ?? []).find(set => set.shape === mapping.shape);\n        if (mapped !== undefined) return mapped;\n    }\n\n    return (pack.sets ?? []).find(set => set.shape === target);\n}\n"],"names":["findSampleDataSet","pack","target","mappings","mapping","readModel","mapped","sets","find","set","shape","undefined"],"mappings":";;AAAA;AACA;AAIA;;;IAIO,SAASA,iBAAAA,CAAkBC,IAAoB,EAAEC,MAAc,EAAEC,WAAyC,EAAE,EAAA;IAC/G,KAAK,MAAMC,WAAWD,QAAAA,CAAU;QAC5B,IAAIC,OAAAA,CAAQC,SAAS,KAAKH,MAAAA,EAAQ;AAClC,QAAA,MAAMI,SAAS,CAACL,IAAAA,CAAKM,IAAI,IAAI,EAAC,EAAGC,IAAI,CAACC,CAAAA,GAAAA,GAAOA,IAAIC,KAAK,KAAKN,QAAQM,KAAK,CAAA;QACxE,IAAIJ,MAAAA,KAAWK,WAAW,OAAOL,MAAAA;AACrC,IAAA;AAEA,IAAA,OAAO,CAACL,IAAAA,CAAKM,IAAI,IAAI,EAAC,EAAGC,IAAI,CAACC,CAAAA,GAAAA,GAAOA,GAAAA,CAAIC,KAAK,KAAKR,MAAAA,CAAAA;AACvD;;"}

package/dist/cjs/sampleData/findSampleRowLiterals.js

@@ -0,0 +1,73 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Finds sample-row literals inside a value: an array holding plain objects of two or more keys, which is what
+ * a hand-written list of demo rows looks like. Returns the path of each, e.g. `rows` or `items[2].children`.
+ * A single-key object is a choice or a token, not a row, and is not reported.
+ *
+ * Spec §11 SD1: components keep declaring shapes only, so a component descriptor's defaults and a template's
+ * properties must not carry row literals; demo rows belong to sample-data packs.
+ *
+ * @param value The value to inspect.
+ * @param path The path prefix of the value, empty for the root.
+ */ function findSampleRowLiterals(value, path = '') {
+    const found = [];
+    if (Array.isArray(value)) {
+        if (value.some(isRow)) found.push(path === '' ? '(root)' : path);
+        value.forEach((item, index)=>found.push(...findSampleRowLiterals(item, `${path}[${index}]`)));
+    } else if (typeof value === 'object' && value !== null) {
+        for (const [key, child] of Object.entries(value)){
+            found.push(...findSampleRowLiterals(child, path === '' ? key : `${path}.${key}`));
+        }
+    }
+    return found;
+}
+/**
+ * Finds the sample-row literals in the defaults of component descriptors, as `<component>: <property path>`
+ * entries (the property path is followed by the location inside the default).
+ *
+ * @param descriptors The descriptors to inspect.
+ */ function findDescriptorSampleRowLiterals(descriptors) {
+    const found = [];
+    for (const descriptor of descriptors){
+        for (const property of descriptor.properties ?? []){
+            for (const location of findSampleRowLiterals(property.default)){
+                const suffix = location === '(root)' ? '' : location.startsWith('[') ? location : `.${location}`;
+                found.push(`${descriptor.component}: ${property.path}${suffix}`);
+            }
+        }
+    }
+    return found;
+}
+function isRow(item) {
+    return typeof item === 'object' && item !== null && !Array.isArray(item) && Object.keys(item).length >= 2;
+}
+/**
+ * Finds the sample-row literals in the element properties of a template's content, as
+ * `<componentName>.<property>` entries (with the location inside the value when it is nested). Only property
+ * values are scanned: the element tree itself is made of objects and is not data.
+ *
+ * @param content A template's content, keyed by slot name.
+ */ function findTemplateSampleRowLiterals(content) {
+    const found = [];
+    const visit = (elements)=>{
+        for (const element of elements ?? []){
+            for (const [name, value] of Object.entries(element.properties ?? {})){
+                for (const location of findSampleRowLiterals(value)){
+                    const suffix = location === '(root)' ? '' : location.startsWith('[') ? location : `.${location}`;
+                    found.push(`${element.componentName ?? '(unnamed)'}.${name}${suffix}`);
+                }
+            }
+            Object.values(element.slots ?? {}).forEach(visit);
+        }
+    };
+    Object.values(content ?? {}).forEach(visit);
+    return found;
+}
+
+exports.findDescriptorSampleRowLiterals = findDescriptorSampleRowLiterals;
+exports.findSampleRowLiterals = findSampleRowLiterals;
+exports.findTemplateSampleRowLiterals = findTemplateSampleRowLiterals;
+//# sourceMappingURL=findSampleRowLiterals.js.map

package/dist/cjs/sampleData/findSampleRowLiterals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findSampleRowLiterals.js","sources":["../../../sampleData/findSampleRowLiterals.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 { ComponentDescriptor } from '@cratis/scene.model';\n\n/**\n * Finds sample-row literals inside a value: an array holding plain objects of two or more keys, which is what\n * a hand-written list of demo rows looks like. Returns the path of each, e.g. `rows` or `items[2].children`.\n * A single-key object is a choice or a token, not a row, and is not reported.\n *\n * Spec §11 SD1: components keep declaring shapes only, so a component descriptor's defaults and a template's\n * properties must not carry row literals; demo rows belong to sample-data packs.\n *\n * @param value The value to inspect.\n * @param path The path prefix of the value, empty for the root.\n */\nexport function findSampleRowLiterals(value: unknown, path = ''): string[] {\n    const found: string[] = [];\n    if (Array.isArray(value)) {\n        if (value.some(isRow)) found.push(path === '' ? '(root)' : path);\n        value.forEach((item, index) => found.push(...findSampleRowLiterals(item, `${path}[${index}]`)));\n    } else if (typeof value === 'object' && value !== null) {\n        for (const [key, child] of Object.entries(value)) {\n            found.push(...findSampleRowLiterals(child, path === '' ? key : `${path}.${key}`));\n        }\n    }\n\n    return found;\n}\n\n/**\n * Finds the sample-row literals in the defaults of component descriptors, as `<component>: <property path>`\n * entries (the property path is followed by the location inside the default).\n *\n * @param descriptors The descriptors to inspect.\n */\nexport function findDescriptorSampleRowLiterals(descriptors: readonly ComponentDescriptor[]): string[] {\n    const found: string[] = [];\n    for (const descriptor of descriptors) {\n        for (const property of descriptor.properties ?? []) {\n            for (const location of findSampleRowLiterals(property.default)) {\n                const suffix = location === '(root)' ? '' : (location.startsWith('[') ? location : `.${location}`);\n                found.push(`${descriptor.component}: ${property.path}${suffix}`);\n            }\n        }\n    }\n\n    return found;\n}\n\nfunction isRow(item: unknown): boolean {\n    return typeof item === 'object' && item !== null && !Array.isArray(item) && Object.keys(item).length >= 2;\n}\n\n/** The part of a scene element the scan reads: its properties and the child elements in its slots. */\ninterface ScannedElement {\n    componentName?: string;\n    properties?: Record<string, unknown>;\n    slots?: Record<string, ScannedElement[]>;\n}\n\n/**\n * Finds the sample-row literals in the element properties of a template's content, as\n * `<componentName>.<property>` entries (with the location inside the value when it is nested). Only property\n * values are scanned: the element tree itself is made of objects and is not data.\n *\n * @param content A template's content, keyed by slot name.\n */\nexport function findTemplateSampleRowLiterals(content: Record<string, ScannedElement[]> | undefined): string[] {\n    const found: string[] = [];\n    const visit = (elements: ScannedElement[] | undefined) => {\n        for (const element of elements ?? []) {\n            for (const [name, value] of Object.entries(element.properties ?? {})) {\n                for (const location of findSampleRowLiterals(value)) {\n                    const suffix = location === '(root)' ? '' : (location.startsWith('[') ? location : `.${location}`);\n                    found.push(`${element.componentName ?? '(unnamed)'}.${name}${suffix}`);\n                }\n            }\n\n            Object.values(element.slots ?? {}).forEach(visit);\n        }\n    };\n\n    Object.values(content ?? {}).forEach(visit);\n    return found;\n}\n"],"names":["findSampleRowLiterals","value","path","found","Array","isArray","some","isRow","push","forEach","item","index","key","child","Object","entries","findDescriptorSampleRowLiterals","descriptors","descriptor","property","properties","location","default","suffix","startsWith","component","keys","length","findTemplateSampleRowLiterals","content","visit","elements","element","name","componentName","values","slots"],"mappings":";;AAAA;AACA;AAIA;;;;;;;;;;AAUC,IACM,SAASA,qBAAAA,CAAsBC,KAAc,EAAEC,OAAO,EAAE,EAAA;AAC3D,IAAA,MAAMC,QAAkB,EAAE;IAC1B,IAAIC,KAAAA,CAAMC,OAAO,CAACJ,KAAAA,CAAAA,EAAQ;QACtB,IAAIA,KAAAA,CAAMK,IAAI,CAACC,KAAAA,CAAAA,EAAQJ,MAAMK,IAAI,CAACN,IAAAA,KAAS,EAAA,GAAK,QAAA,GAAWA,IAAAA,CAAAA;AAC3DD,QAAAA,KAAAA,CAAMQ,OAAO,CAAC,CAACC,IAAAA,EAAMC,KAAAA,GAAUR,MAAMK,IAAI,CAAA,GAAIR,qBAAAA,CAAsBU,IAAAA,EAAM,GAAGR,IAAAA,CAAK,CAAC,EAAES,KAAAA,CAAM,CAAC,CAAC,CAAA,CAAA,CAAA;AAChG,IAAA,CAAA,MAAO,IAAI,OAAOV,KAAAA,KAAU,QAAA,IAAYA,UAAU,IAAA,EAAM;QACpD,KAAK,MAAM,CAACW,GAAAA,EAAKC,KAAAA,CAAM,IAAIC,MAAAA,CAAOC,OAAO,CAACd,KAAAA,CAAAA,CAAQ;YAC9CE,KAAAA,CAAMK,IAAI,CAAA,GAAIR,qBAAAA,CAAsBa,KAAAA,EAAOX,IAAAA,KAAS,EAAA,GAAKU,GAAAA,GAAM,CAAA,EAAGV,IAAAA,CAAK,CAAC,EAAEU,GAAAA,CAAAA,CAAK,CAAA,CAAA;AACnF,QAAA;AACJ,IAAA;IAEA,OAAOT,KAAAA;AACX;AAEA;;;;;IAMO,SAASa,+BAAAA,CAAgCC,WAA2C,EAAA;AACvF,IAAA,MAAMd,QAAkB,EAAE;IAC1B,KAAK,MAAMe,cAAcD,WAAAA,CAAa;AAClC,QAAA,KAAK,MAAME,QAAAA,IAAYD,UAAAA,CAAWE,UAAU,IAAI,EAAE,CAAE;AAChD,YAAA,KAAK,MAAMC,QAAAA,IAAYrB,qBAAAA,CAAsBmB,QAAAA,CAASG,OAAO,CAAA,CAAG;AAC5D,gBAAA,MAAMC,MAAAA,GAASF,QAAAA,KAAa,QAAA,GAAW,EAAA,GAAMA,QAAAA,CAASG,UAAU,CAAC,GAAA,CAAA,GAAOH,QAAAA,GAAW,CAAC,CAAC,EAAEA,QAAAA,CAAAA,CAAU;gBACjGlB,KAAAA,CAAMK,IAAI,CAAC,CAAA,EAAGU,UAAAA,CAAWO,SAAS,CAAC,EAAE,EAAEN,QAAAA,CAASjB,IAAI,CAAA,EAAGqB,MAAAA,CAAAA,CAAQ,CAAA;AACnE,YAAA;AACJ,QAAA;AACJ,IAAA;IAEA,OAAOpB,KAAAA;AACX;AAEA,SAASI,MAAMG,IAAa,EAAA;AACxB,IAAA,OAAO,OAAOA,IAAAA,KAAS,QAAA,IAAYA,IAAAA,KAAS,QAAQ,CAACN,KAAAA,CAAMC,OAAO,CAACK,SAASI,MAAAA,CAAOY,IAAI,CAAChB,IAAAA,CAAAA,CAAMiB,MAAM,IAAI,CAAA;AAC5G;AASA;;;;;;IAOO,SAASC,6BAAAA,CAA8BC,OAAqD,EAAA;AAC/F,IAAA,MAAM1B,QAAkB,EAAE;AAC1B,IAAA,MAAM2B,QAAQ,CAACC,QAAAA,GAAAA;AACX,QAAA,KAAK,MAAMC,OAAAA,IAAWD,QAAAA,IAAY,EAAE,CAAE;AAClC,YAAA,KAAK,MAAM,CAACE,IAAAA,EAAMhC,KAAAA,CAAM,IAAIa,MAAAA,CAAOC,OAAO,CAACiB,OAAAA,CAAQZ,UAAU,IAAI,EAAC,CAAA,CAAI;gBAClE,KAAK,MAAMC,QAAAA,IAAYrB,qBAAAA,CAAsBC,KAAAA,CAAAA,CAAQ;AACjD,oBAAA,MAAMsB,MAAAA,GAASF,QAAAA,KAAa,QAAA,GAAW,EAAA,GAAMA,QAAAA,CAASG,UAAU,CAAC,GAAA,CAAA,GAAOH,QAAAA,GAAW,CAAC,CAAC,EAAEA,QAAAA,CAAAA,CAAU;oBACjGlB,KAAAA,CAAMK,IAAI,CAAC,CAAA,EAAGwB,OAAAA,CAAQE,aAAa,IAAI,WAAA,CAAY,CAAC,EAAED,IAAAA,CAAAA,EAAOV,MAAAA,CAAAA,CAAQ,CAAA;AACzE,gBAAA;AACJ,YAAA;YAEAT,MAAAA,CAAOqB,MAAM,CAACH,OAAAA,CAAQI,KAAK,IAAI,EAAC,CAAA,CAAG3B,OAAO,CAACqB,KAAAA,CAAAA;AAC/C,QAAA;AACJ,IAAA,CAAA;AAEAhB,IAAAA,MAAAA,CAAOqB,MAAM,CAACN,OAAAA,IAAW,EAAC,CAAA,CAAGpB,OAAO,CAACqB,KAAAA,CAAAA;IACrC,OAAO3B,KAAAA;AACX;;;;"}

package/dist/cjs/sampleData/generateSample.js

@@ -0,0 +1,188 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+var inferSampleFieldKind = require('./inferSampleFieldKind.js');
+var sampleLocales = require('./sampleLocales.js');
+var SampleRandom = require('./SampleRandom.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The seed used when none is given, so previews are stable without any configuration. */ const defaultSampleSeed = 1;
+/** How many rows are generated when no count is given. */ const defaultSampleRowCount = 5;
+/** The most rows one call generates. */ const maximumSampleRowCount = 1000;
+/** Days since 1970-01-01 of 2024-01-01, the anchor generated dates count forward from. */ const anchorDay = 19723;
+/** Generated dates fall within this many days after the anchor. */ const dateSpanDays = 731;
+/**
+ * Generates `rowCount` rows of a shape, deterministically for a seed: the same shape, seed, row count and
+ * locale yield the same rows (byte-identical once serialized) in the C# and TypeScript engines.
+ *
+ * Each row has its own generator (see {@link rowSeed}), so row `i` is the same however many rows are asked
+ * for. Within a row the fields are generated in declaration order. A nullable field first draws whether it is
+ * null (one in five is) and then always draws its value, so the sequence never depends on nullability
+ * outcomes. Values follow the field's kind and locale; enum fields only ever produce one of their values,
+ * dates stay within 2024-2025 and amounts have two decimals.
+ *
+ * @param shape The shape to generate rows for.
+ * @param seed The seed; defaults to {@link defaultSampleSeed}.
+ * @param rowCount The number of rows; defaults to {@link defaultSampleRowCount}, clamped to `[0, 1000]`.
+ * @param locale The BCP 47 locale tag selecting names, cities and formats; unknown tags use the default pool.
+ */ function generateSample(shape, seed, rowCount, locale) {
+    const count = Math.min(Math.max(Math.trunc(rowCount ?? defaultSampleRowCount), 0), maximumSampleRowCount);
+    const effectiveSeed = (seed ?? defaultSampleSeed) >>> 0;
+    const pool = sampleLocales.sampleLocaleFor(locale);
+    const rows = [];
+    for(let index = 0; index < count; index++){
+        const random = new SampleRandom.SampleRandom(SampleRandom.rowSeed(effectiveSeed, shape.name, index));
+        const row = {};
+        for (const field of shape.fields){
+            const isNull = field.nullable === true && random.nextInt(5) === 0;
+            const value = generateValue(field, inferSampleFieldKind.inferSampleFieldKind(field), random, pool);
+            row[field.name] = isNull ? null : value;
+        }
+        rows.push(row);
+    }
+    return rows;
+}
+function generateValue(field, kind, random, pool) {
+    switch(kind){
+        case scene_model.SampleFieldKind.Id:
+            return generateId(random);
+        case scene_model.SampleFieldKind.Name:
+            return `${random.pick(pool.firstNames)} ${random.pick(pool.lastNames)}`;
+        case scene_model.SampleFieldKind.Company:
+            return random.pick(pool.companies);
+        case scene_model.SampleFieldKind.Email:
+            {
+                const first = random.pick(pool.firstNames);
+                const last = random.pick(pool.lastNames);
+                return `${slug(first)}.${slug(last)}@${random.pick(pool.domains)}`;
+            }
+        case scene_model.SampleFieldKind.Phone:
+            return [
+                ...pool.phoneTemplate
+            ].map((character)=>character === '#' ? String(random.nextInt(10)) : character).join('');
+        case scene_model.SampleFieldKind.City:
+            return random.pick(pool.cities);
+        case scene_model.SampleFieldKind.Text:
+            {
+                const words = Array.from({
+                    length: 3 + random.nextInt(4)
+                }, ()=>random.pick(pool.words));
+                return capitalize(words.join(' '));
+            }
+        case scene_model.SampleFieldKind.WholeNumber:
+            {
+                const [low, high] = range(field.min, field.max, 0, 1000, Math.trunc);
+                return low + random.nextInt(high - low + 1);
+            }
+        case scene_model.SampleFieldKind.Amount:
+            {
+                const [low, high] = range(field.min, field.max, 10, 5000, (value)=>Math.floor(value * 100 + 0.5));
+                return (low + random.nextInt(high - low + 1)) / 100;
+            }
+        case scene_model.SampleFieldKind.Boolean:
+            return random.nextInt(2) === 1;
+        case scene_model.SampleFieldKind.Date:
+            return formatDay(anchorDay + random.nextInt(dateSpanDays));
+        case scene_model.SampleFieldKind.DateTime:
+            {
+                const day = anchorDay + random.nextInt(dateSpanDays);
+                const seconds = random.nextInt(86400);
+                return `${formatDay(day)}T${pad(Math.floor(seconds / 3600))}:${pad(Math.floor(seconds / 60) % 60)}:${pad(seconds % 60)}Z`;
+            }
+        case scene_model.SampleFieldKind.Enum:
+            return field.enumValues !== undefined && field.enumValues !== null && field.enumValues.length > 0 ? random.pick(field.enumValues) : null;
+        default:
+            return null;
+    }
+}
+function range(min, max, defaultMin, defaultMax, convert) {
+    const low = convert(min ?? defaultMin);
+    const high = convert(max ?? defaultMax);
+    return high < low ? [
+        high,
+        low
+    ] : [
+        low,
+        high
+    ];
+}
+function generateId(random) {
+    const a = random.next();
+    const b = (random.next() & 0xFFFF0FFF | 0x00004000) >>> 0;
+    const c = (random.next() & 0x3FFFFFFF | 0x80000000) >>> 0;
+    const d = random.next();
+    return `${hex(a, 8)}-${hex(b >>> 16, 4)}-${hex(b & 0xFFFF, 4)}-${hex(c >>> 16, 4)}-${hex(c & 0xFFFF, 4)}${hex(d, 8)}`;
+}
+const transliterations = new Map([
+    [
+        'æ',
+        'ae'
+    ],
+    [
+        'ø',
+        'o'
+    ],
+    [
+        'å',
+        'a'
+    ],
+    [
+        'ä',
+        'a'
+    ],
+    [
+        'ö',
+        'o'
+    ],
+    [
+        'ü',
+        'u'
+    ],
+    [
+        'ß',
+        'ss'
+    ],
+    [
+        'é',
+        'e'
+    ]
+]);
+function slug(text) {
+    let result = '';
+    for (const character of text.toLowerCase()){
+        const mapped = transliterations.get(character) ?? character;
+        for (const part of mapped){
+            if (part >= 'a' && part <= 'z' || part >= '0' && part <= '9') result += part;
+        }
+    }
+    return result;
+}
+function capitalize(text) {
+    const first = text.charAt(0);
+    return first >= 'a' && first <= 'z' ? first.toUpperCase() + text.slice(1) : text;
+}
+function hex(value, digits) {
+    return (value >>> 0).toString(16).padStart(digits, '0');
+}
+function pad(value) {
+    return value < 10 ? `0${value}` : String(value);
+}
+/** Formats days since 1970-01-01 as `yyyy-MM-dd` (Howard Hinnant's civil-from-days). */ function formatDay(days) {
+    const shifted = days + 719468;
+    const era = Math.floor(shifted / 146097);
+    const dayOfEra = shifted - era * 146097;
+    const yearOfEra = Math.floor((dayOfEra - Math.floor(dayOfEra / 1460) + Math.floor(dayOfEra / 36524) - Math.floor(dayOfEra / 146096)) / 365);
+    const dayOfYear = dayOfEra - (365 * yearOfEra + Math.floor(yearOfEra / 4) - Math.floor(yearOfEra / 100));
+    const monthPrime = Math.floor((5 * dayOfYear + 2) / 153);
+    const day = dayOfYear - Math.floor((153 * monthPrime + 2) / 5) + 1;
+    const month = monthPrime < 10 ? monthPrime + 3 : monthPrime - 9;
+    const year = yearOfEra + era * 400 + (month <= 2 ? 1 : 0);
+    return `${String(year).padStart(4, '0')}-${pad(month)}-${pad(day)}`;
+}
+
+exports.defaultSampleRowCount = defaultSampleRowCount;
+exports.defaultSampleSeed = defaultSampleSeed;
+exports.generateSample = generateSample;
+exports.maximumSampleRowCount = maximumSampleRowCount;
+//# sourceMappingURL=generateSample.js.map

package/dist/cjs/sampleData/generateSample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateSample.js","sources":["../../../sampleData/generateSample.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 { SampleFieldKind, SampleShape, SampleShapeField } from '@cratis/scene.model';\nimport { inferSampleFieldKind } from './inferSampleFieldKind';\nimport { SampleLocale, sampleLocaleFor } from './sampleLocales';\nimport { SampleRandom, rowSeed } from './SampleRandom';\n\n/** The seed used when none is given, so previews are stable without any configuration. */\nexport const defaultSampleSeed = 1;\n\n/** How many rows are generated when no count is given. */\nexport const defaultSampleRowCount = 5;\n\n/** The most rows one call generates. */\nexport const maximumSampleRowCount = 1000;\n\n/** Days since 1970-01-01 of 2024-01-01, the anchor generated dates count forward from. */\nconst anchorDay = 19723;\n\n/** Generated dates fall within this many days after the anchor. */\nconst dateSpanDays = 731;\n\n/**\n * Generates `rowCount` rows of a shape, deterministically for a seed: the same shape, seed, row count and\n * locale yield the same rows (byte-identical once serialized) in the C# and TypeScript engines.\n *\n * Each row has its own generator (see {@link rowSeed}), so row `i` is the same however many rows are asked\n * for. Within a row the fields are generated in declaration order. A nullable field first draws whether it is\n * null (one in five is) and then always draws its value, so the sequence never depends on nullability\n * outcomes. Values follow the field's kind and locale; enum fields only ever produce one of their values,\n * dates stay within 2024-2025 and amounts have two decimals.\n *\n * @param shape The shape to generate rows for.\n * @param seed The seed; defaults to {@link defaultSampleSeed}.\n * @param rowCount The number of rows; defaults to {@link defaultSampleRowCount}, clamped to `[0, 1000]`.\n * @param locale The BCP 47 locale tag selecting names, cities and formats; unknown tags use the default pool.\n */\nexport function generateSample(shape: SampleShape, seed?: number, rowCount?: number, locale?: string): Record<string, unknown>[] {\n    const count = Math.min(Math.max(Math.trunc(rowCount ?? defaultSampleRowCount), 0), maximumSampleRowCount);\n    const effectiveSeed = (seed ?? defaultSampleSeed) >>> 0;\n    const pool = sampleLocaleFor(locale);\n    const rows: Record<string, unknown>[] = [];\n\n    for (let index = 0; index < count; index++) {\n        const random = new SampleRandom(rowSeed(effectiveSeed, shape.name, index));\n        const row: Record<string, unknown> = {};\n        for (const field of shape.fields) {\n            const isNull = field.nullable === true && random.nextInt(5) === 0;\n            const value = generateValue(field, inferSampleFieldKind(field), random, pool);\n            row[field.name] = isNull ? null : value;\n        }\n        rows.push(row);\n    }\n\n    return rows;\n}\n\nfunction generateValue(field: SampleShapeField, kind: SampleFieldKind, random: SampleRandom, pool: SampleLocale): unknown {\n    switch (kind) {\n        case SampleFieldKind.Id:\n            return generateId(random);\n        case SampleFieldKind.Name:\n            return `${random.pick(pool.firstNames)} ${random.pick(pool.lastNames)}`;\n        case SampleFieldKind.Company:\n            return random.pick(pool.companies);\n        case SampleFieldKind.Email: {\n            const first = random.pick(pool.firstNames);\n            const last = random.pick(pool.lastNames);\n            return `${slug(first)}.${slug(last)}@${random.pick(pool.domains)}`;\n        }\n        case SampleFieldKind.Phone:\n            return [...pool.phoneTemplate].map(character => (character === '#' ? String(random.nextInt(10)) : character)).join('');\n        case SampleFieldKind.City:\n            return random.pick(pool.cities);\n        case SampleFieldKind.Text: {\n            const words = Array.from({ length: 3 + random.nextInt(4) }, () => random.pick(pool.words));\n            return capitalize(words.join(' '));\n        }\n        case SampleFieldKind.WholeNumber: {\n            const [low, high] = range(field.min, field.max, 0, 1000, Math.trunc);\n            return low + random.nextInt(high - low + 1);\n        }\n        case SampleFieldKind.Amount: {\n            const [low, high] = range(field.min, field.max, 10, 5000, value => Math.floor(value * 100 + 0.5));\n            return (low + random.nextInt(high - low + 1)) / 100;\n        }\n        case SampleFieldKind.Boolean:\n            return random.nextInt(2) === 1;\n        case SampleFieldKind.Date:\n            return formatDay(anchorDay + random.nextInt(dateSpanDays));\n        case SampleFieldKind.DateTime: {\n            const day = anchorDay + random.nextInt(dateSpanDays);\n            const seconds = random.nextInt(86400);\n            return `${formatDay(day)}T${pad(Math.floor(seconds / 3600))}:${pad(Math.floor(seconds / 60) % 60)}:${pad(seconds % 60)}Z`;\n        }\n        case SampleFieldKind.Enum:\n            return field.enumValues !== undefined && field.enumValues !== null && field.enumValues.length > 0 ? random.pick(field.enumValues) : null;\n        default:\n            return null;\n    }\n}\n\nfunction range(min: number | undefined, max: number | undefined, defaultMin: number, defaultMax: number, convert: (value: number) => number): [number, number] {\n    const low = convert(min ?? defaultMin);\n    const high = convert(max ?? defaultMax);\n    return high < low ? [high, low] : [low, high];\n}\n\nfunction generateId(random: SampleRandom): string {\n    const a = random.next();\n    const b = ((random.next() & 0xFFFF0FFF) | 0x00004000) >>> 0;\n    const c = ((random.next() & 0x3FFFFFFF) | 0x80000000) >>> 0;\n    const d = random.next();\n    return `${hex(a, 8)}-${hex(b >>> 16, 4)}-${hex(b & 0xFFFF, 4)}-${hex(c >>> 16, 4)}-${hex(c & 0xFFFF, 4)}${hex(d, 8)}`;\n}\n\nconst transliterations = new Map<string, string>([['æ', 'ae'], ['ø', 'o'], ['å', 'a'], ['ä', 'a'], ['ö', 'o'], ['ü', 'u'], ['ß', 'ss'], ['é', 'e']]);\n\nfunction slug(text: string): string {\n    let result = '';\n    for (const character of text.toLowerCase()) {\n        const mapped = transliterations.get(character) ?? character;\n        for (const part of mapped) {\n            if ((part >= 'a' && part <= 'z') || (part >= '0' && part <= '9')) result += part;\n        }\n    }\n    return result;\n}\n\nfunction capitalize(text: string): string {\n    const first = text.charAt(0);\n    return first >= 'a' && first <= 'z' ? first.toUpperCase() + text.slice(1) : text;\n}\n\nfunction hex(value: number, digits: number): string {\n    return (value >>> 0).toString(16).padStart(digits, '0');\n}\n\nfunction pad(value: number): string {\n    return value < 10 ? `0${value}` : String(value);\n}\n\n/** Formats days since 1970-01-01 as `yyyy-MM-dd` (Howard Hinnant's civil-from-days). */\nfunction formatDay(days: number): string {\n    const shifted = days + 719468;\n    const era = Math.floor(shifted / 146097);\n    const dayOfEra = shifted - era * 146097;\n    const yearOfEra = Math.floor((dayOfEra - Math.floor(dayOfEra / 1460) + Math.floor(dayOfEra / 36524) - Math.floor(dayOfEra / 146096)) / 365);\n    const dayOfYear = dayOfEra - (365 * yearOfEra + Math.floor(yearOfEra / 4) - Math.floor(yearOfEra / 100));\n    const monthPrime = Math.floor((5 * dayOfYear + 2) / 153);\n    const day = dayOfYear - Math.floor((153 * monthPrime + 2) / 5) + 1;\n    const month = monthPrime < 10 ? monthPrime + 3 : monthPrime - 9;\n    const year = yearOfEra + era * 400 + (month <= 2 ? 1 : 0);\n    return `${String(year).padStart(4, '0')}-${pad(month)}-${pad(day)}`;\n}\n"],"names":["defaultSampleSeed","defaultSampleRowCount","maximumSampleRowCount","anchorDay","dateSpanDays","generateSample","shape","seed","rowCount","locale","count","Math","min","max","trunc","effectiveSeed","pool","sampleLocaleFor","rows","index","random","SampleRandom","rowSeed","name","row","field","fields","isNull","nullable","nextInt","value","generateValue","inferSampleFieldKind","push","kind","SampleFieldKind","Id","generateId","Name","pick","firstNames","lastNames","Company","companies","Email","first","last","slug","domains","Phone","phoneTemplate","map","character","String","join","City","cities","Text","words","Array","from","length","capitalize","WholeNumber","low","high","range","Amount","floor","Boolean","Date","formatDay","DateTime","day","seconds","pad","Enum","enumValues","undefined","defaultMin","defaultMax","convert","a","next","b","c","d","hex","transliterations","Map","text","result","toLowerCase","mapped","get","part","charAt","toUpperCase","slice","digits","toString","padStart","days","shifted","era","dayOfEra","yearOfEra","dayOfYear","monthPrime","month","year"],"mappings":";;;;;;;AAAA;AACA;AAOA,2FACO,MAAMA,iBAAAA,GAAoB;AAEjC,2DACO,MAAMC,qBAAAA,GAAwB;AAErC,yCACO,MAAMC,qBAAAA,GAAwB;AAErC,2FACA,MAAMC,SAAAA,GAAY,KAAA;AAElB,oEACA,MAAMC,YAAAA,GAAe,GAAA;AAErB;;;;;;;;;;;;;;IAeO,SAASC,cAAAA,CAAeC,KAAkB,EAAEC,IAAa,EAAEC,QAAiB,EAAEC,MAAe,EAAA;AAChG,IAAA,MAAMC,KAAAA,GAAQC,IAAAA,CAAKC,GAAG,CAACD,IAAAA,CAAKE,GAAG,CAACF,IAAAA,CAAKG,KAAK,CAACN,QAAAA,IAAYP,qBAAAA,CAAAA,EAAwB,CAAA,CAAA,EAAIC,qBAAAA,CAAAA;AACnF,IAAA,MAAMa,aAAAA,GAAiBR,CAAAA,IAAAA,IAAQP,iBAAgB,MAAO,CAAA;AACtD,IAAA,MAAMgB,OAAOC,6BAAAA,CAAgBR,MAAAA,CAAAA;AAC7B,IAAA,MAAMS,OAAkC,EAAE;AAE1C,IAAA,IAAK,IAAIC,KAAAA,GAAQ,CAAA,EAAGA,KAAAA,GAAQT,OAAOS,KAAAA,EAAAA,CAAS;AACxC,QAAA,MAAMC,SAAS,IAAIC,yBAAAA,CAAaC,qBAAQP,aAAAA,EAAeT,KAAAA,CAAMiB,IAAI,EAAEJ,KAAAA,CAAAA,CAAAA;AACnE,QAAA,MAAMK,MAA+B,EAAC;AACtC,QAAA,KAAK,MAAMC,KAAAA,IAASnB,KAAAA,CAAMoB,MAAM,CAAE;YAC9B,MAAMC,MAAAA,GAASF,MAAMG,QAAQ,KAAK,QAAQR,MAAAA,CAAOS,OAAO,CAAC,CAAA,CAAA,KAAO,CAAA;AAChE,YAAA,MAAMC,KAAAA,GAAQC,aAAAA,CAAcN,KAAAA,EAAOO,yCAAAA,CAAqBP,QAAQL,MAAAA,EAAQJ,IAAAA,CAAAA;AACxEQ,YAAAA,GAAG,CAACC,KAAAA,CAAMF,IAAI,CAAC,GAAGI,SAAS,IAAA,GAAOG,KAAAA;AACtC,QAAA;AACAZ,QAAAA,IAAAA,CAAKe,IAAI,CAACT,GAAAA,CAAAA;AACd,IAAA;IAEA,OAAON,IAAAA;AACX;AAEA,SAASa,cAAcN,KAAuB,EAAES,IAAqB,EAAEd,MAAoB,EAAEJ,IAAkB,EAAA;IAC3G,OAAQkB,IAAAA;AACJ,QAAA,KAAKC,4BAAgBC,EAAE;AACnB,YAAA,OAAOC,UAAAA,CAAWjB,MAAAA,CAAAA;AACtB,QAAA,KAAKe,4BAAgBG,IAAI;AACrB,YAAA,OAAO,CAAA,EAAGlB,MAAAA,CAAOmB,IAAI,CAACvB,KAAKwB,UAAU,CAAA,CAAE,CAAC,EAAEpB,MAAAA,CAAOmB,IAAI,CAACvB,IAAAA,CAAKyB,SAAS,CAAA,CAAA,CAAG;AAC3E,QAAA,KAAKN,4BAAgBO,OAAO;AACxB,YAAA,OAAOtB,MAAAA,CAAOmB,IAAI,CAACvB,IAAAA,CAAK2B,SAAS,CAAA;AACrC,QAAA,KAAKR,4BAAgBS,KAAK;AAAE,YAAA;AACxB,gBAAA,MAAMC,KAAAA,GAAQzB,MAAAA,CAAOmB,IAAI,CAACvB,KAAKwB,UAAU,CAAA;AACzC,gBAAA,MAAMM,IAAAA,GAAO1B,MAAAA,CAAOmB,IAAI,CAACvB,KAAKyB,SAAS,CAAA;AACvC,gBAAA,OAAO,CAAA,EAAGM,IAAAA,CAAKF,KAAAA,CAAAA,CAAO,CAAC,EAAEE,IAAAA,CAAKD,IAAAA,CAAAA,CAAM,CAAC,EAAE1B,MAAAA,CAAOmB,IAAI,CAACvB,IAAAA,CAAKgC,OAAO,CAAA,CAAA,CAAG;AACtE,YAAA;AACA,QAAA,KAAKb,4BAAgBc,KAAK;YACtB,OAAO;AAAIjC,gBAAAA,GAAAA,IAAAA,CAAKkC;AAAc,aAAA,CAACC,GAAG,CAACC,CAAAA,SAAAA,GAAcA,SAAAA,KAAc,GAAA,GAAMC,MAAAA,CAAOjC,MAAAA,CAAOS,OAAO,CAAC,EAAA,CAAA,CAAA,GAAOuB,SAAAA,CAAAA,CAAYE,IAAI,CAAC,EAAA,CAAA;AACvH,QAAA,KAAKnB,4BAAgBoB,IAAI;AACrB,YAAA,OAAOnC,MAAAA,CAAOmB,IAAI,CAACvB,IAAAA,CAAKwC,MAAM,CAAA;AAClC,QAAA,KAAKrB,4BAAgBsB,IAAI;AAAE,YAAA;gBACvB,MAAMC,KAAAA,GAAQC,KAAAA,CAAMC,IAAI,CAAC;oBAAEC,MAAAA,EAAQ,CAAA,GAAIzC,MAAAA,CAAOS,OAAO,CAAC,CAAA;AAAG,iBAAA,EAAG,IAAMT,MAAAA,CAAOmB,IAAI,CAACvB,KAAK0C,KAAK,CAAA,CAAA;gBACxF,OAAOI,UAAAA,CAAWJ,KAAAA,CAAMJ,IAAI,CAAC,GAAA,CAAA,CAAA;AACjC,YAAA;AACA,QAAA,KAAKnB,4BAAgB4B,WAAW;AAAE,YAAA;AAC9B,gBAAA,MAAM,CAACC,GAAAA,EAAKC,IAAAA,CAAK,GAAGC,MAAMzC,KAAAA,CAAMb,GAAG,EAAEa,KAAAA,CAAMZ,GAAG,EAAE,CAAA,EAAG,IAAA,EAAMF,KAAKG,KAAK,CAAA;AACnE,gBAAA,OAAOkD,GAAAA,GAAM5C,MAAAA,CAAOS,OAAO,CAACoC,OAAOD,GAAAA,GAAM,CAAA,CAAA;AAC7C,YAAA;AACA,QAAA,KAAK7B,4BAAgBgC,MAAM;AAAE,YAAA;AACzB,gBAAA,MAAM,CAACH,GAAAA,EAAKC,IAAAA,CAAK,GAAGC,KAAAA,CAAMzC,KAAAA,CAAMb,GAAG,EAAEa,KAAAA,CAAMZ,GAAG,EAAE,EAAA,EAAI,MAAMiB,CAAAA,KAAAA,GAASnB,KAAKyD,KAAK,CAACtC,QAAQ,GAAA,GAAM,GAAA,CAAA,CAAA;gBAC5F,OAAQkC,CAAAA,GAAAA,GAAM5C,MAAAA,CAAOS,OAAO,CAACoC,IAAAA,GAAOD,GAAAA,GAAM,CAAA,CAAC,IAAK,GAAA;AACpD,YAAA;AACA,QAAA,KAAK7B,4BAAgBkC,OAAO;YACxB,OAAOjD,MAAAA,CAAOS,OAAO,CAAC,CAAA,CAAA,KAAO,CAAA;AACjC,QAAA,KAAKM,4BAAgBmC,IAAI;AACrB,YAAA,OAAOC,SAAAA,CAAUpE,SAAAA,GAAYiB,MAAAA,CAAOS,OAAO,CAACzB,YAAAA,CAAAA,CAAAA;AAChD,QAAA,KAAK+B,4BAAgBqC,QAAQ;AAAE,YAAA;AAC3B,gBAAA,MAAMC,GAAAA,GAAMtE,SAAAA,GAAYiB,MAAAA,CAAOS,OAAO,CAACzB,YAAAA,CAAAA;gBACvC,MAAMsE,OAAAA,GAAUtD,MAAAA,CAAOS,OAAO,CAAC,KAAA,CAAA;gBAC/B,OAAO,CAAA,EAAG0C,SAAAA,CAAUE,GAAAA,CAAAA,CAAK,CAAC,EAAEE,GAAAA,CAAIhE,IAAAA,CAAKyD,KAAK,CAACM,OAAAA,GAAU,IAAA,CAAA,CAAA,CAAO,CAAC,EAAEC,IAAIhE,IAAAA,CAAKyD,KAAK,CAACM,OAAAA,GAAU,EAAA,CAAA,GAAM,EAAA,CAAA,CAAI,CAAC,EAAEC,GAAAA,CAAID,OAAAA,GAAU,EAAA,CAAA,CAAI,CAAC,CAAC;AAC7H,YAAA;AACA,QAAA,KAAKvC,4BAAgByC,IAAI;AACrB,YAAA,OAAOnD,MAAMoD,UAAU,KAAKC,aAAarD,KAAAA,CAAMoD,UAAU,KAAK,IAAA,IAAQpD,KAAAA,CAAMoD,UAAU,CAAChB,MAAM,GAAG,CAAA,GAAIzC,MAAAA,CAAOmB,IAAI,CAACd,KAAAA,CAAMoD,UAAU,CAAA,GAAI,IAAA;AACxI,QAAA;YACI,OAAO,IAAA;AACf;AACJ;AAEA,SAASX,KAAAA,CAAMtD,GAAuB,EAAEC,GAAuB,EAAEkE,UAAkB,EAAEC,UAAkB,EAAEC,OAAkC,EAAA;IACvI,MAAMjB,GAAAA,GAAMiB,QAAQrE,GAAAA,IAAOmE,UAAAA,CAAAA;IAC3B,MAAMd,IAAAA,GAAOgB,QAAQpE,GAAAA,IAAOmE,UAAAA,CAAAA;AAC5B,IAAA,OAAOf,OAAOD,GAAAA,GAAM;AAACC,QAAAA,IAAAA;AAAMD,QAAAA;KAAI,GAAG;AAACA,QAAAA,GAAAA;AAAKC,QAAAA;AAAK,KAAA;AACjD;AAEA,SAAS5B,WAAWjB,MAAoB,EAAA;IACpC,MAAM8D,CAAAA,GAAI9D,OAAO+D,IAAI,EAAA;IACrB,MAAMC,CAAAA,GAAI,CAAEhE,OAAO+D,IAAI,EAAA,GAAK,UAAA,GAAc,UAAS,MAAO,CAAA;IAC1D,MAAME,CAAAA,GAAI,CAAEjE,OAAO+D,IAAI,EAAA,GAAK,UAAA,GAAc,UAAS,MAAO,CAAA;IAC1D,MAAMG,CAAAA,GAAIlE,OAAO+D,IAAI,EAAA;AACrB,IAAA,OAAO,CAAA,EAAGI,GAAAA,CAAIL,CAAAA,EAAG,CAAA,CAAA,CAAG,CAAC,EAAEK,GAAAA,CAAIH,CAAAA,KAAM,EAAA,EAAI,CAAA,CAAA,CAAG,CAAC,EAAEG,IAAIH,CAAAA,GAAI,MAAA,EAAQ,CAAA,CAAA,CAAG,CAAC,EAAEG,GAAAA,CAAIF,CAAAA,KAAM,EAAA,EAAI,CAAA,CAAA,CAAG,CAAC,EAAEE,GAAAA,CAAIF,CAAAA,GAAI,MAAA,EAAQ,CAAA,CAAA,CAAA,EAAKE,GAAAA,CAAID,GAAG,CAAA,CAAA,CAAA,CAAI;AACzH;AAEA,MAAME,gBAAAA,GAAmB,IAAIC,GAAAA,CAAoB;AAAC,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAK,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAK,KAAA;AAAE,IAAA;AAAC,QAAA,GAAA;AAAK,QAAA;AAAI;AAAC,CAAA,CAAA;AAEnJ,SAAS1C,KAAK2C,IAAY,EAAA;AACtB,IAAA,IAAIC,MAAAA,GAAS,EAAA;AACb,IAAA,KAAK,MAAMvC,SAAAA,IAAasC,IAAAA,CAAKE,WAAW,EAAA,CAAI;AACxC,QAAA,MAAMC,MAAAA,GAASL,gBAAAA,CAAiBM,GAAG,CAAC1C,SAAAA,CAAAA,IAAcA,SAAAA;QAClD,KAAK,MAAM2C,QAAQF,MAAAA,CAAQ;YACvB,IAAKE,QAAQ,GAAA,IAAOA,IAAAA,IAAQ,OAASA,IAAAA,IAAQ,GAAA,IAAOA,IAAAA,IAAQ,GAAA,EAAMJ,MAAAA,IAAUI,IAAAA;AAChF,QAAA;AACJ,IAAA;IACA,OAAOJ,MAAAA;AACX;AAEA,SAAS7B,WAAW4B,IAAY,EAAA;IAC5B,MAAM7C,KAAAA,GAAQ6C,IAAAA,CAAKM,MAAM,CAAC,CAAA,CAAA;IAC1B,OAAOnD,KAAAA,IAAS,GAAA,IAAOA,KAAAA,IAAS,GAAA,GAAMA,KAAAA,CAAMoD,WAAW,EAAA,GAAKP,IAAAA,CAAKQ,KAAK,CAAC,CAAA,CAAA,GAAKR,IAAAA;AAChF;AAEA,SAASH,GAAAA,CAAIzD,KAAa,EAAEqE,MAAc,EAAA;IACtC,OAAQrE,CAAAA,KAAAA,KAAU,CAAA,EAAGsE,QAAQ,CAAC,EAAA,CAAA,CAAIC,QAAQ,CAACF,MAAAA,EAAQ,GAAA,CAAA;AACvD;AAEA,SAASxB,IAAI7C,KAAa,EAAA;AACtB,IAAA,OAAOA,QAAQ,EAAA,GAAK,CAAC,CAAC,EAAEA,KAAAA,CAAAA,CAAO,GAAGuB,MAAAA,CAAOvB,KAAAA,CAAAA;AAC7C;AAEA,yFACA,SAASyC,SAAAA,CAAU+B,IAAY,EAAA;AAC3B,IAAA,MAAMC,UAAUD,IAAAA,GAAO,MAAA;AACvB,IAAA,MAAME,GAAAA,GAAM7F,IAAAA,CAAKyD,KAAK,CAACmC,OAAAA,GAAU,MAAA,CAAA;IACjC,MAAME,QAAAA,GAAWF,UAAUC,GAAAA,GAAM,MAAA;IACjC,MAAME,SAAAA,GAAY/F,KAAKyD,KAAK,CAAC,CAACqC,QAAAA,GAAW9F,IAAAA,CAAKyD,KAAK,CAACqC,QAAAA,GAAW,QAAQ9F,IAAAA,CAAKyD,KAAK,CAACqC,QAAAA,GAAW,KAAA,CAAA,GAAS9F,KAAKyD,KAAK,CAACqC,QAAAA,GAAW,MAAA,CAAM,IAAK,GAAA,CAAA;AACvI,IAAA,MAAME,SAAAA,GAAYF,QAAAA,IAAY,GAAA,GAAMC,YAAY/F,IAAAA,CAAKyD,KAAK,CAACsC,SAAAA,GAAY,CAAA,CAAA,GAAK/F,IAAAA,CAAKyD,KAAK,CAACsC,YAAY,GAAA,CAAG,CAAA;IACtG,MAAME,UAAAA,GAAajG,KAAKyD,KAAK,CAAC,CAAC,CAAA,GAAIuC,SAAAA,GAAY,CAAA,IAAK,GAAA,CAAA;IACpD,MAAMlC,GAAAA,GAAMkC,SAAAA,GAAYhG,IAAAA,CAAKyD,KAAK,CAAC,CAAC,GAAA,GAAMwC,UAAAA,GAAa,CAAA,IAAK,CAAA,CAAA,GAAK,CAAA;AACjE,IAAA,MAAMC,KAAAA,GAAQD,UAAAA,GAAa,EAAA,GAAKA,UAAAA,GAAa,IAAIA,UAAAA,GAAa,CAAA;IAC9D,MAAME,IAAAA,GAAOJ,YAAYF,GAAAA,GAAM,GAAA,IAAOK,KAAAA,IAAS,CAAA,GAAI,IAAI,CAAA,CAAA;AACvD,IAAA,OAAO,CAAA,EAAGxD,MAAAA,CAAOyD,IAAAA,CAAAA,CAAMT,QAAQ,CAAC,CAAA,EAAG,GAAA,CAAA,CAAK,CAAC,EAAE1B,GAAAA,CAAIkC,KAAAA,CAAAA,CAAO,CAAC,EAAElC,IAAIF,GAAAA,CAAAA,CAAAA,CAAM;AACvE;;;;;"}

package/dist/cjs/sampleData/inferSampleFieldKind.js

@@ -0,0 +1,176 @@
+'use strict';
+
+var scene_model = require('@cratis/scene.model');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const typeKinds = new Map([
+    [
+        'guid',
+        scene_model.SampleFieldKind.Id
+    ],
+    [
+        'uuid',
+        scene_model.SampleFieldKind.Id
+    ],
+    [
+        'int',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'int16',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'int32',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'int64',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'short',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'long',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'integer',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'number',
+        scene_model.SampleFieldKind.WholeNumber
+    ],
+    [
+        'decimal',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'double',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'float',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'single',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'money',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'currency',
+        scene_model.SampleFieldKind.Amount
+    ],
+    [
+        'bool',
+        scene_model.SampleFieldKind.Boolean
+    ],
+    [
+        'boolean',
+        scene_model.SampleFieldKind.Boolean
+    ],
+    [
+        'date',
+        scene_model.SampleFieldKind.Date
+    ],
+    [
+        'dateonly',
+        scene_model.SampleFieldKind.Date
+    ],
+    [
+        'datetime',
+        scene_model.SampleFieldKind.DateTime
+    ],
+    [
+        'datetimeoffset',
+        scene_model.SampleFieldKind.DateTime
+    ],
+    [
+        'timestamp',
+        scene_model.SampleFieldKind.DateTime
+    ]
+]);
+const nameKinds = [
+    [
+        [
+            'email'
+        ],
+        scene_model.SampleFieldKind.Email
+    ],
+    [
+        [
+            'phone',
+            'mobile'
+        ],
+        scene_model.SampleFieldKind.Phone
+    ],
+    [
+        [
+            'company',
+            'organization',
+            'organisation'
+        ],
+        scene_model.SampleFieldKind.Company
+    ],
+    [
+        [
+            'city',
+            'town'
+        ],
+        scene_model.SampleFieldKind.City
+    ],
+    [
+        [
+            'product',
+            'item',
+            'title',
+            'subject',
+            'description'
+        ],
+        scene_model.SampleFieldKind.Text
+    ],
+    [
+        [
+            'name',
+            'customer',
+            'assignee',
+            'owner',
+            'author',
+            'contact',
+            'manager',
+            'employee'
+        ],
+        scene_model.SampleFieldKind.Name
+    ]
+];
+/**
+ * The kind of value to generate for a field. An explicit `kind` wins; otherwise a field with `enumValues` is
+ * an enum, a recognised `type` decides, and failing that the field's name does (an `Id` suffix, `email`,
+ * `phone`, `company`, `city`, person-like names), with free text as the fallback. A trailing `?` on the type
+ * is ignored and type names compare case-insensitively.
+ */ function inferSampleFieldKind(field) {
+    if (field.kind !== undefined && field.kind !== null) return field.kind;
+    if (field.enumValues !== undefined && field.enumValues !== null && field.enumValues.length > 0) return scene_model.SampleFieldKind.Enum;
+    let type = (field.type ?? '').trim().toLowerCase();
+    if (type.endsWith('?')) type = type.slice(0, -1);
+    const byType = typeKinds.get(type);
+    if (byType !== undefined) return byType;
+    const name = field.name ?? '';
+    const lower = name.toLowerCase();
+    if (lower === 'id' || name.length > 2 && name.endsWith('Id')) return scene_model.SampleFieldKind.Id;
+    for (const [fragments, kind] of nameKinds){
+        if (fragments.some((fragment)=>lower.includes(fragment))) return kind;
+    }
+    return scene_model.SampleFieldKind.Text;
+}
+
+exports.inferSampleFieldKind = inferSampleFieldKind;
+//# sourceMappingURL=inferSampleFieldKind.js.map

package/dist/cjs/sampleData/inferSampleFieldKind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inferSampleFieldKind.js","sources":["../../../sampleData/inferSampleFieldKind.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 { SampleFieldKind, SampleShapeField } from '@cratis/scene.model';\n\nconst typeKinds = new Map<string, SampleFieldKind>([\n    ['guid', SampleFieldKind.Id],\n    ['uuid', SampleFieldKind.Id],\n    ['int', SampleFieldKind.WholeNumber],\n    ['int16', SampleFieldKind.WholeNumber],\n    ['int32', SampleFieldKind.WholeNumber],\n    ['int64', SampleFieldKind.WholeNumber],\n    ['short', SampleFieldKind.WholeNumber],\n    ['long', SampleFieldKind.WholeNumber],\n    ['integer', SampleFieldKind.WholeNumber],\n    ['number', SampleFieldKind.WholeNumber],\n    ['decimal', SampleFieldKind.Amount],\n    ['double', SampleFieldKind.Amount],\n    ['float', SampleFieldKind.Amount],\n    ['single', SampleFieldKind.Amount],\n    ['money', SampleFieldKind.Amount],\n    ['currency', SampleFieldKind.Amount],\n    ['bool', SampleFieldKind.Boolean],\n    ['boolean', SampleFieldKind.Boolean],\n    ['date', SampleFieldKind.Date],\n    ['dateonly', SampleFieldKind.Date],\n    ['datetime', SampleFieldKind.DateTime],\n    ['datetimeoffset', SampleFieldKind.DateTime],\n    ['timestamp', SampleFieldKind.DateTime],\n]);\n\nconst nameKinds: [string[], SampleFieldKind][] = [\n    [['email'], SampleFieldKind.Email],\n    [['phone', 'mobile'], SampleFieldKind.Phone],\n    [['company', 'organization', 'organisation'], SampleFieldKind.Company],\n    [['city', 'town'], SampleFieldKind.City],\n    [['product', 'item', 'title', 'subject', 'description'], SampleFieldKind.Text],\n    [['name', 'customer', 'assignee', 'owner', 'author', 'contact', 'manager', 'employee'], SampleFieldKind.Name],\n];\n\n/**\n * The kind of value to generate for a field. An explicit `kind` wins; otherwise a field with `enumValues` is\n * an enum, a recognised `type` decides, and failing that the field's name does (an `Id` suffix, `email`,\n * `phone`, `company`, `city`, person-like names), with free text as the fallback. A trailing `?` on the type\n * is ignored and type names compare case-insensitively.\n */\nexport function inferSampleFieldKind(field: SampleShapeField): SampleFieldKind {\n    if (field.kind !== undefined && field.kind !== null) return field.kind as SampleFieldKind;\n    if (field.enumValues !== undefined && field.enumValues !== null && field.enumValues.length > 0) return SampleFieldKind.Enum;\n\n    let type = (field.type ?? '').trim().toLowerCase();\n    if (type.endsWith('?')) type = type.slice(0, -1);\n    const byType = typeKinds.get(type);\n    if (byType !== undefined) return byType;\n\n    const name = field.name ?? '';\n    const lower = name.toLowerCase();\n    if (lower === 'id' || (name.length > 2 && name.endsWith('Id'))) return SampleFieldKind.Id;\n    for (const [fragments, kind] of nameKinds) {\n        if (fragments.some(fragment => lower.includes(fragment))) return kind;\n    }\n\n    return SampleFieldKind.Text;\n}\n"],"names":["typeKinds","Map","SampleFieldKind","Id","WholeNumber","Amount","Boolean","Date","DateTime","nameKinds","Email","Phone","Company","City","Text","Name","inferSampleFieldKind","field","kind","undefined","enumValues","length","Enum","type","trim","toLowerCase","endsWith","slice","byType","get","name","lower","fragments","some","fragment","includes"],"mappings":";;;;AAAA;AACA;AAIA,MAAMA,SAAAA,GAAY,IAAIC,GAAAA,CAA6B;AAC/C,IAAA;AAAC,QAAA,MAAA;AAAQC,QAAAA,2BAAAA,CAAgBC;AAAG,KAAA;AAC5B,IAAA;AAAC,QAAA,MAAA;AAAQD,QAAAA,2BAAAA,CAAgBC;AAAG,KAAA;AAC5B,IAAA;AAAC,QAAA,KAAA;AAAOD,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACpC,IAAA;AAAC,QAAA,OAAA;AAASF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACtC,IAAA;AAAC,QAAA,OAAA;AAASF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACtC,IAAA;AAAC,QAAA,OAAA;AAASF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACtC,IAAA;AAAC,QAAA,OAAA;AAASF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACtC,IAAA;AAAC,QAAA,MAAA;AAAQF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACrC,IAAA;AAAC,QAAA,SAAA;AAAWF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACxC,IAAA;AAAC,QAAA,QAAA;AAAUF,QAAAA,2BAAAA,CAAgBE;AAAY,KAAA;AACvC,IAAA;AAAC,QAAA,SAAA;AAAWF,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AACnC,IAAA;AAAC,QAAA,QAAA;AAAUH,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AAClC,IAAA;AAAC,QAAA,OAAA;AAASH,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AACjC,IAAA;AAAC,QAAA,QAAA;AAAUH,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AAClC,IAAA;AAAC,QAAA,OAAA;AAASH,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AACjC,IAAA;AAAC,QAAA,UAAA;AAAYH,QAAAA,2BAAAA,CAAgBG;AAAO,KAAA;AACpC,IAAA;AAAC,QAAA,MAAA;AAAQH,QAAAA,2BAAAA,CAAgBI;AAAQ,KAAA;AACjC,IAAA;AAAC,QAAA,SAAA;AAAWJ,QAAAA,2BAAAA,CAAgBI;AAAQ,KAAA;AACpC,IAAA;AAAC,QAAA,MAAA;AAAQJ,QAAAA,2BAAAA,CAAgBK;AAAK,KAAA;AAC9B,IAAA;AAAC,QAAA,UAAA;AAAYL,QAAAA,2BAAAA,CAAgBK;AAAK,KAAA;AAClC,IAAA;AAAC,QAAA,UAAA;AAAYL,QAAAA,2BAAAA,CAAgBM;AAAS,KAAA;AACtC,IAAA;AAAC,QAAA,gBAAA;AAAkBN,QAAAA,2BAAAA,CAAgBM;AAAS,KAAA;AAC5C,IAAA;AAAC,QAAA,WAAA;AAAaN,QAAAA,2BAAAA,CAAgBM;AAAS;AAC1C,CAAA,CAAA;AAED,MAAMC,SAAAA,GAA2C;AAC7C,IAAA;AAAC,QAAA;AAAC,YAAA;AAAQ,SAAA;AAAEP,QAAAA,2BAAAA,CAAgBQ;AAAM,KAAA;AAClC,IAAA;AAAC,QAAA;AAAC,YAAA,OAAA;AAAS,YAAA;AAAS,SAAA;AAAER,QAAAA,2BAAAA,CAAgBS;AAAM,KAAA;AAC5C,IAAA;AAAC,QAAA;AAAC,YAAA,SAAA;AAAW,YAAA,cAAA;AAAgB,YAAA;AAAe,SAAA;AAAET,QAAAA,2BAAAA,CAAgBU;AAAQ,KAAA;AACtE,IAAA;AAAC,QAAA;AAAC,YAAA,MAAA;AAAQ,YAAA;AAAO,SAAA;AAAEV,QAAAA,2BAAAA,CAAgBW;AAAK,KAAA;AACxC,IAAA;AAAC,QAAA;AAAC,YAAA,SAAA;AAAW,YAAA,MAAA;AAAQ,YAAA,OAAA;AAAS,YAAA,SAAA;AAAW,YAAA;AAAc,SAAA;AAAEX,QAAAA,2BAAAA,CAAgBY;AAAK,KAAA;AAC9E,IAAA;AAAC,QAAA;AAAC,YAAA,MAAA;AAAQ,YAAA,UAAA;AAAY,YAAA,UAAA;AAAY,YAAA,OAAA;AAAS,YAAA,QAAA;AAAU,YAAA,SAAA;AAAW,YAAA,SAAA;AAAW,YAAA;AAAW,SAAA;AAAEZ,QAAAA,2BAAAA,CAAgBa;AAAK;AAChH,CAAA;AAED;;;;;IAMO,SAASC,oBAAAA,CAAqBC,KAAuB,EAAA;IACxD,IAAIA,KAAAA,CAAMC,IAAI,KAAKC,SAAAA,IAAaF,KAAAA,CAAMC,IAAI,KAAK,IAAA,EAAM,OAAOD,KAAAA,CAAMC,IAAI;AACtE,IAAA,IAAID,MAAMG,UAAU,KAAKD,SAAAA,IAAaF,KAAAA,CAAMG,UAAU,KAAK,IAAA,IAAQH,KAAAA,CAAMG,UAAU,CAACC,MAAM,GAAG,CAAA,EAAG,OAAOnB,4BAAgBoB,IAAI;IAE3H,IAAIC,IAAAA,GAAO,CAACN,KAAAA,CAAMM,IAAI,IAAI,EAAC,EAAGC,IAAI,EAAA,CAAGC,WAAW,EAAA;IAChD,IAAIF,IAAAA,CAAKG,QAAQ,CAAC,GAAA,CAAA,EAAMH,OAAOA,IAAAA,CAAKI,KAAK,CAAC,CAAA,EAAG,EAAC,CAAA;IAC9C,MAAMC,MAAAA,GAAS5B,SAAAA,CAAU6B,GAAG,CAACN,IAAAA,CAAAA;IAC7B,IAAIK,MAAAA,KAAWT,WAAW,OAAOS,MAAAA;IAEjC,MAAME,IAAAA,GAAOb,KAAAA,CAAMa,IAAI,IAAI,EAAA;IAC3B,MAAMC,KAAAA,GAAQD,KAAKL,WAAW,EAAA;AAC9B,IAAA,IAAIM,KAAAA,KAAU,IAAA,IAASD,IAAAA,CAAKT,MAAM,GAAG,CAAA,IAAKS,IAAAA,CAAKJ,QAAQ,CAAC,IAAA,CAAA,EAAQ,OAAOxB,2BAAAA,CAAgBC,EAAE;AACzF,IAAA,KAAK,MAAM,CAAC6B,SAAAA,EAAWd,IAAAA,CAAK,IAAIT,SAAAA,CAAW;QACvC,IAAIuB,SAAAA,CAAUC,IAAI,CAACC,CAAAA,WAAYH,KAAAA,CAAMI,QAAQ,CAACD,QAAAA,CAAAA,CAAAA,EAAY,OAAOhB,IAAAA;AACrE,IAAA;AAEA,IAAA,OAAOhB,4BAAgBY,IAAI;AAC/B;;"}

package/dist/cjs/sampleData/resolveSampleData.js

@@ -0,0 +1,107 @@
+'use strict';
+
+var generateSample = require('./generateSample.js');
+var sampleLocales = require('./sampleLocales.js');
+var findSampleDataSet = require('./findSampleDataSet.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Resolves the rows to show for a read model or shape at design or preview time, by the order of spec §11.2:
+ *
+ * 1. the pack bound to the target (`profile.sampleData.bindings`, a rare override);
+ * 2. the application's active pack: the UI profile's `sampleData.activePack`, chosen once for the whole
+ *    application, or the session-only override (`context.sessionActivePack`) the preview strip sets;
+ * 3. the default pack of the blueprint the template came from (`blueprintDefaultPack`);
+ * 4. generated data typed by field kind ({@link generateSample}), when the request carries a shape.
+ *
+ * A pack supplies rows when it has a set for the target, by an explicit `shape → read model` mapping or else by
+ * name ({@link findSampleDataSet}). A rung that cannot supply rows falls through to the next; an unknown pack
+ * id, or a bound pack without the target's shape, is reported in `diagnostics` (an active or blueprint pack
+ * that merely lacks the shape is normal and not reported). The locale carried is the supplying pack's; for
+ * generated data it is the first existing bound, active or blueprint pack's, else `context.locale`.
+ *
+ * Outside design and preview (`context.isDesignOrPreview` not true) nothing resolves (spec SD6).
+ */ function resolveSampleData(request, context) {
+    const target = request.target ?? request.shape?.name ?? '';
+    const fallbackLocale = context.locale ?? sampleLocales.defaultSampleLocale;
+    const diagnostics = [];
+    if (context.isDesignOrPreview !== true) {
+        return {
+            source: 'disabled',
+            locale: fallbackLocale,
+            rows: [],
+            diagnostics
+        };
+    }
+    const packs = context.packs ?? [];
+    const selection = context.profile?.sampleData;
+    const mappings = selection?.mappings ?? [];
+    const find = (id)=>id === undefined || id === null ? undefined : packs.find((pack)=>pack.id === id);
+    const missing = (id, role)=>{
+        diagnostics.push({
+            code: 'packNotFound',
+            message: `The ${role} sample data pack '${id}' is not available`
+        });
+    };
+    const bindingPackId = (selection?.bindings ?? []).find((binding)=>binding.target === target)?.pack;
+    const bindingPack = find(bindingPackId);
+    if (bindingPackId !== undefined && bindingPack === undefined) {
+        missing(bindingPackId, `bound`);
+    } else if (bindingPack !== undefined) {
+        const set = findSampleDataSet.findSampleDataSet(bindingPack, target, mappings);
+        if (set !== undefined) return fromSet('binding', bindingPack, set.shape, set.rows, diagnostics);
+        diagnostics.push({
+            code: 'shapeNotInPack',
+            message: `The bound sample data pack '${bindingPack.id}' has no rows for '${target}'`
+        });
+    }
+    const sessionPackId = context.sessionActivePack;
+    const chosenPackId = sessionPackId !== undefined ? sessionPackId : selection?.activePack;
+    const activePackId = chosenPackId === '' ? undefined : chosenPackId;
+    const activePack = find(activePackId);
+    if (activePackId !== undefined && activePackId !== null && activePack === undefined) {
+        missing(activePackId, 'active');
+    } else if (activePack !== undefined) {
+        const set = findSampleDataSet.findSampleDataSet(activePack, target, mappings);
+        if (set !== undefined) return fromSet('activePack', activePack, set.shape, set.rows, diagnostics);
+    }
+    const blueprintPackId = context.blueprintDefaultPack;
+    const blueprintPack = find(blueprintPackId);
+    if (blueprintPackId !== undefined && blueprintPackId !== null && blueprintPack === undefined) {
+        missing(blueprintPackId, 'blueprint default');
+    } else if (blueprintPack !== undefined) {
+        const set = findSampleDataSet.findSampleDataSet(blueprintPack, target, mappings);
+        if (set !== undefined) return fromSet('blueprintDefault', blueprintPack, set.shape, set.rows, diagnostics);
+    }
+    const locale = bindingPack?.locale ?? activePack?.locale ?? blueprintPack?.locale ?? fallbackLocale;
+    if (request.shape === undefined) {
+        return {
+            source: 'none',
+            locale,
+            shape: target,
+            rows: [],
+            diagnostics
+        };
+    }
+    return {
+        source: 'generated',
+        locale,
+        shape: request.shape.name,
+        rows: generateSample.generateSample(request.shape, context.seed, context.rowCount, locale),
+        diagnostics
+    };
+}
+function fromSet(source, pack, shape, rows, diagnostics) {
+    return {
+        source,
+        pack: pack.id,
+        locale: pack.locale,
+        shape,
+        rows: structuredClone(rows),
+        diagnostics
+    };
+}
+
+exports.resolveSampleData = resolveSampleData;
+//# sourceMappingURL=resolveSampleData.js.map