@rowsncolumns/spreadsheet 10.2.68

package/dist/esm/helpers.d.ts

@@ -0,0 +1,118 @@
+import type { CellInterface, GridRange } from "@rowsncolumns/grid";
+import type { CellTooltipVariants } from "@rowsncolumns/ui";
+import type { AXIS, Border, CellData, Color, ConditionType, ConditionValue, FilterSpec, FilterView, HorizontalAlign, Sheet, SheetCoordinate, SheetRange, SortOrder, StructuredValue, StyleReference, TableTheme, TableView, VerticalAlign } from "./types";
+export declare const isFirefox: boolean;
+export declare const pointToPixel: (pt: number) => number;
+export declare const pixelToPoint: (px: number) => number;
+/**
+ * Normalize text for display by replacing newlines with spaces.
+ * Excel displays newlines as spaces unless wrapText is enabled in the cell style.
+ * This ensures consistent rendering and width calculation.
+ */
+export declare const normalizeDisplayText: (text: string | undefined, shouldWrap: boolean) => string | undefined;
+/**
+ * Converts border style to dash array
+ * @param style
+ * @returns
+ */
+export declare const convertBorderStyleToDashArray: (style: Border["style"] | undefined) => number[] | undefined;
+/**
+ * Converts border thickness to value
+ * @param style
+ * @returns
+ */
+export declare const convertThicknessStyleToScaleFactor: (style: Border["style"] | undefined) => 2 | 1 | 1.5;
+/**
+ * Create a new empty sheet
+ * @param sheetId
+ * @param title
+ * @returns
+ */
+export declare const createNewSheet: (sheetId: number, title: string, rowCount?: number, columnCount?: number, hidden?: boolean) => Sheet;
+/**
+ * Check if the current cell is header cell
+ * @param cell
+ * @returns
+ */
+export declare const isHeaderCell: (cell: CellInterface) => boolean;
+/**
+ * Get flex justify property from vertical alignment
+ * @param verticalAlignment
+ * @returns
+ */
+export declare const getJustifyPropertyFromAlignment: (verticalAlignment: VerticalAlign | undefined, defaultValue: string | undefined) => string | undefined;
+/**
+ * Get tooltip variant
+ * @param error
+ * @param invalid
+ * @param link
+ * @returns
+ */
+export declare const getTooltipVariant: (error: boolean, invalid: boolean, link: boolean, note: boolean, isCustom: boolean) => CellTooltipVariants["variant"];
+/**
+ * Create an empty 2d array
+ * @param rows
+ * @param columns
+ * @returns
+ */
+export declare const createEmpty2dArray: (rows: number, columns: number) => undefined[][];
+/**
+ * Quick check to see if a filter
+ * is applied to a column
+ * @param columnIndex
+ * @param filterSpecs
+ * @returns
+ */
+export declare const isFilterAppliedToColumnIndex: (columnIndex: number, filterSpecs: FilterSpec[] | undefined | null) => boolean;
+/**
+ * Helper function get header cells in a table
+ * and basicFilter
+ * @param tables
+ * @param basicFilter
+ * @returns
+ */
+export declare const getTableHeaderCells: (tables: TableView[] | undefined, basicFilter: FilterView | undefined | null) => readonly [Map<string, {
+    isFilterActive?: boolean | null;
+    sortOrder: SortOrder | undefined | null;
+    filterButton?: boolean | null;
+    theme?: TableTheme | undefined | null;
+}>, Map<number, boolean>, Map<number, boolean>, Map<string, boolean>, Map<string, boolean>];
+/**
+ * Get icon spacing
+ * @param verticalAlign
+ * @param height
+ * @param iconDimension
+ * @param cellspacing
+ * @returns
+ */
+export declare const getIconSpacing: (verticalAlign: VerticalAlign | undefined, height: number, iconDimension: number, scale: number, cellspacing?: number) => number;
+export declare const getHorizontalSpacing: (horzintalAlign: HorizontalAlign | undefined, width: number, iconDimension: number, scale: number, cellSpacing?: number) => number | undefined;
+export declare const getDefaultRowHeader: (rowIndex: number) => string;
+export declare const getDefaultColumnHeader: (columnIndex: number) => string;
+/**
+ * Get vertical position of the chip
+ * @param y
+ * @param cellHeight
+ */
+export declare const getChipVerticalPosition: (y: number, cellHeight: number, scale: number, verticalAlign: VerticalAlign) => number;
+export declare const definedProps: <T extends Record<string, any> | undefined | null>(obj: T) => Partial<NonNullable<T>> | T;
+export declare const isGridRange: (maybeCellOrRange: CellInterface | GridRange) => maybeCellOrRange is GridRange;
+export declare const addIndent: (text: string, indent: number, alignment: HorizontalAlign) => string;
+export declare const generateMultiDimTitle: (dims: number[] | undefined, axis: AXIS) => string | null;
+export declare const createArrayRange: (start: number, end: number) => number[];
+export declare const isInSequence: (arr: number[]) => boolean;
+export declare const getCurrencySymbol: (locale: string | undefined, currency: string) => string | undefined;
+export declare const isSheetRange: (mayBeSheetRange: SheetCoordinate | SheetRange) => mayBeSheetRange is SheetRange;
+export declare const sheetRangeToSheetCoordinate: (mayBeSheetRange: SheetCoordinate | SheetRange) => SheetCoordinate;
+export declare const isEqualColors: (a: Color | undefined, b: Color | undefined) => boolean;
+export declare const checkIfStringIsReference: (str: string | undefined) => boolean;
+export declare const trimValue: (value: string | undefined) => string | undefined;
+export declare const shouldShowToValue: (conditionType: ConditionType | undefined) => boolean | undefined;
+export declare const shouldShowFromValue: (conditionType: ConditionType | undefined) => boolean;
+export declare const splitDataValidationListValues: (listString: string | undefined) => ConditionValue[];
+export declare const isTouchDevice: boolean;
+export declare const isStyleReference: <T extends CellData>(cellFormat?: T["ef"]) => cellFormat is StyleReference;
+export declare const isStructuredValue: <T extends CellData>(ev?: T["effectiveValue"]) => ev is StructuredValue;
+export declare const isHoveredCellsWithinBounds: (range: GridRange | undefined, activeCell: CellInterface | undefined | null, hoveredCell: CellInterface | undefined | null) => boolean | null | undefined;
+export { getCellFormattedValue, getCellUserEnteredValue, getCellEffectiveValue, getExtendedValueNumber, getExtendedValueString, getExtendedValueBool, getExtendedValueFormula, getExtendedValueError, } from "@rowsncolumns/utils";
+//# sourceMappingURL=helpers.d.ts.map

package/dist/esm/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAMnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAQ5D,OAAO,KAAK,EACV,IAAI,EACJ,MAAM,EAEN,QAAQ,EACR,KAAK,EACL,aAAa,EACb,cAAc,EACd,UAAU,EACV,UAAU,EACV,eAAe,EACf,KAAK,EACL,eAAe,EACf,UAAU,EACV,SAAS,EAET,eAAe,EACf,cAAc,EACd,UAAU,EACV,SAAS,EACT,aAAa,EACd,MAAM,SAAS,CAAC;AAGjB,eAAO,MAAM,SAAS,SAEb,CAAC;AAGV,eAAO,MAAM,YAAY,GAAI,IAAI,MAAM,WAA+B,CAAC;AAGvE,eAAO,MAAM,YAAY,GAAI,IAAI,MAAM,WAA+B,CAAC;AAEvE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAC/B,MAAM,MAAM,GAAG,SAAS,EACxB,YAAY,OAAO,KAClB,MAAM,GAAG,SAKX,CAAC;AAUF;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GACxC,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,yBA2BnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,GAC7C,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,gBAYnC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,SAAS,MAAM,EACf,OAAO,MAAM,EACb,iBAAgB,EAChB,oBAAkB,EAClB,gBAAc,KACb,KASD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,aAAa,YAM/C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,GAC1C,mBAAmB,aAAa,GAAG,SAAS,EAC5C,cAAc,MAAM,GAAG,SAAS,uBAYjC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,OAAO,EACd,SAAS,OAAO,EAChB,MAAM,OAAO,EACb,MAAM,OAAO,EACb,UAAU,OAAO,KAChB,mBAAmB,CAAC,SAAS,CAgB/B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,kBAE/D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,GACvC,aAAa,MAAM,EACnB,aAAa,UAAU,EAAE,GAAG,SAAS,GAAG,IAAI,YAU7C,CAAC;AAgBF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,SAAS,EAAE,GAAG,SAAS,EAC/B,aAAa,UAAU,GAAG,SAAS,GAAG,IAAI;qBAMrB,OAAO,GAAG,IAAI;eACpB,SAAS,GAAG,SAAS,GAAG,IAAI;mBACxB,OAAO,GAAG,IAAI;YACrB,UAAU,GAAG,SAAS,GAAG,IAAI;2FA+E1C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GACzB,eAAe,aAAa,GAAG,SAAS,EACxC,QAAQ,MAAM,EACd,eAAe,MAAM,EACrB,OAAO,MAAM,EACb,oBAAe,WAUhB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,gBAAgB,eAAe,GAAG,SAAS,EAC3C,OAAO,MAAM,EACb,eAAe,MAAM,EACrB,OAAO,MAAM,EACb,oBAAe,uBAUhB,CAAC;AAGF,eAAO,MAAM,mBAAmB,GAAI,UAAU,MAAM,WAAqB,CAAC;AAC1E,eAAO,MAAM,sBAAsB,GAAI,aAAa,MAAM,WAC3B,CAAC;AAEhC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAClC,GAAG,MAAM,EACT,YAAY,MAAM,EAClB,OAAO,MAAM,EACb,eAAe,aAAa,WAiB7B,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,IAAI,EAC3E,KAAK,CAAC,KACL,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAU5B,CAAC;AAEF,eAAO,MAAM,WAAW,GACtB,kBAAkB,aAAa,GAAG,SAAS,KAC1C,gBAAgB,IAAI,SAEtB,CAAC;AAEF,eAAO,MAAM,SAAS,GACpB,MAAM,MAAM,EACZ,QAAQ,MAAM,EACd,WAAW,eAAe,WAI3B,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EAAE,GAAG,SAAS,EAC1B,MAAM,IAAI,kBAgBX,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,EAAE,KAAK,MAAM,aAI1D,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,EAAE,KAAG,OAY5C,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,GAAG,SAAS,EAC1B,UAAU,MAAM,uBAUjB,CAAC;AAEF,eAAO,MAAM,YAAY,GACvB,iBAAiB,eAAe,GAAG,UAAU,KAC5C,eAAe,IAAI,UAErB,CAAC;AAEF,eAAO,MAAM,2BAA2B,GACtC,iBAAiB,eAAe,GAAG,UAAU,KAC5C,eASF,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,GAAG,KAAK,GAAG,SAAS,EAAE,GAAG,KAAK,GAAG,SAAS,YAgBvE,CAAC;AAKF,eAAO,MAAM,wBAAwB,GAAI,KAAK,MAAM,GAAG,SAAS,YACV,CAAC;AAEvD,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,GAAG,SAAS,uBAAkB,CAAC;AAEtE,eAAO,MAAM,iBAAiB,GAAI,eAAe,aAAa,GAAG,SAAS,wBAO/C,CAAC;AAE5B,eAAO,MAAM,mBAAmB,GAAI,eAAe,aAAa,GAAG,SAAS,YA0BjD,CAAC;AAE5B,eAAO,MAAM,6BAA6B,GACxC,YAAY,MAAM,GAAG,SAAS,KAC7B,cAAc,EAqBhB,CAAC;AAGF,eAAO,MAAM,aAAa,SAAwC,CAAC;AAGnE,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,QAAQ,EACjD,aAAa,CAAC,CAAC,IAAI,CAAC,KACnB,UAAU,IAAI,cAKhB,CAAC;AAGF,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,QAAQ,EAClD,KAAK,CAAC,CAAC,gBAAgB,CAAC,KACvB,EAAE,IAAI,eAKR,CAAC;AAEF,eAAO,MAAM,0BAA0B,GACrC,OAAO,SAAS,GAAG,SAAS,EAC5B,YAAY,aAAa,GAAG,SAAS,GAAG,IAAI,EAC5C,aAAa,aAAa,GAAG,SAAS,GAAG,IAAI,+BAM9C,CAAC;AAEF,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,qBAAqB,CAAC"}

package/dist/esm/helpers.js

@@ -0,0 +1,455 @@
+import { canUseDOM, cellIdentifier, isCellWithinBounds, } from "@rowsncolumns/grid";
+import { isNil, number2Alpha, stripDataValidationTextPrefix, } from "@rowsncolumns/utils";
+import { CHIP_HEIGHT, CHIP_SPACING, CONDITION_NONE } from "./config";
+// Check if browser is Firefox
+export const isFirefox = canUseDOM
+    ? navigator.userAgent.indexOf("Firefox") !== -1
+    : false;
+/* Converts point to pixel */
+export const pointToPixel = (pt) => Math.round((13 / 10) * pt);
+/* Convert pixel to point */
+export const pixelToPoint = (px) => Math.round((px / 13) * 10);
+/**
+ * Normalize text for display by replacing newlines with spaces.
+ * Excel displays newlines as spaces unless wrapText is enabled in the cell style.
+ * This ensures consistent rendering and width calculation.
+ */
+export const normalizeDisplayText = (text, shouldWrap) => {
+    if (shouldWrap || text === undefined) {
+        return text;
+    }
+    return text.replace(/\n/g, " ");
+};
+// Dpr utils
+const getPixelRatio = () => (canUseDOM ? window.devicePixelRatio : 1);
+const dashDotWidth = Math.max(Math.floor(getPixelRatio() / 2), 0.5);
+const getDotArray = () => getPixelRatio() === 1
+    ? [dashDotWidth, dashDotWidth + getPixelRatio()]
+    : [dashDotWidth, dashDotWidth];
+/**
+ * Converts border style to dash array
+ * @param style
+ * @returns
+ */
+export const convertBorderStyleToDashArray = (style) => {
+    // Dash patterns follow Canvas's `setLineDash` convention: pairs of
+    // [on, off, on, off, ...]. Values chosen to give visually distinct
+    // strokes that match Excel's rendering at typical zoom levels.
+    switch (style) {
+        case "dashed":
+        case "mediumDashed":
+            return [2, 2];
+        case "dotted":
+            return getDotArray();
+        case "hair":
+            // OOXML hair: very fine dotted, slightly tighter than `dotted`.
+            return [1, 1];
+        case "dashDot":
+        case "mediumDashDot":
+            return [4, 2, 1, 2];
+        case "dashDotDot":
+            return [4, 2, 1, 2, 1, 2];
+        case "slantDashDot":
+            // Canvas can't paint slanted segments, so fall back to the
+            // standard dash-dot pattern. Visually distinct from `solid` even
+            // without the slant.
+            return [4, 2, 1, 2];
+        default:
+            return undefined;
+    }
+};
+/**
+ * Converts border thickness to value
+ * @param style
+ * @returns
+ */
+export const convertThicknessStyleToScaleFactor = (style) => {
+    switch (style) {
+        case "solid_medium":
+        case "mediumDashed":
+        case "mediumDashDot":
+            return 1.5;
+        case "solid_thick":
+            return 2;
+        default:
+            return 1;
+    }
+};
+/**
+ * Create a new empty sheet
+ * @param sheetId
+ * @param title
+ * @returns
+ */
+export const createNewSheet = (sheetId, title, rowCount = 1_000, columnCount = 1_00, hidden = false) => ({
+    title,
+    sheetId,
+    rowCount,
+    columnCount,
+    hidden,
+    merges: [],
+    columnMetadata: [],
+    rowMetadata: [],
+});
+/**
+ * Check if the current cell is header cell
+ * @param cell
+ * @returns
+ */
+export const isHeaderCell = (cell) => {
+    const { rowIndex, columnIndex } = cell;
+    return (rowIndex === 0 ||
+        (columnIndex === 0 && !(rowIndex === 0 && columnIndex === 0)));
+};
+/**
+ * Get flex justify property from vertical alignment
+ * @param verticalAlignment
+ * @returns
+ */
+export const getJustifyPropertyFromAlignment = (verticalAlignment, defaultValue) => {
+    switch (verticalAlignment) {
+        case "bottom":
+            return "flex-end";
+        case "top":
+            return "flex-start";
+        case "middle":
+            return "center";
+        default:
+            return defaultValue;
+    }
+};
+/**
+ * Get tooltip variant
+ * @param error
+ * @param invalid
+ * @param link
+ * @returns
+ */
+export const getTooltipVariant = (error, invalid, link, note, isCustom) => {
+    if (isCustom) {
+        return "custom";
+    }
+    if (error) {
+        return "error";
+    }
+    if (invalid) {
+        return "invalid";
+    }
+    if (link) {
+        return "link";
+    }
+    if (note) {
+        return "note";
+    }
+};
+/**
+ * Create an empty 2d array
+ * @param rows
+ * @param columns
+ * @returns
+ */
+export const createEmpty2dArray = (rows, columns) => {
+    return [...Array(rows)].map(() => [...Array(columns)].map(() => undefined));
+};
+/**
+ * Quick check to see if a filter
+ * is applied to a column
+ * @param columnIndex
+ * @param filterSpecs
+ * @returns
+ */
+export const isFilterAppliedToColumnIndex = (columnIndex, filterSpecs) => {
+    return Boolean(filterSpecs?.find((spec) => spec.columnIndex === columnIndex &&
+        (spec.filterCriteria?.condition?.type ||
+            spec.filterCriteria?.visibleValues?.length)));
+};
+/**
+ * Quick check to see if sort is applied to a column
+ * @param columnIndex
+ * @param filterSpecs
+ * @returns
+ */
+const getSortOrderOfColumnIndex = (columnIndex, sortSpecs) => {
+    return sortSpecs?.find((spec) => spec.dimensionIndex === columnIndex)
+        ?.sortOrder;
+};
+/**
+ * Helper function get header cells in a table
+ * and basicFilter
+ * @param tables
+ * @param basicFilter
+ * @returns
+ */
+export const getTableHeaderCells = (tables, basicFilter) => {
+    // Boolean value indicates if filter is active or not
+    const headerCells = new Map();
+    const calculatedColumnHeaderCells = new Map();
+    const tableColumnHeaderIds = new Map();
+    const tableRowHeaderIds = new Map();
+    const tableFooterIds = new Map();
+    tables?.forEach((table) => {
+        const { range, filterSpecs, sortSpecs, totalRow = false, columns, theme, } = table;
+        const filterButton = table.filterButton ?? true;
+        const headerRow = table.headerRow ?? true;
+        for (let i = range.startColumnIndex; i <= range.endColumnIndex; i++) {
+            const columnIdx = i - range.startColumnIndex;
+            const isFilterActive = isFilterAppliedToColumnIndex(columnIdx, filterSpecs);
+            const sortOrder = getSortOrderOfColumnIndex(i, sortSpecs);
+            const id = cellIdentifier(range.startRowIndex, i);
+            if (headerRow) {
+                headerCells.set(id, {
+                    isFilterActive: filterButton ? isFilterActive : undefined,
+                    filterButton: filterButton,
+                    sortOrder,
+                    theme,
+                });
+            }
+            if (totalRow) {
+                const footerCellId = cellIdentifier(range.endRowIndex, i);
+                tableFooterIds.set(footerCellId, true);
+            }
+            tableColumnHeaderIds.set(i, true);
+            // Calculated column ids
+            if (columns?.[columnIdx]?.formula) {
+                calculatedColumnHeaderCells.set(id, true);
+            }
+        }
+        for (let i = range.startRowIndex; i <= range.endRowIndex; i++) {
+            tableRowHeaderIds.set(i, true);
+        }
+    });
+    if (basicFilter) {
+        const { range, filterSpecs, sortSpecs } = basicFilter;
+        if (range) {
+            for (let i = range.startColumnIndex; i <= range.endColumnIndex; i++) {
+                const dimensionIndex = i - range.startColumnIndex;
+                const isFilterActive = isFilterAppliedToColumnIndex(dimensionIndex, filterSpecs);
+                const sortOrder = getSortOrderOfColumnIndex(i, sortSpecs);
+                headerCells.set(cellIdentifier(range.startRowIndex, i), {
+                    isFilterActive,
+                    sortOrder,
+                    filterButton: true,
+                });
+                tableColumnHeaderIds.set(i, true);
+            }
+            for (let i = range.startRowIndex; i <= range.endRowIndex; i++) {
+                tableRowHeaderIds.set(i, true);
+            }
+        }
+    }
+    return [
+        headerCells,
+        tableColumnHeaderIds,
+        tableRowHeaderIds,
+        calculatedColumnHeaderCells,
+        tableFooterIds,
+    ];
+};
+/**
+ * Get icon spacing
+ * @param verticalAlign
+ * @param height
+ * @param iconDimension
+ * @param cellspacing
+ * @returns
+ */
+export const getIconSpacing = (verticalAlign, height, iconDimension, scale, cellspacing = 0) => {
+    switch (verticalAlign) {
+        case "top":
+            return cellspacing;
+        case "middle":
+            return (height - iconDimension * scale) / 2;
+        default:
+            return height - scale * iconDimension - cellspacing;
+    }
+};
+export const getHorizontalSpacing = (horzintalAlign, width, iconDimension, scale, cellSpacing = 0) => {
+    switch (horzintalAlign) {
+        case "left":
+            return scale;
+        case "center":
+            return width / 2 - (iconDimension * scale) / 2 - 1;
+        case "right":
+            return width - scale * iconDimension - cellSpacing;
+    }
+};
+// Row and column header function
+export const getDefaultRowHeader = (rowIndex) => String(rowIndex);
+export const getDefaultColumnHeader = (columnIndex) => number2Alpha(columnIndex - 1);
+/**
+ * Get vertical position of the chip
+ * @param y
+ * @param cellHeight
+ */
+export const getChipVerticalPosition = (y, cellHeight, scale, verticalAlign) => {
+    switch (verticalAlign) {
+        case "bottom":
+            return Math.floor(y + cellHeight - CHIP_HEIGHT * scale - CHIP_SPACING * scale);
+        case "top":
+            return y;
+        case "middle":
+            return Math.floor(y +
+                cellHeight / 2 -
+                (CHIP_HEIGHT * scale) / 2 -
+                (CHIP_SPACING * scale) / 2);
+    }
+};
+export const definedProps = (obj) => {
+    if (isNil(obj))
+        return obj;
+    const result = {};
+    for (const key in obj) {
+        if (!isNil(obj[key])) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+};
+export const isGridRange = (maybeCellOrRange) => {
+    return "startRowIndex" in maybeCellOrRange;
+};
+export const addIndent = (text, indent, alignment) => {
+    const spaces = " ".repeat(indent);
+    return alignment === "left" || !alignment ? spaces + text : text + spaces;
+};
+export const generateMultiDimTitle = (dims, axis) => {
+    if (!dims) {
+        return null;
+    }
+    if (!isInSequence(dims)) {
+        return null;
+    }
+    const { 0: first, [dims.length - 1]: last } = dims;
+    if (first !== last) {
+        if (axis === "y")
+            return number2Alpha(first - 1) + "-" + number2Alpha(last - 1);
+        return first + "-" + last;
+    }
+    return null;
+};
+export const createArrayRange = (start, end) => {
+    return Array.from({ length: end - start + 1 }).map((_, index) => start + index);
+};
+export const isInSequence = (arr) => {
+    if (arr.length <= 1)
+        return true;
+    const sortedNumbers = [...arr].sort((a, b) => a - b);
+    for (let i = 0; i < sortedNumbers.length - 1; i++) {
+        if (sortedNumbers[i + 1] - sortedNumbers[i] !== 1) {
+            return false;
+        }
+    }
+    return true;
+};
+export const getCurrencySymbol = (locale, currency) => {
+    const currencySymbol = new Intl.NumberFormat(locale, {
+        style: "currency",
+        currency,
+    })
+        .formatToParts(1)
+        .find((item) => item.type === "currency")?.value;
+    return currencySymbol;
+};
+export const isSheetRange = (mayBeSheetRange) => {
+    return !!mayBeSheetRange.startRowIndex;
+};
+export const sheetRangeToSheetCoordinate = (mayBeSheetRange) => {
+    if (isSheetRange(mayBeSheetRange)) {
+        return {
+            rowIndex: mayBeSheetRange.startRowIndex,
+            columnIndex: mayBeSheetRange.startColumnIndex,
+            sheetId: mayBeSheetRange.sheetId,
+        };
+    }
+    return mayBeSheetRange;
+};
+export const isEqualColors = (a, b) => {
+    if (typeof a !== typeof b) {
+        return false;
+    }
+    if (typeof a === "string" && typeof b === "string") {
+        return a === b;
+    }
+    if (typeof a === "object" &&
+        typeof b === "object" &&
+        a.theme === b.theme &&
+        a.tint === b.tint) {
+        return true;
+    }
+    return false;
+};
+// https://regex101.com/r/h40MZC/1
+const rangeReferencePattern = /^(\=?'?[A-Za-z0-9\s]+'?\!)?(\$?[A-Za-z]+\$?\d+):?(\$?[A-Za-z]+\$?\d+)?$/;
+export const checkIfStringIsReference = (str) => isNil(str) ? false : rangeReferencePattern.test(str);
+export const trimValue = (value) => value?.trim();
+export const shouldShowToValue = (conditionType) => conditionType &&
+    [
+        "NUMBER_BETWEEN",
+        "NUMBER_NOT_BETWEEN",
+        "DATE_BETWEEN",
+        "DATE_NOT_BETWEEN",
+    ].includes(conditionType);
+export const shouldShowFromValue = (conditionType) => !!conditionType &&
+    ![
+        "NOT_BLANK",
+        "BLANK",
+        "ERROR",
+        "NOT_ERROR",
+        "NUMBER_ABOVE_AVERAGE",
+        "NUMBER_BELOW_AVERAGE",
+        "TEXT_IS_EMAIL",
+        "TEXT_IS_URL",
+        "DATE_IS_VALID",
+        "DATE_TODAY",
+        "DATE_YESTERDAY",
+        "DATE_TOMORROW",
+        "DATE_LAST_7_DAYS",
+        "DATE_LAST_WEEK",
+        "DATE_THIS_WEEK",
+        "DATE_NEXT_WEEK",
+        "DATE_LAST_MONTH",
+        "DATE_THIS_MONTH",
+        "DATE_NEXT_MONTH",
+        "BOOLEAN",
+        CONDITION_NONE,
+    ].includes(conditionType);
+export const splitDataValidationListValues = (listString) => {
+    if (isNil(listString)) {
+        return [];
+    }
+    // Remove the surrounding double quotes
+    const trimmedString = listString.replace(/^"(.*)"$/, "$1");
+    // Split the string by the comma separator
+    const values = trimmedString.split(",");
+    // Trim whitespace from each value. A leading apostrophe is Excel's text
+    // prefix (`'000s` is the text "000s" and a bare `'` is empty text), never
+    // part of the value.
+    const trimmedValues = values
+        .map((value) => value.trim())
+        .map(stripDataValidationTextPrefix)
+        .map((userEnteredValue) => ({
+        userEnteredValue,
+    }));
+    return trimmedValues;
+};
+// Check if touch device
+export const isTouchDevice = canUseDOM && "ontouchstart" in window;
+// Check if its a style reference
+export const isStyleReference = (cellFormat) => {
+    if (!cellFormat) {
+        return false;
+    }
+    return `sid` in cellFormat || `styleId` in cellFormat;
+};
+// Check if its a shared string reference
+export const isStructuredValue = (ev) => {
+    if (!ev) {
+        return false;
+    }
+    return `structuredValue` in ev;
+};
+export const isHoveredCellsWithinBounds = (range, activeCell, hoveredCell) => {
+    return ((activeCell && isCellWithinBounds(activeCell, range)) ||
+        (hoveredCell && isCellWithinBounds(hoveredCell, range)));
+};
+export { getCellFormattedValue, getCellUserEnteredValue, getCellEffectiveValue, getExtendedValueNumber, getExtendedValueString, getExtendedValueBool, getExtendedValueFormula, getExtendedValueError, } from "@rowsncolumns/utils";

package/dist/esm/hooks/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./use-spreadsheet-theme";
+export * from "./use-create-address-from-selection";
+export * from "./use-callback-ref";
+export * from "./use-isomorphic-layout-effect";
+export * from "./use-merge.refs";
+export * from "./use-fonts";
+export * from "./use-border-styles";
+export * from "./use-previous";
+export * from "./use-cell-diff-highlight";
+export * from "./use-selection-aware-formatting";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,qCAAqC,CAAC;AACpD,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC"}

package/dist/esm/hooks/index.js

@@ -0,0 +1,10 @@
+export * from "./use-spreadsheet-theme";
+export * from "./use-create-address-from-selection";
+export * from "./use-callback-ref";
+export * from "./use-isomorphic-layout-effect";
+export * from "./use-merge.refs";
+export * from "./use-fonts";
+export * from "./use-border-styles";
+export * from "./use-previous";
+export * from "./use-cell-diff-highlight";
+export * from "./use-selection-aware-formatting";

package/dist/esm/hooks/show-zeros.d.ts

@@ -0,0 +1,13 @@
+import type { ExtendedValue } from "../types";
+/**
+ * Excel's "Hide zero values in cells that have zero value" sheet-view
+ * setting (`<sheetView showZeros="0"/>`). When off, cells whose effective
+ * value is exactly the number 0 render as empty.
+ *
+ * Only numeric zeros are hidden — string "0", booleans, and formulas
+ * returning a non-numeric value all render normally.
+ *
+ * Returns the formatted value to display.
+ */
+export declare const applyShowZeros: (formattedValue: string | undefined, effectiveValue: ExtendedValue | undefined | null, showZeros: boolean | null | undefined) => string | undefined;
+//# sourceMappingURL=show-zeros.d.ts.map

package/dist/esm/hooks/show-zeros.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"show-zeros.d.ts","sourceRoot":"","sources":["../../../hooks/show-zeros.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GACzB,gBAAgB,MAAM,GAAG,SAAS,EAClC,gBAAgB,aAAa,GAAG,SAAS,GAAG,IAAI,EAChD,WAAW,OAAO,GAAG,IAAI,GAAG,SAAS,KACpC,MAAM,GAAG,SAOX,CAAC"}

package/dist/esm/hooks/show-zeros.js

@@ -0,0 +1,19 @@
+/**
+ * Excel's "Hide zero values in cells that have zero value" sheet-view
+ * setting (`<sheetView showZeros="0"/>`). When off, cells whose effective
+ * value is exactly the number 0 render as empty.
+ *
+ * Only numeric zeros are hidden — string "0", booleans, and formulas
+ * returning a non-numeric value all render normally.
+ *
+ * Returns the formatted value to display.
+ */
+export const applyShowZeros = (formattedValue, effectiveValue, showZeros) => {
+    if (showZeros !== false)
+        return formattedValue;
+    const numberValue = effectiveValue?.numberValue ?? effectiveValue?.nv;
+    if (typeof numberValue === "number" && numberValue === 0) {
+        return "";
+    }
+    return formattedValue;
+};

package/dist/esm/hooks/use-async.d.ts

@@ -0,0 +1,2 @@
+export declare const useAsync: <T>(asyncFunction: () => Promise<T> | undefined) => T | undefined;
+//# sourceMappingURL=use-async.d.ts.map

package/dist/esm/hooks/use-async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-async.d.ts","sourceRoot":"","sources":["../../../hooks/use-async.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,eAAe,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,kBAuBtE,CAAC"}

package/dist/esm/hooks/use-async.js

@@ -0,0 +1,22 @@
+import { useCallback, useRef, useSyncExternalStore } from "react";
+export const useAsync = (asyncFunction) => {
+    const resultRef = useRef(undefined);
+    const getSnapShot = () => resultRef.current;
+    const subscribe = useCallback((onStoreChange) => {
+        const executeAsync = async () => {
+            try {
+                const result = await asyncFunction?.();
+                resultRef.current = result;
+            }
+            catch (err) {
+                resultRef.current = undefined;
+            }
+            finally {
+                onStoreChange();
+            }
+        };
+        executeAsync();
+        return () => undefined;
+    }, [asyncFunction]);
+    return useSyncExternalStore(subscribe, getSnapShot, getSnapShot);
+};