@trebco/treb 25.2.0 → 25.5.0

package/treb-format/src/format_parser.ts

@@ -1,26 +1,27 @@
-/*
- * 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-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 import { NumberFormatSection } from './number_format_section';
-import { TextPartFlag, TextPart } from 'treb-base-types';
+import type { TextPart } from 'treb-base-types';
+import { TextPartFlag } from 'treb-base-types';
 // import { NumberFormat } from './format';
 
 const ASTERISK = 0x2A;  // TODO

package/treb-format/src/value_parser.ts

@@ -1,25 +1,26 @@
-/*
- * 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
- * 
- */
-
-import { ValueType, Localization, Complex } from 'treb-base-types';
+/*
+ * 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
+ * 
+ */
+
+import type { Complex } from 'treb-base-types';
+import { ValueType, Localization } from 'treb-base-types';
 import { UnlotusDate } from './format';
 
 /**

package/treb-grid/src/editors/formula_bar.ts

@@ -23,7 +23,8 @@ import { Yield } from 'treb-utils';
 
 import { DOMUtilities } from '../util/dom_utilities';
 import type { Theme } from 'treb-base-types';
-import { FormulaEditorBase, FormulaEditorEvent } from './formula_editor_base';
+import type { FormulaEditorEvent } from './formula_editor_base';
+import { FormulaEditorBase } from './formula_editor_base';
 import type { GridOptions } from '../types/grid_options';
 import type { Autocomplete } from './autocomplete';
 import type { DataModel, ViewModel } from '../types/data_model';

package/treb-grid/src/editors/formula_editor_base.ts

@@ -19,13 +19,15 @@
  * 
  */
 
-import { Area, Cell, Theme, Rectangle, Localization, ICellAddress } from 'treb-base-types';
+import type { Cell, Theme, ICellAddress } from 'treb-base-types';
+import { Area, Rectangle, Localization } from 'treb-base-types';
 import { Yield, EventSource } from 'treb-utils';
 import type { Parser, UnitRange, UnitAddress, ParseResult, ExpressionUnit } from 'treb-parser';
 
 import type { GridSelection } from '../types/grid_selection';
 import type { Autocomplete, AutocompleteResult } from './autocomplete';
-import { AutocompleteExecResult, AutocompleteMatcher, DescriptorType } from './autocomplete_matcher';
+import type { AutocompleteExecResult, AutocompleteMatcher} from './autocomplete_matcher';
+import { DescriptorType } from './autocomplete_matcher';
 
 import type { DataModel, ViewModel } from '../types/data_model';
 import { UA } from '../util/ua';

package/treb-grid/src/editors/overlay_editor.ts

@@ -28,7 +28,8 @@
  * and get layout working properly. 
  */
 
-import { Style, Theme, CellValue, Rectangle, ThemeColor2, Cell } from 'treb-base-types';
+import type { Theme, CellValue, Rectangle, Cell } from 'treb-base-types';
+import { Style, ThemeColor2 } from 'treb-base-types';
 import { Yield } from 'treb-utils';
 import type { Parser } from 'treb-parser';
 import type { GridSelection } from '../types/grid_selection';

package/treb-grid/src/index.ts

@@ -22,16 +22,19 @@
 export { Grid } from './types/grid';
 export { GridBase } from './types/grid_base';
 export { Sheet } from './types/sheet';
-export { DataModel, MacroFunction, SerializedNamedExpression, SerializedModel } from './types/data_model';
+export { DataModel, type MacroFunction } from './types/data_model';
+export type { SerializedNamedExpression, SerializedModel } from './types/data_model';
 export * from './types/grid_events';
-export { SerializedSheet, FreezePane } from './types/sheet_types';
-export { Annotation, ViewData as AnnotationViewData } from './types/annotation';
-export { GridOptions } from './types/grid_options';
-export { Command, CommandKey } from './types/grid_command';
+export type { SerializedSheet, FreezePane } from './types/sheet_types';
+export { Annotation } from './types/annotation';
+export type { ViewData as AnnotationViewData } from './types/annotation';
+export type { GridOptions } from './types/grid_options';
+export { CommandKey } from './types/grid_command';
+export type { Command } from './types/grid_command';
 export { NamedRangeCollection } from './types/named_range';
-export { GridSelection } from './types/grid_selection';
+export type { GridSelection } from './types/grid_selection';
 export { BorderConstants } from './types/border_constants';
-export { SerializeOptions } from './types/serialize_options';
-export { FunctionDescriptor, ArgumentDescriptor } from './editors/autocomplete_matcher';
+export type { SerializeOptions } from './types/serialize_options';
+export type { FunctionDescriptor, ArgumentDescriptor } from './editors/autocomplete_matcher';
 export { UA } from './util/ua';
-export { SetRangeOptions } from './types/set_range_options';
+export type { SetRangeOptions } from './types/set_range_options';

package/treb-grid/src/layout/base_layout.ts

@@ -23,7 +23,8 @@ import { DOMUtilities } from '../util/dom_utilities';
 import type { DataModel, ViewModel } from '../types/data_model';
 
 import type { Tile } from '../types/tile';
-import { Style, Theme, Point, Extent, Size, Position, Area, ICellAddress, Rectangle, ThemeColor, Table } from 'treb-base-types';
+import type { Theme, Point, Extent, Size, Position, ICellAddress, Table } from 'treb-base-types';
+import { Style, Area, Rectangle, ThemeColor } from 'treb-base-types';
 
 import { MouseDrag } from '../types/drag_mask';
 import type { GridEvent } from '../types/grid_events';
@@ -39,7 +40,8 @@ import type { GridEvent } from '../types/grid_events';
 // define area as a generic, then define it on some arbitrary value. that would
 // force separation of all the functions between the two types (I think)
 
-import { Area as TileRange, CellValue, AnnotationLayout, Corner } from 'treb-base-types';
+import type { CellValue, AnnotationLayout, Corner } from 'treb-base-types';
+import { Area as TileRange } from 'treb-base-types';
 import type { Annotation } from '../types/annotation';
 
 export { Area as TileRange } from 'treb-base-types';

package/treb-grid/src/render/selection-renderer.ts

@@ -1,27 +1,29 @@
-/*
- * 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
- * 
- */
-
-import { Theme, Rectangle, ICellAddress } from 'treb-base-types';
+/*
+ * 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
+ * 
+ */
+
+import type { Theme, ICellAddress } from 'treb-base-types';
+import { Rectangle } from 'treb-base-types';
 import type { BaseLayout } from '../layout/base_layout';
-import { SVGSelectionBlock, SelectionOffset } from './svg_selection_block';
+import type { SelectionOffset } from './svg_selection_block';
+import { SVGSelectionBlock } from './svg_selection_block';
 import type { GridSelection } from '../types/grid_selection';
 import { HeaderOverlay, Orientation } from './svg_header_overlay';
 import type { DataModel, ViewModel } from '../types/data_model';

package/treb-grid/src/render/tile_renderer.ts

@@ -19,14 +19,16 @@
  * 
  */
 
-import { TextPartFlag, ICellAddress, Style, ValueType, 
+import type { ICellAddress, 
          PreparedText, RenderTextPart,
-         Cell, Area, Size, Rectangle, 
-         Theme, ThemeColor, ThemeColor2, Table } from 'treb-base-types';
+         Cell, Size, 
+         Theme} from 'treb-base-types';
+import { TextPartFlag, Style, ValueType, Area, Rectangle, ThemeColor, ThemeColor2 } from 'treb-base-types';
 
 import type { Tile } from '../types/tile';
 import { FontMetricsCache as FontMetricsCache2 } from '../util/fontmetrics2';
-import { FormattedString, MDParser } from 'treb-parser';
+import type { FormattedString} from 'treb-parser';
+import { MDParser } from 'treb-parser';
 import type { BaseLayout, TileRange } from '../layout/base_layout';
 import type { DataModel, ViewModel } from '../types/data_model';
 import type { GridOptions } from '../types/grid_options';

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

@@ -1,25 +1,26 @@
-/*
- * 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
- * 
- */
-
-import { Rectangle, ICellAddress, AnnotationLayout } from 'treb-base-types';
+/*
+ * 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
+ * 
+ */
+
+import type { ICellAddress, AnnotationLayout } from 'treb-base-types';
+import { Rectangle } from 'treb-base-types';
 
 /**
  * new annotation class. annotations are arbitrary content
@@ -78,8 +79,18 @@ export interface ViewData {
 
 }
 
+/**
+ * why is this a class? it doesn't do anything.
+ * FIXME: -> interface
+ */
 export class Annotation {
 
+  /** 
+   * the key field is used to identify and coordinate annotations when we 
+   * have freeze panes. when an annotation crosses a freeze pane, we need
+   * two copies of the rendered node so that we can scroll. we use the key
+   * to match the frozen/unfrozen instances.
+   */
   public get key(): number { return this.key_; }
 
   /** coordinates, in sheet space */
@@ -105,15 +116,6 @@ export class Annotation {
   /** also opaque data, but not serialized. */
   public temp: any = {};
 
-  /* * flag indicating we have inflated this. not serialized */
-  // public inflated = false;
-
-  /* * if function exists, will be called when the annotation is resized */
-  // public resize_callback?: () => void;
-
-  /* * if function exists, will be called when the annotation needs to update */
-  // public update_callback?: () => void;
-
   /** annotation can be resized. this is advisory, for UI */
   public resizable = true;
 
@@ -132,12 +134,6 @@ export class Annotation {
   /** resize when resizing/inserting rows/columns */
   public resize_with_cells = true;
 
-  /* * layout node, obviously not serialized */
-  // public node?: HTMLDivElement;
-
-  /* * content node */
-  // public content_node?: HTMLDivElement;
-
   public view: ViewData[] = [];
 
   /**

package/treb-grid/src/types/data_model.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-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 import type { Sheet } from './sheet';
 import type { IArea, ICellAddress, Table } from 'treb-base-types';
 import type { SerializedSheet } from './sheet_types';
@@ -26,12 +26,20 @@ import { NamedRangeCollection } from './named_range';
 import type { ExpressionUnit, UnitAddress, UnitStructuredReference, UnitRange } from 'treb-parser';
 import { Style } from 'treb-base-types';
 
-export interface MacroFunction {
+export interface SerializedMacroFunction {
   name: string;
   function_def: string;
   argument_names?: string[];
   // argument_default_values?: any[]; // <- new
   description?: string;
+}
+
+/**
+ * we define this as extending the serialized version, rather
+ * than taking out the parameter, so we can make that def public
+ * in the API types.
+ */
+export interface MacroFunction extends SerializedMacroFunction {
   expression?: ExpressionUnit;
 }