@candidstartup/infinisheet-types 0.7.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023-2024, Tim Wiegand
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,10 @@
+[![NPM Type Definitions](https://img.shields.io/npm/types/@candidstartup/infinisheet-types)](https://www.npmjs.com/package/@candidstartup/infinisheet-types)
+[![NPM Version](https://img.shields.io/npm/v/@candidstartup/infinisheet-types)](https://www.npmjs.com/package/@candidstartup/infinisheet-types)
+[![NPM bundle size](https://img.shields.io/bundlephobia/minzip/@candidstartup/infinisheet-types)](https://www.npmjs.com/package/@candidstartup/infinisheet-types)
+[![Build Status](https://github.com/TheCandidStartup/infinisheet/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/TheCandidStartup/infinisheet/actions/workflows/build.yml)
+
+# @candidstartup/infinisheet-types
+
+Common types shared by InfiniSheet frontend and backend packages.
+
+

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Interface used to determine the size and positioning offset for items in a single dimension.
+ */
+interface ItemOffsetMapping {
+    /** Size of item with given index */
+    itemSize(itemIndex: number): number;
+    /** Offset from start of container to specified item
+     *
+     * `itemOffset(n)` should be equal to `Sum{i:0->n-1}(itemSize(i))`
+     *
+     * To efficiently support large containers, cost should be `O(logn)` or better.
+     */
+    itemOffset(itemIndex: number): number;
+    /** Given an offset, return the index of the item that intersects that offset, together with the start offset of that item */
+    offsetToItem(offset: number): [itemIndex: number, startOffset: number];
+}
+
+/**
+ * Implementation of {@link ItemOffsetMapping} for use when all items have a fixed size
+ */
+declare class FixedSizeItemOffsetMapping implements ItemOffsetMapping {
+    #private;
+    /**
+     * @param itemSize - Size to use for all items
+     */
+    constructor(itemSize: number);
+    itemSize(_itemIndex: number): number;
+    itemOffset(itemIndex: number): number;
+    offsetToItem(offset: number): [itemIndex: number, startOffset: number];
+}
+
+/**
+ * Implementation of {@link ItemOffsetMapping} for use when initial items have variable sizes.
+ */
+declare class VariableSizeItemOffsetMapping implements ItemOffsetMapping {
+    #private;
+    /**
+     * @param defaultItemSize - Size to use for all other items
+     * @param sizes - Array of sizes to use for the initial items, one size per item
+     */
+    constructor(defaultItemSize: number, sizes: number[]);
+    itemSize(itemIndex: number): number;
+    itemOffset(itemIndex: number): number;
+    offsetToItem(offset: number): [itemIndex: number, startOffset: number];
+}
+
+/** Possible spreadsheet error values
+ *
+ * Includes those that can be returned by `ERROR.TYPE` and additional values
+ * introduced by more recent versions of Excel.
+*/
+type CellErrorValue = '#NULL!' | '#DIV/0!' | '#VALUE!' | '#REF!' | '#NAME?' | '#NUM!' | '#N/A' | '#GETTING_DATA' | '#SPILL!' | '#UNKNOWN!' | '#FIELD!' | '#CALC!';
+/** Type that represents an error value stored in a cell
+ *
+ * Defined as a discriminated union so that additional cell value types
+ * can be added in future.
+ */
+interface CellError {
+    /** Discriminated union tag */
+    type: 'CellError';
+    /** {@link CellErrorValue | Error Value} */
+    value: CellErrorValue;
+}
+/** Possible types for a cell value
+ *
+ * The native JavaScript types string, number and boolean represent the *Text*, *Number* and *Logical*
+ * spreadsheet data types. {@link CellError} represents an *Error Value*.
+ *
+ * Undefined is used to represent a cell with no defined value. Null represents a cell that has been
+ * explicitly marked as empty.
+*/
+type CellValue = string | number | boolean | null | undefined | CellError;
+/**
+ * Interface used to access the data in a spreadsheet
+ *
+ * The data exposed through the interface may change over time outside of any changes made through the interface. The caller
+ * can use the {@link subscribe} method to be notified when the data changes. When reading data, the caller must first request
+ * a snapshot using {@link getSnapshot}. All values returned by gettors are relative to a specified snapshot. The values will be
+ * consistent with each other as long as the same snapshot is used.
+ *
+ * @typeParam Snapshot - Type of snapshot. Implementations are free to use whatever type makes sense for them.
+ */
+interface SpreadsheetData<Snapshot> {
+    /** Subscribe to data changes */
+    subscribe(onDataChange: () => void): () => void;
+    /** Return a snapshot to use when accessing values at a consistent point in time */
+    getSnapshot(): Snapshot;
+    /** Number of rows in the spreadsheet */
+    getRowCount(snapshot: Snapshot): number;
+    /** {@link ItemOffsetMapping} which describes sizes and offsets to start of rows */
+    getRowItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping;
+    /** Number of columns in the spreadsheet */
+    getColumnCount(snapshot: Snapshot): number;
+    /** {@link ItemOffsetMapping} which describes sizes and offsets to start of columns */
+    getColumnItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping;
+    /** Value of specified cell using 0-based row and column indexes */
+    getCellValue(snapshot: Snapshot, row: number, column: number): CellValue;
+    /** Format of specified cell using 0-based row and column indexes */
+    getCellFormat(snapshot: Snapshot, row: number, column: number): string | undefined;
+    /** Set value and format of specified cell
+     *
+     * @returns True if the change was successfully applied
+     */
+    setCellValueAndFormat(row: number, column: number, value: CellValue, format: string | undefined): boolean;
+}
+declare class EmptySpreadsheetData implements SpreadsheetData<number> {
+    subscribe(_onDataChange: () => void): () => void;
+    getSnapshot(): number;
+    getRowCount(_snapshot: number): number;
+    getRowItemOffsetMapping(_snapshot: number): ItemOffsetMapping;
+    getColumnCount(_snapshot: number): number;
+    getColumnItemOffsetMapping(_snapshot: number): ItemOffsetMapping;
+    getCellValue(_snapshot: number, _row: number, _column: number): CellValue;
+    getCellFormat(_snapshot: number, _row: number, _column: number): string | undefined;
+    setCellValueAndFormat(_row: number, _column: number, _value: CellValue, _format: string | undefined): boolean;
+}
+
+/**  Classic Spreadsheet reference to Column (e.g "A") */
+type ColRef = string;
+/**  Classic Spreadsheet reference to Cell (e.g. "A1"), Row (e.g. "1") or Column (e.g "A") */
+type RowColRef = string;
+/** Equivalent to {@link RowColRef} as coordinate pair. "A1" has coords [0,0], "1" is [0,undefined] and "A" is [undefined,0] */
+type RowColCoords = [row: number | undefined, col: number | undefined];
+/** Converts a {@link ColRef} to the 0-based index of the column */
+declare function colRefToIndex(col: ColRef): number;
+/** Converts a 0-based column index to a {@link ColRef} */
+declare function indexToColRef(index: number): ColRef;
+/** Splits a RowColRef into a 0-based row index and a {@link ColRef} */
+declare function splitRowColRef(ref: RowColRef): [row: number | undefined, col: ColRef | undefined];
+/**  Converts a {@link RowColRef} to {@link RowColCoords} */
+declare function rowColRefToCoords(ref: RowColRef): RowColCoords;
+/**  Converts {@link RowColCoords} to a {@link RowColRef} */
+declare function rowColCoordsToRef(row: number | undefined, col: number | undefined): RowColRef;
+
+export { type CellError, type CellErrorValue, type CellValue, type ColRef, EmptySpreadsheetData, FixedSizeItemOffsetMapping, type ItemOffsetMapping, type RowColCoords, type RowColRef, type SpreadsheetData, VariableSizeItemOffsetMapping, colRefToIndex, indexToColRef, rowColCoordsToRef, rowColRefToCoords, splitRowColRef };

package/dist/index.js

@@ -0,0 +1,149 @@
+import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
+
+var _FixedSizeItemOffsetMapping_fixedItemSize;
+/**
+ * Implementation of {@link ItemOffsetMapping} for use when all items have a fixed size
+ */
+class FixedSizeItemOffsetMapping {
+    /**
+     * @param itemSize - Size to use for all items
+     */
+    constructor(itemSize) {
+        _FixedSizeItemOffsetMapping_fixedItemSize.set(this, void 0);
+        __classPrivateFieldSet(this, _FixedSizeItemOffsetMapping_fixedItemSize, itemSize, "f");
+    }
+    itemSize(_itemIndex) {
+        return __classPrivateFieldGet(this, _FixedSizeItemOffsetMapping_fixedItemSize, "f");
+    }
+    itemOffset(itemIndex) {
+        return itemIndex * __classPrivateFieldGet(this, _FixedSizeItemOffsetMapping_fixedItemSize, "f");
+    }
+    offsetToItem(offset) {
+        const itemIndex = Math.floor(offset / __classPrivateFieldGet(this, _FixedSizeItemOffsetMapping_fixedItemSize, "f"));
+        const startOffset = itemIndex * __classPrivateFieldGet(this, _FixedSizeItemOffsetMapping_fixedItemSize, "f");
+        return [itemIndex, startOffset];
+    }
+}
+_FixedSizeItemOffsetMapping_fixedItemSize = new WeakMap();
+
+var _VariableSizeItemOffsetMapping_defaultItemSize, _VariableSizeItemOffsetMapping_sizes;
+/**
+ * Implementation of {@link ItemOffsetMapping} for use when initial items have variable sizes.
+ */
+class VariableSizeItemOffsetMapping {
+    /**
+     * @param defaultItemSize - Size to use for all other items
+     * @param sizes - Array of sizes to use for the initial items, one size per item
+     */
+    constructor(defaultItemSize, sizes) {
+        _VariableSizeItemOffsetMapping_defaultItemSize.set(this, void 0);
+        _VariableSizeItemOffsetMapping_sizes.set(this, void 0);
+        __classPrivateFieldSet(this, _VariableSizeItemOffsetMapping_defaultItemSize, defaultItemSize, "f");
+        __classPrivateFieldSet(this, _VariableSizeItemOffsetMapping_sizes, sizes, "f");
+    }
+    itemSize(itemIndex) {
+        return (itemIndex < __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f").length) ? __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f")[itemIndex] : __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_defaultItemSize, "f");
+    }
+    itemOffset(itemIndex) {
+        let offset = 0;
+        let length = __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f").length;
+        if (itemIndex > length) {
+            const numDefaultSize = itemIndex - length;
+            offset = numDefaultSize * __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_defaultItemSize, "f");
+        }
+        else {
+            length = itemIndex;
+        }
+        for (let i = 0; i < length; i++) {
+            offset += __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f")[i];
+        }
+        return offset;
+    }
+    offsetToItem(offset) {
+        let startOffset = 0;
+        const length = __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f").length;
+        for (let i = 0; i < length; i++) {
+            const size = __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_sizes, "f")[i];
+            if (startOffset + size > offset) {
+                return [i, startOffset];
+            }
+            startOffset += size;
+        }
+        const itemIndex = Math.floor((offset - startOffset) / __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_defaultItemSize, "f"));
+        startOffset += itemIndex * __classPrivateFieldGet(this, _VariableSizeItemOffsetMapping_defaultItemSize, "f");
+        return [itemIndex + length, startOffset];
+    }
+}
+_VariableSizeItemOffsetMapping_defaultItemSize = new WeakMap(), _VariableSizeItemOffsetMapping_sizes = new WeakMap();
+
+const rowItemOffsetMapping = new FixedSizeItemOffsetMapping(30);
+const columnItemOffsetMapping = new FixedSizeItemOffsetMapping(100);
+class EmptySpreadsheetData {
+    subscribe(_onDataChange) { return () => { }; }
+    getSnapshot() { return 0; }
+    getRowCount(_snapshot) { return 0; }
+    getRowItemOffsetMapping(_snapshot) { return rowItemOffsetMapping; }
+    getColumnCount(_snapshot) { return 0; }
+    getColumnItemOffsetMapping(_snapshot) { return columnItemOffsetMapping; }
+    getCellValue(_snapshot, _row, _column) { return null; }
+    getCellFormat(_snapshot, _row, _column) { return undefined; }
+    setCellValueAndFormat(_row, _column, _value, _format) { return false; }
+}
+
+/** Converts a {@link ColRef} to the 0-based index of the column */
+function colRefToIndex(col) {
+    let n = 0;
+    for (let i = 0; i < col.length; i++) {
+        n = col.charCodeAt(i) - 64 + n * 26;
+    }
+    return n - 1;
+}
+/** Converts a 0-based column index to a {@link ColRef} */
+function indexToColRef(index) {
+    let ret = "";
+    index++;
+    while (index > 0) {
+        index--;
+        const remainder = index % 26;
+        index = Math.floor(index / 26);
+        ret = String.fromCharCode(65 + remainder) + ret;
+    }
+    return ret;
+}
+/** Splits a RowColRef into a 0-based row index and a {@link ColRef} */
+function splitRowColRef(ref) {
+    const re = /^([A-Z]*)(\d*)$/;
+    const found = ref.match(re);
+    if (!found)
+        return [undefined, undefined];
+    const col = found[1];
+    const row = parseInt(found[2]);
+    return [(row > 0) ? row - 1 : undefined, col ? col : undefined];
+}
+/**  Converts a {@link RowColRef} to {@link RowColCoords} */
+function rowColRefToCoords(ref) {
+    const [row, col] = splitRowColRef(ref);
+    return [row, col ? colRefToIndex(col) : undefined];
+}
+/**  Converts {@link RowColCoords} to a {@link RowColRef} */
+function rowColCoordsToRef(row, col) {
+    if (row !== undefined) {
+        if (col !== undefined) {
+            return indexToColRef(col) + (row + 1);
+        }
+        else {
+            return (row + 1).toString();
+        }
+    }
+    else {
+        if (col !== undefined) {
+            return indexToColRef(col);
+        }
+        else {
+            return "";
+        }
+    }
+}
+
+export { EmptySpreadsheetData, FixedSizeItemOffsetMapping, VariableSizeItemOffsetMapping, colRefToIndex, indexToColRef, rowColCoordsToRef, rowColRefToCoords, splitRowColRef };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/FixedSizeItemOffsetMapping.ts","../src/VariableSizeItemOffsetMapping.ts","../src/SpreadsheetData.ts","../src/RowColRef.ts"],"sourcesContent":["import type { ItemOffsetMapping } from './ItemOffsetMapping';\n\n/**\n * Implementation of {@link ItemOffsetMapping} for use when all items have a fixed size\n */\nexport class FixedSizeItemOffsetMapping implements ItemOffsetMapping {\n  /**\n   * @param itemSize - Size to use for all items\n   */\n  constructor (itemSize: number) {\n    this.#fixedItemSize = itemSize;\n  }\n\n  itemSize(_itemIndex: number): number {\n    return this.#fixedItemSize;\n  }\n\n  itemOffset(itemIndex: number): number {\n    return itemIndex * this.#fixedItemSize;\n  }\n\n  offsetToItem(offset: number): [itemIndex: number, startOffset: number] {\n    const itemIndex = Math.floor(offset / this.#fixedItemSize);\n    const startOffset = itemIndex * this.#fixedItemSize;\n\n    return [itemIndex, startOffset];\n  }\n\n  #fixedItemSize: number;\n}\n\n","import type { ItemOffsetMapping } from './ItemOffsetMapping';\n\n/**\n * Implementation of {@link ItemOffsetMapping} for use when initial items have variable sizes.\n */\nexport class VariableSizeItemOffsetMapping implements ItemOffsetMapping {\n  /**\n   * @param defaultItemSize - Size to use for all other items\n   * @param sizes - Array of sizes to use for the initial items, one size per item\n   */\n  constructor (defaultItemSize: number, sizes: number[]) {\n    this.#defaultItemSize = defaultItemSize;\n    this.#sizes = sizes;\n  }\n\n  itemSize(itemIndex: number): number {\n    return (itemIndex < this.#sizes.length) ? this.#sizes[itemIndex] : this.#defaultItemSize;\n  }\n\n  itemOffset(itemIndex: number): number {\n    let offset = 0;\n    let length = this.#sizes.length;\n    if (itemIndex > length) {\n      const numDefaultSize = itemIndex - length;\n      offset = numDefaultSize * this.#defaultItemSize;\n    } else {\n      length = itemIndex;\n    }\n    \n    for (let i = 0; i < length; i ++)\n    {\n      offset += this.#sizes[i];\n    }\n\n    return offset;\n  }\n\n  offsetToItem(offset: number): [itemIndex: number, startOffset: number] {\n    let startOffset = 0;\n    const length = this.#sizes.length;\n    for (let i = 0; i < length; i ++) {\n      const size = this.#sizes[i];\n      if (startOffset + size > offset) {\n        return [i, startOffset];\n      }\n      startOffset += size;\n    }\n\n    const itemIndex = Math.floor((offset - startOffset) / this.#defaultItemSize);\n    startOffset += itemIndex * this.#defaultItemSize;\n\n    return [itemIndex+length, startOffset];\n  }\n\n  #defaultItemSize: number;\n  #sizes: number[];\n}\n","import type { ItemOffsetMapping } from \"./ItemOffsetMapping\";\nimport { FixedSizeItemOffsetMapping } from \"./FixedSizeItemOffsetMapping\";\n\n/** Possible spreadsheet error values\n * \n * Includes those that can be returned by `ERROR.TYPE` and additional values\n * introduced by more recent versions of Excel.\n*/\nexport type CellErrorValue = '#NULL!' | \n  '#DIV/0!' |\n  '#VALUE!' |\n  '#REF!' |\n  '#NAME?' |\n  '#NUM!' |\n  '#N/A' |\n  '#GETTING_DATA' |\n  '#SPILL!' |\n  '#UNKNOWN!' |\n  '#FIELD!' |\n  '#CALC!';\n\n/** Type that represents an error value stored in a cell\n * \n * Defined as a discriminated union so that additional cell value types\n * can be added in future.\n */\nexport interface CellError {\n  /** Discriminated union tag */\n  type: 'CellError',\n\n  /** {@link CellErrorValue | Error Value} */\n  value: CellErrorValue;\n};\n\n/** Possible types for a cell value \n * \n * The native JavaScript types string, number and boolean represent the *Text*, *Number* and *Logical*\n * spreadsheet data types. {@link CellError} represents an *Error Value*.\n * \n * Undefined is used to represent a cell with no defined value. Null represents a cell that has been\n * explicitly marked as empty. \n*/\nexport type CellValue = string | number | boolean | null | undefined | CellError;\n\n/**\n * Interface used to access the data in a spreadsheet\n * \n * The data exposed through the interface may change over time outside of any changes made through the interface. The caller\n * can use the {@link subscribe} method to be notified when the data changes. When reading data, the caller must first request\n * a snapshot using {@link getSnapshot}. All values returned by gettors are relative to a specified snapshot. The values will be\n * consistent with each other as long as the same snapshot is used.\n * \n * @typeParam Snapshot - Type of snapshot. Implementations are free to use whatever type makes sense for them.\n */\nexport interface SpreadsheetData<Snapshot> {\n  /** Subscribe to data changes */\n  subscribe(onDataChange: () => void): () => void,\n\n  /** Return a snapshot to use when accessing values at a consistent point in time */\n  getSnapshot(): Snapshot,\n\n  /** Number of rows in the spreadsheet */\n  getRowCount(snapshot: Snapshot): number,\n\n  /** {@link ItemOffsetMapping} which describes sizes and offsets to start of rows */\n  getRowItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping,\n\n    /** Number of columns in the spreadsheet */\n  getColumnCount(snapshot: Snapshot): number,\n\n  /** {@link ItemOffsetMapping} which describes sizes and offsets to start of columns */\n  getColumnItemOffsetMapping(snapshot: Snapshot): ItemOffsetMapping,\n\n  /** Value of specified cell using 0-based row and column indexes */\n  getCellValue(snapshot: Snapshot, row: number, column: number): CellValue;\n\n  /** Format of specified cell using 0-based row and column indexes */\n  getCellFormat(snapshot: Snapshot, row: number, column: number): string | undefined;\n\n  /** Set value and format of specified cell\n   * \n   * @returns True if the change was successfully applied\n   */\n  setCellValueAndFormat(row: number, column: number, value: CellValue, format: string | undefined): boolean;\n}\n\nconst rowItemOffsetMapping = new FixedSizeItemOffsetMapping(30);\nconst columnItemOffsetMapping = new FixedSizeItemOffsetMapping(100);\n\nexport class EmptySpreadsheetData implements SpreadsheetData<number> {\n  subscribe(_onDataChange: () => void) { return () => {}; }\n  getSnapshot() { return 0; }\n  \n  getRowCount(_snapshot: number) { return 0; }\n  getRowItemOffsetMapping(_snapshot: number): ItemOffsetMapping { return rowItemOffsetMapping; }\n  getColumnCount(_snapshot: number) { return 0; }\n  getColumnItemOffsetMapping(_snapshot: number): ItemOffsetMapping { return columnItemOffsetMapping; }\n  getCellValue(_snapshot: number, _row: number, _column: number): CellValue { return null; }\n  getCellFormat(_snapshot: number, _row: number, _column: number): string|undefined { return undefined; }\n  setCellValueAndFormat(_row: number, _column: number, _value: CellValue, _format: string | undefined): boolean { return false; }\n}\n\n","/**  Classic Spreadsheet reference to Column (e.g \"A\") */\nexport type ColRef = string;\n\n/**  Classic Spreadsheet reference to Cell (e.g. \"A1\"), Row (e.g. \"1\") or Column (e.g \"A\") */\nexport type RowColRef = string;\n\n/** Equivalent to {@link RowColRef} as coordinate pair. \"A1\" has coords [0,0], \"1\" is [0,undefined] and \"A\" is [undefined,0] */\nexport type RowColCoords = [row: number|undefined, col: number|undefined];\n\n/** Converts a {@link ColRef} to the 0-based index of the column */\nexport function colRefToIndex(col: ColRef): number {\n  let n = 0;\n  for (let i = 0; i < col.length; i ++) {\n    n = col.charCodeAt(i) - 64 + n * 26;\n  }\n  return n-1;\n}\n\n/** Converts a 0-based column index to a {@link ColRef} */\nexport function indexToColRef(index: number): ColRef {\n  let ret = \"\";\n  index ++;\n  while (index > 0) {\n    index --;\n    const remainder = index % 26;\n    index = Math.floor(index / 26);\n    ret = String.fromCharCode(65+remainder) + ret;\n  }\n  return ret;\n}\n\n/** Splits a RowColRef into a 0-based row index and a {@link ColRef} */\nexport function splitRowColRef(ref: RowColRef): [row: number|undefined, col: ColRef|undefined] {\n  const re = /^([A-Z]*)(\\d*)$/;\n  const found = ref.match(re);\n  if (!found)\n    return [undefined,undefined];\n\n  const col = found[1];\n  const row = parseInt(found[2]);\n  return [(row>0) ? row-1 : undefined, col ? col : undefined];\n}\n\n/**  Converts a {@link RowColRef} to {@link RowColCoords} */\nexport function rowColRefToCoords(ref: RowColRef): RowColCoords {\n  const [row,col] = splitRowColRef(ref);\n  return [row, col ? colRefToIndex(col) : undefined];\n}\n\n/**  Converts {@link RowColCoords} to a {@link RowColRef} */\nexport function rowColCoordsToRef(row: number|undefined, col: number|undefined): RowColRef {\n  if (row !== undefined) {\n    if (col !== undefined) {\n      return indexToColRef(col) + (row+1);\n    } else {\n      return (row+1).toString();\n    }\n  } else {\n    if (col !== undefined) {\n      return indexToColRef(col);\n    } else {\n      return \"\";\n    }\n  }\n}"],"names":[],"mappings":";;;AAEA;;AAEG;MACU,0BAA0B,CAAA;AACrC;;AAEG;AACH,IAAA,WAAA,CAAa,QAAgB,EAAA;QAmB7B,yCAAuB,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAlBrB,QAAA,sBAAA,CAAA,IAAI,EAAA,yCAAA,EAAkB,QAAQ,EAAA,GAAA,CAAA;;AAGhC,IAAA,QAAQ,CAAC,UAAkB,EAAA;QACzB,OAAO,sBAAA,CAAA,IAAI,EAAA,yCAAA,EAAA,GAAA,CAAe;;AAG5B,IAAA,UAAU,CAAC,SAAiB,EAAA;AAC1B,QAAA,OAAO,SAAS,GAAG,sBAAA,CAAA,IAAI,iDAAe;;AAGxC,IAAA,YAAY,CAAC,MAAc,EAAA;AACzB,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,sBAAA,CAAA,IAAI,EAAe,yCAAA,EAAA,GAAA,CAAA,CAAC;AAC1D,QAAA,MAAM,WAAW,GAAG,SAAS,GAAG,sBAAA,CAAA,IAAI,iDAAe;AAEnD,QAAA,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC;;AAIlC;;;;AC3BD;;AAEG;MACU,6BAA6B,CAAA;AACxC;;;AAGG;IACH,WAAa,CAAA,eAAuB,EAAE,KAAe,EAAA;QA4CrD,8CAAyB,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACzB,oCAAiB,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AA5Cf,QAAA,sBAAA,CAAA,IAAI,EAAA,8CAAA,EAAoB,eAAe,EAAA,GAAA,CAAA;AACvC,QAAA,sBAAA,CAAA,IAAI,EAAA,oCAAA,EAAU,KAAK,EAAA,GAAA,CAAA;;AAGrB,IAAA,QAAQ,CAAC,SAAiB,EAAA;QACxB,OAAO,CAAC,SAAS,GAAG,sBAAA,CAAA,IAAI,4CAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,EAAA,oCAAA,EAAA,GAAA,CAAO,CAAC,SAAS,CAAC,GAAG,sBAAA,CAAA,IAAI,EAAA,8CAAA,EAAA,GAAA,CAAiB;;AAG1F,IAAA,UAAU,CAAC,SAAiB,EAAA;QAC1B,IAAI,MAAM,GAAG,CAAC;AACd,QAAA,IAAI,MAAM,GAAG,sBAAA,CAAA,IAAI,EAAO,oCAAA,EAAA,GAAA,CAAA,CAAC,MAAM;AAC/B,QAAA,IAAI,SAAS,GAAG,MAAM,EAAE;AACtB,YAAA,MAAM,cAAc,GAAG,SAAS,GAAG,MAAM;AACzC,YAAA,MAAM,GAAG,cAAc,GAAG,sBAAA,CAAA,IAAI,sDAAiB;;aAC1C;YACL,MAAM,GAAG,SAAS;;AAGpB,QAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAG,EAChC;AACE,YAAA,MAAM,IAAI,sBAAA,CAAA,IAAI,4CAAO,CAAC,CAAC,CAAC;;AAG1B,QAAA,OAAO,MAAM;;AAGf,IAAA,YAAY,CAAC,MAAc,EAAA;QACzB,IAAI,WAAW,GAAG,CAAC;AACnB,QAAA,MAAM,MAAM,GAAG,sBAAA,CAAA,IAAI,EAAO,oCAAA,EAAA,GAAA,CAAA,CAAC,MAAM;AACjC,QAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAG,EAAE;YAChC,MAAM,IAAI,GAAG,sBAAA,CAAA,IAAI,4CAAO,CAAC,CAAC,CAAC;AAC3B,YAAA,IAAI,WAAW,GAAG,IAAI,GAAG,MAAM,EAAE;AAC/B,gBAAA,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC;;YAEzB,WAAW,IAAI,IAAI;;AAGrB,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,WAAW,IAAI,sBAAA,CAAA,IAAI,EAAA,8CAAA,EAAA,GAAA,CAAiB,CAAC;AAC5E,QAAA,WAAW,IAAI,SAAS,GAAG,sBAAA,CAAA,IAAI,sDAAiB;AAEhD,QAAA,OAAO,CAAC,SAAS,GAAC,MAAM,EAAE,WAAW,CAAC;;AAKzC;;;AC8BD,MAAM,oBAAoB,GAAG,IAAI,0BAA0B,CAAC,EAAE,CAAC;AAC/D,MAAM,uBAAuB,GAAG,IAAI,0BAA0B,CAAC,GAAG,CAAC;MAEtD,oBAAoB,CAAA;IAC/B,SAAS,CAAC,aAAyB,EAAA,EAAI,OAAO,MAAO,GAAC,CAAC;AACvD,IAAA,WAAW,GAAK,EAAA,OAAO,CAAC,CAAC;AAEzB,IAAA,WAAW,CAAC,SAAiB,EAAA,EAAI,OAAO,CAAC,CAAC;AAC1C,IAAA,uBAAuB,CAAC,SAAiB,EAAA,EAAuB,OAAO,oBAAoB,CAAC;AAC5F,IAAA,cAAc,CAAC,SAAiB,EAAA,EAAI,OAAO,CAAC,CAAC;AAC7C,IAAA,0BAA0B,CAAC,SAAiB,EAAA,EAAuB,OAAO,uBAAuB,CAAC;IAClG,YAAY,CAAC,SAAiB,EAAE,IAAY,EAAE,OAAe,EAAA,EAAe,OAAO,IAAI,CAAC;IACxF,aAAa,CAAC,SAAiB,EAAE,IAAY,EAAE,OAAe,EAAA,EAAsB,OAAO,SAAS,CAAC;AACrG,IAAA,qBAAqB,CAAC,IAAY,EAAE,OAAe,EAAE,MAAiB,EAAE,OAA2B,EAAa,EAAA,OAAO,KAAK,CAAC;AAC9H;;AC3FD;AACM,SAAU,aAAa,CAAC,GAAW,EAAA;IACvC,IAAI,CAAC,GAAG,CAAC;AACT,IAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAG,EAAE;AACpC,QAAA,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE;;IAErC,OAAO,CAAC,GAAC,CAAC;AACZ;AAEA;AACM,SAAU,aAAa,CAAC,KAAa,EAAA;IACzC,IAAI,GAAG,GAAG,EAAE;AACZ,IAAA,KAAK,EAAG;AACR,IAAA,OAAO,KAAK,GAAG,CAAC,EAAE;AAChB,QAAA,KAAK,EAAG;AACR,QAAA,MAAM,SAAS,GAAG,KAAK,GAAG,EAAE;QAC5B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;QAC9B,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,GAAC,SAAS,CAAC,GAAG,GAAG;;AAE/C,IAAA,OAAO,GAAG;AACZ;AAEA;AACM,SAAU,cAAc,CAAC,GAAc,EAAA;IAC3C,MAAM,EAAE,GAAG,iBAAiB;IAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;AAC3B,IAAA,IAAI,CAAC,KAAK;AACR,QAAA,OAAO,CAAC,SAAS,EAAC,SAAS,CAAC;AAE9B,IAAA,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC;IACpB,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,OAAO,CAAC,CAAC,GAAG,GAAC,CAAC,IAAI,GAAG,GAAC,CAAC,GAAG,SAAS,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAC7D;AAEA;AACM,SAAU,iBAAiB,CAAC,GAAc,EAAA;IAC9C,MAAM,CAAC,GAAG,EAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC;AACrC,IAAA,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;AACpD;AAEA;AACgB,SAAA,iBAAiB,CAAC,GAAqB,EAAE,GAAqB,EAAA;AAC5E,IAAA,IAAI,GAAG,KAAK,SAAS,EAAE;AACrB,QAAA,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,GAAC,CAAC,CAAC;;aAC9B;YACL,OAAO,CAAC,GAAG,GAAC,CAAC,EAAE,QAAQ,EAAE;;;SAEtB;AACL,QAAA,IAAI,GAAG,KAAK,SAAS,EAAE;AACrB,YAAA,OAAO,aAAa,CAAC,GAAG,CAAC;;aACpB;AACL,YAAA,OAAO,EAAE;;;AAGf;;;;"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@candidstartup/infinisheet-types",
+  "private": false,
+  "version": "0.7.0",
+  "description": "Common types for the InfiniSheet packages",
+  "author": "Tim Wiegand <tim.wiegand@thecandidstartup.org>",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TheCandidStartup/infinisheet.git",
+    "directory": "packages/infinisheet-types"
+  },
+  "bugs": {
+    "url": "https://github.com/TheCandidStartup/infinisheet/issues"
+  },
+  "homepage": "https://github.com/TheCandidStartup/infinisheet/blob/main/packages/infinisheet-types/README.md",
+  "keywords": [
+    "typescript",
+    "spreadsheet",
+    "infinisheet"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "clean": "rimraf {dist,temp}",
+    "prebuild": "npm run clean",
+    "typecheck": "tsc -p tsconfig.json",
+    "build-tsc": "tsc -p tsconfig.build.json",
+    "build-rollup": "rollup -c ../rollup.config.mjs",
+    "build": "npm run build-rollup",
+    "lint": "eslint . --report-unused-disable-directives --max-warnings 0",
+    "devapi": "api-extractor run --local",
+    "prodapi": "api-extractor run",
+    "devbuild": "npm run build && npm run lint && npm run devapi",
+    "test": "vitest"
+  },
+  "main": "index.js",
+  "gitHead": "5ea8ee7cef0e539dd15b844bd074a745d08b6ba6"
+}