@trebco/treb 26.0.5 → 27.0.0

package/esbuild-utils.mjs

@@ -5,7 +5,7 @@ import * as esbuild from 'esbuild';
 import { promises as fs } from 'fs';
 import { minify } from 'html-minifier';
 import path from 'path';
-import sass from 'sass';
+import * as sass from 'sass';
 import cssnano from 'cssnano';
 import postcss from 'postcss';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "26.0.5",
+  "version": "27.0.0",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {
@@ -12,12 +12,12 @@
   "type": "module",
   "devDependencies": {
     "@types/html-minifier": "^4.0.2",
-    "@types/node": "^18.15.3",
+    "@types/node": "^20.4.0",
     "@typescript-eslint/eslint-plugin": "^5.30.4",
     "@typescript-eslint/parser": "^5.30.4",
     "archiver": "^5.3.0",
     "cssnano": "^6.0.0",
-    "esbuild": "^0.17.11",
+    "esbuild": "^0.18.11",
     "eslint": "^8.19.0",
     "fast-xml-parser": "^4.0.7",
     "html-minifier": "^4.0.0",

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

@@ -22,7 +22,7 @@
 // import { Parser } from 'treb-parser';
 
 import type { Area, IArea } from './area';
-import type { Style } from './style';
+import type { Style, CellStyle } from './style';
 import type { TextPart } from './text_part';
 import type { Complex } from './value-type';
 import { ValueType, GetValueType } from './value-type';
@@ -35,7 +35,7 @@ export interface RenderFunctionOptions {
   width: number;
   context: CanvasRenderingContext2D;
   cell: Cell;
-  style: Style.Properties;
+  style: CellStyle;
   scale?: number;
 }
 
@@ -275,7 +275,7 @@ export class Cell {
   // data (FIXME: if style is an object, this would just be a pointer, so
   // why not just use a reference?)
   // style:number = 0;
-  public style?: Style.Properties;
+  public style?: CellStyle;
 
   /** if this cell is part of an array, pointer to the area. */
   public area?: Area;

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

@@ -31,7 +31,7 @@ import { Cell } from './cell';
 import type { Table } from './table';
 import { type SerializedValueType, ValueType, GetValueType, ValueTypeList } from './value-type';
 import type { CellValue, UnionValue } from './union';
-import type { Style } from './style';
+import type { Style, CellStyle } from './style';
 
 export interface CellSerializationOptions {
   preserve_type?: boolean;
@@ -88,7 +88,13 @@ export interface BaseCellData {
   // locked?: boolean;
 }
 
-export interface FlatCellData extends BaseCellData {
+/**
+ * this type is for serialized data that includes the row and column
+ * in each cell. this was the original serialized data type, and is
+ * still supported. current serialization will group data into rows or
+ * columns, whichever results in a smaller overall serialized representation.
+ */
+export interface CellDataWithAddress extends BaseCellData {
   row: number;
   column: number;
 }
@@ -97,31 +103,43 @@ export interface NestedCellData {
   cells: BaseCellData[];
 }
 
+/**
+ * this type is for serialized data that is grouped by row, with each
+ * cell referencing a column in the spreadsheet. 
+ */
+export interface CellDataWithColumn extends BaseCellData {
+  column: number;
+}
+
 export interface NestedRowData extends NestedCellData {
   row: number;
-  cells: Array<{
-    column: number;
-  } & BaseCellData>;
+  cells: CellDataWithColumn[];
+}
+
+/**
+ * this type is for serialized data that is grouped by column, with each
+ * cell referencing a row in the spreadsheet. 
+ */
+export interface CellDataWithRow extends BaseCellData {
+  row: number;
 }
 
 export interface NestedColumnData extends NestedCellData {
   column: number;
-  cells: Array<{
-    row: number;
-  } & BaseCellData>;
+  cells: CellDataWithRow[];
 }
 
-export type SerializedCellData = FlatCellData[]|NestedRowData[]|NestedColumnData[];
+export type SerializedCellData = CellDataWithAddress[]|NestedRowData[]|NestedColumnData[];
 
 // some type guards for the various data types
 
 /** @internal */
-export const IsFlatData = (test: FlatCellData|NestedCellData): test is FlatCellData => {
+export const IsFlatData = (test: CellDataWithAddress|NestedCellData): test is CellDataWithAddress => {
   return !(test as NestedCellData).cells;
 }
 
 /** @internal */
-export const IsFlatDataArray = (test: FlatCellData[]|NestedCellData[]): test is FlatCellData[] => {
+export const IsFlatDataArray = (test: CellDataWithAddress[]|NestedCellData[]): test is CellDataWithAddress[] => {
   return (!!test[0]) && IsFlatData(test[0]);
 };
 
@@ -418,7 +436,7 @@ export class Cells {
   /**
    * UPDATE: adding optional style refs, for export
    */
-  public FromJSON(data: SerializedCellData = [], style_refs?: Style.Properties[]): void {
+  public FromJSON(data: SerializedCellData = [], style_refs?: CellStyle[]): void {
 
     this.data = [];
 
@@ -428,7 +446,7 @@ export class Cells {
 
     if (!IsFlatDataArray(data)) {
 
-      const new_data: FlatCellData[] = [];
+      const new_data: CellDataWithAddress[] = [];
 
       if (IsNestedRowArray(data)) {
         for (const block of data) {
@@ -595,7 +613,7 @@ export class Cells {
       end_row = options.subset.end.row;
     }
 
-    const data: FlatCellData[] = [];
+    const data: CellDataWithAddress[] = [];
 
     let last_row = -1;
     let last_col = -1;
@@ -662,7 +680,7 @@ export class Cells {
                   ( cell.style.fill || cell.style.border_bottom ||
                     cell.style.border_top || cell.style.border_left || cell.style.border_right)))){
 
-            const obj: FlatCellData = { row, column, value: cell.value };
+            const obj: CellDataWithAddress = { row, column, value: cell.value };
             if (cell.note) {
               obj.note = cell.note;
             }

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

@@ -22,32 +22,34 @@
 /**
  * utility functions, primarily for adjusting lightness. since we generally
  * traffic in RGB (or symbolic colors) that requires translating to/from HSL.
+ * 
+ * @internal
  */
-class ColorFunctions {
+export const ColorFunctions = {
 
   /** darken rgb color by amount (%), optionally relative */
-  public Darken(r: number, g: number, b: number, amount: number, relative = false) {
+  Darken: (r: number, g: number, b: number, amount: number, relative = false) => {
 
     // eslint-disable-next-line prefer-const
-    let { h, s, l } = this.RGBToHSL(r, g, b);
+    let { h, s, l } = ColorFunctions.RGBToHSL(r, g, b);
     if (relative) l -= l * amount / 100;
     else l -= amount / 100;
     l = Math.max(0, Math.min(1, l));
-    return this.HSLToRGB(h, s, l);
-  }
+    return ColorFunctions.HSLToRGB(h, s, l);
+  },
 
   /** lighten rgb color by amount (%), optionally relative */
-  public Lighten(r: number, g: number, b: number, amount: number, relative = false) {
+  Lighten: (r: number, g: number, b: number, amount: number, relative = false) => {
 
     // eslint-disable-next-line prefer-const
-    let { h, s, l } = this.RGBToHSL(r, g, b);
+    let { h, s, l } = ColorFunctions.RGBToHSL(r, g, b);
     if (relative) l += l * amount / 100;
     else l += amount / 100;
     l = Math.max(0, Math.min(1, l));
-    return this.HSLToRGB(h, s, l);
-  }
+    return ColorFunctions.HSLToRGB(h, s, l);
+  },
 
-  public RGBToHSL(r: number, g: number, b: number) {
+  RGBToHSL: (r: number, g: number, b: number) => {
 
     r /= 255;
     g /= 255;
@@ -82,9 +84,9 @@ class ColorFunctions {
     }
 
     return { h: h * 360, s, l };
-  }
+  },
 
-  public HSLToRGB(h: number, s: number, l: number) {
+  HSLToRGB: (h: number, s: number, l: number) => {
 
     let r: number;
     let g: number;
@@ -97,9 +99,9 @@ class ColorFunctions {
       h = h / 360;
       const q = l < 0.5 ? l * (1 + s) : l + s - l * s;
       const p = 2 * l - q;
-      r = this.HueToRGB(p, q, h + 1 / 3);
-      g = this.HueToRGB(p, q, h);
-      b = this.HueToRGB(p, q, h - 1 / 3);
+      r = ColorFunctions.HueToRGB(p, q, h + 1 / 3);
+      g = ColorFunctions.HueToRGB(p, q, h);
+      b = ColorFunctions.HueToRGB(p, q, h - 1 / 3);
     }
 
     return { 
@@ -107,18 +109,16 @@ class ColorFunctions {
       g: Math.round(g * 255), 
       b: Math.round(b * 255), 
     };
-  }
+  },
 
-  private HueToRGB(p: number, q: number, t: number) {
+  HueToRGB: (p: number, q: number, t: number) => {
     if (t < 0) t += 1;
     if (t > 1) t -= 1;
     if (t < 1 / 6) return p + (q - p) * 6 * t;
     if (t < 1 / 2) return q;
     if (t < 2 / 3) return p + (q - p) * (2 / 3 - t) * 6;
     return p;
-  }
+  },
 
-}
+};
 
-/** @internal */
-export const Color = new ColorFunctions();

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

@@ -19,7 +19,7 @@
  * 
  */
 
-import type { Style } from './style';
+import type { CellStyle } from './style';
 import type { SerializedValueType, ValueType } from './value-type';
 import type { IArea } from './area';
 import type { AnnotationLayout } from './layout';
@@ -57,7 +57,7 @@ export interface ImportedSheetData {
   default_column_width: number;
   column_widths: number[];
   row_heights: number[];
-  styles: Style.Properties[];
+  styles: CellStyle[];
 
   // optional, for backcompat
   sheet_style?: number;