@trebco/treb 28.17.4 → 29.1.2

package/treb-embed/src/embedded-spreadsheet.ts

@@ -25,49 +25,58 @@
 /// <reference path="./content-types.d.ts" />
 
 import type {
-  GridEvent, SerializeOptions, Annotation,
-  SerializedModel, FreezePane, SerializedSheet,
+  GridEvent, 
   SheetChangeEvent, GridOptions, 
-  GridSelection, CellEvent, FunctionDescriptor, 
-  AnnotationViewData,
-  AnnotationType, 
+  CellEvent, FunctionDescriptor, 
   ExternalEditorConfig,
-  ConditionalFormatDuplicateValuesOptions,
-  ConditionalFormatDuplicateValues,
-  ConditionalFormatGradientOptions,
-  ConditionalFormat, 
-  ConditionalFormatGradient, 
-  ConditionalFormatExpression,
-  StandardGradient,
-  CondifionalFormatExpressionOptions,
-  ConditionalFormatCellMatchOptions,
-  ConditionalFormatCellMatch,
-  MacroFunction,
-  SerializedNamedExpression,
 } from 'treb-grid';
 
+import { DataModel, Sheet, StandardGradientsList } from 'treb-data-model';
+import type { 
+    SerializeOptions, 
+    Annotation,
+    AnnotationViewData,
+    AnnotationType, 
+    MacroFunction, 
+    GridSelection, 
+    ConnectedElementType, 
+    SerializedModel, 
+    SerializedSheet, 
+    FreezePane,
+    ConditionalFormatDuplicateValuesOptions,
+    ConditionalFormatGradientOptions,
+    ConditionalFormat, 
+    ConditionalFormatGradient, 
+    ConditionalFormatExpression,
+    StandardGradient,
+    CondifionalFormatExpressionOptions,
+    ConditionalFormatCellMatchOptions,
+    ConditionalFormatCellMatch,
+  
+   } from 'treb-data-model';
+
+
 import {
-  DataModel, Grid, BorderConstants, Sheet, ErrorCode, UA,
-  StandardGradientsList,
+  Grid, BorderConstants, ErrorCode, UA,
 } from 'treb-grid';
 
 import { 
   Parser, DecimalMarkType, 
   ArgumentSeparatorType, QuotedSheetNameRegex } from 'treb-parser';
 
-import { Calculator, type LeafVertex } from 'treb-calculator';
+import { Calculator } from 'treb-calculator';
 
 import type {
   ICellAddress, 
   EvaluateOptions,
   IArea, CellValue, Point,
   Complex, ExtendedUnion, IRectangle,
-  AddressReference, RangeReference, TableSortOptions, Table, TableTheme, GradientStop,
+  AddressReference, RangeReference, TableSortOptions, Table, TableTheme,
 } from 'treb-base-types';
 
 import {
   IsArea, ThemeColorTable, ComplexToString, Rectangle, IsComplex, type CellStyle,
-  Localization, Style, type Color, ThemeColor2, IsCellAddress, Area, IsFlatData, IsFlatDataArray, Gradient, ValueType, DOMContext, 
+  Localization, Style, type Color, ThemeColor2, IsCellAddress, Area, IsFlatData, IsFlatDataArray, Gradient, DOMContext, 
 } from 'treb-base-types';
 
 import { EventSource, ValidateURI } from 'treb-utils';
@@ -90,7 +99,6 @@ import { Chart, ChartFunctions } from 'treb-charts';
 import type { SetRangeOptions } from 'treb-grid';
 
 import type { StateLeafVertex } from 'treb-calculator';
-import type { ConnectedElementType } from 'treb-grid';
 
 
 // --- worker ------------------------------------------------------------------
@@ -496,7 +504,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * parameter you can set when creating the spreadsheet.
    */
   public get user_data(): USER_DATA_TYPE|undefined {
-    return this.grid.model.user_data;
+    return this.grid.model.user_data as USER_DATA_TYPE;
   }
 
   /** 
@@ -693,7 +701,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     if (this.options.local_storage && !options.model ) {
 
-      window.addEventListener('visibilitychange', event => {
+      window.addEventListener('visibilitychange', () => {
         if (document.visibilityState === 'hidden') {
           if (this.options.local_storage && this.dirty) {
             this.SaveLocalStorage(this.options.local_storage);
@@ -784,7 +792,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
 
     if (options.model) {
-      this.model = options.model.model;
+      this.model = options.model.model as DataModel;
       this.calculator = options.model.calculator; // as CalcType;
       this.DOM = options.model.DOM;
     }
@@ -946,7 +954,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
           case 'style':
             this.DocumentChange();
-            this.UpdateDocumentStyles(false);
+            this.UpdateDocumentStyles();
             this.UpdateSelectionStyle();
             break;
 
@@ -1297,7 +1305,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       if (event.type === 'structure') {
         this.grid.EnsureActiveSheet();
         this.grid.UpdateLayout();
-        (this.grid as any).tab_bar?.Update();
+        // (this.grid as any).tab_bar?.Update();
+        this.grid.UpdateTabBar();
       }
     });
 
@@ -1315,7 +1324,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       if (event.type === 'structure') {
         view.grid.EnsureActiveSheet();
         view.grid.UpdateLayout();
-        (view.grid as any).tab_bar?.Update();
+        // (view.grid as any).tab_bar?.Update();
+        view.grid.UpdateTabBar();
       }
     });
 
@@ -2235,7 +2245,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     const element = this.model.connected_elements.get(id);
     if (element) {
       element.formula = formula;
-      const internal = (element.internal) as { vertex: StateLeafVertex, state: any };
+
+      const internal = (element.internal) as { vertex: StateLeafVertex, state: unknown };
 
       if (internal?.state) {
         internal.state = undefined;
@@ -2262,8 +2273,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     // FIXME: merge w/ insert annotation?
 
-    let r1c1 = options?.r1c1 || false;
-    let argument_separator = options?.argument_separator || this.parser.argument_separator; // default to current
+    const r1c1 = options?.r1c1 || false;
+    const argument_separator = options?.argument_separator || this.parser.argument_separator; // default to current
 
     this.parser.Save();
     this.parser.flags.r1c1 = r1c1;
@@ -2776,7 +2787,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
 
     if (!this.export_worker) {
-      this.export_worker = await this.LoadWorker('export');
+      this.export_worker = await this.LoadWorker();
     }
 
     return new Promise<Blob>((resolve, reject) => {
@@ -3295,7 +3306,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
 
     if (text && filename) {
-      const blob = new Blob([text as any], { type: 'text/plain;charset=utf-8' });
+      const blob = new Blob([text], { type: 'text/plain;charset=utf-8' });
       this.SaveAs(blob, filename);
     }
 
@@ -3927,37 +3938,6 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     return this.calculator.Unresolve(ref, this.grid.active_sheet, qualified, named);
 
-    /*
-    let range = '';
-    const area = IsCellAddress(ref) ? new Area(ref) : new Area(ref.start, ref.end);
-
-    if (named) {
-      const named_range = this.model.named_ranges.MatchSelection(area);
-      if (named_range) {
-        return named_range;
-      }
-    }
-
-    if (area.count > 1) {
-      range = Area.CellAddressToLabel(area.start) + ':' + Area.CellAddressToLabel(area.end);
-    }
-    else {
-      range = Area.CellAddressToLabel(area.start);
-    }
-
-    if (!qualified) {
-      return range;
-    }
-
-    // is there a function to resolve sheet? actually, don't we know that
-    // the active selection must be on the active sheet? (...)
-
-    const sheet_id = area.start.sheet_id || this.grid.active_sheet.id;
-    const sheet_name = this.calculator.ResolveSheetName(sheet_id, true);
-
-    return sheet_name ? sheet_name + '!' + range : range;
-    */
-
   }
   
   /**
@@ -4162,8 +4142,9 @@ export 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
    * 
@@ -4176,7 +4157,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * 
    * @public
    */
-  public DefineName(name: string, value: RangeReference|CellValue): void {
+  public DefineName(name: string, value: RangeReference|CellValue, scope?: string|number, overwrite = false): void {
 
     // how can we unify named ranges and named expressions?
     //
@@ -4199,9 +4180,19 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       throw new Error('invalid value (null or undefined)');
     }
 
+    if (typeof scope === 'string') {
+      const id = this.model.sheets.ID(scope);
+      if (typeof id === 'number') {
+        scope = id;
+      }
+      else {
+        throw new Error('invalid scope; use a sheet name or sheet id');
+      }
+    }
+
     if (typeof value === 'object') {
       if (IsCellAddress(value) || IsArea(value)) {
-        this.grid.SetName(name, this.model.ResolveArea(value, this.grid.active_sheet));
+        this.grid.SetName(name, this.model.ResolveArea(value, this.grid.active_sheet), undefined, scope, overwrite);
         return;
       }
     }
@@ -4218,45 +4209,17 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       switch (parse_result.expression.type) {
         case 'address':
         case 'range':
-          this.grid.SetName(name, this.model.ResolveArea(parse_result.expression, this.grid.active_sheet));
+          this.grid.SetName(name, this.model.ResolveArea(parse_result.expression, this.grid.active_sheet), undefined, scope, overwrite);
           return;
       }
-      this.grid.SetName(name, undefined, value);
+      this.grid.SetName(name, undefined, value, scope, overwrite);
       
     }
     else {
-      this.grid.SetName(name, undefined, value.toString());
+      this.grid.SetName(name, undefined, value.toString(), scope, overwrite);
     }
     
-
-    /*
-    // API v1 OK
-
-    if (!range) {
-      const selection = this.GetSelectionReference();
-      if (!selection.empty) {
-        range = selection.area;
-      }
-      else {
-        throw new Error('invalid reference');
-      }
-    }
-
-    // NOTE: AC is handled internally
-
-    this.grid.SetName(name, this.model.ResolveArea(range, this.grid.active_sheet));
-    */
-  }
-
-  /* *
-   * define a named expression
-   * 
-   * @internal
-   * /
-  public DefineNamedExpression(name: string, expression: string): void {
-    this.grid.SetName(name, undefined, expression);
   }
-  */
 
   /**
    * Set or remove a link in a cell. 
@@ -4297,7 +4260,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     let resolved: Area|undefined = undefined; 
 
-    if (!!range) {
+    if (range) {
       resolved = this.model.ResolveArea(range, this.grid.active_sheet);
       if (resolved.start.sheet_id) {
         if (resolved.start.sheet_id !== this.grid.active_sheet.id) {
@@ -4511,58 +4474,14 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       }
     }
 
-    // when serializing named expressions, we have to make sure
-    // that there's a sheet name in any address/range. 
-
-    const named_expressions: SerializedNamedExpression[] = [];
-    if (this.model.named_expressions) {
-
-      for (const [name, expr] of this.model.named_expressions) {
-        this.parser.Walk(expr, unit => {
-          if (unit.type === 'address' || unit.type === 'range') {
-            const test = unit.type === 'range' ? unit.start : unit;
-
-            test.absolute_column = test.absolute_row = true;
-
-            if (!test.sheet) {
-              if (test.sheet_id) {
-                const sheet = this.model.sheets.Find(test.sheet_id);
-                if (sheet) {
-                  test.sheet = sheet.name;
-                }
-              }
-              if (!test.sheet) {
-                test.sheet = active_sheet.name;
-              }
-            }
-
-            if (unit.type === 'range') {
-              unit.end.absolute_column = unit.end.absolute_row = true;
-            }
-
-            return false;
-          }
-          else if (unit.type === 'call' && options.export_functions) {
-            // ...
-          }
-          return true;
-        });
-        const rendered = this.parser.Render(expr, { missing: '' });
-        named_expressions.push({
-          name, expression: rendered
-        });
-      }
-    }
+    const named = this.model.SerializeNames(active_sheet);
 
     return {
       sheet_data,
       active_sheet: active_sheet.id,
-      named_ranges: this.model.named_ranges.Count() ?
-        this.model.named_ranges.Serialize() :
-        undefined,
+      named: named.length ? named : undefined,
       macro_functions,
       tables,
-      named_expressions: named_expressions.length ? named_expressions : undefined,
     };
 
   }
@@ -4677,7 +4596,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
 
     if (!this.export_worker) {
-      this.export_worker = await this.LoadWorker('export');
+      this.export_worker = await this.LoadWorker();
     }
 
     // this originally returned a Promise<Blob> but the actual
@@ -4760,11 +4679,11 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
   protected HandleCellEvent(event: CellEvent): void {
 
-    const type = event.data?.type;
-    if (type === 'hyperlink') {
+    // const type = event.data?.type;
+    if (event.data?.type === 'hyperlink') {
 
       const hyperlink_error = 'hyperlink invalid target';
-      const data = event.data.data || '';
+      const data = event.data.reference || '';
 
       if (typeof data === 'string') {
 
@@ -4884,24 +4803,6 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
   }
 
-  /* *
-   * replacement for fetch
-   * FIXME: move to utils or other lib
-   * FIXME: we don't need to do this for ES6, presumably...
-   * can this move into the legacy/modern code? or is there a polyfill? (...)
-   * /
-  protected async Fetch(uri: string): Promise<string> {
-    return new Promise<string>((resolve, reject) => {
-      const xhr = new XMLHttpRequest();
-      xhr.onload = () => resolve(xhr.response);
-      xhr.onerror = () => reject('load error');
-      xhr.ontimeout = () => reject('timeout');
-      xhr.open('GET', uri);
-      xhr.send();
-    });
-  }
-  */
-
   /**
    * I'm restructuring the select file routine to simplify, in service
    * of figuring out what's going wrong in OSX/Chrome. the current routine
@@ -5013,7 +4914,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
             // probably because there are some async calls; hence the
             // src attribute is set before it's inflated. 
 
-            const annotation = this.grid.CreateAnnotation({
+            // const annotation = 
+            this.grid.CreateAnnotation({
               type: 'image',
               formula: '',
               data: {
@@ -5147,10 +5049,12 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
   protected UpdateAnnotations(): void {
 
     for (const annotation of this.grid.active_sheet.annotations) {
-      if (annotation.temp.vertex) {
-        const vertex = annotation.temp.vertex as StateLeafVertex;
-        if (vertex.state_id !== annotation.temp.state) {
-          annotation.temp.state = vertex.state_id;
+
+      const vertex_data = annotation.temp as { vertex?: StateLeafVertex, state?: number };
+
+      if (vertex_data.vertex) {
+        if (vertex_data.vertex.state_id !== vertex_data.state) {
+          vertex_data.state = vertex_data.vertex.state_id;
 
           // set all views dirty in this case
           for (const view of annotation.view) {
@@ -5190,7 +5094,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
   protected UpdateConnectedElements() {
     for (const element of this.model.connected_elements.values()) {
-      const internal = (element.internal) as { vertex: StateLeafVertex, state: any };
+      const internal = (element.internal) as { vertex: StateLeafVertex, state: unknown };
       if (internal?.vertex && internal.vertex.state_id !== internal.state ) {
         internal.state = internal.vertex.state_id;
         const fn = element.update; 
@@ -5666,7 +5570,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
   }
 
-  protected UpdateDocumentStyles(update = true): void {
+  protected UpdateDocumentStyles(): void {
 
     const number_format_map: Record<string, number> = {};
     const color_map: Record<string, number> = {};
@@ -5941,6 +5845,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     this.grid.UpdateSheets(sheets, undefined, override_sheet || data.active_sheet);
 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     for (const [name, table] of this.model.tables.entries()) {
       if (table.area.start.sheet_id) {
         const sheet = model.sheets.Find(table.area.start.sheet_id);
@@ -5957,52 +5862,56 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     model.document_name = data.name;
     model.user_data = data.user_data;
-    model.named_ranges.Reset();
 
-    // old models have it in sheet, new models have at top level -- we can
-    // support old models, but write in the new syntax
+    // resets for both named ranges and named expressions, until we consolidate
+    model.named.Reset(); 
 
-    let named_range_data = data.named_ranges;
-    if (!named_range_data && sheets[0] && sheets[0].named_ranges) {
-      named_range_data = sheets[0].named_ranges;
+    if (data.named) {
+      this.model.UnserializeNames(data.named, this.grid.active_sheet);
     }
+    else {
 
-    if (named_range_data) {
-      model.named_ranges.Deserialize(named_range_data);
-    }
+      // console.info("using old-style name import")
 
-    // when importing named expressions, we have to make sure there's a
-    // sheet ID attached to each range/address. hopefully we have serialized
-    // it with a sheet name so we can look up.
+      //------------------------------------------------------------------------
+      //
+      // old style handling of named ranges and expressions. we'll leave
+      // this here for the time being. [update: rewriting slightly to share 
+      // some code]
+      //
+      //------------------------------------------------------------------------
+
+      // old models have it in sheet, new models have at top level -- we can
+      // support old models, but write in the new syntax
+
+      let named_range_data = data.named_ranges;
+      if (!named_range_data && sheets[0] && sheets[0].named_ranges) {
+        named_range_data = sheets[0].named_ranges;
+      }
+
+      if (named_range_data) {
+        for (const [name, value] of Object.entries(named_range_data)) {
+          model.named.SetNamedRange(name, new Area(value.start, value.end));
+        }
+      }
+
+      // when importing named expressions, we have to make sure there's a
+      // sheet ID attached to each range/address. hopefully we have serialized
+      // it with a sheet name so we can look up.
+
+      // model.named_expressions.clear(); // already reset (composite w/ named ranges)
+
+      if (data.named_expressions) {
+        for (const pair of data.named_expressions) {
+
+          this.model.UnserializeNames([{
+            name: pair.name,
+            expression: pair.expression,
+          }], this.grid.active_sheet);
 
-    model.named_expressions.clear(); // = {};
-    if (data.named_expressions) {
-      for (const pair of data.named_expressions) {
-        const parse_result = this.parser.Parse('' || pair.expression);
-        if (parse_result.valid && parse_result.expression) {
-          this.parser.Walk(parse_result.expression, unit => {
-            if (unit.type === 'address' || unit.type === 'range') {
-              if (unit.type === 'range') {
-                unit = unit.start;
-              }
-              if (!unit.sheet_id) {
-                if (unit.sheet) {
-                  const sheet = this.model.sheets.Find(unit.sheet);
-                  if (sheet) {
-                    unit.sheet_id = sheet.id;
-                  }
-                }
-              }
-              if (!unit.sheet_id) {
-                unit.sheet_id = this.grid.active_sheet.id;
-              }
-              return false; // don't continue in ranges
-            }
-            return true;
-          });
-          model.named_expressions.set(pair.name.toUpperCase(), parse_result.expression);
         }
       }
+
     }
 
     model.macro_functions.clear();
@@ -6028,7 +5937,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * load worker. optionally uses an ambient path as prefix; intended for
    * loading in different directories (or different hosts?)
    */
-  protected async LoadWorker(name: string): Promise<Worker> {
+  protected async LoadWorker(): Promise<Worker> {
 
     // this is inlined to ensure the code will be tree-shaken properly
     // (we're trying to force it to remove the imported worker script)
@@ -6042,7 +5951,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       if (export_worker_script) {
         try {
           const worker = new Worker(
-              URL.createObjectURL(new Blob([(export_worker_script as any).default], { type: 'application/javascript' })));
+              URL.createObjectURL(new Blob([(export_worker_script as {default: string}).default], { type: 'application/javascript' })));
           return worker;
         }
         catch (err) {
@@ -6058,60 +5967,6 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     throw new Error('creating worker failed');
 
-    /*
-
-    if (!EmbeddedSpreadsheet.treb_base_path) {
-      console.warn('worker path is not set. it you are loading TREB in an ESM module, please either '
-        + 'include the script in a document <script/> tag, or call the method TREB.SetScriptPath() to '
-        + 'set the load path for workers (this should be the path to TREB script files).');
-      throw new Error('worker path not set');
-    }
-
-    if (!/\.js$/.test(name)) name += ('-' + process.env.BUILD_VERSION + '.js');
-
-    let worker: Worker;
-    let treb_path = EmbeddedSpreadsheet.treb_base_path;
-
-    if (treb_path) {
-      if (!/\/$/.test(treb_path)) treb_path += '/';
-      name = treb_path + name;
-    }
-
-    // for remote workers, fetch and construct as blob. for local
-    // workers we can just create.
-
-    // actually we're now getting a fully-qualified URL, so it will
-    // always have a network prefix (or a file prefix)
-
-    // FIXME: testing... in particular URL.createObjectURL and new Blob
-
-    if (/^(http:|https:|\/\/)/.test(name)) {
-      const response = await fetch(name);
-
-      if (!response.ok) {
-        throw new Error('Error loading worker script');
-      }
-      
-      const script = await response.text();
-
-      // const script = await this.Fetch(name);
-      worker = new Worker(URL.createObjectURL(new Blob([script], { type: 'application/javascript' })));
-    }
-    else if (/^file:/.test(name)) {
-      throw new Error('invalid URI');
-    }
-    else {
-
-      // this was intended for relative URIs but now it is applied
-      // to file:// URIs, which won't work anyway (in chrome, at least)
-
-      worker = new Worker(name);
-
-    }
-
-    return worker;
-    */
-
   }
 
   /**

package/treb-embed/src/selection-state.ts

@@ -1,5 +1,5 @@
 
-import type { GridSelection } from 'treb-grid';
+import type { GridSelection } from 'treb-data-model';
 import type { CellStyle } from 'treb-base-types';
 
 /**

package/treb-embed/src/toolbar-message.ts

@@ -1,5 +1,5 @@
 
-import type { Style, Color } from 'treb-base-types';
+import type { Color } from 'treb-base-types';
 
 /* 
  * this is an attempt to lock down toolbar commands, and better