@youp-grid/core 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,181 @@
+export type GridRowId = string | number;
+export type GridRowModelType = "client" | "server";
+export type SortDirection = "asc" | "desc";
+export type ColumnPin = "left" | "right";
+export type FilterOperator = "contains" | "equals" | "startsWith" | "endsWith" | "gt" | "gte" | "lt" | "lte" | "between" | "isEmpty" | "isNotEmpty" | "in";
+export type Accessor<TRow, TValue = unknown> = (row: TRow) => TValue;
+export type ColumnComparator<TValue = unknown, TRow = unknown> = (leftValue: TValue, rightValue: TValue, leftRow: TRow, rightRow: TRow) => number;
+export type ColumnFilterPredicate<TValue = unknown, TRow = unknown> = (value: TValue, filter: FilterRule, row: TRow) => boolean;
+export type ValueFormatter<TValue = unknown, TRow = unknown> = (value: TValue, row: TRow) => string;
+export type ValueParser<TValue = unknown, TRow = unknown> = (input: string, row: TRow) => TValue;
+export type ColumnDef<TRow, TValue = unknown> = {
+    id?: string;
+    field?: Extract<keyof TRow, string> | string;
+    headerName?: string;
+    headerGroup?: string;
+    accessor?: Accessor<TRow, TValue>;
+    sortable?: boolean;
+    filterable?: boolean;
+    editable?: boolean;
+    hidden?: boolean;
+    pinned?: ColumnPin;
+    width?: number;
+    minWidth?: number;
+    maxWidth?: number;
+    comparator?: ColumnComparator<TValue, TRow>;
+    filterPredicate?: ColumnFilterPredicate<TValue, TRow>;
+    valueFormatter?: ValueFormatter<TValue, TRow>;
+    valueParser?: ValueParser<TValue, TRow>;
+};
+export type ResolvedColumnDef<TRow, TValue = unknown> = Omit<ColumnDef<TRow, TValue>, "id" | "accessor"> & {
+    id: string;
+    headerName: string;
+    accessor: Accessor<TRow, TValue>;
+};
+export type SortRule = {
+    columnId: string;
+    direction: SortDirection;
+};
+export type ColumnState = {
+    columnId: string;
+    hidden?: boolean;
+    pinned?: ColumnPin;
+    width?: number;
+    order?: number;
+};
+export type FilterRule = {
+    columnId: string;
+    operator: FilterOperator;
+    value?: unknown;
+};
+export type AggregationFunctionName = "sum" | "avg" | "min" | "max" | "count";
+export type AggregationRule = {
+    columnId: string;
+    function: AggregationFunctionName;
+    label?: string;
+};
+export type AggregationResult = {
+    columnId: string;
+    function: AggregationFunctionName;
+    label: string;
+    value: number | undefined;
+    rowCount: number;
+    valueCount: number;
+};
+export type RowGroupingState = {
+    columnIds: string[];
+    collapsedGroupIds?: string[];
+};
+export type PaginationState = {
+    pageIndex: number;
+    pageSize: number;
+};
+export type CursorPaginationState = {
+    cursor?: string;
+    pageSize: number;
+    previousCursor?: string;
+    nextCursor?: string;
+    hasPreviousPage?: boolean;
+    hasNextPage?: boolean;
+};
+export type RemoteRequestStatus = "idle" | "loading" | "success" | "error" | "cancelled";
+export type RemoteRequestState = {
+    requestId?: string;
+    sequence: number;
+    status: RemoteRequestStatus;
+    error?: string;
+};
+export type RemoteCacheState = {
+    key?: string;
+    version: number;
+    stale?: boolean;
+    invalidatedKeys?: string[];
+};
+export type GridState = {
+    columns?: ColumnState[];
+    sort?: SortRule[];
+    filters?: FilterRule[];
+    aggregation?: AggregationRule[];
+    rowGrouping?: RowGroupingState;
+    pagination?: PaginationState;
+    cursorPagination?: CursorPaginationState;
+    remoteRequest?: RemoteRequestState;
+    remoteCache?: RemoteCacheState;
+    selectedRowIds?: GridRowId[];
+};
+export type RowNode<TRow> = {
+    id: GridRowId;
+    index: number;
+    original: TRow;
+};
+export type RowGroupNode = {
+    type: "group";
+    id: string;
+    groupId: string;
+    index: number;
+    depth: number;
+    columnId: string;
+    value: unknown;
+    label: string;
+    rowCount: number;
+    expanded: boolean;
+};
+export type RowDisplayNode<TRow> = RowNode<TRow> | RowGroupNode;
+export type BuildRowModelOptions<TRow> = {
+    rows: readonly TRow[];
+    columns: readonly ColumnDef<TRow>[];
+    state?: GridState;
+    getRowId?: (row: TRow, index: number) => GridRowId;
+    rowModelType?: GridRowModelType;
+    serverRowCount?: number;
+    serverFilteredRowCount?: number;
+};
+export type RowModel<TRow> = {
+    columns: ResolvedColumnDef<TRow>[];
+    visibleColumns: ResolvedColumnDef<TRow>[];
+    allRows: RowNode<TRow>[];
+    filteredRows: RowNode<TRow>[];
+    sortedRows: RowNode<TRow>[];
+    visibleRows: RowNode<TRow>[];
+    displayRows: RowDisplayNode<TRow>[];
+    aggregation: AggregationResult[];
+    totalRowCount: number;
+    filteredRowCount: number;
+    visibleRowCount: number;
+    pageCount?: number;
+};
+export type VirtualRangeOptions = {
+    itemCount: number;
+    itemSize: number;
+    viewportSize: number;
+    scrollOffset: number;
+    overscan?: number;
+};
+export type InfiniteScrollTriggerOptions = {
+    rowCount: number;
+    lastVisibleRowIndex: number;
+    threshold?: number;
+    hasMoreRows?: boolean;
+    loading?: boolean;
+};
+export type InfiniteScrollTrigger = {
+    shouldLoadMore: boolean;
+    rowCount: number;
+    lastVisibleRowIndex: number;
+    threshold: number;
+    remainingRows: number;
+};
+export type VirtualRange = {
+    startIndex: number;
+    endIndex: number;
+    beforeSize: number;
+    afterSize: number;
+    totalSize: number;
+    items: VirtualItem[];
+};
+export type VirtualItem = {
+    index: number;
+    start: number;
+    size: number;
+    end: number;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/virtualizer.d.ts

@@ -0,0 +1,2 @@
+import type { VirtualRange, VirtualRangeOptions } from "./types.ts";
+export declare function getVirtualRange(options: VirtualRangeOptions): VirtualRange;

package/dist/virtualizer.js

@@ -0,0 +1,47 @@
+export function getVirtualRange(options) {
+    const itemCount = Math.max(0, options.itemCount);
+    const itemSize = Math.max(1, options.itemSize);
+    const viewportSize = Math.max(0, options.viewportSize);
+    const scrollOffset = Math.max(0, options.scrollOffset);
+    const overscan = Math.max(0, options.overscan ?? 3);
+    const totalSize = itemCount * itemSize;
+    if (itemCount === 0 || viewportSize === 0) {
+        return {
+            startIndex: 0,
+            endIndex: -1,
+            beforeSize: 0,
+            afterSize: 0,
+            totalSize,
+            items: [],
+        };
+    }
+    const visibleStart = Math.floor(scrollOffset / itemSize);
+    const visibleEnd = Math.ceil((scrollOffset + viewportSize) / itemSize) - 1;
+    const startIndex = clamp(visibleStart - overscan, 0, itemCount - 1);
+    const endIndex = clamp(visibleEnd + overscan, startIndex, itemCount - 1);
+    const items = createVirtualItems(startIndex, endIndex, itemSize);
+    return {
+        startIndex,
+        endIndex,
+        beforeSize: startIndex * itemSize,
+        afterSize: Math.max(0, totalSize - (endIndex + 1) * itemSize),
+        totalSize,
+        items,
+    };
+}
+function createVirtualItems(startIndex, endIndex, itemSize) {
+    const items = [];
+    for (let index = startIndex; index <= endIndex; index += 1) {
+        const start = index * itemSize;
+        items.push({
+            index,
+            start,
+            size: itemSize,
+            end: start + itemSize,
+        });
+    }
+    return items;
+}
+function clamp(value, min, max) {
+    return Math.min(Math.max(value, min), max);
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@youp-grid/core",
+  "version": "0.1.0",
+  "description": "Framework-agnostic data grid core for Youp Grid.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/SeungyoupBaek/youp-grid.git",
+    "directory": "packages/core"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json"
+  }
+}