@trebco/treb 28.5.2 → 28.10.0

package/dist/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v28.5. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v28.10. Copyright 2018-2024 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /**
  * add our tag to the map
@@ -19,12 +19,20 @@ declare global {
 export declare class TREBGlobal {
 
     /**
-     * build version
+     * Package version
      */
     version: string;
 
     /**
-     * create a spreadsheet instance
+     * Create a spreadsheet. The `USER_DATA_TYPE` template parameter is the type
+     * assigned to the `user_data` field of the spreadsheet instance -- it can
+     * help simplify typing if you are storing extra data in spreadsheet
+     * files.
+     *
+     * Just ignore this parameter if you don't need it.
+     *
+     * @typeParam USER_DATA_TYPE - type for the `user_data` field in the
+     * spreadsheet instance
      */
     CreateSpreadsheet<USER_DATA_TYPE = unknown>(options: EmbeddedSpreadsheetOptions): EmbeddedSpreadsheet<USER_DATA_TYPE>;
 }
@@ -256,6 +264,13 @@ export interface EmbeddedSpreadsheetOptions {
      * top-left of the spreadsheet when a network document has local changes.
      */
     revert_indicator?: boolean;
+
+    /**
+     * handle the F9 key and recalculate the spreadsheet. for compatibility.
+     * we're leaving this option to default `false` for now, but that may
+     * change in the future. key modifiers have no effect.
+     */
+    recalculate_on_f9?: boolean;
 }
 
 /**
@@ -291,11 +306,17 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
     /** document name (metadata) */
     set document_name(name: string | undefined);
 
-    /** opaque user data (metadata) */
+    /**
+     * opaque user data (metadata). `USER_DATA_TYPE` is a template
+     * parameter you can set when creating the spreadsheet.
+     */
     get user_data(): USER_DATA_TYPE | undefined;
 
-    /** opaque user data (metadata) */
-    set user_data(data: USER_DATA_TYPE);
+    /**
+     * opaque user data (metadata). `USER_DATA_TYPE` is a template
+     * parameter you can set when creating the spreadsheet.
+     */
+    set user_data(data: USER_DATA_TYPE | undefined);
 
     /** current grid scale */
     get scale(): number;
@@ -849,6 +870,16 @@ export declare class EmbeddedSpreadsheet<USER_DATA_TYPE = unknown> {
      */
     FormatNumber(value: number, format?: string): string;
 
+    /**
+     * convert a javascript date (or timestamp) to a spreadsheet date
+     */
+    SpreadsheetDate(javascript_date: number | Date): number;
+
+    /**
+     * convert a spreadsheet date to a javascript date
+     */
+    JavascriptDate(spreadsheet_date: number): number;
+
     /**
      * Apply borders to range.
      *

package/package.json

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

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -1,24 +1,24 @@
-/*
- * 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-2024 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 /**
  * utility types collected from various other files,
  * attempting to consolidate

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -15,7 +15,7 @@ export class Gradient {
 
   public mapped: Array<GradientStop & { resolved: number[] }>;
 
-  constructor(stops: GradientStop[], theme: Theme, public color_space: ColorSpace = 'HSL') {
+  constructor(stops: GradientStop[], theme: Theme, public color_space: ColorSpace = 'RGB') {
 
     this.mapped = stops.map(stop => {
 

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

package/treb-base-types/src/index-standalone.ts

@@ -14,16 +14,16 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */
 
-/**
- * this is a special index for inclusion in the standalone format lib
- */
-
-export * from './localization';
-export * from './text_part';
-export * from './value-type';
-
+/**
+ * this is a special index for inclusion in the standalone format lib
+ */
+
+export * from './localization';
+export * from './text_part';
+export * from './value-type';
+

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -1,24 +1,24 @@
-/*
- * 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-2024 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 import type { ICellAddress } from './area';
 
 /**

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

@@ -1,24 +1,24 @@
-/*
- * 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-2024 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 /**
  * the point of localization is to have a central, single source of truth
  * for the current locale. this can come from the browser, via a GET
@@ -98,6 +98,12 @@ export class Localization {
 
     }
 
+    // don't allow the "C" locale
+    if (this.locale === 'C') {
+      console.warn('Locale not set, defaulting to en-us');
+      this.locale = 'en-us';
+    }
+   
     const decimal_separator = new Intl.NumberFormat(this.locale,
       {minimumFractionDigits: 1}).format(3.3).replace(/\d/g, '');
 

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -1,24 +1,24 @@
-/*
- * 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-2024 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 export enum TextPartFlag {
 
   /** just render */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

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

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

package/treb-base-types/style/resizable.css

@@ -1,24 +1,24 @@
-/*
- * 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-2024 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 .treb-embed-mouse-mask {
   position: fixed;
   top: 0px;

package/treb-calculator/src/calculator.ts

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */
@@ -1769,7 +1769,25 @@ export class Calculator extends Graph {
 
   public UpdateConditionals(list?: ConditionalFormat|ConditionalFormat[], context?: Sheet): void {
 
+    // this method is (1) relying on the leaf vertex Set to avoid duplication,
+    // and (2) leaving orphansed conditionals in place. we should look to 
+    // cleaning things up. 
+
+    // is it also (3) adding unecessary calculations (building the expression,
+    // below)?
+
     if (!list) {
+
+      // we could in theory remove all of the leaves (the ones we know to
+      // be used for conditionals), because they will be added back below.
+      // how wasteful is that?
+      
+      // or maybe we could change the mark, and then use invalid marks 
+      // to check?
+
+      // the alternative is just to leave them as orphans until the graph
+      // is rebuilt. which is lazy, but probably not that bad... 
+
       for (const sheet of this.model.sheets.list) {
         if (sheet.conditional_formats?.length) {
           this.UpdateConditionals(sheet.conditional_formats, sheet);
@@ -1833,7 +1851,11 @@ export class Calculator extends Graph {
         entry.internal = {};
       }
       if (!entry.internal.vertex) {
-        entry.internal.vertex = new CalculationLeafVertex();
+
+        const vertex = new CalculationLeafVertex();
+        vertex.use = 'conditional';
+
+        entry.internal.vertex = vertex;
 
         let options: EvaluateOptions|undefined;
         if (entry.type !== 'gradient' && entry.type !== 'duplicate-values') {
@@ -1851,35 +1873,6 @@ export class Calculator extends Graph {
       this.AddLeafVertex(vertex);
       this.UpdateLeafVertex(vertex, expression, context);
 
-      /*
-      if (entry.type === 'cell-match') {
-        if (!entry.internal) {
-          entry.internal = {};
-        }
-        if (!entry.internal.vertex) {
-          entry.internal.vertex = new CalculationLeafVertex();
-        }
-        const vertex = entry.internal.vertex as LeafVertex;
-        this.AddLeafVertex(vertex);
-        this.UpdateLeafVertex(vertex, entry.expression, context);
-      }
-      else if (entry.type === 'expression') {
-        if (!entry.internal) {
-          entry.internal = {};
-        }
-        if (!entry.internal.vertex) {
-          entry.internal.vertex = new CalculationLeafVertex();
-
-          // set initial state based on current state
-          entry.internal.vertex.result = { type: ValueType.boolean, value: !!entry.applied };
-
-        }
-        const vertex = entry.internal.vertex as LeafVertex;
-        this.AddLeafVertex(vertex);
-        this.UpdateLeafVertex(vertex, entry.expression, context);
-      }
-      */
-
     }
 
   }

package/treb-calculator/src/complex-math.ts

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

package/treb-calculator/src/dag/array-vertex.ts

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */

package/treb-calculator/src/dag/calculation_leaf_vertex.ts

@@ -14,7 +14,7 @@
  * 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. 
+ * Copyright 2022-2024 trebco, llc. 
  * info@treb.app
  * 
  */
@@ -42,6 +42,13 @@ export class CalculationLeafVertex extends SpreadsheetVertex {
   
   public address = { row: -1, column: -1 }; // fake address
 
+  /**
+   * this type is currently only used for conditional formatting.
+   * but that might change in the future. I want to identify what
+   * it's used for so we can selectively prune them when necessary.
+   */
+  public use?: string;
+
   /** 
    * flag, to reduce unecessary application. work in progress. this
    * indicates that we reached the calculation step. that means either