@bilig/workbook-domain 0.1.0

package/LICENSE

@@ -0,0 +1 @@
+MIT

package/README.md

@@ -0,0 +1,13 @@
+# @bilig/workbook-domain
+
+Transport-neutral workbook mutation language and batch types for bilig.
+
+Use this package for workbook semantic types that should not depend on a transport,
+runtime, or replica-state implementation, including:
+
+- `WorkbookOp`
+- `WorkbookTxn`
+- `EngineOp`
+- `EngineOpBatch`
+
+Replica-state bookkeeping lives inside `@bilig/core`.

package/dist/guards.d.ts

@@ -0,0 +1,4 @@
+export declare function isWorkbookOp(value: unknown): value is import("./index.js").WorkbookOp;
+export declare function isEngineOp(value: unknown): value is import("./index.js").EngineOp;
+export declare function isEngineOps(value: unknown): value is import("./index.js").EngineOp[];
+export declare function isEngineOpBatch(value: unknown): value is import("./index.js").EngineOpBatch;

package/dist/guards.js

@@ -0,0 +1,293 @@
+import { isCellRangeRef, isLiteralInput } from "@bilig/protocol";
+const HORIZONTAL_ALIGNMENT_VALUES = new Set(["general", "left", "center", "right"]);
+const VERTICAL_ALIGNMENT_VALUES = new Set(["top", "middle", "bottom"]);
+const BORDER_STYLE_VALUES = new Set(["solid", "dashed", "dotted", "double"]);
+const BORDER_WEIGHT_VALUES = new Set(["thin", "medium", "thick"]);
+const NUMBER_FORMAT_KIND_VALUES = new Set([
+    "general",
+    "number",
+    "currency",
+    "accounting",
+    "percent",
+    "date",
+    "time",
+    "datetime",
+    "text",
+]);
+const COMPATIBILITY_MODE_VALUES = new Set(["excel-modern", "odf-1.4"]);
+const SORT_DIRECTION_VALUES = new Set(["asc", "desc"]);
+const PIVOT_AGGREGATION_VALUES = new Set(["sum", "count"]);
+function isRecord(value) {
+    return typeof value === "object" && value !== null;
+}
+function isFiniteNumber(value) {
+    return typeof value === "number" && Number.isFinite(value);
+}
+function isStringArray(value) {
+    return Array.isArray(value) && value.every((entry) => typeof entry === "string");
+}
+function isOptionalString(value) {
+    return value === undefined || typeof value === "string";
+}
+function isOptionalNumber(value) {
+    return value === undefined || isFiniteNumber(value);
+}
+function isOptionalNullableNumber(value) {
+    return value === undefined || value === null || isFiniteNumber(value);
+}
+function isOptionalBoolean(value) {
+    return value === undefined || typeof value === "boolean";
+}
+function isOptionalNullableBoolean(value) {
+    return value === undefined || value === null || typeof value === "boolean";
+}
+function hasString(value, key) {
+    return typeof value[key] === "string";
+}
+function hasFiniteNumber(value, key) {
+    return isFiniteNumber(value[key]);
+}
+function isWorkbookAxisEntry(value) {
+    return (isRecord(value) &&
+        hasString(value, "id") &&
+        hasFiniteNumber(value, "index") &&
+        isOptionalNullableNumber(value["size"]) &&
+        isOptionalNullableBoolean(value["hidden"]));
+}
+function isCellBorderSide(value) {
+    return (isRecord(value) &&
+        hasString(value, "color") &&
+        typeof value["style"] === "string" &&
+        BORDER_STYLE_VALUES.has(value["style"]) &&
+        typeof value["weight"] === "string" &&
+        BORDER_WEIGHT_VALUES.has(value["weight"]));
+}
+function isCellStyleRecord(value) {
+    if (!isRecord(value) || !hasString(value, "id")) {
+        return false;
+    }
+    const fill = value["fill"];
+    if (fill !== undefined && (!isRecord(fill) || typeof fill["backgroundColor"] !== "string")) {
+        return false;
+    }
+    const font = value["font"];
+    if (font !== undefined &&
+        (!isRecord(font) ||
+            !isOptionalString(font["family"]) ||
+            !isOptionalNumber(font["size"]) ||
+            !isOptionalBoolean(font["bold"]) ||
+            !isOptionalBoolean(font["italic"]) ||
+            !isOptionalBoolean(font["underline"]) ||
+            !isOptionalString(font["color"]))) {
+        return false;
+    }
+    const alignment = value["alignment"];
+    if (alignment !== undefined &&
+        (!isRecord(alignment) ||
+            !(alignment["horizontal"] === undefined ||
+                (typeof alignment["horizontal"] === "string" &&
+                    HORIZONTAL_ALIGNMENT_VALUES.has(alignment["horizontal"]))) ||
+            !(alignment["vertical"] === undefined ||
+                (typeof alignment["vertical"] === "string" &&
+                    VERTICAL_ALIGNMENT_VALUES.has(alignment["vertical"]))) ||
+            !isOptionalBoolean(alignment["wrap"]) ||
+            !isOptionalNumber(alignment["indent"]))) {
+        return false;
+    }
+    const borders = value["borders"];
+    if (borders !== undefined &&
+        (!isRecord(borders) ||
+            !(borders["top"] === undefined || isCellBorderSide(borders["top"])) ||
+            !(borders["right"] === undefined || isCellBorderSide(borders["right"])) ||
+            !(borders["bottom"] === undefined || isCellBorderSide(borders["bottom"])) ||
+            !(borders["left"] === undefined || isCellBorderSide(borders["left"])))) {
+        return false;
+    }
+    return true;
+}
+function isCellNumberFormatRecord(value) {
+    return (isRecord(value) &&
+        hasString(value, "id") &&
+        hasString(value, "code") &&
+        typeof value["kind"] === "string" &&
+        NUMBER_FORMAT_KIND_VALUES.has(value["kind"]));
+}
+function isWorkbookCalculationSettings(value) {
+    return (isRecord(value) &&
+        (value["mode"] === "automatic" || value["mode"] === "manual") &&
+        (value["compatibilityMode"] === undefined ||
+            (typeof value["compatibilityMode"] === "string" &&
+                COMPATIBILITY_MODE_VALUES.has(value["compatibilityMode"]))));
+}
+function isWorkbookVolatileContext(value) {
+    return isRecord(value) && hasFiniteNumber(value, "recalcEpoch");
+}
+function isWorkbookSortKey(value) {
+    return (isRecord(value) &&
+        hasString(value, "keyAddress") &&
+        typeof value["direction"] === "string" &&
+        SORT_DIRECTION_VALUES.has(value["direction"]));
+}
+function isWorkbookDefinedNameValue(value) {
+    if (isLiteralInput(value)) {
+        return true;
+    }
+    if (!isRecord(value) || typeof value["kind"] !== "string") {
+        return false;
+    }
+    switch (value["kind"]) {
+        case "scalar":
+            return isLiteralInput(value["value"]);
+        case "cell-ref":
+            return hasString(value, "sheetName") && hasString(value, "address");
+        case "range-ref":
+            return isCellRangeRef(value);
+        case "structured-ref":
+            return hasString(value, "tableName") && hasString(value, "columnName");
+        case "formula":
+            return hasString(value, "formula");
+        default:
+            return false;
+    }
+}
+function isWorkbookTableOp(value) {
+    return (isRecord(value) &&
+        hasString(value, "name") &&
+        hasString(value, "sheetName") &&
+        hasString(value, "startAddress") &&
+        hasString(value, "endAddress") &&
+        isStringArray(value["columnNames"]) &&
+        typeof value["headerRow"] === "boolean" &&
+        typeof value["totalsRow"] === "boolean");
+}
+function isWorkbookPivotValue(value) {
+    return (isRecord(value) &&
+        hasString(value, "sourceColumn") &&
+        typeof value["summarizeBy"] === "string" &&
+        PIVOT_AGGREGATION_VALUES.has(value["summarizeBy"]) &&
+        isOptionalString(value["outputLabel"]));
+}
+export function isWorkbookOp(value) {
+    if (!isRecord(value) || typeof value["kind"] !== "string") {
+        return false;
+    }
+    switch (value["kind"]) {
+        case "upsertWorkbook":
+            return hasString(value, "name");
+        case "setWorkbookMetadata":
+            return hasString(value, "key") && isLiteralInput(value["value"]);
+        case "setCalculationSettings":
+            return isWorkbookCalculationSettings(value["settings"]);
+        case "setVolatileContext":
+            return isWorkbookVolatileContext(value["context"]);
+        case "upsertSheet":
+            return (hasString(value, "name") && hasFiniteNumber(value, "order") && isOptionalNumber(value["id"]));
+        case "renameSheet":
+            return hasString(value, "oldName") && hasString(value, "newName");
+        case "deleteSheet":
+            return hasString(value, "name");
+        case "insertRows":
+        case "insertColumns":
+            return (hasString(value, "sheetName") &&
+                hasFiniteNumber(value, "start") &&
+                hasFiniteNumber(value, "count") &&
+                (value["entries"] === undefined ||
+                    (Array.isArray(value["entries"]) &&
+                        value["entries"].every((entry) => isWorkbookAxisEntry(entry)))));
+        case "deleteRows":
+        case "deleteColumns":
+            return (hasString(value, "sheetName") &&
+                hasFiniteNumber(value, "start") &&
+                hasFiniteNumber(value, "count"));
+        case "moveRows":
+        case "moveColumns":
+            return (hasString(value, "sheetName") &&
+                hasFiniteNumber(value, "start") &&
+                hasFiniteNumber(value, "count") &&
+                hasFiniteNumber(value, "target"));
+        case "updateRowMetadata":
+        case "updateColumnMetadata":
+            return (hasString(value, "sheetName") &&
+                hasFiniteNumber(value, "start") &&
+                hasFiniteNumber(value, "count") &&
+                isOptionalNullableNumber(value["size"]) &&
+                isOptionalNullableBoolean(value["hidden"]));
+        case "setFreezePane":
+            return (hasString(value, "sheetName") &&
+                hasFiniteNumber(value, "rows") &&
+                hasFiniteNumber(value, "cols"));
+        case "clearFreezePane":
+            return hasString(value, "sheetName");
+        case "setFilter":
+        case "clearFilter":
+        case "clearSort":
+            return hasString(value, "sheetName") && isCellRangeRef(value["range"]);
+        case "setSort":
+            return (hasString(value, "sheetName") &&
+                isCellRangeRef(value["range"]) &&
+                Array.isArray(value["keys"]) &&
+                value["keys"].every((entry) => isWorkbookSortKey(entry)));
+        case "setCellValue":
+            return (hasString(value, "sheetName") &&
+                hasString(value, "address") &&
+                isLiteralInput(value["value"]));
+        case "setCellFormula":
+            return (hasString(value, "sheetName") && hasString(value, "address") && hasString(value, "formula"));
+        case "setCellFormat":
+            return (hasString(value, "sheetName") &&
+                hasString(value, "address") &&
+                (value["format"] === null || typeof value["format"] === "string"));
+        case "upsertCellStyle":
+            return isCellStyleRecord(value["style"]);
+        case "upsertCellNumberFormat":
+            return isCellNumberFormatRecord(value["format"]);
+        case "setStyleRange":
+            return isCellRangeRef(value["range"]) && hasString(value, "styleId");
+        case "setFormatRange":
+            return isCellRangeRef(value["range"]) && hasString(value, "formatId");
+        case "clearCell":
+            return hasString(value, "sheetName") && hasString(value, "address");
+        case "upsertDefinedName":
+            return hasString(value, "name") && isWorkbookDefinedNameValue(value["value"]);
+        case "deleteDefinedName":
+        case "deleteTable":
+            return hasString(value, "name");
+        case "upsertTable":
+            return isWorkbookTableOp(value["table"]);
+        case "upsertSpillRange":
+            return (hasString(value, "sheetName") &&
+                hasString(value, "address") &&
+                hasFiniteNumber(value, "rows") &&
+                hasFiniteNumber(value, "cols"));
+        case "deleteSpillRange":
+        case "deletePivotTable":
+            return hasString(value, "sheetName") && hasString(value, "address");
+        case "upsertPivotTable":
+            return (hasString(value, "name") &&
+                hasString(value, "sheetName") &&
+                hasString(value, "address") &&
+                isCellRangeRef(value["source"]) &&
+                isStringArray(value["groupBy"]) &&
+                Array.isArray(value["values"]) &&
+                value["values"].every((entry) => isWorkbookPivotValue(entry)) &&
+                hasFiniteNumber(value, "rows") &&
+                hasFiniteNumber(value, "cols"));
+        default:
+            return false;
+    }
+}
+export function isEngineOp(value) {
+    return isWorkbookOp(value);
+}
+export function isEngineOps(value) {
+    return Array.isArray(value) && value.every((entry) => isEngineOp(entry));
+}
+export function isEngineOpBatch(value) {
+    return (isRecord(value) &&
+        hasString(value, "id") &&
+        hasString(value, "replicaId") &&
+        isRecord(value["clock"]) &&
+        hasFiniteNumber(value["clock"], "counter") &&
+        isEngineOps(value["ops"]));
+}
+//# sourceMappingURL=guards.js.map

package/dist/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjE,MAAM,2BAA2B,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACpF,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AACvE,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC7E,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AAClE,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC;IACxC,SAAS;IACT,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,SAAS;IACT,MAAM;IACN,MAAM;IACN,UAAU;IACV,MAAM;CACP,CAAC,CAAC;AACH,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AACvD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAE3D,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC1D,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc;IAC9C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC3D,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAc;IAC/C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC;AAED,SAAS,SAAS,CAAC,KAA8B,EAAE,GAAW;IAC5D,OAAO,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CAAC,KAA8B,EAAE,GAAW;IAClE,OAAO,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC;QACtB,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;QAC/B,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,yBAAyB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC;QACzB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,QAAQ;QAClC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ;QACnC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAC1C,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC3F,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,IACE,IAAI,KAAK,SAAS;QAClB,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YACd,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/B,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClC,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACrC,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EACnC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;IACrC,IACE,SAAS,KAAK,SAAS;QACvB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;YACnB,CAAC,CACC,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS;gBACrC,CAAC,OAAO,SAAS,CAAC,YAAY,CAAC,KAAK,QAAQ;oBAC1C,2BAA2B,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAC5D;YACD,CAAC,CACC,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS;gBACnC,CAAC,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,QAAQ;oBACxC,yBAAyB,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CACxD;YACD,CAAC,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACrC,CAAC,gBAAgB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EACzC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,IACE,OAAO,KAAK,SAAS;QACrB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;YACjB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YACnE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YACvE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YACzE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACxE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc;IAC9C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC;QACtB,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;QACxB,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ;QACjC,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAC7C,CAAC;AACJ,CAAC;AAED,SAAS,6BAA6B,CAAC,KAAc;IACnD,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;QAC7D,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,SAAS;YACvC,CAAC,OAAO,KAAK,CAAC,mBAAmB,CAAC,KAAK,QAAQ;gBAC7C,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAc;IAC/C,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC;QAC9B,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,QAAQ;QACtC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAC9C,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,KAAc;IAChD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACxC,KAAK,UAAU;YACb,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACtE,KAAK,WAAW;YACd,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,gBAAgB;YACnB,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACzE,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACrC;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;QAC7B,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC;QAChC,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC;QAC9B,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS;QACvC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS,CACxC,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC;QAChC,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,QAAQ;QACxC,wBAAwB,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClD,gBAAgB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CACvC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,KAAK,gBAAgB;YACnB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClC,KAAK,qBAAqB;YACxB,OAAO,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,KAAK,wBAAwB;YAC3B,OAAO,6BAA6B,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QAC1D,KAAK,oBAAoB;YACvB,OAAO,yBAAyB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACrD,KAAK,aAAa;YAChB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAC7F,CAAC;QACJ,KAAK,aAAa;YAChB,OAAO,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACpE,KAAK,aAAa;YAChB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClC,KAAK,YAAY,CAAC;QAClB,KAAK,eAAe;YAClB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS;oBAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;wBAC9B,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACpE,CAAC;QACJ,KAAK,YAAY,CAAC;QAClB,KAAK,eAAe;YAClB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAChC,CAAC;QACJ,KAAK,UAAU,CAAC;QAChB,KAAK,aAAa;YAChB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CACjC,CAAC;QACJ,KAAK,mBAAmB,CAAC;QACzB,KAAK,sBAAsB;YACzB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC/B,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACvC,yBAAyB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAC3C,CAAC;QACJ,KAAK,eAAe;YAClB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC;gBAC9B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAC/B,CAAC;QACJ,KAAK,iBAAiB;YACpB,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACvC,KAAK,WAAW,CAAC;QACjB,KAAK,aAAa,CAAC;QACnB,KAAK,WAAW;YACd,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,KAAK,SAAS;YACZ,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC9B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC5B,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CACzD,CAAC;QACJ,KAAK,cAAc;YACjB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAC3B,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAC/B,CAAC;QACJ,KAAK,gBAAgB;YACnB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAC5F,CAAC;QACJ,KAAK,eAAe;YAClB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAC3B,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAClE,CAAC;QACJ,KAAK,iBAAiB;YACpB,OAAO,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3C,KAAK,wBAAwB;YAC3B,OAAO,wBAAwB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,KAAK,eAAe;YAClB,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACvE,KAAK,gBAAgB;YACnB,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACxE,KAAK,WAAW;YACd,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACtE,KAAK,mBAAmB;YACtB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,0BAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,KAAK,mBAAmB,CAAC;QACzB,KAAK,aAAa;YAChB,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClC,KAAK,aAAa;YAChB,OAAO,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3C,KAAK,kBAAkB;YACrB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAC3B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC;gBAC9B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAC/B,CAAC;QACJ,KAAK,kBAAkB,CAAC;QACxB,KAAK,kBAAkB;YACrB,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACtE,KAAK,kBAAkB;YACrB,OAAO,CACL,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;gBACxB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;gBAC7B,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC;gBAC3B,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC/B,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC/B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC9B,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC7D,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC;gBAC9B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAC/B,CAAC;QACJ;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC;QACtB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxB,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;QAC1C,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAC1B,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,209 @@
+export * from "./guards.js";
+import type { CellRangeRef, CellNumberFormatRecord, CellStyleRecord, LiteralInput, WorkbookAxisEntrySnapshot, WorkbookCalculationSettingsSnapshot, WorkbookDefinedNameValueSnapshot, WorkbookPivotValueSnapshot, 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 {
+    name: string;
+    sheetName: string;
+    startAddress: string;
+    endAddress: string;
+    columnNames: string[];
+    headerRow: boolean;
+    totalsRow: boolean;
+}
+export interface WorkbookSortKey {
+    keyAddress: string;
+    direction: WorkbookSortDirection;
+}
+export interface WorkbookAxisEntryOp extends WorkbookAxisEntrySnapshot {
+}
+export interface WorkbookCellStyleOp extends CellStyleRecord {
+}
+export interface WorkbookCellNumberFormatOp extends CellNumberFormatRecord {
+}
+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: "setFilter";
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: "clearFilter";
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: "setSort";
+    sheetName: string;
+    range: CellRangeRef;
+    keys: WorkbookSortKey[];
+} | {
+    kind: "clearSort";
+    sheetName: string;
+    range: CellRangeRef;
+} | {
+    kind: "setCellValue";
+    sheetName: string;
+    address: string;
+    value: LiteralInput;
+} | {
+    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";
+    name: string;
+    sheetName: string;
+    address: string;
+    source: CellRangeRef;
+    groupBy: string[];
+    values: WorkbookPivotValueSnapshot[];
+    rows: number;
+    cols: number;
+} | {
+    kind: "deletePivotTable";
+    sheetName: string;
+    address: 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/index.js

@@ -0,0 +1,2 @@
+export * from "./guards.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@bilig/workbook-domain",
+  "version": "0.1.0",
+  "description": "Transport-neutral workbook domain ops and batch types for bilig.",
+  "keywords": [
+    "bilig",
+    "domain",
+    "spreadsheet",
+    "workbook"
+  ],
+  "homepage": "https://github.com/proompteng/bilig/tree/main/packages/workbook-domain#readme",
+  "bugs": {
+    "url": "https://github.com/proompteng/bilig/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/proompteng/bilig.git",
+    "directory": "packages/workbook-domain"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bilig/protocol": "0.1.0"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}