@kronor/dtv 0.7.1 → 1.0.0

package/README.md

@@ -26,7 +26,7 @@ import type { AppProps } from '@kronor/dtv';
 All required styles are injected automatically via the JS bundle (using `vite-plugin-css-injected-by-js`).
 
 ### Runtime Options (AppProps)
-Key props you can pass to `App` (or via `renderTableView` in `main.tsx`):
+Key props you can pass to `App` (or via `dtv.renderTableView` in `main.tsx`):
 
 - `graphqlHost` / `graphqlToken`: GraphQL endpoint + bearer auth token.
 - `geminiApiKey`: API key used by the AI Filter Assistant.
@@ -41,7 +41,7 @@ Key props you can pass to `App` (or via `renderTableView` in `main.tsx`):
 
 Example:
 ```ts
-renderTableView('root', {
+dtv.renderTableView('root', {
   graphqlHost: 'https://example/graphql',
   graphqlToken: 'token',
   geminiApiKey: 'gemini-key',
@@ -75,7 +75,7 @@ React and ReactDOM 19 are peer dependencies; ensure they are installed in the ho
 - Data is fetched via GraphQL using `graphql-request` (see `src/framework/data.ts`).
 - Views define their own GraphQL queries and filter schemas.
 - Filter expressions are serialized/deserialized using helpers in `src/framework/filters.ts`.
- - Unified URL Filter Param: Both share links and persistence use a single base64 URL-safe encoded parameter `dtv-filter-state`. Enable syncing by passing `syncFilterStateToUrl: true` to `renderTableView` (or `?sync-filter-state-to-url=true` in dev). The param is updated only when filters are applied (not on every change). When disabled, a one-off link is consumed (param removed after load).
+ - Unified URL Filter Param: Both share links and persistence use a single base64 URL-safe encoded parameter `dtv-filter-state`. Enable syncing by passing `syncFilterStateToUrl: true` to `dtv.renderTableView` (or `?sync-filter-state-to-url=true` in dev). The param is updated only when filters are applied (not on every change). When disabled, a one-off link is consumed (param removed after load).
 
 ## Development
 
@@ -111,6 +111,41 @@ npm test
 npm run test
 ```
 
+## Release Process
+
+Automated release script performs validation (lint, build, unit + e2e tests), builds the library bundle, bumps the version, pushes git tags, and publishes to npm.
+
+### Run a release
+```sh
+npm run release
+```
+You'll be prompted for the semver bump (`patch`, `minor`, or `major`). Default is `patch` if you press Enter.
+
+### Options / Flags
+```sh
+npm run release -- --type=minor      # Non-interactive minor release
+npm run release -- --dry             # Run validations only; skip version/tag/publish
+npm run release -- --skip-e2e        # Skip Playwright tests (use sparingly)
+npm run release -- --skip-unit       # Skip Jest tests (NOT recommended)
+npm run release -- --allow-dirty     # Allow running with uncommitted changes (avoids safety check)
+```
+
+### Requirements
+- You must be authenticated with npm (`npm login`).
+- Git working tree must be clean (unless using `--allow-dirty`).
+- CI should pass for the commit you are releasing.
+
+### What it does
+1. Lints source code.
+2. Builds application (`npm run build`).
+3. Runs unit tests (Jest) and E2E tests (Playwright).
+4. Builds library bundle (`npm run build:lib`).
+5. Bumps version via `npm version <type>` (commit + tag).
+6. Pushes commit and tags.
+7. Publishes to npm (`npm publish --access public`).
+
+Use `--dry` first if you want to verify everything without changing the version or publishing.
+
 ## Examples
 - See `src/views/paymentRequest.tsx` for a full-featured view definition.
 - See `src/components/AIAssistantForm.tsx` for AI-driven filter generation.