@topgrid/grid 0.1.0

package/README.md

@@ -0,0 +1,115 @@
+# @topgrid/grid
+
+> **Meta package facade** — re-exports the public API of all 13 underlying packages
+> (`@topgrid/grid-*`). Activates a single entry point per ADR-MOD-GRID-REFACTOR-2026-05-17-003.
+
+## What's Included
+
+### MIT packages (4)
+
+| Package | Description |
+|---------|-------------|
+| `@topgrid/grid-core` | TanStack Table abstraction + `<Grid>` + `useGridState` + legacy aliases (BaseGrid, VirtualGrid, ColumnPinGrid, TreeGrid) + pagination + `createColumns` + column-drag + multi-sort base |
+| `@topgrid/grid-renderers` | Cell renderers (Text, Number, Date, StatusBadge, Link, Button, Check, Icon, Tag, Avatar, Progress) + `EditableCell` + `defaultRendererRegistry` (canonical) |
+| `@topgrid/grid-features` | Filter UI (Text/Number/Date/Select) + `useMultiSort` + filter primitives |
+| `@topgrid/grid-export` | Excel / CSV / PDF export + clipboard + print |
+
+### Pro packages (7)
+
+| Package | Description |
+|---------|-------------|
+| `@topgrid/grid-pro-tracking` | Change tracking + `ChangeTrackingGrid` |
+| `@topgrid/grid-pro-range` | Cell range selection + keyboard nav + clipboard + drag-fill |
+| `@topgrid/grid-pro-datamap` | DataMap / AsyncDataMap (lookup tables, async loading) |
+| `@topgrid/grid-pro-merging` | Cell merging (rowSpan) |
+| `@topgrid/grid-pro-header` | Multi-row grouped headers + `GroupedHeaderGrid` (canonical) |
+| `@topgrid/grid-pro-agg` | Aggregation + grouping + `GroupPanel` |
+| `@topgrid/grid-pro-master` | Master-detail row expansion + context menu + row pinning + expanded persistence |
+
+### Infrastructure (1)
+
+| Package | Description |
+|---------|-------------|
+| `@topgrid/grid-license` | License gate utilities (`setLicenseKey`, `checkLicense`, `Watermark`) |
+
+## Usage
+
+```ts
+// Single entry — convenient for app-side consumers using both MIT and Pro features.
+import { Grid, createColumns, NumberCell, StatusBadgeCell, setLicenseKey } from '@topgrid/grid';
+import type { GridProps, TomisColumnDef } from '@topgrid/grid';
+```
+
+```ts
+// Pro features remain license-gated at module load (each sub-package runs `checkLicense()`).
+import { setLicenseKey } from '@topgrid/grid';
+import { MasterDetailGrid, RangeSelectGrid } from '@topgrid/grid';
+
+setLicenseKey('your-license-key');
+```
+
+## MIT-only consumption
+
+Importing from `@topgrid/grid` brings in the full Pro surface (license-gated at runtime).
+For **MIT-only** applications (no license key, no Pro packages installed), import the
+underlying MIT packages directly:
+
+```bash
+pnpm add @topgrid/grid-core @topgrid/grid-renderers @topgrid/grid-features @topgrid/grid-export
+```
+
+```ts
+import { Grid, createColumns } from '@topgrid/grid-core';
+import { NumberCell } from '@topgrid/grid-renderers';
+```
+
+## Tree-shaking
+
+The meta facade is built with `tsup` + `treeshake: true` and emits a thin re-export
+shim (~1.5 KB dist). Consumer bundlers (Vite, esbuild, webpack) follow the re-export
+chain and bundle only what your app actually imports.
+
+Side-effect imports (notably `@topgrid/grid-renderers`' `wireDefaultRenderers()` — see
+ADR-MOD-GRID-REFACTOR-2026-05-17-002) are preserved via the `sideEffects` field.
+
+## Collision handling
+
+The facade resolves the 5 cross-package name collisions (probed via TypeScript) by
+canonicalizing exports:
+
+| Identifier | Canonical source | Reason |
+|------------|------------------|--------|
+| `defaultRendererRegistry`, `registerRenderer` | `@topgrid/grid-renderers` | grid-core's are placeholder fallback (ADR-002 D-3A) |
+| `TomisColumnDef` (type) | `@topgrid/grid-core` | grid-pro-datamap's alias is `@deprecated` (ADR-006) |
+| `GroupedHeaderGrid`, `GroupedHeaderGridProps` | `@topgrid/grid-pro-header` | grid-core's `legacy/` are C-6 alias |
+
+The 6 `@deprecated` APIs from `@topgrid/grid-core` (per ADR-013) are **not** re-exported
+through the facade:
+
+- `createTomisColumnHelper`
+- `createGroupedColumns`, `TomisColumnGroup`
+- `useColumnPersistence`
+- `ColumnVisibilityMenu`, `ColumnVisibilityMenuProps`
+
+To use them during deprecation, import directly from `@topgrid/grid-core`.
+
+## Peer Dependencies
+
+| Package | Version |
+|---------|---------|
+| `@tanstack/react-table` | `^8.0.0` |
+| `@tanstack/react-virtual` | `^3.0.0` (optional) |
+| `react` | `^18.0.0 \|\| ^19.0.0` |
+| `react-dom` | `^18.0.0 \|\| ^19.0.0` |
+| `xlsx` | `^0.18.0` (optional) |
+| `jspdf` | `^2.5.0` (optional) |
+| `jspdf-autotable` | `^3.5.0` (optional) |
+
+## License
+
+`SEE LICENSE IN EULA` (meta includes Pro packages). For MIT-only consumption, install
+the four MIT packages individually — see [MIT-only consumption](#mit-only-consumption).
+
+---
+
+[Documentation](https://grid.tomis.dev) | [API Reference](https://grid.tomis.dev/api)

package/dist/index.cjs

@@ -0,0 +1,163 @@
+'use strict';
+
+var gridCore = require('@topgrid/grid-core');
+var gridRenderers = require('@topgrid/grid-renderers');
+var gridFeatures = require('@topgrid/grid-features');
+var gridExport = require('@topgrid/grid-export');
+var gridLicense = require('@topgrid/grid-license');
+var gridProTracking = require('@topgrid/grid-pro-tracking');
+var gridProRange = require('@topgrid/grid-pro-range');
+var gridProDatamap = require('@topgrid/grid-pro-datamap');
+var gridProMerging = require('@topgrid/grid-pro-merging');
+var gridProHeader = require('@topgrid/grid-pro-header');
+var gridProAgg = require('@topgrid/grid-pro-agg');
+var gridProMaster = require('@topgrid/grid-pro-master');
+
+
+
+Object.defineProperty(exports, "BaseGrid", {
+  enumerable: true,
+  get: function () { return gridCore.BaseGrid; }
+});
+Object.defineProperty(exports, "ColumnPinGrid", {
+  enumerable: true,
+  get: function () { return gridCore.ColumnPinGrid; }
+});
+Object.defineProperty(exports, "DropIndicator", {
+  enumerable: true,
+  get: function () { return gridCore.DropIndicator; }
+});
+Object.defineProperty(exports, "Grid", {
+  enumerable: true,
+  get: function () { return gridCore.Grid; }
+});
+Object.defineProperty(exports, "GridPagination", {
+  enumerable: true,
+  get: function () { return gridCore.GridPagination; }
+});
+Object.defineProperty(exports, "PageSizeSelect", {
+  enumerable: true,
+  get: function () { return gridCore.PageSizeSelect; }
+});
+Object.defineProperty(exports, "SortBadge", {
+  enumerable: true,
+  get: function () { return gridCore.SortBadge; }
+});
+Object.defineProperty(exports, "SortClearButton", {
+  enumerable: true,
+  get: function () { return gridCore.SortClearButton; }
+});
+Object.defineProperty(exports, "TotalCount", {
+  enumerable: true,
+  get: function () { return gridCore.TotalCount; }
+});
+Object.defineProperty(exports, "TreeGrid", {
+  enumerable: true,
+  get: function () { return gridCore.TreeGrid; }
+});
+Object.defineProperty(exports, "VirtualGrid", {
+  enumerable: true,
+  get: function () { return gridCore.VirtualGrid; }
+});
+Object.defineProperty(exports, "createColumns", {
+  enumerable: true,
+  get: function () { return gridCore.createColumns; }
+});
+Object.defineProperty(exports, "useColumnDrag", {
+  enumerable: true,
+  get: function () { return gridCore.useColumnDrag; }
+});
+Object.defineProperty(exports, "useColumnOrderPersist", {
+  enumerable: true,
+  get: function () { return gridCore.useColumnOrderPersist; }
+});
+Object.defineProperty(exports, "useGridState", {
+  enumerable: true,
+  get: function () { return gridCore.useGridState; }
+});
+Object.defineProperty(exports, "useStoragePersist", {
+  enumerable: true,
+  get: function () { return gridCore.useStoragePersist; }
+});
+Object.defineProperty(exports, "useUrlSync", {
+  enumerable: true,
+  get: function () { return gridCore.useUrlSync; }
+});
+Object.defineProperty(exports, "DataMapCell", {
+  enumerable: true,
+  get: function () { return gridProDatamap.DataMapCell; }
+});
+Object.defineProperty(exports, "DataMapEditor", {
+  enumerable: true,
+  get: function () { return gridProDatamap.DataMapEditor; }
+});
+Object.defineProperty(exports, "createAsyncDataMap", {
+  enumerable: true,
+  get: function () { return gridProDatamap.createAsyncDataMap; }
+});
+Object.defineProperty(exports, "createDataMap", {
+  enumerable: true,
+  get: function () { return gridProDatamap.createDataMap; }
+});
+Object.keys(gridRenderers).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridRenderers[k]; }
+  });
+});
+Object.keys(gridFeatures).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridFeatures[k]; }
+  });
+});
+Object.keys(gridExport).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridExport[k]; }
+  });
+});
+Object.keys(gridLicense).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridLicense[k]; }
+  });
+});
+Object.keys(gridProTracking).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProTracking[k]; }
+  });
+});
+Object.keys(gridProRange).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProRange[k]; }
+  });
+});
+Object.keys(gridProMerging).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProMerging[k]; }
+  });
+});
+Object.keys(gridProHeader).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProHeader[k]; }
+  });
+});
+Object.keys(gridProAgg).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProAgg[k]; }
+  });
+});
+Object.keys(gridProMaster).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return gridProMaster[k]; }
+  });
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs","sourcesContent":[]}

package/dist/index.d.cts

@@ -0,0 +1,12 @@
+export { BaseGrid, BaseGridProps, ColumnInfo, ColumnPersistenceOptions, ColumnPinGrid, ColumnPinGridProps, DragThProps, DropIndicator, Grid, GridColumnResizeMode, GridHandle, GridPagination, GridPaginationOptions, GridPaginationProps, GridProps, GridRowSelectionOptions, GridScrollToOptions, GridState, GridStateKey, GridStateValues, PageSizeSelect, PageSizeSelectProps, PaginationMode, PersistTarget, RendererFn, RendererRegistry, RowSelectionMode, SortBadge, SortBadgeProps, SortClearButton, SortClearButtonProps, TomisColumnDef, TomisColumnType, TotalCount, TotalCountProps, TreeGrid, TreeGridProps, UseColumnDragProps, UseColumnDragReturn, UseColumnOrderPersistProps, UseGridStateOptions, UseStoragePersistOptions, UseUrlSyncOptions, VirtualGrid, VirtualGridProps, createColumns, useColumnDrag, useColumnOrderPersist, useGridState, useStoragePersist, useUrlSync } from '@topgrid/grid-core';
+export * from '@topgrid/grid-renderers';
+export * from '@topgrid/grid-features';
+export * from '@topgrid/grid-export';
+export * from '@topgrid/grid-license';
+export * from '@topgrid/grid-pro-tracking';
+export * from '@topgrid/grid-pro-range';
+export { AsyncDataMap, AsyncDataMapState, CreateAsyncDataMapOptions, CreateDataMapOptions, DataMap, DataMapCell, DataMapCellProps, DataMapColumnDef, DataMapEditor, DataMapEditorProps, PathOrAccessor, createAsyncDataMap, createDataMap } from '@topgrid/grid-pro-datamap';
+export * from '@topgrid/grid-pro-merging';
+export * from '@topgrid/grid-pro-header';
+export * from '@topgrid/grid-pro-agg';
+export * from '@topgrid/grid-pro-master';

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { BaseGrid, BaseGridProps, ColumnInfo, ColumnPersistenceOptions, ColumnPinGrid, ColumnPinGridProps, DragThProps, DropIndicator, Grid, GridColumnResizeMode, GridHandle, GridPagination, GridPaginationOptions, GridPaginationProps, GridProps, GridRowSelectionOptions, GridScrollToOptions, GridState, GridStateKey, GridStateValues, PageSizeSelect, PageSizeSelectProps, PaginationMode, PersistTarget, RendererFn, RendererRegistry, RowSelectionMode, SortBadge, SortBadgeProps, SortClearButton, SortClearButtonProps, TomisColumnDef, TomisColumnType, TotalCount, TotalCountProps, TreeGrid, TreeGridProps, UseColumnDragProps, UseColumnDragReturn, UseColumnOrderPersistProps, UseGridStateOptions, UseStoragePersistOptions, UseUrlSyncOptions, VirtualGrid, VirtualGridProps, createColumns, useColumnDrag, useColumnOrderPersist, useGridState, useStoragePersist, useUrlSync } from '@topgrid/grid-core';
+export * from '@topgrid/grid-renderers';
+export * from '@topgrid/grid-features';
+export * from '@topgrid/grid-export';
+export * from '@topgrid/grid-license';
+export * from '@topgrid/grid-pro-tracking';
+export * from '@topgrid/grid-pro-range';
+export { AsyncDataMap, AsyncDataMapState, CreateAsyncDataMapOptions, CreateDataMapOptions, DataMap, DataMapCell, DataMapCellProps, DataMapColumnDef, DataMapEditor, DataMapEditorProps, PathOrAccessor, createAsyncDataMap, createDataMap } from '@topgrid/grid-pro-datamap';
+export * from '@topgrid/grid-pro-merging';
+export * from '@topgrid/grid-pro-header';
+export * from '@topgrid/grid-pro-agg';
+export * from '@topgrid/grid-pro-master';

package/dist/index.mjs

@@ -0,0 +1,14 @@
+export { BaseGrid, ColumnPinGrid, DropIndicator, Grid, GridPagination, PageSizeSelect, SortBadge, SortClearButton, TotalCount, TreeGrid, VirtualGrid, createColumns, useColumnDrag, useColumnOrderPersist, useGridState, useStoragePersist, useUrlSync } from '@topgrid/grid-core';
+export * from '@topgrid/grid-renderers';
+export * from '@topgrid/grid-features';
+export * from '@topgrid/grid-export';
+export * from '@topgrid/grid-license';
+export * from '@topgrid/grid-pro-tracking';
+export * from '@topgrid/grid-pro-range';
+export { DataMapCell, DataMapEditor, createAsyncDataMap, createDataMap } from '@topgrid/grid-pro-datamap';
+export * from '@topgrid/grid-pro-merging';
+export * from '@topgrid/grid-pro-header';
+export * from '@topgrid/grid-pro-agg';
+export * from '@topgrid/grid-pro-master';
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs","sourcesContent":[]}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@topgrid/grid",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "SEE LICENSE IN EULA",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Meta package — aggregates all @topgrid/grid-* packages (MIT + Pro facade)",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "sideEffects": [
+    "./src/index.ts",
+    "./dist/index.mjs",
+    "./dist/index.cjs"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@topgrid/grid-core": "0.1.0",
+    "@topgrid/grid-features": "0.3.0",
+    "@topgrid/grid-renderers": "0.1.0",
+    "@topgrid/grid-export": "0.2.0",
+    "@topgrid/grid-license": "0.1.0",
+    "@topgrid/grid-pro-range": "0.1.0",
+    "@topgrid/grid-pro-datamap": "0.2.0",
+    "@topgrid/grid-pro-header": "0.1.0",
+    "@topgrid/grid-pro-tracking": "0.1.0",
+    "@topgrid/grid-pro-merging": "0.1.0",
+    "@topgrid/grid-pro-agg": "0.1.0",
+    "@topgrid/grid-pro-master": "0.1.0"
+  },
+  "peerDependencies": {
+    "@tanstack/react-table": "^8.0.0",
+    "@tanstack/react-virtual": "^3.0.0",
+    "jspdf": "^2.5.0",
+    "jspdf-autotable": "^3.5.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "xlsx": "^0.18.0"
+  },
+  "peerDependenciesMeta": {
+    "@tanstack/react-virtual": {
+      "optional": true
+    },
+    "jspdf": {
+      "optional": true
+    },
+    "jspdf-autotable": {
+      "optional": true
+    },
+    "xlsx": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "echo TODO"
+  }
+}