@trebco/treb 28.5.2 → 28.10.0

package/treb-grid/src/types/grid_base.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
  * 
  */
@@ -67,6 +67,10 @@ interface PatchOptions extends PatchAreaOptions {
   sheet: Sheet;
 }
 
+const AssertNever = (value: never) => {
+  console.error('invalid case');
+};
+
 export class GridBase {
 
   // --- public members --------------------------------------------------------
@@ -160,6 +164,24 @@ export class GridBase {
 
   // --- API methods -----------------------------------------------------------
 
+  public RemoveConditionalFormat(options: {
+        format?: ConditionalFormat;
+        area?: IArea;
+      }) {
+
+    this.ExecCommand({
+      key: CommandKey.RemoveConditionalFormat,
+      ...options,
+    });
+  }
+
+  public AddConditionalFormat(format: ConditionalFormat) {
+    this.ExecCommand({
+      key: CommandKey.AddConditionalFormat,
+      format,
+    });
+  }
+
   /** remove a table. doesn't remove any data, just removes the overlay. */
   public RemoveTable(table: Table) {
     this.ExecCommand({
@@ -1887,7 +1909,7 @@ export class GridBase {
           break;
         */
 
-        // special case
+        // special cases
         case CommandKey.SortTable:
         case CommandKey.RemoveTable:
           if (!command.table.area.start.sheet_id) {
@@ -1895,6 +1917,12 @@ export class GridBase {
           }
           break;
 
+        case CommandKey.AddConditionalFormat:
+          if (!command.format.area.start.sheet_id) {
+            command.format.area.start.sheet_id = id;
+          }
+          break;
+
         // field
         case CommandKey.ResizeRows:
         case CommandKey.ResizeColumns:
@@ -1920,6 +1948,14 @@ export class GridBase {
         case CommandKey.Select:
         case CommandKey.InsertTable:
 
+        // note that remove conditional format could have a format
+        // object (with an area) instead of an area. but in that case,
+        // the format object must match an existing format, so it would
+        // have to have a proper area. there's no case where we would
+        // want to add it. so we only handle the area case.
+
+        case CommandKey.RemoveConditionalFormat:
+
           if (command.area) {
             if (IsCellAddress(command.area)) {
               if (!command.area.sheet_id) {
@@ -1934,10 +1970,13 @@ export class GridBase {
           }
           break;
 
-        // default:
-        //  // command key here should be `never` if we've covered all the 
-        //  // cases (ts will complain)
-        //  // console.warn('unhandled command key', command.key);
+        default:
+
+          // this is intended to check that we've handled all cases. if you
+          // add additional commands and they're not handled, this should 
+          // raise a ts error.
+
+          AssertNever(command);
 
       }
     }
@@ -3534,6 +3573,88 @@ export class GridBase {
 
           break;
 
+        case CommandKey.AddConditionalFormat:
+          {
+
+            const sheet = this.FindSheet(command.format.area);
+            sheet.conditional_formats.push(command.format);
+
+            sheet.Invalidate(new Area(command.format.area.start, command.format.area.end));
+
+            if (sheet === this.active_sheet) {
+              // flags.style_area = Area.Join(command.format.area, flags.style_area);
+              flags.render_area = Area.Join(command.format.area, flags.render_area);
+            }
+            else {
+              // flags.style_event = true;
+            }
+
+            flags.structure_event = true;
+            flags.conditional_formatting_event = true;
+
+          }
+          break;
+
+        case CommandKey.RemoveConditionalFormat:
+
+          {
+            let sheet: Sheet|undefined;
+            let count = 0;
+
+            if (command.format) {
+
+              // we're removing by object equivalence, not strict equality.
+              // this is in case we're switching contexts and the objects
+              // are not strictly equal. may be unecessary. do we need to
+              // normalize in some way? (...)
+
+              const format = JSON.stringify(command.format);
+
+              sheet = this.FindSheet(command.format.area);
+              sheet.conditional_formats = sheet.conditional_formats.filter(test => {
+                // if (test === command.format) {
+                if (JSON.stringify(test) === format) {
+                  count++;
+                  flags.render_area = Area.Join(test.area, flags.render_area);
+                  return false;
+                }
+                return true;
+              });
+
+            }
+            else if (command.area) {
+              const area = new Area(command.area.start, command.area.end);
+              sheet = this.FindSheet(command.area);
+
+              sheet.conditional_formats = sheet.conditional_formats.filter(test => {
+                const compare = new Area(test.area.start, test.area.end);
+                if (compare.Intersects(area)) {
+                  count++;
+                  flags.render_area = Area.Join(compare, flags.render_area);
+                  return false;
+                }
+                return true;
+              });
+        
+            }
+
+            if (sheet && count) {
+              sheet.FlushConditionalFormats();
+              flags.structure_event = true;
+
+              // this will flush leaf vertices. but it's expensive because
+              // it's rebuilding the whole graph. we could maybe reduce a 
+              // bit... the question is what's worse: rebuilding the graph
+              // or leaving orphans for a while?
+
+              // flags.structure_rebuild_required = true;
+
+              flags.conditional_formatting_event = true;
+            }
+
+          }
+          break;
+
         case CommandKey.InsertTable:
 
           // the most important thing here is validating that we can
@@ -4170,6 +4291,7 @@ export class GridBase {
       events.push({
         type: 'structure',
         rebuild_required: flags.structure_rebuild_required,
+        conditional_format: flags.conditional_formatting_event,
       });
     }
 

package/treb-grid/src/types/grid_command.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
  * 
  */
@@ -22,6 +22,7 @@
 import type { ICellAddress, IArea, Style, CellStyle, Color, CellValue, Table, TableSortType, TableTheme } from 'treb-base-types';
 import type { ExpressionUnit } from 'treb-parser';
 import type { BorderConstants } from './border_constants';
+import type { ConditionalFormat } from './conditional_format';
 
 /**
  * switching to an exec-command based model, so we can serialize
@@ -73,6 +74,9 @@ export enum CommandKey {
   InsertTable,
   RemoveTable,
 
+  AddConditionalFormat,
+  RemoveConditionalFormat,
+
 }
 
 /** base type for sheet commands -- can select sheet by name, id or index */
@@ -418,6 +422,32 @@ export interface ReorderSheetCommand {
   move_before: number;
 }
 
+/**
+ * add conditional format
+ */
+export interface AddConditionalFormatCommand {
+  key: CommandKey.AddConditionalFormat;
+  format: ConditionalFormat;
+}
+
+/**
+ * remove conditional format, either as an object or from a target 
+ * area. as an object, we'll match using object equivalence and not 
+ * identity. 
+ */
+export interface RemoveConditionalFormatCommand {
+
+  key: CommandKey.RemoveConditionalFormat;
+
+  /** if format is omitted, we will remove all formats from the target range */
+  format?: ConditionalFormat;
+
+  /** one of area or format should be supplied */
+  area?: IArea; 
+
+}
+
+
 /**
  * ephemeral flag added to commands.
  * /
@@ -459,6 +489,8 @@ export type Command =
   | ActivateSheetCommand
   | DataValidationCommand
   | DuplicateSheetCommand
+  | AddConditionalFormatCommand
+  | RemoveConditionalFormatCommand
   ) ; // & Ephemeral;
 
 /**

package/treb-grid/src/types/grid_events.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
  * 
  */
@@ -23,6 +23,7 @@ import type { GridSelection } from './grid_selection';
 import type { Annotation } from './annotation';
 import type { Sheet } from './sheet';
 import type { Area } from 'treb-base-types';
+import type { ConditionalFormat } from './conditional_format';
 
 export enum ErrorCode {
 
@@ -80,6 +81,12 @@ export interface StructureEvent {
    * FIXME: merge/unmerge? (...) I think yes
    */
   rebuild_required?: boolean;
+
+  /** 
+   * we can use this when conditional formats are modified/added/removed 
+   */
+  conditional_format?: boolean;
+  
 }
 
 export interface AnnotationEvent {

package/treb-grid/src/types/grid_options.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
  * 
  */
@@ -24,6 +24,14 @@ import type { StatsEntry } from './tab_bar';
 
 export type StatsFunction = (data: CellValue|CellValue[][]|undefined) => StatsEntry[];
 
+
+/**
+ * @internalRemarks
+ * 
+ * why are there two levels of options? can we consolidate this with
+ * the embedded spreadsheet options? they are never (AFAICT) used 
+ * independently. maybe that's recent.
+ */
 export interface GridOptions {
 
   /** can expand rows/columns */

package/treb-grid/src/types/grid_selection.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-grid/src/types/named_range.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-grid/src/types/scale-control.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-grid/src/types/serialize_options.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-grid/src/types/set_range_options.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-grid/src/types/sheet.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
  * 
  */
@@ -3232,62 +3232,6 @@ export class Sheet {
 
   }
 
-  /*
-  public ApplyConditionalFormats() {
-
-    this.FlushConditionalFormatCache();
-
-    for (const entry of this.conditional_formats) {
-
-      console.info({entry});
-
-      if (entry.applied) {
-        this.ApplyConditionalFormatCache(entry);
-      }
-    }
-
-  }
-
-  public FlushConditionalFormatCache() {
-
-    // FIXME: need to flush any styles that are set, unless they match;
-    // perhaps we should use an alternate cache so we can compare? TODO/FIXME
-
-    for (const [row, row_data] of this.conditional_format_cache.entries()) {
-      if (row_data) {
-        for (const [column, column_data] of row_data.entries()) {
-          if (column_data) {
-
-            this.CellData({row, column}).FlushStyle();
-
-          }
-        }
-      }
-    }
-
-    this.conditional_format_cache = [];
-
-  }
-
-  public ApplyConditionalFormatCache(format: ConditionalFormat) {
-    
-    for (let row = format.area.start.row; row <= format.area.end.row; row++ ) {
-      for (let column = format.area.start.column; column <= format.area.end.column; column++ ) {
-        if (!this.conditional_format_cache[row]) {
-          this.conditional_format_cache[row] = [];
-        }
-        if (!this.conditional_format_cache[row][column]) {
-          this.conditional_format_cache[row][column] = [];
-        }
-        this.conditional_format_cache[row][column].push(format.style);
-        this.CellData({row, column}).FlushStyle();
-
-      }
-    }
-
-  }
-  */
-
   private ConditionalFormatForCell(address: ICellAddress): CellStyle[] {
     if (this.conditional_format_cache[address.row]) {
       return this.conditional_format_cache[address.row][address.column] || [];

package/treb-grid/src/types/sheet_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-grid/src/types/tab_bar.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-grid/src/types/tile.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 { Point, Size, Position } from 'treb-base-types';
 
 /**

package/treb-grid/src/types/update_flags.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
  * 
  */
@@ -64,6 +64,7 @@ export interface UpdateFlags {
 
   data_event?: boolean;
   style_event?: boolean;
+  conditional_formatting_event?: boolean;
   structure_event?: boolean;
   structure_rebuild_required?: boolean;
 

package/treb-grid/src/util/fontmetrics2.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-grid/src/util/ua.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
+ * 
+ */
+
 const app_version = typeof navigator === 'undefined' ? '' : navigator.appVersion;
 const user_agent = typeof navigator === 'undefined' ? '' : navigator.userAgent;
 

package/treb-parser/src/csv-parser.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
+ * 
+ */
+
 enum ParseState {
   default = 0,
   quoted = 1,

package/treb-parser/src/index.ts

@@ -14,12 +14,12 @@
  * 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
  * 
  */
 
-export * from './parser-types';
-export * from './parser';
-export * from './csv-parser';
-export * from './md-parser';
+export * from './parser-types';
+export * from './parser';
+export * from './csv-parser';
+export * from './md-parser';

package/treb-parser/src/md-parser.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-parser/src/parser-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
  * 
  */