@trebco/treb 31.3.4 → 31.7.0

package/treb-grid/src/types/grid_base.ts

@@ -43,7 +43,7 @@ import type { DataModel, ConditionalFormat, // MacroFunction, SerializedModel, S
 import type { Parser, UnitAddress} from 'treb-parser';
 import { type ExpressionUnit, IllegalSheetNameRegex, ParseCSV, DecimalMarkType } from 'treb-parser';
 import { Area, IsCellAddress, ValueType, DefaultTableSortOptions } from 'treb-base-types';
-import type { ICellAddress, IArea, Cell, CellValue, CellStyle, Table, TableSortOptions, TableTheme, Complex, PatchOptions as PatchAreaOptions } from 'treb-base-types';
+import type { ICellAddress, IArea, Cell, CellValue, CellStyle, Table, TableSortOptions, TableTheme, Complex, PatchOptions as PatchAreaOptions, Color } from 'treb-base-types';
 
 import { Sheet, type SerializeOptions, type Annotation } from 'treb-data-model';
 
@@ -53,7 +53,7 @@ import { NumberFormat, ValueParser } from 'treb-format';
 
 import type { GridEvent } from './grid_events';
 import { ErrorCode } from './grid_events';
-import type { CommandRecord, DataValidationCommand, DuplicateSheetCommand, FreezeCommand, InsertColumnsCommand, InsertRowsCommand, ResizeColumnsCommand, ResizeRowsCommand, SelectCommand, SetRangeCommand, ShowSheetCommand, SortTableCommand } from './grid_command';
+import type { CommandRecord, CreateAnnotationCommand, DataValidationCommand, DuplicateSheetCommand, FreezeCommand, InsertColumnsCommand, InsertRowsCommand, RemoveAnnotationCommand, ResizeColumnsCommand, ResizeRowsCommand, SelectCommand, SetRangeCommand, ShowSheetCommand, SortTableCommand } from './grid_command';
 import { DefaultGridOptions, type GridOptions } from './grid_options';
 
 import { BorderConstants } from './border_constants';
@@ -813,6 +813,34 @@ export class GridBase {
 
   }
 
+  protected RemoveAnnotationInternal(command: RemoveAnnotationCommand) {
+
+    for (let i = 0; i < command.sheet.annotations.length; i++) {
+      if (command.annotation === command.sheet.annotations[i]) {
+        command.sheet.annotations.splice(i, 1);
+
+        // subclass only // this.layout.RemoveAnnotation(annotation);
+
+        // do we still need this message? not sure
+
+        this.grid_events.Publish({
+          type: 'annotation',
+          annotation: command.annotation,
+          event: 'delete',
+        });
+
+        return;
+      }
+    }
+    
+  }
+
+  /** placeholder */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  protected CreateAnnotationInternal(command: CreateAnnotationCommand) {
+    
+  }
+
   /**
    * resize rows. this supports auto size, but that will fail in !ui grid,
    * because it uses HTML. also non-ui doesn't really need to worry about 
@@ -1904,6 +1932,7 @@ export class GridBase {
         
         // nothing
         case CommandKey.Null:
+        case CommandKey.TabColor:
         case CommandKey.ShowHeaders:
         case CommandKey.ShowSheet:
         case CommandKey.AddSheet:
@@ -1913,6 +1942,8 @@ export class GridBase {
         case CommandKey.RenameSheet:
         case CommandKey.ReorderSheet:
         case CommandKey.Reset:
+        case CommandKey.CreateAnnotation:
+        case CommandKey.RemoveAnnotation:
           break;
 
         /*
@@ -2009,6 +2040,14 @@ export class GridBase {
 
   }
 
+  public TabColor(sheet: Sheet, color?: Color) {
+    this.ExecCommand({
+      key: CommandKey.TabColor,
+      sheet,
+      color,
+    });
+  }
+
   /**
    * add sheet. data only.
    */
@@ -4183,6 +4222,20 @@ export class GridBase {
           flags.structure_event = true;
           break;
 
+        case CommandKey.TabColor:
+          command.sheet.tab_color = command.color;
+
+          // NOTE: the flag.sheets originally did not update tab colors,
+          // which were cached. we could create a new flag for that, or 
+          // we could just refresh the colors. since there aren't that
+          // many of them, it's probably OK to just refresh the colors any
+          // time this flag is set. if that becomes a perf issue in the 
+          // future we could add a new flag.
+
+          flags.sheets = true; // repaint tab bar
+          flags.structure_event = true;
+          break;
+
         case CommandKey.ReorderSheet:
           {
             // COEDITING: seems OK, irrespective of active sheet
@@ -4225,6 +4278,20 @@ export class GridBase {
           }
           break;
 
+        case CommandKey.RemoveAnnotation:
+          this.RemoveAnnotationInternal(command);
+          flags.structure_event = true;
+          flags.structure_rebuild_required = true;
+          flags.annotation_event = true;
+          break;          
+
+        case CommandKey.CreateAnnotation:
+          this.CreateAnnotationInternal(command);
+          flags.structure_event = true;
+          flags.structure_rebuild_required = true;
+          flags.annotation_event = true;
+          break;
+
         case CommandKey.ResizeRows:
 
           // moving this to a method so we can specialize: non-UI grid
@@ -4483,6 +4550,7 @@ export class GridBase {
         type: 'structure',
         rebuild_required: flags.structure_rebuild_required,
         conditional_format: flags.conditional_formatting_event,
+        update_annotations: flags.annotation_event,
       });
     }
 

package/treb-grid/src/types/grid_command.ts

@@ -19,10 +19,10 @@
  * 
  */
 
-import type { ICellAddress, IArea, CellStyle, Color, CellValue, Table, TableSortType, TableTheme } from 'treb-base-types';
+import type { ICellAddress, IArea, CellStyle, Color, CellValue, Table, TableSortType, TableTheme, IRectangle } from 'treb-base-types';
 import type { ExpressionUnit } from 'treb-parser';
 import type { BorderConstants } from './border_constants';
-import type { ConditionalFormat } from 'treb-data-model';
+import type { Annotation, AnnotationData, ConditionalFormat, Sheet } from 'treb-data-model';
 
 /**
  * switching to an exec-command based model, so we can serialize
@@ -78,6 +78,27 @@ export enum CommandKey {
   AddConditionalFormat,
   RemoveConditionalFormat,
 
+  TabColor,
+  CreateAnnotation,
+  RemoveAnnotation,
+
+}
+
+export interface RemoveAnnotationCommand {
+  key: CommandKey.RemoveAnnotation;
+  sheet: Sheet;
+  annotation: Annotation;
+}
+
+export interface CreateAnnotationCommand {
+  key: CommandKey.CreateAnnotation;
+  sheet: Sheet;
+  properties: Partial<AnnotationData>;
+  add_to_sheet?: boolean;
+  offset?: boolean;
+  target?: IArea|IRectangle;
+  focus?: boolean;
+
 }
 
 /** base type for sheet commands -- can select sheet by name, id or index */
@@ -439,6 +460,12 @@ export interface AddConditionalFormatCommand {
   format: ConditionalFormat;
 }
 
+export interface TabColorCommand {
+  key: CommandKey.TabColor;
+  sheet: Sheet;
+  color?: Color;
+}
+
 /**
  * remove conditional format, either as an object or from a target 
  * area. as an object, we'll match using object equivalence and not 
@@ -480,6 +507,7 @@ export type Command =
   | SetNameCommand
   | AddSheetCommand
   | SetRangeCommand
+  | TabColorCommand
   | SortTableCommand
   | ShowSheetCommand
   | MergeCellsCommand
@@ -499,6 +527,8 @@ export type Command =
   | ActivateSheetCommand
   | DataValidationCommand
   | DuplicateSheetCommand
+  | CreateAnnotationCommand
+  | RemoveAnnotationCommand
   | AddConditionalFormatCommand
   | RemoveConditionalFormatCommand
   ) ; // & Ephemeral;

package/treb-grid/src/types/grid_events.ts

@@ -83,7 +83,13 @@ export interface StructureEvent {
    * we can use this when conditional formats are modified/added/removed 
    */
   conditional_format?: boolean;
-  
+
+  /**
+   * this flag should be set if annotations have been added or removed,
+   * so parent/child views can update as necessary
+   */
+  update_annotations?: boolean;
+
 }
 
 export interface AnnotationEvent {

package/treb-grid/src/types/grid_options.ts

@@ -90,6 +90,9 @@ export interface GridOptions {
   /** support MD formatting in text */
   markdown?: boolean;
 
+  /** support MD formatting in comments */
+  comment_markdown?: boolean;
+
   /** support font stacks */
   support_font_stacks?: boolean;
 
@@ -104,6 +107,7 @@ export const DefaultGridOptions: GridOptions = {
   // insert_function_button: false,
   expand_formula_button: false,
   expand: true,
+  comment_markdown: true,
   repaint_on_cell_change: true,
   grid_over_background: false, // true,
 };

package/treb-grid/src/types/tab_bar.ts

@@ -443,6 +443,8 @@ export class TabBar extends EventSource<TabEvent> {
    */
   public Update(): void {
 
+    this.tab_color_cache.clear(); // we're setting tab color but it's not getting updated otherwise
+
     // this is a hack to normalize behavior if you try to re-order
     // a tab that's not the active tab. what ordinarily happens is
     // we start the drag, but then Update is called again which rebuilds

package/treb-grid/src/types/update_flags.ts

@@ -68,6 +68,12 @@ export interface UpdateFlags {
   structure_event?: boolean;
   structure_rebuild_required?: boolean;
 
+  /** 
+   * new, an indication to split views that we might need to update/reinflate
+   * annotations.
+  */
+  annotation_event?: boolean;
+
   render_area?: Area;
   data_area?: Area;
   style_area?: Area;

package/treb-parser/src/md-parser.ts

@@ -103,8 +103,16 @@ export class MDParser {
    * 
    * also the way this works adds extra tags if you have nested styles. not
    * an issue if it's just for testing though.
+   * 
+   * update to optionally not add breaking spaces (<br/>). we need this for
+   * containers that are set to white-space: pre-line, where we will already
+   * get a linebreak.
+   * 
    */
-  public HTML(formatted: FormattedString[][]): string {
+  public HTML(formatted: FormattedString[][], options: { br?: boolean } = {}): string {
+
+    // default options
+    options = { br: true, ...options };
 
     const lines: string[] = [];
 
@@ -128,7 +136,7 @@ export class MDParser {
       lines.push(text.join(''));
     }
 
-    return lines.join('<br/>\n');
+    return lines.join(options.br ? '<br/>\n' : '\n');
     
   }
 
@@ -454,7 +462,12 @@ export class MDParser {
           tokens.push({ type: 'text', text: current_token });
         }
 
-        let tmp = char;
+        tokens.push({
+          type: 'newline',
+          text: char,
+        })
+
+        let tmp = '';
         for (;;) { // while (true) {
           const next_char = text[index+1];
           if (this.IsNewline(next_char)) {
@@ -465,10 +478,13 @@ export class MDParser {
             break;
           }
         }
-        tokens.push({
-          type: 'newline',
-          text: tmp,
-        })
+
+        if (tmp.length) {
+          tokens.push({
+            type: 'newline',
+            text: tmp,
+          });
+        }
         escape = false;
         current_token = '';
 

package/test/parser.ts

@@ -1,13 +0,0 @@
-
-import { Parser } from '../treb-parser/src/parser.js';
-
-const parser = new Parser();
-
-let text = "=NORMDIST((LN(S/K)+(r+s^2/2)*T)/(s*SQRT(T)), 0, 1, TRUE)*S - NORMDIST((LN(S/K)+(r-s^2/2)*T)/(s*SQRT(T)), 0, 1, TRUE)*K*EXP(-r*T)";
-let result = parser.Parse(text);
-// console.info('valid?', result.valid, result.expression);
-
-text = "=s*SQRT(T)";
-result = parser.Parse(text);
-console.info('valid?', result.valid, result.expression);
-