@revisium/client 0.1.0-alpha.1 → 0.2.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 +372 -36
- package/dist/data-operations.d.ts +52 -0
- package/dist/data-operations.d.ts.map +1 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/index.d.ts +9 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/types.gen.d.ts +69 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +31 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.d.ts +5 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +9 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +22 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.d.ts +27 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +31 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +7 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +24 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.d.ts +33 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/sdk.gen.d.ts +79 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.d.ts +2164 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/index.cjs +2270 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +2263 -3
- package/dist/index.mjs.map +1 -1
- package/dist/revisium-client.d.ts +67 -2
- package/dist/revisium-client.d.ts.map +1 -1
- package/dist/revisium-scope.d.ts +76 -0
- package/dist/revisium-scope.d.ts.map +1 -0
- package/package.json +15 -3
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://github.com/revisium/revisium-client/blob/master/LICENSE)
|
|
8
8
|
[](https://github.com/revisium/revisium-client/releases)
|
|
9
9
|
|
|
10
|
-
TypeScript
|
|
10
|
+
Typed TypeScript client for [Revisium](https://revisium.io) REST API.
|
|
11
11
|
|
|
12
12
|
</div>
|
|
13
13
|
|
|
@@ -17,60 +17,396 @@ TypeScript HTTP client for [Revisium](https://revisium.io) REST API.
|
|
|
17
17
|
npm install @revisium/client
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Quick Start
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
23
23
|
import { RevisiumClient } from '@revisium/client';
|
|
24
24
|
|
|
25
25
|
const client = new RevisiumClient({ baseUrl: 'http://localhost:8080' });
|
|
26
26
|
|
|
27
|
-
//
|
|
28
|
-
await client.
|
|
27
|
+
// Set context — resolves revisionId from branch
|
|
28
|
+
await client.setContext({
|
|
29
|
+
organizationId: 'admin',
|
|
30
|
+
projectName: 'my-project',
|
|
31
|
+
branchName: 'master', // default: 'master'
|
|
32
|
+
revision: 'draft', // default: 'draft'
|
|
33
|
+
});
|
|
29
34
|
|
|
30
|
-
//
|
|
31
|
-
client.
|
|
35
|
+
// Create table with schema
|
|
36
|
+
await client.createTable('posts', {
|
|
37
|
+
type: 'object',
|
|
38
|
+
properties: {
|
|
39
|
+
title: { type: 'string', default: '' },
|
|
40
|
+
published: { type: 'boolean', default: false },
|
|
41
|
+
},
|
|
42
|
+
additionalProperties: false,
|
|
43
|
+
required: ['title', 'published'],
|
|
44
|
+
});
|
|
32
45
|
|
|
33
|
-
//
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
46
|
+
// Create row
|
|
47
|
+
await client.createRow('posts', 'post-1', {
|
|
48
|
+
title: 'Hello World',
|
|
49
|
+
published: true,
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
// Read data
|
|
53
|
+
const rows = await client.getRows('posts', { first: 100 });
|
|
54
|
+
const row = await client.getRow('posts', 'post-1');
|
|
55
|
+
|
|
56
|
+
// Commit changes
|
|
57
|
+
await client.commit('Initial content');
|
|
58
|
+
|
|
59
|
+
// Read committed data (head revision)
|
|
60
|
+
await client.setContext({
|
|
61
|
+
organizationId: 'admin',
|
|
62
|
+
projectName: 'my-project',
|
|
63
|
+
revision: 'head',
|
|
64
|
+
});
|
|
65
|
+
const tables = await client.getTables();
|
|
37
66
|
```
|
|
38
67
|
|
|
39
68
|
## API
|
|
40
69
|
|
|
41
|
-
###
|
|
70
|
+
### Authentication (optional)
|
|
71
|
+
|
|
72
|
+
Authentication is not required when the server runs in no-auth mode. If auth is enabled:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
await client.login('username', 'password');
|
|
76
|
+
// or
|
|
77
|
+
client.loginWithToken('jwt-token');
|
|
78
|
+
|
|
79
|
+
client.isAuthenticated(); // boolean
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Context
|
|
42
83
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
84
|
+
```typescript
|
|
85
|
+
await client.setContext({
|
|
86
|
+
organizationId: 'admin',
|
|
87
|
+
projectName: 'my-project',
|
|
88
|
+
branchName: 'master', // default: 'master'
|
|
89
|
+
revision: 'draft', // 'draft' | 'head' | '<revisionId>'
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
client.organizationId; // current org
|
|
93
|
+
client.projectName; // current project
|
|
94
|
+
client.branchName; // current branch
|
|
95
|
+
client.revisionId; // resolved revision ID
|
|
96
|
+
client.isDraft; // true if revision === 'draft'
|
|
97
|
+
```
|
|
48
98
|
|
|
49
|
-
###
|
|
99
|
+
### Read Operations (any revision)
|
|
50
100
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
101
|
+
```typescript
|
|
102
|
+
await client.getTables({ first: 100, after: 'cursor' });
|
|
103
|
+
await client.getTable('posts');
|
|
104
|
+
await client.getTableSchema('posts');
|
|
105
|
+
await client.getRows('posts', { first: 100 });
|
|
106
|
+
await client.getRow('posts', 'post-1');
|
|
107
|
+
await client.getChanges();
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Write Operations (draft only)
|
|
111
|
+
|
|
112
|
+
Write methods throw if `revision` is not `'draft'`.
|
|
113
|
+
|
|
114
|
+
```typescript
|
|
115
|
+
// Tables
|
|
116
|
+
await client.createTable('posts', schema);
|
|
117
|
+
await client.updateTable('posts', patches);
|
|
118
|
+
await client.deleteTable('posts');
|
|
119
|
+
await client.renameTable('posts', 'articles');
|
|
120
|
+
|
|
121
|
+
// Rows
|
|
122
|
+
await client.createRow('posts', 'row-1', data);
|
|
123
|
+
await client.createRows('posts', [{ rowId: 'r1', data }, { rowId: 'r2', data }]);
|
|
124
|
+
await client.updateRow('posts', 'row-1', data);
|
|
125
|
+
await client.updateRows('posts', [{ rowId: 'r1', data }]);
|
|
126
|
+
await client.patchRow('posts', 'row-1', [{ op: 'replace', path: 'title', value: 'New' }]);
|
|
127
|
+
await client.deleteRow('posts', 'row-1');
|
|
128
|
+
await client.deleteRows('posts', ['row-1', 'row-2']);
|
|
129
|
+
await client.renameRow('posts', 'row-1', 'post-1');
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Version Control (draft only)
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
const revision = await client.commit('my changes'); // auto-refreshes draftRevisionId
|
|
136
|
+
await client.revertChanges(); // auto-refreshes draftRevisionId
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Isolated Scopes (`withContext`)
|
|
140
|
+
|
|
141
|
+
Use `withContext()` to create isolated scopes that share authentication but have independent context. Useful for multi-context scenarios (e.g., handling parallel requests in a server).
|
|
142
|
+
|
|
143
|
+
```typescript
|
|
144
|
+
const client = new RevisiumClient({ baseUrl: 'http://localhost:8080' });
|
|
145
|
+
await client.login('admin', 'admin');
|
|
146
|
+
|
|
147
|
+
// Create isolated scopes — each has its own revisionId
|
|
148
|
+
const scopeA = await client.withContext({
|
|
149
|
+
organizationId: 'admin',
|
|
150
|
+
projectName: 'project-a',
|
|
151
|
+
revision: 'draft',
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
const scopeB = await client.withContext({
|
|
155
|
+
organizationId: 'admin',
|
|
156
|
+
projectName: 'project-b',
|
|
157
|
+
revision: 'draft',
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
// Scopes work independently
|
|
161
|
+
await scopeA.createRow('posts', 'row-1', { title: 'Hello' });
|
|
162
|
+
await scopeB.getTables();
|
|
163
|
+
|
|
164
|
+
// Commit in one scope marks sibling scopes (same branch) as stale
|
|
165
|
+
const scopeC = await client.withContext({
|
|
166
|
+
organizationId: 'admin',
|
|
167
|
+
projectName: 'project-a',
|
|
168
|
+
revision: 'draft',
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
await scopeA.commit('changes');
|
|
172
|
+
// scopeC.isStale === true — auto-refreshes on next data access
|
|
173
|
+
|
|
174
|
+
// Dispose when done to clean up tracking
|
|
175
|
+
scopeA.dispose();
|
|
176
|
+
scopeB.dispose();
|
|
177
|
+
scopeC.dispose();
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
#### Scope Properties
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
scope.organizationId; // string
|
|
184
|
+
scope.projectName; // string
|
|
185
|
+
scope.branchName; // string
|
|
186
|
+
scope.revisionId; // string — current cached revisionId
|
|
187
|
+
scope.isDraft; // boolean
|
|
188
|
+
scope.isStale; // boolean — true if sibling committed
|
|
189
|
+
scope.isDisposed; // boolean
|
|
190
|
+
scope.client; // underlying HTTP client (shared with parent)
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
#### Scope Methods
|
|
194
|
+
|
|
195
|
+
```typescript
|
|
196
|
+
// Same data methods as RevisiumClient
|
|
197
|
+
await scope.getTables();
|
|
198
|
+
await scope.createRow('posts', 'row-1', data);
|
|
199
|
+
await scope.commit('message');
|
|
200
|
+
// ... all other read/write/version-control methods
|
|
201
|
+
|
|
202
|
+
// Scope-specific
|
|
203
|
+
scope.markStale(); // manually mark as stale
|
|
204
|
+
await scope.refresh(); // manually refresh revisionId
|
|
205
|
+
scope.dispose(); // unregister from parent tracking
|
|
206
|
+
```
|
|
58
207
|
|
|
59
|
-
|
|
208
|
+
#### Stale Behavior
|
|
60
209
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
| `getChanges()` | Get pending changes summary |
|
|
210
|
+
- When one scope commits or reverts, all sibling scopes on the same branch are marked stale
|
|
211
|
+
- Stale scopes auto-refresh their `revisionId` on the next data method call
|
|
212
|
+
- Scopes with explicit `revisionId` (not `'draft'` or `'head'`) never go stale
|
|
213
|
+
- Concurrent reads on a stale scope share a single refresh API call (promise dedup)
|
|
66
214
|
|
|
67
|
-
|
|
215
|
+
## Error Handling
|
|
68
216
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
217
|
+
`RevisiumClient` methods throw on errors instead of returning `{ data, error }`:
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
// Context not set
|
|
221
|
+
try {
|
|
222
|
+
await client.getRows('posts');
|
|
223
|
+
} catch (err) {
|
|
224
|
+
console.error(err.message); // "Context not set. Call setContext() first."
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
// Mutations in read-only revision
|
|
228
|
+
await client.setContext({
|
|
229
|
+
organizationId: 'admin',
|
|
230
|
+
projectName: 'my-project',
|
|
231
|
+
revision: 'head', // or explicit revisionId
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
try {
|
|
235
|
+
await client.createRow('posts', 'row-1', { title: 'Hello' });
|
|
236
|
+
} catch (err) {
|
|
237
|
+
console.error(err.message);
|
|
238
|
+
// "Mutations are only allowed in draft revision. Use setContext({ revision: "draft" })."
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
## Low-Level SDK
|
|
243
|
+
|
|
244
|
+
For advanced use cases, the auto-generated SDK functions are available:
|
|
245
|
+
|
|
246
|
+
```typescript
|
|
247
|
+
import { client, sdk } from '@revisium/client';
|
|
248
|
+
|
|
249
|
+
client.setConfig({ baseUrl: 'http://localhost:8080' });
|
|
250
|
+
|
|
251
|
+
const { data, error } = await sdk.login({
|
|
252
|
+
body: { emailOrUsername: 'admin', password: 'admin' },
|
|
253
|
+
});
|
|
254
|
+
|
|
255
|
+
if (error) {
|
|
256
|
+
console.error(error.statusCode, error.message);
|
|
257
|
+
} else {
|
|
258
|
+
client.setConfig({ auth: data.accessToken });
|
|
259
|
+
}
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Custom Client Instance
|
|
263
|
+
|
|
264
|
+
```typescript
|
|
265
|
+
import { createClient, createConfig, sdk } from '@revisium/client';
|
|
266
|
+
|
|
267
|
+
const myClient = createClient(createConfig({
|
|
268
|
+
baseUrl: 'https://my-revisium.example.com',
|
|
269
|
+
auth: 'my-token',
|
|
270
|
+
}));
|
|
271
|
+
|
|
272
|
+
const result = await sdk.projects({
|
|
273
|
+
client: myClient,
|
|
274
|
+
path: { organizationId: 'admin' },
|
|
275
|
+
query: { first: 100 },
|
|
276
|
+
});
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
## Available Low-Level Functions
|
|
280
|
+
|
|
281
|
+
### Auth
|
|
282
|
+
|
|
283
|
+
| Function | Method | Description |
|
|
284
|
+
|----------|--------|-------------|
|
|
285
|
+
| `login` | POST | Authenticate and get access token |
|
|
286
|
+
| `me` | GET | Get current user |
|
|
287
|
+
| `createUser` | POST | Create user (admin) |
|
|
288
|
+
| `updatePassword` | PUT | Update password |
|
|
289
|
+
|
|
290
|
+
### Projects
|
|
291
|
+
|
|
292
|
+
| Function | Method | Description |
|
|
293
|
+
|----------|--------|-------------|
|
|
294
|
+
| `projects` | GET | List projects |
|
|
295
|
+
| `project` | GET | Get project by name |
|
|
296
|
+
| `createProject` | POST | Create project |
|
|
297
|
+
| `updateProject` | PUT | Update project settings |
|
|
298
|
+
| `deleteProject` | DELETE | Delete project |
|
|
299
|
+
|
|
300
|
+
### Branches
|
|
301
|
+
|
|
302
|
+
| Function | Method | Description |
|
|
303
|
+
|----------|--------|-------------|
|
|
304
|
+
| `rootBranch` | GET | Get root branch |
|
|
305
|
+
| `branches` | GET | List branches |
|
|
306
|
+
| `branch` | GET | Get branch by name |
|
|
307
|
+
| `branchTouched` | GET | Check for uncommitted changes |
|
|
308
|
+
| `createBranch` | POST | Create branch from revision |
|
|
309
|
+
| `deleteBranch` | DELETE | Delete branch |
|
|
310
|
+
| `parentBranch` | GET | Get parent branch |
|
|
311
|
+
| `childBranches` | GET | List child branches |
|
|
312
|
+
|
|
313
|
+
### Revisions
|
|
314
|
+
|
|
315
|
+
| Function | Method | Description |
|
|
316
|
+
|----------|--------|-------------|
|
|
317
|
+
| `draftRevision` | GET | Get draft (working) revision |
|
|
318
|
+
| `headRevision` | GET | Get latest committed revision |
|
|
319
|
+
| `startRevision` | GET | Get first revision |
|
|
320
|
+
| `revision` | GET | Get revision by ID |
|
|
321
|
+
| `revisions` | GET | List revisions |
|
|
322
|
+
| `createRevision` | POST | Commit changes |
|
|
323
|
+
| `revertChanges` | POST | Revert uncommitted changes |
|
|
324
|
+
| `parentRevision` | GET | Get parent revision |
|
|
325
|
+
| `childRevision` | GET | Get child revision |
|
|
326
|
+
|
|
327
|
+
### Tables
|
|
328
|
+
|
|
329
|
+
| Function | Method | Description |
|
|
330
|
+
|----------|--------|-------------|
|
|
331
|
+
| `tables` | GET | List tables |
|
|
332
|
+
| `table` | GET | Get table by ID |
|
|
333
|
+
| `tableSchema` | GET | Get table JSON Schema |
|
|
334
|
+
| `createTable` | POST | Create table |
|
|
335
|
+
| `updateTable` | PATCH | Update table schema (JSON Patch) |
|
|
336
|
+
| `renameTable` | PATCH | Rename table |
|
|
337
|
+
| `deleteTable` | DELETE | Delete table |
|
|
338
|
+
| `tableCountRows` | GET | Count rows in table |
|
|
339
|
+
|
|
340
|
+
### Rows
|
|
341
|
+
|
|
342
|
+
| Function | Method | Description |
|
|
343
|
+
|----------|--------|-------------|
|
|
344
|
+
| `rows` | POST | Query rows (with filters) |
|
|
345
|
+
| `row` | GET | Get row by ID |
|
|
346
|
+
| `createRow` | POST | Create row |
|
|
347
|
+
| `createRows` | POST | Bulk create rows |
|
|
348
|
+
| `updateRow` | PUT | Update row data |
|
|
349
|
+
| `updateRows` | PUT | Bulk update rows |
|
|
350
|
+
| `patchRow` | PATCH | Patch row (JSON Patch) |
|
|
351
|
+
| `patchRows` | PATCH | Bulk patch rows |
|
|
352
|
+
| `renameRow` | PATCH | Rename row |
|
|
353
|
+
| `deleteRow` | DELETE | Delete row |
|
|
354
|
+
| `deleteRows` | DELETE | Bulk delete rows |
|
|
355
|
+
|
|
356
|
+
### Changes
|
|
357
|
+
|
|
358
|
+
| Function | Method | Description |
|
|
359
|
+
|----------|--------|-------------|
|
|
360
|
+
| `revisionChanges` | GET | Get revision changes summary |
|
|
361
|
+
| `tableChanges` | GET | Get table-level changes |
|
|
362
|
+
| `rowChanges` | GET | Get row-level changes |
|
|
363
|
+
|
|
364
|
+
### Migrations, Endpoints, Foreign Keys
|
|
365
|
+
|
|
366
|
+
| Function | Method | Description |
|
|
367
|
+
|----------|--------|-------------|
|
|
368
|
+
| `migrations` | GET | Get migrations |
|
|
369
|
+
| `applyMigrations` | POST | Apply migrations |
|
|
370
|
+
| `endpoints` | GET | List endpoints |
|
|
371
|
+
| `createEndpoint` | POST | Create endpoint |
|
|
372
|
+
| `deleteEndpoint` | DELETE | Delete endpoint |
|
|
373
|
+
| `endpointRelatives` | GET | Get endpoint relatives |
|
|
374
|
+
| `tableForeignKeysBy` | GET | Foreign keys from table |
|
|
375
|
+
| `tableForeignKeysTo` | GET | Foreign keys to table |
|
|
376
|
+
| `rowForeignKeysBy` | GET | Foreign keys from row |
|
|
377
|
+
| `rowForeignKeysTo` | GET | Foreign keys to row |
|
|
378
|
+
| `uploadFile` | POST | Upload file |
|
|
379
|
+
|
|
380
|
+
### System
|
|
381
|
+
|
|
382
|
+
| Function | Method | Description |
|
|
383
|
+
|----------|--------|-------------|
|
|
384
|
+
| `getConfiguration` | GET | Get server configuration |
|
|
385
|
+
| `liveness` | GET | Liveness probe |
|
|
386
|
+
| `readiness` | GET | Readiness probe |
|
|
387
|
+
|
|
388
|
+
### Organization & Users
|
|
389
|
+
|
|
390
|
+
| Function | Method | Description |
|
|
391
|
+
|----------|--------|-------------|
|
|
392
|
+
| `usersOrganization` | GET | List organization users |
|
|
393
|
+
| `addUserToOrganization` | POST | Add user to organization |
|
|
394
|
+
| `removeUserFromOrganization` | DELETE | Remove user from organization |
|
|
395
|
+
| `usersProject` | GET | List project users |
|
|
396
|
+
| `addUserToProject` | POST | Add user to project |
|
|
397
|
+
| `removeUserFromProject` | DELETE | Remove user from project |
|
|
398
|
+
|
|
399
|
+
## Development
|
|
400
|
+
|
|
401
|
+
```bash
|
|
402
|
+
npm run generate # Regenerate client from OpenAPI spec
|
|
403
|
+
npm run generate:download # Download spec and regenerate
|
|
404
|
+
npm run tsc # TypeScript check
|
|
405
|
+
npm run lint:ci # Lint
|
|
406
|
+
npm test # Unit tests
|
|
407
|
+
npm run test:integration # Integration tests (requires running Revisium)
|
|
408
|
+
npm run build # Build
|
|
409
|
+
```
|
|
74
410
|
|
|
75
411
|
## License
|
|
76
412
|
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import type { Client } from './generated/client/index.js';
|
|
2
|
+
import type { CreateRowResponse, CreateRowsResponse, CreateTableResponse, GetTableRowsDto, PatchRow, PatchRowResponse, RenameRowResponse, RenameTableResponse, RevisionChangesResponse, RevisionModel, RowModel, RowsConnection, TableModel, TablesConnection, UpdateRowResponse, UpdateRowsResponse, UpdateTableResponse } from './generated/types.gen.js';
|
|
3
|
+
export interface BranchContext {
|
|
4
|
+
readonly organizationId: string;
|
|
5
|
+
readonly projectName: string;
|
|
6
|
+
readonly branchName: string;
|
|
7
|
+
}
|
|
8
|
+
export interface ScopeContext {
|
|
9
|
+
readonly client: Client;
|
|
10
|
+
readonly branch: BranchContext;
|
|
11
|
+
readonly isDraft: boolean;
|
|
12
|
+
getRevisionId(): Promise<string>;
|
|
13
|
+
}
|
|
14
|
+
export declare function unwrap<T>(result: {
|
|
15
|
+
data?: T;
|
|
16
|
+
error?: unknown;
|
|
17
|
+
}): T;
|
|
18
|
+
export declare function assertDraft(ctx: ScopeContext): void;
|
|
19
|
+
export declare function assertContext(ctx: ScopeContext): void;
|
|
20
|
+
export declare function getTables(ctx: ScopeContext, options?: {
|
|
21
|
+
first?: number;
|
|
22
|
+
after?: string;
|
|
23
|
+
}): Promise<TablesConnection>;
|
|
24
|
+
export declare function getTable(ctx: ScopeContext, tableId: string): Promise<TableModel>;
|
|
25
|
+
export declare function getTableSchema(ctx: ScopeContext, tableId: string): Promise<object>;
|
|
26
|
+
export declare function getRows(ctx: ScopeContext, tableId: string, options?: GetTableRowsDto): Promise<RowsConnection>;
|
|
27
|
+
export declare function getRow(ctx: ScopeContext, tableId: string, rowId: string): Promise<RowModel>;
|
|
28
|
+
export declare function getChanges(ctx: ScopeContext): Promise<RevisionChangesResponse>;
|
|
29
|
+
export declare function createTable(ctx: ScopeContext, tableId: string, schema: object): Promise<CreateTableResponse>;
|
|
30
|
+
export declare function updateTable(ctx: ScopeContext, tableId: string, patches: object[]): Promise<UpdateTableResponse>;
|
|
31
|
+
export declare function deleteTable(ctx: ScopeContext, tableId: string): Promise<void>;
|
|
32
|
+
export declare function renameTable(ctx: ScopeContext, tableId: string, nextTableId: string): Promise<RenameTableResponse>;
|
|
33
|
+
export declare function createRow(ctx: ScopeContext, tableId: string, rowId: string, data: object): Promise<CreateRowResponse>;
|
|
34
|
+
export declare function createRows(ctx: ScopeContext, tableId: string, rows: Array<{
|
|
35
|
+
rowId: string;
|
|
36
|
+
data: object;
|
|
37
|
+
}>): Promise<CreateRowsResponse>;
|
|
38
|
+
export declare function updateRow(ctx: ScopeContext, tableId: string, rowId: string, data: object): Promise<UpdateRowResponse>;
|
|
39
|
+
export declare function updateRows(ctx: ScopeContext, tableId: string, rows: Array<{
|
|
40
|
+
rowId: string;
|
|
41
|
+
data: object;
|
|
42
|
+
}>): Promise<UpdateRowsResponse>;
|
|
43
|
+
export declare function patchRow(ctx: ScopeContext, tableId: string, rowId: string, patches: PatchRow[]): Promise<PatchRowResponse>;
|
|
44
|
+
export declare function deleteRow(ctx: ScopeContext, tableId: string, rowId: string): Promise<void>;
|
|
45
|
+
export declare function deleteRows(ctx: ScopeContext, tableId: string, rowIds: string[]): Promise<void>;
|
|
46
|
+
export declare function renameRow(ctx: ScopeContext, tableId: string, rowId: string, nextRowId: string): Promise<RenameRowResponse>;
|
|
47
|
+
export declare function commit(ctx: ScopeContext, comment?: string): Promise<RevisionModel>;
|
|
48
|
+
export declare function revertChanges(ctx: ScopeContext): Promise<void>;
|
|
49
|
+
export declare function fetchDraftRevisionId(client: Client, branch: BranchContext): Promise<string>;
|
|
50
|
+
export declare function fetchHeadRevisionId(client: Client, branch: BranchContext): Promise<string>;
|
|
51
|
+
export declare function validateRevisionId(client: Client, revisionId: string): Promise<void>;
|
|
52
|
+
//# sourceMappingURL=data-operations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-operations.d.ts","sourceRoot":"","sources":["../src/data-operations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,aAAa,EACb,QAAQ,EACR,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,0BAA0B,CAAC;AAElC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAClC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,CAAC,CAQlE;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAOnD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAIrD;AAED,wBAAsB,SAAS,CAC7B,GAAG,EAAE,YAAY,EACjB,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3C,OAAO,CAAC,gBAAgB,CAAC,CAQ3B;AAED,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,CAAC,CAOrB;AAED,wBAAsB,cAAc,CAClC,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED,wBAAsB,OAAO,CAC3B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CAQzB;AAED,wBAAsB,MAAM,CAC1B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,QAAQ,CAAC,CAOnB;AAED,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,GAChB,OAAO,CAAC,uBAAuB,CAAC,CAOlC;AAED,wBAAsB,WAAW,CAC/B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,mBAAmB,CAAC,CAY9B;AAED,wBAAsB,WAAW,CAC/B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,mBAAmB,CAAC,CAW9B;AAED,wBAAsB,WAAW,CAC/B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAQf;AAED,wBAAsB,WAAW,CAC/B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,mBAAmB,CAAC,CAS9B;AAED,wBAAsB,SAAS,CAC7B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAS5B;AAED,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,CAc7B;AAED,wBAAsB,SAAS,CAC7B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAS5B;AAED,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,CAc7B;AAED,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,EAAE,GAClB,OAAO,CAAC,gBAAgB,CAAC,CAS3B;AAED,wBAAsB,SAAS,CAC7B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAQf;AAED,wBAAsB,UAAU,CAC9B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CASf;AAED,wBAAsB,SAAS,CAC7B,GAAG,EAAE,YAAY,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,iBAAiB,CAAC,CAS5B;AAED,wBAAsB,MAAM,CAC1B,GAAG,EAAE,YAAY,EACjB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,aAAa,CAAC,CAYxB;AAED,wBAAsB,aAAa,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAWpE;AAED,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAMf"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.gen.d.ts","sourceRoot":"","sources":["../../../src/generated/client/client.gen.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAA0C,MAAM,aAAa,CAAC;AAgB1F,eAAO,MAAM,YAAY,GAAI,SAAQ,MAAW,KAAG,MA0QlD,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export type { Auth } from '../core/auth.gen';
|
|
2
|
+
export type { QuerySerializerOptions } from '../core/bodySerializer.gen';
|
|
3
|
+
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen';
|
|
4
|
+
export { buildClientParams } from '../core/params.gen';
|
|
5
|
+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
|
|
6
|
+
export { createClient } from './client.gen';
|
|
7
|
+
export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
|
|
8
|
+
export { createConfig, mergeHeaders } from './utils.gen';
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/client/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,6BAA6B,GAC9B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EACV,MAAM,EACN,aAAa,EACb,MAAM,EACN,kBAAkB,EAClB,OAAO,EACP,cAAc,EACd,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type { Auth } from '../core/auth.gen';
|
|
2
|
+
import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen';
|
|
3
|
+
import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
|
|
4
|
+
import type { Middleware } from './utils.gen';
|
|
5
|
+
export type ResponseStyle = 'data' | 'fields';
|
|
6
|
+
export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
|
|
7
|
+
baseUrl?: T['baseUrl'];
|
|
8
|
+
fetch?: typeof fetch;
|
|
9
|
+
next?: never;
|
|
10
|
+
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
11
|
+
responseStyle?: ResponseStyle;
|
|
12
|
+
throwOnError?: T['throwOnError'];
|
|
13
|
+
}
|
|
14
|
+
export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
15
|
+
responseStyle: TResponseStyle;
|
|
16
|
+
throwOnError: ThrowOnError;
|
|
17
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
18
|
+
body?: unknown;
|
|
19
|
+
path?: Record<string, unknown>;
|
|
20
|
+
query?: Record<string, unknown>;
|
|
21
|
+
security?: ReadonlyArray<Auth>;
|
|
22
|
+
url: Url;
|
|
23
|
+
}
|
|
24
|
+
export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
25
|
+
serializedBody?: string;
|
|
26
|
+
}
|
|
27
|
+
export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
|
|
28
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
29
|
+
request: Request;
|
|
30
|
+
response: Response;
|
|
31
|
+
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
32
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
33
|
+
error: undefined;
|
|
34
|
+
} | {
|
|
35
|
+
data: undefined;
|
|
36
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
37
|
+
}) & {
|
|
38
|
+
request: Request;
|
|
39
|
+
response: Response;
|
|
40
|
+
}>;
|
|
41
|
+
export interface ClientOptions {
|
|
42
|
+
baseUrl?: string;
|
|
43
|
+
responseStyle?: ResponseStyle;
|
|
44
|
+
throwOnError?: boolean;
|
|
45
|
+
}
|
|
46
|
+
type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
47
|
+
type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
48
|
+
type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
49
|
+
type BuildUrlFn = <TData extends {
|
|
50
|
+
body?: unknown;
|
|
51
|
+
path?: Record<string, unknown>;
|
|
52
|
+
query?: Record<string, unknown>;
|
|
53
|
+
url: string;
|
|
54
|
+
}>(options: TData & Options<TData>) => string;
|
|
55
|
+
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
56
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
57
|
+
};
|
|
58
|
+
export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
|
|
59
|
+
export interface TDataShape {
|
|
60
|
+
body?: unknown;
|
|
61
|
+
headers?: unknown;
|
|
62
|
+
path?: unknown;
|
|
63
|
+
query?: unknown;
|
|
64
|
+
url: string;
|
|
65
|
+
}
|
|
66
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
67
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
68
|
+
export {};
|
|
69
|
+
//# sourceMappingURL=types.gen.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.gen.d.ts","sourceRoot":"","sources":["../../../src/generated/client/types.gen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE9C,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAC7D,SAAQ,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,EAAE,UAAU;IAIpE,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAOvB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAOrB,IAAI,CAAC,EAAE,KAAK,CAAC;IASb,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;IAMpF,aAAa,CAAC,EAAE,aAAa,CAAC;IAM9B,YAAY,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc,CAC7B,KAAK,GAAG,OAAO,EACf,cAAc,SAAS,aAAa,GAAG,QAAQ,EAC/C,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,GAAG,SAAS,MAAM,GAAG,MAAM,CAE3B,SACE,MAAM,CAAC;IACL,aAAa,EAAE,cAAc,CAAC;IAC9B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC,EACF,IAAI,CACF,uBAAuB,CAAC,KAAK,CAAC,EAC5B,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,qBAAqB,GACrB,kBAAkB,CACrB;IAMH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAIhC,QAAQ,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAC/B,GAAG,EAAE,GAAG,CAAC;CACV;AAED,MAAM,WAAW,sBAAsB,CACrC,cAAc,SAAS,aAAa,GAAG,QAAQ,EAC/C,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,GAAG,SAAS,MAAM,GAAG,MAAM,CAC3B,SAAQ,cAAc,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,CAAC;IAClE,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,aAAa,CACvB,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,cAAc,SAAS,aAAa,GAAG,QAAQ,IAC7C,YAAY,SAAS,IAAI,GACzB,OAAO,CACL,cAAc,SAAS,MAAM,GACzB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,KAAK,CAAC,MAAM,KAAK,CAAC,GAClB,KAAK,GACP;IACE,IAAI,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC;IACzE,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CACN,GACD,OAAO,CACL,cAAc,SAAS,MAAM,GACzB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG,SAAS,GAChF,CACI;IACE,IAAI,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC;IACzE,KAAK,EAAE,SAAS,CAAC;CAClB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,MAAM,CAAC,GAAG,MAAM,CAAC;CAC/E,CACJ,GAAG;IACF,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CACN,CAAC;AAEN,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,KAAK,QAAQ,GAAG,CACd,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,YAAY,SAAS,OAAO,GAAG,KAAK,EACpC,cAAc,SAAS,aAAa,GAAG,QAAQ,EAE/C,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,KACzE,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;AAEhE,KAAK,KAAK,GAAG,CACX,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,YAAY,SAAS,OAAO,GAAG,KAAK,EACpC,cAAc,SAAS,aAAa,GAAG,QAAQ,EAE/C,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,KACzE,OAAO,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAEpD,KAAK,SAAS,GAAG,CACf,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,YAAY,SAAS,OAAO,GAAG,KAAK,EACpC,cAAc,SAAS,aAAa,GAAG,QAAQ,EAE/C,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,GAC1E,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,KAC5E,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;AAEhE,KAAK,UAAU,GAAG,CAChB,KAAK,SAAS;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb,EAED,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAC5B,MAAM,CAAC;AAEZ,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG;IAChF,YAAY,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;CAC9E,CAAC;AAUF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,IAAI,CACxE,QAAQ,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,KACjC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,SAAS,GAAG,OAAO,EACnB,cAAc,SAAS,aAAa,GAAG,QAAQ,IAC7C,QAAQ,CACV,cAAc,CAAC,SAAS,EAAE,cAAc,EAAE,YAAY,CAAC,EACvD,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAClC,GACC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { QuerySerializerOptions } from '../core/bodySerializer.gen';
|
|
2
|
+
import type { Client, ClientOptions, Config, RequestOptions } from './types.gen';
|
|
3
|
+
export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => (queryParams: T) => string;
|
|
4
|
+
export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
|
|
5
|
+
export declare const setAuthParams: ({ security, ...options }: Pick<Required<RequestOptions>, "security"> & Pick<RequestOptions, "auth" | "query"> & {
|
|
6
|
+
headers: Headers;
|
|
7
|
+
}) => Promise<void>;
|
|
8
|
+
export declare const buildUrl: Client['buildUrl'];
|
|
9
|
+
export declare const mergeConfigs: (a: Config, b: Config) => Config;
|
|
10
|
+
export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
|
|
11
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
|
|
12
|
+
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
13
|
+
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
14
|
+
declare class Interceptors<Interceptor> {
|
|
15
|
+
fns: Array<Interceptor | null>;
|
|
16
|
+
clear(): void;
|
|
17
|
+
eject(id: number | Interceptor): void;
|
|
18
|
+
exists(id: number | Interceptor): boolean;
|
|
19
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
20
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
21
|
+
use(fn: Interceptor): number;
|
|
22
|
+
}
|
|
23
|
+
export interface Middleware<Req, Res, Err, Options> {
|
|
24
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
25
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
26
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
27
|
+
}
|
|
28
|
+
export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
|
|
29
|
+
export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
|
|
30
|
+
export {};
|
|
31
|
+
//# sourceMappingURL=utils.gen.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.gen.d.ts","sourceRoot":"","sources":["../../../src/generated/client/utils.gen.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAQzE,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEjF,eAAO,MAAM,qBAAqB,GAAI,CAAC,GAAG,OAAO,EAAE,0BAGhD,sBAA2B,mBACU,CAAC,WA6CxC,CAAC;AAKF,eAAO,MAAM,UAAU,GAAI,aAAa,MAAM,GAAG,IAAI,KAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAgCxF,CAAC;AAqBF,eAAO,MAAM,aAAa,GAAU,0BAGjC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,GAC3C,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG;IACvC,OAAO,EAAE,OAAO,CAAC;CAClB,kBA8BF,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,UAAU,CAUpC,CAAC;AAEL,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,MAOnD,CAAC;AAUF,eAAO,MAAM,YAAY,GACvB,GAAG,SAAS,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,KACzD,OA2BF,CAAC;AAEF,KAAK,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,IAAI,CAC5C,KAAK,EAAE,GAAG,EACV,QAAQ,EAAE,GAAG,EACb,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,OAAO,KACb,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAExB,KAAK,cAAc,CAAC,GAAG,EAAE,OAAO,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAE3F,KAAK,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,IAAI,CACvC,QAAQ,EAAE,GAAG,EACb,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,OAAO,KACb,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAExB,cAAM,YAAY,CAAC,WAAW;IAC5B,GAAG,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,CAAM;IAEpC,KAAK,IAAI,IAAI;IAIb,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAOrC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO;IAKzC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM;IAOrD,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,EAAE,EAAE,EAAE,WAAW,GAAG,MAAM,GAAG,WAAW,GAAG,KAAK;IAS/E,GAAG,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM;CAI7B;AAED,MAAM,WAAW,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO;IAChD,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5D,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;CAC3D;AAED,eAAO,MAAM,kBAAkB,GAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,OAAK,UAAU,CACtE,GAAG,EACH,GAAG,EACH,GAAG,EACH,OAAO,CAKP,CAAC;AAkBH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,aAAa,GAAG,aAAa,EAClE,WAAU,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAM,KACtD,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAMxC,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type ClientOptions, type Config } from './client';
|
|
2
|
+
import type { ClientOptions as ClientOptions2 } from './types.gen';
|
|
3
|
+
export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
|
|
4
|
+
export declare const client: import("./client").Client;
|
|
5
|
+
//# sourceMappingURL=client.gen.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.gen.d.ts","sourceRoot":"","sources":["../../src/generated/client.gen.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,MAAM,EAA8B,MAAM,UAAU,CAAC;AACvF,OAAO,KAAK,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,aAAa,CAAC;AAUnE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,aAAa,GAAG,cAAc,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAEzJ,eAAO,MAAM,MAAM,2BAA+C,CAAC"}
|