@weave-kit/client 0.1.0 → 0.1.1

package/README.md

@@ -1,64 +1,95 @@
-# @weave-kit/client
-
-Framework-agnostic TypeScript SDK for the WeaveKit engine. No DOM or UI-framework dependencies — usable in browsers, Node, or anywhere a `fetch` implementation exists.
-
-## Usage
-
-```ts
-import { createClient } from '@weave-kit/client';
-import type { Lead } from './generated/types';
-
-const client = createClient({ baseUrl: 'http://localhost:3000', apiKey: 'sk-admin' });
-const leads = client.objects<Lead>('lead');
-
-const result = await leads.find({
-  filter: { status: 'open' },
-  sort: [{ field: 'created_at', direction: 'desc' }],
-  limit: 20,
-});
-const one = await leads.findOne('L1'); // null on 404 (does not leak existence)
-const created = await leads.create({ title: 'New lead' });
-const updated = await leads.update('L1', { title: 'Renamed' });
-await leads.delete('L1');
-```
-
-## Object-level types
-
-`weave types` in your project compiles `schema.json` into `generated/types.ts`:
-
-```sh
-weave types   # → generated/types.ts
-```
-
-```ts
-import type { Lead } from './generated/types';
-const leads = createClient({ baseUrl, apiKey }).objects<Lead>('lead');
-```
-
-Every field type, enum union, and relation's primary-key type is derived from the schema. `objects<T>` defaults to `Record<string, unknown>` when you omit the type.
-
-## Methods
-
-`objects<T>(name)` returns:
-
-- `find(params?)` — `Promise<RestResult<T>>` (`{ rows, total, limit, offset }`)
-- `findOne(id, params?)` — `Promise<T | null>` (404 → null)
-- `create(data: Partial<T>)` — `Promise<T>`
-- `update(id, changes: Partial<T>)` — `Promise<T>`
-- `delete(id)` — `Promise<void>`
-
-## Errors
-
-Non-2xx responses throw `ClientError`:
-
-```ts
-try {
-  await leads.find();
-} catch (error) {
-  if (error instanceof ClientError) {
-    error.status; // 401/403/404/400/500
-    error.code;   // e.g. 'rbac.denied.read', 'auth.missingKey'
-    error.message;
-  }
-}
-```
+# @weave-kit/client
+
+> Framework-agnostic TypeScript SDK for the WeaveKit engine.
+
+No DOM or UI-framework dependencies — usable in browsers, Node.js, or anywhere a `fetch`
+implementation exists.
+
+## Install
+
+```sh
+npm install @weave-kit/client
+```
+
+Requires Node.js 24 LTS (for a Node runtime) or any modern browser.
+
+## Usage
+
+```ts
+import { createClient } from '@weave-kit/client';
+import type { Lead } from './generated/types';
+
+const client = createClient({ baseUrl: 'http://localhost:3000', apiKey: 'sk-admin' });
+const leads = client.objects<Lead>('lead');
+
+const result = await leads.find({
+  filter: { status: 'open' },
+  sort: [{ field: 'created_at', direction: 'desc' }],
+  limit: 20,
+});
+const one = await leads.findOne('L1'); // null on 404 (does not leak existence)
+const created = await leads.create({ title: 'New lead' });
+const updated = await leads.update('L1', { title: 'Renamed' });
+await leads.delete('L1');
+```
+
+## Methods
+
+`objects<T>(name)` returns:
+
+- `find(params?)` — `Promise<RestResult<T>>` (`{ rows, total, limit, offset }`)
+- `findOne(id, params?)` — `Promise<T | null>` (404 → null)
+- `create(data: Partial<T>)` — `Promise<T>`
+- `update(id, changes: Partial<T>)` — `Promise<T>`
+- `delete(id)` — `Promise<void>`
+
+The client also exposes `metadata`, `permissions`, `audit`, `approvals`, `guardrails`, `identities`,
+`layouts`, `schema`, `scripts`, and an SSE `subscribe` for live events.
+
+## Object-level types
+
+`weave types` in your engine project compiles `schema.json` into `generated/types.ts`:
+
+```sh
+weave types   # → generated/types.ts
+```
+
+```ts
+import type { Lead } from './generated/types';
+const leads = createClient({ baseUrl, apiKey }).objects<Lead>('lead');
+```
+
+Every field type, enum union, and relation's primary-key type is derived from the schema.
+`objects<T>` defaults to `Record<string, unknown>` when you omit the type.
+
+## Errors
+
+Non-2xx responses throw `ClientError`:
+
+```ts
+import { ClientError } from '@weave-kit/client';
+
+try {
+  await leads.find();
+} catch (error) {
+  if (error instanceof ClientError) {
+    error.status; // 401/403/404/400/500
+    error.code;   // e.g. 'rbac.denied.read', 'auth.missingKey'
+    error.message;
+  }
+}
+```
+
+## Development
+
+```sh
+npm install
+npm run build        # tsc → dist
+npm test
+npm run typecheck
+npm run lint
+```
+
+## License
+
+[MIT](LICENSE)

package/dist/scripts.d.ts

@@ -17,7 +17,7 @@ export interface ScriptSaveResult {
     version: string;
     warnings?: string[];
 }
-/** Page-scoped client script accessor (千页千面): `show.client`/`list.client`.
+/** Page-scoped client script accessor (per-page customization): `show.client`/`list.client`.
  *  Page-level (`/pages/<path>/scripts/<kind>`) overrides the object script for
  *  that page; block-level (`/pages/<path>/blocks/<ui_id>/scripts/<kind>`) scopes
  *  a script to one `list` block instance. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-kit/client",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "WeaveKit client — framework-agnostic TypeScript SDK",
   "type": "module",
   "main": "./dist/index.js",