@zephytiju/juntai-typescript-sdk 3.3.0 → 3.5.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/CHANGELOG.md +13 -0
- package/README.md +27 -0
- package/dist/clients/lattice.ontology/index.d.ts +5 -0
- package/dist/clients/lattice.ontology/index.js +4 -0
- package/dist/clients/lattice.runtime-generation/index.d.ts +5 -0
- package/dist/clients/lattice.runtime-generation/index.js +4 -0
- package/dist/generated/lattice.ontology/client/client.gen.d.ts +2 -0
- package/dist/generated/lattice.ontology/client/client.gen.js +216 -0
- package/dist/generated/lattice.ontology/client/index.d.ts +10 -0
- package/dist/generated/lattice.ontology/client/index.js +6 -0
- package/dist/generated/lattice.ontology/client/types.gen.d.ts +120 -0
- package/dist/generated/lattice.ontology/client/types.gen.js +2 -0
- package/dist/generated/lattice.ontology/client/utils.gen.d.ts +37 -0
- package/dist/generated/lattice.ontology/client/utils.gen.js +228 -0
- package/dist/generated/lattice.ontology/client.gen.d.ts +12 -0
- package/dist/generated/lattice.ontology/client.gen.js +3 -0
- package/dist/generated/lattice.ontology/core/auth.gen.d.ts +25 -0
- package/dist/generated/lattice.ontology/core/auth.gen.js +14 -0
- package/dist/generated/lattice.ontology/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/lattice.ontology/core/bodySerializer.gen.js +57 -0
- package/dist/generated/lattice.ontology/core/params.gen.d.ts +43 -0
- package/dist/generated/lattice.ontology/core/params.gen.js +109 -0
- package/dist/generated/lattice.ontology/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/lattice.ontology/core/pathSerializer.gen.js +106 -0
- package/dist/generated/lattice.ontology/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/lattice.ontology/core/queryKeySerializer.gen.js +92 -0
- package/dist/generated/lattice.ontology/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/lattice.ontology/core/serverSentEvents.gen.js +132 -0
- package/dist/generated/lattice.ontology/core/types.gen.d.ts +83 -0
- package/dist/generated/lattice.ontology/core/types.gen.js +2 -0
- package/dist/generated/lattice.ontology/core/utils.gen.d.ts +19 -0
- package/dist/generated/lattice.ontology/core/utils.gen.js +87 -0
- package/dist/generated/lattice.ontology/index.d.ts +2 -0
- package/dist/generated/lattice.ontology/index.js +2 -0
- package/dist/generated/lattice.ontology/sdk.gen.d.ts +103 -0
- package/dist/generated/lattice.ontology/sdk.gen.js +242 -0
- package/dist/generated/lattice.ontology/types.gen.d.ts +3704 -0
- package/dist/generated/lattice.ontology/types.gen.js +2 -0
- package/dist/generated/lattice.runtime-generation/client/client.gen.d.ts +2 -0
- package/dist/generated/lattice.runtime-generation/client/client.gen.js +216 -0
- package/dist/generated/lattice.runtime-generation/client/index.d.ts +10 -0
- package/dist/generated/lattice.runtime-generation/client/index.js +6 -0
- package/dist/generated/lattice.runtime-generation/client/types.gen.d.ts +120 -0
- package/dist/generated/lattice.runtime-generation/client/types.gen.js +2 -0
- package/dist/generated/lattice.runtime-generation/client/utils.gen.d.ts +37 -0
- package/dist/generated/lattice.runtime-generation/client/utils.gen.js +228 -0
- package/dist/generated/lattice.runtime-generation/client.gen.d.ts +12 -0
- package/dist/generated/lattice.runtime-generation/client.gen.js +3 -0
- package/dist/generated/lattice.runtime-generation/core/auth.gen.d.ts +25 -0
- package/dist/generated/lattice.runtime-generation/core/auth.gen.js +14 -0
- package/dist/generated/lattice.runtime-generation/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/lattice.runtime-generation/core/bodySerializer.gen.js +57 -0
- package/dist/generated/lattice.runtime-generation/core/params.gen.d.ts +43 -0
- package/dist/generated/lattice.runtime-generation/core/params.gen.js +109 -0
- package/dist/generated/lattice.runtime-generation/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/lattice.runtime-generation/core/pathSerializer.gen.js +106 -0
- package/dist/generated/lattice.runtime-generation/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/lattice.runtime-generation/core/queryKeySerializer.gen.js +92 -0
- package/dist/generated/lattice.runtime-generation/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/lattice.runtime-generation/core/serverSentEvents.gen.js +132 -0
- package/dist/generated/lattice.runtime-generation/core/types.gen.d.ts +83 -0
- package/dist/generated/lattice.runtime-generation/core/types.gen.js +2 -0
- package/dist/generated/lattice.runtime-generation/core/utils.gen.d.ts +19 -0
- package/dist/generated/lattice.runtime-generation/core/utils.gen.js +87 -0
- package/dist/generated/lattice.runtime-generation/index.d.ts +2 -0
- package/dist/generated/lattice.runtime-generation/index.js +2 -0
- package/dist/generated/lattice.runtime-generation/sdk.gen.d.ts +39 -0
- package/dist/generated/lattice.runtime-generation/sdk.gen.js +54 -0
- package/dist/generated/lattice.runtime-generation/types.gen.d.ts +966 -0
- package/dist/generated/lattice.runtime-generation/types.gen.js +2 -0
- package/dist/generated/platform.blueprint/index.d.ts +1 -1
- package/dist/generated/platform.blueprint/types.gen.d.ts +41 -2
- package/dist/index.d.ts +5 -1
- package/dist/index.js +5 -1
- package/dist/release-manifest.json +36 -8
- package/package.json +11 -1
- package/sources/openapi.lock.json +46 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 3.5.0
|
|
4
|
+
|
|
5
|
+
- Add LatticeModelConfigurationService 0.3.0 as `lattice.ontology` / `latticeOntology`, pinned to source `803bde6e973829a5f8adfca58021d87dfb09e324` and OpenAPI SHA-256 `4d3a6168f4347faa91b572b4323c43d05b3df9fc94c08446fe5400fd97333335`.
|
|
6
|
+
- Add LatticeRuntimeGenerationService 0.1.0 as `lattice.runtime-generation` / `latticeRuntimeGeneration`, pinned to source `01ca9bb890e332a873c651de984b5795c4097b48` and OpenAPI SHA-256 `4c08968721337bbd496fd12b0a0193b75dbb48822954549bfe240f4014b3eae3`.
|
|
7
|
+
- Generate all 28 Lattice operations and their service-owned types with isolated client factories. Preserve same-origin fetch, revisions, idempotency, application scope, cancellation, pagination, and stable errors.
|
|
8
|
+
- Verify clean installed tarballs in Chromium, including the downloaded public npm release, using explicit HTTP adapter fixtures. No Lattice domain types or operations are handwritten.
|
|
9
|
+
|
|
10
|
+
## 3.4.0
|
|
11
|
+
|
|
12
|
+
- Generate Blueprint 3.1.0 from its immutable released OpenAPI and exact OCI/source pins.
|
|
13
|
+
- Add the `artifact_registry` reference variant for authoritative Artifact Registry IDs and separate manifest/payload digests, media type and size.
|
|
14
|
+
- Preserve legacy Artifact and Configuration reference schemas, request routing, idempotency and injected authentication/cancellation behavior.
|
|
15
|
+
|
|
3
16
|
## 3.3.0
|
|
4
17
|
|
|
5
18
|
- Add Prism Composition Service 1.0.0 and Prism Build Service 1.0.0 from their exact released source commits and checksum-verified OpenAPI artifacts.
|
package/README.md
CHANGED
|
@@ -17,6 +17,8 @@ import { createClient as createVanguDeploymentClient } from "@zephytiju/juntai-t
|
|
|
17
17
|
import { createClient as createUsageCostClient } from "@zephytiju/juntai-typescript-sdk/services/juntai.usage-cost";
|
|
18
18
|
import { createClient as createPrismCompositionClient } from "@zephytiju/juntai-typescript-sdk/services/prism.composition";
|
|
19
19
|
import { createClient as createPrismBuildClient } from "@zephytiju/juntai-typescript-sdk/services/prism.build";
|
|
20
|
+
import { createClient as createLatticeOntologyClient } from "@zephytiju/juntai-typescript-sdk/services/lattice.ontology";
|
|
21
|
+
import { createClient as createLatticeGenerationClient } from "@zephytiju/juntai-typescript-sdk/services/lattice.runtime-generation";
|
|
20
22
|
```
|
|
21
23
|
|
|
22
24
|
All imports resolve from this one aggregate dependency; there are no service-specific npm packages. Account exposes opaque `Account/v1`, `AccountProfile/v1`, integration-binding, stable-error, authorization-action, idempotency, and concurrency contracts. Application Metadata includes the exact application-documentation discovery contract, Blueprint exposes only the Console-facing Blueprint Service API, IAM exposes the exact same-origin account and immutable-application administration contract, and Vangu Deployment exposes authorized target inspection plus immutable PREVIEW, APPLY, and REMOVE execution control.
|
|
@@ -39,6 +41,31 @@ const account = createAccountClient({
|
|
|
39
41
|
});
|
|
40
42
|
```
|
|
41
43
|
|
|
44
|
+
## Lattice consumers
|
|
45
|
+
|
|
46
|
+
Version 3.5.0 adds `latticeOntology` and `latticeRuntimeGeneration` root namespaces, also available under `clients["lattice.ontology"]` and `clients["lattice.runtime-generation"]`. Their full service subpaths expose generated operations, types, and isolated factories from LatticeModelConfigurationService 0.3.0 and LatticeRuntimeGenerationService 0.1.0. `sources/openapi.lock.json` records each exact source revision, OpenAPI SHA-256, and output digest.
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import { latticeOntology, latticeRuntimeGeneration } from "@zephytiju/juntai-typescript-sdk";
|
|
50
|
+
|
|
51
|
+
// Use the same-origin gateway paths reviewed for the host Console deployment.
|
|
52
|
+
const ontology = latticeOntology.createClient({ baseUrl: ontologyGatewayPath, fetch: context.fetch });
|
|
53
|
+
const generation = latticeRuntimeGeneration.createClient({ baseUrl: generationGatewayPath, fetch: context.fetch });
|
|
54
|
+
const preview = await latticeOntology.previewDefinitions({
|
|
55
|
+
client: ontology,
|
|
56
|
+
body: { bundle_id: bundleId, bundle_revision: revision, definition_ids: selectedDefinitionIds },
|
|
57
|
+
});
|
|
58
|
+
const operation = await latticeRuntimeGeneration.getGenerationOperation({
|
|
59
|
+
client: generation,
|
|
60
|
+
headers: { "X-Juntai-Application-ID": applicationId },
|
|
61
|
+
path: { generation_operation_id: operationId },
|
|
62
|
+
});
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Pass each factory instance through the operation's `client` option. Relative gateway paths work in the browser; server adapters use an absolute URL. Console owns session-aware fetch and rejects protected cross-origin calls. The SDK supplies neither session credentials nor gateway registration. Operations use the exact released flat names and snake_case request properties. Authoring commands preserve body `expected_bundle_revision` and `idempotency_key`; generation requires application scope and preserves exact reference versions, including Object version `"1"`. Cancellation forwards `If-Match` when supplied, and evidence reads require `expected_digest`. Inspect returned `data`, `error`, `response`, and ETag; an accepted generation remains queued until authoritative lookup reports a terminal status. After an ambiguous command, recover using its existing identity instead of automatically replaying it.
|
|
66
|
+
|
|
67
|
+
`npm run check:consumer` installs a packed release into a clean directory, checks ESM exports and TypeScript declarations, bundles it for the browser without Node shims or runtime dependencies, and runs Chromium against explicit same-origin HTTP adapter fixtures. It exercises authoring, preview/release, generation lookup/cancellation/evidence, pagination, session/correlation forwarding, denial, stale revision, expiry, cancellation, isolation, and lost-response recovery. These are SDK contract fixtures; service deployment and end-to-end LatticeConsole acceptance remain with their owning tasks. Run `npx --no-install playwright install --with-deps chromium` before local verification. `--tarball <path>` tests an already downloaded release; publication CI runs this against the integrity-verified public npm tarball.
|
|
68
|
+
|
|
42
69
|
The withdrawn unscoped `juntai-typescript-sdk@1.1.0` publication is historical
|
|
43
70
|
metadata only. Do not install it or treat it as target release evidence.
|
|
44
71
|
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/** Generated stable adapter for lattice.ontology. Do not edit. */
|
|
2
|
+
export * from "../../generated/lattice.ontology/index.js";
|
|
3
|
+
export { client } from "../../generated/lattice.ontology/client.gen.js";
|
|
4
|
+
export { createClient, createConfig } from "../../generated/lattice.ontology/client/index.js";
|
|
5
|
+
export type { Client, Config } from "../../generated/lattice.ontology/client/index.js";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Generated stable adapter for lattice.ontology. Do not edit. */
|
|
2
|
+
export * from "../../generated/lattice.ontology/index.js";
|
|
3
|
+
export { client } from "../../generated/lattice.ontology/client.gen.js";
|
|
4
|
+
export { createClient, createConfig } from "../../generated/lattice.ontology/client/index.js";
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/** Generated stable adapter for lattice.runtime-generation. Do not edit. */
|
|
2
|
+
export * from "../../generated/lattice.runtime-generation/index.js";
|
|
3
|
+
export { client } from "../../generated/lattice.runtime-generation/client.gen.js";
|
|
4
|
+
export { createClient, createConfig } from "../../generated/lattice.runtime-generation/client/index.js";
|
|
5
|
+
export type { Client, Config } from "../../generated/lattice.runtime-generation/client/index.js";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Generated stable adapter for lattice.runtime-generation. Do not edit. */
|
|
2
|
+
export * from "../../generated/lattice.runtime-generation/index.js";
|
|
3
|
+
export { client } from "../../generated/lattice.runtime-generation/client.gen.js";
|
|
4
|
+
export { createClient, createConfig } from "../../generated/lattice.runtime-generation/client/index.js";
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
import { createSseClient } from '../core/serverSentEvents.gen.js';
|
|
3
|
+
import { getValidRequestBody } from '../core/utils.gen.js';
|
|
4
|
+
import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from './utils.gen.js';
|
|
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
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type { Auth } from '../core/auth.gen.js';
|
|
2
|
+
export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
|
|
3
|
+
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
|
|
4
|
+
export { buildClientParams } from '../core/params.gen.js';
|
|
5
|
+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
|
|
6
|
+
export type { ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
|
|
7
|
+
export type { ClientMeta } from '../core/types.gen.js';
|
|
8
|
+
export { createClient } from './client.gen.js';
|
|
9
|
+
export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen.js';
|
|
10
|
+
export { createConfig, mergeHeaders } from './utils.gen.js';
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
|
|
3
|
+
export { buildClientParams } from '../core/params.gen.js';
|
|
4
|
+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
|
|
5
|
+
export { createClient } from './client.gen.js';
|
|
6
|
+
export { createConfig, mergeHeaders } from './utils.gen.js';
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import type { Auth } from '../core/auth.gen.js';
|
|
2
|
+
import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
|
|
3
|
+
import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
|
|
4
|
+
import type { Middleware } from './utils.gen.js';
|
|
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 {};
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
|
|
2
|
+
import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
|
|
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 {};
|