@onkernel/sdk 0.96.0 → 0.98.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 +15 -0
- package/package.json +1 -1
- package/resources/auth/connections.d.mts +5 -3
- package/resources/auth/connections.d.mts.map +1 -1
- package/resources/auth/connections.d.ts +5 -3
- package/resources/auth/connections.d.ts.map +1 -1
- package/resources/browsers/browsers.d.mts +23 -15
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +23 -15
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js +23 -15
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs +23 -15
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/computer.d.mts +62 -45
- package/resources/browsers/computer.d.mts.map +1 -1
- package/resources/browsers/computer.d.ts +62 -45
- package/resources/browsers/computer.d.ts.map +1 -1
- package/resources/browsers/computer.js +74 -57
- package/resources/browsers/computer.js.map +1 -1
- package/resources/browsers/computer.mjs +74 -57
- package/resources/browsers/computer.mjs.map +1 -1
- package/resources/browsers/fs/fs.d.mts +61 -47
- package/resources/browsers/fs/fs.d.mts.map +1 -1
- package/resources/browsers/fs/fs.d.ts +61 -47
- package/resources/browsers/fs/fs.d.ts.map +1 -1
- package/resources/browsers/fs/fs.js +73 -59
- package/resources/browsers/fs/fs.js.map +1 -1
- package/resources/browsers/fs/fs.mjs +73 -59
- package/resources/browsers/fs/fs.mjs.map +1 -1
- package/resources/browsers/fs/watch.d.mts +8 -8
- package/resources/browsers/fs/watch.d.mts.map +1 -1
- package/resources/browsers/fs/watch.d.ts +8 -8
- package/resources/browsers/fs/watch.d.ts.map +1 -1
- package/resources/browsers/fs/watch.js +9 -9
- package/resources/browsers/fs/watch.js.map +1 -1
- package/resources/browsers/fs/watch.mjs +9 -9
- package/resources/browsers/fs/watch.mjs.map +1 -1
- package/resources/browsers/index.d.mts +2 -1
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +2 -1
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js +3 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs +1 -0
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/browsers/logs.d.mts +5 -4
- package/resources/browsers/logs.d.mts.map +1 -1
- package/resources/browsers/logs.d.ts +5 -4
- package/resources/browsers/logs.d.ts.map +1 -1
- package/resources/browsers/logs.js +6 -5
- package/resources/browsers/logs.js.map +1 -1
- package/resources/browsers/logs.mjs +6 -5
- package/resources/browsers/logs.mjs.map +1 -1
- package/resources/browsers/playwright.d.mts +7 -4
- package/resources/browsers/playwright.d.mts.map +1 -1
- package/resources/browsers/playwright.d.ts +7 -4
- package/resources/browsers/playwright.d.ts.map +1 -1
- package/resources/browsers/playwright.js +8 -5
- package/resources/browsers/playwright.js.map +1 -1
- package/resources/browsers/playwright.mjs +8 -5
- package/resources/browsers/playwright.mjs.map +1 -1
- package/resources/browsers/process.d.mts +31 -23
- package/resources/browsers/process.d.mts.map +1 -1
- package/resources/browsers/process.d.ts +31 -23
- package/resources/browsers/process.d.ts.map +1 -1
- package/resources/browsers/process.js +33 -25
- package/resources/browsers/process.js.map +1 -1
- package/resources/browsers/process.mjs +33 -25
- package/resources/browsers/process.mjs.map +1 -1
- package/resources/browsers/replays.d.mts +14 -10
- package/resources/browsers/replays.d.mts.map +1 -1
- package/resources/browsers/replays.d.ts +14 -10
- package/resources/browsers/replays.d.ts.map +1 -1
- package/resources/browsers/replays.js +16 -12
- package/resources/browsers/replays.js.map +1 -1
- package/resources/browsers/replays.mjs +16 -12
- package/resources/browsers/replays.mjs.map +1 -1
- package/resources/browsers/telemetry.d.mts +158 -12
- package/resources/browsers/telemetry.d.mts.map +1 -1
- package/resources/browsers/telemetry.d.ts +158 -12
- package/resources/browsers/telemetry.d.ts.map +1 -1
- package/resources/browsers/telemetry.js +6 -6
- package/resources/browsers/telemetry.js.map +1 -1
- package/resources/browsers/telemetry.mjs +6 -6
- package/resources/browsers/telemetry.mjs.map +1 -1
- package/resources/browsers/webmcp.d.mts +148 -0
- package/resources/browsers/webmcp.d.mts.map +1 -0
- package/resources/browsers/webmcp.d.ts +148 -0
- package/resources/browsers/webmcp.d.ts.map +1 -0
- package/resources/browsers/webmcp.js +51 -0
- package/resources/browsers/webmcp.js.map +1 -0
- package/resources/browsers/webmcp.mjs +47 -0
- package/resources/browsers/webmcp.mjs.map +1 -0
- package/resources/telemetry/destinations.d.mts +23 -12
- package/resources/telemetry/destinations.d.mts.map +1 -1
- package/resources/telemetry/destinations.d.ts +23 -12
- package/resources/telemetry/destinations.d.ts.map +1 -1
- package/resources/telemetry/destinations.js +18 -8
- package/resources/telemetry/destinations.js.map +1 -1
- package/resources/telemetry/destinations.mjs +18 -8
- package/resources/telemetry/destinations.mjs.map +1 -1
- package/src/resources/auth/connections.ts +5 -2
- package/src/resources/browsers/browsers.ts +55 -15
- package/src/resources/browsers/computer.ts +78 -57
- package/src/resources/browsers/fs/fs.ts +93 -59
- package/src/resources/browsers/fs/watch.ts +13 -13
- package/src/resources/browsers/index.ts +14 -0
- package/src/resources/browsers/logs.ts +10 -5
- package/src/resources/browsers/playwright.ts +8 -5
- package/src/resources/browsers/process.ts +47 -35
- package/src/resources/browsers/replays.ts +20 -16
- package/src/resources/browsers/telemetry.ts +208 -13
- package/src/resources/browsers/webmcp.ts +196 -0
- package/src/resources/telemetry/destinations.ts +23 -12
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Discover and invoke native page tools across the browser instance.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Webmcp extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Invokes the exact live registration identified by tool_ref and waits
|
|
10
|
+
* synchronously for its result. Navigation during execution is allowed. If the tab
|
|
11
|
+
* or embedded frame disappears, or the request times out after invocation begins,
|
|
12
|
+
* the response reports outcome_unknown and the tool is not retried.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const invocationResult =
|
|
17
|
+
* await client.browsers.webmcp.invokeTool(
|
|
18
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
19
|
+
* {
|
|
20
|
+
* input: { foo: 'bar' },
|
|
21
|
+
* tool_ref: 'x',
|
|
22
|
+
* },
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
invokeTool(idOrName: string, body: WebmcpInvokeToolParams, options?: RequestOptions): APIPromise<InvocationResult>;
|
|
27
|
+
/**
|
|
28
|
+
* Returns a snapshot of native WebMCP tools available across every open tab and
|
|
29
|
+
* embedded frame in the browser. Each tool includes an opaque tool_ref for
|
|
30
|
+
* invoking that exact live registration. Tools disappear when their document
|
|
31
|
+
* closes or navigates away.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const toolsResponse =
|
|
36
|
+
* await client.browsers.webmcp.listTools(
|
|
37
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
listTools(idOrName: string, options?: RequestOptions): APIPromise<ToolsResponse>;
|
|
42
|
+
}
|
|
43
|
+
export interface InvocationFailure {
|
|
44
|
+
code: 'outcome_unknown';
|
|
45
|
+
message: string;
|
|
46
|
+
invocation_id?: string;
|
|
47
|
+
}
|
|
48
|
+
export interface InvocationResult {
|
|
49
|
+
invocation_id: string;
|
|
50
|
+
status: 'completed' | 'canceled' | 'error';
|
|
51
|
+
error_text?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Untrusted page-provided output. Callers must treat it as potentially malicious
|
|
54
|
+
* input.
|
|
55
|
+
*/
|
|
56
|
+
output?: unknown;
|
|
57
|
+
}
|
|
58
|
+
export interface InvokeRequest {
|
|
59
|
+
/**
|
|
60
|
+
* Tool input, limited to 1 MiB after JSON serialization.
|
|
61
|
+
*/
|
|
62
|
+
input: {
|
|
63
|
+
[key: string]: unknown;
|
|
64
|
+
};
|
|
65
|
+
tool_ref: string;
|
|
66
|
+
timeout_sec?: number;
|
|
67
|
+
}
|
|
68
|
+
export interface Tool {
|
|
69
|
+
description: string;
|
|
70
|
+
input_schema: {
|
|
71
|
+
[key: string]: unknown;
|
|
72
|
+
};
|
|
73
|
+
name: string;
|
|
74
|
+
source: ToolSource;
|
|
75
|
+
/**
|
|
76
|
+
* Opaque reference for invoking this exact live registration. It becomes invalid
|
|
77
|
+
* when its document or browser process is replaced.
|
|
78
|
+
*/
|
|
79
|
+
tool_ref: string;
|
|
80
|
+
/**
|
|
81
|
+
* Page-provided behavioral hints. These values are untrusted and are not enforced
|
|
82
|
+
* by Kernel.
|
|
83
|
+
*/
|
|
84
|
+
annotations?: ToolAnnotations;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Page-provided behavioral hints. These values are untrusted and are not enforced
|
|
88
|
+
* by Kernel.
|
|
89
|
+
*/
|
|
90
|
+
export interface ToolAnnotations {
|
|
91
|
+
autosubmit: boolean;
|
|
92
|
+
consequential: boolean;
|
|
93
|
+
read_only: boolean;
|
|
94
|
+
untrusted_content: boolean;
|
|
95
|
+
}
|
|
96
|
+
export interface ToolFrame {
|
|
97
|
+
/**
|
|
98
|
+
* Monotonically increasing identifier for this embedded frame during the current
|
|
99
|
+
* browser process.
|
|
100
|
+
*/
|
|
101
|
+
frame_id: number;
|
|
102
|
+
/**
|
|
103
|
+
* Current frame URL with the fragment omitted.
|
|
104
|
+
*/
|
|
105
|
+
url: string;
|
|
106
|
+
}
|
|
107
|
+
export interface ToolSource {
|
|
108
|
+
/**
|
|
109
|
+
* Embedded frame that registered the tool, or null when the top-level page
|
|
110
|
+
* registered it.
|
|
111
|
+
*/
|
|
112
|
+
frame: ToolFrame | null;
|
|
113
|
+
/**
|
|
114
|
+
* Current title of the top-level page.
|
|
115
|
+
*/
|
|
116
|
+
page_title: string;
|
|
117
|
+
/**
|
|
118
|
+
* Current URL of the top-level page with the fragment omitted.
|
|
119
|
+
*/
|
|
120
|
+
page_url: string;
|
|
121
|
+
/**
|
|
122
|
+
* Monotonically increasing identifier for the tab during the current browser
|
|
123
|
+
* process.
|
|
124
|
+
*/
|
|
125
|
+
tab_id: number;
|
|
126
|
+
/**
|
|
127
|
+
* Monotonically increasing identifier for the browser window during the current
|
|
128
|
+
* browser process.
|
|
129
|
+
*/
|
|
130
|
+
window_id: number;
|
|
131
|
+
}
|
|
132
|
+
export interface ToolsResponse {
|
|
133
|
+
tools: Array<Tool>;
|
|
134
|
+
}
|
|
135
|
+
export interface WebmcpInvokeToolParams {
|
|
136
|
+
/**
|
|
137
|
+
* Tool input, limited to 1 MiB after JSON serialization.
|
|
138
|
+
*/
|
|
139
|
+
input: {
|
|
140
|
+
[key: string]: unknown;
|
|
141
|
+
};
|
|
142
|
+
tool_ref: string;
|
|
143
|
+
timeout_sec?: number;
|
|
144
|
+
}
|
|
145
|
+
export declare namespace Webmcp {
|
|
146
|
+
export { type InvocationFailure as InvocationFailure, type InvocationResult as InvocationResult, type InvokeRequest as InvokeRequest, type Tool as Tool, type ToolAnnotations as ToolAnnotations, type ToolFrame as ToolFrame, type ToolSource as ToolSource, type ToolsResponse as ToolsResponse, type WebmcpInvokeToolParams as WebmcpInvokeToolParams, };
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=webmcp.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webmcp.d.mts","sourceRoot":"","sources":["../../src/resources/browsers/webmcp.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGjF;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,iBAAiB,CAAC;IAExB,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IAEtB,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,IAAI;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,UAAU,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,OAAO,CAAC;IAEpB,aAAa,EAAE,OAAO,CAAC;IAEvB,SAAS,EAAE,OAAO,CAAC;IAEnB,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* Discover and invoke native page tools across the browser instance.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Webmcp extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Invokes the exact live registration identified by tool_ref and waits
|
|
10
|
+
* synchronously for its result. Navigation during execution is allowed. If the tab
|
|
11
|
+
* or embedded frame disappears, or the request times out after invocation begins,
|
|
12
|
+
* the response reports outcome_unknown and the tool is not retried.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const invocationResult =
|
|
17
|
+
* await client.browsers.webmcp.invokeTool(
|
|
18
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
19
|
+
* {
|
|
20
|
+
* input: { foo: 'bar' },
|
|
21
|
+
* tool_ref: 'x',
|
|
22
|
+
* },
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
invokeTool(idOrName: string, body: WebmcpInvokeToolParams, options?: RequestOptions): APIPromise<InvocationResult>;
|
|
27
|
+
/**
|
|
28
|
+
* Returns a snapshot of native WebMCP tools available across every open tab and
|
|
29
|
+
* embedded frame in the browser. Each tool includes an opaque tool_ref for
|
|
30
|
+
* invoking that exact live registration. Tools disappear when their document
|
|
31
|
+
* closes or navigates away.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const toolsResponse =
|
|
36
|
+
* await client.browsers.webmcp.listTools(
|
|
37
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
listTools(idOrName: string, options?: RequestOptions): APIPromise<ToolsResponse>;
|
|
42
|
+
}
|
|
43
|
+
export interface InvocationFailure {
|
|
44
|
+
code: 'outcome_unknown';
|
|
45
|
+
message: string;
|
|
46
|
+
invocation_id?: string;
|
|
47
|
+
}
|
|
48
|
+
export interface InvocationResult {
|
|
49
|
+
invocation_id: string;
|
|
50
|
+
status: 'completed' | 'canceled' | 'error';
|
|
51
|
+
error_text?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Untrusted page-provided output. Callers must treat it as potentially malicious
|
|
54
|
+
* input.
|
|
55
|
+
*/
|
|
56
|
+
output?: unknown;
|
|
57
|
+
}
|
|
58
|
+
export interface InvokeRequest {
|
|
59
|
+
/**
|
|
60
|
+
* Tool input, limited to 1 MiB after JSON serialization.
|
|
61
|
+
*/
|
|
62
|
+
input: {
|
|
63
|
+
[key: string]: unknown;
|
|
64
|
+
};
|
|
65
|
+
tool_ref: string;
|
|
66
|
+
timeout_sec?: number;
|
|
67
|
+
}
|
|
68
|
+
export interface Tool {
|
|
69
|
+
description: string;
|
|
70
|
+
input_schema: {
|
|
71
|
+
[key: string]: unknown;
|
|
72
|
+
};
|
|
73
|
+
name: string;
|
|
74
|
+
source: ToolSource;
|
|
75
|
+
/**
|
|
76
|
+
* Opaque reference for invoking this exact live registration. It becomes invalid
|
|
77
|
+
* when its document or browser process is replaced.
|
|
78
|
+
*/
|
|
79
|
+
tool_ref: string;
|
|
80
|
+
/**
|
|
81
|
+
* Page-provided behavioral hints. These values are untrusted and are not enforced
|
|
82
|
+
* by Kernel.
|
|
83
|
+
*/
|
|
84
|
+
annotations?: ToolAnnotations;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Page-provided behavioral hints. These values are untrusted and are not enforced
|
|
88
|
+
* by Kernel.
|
|
89
|
+
*/
|
|
90
|
+
export interface ToolAnnotations {
|
|
91
|
+
autosubmit: boolean;
|
|
92
|
+
consequential: boolean;
|
|
93
|
+
read_only: boolean;
|
|
94
|
+
untrusted_content: boolean;
|
|
95
|
+
}
|
|
96
|
+
export interface ToolFrame {
|
|
97
|
+
/**
|
|
98
|
+
* Monotonically increasing identifier for this embedded frame during the current
|
|
99
|
+
* browser process.
|
|
100
|
+
*/
|
|
101
|
+
frame_id: number;
|
|
102
|
+
/**
|
|
103
|
+
* Current frame URL with the fragment omitted.
|
|
104
|
+
*/
|
|
105
|
+
url: string;
|
|
106
|
+
}
|
|
107
|
+
export interface ToolSource {
|
|
108
|
+
/**
|
|
109
|
+
* Embedded frame that registered the tool, or null when the top-level page
|
|
110
|
+
* registered it.
|
|
111
|
+
*/
|
|
112
|
+
frame: ToolFrame | null;
|
|
113
|
+
/**
|
|
114
|
+
* Current title of the top-level page.
|
|
115
|
+
*/
|
|
116
|
+
page_title: string;
|
|
117
|
+
/**
|
|
118
|
+
* Current URL of the top-level page with the fragment omitted.
|
|
119
|
+
*/
|
|
120
|
+
page_url: string;
|
|
121
|
+
/**
|
|
122
|
+
* Monotonically increasing identifier for the tab during the current browser
|
|
123
|
+
* process.
|
|
124
|
+
*/
|
|
125
|
+
tab_id: number;
|
|
126
|
+
/**
|
|
127
|
+
* Monotonically increasing identifier for the browser window during the current
|
|
128
|
+
* browser process.
|
|
129
|
+
*/
|
|
130
|
+
window_id: number;
|
|
131
|
+
}
|
|
132
|
+
export interface ToolsResponse {
|
|
133
|
+
tools: Array<Tool>;
|
|
134
|
+
}
|
|
135
|
+
export interface WebmcpInvokeToolParams {
|
|
136
|
+
/**
|
|
137
|
+
* Tool input, limited to 1 MiB after JSON serialization.
|
|
138
|
+
*/
|
|
139
|
+
input: {
|
|
140
|
+
[key: string]: unknown;
|
|
141
|
+
};
|
|
142
|
+
tool_ref: string;
|
|
143
|
+
timeout_sec?: number;
|
|
144
|
+
}
|
|
145
|
+
export declare namespace Webmcp {
|
|
146
|
+
export { type InvocationFailure as InvocationFailure, type InvocationResult as InvocationResult, type InvokeRequest as InvokeRequest, type Tool as Tool, type ToolAnnotations as ToolAnnotations, type ToolFrame as ToolFrame, type ToolSource as ToolSource, type ToolsResponse as ToolsResponse, type WebmcpInvokeToolParams as WebmcpInvokeToolParams, };
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=webmcp.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webmcp.d.ts","sourceRoot":"","sources":["../../src/resources/browsers/webmcp.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGjF;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,iBAAiB,CAAC;IAExB,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IAEtB,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,IAAI;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,UAAU,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,OAAO,CAAC;IAEpB,aAAa,EAAE,OAAO,CAAC;IAEvB,SAAS,EAAE,OAAO,CAAC;IAEnB,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Webmcp = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* Discover and invoke native page tools across the browser instance.
|
|
9
|
+
*/
|
|
10
|
+
class Webmcp extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Invokes the exact live registration identified by tool_ref and waits
|
|
13
|
+
* synchronously for its result. Navigation during execution is allowed. If the tab
|
|
14
|
+
* or embedded frame disappears, or the request times out after invocation begins,
|
|
15
|
+
* the response reports outcome_unknown and the tool is not retried.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const invocationResult =
|
|
20
|
+
* await client.browsers.webmcp.invokeTool(
|
|
21
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
22
|
+
* {
|
|
23
|
+
* input: { foo: 'bar' },
|
|
24
|
+
* tool_ref: 'x',
|
|
25
|
+
* },
|
|
26
|
+
* );
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
invokeTool(idOrName, body, options) {
|
|
30
|
+
return this._client.post((0, path_1.path) `/browsers/${idOrName}/webmcp/invoke`, { body, ...options });
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Returns a snapshot of native WebMCP tools available across every open tab and
|
|
34
|
+
* embedded frame in the browser. Each tool includes an opaque tool_ref for
|
|
35
|
+
* invoking that exact live registration. Tools disappear when their document
|
|
36
|
+
* closes or navigates away.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const toolsResponse =
|
|
41
|
+
* await client.browsers.webmcp.listTools(
|
|
42
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
listTools(idOrName, options) {
|
|
47
|
+
return this._client.get((0, path_1.path) `/browsers/${idOrName}/webmcp/tools`, options);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
exports.Webmcp = Webmcp;
|
|
51
|
+
//# sourceMappingURL=webmcp.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webmcp.js","sourceRoot":"","sources":["../../src/resources/browsers/webmcp.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,QAAgB,EAChB,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,QAAQ,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,QAAQ,eAAe,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;CACF;AA5CD,wBA4CC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Discover and invoke native page tools across the browser instance.
|
|
6
|
+
*/
|
|
7
|
+
export class Webmcp extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Invokes the exact live registration identified by tool_ref and waits
|
|
10
|
+
* synchronously for its result. Navigation during execution is allowed. If the tab
|
|
11
|
+
* or embedded frame disappears, or the request times out after invocation begins,
|
|
12
|
+
* the response reports outcome_unknown and the tool is not retried.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const invocationResult =
|
|
17
|
+
* await client.browsers.webmcp.invokeTool(
|
|
18
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
19
|
+
* {
|
|
20
|
+
* input: { foo: 'bar' },
|
|
21
|
+
* tool_ref: 'x',
|
|
22
|
+
* },
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
invokeTool(idOrName, body, options) {
|
|
27
|
+
return this._client.post(path `/browsers/${idOrName}/webmcp/invoke`, { body, ...options });
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Returns a snapshot of native WebMCP tools available across every open tab and
|
|
31
|
+
* embedded frame in the browser. Each tool includes an opaque tool_ref for
|
|
32
|
+
* invoking that exact live registration. Tools disappear when their document
|
|
33
|
+
* closes or navigates away.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const toolsResponse =
|
|
38
|
+
* await client.browsers.webmcp.listTools(
|
|
39
|
+
* 'htzv5orfit78e1m2biiifpbv',
|
|
40
|
+
* );
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
listTools(idOrName, options) {
|
|
44
|
+
return this._client.get(path `/browsers/${idOrName}/webmcp/tools`, options);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=webmcp.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webmcp.mjs","sourceRoot":"","sources":["../../src/resources/browsers/webmcp.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,QAAgB,EAChB,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,QAAQ,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,QAAgB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,QAAQ,eAAe,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;CACF"}
|
|
@@ -7,12 +7,16 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class Destinations extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Create an OTLP export destination in the
|
|
11
|
-
* within the
|
|
10
|
+
* Create an OTLP export destination in the authenticated organization. Names must
|
|
11
|
+
* be unique within the organization. Requires an organization-scoped credential or
|
|
12
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
12
13
|
*/
|
|
13
14
|
create(body: DestinationCreateParams, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
14
15
|
/**
|
|
15
|
-
* Retrieve a
|
|
16
|
+
* Retrieve a customer-visible OTLP destination in the authenticated organization
|
|
17
|
+
* by its ID or name. Project-scoped credentials can retrieve these destinations
|
|
18
|
+
* for selection by workloads in their project. Non-dashboard reads return header
|
|
19
|
+
* values redacted.
|
|
16
20
|
*/
|
|
17
21
|
retrieve(idOrName: string, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
18
22
|
/**
|
|
@@ -20,14 +24,18 @@ export declare class Destinations extends APIResource {
|
|
|
20
24
|
* values without restarting, which makes this the way to rotate credentials
|
|
21
25
|
* without interrupting export.
|
|
22
26
|
*
|
|
23
|
-
* Names must be unique within the
|
|
24
|
-
* managed auth connection selects this destination by name, since that
|
|
25
|
-
* resolves the name on every login. Every other field, including
|
|
26
|
-
* editable.
|
|
27
|
+
* Names must be unique within the organization. Renaming is refused with a 409
|
|
28
|
+
* while a managed auth connection selects this destination by name, since that
|
|
29
|
+
* connection resolves the name on every login. Every other field, including
|
|
30
|
+
* `headers`, stays editable. Requires an organization-scoped credential or
|
|
31
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
27
32
|
*/
|
|
28
33
|
update(idOrName: string, body: DestinationUpdateParams, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
29
34
|
/**
|
|
30
|
-
* List OTLP export destinations in the
|
|
35
|
+
* List customer-visible OTLP export destinations in the authenticated
|
|
36
|
+
* organization. Project-scoped credentials can list these destinations for
|
|
37
|
+
* selection by workloads in their project. Non-dashboard reads return header
|
|
38
|
+
* values redacted.
|
|
31
39
|
*/
|
|
32
40
|
list(query?: DestinationListParams | null | undefined, options?: RequestOptions): PagePromise<OtlpDestinationsOffsetPagination, OtlpDestination>;
|
|
33
41
|
/**
|
|
@@ -36,6 +44,8 @@ export declare class Destinations extends APIResource {
|
|
|
36
44
|
* end or delete them first. It is refused the same way while a managed auth
|
|
37
45
|
* connection still selects it, because that connection re-resolves the destination
|
|
38
46
|
* on every login, and while a managed auth login using it is still in progress.
|
|
47
|
+
* Requires an organization-scoped credential or dashboard authentication;
|
|
48
|
+
* project-scoped credentials receive a 403.
|
|
39
49
|
*/
|
|
40
50
|
delete(idOrName: string, options?: RequestOptions): APIPromise<void>;
|
|
41
51
|
}
|
|
@@ -54,14 +64,15 @@ export interface OtlpDestination {
|
|
|
54
64
|
endpoint: string;
|
|
55
65
|
/**
|
|
56
66
|
* Headers sent with each export request. Names are returned in canonical form
|
|
57
|
-
* (`Authorization`, not `authorization`).
|
|
58
|
-
* strings, so the keys are visible but the credentials are not.
|
|
67
|
+
* (`Authorization`, not `authorization`). Non-dashboard reads return values
|
|
68
|
+
* redacted as empty strings, so the keys are visible but the credentials are not.
|
|
69
|
+
* Dashboard reads return the stored values.
|
|
59
70
|
*/
|
|
60
71
|
headers: {
|
|
61
72
|
[key: string]: string;
|
|
62
73
|
};
|
|
63
74
|
/**
|
|
64
|
-
* Unique within the
|
|
75
|
+
* Unique within the organization. Usable in place of the ID when selecting a
|
|
65
76
|
* destination, so it cannot be shaped like an ID.
|
|
66
77
|
*/
|
|
67
78
|
name: string;
|
|
@@ -84,7 +95,7 @@ export interface DestinationCreateParams {
|
|
|
84
95
|
*/
|
|
85
96
|
endpoint: string;
|
|
86
97
|
/**
|
|
87
|
-
* Unique within the
|
|
98
|
+
* Unique within the organization.
|
|
88
99
|
*/
|
|
89
100
|
name: string;
|
|
90
101
|
description?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"destinations.d.mts","sourceRoot":"","sources":["../../src/resources/telemetry/destinations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,kCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"destinations.d.mts","sourceRoot":"","sources":["../../src/resources/telemetry/destinations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,kCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI5F;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,eAAe,CAAC;IAOjE;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMrE;AAED,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -7,12 +7,16 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class Destinations extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Create an OTLP export destination in the
|
|
11
|
-
* within the
|
|
10
|
+
* Create an OTLP export destination in the authenticated organization. Names must
|
|
11
|
+
* be unique within the organization. Requires an organization-scoped credential or
|
|
12
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
12
13
|
*/
|
|
13
14
|
create(body: DestinationCreateParams, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
14
15
|
/**
|
|
15
|
-
* Retrieve a
|
|
16
|
+
* Retrieve a customer-visible OTLP destination in the authenticated organization
|
|
17
|
+
* by its ID or name. Project-scoped credentials can retrieve these destinations
|
|
18
|
+
* for selection by workloads in their project. Non-dashboard reads return header
|
|
19
|
+
* values redacted.
|
|
16
20
|
*/
|
|
17
21
|
retrieve(idOrName: string, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
18
22
|
/**
|
|
@@ -20,14 +24,18 @@ export declare class Destinations extends APIResource {
|
|
|
20
24
|
* values without restarting, which makes this the way to rotate credentials
|
|
21
25
|
* without interrupting export.
|
|
22
26
|
*
|
|
23
|
-
* Names must be unique within the
|
|
24
|
-
* managed auth connection selects this destination by name, since that
|
|
25
|
-
* resolves the name on every login. Every other field, including
|
|
26
|
-
* editable.
|
|
27
|
+
* Names must be unique within the organization. Renaming is refused with a 409
|
|
28
|
+
* while a managed auth connection selects this destination by name, since that
|
|
29
|
+
* connection resolves the name on every login. Every other field, including
|
|
30
|
+
* `headers`, stays editable. Requires an organization-scoped credential or
|
|
31
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
27
32
|
*/
|
|
28
33
|
update(idOrName: string, body: DestinationUpdateParams, options?: RequestOptions): APIPromise<OtlpDestination>;
|
|
29
34
|
/**
|
|
30
|
-
* List OTLP export destinations in the
|
|
35
|
+
* List customer-visible OTLP export destinations in the authenticated
|
|
36
|
+
* organization. Project-scoped credentials can list these destinations for
|
|
37
|
+
* selection by workloads in their project. Non-dashboard reads return header
|
|
38
|
+
* values redacted.
|
|
31
39
|
*/
|
|
32
40
|
list(query?: DestinationListParams | null | undefined, options?: RequestOptions): PagePromise<OtlpDestinationsOffsetPagination, OtlpDestination>;
|
|
33
41
|
/**
|
|
@@ -36,6 +44,8 @@ export declare class Destinations extends APIResource {
|
|
|
36
44
|
* end or delete them first. It is refused the same way while a managed auth
|
|
37
45
|
* connection still selects it, because that connection re-resolves the destination
|
|
38
46
|
* on every login, and while a managed auth login using it is still in progress.
|
|
47
|
+
* Requires an organization-scoped credential or dashboard authentication;
|
|
48
|
+
* project-scoped credentials receive a 403.
|
|
39
49
|
*/
|
|
40
50
|
delete(idOrName: string, options?: RequestOptions): APIPromise<void>;
|
|
41
51
|
}
|
|
@@ -54,14 +64,15 @@ export interface OtlpDestination {
|
|
|
54
64
|
endpoint: string;
|
|
55
65
|
/**
|
|
56
66
|
* Headers sent with each export request. Names are returned in canonical form
|
|
57
|
-
* (`Authorization`, not `authorization`).
|
|
58
|
-
* strings, so the keys are visible but the credentials are not.
|
|
67
|
+
* (`Authorization`, not `authorization`). Non-dashboard reads return values
|
|
68
|
+
* redacted as empty strings, so the keys are visible but the credentials are not.
|
|
69
|
+
* Dashboard reads return the stored values.
|
|
59
70
|
*/
|
|
60
71
|
headers: {
|
|
61
72
|
[key: string]: string;
|
|
62
73
|
};
|
|
63
74
|
/**
|
|
64
|
-
* Unique within the
|
|
75
|
+
* Unique within the organization. Usable in place of the ID when selecting a
|
|
65
76
|
* destination, so it cannot be shaped like an ID.
|
|
66
77
|
*/
|
|
67
78
|
name: string;
|
|
@@ -84,7 +95,7 @@ export interface DestinationCreateParams {
|
|
|
84
95
|
*/
|
|
85
96
|
endpoint: string;
|
|
86
97
|
/**
|
|
87
|
-
* Unique within the
|
|
98
|
+
* Unique within the organization.
|
|
88
99
|
*/
|
|
89
100
|
name: string;
|
|
90
101
|
description?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"destinations.d.ts","sourceRoot":"","sources":["../../src/resources/telemetry/destinations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"destinations.d.ts","sourceRoot":"","sources":["../../src/resources/telemetry/destinations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,iCAA8B;AAEnG,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI5F;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,eAAe,CAAC;IAOjE;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMrE;AAED,MAAM,MAAM,gCAAgC,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -11,14 +11,18 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
11
11
|
*/
|
|
12
12
|
class Destinations extends resource_1.APIResource {
|
|
13
13
|
/**
|
|
14
|
-
* Create an OTLP export destination in the
|
|
15
|
-
* within the
|
|
14
|
+
* Create an OTLP export destination in the authenticated organization. Names must
|
|
15
|
+
* be unique within the organization. Requires an organization-scoped credential or
|
|
16
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
16
17
|
*/
|
|
17
18
|
create(body, options) {
|
|
18
19
|
return this._client.post('/telemetry/destinations', { body, ...options });
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
21
|
-
* Retrieve a
|
|
22
|
+
* Retrieve a customer-visible OTLP destination in the authenticated organization
|
|
23
|
+
* by its ID or name. Project-scoped credentials can retrieve these destinations
|
|
24
|
+
* for selection by workloads in their project. Non-dashboard reads return header
|
|
25
|
+
* values redacted.
|
|
22
26
|
*/
|
|
23
27
|
retrieve(idOrName, options) {
|
|
24
28
|
return this._client.get((0, path_1.path) `/telemetry/destinations/${idOrName}`, options);
|
|
@@ -28,16 +32,20 @@ class Destinations extends resource_1.APIResource {
|
|
|
28
32
|
* values without restarting, which makes this the way to rotate credentials
|
|
29
33
|
* without interrupting export.
|
|
30
34
|
*
|
|
31
|
-
* Names must be unique within the
|
|
32
|
-
* managed auth connection selects this destination by name, since that
|
|
33
|
-
* resolves the name on every login. Every other field, including
|
|
34
|
-
* editable.
|
|
35
|
+
* Names must be unique within the organization. Renaming is refused with a 409
|
|
36
|
+
* while a managed auth connection selects this destination by name, since that
|
|
37
|
+
* connection resolves the name on every login. Every other field, including
|
|
38
|
+
* `headers`, stays editable. Requires an organization-scoped credential or
|
|
39
|
+
* dashboard authentication; project-scoped credentials receive a 403.
|
|
35
40
|
*/
|
|
36
41
|
update(idOrName, body, options) {
|
|
37
42
|
return this._client.patch((0, path_1.path) `/telemetry/destinations/${idOrName}`, { body, ...options });
|
|
38
43
|
}
|
|
39
44
|
/**
|
|
40
|
-
* List OTLP export destinations in the
|
|
45
|
+
* List customer-visible OTLP export destinations in the authenticated
|
|
46
|
+
* organization. Project-scoped credentials can list these destinations for
|
|
47
|
+
* selection by workloads in their project. Non-dashboard reads return header
|
|
48
|
+
* values redacted.
|
|
41
49
|
*/
|
|
42
50
|
list(query = {}, options) {
|
|
43
51
|
return this._client.getAPIList('/telemetry/destinations', (pagination_1.OffsetPagination), {
|
|
@@ -51,6 +59,8 @@ class Destinations extends resource_1.APIResource {
|
|
|
51
59
|
* end or delete them first. It is refused the same way while a managed auth
|
|
52
60
|
* connection still selects it, because that connection re-resolves the destination
|
|
53
61
|
* on every login, and while a managed auth login using it is still in progress.
|
|
62
|
+
* Requires an organization-scoped credential or dashboard authentication;
|
|
63
|
+
* project-scoped credentials receive a 403.
|
|
54
64
|
*/
|
|
55
65
|
delete(idOrName, options) {
|
|
56
66
|
return this._client.delete((0, path_1.path) `/telemetry/destinations/${idOrName}`, {
|