lemma-sdk 0.2.46 → 0.3.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 +16 -0
- package/dist/browser/lemma-client.js +13661 -4410
- package/dist/browser.d.ts +14 -6
- package/dist/browser.js +35 -6
- package/dist/client.d.ts +4 -0
- package/dist/client.js +15 -3
- package/dist/config.d.ts +4 -0
- package/dist/config.js +7 -1
- package/dist/generated.d.ts +14 -1
- package/dist/generated.js +62 -11
- package/dist/http.d.ts +47 -1
- package/dist/http.js +145 -26
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/namespaces/agents.d.ts +20 -1
- package/dist/namespaces/agents.js +29 -1
- package/dist/namespaces/conversations.d.ts +3 -0
- package/dist/namespaces/conversations.js +2 -0
- package/dist/namespaces/desks.d.ts +9 -0
- package/dist/namespaces/desks.js +6 -0
- package/dist/namespaces/files.d.ts +18 -0
- package/dist/namespaces/files.js +21 -0
- package/dist/namespaces/functions.d.ts +3 -0
- package/dist/namespaces/functions.js +5 -0
- package/dist/namespaces/widgets.d.ts +17 -0
- package/dist/namespaces/widgets.js +16 -0
- package/dist/openapi_client/core/OpenAPI.js +1 -1
- package/dist/openapi_client/index.d.ts +4 -0
- package/dist/openapi_client/index.js +1 -0
- package/dist/openapi_client/models/AgentRunStatus.d.ts +10 -0
- package/dist/openapi_client/models/AgentRunStatus.js +15 -0
- package/dist/openapi_client/models/AgentToolset.d.ts +2 -2
- package/dist/openapi_client/models/AgentToolset.js +1 -1
- package/dist/openapi_client/models/ConversationResponse.d.ts +4 -0
- package/dist/openapi_client/models/ConversationType.d.ts +2 -1
- package/dist/openapi_client/models/ConversationType.js +1 -0
- package/dist/openapi_client/models/DatastoreQueryRequest.d.ts +1 -1
- package/dist/openapi_client/models/FileSearchResultSchema.d.ts +2 -0
- package/dist/openapi_client/models/FileSignedUrlRequest.d.ts +4 -0
- package/dist/openapi_client/models/FileSignedUrlRequest.js +1 -0
- package/dist/openapi_client/models/FileSignedUrlResponse.d.ts +6 -0
- package/dist/openapi_client/models/FileSignedUrlResponse.js +1 -0
- package/dist/openapi_client/models/FileUrlResponse.d.ts +6 -0
- package/dist/openapi_client/models/FileUrlResponse.js +1 -0
- package/dist/openapi_client/services/AgentConversationsService.d.ts +3 -2
- package/dist/openapi_client/services/AgentConversationsService.js +4 -2
- package/dist/openapi_client/services/FilesService.d.ts +20 -0
- package/dist/openapi_client/services/FilesService.js +47 -0
- package/dist/openapi_client/services/QueryService.d.ts +1 -1
- package/dist/openapi_client/services/QueryService.js +1 -1
- package/dist/run-utils.d.ts +24 -0
- package/dist/run-utils.js +54 -0
- package/dist/version.d.ts +5 -0
- package/dist/version.js +7 -0
- package/package.json +10 -5
- package/dist/hey_client/client/client.gen.d.ts +0 -2
- package/dist/hey_client/client/client.gen.js +0 -216
- package/dist/hey_client/client/index.d.ts +0 -10
- package/dist/hey_client/client/index.js +0 -6
- package/dist/hey_client/client/types.gen.d.ts +0 -120
- package/dist/hey_client/client/types.gen.js +0 -2
- package/dist/hey_client/client/utils.gen.d.ts +0 -37
- package/dist/hey_client/client/utils.gen.js +0 -228
- package/dist/hey_client/client.gen.d.ts +0 -12
- package/dist/hey_client/client.gen.js +0 -3
- package/dist/hey_client/core/auth.gen.d.ts +0 -25
- package/dist/hey_client/core/auth.gen.js +0 -14
- package/dist/hey_client/core/bodySerializer.gen.d.ts +0 -25
- package/dist/hey_client/core/bodySerializer.gen.js +0 -57
- package/dist/hey_client/core/params.gen.d.ts +0 -43
- package/dist/hey_client/core/params.gen.js +0 -100
- package/dist/hey_client/core/pathSerializer.gen.d.ts +0 -33
- package/dist/hey_client/core/pathSerializer.gen.js +0 -106
- package/dist/hey_client/core/queryKeySerializer.gen.d.ts +0 -18
- package/dist/hey_client/core/queryKeySerializer.gen.js +0 -92
- package/dist/hey_client/core/serverSentEvents.gen.d.ts +0 -71
- package/dist/hey_client/core/serverSentEvents.gen.js +0 -132
- package/dist/hey_client/core/types.gen.d.ts +0 -83
- package/dist/hey_client/core/types.gen.js +0 -2
- package/dist/hey_client/core/utils.gen.d.ts +0 -19
- package/dist/hey_client/core/utils.gen.js +0 -87
- package/dist/hey_client/index.d.ts +0 -2
- package/dist/hey_client/index.js +0 -2
- package/dist/hey_client/sdk.gen.d.ts +0 -1005
- package/dist/hey_client/sdk.gen.js +0 -1438
- package/dist/hey_client/types.gen.d.ts +0 -12992
- package/dist/hey_client/types.gen.js +0 -2
package/dist/run-utils.js
CHANGED
|
@@ -50,3 +50,57 @@ export function nextBackoffDelay(attempt, options = {}) {
|
|
|
50
50
|
const delay = Math.round(baseMs * Math.pow(factor, safeAttempt));
|
|
51
51
|
return Math.min(Math.max(baseMs, delay), maxMs);
|
|
52
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* Statuses worth retrying with backoff. Deliberately conservative: 429 is an
|
|
55
|
+
* explicit "back off", and 502/503/504 are gateway errors where the request
|
|
56
|
+
* usually never reached the handler — so retrying is safe even for writes.
|
|
57
|
+
* 500 is excluded (it may indicate a partial side effect).
|
|
58
|
+
*/
|
|
59
|
+
export const RETRYABLE_STATUS = new Set([429, 502, 503, 504]);
|
|
60
|
+
/** Parse a server `Retry-After` header (delta-seconds or HTTP-date) into ms,
|
|
61
|
+
* capped at 30s. Returns null when the header is absent or unparseable. */
|
|
62
|
+
export function serverRetryAfterMs(retryAfter) {
|
|
63
|
+
if (!retryAfter) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
const seconds = Number(retryAfter);
|
|
67
|
+
if (Number.isFinite(seconds) && seconds >= 0) {
|
|
68
|
+
return Math.min(seconds * 1000, 30_000);
|
|
69
|
+
}
|
|
70
|
+
const dateMs = Date.parse(retryAfter);
|
|
71
|
+
if (!Number.isNaN(dateMs)) {
|
|
72
|
+
return Math.max(0, Math.min(dateMs - Date.now(), 30_000));
|
|
73
|
+
}
|
|
74
|
+
return null;
|
|
75
|
+
}
|
|
76
|
+
/** Resolve a backoff delay, honoring a server `Retry-After` header when present. */
|
|
77
|
+
export function retryAfterMs(retryAfter, attempt) {
|
|
78
|
+
return serverRetryAfterMs(retryAfter) ?? nextBackoffDelay(attempt);
|
|
79
|
+
}
|
|
80
|
+
/** Equal jitter: keep half the delay fixed and randomize the other half, so the
|
|
81
|
+
* result lands in `[delay/2, delay]`. Spreads correlated retries (thundering
|
|
82
|
+
* herd) without ever waiting longer than the computed backoff. */
|
|
83
|
+
export function applyJitter(delayMs, random = Math.random) {
|
|
84
|
+
if (!Number.isFinite(delayMs) || delayMs <= 0) {
|
|
85
|
+
return 0;
|
|
86
|
+
}
|
|
87
|
+
const half = delayMs / 2;
|
|
88
|
+
return Math.round(half + random() * half);
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Single source of truth for the retry decision shared by the hand-written
|
|
92
|
+
* `HttpClient` and the generated-client adapter. Returns the number of ms to
|
|
93
|
+
* wait before retrying, or `null` when the status is non-retryable or retries
|
|
94
|
+
* are exhausted. A server-advised `Retry-After` is honored verbatim (no jitter);
|
|
95
|
+
* the computed exponential backoff gets equal jitter.
|
|
96
|
+
*/
|
|
97
|
+
export function retryDelayForStatus(status, attempt, maxRetries, retryAfterHeader, random = Math.random) {
|
|
98
|
+
if (!RETRYABLE_STATUS.has(status) || attempt >= maxRetries) {
|
|
99
|
+
return null;
|
|
100
|
+
}
|
|
101
|
+
const serverMs = serverRetryAfterMs(retryAfterHeader);
|
|
102
|
+
if (serverMs !== null) {
|
|
103
|
+
return serverMs;
|
|
104
|
+
}
|
|
105
|
+
return applyJitter(nextBackoffDelay(attempt), random);
|
|
106
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const SDK_VERSION = "0.3.0";
|
|
2
|
+
/** Sent as `X-Lemma-Client` on every request so the backend can log which client
|
|
3
|
+
* + version hit an endpoint (User-Agent is a forbidden header in browser fetch). */
|
|
4
|
+
export declare const CLIENT_HEADER_NAME = "X-Lemma-Client";
|
|
5
|
+
export declare const CLIENT_HEADER_VALUE = "lemma-sdk-ts/0.3.0";
|
package/dist/version.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Keep SDK_VERSION in sync with package.json "version". The CI codegen/drift
|
|
2
|
+
// gate (workstream A) asserts they match so this can't silently drift.
|
|
3
|
+
export const SDK_VERSION = "0.3.0";
|
|
4
|
+
/** Sent as `X-Lemma-Client` on every request so the backend can log which client
|
|
5
|
+
* + version hit an endpoint (User-Agent is a forbidden header in browser fetch). */
|
|
6
|
+
export const CLIENT_HEADER_NAME = "X-Lemma-Client";
|
|
7
|
+
export const CLIENT_HEADER_VALUE = `lemma-sdk-ts/${SDK_VERSION}`;
|
package/package.json
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "lemma-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Official TypeScript SDK for Lemma APIs, optimized around pod-scoped workflows",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"author": "Lemma",
|
|
5
7
|
"type": "module",
|
|
6
8
|
"main": "dist/index.js",
|
|
7
9
|
"types": "dist/index.d.ts",
|
|
@@ -44,9 +46,9 @@
|
|
|
44
46
|
],
|
|
45
47
|
"scripts": {
|
|
46
48
|
"generate:client": "./scripts/generate_openapi_client.sh",
|
|
47
|
-
"generate:client:hey": "LEMMA_TS_GENERATOR=hey ./scripts/generate_openapi_client.sh",
|
|
48
49
|
"build": "npm run clean && tsc -p tsconfig.json && npm run build:bundle",
|
|
49
|
-
"build:bundle": "
|
|
50
|
+
"build:bundle": "node ./scripts/build_browser_bundle.mjs",
|
|
51
|
+
"test": "npm run build:bundle && vitest run",
|
|
50
52
|
"clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true, maxRetries: 10, retryDelay: 100 })\"",
|
|
51
53
|
"registry:build": "shadcn build ./registry.json -o ./public/r",
|
|
52
54
|
"registry:check": "npm run registry:build && node ./scripts/check_registry_blocks.mjs",
|
|
@@ -65,10 +67,13 @@
|
|
|
65
67
|
"supertokens-web-js": "^0.16.0"
|
|
66
68
|
},
|
|
67
69
|
"devDependencies": {
|
|
68
|
-
"@
|
|
70
|
+
"@types/node": "^24.13.2",
|
|
69
71
|
"@types/react": "^19.2.14",
|
|
72
|
+
"esbuild": "^0.28.1",
|
|
73
|
+
"jsdom": "^24.1.1",
|
|
70
74
|
"openapi-typescript-codegen": "^0.29.0",
|
|
71
75
|
"shadcn": "^4.2.0",
|
|
72
|
-
"typescript": "^5.6.3"
|
|
76
|
+
"typescript": "^5.6.3",
|
|
77
|
+
"vitest": "^2.0.5"
|
|
73
78
|
}
|
|
74
79
|
}
|
|
@@ -1,216 +0,0 @@
|
|
|
1
|
-
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
import { createSseClient } from '../core/serverSentEvents.gen';
|
|
3
|
-
import { getValidRequestBody } from '../core/utils.gen';
|
|
4
|
-
import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from './utils.gen';
|
|
5
|
-
export const createClient = (config = {}) => {
|
|
6
|
-
let _config = mergeConfigs(createConfig(), config);
|
|
7
|
-
const getConfig = () => ({ ..._config });
|
|
8
|
-
const setConfig = (config) => {
|
|
9
|
-
_config = mergeConfigs(_config, config);
|
|
10
|
-
return getConfig();
|
|
11
|
-
};
|
|
12
|
-
const interceptors = createInterceptors();
|
|
13
|
-
const beforeRequest = async (options) => {
|
|
14
|
-
const opts = {
|
|
15
|
-
..._config,
|
|
16
|
-
...options,
|
|
17
|
-
fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
|
|
18
|
-
headers: mergeHeaders(_config.headers, options.headers),
|
|
19
|
-
serializedBody: undefined,
|
|
20
|
-
};
|
|
21
|
-
if (opts.security) {
|
|
22
|
-
await setAuthParams(opts);
|
|
23
|
-
}
|
|
24
|
-
if (opts.requestValidator) {
|
|
25
|
-
await opts.requestValidator(opts);
|
|
26
|
-
}
|
|
27
|
-
if (opts.body !== undefined && opts.bodySerializer) {
|
|
28
|
-
opts.serializedBody = opts.bodySerializer(opts.body);
|
|
29
|
-
}
|
|
30
|
-
// remove Content-Type header if body is empty to avoid sending invalid requests
|
|
31
|
-
if (opts.body === undefined || opts.serializedBody === '') {
|
|
32
|
-
opts.headers.delete('Content-Type');
|
|
33
|
-
}
|
|
34
|
-
const resolvedOpts = opts;
|
|
35
|
-
const url = buildUrl(resolvedOpts);
|
|
36
|
-
return { opts: resolvedOpts, url };
|
|
37
|
-
};
|
|
38
|
-
const request = async (options) => {
|
|
39
|
-
const throwOnError = options.throwOnError ?? _config.throwOnError;
|
|
40
|
-
const responseStyle = options.responseStyle ?? _config.responseStyle;
|
|
41
|
-
let request;
|
|
42
|
-
let response;
|
|
43
|
-
try {
|
|
44
|
-
const { opts, url } = await beforeRequest(options);
|
|
45
|
-
const requestInit = {
|
|
46
|
-
redirect: 'follow',
|
|
47
|
-
...opts,
|
|
48
|
-
body: getValidRequestBody(opts),
|
|
49
|
-
};
|
|
50
|
-
request = new Request(url, requestInit);
|
|
51
|
-
for (const fn of interceptors.request.fns) {
|
|
52
|
-
if (fn) {
|
|
53
|
-
request = await fn(request, opts);
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
// fetch must be assigned here, otherwise it would throw the error:
|
|
57
|
-
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
|
|
58
|
-
const _fetch = opts.fetch;
|
|
59
|
-
response = await _fetch(request);
|
|
60
|
-
for (const fn of interceptors.response.fns) {
|
|
61
|
-
if (fn) {
|
|
62
|
-
response = await fn(response, request, opts);
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
const result = {
|
|
66
|
-
request,
|
|
67
|
-
response,
|
|
68
|
-
};
|
|
69
|
-
if (response.ok) {
|
|
70
|
-
const parseAs = (opts.parseAs === 'auto'
|
|
71
|
-
? getParseAs(response.headers.get('Content-Type'))
|
|
72
|
-
: opts.parseAs) ?? 'json';
|
|
73
|
-
if (response.status === 204 || response.headers.get('Content-Length') === '0') {
|
|
74
|
-
let emptyData;
|
|
75
|
-
switch (parseAs) {
|
|
76
|
-
case 'arrayBuffer':
|
|
77
|
-
case 'blob':
|
|
78
|
-
case 'text':
|
|
79
|
-
emptyData = await response[parseAs]();
|
|
80
|
-
break;
|
|
81
|
-
case 'formData':
|
|
82
|
-
emptyData = new FormData();
|
|
83
|
-
break;
|
|
84
|
-
case 'stream':
|
|
85
|
-
emptyData = response.body;
|
|
86
|
-
break;
|
|
87
|
-
case 'json':
|
|
88
|
-
default:
|
|
89
|
-
emptyData = {};
|
|
90
|
-
break;
|
|
91
|
-
}
|
|
92
|
-
return opts.responseStyle === 'data'
|
|
93
|
-
? emptyData
|
|
94
|
-
: {
|
|
95
|
-
data: emptyData,
|
|
96
|
-
...result,
|
|
97
|
-
};
|
|
98
|
-
}
|
|
99
|
-
let data;
|
|
100
|
-
switch (parseAs) {
|
|
101
|
-
case 'arrayBuffer':
|
|
102
|
-
case 'blob':
|
|
103
|
-
case 'formData':
|
|
104
|
-
case 'text':
|
|
105
|
-
data = await response[parseAs]();
|
|
106
|
-
break;
|
|
107
|
-
case 'json': {
|
|
108
|
-
// Some servers return 200 with no Content-Length and empty body.
|
|
109
|
-
// response.json() would throw; read as text and parse if non-empty.
|
|
110
|
-
const text = await response.text();
|
|
111
|
-
data = text ? JSON.parse(text) : {};
|
|
112
|
-
break;
|
|
113
|
-
}
|
|
114
|
-
case 'stream':
|
|
115
|
-
return opts.responseStyle === 'data'
|
|
116
|
-
? response.body
|
|
117
|
-
: {
|
|
118
|
-
data: response.body,
|
|
119
|
-
...result,
|
|
120
|
-
};
|
|
121
|
-
}
|
|
122
|
-
if (parseAs === 'json') {
|
|
123
|
-
if (opts.responseValidator) {
|
|
124
|
-
await opts.responseValidator(data);
|
|
125
|
-
}
|
|
126
|
-
if (opts.responseTransformer) {
|
|
127
|
-
data = await opts.responseTransformer(data);
|
|
128
|
-
}
|
|
129
|
-
}
|
|
130
|
-
return opts.responseStyle === 'data'
|
|
131
|
-
? data
|
|
132
|
-
: {
|
|
133
|
-
data,
|
|
134
|
-
...result,
|
|
135
|
-
};
|
|
136
|
-
}
|
|
137
|
-
const textError = await response.text();
|
|
138
|
-
let jsonError;
|
|
139
|
-
try {
|
|
140
|
-
jsonError = JSON.parse(textError);
|
|
141
|
-
}
|
|
142
|
-
catch {
|
|
143
|
-
// noop
|
|
144
|
-
}
|
|
145
|
-
throw jsonError ?? textError;
|
|
146
|
-
}
|
|
147
|
-
catch (error) {
|
|
148
|
-
let finalError = error;
|
|
149
|
-
for (const fn of interceptors.error.fns) {
|
|
150
|
-
if (fn) {
|
|
151
|
-
finalError = await fn(finalError, response, request, options);
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
finalError = finalError || {};
|
|
155
|
-
if (throwOnError) {
|
|
156
|
-
throw finalError;
|
|
157
|
-
}
|
|
158
|
-
// TODO: we probably want to return error and improve types
|
|
159
|
-
return responseStyle === 'data'
|
|
160
|
-
? undefined
|
|
161
|
-
: {
|
|
162
|
-
error: finalError,
|
|
163
|
-
request,
|
|
164
|
-
response,
|
|
165
|
-
};
|
|
166
|
-
}
|
|
167
|
-
};
|
|
168
|
-
const makeMethodFn = (method) => (options) => request({ ...options, method });
|
|
169
|
-
const makeSseFn = (method) => async (options) => {
|
|
170
|
-
const { opts, url } = await beforeRequest(options);
|
|
171
|
-
return createSseClient({
|
|
172
|
-
...opts,
|
|
173
|
-
body: opts.body,
|
|
174
|
-
method,
|
|
175
|
-
onRequest: async (url, init) => {
|
|
176
|
-
let request = new Request(url, init);
|
|
177
|
-
for (const fn of interceptors.request.fns) {
|
|
178
|
-
if (fn) {
|
|
179
|
-
request = await fn(request, opts);
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
return request;
|
|
183
|
-
},
|
|
184
|
-
serializedBody: getValidRequestBody(opts),
|
|
185
|
-
url,
|
|
186
|
-
});
|
|
187
|
-
};
|
|
188
|
-
const _buildUrl = (options) => buildUrl({ ..._config, ...options });
|
|
189
|
-
return {
|
|
190
|
-
buildUrl: _buildUrl,
|
|
191
|
-
connect: makeMethodFn('CONNECT'),
|
|
192
|
-
delete: makeMethodFn('DELETE'),
|
|
193
|
-
get: makeMethodFn('GET'),
|
|
194
|
-
getConfig,
|
|
195
|
-
head: makeMethodFn('HEAD'),
|
|
196
|
-
interceptors,
|
|
197
|
-
options: makeMethodFn('OPTIONS'),
|
|
198
|
-
patch: makeMethodFn('PATCH'),
|
|
199
|
-
post: makeMethodFn('POST'),
|
|
200
|
-
put: makeMethodFn('PUT'),
|
|
201
|
-
request,
|
|
202
|
-
setConfig,
|
|
203
|
-
sse: {
|
|
204
|
-
connect: makeSseFn('CONNECT'),
|
|
205
|
-
delete: makeSseFn('DELETE'),
|
|
206
|
-
get: makeSseFn('GET'),
|
|
207
|
-
head: makeSseFn('HEAD'),
|
|
208
|
-
options: makeSseFn('OPTIONS'),
|
|
209
|
-
patch: makeSseFn('PATCH'),
|
|
210
|
-
post: makeSseFn('POST'),
|
|
211
|
-
put: makeSseFn('PUT'),
|
|
212
|
-
trace: makeSseFn('TRACE'),
|
|
213
|
-
},
|
|
214
|
-
trace: makeMethodFn('TRACE'),
|
|
215
|
-
};
|
|
216
|
-
};
|
|
@@ -1,10 +0,0 @@
|
|
|
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 type { ServerSentEventsResult } from '../core/serverSentEvents.gen';
|
|
7
|
-
export type { ClientMeta } from '../core/types.gen';
|
|
8
|
-
export { createClient } from './client.gen';
|
|
9
|
-
export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
|
|
10
|
-
export { createConfig, mergeHeaders } from './utils.gen';
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen';
|
|
3
|
-
export { buildClientParams } from '../core/params.gen';
|
|
4
|
-
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
|
|
5
|
-
export { createClient } from './client.gen';
|
|
6
|
-
export { createConfig, mergeHeaders } from './utils.gen';
|
|
@@ -1,120 +0,0 @@
|
|
|
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
|
-
/**
|
|
8
|
-
* Base URL for all requests made by this client.
|
|
9
|
-
*/
|
|
10
|
-
baseUrl?: T['baseUrl'];
|
|
11
|
-
/**
|
|
12
|
-
* Fetch API implementation. You can use this option to provide a custom
|
|
13
|
-
* fetch instance.
|
|
14
|
-
*
|
|
15
|
-
* @default globalThis.fetch
|
|
16
|
-
*/
|
|
17
|
-
fetch?: typeof fetch;
|
|
18
|
-
/**
|
|
19
|
-
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
20
|
-
* options won't have any effect.
|
|
21
|
-
*
|
|
22
|
-
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
23
|
-
*/
|
|
24
|
-
next?: never;
|
|
25
|
-
/**
|
|
26
|
-
* Return the response data parsed in a specified format. By default, `auto`
|
|
27
|
-
* will infer the appropriate method from the `Content-Type` response header.
|
|
28
|
-
* You can override this behavior with any of the {@link Body} methods.
|
|
29
|
-
* Select `stream` if you don't want to parse response data at all.
|
|
30
|
-
*
|
|
31
|
-
* @default 'auto'
|
|
32
|
-
*/
|
|
33
|
-
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
34
|
-
/**
|
|
35
|
-
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
36
|
-
*
|
|
37
|
-
* @default 'fields'
|
|
38
|
-
*/
|
|
39
|
-
responseStyle?: ResponseStyle;
|
|
40
|
-
/**
|
|
41
|
-
* Throw an error instead of returning it in the response?
|
|
42
|
-
*
|
|
43
|
-
* @default false
|
|
44
|
-
*/
|
|
45
|
-
throwOnError?: T['throwOnError'];
|
|
46
|
-
}
|
|
47
|
-
export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
48
|
-
responseStyle: TResponseStyle;
|
|
49
|
-
throwOnError: ThrowOnError;
|
|
50
|
-
}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
51
|
-
/**
|
|
52
|
-
* Any body that you want to add to your request.
|
|
53
|
-
*
|
|
54
|
-
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
55
|
-
*/
|
|
56
|
-
body?: unknown;
|
|
57
|
-
path?: Record<string, unknown>;
|
|
58
|
-
query?: Record<string, unknown>;
|
|
59
|
-
/**
|
|
60
|
-
* Security mechanism(s) to use for the request.
|
|
61
|
-
*/
|
|
62
|
-
security?: ReadonlyArray<Auth>;
|
|
63
|
-
url: Url;
|
|
64
|
-
}
|
|
65
|
-
export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
66
|
-
headers: Headers;
|
|
67
|
-
serializedBody?: string;
|
|
68
|
-
}
|
|
69
|
-
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 : {
|
|
70
|
-
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
71
|
-
request: Request;
|
|
72
|
-
response: Response;
|
|
73
|
-
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
74
|
-
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
75
|
-
error: undefined;
|
|
76
|
-
} | {
|
|
77
|
-
data: undefined;
|
|
78
|
-
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
79
|
-
}) & {
|
|
80
|
-
/** request may be undefined, because error may be from building the request object itself */
|
|
81
|
-
request?: Request;
|
|
82
|
-
/** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
83
|
-
response?: Response;
|
|
84
|
-
}>;
|
|
85
|
-
export interface ClientOptions {
|
|
86
|
-
baseUrl?: string;
|
|
87
|
-
responseStyle?: ResponseStyle;
|
|
88
|
-
throwOnError?: boolean;
|
|
89
|
-
}
|
|
90
|
-
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>;
|
|
91
|
-
type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
|
|
92
|
-
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>;
|
|
93
|
-
type BuildUrlFn = <TData extends {
|
|
94
|
-
body?: unknown;
|
|
95
|
-
path?: Record<string, unknown>;
|
|
96
|
-
query?: Record<string, unknown>;
|
|
97
|
-
url: string;
|
|
98
|
-
}>(options: TData & Options<TData>) => string;
|
|
99
|
-
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
100
|
-
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
101
|
-
};
|
|
102
|
-
/**
|
|
103
|
-
* The `createClientConfig()` function will be called on client initialization
|
|
104
|
-
* and the returned object will become the client's initial configuration.
|
|
105
|
-
*
|
|
106
|
-
* You may want to initialize your client this way instead of calling
|
|
107
|
-
* `setConfig()`. This is useful for example if you're using Next.js
|
|
108
|
-
* to ensure your client always has the correct values.
|
|
109
|
-
*/
|
|
110
|
-
export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
|
|
111
|
-
export interface TDataShape {
|
|
112
|
-
body?: unknown;
|
|
113
|
-
headers?: unknown;
|
|
114
|
-
path?: unknown;
|
|
115
|
-
query?: unknown;
|
|
116
|
-
url: string;
|
|
117
|
-
}
|
|
118
|
-
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
119
|
-
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'>);
|
|
120
|
-
export {};
|
|
@@ -1,37 +0,0 @@
|
|
|
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
|
-
/**
|
|
5
|
-
* Infers parseAs value from provided Content-Type header.
|
|
6
|
-
*/
|
|
7
|
-
export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
|
|
8
|
-
export declare function setAuthParams(options: Pick<RequestOptions, 'auth' | 'query' | 'security'> & {
|
|
9
|
-
headers: Headers;
|
|
10
|
-
}): Promise<void>;
|
|
11
|
-
export declare const buildUrl: Client['buildUrl'];
|
|
12
|
-
export declare const mergeConfigs: (a: Config, b: Config) => Config;
|
|
13
|
-
export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
|
|
14
|
-
type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
|
|
15
|
-
/** response may be undefined due to a network error where no response object is produced */
|
|
16
|
-
response: Res | undefined,
|
|
17
|
-
/** request may be undefined, because error may be from building the request object itself */
|
|
18
|
-
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
19
|
-
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
20
|
-
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
21
|
-
declare class Interceptors<Interceptor> {
|
|
22
|
-
fns: Array<Interceptor | null>;
|
|
23
|
-
clear(): void;
|
|
24
|
-
eject(id: number | Interceptor): void;
|
|
25
|
-
exists(id: number | Interceptor): boolean;
|
|
26
|
-
getInterceptorIndex(id: number | Interceptor): number;
|
|
27
|
-
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
28
|
-
use(fn: Interceptor): number;
|
|
29
|
-
}
|
|
30
|
-
export interface Middleware<Req, Res, Err, Options> {
|
|
31
|
-
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
32
|
-
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
33
|
-
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
34
|
-
}
|
|
35
|
-
export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
|
|
36
|
-
export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
|
|
37
|
-
export {};
|