@alienkarma/exceljs 4.4.0-fork.1

package/dist/es5/doc/enums.js

@@ -0,0 +1,49 @@
+'use strict';
+
+module.exports = {
+  ValueType: {
+    Null: 0,
+    Merge: 1,
+    Number: 2,
+    String: 3,
+    Date: 4,
+    Hyperlink: 5,
+    Formula: 6,
+    SharedString: 7,
+    RichText: 8,
+    Boolean: 9,
+    Error: 10
+  },
+  FormulaType: {
+    None: 0,
+    Master: 1,
+    Shared: 2
+  },
+  RelationshipType: {
+    None: 0,
+    OfficeDocument: 1,
+    Worksheet: 2,
+    CalcChain: 3,
+    SharedStrings: 4,
+    Styles: 5,
+    Theme: 6,
+    Hyperlink: 7
+  },
+  DocumentType: {
+    Xlsx: 1
+  },
+  ReadingOrder: {
+    LeftToRight: 1,
+    RightToLeft: 2
+  },
+  ErrorValue: {
+    NotApplicable: '#N/A',
+    Ref: '#REF!',
+    Name: '#NAME?',
+    DivZero: '#DIV/0!',
+    Null: '#NULL!',
+    Value: '#VALUE!',
+    Num: '#NUM!'
+  }
+};
+//# sourceMappingURL=enums.js.map

package/dist/es5/doc/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","names":["module","exports","ValueType","Null","Merge","Number","String","Date","Hyperlink","Formula","SharedString","RichText","Boolean","Error","FormulaType","None","Master","Shared","RelationshipType","OfficeDocument","Worksheet","CalcChain","SharedStrings","Styles","Theme","DocumentType","Xlsx","ReadingOrder","LeftToRight","RightToLeft","ErrorValue","NotApplicable","Ref","Name","DivZero","Value","Num"],"sources":["../../../lib/doc/enums.js"],"sourcesContent":["'use strict';\r\n\r\nmodule.exports = {\r\n  ValueType: {\r\n    Null: 0,\r\n    Merge: 1,\r\n    Number: 2,\r\n    String: 3,\r\n    Date: 4,\r\n    Hyperlink: 5,\r\n    Formula: 6,\r\n    SharedString: 7,\r\n    RichText: 8,\r\n    Boolean: 9,\r\n    Error: 10,\r\n  },\r\n  FormulaType: {\r\n    None: 0,\r\n    Master: 1,\r\n    Shared: 2,\r\n  },\r\n  RelationshipType: {\r\n    None: 0,\r\n    OfficeDocument: 1,\r\n    Worksheet: 2,\r\n    CalcChain: 3,\r\n    SharedStrings: 4,\r\n    Styles: 5,\r\n    Theme: 6,\r\n    Hyperlink: 7,\r\n  },\r\n  DocumentType: {\r\n    Xlsx: 1,\r\n  },\r\n  ReadingOrder: {\r\n    LeftToRight: 1,\r\n    RightToLeft: 2,\r\n  },\r\n  ErrorValue: {\r\n    NotApplicable: '#N/A',\r\n    Ref: '#REF!',\r\n    Name: '#NAME?',\r\n    DivZero: '#DIV/0!',\r\n    Null: '#NULL!',\r\n    Value: '#VALUE!',\r\n    Num: '#NUM!',\r\n  },\r\n};\r\n"],"mappings":"AAAA,YAAY;;AAEZA,MAAM,CAACC,OAAO,GAAG;EACfC,SAAS,EAAE;IACTC,IAAI,EAAE,CAAC;IACPC,KAAK,EAAE,CAAC;IACRC,MAAM,EAAE,CAAC;IACTC,MAAM,EAAE,CAAC;IACTC,IAAI,EAAE,CAAC;IACPC,SAAS,EAAE,CAAC;IACZC,OAAO,EAAE,CAAC;IACVC,YAAY,EAAE,CAAC;IACfC,QAAQ,EAAE,CAAC;IACXC,OAAO,EAAE,CAAC;IACVC,KAAK,EAAE;EACT,CAAC;EACDC,WAAW,EAAE;IACXC,IAAI,EAAE,CAAC;IACPC,MAAM,EAAE,CAAC;IACTC,MAAM,EAAE;EACV,CAAC;EACDC,gBAAgB,EAAE;IAChBH,IAAI,EAAE,CAAC;IACPI,cAAc,EAAE,CAAC;IACjBC,SAAS,EAAE,CAAC;IACZC,SAAS,EAAE,CAAC;IACZC,aAAa,EAAE,CAAC;IAChBC,MAAM,EAAE,CAAC;IACTC,KAAK,EAAE,CAAC;IACRhB,SAAS,EAAE;EACb,CAAC;EACDiB,YAAY,EAAE;IACZC,IAAI,EAAE;EACR,CAAC;EACDC,YAAY,EAAE;IACZC,WAAW,EAAE,CAAC;IACdC,WAAW,EAAE;EACf,CAAC;EACDC,UAAU,EAAE;IACVC,aAAa,EAAE,MAAM;IACrBC,GAAG,EAAE,OAAO;IACZC,IAAI,EAAE,QAAQ;IACdC,OAAO,EAAE,SAAS;IAClB/B,IAAI,EAAE,QAAQ;IACdgC,KAAK,EAAE,SAAS;IAChBC,GAAG,EAAE;EACP;AACF,CAAC","ignoreList":[]}

package/dist/es5/doc/image.js

@@ -0,0 +1,69 @@
+"use strict";
+
+const colCache = require('../utils/col-cache');
+const Anchor = require('./anchor');
+class Image {
+  constructor(worksheet, model) {
+    this.worksheet = worksheet;
+    this.model = model;
+  }
+  get model() {
+    switch (this.type) {
+      case 'background':
+        return {
+          type: this.type,
+          imageId: this.imageId
+        };
+      case 'image':
+        return {
+          type: this.type,
+          imageId: this.imageId,
+          hyperlinks: this.range.hyperlinks,
+          range: {
+            tl: this.range.tl.model,
+            br: this.range.br && this.range.br.model,
+            ext: this.range.ext,
+            editAs: this.range.editAs
+          }
+        };
+      default:
+        throw new Error('Invalid Image Type');
+    }
+  }
+  set model(_ref) {
+    let {
+      type,
+      imageId,
+      range,
+      hyperlinks
+    } = _ref;
+    this.type = type;
+    this.imageId = imageId;
+    if (type === 'image') {
+      if (typeof range === 'string') {
+        const decoded = colCache.decode(range);
+        this.range = {
+          tl: new Anchor(this.worksheet, {
+            col: decoded.left,
+            row: decoded.top
+          }, -1),
+          br: new Anchor(this.worksheet, {
+            col: decoded.right,
+            row: decoded.bottom
+          }, 0),
+          editAs: 'oneCell'
+        };
+      } else {
+        this.range = {
+          tl: new Anchor(this.worksheet, range.tl, 0),
+          br: range.br && new Anchor(this.worksheet, range.br, 0),
+          ext: range.ext,
+          editAs: range.editAs,
+          hyperlinks: hyperlinks || range.hyperlinks
+        };
+      }
+    }
+  }
+}
+module.exports = Image;
+//# sourceMappingURL=image.js.map

package/dist/es5/doc/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","names":["colCache","require","Anchor","Image","constructor","worksheet","model","type","imageId","hyperlinks","range","tl","br","ext","editAs","Error","_ref","decoded","decode","col","left","row","top","right","bottom","module","exports"],"sources":["../../../lib/doc/image.js"],"sourcesContent":["const colCache = require('../utils/col-cache');\r\nconst Anchor = require('./anchor');\r\n\r\nclass Image {\r\n  constructor(worksheet, model) {\r\n    this.worksheet = worksheet;\r\n    this.model = model;\r\n  }\r\n\r\n  get model() {\r\n    switch (this.type) {\r\n      case 'background':\r\n        return {\r\n          type: this.type,\r\n          imageId: this.imageId,\r\n        };\r\n      case 'image':\r\n        return {\r\n          type: this.type,\r\n          imageId: this.imageId,\r\n          hyperlinks: this.range.hyperlinks,\r\n          range: {\r\n            tl: this.range.tl.model,\r\n            br: this.range.br && this.range.br.model,\r\n            ext: this.range.ext,\r\n            editAs: this.range.editAs,\r\n          },\r\n        };\r\n      default:\r\n        throw new Error('Invalid Image Type');\r\n    }\r\n  }\r\n\r\n  set model({type, imageId, range, hyperlinks}) {\r\n    this.type = type;\r\n    this.imageId = imageId;\r\n\r\n    if (type === 'image') {\r\n      if (typeof range === 'string') {\r\n        const decoded = colCache.decode(range);\r\n        this.range = {\r\n          tl: new Anchor(this.worksheet, {col: decoded.left, row: decoded.top}, -1),\r\n          br: new Anchor(this.worksheet, {col: decoded.right, row: decoded.bottom}, 0),\r\n          editAs: 'oneCell',\r\n        };\r\n      } else {\r\n        this.range = {\r\n          tl: new Anchor(this.worksheet, range.tl, 0),\r\n          br: range.br && new Anchor(this.worksheet, range.br, 0),\r\n          ext: range.ext,\r\n          editAs: range.editAs,\r\n          hyperlinks: hyperlinks || range.hyperlinks,\r\n        };\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\nmodule.exports = Image;\r\n"],"mappings":";;AAAA,MAAMA,QAAQ,GAAGC,OAAO,CAAC,oBAAoB,CAAC;AAC9C,MAAMC,MAAM,GAAGD,OAAO,CAAC,UAAU,CAAC;AAElC,MAAME,KAAK,CAAC;EACVC,WAAWA,CAACC,SAAS,EAAEC,KAAK,EAAE;IAC5B,IAAI,CAACD,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACC,KAAK,GAAGA,KAAK;EACpB;EAEA,IAAIA,KAAKA,CAAA,EAAG;IACV,QAAQ,IAAI,CAACC,IAAI;MACf,KAAK,YAAY;QACf,OAAO;UACLA,IAAI,EAAE,IAAI,CAACA,IAAI;UACfC,OAAO,EAAE,IAAI,CAACA;QAChB,CAAC;MACH,KAAK,OAAO;QACV,OAAO;UACLD,IAAI,EAAE,IAAI,CAACA,IAAI;UACfC,OAAO,EAAE,IAAI,CAACA,OAAO;UACrBC,UAAU,EAAE,IAAI,CAACC,KAAK,CAACD,UAAU;UACjCC,KAAK,EAAE;YACLC,EAAE,EAAE,IAAI,CAACD,KAAK,CAACC,EAAE,CAACL,KAAK;YACvBM,EAAE,EAAE,IAAI,CAACF,KAAK,CAACE,EAAE,IAAI,IAAI,CAACF,KAAK,CAACE,EAAE,CAACN,KAAK;YACxCO,GAAG,EAAE,IAAI,CAACH,KAAK,CAACG,GAAG;YACnBC,MAAM,EAAE,IAAI,CAACJ,KAAK,CAACI;UACrB;QACF,CAAC;MACH;QACE,MAAM,IAAIC,KAAK,CAAC,oBAAoB,CAAC;IACzC;EACF;EAEA,IAAIT,KAAKA,CAAAU,IAAA,EAAqC;IAAA,IAApC;MAACT,IAAI;MAAEC,OAAO;MAAEE,KAAK;MAAED;IAAU,CAAC,GAAAO,IAAA;IAC1C,IAAI,CAACT,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,OAAO,GAAGA,OAAO;IAEtB,IAAID,IAAI,KAAK,OAAO,EAAE;MACpB,IAAI,OAAOG,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAMO,OAAO,GAAGjB,QAAQ,CAACkB,MAAM,CAACR,KAAK,CAAC;QACtC,IAAI,CAACA,KAAK,GAAG;UACXC,EAAE,EAAE,IAAIT,MAAM,CAAC,IAAI,CAACG,SAAS,EAAE;YAACc,GAAG,EAAEF,OAAO,CAACG,IAAI;YAAEC,GAAG,EAAEJ,OAAO,CAACK;UAAG,CAAC,EAAE,CAAC,CAAC,CAAC;UACzEV,EAAE,EAAE,IAAIV,MAAM,CAAC,IAAI,CAACG,SAAS,EAAE;YAACc,GAAG,EAAEF,OAAO,CAACM,KAAK;YAAEF,GAAG,EAAEJ,OAAO,CAACO;UAAM,CAAC,EAAE,CAAC,CAAC;UAC5EV,MAAM,EAAE;QACV,CAAC;MACH,CAAC,MAAM;QACL,IAAI,CAACJ,KAAK,GAAG;UACXC,EAAE,EAAE,IAAIT,MAAM,CAAC,IAAI,CAACG,SAAS,EAAEK,KAAK,CAACC,EAAE,EAAE,CAAC,CAAC;UAC3CC,EAAE,EAAEF,KAAK,CAACE,EAAE,IAAI,IAAIV,MAAM,CAAC,IAAI,CAACG,SAAS,EAAEK,KAAK,CAACE,EAAE,EAAE,CAAC,CAAC;UACvDC,GAAG,EAAEH,KAAK,CAACG,GAAG;UACdC,MAAM,EAAEJ,KAAK,CAACI,MAAM;UACpBL,UAAU,EAAEA,UAAU,IAAIC,KAAK,CAACD;QAClC,CAAC;MACH;IACF;EACF;AACF;AAEAgB,MAAM,CAACC,OAAO,GAAGvB,KAAK","ignoreList":[]}

package/dist/es5/doc/modelcontainer.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const XLSX = require('../xlsx/xlsx');
+class ModelContainer {
+  constructor(model) {
+    this.model = model;
+  }
+  get xlsx() {
+    if (!this._xlsx) {
+      this._xlsx = new XLSX(this);
+    }
+    return this._xlsx;
+  }
+}
+module.exports = ModelContainer;
+//# sourceMappingURL=modelcontainer.js.map

package/dist/es5/doc/modelcontainer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelcontainer.js","names":["XLSX","require","ModelContainer","constructor","model","xlsx","_xlsx","module","exports"],"sources":["../../../lib/doc/modelcontainer.js"],"sourcesContent":["'use strict';\r\n\r\nconst XLSX = require('../xlsx/xlsx');\r\n\r\nclass ModelContainer {\r\n  constructor(model) {\r\n    this.model = model;\r\n  }\r\n\r\n  get xlsx() {\r\n    if (!this._xlsx) {\r\n      this._xlsx = new XLSX(this);\r\n    }\r\n    return this._xlsx;\r\n  }\r\n}\r\n\r\nmodule.exports = ModelContainer;\r\n"],"mappings":"AAAA,YAAY;;AAEZ,MAAMA,IAAI,GAAGC,OAAO,CAAC,cAAc,CAAC;AAEpC,MAAMC,cAAc,CAAC;EACnBC,WAAWA,CAACC,KAAK,EAAE;IACjB,IAAI,CAACA,KAAK,GAAGA,KAAK;EACpB;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,IAAI,CAAC,IAAI,CAACC,KAAK,EAAE;MACf,IAAI,CAACA,KAAK,GAAG,IAAIN,IAAI,CAAC,IAAI,CAAC;IAC7B;IACA,OAAO,IAAI,CAACM,KAAK;EACnB;AACF;AAEAC,MAAM,CAACC,OAAO,GAAGN,cAAc","ignoreList":[]}

package/dist/es5/doc/note.js

@@ -0,0 +1,64 @@
+"use strict";
+
+const _ = require('../utils/under-dash');
+class Note {
+  constructor(note) {
+    this.note = note;
+  }
+  get model() {
+    let value = null;
+    switch (typeof this.note) {
+      case 'string':
+        value = {
+          type: 'note',
+          note: {
+            texts: [{
+              text: this.note
+            }]
+          }
+        };
+        break;
+      default:
+        value = {
+          type: 'note',
+          note: this.note
+        };
+        break;
+    }
+    // Suitable for all cell comments
+    return _.deepMerge({}, Note.DEFAULT_CONFIGS, value);
+  }
+  set model(value) {
+    const {
+      note
+    } = value;
+    const {
+      texts
+    } = note;
+    if (texts.length === 1 && Object.keys(texts[0]).length === 1) {
+      this.note = texts[0].text;
+    } else {
+      this.note = note;
+    }
+  }
+  static fromModel(model) {
+    const note = new Note();
+    note.model = model;
+    return note;
+  }
+}
+Note.DEFAULT_CONFIGS = {
+  note: {
+    margins: {
+      insetmode: 'auto',
+      inset: [0.13, 0.13, 0.25, 0.25]
+    },
+    protection: {
+      locked: 'True',
+      lockText: 'True'
+    },
+    editAs: 'absolute'
+  }
+};
+module.exports = Note;
+//# sourceMappingURL=note.js.map

package/dist/es5/doc/note.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"note.js","names":["_","require","Note","constructor","note","model","value","type","texts","text","deepMerge","DEFAULT_CONFIGS","length","Object","keys","fromModel","margins","insetmode","inset","protection","locked","lockText","editAs","module","exports"],"sources":["../../../lib/doc/note.js"],"sourcesContent":["const _ = require('../utils/under-dash');\r\n\r\nclass Note {\r\n  constructor(note) {\r\n    this.note = note;\r\n  }\r\n\r\n  get model() {\r\n    let value = null;\r\n    switch (typeof this.note) {\r\n      case 'string':\r\n        value = {\r\n          type: 'note',\r\n          note: {\r\n            texts: [\r\n              {\r\n                text: this.note,\r\n              },\r\n            ],\r\n          },\r\n        };\r\n        break;\r\n      default:\r\n        value = {\r\n          type: 'note',\r\n          note: this.note,\r\n        };\r\n        break;\r\n    }\r\n    // Suitable for all cell comments\r\n    return _.deepMerge({}, Note.DEFAULT_CONFIGS, value);\r\n  }\r\n\r\n  set model(value) {\r\n    const {note} = value;\r\n    const {texts} = note;\r\n    if (texts.length === 1 && Object.keys(texts[0]).length === 1) {\r\n      this.note = texts[0].text;\r\n    } else {\r\n      this.note = note;\r\n    }\r\n  }\r\n\r\n  static fromModel(model) {\r\n    const note = new Note();\r\n    note.model = model;\r\n    return note;\r\n  }\r\n}\r\n\r\nNote.DEFAULT_CONFIGS = {\r\n  note: {\r\n    margins: {\r\n      insetmode: 'auto',\r\n      inset: [0.13, 0.13, 0.25, 0.25],\r\n    },\r\n    protection: {\r\n      locked: 'True',\r\n      lockText: 'True',\r\n    },\r\n    editAs: 'absolute',\r\n  },\r\n};\r\n\r\nmodule.exports = Note;\r\n"],"mappings":";;AAAA,MAAMA,CAAC,GAAGC,OAAO,CAAC,qBAAqB,CAAC;AAExC,MAAMC,IAAI,CAAC;EACTC,WAAWA,CAACC,IAAI,EAAE;IAChB,IAAI,CAACA,IAAI,GAAGA,IAAI;EAClB;EAEA,IAAIC,KAAKA,CAAA,EAAG;IACV,IAAIC,KAAK,GAAG,IAAI;IAChB,QAAQ,OAAO,IAAI,CAACF,IAAI;MACtB,KAAK,QAAQ;QACXE,KAAK,GAAG;UACNC,IAAI,EAAE,MAAM;UACZH,IAAI,EAAE;YACJI,KAAK,EAAE,CACL;cACEC,IAAI,EAAE,IAAI,CAACL;YACb,CAAC;UAEL;QACF,CAAC;QACD;MACF;QACEE,KAAK,GAAG;UACNC,IAAI,EAAE,MAAM;UACZH,IAAI,EAAE,IAAI,CAACA;QACb,CAAC;QACD;IACJ;IACA;IACA,OAAOJ,CAAC,CAACU,SAAS,CAAC,CAAC,CAAC,EAAER,IAAI,CAACS,eAAe,EAAEL,KAAK,CAAC;EACrD;EAEA,IAAID,KAAKA,CAACC,KAAK,EAAE;IACf,MAAM;MAACF;IAAI,CAAC,GAAGE,KAAK;IACpB,MAAM;MAACE;IAAK,CAAC,GAAGJ,IAAI;IACpB,IAAII,KAAK,CAACI,MAAM,KAAK,CAAC,IAAIC,MAAM,CAACC,IAAI,CAACN,KAAK,CAAC,CAAC,CAAC,CAAC,CAACI,MAAM,KAAK,CAAC,EAAE;MAC5D,IAAI,CAACR,IAAI,GAAGI,KAAK,CAAC,CAAC,CAAC,CAACC,IAAI;IAC3B,CAAC,MAAM;MACL,IAAI,CAACL,IAAI,GAAGA,IAAI;IAClB;EACF;EAEA,OAAOW,SAASA,CAACV,KAAK,EAAE;IACtB,MAAMD,IAAI,GAAG,IAAIF,IAAI,CAAC,CAAC;IACvBE,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,OAAOD,IAAI;EACb;AACF;AAEAF,IAAI,CAACS,eAAe,GAAG;EACrBP,IAAI,EAAE;IACJY,OAAO,EAAE;MACPC,SAAS,EAAE,MAAM;MACjBC,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAChC,CAAC;IACDC,UAAU,EAAE;MACVC,MAAM,EAAE,MAAM;MACdC,QAAQ,EAAE;IACZ,CAAC;IACDC,MAAM,EAAE;EACV;AACF,CAAC;AAEDC,MAAM,CAACC,OAAO,GAAGtB,IAAI","ignoreList":[]}

package/dist/es5/doc/pivot-table.js

@@ -0,0 +1,137 @@
+"use strict";
+
+const {
+  objectFromProps,
+  range,
+  toSortedArray
+} = require('../utils/utils');
+
+// TK(2023-10-10): turn this into a class constructor.
+
+function makePivotTable(worksheet, model) {
+  // Example `model`:
+  // {
+  //   // Source of data: the entire sheet range is taken,
+  //   // akin to `worksheet1.getSheetValues()`.
+  //   sourceSheet: worksheet1,
+  //
+  //   // Pivot table fields: values indicate field names;
+  //   // they come from the first row in `worksheet1`.
+  //   rows: ['A', 'B'],
+  //   columns: ['C'],
+  //   values: ['E'], // only 1 item possible for now
+  //   metric: 'sum', // only 'sum' possible for now
+  // }
+
+  validate(worksheet, model);
+  const {
+    sourceSheet
+  } = model;
+  let {
+    rows,
+    columns,
+    values
+  } = model;
+  const cacheFields = makeCacheFields(sourceSheet, [...rows, ...columns]);
+
+  // let {rows, columns, values} use indices instead of names;
+  // names can then be accessed via `pivotTable.cacheFields[index].name`.
+  // *Note*: Using `reduce` as `Object.fromEntries` requires Node 12+;
+  // ExcelJS is >=8.3.0 (as of 2023-10-08).
+  const nameToIndex = cacheFields.reduce((result, cacheField, index) => {
+    result[cacheField.name] = index;
+    return result;
+  }, {});
+  rows = rows.map(row => nameToIndex[row]);
+  columns = columns.map(column => nameToIndex[column]);
+  values = values.map(value => nameToIndex[value]);
+
+  // form pivot table object
+  return {
+    sourceSheet,
+    rows,
+    columns,
+    values,
+    metric: 'sum',
+    cacheFields,
+    // defined in <pivotTableDefinition> of xl/pivotTables/pivotTable1.xml;
+    // also used in xl/workbook.xml
+    cacheId: '10'
+  };
+}
+function validate(worksheet, model) {
+  if (worksheet.workbook.pivotTables.length === 1) {
+    throw new Error('A pivot table was already added. At this time, ExcelJS supports at most one pivot table per file.');
+  }
+  if (model.metric && model.metric !== 'sum') {
+    throw new Error('Only the "sum" metric is supported at this time.');
+  }
+  const headerNames = model.sourceSheet.getRow(1).values.slice(1);
+  const isInHeaderNames = objectFromProps(headerNames, true);
+  for (const name of [...model.rows, ...model.columns, ...model.values]) {
+    if (!isInHeaderNames[name]) {
+      throw new Error(`The header name "${name}" was not found in ${model.sourceSheet.name}.`);
+    }
+  }
+  if (!model.rows.length) {
+    throw new Error('No pivot table rows specified.');
+  }
+  if (!model.columns.length) {
+    throw new Error('No pivot table columns specified.');
+  }
+  if (model.values.length !== 1) {
+    throw new Error('Exactly 1 value needs to be specified at this time.');
+  }
+}
+function makeCacheFields(worksheet, fieldNamesWithSharedItems) {
+  // Cache fields are used in pivot tables to reference source data.
+  //
+  // Example
+  // -------
+  // Turn
+  //
+  //  `worksheet` sheet values [
+  //    ['A', 'B', 'C', 'D', 'E'],
+  //    ['a1', 'b1', 'c1', 4, 5],
+  //    ['a1', 'b2', 'c1', 4, 5],
+  //    ['a2', 'b1', 'c2', 14, 24],
+  //    ['a2', 'b2', 'c2', 24, 35],
+  //    ['a3', 'b1', 'c3', 34, 45],
+  //    ['a3', 'b2', 'c3', 44, 45]
+  //  ];
+  //  fieldNamesWithSharedItems = ['A', 'B', 'C'];
+  //
+  // into
+  //
+  //  [
+  //    { name: 'A', sharedItems: ['a1', 'a2', 'a3'] },
+  //    { name: 'B', sharedItems: ['b1', 'b2'] },
+  //    { name: 'C', sharedItems: ['c1', 'c2', 'c3'] },
+  //    { name: 'D', sharedItems: null },
+  //    { name: 'E', sharedItems: null }
+  //  ]
+
+  const names = worksheet.getRow(1).values;
+  const nameToHasSharedItems = objectFromProps(fieldNamesWithSharedItems, true);
+  const aggregate = columnIndex => {
+    const columnValues = worksheet.getColumn(columnIndex).values.splice(2);
+    const columnValuesAsSet = new Set(columnValues);
+    return toSortedArray(columnValuesAsSet);
+  };
+
+  // make result
+  const result = [];
+  for (const columnIndex of range(1, names.length)) {
+    const name = names[columnIndex];
+    const sharedItems = nameToHasSharedItems[name] ? aggregate(columnIndex) : null;
+    result.push({
+      name,
+      sharedItems
+    });
+  }
+  return result;
+}
+module.exports = {
+  makePivotTable
+};
+//# sourceMappingURL=pivot-table.js.map

package/dist/es5/doc/pivot-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pivot-table.js","names":["objectFromProps","range","toSortedArray","require","makePivotTable","worksheet","model","validate","sourceSheet","rows","columns","values","cacheFields","makeCacheFields","nameToIndex","reduce","result","cacheField","index","name","map","row","column","value","metric","cacheId","workbook","pivotTables","length","Error","headerNames","getRow","slice","isInHeaderNames","fieldNamesWithSharedItems","names","nameToHasSharedItems","aggregate","columnIndex","columnValues","getColumn","splice","columnValuesAsSet","Set","sharedItems","push","module","exports"],"sources":["../../../lib/doc/pivot-table.js"],"sourcesContent":["const {objectFromProps, range, toSortedArray} = require('../utils/utils');\r\n\r\n// TK(2023-10-10): turn this into a class constructor.\r\n\r\nfunction makePivotTable(worksheet, model) {\r\n  // Example `model`:\r\n  // {\r\n  //   // Source of data: the entire sheet range is taken,\r\n  //   // akin to `worksheet1.getSheetValues()`.\r\n  //   sourceSheet: worksheet1,\r\n  //\r\n  //   // Pivot table fields: values indicate field names;\r\n  //   // they come from the first row in `worksheet1`.\r\n  //   rows: ['A', 'B'],\r\n  //   columns: ['C'],\r\n  //   values: ['E'], // only 1 item possible for now\r\n  //   metric: 'sum', // only 'sum' possible for now\r\n  // }\r\n\r\n  validate(worksheet, model);\r\n\r\n  const {sourceSheet} = model;\r\n  let {rows, columns, values} = model;\r\n\r\n  const cacheFields = makeCacheFields(sourceSheet, [...rows, ...columns]);\r\n\r\n  // let {rows, columns, values} use indices instead of names;\r\n  // names can then be accessed via `pivotTable.cacheFields[index].name`.\r\n  // *Note*: Using `reduce` as `Object.fromEntries` requires Node 12+;\r\n  // ExcelJS is >=8.3.0 (as of 2023-10-08).\r\n  const nameToIndex = cacheFields.reduce((result, cacheField, index) => {\r\n    result[cacheField.name] = index;\r\n    return result;\r\n  }, {});\r\n  rows = rows.map(row => nameToIndex[row]);\r\n  columns = columns.map(column => nameToIndex[column]);\r\n  values = values.map(value => nameToIndex[value]);\r\n\r\n  // form pivot table object\r\n  return {\r\n    sourceSheet,\r\n    rows,\r\n    columns,\r\n    values,\r\n    metric: 'sum',\r\n    cacheFields,\r\n    // defined in <pivotTableDefinition> of xl/pivotTables/pivotTable1.xml;\r\n    // also used in xl/workbook.xml\r\n    cacheId: '10',\r\n  };\r\n}\r\n\r\nfunction validate(worksheet, model) {\r\n  if (worksheet.workbook.pivotTables.length === 1) {\r\n    throw new Error(\r\n      'A pivot table was already added. At this time, ExcelJS supports at most one pivot table per file.'\r\n    );\r\n  }\r\n\r\n  if (model.metric && model.metric !== 'sum') {\r\n    throw new Error('Only the \"sum\" metric is supported at this time.');\r\n  }\r\n\r\n  const headerNames = model.sourceSheet.getRow(1).values.slice(1);\r\n  const isInHeaderNames = objectFromProps(headerNames, true);\r\n  for (const name of [...model.rows, ...model.columns, ...model.values]) {\r\n    if (!isInHeaderNames[name]) {\r\n      throw new Error(`The header name \"${name}\" was not found in ${model.sourceSheet.name}.`);\r\n    }\r\n  }\r\n\r\n  if (!model.rows.length) {\r\n    throw new Error('No pivot table rows specified.');\r\n  }\r\n\r\n  if (!model.columns.length) {\r\n    throw new Error('No pivot table columns specified.');\r\n  }\r\n\r\n  if (model.values.length !== 1) {\r\n    throw new Error('Exactly 1 value needs to be specified at this time.');\r\n  }\r\n}\r\n\r\nfunction makeCacheFields(worksheet, fieldNamesWithSharedItems) {\r\n  // Cache fields are used in pivot tables to reference source data.\r\n  //\r\n  // Example\r\n  // -------\r\n  // Turn\r\n  //\r\n  //  `worksheet` sheet values [\r\n  //    ['A', 'B', 'C', 'D', 'E'],\r\n  //    ['a1', 'b1', 'c1', 4, 5],\r\n  //    ['a1', 'b2', 'c1', 4, 5],\r\n  //    ['a2', 'b1', 'c2', 14, 24],\r\n  //    ['a2', 'b2', 'c2', 24, 35],\r\n  //    ['a3', 'b1', 'c3', 34, 45],\r\n  //    ['a3', 'b2', 'c3', 44, 45]\r\n  //  ];\r\n  //  fieldNamesWithSharedItems = ['A', 'B', 'C'];\r\n  //\r\n  // into\r\n  //\r\n  //  [\r\n  //    { name: 'A', sharedItems: ['a1', 'a2', 'a3'] },\r\n  //    { name: 'B', sharedItems: ['b1', 'b2'] },\r\n  //    { name: 'C', sharedItems: ['c1', 'c2', 'c3'] },\r\n  //    { name: 'D', sharedItems: null },\r\n  //    { name: 'E', sharedItems: null }\r\n  //  ]\r\n\r\n  const names = worksheet.getRow(1).values;\r\n  const nameToHasSharedItems = objectFromProps(fieldNamesWithSharedItems, true);\r\n\r\n  const aggregate = columnIndex => {\r\n    const columnValues = worksheet.getColumn(columnIndex).values.splice(2);\r\n    const columnValuesAsSet = new Set(columnValues);\r\n    return toSortedArray(columnValuesAsSet);\r\n  };\r\n\r\n  // make result\r\n  const result = [];\r\n  for (const columnIndex of range(1, names.length)) {\r\n    const name = names[columnIndex];\r\n    const sharedItems = nameToHasSharedItems[name] ? aggregate(columnIndex) : null;\r\n    result.push({name, sharedItems});\r\n  }\r\n  return result;\r\n}\r\n\r\nmodule.exports = {makePivotTable};\r\n"],"mappings":";;AAAA,MAAM;EAACA,eAAe;EAAEC,KAAK;EAAEC;AAAa,CAAC,GAAGC,OAAO,CAAC,gBAAgB,CAAC;;AAEzE;;AAEA,SAASC,cAAcA,CAACC,SAAS,EAAEC,KAAK,EAAE;EACxC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;EAEAC,QAAQ,CAACF,SAAS,EAAEC,KAAK,CAAC;EAE1B,MAAM;IAACE;EAAW,CAAC,GAAGF,KAAK;EAC3B,IAAI;IAACG,IAAI;IAAEC,OAAO;IAAEC;EAAM,CAAC,GAAGL,KAAK;EAEnC,MAAMM,WAAW,GAAGC,eAAe,CAACL,WAAW,EAAE,CAAC,GAAGC,IAAI,EAAE,GAAGC,OAAO,CAAC,CAAC;;EAEvE;EACA;EACA;EACA;EACA,MAAMI,WAAW,GAAGF,WAAW,CAACG,MAAM,CAAC,CAACC,MAAM,EAAEC,UAAU,EAAEC,KAAK,KAAK;IACpEF,MAAM,CAACC,UAAU,CAACE,IAAI,CAAC,GAAGD,KAAK;IAC/B,OAAOF,MAAM;EACf,CAAC,EAAE,CAAC,CAAC,CAAC;EACNP,IAAI,GAAGA,IAAI,CAACW,GAAG,CAACC,GAAG,IAAIP,WAAW,CAACO,GAAG,CAAC,CAAC;EACxCX,OAAO,GAAGA,OAAO,CAACU,GAAG,CAACE,MAAM,IAAIR,WAAW,CAACQ,MAAM,CAAC,CAAC;EACpDX,MAAM,GAAGA,MAAM,CAACS,GAAG,CAACG,KAAK,IAAIT,WAAW,CAACS,KAAK,CAAC,CAAC;;EAEhD;EACA,OAAO;IACLf,WAAW;IACXC,IAAI;IACJC,OAAO;IACPC,MAAM;IACNa,MAAM,EAAE,KAAK;IACbZ,WAAW;IACX;IACA;IACAa,OAAO,EAAE;EACX,CAAC;AACH;AAEA,SAASlB,QAAQA,CAACF,SAAS,EAAEC,KAAK,EAAE;EAClC,IAAID,SAAS,CAACqB,QAAQ,CAACC,WAAW,CAACC,MAAM,KAAK,CAAC,EAAE;IAC/C,MAAM,IAAIC,KAAK,CACb,mGACF,CAAC;EACH;EAEA,IAAIvB,KAAK,CAACkB,MAAM,IAAIlB,KAAK,CAACkB,MAAM,KAAK,KAAK,EAAE;IAC1C,MAAM,IAAIK,KAAK,CAAC,kDAAkD,CAAC;EACrE;EAEA,MAAMC,WAAW,GAAGxB,KAAK,CAACE,WAAW,CAACuB,MAAM,CAAC,CAAC,CAAC,CAACpB,MAAM,CAACqB,KAAK,CAAC,CAAC,CAAC;EAC/D,MAAMC,eAAe,GAAGjC,eAAe,CAAC8B,WAAW,EAAE,IAAI,CAAC;EAC1D,KAAK,MAAMX,IAAI,IAAI,CAAC,GAAGb,KAAK,CAACG,IAAI,EAAE,GAAGH,KAAK,CAACI,OAAO,EAAE,GAAGJ,KAAK,CAACK,MAAM,CAAC,EAAE;IACrE,IAAI,CAACsB,eAAe,CAACd,IAAI,CAAC,EAAE;MAC1B,MAAM,IAAIU,KAAK,CAAC,oBAAoBV,IAAI,sBAAsBb,KAAK,CAACE,WAAW,CAACW,IAAI,GAAG,CAAC;IAC1F;EACF;EAEA,IAAI,CAACb,KAAK,CAACG,IAAI,CAACmB,MAAM,EAAE;IACtB,MAAM,IAAIC,KAAK,CAAC,gCAAgC,CAAC;EACnD;EAEA,IAAI,CAACvB,KAAK,CAACI,OAAO,CAACkB,MAAM,EAAE;IACzB,MAAM,IAAIC,KAAK,CAAC,mCAAmC,CAAC;EACtD;EAEA,IAAIvB,KAAK,CAACK,MAAM,CAACiB,MAAM,KAAK,CAAC,EAAE;IAC7B,MAAM,IAAIC,KAAK,CAAC,qDAAqD,CAAC;EACxE;AACF;AAEA,SAAShB,eAAeA,CAACR,SAAS,EAAE6B,yBAAyB,EAAE;EAC7D;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;EAEA,MAAMC,KAAK,GAAG9B,SAAS,CAAC0B,MAAM,CAAC,CAAC,CAAC,CAACpB,MAAM;EACxC,MAAMyB,oBAAoB,GAAGpC,eAAe,CAACkC,yBAAyB,EAAE,IAAI,CAAC;EAE7E,MAAMG,SAAS,GAAGC,WAAW,IAAI;IAC/B,MAAMC,YAAY,GAAGlC,SAAS,CAACmC,SAAS,CAACF,WAAW,CAAC,CAAC3B,MAAM,CAAC8B,MAAM,CAAC,CAAC,CAAC;IACtE,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,CAACJ,YAAY,CAAC;IAC/C,OAAOrC,aAAa,CAACwC,iBAAiB,CAAC;EACzC,CAAC;;EAED;EACA,MAAM1B,MAAM,GAAG,EAAE;EACjB,KAAK,MAAMsB,WAAW,IAAIrC,KAAK,CAAC,CAAC,EAAEkC,KAAK,CAACP,MAAM,CAAC,EAAE;IAChD,MAAMT,IAAI,GAAGgB,KAAK,CAACG,WAAW,CAAC;IAC/B,MAAMM,WAAW,GAAGR,oBAAoB,CAACjB,IAAI,CAAC,GAAGkB,SAAS,CAACC,WAAW,CAAC,GAAG,IAAI;IAC9EtB,MAAM,CAAC6B,IAAI,CAAC;MAAC1B,IAAI;MAAEyB;IAAW,CAAC,CAAC;EAClC;EACA,OAAO5B,MAAM;AACf;AAEA8B,MAAM,CAACC,OAAO,GAAG;EAAC3C;AAAc,CAAC","ignoreList":[]}

package/dist/es5/doc/range.js

@@ -0,0 +1,229 @@
+"use strict";
+
+const colCache = require('../utils/col-cache');
+
+// used by worksheet to calculate sheet dimensions
+class Range {
+  constructor() {
+    this.decode(arguments);
+  }
+  setTLBR(t, l, b, r, s) {
+    if (arguments.length < 4) {
+      // setTLBR(tl, br, s)
+      const tl = colCache.decodeAddress(t);
+      const br = colCache.decodeAddress(l);
+      this.model = {
+        top: Math.min(tl.row, br.row),
+        left: Math.min(tl.col, br.col),
+        bottom: Math.max(tl.row, br.row),
+        right: Math.max(tl.col, br.col),
+        sheetName: b
+      };
+      this.setTLBR(tl.row, tl.col, br.row, br.col, s);
+    } else {
+      // setTLBR(t, l, b, r, s)
+      this.model = {
+        top: Math.min(t, b),
+        left: Math.min(l, r),
+        bottom: Math.max(t, b),
+        right: Math.max(l, r),
+        sheetName: s
+      };
+    }
+  }
+  decode(argv) {
+    switch (argv.length) {
+      case 5:
+        // [t,l,b,r,s]
+        this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);
+        break;
+      case 4:
+        // [t,l,b,r]
+        this.setTLBR(argv[0], argv[1], argv[2], argv[3]);
+        break;
+      case 3:
+        // [tl,br,s]
+        this.setTLBR(argv[0], argv[1], argv[2]);
+        break;
+      case 2:
+        // [tl,br]
+        this.setTLBR(argv[0], argv[1]);
+        break;
+      case 1:
+        {
+          const value = argv[0];
+          if (value instanceof Range) {
+            // copy constructor
+            this.model = {
+              top: value.model.top,
+              left: value.model.left,
+              bottom: value.model.bottom,
+              right: value.model.right,
+              sheetName: value.sheetName
+            };
+          } else if (value instanceof Array) {
+            // an arguments array
+            this.decode(value);
+          } else if (value.top && value.left && value.bottom && value.right) {
+            // a model
+            this.model = {
+              top: value.top,
+              left: value.left,
+              bottom: value.bottom,
+              right: value.right,
+              sheetName: value.sheetName
+            };
+          } else {
+            // [sheetName!]tl:br
+            const tlbr = colCache.decodeEx(value);
+            if (tlbr.top) {
+              this.model = {
+                top: tlbr.top,
+                left: tlbr.left,
+                bottom: tlbr.bottom,
+                right: tlbr.right,
+                sheetName: tlbr.sheetName
+              };
+            } else {
+              this.model = {
+                top: tlbr.row,
+                left: tlbr.col,
+                bottom: tlbr.row,
+                right: tlbr.col,
+                sheetName: tlbr.sheetName
+              };
+            }
+          }
+          break;
+        }
+      case 0:
+        this.model = {
+          top: 0,
+          left: 0,
+          bottom: 0,
+          right: 0
+        };
+        break;
+      default:
+        throw new Error(`Invalid number of arguments to _getDimensions() - ${argv.length}`);
+    }
+  }
+  get top() {
+    return this.model.top || 1;
+  }
+  set top(value) {
+    this.model.top = value;
+  }
+  get left() {
+    return this.model.left || 1;
+  }
+  set left(value) {
+    this.model.left = value;
+  }
+  get bottom() {
+    return this.model.bottom || 1;
+  }
+  set bottom(value) {
+    this.model.bottom = value;
+  }
+  get right() {
+    return this.model.right || 1;
+  }
+  set right(value) {
+    this.model.right = value;
+  }
+  get sheetName() {
+    return this.model.sheetName;
+  }
+  set sheetName(value) {
+    this.model.sheetName = value;
+  }
+  get _serialisedSheetName() {
+    const {
+      sheetName
+    } = this.model;
+    if (sheetName) {
+      if (/^[a-zA-Z0-9]*$/.test(sheetName)) {
+        return `${sheetName}!`;
+      }
+      return `'${sheetName}'!`;
+    }
+    return '';
+  }
+  expand(top, left, bottom, right) {
+    if (!this.model.top || top < this.top) this.top = top;
+    if (!this.model.left || left < this.left) this.left = left;
+    if (!this.model.bottom || bottom > this.bottom) this.bottom = bottom;
+    if (!this.model.right || right > this.right) this.right = right;
+  }
+  expandRow(row) {
+    if (row) {
+      const {
+        dimensions,
+        number
+      } = row;
+      if (dimensions) {
+        this.expand(number, dimensions.min, number, dimensions.max);
+      }
+    }
+  }
+  expandToAddress(addressStr) {
+    const address = colCache.decodeEx(addressStr);
+    this.expand(address.row, address.col, address.row, address.col);
+  }
+  get tl() {
+    return colCache.n2l(this.left) + this.top;
+  }
+  get $t$l() {
+    return `$${colCache.n2l(this.left)}$${this.top}`;
+  }
+  get br() {
+    return colCache.n2l(this.right) + this.bottom;
+  }
+  get $b$r() {
+    return `$${colCache.n2l(this.right)}$${this.bottom}`;
+  }
+  get range() {
+    return `${this._serialisedSheetName + this.tl}:${this.br}`;
+  }
+  get $range() {
+    return `${this._serialisedSheetName + this.$t$l}:${this.$b$r}`;
+  }
+  get shortRange() {
+    return this.count > 1 ? this.range : this._serialisedSheetName + this.tl;
+  }
+  get $shortRange() {
+    return this.count > 1 ? this.$range : this._serialisedSheetName + this.$t$l;
+  }
+  get count() {
+    return (1 + this.bottom - this.top) * (1 + this.right - this.left);
+  }
+  toString() {
+    return this.range;
+  }
+  intersects(other) {
+    if (other.sheetName && this.sheetName && other.sheetName !== this.sheetName) return false;
+    if (other.bottom < this.top) return false;
+    if (other.top > this.bottom) return false;
+    if (other.right < this.left) return false;
+    if (other.left > this.right) return false;
+    return true;
+  }
+  contains(addressStr) {
+    const address = colCache.decodeEx(addressStr);
+    return this.containsEx(address);
+  }
+  containsEx(address) {
+    if (address.sheetName && this.sheetName && address.sheetName !== this.sheetName) return false;
+    return address.row >= this.top && address.row <= this.bottom && address.col >= this.left && address.col <= this.right;
+  }
+  forEachAddress(cb) {
+    for (let col = this.left; col <= this.right; col++) {
+      for (let row = this.top; row <= this.bottom; row++) {
+        cb(colCache.encodeAddress(row, col), row, col);
+      }
+    }
+  }
+}
+module.exports = Range;
+//# sourceMappingURL=range.js.map

package/dist/es5/doc/range.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"range.js","names":["colCache","require","Range","constructor","decode","arguments","setTLBR","t","l","b","r","s","length","tl","decodeAddress","br","model","top","Math","min","row","left","col","bottom","max","right","sheetName","argv","value","Array","tlbr","decodeEx","Error","_serialisedSheetName","test","expand","expandRow","dimensions","number","expandToAddress","addressStr","address","n2l","$t$l","$b$r","range","$range","shortRange","count","$shortRange","toString","intersects","other","contains","containsEx","forEachAddress","cb","encodeAddress","module","exports"],"sources":["../../../lib/doc/range.js"],"sourcesContent":["const colCache = require('../utils/col-cache');\r\n\r\n// used by worksheet to calculate sheet dimensions\r\nclass Range {\r\n  constructor() {\r\n    this.decode(arguments);\r\n  }\r\n\r\n  setTLBR(t, l, b, r, s) {\r\n    if (arguments.length < 4) {\r\n      // setTLBR(tl, br, s)\r\n      const tl = colCache.decodeAddress(t);\r\n      const br = colCache.decodeAddress(l);\r\n      this.model = {\r\n        top: Math.min(tl.row, br.row),\r\n        left: Math.min(tl.col, br.col),\r\n        bottom: Math.max(tl.row, br.row),\r\n        right: Math.max(tl.col, br.col),\r\n        sheetName: b,\r\n      };\r\n\r\n      this.setTLBR(tl.row, tl.col, br.row, br.col, s);\r\n    } else {\r\n      // setTLBR(t, l, b, r, s)\r\n      this.model = {\r\n        top: Math.min(t, b),\r\n        left: Math.min(l, r),\r\n        bottom: Math.max(t, b),\r\n        right: Math.max(l, r),\r\n        sheetName: s,\r\n      };\r\n    }\r\n  }\r\n\r\n  decode(argv) {\r\n    switch (argv.length) {\r\n      case 5: // [t,l,b,r,s]\r\n        this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);\r\n        break;\r\n      case 4: // [t,l,b,r]\r\n        this.setTLBR(argv[0], argv[1], argv[2], argv[3]);\r\n        break;\r\n\r\n      case 3: // [tl,br,s]\r\n        this.setTLBR(argv[0], argv[1], argv[2]);\r\n        break;\r\n      case 2: // [tl,br]\r\n        this.setTLBR(argv[0], argv[1]);\r\n        break;\r\n\r\n      case 1: {\r\n        const value = argv[0];\r\n        if (value instanceof Range) {\r\n          // copy constructor\r\n          this.model = {\r\n            top: value.model.top,\r\n            left: value.model.left,\r\n            bottom: value.model.bottom,\r\n            right: value.model.right,\r\n            sheetName: value.sheetName,\r\n          };\r\n        } else if (value instanceof Array) {\r\n          // an arguments array\r\n          this.decode(value);\r\n        } else if (value.top && value.left && value.bottom && value.right) {\r\n          // a model\r\n          this.model = {\r\n            top: value.top,\r\n            left: value.left,\r\n            bottom: value.bottom,\r\n            right: value.right,\r\n            sheetName: value.sheetName,\r\n          };\r\n        } else {\r\n          // [sheetName!]tl:br\r\n          const tlbr = colCache.decodeEx(value);\r\n          if (tlbr.top) {\r\n            this.model = {\r\n              top: tlbr.top,\r\n              left: tlbr.left,\r\n              bottom: tlbr.bottom,\r\n              right: tlbr.right,\r\n              sheetName: tlbr.sheetName,\r\n            };\r\n          } else {\r\n            this.model = {\r\n              top: tlbr.row,\r\n              left: tlbr.col,\r\n              bottom: tlbr.row,\r\n              right: tlbr.col,\r\n              sheetName: tlbr.sheetName,\r\n            };\r\n          }\r\n        }\r\n        break;\r\n      }\r\n\r\n      case 0:\r\n        this.model = {\r\n          top: 0,\r\n          left: 0,\r\n          bottom: 0,\r\n          right: 0,\r\n        };\r\n        break;\r\n\r\n      default:\r\n        throw new Error(`Invalid number of arguments to _getDimensions() - ${argv.length}`);\r\n    }\r\n  }\r\n\r\n  get top() {\r\n    return this.model.top || 1;\r\n  }\r\n\r\n  set top(value) {\r\n    this.model.top = value;\r\n  }\r\n\r\n  get left() {\r\n    return this.model.left || 1;\r\n  }\r\n\r\n  set left(value) {\r\n    this.model.left = value;\r\n  }\r\n\r\n  get bottom() {\r\n    return this.model.bottom || 1;\r\n  }\r\n\r\n  set bottom(value) {\r\n    this.model.bottom = value;\r\n  }\r\n\r\n  get right() {\r\n    return this.model.right || 1;\r\n  }\r\n\r\n  set right(value) {\r\n    this.model.right = value;\r\n  }\r\n\r\n  get sheetName() {\r\n    return this.model.sheetName;\r\n  }\r\n\r\n  set sheetName(value) {\r\n    this.model.sheetName = value;\r\n  }\r\n\r\n  get _serialisedSheetName() {\r\n    const {sheetName} = this.model;\r\n    if (sheetName) {\r\n      if (/^[a-zA-Z0-9]*$/.test(sheetName)) {\r\n        return `${sheetName}!`;\r\n      }\r\n      return `'${sheetName}'!`;\r\n    }\r\n    return '';\r\n  }\r\n\r\n  expand(top, left, bottom, right) {\r\n    if (!this.model.top || top < this.top) this.top = top;\r\n    if (!this.model.left || left < this.left) this.left = left;\r\n    if (!this.model.bottom || bottom > this.bottom) this.bottom = bottom;\r\n    if (!this.model.right || right > this.right) this.right = right;\r\n  }\r\n\r\n  expandRow(row) {\r\n    if (row) {\r\n      const {dimensions, number} = row;\r\n      if (dimensions) {\r\n        this.expand(number, dimensions.min, number, dimensions.max);\r\n      }\r\n    }\r\n  }\r\n\r\n  expandToAddress(addressStr) {\r\n    const address = colCache.decodeEx(addressStr);\r\n    this.expand(address.row, address.col, address.row, address.col);\r\n  }\r\n\r\n  get tl() {\r\n    return colCache.n2l(this.left) + this.top;\r\n  }\r\n\r\n  get $t$l() {\r\n    return `$${colCache.n2l(this.left)}$${this.top}`;\r\n  }\r\n\r\n  get br() {\r\n    return colCache.n2l(this.right) + this.bottom;\r\n  }\r\n\r\n  get $b$r() {\r\n    return `$${colCache.n2l(this.right)}$${this.bottom}`;\r\n  }\r\n\r\n  get range() {\r\n    return `${this._serialisedSheetName + this.tl}:${this.br}`;\r\n  }\r\n\r\n  get $range() {\r\n    return `${this._serialisedSheetName + this.$t$l}:${this.$b$r}`;\r\n  }\r\n\r\n  get shortRange() {\r\n    return this.count > 1 ? this.range : this._serialisedSheetName + this.tl;\r\n  }\r\n\r\n  get $shortRange() {\r\n    return this.count > 1 ? this.$range : this._serialisedSheetName + this.$t$l;\r\n  }\r\n\r\n  get count() {\r\n    return (1 + this.bottom - this.top) * (1 + this.right - this.left);\r\n  }\r\n\r\n  toString() {\r\n    return this.range;\r\n  }\r\n\r\n  intersects(other) {\r\n    if (other.sheetName && this.sheetName && other.sheetName !== this.sheetName) return false;\r\n    if (other.bottom < this.top) return false;\r\n    if (other.top > this.bottom) return false;\r\n    if (other.right < this.left) return false;\r\n    if (other.left > this.right) return false;\r\n    return true;\r\n  }\r\n\r\n  contains(addressStr) {\r\n    const address = colCache.decodeEx(addressStr);\r\n    return this.containsEx(address);\r\n  }\r\n\r\n  containsEx(address) {\r\n    if (address.sheetName && this.sheetName && address.sheetName !== this.sheetName) return false;\r\n    return (\r\n      address.row >= this.top &&\r\n      address.row <= this.bottom &&\r\n      address.col >= this.left &&\r\n      address.col <= this.right\r\n    );\r\n  }\r\n\r\n  forEachAddress(cb) {\r\n    for (let col = this.left; col <= this.right; col++) {\r\n      for (let row = this.top; row <= this.bottom; row++) {\r\n        cb(colCache.encodeAddress(row, col), row, col);\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\nmodule.exports = Range;\r\n"],"mappings":";;AAAA,MAAMA,QAAQ,GAAGC,OAAO,CAAC,oBAAoB,CAAC;;AAE9C;AACA,MAAMC,KAAK,CAAC;EACVC,WAAWA,CAAA,EAAG;IACZ,IAAI,CAACC,MAAM,CAACC,SAAS,CAAC;EACxB;EAEAC,OAAOA,CAACC,CAAC,EAAEC,CAAC,EAAEC,CAAC,EAAEC,CAAC,EAAEC,CAAC,EAAE;IACrB,IAAIN,SAAS,CAACO,MAAM,GAAG,CAAC,EAAE;MACxB;MACA,MAAMC,EAAE,GAAGb,QAAQ,CAACc,aAAa,CAACP,CAAC,CAAC;MACpC,MAAMQ,EAAE,GAAGf,QAAQ,CAACc,aAAa,CAACN,CAAC,CAAC;MACpC,IAAI,CAACQ,KAAK,GAAG;QACXC,GAAG,EAAEC,IAAI,CAACC,GAAG,CAACN,EAAE,CAACO,GAAG,EAAEL,EAAE,CAACK,GAAG,CAAC;QAC7BC,IAAI,EAAEH,IAAI,CAACC,GAAG,CAACN,EAAE,CAACS,GAAG,EAAEP,EAAE,CAACO,GAAG,CAAC;QAC9BC,MAAM,EAAEL,IAAI,CAACM,GAAG,CAACX,EAAE,CAACO,GAAG,EAAEL,EAAE,CAACK,GAAG,CAAC;QAChCK,KAAK,EAAEP,IAAI,CAACM,GAAG,CAACX,EAAE,CAACS,GAAG,EAAEP,EAAE,CAACO,GAAG,CAAC;QAC/BI,SAAS,EAAEjB;MACb,CAAC;MAED,IAAI,CAACH,OAAO,CAACO,EAAE,CAACO,GAAG,EAAEP,EAAE,CAACS,GAAG,EAAEP,EAAE,CAACK,GAAG,EAAEL,EAAE,CAACO,GAAG,EAAEX,CAAC,CAAC;IACjD,CAAC,MAAM;MACL;MACA,IAAI,CAACK,KAAK,GAAG;QACXC,GAAG,EAAEC,IAAI,CAACC,GAAG,CAACZ,CAAC,EAAEE,CAAC,CAAC;QACnBY,IAAI,EAAEH,IAAI,CAACC,GAAG,CAACX,CAAC,EAAEE,CAAC,CAAC;QACpBa,MAAM,EAAEL,IAAI,CAACM,GAAG,CAACjB,CAAC,EAAEE,CAAC,CAAC;QACtBgB,KAAK,EAAEP,IAAI,CAACM,GAAG,CAAChB,CAAC,EAAEE,CAAC,CAAC;QACrBgB,SAAS,EAAEf;MACb,CAAC;IACH;EACF;EAEAP,MAAMA,CAACuB,IAAI,EAAE;IACX,QAAQA,IAAI,CAACf,MAAM;MACjB,KAAK,CAAC;QAAE;QACN,IAAI,CAACN,OAAO,CAACqB,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,CAAC;QACzD;MACF,KAAK,CAAC;QAAE;QACN,IAAI,CAACrB,OAAO,CAACqB,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,CAAC;QAChD;MAEF,KAAK,CAAC;QAAE;QACN,IAAI,CAACrB,OAAO,CAACqB,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,CAAC;QACvC;MACF,KAAK,CAAC;QAAE;QACN,IAAI,CAACrB,OAAO,CAACqB,IAAI,CAAC,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B;MAEF,KAAK,CAAC;QAAE;UACN,MAAMC,KAAK,GAAGD,IAAI,CAAC,CAAC,CAAC;UACrB,IAAIC,KAAK,YAAY1B,KAAK,EAAE;YAC1B;YACA,IAAI,CAACc,KAAK,GAAG;cACXC,GAAG,EAAEW,KAAK,CAACZ,KAAK,CAACC,GAAG;cACpBI,IAAI,EAAEO,KAAK,CAACZ,KAAK,CAACK,IAAI;cACtBE,MAAM,EAAEK,KAAK,CAACZ,KAAK,CAACO,MAAM;cAC1BE,KAAK,EAAEG,KAAK,CAACZ,KAAK,CAACS,KAAK;cACxBC,SAAS,EAAEE,KAAK,CAACF;YACnB,CAAC;UACH,CAAC,MAAM,IAAIE,KAAK,YAAYC,KAAK,EAAE;YACjC;YACA,IAAI,CAACzB,MAAM,CAACwB,KAAK,CAAC;UACpB,CAAC,MAAM,IAAIA,KAAK,CAACX,GAAG,IAAIW,KAAK,CAACP,IAAI,IAAIO,KAAK,CAACL,MAAM,IAAIK,KAAK,CAACH,KAAK,EAAE;YACjE;YACA,IAAI,CAACT,KAAK,GAAG;cACXC,GAAG,EAAEW,KAAK,CAACX,GAAG;cACdI,IAAI,EAAEO,KAAK,CAACP,IAAI;cAChBE,MAAM,EAAEK,KAAK,CAACL,MAAM;cACpBE,KAAK,EAAEG,KAAK,CAACH,KAAK;cAClBC,SAAS,EAAEE,KAAK,CAACF;YACnB,CAAC;UACH,CAAC,MAAM;YACL;YACA,MAAMI,IAAI,GAAG9B,QAAQ,CAAC+B,QAAQ,CAACH,KAAK,CAAC;YACrC,IAAIE,IAAI,CAACb,GAAG,EAAE;cACZ,IAAI,CAACD,KAAK,GAAG;gBACXC,GAAG,EAAEa,IAAI,CAACb,GAAG;gBACbI,IAAI,EAAES,IAAI,CAACT,IAAI;gBACfE,MAAM,EAAEO,IAAI,CAACP,MAAM;gBACnBE,KAAK,EAAEK,IAAI,CAACL,KAAK;gBACjBC,SAAS,EAAEI,IAAI,CAACJ;cAClB,CAAC;YACH,CAAC,MAAM;cACL,IAAI,CAACV,KAAK,GAAG;gBACXC,GAAG,EAAEa,IAAI,CAACV,GAAG;gBACbC,IAAI,EAAES,IAAI,CAACR,GAAG;gBACdC,MAAM,EAAEO,IAAI,CAACV,GAAG;gBAChBK,KAAK,EAAEK,IAAI,CAACR,GAAG;gBACfI,SAAS,EAAEI,IAAI,CAACJ;cAClB,CAAC;YACH;UACF;UACA;QACF;MAEA,KAAK,CAAC;QACJ,IAAI,CAACV,KAAK,GAAG;UACXC,GAAG,EAAE,CAAC;UACNI,IAAI,EAAE,CAAC;UACPE,MAAM,EAAE,CAAC;UACTE,KAAK,EAAE;QACT,CAAC;QACD;MAEF;QACE,MAAM,IAAIO,KAAK,CAAC,qDAAqDL,IAAI,CAACf,MAAM,EAAE,CAAC;IACvF;EACF;EAEA,IAAIK,GAAGA,CAAA,EAAG;IACR,OAAO,IAAI,CAACD,KAAK,CAACC,GAAG,IAAI,CAAC;EAC5B;EAEA,IAAIA,GAAGA,CAACW,KAAK,EAAE;IACb,IAAI,CAACZ,KAAK,CAACC,GAAG,GAAGW,KAAK;EACxB;EAEA,IAAIP,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACL,KAAK,CAACK,IAAI,IAAI,CAAC;EAC7B;EAEA,IAAIA,IAAIA,CAACO,KAAK,EAAE;IACd,IAAI,CAACZ,KAAK,CAACK,IAAI,GAAGO,KAAK;EACzB;EAEA,IAAIL,MAAMA,CAAA,EAAG;IACX,OAAO,IAAI,CAACP,KAAK,CAACO,MAAM,IAAI,CAAC;EAC/B;EAEA,IAAIA,MAAMA,CAACK,KAAK,EAAE;IAChB,IAAI,CAACZ,KAAK,CAACO,MAAM,GAAGK,KAAK;EAC3B;EAEA,IAAIH,KAAKA,CAAA,EAAG;IACV,OAAO,IAAI,CAACT,KAAK,CAACS,KAAK,IAAI,CAAC;EAC9B;EAEA,IAAIA,KAAKA,CAACG,KAAK,EAAE;IACf,IAAI,CAACZ,KAAK,CAACS,KAAK,GAAGG,KAAK;EAC1B;EAEA,IAAIF,SAASA,CAAA,EAAG;IACd,OAAO,IAAI,CAACV,KAAK,CAACU,SAAS;EAC7B;EAEA,IAAIA,SAASA,CAACE,KAAK,EAAE;IACnB,IAAI,CAACZ,KAAK,CAACU,SAAS,GAAGE,KAAK;EAC9B;EAEA,IAAIK,oBAAoBA,CAAA,EAAG;IACzB,MAAM;MAACP;IAAS,CAAC,GAAG,IAAI,CAACV,KAAK;IAC9B,IAAIU,SAAS,EAAE;MACb,IAAI,gBAAgB,CAACQ,IAAI,CAACR,SAAS,CAAC,EAAE;QACpC,OAAO,GAAGA,SAAS,GAAG;MACxB;MACA,OAAO,IAAIA,SAAS,IAAI;IAC1B;IACA,OAAO,EAAE;EACX;EAEAS,MAAMA,CAAClB,GAAG,EAAEI,IAAI,EAAEE,MAAM,EAAEE,KAAK,EAAE;IAC/B,IAAI,CAAC,IAAI,CAACT,KAAK,CAACC,GAAG,IAAIA,GAAG,GAAG,IAAI,CAACA,GAAG,EAAE,IAAI,CAACA,GAAG,GAAGA,GAAG;IACrD,IAAI,CAAC,IAAI,CAACD,KAAK,CAACK,IAAI,IAAIA,IAAI,GAAG,IAAI,CAACA,IAAI,EAAE,IAAI,CAACA,IAAI,GAAGA,IAAI;IAC1D,IAAI,CAAC,IAAI,CAACL,KAAK,CAACO,MAAM,IAAIA,MAAM,GAAG,IAAI,CAACA,MAAM,EAAE,IAAI,CAACA,MAAM,GAAGA,MAAM;IACpE,IAAI,CAAC,IAAI,CAACP,KAAK,CAACS,KAAK,IAAIA,KAAK,GAAG,IAAI,CAACA,KAAK,EAAE,IAAI,CAACA,KAAK,GAAGA,KAAK;EACjE;EAEAW,SAASA,CAAChB,GAAG,EAAE;IACb,IAAIA,GAAG,EAAE;MACP,MAAM;QAACiB,UAAU;QAAEC;MAAM,CAAC,GAAGlB,GAAG;MAChC,IAAIiB,UAAU,EAAE;QACd,IAAI,CAACF,MAAM,CAACG,MAAM,EAAED,UAAU,CAAClB,GAAG,EAAEmB,MAAM,EAAED,UAAU,CAACb,GAAG,CAAC;MAC7D;IACF;EACF;EAEAe,eAAeA,CAACC,UAAU,EAAE;IAC1B,MAAMC,OAAO,GAAGzC,QAAQ,CAAC+B,QAAQ,CAACS,UAAU,CAAC;IAC7C,IAAI,CAACL,MAAM,CAACM,OAAO,CAACrB,GAAG,EAAEqB,OAAO,CAACnB,GAAG,EAAEmB,OAAO,CAACrB,GAAG,EAAEqB,OAAO,CAACnB,GAAG,CAAC;EACjE;EAEA,IAAIT,EAAEA,CAAA,EAAG;IACP,OAAOb,QAAQ,CAAC0C,GAAG,CAAC,IAAI,CAACrB,IAAI,CAAC,GAAG,IAAI,CAACJ,GAAG;EAC3C;EAEA,IAAI0B,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI3C,QAAQ,CAAC0C,GAAG,CAAC,IAAI,CAACrB,IAAI,CAAC,IAAI,IAAI,CAACJ,GAAG,EAAE;EAClD;EAEA,IAAIF,EAAEA,CAAA,EAAG;IACP,OAAOf,QAAQ,CAAC0C,GAAG,CAAC,IAAI,CAACjB,KAAK,CAAC,GAAG,IAAI,CAACF,MAAM;EAC/C;EAEA,IAAIqB,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI5C,QAAQ,CAAC0C,GAAG,CAAC,IAAI,CAACjB,KAAK,CAAC,IAAI,IAAI,CAACF,MAAM,EAAE;EACtD;EAEA,IAAIsB,KAAKA,CAAA,EAAG;IACV,OAAO,GAAG,IAAI,CAACZ,oBAAoB,GAAG,IAAI,CAACpB,EAAE,IAAI,IAAI,CAACE,EAAE,EAAE;EAC5D;EAEA,IAAI+B,MAAMA,CAAA,EAAG;IACX,OAAO,GAAG,IAAI,CAACb,oBAAoB,GAAG,IAAI,CAACU,IAAI,IAAI,IAAI,CAACC,IAAI,EAAE;EAChE;EAEA,IAAIG,UAAUA,CAAA,EAAG;IACf,OAAO,IAAI,CAACC,KAAK,GAAG,CAAC,GAAG,IAAI,CAACH,KAAK,GAAG,IAAI,CAACZ,oBAAoB,GAAG,IAAI,CAACpB,EAAE;EAC1E;EAEA,IAAIoC,WAAWA,CAAA,EAAG;IAChB,OAAO,IAAI,CAACD,KAAK,GAAG,CAAC,GAAG,IAAI,CAACF,MAAM,GAAG,IAAI,CAACb,oBAAoB,GAAG,IAAI,CAACU,IAAI;EAC7E;EAEA,IAAIK,KAAKA,CAAA,EAAG;IACV,OAAO,CAAC,CAAC,GAAG,IAAI,CAACzB,MAAM,GAAG,IAAI,CAACN,GAAG,KAAK,CAAC,GAAG,IAAI,CAACQ,KAAK,GAAG,IAAI,CAACJ,IAAI,CAAC;EACpE;EAEA6B,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACL,KAAK;EACnB;EAEAM,UAAUA,CAACC,KAAK,EAAE;IAChB,IAAIA,KAAK,CAAC1B,SAAS,IAAI,IAAI,CAACA,SAAS,IAAI0B,KAAK,CAAC1B,SAAS,KAAK,IAAI,CAACA,SAAS,EAAE,OAAO,KAAK;IACzF,IAAI0B,KAAK,CAAC7B,MAAM,GAAG,IAAI,CAACN,GAAG,EAAE,OAAO,KAAK;IACzC,IAAImC,KAAK,CAACnC,GAAG,GAAG,IAAI,CAACM,MAAM,EAAE,OAAO,KAAK;IACzC,IAAI6B,KAAK,CAAC3B,KAAK,GAAG,IAAI,CAACJ,IAAI,EAAE,OAAO,KAAK;IACzC,IAAI+B,KAAK,CAAC/B,IAAI,GAAG,IAAI,CAACI,KAAK,EAAE,OAAO,KAAK;IACzC,OAAO,IAAI;EACb;EAEA4B,QAAQA,CAACb,UAAU,EAAE;IACnB,MAAMC,OAAO,GAAGzC,QAAQ,CAAC+B,QAAQ,CAACS,UAAU,CAAC;IAC7C,OAAO,IAAI,CAACc,UAAU,CAACb,OAAO,CAAC;EACjC;EAEAa,UAAUA,CAACb,OAAO,EAAE;IAClB,IAAIA,OAAO,CAACf,SAAS,IAAI,IAAI,CAACA,SAAS,IAAIe,OAAO,CAACf,SAAS,KAAK,IAAI,CAACA,SAAS,EAAE,OAAO,KAAK;IAC7F,OACEe,OAAO,CAACrB,GAAG,IAAI,IAAI,CAACH,GAAG,IACvBwB,OAAO,CAACrB,GAAG,IAAI,IAAI,CAACG,MAAM,IAC1BkB,OAAO,CAACnB,GAAG,IAAI,IAAI,CAACD,IAAI,IACxBoB,OAAO,CAACnB,GAAG,IAAI,IAAI,CAACG,KAAK;EAE7B;EAEA8B,cAAcA,CAACC,EAAE,EAAE;IACjB,KAAK,IAAIlC,GAAG,GAAG,IAAI,CAACD,IAAI,EAAEC,GAAG,IAAI,IAAI,CAACG,KAAK,EAAEH,GAAG,EAAE,EAAE;MAClD,KAAK,IAAIF,GAAG,GAAG,IAAI,CAACH,GAAG,EAAEG,GAAG,IAAI,IAAI,CAACG,MAAM,EAAEH,GAAG,EAAE,EAAE;QAClDoC,EAAE,CAACxD,QAAQ,CAACyD,aAAa,CAACrC,GAAG,EAAEE,GAAG,CAAC,EAAEF,GAAG,EAAEE,GAAG,CAAC;MAChD;IACF;EACF;AACF;AAEAoC,MAAM,CAACC,OAAO,GAAGzD,KAAK","ignoreList":[]}