@bilig/workbook 0.42.0

package/dist/model.js

@@ -0,0 +1,331 @@
+import { formula } from './formula.js';
+import { collectWorkbookRefs, createWorkbookFindApi } from './find.js';
+import { createWorkbookCheckApi } from './check.js';
+import { normalizeOptionalWorkbookActionInput, normalizeWorkbookActionInputDescription, validateWorkbookActionInput, } from './input.js';
+import { isWorkbookOp } from './guards.js';
+export function defineModel(config) {
+    if (config.name.trim() === '') {
+        throw new Error('Workbook model name cannot be empty');
+    }
+    normalizeOptionalDescription(config.description, `Workbook model ${config.name} description`);
+    const actionNames = Object.keys(config.actions);
+    if (actionNames.length === 0) {
+        throw new Error(`Workbook model ${config.name} must define at least one action`);
+    }
+    const emptyActionName = actionNames.find((name) => name.trim() === '');
+    if (emptyActionName !== undefined) {
+        throw new Error(`Workbook model ${config.name} has an empty action name`);
+    }
+    actionNames.forEach((name) => {
+        validateActionDefinition(config.name, name, config.actions[name]);
+    });
+    return config;
+}
+export function inspectModel(model) {
+    const actions = Object.keys(model.actions).toSorted();
+    const description = normalizeOptionalDescription(model.description, `Workbook model ${model.name} description`);
+    return {
+        name: model.name,
+        ...(description !== undefined ? { description } : {}),
+        actions,
+        actionDetails: actions.map((actionName) => inspectAction(actionName, model.actions[actionName])),
+        hasChecks: model.checks !== undefined,
+    };
+}
+function normalizeOptionalDescription(value, label) {
+    if (value === undefined) {
+        return undefined;
+    }
+    const description = value.trim();
+    if (description === '') {
+        throw new Error(`${label} cannot be empty`);
+    }
+    return description;
+}
+function isActionConfig(definition) {
+    return typeof definition === 'object' && definition !== null;
+}
+function validateActionDefinition(modelName, actionName, definition) {
+    if (typeof definition === 'function') {
+        return;
+    }
+    if (!isActionConfig(definition) || typeof definition.run !== 'function') {
+        throw new Error(`Workbook model ${modelName} action ${actionName} must be a function or action object with run`);
+    }
+    normalizeOptionalDescription(definition.description, `Workbook model ${modelName} action ${actionName} description`);
+    if (definition.input !== undefined) {
+        normalizeWorkbookActionInputDescription(definition.input);
+    }
+}
+function actionRunner(definition) {
+    return typeof definition === 'function' ? definition : definition.run;
+}
+function inspectAction(name, definition) {
+    if (definition === undefined || typeof definition === 'function') {
+        return { name };
+    }
+    const description = normalizeOptionalDescription(definition.description, `Workbook action ${name} description`);
+    const input = definition.input === undefined ? undefined : normalizeWorkbookActionInputDescription(definition.input);
+    return {
+        name,
+        ...(description !== undefined ? { description } : {}),
+        ...(input !== undefined ? { input } : {}),
+    };
+}
+function concreteSingleCell(target) {
+    if (target.kind !== 'range') {
+        return null;
+    }
+    const range = target.range;
+    return range.startAddress === range.endAddress ? { sheetName: range.sheetName, address: range.startAddress } : null;
+}
+function commandMessage(command) {
+    switch (command.kind) {
+        case 'writeFormula':
+            return `Write formula to ${command.target.label}`;
+        case 'writeValue':
+            return `Write value to ${command.target.label}`;
+        case 'format':
+            return `Format ${command.target.label}`;
+        case 'clear':
+            return `Clear ${command.target.label}`;
+        case 'op':
+            return (command.message ??
+                (command.target === undefined
+                    ? `Add workbook op ${command.op.kind}`
+                    : `Add workbook op ${command.op.kind} for ${command.target.label}`));
+    }
+}
+function commandTarget(command) {
+    return command.target;
+}
+function cloneWorkbookOp(op) {
+    return structuredClone(op);
+}
+function createCheckWorkbook(input) {
+    return Object.freeze({
+        ...createWorkbookFindApi(),
+        check: createWorkbookCheckApi((entry) => input.checks.push(entry)),
+    });
+}
+function createActionWorkbook(input) {
+    const checkWorkbook = createCheckWorkbook({ checks: input.checks });
+    function pushCommand(command) {
+        if (command.kind === 'op') {
+            const commandOp = cloneWorkbookOp(command.op);
+            const planOp = cloneWorkbookOp(command.op);
+            input.commands.push({
+                kind: 'op',
+                op: commandOp,
+                ...(command.target !== undefined ? { target: command.target } : {}),
+                ...(command.message !== undefined ? { message: command.message } : {}),
+            });
+            input.ops.push(planOp);
+            return;
+        }
+        input.commands.push(command);
+        const target = concreteSingleCell(command.target);
+        if (target === null) {
+            return;
+        }
+        switch (command.kind) {
+            case 'writeFormula':
+                input.ops.push({
+                    kind: 'setCellFormula',
+                    sheetName: target.sheetName,
+                    address: target.address,
+                    formula: command.formula,
+                });
+                return;
+            case 'writeValue':
+                input.ops.push({
+                    kind: 'setCellValue',
+                    sheetName: target.sheetName,
+                    address: target.address,
+                    value: command.value,
+                });
+                return;
+            case 'clear':
+                input.ops.push({
+                    kind: 'clearCell',
+                    sheetName: target.sheetName,
+                    address: target.address,
+                });
+                return;
+            case 'format':
+                if (command.numberFormat !== undefined) {
+                    input.ops.push({
+                        kind: 'setCellFormat',
+                        sheetName: target.sheetName,
+                        address: target.address,
+                        format: command.numberFormat,
+                    });
+                }
+                return;
+        }
+    }
+    const workbook = {
+        ...checkWorkbook,
+        writeFormula(target, value) {
+            pushCommand({
+                kind: 'writeFormula',
+                target,
+                formula: formula.source(value),
+                inputs: formula.inputs(value),
+            });
+        },
+        writeValue(target, value) {
+            pushCommand({
+                kind: 'writeValue',
+                target,
+                value,
+            });
+        },
+        format(target, options) {
+            pushCommand({
+                kind: 'format',
+                target,
+                ...(options.style !== undefined ? { style: options.style } : {}),
+                ...(options.numberFormat !== undefined ? { numberFormat: options.numberFormat } : {}),
+            });
+        },
+        clear(target) {
+            pushCommand({
+                kind: 'clear',
+                target,
+            });
+        },
+        addOp(op, options = {}) {
+            if (!isWorkbookOp(op)) {
+                throw new Error('Workbook op is not a valid WorkbookOp');
+            }
+            pushCommand({
+                kind: 'op',
+                op,
+                ...(options.target !== undefined ? { target: options.target } : {}),
+                ...(options.message !== undefined ? { message: options.message } : {}),
+            });
+        },
+    };
+    return Object.freeze(workbook);
+}
+function pushReturnedChecks(target, returned) {
+    returned?.forEach((entry) => {
+        if (!target.includes(entry)) {
+            target.push(entry);
+        }
+    });
+}
+function errorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+function inputProperty(input) {
+    return input === undefined ? {} : { input };
+}
+function failedPlan(modelName, actionName, code, message, checks = [], input) {
+    return {
+        status: 'failed',
+        modelName,
+        actionName,
+        ...inputProperty(input),
+        checks,
+        errors: [{ code, message }],
+    };
+}
+function actionNotFound(modelName, actionName) {
+    return {
+        code: 'action_not_found',
+        message: `Workbook model ${modelName} does not define action ${actionName}`,
+    };
+}
+function createActionPlan(modelName, actionName, input, refs, commands, ops, checks) {
+    return {
+        modelName,
+        actionName,
+        ...inputProperty(input),
+        refs,
+        refsUsed: collectWorkbookRefs(refs),
+        commands,
+        ops,
+        changed: commands.map((command) => {
+            const target = commandTarget(command);
+            return {
+                kind: command.kind,
+                ...(target !== undefined ? { target } : {}),
+                message: commandMessage(command),
+            };
+        }),
+        checks,
+    };
+}
+export function planWorkbookAction(model, actionName, input) {
+    let normalizedInput;
+    try {
+        normalizedInput = normalizeOptionalWorkbookActionInput(input);
+    }
+    catch (error) {
+        return failedPlan(model.name, actionName, 'invalid_action_input', errorMessage(error));
+    }
+    const actionDefinition = model.actions[actionName];
+    if (actionDefinition === undefined) {
+        return {
+            status: 'failed',
+            modelName: model.name,
+            actionName,
+            ...inputProperty(normalizedInput),
+            checks: [],
+            errors: [actionNotFound(model.name, actionName)],
+        };
+    }
+    if (isActionConfig(actionDefinition) && actionDefinition.input !== undefined) {
+        try {
+            validateWorkbookActionInput(normalizeWorkbookActionInputDescription(actionDefinition.input), normalizedInput);
+        }
+        catch (error) {
+            return failedPlan(model.name, actionName, 'invalid_action_input', errorMessage(error), [], normalizedInput);
+        }
+    }
+    const action = actionRunner(actionDefinition);
+    const commands = [];
+    const ops = [];
+    const checks = [];
+    const findWorkbook = Object.freeze(createWorkbookFindApi());
+    let refs;
+    try {
+        refs = model.find(findWorkbook);
+    }
+    catch (error) {
+        return failedPlan(model.name, actionName, 'find_failed', errorMessage(error), checks, normalizedInput);
+    }
+    const checkContext = { refs, workbook: createCheckWorkbook({ checks }), ...inputProperty(normalizedInput) };
+    try {
+        pushReturnedChecks(checks, model.checks?.(checkContext));
+    }
+    catch (error) {
+        return failedPlan(model.name, actionName, 'checks_failed', errorMessage(error), checks, normalizedInput);
+    }
+    const actionContext = {
+        refs,
+        workbook: createActionWorkbook({ commands, ops, checks }),
+        ...inputProperty(normalizedInput),
+    };
+    try {
+        action(actionContext);
+    }
+    catch (error) {
+        return failedPlan(model.name, actionName, 'action_failed', errorMessage(error), checks, normalizedInput);
+    }
+    return {
+        status: 'planned',
+        plan: createActionPlan(model.name, actionName, normalizedInput, refs, commands, ops, checks),
+    };
+}
+export function buildWorkbookActionPlan(model, actionName, input) {
+    const result = planWorkbookAction(model, actionName, input);
+    if (result.status === 'failed') {
+        const [error] = result.errors;
+        throw new Error(error?.message ?? `Workbook model ${model.name} failed to plan action ${actionName}`);
+    }
+    return result.plan;
+}
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAA+B,MAAM,cAAc,CAAA;AACnE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAA0C,MAAM,WAAW,CAAA;AAC9G,OAAO,EAAE,sBAAsB,EAAyB,MAAM,YAAY,CAAA;AAC1E,OAAO,EACL,oCAAoC,EACpC,uCAAuC,EACvC,2BAA2B,GAG5B,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAmI1C,MAAM,UAAU,WAAW,CACzB,MAA0C;IAE1C,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IACD,4BAA4B,CAAC,MAAM,CAAC,WAAW,EAAE,kBAAkB,MAAM,CAAC,IAAI,cAAc,CAAC,CAAA;IAC7F,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC/C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,IAAI,kCAAkC,CAAC,CAAA;IAClF,CAAC;IACD,MAAM,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACtE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,IAAI,2BAA2B,CAAC,CAAA;IAC3E,CAAC;IACD,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,wBAAwB,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IACnE,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,YAAY,CAAgD,KAAmC;IAC7G,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;IACrD,MAAM,WAAW,GAAG,4BAA4B,CAAC,KAAK,CAAC,WAAW,EAAE,kBAAkB,KAAK,CAAC,IAAI,cAAc,CAAC,CAAA;IAC/G,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO;QACP,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAChG,SAAS,EAAE,KAAK,CAAC,MAAM,KAAK,SAAS;KACtC,CAAA;AACH,CAAC;AAED,SAAS,4BAA4B,CAAC,KAAyB,EAAE,KAAa;IAC5E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAChC,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,kBAAkB,CAAC,CAAA;IAC7C,CAAC;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,SAAS,cAAc,CAAO,UAAsD;IAClF,OAAO,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,IAAI,CAAA;AAC9D,CAAC;AAED,SAAS,wBAAwB,CAC/B,SAAiB,EACjB,UAAkB,EAClB,UAAsD;IAEtD,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;QACrC,OAAM;IACR,CAAC;IACD,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,kBAAkB,SAAS,WAAW,UAAU,+CAA+C,CAAC,CAAA;IAClH,CAAC;IACD,4BAA4B,CAAC,UAAU,CAAC,WAAW,EAAE,kBAAkB,SAAS,WAAW,UAAU,cAAc,CAAC,CAAA;IACpH,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnC,uCAAuC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAO,UAA0C;IACpE,OAAO,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAA;AACvE,CAAC;AAED,SAAS,aAAa,CAAO,IAAY,EAAE,UAAsD;IAC/F,IAAI,UAAU,KAAK,SAAS,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;QACjE,OAAO,EAAE,IAAI,EAAE,CAAA;IACjB,CAAC;IACD,MAAM,WAAW,GAAG,4BAA4B,CAAC,UAAU,CAAC,WAAW,EAAE,mBAAmB,IAAI,cAAc,CAAC,CAAA;IAC/G,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,uCAAuC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IACpH,OAAO;QACL,IAAI;QACJ,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAmB;IAC7C,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;IAC1B,OAAO,KAAK,CAAC,YAAY,KAAK,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACrH,CAAC;AAED,SAAS,cAAc,CAAC,OAA8B;IACpD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO,oBAAoB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACnD,KAAK,YAAY;YACf,OAAO,kBAAkB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACjD,KAAK,QAAQ;YACX,OAAO,UAAU,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACzC,KAAK,OAAO;YACV,OAAO,SAAS,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACxC,KAAK,IAAI;YACP,OAAO,CACL,OAAO,CAAC,OAAO;gBACf,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS;oBAC3B,CAAC,CAAC,mBAAmB,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE;oBACtC,CAAC,CAAC,mBAAmB,OAAO,CAAC,EAAE,CAAC,IAAI,QAAQ,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CACtE,CAAA;IACL,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,OAA8B;IACnD,OAAO,OAAO,CAAC,MAAM,CAAA;AACvB,CAAC;AAED,SAAS,eAAe,CAAC,EAAc;IACrC,OAAO,eAAe,CAAC,EAAE,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAiD;IAC5E,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,GAAG,qBAAqB,EAAE;QAC1B,KAAK,EAAE,sBAAsB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACnE,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAI7B;IACC,MAAM,aAAa,GAAG,mBAAmB,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IAEnE,SAAS,WAAW,CAAC,OAA8B;QACjD,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC7C,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC1C,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,IAAI;gBACV,EAAE,EAAE,SAAS;gBACb,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACvE,CAAC,CAAA;YACF,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACtB,OAAM;QACR,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAE5B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QACD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,cAAc;gBACjB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,gBAAgB;oBACtB,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB,CAAC,CAAA;gBACF,OAAM;YACR,KAAK,YAAY;gBACf,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,cAAc;oBACpB,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,OAAO,CAAC,KAAK;iBACrB,CAAC,CAAA;gBACF,OAAM;YACR,KAAK,OAAO;gBACV,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,WAAW;oBACjB,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB,CAAC,CAAA;gBACF,OAAM;YACR,KAAK,QAAQ;gBACX,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACvC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;wBACb,IAAI,EAAE,eAAe;wBACrB,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,MAAM,EAAE,OAAO,CAAC,YAAY;qBAC7B,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAM;QACV,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAA2B;QACvC,GAAG,aAAa;QAChB,YAAY,CAAC,MAAmB,EAAE,KAA6B;YAC7D,WAAW,CAAC;gBACV,IAAI,EAAE,cAAc;gBACpB,MAAM;gBACN,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;aAC9B,CAAC,CAAA;QACJ,CAAC;QACD,UAAU,CAAC,MAAmB,EAAE,KAAmB;YACjD,WAAW,CAAC;gBACV,IAAI,EAAE,YAAY;gBAClB,MAAM;gBACN,KAAK;aACN,CAAC,CAAA;QACJ,CAAC;QACD,MAAM,CAAC,MAAmB,EAAE,OAAmF;YAC7G,WAAW,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,MAAM;gBACN,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChE,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtF,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,CAAC,MAAmB;YACvB,WAAW,CAAC;gBACV,IAAI,EAAE,OAAO;gBACb,MAAM;aACP,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,CAAC,EAAc,EAAE,UAAgC,EAAE;YACtD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;YAC1D,CAAC;YACD,WAAW,CAAC;gBACV,IAAI,EAAE,IAAI;gBACV,EAAE;gBACF,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACvE,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED,SAAS,kBAAkB,CAAC,MAA6B,EAAE,QAAoD;IAC7G,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpB,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC/D,CAAC;AAED,SAAS,aAAa,CAAC,KAAsC;IAC3D,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAA;AAC7C,CAAC;AAED,SAAS,UAAU,CACjB,SAAiB,EACjB,UAAkB,EAClB,IAA0B,EAC1B,OAAe,EACf,SAAyC,EAAE,EAC3C,KAA2B;IAE3B,OAAO;QACL,MAAM,EAAE,QAAQ;QAChB,SAAS;QACT,UAAU;QACV,GAAG,aAAa,CAAC,KAAK,CAAC;QACvB,MAAM;QACN,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;KAC5B,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,SAAiB,EAAE,UAAkB;IAC3D,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,kBAAkB,SAAS,2BAA2B,UAAU,EAAE;KAC5E,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,SAAiB,EACjB,UAAkB,EAClB,KAAsC,EACtC,IAAU,EACV,QAA0C,EAC1C,GAA0B,EAC1B,MAAsC;IAEtC,OAAO;QACL,SAAS;QACT,UAAU;QACV,GAAG,aAAa,CAAC,KAAK,CAAC;QACvB,IAAI;QACJ,QAAQ,EAAE,mBAAmB,CAAC,IAAI,CAAC;QACnC,QAAQ;QACR,GAAG;QACH,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAChC,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;YACrC,OAAO;gBACL,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;aACjC,CAAA;QACH,CAAC,CAAC;QACF,MAAM;KACP,CAAA;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,KAAmC,EACnC,UAAkB,EAClB,KAA2B;IAE3B,IAAI,eAAgD,CAAA;IACpD,IAAI,CAAC;QACH,eAAe,GAAG,oCAAoC,CAAC,KAAK,CAAC,CAAA;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,UAAU,CAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,sBAAsB,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9F,CAAC;IAED,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAClD,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,KAAK,CAAC,IAAI;YACrB,UAAU;YACV,GAAG,aAAa,CAAC,eAAe,CAAC;YACjC,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;SACjD,CAAA;IACH,CAAC;IACD,IAAI,cAAc,CAAC,gBAAgB,CAAC,IAAI,gBAAgB,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC7E,IAAI,CAAC;YACH,2BAA2B,CAAC,uCAAuC,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,CAAA;QAC/G,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,UAAU,CAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,sBAAsB,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,eAAe,CAAC,CAAA;QACnH,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAA;IAE7C,MAAM,QAAQ,GAA4B,EAAE,CAAA;IAC5C,MAAM,GAAG,GAAiB,EAAE,CAAA;IAC5B,MAAM,MAAM,GAA0B,EAAE,CAAA;IACxC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAA;IAE3D,IAAI,IAAU,CAAA;IACd,IAAI,CAAC;QACH,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,UAAU,CAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;IAC9G,CAAC;IAED,MAAM,YAAY,GAA+B,EAAE,IAAI,EAAE,QAAQ,EAAE,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,aAAa,CAAC,eAAe,CAAC,EAAE,CAAA;IACvI,IAAI,CAAC;QACH,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,CAAC,CAAA;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,UAAU,CAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;IAChH,CAAC;IAED,MAAM,aAAa,GAAgC;QACjD,IAAI;QACJ,QAAQ,EAAE,oBAAoB,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QACzD,GAAG,aAAa,CAAC,eAAe,CAAC;KAClC,CAAA;IACD,IAAI,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,CAAA;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,UAAU,CAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;IAChH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;KAC7F,CAAA;AACH,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,KAAmC,EACnC,UAAsB,EACtB,KAA2B;IAE3B,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;IAC3D,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;QAC7B,MAAM,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,kBAAkB,KAAK,CAAC,IAAI,0BAA0B,UAAU,EAAE,CAAC,CAAA;IACvG,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAA;AACpB,CAAC"}

package/dist/ops.d.ts

@@ -0,0 +1,283 @@
+import type { CellRangeRef, CellNumberFormatRecord, CellStyleRecord, CellStylePatch, LiteralInput, WorkbookAutoFilterSnapshot, WorkbookCommentThreadSnapshot, WorkbookChartSnapshot, WorkbookConditionalFormatSnapshot, WorkbookDataValidationSnapshot, WorkbookImageSnapshot, WorkbookMergeRangeSnapshot, WorkbookNoteSnapshot, WorkbookRangeProtectionSnapshot, WorkbookSheetProtectionSnapshot, WorkbookShapeSnapshot, WorkbookAxisEntrySnapshot, WorkbookCalculationSettingsSnapshot, WorkbookDefinedNameValueSnapshot, WorkbookPivotSnapshot, WorkbookTableSnapshot, WorkbookVolatileContextSnapshot } from '@bilig/protocol';
+export type ReplicaId = string;
+export type OpId = string;
+export interface Clock {
+    counter: number;
+}
+export type WorkbookStructuralAxis = 'row' | 'column';
+export type WorkbookSortDirection = 'asc' | 'desc';
+export interface WorkbookTableOp extends WorkbookTableSnapshot {
+}
+export interface WorkbookSortKey {
+    keyAddress: string;
+    direction: WorkbookSortDirection;
+}
+export interface WorkbookAxisEntryOp extends WorkbookAxisEntrySnapshot {
+}
+export interface WorkbookCellStyleOp extends CellStyleRecord {
+}
+export interface WorkbookCellNumberFormatOp extends CellNumberFormatRecord {
+}
+export interface WorkbookDataValidationOp extends WorkbookDataValidationSnapshot {
+}
+export interface WorkbookConditionalFormatOp extends WorkbookConditionalFormatSnapshot {
+    style: CellStylePatch;
+}
+export interface WorkbookSheetProtectionOp extends WorkbookSheetProtectionSnapshot {
+}
+export interface WorkbookRangeProtectionOp extends WorkbookRangeProtectionSnapshot {
+}
+export interface WorkbookCommentThreadOp extends WorkbookCommentThreadSnapshot {
+}
+export interface WorkbookNoteOp extends WorkbookNoteSnapshot {
+}
+export interface WorkbookChartOp extends WorkbookChartSnapshot {
+}
+export interface WorkbookImageOp extends WorkbookImageSnapshot {
+}
+export interface WorkbookShapeOp extends WorkbookShapeSnapshot {
+}
+export interface WorkbookMergeRangeOp extends WorkbookMergeRangeSnapshot {
+}
+export interface WorkbookPivotOp extends WorkbookPivotSnapshot {
+    source: CellRangeRef;
+}
+export type WorkbookOp = {
+    kind: 'upsertWorkbook';
+    name: string;
+} | {
+    kind: 'setWorkbookMetadata';
+    key: string;
+    value: LiteralInput;
+} | {
+    kind: 'setCalculationSettings';
+    settings: WorkbookCalculationSettingsSnapshot;
+} | {
+    kind: 'setVolatileContext';
+    context: WorkbookVolatileContextSnapshot;
+} | {
+    kind: 'upsertSheet';
+    name: string;
+    order: number;
+    id?: number;
+} | {
+    kind: 'renameSheet';
+    oldName: string;
+    newName: string;
+} | {
+    kind: 'deleteSheet';
+    name: string;
+} | {
+    kind: 'insertRows';
+    sheetName: string;
+    start: number;
+    count: number;
+    entries?: WorkbookAxisEntryOp[];
+} | {
+    kind: 'deleteRows';
+    sheetName: string;
+    start: number;
+    count: number;
+} | {
+    kind: 'moveRows';
+    sheetName: string;
+    start: number;
+    count: number;
+    target: number;
+} | {
+    kind: 'insertColumns';
+    sheetName: string;
+    start: number;
+    count: number;
+    entries?: WorkbookAxisEntryOp[];
+} | {
+    kind: 'deleteColumns';
+    sheetName: string;
+    start: number;
+    count: number;
+} | {
+    kind: 'moveColumns';
+    sheetName: string;
+    start: number;
+    count: number;
+    target: number;
+} | {
+    kind: 'updateRowMetadata';
+    sheetName: string;
+    start: number;
+    count: number;
+    size: number | null;
+    hidden: boolean | null;
+} | {
+    kind: 'updateColumnMetadata';
+    sheetName: string;
+    start: number;
+    count: number;
+    size: number | null;
+    hidden: boolean | null;
+} | {
+    kind: 'setFreezePane';
+    sheetName: string;
+    rows: number;
+    cols: number;
+} | {
+    kind: 'clearFreezePane';
+    sheetName: string;
+} | {
+    kind: 'mergeCells';
+    range: WorkbookMergeRangeOp;
+} | {
+    kind: 'unmergeCells';
+    range: CellRangeRef;
+} | {
+    kind: 'setSheetProtection';
+    protection: WorkbookSheetProtectionOp;
+} | {
+    kind: 'clearSheetProtection';
+    sheetName: string;
+} | {
+    kind: 'setFilter';
+    sheetName: string;
+    range: WorkbookAutoFilterSnapshot;
+} | {
+    kind: 'clearFilter';
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: 'setSort';
+    sheetName: string;
+    range: CellRangeRef;
+    keys: WorkbookSortKey[];
+} | {
+    kind: 'clearSort';
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: 'setDataValidation';
+    validation: WorkbookDataValidationOp;
+} | {
+    kind: 'clearDataValidation';
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: 'upsertConditionalFormat';
+    format: WorkbookConditionalFormatOp;
+} | {
+    kind: 'deleteConditionalFormat';
+    id: string;
+    sheetName: string;
+} | {
+    kind: 'upsertRangeProtection';
+    protection: WorkbookRangeProtectionOp;
+} | {
+    kind: 'deleteRangeProtection';
+    id: string;
+    sheetName: string;
+} | {
+    kind: 'upsertCommentThread';
+    thread: WorkbookCommentThreadOp;
+} | {
+    kind: 'deleteCommentThread';
+    sheetName: string;
+    address: string;
+} | {
+    kind: 'upsertNote';
+    note: WorkbookNoteOp;
+} | {
+    kind: 'deleteNote';
+    sheetName: string;
+    address: string;
+} | {
+    kind: 'setCellValue';
+    sheetName: string;
+    address: string;
+    value: LiteralInput;
+    authoredBlank?: boolean;
+} | {
+    kind: 'setCellFormula';
+    sheetName: string;
+    address: string;
+    formula: string;
+} | {
+    kind: 'setCellFormat';
+    sheetName: string;
+    address: string;
+    format: string | null;
+} | {
+    kind: 'upsertCellStyle';
+    style: WorkbookCellStyleOp;
+} | {
+    kind: 'upsertCellNumberFormat';
+    format: WorkbookCellNumberFormatOp;
+} | {
+    kind: 'setStyleRange';
+    range: CellRangeRef;
+    styleId: string;
+} | {
+    kind: 'setFormatRange';
+    range: CellRangeRef;
+    formatId: string;
+} | {
+    kind: 'clearCell';
+    sheetName: string;
+    address: string;
+} | {
+    kind: 'upsertDefinedName';
+    name: string;
+    value: WorkbookDefinedNameValueSnapshot;
+} | {
+    kind: 'deleteDefinedName';
+    name: string;
+} | {
+    kind: 'upsertTable';
+    table: WorkbookTableOp;
+} | {
+    kind: 'deleteTable';
+    name: string;
+} | {
+    kind: 'upsertSpillRange';
+    sheetName: string;
+    address: string;
+    rows: number;
+    cols: number;
+} | {
+    kind: 'deleteSpillRange';
+    sheetName: string;
+    address: string;
+} | ({
+    kind: 'upsertPivotTable';
+} & WorkbookPivotOp) | {
+    kind: 'deletePivotTable';
+    sheetName: string;
+    address: string;
+} | {
+    kind: 'upsertChart';
+    chart: WorkbookChartOp;
+} | {
+    kind: 'deleteChart';
+    id: string;
+} | {
+    kind: 'upsertImage';
+    image: WorkbookImageOp;
+} | {
+    kind: 'deleteImage';
+    id: string;
+} | {
+    kind: 'upsertShape';
+    shape: WorkbookShapeOp;
+} | {
+    kind: 'deleteShape';
+    id: string;
+};
+export type EngineOp = WorkbookOp;
+export interface WorkbookOpBatch {
+    id: OpId;
+    replicaId: ReplicaId;
+    clock: Clock;
+    ops: WorkbookOp[];
+}
+export type EngineOpBatch = WorkbookOpBatch;
+export interface WorkbookTxn {
+    ops: WorkbookOp[];
+    potentialNewCells?: number;
+}

package/dist/ops.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ops.js.map

package/dist/ops.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ops.js","sourceRoot":"","sources":["../src/ops.ts"],"names":[],"mappings":""}

package/dist/readback.d.ts

@@ -0,0 +1,35 @@
+import type { LiteralInput } from '@bilig/protocol';
+import type { WorkbookRef } from './find.js';
+import type { WorkbookCheckResult } from './result.js';
+export interface WorkbookRunReadback {
+    readonly target: WorkbookRef;
+    readonly value?: LiteralInput;
+    readonly formula?: string | null;
+    readonly values?: readonly (readonly LiteralInput[])[];
+    readonly formulas?: readonly (readonly (string | null)[])[];
+    readonly cells?: readonly WorkbookCellReadback[];
+}
+export interface WorkbookCellReadback {
+    readonly sheetName: string;
+    readonly address: string;
+    readonly value?: LiteralInput;
+    readonly formula?: string | null;
+}
+export type WorkbookReadbackIssueCode = 'readback_missing' | 'duplicate_readback' | 'value_mismatch' | 'values_mismatch' | 'formula_mismatch' | 'formulas_mismatch';
+export declare const workbookReadbackIssueCodes: readonly ("readback_missing" | "duplicate_readback" | "value_mismatch" | "values_mismatch" | "formula_mismatch" | "formulas_mismatch")[];
+export declare function isWorkbookReadbackIssueCode(value: unknown): value is WorkbookReadbackIssueCode;
+export interface WorkbookReadbackIssue {
+    readonly code: WorkbookReadbackIssueCode;
+    readonly message: string;
+    readonly path?: string;
+    readonly check: WorkbookCheckResult;
+    readonly target?: WorkbookRef;
+    readonly expected?: LiteralInput | readonly (readonly LiteralInput[])[] | readonly (readonly (string | null)[])[];
+    readonly actual?: LiteralInput | readonly (readonly LiteralInput[])[] | readonly (readonly (string | null)[])[];
+}
+export interface WorkbookReadbackVerification {
+    readonly status: 'passed' | 'failed';
+    readonly checks: readonly WorkbookCheckResult[];
+    readonly issues: readonly WorkbookReadbackIssue[];
+}
+export declare function verifyWorkbookReadbacks(checks: readonly WorkbookCheckResult[], readbacks: readonly WorkbookRunReadback[]): WorkbookReadbackVerification;