@trebco/treb 37.0.0 → 37.1.0

package/build/treb-data-model/src/index.js

@@ -0,0 +1,28 @@
+/*
+ * 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 { DataModel } from './data_model';
+export { Sheet } from './sheet';
+export * from './conditional_format';
+export { Annotation } from './annotation';
+export * from './data-validation';
+export * from './types';
+export * from './language-model';
+//# sourceMappingURL=index.js.map

package/build/treb-data-model/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../treb-data-model/src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,cAAc,sBAAsB,CAAC;AAIrC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC"}

package/build/treb-data-model/src/language-model.d.ts

@@ -0,0 +1,22 @@
+/**
+ * this is similar to a function descriptor, but we need a lot less
+ * information. not sure if we should composite them.
+ */
+export interface TranslatedFunctionDescriptor {
+    /** original name (name in english), so we know what to replace. */
+    base: string;
+    /** name (localized) */
+    name: string;
+    /** description, if we have it. if not, show the english description? or nothing? dunno  */
+    description?: string;
+    /** argument names only */
+    arguments?: string[];
+}
+export interface LanguageModel {
+    name: string;
+    version?: string;
+    locale?: string;
+    functions?: TranslatedFunctionDescriptor[];
+    boolean_true?: string;
+    boolean_false?: string;
+}

package/build/treb-data-model/src/language-model.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=language-model.js.map

package/build/treb-data-model/src/language-model.js.map

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

package/build/treb-data-model/src/named.d.ts

@@ -0,0 +1,124 @@
+import { Area } from 'treb-base-types';
+import type { IArea } from 'treb-base-types';
+import type { ExpressionUnit, Parser } from 'treb-parser';
+interface NamedExpression {
+    type: 'expression';
+    expression: ExpressionUnit;
+}
+interface NamedRange {
+    type: 'range';
+    area: Area;
+}
+/** @internal */
+export type Named = (NamedExpression | NamedRange) & {
+    name: string;
+    scope?: number;
+};
+/**
+ * serialized type is a composite of expression/range. we determine
+ * what it is when parsing the expression. this simplifies passing these
+ * things around.
+ *
+ * (named expressions and ranges they have slightly different behavior,
+ * which is why we have a distinction at all).
+ *
+ */
+export interface SerializedNamed {
+    name: string;
+    /** expression or address/area */
+    expression: string;
+    /** scope is a sheet name (not ID) */
+    scope?: string;
+    /**
+     * adding type. this is optional, it's not used by tooling. it's
+     * just for informational purpopses for clients.
+     */
+    type?: 'range' | 'expression';
+}
+/**
+ * this is a replacement for the name manager, which handles
+ * operations relating to named ranges.
+ */
+export declare class NamedRangeManager {
+    parser: Parser;
+    /**
+     * this map is stored with normalized names. normalized names
+     * here means we call `toLowerCase`. the objects themselves
+     * contain canonical names.
+     *
+     * ...we've always had a map for this, for fast lookups. but
+     * with scoping, we can't necessarily look up by name. let's try
+     * using scope:name keys. that way we can search for scope:name
+     * and then name and return the first match, if any.
+     *
+     */
+    protected named: Map<string, Named>;
+    get list(): MapIterator<Named>;
+    constructor(parser: Parser);
+    /** shorthand for setting named expression */
+    SetNamedExpression(name: string, expression: ExpressionUnit, scope?: number): boolean;
+    /** shorthand for setting named range */
+    SetNamedRange(name: string, area: IArea, scope?: number): boolean;
+    /**
+     * add name. names are case-insensitive. if the name already
+     * exists, it will be overwritten.
+     *
+     * update: returns success (FIXME: proper errors)
+     */
+    private SetName;
+    private ScopedName;
+    ClearName(name: string, scope?: number): void;
+    /**
+     * if we delete a sheet, remove ranges in that sheet. also remove
+     * anything that's scoped to the sheet.
+     */
+    RemoveRangesForSheet(sheet_id: number): void;
+    Reset(): void;
+    /**
+     * requiring scope to help propgogate changes. we check the scoped
+     * version first; if that's not found, we default to the global version.
+     * that implies that if there are both, we'll prefer the scoped name.
+     *
+     * now possible to require scope, for qualified scoped names
+     *
+     * Q: why require scope? what's the benefit of that? (...)
+     *
+     */
+    Get_(name: string, scope: number, require_scope?: boolean): Named | undefined;
+    /**
+     * named range rules:
+     *
+     * - legal characters are alphanumeric, underscore and dot.
+     *
+     * - must start with letter or underscore (not a number or dot).
+     *   UPDATE: also possibly a backslash? not sure if that's escaping or not.
+     *
+     * - cannot look like a spreadsheet address, which is 1-3 letters followed by numbers.
+     *   UPDATE: actually this is legal if the number is "0". that's the only
+     *   number. I don't think our parser will process this correctly, so until
+     *   then keep it illegal.
+     *
+     * - apparently questuon marks are legal, but not in first position. atm
+     *   our parser will reject.
+     *
+     * - FIXME: we should block R1C1-looking notation as well
+     *
+     * returns a normalized name (just caps, atm)
+     */
+    ValidateNamed(name: string): string | false;
+    /**
+     * match an area, optionally a target within a larger area (for selections).
+     * we don't use the selection directly, as we may need to adjust target for
+     * merge area. returns the name only if the area is an exact match.
+     */
+    MatchSelection(area: Area, target?: Area): string | undefined;
+    /**
+     * fix named range references after row/column insert/delete
+     *
+     * surely there's overlap between this function and what we do in
+     * grid when columns are added/removed. can we consolidate? (FIXME/TODO)
+     *
+     */
+    PatchNamedRanges(sheet_id: number, before_column: number, column_count: number, before_row: number, row_count: number): void;
+}
+export {};

package/build/treb-data-model/src/named.js

@@ -0,0 +1,372 @@
+/*
+ * 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
+ *
+ */
+import { Area } from 'treb-base-types';
+/**
+ * this is a replacement for the name manager, which handles
+ * operations relating to named ranges.
+ */
+export class NamedRangeManager {
+    parser;
+    /**
+     * this map is stored with normalized names. normalized names
+     * here means we call `toLowerCase`. the objects themselves
+     * contain canonical names.
+     *
+     * ...we've always had a map for this, for fast lookups. but
+     * with scoping, we can't necessarily look up by name. let's try
+     * using scope:name keys. that way we can search for scope:name
+     * and then name and return the first match, if any.
+     *
+     */
+    named = new Map();
+    get list() {
+        return this.named.values();
+    }
+    constructor(parser) {
+        this.parser = parser;
+    }
+    /** shorthand for setting named expression */
+    SetNamedExpression(name, expression, scope) {
+        return this.SetName({
+            type: 'expression',
+            name,
+            expression,
+            scope,
+        });
+    }
+    /** shorthand for setting named range */
+    SetNamedRange(name, area, scope) {
+        return this.SetName({
+            type: 'range',
+            name,
+            area: new Area(area.start, area.end),
+            scope,
+        });
+    }
+    /**
+     * add name. names are case-insensitive. if the name already
+     * exists, it will be overwritten.
+     *
+     * update: returns success (FIXME: proper errors)
+     */
+    SetName(named) {
+        const name = named.name;
+        // console.info('set name', named.name, {named});
+        const validated = this.ValidateNamed(name);
+        if (!validated) {
+            console.warn('invalid name', { name });
+            return false;
+        }
+        /*
+    
+        if (named.type === 'range') {
+    
+          // why is this considered invalid here? I've seen it done.
+          // maybe something we're doing with these ranges doesn't
+          // collapse them? (...)
+    
+          if (named.area.entire_column || named.area.entire_row) {
+            console.info({named});
+            console.warn('invalid range');
+            return false;
+          }
+    
+        }
+    
+        */
+        // this.named.set(name.toLowerCase(), named);
+        this.named.set(this.ScopedName(name, named.scope), named);
+        return true;
+    }
+    ScopedName(name, scope) {
+        if (typeof scope === 'number') {
+            return scope + ':' + name.toLowerCase();
+        }
+        return name.toLowerCase();
+    }
+    ClearName(name, scope) {
+        if (typeof scope === 'number') {
+            this.named.delete(this.ScopedName(name, scope));
+        }
+        else {
+            this.named.delete(name.toLowerCase());
+        }
+    }
+    /**
+     * if we delete a sheet, remove ranges in that sheet. also remove
+     * anything that's scoped to the sheet.
+     */
+    RemoveRangesForSheet(sheet_id) {
+        const remove = [];
+        for (const [name, entry] of this.named) {
+            if (entry.type === 'range' && entry.area.start.sheet_id === sheet_id) {
+                remove.push(name);
+            }
+            else if (entry.scope === sheet_id) {
+                remove.push(name);
+            }
+        }
+        for (const name of remove) {
+            this.named.delete(name);
+        }
+    }
+    Reset() {
+        this.named.clear();
+    }
+    /**
+     * requiring scope to help propgogate changes. we check the scoped
+     * version first; if that's not found, we default to the global version.
+     * that implies that if there are both, we'll prefer the scoped name.
+     *
+     * now possible to require scope, for qualified scoped names
+     *
+     * Q: why require scope? what's the benefit of that? (...)
+     *
+     */
+    Get_(name, scope, require_scope = false) {
+        if (require_scope) {
+            return this.named.get(this.ScopedName(name, scope));
+        }
+        return this.named.get(this.ScopedName(name, scope)) ?? this.named.get(name.toLowerCase());
+    }
+    /**
+     * named range rules:
+     *
+     * - legal characters are alphanumeric, underscore and dot.
+     *
+     * - must start with letter or underscore (not a number or dot).
+     *   UPDATE: also possibly a backslash? not sure if that's escaping or not.
+     *
+     * - cannot look like a spreadsheet address, which is 1-3 letters followed by numbers.
+     *   UPDATE: actually this is legal if the number is "0". that's the only
+     *   number. I don't think our parser will process this correctly, so until
+     *   then keep it illegal.
+     *
+     * - apparently questuon marks are legal, but not in first position. atm
+     *   our parser will reject.
+     *
+     * - FIXME: we should block R1C1-looking notation as well
+     *
+     * returns a normalized name (just caps, atm)
+     */
+    ValidateNamed(name) {
+        // normalize
+        name = name.trim().toUpperCase();
+        // can't be empty
+        if (!name.length)
+            return false;
+        // can only contain legal characters [FIXME: backslash is legal?]
+        if (/[^A-Z\d_.?]/.test(name))
+            return false;
+        // must start with ascii letter or underscore
+        if (/^[^A-Z_]/.test(name))
+            return false;
+        // these are not legal for some reason -- they look like R1C1?
+        if (name === 'R' || name === 'C') {
+            return false;
+        }
+        // FIXME: should we just use a parser? we're adding more and more regexes.
+        // can't look like a spreadsheet address, unless the row is === 0
+        if (/^[A-Z]{1,3}[1-9]\d*$/.test(name))
+            return false;
+        // can't look like R1C1 either (we already checked for R and C)
+        if (/^R[[\]\d]+C/.test(name)) {
+            return false;
+        }
+        return name;
+    }
+    /**
+     * match an area, optionally a target within a larger area (for selections).
+     * we don't use the selection directly, as we may need to adjust target for
+     * merge area. returns the name only if the area is an exact match.
+     */
+    MatchSelection(area, target) {
+        if (!area.start.sheet_id) {
+            throw new Error('match selection without sheet id');
+        }
+        let label;
+        for (const entry of this.named.values()) {
+            if (entry.type === 'range') {
+                if (entry.area.start.sheet_id === area.start.sheet_id) {
+                    if (area.Equals(entry.area)) {
+                        label = entry.name; // don't break, in case there's a match for target which takes precendence.
+                    }
+                    if (target?.Equals(entry.area)) {
+                        return entry.name;
+                    }
+                }
+            }
+        }
+        return label;
+    }
+    /**
+     * fix named range references after row/column insert/delete
+     *
+     * surely there's overlap between this function and what we do in
+     * grid when columns are added/removed. can we consolidate? (FIXME/TODO)
+     *
+     */
+    PatchNamedRanges(sheet_id, before_column, column_count, before_row, row_count) {
+        const copy = [...this.list];
+        for (const entry of copy) {
+            if (entry.type === 'expression') {
+                continue;
+            }
+            const key = entry.name;
+            const range = entry.area;
+            if (range.start.sheet_id !== sheet_id) {
+                console.info('skipping name', key);
+                continue;
+            }
+            if (column_count && before_column <= range.end.column) {
+                /*
+                // (1) we are before the insert point, not affected
+        
+                if (before_column > range.end.column) {
+                  continue;
+                }
+                */
+                if (column_count > 0) {
+                    // (2) it's an insert and we are past the insert point:
+                    //     increment [start] and [end] by [count]
+                    if (before_column <= range.start.column) {
+                        range.Shift(0, column_count);
+                    }
+                    // (3) it's an insert and we contain the insert point:
+                    //     increment [end] by [count]
+                    else if (before_column > range.start.column && before_column <= range.end.column) {
+                        range.ConsumeAddress({ row: range.end.row, column: range.end.column + column_count });
+                    }
+                    else {
+                        console.warn(`PNR X case 1`, before_column, column_count, JSON.stringify(range));
+                    }
+                }
+                else if (column_count < 0) {
+                    // (4) it's a delete and we are past the delete point (before+count):
+                    //     decrement [start] and [end] by [count]
+                    if (before_column - column_count <= range.start.column) {
+                        range.Shift(0, column_count);
+                    }
+                    // (5) it's a delete and contains the entire range
+                    else if (before_column <= range.start.column && before_column - column_count > range.end.column) {
+                        this.ClearName(key);
+                    }
+                    // (6) it's a delete and contains part of the range. clip the range.
+                    else if (before_column <= range.start.column) {
+                        const last_column = before_column - column_count - 1;
+                        this.SetName({
+                            type: 'range', area: new Area({
+                                row: range.start.row, column: last_column + 1 + column_count, sheet_id
+                            }, {
+                                row: range.end.row, column: range.end.column + column_count
+                            }), name: key,
+                        });
+                    }
+                    else if (before_column <= range.end.column) {
+                        const last_column = before_column - column_count - 1;
+                        if (last_column >= range.end.column) {
+                            this.SetName({ type: 'range', area: new Area({
+                                    row: range.start.row, column: range.start.column, sheet_id
+                                }, {
+                                    row: range.end.row, column: before_column - 1
+                                }), name: key });
+                        }
+                        else {
+                            this.SetName({ type: 'range', name: key, area: new Area({
+                                    row: range.start.row, column: range.start.column, sheet_id
+                                }, {
+                                    row: range.end.row, column: range.start.column + range.columns + column_count - 1
+                                }) });
+                        }
+                    }
+                    else {
+                        console.warn(`PNR X case 2`, before_column, column_count, JSON.stringify(range));
+                    }
+                }
+            }
+            if (row_count && before_row <= range.end.row) {
+                /*
+                // (1) we are before the insert point, not affected
+        
+                if (before_row > range.end.row) {
+                  continue;
+                }
+                */
+                if (row_count > 0) {
+                    // (2) it's an insert and we are past the insert point:
+                    //     increment [start] and [end] by [count]
+                    if (before_row <= range.start.row) {
+                        range.Shift(row_count, 0);
+                    }
+                    // (3) it's an insert and we contain the insert point:
+                    //     increment [end] by [count]
+                    else if (before_row > range.start.row && before_row <= range.end.row) {
+                        range.ConsumeAddress({ row: range.end.row + row_count, column: range.end.column });
+                    }
+                    else {
+                        console.warn(`PNR X case 3`, before_row, row_count, JSON.stringify(range));
+                    }
+                }
+                else if (row_count < 0) {
+                    // (4) it's a delete and we are past the delete point (before+count):
+                    //     decrement [start] and [end] by [count]
+                    if (before_row - row_count <= range.start.row) {
+                        range.Shift(row_count, 0);
+                    }
+                    // (5) it's a delete and contains the entire range
+                    else if (before_row <= range.start.row && before_row - row_count > range.end.row) {
+                        this.ClearName(key);
+                    }
+                    // (6) it's a delete and contains part of the range. clip the range.
+                    else if (before_row <= range.start.row) {
+                        const last_row = before_row - row_count - 1;
+                        this.SetNamedRange(key, new Area({
+                            column: range.start.column, row: last_row + 1 + row_count, sheet_id
+                        }, {
+                            column: range.end.column, row: range.end.row + row_count
+                        }));
+                    }
+                    else if (before_row <= range.end.row) {
+                        const last_row = before_row - row_count - 1;
+                        if (last_row >= range.end.row) {
+                            this.SetNamedRange(key, new Area({
+                                column: range.start.column, row: range.start.row, sheet_id
+                            }, {
+                                column: range.end.column, row: before_row - 1
+                            }));
+                        }
+                        else {
+                            this.SetNamedRange(key, new Area({
+                                column: range.start.column, row: range.start.row, sheet_id
+                            }, {
+                                column: range.end.column, row: range.start.row + range.rows + row_count - 1
+                            }));
+                        }
+                    }
+                    else {
+                        console.warn(`PNR X case 4`, before_row, row_count, JSON.stringify(range));
+                    }
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=named.js.map

package/build/treb-data-model/src/named.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"named.js","sourceRoot":"","sources":["../../../treb-data-model/src/named.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AA+CvC;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAmBT;IAjBnB;;;;;;;;;;OAUG;IACO,KAAK,GAAuB,IAAI,GAAG,EAAE,CAAC;IAEhD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED,YAAmB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAErC,6CAA6C;IACtC,kBAAkB,CAAC,IAAY,EAAE,UAA0B,EAAE,KAAc;QAChF,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,IAAI,EAAE,YAAY;YAClB,IAAI;YACJ,UAAU;YACV,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,wCAAwC;IACjC,aAAa,CAAC,IAAY,EAAE,IAAW,EAAE,KAAc;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,IAAI,EAAE,OAAO;YACb,IAAI;YACJ,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC;YACpC,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,OAAO,CAAC,KAAY;QAE1B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,iDAAiD;QAEjD,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAC,IAAI,EAAC,CAAC,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QAED;;;;;;;;;;;;;;;;UAgBE;QAEF,6CAA6C;QAC7C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QAE1D,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,UAAU,CAAC,IAAY,EAAE,KAAc;QAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,SAAS,CAAC,IAAY,EAAE,KAAc;QAE3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAClD,CAAC;aACI,CAAC;YACJ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,QAAgB;QAE1C,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACvC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACrE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;iBACI,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;IAEH,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;;;OASG;IACI,IAAI,CAAC,IAAY,EAAE,KAAa,EAAE,aAAa,GAAG,KAAK;QAE5D,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACtD,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,aAAa,CAAC,IAAY;QAE/B,YAAY;QACZ,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAEjC,iBAAiB;QACjB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE/B,iEAAiE;QACjE,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAE3C,6CAA6C;QAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAExC,8DAA8D;QAC9D,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,0EAA0E;QAE1E,iEAAiE;QACjE,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAEpD,+DAA+D;QAC/D,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IAEd,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAU,EAAE,MAAa;QAE7C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,KAAuB,CAAC;QAE5B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACtD,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC5B,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,2EAA2E;oBACjG,CAAC;oBACD,IAAI,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC/B,OAAO,KAAK,CAAC,IAAI,CAAC;oBACpB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IAEf,CAAC;IAGD;;;;;;OAMG;IACI,gBAAgB,CAAC,QAAgB,EAAE,aAAqB,EAAE,YAAoB,EAAE,UAAkB,EAAE,SAAiB;QAE1H,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5B,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YAEzB,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAChC,SAAS;YACX,CAAC;YAED,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;YACvB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAEzB,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACtC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;gBACnC,SAAS;YACX,CAAC;YAED,IAAI,YAAY,IAAI,aAAa,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;gBAEtD;;;;;;kBAME;gBAEF,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBAErB,uDAAuD;oBACvD,6CAA6C;oBAE7C,IAAI,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBACxC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;oBAC/B,CAAC;oBAED,sDAAsD;oBACtD,iCAAiC;yBAE5B,IAAI,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,aAAa,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;wBACjF,KAAK,CAAC,cAAc,CAAC,EAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,YAAY,EAAC,CAAC,CAAC;oBACtF,CAAC;yBAEI,CAAC;wBACJ,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBACnF,CAAC;gBAEH,CAAC;qBACI,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBAE1B,qEAAqE;oBACrE,6CAA6C;oBAE7C,IAAI,aAAa,GAAG,YAAY,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBACvD,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;oBAC/B,CAAC;oBAED,kDAAkD;yBAE7C,IAAI,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,aAAa,GAAG,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;wBAChG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACtB,CAAC;oBAED,oEAAoE;yBAE/D,IAAI,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;wBAC7C,MAAM,WAAW,GAAG,aAAa,GAAG,YAAY,GAAG,CAAC,CAAC;wBACrD,IAAI,CAAC,OAAO,CAAC;4BACX,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC;gCAC9B,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,GAAG,CAAC,GAAG,YAAY,EAAE,QAAQ;6BAAE,EAAE;gCACxE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,YAAY;6BAAE,CAAC,EAAE,IAAI,EAAE,GAAG;yBAAG,CAAC,CAAC;oBACpF,CAAC;yBAEI,IAAI,aAAa,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;wBAC3C,MAAM,WAAW,GAAG,aAAa,GAAG,YAAY,GAAG,CAAC,CAAC;wBAErD,IAAI,WAAW,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;4BACpC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC;oCAC3C,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ;iCAAE,EAAE;oCAC5D,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAG,CAAC;iCAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;wBACrE,CAAC;6BACI,CAAC;4BACJ,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC;oCACtD,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ;iCAAE,EAAE;oCAC5D,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,OAAO,GAAG,YAAY,GAAG,CAAC;iCAAC,CAAC,EAAC,CAAC,CAAC;wBAC5F,CAAC;oBAEH,CAAC;yBAEI,CAAC;wBACJ,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBACnF,CAAC;gBAEH,CAAC;YACH,CAAC;YAGD,IAAI,SAAS,IAAI,UAAU,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAE7C;;;;;;kBAME;gBAEF,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;oBAElB,uDAAuD;oBACvD,6CAA6C;oBAE7C,IAAI,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;wBAClC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;oBAC5B,CAAC;oBAED,sDAAsD;oBACtD,iCAAiC;yBAE5B,IAAI,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,UAAU,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;wBACrE,KAAK,CAAC,cAAc,CAAC,EAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAC,CAAC,CAAC;oBACnF,CAAC;yBAEI,CAAC;wBACJ,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7E,CAAC;gBAEH,CAAC;qBACI,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;oBAEvB,qEAAqE;oBACrE,6CAA6C;oBAE7C,IAAI,UAAU,GAAG,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;wBAC9C,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;oBAC5B,CAAC;oBAED,kDAAkD;yBAE7C,IAAI,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,UAAU,GAAG,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;wBACjF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACtB,CAAC;oBAED,oEAAoE;yBAE/D,IAAI,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;wBACvC,MAAM,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;wBAC5C,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC;4BAC/B,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,GAAG,SAAS,EAAE,QAAQ;yBAAE,EAAE;4BACrE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,SAAS;yBAAE,CAAC,CAAC,CAAC;oBACnE,CAAC;yBAEI,IAAI,UAAU,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;wBACrC,MAAM,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;wBAC5C,IAAI,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;4BAC9B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC;gCAC/B,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ;6BAAE,EAAE;gCAC5D,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,CAAC;6BAAE,CAAC,CAAC,CAAC;wBACxD,CAAC;6BACI,CAAC;4BACJ,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC;gCAC/B,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ;6BAAE,EAAE;gCAC5D,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,GAAG,SAAS,GAAG,CAAC;6BAAE,CAAC,CAAC,CAAC;wBACtF,CAAC;oBAEH,CAAC;yBAEI,CAAC;wBACJ,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7E,CAAC;gBAEH,CAAC;YACH,CAAC;QAEH,CAAC;IAEH,CAAC;CAEF"}

package/build/treb-data-model/src/serialize_options.d.ts

@@ -0,0 +1,49 @@
+/**
+ * options for serializing data
+ *
+ * @privateRemarks
+ * essentially a placeholder for options; we only have one at the moment.
+ *
+ * note that the underlying cells container has its own set of options. we
+ * are explicitly not using that so we can add things that are beyond that
+ * scope.
+ *
+ * still, we might just wrap that object [FIXME/TODO].
+ */
+export interface SerializeOptions {
+    /** optimize for size */
+    optimize?: 'size' | 'speed';
+    /** include the rendered/calculated value in export */
+    rendered_values?: boolean;
+    /**
+     * preserve cell type
+     * @internal
+     */
+    preserve_type?: boolean;
+    /**
+     * expand arrays so cells have individual values
+     * @internal
+     */
+    expand_arrays?: boolean;
+    /** translate colors to xlsx-friendly values */
+    export_colors?: boolean;
+    /** export cells that have no value, but have a border or background color */
+    decorated_cells?: boolean;
+    /** prune unused rows/columns */
+    shrink?: boolean;
+    /**
+     * include tables. tables will be serialized in the model, so we can
+     * drop them from cells. but you can leave them in if that's useful.
+     */
+    tables?: boolean;
+    /** share resources (images, for now) to prevent writing data URIs more than once */
+    share_resources?: boolean;
+    /**
+     * if a function has an export() handler, call that
+     */
+    export_functions?: boolean;
+    /**
+     * @internal
+     */
+    apply_row_pattern?: boolean;
+}

package/build/treb-data-model/src/serialize_options.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=serialize_options.js.map

package/build/treb-data-model/src/serialize_options.js.map

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