@shbernal/ts-xlsx 3.0.0 → 3.2.0

package/dist/core/{modern-functions.js → future-functions.js}

@@ -1,148 +1,179 @@
-export const MODERN_FUNCTIONS = new Set([
-    'FILTER',
-    'SORT',
-    'SORTBY',
-    'UNIQUE',
-    'SEQUENCE',
-    'RANDARRAY',
-    'XLOOKUP',
-    'XMATCH',
-    'LAMBDA',
-    'LET',
-    'BYROW',
-    'BYCOL',
-    'MAKEARRAY',
-    'MAP',
-    'REDUCE',
-    'SCAN',
-    'ISOMITTED',
-    'VSTACK',
-    'HSTACK',
-    'TOROW',
-    'TOCOL',
-    'WRAPROWS',
-    'WRAPCOLS',
-    'TAKE',
-    'DROP',
-    'EXPAND',
-    'CHOOSEROWS',
-    'CHOOSECOLS',
-    'TEXTJOIN',
-    'CONCAT',
-    'TEXTBEFORE',
-    'TEXTAFTER',
-    'TEXTSPLIT',
-    'ARRAYTOTEXT',
-    'VALUETOTEXT',
-    'IFS',
-    'SWITCH',
-    'MAXIFS',
-    'MINIFS',
-    'AGGREGATE',
+const WORKSHEET_ONLY_FUNCTIONS = ['FILTER', 'PY', 'SORT'];
+const SPECIFIED_FUNCTIONS = [
     'ACOT',
     'ACOTH',
-    'COT',
-    'COTH',
-    'CSC',
-    'CSCH',
-    'SEC',
-    'SECH',
+    'AGGREGATE',
     'ARABIC',
     'BASE',
-    'DECIMAL',
-    'COMBINA',
-    'PERMUTATIONA',
-    'GAMMA',
-    'GAUSS',
-    'PHI',
-    'MUNIT',
-    'BITAND',
-    'BITOR',
-    'BITXOR',
-    'BITLSHIFT',
-    'BITRSHIFT',
-    'IMCOSH',
-    'IMCOT',
-    'IMCSC',
-    'IMCSCH',
-    'IMSEC',
-    'IMSECH',
-    'IMSINH',
-    'IMTAN',
-    'DAYS',
-    'ISOWEEKNUM',
-    'IFNA',
-    'NUMBERVALUE',
-    'SHEET',
-    'SHEETS',
-    'FORMULATEXT',
-    'ISFORMULA',
-    'ENCODEURL',
-    'WEBSERVICE',
-    'FILTERXML',
-    'UNICHAR',
-    'UNICODE',
-    'XOR',
-    'PDURATION',
-    'RRI',
     'BETA.DIST',
     'BETA.INV',
     'BINOM.DIST',
     'BINOM.DIST.RANGE',
     'BINOM.INV',
+    'BITAND',
+    'BITLSHIFT',
+    'BITOR',
+    'BITRSHIFT',
+    'BITXOR',
+    'BYCOL',
+    'BYROW',
+    'CEILING.MATH',
+    'CEILING.PRECISE',
     'CHISQ.DIST',
     'CHISQ.DIST.RT',
     'CHISQ.INV',
     'CHISQ.INV.RT',
     'CHISQ.TEST',
+    'CHOOSECOLS',
+    'CHOOSEROWS',
+    'COMBINA',
+    'CONCAT',
     'CONFIDENCE.NORM',
     'CONFIDENCE.T',
+    'COT',
+    'COTH',
     'COVARIANCE.P',
     'COVARIANCE.S',
+    'CSC',
+    'CSCH',
+    'DAYS',
+    'DECIMAL',
+    'DROP',
+    'ERF.PRECISE',
+    'ERFC.PRECISE',
+    'EXPAND',
     'EXPON.DIST',
     'F.DIST',
     'F.DIST.RT',
     'F.INV',
     'F.INV.RT',
     'F.TEST',
+    'FIELDVALUE',
+    'FILTERXML',
+    'FLOOR.MATH',
+    'FLOOR.PRECISE',
+    'FORECAST.ETS',
+    'FORECAST.ETS.CONFINT',
+    'FORECAST.ETS.SEASONALITY',
+    'FORECAST.ETS.STAT',
+    'FORECAST.LINEAR',
+    'FORMULATEXT',
+    'GAMMA',
     'GAMMA.DIST',
     'GAMMA.INV',
     'GAMMALN.PRECISE',
+    'GAUSS',
+    'HSTACK',
     'HYPGEOM.DIST',
+    'IFNA',
+    'IFS',
+    'IMCOSH',
+    'IMCOT',
+    'IMCSC',
+    'IMCSCH',
+    'IMSEC',
+    'IMSECH',
+    'IMSINH',
+    'IMTAN',
+    'ISFORMULA',
+    'ISOMITTED',
+    'ISOWEEKNUM',
+    'LAMBDA',
+    'LET',
     'LOGNORM.DIST',
     'LOGNORM.INV',
+    'MAKEARRAY',
+    'MAP',
+    'MAXIFS',
+    'MINIFS',
     'MODE.MULT',
     'MODE.SNGL',
+    'MUNIT',
     'NEGBINOM.DIST',
     'NORM.DIST',
     'NORM.INV',
     'NORM.S.DIST',
     'NORM.S.INV',
+    'NUMBERVALUE',
+    'PDURATION',
     'PERCENTILE.EXC',
     'PERCENTILE.INC',
     'PERCENTRANK.EXC',
     'PERCENTRANK.INC',
+    'PERMUTATIONA',
+    'PHI',
     'POISSON.DIST',
+    'PQSOURCE',
+    'PYTHON_STR',
+    'PYTHON_TYPE',
+    'PYTHON_TYPENAME',
     'QUARTILE.EXC',
     'QUARTILE.INC',
+    'QUERYSTRING',
+    'RANDARRAY',
     'RANK.AVG',
     'RANK.EQ',
+    'REDUCE',
+    'RRI',
+    'SCAN',
+    'SEC',
+    'SECH',
+    'SEQUENCE',
+    'SHEET',
+    'SHEETS',
     'SKEW.P',
+    'SORTBY',
     'STDEV.P',
     'STDEV.S',
+    'SWITCH',
     'T.DIST',
     'T.DIST.2T',
     'T.DIST.RT',
     'T.INV',
     'T.INV.2T',
     'T.TEST',
+    'TAKE',
+    'TEXTAFTER',
+    'TEXTBEFORE',
+    'TEXTJOIN',
+    'TEXTSPLIT',
+    'TOCOL',
+    'TOROW',
+    'UNICHAR',
+    'UNICODE',
+    'UNIQUE',
     'VAR.P',
     'VAR.S',
+    'VSTACK',
+    'WEBSERVICE',
     'WEIBULL.DIST',
+    'WRAPCOLS',
+    'WRAPROWS',
+    'XLOOKUP',
+    'XOR',
     'Z.TEST',
-    'CEILING.PRECISE',
-    'FLOOR.PRECISE',
-    'ISO.CEILING',
-    'ERF.PRECISE',
-    'ERFC.PRECISE',
+];
+const OBSERVED_FUNCTIONS = [
+    'ANCHORARRAY',
+    'ARRAYTOTEXT',
+    'DETECTLANGUAGE',
+    'ENCODEURL',
+    'GROUPBY',
+    'IMAGE',
+    'PERCENTOF',
+    'PIVOTBY',
+    'REGEXEXTRACT',
+    'REGEXREPLACE',
+    'REGEXTEST',
+    'SINGLE',
+    'STOCKHISTORY',
+    'TRANSLATE',
+    'TRIMRANGE',
+    'VALUETOTEXT',
+    'XMATCH',
+];
+export const FUTURE_FUNCTION_PREFIXES = new Map([
+    ...WORKSHEET_ONLY_FUNCTIONS.map((name) => [name, '_xlfn._xlws.']),
+    ...SPECIFIED_FUNCTIONS.map((name) => [name, '_xlfn.']),
+    ...OBSERVED_FUNCTIONS.map((name) => [name, '_xlfn.']),
 ]);

package/dist/core/grid-edits.d.ts

@@ -2,11 +2,15 @@ import { type AutoFilter } from './autofilter.ts';
 import { Cell } from './cell.ts';
 import type { ConditionalFormattingOverlay } from './conditional-formatting-overlay.ts';
 import type { DataValidationOverlay } from './data-validation-overlay.ts';
+import { type SheetSplice } from './formula-references.ts';
+import type { HyperlinkOverlay } from './hyperlink.ts';
 import { type AnchoredImage } from './image.ts';
-import type { MergeRect } from './merge.ts';
+import type { PageBreak } from './page-setup.ts';
+import { type ParsedPivotTable, type PivotTable } from './pivot-table.ts';
 import type { Table } from './table.ts';
 import { type CellValue } from './value.ts';
 import type { WorksheetComments } from './worksheet-comments.ts';
+import type { WorksheetMerges } from './worksheet-merges.ts';
 import type { ColumnProperties, RowProperties } from './worksheet.ts';
 /**
  * The sheet's autofilter, reached as a slot rather than held by reference like the containers beside
@@ -20,13 +24,24 @@ interface GridStorage {
     readonly rows: Map<number, Map<number, Cell>>;
     readonly rowProperties: Map<number, RowProperties>;
     readonly columns: Map<number, ColumnProperties>;
-    readonly merges: string[];
-    readonly mergeRects: MergeRect[];
+    readonly merges: WorksheetMerges;
     readonly tables: Table[];
+    readonly pivotTables: readonly PivotTable[];
+    readonly loadedPivotTables: ParsedPivotTable[];
     readonly images: AnchoredImage[];
     readonly dataValidations: DataValidationOverlay;
     readonly conditionalFormattings: ConditionalFormattingOverlay;
+    readonly hyperlinks: HyperlinkOverlay;
+    /** The sheet's name, which an unqualified reference in one of its formulas means. */
+    readonly sheetName: () => string;
+    /**
+     * What moves the formulas outside this sheet that name it: every other sheet's, and the workbook's
+     * defined names. `undefined` for a sheet no workbook holds.
+     */
+    readonly formulaHost: () => ((edit: SheetSplice) => void) | undefined;
     readonly comments: WorksheetComments;
+    readonly rowBreaks: PageBreak[];
+    readonly columnBreaks: PageBreak[];
     readonly autoFilter: AutoFilterSlot;
 }
 export declare class GridEdits {
@@ -34,5 +49,17 @@ export declare class GridEdits {
     constructor(storage: GridStorage);
     spliceRows(start: number, count: number, inserted: Map<number, Cell>[]): void;
     spliceColumns(start: number, count: number, inserts: CellValue[][]): void;
+    /**
+     * Move the references this sheet's formulas make to the sheet a splice changed, which may be this
+     * sheet or another: every cell formula, and every data validation's and conditional format's formula.
+     *
+     * A shared formula is described once, by its master, and each clone is that text translated to where
+     * the clone sits. A splice usually keeps that true, since the master, the clone and what they refer to
+     * all move together, but not always: an insert between the cells one clone refers to and the cells its
+     * master does grows one reference and not the other, and a delete can take the master and leave the
+     * clone. A clone the moved master no longer describes stops sharing and becomes a formula of its own,
+     * spelled as it was rewritten; the rest of the group keeps sharing.
+     */
+    spliceFormulas(edit: SheetSplice): void;
 }
 export {};