@alaarab/ogrid-core 2.1.2 → 2.1.4

package/dist/esm/utils/undoRedoStack.js

@@ -1,130 +0,0 @@
-/**
- * Pure undo/redo stack data structure shared across React, Vue, Angular, and JS.
- * No framework dependencies — all state is plain arrays.
- *
- * Usage:
- *   const stack = new UndoRedoStack<MyEvent>(100);
- *   stack.push([event]);        // single event
- *   stack.beginBatch();
- *   stack.push([event1]);
- *   stack.push([event2]);
- *   stack.endBatch();           // event1 + event2 are one undo step
- *   const batch = stack.undo(); // returns the batch to reverse
- *   const batch = stack.redo(); // returns the batch to re-apply
- */
-export class UndoRedoStack {
-    constructor(maxDepth = 100) {
-        this.history = [];
-        this.redoStack = [];
-        this.batch = null;
-        this.maxDepth = maxDepth;
-    }
-    /** Whether there are undo steps available. */
-    get canUndo() {
-        return this.history.length > 0;
-    }
-    /** Whether there are redo steps available. */
-    get canRedo() {
-        return this.redoStack.length > 0;
-    }
-    /** Number of history entries. */
-    get historyLength() {
-        return this.history.length;
-    }
-    /** Number of redo entries. */
-    get redoLength() {
-        return this.redoStack.length;
-    }
-    /** Whether a batch is currently open. */
-    get isBatching() {
-        return this.batch !== null;
-    }
-    /**
-     * Record a group of events as a single undoable step.
-     * If a batch is open, accumulates into the batch instead.
-     * Clears the redo stack on any new entry.
-     */
-    push(events) {
-        if (events.length === 0)
-            return;
-        if (this.batch !== null) {
-            this.batch.push(...events);
-        }
-        else {
-            this.history.push(events);
-            if (this.history.length > this.maxDepth) {
-                this.history.splice(0, this.history.length - this.maxDepth);
-            }
-            // Clear redo stack in-place — avoids allocating a new array on every edit
-            this.redoStack.length = 0;
-        }
-    }
-    /**
-     * Record a single event as a step (shorthand for push([event])).
-     * If a batch is open, accumulates into the batch instead.
-     */
-    record(event) {
-        this.push([event]);
-    }
-    /**
-     * Start a batch — subsequent record/push calls accumulate into one undo step.
-     * Has no effect if a batch is already open.
-     */
-    beginBatch() {
-        if (this.batch === null) {
-            this.batch = [];
-        }
-    }
-    /**
-     * End a batch — commits all accumulated events as one undo step.
-     * Has no effect if no batch is open or if the batch is empty.
-     */
-    endBatch() {
-        const b = this.batch;
-        this.batch = null;
-        if (!b || b.length === 0)
-            return;
-        this.history.push(b);
-        if (this.history.length > this.maxDepth) {
-            this.history.splice(0, this.history.length - this.maxDepth);
-        }
-        this.redoStack.length = 0;
-    }
-    /**
-     * Pop the most recent history entry for undo.
-     * Returns the batch of events (in original order) to be reversed by the caller,
-     * or null if there is nothing to undo.
-     *
-     * The caller is responsible for applying the events in reverse order.
-     */
-    undo() {
-        const lastBatch = this.history.pop();
-        if (!lastBatch)
-            return null;
-        this.redoStack.push(lastBatch);
-        return lastBatch;
-    }
-    /**
-     * Pop the most recent redo entry.
-     * Returns the batch of events (in original order) to be re-applied by the caller,
-     * or null if there is nothing to redo.
-     */
-    redo() {
-        const nextBatch = this.redoStack.pop();
-        if (!nextBatch)
-            return null;
-        this.history.push(nextBatch);
-        return nextBatch;
-    }
-    /**
-     * Clear all history and redo state.
-     * Does not affect any open batch — call endBatch() first if needed.
-     */
-    clear() {
-        this.history = [];
-        this.redoStack = [];
-        // Intentionally leaves this.batch untouched. If a batch is open,
-        // subsequent records will still accumulate until endBatch() is called.
-        // Callers that want to abort an open batch should call endBatch() first.
-    }
-}

package/dist/esm/utils/validation.js

@@ -1,43 +0,0 @@
-/**
- * Validate column definitions at grid initialization.
- * Called once (not per render). Warns on empty/missing/duplicate columnIds.
- */
-export function validateColumns(columns) {
-    if (!Array.isArray(columns) || columns.length === 0) {
-        console.warn('[OGrid] columns prop is empty or not an array');
-        return;
-    }
-    const ids = new Set();
-    for (const col of columns) {
-        if (!col.columnId) {
-            console.warn('[OGrid] Column missing columnId:', col);
-        }
-        if (ids.has(col.columnId)) {
-            console.warn(`[OGrid] Duplicate columnId: "${col.columnId}"`);
-        }
-        ids.add(col.columnId);
-    }
-}
-/**
- * Validate that getRowId returns unique, non-null values.
- * Dev-only (skipped in production). Samples the first 100 rows.
- * Called once on first data render via a hasValidated flag in the caller.
- */
-export function validateRowIds(items, getRowId) {
-    if (typeof process !== 'undefined' && process.env.NODE_ENV === 'production')
-        return;
-    const ids = new Set();
-    const limit = Math.min(items.length, 100);
-    for (let i = 0; i < limit; i++) {
-        const id = getRowId(items[i]);
-        if (id == null) {
-            console.warn(`[OGrid] getRowId returned null/undefined for row ${i}`);
-            return;
-        }
-        if (ids.has(id)) {
-            console.warn(`[OGrid] Duplicate row ID "${id}" at index ${i}. getRowId must return unique values.`);
-            return;
-        }
-        ids.add(id);
-    }
-}

package/dist/esm/utils/valueParsers.js

@@ -1,121 +0,0 @@
-/**
- * Run the column's valueParser (if any), or auto-validate select columns.
- * Returns `{ valid: true, value }` with the parsed value, or `{ valid: false }` to reject.
- */
-export function parseValue(newValue, oldValue, item, col) {
-    // 1. Custom valueParser takes priority
-    if (col.valueParser) {
-        const params = {
-            newValue,
-            oldValue,
-            data: item,
-            column: col,
-        };
-        const parsed = col.valueParser(params);
-        if (parsed === undefined) {
-            return { valid: false, value: undefined };
-        }
-        return { valid: true, value: parsed };
-    }
-    // 2. Auto-validate select columns against allowed values
-    if (col.cellEditor === 'select' &&
-        col.cellEditorParams?.values != null &&
-        Array.isArray(col.cellEditorParams.values)) {
-        const allowedValues = col.cellEditorParams.values;
-        const strValue = typeof newValue === 'string' ? newValue : String(newValue ?? '');
-        // Allow clearing (empty string)
-        if (strValue === '') {
-            return { valid: true, value: '' };
-        }
-        // Case-insensitive match; return canonical value from the options list
-        const match = allowedValues.find((v) => String(v).toLowerCase() === strValue.toLowerCase());
-        if (match !== undefined) {
-            return { valid: true, value: match };
-        }
-        return { valid: false, value: undefined };
-    }
-    // 3. Auto-validate built-in column types
-    const colType = col.type;
-    if (colType === 'date') {
-        const parsed = dateParser({ newValue, oldValue, data: item, column: col });
-        return parsed === undefined ? { valid: false, value: undefined } : { valid: true, value: parsed };
-    }
-    if (colType === 'boolean') {
-        const parsed = booleanParser({ newValue, oldValue, data: item, column: col });
-        return parsed === undefined ? { valid: false, value: undefined } : { valid: true, value: parsed };
-    }
-    if (colType === 'numeric') {
-        const parsed = numberParser({ newValue, oldValue, data: item, column: col });
-        return parsed === undefined ? { valid: false, value: undefined } : { valid: true, value: parsed };
-    }
-    // 4. No parser, not a select column, no built-in type — pass through unchanged
-    return { valid: true, value: newValue };
-}
-// --- Built-in parser helpers ---
-// Consumers assign these to columns: { valueParser: numberParser }
-// Return `undefined` to reject; `null` to clear the cell.
-/**
- * Parses a value as a number. Strips whitespace and commas.
- * Returns `undefined` (reject) if result is NaN.
- */
-export function numberParser(params) {
-    const { newValue } = params;
-    if (newValue === '' || newValue == null)
-        return null;
-    const str = String(newValue).replace(/[\s,]/g, '');
-    const num = Number(str);
-    return Number.isNaN(num) ? undefined : num;
-}
-/**
- * Parses a currency string. Strips currency symbols ($, €, £, ¥), whitespace, commas.
- * Returns `undefined` (reject) if result is NaN.
- */
-export function currencyParser(params) {
-    const { newValue } = params;
-    if (newValue === '' || newValue == null)
-        return null;
-    const str = String(newValue)
-        .replace(/[$\u20AC\u00A3\u00A5]/g, '') // $, €, £, ¥
-        .replace(/[\s,]/g, '');
-    const num = Number(str);
-    return Number.isNaN(num) ? undefined : num;
-}
-/**
- * Parses a date string via `new Date()`. Returns ISO string or `undefined` if invalid.
- */
-export function dateParser(params) {
-    const { newValue } = params;
-    if (newValue === '' || newValue == null)
-        return null;
-    const str = String(newValue).trim();
-    const date = new Date(str);
-    if (Number.isNaN(date.getTime()))
-        return undefined;
-    return date.toISOString();
-}
-/**
- * Validates an email address with a basic regex.
- * Returns the trimmed string or `undefined` if invalid.
- */
-export function emailParser(params) {
-    const { newValue } = params;
-    if (newValue === '' || newValue == null)
-        return null;
-    const str = String(newValue).trim();
-    return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(str) ? str : undefined;
-}
-/**
- * Parses boolean-like values: true/false/yes/no/1/0.
- * Returns `undefined` if not recognized.
- */
-export function booleanParser(params) {
-    const { newValue } = params;
-    if (newValue === '' || newValue == null)
-        return null;
-    const str = String(newValue).trim().toLowerCase();
-    if (['true', 'yes', '1'].includes(str))
-        return true;
-    if (['false', 'no', '0'].includes(str))
-        return false;
-    return undefined;
-}

package/dist/esm/utils/virtualScroll.js

@@ -1,46 +0,0 @@
-/**
- * Compute the range of rows that should be rendered for a given scroll position.
- *
- * @param scrollTop - Current vertical scroll offset (px)
- * @param rowHeight - Fixed height of each row (px)
- * @param containerHeight - Visible height of the scroll container (px)
- * @param totalRows - Total number of rows in the dataset
- * @param overscan - Number of extra rows to render above and below the visible area (default: 5)
- * @returns The visible range with start/end indices and top/bottom spacer offsets
- */
-export function computeVisibleRange(scrollTop, rowHeight, containerHeight, totalRows, overscan = 5) {
-    if (totalRows <= 0 || rowHeight <= 0 || containerHeight <= 0) {
-        return { startIndex: 0, endIndex: 0, offsetTop: 0, offsetBottom: 0 };
-    }
-    const startIndex = Math.max(0, Math.floor(scrollTop / rowHeight) - overscan);
-    const endIndex = Math.min(totalRows - 1, Math.ceil((scrollTop + containerHeight) / rowHeight) + overscan);
-    const offsetTop = startIndex * rowHeight;
-    const offsetBottom = Math.max(0, (totalRows - endIndex - 1) * rowHeight);
-    return { startIndex, endIndex, offsetTop, offsetBottom };
-}
-/**
- * Compute the total scrollable height for all rows.
- */
-export function computeTotalHeight(totalRows, rowHeight) {
-    return totalRows * rowHeight;
-}
-/**
- * Compute the scrollTop value needed to bring a specific row into view.
- *
- * @param rowIndex - The row to scroll to
- * @param rowHeight - Fixed height of each row (px)
- * @param containerHeight - Visible height of the scroll container (px)
- * @param align - Where to position the row: 'start' (top), 'center', or 'end' (bottom). Default: 'start'.
- * @returns The scrollTop value to set on the container
- */
-export function getScrollTopForRow(rowIndex, rowHeight, containerHeight, align = 'start') {
-    const rowTop = rowIndex * rowHeight;
-    switch (align) {
-        case 'start':
-            return rowTop;
-        case 'center':
-            return Math.max(0, rowTop - (containerHeight - rowHeight) / 2);
-        case 'end':
-            return Math.max(0, rowTop - containerHeight + rowHeight);
-    }
-}