@hexpro/qr-code-studio 0.0.0-stage → 0.1.0

package/dist/studio/form.js

@@ -0,0 +1,91 @@
+/**
+ * The form a view draws for a content type: its schema with the values, the
+ * issues sorted onto the fields they belong to, and the fields gathered into
+ * the groups and the disclosure the schema asks for.
+ *
+ * A view renders this and nothing else, so a content type added to the
+ * registry gets a working form in both interfaces without a line of view
+ * code. Field order is the schema's; a group is a run of consecutive fields
+ * sharing a `group`, which is how every built-in type lays its groups out.
+ */
+import { emptyValue } from './document.js';
+import { groupKey } from './keys.js';
+function belongsTo(found, key) {
+    return found.path[0] === 'fields' && found.path[1] === key;
+}
+function safetyOf(type, value) {
+    if (type.safety === undefined)
+        return [];
+    try {
+        return type.safety(value);
+    }
+    catch {
+        // A safety analyser is advice. One that cannot cope with a value has
+        // nothing to say about it, and the form still has to draw.
+        return [];
+    }
+}
+export function formView(type, fields, issues) {
+    const views = type.fields.map((field) => {
+        const value = Object.prototype.hasOwnProperty.call(fields, field.key)
+            ? fields[field.key]
+            : emptyValue(field);
+        return Object.freeze({
+            key: field.key,
+            kind: field.kind,
+            labelKey: field.labelKey,
+            hintKey: field.hintKey ?? null,
+            required: field.required === true,
+            multiple: field.multiple === true,
+            maxItems: field.maxItems ?? null,
+            maxLength: field.maxLength ?? null,
+            min: field.min ?? null,
+            max: field.max ?? null,
+            options: field.options ?? [],
+            group: field.group ?? null,
+            advanced: field.advanced === true,
+            secret: field.kind === 'secret',
+            value,
+            issues: Object.freeze(issues.filter((found) => belongsTo(found, field.key))),
+        });
+    });
+    const groups = [];
+    let open = null;
+    const close = () => {
+        if (open === null)
+            return;
+        groups.push(Object.freeze({
+            id: open.id,
+            labelKey: open.id === null ? null : groupKey(open.id),
+            advanced: open.fields.every((field) => field.advanced),
+            fields: Object.freeze(open.fields.map((field) => field.key)),
+        }));
+        open = null;
+    };
+    for (const view of views) {
+        // Ungrouped fields gather too, so a group's heading never splits a run of plain fields in two.
+        if (open === null || open.id !== view.group) {
+            close();
+            open = { id: view.group, fields: [] };
+        }
+        open.fields.push(view);
+    }
+    close();
+    const keys = new Set(type.fields.map((field) => field.key));
+    const errors = issues.some((found) => found.severity === 'error');
+    return Object.freeze({
+        typeId: type.id,
+        labelKey: type.labelKey,
+        descriptionKey: type.descriptionKey,
+        actionKey: type.actionKey,
+        category: type.category,
+        fields: Object.freeze(views),
+        groups: Object.freeze(groups),
+        hasAdvanced: views.some((view) => view.advanced),
+        issues: Object.freeze(issues.filter((found) => !(found.path[0] === 'fields' && keys.has(found.path[1])))),
+        compatibility: type.compatibility ?? [],
+        safety: errors ? [] : safetyOf(type, fields),
+        designLocked: type.constraints?.designLocked === true,
+    });
+}
+//# sourceMappingURL=form.js.map

package/dist/studio/form.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.js","sourceRoot":"","sources":["../../src/studio/form.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC,SAAS,SAAS,CAAC,KAAY,EAAE,GAAW;IAC3C,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AAC5D,CAAC;AAED,SAAS,QAAQ,CAChB,IAAiB,EACjB,KAA2C;IAE3C,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACzC,IAAI,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACR,qEAAqE;QACrE,2DAA2D;QAC3D,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC;AAED,MAAM,UAAU,QAAQ,CACvB,IAAiB,EACjB,MAA4C,EAC5C,MAAwB;IAExB,MAAM,KAAK,GAAgB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACpD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;YACpE,CAAC,CAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAgB;YACnC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,MAAM,CAAC,MAAM,CAAC;YACpB,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,IAAI;YACjC,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,IAAI;YACjC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;YAChC,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI;YAClC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,IAAI;YACtB,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,IAAI;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;YAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI;YAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,IAAI;YACjC,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC/B,KAAK;YACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;SAC5E,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,IAAI,IAAI,GAAsD,IAAI,CAAC;IACnE,MAAM,KAAK,GAAG,GAAS,EAAE;QACxB,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO;QAC1B,MAAM,CAAC,IAAI,CACV,MAAM,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACrD,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAC5D,CAAC,CACF,CAAC;QACF,IAAI,GAAG,IAAI,CAAC;IACb,CAAC,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,+FAA+F;QAC/F,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7C,KAAK,EAAE,CAAC;YACR,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,KAAK,EAAE,CAAC;IAER,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IAClE,OAAO,MAAM,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,cAAc,EAAE,IAAI,CAAC,cAAc;QACnC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;QAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;QAC7B,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChD,MAAM,EAAE,MAAM,CAAC,MAAM,CACpB,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC,CAC5F;QACD,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;QACvC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAC5C,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,YAAY,KAAK,IAAI;KACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/studio/history.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Undo and redo, as a pure value.
+ *
+ * What is undone is the part of the document that is the person's work: the
+ * content type, its fields and the design. The mode and the scan conditions
+ * are settings about how they are looking at it, so changing them is never a
+ * step, and undoing a step leaves them as they are.
+ *
+ * Three things make a run of changes one step rather than many:
+ *
+ * - typing into one field: consecutive edits of the same field coalesce, so
+ *   undo takes back the word, not the last letter;
+ * - a coalesce key on a design patch: consecutive patches with the same key
+ *   (a colour picker being dragged) are one step;
+ * - an explicit group, `begin` to `commit`, for a slider: every patch in
+ *   between is one step, and `cancel` puts the design back as it was at
+ *   `begin`, with nothing recorded.
+ */
+import type { FieldValue } from '../payload/types.js';
+import type { QrDesignV1 } from '../design/types.js';
+/** The undoable part of a document. */
+export interface Work {
+    readonly typeId: string;
+    readonly fields: Readonly<Record<string, FieldValue>>;
+    readonly design: QrDesignV1;
+}
+export interface History {
+    readonly past: readonly Work[];
+    readonly future: readonly Work[];
+    /** The open group's key and the work as it was when it opened. */
+    readonly group: {
+        readonly key: string;
+        readonly base: Work;
+    } | null;
+    /** The coalesce key of the step at the top of `past`, while it may still grow. */
+    readonly coalescing: string | null;
+}
+export declare const EMPTY_HISTORY: History;
+/**
+ * The history after a change from `before`. `coalesce` names a run of
+ * changes that make one step together; consecutive changes with the same name
+ * record only the first `before`.
+ */
+export declare function recordChange(history: History, before: Work, coalesce: string | null, limit: number): History;
+/** Ends any run of coalescing changes, so the next change is a step of its own. */
+export declare function breakRun(history: History): History;
+/** Opens a group. A group already open under another key is committed first. */
+export declare function beginGroup(history: History, key: string, current: Work, limit: number): History;
+/** Closes the group as one step, if anything in it changed the work. A key that is not the open group's is ignored. */
+export declare function commitGroup(history: History, key: string, current: Work, limit: number): History;
+/** Closes the group and says what to restore, or null when no group is open. */
+export declare function cancelGroup(history: History): {
+    history: History;
+    restore: Work;
+} | null;
+export declare function undo(history: History, current: Work): {
+    history: History;
+    restore: Work;
+} | null;
+export declare function redo(history: History, current: Work, limit: number): {
+    history: History;
+    restore: Work;
+} | null;
+/** Identity is enough: every change makes new objects and an unchanged part keeps its own. */
+export declare function sameWork(a: Work, b: Work): boolean;
+//# sourceMappingURL=history.d.ts.map

package/dist/studio/history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../../src/studio/history.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,uCAAuC;AACvC,MAAM,WAAW,IAAI;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACtD,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;CAC5B;AAED,MAAM,WAAW,OAAO;IACvB,QAAQ,CAAC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC;IACjC,kEAAkE;IAClE,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IACrE,kFAAkF;IAClF,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,eAAO,MAAM,aAAa,EAAE,OAK1B,CAAC;AAMH;;;;GAIG;AACH,wBAAgB,YAAY,CAC3B,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,IAAI,EACZ,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,EAAE,MAAM,GACX,OAAO,CAWT;AAED,mFAAmF;AACnF,wBAAgB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAElD;AAED,gFAAgF;AAChF,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAK/F;AAED,uHAAuH;AACvH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAUhG;AAED,gFAAgF;AAChF,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAGxF;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAYhG;AAED,wBAAgB,IAAI,CACnB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,IAAI,EACb,KAAK,EAAE,MAAM,GACX;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG,IAAI,CAY5C;AAED,8FAA8F;AAC9F,wBAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,OAAO,CAElD"}

package/dist/studio/history.js

@@ -0,0 +1,109 @@
+/**
+ * Undo and redo, as a pure value.
+ *
+ * What is undone is the part of the document that is the person's work: the
+ * content type, its fields and the design. The mode and the scan conditions
+ * are settings about how they are looking at it, so changing them is never a
+ * step, and undoing a step leaves them as they are.
+ *
+ * Three things make a run of changes one step rather than many:
+ *
+ * - typing into one field: consecutive edits of the same field coalesce, so
+ *   undo takes back the word, not the last letter;
+ * - a coalesce key on a design patch: consecutive patches with the same key
+ *   (a colour picker being dragged) are one step;
+ * - an explicit group, `begin` to `commit`, for a slider: every patch in
+ *   between is one step, and `cancel` puts the design back as it was at
+ *   `begin`, with nothing recorded.
+ */
+export const EMPTY_HISTORY = Object.freeze({
+    past: Object.freeze([]),
+    future: Object.freeze([]),
+    group: null,
+    coalescing: null,
+});
+function trimmed(past, limit) {
+    return past.length > limit ? past.slice(past.length - limit) : past;
+}
+/**
+ * The history after a change from `before`. `coalesce` names a run of
+ * changes that make one step together; consecutive changes with the same name
+ * record only the first `before`.
+ */
+export function recordChange(history, before, coalesce, limit) {
+    if (history.group !== null)
+        return history;
+    if (coalesce !== null && coalesce === history.coalescing && history.past.length > 0) {
+        return history.future.length === 0 ? history : { ...history, future: [] };
+    }
+    return {
+        past: trimmed([...history.past, before], limit),
+        future: [],
+        group: null,
+        coalescing: coalesce,
+    };
+}
+/** Ends any run of coalescing changes, so the next change is a step of its own. */
+export function breakRun(history) {
+    return history.coalescing === null ? history : { ...history, coalescing: null };
+}
+/** Opens a group. A group already open under another key is committed first. */
+export function beginGroup(history, key, current, limit) {
+    if (history.group?.key === key)
+        return history;
+    const closed = history.group === null ? history : commitGroup(history, history.group.key, current, limit);
+    return { ...closed, group: { key, base: current }, coalescing: null };
+}
+/** Closes the group as one step, if anything in it changed the work. A key that is not the open group's is ignored. */
+export function commitGroup(history, key, current, limit) {
+    const group = history.group;
+    if (group === null || group.key !== key)
+        return history;
+    if (sameWork(group.base, current))
+        return { ...history, group: null };
+    return {
+        past: trimmed([...history.past, group.base], limit),
+        future: [],
+        group: null,
+        coalescing: null,
+    };
+}
+/** Closes the group and says what to restore, or null when no group is open. */
+export function cancelGroup(history) {
+    if (history.group === null)
+        return null;
+    return { history: { ...history, group: null }, restore: history.group.base };
+}
+export function undo(history, current) {
+    const previous = history.past[history.past.length - 1];
+    if (previous === undefined)
+        return null;
+    return {
+        history: {
+            past: history.past.slice(0, -1),
+            future: [...history.future, current],
+            group: null,
+            coalescing: null,
+        },
+        restore: previous,
+    };
+}
+export function redo(history, current, limit) {
+    const next = history.future[history.future.length - 1];
+    if (next === undefined)
+        return null;
+    return {
+        history: {
+            past: trimmed([...history.past, current], limit),
+            future: history.future.slice(0, -1),
+            group: null,
+            coalescing: null,
+        },
+        restore: next,
+    };
+}
+/** Identity is enough: every change makes new objects and an unchanged part keeps its own. */
+export function sameWork(a, b) {
+    return a.typeId === b.typeId && a.fields === b.fields && a.design === b.design;
+}
+//# sourceMappingURL=history.js.map

package/dist/studio/history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.js","sourceRoot":"","sources":["../../src/studio/history.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAqBH,MAAM,CAAC,MAAM,aAAa,GAAY,MAAM,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAoB;IAC1C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAoB;IAC5C,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;CAChB,CAAC,CAAC;AAEH,SAAS,OAAO,CAAC,IAAqB,EAAE,KAAa;IACpD,OAAO,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC3B,OAAgB,EAChB,MAAY,EACZ,QAAuB,EACvB,KAAa;IAEb,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,OAAO,CAAC;IAC3C,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrF,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC3E,CAAC;IACD,OAAO;QACN,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC;QAC/C,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,QAAQ;KACpB,CAAC;AACH,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,QAAQ,CAAC,OAAgB;IACxC,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;AACjF,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,UAAU,CAAC,OAAgB,EAAE,GAAW,EAAE,OAAa,EAAE,KAAa;IACrF,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG;QAAE,OAAO,OAAO,CAAC;IAC/C,MAAM,MAAM,GACX,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5F,OAAO,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;AACvE,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,WAAW,CAAC,OAAgB,EAAE,GAAW,EAAE,OAAa,EAAE,KAAa;IACtF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,GAAG;QAAE,OAAO,OAAO,CAAC;IACxD,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC;QAAE,OAAO,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACtE,OAAO;QACN,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;QACnD,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,IAAI;KAChB,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC3C,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACxC,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,OAAgB,EAAE,OAAa;IACnD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACxC,OAAO;QACN,OAAO,EAAE;YACR,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/B,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;YACpC,KAAK,EAAE,IAAI;YACX,UAAU,EAAE,IAAI;SAChB;QACD,OAAO,EAAE,QAAQ;KACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,IAAI,CACnB,OAAgB,EAChB,OAAa,EACb,KAAa;IAEb,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,OAAO;QACN,OAAO,EAAE;YACR,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC;YAChD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACnC,KAAK,EAAE,IAAI;YACX,UAAU,EAAE,IAAI;SAChB;QACD,OAAO,EAAE,IAAI;KACb,CAAC;AACH,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,QAAQ,CAAC,CAAO,EAAE,CAAO;IACxC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC;AAChF,CAAC"}

package/dist/studio/index.d.ts

@@ -0,0 +1,16 @@
+export { createStudio, DEFAULT_SCHEDULER, MAX_DESIGN_FILE, MAX_RAW_TEXT } from './studio.js';
+export type { BatchState, Catalogue, CatalogueEntry, CommandResult, CommandResults, DesignLinkResult, DesignState, ExportFormat, ExportOptions, ExportResult, FieldGroupView, FieldView, FormView, FrameCatalogueEntry, ModuleCatalogueEntry, InspectState, BrandKit, KitItem, KitSummary, LibraryContents, LibraryFileOpened, LibraryItem, LibraryItemSummary, LibraryProbeState, LibraryShelves, LibraryState, LibraryStore, PayloadTypeEntry, PresetCatalogueEntry, PresetThumbnails, PreviewState, RasterEncoder, Refusal, RegionCatalogueEntry, Scheduler, SegmentSummary, Studio, StudioAction, StudioCommand, StudioDocument, StudioError, StudioMode, StudioOptions, StudioSnapshot, SymbolState, SymbolView, SymbologyCatalogueEntry, VerifyState, } from './types.js';
+export { CAPTURE_AXES, CHECK_IDS } from './seams.js';
+export type { Baseline, BatchMapping, BatchOutput, CaptureAxis, CheckId, CheckStatus, DesignPatch, Fix, FixSuggester, Gs1Element, InspectPayload, InspectReport, InspectSet, InspectedSymbol, Inspector, Printer, VerifyBlock, VerifyCapture, VerifyCheck, VerifyConditions, VerifyGenerator, VerifyJob, VerifyProgress, VerifyReport, VerifyRunner, } from './seams.js';
+export { STUDIO_KEYS, axisKey, categoryKey, checkKey, errorKey, LIBRARY_REASON_KEYS, errorMessageKey, groupKey, presetCategoryKey, studioError, } from './keys.js';
+export { SAMPLE_CONTENT } from './catalogue.js';
+export { DEFAULT_CONDITIONS } from './document.js';
+export { DEFAULT_PRINT_MM, EXPORT_MAX_PIXELS, EXPORT_MAX_SIDE } from './export.js';
+export { LOGO_ASSET_ID, LOGO_MAX_BYTES, LOGO_MAX_SIDE, logoPatches, removeLogoPatches, } from './logo.js';
+export { exportName, fileStem } from './names.js';
+export { KIT_CONTRAST, KIT_GROUND_LUMINANCE, KIT_PALETTE_MAX, applyKit, kitFromDesign, } from './kit.js';
+export { SHUFFLE_CONTRAST, contrastRatio, luminance } from './contrast.js';
+export { FULL_CAPTURE_SEEDS, LIVE_CAPTURE_SEEDS, UNAVAILABLE_RUNNER, slicedVerifyRunner, verifyJob, } from './verify.js';
+export type { DesignAsset, QrDesignV1 } from '../design/types.js';
+export type { RgbaImage } from '../core/image.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/studio/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/studio/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC7F,YAAY,EACX,UAAU,EACV,SAAS,EACT,cAAc,EACd,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,cAAc,EACd,SAAS,EACT,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,OAAO,EACP,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,MAAM,EACN,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,UAAU,EACV,aAAa,EACb,cAAc,EACd,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,WAAW,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACrD,YAAY,EACX,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,WAAW,EACX,OAAO,EACP,WAAW,EACX,WAAW,EACX,GAAG,EACH,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,UAAU,EACV,eAAe,EACf,SAAS,EACT,OAAO,EACP,WAAW,EACX,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,cAAc,EACd,YAAY,EACZ,YAAY,GACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,WAAW,EACX,OAAO,EACP,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,WAAW,GACX,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EACN,aAAa,EACb,cAAc,EACd,aAAa,EACb,WAAW,EACX,iBAAiB,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EACN,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,QAAQ,EACR,aAAa,GACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EACN,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,SAAS,GACT,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAClE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/studio/index.js

@@ -0,0 +1,12 @@
+export { createStudio, DEFAULT_SCHEDULER, MAX_DESIGN_FILE, MAX_RAW_TEXT } from './studio.js';
+export { CAPTURE_AXES, CHECK_IDS } from './seams.js';
+export { STUDIO_KEYS, axisKey, categoryKey, checkKey, errorKey, LIBRARY_REASON_KEYS, errorMessageKey, groupKey, presetCategoryKey, studioError, } from './keys.js';
+export { SAMPLE_CONTENT } from './catalogue.js';
+export { DEFAULT_CONDITIONS } from './document.js';
+export { DEFAULT_PRINT_MM, EXPORT_MAX_PIXELS, EXPORT_MAX_SIDE } from './export.js';
+export { LOGO_ASSET_ID, LOGO_MAX_BYTES, LOGO_MAX_SIDE, logoPatches, removeLogoPatches, } from './logo.js';
+export { exportName, fileStem } from './names.js';
+export { KIT_CONTRAST, KIT_GROUND_LUMINANCE, KIT_PALETTE_MAX, applyKit, kitFromDesign, } from './kit.js';
+export { SHUFFLE_CONTRAST, contrastRatio, luminance } from './contrast.js';
+export { FULL_CAPTURE_SEEDS, LIVE_CAPTURE_SEEDS, UNAVAILABLE_RUNNER, slicedVerifyRunner, verifyJob, } from './verify.js';
+//# sourceMappingURL=index.js.map

package/dist/studio/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/studio/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAmD7F,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AA4BrD,OAAO,EACN,WAAW,EACX,OAAO,EACP,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,WAAW,GACX,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EACN,aAAa,EACb,cAAc,EACd,aAAa,EACb,WAAW,EACX,iBAAiB,GACjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EACN,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,QAAQ,EACR,aAAa,GACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EACN,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,SAAS,GACT,MAAM,aAAa,CAAC"}

package/dist/studio/keys.d.ts

@@ -0,0 +1,86 @@
+/**
+ * The message keys the studio hands to a view, and how an error becomes one.
+ *
+ * A view never shows an error's `message`: the website translates, and the
+ * offline app looks the key up in its English catalogue. So every error that
+ * reaches a person goes through `studioError`, which picks the most specific
+ * sentence there is. An encoding failure has its own keys in the encode
+ * layer's catalogue, found by the param that says why; a reading failure has
+ * the reader's, by `decodeFailureKey`; the library's, by the reason a store
+ * gives; a spreadsheet the batch layer cannot
+ * read has that layer's, by its reason; a font or a print refusal has the
+ * text layer's; anything else has the generic sentence for its code,
+ * `error.<area>.<detail>`.
+ */
+import { QrStudioError } from '../core/errors.js';
+import type { QrStudioErrorCode } from '../core/errors.js';
+import type { Issue, MessageKey } from '../core/issue.js';
+import type { PayloadCategory } from '../payload/types.js';
+import type { PresetCategory } from '../design/types.js';
+import type { CaptureAxis, CheckId, VerifyCheck } from './seams.js';
+import type { StudioError } from './types.js';
+/** Everything the studio says in its own words. */
+export declare const STUDIO_KEYS: Readonly<{
+    /** The code on screen is the last one that worked; the content as it stands cannot be made. */
+    readonly contentInvalid: "studio.issue.content-invalid";
+    /** Nothing to make a code from yet. */
+    readonly contentEmpty: "studio.issue.content-empty";
+    readonly designLocked: "studio.issue.design-locked";
+    readonly constrained: "studio.issue.constrained";
+    readonly unknownType: "studio.issue.unknown-type";
+    readonly readOnlyType: "studio.issue.read-only-type";
+    readonly unknownField: "studio.issue.unknown-field";
+    readonly fieldValue: "studio.issue.field-value";
+    readonly unknownPreset: "studio.issue.unknown-preset";
+    readonly patchPath: "studio.issue.patch-path";
+    readonly designFile: "studio.issue.design-file";
+    readonly designLink: "studio.issue.design-link";
+    readonly rawTooLong: "studio.issue.raw-too-long";
+    readonly unknownFix: "studio.issue.unknown-fix";
+    readonly conditions: "studio.issue.conditions";
+    readonly quietZoneBelowMinimum: "studio.issue.quiet-zone-below-minimum";
+    readonly exportSizeConstrained: "studio.issue.export-size-constrained";
+    readonly exportOption: "studio.issue.export-option";
+    readonly documentRepaired: "studio.issue.document-repaired";
+}>;
+/** A content category's heading. */
+export declare function categoryKey(category: PayloadCategory): MessageKey;
+/** A preset category's heading. */
+export declare function presetCategoryKey(category: PresetCategory): MessageKey;
+/** A field group's heading: 'address', 'utm' and the rest. */
+export declare function groupKey(group: string): MessageKey;
+/**
+ * A scan check's name, for the row a view shows its result in: verify's own
+ * (`checkNameKey`), so the studio, the report and every view call a check by
+ * one name. Contrast is checked twice, as symbol contrast and as modulation
+ * (`grade` 'MOD'), and each has a name of its own.
+ */
+export declare function checkKey(id: CheckId, grade?: VerifyCheck['grade']): MessageKey;
+/** What the scan check is doing, for its progress. */
+export declare function axisKey(axis: CaptureAxis | 'static'): MessageKey;
+/** The generic sentence for an error code: 'encode/too-much-data' is 'error.encode.too-much-data'. */
+export declare function errorMessageKey(code: QrStudioErrorCode): MessageKey;
+/**
+ * The library's specific sentences, by code and reason: a delete another tab
+ * holds up, an item that has gone, a library file that is full, a brand kit
+ * the studio cannot keep. Both stores give these reasons
+ * (src/dom/file-library.ts, src/dom/library); keyed by code as well, so the
+ * same reason from another layer means nothing here.
+ */
+export declare const LIBRARY_REASON_KEYS: Readonly<Record<string, MessageKey>>;
+/** The most specific key there is for an error. */
+export declare function errorKey(error: QrStudioError): MessageKey;
+/** An error as a view shows it. Params are numbers and identifiers, never content, as the error classes promise. */
+export declare function studioError(error: QrStudioError): StudioError;
+/** An error as an issue at `path`, for the places a view shows issues. */
+export declare function errorIssue(error: QrStudioError, path: readonly (string | number)[]): Issue;
+/**
+ * The QrStudioError a thrown value amounts to.
+ *
+ * Anything that is not one (a TypeError from a third party's registry entry,
+ * a RangeError from a malformed file deep in a parser) is reported as the
+ * generic failure for `fallback`, because a person caused it by what they
+ * typed or opened, and the studio promises not to throw for that.
+ */
+export declare function asStudioError(thrown: unknown, fallback: QrStudioErrorCode): QrStudioError;
+//# sourceMappingURL=keys.d.ts.map

package/dist/studio/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/studio/keys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,mDAAmD;AACnD,eAAO,MAAM,WAAW;IACvB,+FAA+F;;IAE/F,uCAAuC;;;;;;;;;;;;;;;;;;;EAmB7B,CAAC;AAEZ,oCAAoC;AACpC,wBAAgB,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,UAAU,CAEjE;AAED,mCAAmC;AACnC,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,cAAc,GAAG,UAAU,CAEtE;AAED,8DAA8D;AAC9D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,UAAU,CAE9E;AAED,sDAAsD;AACtD,wBAAgB,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,QAAQ,GAAG,UAAU,CAEhE;AAED,sGAAsG;AACtG,wBAAgB,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,UAAU,CAEnE;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAKnE,CAAC;AAEH,mDAAmD;AACnD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,UAAU,CAqDzD;AAED,oHAAoH;AACpH,wBAAgB,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,WAAW,CAE7D;AAED,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,KAAK,CAE1F;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,GAAG,aAAa,CAGzF"}

package/dist/studio/keys.js

@@ -0,0 +1,165 @@
+/**
+ * The message keys the studio hands to a view, and how an error becomes one.
+ *
+ * A view never shows an error's `message`: the website translates, and the
+ * offline app looks the key up in its English catalogue. So every error that
+ * reaches a person goes through `studioError`, which picks the most specific
+ * sentence there is. An encoding failure has its own keys in the encode
+ * layer's catalogue, found by the param that says why; a reading failure has
+ * the reader's, by `decodeFailureKey`; the library's, by the reason a store
+ * gives; a spreadsheet the batch layer cannot
+ * read has that layer's, by its reason; a font or a print refusal has the
+ * text layer's; anything else has the generic sentence for its code,
+ * `error.<area>.<detail>`.
+ */
+import { QrStudioError } from '../core/errors.js';
+import { decodeFailureKey } from '../decode/failure.js';
+import { issue } from '../core/issue.js';
+import { checkNameKey } from '../verify/keys.js';
+/** Everything the studio says in its own words. */
+export const STUDIO_KEYS = Object.freeze({
+    /** The code on screen is the last one that worked; the content as it stands cannot be made. */
+    contentInvalid: 'studio.issue.content-invalid',
+    /** Nothing to make a code from yet. */
+    contentEmpty: 'studio.issue.content-empty',
+    designLocked: 'studio.issue.design-locked',
+    constrained: 'studio.issue.constrained',
+    unknownType: 'studio.issue.unknown-type',
+    readOnlyType: 'studio.issue.read-only-type',
+    unknownField: 'studio.issue.unknown-field',
+    fieldValue: 'studio.issue.field-value',
+    unknownPreset: 'studio.issue.unknown-preset',
+    patchPath: 'studio.issue.patch-path',
+    designFile: 'studio.issue.design-file',
+    designLink: 'studio.issue.design-link',
+    rawTooLong: 'studio.issue.raw-too-long',
+    unknownFix: 'studio.issue.unknown-fix',
+    conditions: 'studio.issue.conditions',
+    quietZoneBelowMinimum: 'studio.issue.quiet-zone-below-minimum',
+    exportSizeConstrained: 'studio.issue.export-size-constrained',
+    exportOption: 'studio.issue.export-option',
+    documentRepaired: 'studio.issue.document-repaired',
+});
+/** A content category's heading. */
+export function categoryKey(category) {
+    return `studio.category.${category}`;
+}
+/** A preset category's heading. */
+export function presetCategoryKey(category) {
+    return `studio.preset-category.${category}`;
+}
+/** A field group's heading: 'address', 'utm' and the rest. */
+export function groupKey(group) {
+    return `studio.group.${group}`;
+}
+/**
+ * A scan check's name, for the row a view shows its result in: verify's own
+ * (`checkNameKey`), so the studio, the report and every view call a check by
+ * one name. Contrast is checked twice, as symbol contrast and as modulation
+ * (`grade` 'MOD'), and each has a name of its own.
+ */
+export function checkKey(id, grade) {
+    return checkNameKey({ id, grade });
+}
+/** What the scan check is doing, for its progress. */
+export function axisKey(axis) {
+    return `studio.axis.${axis}`;
+}
+/** The generic sentence for an error code: 'encode/too-much-data' is 'error.encode.too-much-data'. */
+export function errorMessageKey(code) {
+    return `error.${code.replace('/', '.')}`;
+}
+function param(error, name) {
+    const value = error.params[name];
+    return typeof value === 'string' && /^[a-z0-9-]+$/.test(value) ? value : undefined;
+}
+/**
+ * The library's specific sentences, by code and reason: a delete another tab
+ * holds up, an item that has gone, a library file that is full, a brand kit
+ * the studio cannot keep. Both stores give these reasons
+ * (src/dom/file-library.ts, src/dom/library); keyed by code as well, so the
+ * same reason from another layer means nothing here.
+ */
+export const LIBRARY_REASON_KEYS = Object.freeze({
+    'library/unavailable:blocked': 'dom.library.error.blocked',
+    'library/corrupt:missing': 'dom.library.error.missing',
+    'library/quota:file-full': 'dom.library.error.file-full',
+    'design/invalid:kit': 'dom.library.error.kit',
+});
+/** The most specific key there is for an error. */
+export function errorKey(error) {
+    const reasoned = `${error.code}:${String(error.params.reason)}`;
+    if (Object.prototype.hasOwnProperty.call(LIBRARY_REASON_KEYS, reasoned)) {
+        return LIBRARY_REASON_KEYS[reasoned];
+    }
+    switch (error.code) {
+        case 'encode/too-much-data':
+            return 'encode.too-much-data';
+        case 'encode/unsupported-feature': {
+            const feature = param(error, 'feature');
+            return feature === undefined
+                ? errorMessageKey(error.code)
+                : `encode.unsupported-feature.${feature}`;
+        }
+        case 'encode/unsupported-content': {
+            const reason = param(error, 'reason');
+            return reason === undefined
+                ? errorMessageKey(error.code)
+                : `encode.unsupported-content.${reason}`;
+        }
+        case 'decode/not-found':
+        case 'decode/unreadable':
+        case 'decode/unsupported':
+            return decodeFailureKey(error);
+        case 'batch/malformed-csv': {
+            const reason = param(error, 'reason');
+            return reason === undefined ? errorMessageKey(error.code) : `batch.malformed-csv.${reason}`;
+        }
+        case 'batch/too-many-rows':
+            return 'batch.too-many-rows';
+        case 'batch/unknown-column':
+            return 'batch.unknown-column';
+        case 'platform/unavailable':
+            // A spreadsheet in an encoding this browser cannot read has its own sentence.
+            return param(error, 'feature') === 'text-encoding'
+                ? 'batch.encoding-unavailable'
+                : errorMessageKey(error.code);
+        case 'font/malformed':
+            return 'text.font.malformed';
+        case 'font/missing-glyphs':
+            return 'text.font.missing-glyphs';
+        case 'render/surface-too-large':
+            // The PDF writer's page limit says so by its maxMm; a raster's by its pixels.
+            return error.params.maxMm === undefined
+                ? errorMessageKey(error.code)
+                : 'render.print.too-large';
+        case 'render/format-unavailable':
+            return param(error, 'format') === 'eps' && param(error, 'reason') === 'transparency'
+                ? 'render.eps.transparency'
+                : errorMessageKey(error.code);
+        default:
+            return errorMessageKey(error.code);
+    }
+}
+/** An error as a view shows it. Params are numbers and identifiers, never content, as the error classes promise. */
+export function studioError(error) {
+    return { code: error.code, messageKey: errorKey(error), params: error.params };
+}
+/** An error as an issue at `path`, for the places a view shows issues. */
+export function errorIssue(error, path) {
+    return issue(errorKey(error), path, 'error', error.params);
+}
+/**
+ * The QrStudioError a thrown value amounts to.
+ *
+ * Anything that is not one (a TypeError from a third party's registry entry,
+ * a RangeError from a malformed file deep in a parser) is reported as the
+ * generic failure for `fallback`, because a person caused it by what they
+ * typed or opened, and the studio promises not to throw for that.
+ */
+export function asStudioError(thrown, fallback) {
+    if (thrown instanceof QrStudioError)
+        return thrown;
+    return new QrStudioError(fallback, 'That could not be done.', {}, { cause: thrown });
+}
+//# sourceMappingURL=keys.js.map

package/dist/studio/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../src/studio/keys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAIzC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,+FAA+F;IAC/F,cAAc,EAAE,8BAA8B;IAC9C,uCAAuC;IACvC,YAAY,EAAE,4BAA4B;IAC1C,YAAY,EAAE,4BAA4B;IAC1C,WAAW,EAAE,0BAA0B;IACvC,WAAW,EAAE,2BAA2B;IACxC,YAAY,EAAE,6BAA6B;IAC3C,YAAY,EAAE,4BAA4B;IAC1C,UAAU,EAAE,0BAA0B;IACtC,aAAa,EAAE,6BAA6B;IAC5C,SAAS,EAAE,yBAAyB;IACpC,UAAU,EAAE,0BAA0B;IACtC,UAAU,EAAE,0BAA0B;IACtC,UAAU,EAAE,2BAA2B;IACvC,UAAU,EAAE,0BAA0B;IACtC,UAAU,EAAE,yBAAyB;IACrC,qBAAqB,EAAE,uCAAuC;IAC9D,qBAAqB,EAAE,sCAAsC;IAC7D,YAAY,EAAE,4BAA4B;IAC1C,gBAAgB,EAAE,gCAAgC;CACzC,CAAC,CAAC;AAEZ,oCAAoC;AACpC,MAAM,UAAU,WAAW,CAAC,QAAyB;IACpD,OAAO,mBAAmB,QAAQ,EAAE,CAAC;AACtC,CAAC;AAED,mCAAmC;AACnC,MAAM,UAAU,iBAAiB,CAAC,QAAwB;IACzD,OAAO,0BAA0B,QAAQ,EAAE,CAAC;AAC7C,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,QAAQ,CAAC,KAAa;IACrC,OAAO,gBAAgB,KAAK,EAAE,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAW,EAAE,KAA4B;IACjE,OAAO,YAAY,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,OAAO,CAAC,IAA4B;IACnD,OAAO,eAAe,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,eAAe,CAAC,IAAuB;IACtD,OAAO,SAAS,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;AAC1C,CAAC;AAED,SAAS,KAAK,CAAC,KAAoB,EAAE,IAAY;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACpF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAyC,MAAM,CAAC,MAAM,CAAC;IACtF,6BAA6B,EAAE,2BAA2B;IAC1D,yBAAyB,EAAE,2BAA2B;IACtD,yBAAyB,EAAE,6BAA6B;IACxD,oBAAoB,EAAE,uBAAuB;CAC7C,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC5C,MAAM,QAAQ,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAChE,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAAE,CAAC;QACzE,OAAO,mBAAmB,CAAC,QAAQ,CAAe,CAAC;IACpD,CAAC;IACD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,sBAAsB;YAC1B,OAAO,sBAAsB,CAAC;QAC/B,KAAK,4BAA4B,CAAC,CAAC,CAAC;YACnC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACxC,OAAO,OAAO,KAAK,SAAS;gBAC3B,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,CAAC,CAAC,8BAA8B,OAAO,EAAE,CAAC;QAC5C,CAAC;QACD,KAAK,4BAA4B,CAAC,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACtC,OAAO,MAAM,KAAK,SAAS;gBAC1B,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,CAAC,CAAC,8BAA8B,MAAM,EAAE,CAAC;QAC3C,CAAC;QACD,KAAK,kBAAkB,CAAC;QACxB,KAAK,mBAAmB,CAAC;QACzB,KAAK,oBAAoB;YACxB,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAChC,KAAK,qBAAqB,CAAC,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACtC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB,MAAM,EAAE,CAAC;QAC7F,CAAC;QACD,KAAK,qBAAqB;YACzB,OAAO,qBAAqB,CAAC;QAC9B,KAAK,sBAAsB;YAC1B,OAAO,sBAAsB,CAAC;QAC/B,KAAK,sBAAsB;YAC1B,8EAA8E;YAC9E,OAAO,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,eAAe;gBACjD,CAAC,CAAC,4BAA4B;gBAC9B,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC,KAAK,gBAAgB;YACpB,OAAO,qBAAqB,CAAC;QAC9B,KAAK,qBAAqB;YACzB,OAAO,0BAA0B,CAAC;QACnC,KAAK,0BAA0B;YAC9B,8EAA8E;YAC9E,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS;gBACtC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,CAAC,CAAC,wBAAwB,CAAC;QAC7B,KAAK,2BAA2B;YAC/B,OAAO,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,cAAc;gBACnF,CAAC,CAAC,yBAAyB;gBAC3B,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC;YACC,OAAO,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;AACF,CAAC;AAED,oHAAoH;AACpH,MAAM,UAAU,WAAW,CAAC,KAAoB;IAC/C,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AAChF,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,UAAU,CAAC,KAAoB,EAAE,IAAkC;IAClF,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,MAAe,EAAE,QAA2B;IACzE,IAAI,MAAM,YAAY,aAAa;QAAE,OAAO,MAAM,CAAC;IACnD,OAAO,IAAI,aAAa,CAAC,QAAQ,EAAE,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACtF,CAAC"}

package/dist/studio/kit.d.ts

@@ -0,0 +1,44 @@
+/**
+ * A brand kit applied to a design, and a kit made from one.
+ *
+ * A kit is a palette, perhaps a logo, and the presets the brand prefers. The
+ * palette is a set of colours with no roles, so applying it has to decide
+ * which colour goes where, and has to keep the code readable while it does.
+ * The rule, in order:
+ *
+ * 1. The ground. The kit's lightest ink becomes the background when it is
+ *    pale enough to be one (relative luminance 0.8 or more, about the
+ *    lightness of a pale tint). Otherwise the design keeps its own ground.
+ * 2. The modules. The kit's darkest ink becomes the module colour when it
+ *    stands at 4.5:1 or more against the ground, the floor every preset is
+ *    held to. Otherwise the modules keep their own colour, because a brand
+ *    colour that does not read is worse than no brand colour.
+ * 3. The finder rings. The next darkest ink that also clears 4.5:1 becomes
+ *    the colour of the three corner rings, the one place a second brand
+ *    colour shows without costing the data modules anything. Without one the
+ *    rings follow the modules. A design with no finder style of its own gets
+ *    the plain square ring and centre, the pair every reader finds.
+ * 4. The logo. A kit with a picture logo puts it in the middle, keeping the
+ *    size and clearing the design already had.
+ *
+ * Contrast is judged against the ground's own colour when it is a solid
+ * ink, and against white otherwise (a gradient, a fill, or no ground, which
+ * is paper). The kit's presets are not applied: they are offered, first,
+ * beside the rest (`snapshot.library.kit`).
+ */
+import type { QrDesignV1 } from '../design/types.js';
+import type { BrandKit } from './types.js';
+/** The luminance at or above which a kit ink can be a ground. */
+export declare const KIT_GROUND_LUMINANCE = 0.8;
+/** The contrast a kit ink needs against the ground to draw modules or rings. */
+export declare const KIT_CONTRAST = 4.5;
+/** The most inks a kit holds, as both library stores allow. */
+export declare const KIT_PALETTE_MAX = 32;
+/** The design with `kit` applied by the rule above. The person's own logo stays when the kit has none. */
+export declare function applyKit(design: QrDesignV1, kit: BrandKit): QrDesignV1;
+/**
+ * A kit made from a design, for "Save as brand kit": its inks, its picture
+ * logo, and no presets, which the person chooses.
+ */
+export declare function kitFromDesign(design: QrDesignV1): BrandKit;
+//# sourceMappingURL=kit.d.ts.map