@yuanliwei/exceljs 4.4.0 → 4.4.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';\n\nmodule.exports = {\n  ValueType: {\n    Null: 0,\n    Merge: 1,\n    Number: 2,\n    String: 3,\n    Date: 4,\n    Hyperlink: 5,\n    Formula: 6,\n    SharedString: 7,\n    RichText: 8,\n    Boolean: 9,\n    Error: 10,\n  },\n  FormulaType: {\n    None: 0,\n    Master: 1,\n    Shared: 2,\n  },\n  RelationshipType: {\n    None: 0,\n    OfficeDocument: 1,\n    Worksheet: 2,\n    CalcChain: 3,\n    SharedStrings: 4,\n    Styles: 5,\n    Theme: 6,\n    Hyperlink: 7,\n  },\n  DocumentType: {\n    Xlsx: 1,\n  },\n  ReadingOrder: {\n    LeftToRight: 1,\n    RightToLeft: 2,\n  },\n  ErrorValue: {\n    NotApplicable: '#N/A',\n    Ref: '#REF!',\n    Name: '#NAME?',\n    DivZero: '#DIV/0!',\n    Null: '#NULL!',\n    Value: '#VALUE!',\n    Num: '#NUM!',\n  },\n};\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,67 @@
+"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 = _ref.type,
+      imageId = _ref.imageId,
+      range = _ref.range,
+      hyperlinks = _ref.hyperlinks;
+    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');\nconst Anchor = require('./anchor');\n\nclass Image {\n  constructor(worksheet, model) {\n    this.worksheet = worksheet;\n    this.model = model;\n  }\n\n  get model() {\n    switch (this.type) {\n      case 'background':\n        return {\n          type: this.type,\n          imageId: this.imageId,\n        };\n      case 'image':\n        return {\n          type: this.type,\n          imageId: this.imageId,\n          hyperlinks: this.range.hyperlinks,\n          range: {\n            tl: this.range.tl.model,\n            br: this.range.br && this.range.br.model,\n            ext: this.range.ext,\n            editAs: this.range.editAs,\n          },\n        };\n      default:\n        throw new Error('Invalid Image Type');\n    }\n  }\n\n  set model({type, imageId, range, hyperlinks}) {\n    this.type = type;\n    this.imageId = imageId;\n\n    if (type === 'image') {\n      if (typeof range === 'string') {\n        const decoded = colCache.decode(range);\n        this.range = {\n          tl: new Anchor(this.worksheet, {col: decoded.left, row: decoded.top}, -1),\n          br: new Anchor(this.worksheet, {col: decoded.right, row: decoded.bottom}, 0),\n          editAs: 'oneCell',\n        };\n      } else {\n        this.range = {\n          tl: new Anchor(this.worksheet, range.tl, 0),\n          br: range.br && new Anchor(this.worksheet, range.br, 0),\n          ext: range.ext,\n          editAs: range.editAs,\n          hyperlinks: hyperlinks || range.hyperlinks,\n        };\n      }\n    }\n  }\n}\n\nmodule.exports = Image;\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,IAAnCT,IAAI,GAAAS,IAAA,CAAJT,IAAI;MAAEC,OAAO,GAAAQ,IAAA,CAAPR,OAAO;MAAEE,KAAK,GAAAM,IAAA,CAALN,KAAK;MAAED,UAAU,GAAAO,IAAA,CAAVP,UAAU;IACzC,IAAI,CAACF,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';\n\nconst XLSX = require('../xlsx/xlsx');\n\nclass ModelContainer {\n  constructor(model) {\n    this.model = model;\n  }\n\n  get xlsx() {\n    if (!this._xlsx) {\n      this._xlsx = new XLSX(this);\n    }\n    return this._xlsx;\n  }\n}\n\nmodule.exports = ModelContainer;\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,60 @@
+"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.note;
+    const texts = note.texts;
+    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');\n\nclass Note {\n  constructor(note) {\n    this.note = note;\n  }\n\n  get model() {\n    let value = null;\n    switch (typeof this.note) {\n      case 'string':\n        value = {\n          type: 'note',\n          note: {\n            texts: [\n              {\n                text: this.note,\n              },\n            ],\n          },\n        };\n        break;\n      default:\n        value = {\n          type: 'note',\n          note: this.note,\n        };\n        break;\n    }\n    // Suitable for all cell comments\n    return _.deepMerge({}, Note.DEFAULT_CONFIGS, value);\n  }\n\n  set model(value) {\n    const {note} = value;\n    const {texts} = note;\n    if (texts.length === 1 && Object.keys(texts[0]).length === 1) {\n      this.note = texts[0].text;\n    } else {\n      this.note = note;\n    }\n  }\n\n  static fromModel(model) {\n    const note = new Note();\n    note.model = model;\n    return note;\n  }\n}\n\nNote.DEFAULT_CONFIGS = {\n  note: {\n    margins: {\n      insetmode: 'auto',\n      inset: [0.13, 0.13, 0.25, 0.25],\n    },\n    protection: {\n      locked: 'True',\n      lockText: 'True',\n    },\n    editAs: 'absolute',\n  },\n};\n\nmodule.exports = Note;\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,MAAOF,IAAI,GAAIE,KAAK,CAAbF,IAAI;IACX,MAAOI,KAAK,GAAIJ,IAAI,CAAbI,KAAK;IACZ,IAAIA,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,132 @@
+"use strict";
+
+const _require = require('../utils/utils'),
+  objectFromProps = _require.objectFromProps,
+  range = _require.range,
+  toSortedArray = _require.toSortedArray;
+
+// 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.sourceSheet;
+  let rows = model.rows,
+    columns = model.columns,
+    values = model.values;
+  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 \"".concat(name, "\" was not found in ").concat(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":["_require","require","objectFromProps","range","toSortedArray","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","concat","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');\n\n// TK(2023-10-10): turn this into a class constructor.\n\nfunction makePivotTable(worksheet, model) {\n  // Example `model`:\n  // {\n  //   // Source of data: the entire sheet range is taken,\n  //   // akin to `worksheet1.getSheetValues()`.\n  //   sourceSheet: worksheet1,\n  //\n  //   // Pivot table fields: values indicate field names;\n  //   // they come from the first row in `worksheet1`.\n  //   rows: ['A', 'B'],\n  //   columns: ['C'],\n  //   values: ['E'], // only 1 item possible for now\n  //   metric: 'sum', // only 'sum' possible for now\n  // }\n\n  validate(worksheet, model);\n\n  const {sourceSheet} = model;\n  let {rows, columns, values} = model;\n\n  const cacheFields = makeCacheFields(sourceSheet, [...rows, ...columns]);\n\n  // let {rows, columns, values} use indices instead of names;\n  // names can then be accessed via `pivotTable.cacheFields[index].name`.\n  // *Note*: Using `reduce` as `Object.fromEntries` requires Node 12+;\n  // ExcelJS is >=8.3.0 (as of 2023-10-08).\n  const nameToIndex = cacheFields.reduce((result, cacheField, index) => {\n    result[cacheField.name] = index;\n    return result;\n  }, {});\n  rows = rows.map(row => nameToIndex[row]);\n  columns = columns.map(column => nameToIndex[column]);\n  values = values.map(value => nameToIndex[value]);\n\n  // form pivot table object\n  return {\n    sourceSheet,\n    rows,\n    columns,\n    values,\n    metric: 'sum',\n    cacheFields,\n    // defined in <pivotTableDefinition> of xl/pivotTables/pivotTable1.xml;\n    // also used in xl/workbook.xml\n    cacheId: '10',\n  };\n}\n\nfunction validate(worksheet, model) {\n  if (worksheet.workbook.pivotTables.length === 1) {\n    throw new Error(\n      'A pivot table was already added. At this time, ExcelJS supports at most one pivot table per file.'\n    );\n  }\n\n  if (model.metric && model.metric !== 'sum') {\n    throw new Error('Only the \"sum\" metric is supported at this time.');\n  }\n\n  const headerNames = model.sourceSheet.getRow(1).values.slice(1);\n  const isInHeaderNames = objectFromProps(headerNames, true);\n  for (const name of [...model.rows, ...model.columns, ...model.values]) {\n    if (!isInHeaderNames[name]) {\n      throw new Error(`The header name \"${name}\" was not found in ${model.sourceSheet.name}.`);\n    }\n  }\n\n  if (!model.rows.length) {\n    throw new Error('No pivot table rows specified.');\n  }\n\n  if (!model.columns.length) {\n    throw new Error('No pivot table columns specified.');\n  }\n\n  if (model.values.length !== 1) {\n    throw new Error('Exactly 1 value needs to be specified at this time.');\n  }\n}\n\nfunction makeCacheFields(worksheet, fieldNamesWithSharedItems) {\n  // Cache fields are used in pivot tables to reference source data.\n  //\n  // Example\n  // -------\n  // Turn\n  //\n  //  `worksheet` sheet values [\n  //    ['A', 'B', 'C', 'D', 'E'],\n  //    ['a1', 'b1', 'c1', 4, 5],\n  //    ['a1', 'b2', 'c1', 4, 5],\n  //    ['a2', 'b1', 'c2', 14, 24],\n  //    ['a2', 'b2', 'c2', 24, 35],\n  //    ['a3', 'b1', 'c3', 34, 45],\n  //    ['a3', 'b2', 'c3', 44, 45]\n  //  ];\n  //  fieldNamesWithSharedItems = ['A', 'B', 'C'];\n  //\n  // into\n  //\n  //  [\n  //    { name: 'A', sharedItems: ['a1', 'a2', 'a3'] },\n  //    { name: 'B', sharedItems: ['b1', 'b2'] },\n  //    { name: 'C', sharedItems: ['c1', 'c2', 'c3'] },\n  //    { name: 'D', sharedItems: null },\n  //    { name: 'E', sharedItems: null }\n  //  ]\n\n  const names = worksheet.getRow(1).values;\n  const nameToHasSharedItems = objectFromProps(fieldNamesWithSharedItems, true);\n\n  const aggregate = columnIndex => {\n    const columnValues = worksheet.getColumn(columnIndex).values.splice(2);\n    const columnValuesAsSet = new Set(columnValues);\n    return toSortedArray(columnValuesAsSet);\n  };\n\n  // make result\n  const result = [];\n  for (const columnIndex of range(1, names.length)) {\n    const name = names[columnIndex];\n    const sharedItems = nameToHasSharedItems[name] ? aggregate(columnIndex) : null;\n    result.push({name, sharedItems});\n  }\n  return result;\n}\n\nmodule.exports = {makePivotTable};\n"],"mappings":";;AAAA,MAAAA,QAAA,GAAgDC,OAAO,CAAC,gBAAgB,CAAC;EAAlEC,eAAe,GAAAF,QAAA,CAAfE,eAAe;EAAEC,KAAK,GAAAH,QAAA,CAALG,KAAK;EAAEC,aAAa,GAAAJ,QAAA,CAAbI,aAAa;;AAE5C;;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,MAAOE,WAAW,GAAIF,KAAK,CAApBE,WAAW;EAClB,IAAKC,IAAI,GAAqBH,KAAK,CAA9BG,IAAI;IAAEC,OAAO,GAAYJ,KAAK,CAAxBI,OAAO;IAAEC,MAAM,GAAIL,KAAK,CAAfK,MAAM;EAE1B,MAAMC,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,GAAGhC,eAAe,CAAC6B,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,sBAAAK,MAAA,CAAqBf,IAAI,0BAAAe,MAAA,CAAsB5B,KAAK,CAACE,WAAW,CAACW,IAAI,MAAG,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,EAAE8B,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,GAAG/B,SAAS,CAAC0B,MAAM,CAAC,CAAC,CAAC,CAACpB,MAAM;EACxC,MAAM0B,oBAAoB,GAAGpC,eAAe,CAACkC,yBAAyB,EAAE,IAAI,CAAC;EAE7E,MAAMG,SAAS,GAAGC,WAAW,IAAI;IAC/B,MAAMC,YAAY,GAAGnC,SAAS,CAACoC,SAAS,CAACF,WAAW,CAAC,CAAC5B,MAAM,CAAC+B,MAAM,CAAC,CAAC,CAAC;IACtE,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,CAACJ,YAAY,CAAC;IAC/C,OAAOrC,aAAa,CAACwC,iBAAiB,CAAC;EACzC,CAAC;;EAED;EACA,MAAM3B,MAAM,GAAG,EAAE;EACjB,KAAK,MAAMuB,WAAW,IAAIrC,KAAK,CAAC,CAAC,EAAEkC,KAAK,CAACR,MAAM,CAAC,EAAE;IAChD,MAAMT,IAAI,GAAGiB,KAAK,CAACG,WAAW,CAAC;IAC/B,MAAMM,WAAW,GAAGR,oBAAoB,CAAClB,IAAI,CAAC,GAAGmB,SAAS,CAACC,WAAW,CAAC,GAAG,IAAI;IAC9EvB,MAAM,CAAC8B,IAAI,CAAC;MAAC3B,IAAI;MAAE0B;IAAW,CAAC,CAAC;EAClC;EACA,OAAO7B,MAAM;AACf;AAEA+B,MAAM,CAACC,OAAO,GAAG;EAAC5C;AAAc,CAAC","ignoreList":[]}

package/dist/es5/doc/range.js

@@ -0,0 +1,225 @@
+"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() - ".concat(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.sheetName;
+    if (sheetName) {
+      if (/^[a-zA-Z0-9]*$/.test(sheetName)) {
+        return "".concat(sheetName, "!");
+      }
+      return "'".concat(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 = row.dimensions,
+        number = row.number;
+      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 "$".concat(colCache.n2l(this.left), "$").concat(this.top);
+  }
+  get br() {
+    return colCache.n2l(this.right) + this.bottom;
+  }
+  get $b$r() {
+    return "$".concat(colCache.n2l(this.right), "$").concat(this.bottom);
+  }
+  get range() {
+    return "".concat(this._serialisedSheetName + this.tl, ":").concat(this.br);
+  }
+  get $range() {
+    return "".concat(this._serialisedSheetName + this.$t$l, ":").concat(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","concat","_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');\n\n// used by worksheet to calculate sheet dimensions\nclass Range {\n  constructor() {\n    this.decode(arguments);\n  }\n\n  setTLBR(t, l, b, r, s) {\n    if (arguments.length < 4) {\n      // setTLBR(tl, br, s)\n      const tl = colCache.decodeAddress(t);\n      const br = colCache.decodeAddress(l);\n      this.model = {\n        top: Math.min(tl.row, br.row),\n        left: Math.min(tl.col, br.col),\n        bottom: Math.max(tl.row, br.row),\n        right: Math.max(tl.col, br.col),\n        sheetName: b,\n      };\n\n      this.setTLBR(tl.row, tl.col, br.row, br.col, s);\n    } else {\n      // setTLBR(t, l, b, r, s)\n      this.model = {\n        top: Math.min(t, b),\n        left: Math.min(l, r),\n        bottom: Math.max(t, b),\n        right: Math.max(l, r),\n        sheetName: s,\n      };\n    }\n  }\n\n  decode(argv) {\n    switch (argv.length) {\n      case 5: // [t,l,b,r,s]\n        this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);\n        break;\n      case 4: // [t,l,b,r]\n        this.setTLBR(argv[0], argv[1], argv[2], argv[3]);\n        break;\n\n      case 3: // [tl,br,s]\n        this.setTLBR(argv[0], argv[1], argv[2]);\n        break;\n      case 2: // [tl,br]\n        this.setTLBR(argv[0], argv[1]);\n        break;\n\n      case 1: {\n        const value = argv[0];\n        if (value instanceof Range) {\n          // copy constructor\n          this.model = {\n            top: value.model.top,\n            left: value.model.left,\n            bottom: value.model.bottom,\n            right: value.model.right,\n            sheetName: value.sheetName,\n          };\n        } else if (value instanceof Array) {\n          // an arguments array\n          this.decode(value);\n        } else if (value.top && value.left && value.bottom && value.right) {\n          // a model\n          this.model = {\n            top: value.top,\n            left: value.left,\n            bottom: value.bottom,\n            right: value.right,\n            sheetName: value.sheetName,\n          };\n        } else {\n          // [sheetName!]tl:br\n          const tlbr = colCache.decodeEx(value);\n          if (tlbr.top) {\n            this.model = {\n              top: tlbr.top,\n              left: tlbr.left,\n              bottom: tlbr.bottom,\n              right: tlbr.right,\n              sheetName: tlbr.sheetName,\n            };\n          } else {\n            this.model = {\n              top: tlbr.row,\n              left: tlbr.col,\n              bottom: tlbr.row,\n              right: tlbr.col,\n              sheetName: tlbr.sheetName,\n            };\n          }\n        }\n        break;\n      }\n\n      case 0:\n        this.model = {\n          top: 0,\n          left: 0,\n          bottom: 0,\n          right: 0,\n        };\n        break;\n\n      default:\n        throw new Error(`Invalid number of arguments to _getDimensions() - ${argv.length}`);\n    }\n  }\n\n  get top() {\n    return this.model.top || 1;\n  }\n\n  set top(value) {\n    this.model.top = value;\n  }\n\n  get left() {\n    return this.model.left || 1;\n  }\n\n  set left(value) {\n    this.model.left = value;\n  }\n\n  get bottom() {\n    return this.model.bottom || 1;\n  }\n\n  set bottom(value) {\n    this.model.bottom = value;\n  }\n\n  get right() {\n    return this.model.right || 1;\n  }\n\n  set right(value) {\n    this.model.right = value;\n  }\n\n  get sheetName() {\n    return this.model.sheetName;\n  }\n\n  set sheetName(value) {\n    this.model.sheetName = value;\n  }\n\n  get _serialisedSheetName() {\n    const {sheetName} = this.model;\n    if (sheetName) {\n      if (/^[a-zA-Z0-9]*$/.test(sheetName)) {\n        return `${sheetName}!`;\n      }\n      return `'${sheetName}'!`;\n    }\n    return '';\n  }\n\n  expand(top, left, bottom, right) {\n    if (!this.model.top || top < this.top) this.top = top;\n    if (!this.model.left || left < this.left) this.left = left;\n    if (!this.model.bottom || bottom > this.bottom) this.bottom = bottom;\n    if (!this.model.right || right > this.right) this.right = right;\n  }\n\n  expandRow(row) {\n    if (row) {\n      const {dimensions, number} = row;\n      if (dimensions) {\n        this.expand(number, dimensions.min, number, dimensions.max);\n      }\n    }\n  }\n\n  expandToAddress(addressStr) {\n    const address = colCache.decodeEx(addressStr);\n    this.expand(address.row, address.col, address.row, address.col);\n  }\n\n  get tl() {\n    return colCache.n2l(this.left) + this.top;\n  }\n\n  get $t$l() {\n    return `$${colCache.n2l(this.left)}$${this.top}`;\n  }\n\n  get br() {\n    return colCache.n2l(this.right) + this.bottom;\n  }\n\n  get $b$r() {\n    return `$${colCache.n2l(this.right)}$${this.bottom}`;\n  }\n\n  get range() {\n    return `${this._serialisedSheetName + this.tl}:${this.br}`;\n  }\n\n  get $range() {\n    return `${this._serialisedSheetName + this.$t$l}:${this.$b$r}`;\n  }\n\n  get shortRange() {\n    return this.count > 1 ? this.range : this._serialisedSheetName + this.tl;\n  }\n\n  get $shortRange() {\n    return this.count > 1 ? this.$range : this._serialisedSheetName + this.$t$l;\n  }\n\n  get count() {\n    return (1 + this.bottom - this.top) * (1 + this.right - this.left);\n  }\n\n  toString() {\n    return this.range;\n  }\n\n  intersects(other) {\n    if (other.sheetName && this.sheetName && other.sheetName !== this.sheetName) return false;\n    if (other.bottom < this.top) return false;\n    if (other.top > this.bottom) return false;\n    if (other.right < this.left) return false;\n    if (other.left > this.right) return false;\n    return true;\n  }\n\n  contains(addressStr) {\n    const address = colCache.decodeEx(addressStr);\n    return this.containsEx(address);\n  }\n\n  containsEx(address) {\n    if (address.sheetName && this.sheetName && address.sheetName !== this.sheetName) return false;\n    return (\n      address.row >= this.top &&\n      address.row <= this.bottom &&\n      address.col >= this.left &&\n      address.col <= this.right\n    );\n  }\n\n  forEachAddress(cb) {\n    for (let col = this.left; col <= this.right; col++) {\n      for (let row = this.top; row <= this.bottom; row++) {\n        cb(colCache.encodeAddress(row, col), row, col);\n      }\n    }\n  }\n}\n\nmodule.exports = Range;\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,sDAAAC,MAAA,CAAsDN,IAAI,CAACf,MAAM,CAAE,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,IAAIM,oBAAoBA,CAAA,EAAG;IACzB,MAAOR,SAAS,GAAI,IAAI,CAACV,KAAK,CAAvBU,SAAS;IAChB,IAAIA,SAAS,EAAE;MACb,IAAI,gBAAgB,CAACS,IAAI,CAACT,SAAS,CAAC,EAAE;QACpC,UAAAO,MAAA,CAAUP,SAAS;MACrB;MACA,WAAAO,MAAA,CAAWP,SAAS;IACtB;IACA,OAAO,EAAE;EACX;EAEAU,MAAMA,CAACnB,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;EAEAY,SAASA,CAACjB,GAAG,EAAE;IACb,IAAIA,GAAG,EAAE;MACP,MAAOkB,UAAU,GAAYlB,GAAG,CAAzBkB,UAAU;QAAEC,MAAM,GAAInB,GAAG,CAAbmB,MAAM;MACzB,IAAID,UAAU,EAAE;QACd,IAAI,CAACF,MAAM,CAACG,MAAM,EAAED,UAAU,CAACnB,GAAG,EAAEoB,MAAM,EAAED,UAAU,CAACd,GAAG,CAAC;MAC7D;IACF;EACF;EAEAgB,eAAeA,CAACC,UAAU,EAAE;IAC1B,MAAMC,OAAO,GAAG1C,QAAQ,CAAC+B,QAAQ,CAACU,UAAU,CAAC;IAC7C,IAAI,CAACL,MAAM,CAACM,OAAO,CAACtB,GAAG,EAAEsB,OAAO,CAACpB,GAAG,EAAEoB,OAAO,CAACtB,GAAG,EAAEsB,OAAO,CAACpB,GAAG,CAAC;EACjE;EAEA,IAAIT,EAAEA,CAAA,EAAG;IACP,OAAOb,QAAQ,CAAC2C,GAAG,CAAC,IAAI,CAACtB,IAAI,CAAC,GAAG,IAAI,CAACJ,GAAG;EAC3C;EAEA,IAAI2B,IAAIA,CAAA,EAAG;IACT,WAAAX,MAAA,CAAWjC,QAAQ,CAAC2C,GAAG,CAAC,IAAI,CAACtB,IAAI,CAAC,OAAAY,MAAA,CAAI,IAAI,CAAChB,GAAG;EAChD;EAEA,IAAIF,EAAEA,CAAA,EAAG;IACP,OAAOf,QAAQ,CAAC2C,GAAG,CAAC,IAAI,CAAClB,KAAK,CAAC,GAAG,IAAI,CAACF,MAAM;EAC/C;EAEA,IAAIsB,IAAIA,CAAA,EAAG;IACT,WAAAZ,MAAA,CAAWjC,QAAQ,CAAC2C,GAAG,CAAC,IAAI,CAAClB,KAAK,CAAC,OAAAQ,MAAA,CAAI,IAAI,CAACV,MAAM;EACpD;EAEA,IAAIuB,KAAKA,CAAA,EAAG;IACV,UAAAb,MAAA,CAAU,IAAI,CAACC,oBAAoB,GAAG,IAAI,CAACrB,EAAE,OAAAoB,MAAA,CAAI,IAAI,CAAClB,EAAE;EAC1D;EAEA,IAAIgC,MAAMA,CAAA,EAAG;IACX,UAAAd,MAAA,CAAU,IAAI,CAACC,oBAAoB,GAAG,IAAI,CAACU,IAAI,OAAAX,MAAA,CAAI,IAAI,CAACY,IAAI;EAC9D;EAEA,IAAIG,UAAUA,CAAA,EAAG;IACf,OAAO,IAAI,CAACC,KAAK,GAAG,CAAC,GAAG,IAAI,CAACH,KAAK,GAAG,IAAI,CAACZ,oBAAoB,GAAG,IAAI,CAACrB,EAAE;EAC1E;EAEA,IAAIqC,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,CAAC1B,MAAM,GAAG,IAAI,CAACN,GAAG,KAAK,CAAC,GAAG,IAAI,CAACQ,KAAK,GAAG,IAAI,CAACJ,IAAI,CAAC;EACpE;EAEA8B,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACL,KAAK;EACnB;EAEAM,UAAUA,CAACC,KAAK,EAAE;IAChB,IAAIA,KAAK,CAAC3B,SAAS,IAAI,IAAI,CAACA,SAAS,IAAI2B,KAAK,CAAC3B,SAAS,KAAK,IAAI,CAACA,SAAS,EAAE,OAAO,KAAK;IACzF,IAAI2B,KAAK,CAAC9B,MAAM,GAAG,IAAI,CAACN,GAAG,EAAE,OAAO,KAAK;IACzC,IAAIoC,KAAK,CAACpC,GAAG,GAAG,IAAI,CAACM,MAAM,EAAE,OAAO,KAAK;IACzC,IAAI8B,KAAK,CAAC5B,KAAK,GAAG,IAAI,CAACJ,IAAI,EAAE,OAAO,KAAK;IACzC,IAAIgC,KAAK,CAAChC,IAAI,GAAG,IAAI,CAACI,KAAK,EAAE,OAAO,KAAK;IACzC,OAAO,IAAI;EACb;EAEA6B,QAAQA,CAACb,UAAU,EAAE;IACnB,MAAMC,OAAO,GAAG1C,QAAQ,CAAC+B,QAAQ,CAACU,UAAU,CAAC;IAC7C,OAAO,IAAI,CAACc,UAAU,CAACb,OAAO,CAAC;EACjC;EAEAa,UAAUA,CAACb,OAAO,EAAE;IAClB,IAAIA,OAAO,CAAChB,SAAS,IAAI,IAAI,CAACA,SAAS,IAAIgB,OAAO,CAAChB,SAAS,KAAK,IAAI,CAACA,SAAS,EAAE,OAAO,KAAK;IAC7F,OACEgB,OAAO,CAACtB,GAAG,IAAI,IAAI,CAACH,GAAG,IACvByB,OAAO,CAACtB,GAAG,IAAI,IAAI,CAACG,MAAM,IAC1BmB,OAAO,CAACpB,GAAG,IAAI,IAAI,CAACD,IAAI,IACxBqB,OAAO,CAACpB,GAAG,IAAI,IAAI,CAACG,KAAK;EAE7B;EAEA+B,cAAcA,CAACC,EAAE,EAAE;IACjB,KAAK,IAAInC,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;QAClDqC,EAAE,CAACzD,QAAQ,CAAC0D,aAAa,CAACtC,GAAG,EAAEE,GAAG,CAAC,EAAEF,GAAG,EAAEE,GAAG,CAAC;MAChD;IACF;EACF;AACF;AAEAqC,MAAM,CAACC,OAAO,GAAG1D,KAAK","ignoreList":[]}