@trebco/treb 25.2.0 → 25.5.0

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

@@ -21,27 +21,37 @@
 
 // --- imports -----------------------------------------------------------------
 
-import {
-  Grid, GridEvent, SerializeOptions, Annotation,
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="./content-types.d.ts" />
+
+import type {
+  GridEvent, SerializeOptions, Annotation,
   SerializedModel, FreezePane, SerializedSheet,
-  BorderConstants, SheetChangeEvent, GridOptions, 
-  Sheet, GridSelection, CellEvent, FunctionDescriptor, 
-  DataModel, AnnotationViewData, ErrorCode, UA
+  SheetChangeEvent, GridOptions, 
+  GridSelection, CellEvent, FunctionDescriptor, 
+  AnnotationViewData, 
+} from 'treb-grid';
+
+import {
+  DataModel, Grid, BorderConstants, Sheet, ErrorCode, UA
 } from 'treb-grid';
 
 import { 
   Parser, DecimalMarkType, 
   ArgumentSeparatorType, QuotedSheetNameRegex } from 'treb-parser';
 
-import { Calculator, EvaluateOptions, LeafVertex } from 'treb-calculator';
+import { Calculator, type EvaluateOptions, type LeafVertex } from 'treb-calculator';
+
+import type {
+  ICellAddress, 
+  IArea, CellValue, Point,
+  Complex, ExtendedUnion, IRectangle,
+  AddressReference, RangeReference, TableSortOptions, Table, TableTheme,
+} from 'treb-base-types';
 
 import {
-  ThemeColor2,
-  IsCellAddress, Localization, Style, ICellAddress, 
-  Area, IArea, CellValue, Point,
-  IsFlatData, IsFlatDataArray, Rectangle, IsComplex, 
-  ComplexToString, Complex, ExtendedUnion, IRectangle,
-  AddressReference, RangeReference, IsArea, TableSortOptions, Table, ThemeColorTable, TableTheme,
+  IsArea, ThemeColorTable, ComplexToString, Rectangle, IsComplex, 
+  Localization, Style, ThemeColor2, IsCellAddress, Area, IsFlatData, IsFlatDataArray, 
 } from 'treb-base-types';
 
 import { EventSource, Yield, ValidateURI } from 'treb-utils';
@@ -51,37 +61,32 @@ import { NumberFormatCache, ValueParser, NumberFormat } from 'treb-format';
 
 import { Dialog, DialogType } from './progress-dialog';
 import { Spinner } from './spinner';
-import { EmbeddedSpreadsheetOptions, DefaultOptions, ExportOptions } from './options';
-import { TREBDocument, SaveFileType, LoadSource, EmbeddedSheetEvent, InsertTableOptions } from './types';
+import { type EmbeddedSpreadsheetOptions, DefaultOptions, type ExportOptions } from './options';
+import { type TREBDocument, SaveFileType, LoadSource, type EmbeddedSheetEvent, type InsertTableOptions } from './types';
 
 import type { LanguageModel, TranslatedFunctionDescriptor } from './language-model';
 import type { SelectionState } from './selection-state';
 import type { BorderToolbarMessage, ToolbarMessage } from './toolbar-message';
 
 import { Chart, ChartFunctions } from 'treb-charts';
-
-// --- 3d party ----------------------------------------------------------------
-
-// import * as FileSaver from 'file-saver';
-
-// --- style -------------------------------------------------------------------
-
-// we moved grid style (sass) imports from grid -> here so we can better
-// support headless/server-side grid. if we build with esbuild they'd
-// disappear so we could move these back...
-
-// import 'treb-grid/style/grid-layout.scss';
-// import 'treb-grid/style/grid.scss';
-// import '../style/embed.scss';
-
 import type { SetRangeOptions } from 'treb-grid';
 
-// ---
+// --- worker ------------------------------------------------------------------
 
-import export_worker_script from 'worker:../../treb-export/src/export-worker/index-modern.ts';
-const crocus = 100;
+/**
+ * note the clumsy URI-like syntax. if typescript can see that the thing
+ * is a ts file, even if we have a prefix and a type defined for that 
+ * prefix, it will still try to read it. 
+ * 
+ * this is not a great solution. I was thinking about letting ts read it.
+ * That won't impact esbuild, and it has the helpful side effect of type 
+ * checking the worker when we run tsc. but it doesn't like the .ts extension.
+ * also it actually tries to import the file, which means you have to export
+ * some junk value.
+ */
+import export_worker_script from 'worker://../../treb-export/src/export-worker/index-modern.ts';
 
-// ---
+// --- types -------------------------------------------------------------------
 
 /**
  * options for saving files. we add the option for JSON formatting.
@@ -501,11 +506,15 @@ export class EmbeddedSpreadsheet {
       }
     }
 
+    if (this.options.document && this.options.inline_document) {
+      console.warn('both document and inline-document are provided');
+    }
+
     const network_document = this.options.document;
 
     // optionally data from storage, with fallback
 
-    let data: string | undefined;
+    let data: string | undefined | TREBDocument;
     let source: LoadSource | undefined;
 
     // don't load if we're a split view. we can also skip the 
@@ -518,6 +527,14 @@ export class EmbeddedSpreadsheet {
       }
     }
 
+    // if we have an inline document, and there was nothing in local storage,
+    // load the inline document now. not for splits.
+
+    if (!data && !this.options.toll_initial_load && !options.model && options.inline_document) {
+      data = options.inline_document;
+      source = LoadSource.INLINE_DOCUMENT;
+    }
+
     // this one should not be done for a split view, but we should still
     // do it if the toll flag is set, and storage key is set. 
 
@@ -681,7 +698,7 @@ export class EmbeddedSpreadsheet {
       // to the current view. this can lead to strange behavior depending
       // on which window you're in. needs some thought.
 
-      this.key_listener = this.HandleKeyDown.bind(this);
+      this.key_listener = (event) => this.HandleKeyDown(event);
       container.addEventListener('keydown', this.key_listener);
 
       const toll_initial_render = !!(data || this.options.document);
@@ -853,8 +870,12 @@ export class EmbeddedSpreadsheet {
     // FIXME: this should yield so we can subscribe to events before the initial load
 
     if (data) {
-      this.LoadDocument(JSON.parse(data), 
-        { recalculate: !!this.options.recalculate, source});
+      if (typeof data === 'string') {
+        data = JSON.parse(data);
+      }
+      if (data) {
+        this.LoadDocument(data as TREBDocument, { recalculate: !!this.options.recalculate, source});
+      }
     }
     else if (!network_document) {
 
@@ -867,16 +888,12 @@ export class EmbeddedSpreadsheet {
 
     this.FlushUndo();
 
-    // FIXME: this is deprecated [what?]
-    // [this is now a file property, not an option]
-
-    // if (options.freeze_rows || options.freeze_columns) {
-    //  this.grid.Freeze(options.freeze_rows || 0, options.freeze_columns || 0);
-    // }
+    // why is this outside of the container test? there should be
+    // no reason to do this when headless
 
-    // if (typeof options.show_headers !== 'undefined') {
     this.grid.ShowHeaders(this.options.headers);
-    // }
+
+    // again, this should be gated on container
 
     // optionally scroll grid on create (async -- why?)
 
@@ -1054,6 +1071,11 @@ export class EmbeddedSpreadsheet {
           message: `You can't change part of an array`,
         }
 
+      case ErrorCode.invalid_area_for_paste:
+        return {
+          message: 'Invalid area for paste',
+        }
+
       case ErrorCode.invalid_area_for_table:
         return {
           message: `Invalid area for table`,
@@ -1906,12 +1928,15 @@ export class EmbeddedSpreadsheet {
     
     const { x, y } = this.grid.GetScrollOffset();
     const scale = this.grid.scale || 1;
+    const auto_size = { width: 301, height: 301 };
+
+    // we're not sizing this very well at scale, because scale is stepped. FIXME
 
     this.grid.CreateAnnotation({
       type,
       formula,
       // class_name,
-    }, undefined, undefined, target || { top: y / scale + 30, left: x / scale + 30, width: 300, height: 300 });
+    }, undefined, undefined, target || { top: y / scale + 30, left: x / scale + 30, ...auto_size });
 
   }
 
@@ -2298,6 +2323,15 @@ export class EmbeddedSpreadsheet {
    */
   public Revert(): void {
 
+    if (this.options.inline_document) {
+      this.LoadDocument(this.options.inline_document);
+      if (this.options.storage_key) {
+        this.SaveLocalStorage('reverted_backup');
+        localStorage.removeItem(this.options.storage_key);
+      }
+      return;
+    }
+
     const canonical = this.options.document;
 
     if (canonical) {
@@ -3484,7 +3518,7 @@ export class EmbeddedSpreadsheet {
 
     // still for now we can take advantage of that and skip the check.
 
-    this.grid.ApplyBorders(range ? this.calculator.ResolveArea(range, this.grid.active_sheet) : undefined, borders, undefined, width);
+    this.grid.ApplyBorders2(range ? this.calculator.ResolveArea(range, this.grid.active_sheet) : undefined, borders, {}, width);
 
   }
 

package/treb-embed/src/options.ts

@@ -20,6 +20,7 @@
  */
 
 import type { ICellAddress } from 'treb-base-types';
+import type { TREBDocument } from './types';
 
 /**
  * options for exporting CSV/TSV
@@ -97,6 +98,16 @@ export interface EmbeddedSpreadsheetOptions {
    */
   document?: string;
 
+  /**
+   * @internal - testing
+   * 
+   * load document directly from data. obeys the same rules as `document` 
+   * regarding local storage and revert. if you provide both document and
+   * inline_document we will show a warning, but inline_document will take
+   * precedence.
+   */
+  inline_document?: TREBDocument;
+
   /** 
    * fetch network document (URI) 
    * @deprecated - use `document`

package/treb-embed/src/progress-dialog.ts

@@ -19,9 +19,6 @@
  * 
  */
 
-import {tmpl, NodeModel} from 'treb-utils'; 
-// import '../style/icon.scss';
-
 export enum DialogType {
   default = '', 
   info = 'info',

package/treb-embed/src/types.ts

@@ -20,7 +20,8 @@
  */
 
 import type { IArea, Table, TableTheme } from 'treb-base-types';
-import type { MacroFunction, SerializedNamedExpression, SerializedSheet } from 'treb-grid';
+import type { SerializedNamedExpression, SerializedSheet } from 'treb-grid';
+import type { SerializedMacroFunction } from 'treb-grid/src/types/data_model';
 
 export enum SaveFileType {
   json = 'json',
@@ -38,6 +39,12 @@ export enum SaveFileType {
 // and so on
 //
 
+/**
+ * we're not exporting this type in the public API because there are so many 
+ * nested types that aren't used anywhere else (in public functions). 
+ * 
+ * I would like to do it, though, that `any` looks bad in the  public API.
+ */
 export interface TREBDocument {
   app: string;
   version: string;
@@ -48,8 +55,11 @@ export interface TREBDocument {
   decimal_mark?: '.' | ',';
   active_sheet?: number;
   rendered_values?: boolean;
-  named_ranges?: {[index: string]: IArea};
-  macro_functions?: MacroFunction[];
+  
+  // named_ranges?: {[index: string]: IArea};
+  named_ranges?: Record<string, IArea>;
+
+  macro_functions?: SerializedMacroFunction[];
   named_expressions?: SerializedNamedExpression[];
   tables?: Table[];
   shared_resources?: Record<string, string>;
@@ -64,6 +74,7 @@ export enum LoadSource {
   LOCAL_FILE = 'local-file',
   NETWORK_FILE = 'network-file',
   LOCAL_STORAGE = 'local-storage',
+  INLINE_DOCUMENT = 'inline-document',
   UNDO = 'undo',
 }
 

package/treb-embed/style/layout.scss

@@ -2,7 +2,7 @@
 @import './grid.scss';
 @import './theme-defaults.scss';
 @import './dark-theme.scss';
-@import 'treb-charts/style/charts.scss';
+@import '../../treb-charts/style/charts.scss';
 @import './dialog.scss';
 @import './spinner.scss';
 @import './treb-icons.scss';
@@ -364,34 +364,37 @@
 
   }
 
-}
 
-// these are (atm) outside of the container because we want them
-// to be able to float over any outside content as well... what's the
-// rule with that? something about stacking contexts? of course we're
-// always goint to be fighting z-indexes.
-//
-// ...possible to use a dialog element? TODO: investigate...
-//
-
-.treb-resize-rect {
-  all: initial;
-  z-index: 9998; // ugh
-  position: absolute;
-  top: 0px;
-  left: 0px;
-  border: 1px dotted var(--treb-resize-frame-color, blue);
-  width: 100%;
-  height: 100%;
-  display: block;
-}
+  // these are (atm) outside of the container because we want them
+  // to be able to float over any outside content as well... what's the
+  // rule with that? something about stacking contexts? of course we're
+  // always goint to be fighting z-indexes.
+  //
+  // ...possible to use a dialog element? TODO: investigate...
+  //
+
+  // OK, but then we can't scope properly. so no.
+
+  .treb-resize-rect {
+    all: initial;
+    z-index: 9998; // ugh
+    position: fixed;
+    top: 0px;
+    left: 0px;
+    border: 1px dotted var(--treb-resize-frame-color, blue);
+    width: 100%;
+    height: 100%;
+    display: block;
+  }
+
+  .treb-resize-mask {
+    all: initial;
+    z-index: 9999; // ugh
+    position: fixed;
+    top: 0px;
+    left: 0px;
+    width: 100vw;
+    height: 100vh;
+  }
 
-.treb-resize-mask {
-  all: initial;
-  z-index: 9999; // ugh
-  position: fixed;
-  top: 0px;
-  left: 0px;
-  width: 100vw;
-  height: 100vh;
 }

package/treb-embed/style/theme-defaults.scss

@@ -182,9 +182,14 @@ $text-reference-color-5: rgb(254, 47, 1);
     background: var(--treb-grid-background, #fff);
   }
 
+  /* 
+   * we stopped using this in favor of sheet backgrounds. although
+   * there's a case to be made for the static background as well.
+   *
   .grid-background {
     background-image: var(--treb-grid-background-image, none);
   }
+  */
 
   /**
    * this is used for freeze-area highlights

package/treb-export/src/drawing2/chart2.ts

@@ -21,7 +21,7 @@
 
 // import * as ElementTree from 'elementtree';
 // import { Element, ElementTree as Tree } from 'elementtree';
-import { UnitAddress, UnitRange, UnitLiteral, ExpressionUnit } from 'treb-parser';
+import type { UnitAddress, UnitRange, UnitLiteral, ExpressionUnit } from 'treb-parser';
 
 import { static_title, ref_title, chart_template } from './chart-template-components2';
 import { column_json, column_series } from './column-chart-template2';
@@ -41,7 +41,7 @@ import { scatter_series as scatter2_series } from './scatter2-chart-template';
 // import { v4 as uuidv4 } from 'uuid';
 
 import { Localization } from 'treb-base-types';
-import { RelationshipMap } from '../relationship';
+import type { RelationshipMap } from '../relationship';
 
 export interface ChartOptions {
   type: 'donut'|'column'|'bar'|'scatter'|'scatter2';

package/treb-export/src/drawing2/drawing2.ts

@@ -19,10 +19,12 @@
  * 
  */
 
-import { EmbeddedImage, ImageOptions } from './embedded-image';
-import { Chart, ChartOptions} from './chart2';
-import { RelationshipMap, AddRel } from '../relationship';
-import { Corner } from 'treb-base-types/src';
+import type { ImageOptions } from './embedded-image';
+import { EmbeddedImage } from './embedded-image';
+import type { ChartOptions} from './chart2';
+import { Chart} from './chart2';
+import type { RelationshipMap} from '../relationship';
+import { AddRel } from '../relationship';
 
 const pixel_offset = 9525;
 

package/treb-export/src/export-worker/export-worker.ts

@@ -1,27 +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 { Importer } from '../import';
-// import { Exporter } from '../export';
-import type { ImportedSheetData, IArea } from 'treb-base-types/src';
+/*
+ * 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 { ImportedSheetData } from 'treb-base-types/src';
 
 import { Exporter } from '../export2';
 import { Importer } from '../import2';

package/treb-export/src/export-worker/index-modern.ts

@@ -19,4 +19,5 @@
  * 
  */
 
-import './export-worker';
+import './export-worker';
+

package/treb-export/src/export2.ts

@@ -34,25 +34,32 @@ const XMLDeclaration = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\
 import { template } from './template-2';
 import type { SerializedSheet } from 'treb-grid';
 
-import { IArea, Area, ICellAddress, Cells, ValueType, CellValue, Style, DataValidation, ValidationType,
-         AnnotationLayout, Corner as LayoutCorner, ICellAddress2, Table, Cell } from 'treb-base-types';
+import type { IArea, ICellAddress, CellValue, DataValidation,
+         AnnotationLayout, Corner as LayoutCorner, Cell } from 'treb-base-types';
+import { Area, Cells, ValueType, Style, ValidationType } from 'treb-base-types';
 
 // import * as xmlparser from 'fast-xml-parser';
-import { XMLParser, XmlBuilderOptions, XMLBuilder } from 'fast-xml-parser';
+import type { XmlBuilderOptions} from 'fast-xml-parser';
+import { XMLParser, XMLBuilder } from 'fast-xml-parser';
 
 import { SharedStrings } from './shared-strings2';
-import { StyleCache, XlColor, BorderEdge } from './workbook-style2';
+import type { XlColor, BorderEdge } from './workbook-style2';
+import { StyleCache } from './workbook-style2';
 import { Theme } from './workbook-theme2';
 
-import { RelationshipMap, AddRel } from './relationship';
+import type { RelationshipMap} from './relationship';
+import { AddRel } from './relationship';
 import { XMLOptions2 } from './xml-utils';
 
-import { Parser, UnitAddress, UnitRange, ExpressionUnit, IllegalSheetNameRegex, QuotedSheetNameRegex } from 'treb-parser';
+import type { UnitAddress, UnitRange, ExpressionUnit} from 'treb-parser';
+import { Parser, QuotedSheetNameRegex } from 'treb-parser';
 
 // FIXME: move
-import { Chart, ChartOptions } from './drawing2/chart2';
+import type { ChartOptions } from './drawing2/chart2';
+import { Chart } from './drawing2/chart2';
 import type { ImageOptions } from './drawing2/embedded-image';
-import { Drawing, TwoCellAnchor } from './drawing2/drawing2';
+import type { TwoCellAnchor } from './drawing2/drawing2';
+import { Drawing } from './drawing2/drawing2';
 import type { TableDescription, TableFooterType } from './workbook2';
 
 export class Exporter {

package/treb-export/src/import2.ts

@@ -22,11 +22,16 @@
 //import * as JSZip from 'jszip';
 import JSZip from 'jszip';
 
-import { AnchoredChartDescription, ChartType, TableDescription, Workbook } from './workbook2';
-import { Parser, ParseResult } from 'treb-parser';
-import { is_range, RangeType, ShiftRange, InRange, AddressType, is_address, HyperlinkType } from './address-type';
-import { ImportedSheetData, AnchoredAnnotation, CellParseResult, ValueType, AnnotationLayout, Corner as LayoutCorner, ICellAddress, DataValidation, ValidationType, IArea } from 'treb-base-types/src';
-import { Sheet, VisibleState } from './workbook-sheet2';
+import type { AnchoredChartDescription} from './workbook2';
+import { ChartType, Workbook } from './workbook2';
+import type { ParseResult } from 'treb-parser';
+import { Parser } from 'treb-parser';
+import type { RangeType, AddressType, HyperlinkType } from './address-type';
+import { is_range, ShiftRange, InRange, is_address } from './address-type';
+import type { ImportedSheetData, AnchoredAnnotation, CellParseResult, AnnotationLayout, Corner as LayoutCorner, ICellAddress, DataValidation, IArea } from 'treb-base-types/src';
+import { ValueType, ValidationType } from 'treb-base-types/src';
+import type { Sheet} from './workbook-sheet2';
+import { VisibleState } from './workbook-sheet2';
 import type { CellAnchor } from './drawing2/drawing2';
 import { XMLUtils } from './xml-utils';
 

package/treb-export/src/workbook-sheet2.ts

@@ -41,7 +41,8 @@
  */
 
 
-import { AddressType, RangeType, is_range } from './address-type';
+import type { AddressType, RangeType} from './address-type';
+import { is_range } from './address-type';
 import type { SharedStrings } from './shared-strings2';
 import type { Drawing } from './drawing2/drawing2';
 import type { RelationshipMap } from './relationship';

package/treb-format/src/format.ts

@@ -1,28 +1,29 @@
-/*
- * 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
- * 
- */
-
+/*
+ * 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 { FormatParser } from './format_parser';
 import { NumberFormatSection } from './number_format_section';
+import type { TextPart, Complex, DimensionedQuantity, CellValue} from 'treb-base-types';
 import { 
-    Localization, TextPartFlag, TextPart, Complex, DimensionedQuantity, CellValue, IsDimensionedQuantity,
+    Localization, TextPartFlag, IsDimensionedQuantity,
   } from 'treb-base-types';
 
 //