nodestack-client 1.3.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,341 +1,399 @@
1
- # 🚀 nodestack-client
2
-
3
- > **The Official Lightweight, Type-Safe JavaScript & TypeScript Client SDK for [NodeStack](https://github.com/satya-jugran/nodestack)**
4
- >
5
- > Published on npm: [`nodestack-client`](https://www.npmjs.com/package/nodestack-client)
6
-
7
- [![npm version](https://img.shields.io/npm/v/nodestack-client.svg?color=blue)](https://www.npmjs.com/package/nodestack-client)
8
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
9
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
-
11
- A zero-dependency, isomorphic JavaScript and TypeScript client for NodeStack with out-of-the-box support for:
12
- - ⚡ **Zero runtime dependencies**: Built purely on standard Web APIs (`fetch`, `FormData`, `AbortController`, `EventSource`).
13
- - ðŸŠķ **Ultra-lightweight footprint**: `< 10 KB` minified + gzipped.
14
- - 🔒 **Pluggable & Reactive Auth**: `LocalAuthStore` (localStorage), `MemoryAuthStore` (Node/SSR/testing), and reactive `onChange` state subscriptions.
15
- - ðŸ“Ķ **Fluent Record CRUD & Batch Pagination**: `getList`, `getFullList`, `getFirstListItem`, `create`, `update`, `delete`, `export`, and `import`.
16
- - 🔍 **SQLite FTS5 Full-Text Search**: Embedded BM25 relevance ranking, keyword prefix matching, and contextual snippet highlighting.
17
- - 🔔 **Outbound Webhooks Service**: Programmatic webhook registration, test dispatch, delivery inspection, and HMAC-SHA256 signature verification (`client.webhooks`).
18
- - 📁 **File Uploads & Protected File URLs**: Seamless `FormData` file uploads and URL generation with automatic token appending.
19
- - ðŸ“Ą **Multiplexed Realtime SSE**: Single persistent connection with auto-handshake (`NS_CONNECT`), dynamic subscription sync, and automatic reconnection.
20
- - ðŸŽŊ **100% Type Safety**: Works seamlessly with `nodestack typegen` and `GET /api/types.d.ts` for autocompleted collection names and typed record returns.
21
- - 🌐 **Isomorphic**: Modern Browsers, React / Next.js (SSR + Client), Vue, Svelte, Node.js (18+ / 22+), Bun, Deno, and React Native.
22
-
23
- ---
24
-
25
- ## ðŸ“Ķ Installation
26
-
27
- ```bash
28
- npm install nodestack-client
29
- ```
30
-
31
- Or using Yarn / PNPM / Bun:
32
- ```bash
33
- pnpm add nodestack-client
34
- # or
35
- bun add nodestack-client
36
- ```
37
-
38
- ---
39
-
40
- ## ⚡ Quick Start
41
-
42
- ```typescript
43
- import { NodeStackClient } from 'nodestack-client';
44
-
45
- // Initialize client
46
- const client = new NodeStackClient('http://127.0.0.1:8090');
47
-
48
- // Fetch paginated records
49
- const result = await client.collection('posts').getList(1, 20, {
50
- filter: "status = 'published' && views >= 10",
51
- sort: '-created',
52
- });
53
-
54
- console.log(`Found ${result.totalItems} posts:`, result.items);
55
- ```
56
-
57
- ---
58
-
59
- ## 🔐 Authentication
60
-
61
- ### Authenticate as an Auth Collection User (e.g. `users`)
62
- ```typescript
63
- const authData = await client.collection('users').authWithPassword('alice@example.com', 'password123');
64
-
65
- console.log('Logged in user:', client.authStore.model);
66
- console.log('JWT Token:', client.authStore.token);
67
- console.log('Is valid:', client.authStore.isValid);
68
- ```
69
-
70
- ### Authenticate as a Superuser / Admin
71
- ```typescript
72
- const adminAuth = await client.admins.authWithPassword('admin@nodestack.io', 'MySecretAdminPassword');
73
- console.log('Logged in superuser:', adminAuth.admin.email);
74
- ```
75
-
76
- ### Reactive Auth State Changes
77
- ```typescript
78
- // Subscribe to login / logout events (ideal for React, Vue, Svelte stores)
79
- const unbind = client.authStore.onChange((token, model) => {
80
- console.log('Auth state changed:', { token, model });
81
- });
82
-
83
- // Logout
84
- client.authStore.clear();
85
-
86
- // Unsubscribe listener
87
- unbind();
88
- ```
89
-
90
- ### SSR & Node.js Environments (`MemoryAuthStore`)
91
- In Node.js scripts or server-side rendering where `window.localStorage` is unavailable:
92
- ```typescript
93
- import { NodeStackClient, MemoryAuthStore } from 'nodestack-client';
94
-
95
- const serverClient = new NodeStackClient('http://127.0.0.1:8090', {
96
- authStore: new MemoryAuthStore(),
97
- });
98
- ```
99
-
100
- ---
101
-
102
- ## 📋 Record Operations (CRUD)
103
-
104
- ### 1. Fetch Paginated Records (`getList`)
105
- ```typescript
106
- const result = await client.collection('posts').getList(1, 10, {
107
- filter: "category = 'Tech' && price <= 50",
108
- sort: '-created,title',
109
- expand: 'author,comments',
110
- });
111
-
112
- console.log(result.page, result.totalPages, result.items);
113
- ```
114
-
115
- ### 2. Full-Text Search with BM25 Scoring & Snippets (`search`)
116
- Query records using embedded SQLite FTS5 with BM25 relevance ranking and keyword highlight snippets:
117
- ```typescript
118
- const searchResults = await client.collection('posts').getList(1, 10, {
119
- search: 'distributed systems',
120
- snippetTag: 'mark', // Highlight tag (default: <mark>)
121
- snippetLength: 25, // Max words per snippet excerpt
122
- });
123
-
124
- console.log(searchResults.items[0]._score); // BM25 relevance score
125
- console.log(searchResults.items[0]._snippet); // Best matching snippet excerpt
126
- console.log(searchResults.items[0]._snippets); // Per-field snippet map: { title: "...", content: "..." }
127
- ```
128
-
129
- ### 3. Fetch All Records Across Pages (`getFullList`)
130
- Auto-paginates in batches and returns all matching records as a single array:
131
- ```typescript
132
- const allPosts = await client.collection('posts').getFullList({
133
- batch: 200,
134
- filter: "published = true",
135
- });
136
- ```
137
-
138
- ### 4. Find First Matching Record (`getFirstListItem`)
139
- ```typescript
140
- // Throws ClientResponseError(404) if no match is found
141
- const post = await client.collection('posts').getFirstListItem("slug = 'hello-world'");
142
- ```
143
-
144
- ### 5. Create Record (JSON or File Uploads)
145
- ```typescript
146
- // Plain JSON
147
- const newPost = await client.collection('posts').create({
148
- title: 'My First Post',
149
- published: true,
150
- });
151
-
152
- // Multipart Form Data (File Upload)
153
- const formData = new FormData();
154
- formData.append('title', 'Post with Cover Photo');
155
- formData.append('coverImage', fileInput.files[0]);
156
-
157
- const postWithImage = await client.collection('posts').create(formData);
158
- ```
159
-
160
- ### 6. Update & Delete Records
161
- ```typescript
162
- // Update
163
- const updated = await client.collection('posts').update('rec_123', {
164
- title: 'Updated Title',
165
- });
166
-
167
- // Delete
168
- await client.collection('posts').delete('rec_123');
169
- ```
170
-
171
- ---
172
-
173
- ## 📁 File URLs Helper
174
-
175
- NodeStack provides protected and public file serving at `/api/files/:collection/:recordId/:filename`. Construct fully-qualified URLs easily:
176
-
177
- ```typescript
178
- const record = await client.collection('posts').getOne('rec_123');
179
-
180
- // 1. Standard URL for <img> tags
181
- const imageUrl = client.files.getUrl(record, record.coverImage);
182
-
183
- // 2. Trigger browser download dialog
184
- const downloadUrl = client.files.getUrl(record, record.attachment, {
185
- download: true,
186
- });
187
-
188
- // 3. Attach authentication token for protected files
189
- const protectedUrl = client.files.getUrl(record, record.secretDoc, {
190
- token: true, // Uses active authStore token
191
- });
192
- ```
193
-
194
- ---
195
-
196
- ## ðŸ“Ą Realtime Subscriptions (SSE)
197
-
198
- NodeStack uses Server-Sent Events (SSE) with an initial `NS_CONNECT` handshake and multiplexed collection channels. `nodestack-client` manages this with automatic reconnection and topic synchronization:
199
-
200
- ```typescript
201
- // 1. Subscribe to all changes in a collection
202
- const unsubscribe = await client.collection('posts').subscribe('*', (event) => {
203
- console.log(`Action: ${event.action}`); // 'create' | 'update' | 'delete'
204
- console.log('Record:', event.record);
205
- });
206
-
207
- // 2. Subscribe to a specific record by ID
208
- const unbindRecord = await client.collection('posts').subscribe('rec_123', (event) => {
209
- console.log('Record updated:', event.record);
210
- });
211
-
212
- // 3. Clean up subscriptions when unmounting
213
- await unsubscribe();
214
- await unbindRecord();
215
- ```
216
-
217
- ---
218
-
219
- ## ðŸŽŊ End-to-End Type Safety
220
-
221
- Pair `nodestack-client` with `nodestack typegen`:
222
-
223
- ```bash
224
- # Generate TypeScript definitions from your running server
225
- npx nodestack typegen > src/types/nodestack.ts
226
- ```
227
-
228
- Then supply your `SchemaCollections` dictionary to `NodeStackClient`:
229
-
230
- ```typescript
231
- import { NodeStackClient } from 'nodestack-client';
232
- import { SchemaCollections } from './types/nodestack';
233
-
234
- const client = new NodeStackClient<SchemaCollections>('http://127.0.0.1:8090');
235
-
236
- // Autocomplete for collection names: 'posts' | 'users' | 'orders'
237
- // Return types are automatically inferred as PostRecord, UserRecord, etc.
238
- const posts = await client.collection('posts').getList();
239
- posts.items[0].title; // Fully typed!
240
- ```
241
-
242
- ---
243
-
244
- ## ðŸ›Ąïļ Error Handling
245
-
246
- When NodeStack returns an error (4xx or 5xx), a `ClientResponseError` is thrown:
247
-
248
- ```typescript
249
- import { ClientResponseError } from 'nodestack-client';
250
-
251
- try {
252
- await client.collection('posts').getOne('missing_id');
253
- } catch (err) {
254
- if (err instanceof ClientResponseError) {
255
- console.error('Status:', err.status); // e.g. 404
256
- console.error('Message:', err.message); // e.g. "Record not found"
257
- console.error('Data:', err.data); // Raw response JSON
258
- console.error('Is Aborted:', err.isAbort);
259
- }
260
- }
261
- ```
262
-
263
- ---
264
-
265
- ## ⚡ Latency & Chaos Simulation (For Testing Frontend States)
266
-
267
- Test your frontend loading spinners, skeleton states, error toasts, and retry mechanisms against simulated network conditions:
268
-
269
- ```typescript
270
- // 1. Query-level simulation
271
- const posts = await client.collection('posts').getList({
272
- mock_delay: 1500, // 1.5s mobile 3G delay to test loading skeletons
273
- });
274
-
275
- // 2. Simulate network drops & HTTP errors
276
- try {
277
- await client.collection('posts').getList({
278
- mock_error: 500, // Or ?mock_fail_rate=0.2 for random 20% drops
279
- });
280
- } catch (err) {
281
- if (err instanceof ClientResponseError) {
282
- showToast(`Server error (${err.status}): ${err.message}`);
283
- }
284
- }
285
-
286
- // 3. App-wide chaos simulation toggle (useful during frontend development)
287
- client.setChaos({
288
- delay: 1000, // 1000ms delay on all requests
289
- failRate: 0.15, // 15% random network drop rate
290
- errorStatus: 503 // Return 503 on failure
291
- });
292
-
293
- // Disable chaos
294
- client.setChaos(null);
295
- ```
296
-
297
- ---
298
-
299
- ## 🔔 Outbound Webhooks Management & Signature Verification
300
-
301
- Manage outbound webhook subscriptions, inspect delivery logs, and cryptographically verify incoming webhook payloads:
302
-
303
- ```typescript
304
- // 1. Create a webhook subscription
305
- const webhook = await client.webhooks.create({
306
- name: 'Slack Order Dispatcher',
307
- url: 'https://api.myapp.com/webhooks/orders',
308
- collection: 'orders',
309
- action: 'create', // 'create' | 'update' | 'delete' | '*'
310
- secret: 'whsec_9948a8cf38b1e42c',
311
- enabled: true,
312
- });
313
-
314
- // 2. Dispatch an instant test payload
315
- await client.webhooks.test(webhook.id, { test: true });
316
-
317
- // 3. Inspect delivery history logs
318
- const deliveries = await client.webhooks.getDeliveries({
319
- webhookId: webhook.id,
320
- status: 'failed',
321
- });
322
-
323
- // 4. Retry a failed delivery attempt
324
- if (deliveries.items.length > 0) {
325
- await client.webhooks.retryDelivery(deliveries.items[0].id);
326
- }
327
-
328
- // 5. Verify HMAC-SHA256 signature in your receiving server/microservice
329
- const isValid = client.webhooks.verifySignature(
330
- rawRequestBodyString,
331
- requestHeaders['x-nodestack-signature'],
332
- 'whsec_9948a8cf38b1e42c'
333
- );
334
- ```
335
-
336
- ---
337
-
338
- ## 📄 License
339
-
340
- MIT ÂĐ NodeStack Contributors
341
-
1
+ # 🚀 nodestack-client
2
+
3
+ > **The Official Lightweight, Type-Safe JavaScript & TypeScript Client SDK for [NodeStack](https://github.com/satya-jugran/nodestack)**
4
+ >
5
+ > Published on npm: [`nodestack-client`](https://www.npmjs.com/package/nodestack-client)
6
+
7
+ [![npm version](https://img.shields.io/npm/v/nodestack-client.svg?color=blue)](https://www.npmjs.com/package/nodestack-client)
8
+ [![TypeScript](https://img.shields.io/badge/TypeScript-7.x-blue.svg)](https://www.typescriptlang.org/)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
+
11
+ A zero-dependency, isomorphic JavaScript and TypeScript client for NodeStack with out-of-the-box support for:
12
+ - ⚡ **Zero runtime dependencies**: Built purely on standard Web APIs (`fetch`, `FormData`, `AbortController`, `EventSource`).
13
+ - ðŸŠķ **Ultra-lightweight footprint**: `< 10 KB` minified + gzipped.
14
+ - ðŸĒ **Multi-Application & App Scoping (v2.0)**: Fluent `client.app(slug)` scoping with automatic `x-nodestack-app` header injection, scoped SSE streams, and administrative `client.apps` management.
15
+ - 🔒 **Pluggable & Reactive Auth**: `LocalAuthStore` (localStorage), `MemoryAuthStore` (Node/SSR/testing), and reactive `onChange` state subscriptions.
16
+ - ðŸ“Ķ **Fluent Record CRUD & Batch Pagination**: `getList`, `getFullList`, `getFirstListItem`, `create`, `update`, `delete`, `export`, and `import`.
17
+ - 🔍 **SQLite FTS5 Full-Text Search**: Embedded BM25 relevance ranking, keyword prefix matching, and contextual snippet highlighting.
18
+ - 🔔 **Outbound Webhooks Service**: Programmatic webhook registration, test dispatch, delivery inspection, and HMAC-SHA256 signature verification (`client.webhooks`).
19
+ - 📁 **File Uploads & Protected File URLs**: Seamless `FormData` file uploads and URL generation with automatic token appending.
20
+ - ðŸ“Ą **Multiplexed Realtime SSE**: Single persistent connection with auto-handshake (`NS_CONNECT`), dynamic subscription sync, and automatic reconnection.
21
+ - ðŸŽŊ **100% Type Safety**: Works seamlessly with `nodestack typegen` and `GET /api/types.d.ts` for autocompleted collection names and typed record returns.
22
+ - 🌐 **Isomorphic**: Modern Browsers, React / Next.js (SSR + Client), Vue, Svelte, Node.js (20+ / 22+ / 24+), Bun, Deno, and React Native.
23
+
24
+ ---
25
+
26
+ ## ðŸ“Ķ Installation
27
+
28
+ ```bash
29
+ npm install nodestack-client
30
+ ```
31
+
32
+ Or using Yarn / PNPM / Bun:
33
+ ```bash
34
+ pnpm add nodestack-client
35
+ # or
36
+ bun add nodestack-client
37
+ ```
38
+
39
+ ---
40
+
41
+ ## ⚡ Quick Start
42
+
43
+ ```typescript
44
+ import { NodeStackClient } from 'nodestack-client';
45
+
46
+ // Initialize client
47
+ const client = new NodeStackClient('http://127.0.0.1:8090');
48
+
49
+ // Fetch paginated records
50
+ const result = await client.collection('posts').getList(1, 20, {
51
+ filter: "status = 'published' && views >= 10",
52
+ sort: '-created',
53
+ });
54
+
55
+ console.log(`Found ${result.totalItems} posts:`, result.items);
56
+ ```
57
+
58
+ ---
59
+
60
+ ## 🔐 Authentication
61
+
62
+ ### Authenticate as an Auth Collection User (e.g. `users`)
63
+ ```typescript
64
+ const authData = await client.collection('users').authWithPassword('alice@example.com', 'password123');
65
+
66
+ console.log('Logged in user:', client.authStore.model);
67
+ console.log('JWT Token:', client.authStore.token);
68
+ console.log('Is valid:', client.authStore.isValid);
69
+ ```
70
+
71
+ ### Authenticate as a Superuser / Admin
72
+ ```typescript
73
+ const adminAuth = await client.admins.authWithPassword('admin@nodestack.io', 'MySecretAdminPassword');
74
+ console.log('Logged in superuser:', adminAuth.admin.email);
75
+ ```
76
+
77
+ ### Reactive Auth State Changes
78
+ ```typescript
79
+ // Subscribe to login / logout events (ideal for React, Vue, Svelte stores)
80
+ const unbind = client.authStore.onChange((token, model) => {
81
+ console.log('Auth state changed:', { token, model });
82
+ });
83
+
84
+ // Logout
85
+ client.authStore.clear();
86
+
87
+ // Unsubscribe listener
88
+ unbind();
89
+ ```
90
+
91
+ ### SSR & Node.js Environments (`MemoryAuthStore`)
92
+ In Node.js scripts or server-side rendering where `window.localStorage` is unavailable:
93
+ ```typescript
94
+ import { NodeStackClient, MemoryAuthStore } from 'nodestack-client';
95
+
96
+ const serverClient = new NodeStackClient('http://127.0.0.1:8090', {
97
+ authStore: new MemoryAuthStore(),
98
+ });
99
+ ```
100
+
101
+ ---
102
+
103
+ ## ðŸĒ Multi-Application & App Scoping (v2.0)
104
+
105
+ NodeStack v2.0 supports hosting multiple isolated applications on a single backend instance. `nodestack-client` makes targeting and managing applications seamless:
106
+
107
+ ### 1. Scoped Client Instances (`client.app`)
108
+ Call `client.app(slug)` to create a scoped client. It shares the same connection config and auth store (or a custom one) while automatically scoping all requests:
109
+ - Automatically injects `x-nodestack-app: slug` on all collection requests.
110
+ - Scopes Realtime SSE streams (`/api/realtime?app=slug`).
111
+ - Generates scoped file URLs (`/api/apps/:appId/files/...`).
112
+
113
+ ```typescript
114
+ const client = new NodeStackClient('http://127.0.0.1:8090');
115
+
116
+ // Scope to the 'ecommerce' application
117
+ const shopClient = client.app('ecommerce');
118
+
119
+ // All queries now operate within 'ecommerce' SQLite database
120
+ const products = await shopClient.collection('products').getList(1, 20);
121
+
122
+ // File URLs automatically point to the app-scoped file route:
123
+ // http://127.0.0.1:8090/api/apps/ecommerce/files/products/rec_123/image.png
124
+ const imgUrl = shopClient.files.getUrl(products.items[0], products.items[0].cover);
125
+
126
+ // Realtime SSE scoped to 'ecommerce'
127
+ shopClient.collection('orders').subscribe('*', (e) => {
128
+ console.log('New shop order:', e.record);
129
+ });
130
+ ```
131
+
132
+ ### 2. Multi-App Management Service (`client.apps`)
133
+ Administrative scripts or superusers can provision, inspect, and delete applications programmatically:
134
+
135
+ ```typescript
136
+ // Authenticate as superuser
137
+ await client.admins.authWithPassword('admin@nodestack.io', 'AdminPass123!');
138
+
139
+ // List hosted applications
140
+ const apps = await client.apps.getList(1, 50);
141
+
142
+ // Create a new app from a starter template ('saas' | 'blog' | 'ecommerce' | 'blank')
143
+ const newApp = await client.apps.create({
144
+ name: 'Analytics Dashboard',
145
+ slug: 'analytics',
146
+ template: 'saas',
147
+ });
148
+
149
+ // Update app details
150
+ await client.apps.update(newApp.id, {
151
+ name: 'Analytics Production',
152
+ });
153
+
154
+ // Delete an application (deletes its SQLite DB & uploaded files)
155
+ await client.apps.delete(newApp.id);
156
+ ```
157
+
158
+ ---
159
+
160
+ ## 📋 Record Operations (CRUD)
161
+
162
+ ### 1. Fetch Paginated Records (`getList`)
163
+ ```typescript
164
+ const result = await client.collection('posts').getList(1, 10, {
165
+ filter: "category = 'Tech' && price <= 50",
166
+ sort: '-created,title',
167
+ expand: 'author,comments',
168
+ });
169
+
170
+ console.log(result.page, result.totalPages, result.items);
171
+ ```
172
+
173
+ ### 2. Full-Text Search with BM25 Scoring & Snippets (`search`)
174
+ Query records using embedded SQLite FTS5 with BM25 relevance ranking and keyword highlight snippets:
175
+ ```typescript
176
+ const searchResults = await client.collection('posts').getList(1, 10, {
177
+ search: 'distributed systems',
178
+ snippetTag: 'mark', // Highlight tag (default: <mark>)
179
+ snippetLength: 25, // Max words per snippet excerpt
180
+ });
181
+
182
+ console.log(searchResults.items[0]._score); // BM25 relevance score
183
+ console.log(searchResults.items[0]._snippet); // Best matching snippet excerpt
184
+ console.log(searchResults.items[0]._snippets); // Per-field snippet map: { title: "...", content: "..." }
185
+ ```
186
+
187
+ ### 3. Fetch All Records Across Pages (`getFullList`)
188
+ Auto-paginates in batches and returns all matching records as a single array:
189
+ ```typescript
190
+ const allPosts = await client.collection('posts').getFullList({
191
+ batch: 200,
192
+ filter: "published = true",
193
+ });
194
+ ```
195
+
196
+ ### 4. Find First Matching Record (`getFirstListItem`)
197
+ ```typescript
198
+ // Throws ClientResponseError(404) if no match is found
199
+ const post = await client.collection('posts').getFirstListItem("slug = 'hello-world'");
200
+ ```
201
+
202
+ ### 5. Create Record (JSON or File Uploads)
203
+ ```typescript
204
+ // Plain JSON
205
+ const newPost = await client.collection('posts').create({
206
+ title: 'My First Post',
207
+ published: true,
208
+ });
209
+
210
+ // Multipart Form Data (File Upload)
211
+ const formData = new FormData();
212
+ formData.append('title', 'Post with Cover Photo');
213
+ formData.append('coverImage', fileInput.files[0]);
214
+
215
+ const postWithImage = await client.collection('posts').create(formData);
216
+ ```
217
+
218
+ ### 6. Update & Delete Records
219
+ ```typescript
220
+ // Update
221
+ const updated = await client.collection('posts').update('rec_123', {
222
+ title: 'Updated Title',
223
+ });
224
+
225
+ // Delete
226
+ await client.collection('posts').delete('rec_123');
227
+ ```
228
+
229
+ ---
230
+
231
+ ## 📁 File URLs Helper
232
+
233
+ NodeStack provides protected and public file serving at `/api/files/:collection/:recordId/:filename`. Construct fully-qualified URLs easily:
234
+
235
+ ```typescript
236
+ const record = await client.collection('posts').getOne('rec_123');
237
+
238
+ // 1. Standard URL for <img> tags
239
+ const imageUrl = client.files.getUrl(record, record.coverImage);
240
+
241
+ // 2. Trigger browser download dialog
242
+ const downloadUrl = client.files.getUrl(record, record.attachment, {
243
+ download: true,
244
+ });
245
+
246
+ // 3. Attach authentication token for protected files
247
+ const protectedUrl = client.files.getUrl(record, record.secretDoc, {
248
+ token: true, // Uses active authStore token
249
+ });
250
+ ```
251
+
252
+ ---
253
+
254
+ ## ðŸ“Ą Realtime Subscriptions (SSE)
255
+
256
+ NodeStack uses Server-Sent Events (SSE) with an initial `NS_CONNECT` handshake and multiplexed collection channels. `nodestack-client` manages this with automatic reconnection and topic synchronization:
257
+
258
+ ```typescript
259
+ // 1. Subscribe to all changes in a collection
260
+ const unsubscribe = await client.collection('posts').subscribe('*', (event) => {
261
+ console.log(`Action: ${event.action}`); // 'create' | 'update' | 'delete'
262
+ console.log('Record:', event.record);
263
+ });
264
+
265
+ // 2. Subscribe to a specific record by ID
266
+ const unbindRecord = await client.collection('posts').subscribe('rec_123', (event) => {
267
+ console.log('Record updated:', event.record);
268
+ });
269
+
270
+ // 3. Clean up subscriptions when unmounting
271
+ await unsubscribe();
272
+ await unbindRecord();
273
+ ```
274
+
275
+ ---
276
+
277
+ ## ðŸŽŊ End-to-End Type Safety
278
+
279
+ Pair `nodestack-client` with `nodestack typegen`:
280
+
281
+ ```bash
282
+ # Generate TypeScript definitions from your running server
283
+ npx nodestack typegen > src/types/nodestack.ts
284
+ ```
285
+
286
+ Then supply your `SchemaCollections` dictionary to `NodeStackClient`:
287
+
288
+ ```typescript
289
+ import { NodeStackClient } from 'nodestack-client';
290
+ import { SchemaCollections } from './types/nodestack';
291
+
292
+ const client = new NodeStackClient<SchemaCollections>('http://127.0.0.1:8090');
293
+
294
+ // Autocomplete for collection names: 'posts' | 'users' | 'orders'
295
+ // Return types are automatically inferred as PostRecord, UserRecord, etc.
296
+ const posts = await client.collection('posts').getList();
297
+ posts.items[0].title; // Fully typed!
298
+ ```
299
+
300
+ ---
301
+
302
+ ## ðŸ›Ąïļ Error Handling
303
+
304
+ When NodeStack returns an error (4xx or 5xx), a `ClientResponseError` is thrown:
305
+
306
+ ```typescript
307
+ import { ClientResponseError } from 'nodestack-client';
308
+
309
+ try {
310
+ await client.collection('posts').getOne('missing_id');
311
+ } catch (err) {
312
+ if (err instanceof ClientResponseError) {
313
+ console.error('Status:', err.status); // e.g. 404
314
+ console.error('Message:', err.message); // e.g. "Record not found"
315
+ console.error('Data:', err.data); // Raw response JSON
316
+ console.error('Is Aborted:', err.isAbort);
317
+ }
318
+ }
319
+ ```
320
+
321
+ ---
322
+
323
+ ## ⚡ Latency & Chaos Simulation (For Testing Frontend States)
324
+
325
+ Test your frontend loading spinners, skeleton states, error toasts, and retry mechanisms against simulated network conditions:
326
+
327
+ ```typescript
328
+ // 1. Query-level simulation
329
+ const posts = await client.collection('posts').getList({
330
+ mock_delay: 1500, // 1.5s mobile 3G delay to test loading skeletons
331
+ });
332
+
333
+ // 2. Simulate network drops & HTTP errors
334
+ try {
335
+ await client.collection('posts').getList({
336
+ mock_error: 500, // Or ?mock_fail_rate=0.2 for random 20% drops
337
+ });
338
+ } catch (err) {
339
+ if (err instanceof ClientResponseError) {
340
+ showToast(`Server error (${err.status}): ${err.message}`);
341
+ }
342
+ }
343
+
344
+ // 3. App-wide chaos simulation toggle (useful during frontend development)
345
+ client.setChaos({
346
+ delay: 1000, // 1000ms delay on all requests
347
+ failRate: 0.15, // 15% random network drop rate
348
+ errorStatus: 503 // Return 503 on failure
349
+ });
350
+
351
+ // Disable chaos
352
+ client.setChaos(null);
353
+ ```
354
+
355
+ ---
356
+
357
+ ## 🔔 Outbound Webhooks Management & Signature Verification
358
+
359
+ Manage outbound webhook subscriptions, inspect delivery logs, and cryptographically verify incoming webhook payloads:
360
+
361
+ ```typescript
362
+ // 1. Create a webhook subscription
363
+ const webhook = await client.webhooks.create({
364
+ name: 'Slack Order Dispatcher',
365
+ url: 'https://api.myapp.com/webhooks/orders',
366
+ collection: 'orders',
367
+ action: 'create', // 'create' | 'update' | 'delete' | '*'
368
+ secret: 'whsec_9948a8cf38b1e42c',
369
+ enabled: true,
370
+ });
371
+
372
+ // 2. Dispatch an instant test payload
373
+ await client.webhooks.test(webhook.id, { test: true });
374
+
375
+ // 3. Inspect delivery history logs
376
+ const deliveries = await client.webhooks.getDeliveries({
377
+ webhookId: webhook.id,
378
+ status: 'failed',
379
+ });
380
+
381
+ // 4. Retry a failed delivery attempt
382
+ if (deliveries.items.length > 0) {
383
+ await client.webhooks.retryDelivery(deliveries.items[0].id);
384
+ }
385
+
386
+ // 5. Verify HMAC-SHA256 signature in your receiving server/microservice
387
+ const isValid = client.webhooks.verifySignature(
388
+ rawRequestBodyString,
389
+ requestHeaders['x-nodestack-signature'],
390
+ 'whsec_9948a8cf38b1e42c'
391
+ );
392
+ ```
393
+
394
+ ---
395
+
396
+ ## 📄 License
397
+
398
+ MIT ÂĐ NodeStack Contributors
399
+