@trebco/treb 27.5.3 → 27.9.0

package/dist/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v27.5. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v27.9. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /**
  * add our tag to the map
@@ -316,7 +316,7 @@ export declare class EmbeddedSpreadsheet {
      * to support outside tooling by highlighting a list of arguments and
      * responding to selection.
      */
-    ExternalEditor(editor?: Partial<ExternalEditorType>): void;
+    ExternalEditor(config?: Partial<ExternalEditorConfig>): void;
 
     /**
      * Use this function to batch multiple document changes. Essentially the
@@ -1055,7 +1055,7 @@ export interface SetRangeOptions {
      */
     r1c1?: boolean;
 }
-export interface ExternalEditorType {
+export interface ExternalEditorConfig {
 
     /**
      * list of dependencies to highlight. we support undefined entries in
@@ -1074,6 +1074,20 @@ export interface ExternalEditorType {
      * practice.
      */
     update: ExternalEditorCallback;
+
+    /**
+     * a list of nodes that will serve as editors. when you attach, we will do
+     * an initial pass of context highlighting. we highlight on text changes
+     * and insert references if you make a selection in the spreadsheet while
+     * an editor is focused.
+     */
+    nodes: HTMLElement[];
+
+    /**
+     * assume that we're editing a formula. does not require leading `=`.
+     * defaults to `true` for historical reasons.
+     */
+    assume_formula?: boolean;
 }
 export type DependencyList = Array<IArea | ICellAddress | undefined>;
 export type ExternalEditorCallback = (selection?: string) => DependencyList | undefined;
@@ -1277,6 +1291,26 @@ export interface TableSortOptions {
 }
 export type TableSortType = 'text' | 'numeric' | 'auto';
 
+/**
+ * options for the evaluate function
+ */
+export interface EvaluateOptions {
+
+    /**
+     * argument separator to use when parsing input. set this option to
+     * use a consistent argument separator independent of current locale.
+     */
+    argument_separator?: ',' | ';';
+
+    /**
+     * allow R1C1-style references. the Evaluate function cannot use
+     * relative references (e.g. R[-1]C[0]), so those will always fail.
+     * however it may be useful to use direct R1C1 references (e.g. R3C4),
+     * so we optionally support that behind this flag.
+     */
+    r1c1?: boolean;
+}
+
 /**
  * this is the document type used by TREB. it has a lot of small variations
  * for historical reasons and backwards compatibility. usually it's preferable
@@ -1807,23 +1841,3 @@ export interface ExportOptions {
     /** use number formats when exporting numbers */
     formatted?: boolean;
 }
-
-/**
- * options for the evaluate function
- */
-export interface EvaluateOptions {
-
-    /**
-     * argument separator to use when parsing input. set this option to
-     * use a consistent argument separator independent of current locale.
-     */
-    argument_separator?: ',' | ';';
-
-    /**
-     * allow R1C1-style references. the Evaluate function cannot use
-     * relative references (e.g. R[-1]C[0]), so those will always fail.
-     * however it may be useful to use direct R1C1 references (e.g. R3C4),
-     * so we optionally support that behind this flag.
-     */
-    r1c1?: boolean;
-}

package/notes/conditional-fomratring.md

@@ -0,0 +1,29 @@
+conditional formatting TODO list
+
+ - import/export 
+
+ - run through the command queue
+
+ - dragging selection knob should expand conditional formats
+   (if you have the whole thing selected). at the moment it
+   seems to be hard-copying the format, which is bad.
+
+---
+
+done
+ 
+ - consolidate expression and cell-match types, in the sheet part,
+   handle arrays and single cells
+
+   note that these are now essentially the same thing, with a small
+   difference when we attach the conditional format to the graph. so 
+   we could combine them. but, because there's a hard distinction in 
+   XLSX, we will probably need to keep track of which is which.
+
+ - if you do the above you can remove the "applied" flag
+
+ - update range (and formula) based on insert/delete row/col
+   (+ sheet name change)
+
+ - use a gradient function
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "27.5.3",
+  "version": "27.9.0",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {
@@ -15,9 +15,9 @@
     "@types/node": "^20.4.0",
     "@typescript-eslint/eslint-plugin": "^6.1.0",
     "@typescript-eslint/parser": "^6.1.0",
-    "archiver": "^5.3.0",
+    "archiver": "^6.0.1",
     "cssnano": "^6.0.0",
-    "esbuild": "^0.18.11",
+    "esbuild": "^0.19.2",
     "eslint": "^8.19.0",
     "fast-xml-parser": "^4.0.7",
     "html-minifier": "^4.0.0",

package/treb-base-types/src/area.ts

@@ -55,6 +55,13 @@ export interface IArea {
   end: ICellAddress;
 }
 
+export interface PatchOptions {
+  before_column: number;
+  column_count: number;
+  before_row: number;
+  row_count: number;
+}
+
 /**
  * type guard function
  * FIXME: is there a naming convention for these?
@@ -197,7 +204,181 @@ export class Area implements IArea { // }, IterableIterator<ICellAddress> {
       });
   }
 
+  /**
+   * adjust an area in response to an insert/delete operation.
+   * I noticed we were doing this in several places. moved here to unify.
+   * 
+   * @param source - the starting area. we'll create a new object to return
+   * (we will not mutate in place)
+   */
+  public static PatchArea(source: IArea, options: PatchOptions): Area | false {
+
+    const { before_column, column_count, before_row, row_count } = options;
+
+    let area = new Area(source.start, source.end);
+    const sheet_id = source.start.sheet_id;
+
+    if (column_count && before_column <= area.end.column) {
+
+      /*
+      // (1) we are before the insert point, not affected
+
+      if (before_column > range.end.column) {
+        continue;
+      }
+      */
+
+      if (column_count > 0) {
+
+        // (2) it's an insert and we are past the insert point:
+        //     increment [start] and [end] by [count]
+
+        if (before_column <= area.start.column) {
+          area.Shift(0, column_count);
+        }
+
+        // (3) it's an insert and we contain the insert point:
+        //     increment [end] by [count]
+
+        else if (before_column > area.start.column && before_column <= area.end.column) {
+          area.ConsumeAddress({row: area.end.row, column: area.end.column + column_count});
+        }
+
+        else {
+          console.warn(`AA X case 1`, before_column, column_count, JSON.stringify(area));
+        }
+
+      }
+      else if (column_count < 0) {
+
+        // (4) it's a delete and we are past the delete point (before+count):
+        //     decrement [start] and [end] by [count]
+
+        if (before_column - column_count <= area.start.column) {
+          area.Shift(0, column_count);
+        }
+
+        // (5) it's a delete and contains the entire range
+
+        else if (before_column <= area.start.column && before_column - column_count > area.end.column) {
+
+          // we can actually just return at this point
+          return false;
+
+        }
+
+        // (6) it's a delete and contains part of the range. clip the range.
+
+        else if (before_column <= area.start.column) {
+          const last_column = before_column - column_count - 1;
+          area = new Area({
+            row: area.start.row, column: last_column + 1 + column_count, sheet_id }, {
+              row: area.end.row, column: area.end.column + column_count });
+        }
+
+        else if (before_column <= area.end.column) {
+          const last_column = before_column - column_count - 1;
+
+          if (last_column >= area.end.column) {
+            area = new Area({
+              row: area.start.row, column: area.start.column, sheet_id }, {
+                row: area.end.row, column: before_column - 1 });
+          }
+          else {
+            area = new Area({
+              row: area.start.row, column: area.start.column, sheet_id }, {
+                row: area.end.row, column: area.start.column + area.columns + column_count - 1});
+          }
+
+        }
+
+        else {
+          console.warn(`AA X case 2`, before_column, column_count, JSON.stringify(area));
+        }
 
+      }
+    }
+
+    if (row_count && before_row <= area.end.row) {
+
+      /*
+      // (1) we are before the insert point, not affected
+
+      if (before_column > range.end.column) {
+        continue;
+      }
+      */
+
+      if (row_count > 0) {
+
+        // (2) it's an insert and we are past the insert point:
+        //     increment [start] and [end] by [count]
+
+        if (before_row <= area.start.row) {
+          area.Shift(row_count, 0);
+        }
+
+        // (3) it's an insert and we contain the insert point:
+        //     increment [end] by [count]
+
+        else if (before_row > area.start.row && before_row <= area.end.row) {
+          area.ConsumeAddress({row: area.end.row + row_count, column: area.end.column});
+        }
+
+        else {
+          console.warn(`AA X case 3`, before_row, row_count, JSON.stringify(area));
+        }
+
+      }
+      else if (row_count < 0) {
+
+        // (4) it's a delete and we are past the delete point (before+count):
+        //     decrement [start] and [end] by [count]
+
+        if (before_row - row_count <= area.start.row) {
+          area.Shift(row_count, 0);
+        }
+
+        // (5) it's a delete and contains the entire range
+
+        else if (before_row <= area.start.row && before_row - row_count > area.end.row) {
+          return false;
+        }
+
+        // (6) it's a delete and contains part of the range. clip the range.
+
+        else if (before_row <= area.start.row) {
+          const last_row = before_row - row_count - 1;
+          area = new Area({
+            column: area.start.column, row: last_row + 1 + row_count, sheet_id }, {
+              column: area.end.column, row: area.end.row + row_count });
+        }
+
+        else if (before_row <= area.end.row) {
+          const last_row = before_row - row_count - 1;
+          if (last_row >= area.end.row) {
+            area = new Area({
+              column: area.start.column, row: area.start.row, sheet_id }, {
+                column: area.end.column, row: before_row - 1 });
+          }
+          else {
+            area = new Area({
+              column: area.start.column, row: area.start.row, sheet_id }, {
+                column: area.end.column, row: area.start.row + area.rows + row_count - 1 });
+          }
+
+        }
+
+        else {
+          console.warn(`AA X case 4`, before_row, row_count, JSON.stringify(area));
+        }
+
+      }
+    }
+
+    return area;
+
+  }
 
   /** accessor returns a _copy_ of the start address */
   public get start(): ICellAddress {

package/treb-base-types/src/evaluate-options.ts

@@ -0,0 +1,21 @@
+
+/**
+ * options for the evaluate function
+ */
+export interface EvaluateOptions {
+
+  /**
+   * argument separator to use when parsing input. set this option to 
+   * use a consistent argument separator independent of current locale.
+   */
+  argument_separator?: ','|';';
+
+  /** 
+   * allow R1C1-style references. the Evaluate function cannot use
+   * relative references (e.g. R[-1]C[0]), so those will always fail. 
+   * however it may be useful to use direct R1C1 references (e.g. R3C4),
+   * so we optionally support that behind this flag.
+   */
+  r1c1?: boolean;
+  
+}

package/treb-base-types/src/gradient.ts

@@ -0,0 +1,97 @@
+
+import { Measurement } from 'treb-utils';
+import { type Color } from './style';
+import { type Theme, ThemeColor2 } from './theme';
+import { ColorFunctions } from './color';
+
+export interface GradientStop {
+  value: number;
+  color: Color;
+}
+
+export type ColorSpace = 'RGB'|'HSL';
+
+export class Gradient {
+
+  public mapped: Array<GradientStop & { resolved: number[] }>;
+
+  constructor(stops: GradientStop[], theme: Theme, public color_space: ColorSpace = 'HSL') {
+
+    this.mapped = stops.map(stop => {
+
+      if (stop.value < 0 || stop.value > 1) {
+        throw new Error('invalid stop value');
+      }
+
+      const rgb = Measurement.MeasureColor(ThemeColor2(theme, stop.color));
+
+      let resolved: number[] = [];
+
+      if (color_space === 'HSL') {
+        const hsl = ColorFunctions.RGBToHSL(rgb[0], rgb[1], rgb[2]);
+        resolved = [hsl.h, hsl.s, hsl.l];
+      }
+      else {
+        resolved = [...rgb];
+      }
+
+      return {
+        ...stop, resolved,
+      };
+
+    });
+
+    this.mapped.sort((a, b) => a.value - b.value);
+
+    // FIXME: we should expand the gradient, but for now we'll just clamp
+
+    if (this.mapped[0].value > 0) {
+      this.mapped.unshift({
+        ...this.mapped[0], value: 0
+      });
+    }
+
+    if (this.mapped[this.mapped.length - 1].value < 1) {
+      this.mapped.push({
+        ...this.mapped[this.mapped.length - 1], value: 1
+      });
+    }
+
+  }
+
+  public RenderColor(values: number[]) {
+    if (this.color_space === 'RGB') {
+      return { text: `rgb(${values})` };
+    }
+    return { text: `hsl(${values[0]},${values[1] * 100}%,${values[2] * 100}%)` };
+  }
+
+  public Interpolate(value: number): Color {
+
+    value = Math.min(1, Math.max(0, value));
+    for (const [index, stop] of this.mapped.entries()) {
+
+      if (value === stop.value) {
+        return this.RenderColor(stop.resolved);
+      }
+      if (value < stop.value) {
+        const a = this.mapped[index - 1];
+        const b = stop;
+
+        const range = b.value - a.value; // FIXME: cache
+        const advance = value - a.value;
+        
+        const values = [0,1,2].map(index => {
+          return a.resolved[index] + (b.resolved[index] - a.resolved[index]) / range * advance;
+        });
+
+        return this.RenderColor(values);
+
+      }
+    }
+    
+    return { text: '' };
+
+  }
+
+}

package/treb-base-types/src/import.ts

@@ -25,7 +25,7 @@ import type { IArea } from './area';
 import type { AnnotationLayout } from './layout';
 import type { DataValidation } from './cell';
 import type { Table } from './table';
-import type { AnnotationType } from 'treb-grid';
+import type { AnnotationType, ConditionalFormat } from 'treb-grid';
 
 export interface CellParseResult {
   row: number,
@@ -58,6 +58,7 @@ export interface ImportedSheetData {
   column_widths: number[];
   row_heights: number[];
   styles: CellStyle[];
+  conditional_formats: ConditionalFormat[];
 
   // optional, for backcompat
   sheet_style?: number;

package/treb-base-types/src/index.ts

@@ -36,6 +36,8 @@ export * from './layout';
 export * from './render_text';
 export * from './api_types';
 export * from './table';
+export * from './gradient';
+export * from './evaluate-options';
 
 // import * as Style from './style';
 // export { Style };