@trebco/treb 25.2.0 → 25.5.0

package/treb-grid/src/types/grid_base.ts

@@ -37,14 +37,17 @@
 
 import { EventSource } from 'treb-utils';
 import type { DataModel, MacroFunction, SerializedModel, SerializedNamedExpression, ViewModel } from './data_model';
-import { Parser, type ExpressionUnit, UnitAddress, IllegalSheetNameRegex } from 'treb-parser';
-import { Area, Style, IsCellAddress, ValidationType, ValueType, Table, TableSortOptions, DefaultTableSortOptions, TableTheme } from 'treb-base-types';
-import type { ICellAddress, IArea, Cell, CellValue } from 'treb-base-types';
+import type { Parser, UnitAddress} from 'treb-parser';
+import { type ExpressionUnit, IllegalSheetNameRegex, ParseCSV, ArgumentSeparatorType, DecimalMarkType } from 'treb-parser';
+import { Area, IsCellAddress, ValidationType, ValueType, DefaultTableSortOptions } from 'treb-base-types';
+import type { ICellAddress, IArea, Cell, CellValue , Style, Table, TableSortOptions, TableTheme, Complex } from 'treb-base-types';
 import { Sheet } from './sheet';
-import { AutocompleteMatcher, FunctionDescriptor, DescriptorType } from '../editors/autocomplete_matcher';
-import { NumberFormat } from 'treb-format';
+import type { FunctionDescriptor} from '../editors/autocomplete_matcher';
+import { AutocompleteMatcher, DescriptorType } from '../editors/autocomplete_matcher';
+import { NumberFormat, ValueParser } from 'treb-format';
 
-import { ErrorCode, GridEvent } from './grid_events';
+import type { GridEvent } from './grid_events';
+import { ErrorCode } from './grid_events';
 import type { CommandRecord, DataValidationCommand, DuplicateSheetCommand, FreezeCommand, InsertColumnsCommand, InsertRowsCommand, ResizeColumnsCommand, ResizeRowsCommand, SelectCommand, SetRangeCommand, ShowSheetCommand, SortTableCommand } from './grid_command';
 import { DefaultGridOptions, type GridOptions } from './grid_options';
 import type { SerializeOptions } from './serialize_options';
@@ -55,7 +58,7 @@ import { CommandKey } from './grid_command';
 import type { Command, ActivateSheetCommand, 
                DeleteSheetCommand, UpdateBordersCommand, SheetSelection } from './grid_command';
 import type { UpdateFlags } from './update_flags';
-import type { LegacySerializedSheet } from './sheet_types';
+import type { FreezePane, LegacySerializedSheet } from './sheet_types';
 import type { Annotation } from './annotation';
 import type { ClipboardCellData } from './clipboard_data';
 
@@ -202,6 +205,176 @@ export class GridBase {
 
   }
 
+  /**
+   * activate sheet, by name or index number
+   * @param sheet number (index into the array) or string (name)
+   */
+  public ActivateSheet(sheet: number | string): void {
+
+    const index = (typeof sheet === 'number') ? sheet : undefined;
+    const name = (typeof sheet === 'string') ? sheet : undefined;
+
+    this.ExecCommand({
+      key: CommandKey.ActivateSheet,
+      index,
+      name,
+    });
+
+  }
+
+  /**
+   * activate sheet, by ID
+   */
+  public ActivateSheetID(id: number): void {
+    this.ExecCommand({
+      key: CommandKey.ActivateSheet,
+      id,
+    });
+  }
+
+  /**
+   * duplicate sheet by index or (omitting index) the current active sheet
+   */
+  public DuplicateSheet(index?: number, name?: string, insert_before?: number|string): void {
+
+    const command: DuplicateSheetCommand = {
+      key: CommandKey.DuplicateSheet,
+      new_name: name,
+      insert_before,
+    };
+
+    if (typeof index === 'undefined') {
+      command.id = this.active_sheet.id;
+    }
+    else {
+      command.index = index;
+    }
+
+    this.ExecCommand(command);
+
+  }
+
+  public AddSheet(name?: string): void {
+    this.ExecCommand({
+      key: CommandKey.AddSheet,
+      name,
+      show: true,
+    });
+  }
+
+  /**
+   * delete sheet, by index or (omitting index) the current active sheet
+   */
+  public DeleteSheet(index?: number): void {
+
+    if (typeof index === 'undefined') {
+      if (!this.model.sheets.list.some((sheet, i) => {
+        if (sheet === this.active_sheet) {
+          index = i;
+          return true;
+        }
+        return false;
+      })) {
+        throw new Error('invalid index');
+      }
+    }
+
+    this.ExecCommand({
+      key: CommandKey.DeleteSheet,
+      index,
+    });
+
+  }
+
+  /** insert sheet at the given index (or current index) */
+  public InsertSheet(index?: number, name?: string): void {
+
+    if (typeof index === 'undefined') {
+      if (!this.model.sheets.list.some((sheet, i) => {
+        if (sheet === this.active_sheet) {
+          index = i + 1;
+          return true;
+        }
+        return false;
+      })) {
+        throw new Error('invalid index');
+      }
+    }
+
+    this.ExecCommand({
+      key: CommandKey.AddSheet,
+      insert_index: index,
+      name,
+      show: true,
+    });
+
+  }
+
+  public DeleteSheetID(id: number): void {
+    this.ExecCommand({
+      key: CommandKey.DeleteSheet,
+      id,
+    });
+  }
+
+  /**
+   * clear sheet, reset all data
+   */
+  public Reset(): void {
+    this.ExecCommand({ key: CommandKey.Reset });
+  }
+
+  /**
+   * set hyperlink, like set note
+   */
+  public SetLink(address: ICellAddress, reference?: string): void {
+
+    /*
+    if (!address) {
+      if (this.primary_selection.empty) return;
+      address = this.primary_selection.target;
+    }
+    */
+
+    this.ExecCommand({
+      key: CommandKey.SetLink,
+      area: address,
+      reference,
+    });
+
+  }
+
+  public ShowAll(): void {
+
+    // obviously there are better ways to do this, but this
+    // will use the execcommand system and _should_ only fire
+    // a single event (FIXME: check)
+
+    const commands: ShowSheetCommand[] = [];
+    for (let index = 0; index < this.model.sheets.length; index++) {
+      commands.push({
+        key: CommandKey.ShowSheet,
+        index,
+        show: true,
+      });
+    }
+    this.ExecCommand(commands);
+  }
+
+  public ShowSheet(index: number|string = 0, show = true): void {
+
+    const command: ShowSheetCommand = {
+      key: CommandKey.ShowSheet,
+      show,
+    };
+
+    if (typeof index === 'string') { command.name = index; }
+    else { command.index = index; }
+
+    this.ExecCommand(command);
+    
+  }
+
   /**
    * sort table. column is absolute.
    */
@@ -221,6 +394,170 @@ export class GridBase {
     });
     
   }
+  
+  /** return freeze area */
+  public GetFreeze(): FreezePane {
+    return { ...this.active_sheet.freeze };
+  }
+
+  /**
+   * insert rows(s) at some specific point
+   */
+  public InsertRows(before_row = 0, count = 1): void {
+    this.ExecCommand({
+      key: CommandKey.InsertRows,
+      before_row,
+      count,
+    });
+  }
+
+  /**
+   * return the table (if any) at the given address
+   */
+  public GetTableReference(address: ICellAddress): Table|undefined {
+    const sheet = this.model.sheets.Find(address.sheet_id || this.active_sheet.id);
+    return sheet?.CellData(address).table || undefined;
+  }
+
+
+  /**
+   * reset sheet, set data from CSV
+   *
+   * FIXME: this is problematic, because it runs around the exec command
+   * system. however it doesn't seem like a good candidate for a separate
+   * command. it should maybe move to the import class? (...)
+   *
+   * one problem with that is that import is really, really heavy (jszip).
+   * it seems wasteful to require all that just to import csv.
+   */
+  public FromCSV(text: string): void {
+
+    // CSV assumes dot-decimal, correct? if we want to use the
+    // parser we will have to check (and set/reset) the separator
+
+    const toggle_separator = this.parser.decimal_mark === DecimalMarkType.Comma;
+
+    if (toggle_separator) {
+      // swap
+      this.parser.argument_separator = ArgumentSeparatorType.Comma;
+      this.parser.decimal_mark = DecimalMarkType.Period;
+    }
+
+    const records = ParseCSV(text);
+    const arr = records.map((record) =>
+      record.map((field) => {
+        if (field) {
+          const tmp = this.parser.Parse(field);
+          if (tmp.expression?.type === 'complex') {
+            return tmp.expression as Complex;
+          }
+        }
+        return ValueParser.TryParse(field).value;
+      }));
+
+    if (toggle_separator) {
+      // reset
+      this.parser.argument_separator = ArgumentSeparatorType.Semicolon;
+      this.parser.decimal_mark = DecimalMarkType.Comma;
+    }
+  
+    const end = {
+      row: Math.max(0, arr.length - 1),
+      column: arr.reduce((max, row) => Math.max(max, Math.max(0, row.length - 1)), 0),
+    };
+
+    // NOTE: SetRange here does not need to be translated, because
+    // we're not expecting spreadsheet functions in the CSV. CSV should
+    // be data only. Famous last words.
+    
+    this.ExecCommand([
+      { key: CommandKey.Reset },
+      {
+        key: CommandKey.SetRange,
+        area: { start: { row: 0, column: 0 }, end },
+        value: arr,
+      },
+
+      // we took this out because the data may require a layout update
+      // (rebuilding tiles); in that case, this will be duplicative. maybe
+      // should use setTimeout or some sort of queue...
+
+      // { key: CommandKey.ResizeColumns }, // auto
+    ]);
+
+  }
+
+
+  /**
+   * insert column(s) at some specific point
+   */
+  public InsertColumns(before_column = 0, count = 1): void {
+    this.ExecCommand({
+      key: CommandKey.InsertColumns,
+      before_column,
+      count,
+    });
+  }
+
+  /** move sheet (X) before sheet (Y) */
+  public ReorderSheet(index: number, move_before: number): void {
+    this.ExecCommand({
+      key: CommandKey.ReorderSheet,
+      index,
+      move_before,
+    });
+  }
+
+  /**
+   * rename active sheet
+   */
+  public RenameSheet(sheet: Sheet, name: string): void {
+    this.ExecCommand({
+      key: CommandKey.RenameSheet,
+      new_name: name,
+      id: sheet.id,
+    });
+  }
+
+  /**
+   * freeze rows or columns. set to 0 (or call with no arguments) to un-freeze.
+   *
+   * highglight is shown by default, but we can hide it(mostly for document load)
+   */
+  public Freeze(rows = 0, columns = 0, highlight_transition = true): void {
+    this.ExecCommand({
+      key: CommandKey.Freeze,
+      rows,
+      columns,
+      highlight_transition,
+    });
+  }
+
+  /**
+   * API method
+   */
+  public SetRowHeight(row?: number | number[], height?: number, shrink = true): void {
+    this.ExecCommand({
+      key: CommandKey.ResizeRows,
+      row,
+      height,
+      shrink,
+    });
+  }
+
+  /**
+   * API method
+   *
+   * @param column column, columns, or undefined means all columns
+   * @param width target width, or undefined means auto-size
+   */
+  public SetColumnWidth(column?: number | number[], width = 0): void {
+    this.ExecCommand({
+      key: CommandKey.ResizeColumns,
+      column,
+      width,
+    });
+  }
 
   /**
    * filter table. what this means is "show the rows that match the filter
@@ -552,6 +889,63 @@ export class GridBase {
 
   }
 
+  /**
+   * check if we can paste into the target area(s). this will
+   * return false if the areas contain locked cells, or part of
+   * an array or merge but not the whole array or merge.
+   * 
+   * @param areas 
+   * @returns 
+   */
+  protected ValidatePasteAreas(areas: Area[]): boolean {
+    for (const area of areas) {
+
+      let sheet: Sheet|undefined = this.active_sheet;
+      if (area.start.sheet_id && area.start.sheet_id !== sheet.id) {
+        sheet = this.model.sheets.Find(area.start.sheet_id);
+      }
+      if (!sheet) {
+        return false;
+      }
+
+      let valid = true;
+
+      sheet.cells.Apply2(area, cell => {
+        if (cell.style?.locked)  {
+          console.info('invalid: locked cells');
+          valid = false;
+        }
+        if (cell.merge_area) {
+          if (!area.Contains(cell.merge_area.start) || !area.Contains(cell.merge_area.end)) {
+            console.info('invalid: merge area');
+            valid = false;
+          }
+        }
+        if (cell.area) {
+          if (!area.Contains(cell.area.start) || !area.Contains(cell.area.end)) {
+            console.info('invalid: array');
+            valid = false;
+          }
+        }
+        /* ok for paste
+        if (cell.table) {
+          if (!area.Contains(cell.table.area.start) || !area.Contains(cell.table.area.end)) {
+            console.info('invalid: table');
+            valid = false;
+          }
+        }
+        */
+        return valid;
+      });
+
+      if (!valid) {
+        return false;
+      }
+
+    }
+    return true;
+  }
+
   protected SetValidationInternal(command: DataValidationCommand): void {
 
     let cell: Cell|undefined;

package/treb-grid/src/types/grid_events.ts

@@ -41,6 +41,9 @@ export enum ErrorCode {
   /** invalid area for insert table: there's a merge, array or existing table within the range */
   invalid_area_for_table,
 
+  /** invalid area for paste, same as invalid area for table */
+  invalid_area_for_paste,
+
 }
 
 export interface SheetChangeEvent {

package/treb-grid/src/types/grid_selection.ts

@@ -1,25 +1,25 @@
-/*
- * This file is part of TREB.
- *
- * TREB is free software: you can redistribute it and/or modify it under the 
- * terms of the GNU General Public License as published by the Free Software 
- * Foundation, either version 3 of the License, or (at your option) any 
- * later version.
- *
- * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
- * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
- * details.
- *
- * You should have received a copy of the GNU General Public License along 
- * with TREB. If not, see <https://www.gnu.org/licenses/>. 
- *
- * Copyright 2022-2023 trebco, llc. 
- * info@treb.app
- * 
- */
-
-import { Area, ICellAddress } from 'treb-base-types';
+/*
+ * This file is part of TREB.
+ *
+ * TREB is free software: you can redistribute it and/or modify it under the 
+ * terms of the GNU General Public License as published by the Free Software 
+ * Foundation, either version 3 of the License, or (at your option) any 
+ * later version.
+ *
+ * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with TREB. If not, see <https://www.gnu.org/licenses/>. 
+ *
+ * Copyright 2022-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
+import { Area, type ICellAddress } from 'treb-base-types';
 
 /**
  * FIXME: this is broken. we treat this as a simple javascript object,

package/treb-grid/src/types/named_range.ts

@@ -1,25 +1,25 @@
-/*
- * This file is part of TREB.
- *
- * TREB is free software: you can redistribute it and/or modify it under the 
- * terms of the GNU General Public License as published by the Free Software 
- * Foundation, either version 3 of the License, or (at your option) any 
- * later version.
- *
- * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
- * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
- * details.
- *
- * You should have received a copy of the GNU General Public License along 
- * with TREB. If not, see <https://www.gnu.org/licenses/>. 
- *
- * Copyright 2022-2023 trebco, llc. 
- * info@treb.app
- * 
- */
-
-import { IArea, Area } from 'treb-base-types';
+/*
+ * This file is part of TREB.
+ *
+ * TREB is free software: you can redistribute it and/or modify it under the 
+ * terms of the GNU General Public License as published by the Free Software 
+ * Foundation, either version 3 of the License, or (at your option) any 
+ * later version.
+ *
+ * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with TREB. If not, see <https://www.gnu.org/licenses/>. 
+ *
+ * Copyright 2022-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
+import { type IArea, Area } from 'treb-base-types';
 
 /**
  * I want to repurpose named ranges (a little) to allow either values or 

package/treb-grid/src/types/sheet.ts

@@ -21,22 +21,23 @@
 
 // --- treb imports -----------------------------------------------------------
 
-import {
-  Cell, ValueType, Cells, Style,
-  Area, ICellAddress, CellSerializationOptions, IsFlatDataArray, 
-  IsNestedRowArray, CellValue, ImportedSheetData, Complex, 
-  DimensionedQuantity, IsCellAddress, IArea, Table, TableTheme,
+import { ValueType, Cells, Style,
+  Area, IsFlatDataArray, 
+  IsNestedRowArray, IsCellAddress
 } from 'treb-base-types';
 import { NumberFormatCache } from 'treb-format';
 import { Measurement, ValidateURI } from 'treb-utils';
 
-import type { TextPart } from 'treb-base-types';
+import type { TextPart ,
+  Cell, ICellAddress, CellSerializationOptions, CellValue, ImportedSheetData, Complex, 
+  DimensionedQuantity, IArea, Table, TableTheme} from 'treb-base-types';
 
 // --- local imports ----------------------------------------------------------
 
 import type { FreezePane, SerializedSheet, ScrollOffset } from './sheet_types';
 import type { SerializeOptions } from './serialize_options';
-import { CreateSelection, GridSelection } from './grid_selection';
+import type { GridSelection } from './grid_selection';
+import { CreateSelection } from './grid_selection';
 import { Annotation } from './annotation';
 
 // --- constants --------------------------------------------------------------

package/treb-grid/src/types/sheet_types.ts

@@ -57,21 +57,25 @@ export interface SerializedSheet {
   cell_style_refs?: Style.Properties[]; // old 
   styles?: Style.Properties[];          // new
 
-  // row_style: Style.Properties[];
-  // column_style: Style.Properties[];
-  // row_style: Array<Style.Properties|number>;
-  // column_style: Array<Style.Properties|number>;
   row_style: Record<number, Style.Properties|number>;
   column_style: Record<number, Style.Properties|number>;
 
+  /** 
+   * @deprecated - no one uses this anymore and it's weird 
+   */
   row_pattern?: Style.Properties[];
 
   default_row_height?: number;
   default_column_width?: number;
 
-  row_height?: {[index: number]: number};
-  column_width?: {[index: number]: number};
-  named_ranges?: {[index: string]: IArea};
+  row_height?: Record<number, number>;
+  column_width?: Record<number, number>;
+  named_ranges?: Record<string, IArea>;
+
+  // row_height?: {[index: number]: number};
+  // column_width?: {[index: number]: number};
+  // named_ranges?: {[index: string]: IArea};
+
   freeze?: FreezePane;
 
   id?: number;

package/treb-grid/src/types/tab_bar.ts

@@ -25,7 +25,7 @@ import type { Sheet } from './sheet';
 import type { BaseLayout } from '../layout/base_layout';
 import { MouseDrag } from './drag_mask';
 import type { GridOptions } from './grid_options';
-import { ScaleEvent, ScaleControl } from './scale-control';
+import { type ScaleEvent, ScaleControl } from './scale-control';
 
 export interface ActivateSheetEvent {
   type: 'activate-sheet';

package/treb-parser/src/parser.ts

@@ -19,7 +19,7 @@
  * 
  */
 
-import {
+import type {
   ExpressionUnit,
   UnitAddress,
   UnitIdentifier,
@@ -29,13 +29,14 @@ import {
   UnitUnary,
   DependencyList,
   ParseResult,
-  ArgumentSeparatorType,
-  DecimalMarkType,
   UnitLiteral,
   UnitLiteralNumber,
   ParserFlags,
   UnitStructuredReference,
-  RenderOptions,
+  RenderOptions} from './parser-types';
+import {
+  ArgumentSeparatorType,
+  DecimalMarkType
 } from './parser-types';
 
 interface PrecedenceList {

package/tsproject.json

@@ -3,7 +3,7 @@
     "declaration": true,
     "declarationDir": "declaration",
     "target": "esnext",
-    "module": "es2020",
+    "module": "esnext",
     "strict": true,
     "composite": true,
     "baseUrl": "./",
@@ -16,7 +16,7 @@
     "rootDir": ".",
     "importHelpers": true,
     "noEmitHelpers": true,
-    "importsNotUsedAsValues": "error",
+    "verbatimModuleSyntax": true,
     "lib": [
       "dom", "es2015"
     ],
@@ -24,7 +24,6 @@
     "esModuleInterop": true
   },
   "exclude": [
-    "node_modules",
-    "external-declaration-files"
+    "node_modules"
   ]
 }

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-  },
-  "references": [
-    { "path": "./treb-embed/modern.tsconfig.json" },
-    { "path": "./treb-export/modern.tsconfig.json" }
-  ],
-  "files": []
-}