@orchestration-ai/sdk 0.1.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 +316 -0
- package/dist/cjs/client/client.gen.d.ts +3 -0
- package/dist/cjs/client/client.gen.d.ts.map +1 -0
- package/dist/cjs/client/client.gen.js +143 -0
- package/dist/cjs/client/client.gen.js.map +1 -0
- package/dist/cjs/client/index.d.ts +9 -0
- package/dist/cjs/client/index.d.ts.map +1 -0
- package/dist/cjs/client/index.js +17 -0
- package/dist/cjs/client/index.js.map +1 -0
- package/dist/cjs/client/types.gen.d.ts +88 -0
- package/dist/cjs/client/types.gen.d.ts.map +1 -0
- package/dist/cjs/client/types.gen.js +4 -0
- package/dist/cjs/client/types.gen.js.map +1 -0
- package/dist/cjs/client/utils.gen.d.ts +15 -0
- package/dist/cjs/client/utils.gen.d.ts.map +1 -0
- package/dist/cjs/client/utils.gen.js +182 -0
- package/dist/cjs/client/utils.gen.js.map +1 -0
- package/dist/cjs/client.gen.d.ts +13 -0
- package/dist/cjs/client.gen.d.ts.map +1 -0
- package/dist/cjs/client.gen.js +7 -0
- package/dist/cjs/client.gen.js.map +1 -0
- package/dist/cjs/core/auth.gen.d.ts +19 -0
- package/dist/cjs/core/auth.gen.d.ts.map +1 -0
- package/dist/cjs/core/auth.gen.js +19 -0
- package/dist/cjs/core/auth.gen.js.map +1 -0
- package/dist/cjs/core/bodySerializer.gen.d.ts +26 -0
- package/dist/cjs/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/cjs/core/bodySerializer.gen.js +61 -0
- package/dist/cjs/core/bodySerializer.gen.js.map +1 -0
- package/dist/cjs/core/params.gen.d.ts +44 -0
- package/dist/cjs/core/params.gen.d.ts.map +1 -0
- package/dist/cjs/core/params.gen.js +105 -0
- package/dist/cjs/core/params.gen.js.map +1 -0
- package/dist/cjs/core/pathSerializer.gen.d.ts +34 -0
- package/dist/cjs/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/cjs/core/pathSerializer.gen.js +116 -0
- package/dist/cjs/core/pathSerializer.gen.js.map +1 -0
- package/dist/cjs/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/cjs/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/cjs/core/queryKeySerializer.gen.js +99 -0
- package/dist/cjs/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/cjs/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/cjs/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/cjs/core/serverSentEvents.gen.js +137 -0
- package/dist/cjs/core/serverSentEvents.gen.js.map +1 -0
- package/dist/cjs/core/types.gen.d.ts +79 -0
- package/dist/cjs/core/types.gen.d.ts.map +1 -0
- package/dist/cjs/core/types.gen.js +4 -0
- package/dist/cjs/core/types.gen.js.map +1 -0
- package/dist/cjs/core/utils.gen.d.ts +20 -0
- package/dist/cjs/core/utils.gen.d.ts.map +1 -0
- package/dist/cjs/core/utils.gen.js +94 -0
- package/dist/cjs/core/utils.gen.js.map +1 -0
- package/dist/cjs/index.d.ts +3 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +72 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/sdk.gen.d.ts +81 -0
- package/dist/cjs/sdk.gen.d.ts.map +1 -0
- package/dist/cjs/sdk.gen.js +752 -0
- package/dist/cjs/sdk.gen.js.map +1 -0
- package/dist/cjs/types.gen.d.ts +3653 -0
- package/dist/cjs/types.gen.d.ts.map +1 -0
- package/dist/cjs/types.gen.js +4 -0
- package/dist/cjs/types.gen.js.map +1 -0
- package/dist/esm/client/client.gen.d.ts +3 -0
- package/dist/esm/client/client.gen.d.ts.map +1 -0
- package/dist/esm/client/client.gen.js +136 -0
- package/dist/esm/client/client.gen.js.map +1 -0
- package/dist/esm/client/index.d.ts +9 -0
- package/dist/esm/client/index.d.ts.map +1 -0
- package/dist/esm/client/index.js +7 -0
- package/dist/esm/client/index.js.map +1 -0
- package/dist/esm/client/types.gen.d.ts +88 -0
- package/dist/esm/client/types.gen.d.ts.map +1 -0
- package/dist/esm/client/types.gen.js +3 -0
- package/dist/esm/client/types.gen.js.map +1 -0
- package/dist/esm/client/utils.gen.d.ts +15 -0
- package/dist/esm/client/utils.gen.d.ts.map +1 -0
- package/dist/esm/client/utils.gen.js +173 -0
- package/dist/esm/client/utils.gen.js.map +1 -0
- package/dist/esm/client.gen.d.ts +13 -0
- package/dist/esm/client.gen.d.ts.map +1 -0
- package/dist/esm/client.gen.js +4 -0
- package/dist/esm/client.gen.js.map +1 -0
- package/dist/esm/core/auth.gen.d.ts +19 -0
- package/dist/esm/core/auth.gen.d.ts.map +1 -0
- package/dist/esm/core/auth.gen.js +15 -0
- package/dist/esm/core/auth.gen.js.map +1 -0
- package/dist/esm/core/bodySerializer.gen.d.ts +26 -0
- package/dist/esm/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/esm/core/bodySerializer.gen.js +58 -0
- package/dist/esm/core/bodySerializer.gen.js.map +1 -0
- package/dist/esm/core/params.gen.d.ts +44 -0
- package/dist/esm/core/params.gen.d.ts.map +1 -0
- package/dist/esm/core/params.gen.js +101 -0
- package/dist/esm/core/params.gen.js.map +1 -0
- package/dist/esm/core/pathSerializer.gen.d.ts +34 -0
- package/dist/esm/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/esm/core/pathSerializer.gen.js +107 -0
- package/dist/esm/core/pathSerializer.gen.js.map +1 -0
- package/dist/esm/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/esm/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/esm/core/queryKeySerializer.gen.js +93 -0
- package/dist/esm/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/esm/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/esm/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/esm/core/serverSentEvents.gen.js +134 -0
- package/dist/esm/core/serverSentEvents.gen.js.map +1 -0
- package/dist/esm/core/types.gen.d.ts +79 -0
- package/dist/esm/core/types.gen.d.ts.map +1 -0
- package/dist/esm/core/types.gen.js +3 -0
- package/dist/esm/core/types.gen.js.map +1 -0
- package/dist/esm/core/utils.gen.d.ts +20 -0
- package/dist/esm/core/utils.gen.d.ts.map +1 -0
- package/dist/esm/core/utils.gen.js +88 -0
- package/dist/esm/core/utils.gen.js.map +1 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +3 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +1 -0
- package/dist/esm/sdk.gen.d.ts +81 -0
- package/dist/esm/sdk.gen.d.ts.map +1 -0
- package/dist/esm/sdk.gen.js +683 -0
- package/dist/esm/sdk.gen.js.map +1 -0
- package/dist/esm/types.gen.d.ts +3653 -0
- package/dist/esm/types.gen.d.ts.map +1 -0
- package/dist/esm/types.gen.js +3 -0
- package/dist/esm/types.gen.js.map +1 -0
- package/package.json +56 -0
package/README.md
ADDED
|
@@ -0,0 +1,316 @@
|
|
|
1
|
+
# @orchestration-ai/sdk
|
|
2
|
+
|
|
3
|
+
TypeScript SDK for [Orchestration AI](https://orchestration-ai.com) — The Operating System for AI-Powered Businesses.
|
|
4
|
+
|
|
5
|
+
Works in both **Node.js** and the **browser** using the same package.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @orchestration-ai/sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
The SDK exports a pre-configured `client` with the correct base URL. Just import and use:
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { client } from '@orchestration-ai/sdk/client.gen';
|
|
19
|
+
import { workspaceFind } from '@orchestration-ai/sdk';
|
|
20
|
+
|
|
21
|
+
const response = await workspaceFind();
|
|
22
|
+
console.log(response.data);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Authentication
|
|
26
|
+
|
|
27
|
+
### Node.js (Server-Side)
|
|
28
|
+
|
|
29
|
+
For server-to-server authentication, use the **client_credentials** OAuth flow. The SDK manages token acquisition and refresh automatically:
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { client } from '@orchestration-ai/sdk/client.gen';
|
|
33
|
+
import { setupClientCredentials, workspaceFind } from '@orchestration-ai/sdk';
|
|
34
|
+
|
|
35
|
+
// Setup once — tokens are fetched and refreshed automatically
|
|
36
|
+
setupClientCredentials(client, {
|
|
37
|
+
client_id: 'your-client-id',
|
|
38
|
+
client_secret: 'your-client-secret',
|
|
39
|
+
scope: 'role_admin', // any supported role as scope
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
// All requests are now authenticated
|
|
43
|
+
const workspaces = await workspaceFind();
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
The SDK will:
|
|
47
|
+
- Automatically obtain an access token via `client_credentials` on the first request
|
|
48
|
+
- Re-fetch the token when it expires (with a 30s buffer)
|
|
49
|
+
- Retry once on 401 responses with a fresh token
|
|
50
|
+
- Deduplicate concurrent token requests
|
|
51
|
+
|
|
52
|
+
The `scope` parameter accepts any supported role (e.g. `role_admin`, `role_workspace_writer`, `role_agent_reader`). See [Roles & Permissions](#roles--permissions) for the full list.
|
|
53
|
+
|
|
54
|
+
### Browser (Client-Side)
|
|
55
|
+
|
|
56
|
+
Browser apps should never expose a `client_secret`. The SDK provides utilities to manage the OAuth redirect flow and token storage. Token acquisition and refresh should be handled by your backend.
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { client } from '@orchestration-ai/sdk/client.gen';
|
|
60
|
+
import {
|
|
61
|
+
setupBrowserAuth,
|
|
62
|
+
initiateLogin,
|
|
63
|
+
parseLoginRedirect,
|
|
64
|
+
saveLogin,
|
|
65
|
+
getCurrentLogin,
|
|
66
|
+
isLoginExpired,
|
|
67
|
+
logout,
|
|
68
|
+
} from '@orchestration-ai/sdk';
|
|
69
|
+
|
|
70
|
+
// Attach stored tokens to all requests automatically
|
|
71
|
+
// Optionally provide a refresh callback for automatic token renewal
|
|
72
|
+
setupBrowserAuth(client, {
|
|
73
|
+
onRefreshToken: async () => {
|
|
74
|
+
// Call your backend to refresh the token
|
|
75
|
+
const response = await fetch('/api/auth/refresh');
|
|
76
|
+
if (!response.ok) return null;
|
|
77
|
+
return response.json(); // must return OAuthTokens shape
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
#### OAuth Login Flow
|
|
83
|
+
|
|
84
|
+
**Step 1: Initiate login (redirects the browser)**
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import { client } from '@orchestration-ai/sdk/client.gen';
|
|
88
|
+
import { initiateLogin } from '@orchestration-ai/sdk';
|
|
89
|
+
|
|
90
|
+
function handleLoginClick() {
|
|
91
|
+
initiateLogin(client.getConfig().baseURL, {
|
|
92
|
+
client_id: 'your-client-id',
|
|
93
|
+
redirect_uri: 'https://your-app.com/callback',
|
|
94
|
+
scope: 'role_admin', // any supported role as scope
|
|
95
|
+
}, 'optional-state-value');
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
This redirects the user to the Orchestration AI login page.
|
|
100
|
+
|
|
101
|
+
**Step 2: Handle the redirect callback**
|
|
102
|
+
|
|
103
|
+
On your callback page (e.g. `/callback`), parse the redirect result and exchange the code via your backend:
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
import { parseLoginRedirect, saveLogin } from '@orchestration-ai/sdk';
|
|
107
|
+
|
|
108
|
+
const result = parseLoginRedirect();
|
|
109
|
+
|
|
110
|
+
if (result.granted) {
|
|
111
|
+
// Send the code to your backend to exchange for tokens securely
|
|
112
|
+
// IMPORTANT: pass the same redirect_uri used in initiateLogin
|
|
113
|
+
const tokens = await fetch('/api/auth/exchange', {
|
|
114
|
+
method: 'POST',
|
|
115
|
+
body: JSON.stringify({
|
|
116
|
+
code: result.code,
|
|
117
|
+
redirect_uri: 'https://your-app.com/callback',
|
|
118
|
+
}),
|
|
119
|
+
}).then(r => r.json());
|
|
120
|
+
|
|
121
|
+
// Save the tokens — setupBrowserAuth will attach them to future requests
|
|
122
|
+
saveLogin(tokens);
|
|
123
|
+
} else {
|
|
124
|
+
console.error('Login denied:', result.error, result.error_description);
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
#### Token Refresh
|
|
129
|
+
|
|
130
|
+
If you provided `onRefreshToken` to `setupBrowserAuth`, token refresh is handled automatically — both proactively when the token is about to expire and reactively on 401 responses.
|
|
131
|
+
|
|
132
|
+
If you prefer to handle refresh manually:
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import { isLoginExpired, saveLogin, logout } from '@orchestration-ai/sdk';
|
|
136
|
+
|
|
137
|
+
if (isLoginExpired()) {
|
|
138
|
+
const response = await fetch('/api/auth/refresh');
|
|
139
|
+
if (response.ok) {
|
|
140
|
+
saveLogin(await response.json());
|
|
141
|
+
} else {
|
|
142
|
+
logout();
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
#### Logout
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
import { logout } from '@orchestration-ai/sdk';
|
|
151
|
+
|
|
152
|
+
logout(); // Clears stored tokens from localStorage
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## API Usage Examples
|
|
156
|
+
|
|
157
|
+
### Workspaces
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import { workspaceFind, workspaceCreate, workspaceFindById } from '@orchestration-ai/sdk';
|
|
161
|
+
|
|
162
|
+
// List workspaces
|
|
163
|
+
const { data } = await workspaceFind({ query: { limit: 10, offset: 0 } });
|
|
164
|
+
|
|
165
|
+
// Create a workspace
|
|
166
|
+
const { data: workspace } = await workspaceCreate({
|
|
167
|
+
body: { workspace_name: 'My Workspace' },
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
// Get a workspace by ID
|
|
171
|
+
const { data: ws } = await workspaceFindById({ path: { id: 'workspace-id' } });
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Orchestrations
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
import {
|
|
178
|
+
orchestrationFindByWorkspace,
|
|
179
|
+
orchestrationCreate,
|
|
180
|
+
} from '@orchestration-ai/sdk';
|
|
181
|
+
|
|
182
|
+
// List orchestrations in a workspace
|
|
183
|
+
const { data } = await orchestrationFindByWorkspace({
|
|
184
|
+
path: { workspaceId: 'workspace-id' },
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
// Create an orchestration
|
|
188
|
+
const { data: orch } = await orchestrationCreate({
|
|
189
|
+
path: { workspaceId: 'workspace-id' },
|
|
190
|
+
body: {
|
|
191
|
+
orchestration_name: 'My Orchestration',
|
|
192
|
+
orchestration_description: 'Handles customer support',
|
|
193
|
+
},
|
|
194
|
+
});
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Agents
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import { agentFindByOrchestration, agentCreate } from '@orchestration-ai/sdk';
|
|
201
|
+
|
|
202
|
+
// List agents
|
|
203
|
+
const { data } = await agentFindByOrchestration({
|
|
204
|
+
path: { workspaceId: 'ws-id', orchestrationId: 'orch-id' },
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
// Create an agent
|
|
208
|
+
const { data: agent } = await agentCreate({
|
|
209
|
+
path: { workspaceId: 'ws-id', orchestrationId: 'orch-id' },
|
|
210
|
+
body: {
|
|
211
|
+
agent_name: 'Support Agent',
|
|
212
|
+
agent_description: 'Handles tier 1 support tickets',
|
|
213
|
+
},
|
|
214
|
+
});
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Error Handling
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
import { workspaceFind } from '@orchestration-ai/sdk';
|
|
221
|
+
|
|
222
|
+
const response = await workspaceFind();
|
|
223
|
+
|
|
224
|
+
if (response.error) {
|
|
225
|
+
console.error('Request failed:', response.error);
|
|
226
|
+
} else {
|
|
227
|
+
console.log('Workspaces:', response.data);
|
|
228
|
+
}
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### Using throwOnError
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import { workspaceFind } from '@orchestration-ai/sdk';
|
|
235
|
+
|
|
236
|
+
try {
|
|
237
|
+
const response = await workspaceFind({ throwOnError: true });
|
|
238
|
+
console.log('Workspaces:', response.data);
|
|
239
|
+
} catch (error) {
|
|
240
|
+
console.error('Request failed:', error);
|
|
241
|
+
}
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## Roles & Permissions
|
|
245
|
+
|
|
246
|
+
Access control uses a hierarchical role system. Higher-level roles inherit all permissions from their children.
|
|
247
|
+
|
|
248
|
+
### Top-Level Roles
|
|
249
|
+
|
|
250
|
+
| Role | Inherits |
|
|
251
|
+
|------|----------|
|
|
252
|
+
| `role_admin` | `role_workspace_admin`, `role_application_admin`, `role_access_admin`, `role_llm_keys_admin`, `role_llm_reader`, `role_llm_lister`, `role_service_reader`, `role_service_lister`, `role_day_pass_transaction_lister` |
|
|
253
|
+
|
|
254
|
+
### Admin Roles
|
|
255
|
+
|
|
256
|
+
| Role | Inherits |
|
|
257
|
+
|------|----------|
|
|
258
|
+
| `role_workspace_admin` | `role_workspace_writer`, `role_workspace_lister`, `role_workspace_deleter`, `role_orchestration_admin` |
|
|
259
|
+
| `role_orchestration_admin` | `role_orchestration_writer`, `role_orchestration_lister`, `role_orchestration_deleter`, `role_agent_admin` |
|
|
260
|
+
| `role_agent_admin` | `role_agent_writer`, `role_agent_lister`, `role_agent_deleter` |
|
|
261
|
+
| `role_application_admin` | `role_application_writer`, `role_application_lister`, `role_application_deleter` |
|
|
262
|
+
| `role_access_admin` | `role_access_writer`, `role_access_lister`, `role_access_deleter` |
|
|
263
|
+
| `role_llm_keys_admin` | `role_llm_keys_writer`, `role_llm_keys_lister` |
|
|
264
|
+
|
|
265
|
+
### Writer Roles
|
|
266
|
+
|
|
267
|
+
| Role | Inherits |
|
|
268
|
+
|------|----------|
|
|
269
|
+
| `role_workspace_writer` | `role_workspace_inserter`, `role_workspace_reader`, `role_workspace_updater` |
|
|
270
|
+
| `role_orchestration_writer` | `role_orchestration_inserter`, `role_orchestration_reader`, `role_orchestration_updater` |
|
|
271
|
+
| `role_agent_writer` | `role_agent_inserter`, `role_agent_reader`, `role_agent_updater` |
|
|
272
|
+
| `role_application_writer` | `role_application_inserter`, `role_application_reader`, `role_application_updater` |
|
|
273
|
+
| `role_access_writer` | `role_access_inserter`, `role_access_reader` |
|
|
274
|
+
| `role_llm_keys_writer` | `role_llm_keys_inserter`, `role_llm_keys_reader`, `role_llm_keys_updater` |
|
|
275
|
+
|
|
276
|
+
### Granular Permissions
|
|
277
|
+
|
|
278
|
+
Each resource has fine-grained permissions:
|
|
279
|
+
|
|
280
|
+
- `*_reader` — Read a single resource by ID
|
|
281
|
+
- `*_lister` — List/query resources
|
|
282
|
+
- `*_inserter` — Create new resources
|
|
283
|
+
- `*_updater` — Update existing resources
|
|
284
|
+
- `*_deleter` — Delete resources
|
|
285
|
+
|
|
286
|
+
### Example: Granting Access
|
|
287
|
+
|
|
288
|
+
```typescript
|
|
289
|
+
import { accessCreate } from '@orchestration-ai/sdk';
|
|
290
|
+
|
|
291
|
+
// Grant a user full admin access to a workspace
|
|
292
|
+
await accessCreate({
|
|
293
|
+
body: {
|
|
294
|
+
resource_id: 'workspace-id',
|
|
295
|
+
principal_id: 'user-uid',
|
|
296
|
+
principal_name: 'Jane Doe',
|
|
297
|
+
principal_email: 'jane@example.com',
|
|
298
|
+
role: 'role_admin',
|
|
299
|
+
},
|
|
300
|
+
});
|
|
301
|
+
|
|
302
|
+
// Grant read-only access to orchestrations
|
|
303
|
+
await accessCreate({
|
|
304
|
+
body: {
|
|
305
|
+
resource_id: 'workspace-id',
|
|
306
|
+
principal_id: 'user-uid',
|
|
307
|
+
principal_name: 'Viewer',
|
|
308
|
+
principal_email: 'viewer@example.com',
|
|
309
|
+
role: 'role_orchestration_reader',
|
|
310
|
+
},
|
|
311
|
+
});
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
## License
|
|
315
|
+
|
|
316
|
+
MIT
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.gen.d.ts","sourceRoot":"","sources":["../../../typescript/client/client.gen.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAkB,MAAM,aAAa,CAAC;AAGlE,eAAO,MAAM,YAAY,GAAI,SAAQ,MAAW,KAAG,MAwJlD,CAAC"}
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
|
+
};
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.createClient = void 0;
|
|
8
|
+
const axios_1 = __importDefault(require("axios"));
|
|
9
|
+
const serverSentEvents_gen_1 = require("../core/serverSentEvents.gen");
|
|
10
|
+
const utils_gen_1 = require("../core/utils.gen");
|
|
11
|
+
const utils_gen_2 = require("./utils.gen");
|
|
12
|
+
const createClient = (config = {}) => {
|
|
13
|
+
let _config = (0, utils_gen_2.mergeConfigs)((0, utils_gen_2.createConfig)(), config);
|
|
14
|
+
let instance;
|
|
15
|
+
if (_config.axios && !('Axios' in _config.axios)) {
|
|
16
|
+
instance = _config.axios;
|
|
17
|
+
}
|
|
18
|
+
else {
|
|
19
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
20
|
+
const { auth, ...configWithoutAuth } = _config;
|
|
21
|
+
instance = axios_1.default.create(configWithoutAuth);
|
|
22
|
+
}
|
|
23
|
+
const getConfig = () => ({ ..._config });
|
|
24
|
+
const setConfig = (config) => {
|
|
25
|
+
_config = (0, utils_gen_2.mergeConfigs)(_config, config);
|
|
26
|
+
instance.defaults = {
|
|
27
|
+
...instance.defaults,
|
|
28
|
+
..._config,
|
|
29
|
+
// @ts-expect-error
|
|
30
|
+
headers: (0, utils_gen_2.mergeHeaders)(instance.defaults.headers, _config.headers),
|
|
31
|
+
};
|
|
32
|
+
return getConfig();
|
|
33
|
+
};
|
|
34
|
+
const beforeRequest = async (options) => {
|
|
35
|
+
var _a, _b;
|
|
36
|
+
const opts = {
|
|
37
|
+
..._config,
|
|
38
|
+
...options,
|
|
39
|
+
axios: (_b = (_a = options.axios) !== null && _a !== void 0 ? _a : _config.axios) !== null && _b !== void 0 ? _b : instance,
|
|
40
|
+
headers: (0, utils_gen_2.mergeHeaders)(_config.headers, options.headers),
|
|
41
|
+
};
|
|
42
|
+
if (opts.security) {
|
|
43
|
+
await (0, utils_gen_2.setAuthParams)({
|
|
44
|
+
...opts,
|
|
45
|
+
security: opts.security,
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
if (opts.requestValidator) {
|
|
49
|
+
await opts.requestValidator(opts);
|
|
50
|
+
}
|
|
51
|
+
if (opts.body !== undefined && opts.bodySerializer) {
|
|
52
|
+
opts.body = opts.bodySerializer(opts.body);
|
|
53
|
+
}
|
|
54
|
+
const url = (0, utils_gen_2.buildUrl)(opts);
|
|
55
|
+
return { opts, url };
|
|
56
|
+
};
|
|
57
|
+
// @ts-expect-error
|
|
58
|
+
const request = async (options) => {
|
|
59
|
+
var _a, _b;
|
|
60
|
+
const { opts, url } = await beforeRequest(options);
|
|
61
|
+
try {
|
|
62
|
+
// assign Axios here for consistency with fetch
|
|
63
|
+
const _axios = opts.axios;
|
|
64
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
65
|
+
const { auth, ...optsWithoutAuth } = opts;
|
|
66
|
+
const response = await _axios({
|
|
67
|
+
...optsWithoutAuth,
|
|
68
|
+
baseURL: '', // the baseURL is already included in `url`
|
|
69
|
+
data: (0, utils_gen_1.getValidRequestBody)(opts),
|
|
70
|
+
headers: opts.headers,
|
|
71
|
+
// let `paramsSerializer()` handle query params if it exists
|
|
72
|
+
params: opts.paramsSerializer ? opts.query : undefined,
|
|
73
|
+
url,
|
|
74
|
+
});
|
|
75
|
+
let { data } = response;
|
|
76
|
+
if (opts.responseType === 'json') {
|
|
77
|
+
if (opts.responseValidator) {
|
|
78
|
+
await opts.responseValidator(data);
|
|
79
|
+
}
|
|
80
|
+
if (opts.responseTransformer) {
|
|
81
|
+
data = await opts.responseTransformer(data);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return {
|
|
85
|
+
...response,
|
|
86
|
+
data: data !== null && data !== void 0 ? data : {},
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
catch (error) {
|
|
90
|
+
const e = error;
|
|
91
|
+
if (opts.throwOnError) {
|
|
92
|
+
throw e;
|
|
93
|
+
}
|
|
94
|
+
// @ts-expect-error
|
|
95
|
+
e.error = (_b = (_a = e.response) === null || _a === void 0 ? void 0 : _a.data) !== null && _b !== void 0 ? _b : {};
|
|
96
|
+
return e;
|
|
97
|
+
}
|
|
98
|
+
};
|
|
99
|
+
const makeMethodFn = (method) => (options) => request({ ...options, method });
|
|
100
|
+
const makeSseFn = (method) => async (options) => {
|
|
101
|
+
const { opts, url } = await beforeRequest(options);
|
|
102
|
+
return (0, serverSentEvents_gen_1.createSseClient)({
|
|
103
|
+
...opts,
|
|
104
|
+
body: opts.body,
|
|
105
|
+
headers: opts.headers,
|
|
106
|
+
method,
|
|
107
|
+
serializedBody: (0, utils_gen_1.getValidRequestBody)(opts),
|
|
108
|
+
// @ts-expect-error
|
|
109
|
+
signal: opts.signal,
|
|
110
|
+
url,
|
|
111
|
+
});
|
|
112
|
+
};
|
|
113
|
+
const _buildUrl = (options) => (0, utils_gen_2.buildUrl)({ axios: instance, ..._config, ...options });
|
|
114
|
+
return {
|
|
115
|
+
buildUrl: _buildUrl,
|
|
116
|
+
connect: makeMethodFn('CONNECT'),
|
|
117
|
+
delete: makeMethodFn('DELETE'),
|
|
118
|
+
get: makeMethodFn('GET'),
|
|
119
|
+
getConfig,
|
|
120
|
+
head: makeMethodFn('HEAD'),
|
|
121
|
+
instance,
|
|
122
|
+
options: makeMethodFn('OPTIONS'),
|
|
123
|
+
patch: makeMethodFn('PATCH'),
|
|
124
|
+
post: makeMethodFn('POST'),
|
|
125
|
+
put: makeMethodFn('PUT'),
|
|
126
|
+
request,
|
|
127
|
+
setConfig,
|
|
128
|
+
sse: {
|
|
129
|
+
connect: makeSseFn('CONNECT'),
|
|
130
|
+
delete: makeSseFn('DELETE'),
|
|
131
|
+
get: makeSseFn('GET'),
|
|
132
|
+
head: makeSseFn('HEAD'),
|
|
133
|
+
options: makeSseFn('OPTIONS'),
|
|
134
|
+
patch: makeSseFn('PATCH'),
|
|
135
|
+
post: makeSseFn('POST'),
|
|
136
|
+
put: makeSseFn('PUT'),
|
|
137
|
+
trace: makeSseFn('TRACE'),
|
|
138
|
+
},
|
|
139
|
+
trace: makeMethodFn('TRACE'),
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
exports.createClient = createClient;
|
|
143
|
+
//# sourceMappingURL=client.gen.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.gen.js","sourceRoot":"","sources":["../../../typescript/client/client.gen.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;AAGrD,kDAA0B;AAE1B,uEAA+D;AAE/D,iDAAwD;AAExD,2CAAgG;AAEzF,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,EAAU,EAAE;IAC1D,IAAI,OAAO,GAAG,IAAA,wBAAY,EAAC,IAAA,wBAAY,GAAE,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,QAAuB,CAAC;IAE5B,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,6DAA6D;QAC7D,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC;QAC/C,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,SAAS,GAAG,GAAW,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAEjD,MAAM,SAAS,GAAG,CAAC,MAAc,EAAU,EAAE;QAC3C,OAAO,GAAG,IAAA,wBAAY,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,QAAQ,CAAC,QAAQ,GAAG;YAClB,GAAG,QAAQ,CAAC,QAAQ;YACpB,GAAG,OAAO;YACV,mBAAmB;YACnB,OAAO,EAAE,IAAA,wBAAY,EAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;SAClE,CAAC;QACF,OAAO,SAAS,EAAE,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,KAAK,EAKzB,OAAiD,EACjD,EAAE;;QACF,MAAM,IAAI,GAAG;YACX,GAAG,OAAO;YACV,GAAG,OAAO;YACV,KAAK,EAAE,MAAA,MAAA,OAAO,CAAC,KAAK,mCAAI,OAAO,CAAC,KAAK,mCAAI,QAAQ;YACjD,OAAO,EAAE,IAAA,wBAAY,EAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;SACxD,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAA,yBAAa,EAAC;gBAClB,GAAG,IAAI;gBACP,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,GAAG,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IACvB,CAAC,CAAC;IAEF,mBAAmB;IACnB,MAAM,OAAO,GAAsB,KAAK,EAAE,OAAO,EAAE,EAAE;;QACnD,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC;YACH,+CAA+C;YAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAM,CAAC;YAC3B,6DAA6D;YAC7D,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,EAAE,GAAG,IAAI,CAAC;YAC1C,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC;gBAC5B,GAAG,eAAe;gBAClB,OAAO,EAAE,EAAE,EAAE,2CAA2C;gBACxD,IAAI,EAAE,IAAA,+BAAmB,EAAC,IAAI,CAAC;gBAC/B,OAAO,EAAE,IAAI,CAAC,OAAiC;gBAC/C,4DAA4D;gBAC5D,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;gBACtD,GAAG;aACJ,CAAC,CAAC;YAEH,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;YAExB,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,EAAE,CAAC;gBACjC,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC3B,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC;gBAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC7B,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAED,OAAO;gBACL,GAAG,QAAQ;gBACX,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE;aACjB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,KAAmB,CAAC;YAC9B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,MAAM,CAAC,CAAC;YACV,CAAC;YACD,mBAAmB;YACnB,CAAC,CAAC,KAAK,GAAG,MAAA,MAAA,CAAC,CAAC,QAAQ,0CAAE,IAAI,mCAAI,EAAE,CAAC;YACjC,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,MAA6B,EAAE,EAAE,CAAC,CAAC,OAAuB,EAAE,EAAE,CAClF,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAElC,MAAM,SAAS,GAAG,CAAC,MAA6B,EAAE,EAAE,CAAC,KAAK,EAAE,OAAuB,EAAE,EAAE;QACrF,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAA,sCAAe,EAAC;YACrB,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,IAAmC;YAC9C,OAAO,EAAE,IAAI,CAAC,OAAiC;YAC/C,MAAM;YACN,cAAc,EAAE,IAAA,+BAAmB,EAAC,IAAI,CAAgC;YACxE,mBAAmB;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,GAAG;SACJ,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAuB,CAAC,OAAO,EAAE,EAAE,CAChD,IAAA,oBAAQ,EAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAExD,OAAO;QACL,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC;QAChC,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC;QAC9B,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC;QACxB,SAAS;QACT,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;QAC1B,QAAQ;QACR,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC;QAChC,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC;QAC5B,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;QAC1B,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC;QACxB,OAAO;QACP,SAAS;QACT,GAAG,EAAE;YACH,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC;YAC7B,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC;YAC3B,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;YACrB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC;YAC7B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;YACzB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;YACvB,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;YACrB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;SAC1B;QACD,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC;KACnB,CAAC;AACd,CAAC,CAAC;AAxJW,QAAA,YAAY,gBAwJvB"}
|
|
@@ -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, TDataShape, } from './types.gen';
|
|
8
|
+
export { createConfig } from './utils.gen';
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../typescript/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,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.createConfig = exports.createClient = exports.serializeQueryKeyValue = exports.buildClientParams = exports.urlSearchParamsBodySerializer = exports.jsonBodySerializer = exports.formDataBodySerializer = void 0;
|
|
5
|
+
var bodySerializer_gen_1 = require("../core/bodySerializer.gen");
|
|
6
|
+
Object.defineProperty(exports, "formDataBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.formDataBodySerializer; } });
|
|
7
|
+
Object.defineProperty(exports, "jsonBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.jsonBodySerializer; } });
|
|
8
|
+
Object.defineProperty(exports, "urlSearchParamsBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.urlSearchParamsBodySerializer; } });
|
|
9
|
+
var params_gen_1 = require("../core/params.gen");
|
|
10
|
+
Object.defineProperty(exports, "buildClientParams", { enumerable: true, get: function () { return params_gen_1.buildClientParams; } });
|
|
11
|
+
var queryKeySerializer_gen_1 = require("../core/queryKeySerializer.gen");
|
|
12
|
+
Object.defineProperty(exports, "serializeQueryKeyValue", { enumerable: true, get: function () { return queryKeySerializer_gen_1.serializeQueryKeyValue; } });
|
|
13
|
+
var client_gen_1 = require("./client.gen");
|
|
14
|
+
Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_gen_1.createClient; } });
|
|
15
|
+
var utils_gen_1 = require("./utils.gen");
|
|
16
|
+
Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return utils_gen_1.createConfig; } });
|
|
17
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../typescript/client/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAIrD,iEAIoC;AAHlC,4HAAA,sBAAsB,OAAA;AACtB,wHAAA,kBAAkB,OAAA;AAClB,mIAAA,6BAA6B,OAAA;AAE/B,iDAAuD;AAA9C,+GAAA,iBAAiB,OAAA;AAC1B,yEAAwE;AAA/D,gIAAA,sBAAsB,OAAA;AAC/B,2CAA4C;AAAnC,0GAAA,YAAY,OAAA;AAWrB,yCAA2C;AAAlC,yGAAA,YAAY,OAAA"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import type { AxiosError, AxiosInstance, AxiosRequestHeaders, AxiosResponse, AxiosStatic, CreateAxiosDefaults } from 'axios';
|
|
2
|
+
import type { Auth } from '../core/auth.gen';
|
|
3
|
+
import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen';
|
|
4
|
+
import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
|
|
5
|
+
export interface Config<T extends ClientOptions = ClientOptions> extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, CoreConfig {
|
|
6
|
+
/**
|
|
7
|
+
* Axios implementation. You can use this option to provide either an
|
|
8
|
+
* `AxiosStatic` or an `AxiosInstance`.
|
|
9
|
+
*
|
|
10
|
+
* @default axios
|
|
11
|
+
*/
|
|
12
|
+
axios?: AxiosStatic | AxiosInstance;
|
|
13
|
+
/**
|
|
14
|
+
* Base URL for all requests made by this client.
|
|
15
|
+
*/
|
|
16
|
+
baseURL?: T['baseURL'];
|
|
17
|
+
/**
|
|
18
|
+
* An object containing any HTTP headers that you want to pre-populate your
|
|
19
|
+
* `Headers` object with.
|
|
20
|
+
*
|
|
21
|
+
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
|
22
|
+
*/
|
|
23
|
+
headers?: AxiosRequestHeaders | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
|
|
24
|
+
/**
|
|
25
|
+
* Throw an error instead of returning it in the response?
|
|
26
|
+
*
|
|
27
|
+
* @default false
|
|
28
|
+
*/
|
|
29
|
+
throwOnError?: T['throwOnError'];
|
|
30
|
+
}
|
|
31
|
+
export interface RequestOptions<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
32
|
+
throwOnError: ThrowOnError;
|
|
33
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
34
|
+
/**
|
|
35
|
+
* Any body that you want to add to your request.
|
|
36
|
+
*
|
|
37
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
38
|
+
*/
|
|
39
|
+
body?: unknown;
|
|
40
|
+
path?: Record<string, unknown>;
|
|
41
|
+
query?: Record<string, unknown>;
|
|
42
|
+
/**
|
|
43
|
+
* Security mechanism(s) to use for the request.
|
|
44
|
+
*/
|
|
45
|
+
security?: ReadonlyArray<Auth>;
|
|
46
|
+
url: Url;
|
|
47
|
+
}
|
|
48
|
+
export interface ClientOptions {
|
|
49
|
+
baseURL?: string;
|
|
50
|
+
throwOnError?: boolean;
|
|
51
|
+
}
|
|
52
|
+
export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData>> : Promise<(AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData> & {
|
|
53
|
+
error: undefined;
|
|
54
|
+
}) | (AxiosError<TError extends Record<string, unknown> ? TError[keyof TError] : TError> & {
|
|
55
|
+
data: undefined;
|
|
56
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
57
|
+
})>;
|
|
58
|
+
type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError>;
|
|
59
|
+
type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<never, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
60
|
+
type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError>;
|
|
61
|
+
type BuildUrlFn = <TData extends {
|
|
62
|
+
path?: Record<string, unknown>;
|
|
63
|
+
query?: Record<string, unknown>;
|
|
64
|
+
url: string;
|
|
65
|
+
}>(options: TData & Pick<RequestOptions<unknown, boolean>, 'axios' | 'baseURL' | 'paramsSerializer' | 'querySerializer'>) => string;
|
|
66
|
+
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
67
|
+
instance: AxiosInstance;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* The `createClientConfig()` function will be called on client initialization
|
|
71
|
+
* and the returned object will become the client's initial configuration.
|
|
72
|
+
*
|
|
73
|
+
* You may want to initialize your client this way instead of calling
|
|
74
|
+
* `setConfig()`. This is useful for example if you're using Next.js
|
|
75
|
+
* to ensure your client always has the correct values.
|
|
76
|
+
*/
|
|
77
|
+
export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
|
|
78
|
+
export interface TDataShape {
|
|
79
|
+
body?: unknown;
|
|
80
|
+
headers?: unknown;
|
|
81
|
+
path?: unknown;
|
|
82
|
+
query?: unknown;
|
|
83
|
+
url: string;
|
|
84
|
+
}
|
|
85
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
86
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = OmitKeys<RequestOptions<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
87
|
+
export {};
|
|
88
|
+
//# sourceMappingURL=types.gen.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.gen.d.ts","sourceRoot":"","sources":["../../../typescript/client/types.gen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,mBAAmB,EACpB,MAAM,OAAO,CAAC;AAEf,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;AAEpF,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAC7D,SAAQ,IAAI,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC,EAAE,UAAU;IACxF;;;;;OAKG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IACvB;;;;;OAKG;IACH,OAAO,CAAC,EACJ,mBAAmB,GACnB,MAAM,CACJ,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CACvF,CAAC;IACN;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc,CAC7B,KAAK,GAAG,OAAO,EACf,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,GAAG,SAAS,MAAM,GAAG,MAAM,CAE3B,SACE,MAAM,CAAC;IACL,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC,EACF,IAAI,CACF,uBAAuB,CAAC,KAAK,CAAC,EAC5B,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,sBAAsB,GACtB,qBAAqB,GACrB,kBAAkB,CACrB;IACH;;;;OAIG;IACH,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;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAC/B,GAAG,EAAE,GAAG,CAAC;CACV;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,aAAa,CACvB,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,YAAY,SAAS,OAAO,GAAG,OAAO,IACpC,YAAY,SAAS,IAAI,GACzB,OAAO,CAAC,aAAa,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,GAC1F,OAAO,CACH,CAAC,aAAa,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG;IACnF,KAAK,EAAE,SAAS,CAAC;CAClB,CAAC,GACF,CAAC,UAAU,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG;IACpF,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,CAAC,CACL,CAAC;AAEN,KAAK,QAAQ,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,SAAS,OAAO,GAAG,KAAK,EACtF,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,KACzD,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AAEhD,KAAK,KAAK,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,SAAS,OAAO,GAAG,KAAK,EACnF,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,KACzD,OAAO,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAEpD,KAAK,SAAS,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,SAAS,OAAO,GAAG,KAAK,EACvF,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,GAC1D,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,KAC5D,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AAEhD,KAAK,UAAU,GAAG,CAChB,KAAK,SAAS;IACZ,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,GACZ,IAAI,CACF,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,EAChC,OAAO,GAAG,SAAS,GAAG,kBAAkB,GAAG,iBAAiB,CAC7D,KACA,MAAM,CAAC;AAEZ,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG;IAChF,QAAQ,EAAE,aAAa,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,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,IACjB,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,GACtF,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.gen.js","sourceRoot":"","sources":["../../../typescript/client/types.gen.ts"],"names":[],"mappings":";AAAA,qDAAqD"}
|
|
@@ -0,0 +1,15 @@
|
|
|
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 setAuthParams: ({ security, ...options }: Pick<Required<RequestOptions>, "security"> & Pick<RequestOptions, "auth" | "query"> & {
|
|
5
|
+
headers: Record<any, unknown>;
|
|
6
|
+
}) => Promise<void>;
|
|
7
|
+
export declare const buildUrl: Client['buildUrl'];
|
|
8
|
+
export declare const mergeConfigs: (a: Config, b: Config) => Config;
|
|
9
|
+
/**
|
|
10
|
+
* Special Axios headers keywords allowing to set headers by request method.
|
|
11
|
+
*/
|
|
12
|
+
export declare const axiosHeadersKeywords: readonly ["common", "delete", "get", "head", "patch", "post", "put"];
|
|
13
|
+
export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Record<any, unknown>;
|
|
14
|
+
export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
|
|
15
|
+
//# sourceMappingURL=utils.gen.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.gen.d.ts","sourceRoot":"","sources":["../../../typescript/client/utils.gen.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAOzE,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;AAwBF,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,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;CAC/B,kBAmCF,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,UAAU,CAiBvC,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,MAInD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,sEAQvB,CAAC;AAEX,eAAO,MAAM,YAAY,GACvB,GAAG,SAAS,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,KACzD,MAAM,CAAC,GAAG,EAAE,OAAO,CAiCrB,CAAC;AAEF,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,CAExC,CAAC"}
|