@rowsncolumns/toolkit 24.5.17 → 24.5.19

package/dist/cjs/excel-parser/plugins/xlsb/rgce-parser.d.ts

@@ -1,18 +1,52 @@
 /**
- * Parse Rgce (Reverse Polish Notation Compiled Expression) - binary formula format in XLSB
- * This converts binary Ptg (Parsed Token) tokens into a formula string
+ * Decoder for a BIFF12 formula's token stream (`rgce`, [MS-XLSB] 2.2.2 / 2.5.97.88):
+ * reverse-Polish tokens rebuilt into the formula's text.
  *
- * @param rgceBytes - The binary formula data
- * @returns The formula string (without leading "=")
+ * Strict by design: a formula decodes completely or not at all. A token it
+ * does not know, a function outside the table, a read past the end of the
+ * stream or a stack that does not end with exactly one expression throws
+ * {@link RgceUnsupportedError}, and the caller keeps the cell's cached value
+ * instead of writing a formula that computes something else.
  */
+/** The formula cannot be decoded exactly; keep the cell's cached value. */
+export declare class RgceUnsupportedError extends Error {
+    constructor(message: string);
+}
+export type RgceContext = {
+    /** The sheet an XTI index names (`PtgRef3d`/`PtgArea3d`); `undefined` when unknown. */
+    sheetName?: (ixti: number) => string | undefined;
+    /**
+     * The name a 1-based `PtgName` index refers to, already qualified with its
+     * sheet when the formula's sheet must say which one (`Sheet2!Local`).
+     */
+    definedName?: (index: number) => string | undefined;
+    /** The cell relative references (`PtgRefN`/`PtgAreaN`) are relative to, 1-based. */
+    baseCell?: {
+        row: number;
+        col: number;
+    };
+};
 /**
- * Parse Rgce with sheet names for cross-sheet references
- * @param rgceBytes - The binary formula data
- * @param sheetNames - Array of sheet names for resolving external references
- * @returns The formula string (without leading "=")
+ * A sheet name as a reference prefix: quoted unless it is a plain ASCII
+ * identifier no reader could take for a cell (`A1`, `R1C1`, `R`) or a
+ * boolean. Quoting is always valid, so anything else is quoted.
+ */
+export declare const quoteSheetName: (name: string) => string;
+/**
+ * Decode a formula's tokens into its text, without the leading `=`.
+ *
+ * Throws {@link RgceUnsupportedError} when any part of the formula cannot be
+ * decoded exactly.
+ */
+export declare function decodeRgce(rgce: Uint8Array, context?: RgceContext): string;
+/**
+ * A formula's text, or `""` when it cannot be decoded exactly — never a part of
+ * one. Prefer {@link decodeRgce}, which says why.
+ *
+ * @deprecated the lenient form of {@link decodeRgce}.
  */
 export declare function parseRgce(rgceBytes: Uint8Array, sheetRefResolver?: string[] | ((ixti: number) => string | undefined), baseCell?: {
     row: number;
     col: number;
-}, debug?: boolean): string;
+}): string;
 //# sourceMappingURL=rgce-parser.d.ts.map

package/dist/cjs/excel-parser/plugins/xlsb/rgce-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rgce-parser.d.ts","sourceRoot":"","sources":["../../../../../excel-parser/plugins/xlsb/rgce-parser.ts"],"names":[],"mappings":"AAuHA;;;;;;GAMG;AACH;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,SAAS,EAAE,UAAU,EACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC,EACpE,QAAQ,CAAC,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EACvC,KAAK,UAAQ,GACZ,MAAM,CAqaR"}
+{"version":3,"file":"rgce-parser.d.ts","sourceRoot":"","sources":["../../../../../excel-parser/plugins/xlsb/rgce-parser.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AAEH,2EAA2E;AAC3E,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAI5B;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,uFAAuF;IACvF,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IACjD;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IACpD,oFAAoF;IACpF,QAAQ,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACzC,CAAC;AA+FF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,MAMT,CAAC;AA2DtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,WAAgB,GAAG,MAAM,CAoR9E;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,SAAS,EAAE,UAAU,EACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC,EACpE,QAAQ,CAAC,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACtC,MAAM,CAYR"}