@gp-grid/core 0.7.2

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,440 @@
+# gp-grid-core 🏁 🏎️
+
+<div align="center">
+    <a href="https://www.gp-grid.io">
+        <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/GioPat/gp-grid-docs/refs/heads/master/public/logo-light.svg"/>
+        <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/GioPat/gp-grid-docs/refs/heads/master/public/logo-dark.svg"/>
+        <img width="50%" alt="AG Grid Logo" src="https://raw.githubusercontent.com/GioPat/gp-grid-docs/refs/heads/master/public/logo-dark.svg"/>
+        </picture>
+    </a>
+    <div align="center">
+     Logo by <a href="https://github.com/camillo18tre">camillo18tre ❤️</a>
+      <h4><a href="https://www.gp-grid.io/">🎮 Demo</a> • <a href="https://www.gp-grid.io/docs">📖 Documentation</a>
+    </div>
+</div>
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/GioPat/gp-grid)
+
+A framework-agnostic TypeScript library for building high-performance data grids with high (millions) number of rows with ease.
+
+## Table of Contents
+
+- [Philosophy](#philosophy)
+- [Installation](#installation)
+- [Architecture Overview](#architecture-overview)
+- [Data Sources](#data-sources)
+- [Types Reference](#types-reference)
+- [Creating a Framework Adapter](#creating-a-framework-adapter)
+- [API Reference](#api-reference)
+- [Donations](#donations)
+
+## Available implementations
+
+- [**gp-grid-react**](https://www.npmjs.com/package/gp-grid-react) | Official
+- [**gp-grid-vue**](https://www.npmjs.com/package/gp-grid-vue) | Official
+
+## Philosophy
+
+**gp-grid-core** is built on three core principles:
+
+### 1. Slot-Based Virtual Scrolling
+
+Instead of rendering all rows, the grid maintains a pool of reusable "slots" (DOM containers) that are recycled as users scroll. This approach:
+
+- Renders only visible rows plus a small overscan buffer
+- Recycles DOM elements instead of creating/destroying them
+- Maintains consistent performance regardless of dataset size
+
+### 2. Instruction-Based Architecture
+
+The core emits declarative **instructions** (commands) that describe what the UI should do, rather than manipulating the DOM directly. This pattern:
+
+- Keeps the core framework-agnostic (works with React, Vue, Svelte, vanilla JS)
+- Enables batched updates for optimal rendering performance
+- Provides a clean separation between logic and presentation
+
+### 3. DataSource Abstraction
+
+Data fetching is abstracted through a `DataSource` interface, supporting both:
+
+- **Client-side**: All data loaded in memory, with local sorting/filtering
+- **Server-side**: Data fetched on-demand from an API with server-side operations
+
+## Installation
+
+npm/pnpm/yarn
+
+```bash
+pnpm add gp-grid-core
+```
+
+## Architecture Overview
+
+### GridCore
+
+The main orchestrator class that manages:
+
+- Viewport tracking and scroll synchronization
+- Slot pool lifecycle (create, assign, move, destroy)
+- Data fetching and caching
+- Sort and filter state
+
+```typescript
+import { GridCore, createClientDataSource } from "gp-grid-core";
+
+const dataSource = createClientDataSource(myData);
+
+const grid = new GridCore({
+  columns: [
+    { field: "name", cellDataType: "text", width: 150 },
+    { field: "age", cellDataType: "number", width: 80 },
+  ],
+  dataSource,
+  rowHeight: 36,
+  headerHeight: 40,
+  overscan: 3,
+});
+
+// Subscribe to instructions
+grid.onBatchInstruction((instructions) => {
+  // Handle UI updates based on instructions
+  instructions.forEach((instruction) => {
+    switch (instruction.type) {
+      case "CREATE_SLOT":
+        // Create a new row container
+        break;
+      case "ASSIGN_SLOT":
+        // Assign row data to a slot
+        break;
+      case "MOVE_SLOT":
+        // Position slot via translateY
+        break;
+      // ... handle other instructions
+    }
+  });
+});
+
+// Initialize and start
+await grid.initialize();
+```
+
+### Managers
+
+GridCore includes specialized managers for complex behaviors:
+
+- **SelectionManager**: Handles cell selection, range selection, keyboard navigation
+- **FillManager**: Implements Excel-like fill handle drag operations
+
+### Instruction Types
+
+The core emits these instruction types:
+
+| Instruction                                   | Description                       |
+| --------------------------------------------- | --------------------------------- |
+| `CREATE_SLOT`                                 | Create a new slot in the DOM pool |
+| `DESTROY_SLOT`                                | Remove a slot from the pool       |
+| `ASSIGN_SLOT`                                 | Assign row data to a slot         |
+| `MOVE_SLOT`                                   | Update slot position (translateY) |
+| `SET_ACTIVE_CELL`                             | Update active cell highlight      |
+| `SET_SELECTION_RANGE`                         | Update selection range            |
+| `START_EDIT` / `STOP_EDIT`                    | Toggle edit mode                  |
+| `COMMIT_EDIT`                                 | Commit edited value               |
+| `UPDATE_HEADER`                               | Update header with sort state     |
+| `DATA_LOADING` / `DATA_LOADED` / `DATA_ERROR` | Data fetch lifecycle              |
+
+## Data Sources
+
+### Client-Side Data Source
+
+For datasets that can be loaded entirely in memory. Sorting and filtering are performed client-side.
+
+```typescript
+import { createClientDataSource } from "gp-grid-core";
+
+interface Person {
+  id: number;
+  name: string;
+  age: number;
+  email: string;
+}
+
+const data: Person[] = [
+  { id: 1, name: "Alice", age: 30, email: "alice@example.com" },
+  { id: 2, name: "Bob", age: 25, email: "bob@example.com" },
+  // ... more rows
+];
+
+const dataSource = createClientDataSource(data);
+```
+
+**With custom field accessor** (for nested properties):
+
+```typescript
+const dataSource = createClientDataSource(data, {
+  getFieldValue: (row, field) => {
+    // Custom logic for accessing nested fields
+    if (field === "address.city") {
+      return row.address?.city;
+    }
+    return row[field];
+  },
+});
+```
+
+### Server-Side Data Source
+
+For large datasets that require server-side pagination, sorting, and filtering.
+
+```typescript
+import {
+  createServerDataSource,
+  DataSourceRequest,
+  DataSourceResponse,
+} from "gp-grid-core";
+
+interface Person {
+  id: number;
+  name: string;
+  age: number;
+}
+
+const dataSource = createServerDataSource<Person>(
+  async (request: DataSourceRequest) => {
+    // Build query parameters from request
+    const params = new URLSearchParams({
+      page: String(request.pagination.pageIndex),
+      pageSize: String(request.pagination.pageSize),
+    });
+
+    // Add sort parameters
+    if (request.sort && request.sort.length > 0) {
+      params.set(
+        "sortBy",
+        request.sort.map((s) => `${s.colId}:${s.direction}`).join(","),
+      );
+    }
+
+    // Add filter parameters
+    if (request.filter) {
+      Object.entries(request.filter).forEach(([field, value]) => {
+        params.set(`filter_${field}`, value);
+      });
+    }
+
+    // Fetch from your API
+    const response = await fetch(`/api/people?${params}`);
+    const data = await response.json();
+
+    return {
+      rows: data.items,
+      totalRows: data.totalCount,
+    };
+  },
+);
+```
+
+### DataSource Interface
+
+Both data source types implement this interface:
+
+```typescript
+interface DataSource<TData = Row> {
+  fetch(request: DataSourceRequest): Promise<DataSourceResponse<TData>>;
+}
+
+interface DataSourceRequest {
+  pagination: {
+    pageIndex: number;
+    pageSize: number;
+  };
+  sort?: SortModel[];
+  filter?: FilterModel;
+}
+
+interface DataSourceResponse<TData> {
+  rows: TData[];
+  totalRows: number;
+}
+```
+
+## Types Reference
+
+### ColumnDefinition
+
+```typescript
+interface ColumnDefinition {
+  field: string; // Property path in row data
+  colId?: string; // Unique column ID (defaults to field)
+  cellDataType: CellDataType; // "text" | "number" | "boolean" | "date" | "object"
+  width: number; // Column width in pixels
+  headerName?: string; // Display name (defaults to field)
+  editable?: boolean; // Enable cell editing
+  cellRenderer?: string; // Custom renderer key
+  editRenderer?: string; // Custom edit renderer key
+  headerRenderer?: string; // Custom header renderer key
+}
+```
+
+### Renderer Params
+
+When building framework adapters, these params are passed to custom renderers:
+
+```typescript
+interface CellRendererParams {
+  value: CellValue;
+  rowData: Row;
+  column: ColumnDefinition;
+  rowIndex: number;
+  colIndex: number;
+  isActive: boolean;
+  isSelected: boolean;
+  isEditing: boolean;
+}
+
+interface EditRendererParams extends CellRendererParams {
+  initialValue: CellValue;
+  onValueChange: (newValue: CellValue) => void;
+  onCommit: () => void;
+  onCancel: () => void;
+}
+
+interface HeaderRendererParams {
+  column: ColumnDefinition;
+  colIndex: number;
+  sortDirection?: SortDirection;
+  sortIndex?: number;
+  onSort: (direction: SortDirection | null, addToExisting: boolean) => void;
+}
+```
+
+## Creating a Framework Adapter
+
+To integrate gp-grid-core with any UI framework:
+
+1. **Subscribe to instructions** using `onBatchInstruction()`
+2. **Maintain UI state** by processing instructions
+3. **Render slots** based on the slot pool state
+4. **Forward user interactions** back to GridCore
+
+### Example: Minimal Adapter Pattern
+
+```typescript
+import { GridCore, GridInstruction } from "gp-grid-core";
+
+class MyGridAdapter {
+  private core: GridCore;
+  private slots: Map<string, SlotUIElement> = new Map();
+
+  constructor(options: GridCoreOptions) {
+    this.core = new GridCore(options);
+
+    // Process instructions to update UI
+    this.core.onBatchInstruction((instructions) => {
+      this.processInstructions(instructions);
+      this.render();
+    });
+  }
+
+  private processInstructions(instructions: GridInstruction[]) {
+    for (const instr of instructions) {
+      switch (instr.type) {
+        case "CREATE_SLOT":
+          this.slots.set(instr.slotId, this.createSlotElement());
+          break;
+        case "DESTROY_SLOT":
+          this.slots.delete(instr.slotId);
+          break;
+        case "ASSIGN_SLOT":
+          const slot = this.slots.get(instr.slotId);
+          if (slot) {
+            slot.rowIndex = instr.rowIndex;
+            slot.rowData = instr.rowData;
+          }
+          break;
+        case "MOVE_SLOT":
+          const moveSlot = this.slots.get(instr.slotId);
+          if (moveSlot) {
+            moveSlot.translateY = instr.translateY;
+          }
+          break;
+      }
+    }
+  }
+
+  // Handle scroll events
+  onScroll(
+    scrollTop: number,
+    scrollLeft: number,
+    width: number,
+    height: number,
+  ) {
+    this.core.setViewport(scrollTop, scrollLeft, width, height);
+  }
+
+  // Handle cell click
+  onCellClick(
+    row: number,
+    col: number,
+    modifiers: { shift: boolean; ctrl: boolean },
+  ) {
+    this.core.selection.startSelection({ row, col }, modifiers);
+  }
+
+  async initialize() {
+    await this.core.initialize();
+  }
+}
+```
+
+## API Reference
+
+### GridCore Methods
+
+| Method                                              | Description                           |
+| --------------------------------------------------- | ------------------------------------- |
+| `initialize()`                                      | Initialize grid and load initial data |
+| `setViewport(scrollTop, scrollLeft, width, height)` | Update viewport on scroll/resize      |
+| `setSort(colId, direction, addToExisting)`          | Set column sort                       |
+| `setFilter(colId, value)`                           | Set column filter                     |
+| `startEdit(row, col)`                               | Start editing a cell                  |
+| `commitEdit()`                                      | Commit current edit                   |
+| `cancelEdit()`                                      | Cancel current edit                   |
+| `refresh()`                                         | Refetch data from source              |
+| `getRowCount()`                                     | Get total row count                   |
+| `getRowData(rowIndex)`                              | Get data for a specific row           |
+
+### GridCore Properties
+
+| Property    | Description               |
+| ----------- | ------------------------- |
+| `selection` | SelectionManager instance |
+| `fill`      | FillManager instance      |
+
+## Donations
+
+Keeping this library requires effort and passion, I'm a full time engineer employed on other project and I'm trying my best to keep this work free! For all the features.
+
+If you think this project helped you achieve your goals, it's hopefully worth a beer! 🍻
+
+<div align="center">
+
+### Paypal
+
+[![Paypal QR Code](../../public/images/donazione_paypal.png "Paypal QR Code donation")](https://www.paypal.com/donate/?hosted_button_id=XCNMG6BR4ZMLY)
+
+[https://www.paypal.com/donate/?hosted_button_id=XCNMG6BR4ZMLY](https://www.paypal.com/donate/?hosted_button_id=XCNMG6BR4ZMLY)
+
+### Bitcoin
+
+[![Bitcoin QR Donation](../../public/images/bc1qcukwmzver59eyqq442xyzscmxavqjt568kkc9m.png "Bitcoin QR Donation")](bitcoin:bc1qcukwmzver59eyqq442xyzscmxavqjt568kkc9m)
+
+bitcoin:bc1qcukwmzver59eyqq442xyzscmxavqjt568kkc9m
+
+### Lightning Network
+
+[![Lightning Network QR Donation](../../public/images/lightning.png "Lightning Network QR Donation")](lnurl1dp68gurn8ghj7ampd3kx2ar0veekzar0wd5xjtnrdakj7tnhv4kxctttdehhwm30d3h82unvwqhhx6rpvanhjetdvfjhyvf4xs0xu5p7)
+
+lnurl1dp68gurn8ghj7ampd3kx2ar0veekzar0wd5xjtnrdakj7tnhv4kxctttdehhwm30d3h82unvwqhhx6rpvanhjetdvfjhyvf4xs0xu5p7
+
+</div>