bilig-workpaper 0.161.0 → 0.164.1

package/dist/xlsx-recalc-targets.js

@@ -0,0 +1,89 @@
+export function parseQualifiedCellTarget(workbook, target) {
+    const parsed = parseQualifiedA1(target);
+    const sheet = workbook.getSheetId(parsed.sheetName);
+    if (sheet === undefined) {
+        throw new Error(`Unknown sheet in XLSX formula recalculation target: ${parsed.sheetName}`);
+    }
+    return {
+        sheet,
+        row: parsed.row,
+        col: parsed.col,
+    };
+}
+export function parseQualifiedA1(target) {
+    const trimmed = target.trim();
+    const separator = findSheetSeparator(trimmed);
+    if (separator <= 0 || separator >= trimmed.length - 1) {
+        throw new Error(`Expected a sheet-qualified A1 target such as Inputs!B2, received: ${target}`);
+    }
+    const sheetName = unquoteSheetName(trimmed.slice(0, separator));
+    const a1 = trimmed
+        .slice(separator + 1)
+        .replace(/\$/gu, '')
+        .toUpperCase();
+    const match = /^(?<col>[A-Z]+)(?<row>[1-9][0-9]*)$/u.exec(a1);
+    if (!match?.groups) {
+        throw new Error(`Expected a single A1 cell reference in target ${target}`);
+    }
+    const row = match.groups['row'];
+    const col = match.groups['col'];
+    if (!row || !col) {
+        throw new Error(`Expected a single A1 cell reference in target ${target}`);
+    }
+    return {
+        sheetName,
+        ...parseA1Parts(row, col),
+    };
+}
+export function parseA1CellReference(address) {
+    const match = /^\$?(?<col>[A-Z]+)\$?(?<row>[1-9][0-9]*)$/u.exec(address.trim().toUpperCase());
+    if (!match?.groups) {
+        throw new Error(`Expected a single A1 cell reference, received: ${address}`);
+    }
+    const row = match.groups['row'];
+    const col = match.groups['col'];
+    if (!row || !col) {
+        throw new Error(`Expected a single A1 cell reference, received: ${address}`);
+    }
+    return parseA1Parts(row, col);
+}
+function parseA1Parts(row, col) {
+    return {
+        row: Number.parseInt(row, 10) - 1,
+        col: columnLettersToIndex(col),
+    };
+}
+function findSheetSeparator(target) {
+    let inQuote = false;
+    for (let index = 0; index < target.length; index += 1) {
+        const char = target[index];
+        if (char === "'") {
+            if (inQuote && target[index + 1] === "'") {
+                index += 1;
+            }
+            else {
+                inQuote = !inQuote;
+            }
+            continue;
+        }
+        if (char === '!' && !inQuote) {
+            return index;
+        }
+    }
+    return -1;
+}
+function unquoteSheetName(rawSheetName) {
+    const trimmed = rawSheetName.trim();
+    if (trimmed.startsWith("'") && trimmed.endsWith("'")) {
+        return trimmed.slice(1, -1).replace(/''/gu, "'");
+    }
+    return trimmed;
+}
+function columnLettersToIndex(letters) {
+    let index = 0;
+    for (const char of letters) {
+        index = index * 26 + (char.charCodeAt(0) - 64);
+    }
+    return index - 1;
+}
+//# sourceMappingURL=xlsx-recalc-targets.js.map

package/dist/xlsx-recalc-targets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xlsx-recalc-targets.js","sourceRoot":"","sources":["../src/xlsx-recalc-targets.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,wBAAwB,CAAC,QAAkC,EAAE,MAAc;IACzF,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACvC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACnD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,MAAM,CAAC,SAAS,EAAE,CAAC,CAAA;IAC5F,CAAC;IACD,OAAO;QACL,KAAK;QACL,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,GAAG,EAAE,MAAM,CAAC,GAAG;KAChB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;IAC7B,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC7C,IAAI,SAAS,IAAI,CAAC,IAAI,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,qEAAqE,MAAM,EAAE,CAAC,CAAA;IAChG,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAA;IAC/D,MAAM,EAAE,GAAG,OAAO;SACf,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,WAAW,EAAE,CAAA;IAChB,MAAM,KAAK,GAAG,sCAAsC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC7D,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,iDAAiD,MAAM,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,iDAAiD,MAAM,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED,OAAO;QACL,SAAS;QACT,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC;KAC1B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAe;IAClD,MAAM,KAAK,GAAG,4CAA4C,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;IAC7F,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,OAAO,EAAE,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,kDAAkD,OAAO,EAAE,CAAC,CAAA;IAC9E,CAAC;IAED,OAAO,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAC/B,CAAC;AAED,SAAS,YAAY,CAAC,GAAW,EAAE,GAAW;IAC5C,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC;QACjC,GAAG,EAAE,oBAAoB,CAAC,GAAG,CAAC;KAC/B,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAc;IACxC,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;QAC1B,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,OAAO,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBACzC,KAAK,IAAI,CAAC,CAAA;YACZ,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,CAAC,OAAO,CAAA;YACpB,CAAC;YACD,SAAQ;QACV,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,CAAA;AACX,CAAC;AAED,SAAS,gBAAgB,CAAC,YAAoB;IAC5C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,CAAA;IACnC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACrD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClD,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,KAAK,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;IAChD,CAAC;IACD,OAAO,KAAK,GAAG,CAAC,CAAA;AAClB,CAAC"}

package/dist/xlsx-recalc.d.ts

@@ -0,0 +1,126 @@
+import { type RawCellContent, type WorkPaperChange } from '@bilig/headless';
+import { type CellValue, type LiteralInput, type CompatibilityMode, type WorkbookCalculationMode, type WorkbookDateSystem } from '@bilig/protocol';
+import { type ImportedWorkbookDiagnostics, type XlsxExternalWorkbookInput, type XlsxFormulaRecalcNativeDiagnostics } from '@bilig/xlsx';
+export { WorkPaper } from '@bilig/headless';
+export { exportXlsx, exportXlsxToFile, importXlsx } from '@bilig/headless/xlsx';
+export { parseQualifiedA1, parseQualifiedCellTarget } from './xlsx-recalc-targets.js';
+export type { XlsxExternalWorkbookInput, XlsxExternalWorkbookHydrationDiagnostics } from '@bilig/xlsx';
+export { type StreamingNativeFormulaCounts, type XlsxFormulaRecalcNativeDiagnostics, type XlsxFormulaRecalcPhaseRss, StreamingNativeXlsxRecalcError, } from '@bilig/xlsx';
+export { type StreamingNativeXlsxCacheFormulaInspection, type StreamingNativeXlsxCacheInspectionLimit, type StreamingNativeXlsxCacheInspectionResult, type StreamingNativeXlsxCacheLiteral, type StreamingNativeXlsxCacheStatus, type StreamingNativeXlsxCacheStatusSummary, inspectXlsxCacheFileStreamingNative, } from '@bilig/xlsx';
+export type XlsxFormulaRecalcCellValue = CellValue;
+export type XlsxFormulaRecalcChange = WorkPaperChange;
+export type XlsxFormulaRecalcDiagnostics = ImportedWorkbookDiagnostics & Partial<XlsxFormulaRecalcNativeDiagnostics>;
+export interface XlsxFormulaRecalcEdit {
+    readonly target: string;
+    readonly value: LiteralInput;
+}
+export type XlsxFormulaRecalcWorkPaperEngine = 'auto' | 'workpaper';
+export type XlsxFormulaRecalcWorkPaperFallbackPolicy = 'error' | 'workpaper';
+export interface XlsxFormulaRecalcWorkPaperConfig {
+    readonly calculationSettings?: {
+        readonly mode?: WorkbookCalculationMode;
+        readonly compatibilityMode?: CompatibilityMode;
+        readonly dateSystem?: WorkbookDateSystem;
+        readonly iterate?: boolean | null;
+        readonly iterateCount?: number | null;
+        readonly iterateDelta?: string | null;
+        readonly fullPrecision?: boolean | null;
+        readonly fullCalcOnLoad?: boolean | null;
+        readonly calcOnSave?: boolean | null;
+        readonly calcCompleted?: boolean | null;
+        readonly concurrentCalc?: boolean | null;
+    } | undefined;
+    readonly evaluationTimeoutMs?: number;
+    readonly maxRows?: number;
+    readonly maxColumns?: number;
+    readonly useColumnIndex?: boolean;
+    readonly [key: string]: unknown;
+}
+export interface XlsxFormulaRecalcOptions {
+    readonly fileName?: string;
+    readonly externalWorkbooks?: readonly XlsxExternalWorkbookInput[];
+    readonly edits?: readonly XlsxFormulaRecalcEdit[];
+    readonly reads?: readonly string[];
+    readonly config?: XlsxFormulaRecalcWorkPaperConfig;
+    readonly engine?: XlsxFormulaRecalcWorkPaperEngine;
+    readonly maxRssBytes?: number;
+    readonly fallbackPolicy?: XlsxFormulaRecalcWorkPaperFallbackPolicy;
+}
+export interface XlsxFormulaRecalcFileOptions extends XlsxFormulaRecalcOptions {
+    readonly outputPath: string;
+}
+export interface XlsxFormulaRecalcResult {
+    readonly xlsx: Uint8Array;
+    readonly warnings: readonly string[];
+    readonly sheetNames: readonly string[];
+    readonly reads: Readonly<Record<string, XlsxFormulaRecalcCellValue>>;
+    readonly changes: readonly XlsxFormulaRecalcChange[];
+    readonly diagnostics?: XlsxFormulaRecalcDiagnostics;
+}
+export interface XlsxFormulaRecalcFileResult {
+    readonly bytesWritten: number;
+    readonly warnings: readonly string[];
+    readonly sheetNames: readonly string[];
+    readonly reads: Readonly<Record<string, XlsxFormulaRecalcCellValue>>;
+    readonly changes: readonly XlsxFormulaRecalcChange[];
+    readonly diagnostics?: XlsxFormulaRecalcDiagnostics;
+}
+export type XlsxFormulaRecalcFileToFileEngine = 'auto' | 'streaming-native';
+export type XlsxFormulaRecalcFileToFileFallbackPolicy = 'error';
+export interface XlsxFormulaRecalcFileToFileOptions {
+    readonly outputPath: string;
+    readonly externalWorkbooks?: readonly XlsxExternalWorkbookInput[];
+    readonly edits?: readonly XlsxFormulaRecalcEdit[];
+    readonly reads?: readonly string[];
+    readonly engine?: XlsxFormulaRecalcFileToFileEngine;
+    readonly maxRssBytes?: number;
+    readonly fallbackPolicy?: XlsxFormulaRecalcFileToFileFallbackPolicy;
+}
+export declare function recalculateXlsx(input: Uint8Array | ArrayBuffer | Buffer, options?: XlsxFormulaRecalcOptions): XlsxFormulaRecalcResult;
+export declare function recalculateXlsxFileToFile(inputPath: string, options: XlsxFormulaRecalcFileToFileOptions): Promise<XlsxFormulaRecalcFileResult>;
+export declare function recalculateXlsxToFile(input: Uint8Array | ArrayBuffer | Buffer, options: XlsxFormulaRecalcFileOptions): XlsxFormulaRecalcFileResult;
+export declare const recalculateSheetjsWorkbook: typeof recalculateXlsx;
+export declare const xlsxCacheDoctorSchemaVersion = "xlsx-cache-doctor.v1";
+export type XlsxCacheInspectionLimit = number | 'all';
+export type XlsxCacheStatus = 'fresh' | 'stale' | 'missing-cache' | 'unsupported-recalculation';
+export interface XlsxCacheInspectionOptions {
+    readonly fileName?: string;
+    readonly externalWorkbooks?: readonly XlsxExternalWorkbookInput[];
+    readonly edits?: readonly XlsxFormulaRecalcEdit[];
+    readonly inspectLimit?: XlsxCacheInspectionLimit;
+    readonly config?: XlsxFormulaRecalcWorkPaperConfig;
+}
+export interface XlsxCacheStatusSummary {
+    readonly inspected: number;
+    readonly stale: number;
+    readonly fresh: number;
+    readonly missingCache: number;
+    readonly unsupportedRecalculation: number;
+}
+export interface XlsxCacheFormulaInspection {
+    readonly target: string;
+    readonly formula: string;
+    readonly cachedValue?: RawCellContent;
+    readonly recalculatedValue: XlsxFormulaRecalcCellValue | undefined;
+    readonly literalRecalculatedValue?: RawCellContent | string;
+    readonly cacheStatus: XlsxCacheStatus;
+    readonly staleCachedValue: boolean | null;
+}
+export interface XlsxCacheInspectionResult {
+    readonly schemaVersion: typeof xlsxCacheDoctorSchemaVersion;
+    readonly sheetNames: readonly string[];
+    readonly formulaCellCount: number;
+    readonly inspectedFormulaCellCount: number;
+    readonly uninspectedFormulaCellCount: number;
+    readonly inspectionLimit: XlsxCacheInspectionLimit;
+    readonly staleCachedFormulaCount: number;
+    readonly cacheStatusSummary: XlsxCacheStatusSummary;
+    readonly suggestedReads: readonly string[];
+    readonly formulas: readonly XlsxCacheFormulaInspection[];
+    readonly warnings: readonly string[];
+    readonly diagnostics?: ImportedWorkbookDiagnostics;
+    readonly inspectionCompleted: true;
+    readonly recalculationCompleted: true;
+    readonly excelParity: 'not_proven';
+}
+export declare function inspectXlsxCache(input: Uint8Array | ArrayBuffer | Buffer, options?: XlsxCacheInspectionOptions): XlsxCacheInspectionResult;