@trebco/treb 29.6.2 → 29.8.1

package/treb-data-model/src/sheet.ts

@@ -2225,8 +2225,14 @@ export class Sheet {
       return this.CompositeStyleForCell(area, true, false, apply_theme);
     }
 
+    // the contract says this should return an array, not a single value.
+    // 
+    // I can fix it, but will anyone break? (...) check the indent buttons
+    // (update: looks OK)
+    // 
+
     if (area.start.row === area.end.row && area.start.column === area.end.column) {
-      return this.CompositeStyleForCell(area.start, true, false, apply_theme);
+      return [[this.CompositeStyleForCell(area.start, true, false, apply_theme)]];
     }
 
     const result: CellStyle[][] = [];
@@ -2234,8 +2240,6 @@ export class Sheet {
     for (let r = area.start.row; r <= area.end.row; r++) {
       const row: CellStyle[] = [];
       for (let c = area.start.column; c <= area.end.column; c++) {
-        // const cell = this.CellData({row: r, column: c});
-        // row.push(cell.style || {});
         row.push(this.CompositeStyleForCell({row: r, column: c}, true, false, apply_theme));
       }
       result.push(row);

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

@@ -93,7 +93,7 @@ import type { SelectionState } from './selection-state';
 import type { BorderToolbarMessage, ToolbarMessage } from './toolbar-message';
 
 import { Chart, ChartFunctions } from 'treb-charts';
-import type { SetRangeOptions } from 'treb-grid';
+import type { SetRangeOptions, ClipboardData, PasteOptions } from 'treb-grid';
 
 import type { StateLeafVertex } from 'treb-calculator';
 
@@ -114,60 +114,6 @@ import * as export_worker_script from 'worker:../../treb-export/src/export-worke
 
 // --- types -------------------------------------------------------------------
 
-/**
- * this is a structure for copy/paste data. clipboard data may include 
- * relative formauls and resolved styles, so it's suitable for pasting into 
- * other areas of the spreadsheet.
- * 
- * @privateRemarks
- * work in progress. atm we're not using the system clipboard, although it 
- * might be useful to merge this with grid copy/paste routines in the future.
- * 
- * if it hits the clipboard this should use mime type `application/x-treb-data`
- * 
- */
-export interface ClipboardDataElement {
-
-  /** calculated cell value */
-  calculated: CellValue,
-
-  /** the actual cell value or formula */
-  value: CellValue,
-
-  /** cell style. this may include row/column styles from the copy source */
-  style?: CellStyle,
-
-}
-
-/** clipboard data is a 2d array */
-export type ClipboardData = ClipboardDataElement[][];
-
-/** 
- * optional paste options. we can paste formulas or values, and we 
- * can use the source style, target style, or just use the source
- * number formats.
- */
-export interface PasteOptions {
-
-  /**
-   * when clipboard data includes formulas, optionally paste calculated
-   * values instead of the original formulas. defaults to false.
-   */
-  values?: boolean;
-
-  /** 
-   * when pasting data from the clipboard, we can copy formatting/style 
-   * from the original data, or we can retain the target range formatting
-   * and just paste data. a third option allows pasting source number 
-   * formats but dropping other style information.
-   * 
-   * defaults to "source", meaning paste source styles.
-   */
-
-  formatting?: 'source'|'target'|'number-formats'
-
-}
-
 /**
  * options for saving files. we add the option for JSON formatting.
  */
@@ -1000,10 +946,20 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
               const cached_selection = this.last_selection;
 
+              /*
               ((this.calculation === CalculationOptions.automatic) ?
                 this.Recalculate(event) : Promise.resolve()).then(() => {
                   this.DocumentChange(cached_selection);
                 });
+              */
+
+              // recalc is no longer async
+
+              if (this.calculation === CalculationOptions.automatic) {
+                this.Recalculate(event);
+              }
+
+              this.DocumentChange(cached_selection);
 
               /*
               if (this.calculation === CalculationOptions.automatic) {
@@ -1084,10 +1040,19 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
               if (event.rebuild_required) {
                 this.calculator.Reset();
 
+                /*
                 ((this.calculation === CalculationOptions.automatic) ?
                   this.Recalculate(event) : Promise.resolve()).then(() => {
                     this.DocumentChange(cached_selection);
                   });
+                */
+
+                // recalculate is no longer async
+
+                if (this.calculation === CalculationOptions.automatic) {
+                  this.Recalculate(event);
+                }
+                this.DocumentChange(cached_selection);
 
               }
               else {
@@ -1444,18 +1409,10 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
   /** @internal */
   public ConditionalFormatDuplicateValues(range: RangeReference|undefined, options: ConditionalFormatDuplicateValuesOptions): ConditionalFormat {
-       
-    if (range === undefined) {
-      const ref = this.GetSelectionReference();
-      if (ref.empty) {
-        throw new Error('invalid range (no selection)');
-      }
-      range = ref.area;
-    }
-    
+      
     return this.AddConditionalFormat({
         type: 'duplicate-values',
-        area: this.model.ResolveArea(range, this.grid.active_sheet),
+        area: this.RangeOrSelection(range, 'invalid range (no selection)'),
         ...options,
       });
 
@@ -1466,15 +1423,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    */
   public ConditionalFormatGradient(range: RangeReference|undefined, options: ConditionalFormatGradientOptions|StandardGradient): ConditionalFormat {
 
-    if (range === undefined) {
-      const ref = this.GetSelectionReference();
-      if (ref.empty) {
-        throw new Error('invalid range (no selection)');
-      }
-      range = ref.area;
-    }
-    
-    const area = this.model.ResolveArea(range, this.grid.active_sheet);
+    const area = this.RangeOrSelection(range, 'invalid range (no selection)');
 
     const format: ConditionalFormatGradient = (typeof options === 'object') ?
       {
@@ -1492,19 +1441,9 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
   /** @internal */
   public ConditionalFormatCellMatch(range: RangeReference|undefined, options: ConditionalFormatCellMatchOptions): ConditionalFormat {
 
-    if (range === undefined) {
-      const ref = this.GetSelectionReference();
-      if (ref.empty) {
-        throw new Error('invalid range (no selection)');
-      }
-      range = ref.area;
-    }
-    
-    const area = this.model.ResolveArea(range, this.grid.active_sheet);
-
     const format: ConditionalFormatCellMatch = {
       type: 'cell-match',
-      area,
+      area: this.RangeOrSelection(range, 'invalid range (no selection)'),
       ...options,
     };
 
@@ -1519,19 +1458,9 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    */
   public ConditionalFormatExpression(range: RangeReference|undefined, options: CondifionalFormatExpressionOptions): ConditionalFormat {
 
-    if (range === undefined) {
-      const ref = this.GetSelectionReference();
-      if (ref.empty) {
-        throw new Error('invalid range (no selection)');
-      }
-      range = ref.area;
-    }
-    
-    const area = this.model.ResolveArea(range, this.grid.active_sheet);
-
     const format: ConditionalFormatExpression = {
       type: 'expression',
-      area,
+      area: this.RangeOrSelection(range, 'invalid range (no selection)'),
       ...options,
     };
 
@@ -1572,18 +1501,10 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * @internal
    */
   public RemoveConditionalFormats(range?: RangeReference) {
-
-    if (range === undefined) {
-      const ref = this.GetSelectionReference();
-      if (ref.empty) {
-        throw new Error('invalid range (no selection)');
-      }
-      range = ref.area;
+    const area = this.RangeOrSelection(range);
+    if (area) {
+      this.grid.RemoveConditionalFormat({ area });
     }
-
-    const area = this.model.ResolveArea(range, this.grid.active_sheet);
-    this.grid.RemoveConditionalFormat({ area });
-
   }
 
   //////////////////////////////////////////////////////////////////////////////
@@ -2086,7 +2007,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * nested calls, because nothing will happen until the last one is complete.
    * 
    */
-  public async Batch(func: () => void, paint = false): Promise<void> {
+  public Batch(func: () => void, paint = false): void {
 
     // API v1 OK
 
@@ -2118,7 +2039,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     }
 
     if (recalc || reset) {
-      await this.Recalculate();
+      this.Recalculate();
       this.DocumentChange(cached_selection);
     }
 
@@ -3816,10 +3737,12 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * 
    * the event parameter should not be used if this is called
    * as an API function, remove it from typings
-   * 
+   *
+   * why is this async? it doesn't do anything async.
+   *  
    * @public
    */
-  public async Recalculate(event?: GridEvent): Promise<void> {
+  public Recalculate(event?: GridEvent) {
 
     // API v1 OK
 
@@ -4366,111 +4289,80 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
   }
 
+  /** 
+   * override for paste method omits the data parameter. 
+   */
+  public Paste(target?: RangeReference, options?: PasteOptions): void;
+
   /**
+   * standard paste method accepts data argument
+   * 
+   * @param target 
+   * @param data 
+   * @param options 
+   */
+  public Paste(target?: RangeReference, data?: ClipboardData, options?: PasteOptions): void;
+
+  /**
+   * paste clipboard data into a target range. this method does not use
+   * the system clipboard; pass in clipboard data returned from the Cut or
+   * Copy method.
    * 
    * @param target - the target to paste data into. this can be larger 
    * than the clipboard data, in which case values will be recycled in 
    * blocks. if the target is smaller than the source data, we will expand
-   * it.
+   * it to fit the data.
    * 
    * @param data - clipboard data to paste.
    * 
-   * @param style - optional paste style. default is to paste formulas and
-   * source formatting. paste options can be usef to paste values, values
-   * and number formats, or retain the target formatting.
-   * 
    * @privateRemarks LLM API
+   * 
+   * @privateRemarks this was async when we were thinking of using the 
+   * system clipboard, but that's pretty broken so we're not going to
+   * bother atm.
    */
-  public async Paste(target?: RangeReference, data = EmbeddedSpreadsheet.clipboard, options: PasteOptions = {}) {
+  public Paste(target?: RangeReference, ...args: unknown[]): void {
 
-    if (!data) {
-      throw new Error('no clipboad data');
-    }
+    // support for the dynamic overload (not sure that's actually a good idea)
 
-    if (!target) {
-      const selection = this.GetSelectionReference();
-      if (!selection.empty) {
-        target = selection.area;
-      }
-      else {
-        throw new Error('no range and no selection');
-      }
-    }
+    let data = EmbeddedSpreadsheet.clipboard; // default to "global" clipboard
+    let options: PasteOptions = {}; // default
 
-    const resolved = this.model.ResolveArea(target, this.grid.active_sheet);
+    switch (args.length) {
+      case 1:
 
-    // paste has some special semantics. if the target smaller than the
-    // source data, we write the full data irrespective of size (similar 
-    // to "spill"). otherwise, we recycle in blocks. 
+        // could be either
 
-    // the setrange method will recycle, but we also need to recycle styles.
-
-    // start with data length
-
-    const rows = data.length;
-    const columns = data[0]?.length || 0;
-
-    // target -> block size
-
-    resolved.Resize(
-      Math.max(1, Math.floor(resolved.rows / rows)) * rows, 
-      Math.max(1, Math.floor(resolved.columns / columns)) * columns );
-
-    const sheet = (resolved.start.sheet_id ? this.model.sheets.Find(resolved.start.sheet_id) : this.grid.active_sheet) || this.grid.active_sheet;
-      
-    const values: CellValue[][] = [];
-
-    // optionally collect calculated values, instead of raw values
-
-    if (options.values) {
-      for (const [index, row] of data.entries()) {
-        values[index] = [];
-        for (const cell of row) {
-          values[index].push(cell.calculated);
+        if (Array.isArray(args[0])) {
+          data = args[0] as ClipboardData;
         }
-      }
-    }
-    else {
-      for (const [index, row] of data.entries()) {
-        values[index] = [];
-        for (const cell of row) {
-          values[index].push(cell.value);
+        else if (typeof args[0] === 'object') {
+          options = args[0] as PasteOptions;
         }
-      }
-    }
-
-    // batch to limit events, sync up undo
-
-    return this.Batch(() => {
-
-      this.grid.SetRange(resolved, values, {
-        r1c1: true, recycle: true,
-      });
-
-      if (options.formatting === 'number-formats') {
+        break;
 
-        // number format only, and apply delta
+      case 2:
 
-        for (const address of resolved) {
-          const r = (address.row - resolved.start.row) % rows;
-          const c = (address.column - resolved.start.column) % columns;
-          const number_format = (data[r][c].style || {}).number_format;
-          sheet.UpdateCellStyle(address, { number_format }, true);
+        // check if it exists, could be undef/null
+        if (args[0] && Array.isArray(args[0])) {
+          data = args[0] as ClipboardData;
         }
-      }
-      else if (options.formatting !== 'target') {
 
-        // use source formatting (default)
-        for (const address of resolved) {
-          const r = (address.row - resolved.start.row) % rows;
-          const c = (address.column - resolved.start.column) % columns;
-          sheet.UpdateCellStyle(address, data[r][c].style || {}, false);
+        // 1 should exist if len is 2
+        if (args[1] && typeof args[1] === 'object') {
+          options = args[1] as PasteOptions;
         }
+        break;
+    }
+    
+    if (!data) {
+      throw new Error('no clipboad data');
+    }
 
-      }
-
-    }, true);
-
+    this.grid.PasteArea(
+      this.RangeOrSelection(target, 'no range and no selection'), 
+      data, 
+      options);
 
   }
 
@@ -4482,7 +4374,10 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * @privateRemarks LLM API
    */
   public Copy(source?: RangeReference): ClipboardData {
-    return this.CopyInternal(source, 'copy');
+    const area = this.RangeOrSelection(source);
+    const data: ClipboardData = area ? this.grid.CopyArea(area, 'copy') : [];
+    EmbeddedSpreadsheet.clipboard = structuredClone(data);
+    return data;
   }
 
   /**
@@ -4496,7 +4391,10 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * @privateRemarks LLM API
    */
   public Cut(source?: RangeReference): ClipboardData {
-    return this.CopyInternal(source, 'cut');
+    const area = this.RangeOrSelection(source);
+    const data: ClipboardData = area ? this.grid.CopyArea(area, 'cut') : [];
+    EmbeddedSpreadsheet.clipboard = structuredClone(data);
+    return data;
   }
  
   /** 
@@ -4509,14 +4407,11 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     // API v1 OK
 
-    if (!range) {
-      const selection = this.GetSelectionReference();
-      if (!selection.empty) {
-        range = selection.area;
-      }
-    }
+    const resolved = this.RangeOrSelection(range);
 
-    if (!range) { return undefined; }
+    if (!resolved) {
+      return undefined;
+    }
 
     // handle the old flags and the precedence rule. type takes precedence.
 
@@ -4537,7 +4432,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
       type = 'A1';
     }
 
-    return this.grid.GetRange(this.model.ResolveAddress(range, this.grid.active_sheet), type);
+    return this.grid.GetRange(resolved, type);
 
   }
 
@@ -4557,16 +4452,12 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     // API v1 OK
 
-    if (!range) {
-      const selection = this.GetSelectionReference();
-      if (!selection.empty) {
-        range = selection.area;
-      }
+    const resolved = this.RangeOrSelection(range);
+    if (!resolved) {
+      return undefined;
     }
 
-    if (!range) { return undefined; }
-
-    return this.grid.GetRangeStyle(this.model.ResolveAddress(range, this.grid.active_sheet), apply_theme);
+    return this.grid.GetRangeStyle(resolved, apply_theme);
     
   }
 
@@ -4587,15 +4478,10 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     // API v1 OK
 
-    if (!range) {
-      const selection = this.GetSelectionReference();
-      if (!selection.empty) {
-        range = selection.area;
-      }
-    }
+    const area = this.RangeOrSelection(range);
 
-    if (range) {
-      const area = this.model.ResolveArea(range, this.grid.active_sheet);
+    if (area) {
+      // const area = this.model.ResolveArea(range, this.grid.active_sheet);
 
       if (options.spill && Array.isArray(data)) {
         const rows = data.length;
@@ -4652,65 +4538,40 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
   // --- internal (protected) methods ------------------------------------------
 
   /**
-   * internal composite for cut/copy. mostly identical except we 
-   * read data as A1 for cut, so it will retain references. also
-   * cut clears the data.
-   * 
-   * FIXME: merge with grid cut/copy/paste routines. we already
-   * handle recycling and relative addressing, the only thing missing
-   * is alternate formats.
+   * overload returns undefined if no range and no selection
+   */
+  protected RangeOrSelection(source: RangeReference|undefined): Area|undefined;
+
+  /**
+   * overload throws if no range and no selection (pass the error to throw)
+   */
+  protected RangeOrSelection(source: RangeReference|undefined, error: string): Area;
+
+  /**
+   * this is a common pattern, start with a range reference; if it's 
+   * undefined, check selection; then resolve. if there's no selection 
+   * and no range passed in, returns undefined or if the error parameter
+   * is set, throws.
    */
-  protected CopyInternal(source?: RangeReference, semantics: 'cut'|'copy' = 'copy'): ClipboardData {
+  protected RangeOrSelection(source: RangeReference|undefined, error?: string): Area|undefined {
 
     if (!source) {
       const selection = this.GetSelectionReference();
       if (!selection.empty) {
-        source = selection.area;
+        return selection.area.Clone(); // Area
       }
       else {
-        throw new Error('no range and no selection');
+        if (error) {
+          throw error;
+        }
+        // throw new Error('no range and no selection');
+        return undefined;
       }
     }
 
-    // resolve range so we can use it later -> Area
-    const resolved = this.model.ResolveArea(source, this.grid.active_sheet);
-    const sheet = (resolved.start.sheet_id ? this.model.sheets.Find(resolved.start.sheet_id) : this.grid.active_sheet) || this.grid.active_sheet;
-
-    // get cell data as R1C1 for copy but A1 for cut. 
-    const r1c1 = this.grid.GetRange(resolved, semantics === 'cut' ? 'A1' : 'R1C1') as CellValue[][];
-
-    // get style data, !apply theme but do apply r/c styles
-    const styles = sheet.GetCellStyle(resolved, false);
-
-    // get calculated values
-    let calculated = sheet.cells.GetRange(resolved.start, resolved.end);
-    if (!Array.isArray(calculated)) {
-      calculated = [[calculated]];
-    }
-
-    const data: ClipboardData = [];
-
-    for (const [r, row] of r1c1.entries()) {
-      data[r] = [];
-      for (const [c, value] of row.entries()) {
-
-        data[r][c] = {
-          value,
-          calculated: calculated[r][c],
-          style: styles[r]?.[c],
-        };
-      }
-    } 
-
-    EmbeddedSpreadsheet.clipboard = structuredClone(data);
+    return this.model.ResolveArea(source, this.grid.active_sheet);
 
-    if (semantics === 'cut') {
-      this.grid.SetRange(resolved, undefined, { recycle: true }); // clear
-    }
-
-    return data;
-        
-  }
+  } 
 
   // --- moved from grid/grid base ---------------------------------------------
 

package/treb-export/src/xml-utils.ts

@@ -158,7 +158,7 @@ export class XMLUtils {
    * 
    * in either case we want both "c" elements.
    */
-  public static FindAll(root: any = {}, path: string): any[] {
+  public static FindAll(root: DOMContent = {}, path: string): any[] {
 
     const components = path.split('/');
 
@@ -190,12 +190,12 @@ export class XMLUtils {
    * basically if you see a wildcard, just treat every element as a 
    * match -- right?
    */
-  public static FindAllTail(root: any, elements: string[]): any[] {
+  public static FindAllTail(root: DOMContent|DOMContent[], elements: string[]): DOMContent[] {
 
     if (Array.isArray(root)) {
       return root.reduce((composite, element) => {
         return composite.concat(this.FindAllTail(element, elements));
-      }, []);
+      }, [] as DOMContent[]);
     }
 
     for (let i = 0; i < elements.length; i++) {
@@ -209,15 +209,27 @@ export class XMLUtils {
       // maps attributes and text differently... hopefully they won't use 
       // wildcards
 
+      if (element === '*') {
+
+        const pairs = Object.entries(root) as Array<[string, DOMContent]>;
+        root = pairs.reduce((result, [key, value]) => {
+          if (key !== 'a$' && key !== 't$')  {
+            result.push(value);
+          }
+          return result;
+        }, [] as DOMContent[]);
+
+        /*
       // two loops, really? come on
 
-      if (element === '*') {
-        root = Object.keys(root).
+        root = Object.keys(flat).
             filter(key => (key !== 'a$' && key !== 't$')).
-            map(key => root[key]);
+            map(key => flat[key]) as DOMContent[];
+        */
+
       }
       else {
-        root = root[element];
+        root = root[element] as DOMContent;
       }
 
       if (!root) {
@@ -237,7 +249,7 @@ export class XMLUtils {
         const step = elements.slice(1);
         return root.reduce((composite, element) => {
           return composite.concat(this.FindAllTail(element, step));
-        }, []);
+        }, [] as DOMContent[]);
 
       }
 

package/treb-grid/src/index.ts

@@ -22,6 +22,7 @@
 export { Grid } from './types/grid';
 export { GridBase } from './types/grid_base';
 export * from './types/grid_events';
+export * from './types/clipboard_data2';
 export type { GridOptions } from './types/grid_options';
 export { CommandKey } from './types/grid_command';
 export type { Command } from './types/grid_command';