pixel-react-excel-sheet 1.2.0

package/src/components/ExcelFile/ExcelFile/Excel/engine/point-graph.ts

@@ -0,0 +1,154 @@
+import { Point } from "../point";
+import * as pointHash from "./point-hash";
+import { PointSet } from "./point-set";
+
+/**
+ * Immutable directed graph of points, where each point can have multiple
+ * edges to other points.
+ */
+export class PointGraph {
+  private constructor(private forwards = new Map<string, PointSet>()) {}
+
+  /** Creates a new PointGraph instance from an array-like or iterable object */
+  static from(pairs: Iterable<[Point, PointSet]>): PointGraph {
+    const forwards = new Map<string, PointSet>();
+    for (const [node, edges] of pairs) {
+      forwards.set(pointHash.toString(node), edges);
+    }
+    return new PointGraph(forwards);
+  }
+
+  set(node: Point, edges: PointSet): PointGraph {
+    const newGraph = new PointGraph(new Map(this.forwards));
+    if (edges.size === 0) {
+      newGraph.forwards.delete(pointHash.toString(node));
+      return newGraph;
+    }
+    newGraph.forwards.set(pointHash.toString(node), edges);
+    return newGraph;
+  }
+
+  get(node: Point): PointSet {
+    return this.forwards.get(pointHash.toString(node)) || PointSet.from([]);
+  }
+
+  getBackwards(node: Point): PointSet {
+    let result = PointSet.from([]);
+    for (const [key, value] of this.forwards) {
+      if (value.has(node)) {
+        result = result.add(pointHash.fromString(key));
+      }
+    }
+    return result;
+  }
+
+  getBackwardsRecursive(
+    node: Point,
+    visited: PointSet = PointSet.from([])
+  ): PointSet {
+    let result = this.getBackwards(node);
+    let newVisited = visited;
+    for (const point of result) {
+      if (newVisited.has(point)) {
+        continue;
+      }
+      newVisited = newVisited.add(point);
+      result = result.union(this.getBackwardsRecursive(point, newVisited));
+    }
+    return result;
+  }
+
+  /** Determine whether the graph has a circular dependency, starting from given start point */
+  hasCircularDependency(startPoint: Point): boolean {
+    let visited = PointSet.from([]);
+    const stack: Point[] = [startPoint];
+
+    while (stack.length > 0) {
+      const current = stack.pop();
+      if (!current) {
+        continue;
+      }
+
+      if (visited.has(current)) {
+        return true;
+      }
+
+      visited = visited.add(current);
+
+      const dependents = this.get(current);
+
+      if (!dependents) {
+        continue;
+      }
+
+      for (const dependent of dependents) {
+        stack.push(dependent);
+      }
+    }
+
+    return false;
+  }
+
+  *[Symbol.iterator](): Iterator<[Point, PointSet]> {
+    const visitedHashes = new Set<string>();
+    for (const [key, values] of this.forwards) {
+      const point = pointHash.fromString(key);
+      visitedHashes.add(key);
+      yield [point, values];
+
+      // Make sure to include values that are not included in the forwards map keys
+      for (const value of values) {
+        const hash = pointHash.toString(value);
+        if (!visitedHashes.has(hash) && !this.forwards.has(hash)) {
+          visitedHashes.add(hash);
+          yield [value, PointSet.from([])];
+        }
+      }
+    }
+  }
+
+  /** Get the points in the graph in a breadth-first order */
+  *traverseBFSBackwards(): Generator<Point> {
+    // Create a Set to store the points that have been visited
+    let visited = PointSet.from([]);
+
+    // Create a queue to store the points that still need to be visited
+    const queue: Point[] = [];
+
+    // Iterate over all the points and add the ones with no dependencies to the queue
+    for (const [point, values] of this) {
+      if (values.size === 0) {
+        visited = visited.add(point);
+        queue.push(point);
+      }
+    }
+
+    // While there are points in the queue, remove the first one and yield it
+    while (queue.length > 0) {
+      const point = queue.shift();
+      if (!point) {
+        continue;
+      }
+      yield point;
+
+      // Get the set of points that depend on the current point
+      const dependents = this.getBackwards(point);
+
+      // If there are no dependents, skip to the next iteration
+      if (dependents.size === 0) {
+        continue;
+      }
+
+      // Otherwise, add the dependents to the queue if they have not yet been visited
+      for (const dependent of dependents) {
+        if (
+          !visited.has(dependent) &&
+          this.get(dependent).difference(visited).size === 0
+        ) {
+          queue.push(dependent);
+          visited = visited.add(dependent);
+        }
+      }
+    }
+  }
+}

package/src/components/ExcelFile/ExcelFile/Excel/engine/point-hash.ts

@@ -0,0 +1,10 @@
+import { Point } from "../point";
+
+export function toString(point: Point): string {
+  return `${point.row},${point.column}`;
+}
+
+export function fromString(point: string): Point {
+  const [row, column] = point.split(",");
+  return { row: Number(row), column: Number(column) };
+}

package/src/components/ExcelFile/ExcelFile/Excel/engine/point-set.ts

@@ -0,0 +1,69 @@
+import * as Point from "../point";
+import * as pointHash from "./point-hash";
+
+/**
+ * Immutable Set like interface of points
+ */
+export class PointSet {
+  private constructor(private set: Set<string>) {}
+
+  /** Creates a new PointSet instance from an array-like or iterable object */
+  static from(points: Iterable<Point.Point>): PointSet {
+    const set = new Set<string>();
+    for (const point of points) {
+      set.add(pointHash.toString(point));
+    }
+    return new PointSet(set);
+  }
+
+  /** Returns a boolean asserting whether an point is present with the given value in the Set object or not */
+  has(point: Point.Point): boolean {
+    return this.set.has(pointHash.toString(point));
+  }
+
+  /** Returns the number of points in a PointSet object */
+  get size(): number {
+    return this.set.size;
+  }
+
+  /** Add the given point to given set */
+  add(point: Point.Point): PointSet {
+    const newSet = new Set(this.set);
+    newSet.add(pointHash.toString(point));
+    return new PointSet(newSet);
+  }
+
+  /** Remove the given point from the given set */
+  delete(point: Point.Point): PointSet {
+    const newSet = new Set(this.set);
+    if (!newSet.delete(pointHash.toString(point))) {
+      return this;
+    }
+    return new PointSet(newSet);
+  }
+
+  /** Returns a new PointSet with points common to the set and other */
+  difference(other: PointSet): PointSet {
+    let newSet = this as PointSet;
+    for (const point of other) {
+      newSet = newSet.delete(point);
+    }
+    return newSet;
+  }
+
+  /** Returns a new PointSet with all points in both sets */
+  union(other: PointSet): PointSet {
+    let newSet = this as PointSet;
+    for (const point of other) {
+      newSet = newSet.add(point);
+    }
+    return newSet;
+  }
+
+  /** Creates an iterator of points in the set */
+  *[Symbol.iterator](): Iterator<Point.Point> {
+    for (const value of this.set) {
+      yield pointHash.fromString(value);
+    }
+  }
+}

package/src/components/ExcelFile/ExcelFile/Excel/index.ts

@@ -0,0 +1,48 @@
+import Spreadsheet from "./Spreadsheet";
+import DataEditor from "./DataEditor";
+import DataViewer from "./DataViewer";
+
+export default Spreadsheet;
+export { Spreadsheet, DataEditor, DataViewer };
+export type { Props } from "./Spreadsheet";
+export { createEmpty as createEmptyMatrix } from "./matrix";
+export type { Matrix } from "./matrix";
+export {
+  Selection,
+  EmptySelection,
+  EntireAxisSelection,
+  EntireColumnsSelection,
+  EntireRowsSelection,
+  EntireSelection,
+  EntireWorksheetSelection,
+  InvalidIndexError,
+  RangeSelection,
+} from "./selection";
+export { PointRange } from "./point-range";
+export type { Point } from "./point";
+export type {
+  CellBase,
+  CellDescriptor,
+  Mode,
+  Dimensions,
+  CellChange,
+  CellComponentProps,
+  CellComponent,
+  DataViewerProps,
+  DataViewerComponent,
+  DataEditorProps,
+  DataEditorComponent,
+  ColumnIndicatorComponent,
+  ColumnIndicatorProps,
+  RowIndicatorComponent,
+  RowIndicatorProps,
+  CornerIndicatorComponent,
+  CornerIndicatorProps,
+  RowComponent,
+  RowProps,
+  TableComponent,
+  TableProps,
+  HeaderRowProps,
+  HeaderRowComponent,
+} from "./types";
+export { createFormulaParser, Model } from "./engine";

package/src/components/ExcelFile/ExcelFile/Excel/matrix.ts

@@ -0,0 +1,388 @@
+import * as Point from "./point";
+
+/** A two-dimensional array of given type T in rows and columns */
+export type Matrix<T> = Array<Array<T | undefined>>;
+
+/**
+ * Creates an empty matrix with given rows and columns
+ * @param rows - integer, the amount of rows the matrix should have
+ * @param columns - integer, the amount of columns the matrix should have
+ * @returns an empty matrix with given rows and columns
+ */
+export function createEmpty<T>(rows: number, columns: number): Matrix<T> {
+  const matrix = Array(rows);
+  for (let i = 0; i < rows; i++) {
+    matrix[i] = Array(columns);
+  }
+  return matrix;
+}
+
+/** Gets the value at row and column of matrix. */
+export function get<T>(point: Point.Point, matrix: Matrix<T>): T | undefined {
+  const columns = matrix[point.row];
+  if (columns === undefined) {
+    return undefined;
+  }
+  return columns[point.column];
+}
+
+/** Creates a slice of matrix from startPoint up to, but not including, endPoint. */
+export function slice<T>(
+  startPoint: Point.Point,
+  endPoint: Point.Point,
+  matrix: Matrix<T>
+): Matrix<T> {
+  const sliced: Matrix<T> = [];
+  const columns = endPoint.column - startPoint.column;
+  for (let row = startPoint.row; row <= endPoint.row; row++) {
+    const slicedRow = row - startPoint.row;
+    sliced[slicedRow] = sliced[slicedRow] || Array(columns);
+    for (let column = startPoint.column; column <= endPoint.column; column++) {
+      sliced[slicedRow][column - startPoint.column] = get(
+        { row, column },
+        matrix
+      );
+    }
+  }
+  return sliced;
+}
+
+/** Sets the value at row and column of matrix. If a row doesn't exist, it's created. */
+
+export function set<T>(
+  point: Point.Point,
+  value: T,
+  matrix: Matrix<T>
+): Matrix<T> {
+  // Create a shallow copy of the matrix
+  const nextMatrix = [...matrix];
+
+  // Ensure the first row exists (initialize if undefined)
+  const firstRow = matrix[0] ?? [];
+  const nextFirstRow = [...firstRow];
+
+  // Ensure the first row has enough columns to accommodate the specified column
+  if (nextFirstRow.length <= point.column) {
+    nextFirstRow.length = point.column + 1; // Extend the first row if needed
+  }
+  
+  // Set the modified first row back into the matrix
+  nextMatrix[0] = nextFirstRow;
+
+  // Ensure the specified row exists (initialize if undefined)
+  const nextRow = matrix[point.row] ?? [];
+  const nextRowCopy = [...nextRow];
+
+  // Set the value at the specified point
+  nextRowCopy[point.column] = value;
+
+  // Set the modified row back into the matrix
+  nextMatrix[point.row] = nextRowCopy;
+
+  return nextMatrix;
+}
+
+
+/** Like Matrix.set() but mutates the matrix */
+
+
+export function mutableSet<T>(
+  point: Point.Point,
+  value: T,
+  matrix: Matrix<T>
+): void {
+  // Ensure that the first row exists, if not, create it
+  let firstRow = matrix[0];
+  if (!firstRow) {
+    firstRow = [];
+    matrix[0] = firstRow;
+  }
+
+  // Ensure the row at point.row exists, if not, create it
+  let row = matrix[point.row];
+  if (!row) {
+    row = [];
+    matrix[point.row] = row;
+  }
+
+  // Ensure that the first row has enough columns
+  if (firstRow.length <= point.column) {
+    firstRow.length = point.column + 1; // Extend the first row if needed
+  }
+
+  // Set the value at the specified point
+  row[point.column] = value;
+}
+
+
+
+/** Removes the coordinate of matrix */
+// export function unset<T>(point: Point.Point, matrix: Matrix<T>): Matrix<T> {
+//   if (!has(point, matrix)) {
+//     return matrix;
+//   }
+//   const nextMatrix = [...matrix];
+//   const nextRow = [...matrix[point.row]];
+
+//   // Avoid deleting to preserve first row length
+//   nextRow[point.column] = undefined;
+//   nextMatrix[point.row] = nextRow;
+
+//   return nextMatrix;
+// }
+
+export function unset<T>(point: Point.Point, matrix: Matrix<T>): Matrix<T> {
+  // Check if the point exists in the matrix
+  if (!has(point, matrix)) {
+    return matrix;
+  }
+
+  // Create a shallow copy of the matrix
+  const nextMatrix = [...matrix];
+
+  // Check if the row exists before trying to copy it
+  const currentRow = matrix[point.row];
+  if (currentRow) {
+    // Create a shallow copy of the row
+    const nextRow = [...currentRow];
+    // Avoid deleting to preserve first row length
+    nextRow[point.column] = undefined;
+
+    // Update the matrix with the modified row
+    nextMatrix[point.row] = nextRow;
+  }
+
+  return nextMatrix;
+}
+
+
+/** Creates an array of values by running each element in collection thru iteratee. */
+export function map<T, T2>(
+  func: (value: T | undefined, point: Point.Point) => T2,
+  matrix: Matrix<T>
+): Matrix<T2> {
+  const newMatrix: Matrix<T2> = [];
+  for (const [point, value] of entries(matrix)) {
+    mutableSet(point, func(value, point), newMatrix);
+  }
+  return newMatrix;
+}
+
+/** Create an iterator over the cells in the matrix */
+export function* entries<T>(
+  matrix: Matrix<T>
+): IterableIterator<[Point.Point, T | undefined]> {
+  for (const [row, values] of matrix.entries()) {
+    for (const [column, value] of values.entries()) {
+      const point = { row, column };
+      yield [point, value];
+    }
+  }
+}
+
+/**
+ * Converts all elements in row into a string separated by horizontalSeparator and each row string
+ * to string separated by verticalSeparator
+ */
+
+export function join(
+  matrix: Matrix<unknown>,
+  horizontalSeparator = "\t",
+  verticalSeparator = "\n"
+): string {
+  let joined = "";
+  const { rows, columns } = getSize(matrix);
+  
+  for (let row = 0; row < rows; row++) {
+    if (row) {
+      joined += verticalSeparator;
+    }
+    
+    for (let column = 0; column < columns; column++) {
+      if (column) {
+        joined += horizontalSeparator;
+      }
+      
+      // Ensure matrix[row] exists and matrix[row][column] is not undefined
+      const cellValue = matrix[row]?.[column];
+      
+      // If cellValue is undefined, you can use a fallback value like an empty string
+      joined += cellValue !== undefined ? String(cellValue) : "";
+    }
+  }
+  
+  return joined;
+}
+
+
+/**
+ * Parses a CSV separated by a horizontalSeparator and verticalSeparator into a
+ * Matrix using a transform function
+ */
+export function split<T>(
+  csv: string,
+  transform: (value: string) => T,
+  horizontalSeparator = "\t",
+  verticalSeparator: string | RegExp = /\r\n|\n|\r/
+): Matrix<T> {
+  // Temporarily replace line breaks inside quotes
+  const replaced = csv.replace(/"([^"]*?)"/g, (_, p1) => {
+    return p1.replace(/\n/g, "\\n");
+  });
+  return replaced.split(verticalSeparator).map((row) =>
+    row
+      .split(horizontalSeparator)
+      .map((line) => {
+        // Restore original line breaks in each line
+        return line.replace(/\\n/g, "\n");
+      })
+      .map(transform)
+  );
+}
+
+/** Returns whether the point exists in the matrix or not. */
+export function has(point: Point.Point, matrix: Matrix<unknown>): boolean {
+  const firstRow = matrix[0];
+  if (!firstRow) {
+    return false; // If first row is undefined, return false
+  }
+  
+  // Perform validation checks
+  return (
+    point.row >= 0 &&
+    point.column >= 0 &&
+    Number.isInteger(point.row) &&
+    Number.isInteger(point.column) &&
+    point.column < firstRow.length &&
+    point.row < matrix.length
+  );
+}
+
+
+/** Counts of the rows and column in a matrix */
+export type Size = {
+  /** Count of the rows in the matrix */
+  rows: number;
+  /** Count of the columns in the matrix */
+  columns: number;
+};
+
+/** Gets the count of rows and columns of given matrix */
+export function getSize(matrix: Matrix<unknown>): Size {
+  return {
+    columns: getColumnsCount(matrix),
+    rows: getRowsCount(matrix),
+  };
+}
+
+/** Gets the count of rows of given matrix */
+export function getRowsCount(matrix: Matrix<unknown>): number {
+  return matrix.length;
+}
+
+/** Gets the count of columns of given matrix */
+export function getColumnsCount(matrix: Matrix<unknown>): number {
+  const firstRow = matrix[0];
+  return firstRow ? firstRow.length : 0;
+}
+
+/**
+ * Pads matrix with empty rows to match given total rows
+ * @param matrix - matrix to pad
+ * @param totalRows - number of rows the matrix should have
+ * @returns the updated matrix
+ */
+export function padRows<T>(matrix: Matrix<T>, totalRows: number): Matrix<T> {
+  const { rows, columns } = getSize(matrix);
+
+  if (rows >= totalRows) {
+    return matrix;
+  }
+
+  const missingRows = totalRows - rows;
+  const emptyRow = Array(columns).fill(undefined);
+  const emptyRows = Array(missingRows).fill(emptyRow);
+  return [...matrix, ...emptyRows];
+}
+
+/**
+ * Pads matrix with empty columns to match given total columns
+ * @param matrix - matrix to pad
+ * @param size - minimum size of the matrix after padding.
+ * @returns the updated matrix
+ */
+export function pad<T>(matrix: Matrix<T>, size: Size): Matrix<T> {
+  const { rows, columns } = getSize(matrix);
+
+  if (rows >= size.rows && columns >= size.columns) {
+    // Optimization, no padding required.
+    return matrix;
+  }
+
+  const resultSize: Size = {
+    rows: size.rows > rows ? size.rows : rows,
+    columns: size.columns > columns ? size.columns : columns,
+  };
+
+  let padded = [...matrix];
+  if (resultSize.columns > columns) {
+    const padColumns = resultSize.columns - columns;
+    padded = padded.map((row) => [
+      ...row,
+      ...Array(padColumns).fill(undefined),
+    ]);
+  }
+
+  if (resultSize.rows > rows) {
+    const padRows = resultSize.rows - rows;
+    const emptyRow = Array(resultSize.columns).fill(undefined);
+    padded = [...padded, ...Array(padRows).fill(emptyRow)];
+  }
+
+  return padded;
+}
+
+export function toArray<T>(matrix: Matrix<T>): T[];
+export function toArray<T1, T2>(
+  matrix: Matrix<T1>,
+  transform: (cell: T1 | undefined, coords: Point.Point) => T2
+): T2[];
+
+/**
+ * Flattens a matrix values to an array
+ * @param matrix - the matrix to flatten values from
+ * @param transform - optional transform function to apply to each value in the
+ * matrix
+ * @returns an array of the values from matrix, transformed if a transform
+ * function is passed
+ */
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+
+export function toArray<T1, T2>(
+  matrix: Matrix<T1>,
+  transform?: (cell: T1 | undefined, coords: Point.Point) => T2
+): T2[] {
+  const array: T2[] = [];
+
+  for (let row = 0; row < matrix.length; row++) {
+    const currentRow = matrix[row];
+
+    // Ensure the row is not undefined
+    if (currentRow !== undefined) {
+      for (let column = 0; column < currentRow.length; column++) {
+        const value = currentRow[column];
+        // If transform is provided, apply it; otherwise, use the value as is
+        array.push(transform ? transform(value, { row, column }) : value as T2);
+      }
+    }
+  }
+
+  return array;
+}
+
+
+/** Returns the maximum point in the matrix */
+export function maxPoint(matrix: Matrix<unknown>): Point.Point {
+  const size = getSize(matrix);
+  return { row: size.rows - 1, column: size.columns - 1 };
+}