@fieldia/grid 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fieldia-dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# @fieldia/grid
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A [Fieldia](https://fieldia.dev) table of lines as a spreadsheet, on
+[AG Grid Community](https://www.ag-grid.com/). Each cell is edited with
+Fieldia's own field for its type, wired to its line, so every keystroke
+reaches the form and computed values follow while a cell is being typed.
+
+```sh
+npm install @fieldia/grid ag-grid-community
+```
+
+```ts
+import { mountViewer } from '@fieldia/viewer';
+import { gridWidgets } from '@fieldia/grid';
+
+mountViewer(host, { page, dataSource, widgets: gridWidgets });
+```
+
+A one2many node opts in with `"widget": "grid"`; nodes without it keep the
+plain table, so pages that do not use the grid never load AG Grid. In React
+pass `widgets={gridWidgets}`, in Vue `:widgets="gridWidgets"`, in Angular
+`[widgets]="gridWidgets"`.
+
+```json
+{ "type": "field", "id": "f-lines", "field": "line_ids", "widget": "grid",
+  "totals": ["qty", "subtotal"], "optionalColumns": { "discount": "show" } }
+```
+
+- **Keys**: Enter keeps a cell and moves down, Tab moves across (skipping
+  cells that cannot be edited), Tab or Enter at the end starts a new line,
+  Escape puts a cell back, Space ticks yes/no, Alt+Up/Down moves a line.
+- **Sections and notes** (`lineKinds` on the field) run across the row; a
+  note grows as it is typed.
+- **Moving lines** by a handle, with a `sequenceField` on the field.
+- **Totals** under the lines, **columns** people resize, move and choose
+  (kept in the viewer's `preferences` store), **long tables** that scroll
+  inside, and `"editMode": "row"` to open a whole line at once.
+- **A refused save** marks the wrong cells and opens the first one.
+
+`gridApiOf(element)` returns the AG Grid API behind a grid, for an app that
+needs more than the page describes.
+
+MIT. AG Grid Community is MIT too; AG Grid Enterprise is not used.

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@fieldia/grid",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.3.0",
+  "description": "Fieldia's table of lines on AG Grid: spreadsheet editing with Fieldia's own fields in the cells.",
+  "license": "MIT",
+  "homepage": "https://fieldia.dev",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "module": "./src/index.mjs",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./src/index.d.mts",
+        "require": "./src/index.d.ts"
+      },
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@fieldia/core": "0.3.0",
+    "@fieldia/widgets": "0.3.0",
+    "tslib": "^2.8.1"
+  },
+  "peerDependencies": {
+    "ag-grid-community": "^36.0.0"
+  },
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fieldia-dev/fieldia",
+    "directory": "libs/grid"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ]
 }

package/src/index.d.mts

@@ -0,0 +1,2 @@
+export * from './lib/grid.mjs';
+export * from './lib/styles.mjs';

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/grid';
+export * from './lib/styles';

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/grid"), exports);
+tslib_1.__exportStar(require("./lib/styles"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/grid/src/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,uDAA6B"}

package/src/index.mjs

@@ -0,0 +1,3 @@
+export * from './lib/grid.mjs';
+export * from './lib/styles.mjs';
+//# sourceMappingURL=index.mjs.map

package/src/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../libs/grid/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/src/lib/grid.d.mts

@@ -0,0 +1,8 @@
+import { type GridApi } from 'ag-grid-community';
+import { type Line } from '@fieldia/core';
+import { type WidgetFactory } from '@fieldia/widgets';
+/** The AG Grid API behind a grid's element, for an app that needs more than the page describes. */
+export declare function gridApiOf(element: HTMLElement): GridApi<Line> | undefined;
+export declare const gridWidget: WidgetFactory;
+/** Pass these to the viewer (`widgets`) to show one2many nodes marked `"widget": "grid"` in the grid. */
+export declare const gridWidgets: Record<string, WidgetFactory>;

package/src/lib/grid.d.ts

@@ -0,0 +1,8 @@
+import { type GridApi } from 'ag-grid-community';
+import { type Line } from '@fieldia/core';
+import { type WidgetFactory } from '@fieldia/widgets';
+/** The AG Grid API behind a grid's element, for an app that needs more than the page describes. */
+export declare function gridApiOf(element: HTMLElement): GridApi<Line> | undefined;
+export declare const gridWidget: WidgetFactory;
+/** Pass these to the viewer (`widgets`) to show one2many nodes marked `"widget": "grid"` in the grid. */
+export declare const gridWidgets: Record<string, WidgetFactory>;