@cratis/scene.engine 4.25.0 → 4.26.0

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"resolveSampleData.js","sources":["../../../sampleData/resolveSampleData.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 { SampleDataPack } from '@cratis/scene.model';\nimport { generateSample } from './generateSample';\nimport { defaultSampleLocale } from './sampleLocales';\nimport { findSampleDataSet } from './findSampleDataSet';\nimport { SampleDataContext, SampleDataDiagnostic, SampleDataRequest, SampleDataResolution } from './SampleDataResolution';\n\n/**\n * Resolves the rows to show for a read model or shape at design or preview time, by the order of spec §11.2:\n *\n * 1. the pack bound to the target (`profile.sampleData.bindings`, a rare override);\n * 2. the application's active pack: the UI profile's `sampleData.activePack`, chosen once for the whole\n *    application, or the session-only override (`context.sessionActivePack`) the preview strip sets;\n * 3. the default pack of the blueprint the template came from (`blueprintDefaultPack`);\n * 4. generated data typed by field kind ({@link generateSample}), when the request carries a shape.\n *\n * A pack supplies rows when it has a set for the target, by an explicit `shape → read model` mapping or else by\n * name ({@link findSampleDataSet}). A rung that cannot supply rows falls through to the next; an unknown pack\n * id, or a bound pack without the target's shape, is reported in `diagnostics` (an active or blueprint pack\n * that merely lacks the shape is normal and not reported). The locale carried is the supplying pack's; for\n * generated data it is the first existing bound, active or blueprint pack's, else `context.locale`.\n *\n * Outside design and preview (`context.isDesignOrPreview` not true) nothing resolves (spec SD6).\n */\nexport function resolveSampleData(request: SampleDataRequest, context: SampleDataContext): SampleDataResolution {\n    const target = request.target ?? request.shape?.name ?? '';\n    const fallbackLocale = context.locale ?? defaultSampleLocale;\n    const diagnostics: SampleDataDiagnostic[] = [];\n\n    if (context.isDesignOrPreview !== true) {\n        return { source: 'disabled', locale: fallbackLocale, rows: [], diagnostics };\n    }\n\n    const packs = context.packs ?? [];\n    const selection = context.profile?.sampleData;\n    const mappings = selection?.mappings ?? [];\n    const find = (id: string | null | undefined): SampleDataPack | undefined => (id === undefined || id === null ? undefined : packs.find(pack => pack.id === id));\n    const missing = (id: string, role: string): void => {\n        diagnostics.push({ code: 'packNotFound', message: `The ${role} sample data pack '${id}' is not available` });\n    };\n\n    const bindingPackId = (selection?.bindings ?? []).find(binding => binding.target === target)?.pack;\n    const bindingPack = find(bindingPackId);\n    if (bindingPackId !== undefined && bindingPack === undefined) {\n        missing(bindingPackId, `bound`);\n    } else if (bindingPack !== undefined) {\n        const set = findSampleDataSet(bindingPack, target, mappings);\n        if (set !== undefined) return fromSet('binding', bindingPack, set.shape, set.rows, diagnostics);\n        diagnostics.push({ code: 'shapeNotInPack', message: `The bound sample data pack '${bindingPack.id}' has no rows for '${target}'` });\n    }\n\n    const sessionPackId = context.sessionActivePack;\n    const chosenPackId = sessionPackId !== undefined ? sessionPackId : selection?.activePack;\n    const activePackId = chosenPackId === '' ? undefined : chosenPackId;\n    const activePack = find(activePackId);\n    if (activePackId !== undefined && activePackId !== null && activePack === undefined) {\n        missing(activePackId, 'active');\n    } else if (activePack !== undefined) {\n        const set = findSampleDataSet(activePack, target, mappings);\n        if (set !== undefined) return fromSet('activePack', activePack, set.shape, set.rows, diagnostics);\n    }\n\n    const blueprintPackId = context.blueprintDefaultPack;\n    const blueprintPack = find(blueprintPackId);\n    if (blueprintPackId !== undefined && blueprintPackId !== null && blueprintPack === undefined) {\n        missing(blueprintPackId, 'blueprint default');\n    } else if (blueprintPack !== undefined) {\n        const set = findSampleDataSet(blueprintPack, target, mappings);\n        if (set !== undefined) return fromSet('blueprintDefault', blueprintPack, set.shape, set.rows, diagnostics);\n    }\n\n    const locale = bindingPack?.locale ?? activePack?.locale ?? blueprintPack?.locale ?? fallbackLocale;\n    if (request.shape === undefined) {\n        return { source: 'none', locale, shape: target, rows: [], diagnostics };\n    }\n\n    return {\n        source: 'generated',\n        locale,\n        shape: request.shape.name,\n        rows: generateSample(request.shape, context.seed, context.rowCount, locale),\n        diagnostics,\n    };\n}\n\nfunction fromSet(\n    source: 'binding' | 'activePack' | 'blueprintDefault',\n    pack: SampleDataPack,\n    shape: string,\n    rows: Record<string, unknown>[],\n    diagnostics: SampleDataDiagnostic[],\n): SampleDataResolution {\n    return { source, pack: pack.id, locale: pack.locale, shape, rows: structuredClone(rows), diagnostics };\n}\n"],"names":["resolveSampleData","request","context","target","shape","name","fallbackLocale","locale","defaultSampleLocale","diagnostics","isDesignOrPreview","source","rows","packs","selection","profile","sampleData","mappings","find","id","undefined","pack","missing","role","push","code","message","bindingPackId","bindings","binding","bindingPack","set","findSampleDataSet","fromSet","sessionPackId","sessionActivePack","chosenPackId","activePack","activePackId","blueprintPackId","blueprintDefaultPack","blueprintPack","generateSample","seed","rowCount","structuredClone"],"mappings":";;;;;;AAAA;AACA;AAQA;;;;;;;;;;;;;;;;AAgBC,IACM,SAASA,iBAAAA,CAAkBC,OAA0B,EAAEC,OAA0B,EAAA;AACpF,IAAA,MAAMC,SAASF,OAAAA,CAAQE,MAAM,IAAIF,OAAAA,CAAQG,KAAK,EAAEC,IAAAA,IAAQ,EAAA;IACxD,MAAMC,cAAAA,GAAiBJ,OAAAA,CAAQK,MAAM,IAAIC,iCAAAA;AACzC,IAAA,MAAMC,cAAsC,EAAE;IAE9C,IAAIP,OAAAA,CAAQQ,iBAAiB,KAAK,IAAA,EAAM;QACpC,OAAO;YAAEC,MAAAA,EAAQ,UAAA;YAAYJ,MAAAA,EAAQD,cAAAA;AAAgBM,YAAAA,IAAAA,EAAM,EAAE;AAAEH,YAAAA;AAAY,SAAA;AAC/E,IAAA;AAEA,IAAA,MAAMI,KAAAA,GAAQX,OAAAA,CAAQW,KAAK,IAAI,EAAE;IACjC,MAAMC,SAAAA,GAAYZ,OAAAA,CAAQa,OAAO,EAAEC,UAAAA;IACnC,MAAMC,QAAAA,GAAWH,SAAAA,EAAWG,QAAAA,IAAY,EAAE;AAC1C,IAAA,MAAMC,IAAAA,GAAO,CAACC,EAAAA,GAA+DA,EAAAA,KAAOC,aAAaD,EAAAA,KAAO,IAAA,GAAOC,SAAAA,GAAYP,KAAAA,CAAMK,IAAI,CAACG,CAAAA,IAAAA,GAAQA,IAAAA,CAAKF,EAAE,KAAKA,EAAAA,CAAAA;IAC1J,MAAMG,OAAAA,GAAU,CAACH,EAAAA,EAAYI,IAAAA,GAAAA;AACzBd,QAAAA,WAAAA,CAAYe,IAAI,CAAC;YAAEC,IAAAA,EAAM,cAAA;YAAgBC,OAAAA,EAAS,CAAC,IAAI,EAAEH,IAAAA,CAAK,mBAAmB,EAAEJ,EAAAA,CAAG,kBAAkB;AAAE,SAAA,CAAA;AAC9G,IAAA,CAAA;AAEA,IAAA,MAAMQ,aAAAA,GAAiBb,CAAAA,SAAAA,EAAWc,YAAY,EAAC,EAAGV,IAAI,CAACW,CAAAA,OAAAA,GAAWA,OAAAA,CAAQ1B,MAAM,KAAKA,MAAAA,CAAAA,EAASkB,IAAAA;AAC9F,IAAA,MAAMS,cAAcZ,IAAAA,CAAKS,aAAAA,CAAAA;IACzB,IAAIA,aAAAA,KAAkBP,SAAAA,IAAaU,WAAAA,KAAgBV,SAAAA,EAAW;QAC1DE,OAAAA,CAAQK,aAAAA,EAAe,CAAC,KAAK,CAAC,CAAA;IAClC,CAAA,MAAO,IAAIG,gBAAgBV,SAAAA,EAAW;QAClC,MAAMW,GAAAA,GAAMC,mCAAAA,CAAkBF,WAAAA,EAAa3B,MAAAA,EAAQc,QAAAA,CAAAA;QACnD,IAAIc,GAAAA,KAAQX,SAAAA,EAAW,OAAOa,OAAAA,CAAQ,SAAA,EAAWH,WAAAA,EAAaC,GAAAA,CAAI3B,KAAK,EAAE2B,GAAAA,CAAInB,IAAI,EAAEH,WAAAA,CAAAA;AACnFA,QAAAA,WAAAA,CAAYe,IAAI,CAAC;YAAEC,IAAAA,EAAM,gBAAA;YAAkBC,OAAAA,EAAS,CAAC,4BAA4B,EAAEI,WAAAA,CAAYX,EAAE,CAAC,mBAAmB,EAAEhB,MAAAA,CAAO,CAAC;AAAE,SAAA,CAAA;AACrI,IAAA;IAEA,MAAM+B,aAAAA,GAAgBhC,QAAQiC,iBAAiB;AAC/C,IAAA,MAAMC,YAAAA,GAAeF,aAAAA,KAAkBd,SAAAA,GAAYc,aAAAA,GAAgBpB,SAAAA,EAAWuB,UAAAA;IAC9E,MAAMC,YAAAA,GAAeF,YAAAA,KAAiB,EAAA,GAAKhB,SAAAA,GAAYgB,YAAAA;AACvD,IAAA,MAAMC,aAAanB,IAAAA,CAAKoB,YAAAA,CAAAA;AACxB,IAAA,IAAIA,YAAAA,KAAiBlB,SAAAA,IAAakB,YAAAA,KAAiB,IAAA,IAAQD,eAAejB,SAAAA,EAAW;AACjFE,QAAAA,OAAAA,CAAQgB,YAAAA,EAAc,QAAA,CAAA;IAC1B,CAAA,MAAO,IAAID,eAAejB,SAAAA,EAAW;QACjC,MAAMW,GAAAA,GAAMC,mCAAAA,CAAkBK,UAAAA,EAAYlC,MAAAA,EAAQc,QAAAA,CAAAA;QAClD,IAAIc,GAAAA,KAAQX,SAAAA,EAAW,OAAOa,OAAAA,CAAQ,YAAA,EAAcI,UAAAA,EAAYN,GAAAA,CAAI3B,KAAK,EAAE2B,GAAAA,CAAInB,IAAI,EAAEH,WAAAA,CAAAA;AACzF,IAAA;IAEA,MAAM8B,eAAAA,GAAkBrC,QAAQsC,oBAAoB;AACpD,IAAA,MAAMC,gBAAgBvB,IAAAA,CAAKqB,eAAAA,CAAAA;AAC3B,IAAA,IAAIA,eAAAA,KAAoBnB,SAAAA,IAAamB,eAAAA,KAAoB,IAAA,IAAQE,kBAAkBrB,SAAAA,EAAW;AAC1FE,QAAAA,OAAAA,CAAQiB,eAAAA,EAAiB,mBAAA,CAAA;IAC7B,CAAA,MAAO,IAAIE,kBAAkBrB,SAAAA,EAAW;QACpC,MAAMW,GAAAA,GAAMC,mCAAAA,CAAkBS,aAAAA,EAAetC,MAAAA,EAAQc,QAAAA,CAAAA;QACrD,IAAIc,GAAAA,KAAQX,SAAAA,EAAW,OAAOa,OAAAA,CAAQ,kBAAA,EAAoBQ,aAAAA,EAAeV,GAAAA,CAAI3B,KAAK,EAAE2B,GAAAA,CAAInB,IAAI,EAAEH,WAAAA,CAAAA;AAClG,IAAA;AAEA,IAAA,MAAMF,SAASuB,WAAAA,EAAavB,MAAAA,IAAU8B,UAAAA,EAAY9B,MAAAA,IAAUkC,eAAelC,MAAAA,IAAUD,cAAAA;IACrF,IAAIL,OAAAA,CAAQG,KAAK,KAAKgB,SAAAA,EAAW;QAC7B,OAAO;YAAET,MAAAA,EAAQ,MAAA;AAAQJ,YAAAA,MAAAA;YAAQH,KAAAA,EAAOD,MAAAA;AAAQS,YAAAA,IAAAA,EAAM,EAAE;AAAEH,YAAAA;AAAY,SAAA;AAC1E,IAAA;IAEA,OAAO;QACHE,MAAAA,EAAQ,WAAA;AACRJ,QAAAA,MAAAA;QACAH,KAAAA,EAAOH,OAAAA,CAAQG,KAAK,CAACC,IAAI;QACzBO,IAAAA,EAAM8B,6BAAAA,CAAezC,QAAQG,KAAK,EAAEF,QAAQyC,IAAI,EAAEzC,OAAAA,CAAQ0C,QAAQ,EAAErC,MAAAA,CAAAA;AACpEE,QAAAA;AACJ,KAAA;AACJ;AAEA,SAASwB,OAAAA,CACLtB,MAAqD,EACrDU,IAAoB,EACpBjB,KAAa,EACbQ,IAA+B,EAC/BH,WAAmC,EAAA;IAEnC,OAAO;AAAEE,QAAAA,MAAAA;AAAQU,QAAAA,IAAAA,EAAMA,KAAKF,EAAE;AAAEZ,QAAAA,MAAAA,EAAQc,KAAKd,MAAM;AAAEH,QAAAA,KAAAA;AAAOQ,QAAAA,IAAAA,EAAMiC,eAAAA,CAAgBjC,IAAAA,CAAAA;AAAOH,QAAAA;AAAY,KAAA;AACzG;;"}

package/dist/cjs/sampleData/sampleDataRules.js

@@ -0,0 +1,26 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** A pack id: lower-case letters and digits in groups separated by `.`, `_` or `-` (`crm-nordic-smb`). */ const sampleDataIdPattern = /^[a-z0-9]+([._-][a-z0-9]+)*$/;
+/** A BCP 47 style locale tag: a 2-3 letter language followed by alphanumeric subtags (`nb-NO`, `en-GB`, `zh-Hant-TW`). */ const sampleDataLocalePattern = /^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$/;
+/** The owner of a pack the author created. */ const userSampleDataOwner = 'user';
+/** The prefix of the owner of a pack a blueprint ships (`blueprint:crm`). */ const blueprintSampleDataOwnerPrefix = 'blueprint:';
+/** Whether an owner is `user` or `blueprint:<id>` with a non-empty id. */ function isValidSampleDataOwner(owner) {
+    if (owner === undefined || owner === null) return false;
+    return owner === userSampleDataOwner || owner.startsWith(blueprintSampleDataOwnerPrefix) && owner.length > blueprintSampleDataOwnerPrefix.length && owner.trim() === owner;
+}
+/** The path separator, built from its code so the seam rule against route literals (I4) does not mistake it for a URL. */ const pathSeparator = String.fromCharCode(47);
+/** Whether a package-relative pack path is `sampleData/<name>.json` with no `..`, `\\` or nested leading `/`. */ function isValidSampleDataPath(path) {
+    if (path === undefined || path === null) return false;
+    if (!path.startsWith('sampleData/') || !path.endsWith('.json') || path.length <= 'sampleData/.json'.length) return false;
+    return !path.includes('..') && !path.includes('\\') && !path.split(pathSeparator).includes('');
+}
+
+exports.blueprintSampleDataOwnerPrefix = blueprintSampleDataOwnerPrefix;
+exports.isValidSampleDataOwner = isValidSampleDataOwner;
+exports.isValidSampleDataPath = isValidSampleDataPath;
+exports.sampleDataIdPattern = sampleDataIdPattern;
+exports.sampleDataLocalePattern = sampleDataLocalePattern;
+exports.userSampleDataOwner = userSampleDataOwner;
+//# sourceMappingURL=sampleDataRules.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sampleDataRules.js","sources":["../../../sampleData/sampleDataRules.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\n/** A pack id: lower-case letters and digits in groups separated by `.`, `_` or `-` (`crm-nordic-smb`). */\nexport const sampleDataIdPattern = /^[a-z0-9]+([._-][a-z0-9]+)*$/;\n\n/** A BCP 47 style locale tag: a 2-3 letter language followed by alphanumeric subtags (`nb-NO`, `en-GB`, `zh-Hant-TW`). */\nexport const sampleDataLocalePattern = /^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$/;\n\n/** The owner of a pack the author created. */\nexport const userSampleDataOwner = 'user';\n\n/** The prefix of the owner of a pack a blueprint ships (`blueprint:crm`). */\nexport const blueprintSampleDataOwnerPrefix = 'blueprint:';\n\n/** Whether an owner is `user` or `blueprint:<id>` with a non-empty id. */\nexport function isValidSampleDataOwner(owner: string | undefined): boolean {\n    if (owner === undefined || owner === null) return false;\n    return owner === userSampleDataOwner || (owner.startsWith(blueprintSampleDataOwnerPrefix) && owner.length > blueprintSampleDataOwnerPrefix.length && owner.trim() === owner);\n}\n\n/** The path separator, built from its code so the seam rule against route literals (I4) does not mistake it for a URL. */\nconst pathSeparator = String.fromCharCode(47);\n\n/** Whether a package-relative pack path is `sampleData/<name>.json` with no `..`, `\\\\` or nested leading `/`. */\nexport function isValidSampleDataPath(path: string | undefined): boolean {\n    if (path === undefined || path === null) return false;\n    if (!path.startsWith('sampleData/') || !path.endsWith('.json') || path.length <= 'sampleData/.json'.length) return false;\n    return !path.includes('..') && !path.includes('\\\\') && !path.split(pathSeparator).includes('');\n}\n"],"names":["sampleDataIdPattern","sampleDataLocalePattern","userSampleDataOwner","blueprintSampleDataOwnerPrefix","isValidSampleDataOwner","owner","undefined","startsWith","length","trim","pathSeparator","String","fromCharCode","isValidSampleDataPath","path","endsWith","includes","split"],"mappings":";;AAAA;AACA;AAEA,2GACO,MAAMA,mBAAAA,GAAsB;AAEnC,2HACO,MAAMC,uBAAAA,GAA0B;AAEvC,+CACO,MAAMC,mBAAAA,GAAsB;AAEnC,8EACO,MAAMC,8BAAAA,GAAiC;AAE9C,2EACO,SAASC,sBAAAA,CAAuBC,KAAyB,EAAA;AAC5D,IAAA,IAAIA,KAAAA,KAAUC,SAAAA,IAAaD,KAAAA,KAAU,IAAA,EAAM,OAAO,KAAA;AAClD,IAAA,OAAOA,KAAAA,KAAUH,mBAAAA,IAAwBG,KAAAA,CAAME,UAAU,CAACJ,8BAAAA,CAAAA,IAAmCE,KAAAA,CAAMG,MAAM,GAAGL,8BAAAA,CAA+BK,MAAM,IAAIH,KAAAA,CAAMI,IAAI,EAAA,KAAOJ,KAAAA;AAC1K;AAEA,2HACA,MAAMK,aAAAA,GAAgBC,MAAAA,CAAOC,YAAY,CAAC,EAAA,CAAA;AAE1C,kHACO,SAASC,qBAAAA,CAAsBC,IAAwB,EAAA;AAC1D,IAAA,IAAIA,IAAAA,KAASR,SAAAA,IAAaQ,IAAAA,KAAS,IAAA,EAAM,OAAO,KAAA;AAChD,IAAA,IAAI,CAACA,IAAAA,CAAKP,UAAU,CAAC,aAAA,CAAA,IAAkB,CAACO,IAAAA,CAAKC,QAAQ,CAAC,OAAA,CAAA,IAAYD,KAAKN,MAAM,IAAI,kBAAA,CAAmBA,MAAM,EAAE,OAAO,KAAA;AACnH,IAAA,OAAO,CAACM,IAAAA,CAAKE,QAAQ,CAAC,IAAA,CAAA,IAAS,CAACF,IAAAA,CAAKE,QAAQ,CAAC,IAAA,CAAA,IAAS,CAACF,IAAAA,CAAKG,KAAK,CAACP,aAAAA,CAAAA,CAAeM,QAAQ,CAAC,EAAA,CAAA;AAC/F;;;;;;;"}