@trebco/treb 36.1.2 → 36.1.3

package/dist/treb.d.ts

@@ -892,8 +892,9 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
      * Revert state one level from the undo stack.
      *
      * @public
+     * @returns true if undo succeeded, false if the undo stack was empty
      */
-    Undo(): void;
+    Undo(): boolean;
 
     /**
      * Show the about dialog.
@@ -1131,6 +1132,12 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
      * @param token - the token returned from `Subscribe`
      */
     Cancel(token: number): void;
+
+    /**
+     *
+     */
+    ImportXLSX(// data: string, source: LoadSource): Promise<Blob | void> {
+    data: ArrayBuffer, source: LoadSource, path?: string): Promise<Blob | void>;
 }
 
 /**
@@ -1150,6 +1157,10 @@ export interface LoadDocumentOptions {
     flush?: boolean;
     recalculate?: boolean;
     override_sheet?: string;
+    source?: LoadSource;
+
+    /** opaque data for reference */
+    path?: string;
 }
 
 /**
@@ -1611,121 +1622,6 @@ export type TableSortType = 'text' | 'numeric' | 'auto';
  */
 export declare const GetWorkerContext: () => Promise<Worker>;
 
-/** 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';
-}
-
-/**
- * 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.
- */
-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;
-
-    /** area. if this cell is part of an array, this is the array range */
-    area?: IArea;
-}
-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
  * for historical reasons and backwards compatibility. usually it's preferable
@@ -2291,6 +2187,121 @@ export interface SerializedNamedExpression {
     expression: string;
 }
 
+/** 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';
+}
+
+/**
+ * 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.
+ */
+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;
+
+    /** area. if this cell is part of an array, this is the array range */
+    area?: IArea;
+}
+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;
+
 /**
  * options for exporting CSV/TSV
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "36.1.2",
+  "version": "36.1.3",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {

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

@@ -178,8 +178,11 @@ export interface LoadDocumentOptions {
   /** @internal */
   override_selection?: GridSelection,
 
-  /** @internal */
   source?: LoadSource,
+
+  /** opaque data for reference */
+  path?: string;
+
 }
 
 /**
@@ -3957,7 +3960,11 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     }
 
-    this.Publish({ type: 'load', source: options.source }); // FIXME: should not happen on undo...
+    this.Publish({ 
+      type: 'load', 
+      source: options.source,
+      path: options.path,
+    }); // FIXME: should not happen on undo...
     this.UpdateDocumentStyles();
     this.loaded = true;
    
@@ -4297,8 +4304,9 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
    * Revert state one level from the undo stack.
    * 
    * @public
+   * @returns true if undo succeeded, false if the undo stack was empty
    */
-  public Undo(): void {
+  public Undo(): boolean {
 
     // this is half of the problem, we also need to manage views when
     // we set undo states
@@ -4311,7 +4319,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     if (this.undo_pointer <= 1) {
       console.warn('nothing to undo');
-      return;
+      return false;
     }
 
     const undo_entry = this.undo_stack[(--this.undo_pointer) - 1];
@@ -4341,6 +4349,8 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
 
     // this.file_version--; // decrement
 
+    return true;
+
   }
 
 
@@ -5267,7 +5277,7 @@ export class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
   /**
    *
    */
-   protected async ImportXLSX( // data: string, source: LoadSource): Promise<Blob | void> {
+   public async ImportXLSX( // data: string, source: LoadSource): Promise<Blob | void> {
     data: ArrayBuffer, source: LoadSource, path?: string): Promise<Blob | void> {
 
     // this is inlined to ensure the code will be tree-shaken properly