@trebco/treb 36.1.4 → 37.0.1

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

@@ -0,0 +1,51 @@
+/** structure represents rectangle coordinates */
+export interface IRectangle {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+}
+export declare class Rectangle implements IRectangle {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    get right(): number;
+    get bottom(): number;
+    /**
+     * create a rectangle from an object that looks
+     * like a rectangle, probably a serialized object
+     */
+    static Create(obj: Partial<Rectangle>): Rectangle;
+    static IsRectangle(obj: unknown): obj is IRectangle;
+    constructor(left?: number, top?: number, width?: number, height?: number);
+    /** returns a new rect shifted from this one by (x,y) */
+    Shift(x?: number, y?: number): Rectangle;
+    Scale(scale_x?: number, scale_y?: number): Rectangle;
+    /** returns a new rect expanded from this one by (x,y) */
+    Expand(x?: number, y?: number): Rectangle;
+    /** returns a new rectangle that combines this rectangle with the argument */
+    Combine(rect: Rectangle): Rectangle;
+    /**
+     * check if rectangle contains the given coordinates, optionally with
+     * some added padding
+     */
+    Contains(x: number, y: number, padding?: number): boolean;
+    /** convenience method for canvas */
+    ContextFill(context: CanvasRenderingContext2D): void;
+    /** convenience method for canvas */
+    ContextStroke(context: CanvasRenderingContext2D): void;
+    /** clamp coordinate to rectangle */
+    Clamp(x: number, y: number): {
+        x: number;
+        y: number;
+    };
+    /** convenience method for html element style */
+    ApplyStyle(element: HTMLElement): void;
+    toJSON(): {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    };
+}

package/build/treb-base-types/src/rectangle.js

@@ -0,0 +1,123 @@
+/*
+ * 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-2026 trebco, llc.
+ * info@treb.app
+ *
+ */
+export class Rectangle {
+    left;
+    top;
+    width;
+    height;
+    get right() { return this.left + this.width; }
+    get bottom() { return this.top + this.height; }
+    /**
+     * create a rectangle from an object that looks
+     * like a rectangle, probably a serialized object
+     */
+    static Create(obj) {
+        return new Rectangle(obj.left || 0, obj.top || 0, obj.width || 0, obj.height || 0);
+    }
+    static IsRectangle(obj) {
+        return (!!obj && typeof obj === 'object') &&
+            (typeof obj.left === 'number') &&
+            (typeof obj.top === 'number') &&
+            (typeof obj.width === 'number') &&
+            (typeof obj.height === 'number');
+    }
+    constructor(left = 0, top = 0, width = 0, height = 0) {
+        this.left = left;
+        this.top = top;
+        this.width = width;
+        this.height = height;
+    }
+    /** returns a new rect shifted from this one by (x,y) */
+    Shift(x = 0, y = 0) {
+        return new Rectangle(this.left + x, this.top + y, this.width, this.height);
+    }
+    Scale(scale_x = 1, scale_y = scale_x) {
+        return new Rectangle(this.left * scale_x, this.top * scale_y, this.width * scale_x, this.height * scale_y);
+    }
+    /** returns a new rect expanded from this one by (x,y) */
+    Expand(x = 0, y = 0) {
+        return new Rectangle(this.left, this.top, this.width + x, this.height + y);
+    }
+    /** returns a new rectangle that combines this rectangle with the argument */
+    Combine(rect) {
+        return new Rectangle(Math.min(this.left, rect.left), Math.min(this.top, rect.top), Math.max(this.right, rect.right) - Math.min(this.left, rect.left), Math.max(this.bottom, rect.bottom) - Math.min(this.top, rect.top));
+    }
+    /*
+     * removing this method as part of cleaning up bitwise flags.
+     * if you need this method, rewrite it to use explicit flags.
+     *
+    public CheckEdges(x: number, y: number, border = 16): number{
+  
+      let edge = 0;
+  
+      // tslint:disable-next-line:no-bitwise
+      if (x - this.left < border) edge |= 1;
+  
+      // tslint:disable-next-line:no-bitwise
+      if (this.right - x < border) edge |= 2;
+  
+      // tslint:disable-next-line:no-bitwise
+      if (y - this.top < border) edge |= 4;
+  
+      // tslint:disable-next-line:no-bitwise
+      if (this.bottom - y < border) edge |= 8;
+  
+      return edge;
+    }
+    */
+    /**
+     * check if rectangle contains the given coordinates, optionally with
+     * some added padding
+     */
+    Contains(x, y, padding = 0) {
+        return (x >= this.left - padding)
+            && (x <= (this.left + this.width + padding))
+            && (y >= this.top - padding)
+            && (y <= (this.top + this.height + padding));
+    }
+    /** convenience method for canvas */
+    ContextFill(context) {
+        context.fillRect(this.left, this.top, this.width, this.height);
+    }
+    /** convenience method for canvas */
+    ContextStroke(context) {
+        context.strokeRect(this.left, this.top, this.width, this.height);
+    }
+    /** clamp coordinate to rectangle */
+    Clamp(x, y) {
+        x = Math.min(Math.max(x, this.left), this.right);
+        y = Math.min(Math.max(y, this.top), this.bottom);
+        return { x, y };
+    }
+    /** convenience method for html element style */
+    ApplyStyle(element) {
+        element.style.top = this.top + 'px';
+        element.style.left = this.left + 'px';
+        element.style.width = this.width + 'px';
+        element.style.height = this.height + 'px';
+    }
+    toJSON() {
+        return {
+            top: this.top, left: this.left, width: this.width, height: this.height,
+        };
+    }
+}
+//# sourceMappingURL=rectangle.js.map

package/build/treb-base-types/src/rectangle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rectangle.js","sourceRoot":"","sources":["../../../treb-base-types/src/rectangle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAUH,MAAM,OAAO,SAAS;IAyBC;IACA;IACA;IACA;IA1BrB,IAAW,KAAK,KAAa,OAAO,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAuB;QAC1C,OAAO,IAAI,SAAS,CAClB,GAAG,CAAC,IAAI,IAAI,CAAC,EACb,GAAG,CAAC,GAAG,IAAI,CAAC,EACZ,GAAG,CAAC,KAAK,IAAI,CAAC,EACd,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,GAAY;QACpC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;YACvC,CAAC,OAAQ,GAA+B,CAAC,IAAI,KAAK,QAAQ,CAAC;YAC3D,CAAC,OAAQ,GAA+B,CAAC,GAAG,KAAK,QAAQ,CAAC;YAC1D,CAAC,OAAQ,GAA+B,CAAC,KAAK,KAAK,QAAQ,CAAC;YAC5D,CAAC,OAAQ,GAA+B,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED,YAAqB,OAAO,CAAC,EACR,MAAM,CAAC,EACP,QAAQ,CAAC,EACT,SAAS,CAAC;QAHV,SAAI,GAAJ,IAAI,CAAI;QACR,QAAG,GAAH,GAAG,CAAI;QACP,UAAK,GAAL,KAAK,CAAI;QACT,WAAM,GAAN,MAAM,CAAI;IAAG,CAAC;IAEnC,wDAAwD;IACjD,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC;QACvB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAE,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO;QACzC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC,GAAG,GAAG,OAAO,EAAE,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;IAC7G,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC;QACxB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC;IAC9E,CAAC;IAED,6EAA6E;IACtE,OAAO,CAAC,IAAe;QAC5B,OAAO,IAAI,SAAS,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EACjE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;MAsBE;IAEF;;;OAGG;IACI,QAAQ,CAAC,CAAS,EAAE,CAAS,EAAE,OAAO,GAAG,CAAC;QAC/C,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;eAC5B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC;eACzC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC;eACzB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,oCAAoC;IAC7B,WAAW,CAAC,OAAiC;QAClD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,oCAAoC;IAC7B,aAAa,CAAC,OAAiC;QACpD,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,oCAAoC;IAC7B,KAAK,CAAC,CAAS,EAAE,CAAS;QAC/B,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACjD,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAClB,CAAC;IAED,gDAAgD;IACzC,UAAU,CAAC,OAAoB;QACpC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACtC,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACxC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAC5C,CAAC;IAEM,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM;SACvE,CAAC;IACJ,CAAC;CAEF"}

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

@@ -0,0 +1,34 @@
+/**
+ * information about a rendered substring. FIXME: move this somewhere else
+ *
+ * FIXME: there's a lot of overlap between this and "TextPartFlag", which
+ * comes from base types and is used by formatter. can we consolidate these?
+ *
+ * testing some inline markdown...
+ * FIXME: gate on option? sheet option? (...)
+ *
+ */
+export interface RenderTextPart {
+    text: string;
+    hidden: boolean;
+    width: number;
+    top?: number;
+    left?: number;
+    height?: number;
+    strong?: boolean;
+    emphasis?: boolean;
+    strike?: boolean;
+    indent?: boolean;
+}
+export interface PreparedText {
+    /**
+     * strings now represents parts of individual lines; this both supports
+     * MD and unifies the old system where it meant _either_ parts _or_ lines,
+     * which was super confusing.
+     */
+    strings: RenderTextPart[][];
+    /** this is the max rendered width. individual components have their own width */
+    width: number;
+    /** possibly override format; this is used for number formats that have [color] */
+    format?: string;
+}

package/build/treb-base-types/src/render_text.js

@@ -0,0 +1,22 @@
+/*
+ * 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-2026 trebco, llc.
+ * info@treb.app
+ *
+ */
+export {};
+//# sourceMappingURL=render_text.js.map

package/build/treb-base-types/src/render_text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render_text.js","sourceRoot":"","sources":["../../../treb-base-types/src/render_text.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG"}

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

@@ -0,0 +1,214 @@
+import type { Theme } from './theme';
+/** horizontal align constants for cell style */
+export type HorizontalAlign = '' | 'left' | 'center' | 'right';
+/** vertical align constants for cell style */
+export type VerticalAlign = '' | 'top' | 'bottom' | 'middle';
+export type ThemeColorType = 'Background' | 'Text' | 'Background2' | 'Text2' | 'Accent' | 'Accent2' | 'Accent3' | 'Accent4' | 'Accent5' | 'Accent6';
+export declare const ThemeColorIndex: (color: ThemeColor) => number;
+/**
+ * font size for cell style. we generally prefer relative sizes
+ * (percent or em) because they are relative to the default theme
+ * size, which might be different on different platforms.
+ */
+export interface FontSize {
+    unit: 'pt' | 'px' | 'em' | '%';
+    value: number;
+}
+export interface HTMLColor {
+    text: string;
+    /** @internal */
+    offset?: Color;
+}
+export interface ThemeColor {
+    theme: number | ThemeColorType;
+    tint?: number;
+    /** @internal */
+    offset?: Color;
+}
+export interface NullColor {
+    /** @internal */
+    offset?: Color;
+}
+export type Color = ThemeColor | HTMLColor | NullColor;
+export declare const IsHTMLColor: (color?: Color) => color is HTMLColor;
+export declare const IsThemeColor: (color?: Color) => color is ThemeColor;
+export declare const IsDefinedColor: (color?: Color) => color is (ThemeColor | HTMLColor);
+/** @internal */
+export interface CompositeBorderEdge {
+    width: number;
+    color: Color;
+}
+/** @internal */
+export interface CompositeBorder {
+    top: CompositeBorderEdge;
+    left: CompositeBorderEdge;
+    right: CompositeBorderEdge;
+    bottom: CompositeBorderEdge;
+}
+/**
+ * style properties applied to a single cell, row, column, or sheet.
+ * when rendering a cell, we composite all styles that might apply.
+ */
+export interface CellStyle {
+    /** horizontal align defaults to left */
+    horizontal_align?: HorizontalAlign;
+    /** vertical align defaults to bottom */
+    vertical_align?: VerticalAlign;
+    /** representation for NaN */
+    nan?: string;
+    /** number format, either a symbolic name like "General" or a format string */
+    number_format?: string;
+    /** wrap text */
+    wrap?: boolean;
+    /**
+     * font size. we recommend using relative font sizes (either % or em)
+     * which will be relative to the theme font size.
+     */
+    font_size?: FontSize;
+    /** font face. this can be a comma-delimited list, like CSS */
+    font_face?: string;
+    /** flag */
+    bold?: boolean;
+    /** flag */
+    italic?: boolean;
+    /** flag */
+    underline?: boolean;
+    /** flag */
+    strike?: boolean;
+    /** border weight */
+    border_top?: number;
+    /** border weight */
+    border_right?: number;
+    /** border weight */
+    border_left?: number;
+    /** border weight */
+    border_bottom?: number;
+    /** text color */
+    text?: Color;
+    /** background color */
+    fill?: Color;
+    /** border color */
+    border_top_fill?: Color;
+    /** border color */
+    border_left_fill?: Color;
+    /** border color */
+    border_right_fill?: Color;
+    /** border color */
+    border_bottom_fill?: Color;
+    /** text indent */
+    indent?: number;
+    /**
+     * cell is locked for editing
+     *
+     * @privateRemarks
+     *
+     * this should properly be in cell, not style -- but we keep
+     * it here so it can cascade like other styles.
+     *
+     */
+    locked?: boolean;
+}
+/**
+ * @internal
+ *
+ * starting on data bars, but there might be other conditional
+ * stuff we want to tack on to standard styles.
+ *
+ */
+export type ExtendedCelLStyle = CellStyle & {
+    databar?: {
+        fill: Color;
+        negative?: Color;
+        hide_values?: boolean;
+        value: number;
+        zero: number;
+    };
+};
+/** @internal */
+export type PropertyKeys = keyof CellStyle;
+/**
+ * (finally) removing the old namespace. we keep this object around for
+ * some internal methods, but all the types have moved to the top-level
+ * of this module and need to be imported separately.
+ *
+ * we could theoretically build a backcompat module that re-exports all
+ * the types, but it's probably not necessary -- most updates will just
+ * require a find-and-replace (plus adding some imports).
+ *
+ * @internal
+ */
+export declare const Style: {
+    /**
+     * note that there are no default colors; those should be set
+     * in grid when style is applied. that way the default colors for
+     * border, text and background colors will be theme-dependent and
+     * can change.
+     *
+     * @internal
+     */
+    DefaultProperties: CellStyle;
+    /**
+     * this is a utility function for callers that use borders, to
+     * reduce testing and facilitate reusable methods
+     *
+     * @internal
+     */
+    CompositeBorders: (style: CellStyle) => CompositeBorder;
+    Serialize: (style: CellStyle) => string;
+    /**
+     * merge. returns a new object, does not update dest in place.
+     * NOTE: if it does not update dest in place, then what would be
+     * the use case for a non-delta merge? (...)
+     *
+     * @internal
+     */
+    Merge: (dest: CellStyle, src: CellStyle, delta?: boolean) => CellStyle;
+    /** @internal */
+    Composite: (list: CellStyle[]) => CellStyle;
+    /** @internal */
+    Empty: (style: CellStyle) => boolean;
+    /** @internal */
+    ParseFontSize: (text?: string, default_unit?: string) => CellStyle;
+    /**
+     * returns the font size of the properties argument as a ratio of the
+     * base argument. this is intended to show the relative font size of
+     * a spreadsheet cell; so anything with no value should be "1", and
+     * everything else is relative to that.
+     *
+     * we prefer relative sizes (em, essentially) to fixed sizes because
+     * we may have different base font sizes on different platforms (we do,
+     * in fact, on windows because calibri is too small).
+     *
+     * using relative sizes helps ensure that it looks similar, if not
+     * identical, on different platforms.
+     *
+     * @internal
+     */
+    RelativeFontSize: (properties: CellStyle, base: CellStyle) => number;
+    /**
+     * @internal
+     */
+    FontSize: (properties: CellStyle, prefer_points?: boolean) => string;
+    /**
+     * @internal
+     *
+     * generate a font size based on a base size (hopefully in actual units)
+     * and a relative size (em, %, or possibly a static unit). also optionally
+     * apply a scale.
+     *
+     */
+    CompositeFontSize: (base: FontSize, relative: FontSize, scale?: number, prefer_points?: boolean) => FontSize;
+    /**
+     * return a font string suitable for canvas. because our font sizes are
+     * (probably) in ems, we need a base size to bounce off.
+     */
+    CompositeFont: (base: FontSize, properties: CellStyle, scale: number, theme: Theme) => {
+        font: string;
+        variants: string | undefined;
+        base: FontSize;
+        size: FontSize | undefined;
+        scale: number;
+        stack_size: FontSize | undefined;
+        font_size: FontSize | undefined;
+    };
+};