@trebco/treb 28.17.4 → 29.1.2

package/dist/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v28.17. Copyright 2018-2024 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v29.1. Copyright 2018-2024 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /**
  * add our tag to the map
@@ -929,8 +929,9 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     /**
      * Create a named range or named expression. A named range refers to an
-     * address or range. A named expression can be a value or formula, basically
-     * anything you would type into a cell.
+     * address or range. A named expression can be any value or formula. To set
+     * the value as a literal string, enclose the string in double-quotes (as
+     * you would when using a string as a function argument).
      *
      * @param value range, value or expression
      *
@@ -943,7 +944,7 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
      *
      * @public
      */
-    DefineName(name: string, value: RangeReference | CellValue): void;
+    DefineName(name: string, value: RangeReference | CellValue, scope?: string | number, overwrite?: boolean): void;
 
     /**
      * Set or remove a link in a cell.
@@ -1082,8 +1083,24 @@ export interface FreezePane {
     rows: number;
     columns: number;
 }
-export type AnnotationType = 'treb-chart' | 'image' | 'textbox' | 'external';
-export declare type BorderConstants = "none" | "all" | "outside" | "top" | "bottom" | "left" | "right";
+export declare const StandardGradientsList: {
+    readonly 'red-green': {
+        readonly color_space: "RGB";
+        readonly stops: GradientStop[];
+    };
+    readonly 'red-yellow-green': {
+        readonly color_space: "RGB";
+        readonly stops: GradientStop[];
+    };
+    readonly 'green-red': {
+        readonly color_space: "RGB";
+        readonly stops: GradientStop[];
+    };
+    readonly 'green-yellow-red': {
+        readonly color_space: "RGB";
+        readonly stops: GradientStop[];
+    };
+};
 
 /**
  * options for serializing data
@@ -1119,73 +1136,7 @@ export interface SerializeOptions {
      */
     export_functions?: boolean;
 }
-
-/**
- * options for the SetRange method
- */
-export interface SetRangeOptions {
-
-    /** transpose rectangular array before inserting */
-    transpose?: boolean;
-
-    /** recycle values (R-style) */
-    recycle?: boolean;
-
-    /** apply as an array (as if you pressed ctrl+shift+enter) */
-    array?: boolean;
-
-    /** spill over */
-    spill?: boolean;
-
-    /**
-     * argument separator to use when parsing the input formula. set this
-     * option to call SetRange with a consistent argument separator,
-     * independent of current locale.
-     */
-    argument_separator?: ',' | ';';
-
-    /**
-     * allow R1C1-style references; these can be either absolute
-     * addresses (e.g. R2C4) or relative to the cell (e.g. R[-3]C[0]).
-     */
-    r1c1?: boolean;
-}
-export interface ExternalEditorConfig {
-
-    /**
-     * list of dependencies to highlight. we support undefined entries in
-     * this list so you can use the result of `EmbeddedSpreadsheet.Resolve`,
-     * which may return undefined.
-     */
-    dependencies: DependencyList;
-
-    /**
-     * this callback will be called when the selection changes in the
-     * spreadsheet and this external editor is active. return an updated
-     * list of dependencies to highlight.
-     *
-     * NOTE: this is currently synchronous, but don't rely on that. it
-     * might switch to async in the future depending on how it works in
-     * 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;
+export type AnnotationType = 'treb-chart' | 'image' | 'textbox' | 'external';
 
 /**
  * Structure represents a 2d range of cells.
@@ -1408,6 +1359,74 @@ export interface EvaluateOptions {
      */
     r1c1?: boolean;
 }
+export declare type BorderConstants = "none" | "all" | "outside" | "top" | "bottom" | "left" | "right";
+
+/**
+ * options for the SetRange method
+ */
+export interface SetRangeOptions {
+
+    /** transpose rectangular array before inserting */
+    transpose?: boolean;
+
+    /** recycle values (R-style) */
+    recycle?: boolean;
+
+    /** apply as an array (as if you pressed ctrl+shift+enter) */
+    array?: boolean;
+
+    /** spill over */
+    spill?: boolean;
+
+    /**
+     * argument separator to use when parsing the input formula. set this
+     * option to call SetRange with a consistent argument separator,
+     * independent of current locale.
+     */
+    argument_separator?: ',' | ';';
+
+    /**
+     * allow R1C1-style references; these can be either absolute
+     * addresses (e.g. R2C4) or relative to the cell (e.g. R[-3]C[0]).
+     */
+    r1c1?: boolean;
+}
+export interface ExternalEditorConfig {
+
+    /**
+     * list of dependencies to highlight. we support undefined entries in
+     * this list so you can use the result of `EmbeddedSpreadsheet.Resolve`,
+     * which may return undefined.
+     */
+    dependencies: DependencyList;
+
+    /**
+     * this callback will be called when the selection changes in the
+     * spreadsheet and this external editor is active. return an updated
+     * list of dependencies to highlight.
+     *
+     * NOTE: this is currently synchronous, but don't rely on that. it
+     * might switch to async in the future depending on how it works in
+     * 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;
 
 /**
  * this is the document type used by TREB. it has a lot of small variations
@@ -1436,7 +1455,7 @@ export interface TREBDocument {
      * opaque user data. we don't read or parse this, but applications can
      * use it to store arbitrary data.
      */
-    user_data?: any;
+    user_data?: unknown;
 
     /**
      * per-sheet data. this should be an array, but for historical reasons
@@ -1456,12 +1475,17 @@ export interface TREBDocument {
      */
     rendered_values?: boolean;
 
-    /** document named ranges */
+    /** document named ranges @deprecated */
     named_ranges?: Record<string, IArea>;
 
-    /** document named expressions */
+    /** document named expressions @deprecated */
     named_expressions?: SerializedNamedExpression[];
 
+    /**
+     * new consolidated named ranges & expressions
+     */
+    named?: SerializedNamed[];
+
     /** document macro functions */
     macro_functions?: SerializedMacroFunction[];
 
@@ -1566,10 +1590,31 @@ export interface SelectionEvent {
 export interface FocusViewEvent {
     type: 'focus-view';
 }
+export interface SerializedMacroFunction {
+    name: string;
+    function_def: string;
+    argument_names?: string[];
+    description?: string;
+}
 export interface SerializedNamedExpression {
     name: string;
     expression: string;
 }
+
+/**
+ * serialized type
+ */
+export interface SerializedNamed {
+    name: string;
+    area?: SerializedArea;
+    expression?: string;
+    scope?: string;
+}
+export type SerializedArea = IArea & {
+    start: ICellAddress & {
+        sheet: string;
+    };
+};
 export interface SerializedSheet {
 
     /** cell data */
@@ -1937,12 +1982,6 @@ export interface Corner {
     address: ICellAddress;
     offset: AddressOffset;
 }
-export interface SerializedMacroFunction {
-    name: string;
-    function_def: string;
-    argument_names?: string[];
-    description?: string;
-}
 
 /**
  * options for exporting CSV/TSV

package/eslint.config.js

@@ -0,0 +1,21 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+
+      // allow destructuring to use garbage variables. prefix name with 
+      // underscore (or just use underscore).
+
+      "@typescript-eslint/no-unused-vars": [
+        "error", { 
+          "destructuredArrayIgnorePattern": "^_",
+        }],
+    },
+  },
+);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "28.17.4",
+  "version": "29.1.2",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {
@@ -14,19 +14,18 @@
     "@types/html-minifier": "^4.0.2",
     "@types/node": "^20.8.5",
     "@types/uzip": "^0.20201231.0",
-    "@typescript-eslint/eslint-plugin": "^6.1.0",
-    "@typescript-eslint/parser": "^6.1.0",
     "archiver": "^6.0.1",
     "base64-js": "^1.5.1",
     "cssnano": "^6.0.0",
-    "esbuild": "^0.19.2",
-    "eslint": "^8.19.0",
+    "esbuild": "^0.20.1",
+    "eslint": "^8.56.0",
     "fast-xml-parser": "^4.0.7",
     "html-minifier": "^4.0.0",
     "sass": "^1.69.3",
     "treb-base-types": "file:treb-base-types",
     "treb-calculator": "file:treb-calculator",
     "treb-charts": "file:treb-charts",
+    "treb-data-model": "file:treb-data-model",
     "treb-export": "file:treb-export",
     "treb-format": "file:treb-format",
     "treb-grid": "file:treb-grid",
@@ -34,7 +33,8 @@
     "treb-utils": "file:treb-utils",
     "ts-node-dev": "^2.0.0",
     "tslib": "^2.2.0",
-    "typescript": "^5.0.2",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^7.0.2",
     "uzip": "^0.20201231.0"
   },
   "scripts": {

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

@@ -55,6 +55,8 @@ export interface IArea {
   end: ICellAddress;
 }
 
+export type SerializedArea = IArea & { start: ICellAddress & { sheet: string }};
+
 export interface PatchOptions {
   before_column: number;
   column_count: number;
@@ -712,7 +714,7 @@ export class Area implements IArea {
       },
     };
 
-  };
+  }
 
   /* * @deprecated * /
   public Iterate(f: (...args: any[]) => any): void {
@@ -809,7 +811,7 @@ export class Area implements IArea {
    * the start.
    * 
    */
-  public toJSON(): any {
+  public toJSON(): IArea {
 
     return {
       start: { ...this.start_ },

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

@@ -22,7 +22,7 @@
 // import { Parser } from 'treb-parser';
 
 import type { Area, IArea } from './area';
-import type { Style, CellStyle } from './style';
+import type { CellStyle } from './style';
 import type { TextPart } from './text_part';
 import type { Complex } from './value-type';
 import { ValueType, GetValueType } from './value-type';

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

@@ -31,7 +31,7 @@ import { Cell } from './cell';
 import type { Table } from './table';
 import { type SerializedValueType, ValueType, GetValueType, ValueTypeList } from './value-type';
 import type { CellValue, UnionValue } from './union';
-import type { Style, CellStyle } from './style';
+import type { CellStyle } from './style';
 
 export interface CellSerializationOptions {
   preserve_type?: boolean;
@@ -170,10 +170,8 @@ export class Cells {
   /** switching to row-major */
   public data: Cell[][] = [];
 
-  // tslint:disable-next-line:variable-name
   private rows_ = 0;
 
-  // tslint:disable-next-line:variable-name
   private columns_ = 0;
 
   get rows(): number { return this.rows_; }
@@ -206,7 +204,7 @@ export class Cells {
    */
   public InsertColumns(before = 0, count = 1): void {
 
-    const pre = JSON.parse(JSON.stringify(this.data[13]));
+    // const pre = JSON.parse(JSON.stringify(this.data[13]));
 
     // NOTE: iterating a sparse array, in chrome at least, only
     // hits populated keys. the returned array has the same
@@ -404,6 +402,8 @@ export class Cells {
     return type ? ValueTypeList[type] : undefined;
   }
 
+
+
   /**
    * this method is used for importing legacy data validation types. in those
    * those we used a numeric enum. we're just dropping that altogether (c.f.
@@ -422,9 +422,12 @@ export class Cells {
    */
   public ImportDataValidation(value: DataValidation): DataValidation|undefined {
 
-    if (typeof (value as any).type === 'number') {
-      const types = ['list', 'date', 'range', 'number', 'boolean'];
-      (value as any).type = types[(value as any).type];
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const type: DataValidation['type']|number = (value as any).type;
+
+    if (typeof type === 'number') {
+      const types: Array<DataValidation['type']> = ['list', 'date', 'range', 'number', 'boolean'];
+      value.type = types[type];
       if (!value.type) {
         return undefined;
       }
@@ -755,6 +758,11 @@ export class Cells {
         const new_data: NestedRowData[] = [];
 
         for (const element of data) {
+
+          // the construction here seems to be removing the 
+          // "row" key -- is there a better way to do that? 
+
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
           const {row, ...remainder} = element;
           if (!cells[element.row]) cells[element.row] = [];
           cells[element.row].push(remainder);
@@ -774,6 +782,7 @@ export class Cells {
         const new_data: NestedColumnData[] = [];
 
         for (const element of data) {
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
           const {column, ...remainder} = element;
           if (!cells[element.column]) cells[element.column] = [];
           cells[element.column].push(remainder);

package/treb-base-types/src/dom-utilities.ts

@@ -22,7 +22,7 @@
 const SVGNS = 'http://www.w3.org/2000/svg';
 
 type EventHandlerMap = {
-  [key in keyof HTMLElementEventMap]: (event: HTMLElementEventMap[key]) => any;
+  [key in keyof HTMLElementEventMap]: (event: HTMLElementEventMap[key]) => unknown;
 }
 
 type StyleMap = {
@@ -202,12 +202,14 @@ export class DOMContext {
 
       if (options.events) {
         for (const [key, value] of Object.entries(options.events)) {
-          element.addEventListener(key, value as any); // typing works well up until this point
+          element.addEventListener(key, value as (event: unknown) => void); // typing works well up until this point
         }
       }
 
       if (options.style) {
         for (const [key, value] of Object.entries(options.style)) {
+          
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           (element.style as any)[key] = value; // more sloppy typing
         }
       }

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

@@ -20,12 +20,12 @@
  */
 
 import type { CellStyle } from './style';
-import type { SerializedValueType, ValueType } from './value-type';
+import type { SerializedValueType } from './value-type';
 import type { IArea } from './area';
 import type { AnnotationLayout } from './layout';
 import type { DataValidation } from './cell';
 import type { Table } from './table';
-import type { AnnotationType, ConditionalFormat } from 'treb-grid';
+import type { AnnotationType, ConditionalFormat } from 'treb-data-model';
 
 export interface CellParseResult {
   row: number,

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

@@ -45,11 +45,11 @@ export class Rectangle implements IRectangle {
   }
 
   public static IsRectangle(obj: unknown): obj is IRectangle {
-    return (typeof obj === 'object') &&
-      (typeof (obj as any)?.left === 'number') && 
-      (typeof (obj as any)?.top === 'number') && 
-      (typeof (obj as any)?.width === 'number') && 
-      (typeof (obj as any)?.height === 'number');
+    return (!!obj && typeof obj === 'object') &&
+      (typeof (obj as Record<string, unknown>).left === 'number') && 
+      (typeof (obj as Record<string, unknown>).top === 'number') && 
+      (typeof (obj as Record<string, unknown>).width === 'number') && 
+      (typeof (obj as Record<string, unknown>).height === 'number');
   }
 
   constructor(  public left = 0,

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

@@ -76,7 +76,12 @@ export interface UndefinedUnion {
 
 export interface ExtendedUnion {
   type: ValueType.object;
-  value: any;
+
+  // this needs to come out but it's costly; we apparently relied
+  // pretty heavily on this any leaking in and allowing lots of 
+  // sloppy comparisons. work in progress.
+
+  value: unknown; // any;
   key?: string;
 }
 

package/treb-base-types/src/value-type.ts

@@ -139,7 +139,6 @@ export type SerializedValueType = // typeof ValueTypeList[number];
  * properly. I can't arrive at a good way of doing that automatically. 
  * 
  * old comments:
- * ---
  * 
  * undefined is 0 so we can test it as falsy.
  *
@@ -157,6 +156,7 @@ export enum ValueType {
   boolean = 4,
 
   // we don't actually use this type, it's here for matching only
+  // OK we use it all the time now
   object = 5,
 
   // error is a STRING VALUE... object errors are layered on top? is that