@w6w/sdk 0.4.0 → 0.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/README.md +5 -5
- package/dist/mod.d.ts +2 -2
- package/dist/mod.js +2 -2
- package/dist/src/client.d.ts +6 -6
- package/dist/src/client.js +5 -5
- package/dist/src/config.d.ts +2 -2
- package/dist/src/config.js +2 -2
- package/dist/src/connections.d.ts +2 -2
- package/dist/src/connections.js +1 -1
- package/dist/src/console/api-calls.d.ts +2 -2
- package/dist/src/console/api-calls.js +1 -1
- package/dist/src/console/apps.d.ts +4 -4
- package/dist/src/console/apps.js +3 -3
- package/dist/src/console/auth.d.ts +2 -2
- package/dist/src/console/auth.js +1 -1
- package/dist/src/console/connections.d.ts +2 -2
- package/dist/src/console/connections.js +1 -1
- package/dist/src/console/dashboard.d.ts +2 -2
- package/dist/src/console/dashboard.js +1 -1
- package/dist/src/console/endpoints.d.ts +2 -2
- package/dist/src/console/endpoints.js +1 -1
- package/dist/src/console/functions.d.ts +2 -2
- package/dist/src/console/functions.js +1 -1
- package/dist/src/console/mod.d.ts +3 -3
- package/dist/src/console/mod.js +2 -2
- package/dist/src/console/projects.d.ts +2 -2
- package/dist/src/console/projects.js +1 -1
- package/dist/src/console/reliability.d.ts +2 -2
- package/dist/src/console/reliability.js +1 -1
- package/dist/src/console/saved-tests.d.ts +3 -3
- package/dist/src/console/saved-tests.js +2 -2
- package/dist/src/console/schedules.d.ts +2 -2
- package/dist/src/console/schedules.js +1 -1
- package/dist/src/console/step-tests.d.ts +3 -3
- package/dist/src/console/step-tests.js +2 -2
- package/dist/src/console/subscriptions.d.ts +2 -2
- package/dist/src/console/subscriptions.js +1 -1
- package/dist/src/console/tenant-oauth-apps.d.ts +2 -2
- package/dist/src/console/tenant-oauth-apps.js +1 -1
- package/dist/src/console/tokens.d.ts +2 -2
- package/dist/src/console/tokens.js +1 -1
- package/dist/src/console/vault.d.ts +2 -2
- package/dist/src/console/vault.js +1 -1
- package/dist/src/console/workflows.d.ts +2 -2
- package/dist/src/console/workflows.js +1 -1
- package/dist/src/documents.d.ts +2 -2
- package/dist/src/documents.js +1 -1
- package/dist/src/me.d.ts +2 -2
- package/dist/src/me.js +1 -1
- package/dist/src/run.d.ts +1 -1
- package/dist/src/vars.d.ts +2 -2
- package/dist/src/vars.js +1 -1
- package/dist/src/version.js +1 -1
- package/dist/src/workflows.d.ts +2 -2
- package/dist/src/workflows.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,9 +33,9 @@ same set of operations in every language.
|
|
|
33
33
|
## Quick start
|
|
34
34
|
|
|
35
35
|
```ts
|
|
36
|
-
import {
|
|
36
|
+
import { W6WClient, isActionRun, isFunctionRun, isWorkflowRun } from "@w6w/sdk";
|
|
37
37
|
|
|
38
|
-
const client = new
|
|
38
|
+
const client = new W6WClient(); // reads W6W_BASE_URL and W6W_TOKEN
|
|
39
39
|
|
|
40
40
|
// Who am I, and what versions am I talking to?
|
|
41
41
|
const me = await client.me();
|
|
@@ -121,13 +121,13 @@ interference. There is no default base URL — a client built without one and wi
|
|
|
121
121
|
raises a configuration error naming the variable.
|
|
122
122
|
|
|
123
123
|
```ts
|
|
124
|
-
import {
|
|
124
|
+
import { W6WClient } from "@w6w/sdk";
|
|
125
125
|
|
|
126
126
|
// Everything from the environment.
|
|
127
|
-
const client = new
|
|
127
|
+
const client = new W6WClient();
|
|
128
128
|
|
|
129
129
|
// Explicit arguments override W6W_BASE_URL and W6W_TOKEN.
|
|
130
|
-
const other = new
|
|
130
|
+
const other = new W6WClient({ baseUrl: "https://api.example.com", token: "…" });
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
### `W6W_BASE_URL` is an origin
|
package/dist/mod.d.ts
CHANGED
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
* @module
|
|
16
16
|
*/
|
|
17
17
|
export { VERSION } from "./src/version.ts";
|
|
18
|
-
export {
|
|
18
|
+
export { W6WClient } from "./src/client.ts";
|
|
19
19
|
export { ApiError, ConfigError } from "./src/errors.ts";
|
|
20
|
-
export { BASE_PATH, type FetchLike, joinBaseUrl, type ResolvedConfig, type
|
|
20
|
+
export { BASE_PATH, type FetchLike, joinBaseUrl, type ResolvedConfig, type W6WClientOptions, } from "./src/config.ts";
|
|
21
21
|
export type { HttpMethod, HttpResponse, QueryParams, RequestOptions } from "./src/http.ts";
|
|
22
22
|
export { path } from "./src/http.ts";
|
|
23
23
|
export { DocumentsApi } from "./src/documents.ts";
|
package/dist/mod.js
CHANGED
|
@@ -16,10 +16,10 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export { VERSION } from "./src/version.js";
|
|
18
18
|
// Transport core (T2.1.2): the client, its configuration and the error model.
|
|
19
|
-
export {
|
|
19
|
+
export { W6WClient } from "./src/client.js";
|
|
20
20
|
export { ApiError, ConfigError } from "./src/errors.js";
|
|
21
21
|
export { BASE_PATH, joinBaseUrl, } from "./src/config.js";
|
|
22
|
-
// Exported because `
|
|
22
|
+
// Exported because `W6WClient.request` is public: a host reaching an endpoint
|
|
23
23
|
// this version does not model yet must have the same encoding-at-interpolation
|
|
24
24
|
// tag the operation modules use, or it will concatenate a caller value into a
|
|
25
25
|
// path by hand — the one bug the encoding pin exists to prevent.
|
package/dist/src/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* `
|
|
2
|
+
* `W6WClient` — the object every operation hangs off.
|
|
3
3
|
*
|
|
4
4
|
* It holds three things and no behaviour of its own: the resolved
|
|
5
5
|
* configuration, the transport, and (from T2.1.3 onward) the operation
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
*
|
|
15
15
|
* @module
|
|
16
16
|
*/
|
|
17
|
-
import { type ResolvedConfig, type
|
|
17
|
+
import { type ResolvedConfig, type W6WClientOptions } from "./config.ts";
|
|
18
18
|
import { ConnectionsApi } from "./connections.ts";
|
|
19
19
|
import { ConsoleApi } from "./console/mod.ts";
|
|
20
20
|
import { DocumentsApi } from "./documents.ts";
|
|
@@ -34,14 +34,14 @@ import { WorkflowsApi } from "./workflows.ts";
|
|
|
34
34
|
* @example
|
|
35
35
|
* ```ts
|
|
36
36
|
* // From the environment.
|
|
37
|
-
* const client = new
|
|
37
|
+
* const client = new W6WClient();
|
|
38
38
|
*
|
|
39
39
|
* // Explicit, overriding the environment. Two clients, two credentials, one
|
|
40
40
|
* // process — no interference.
|
|
41
|
-
* const other = new
|
|
41
|
+
* const other = new W6WClient({ baseUrl: "https://api.example.com", token: "t_2" });
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
44
|
-
export declare class
|
|
44
|
+
export declare class W6WClient {
|
|
45
45
|
#private;
|
|
46
46
|
/**
|
|
47
47
|
* The resolved base URL, credential and default project. Exposed read-only
|
|
@@ -109,7 +109,7 @@ export declare class W6wClient {
|
|
|
109
109
|
* @param options - Explicit configuration; anything omitted falls back to the environment.
|
|
110
110
|
* @throws {ConfigError} When no base URL is configured, or the host has no `fetch`.
|
|
111
111
|
*/
|
|
112
|
-
constructor(options?:
|
|
112
|
+
constructor(options?: W6WClientOptions);
|
|
113
113
|
/**
|
|
114
114
|
* Who this client's credential says you are, plus the versions of the
|
|
115
115
|
* components that answered.
|
package/dist/src/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* `
|
|
2
|
+
* `W6WClient` — the object every operation hangs off.
|
|
3
3
|
*
|
|
4
4
|
* It holds three things and no behaviour of its own: the resolved
|
|
5
5
|
* configuration, the transport, and (from T2.1.3 onward) the operation
|
|
@@ -35,14 +35,14 @@ import { WorkflowsApi } from "./workflows.js";
|
|
|
35
35
|
* @example
|
|
36
36
|
* ```ts
|
|
37
37
|
* // From the environment.
|
|
38
|
-
* const client = new
|
|
38
|
+
* const client = new W6WClient();
|
|
39
39
|
*
|
|
40
40
|
* // Explicit, overriding the environment. Two clients, two credentials, one
|
|
41
41
|
* // process — no interference.
|
|
42
|
-
* const other = new
|
|
42
|
+
* const other = new W6WClient({ baseUrl: "https://api.example.com", token: "t_2" });
|
|
43
43
|
* ```
|
|
44
44
|
*/
|
|
45
|
-
export class
|
|
45
|
+
export class W6WClient {
|
|
46
46
|
/**
|
|
47
47
|
* The resolved base URL, credential and default project. Exposed read-only
|
|
48
48
|
* so a host can log *which server* it is talking to without re-deriving the
|
|
@@ -119,7 +119,7 @@ export class W6wClient {
|
|
|
119
119
|
const global = globalThis.fetch;
|
|
120
120
|
if (typeof global !== "function") {
|
|
121
121
|
throw new ConfigError("This runtime has no global fetch. Pass an implementation " +
|
|
122
|
-
"(new
|
|
122
|
+
"(new W6WClient({ fetch })) or run on Node 18+, Deno or Bun.");
|
|
123
123
|
}
|
|
124
124
|
// Bound, so the default keeps working when it is called as a bare
|
|
125
125
|
// function reference rather than as a method of the global object.
|
package/dist/src/config.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ export declare const BASE_PATH = "";
|
|
|
32
32
|
*/
|
|
33
33
|
export type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
|
|
34
34
|
/** Constructor options for a client. Every field is optional. */
|
|
35
|
-
export interface
|
|
35
|
+
export interface W6WClientOptions {
|
|
36
36
|
/**
|
|
37
37
|
* The **origin** of the w6w server, e.g. `https://api.example.com`. The API
|
|
38
38
|
* is served at its root, so no path is appended. It must be an absolute
|
|
@@ -137,7 +137,7 @@ export declare function joinBaseUrl(origin: string): string;
|
|
|
137
137
|
* @returns The resolved configuration.
|
|
138
138
|
* @throws {ConfigError} When no usable base URL was supplied, naming `W6W_BASE_URL`.
|
|
139
139
|
*/
|
|
140
|
-
export declare function resolveConfig(options?:
|
|
140
|
+
export declare function resolveConfig(options?: W6WClientOptions): ResolvedConfig;
|
|
141
141
|
/**
|
|
142
142
|
* The token, or a {@linkcode ConfigError} naming `W6W_TOKEN`.
|
|
143
143
|
*
|
package/dist/src/config.js
CHANGED
|
@@ -84,7 +84,7 @@ export function joinBaseUrl(origin) {
|
|
|
84
84
|
const trimmed = origin.trim().replace(/\/+$/, "");
|
|
85
85
|
if (trimmed.length === 0) {
|
|
86
86
|
throw new ConfigError("No w6w base URL is configured. Pass one to the client " +
|
|
87
|
-
'(new
|
|
87
|
+
'(new W6WClient({ baseUrl: "https://api.example.com" })) or set the ' +
|
|
88
88
|
`${ENV_BASE_URL} environment variable. It holds the server's origin, ` +
|
|
89
89
|
"e.g. \"https://api.example.com\" — the API is served at its root, so no " +
|
|
90
90
|
"path is appended.");
|
|
@@ -161,7 +161,7 @@ export function resolveConfig(options = {}) {
|
|
|
161
161
|
export function requireToken(config) {
|
|
162
162
|
if (config.token === null || config.token.trim().length === 0) {
|
|
163
163
|
throw new ConfigError("No w6w API token is configured. Pass one to the client " +
|
|
164
|
-
'(new
|
|
164
|
+
'(new W6WClient({ token: "…" })) or set the ' +
|
|
165
165
|
`${ENV_TOKEN} environment variable. Every w6w API operation is authenticated.`);
|
|
166
166
|
}
|
|
167
167
|
return config.token;
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
import type { HttpResponse, RequestOptions } from "./http.ts";
|
|
23
23
|
import { type ConnectionSummary } from "./types.ts";
|
|
24
24
|
/**
|
|
25
|
-
* The slice of `
|
|
25
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
26
26
|
* else. Connections carry no `?project=` — the server scopes them by
|
|
27
27
|
* tenant/account from the credential — so, as with `vars`, this host cannot
|
|
28
28
|
* reach the client's configuration to send a scope even by accident.
|
|
@@ -32,7 +32,7 @@ export interface ConnectionsHost {
|
|
|
32
32
|
request<T>(options: RequestOptions): Promise<HttpResponse<T>>;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
* The `connections` namespace on a `
|
|
35
|
+
* The `connections` namespace on a `W6WClient`.
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
38
38
|
* ```ts
|
package/dist/src/connections.js
CHANGED
|
@@ -30,7 +30,7 @@ import type { HttpResponse, RequestOptions } from "../http.ts";
|
|
|
30
30
|
import type { ApiCallRecord } from "./apps.ts";
|
|
31
31
|
export type { ApiCallRecord } from "./apps.ts";
|
|
32
32
|
/**
|
|
33
|
-
* The slice of `
|
|
33
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
34
34
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
35
35
|
* independently constructible in a test and this module never imports the
|
|
36
36
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -54,7 +54,7 @@ export interface ApiCallsFilter {
|
|
|
54
54
|
limit?: number;
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* The `console.apiCalls` namespace on a `
|
|
57
|
+
* The `console.apiCalls` namespace on a `W6WClient`.
|
|
58
58
|
*
|
|
59
59
|
* @example
|
|
60
60
|
* ```ts
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
*/
|
|
62
62
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
63
63
|
/**
|
|
64
|
-
* The slice of `
|
|
64
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
65
65
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
66
66
|
* independently constructible in a test and this module never imports the
|
|
67
67
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -446,7 +446,7 @@ export interface UpsertOAuthConfigInput {
|
|
|
446
446
|
extra?: Record<string, unknown>;
|
|
447
447
|
}
|
|
448
448
|
/**
|
|
449
|
-
* The `console.apps` namespace on a `
|
|
449
|
+
* The `console.apps` namespace on a `W6WClient`.
|
|
450
450
|
*
|
|
451
451
|
* @example
|
|
452
452
|
* ```ts
|
|
@@ -577,7 +577,7 @@ export declare class AppsApi {
|
|
|
577
577
|
* URL for the caller to open.
|
|
578
578
|
*
|
|
579
579
|
* No studio-page caller, but this method's shape must exactly match
|
|
580
|
-
* `
|
|
580
|
+
* `W6WApi.startAppOAuthFlow`'s signature on the `@w6w/ui` facade
|
|
581
581
|
* (`packages/ui/src/provider.tsx:110-114`), which calls it.
|
|
582
582
|
*
|
|
583
583
|
* @param appId - The app id.
|
|
@@ -639,7 +639,7 @@ export declare class AppsApi {
|
|
|
639
639
|
/**
|
|
640
640
|
* Invoke one of an app's actions.
|
|
641
641
|
*
|
|
642
|
-
* This method's shape must exactly match `
|
|
642
|
+
* This method's shape must exactly match `W6WApi.invokeAction`'s signature on
|
|
643
643
|
* the `@w6w/ui` facade (`packages/ui/src/provider.tsx`). It now models the
|
|
644
644
|
* WHOLE of that `opts` — `project` and `state` included.
|
|
645
645
|
*
|
package/dist/src/console/apps.js
CHANGED
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
import { path } from "../http.js";
|
|
63
63
|
import { unwrap } from "../types.js";
|
|
64
64
|
/**
|
|
65
|
-
* The `console.apps` namespace on a `
|
|
65
|
+
* The `console.apps` namespace on a `W6WClient`.
|
|
66
66
|
*
|
|
67
67
|
* @example
|
|
68
68
|
* ```ts
|
|
@@ -264,7 +264,7 @@ export class AppsApi {
|
|
|
264
264
|
* URL for the caller to open.
|
|
265
265
|
*
|
|
266
266
|
* No studio-page caller, but this method's shape must exactly match
|
|
267
|
-
* `
|
|
267
|
+
* `W6WApi.startAppOAuthFlow`'s signature on the `@w6w/ui` facade
|
|
268
268
|
* (`packages/ui/src/provider.tsx:110-114`), which calls it.
|
|
269
269
|
*
|
|
270
270
|
* @param appId - The app id.
|
|
@@ -345,7 +345,7 @@ export class AppsApi {
|
|
|
345
345
|
/**
|
|
346
346
|
* Invoke one of an app's actions.
|
|
347
347
|
*
|
|
348
|
-
* This method's shape must exactly match `
|
|
348
|
+
* This method's shape must exactly match `W6WApi.invokeAction`'s signature on
|
|
349
349
|
* the `@w6w/ui` facade (`packages/ui/src/provider.tsx`). It now models the
|
|
350
350
|
* WHOLE of that `opts` — `project` and `state` included.
|
|
351
351
|
*
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
*/
|
|
48
48
|
import type { HttpResponse, RequestOptions } from "../http.ts";
|
|
49
49
|
/**
|
|
50
|
-
* The slice of `
|
|
50
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
51
51
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
52
52
|
* independently constructible in a test and this module never imports the
|
|
53
53
|
* client back — mirrors `ReliabilityHost` in `./reliability.ts`.
|
|
@@ -153,7 +153,7 @@ export interface ConsoleMe {
|
|
|
153
153
|
versions?: Record<string, string>;
|
|
154
154
|
}
|
|
155
155
|
/**
|
|
156
|
-
* The `console.auth` namespace on a `
|
|
156
|
+
* The `console.auth` namespace on a `W6WClient`.
|
|
157
157
|
*
|
|
158
158
|
* @example
|
|
159
159
|
* ```ts
|
package/dist/src/console/auth.js
CHANGED
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
46
46
|
import { type ConnectionSummary } from "../types.ts";
|
|
47
47
|
/**
|
|
48
|
-
* The slice of `
|
|
48
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
49
49
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
50
50
|
* independently constructible in a test and this module never imports the
|
|
51
51
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -79,7 +79,7 @@ export interface ConnectionTestResult {
|
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
|
-
* The `console.connections` namespace on a `
|
|
82
|
+
* The `console.connections` namespace on a `W6WClient`.
|
|
83
83
|
*
|
|
84
84
|
* @example
|
|
85
85
|
* ```ts
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
*/
|
|
25
25
|
import type { HttpResponse, RequestOptions } from "../http.ts";
|
|
26
26
|
/**
|
|
27
|
-
* The slice of `
|
|
27
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
28
28
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
29
29
|
* independently constructible in a test and this module never imports the
|
|
30
30
|
* client back — mirrors `ReliabilityHost` in `./reliability.ts`.
|
|
@@ -75,7 +75,7 @@ export interface DashboardStats {
|
|
|
75
75
|
}>;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* The `console.dashboard` namespace on a `
|
|
78
|
+
* The `console.dashboard` namespace on a `W6WClient`.
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* ```ts
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
*/
|
|
44
44
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
45
45
|
/**
|
|
46
|
-
* The slice of `
|
|
46
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
47
47
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
48
48
|
* independently constructible in a test and this module never imports the
|
|
49
49
|
* client back — mirrors `WorkflowsHost` in `./workflows.ts`.
|
|
@@ -165,7 +165,7 @@ export type EndpointInvokeResult = {
|
|
|
165
165
|
runId: string;
|
|
166
166
|
};
|
|
167
167
|
/**
|
|
168
|
-
* The `console.endpoints` namespace on a `
|
|
168
|
+
* The `console.endpoints` namespace on a `W6WClient`.
|
|
169
169
|
*
|
|
170
170
|
* @example
|
|
171
171
|
* ```ts
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
*/
|
|
39
39
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
40
40
|
/**
|
|
41
|
-
* The slice of `
|
|
41
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
42
42
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
43
43
|
* independently constructible in a test and this module never imports the
|
|
44
44
|
* client back — mirrors `WorkflowsHost` in `./workflows.ts`.
|
|
@@ -102,7 +102,7 @@ export interface FunctionSummary {
|
|
|
102
102
|
valid: boolean;
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* The `console.functions` namespace on a `
|
|
105
|
+
* The `console.functions` namespace on a `W6WClient`.
|
|
106
106
|
*
|
|
107
107
|
* @example
|
|
108
108
|
* ```ts
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* but deliberately EXCLUDED from `endpoints.json`'s `operations[]` and from
|
|
7
7
|
* the root barrel (`../../mod.ts`) — see `docs/console.md` and HITL-1 in this
|
|
8
8
|
* task's contract. `client.console` is instance state exactly like every other
|
|
9
|
-
* namespace on `
|
|
9
|
+
* namespace on `W6WClient` (`docs/implementation.md` §MECHANISM PIN —
|
|
10
10
|
* instance state, never globals): it holds the host it was constructed with
|
|
11
11
|
* and nothing of its own.
|
|
12
12
|
*
|
|
@@ -70,7 +70,7 @@ export type { ApiCallsFilter, ApiCallsHost } from "./api-calls.ts";
|
|
|
70
70
|
export { TenantOAuthAppsApi } from "./tenant-oauth-apps.ts";
|
|
71
71
|
export type { SetTenantOAuthAppInput, TenantOAuthAppsHost, TenantOAuthAppsResponse, TenantOAuthAppSummary, } from "./tenant-oauth-apps.ts";
|
|
72
72
|
/**
|
|
73
|
-
* The slice of `
|
|
73
|
+
* The slice of `W6WClient` the console namespace group needs: the transport,
|
|
74
74
|
* and nothing else. Structural rather than a concrete client type, so
|
|
75
75
|
* `ConsoleApi` stays independently constructible in a test and this module
|
|
76
76
|
* never imports the client back.
|
|
@@ -80,7 +80,7 @@ export interface ConsoleHost {
|
|
|
80
80
|
request<T>(options: RequestOptions): Promise<HttpResponse<T>>;
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* The `console` namespace group on a `
|
|
83
|
+
* The `console` namespace group on a `W6WClient` — studio-internal, not part
|
|
84
84
|
* of the published partner contract.
|
|
85
85
|
*
|
|
86
86
|
* @example
|
package/dist/src/console/mod.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* but deliberately EXCLUDED from `endpoints.json`'s `operations[]` and from
|
|
7
7
|
* the root barrel (`../../mod.ts`) — see `docs/console.md` and HITL-1 in this
|
|
8
8
|
* task's contract. `client.console` is instance state exactly like every other
|
|
9
|
-
* namespace on `
|
|
9
|
+
* namespace on `W6WClient` (`docs/implementation.md` §MECHANISM PIN —
|
|
10
10
|
* instance state, never globals): it holds the host it was constructed with
|
|
11
11
|
* and nothing of its own.
|
|
12
12
|
*
|
|
@@ -52,7 +52,7 @@ export { SubscriptionsApi } from "./subscriptions.js";
|
|
|
52
52
|
export { ApiCallsApi } from "./api-calls.js";
|
|
53
53
|
export { TenantOAuthAppsApi } from "./tenant-oauth-apps.js";
|
|
54
54
|
/**
|
|
55
|
-
* The `console` namespace group on a `
|
|
55
|
+
* The `console` namespace group on a `W6WClient` — studio-internal, not part
|
|
56
56
|
* of the published partner contract.
|
|
57
57
|
*
|
|
58
58
|
* @example
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
*/
|
|
31
31
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
32
32
|
/**
|
|
33
|
-
* The slice of `
|
|
33
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
34
34
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
35
35
|
* independently constructible in a test and this module never imports the
|
|
36
36
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -55,7 +55,7 @@ export interface Project {
|
|
|
55
55
|
updatedAt: string;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* The `console.projects` namespace on a `
|
|
58
|
+
* The `console.projects` namespace on a `W6WClient`.
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* ```ts
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
*/
|
|
23
23
|
import type { HttpResponse, RequestOptions } from "../http.ts";
|
|
24
24
|
/**
|
|
25
|
-
* The slice of `
|
|
25
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
26
26
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
27
27
|
* independently constructible in a test and this module never imports the
|
|
28
28
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -123,7 +123,7 @@ export interface ReliabilityServices {
|
|
|
123
123
|
services: ReliabilityService[];
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* The `console.reliability` namespace on a `
|
|
126
|
+
* The `console.reliability` namespace on a `W6WClient`.
|
|
127
127
|
*
|
|
128
128
|
* @example
|
|
129
129
|
* ```ts
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
*
|
|
19
19
|
* **`recordTestRun` returns the REAL created row, not `void`.** Studio's
|
|
20
20
|
* current `client.ts` discards it to `void` (`.then(() => {})`) only so its
|
|
21
|
-
* `api` object stays assignable to `@w6w/ui`'s `
|
|
21
|
+
* `api` object stays assignable to `@w6w/ui`'s `W6WApi.recordTestRun`
|
|
22
22
|
* (typed `Promise<void>`, `packages/ui/src/provider.tsx:168-177`) — that is
|
|
23
23
|
* STUDIO's constraint, not the SDK's. Mirrors T2.2.1's `deleteApp` precedent:
|
|
24
24
|
* a "complete client" returns genuinely informative data and discards only
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
*/
|
|
36
36
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
37
37
|
/**
|
|
38
|
-
* The slice of `
|
|
38
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
39
39
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
40
40
|
* independently constructible in a test and this module never imports the
|
|
41
41
|
* client back — mirrors `ConnectionsHost` in `./connections.ts`.
|
|
@@ -89,7 +89,7 @@ export interface SavedTestRun {
|
|
|
89
89
|
createdAt: string;
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* The `console.savedTests` namespace on a `
|
|
92
|
+
* The `console.savedTests` namespace on a `W6WClient`.
|
|
93
93
|
*
|
|
94
94
|
* @example
|
|
95
95
|
* ```ts
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
*
|
|
19
19
|
* **`recordTestRun` returns the REAL created row, not `void`.** Studio's
|
|
20
20
|
* current `client.ts` discards it to `void` (`.then(() => {})`) only so its
|
|
21
|
-
* `api` object stays assignable to `@w6w/ui`'s `
|
|
21
|
+
* `api` object stays assignable to `@w6w/ui`'s `W6WApi.recordTestRun`
|
|
22
22
|
* (typed `Promise<void>`, `packages/ui/src/provider.tsx:168-177`) — that is
|
|
23
23
|
* STUDIO's constraint, not the SDK's. Mirrors T2.2.1's `deleteApp` precedent:
|
|
24
24
|
* a "complete client" returns genuinely informative data and discards only
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
import { path } from "../http.js";
|
|
37
37
|
import { unwrap } from "../types.js";
|
|
38
38
|
/**
|
|
39
|
-
* The `console.savedTests` namespace on a `
|
|
39
|
+
* The `console.savedTests` namespace on a `W6WClient`.
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
42
|
* ```ts
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
*/
|
|
35
35
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
36
36
|
/**
|
|
37
|
-
* The slice of `
|
|
37
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
38
38
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
39
39
|
* independently constructible in a test and this module never imports the
|
|
40
40
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -72,7 +72,7 @@ export interface ScheduleUpsertInput {
|
|
|
72
72
|
variables?: Record<string, unknown>;
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* The `console.schedules` namespace on a `
|
|
75
|
+
* The `console.schedules` namespace on a `W6WClient`.
|
|
76
76
|
*
|
|
77
77
|
* @example
|
|
78
78
|
* ```ts
|
|
@@ -36,7 +36,7 @@ import { path } from "../http.js";
|
|
|
36
36
|
import { ApiError } from "../errors.js";
|
|
37
37
|
import { unwrap } from "../types.js";
|
|
38
38
|
/**
|
|
39
|
-
* The `console.schedules` namespace on a `
|
|
39
|
+
* The `console.schedules` namespace on a `W6WClient`.
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
42
|
* ```ts
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
*
|
|
29
29
|
* **`recordRun` returns the REAL created row, not `void`.** Studio's current
|
|
30
30
|
* `client.ts` discards it to `void` (`.then(() => {})`) only so its `api`
|
|
31
|
-
* object stays assignable to `@w6w/ui`'s `
|
|
31
|
+
* object stays assignable to `@w6w/ui`'s `W6WApi.recordStepTestRun` (typed
|
|
32
32
|
* `Promise<void>`, `packages/ui/src/provider.tsx:211-221`) — that is
|
|
33
33
|
* STUDIO's constraint, not the SDK's. Mirrors `./saved-tests.ts`'s
|
|
34
34
|
* `recordTestRun` exactly; the void-discard happens at studio's own repo
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
*/
|
|
44
44
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
45
45
|
/**
|
|
46
|
-
* The slice of `
|
|
46
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
47
47
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
48
48
|
* independently constructible in a test and this module never imports the
|
|
49
49
|
* client back — mirrors `ConnectionsHost` in `./connections.ts`.
|
|
@@ -86,7 +86,7 @@ export interface StepTestRun {
|
|
|
86
86
|
createdAt: string;
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
* The `console.stepTests` namespace on a `
|
|
89
|
+
* The `console.stepTests` namespace on a `W6WClient`.
|
|
90
90
|
*
|
|
91
91
|
* @example
|
|
92
92
|
* ```ts
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
*
|
|
29
29
|
* **`recordRun` returns the REAL created row, not `void`.** Studio's current
|
|
30
30
|
* `client.ts` discards it to `void` (`.then(() => {})`) only so its `api`
|
|
31
|
-
* object stays assignable to `@w6w/ui`'s `
|
|
31
|
+
* object stays assignable to `@w6w/ui`'s `W6WApi.recordStepTestRun` (typed
|
|
32
32
|
* `Promise<void>`, `packages/ui/src/provider.tsx:211-221`) — that is
|
|
33
33
|
* STUDIO's constraint, not the SDK's. Mirrors `./saved-tests.ts`'s
|
|
34
34
|
* `recordTestRun` exactly; the void-discard happens at studio's own repo
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
import { path } from "../http.js";
|
|
45
45
|
import { unwrap } from "../types.js";
|
|
46
46
|
/**
|
|
47
|
-
* The `console.stepTests` namespace on a `
|
|
47
|
+
* The `console.stepTests` namespace on a `W6WClient`.
|
|
48
48
|
*
|
|
49
49
|
* @example
|
|
50
50
|
* ```ts
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
*/
|
|
46
46
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
47
47
|
/**
|
|
48
|
-
* The slice of `
|
|
48
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
49
49
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
50
50
|
* independently constructible in a test and this module never imports the
|
|
51
51
|
* client back — mirrors `VarsHost` in `../vars.ts`.
|
|
@@ -97,7 +97,7 @@ export interface TriggerEventSummary {
|
|
|
97
97
|
runId: string | null;
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
* The `console.subscriptions` namespace on a `
|
|
100
|
+
* The `console.subscriptions` namespace on a `W6WClient`.
|
|
101
101
|
*
|
|
102
102
|
* @example
|
|
103
103
|
* ```ts
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
*/
|
|
49
49
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
50
50
|
/**
|
|
51
|
-
* The slice of `
|
|
51
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
52
52
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
53
53
|
* independently constructible in a test and this module never imports the
|
|
54
54
|
* client back — mirrors `AuthHost` in `./auth.ts`.
|
|
@@ -131,7 +131,7 @@ export interface SetTenantOAuthAppInput {
|
|
|
131
131
|
disabled?: boolean;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* The `console.tenantOAuthApps` namespace on a `
|
|
134
|
+
* The `console.tenantOAuthApps` namespace on a `W6WClient` — the caller's own
|
|
135
135
|
* tenant, never a tenant of its choosing.
|
|
136
136
|
*
|
|
137
137
|
* @example
|
|
@@ -75,7 +75,7 @@ function toSetBody(input) {
|
|
|
75
75
|
return body;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* The `console.tenantOAuthApps` namespace on a `
|
|
78
|
+
* The `console.tenantOAuthApps` namespace on a `W6WClient` — the caller's own
|
|
79
79
|
* tenant, never a tenant of its choosing.
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
*/
|
|
41
41
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
42
42
|
/**
|
|
43
|
-
* The slice of `
|
|
43
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
44
44
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
45
45
|
* independently constructible in a test and this module never imports the
|
|
46
46
|
* client back — mirrors `ConnectionsHost` in `./connections.ts`.
|
|
@@ -88,7 +88,7 @@ export interface CreateTokenResponse {
|
|
|
88
88
|
secret: string;
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
|
-
* The `console.tokens` namespace on a `
|
|
91
|
+
* The `console.tokens` namespace on a `W6WClient`.
|
|
92
92
|
*
|
|
93
93
|
* @example
|
|
94
94
|
* ```ts
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
*/
|
|
41
41
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
42
42
|
/**
|
|
43
|
-
* The slice of `
|
|
43
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
44
44
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
45
45
|
* independently constructible in a test and this module never imports the
|
|
46
46
|
* client back — mirrors `ConnectionsHost` in `./connections.ts`.
|
|
@@ -85,7 +85,7 @@ export interface SecretValue {
|
|
|
85
85
|
iv: string;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* The `console.vault` namespace on a `
|
|
88
|
+
* The `console.vault` namespace on a `W6WClient`.
|
|
89
89
|
*
|
|
90
90
|
* @example
|
|
91
91
|
* ```ts
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
import { type HttpResponse, type RequestOptions } from "../http.ts";
|
|
55
55
|
import { type RunStatus, type StepError } from "../types.ts";
|
|
56
56
|
/**
|
|
57
|
-
* The slice of `
|
|
57
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
58
58
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
59
59
|
* independently constructible in a test and this module never imports the
|
|
60
60
|
* client back — mirrors `SchedulesHost` in `./schedules.ts`.
|
|
@@ -117,7 +117,7 @@ export interface RunSummary {
|
|
|
117
117
|
finishedAt: string | null;
|
|
118
118
|
}
|
|
119
119
|
/**
|
|
120
|
-
* The `console.workflows` namespace on a `
|
|
120
|
+
* The `console.workflows` namespace on a `W6WClient`.
|
|
121
121
|
*
|
|
122
122
|
* @example
|
|
123
123
|
* ```ts
|
|
@@ -56,7 +56,7 @@ import { unwrap } from "../types.js";
|
|
|
56
56
|
/** The precondition header `upsert` sends when `ifUnmodifiedSince` is given. */
|
|
57
57
|
const PRECONDITION_HEADER = "x-w6w-if-unmodified-since";
|
|
58
58
|
/**
|
|
59
|
-
* The `console.workflows` namespace on a `
|
|
59
|
+
* The `console.workflows` namespace on a `W6WClient`.
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
62
|
* ```ts
|
package/dist/src/documents.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ import type { ResolvedConfig } from "./config.ts";
|
|
|
24
24
|
import { type HttpResponse, type RequestOptions } from "./http.ts";
|
|
25
25
|
import { type Doc, type DocFormat } from "./types.ts";
|
|
26
26
|
/**
|
|
27
|
-
* The slice of `
|
|
27
|
+
* The slice of `W6WClient` this namespace needs: the transport, plus
|
|
28
28
|
* the resolved configuration it reads the **default project** out of. Structural
|
|
29
29
|
* rather than a concrete client type, so the namespace stays independently
|
|
30
30
|
* constructible in a test and this module never imports the client back.
|
|
@@ -78,7 +78,7 @@ export interface DocumentPatch {
|
|
|
78
78
|
description?: string;
|
|
79
79
|
}
|
|
80
80
|
/**
|
|
81
|
-
* The `documents` namespace on a `
|
|
81
|
+
* The `documents` namespace on a `W6WClient`.
|
|
82
82
|
*
|
|
83
83
|
* @example
|
|
84
84
|
* ```ts
|
package/dist/src/documents.js
CHANGED
package/dist/src/me.d.ts
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*
|
|
17
17
|
* It is deliberately not a namespace class. `endpoints.json` names this
|
|
18
18
|
* operation `client.me()`, a method on the client itself, so the module exports
|
|
19
|
-
* a function over a narrow host interface and `
|
|
19
|
+
* a function over a narrow host interface and `W6WClient` delegates to it —
|
|
20
20
|
* same layering as the namespaces, without inventing a `client.me.me()`.
|
|
21
21
|
*
|
|
22
22
|
* @module
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
import type { HttpResponse, RequestOptions } from "./http.ts";
|
|
25
25
|
import type { Me } from "./types.ts";
|
|
26
26
|
/**
|
|
27
|
-
* The slice of `
|
|
27
|
+
* The slice of `W6WClient` this operation needs: the transport, and nothing
|
|
28
28
|
* else. Structural rather than a concrete client type, so it stays
|
|
29
29
|
* independently callable in a test and this module never imports the client
|
|
30
30
|
* back.
|
package/dist/src/me.js
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*
|
|
17
17
|
* It is deliberately not a namespace class. `endpoints.json` names this
|
|
18
18
|
* operation `client.me()`, a method on the client itself, so the module exports
|
|
19
|
-
* a function over a narrow host interface and `
|
|
19
|
+
* a function over a narrow host interface and `W6WClient` delegates to it —
|
|
20
20
|
* same layering as the namespaces, without inventing a `client.me.me()`.
|
|
21
21
|
*
|
|
22
22
|
* @module
|
package/dist/src/run.d.ts
CHANGED
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
import type { HttpResponse, RequestOptions } from "./http.ts";
|
|
46
46
|
import type { RunEnvelope } from "./types.ts";
|
|
47
47
|
/**
|
|
48
|
-
* The slice of `
|
|
48
|
+
* The slice of `W6WClient` this operation needs: the transport, and nothing
|
|
49
49
|
* else. Structural rather than a concrete client type, so it stays
|
|
50
50
|
* independently callable in a test and this module never imports the client
|
|
51
51
|
* back.
|
package/dist/src/vars.d.ts
CHANGED
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
import { type HttpResponse, type RequestOptions } from "./http.ts";
|
|
25
25
|
import { type Var, type VarType } from "./types.ts";
|
|
26
26
|
/**
|
|
27
|
-
* The slice of `
|
|
27
|
+
* The slice of `W6WClient` this namespace needs: the transport, and nothing
|
|
28
28
|
* else. Structural rather than a concrete client type, so the namespace stays
|
|
29
29
|
* independently constructible in a test and this module never imports the
|
|
30
30
|
* client back.
|
|
@@ -68,7 +68,7 @@ export interface VarPatch {
|
|
|
68
68
|
description?: string;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* The `vars` namespace on a `
|
|
71
|
+
* The `vars` namespace on a `W6WClient`.
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
74
|
* ```ts
|
package/dist/src/vars.js
CHANGED
package/dist/src/version.js
CHANGED
package/dist/src/workflows.d.ts
CHANGED
|
@@ -47,7 +47,7 @@ import type { ResolvedConfig } from "./config.ts";
|
|
|
47
47
|
import { type HttpResponse, type RequestOptions } from "./http.ts";
|
|
48
48
|
import { type RunResult, type WorkflowSummary } from "./types.ts";
|
|
49
49
|
/**
|
|
50
|
-
* The slice of `
|
|
50
|
+
* The slice of `W6WClient` this namespace needs: the transport, plus the
|
|
51
51
|
* resolved configuration it reads the **default project** out of. Structural
|
|
52
52
|
* rather than a concrete client type, so the namespace stays independently
|
|
53
53
|
* constructible in a test and this module never imports the client back.
|
|
@@ -131,7 +131,7 @@ export interface WorkflowRunResult extends RunResult {
|
|
|
131
131
|
httpStatus: number;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* The `workflows` namespace on a `
|
|
134
|
+
* The `workflows` namespace on a `W6WClient`.
|
|
135
135
|
*
|
|
136
136
|
* @example
|
|
137
137
|
* ```ts
|
package/dist/src/workflows.js
CHANGED
|
@@ -47,7 +47,7 @@ import { ApiError } from "./errors.js";
|
|
|
47
47
|
import { path } from "./http.js";
|
|
48
48
|
import { isTerminalRunStatus, unwrap, } from "./types.js";
|
|
49
49
|
/**
|
|
50
|
-
* The `workflows` namespace on a `
|
|
50
|
+
* The `workflows` namespace on a `W6WClient`.
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
53
|
* ```ts
|