webdaemon 36.2.0 → 36.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/dist/index.js +27 -27
- package/dist/index.js.map +3 -3
- package/dist/types/ts/GenerativeChatAgent.d.ts +17 -0
- package/dist/types/ts/GenerativeChatAgent.d.ts.map +1 -1
- package/dist/types/ts/McpClient.d.ts +4 -1
- package/dist/types/ts/McpClient.d.ts.map +1 -1
- package/dist/types/ts/McpServer.d.ts +0 -6
- package/dist/types/ts/McpServer.d.ts.map +1 -1
- package/dist/types/ts/Requests.d.ts +36 -0
- package/dist/types/ts/Requests.d.ts.map +1 -1
- package/dist/types/ts/Responses.d.ts +27 -0
- package/dist/types/ts/Responses.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -25,6 +25,21 @@ export interface GenerativeChatAgentOptions {
|
|
|
25
25
|
defaultTemperature?: number;
|
|
26
26
|
/** Initial value for the extended-thinking setting. Defaults to false. */
|
|
27
27
|
defaultThinking?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Initial value for the reasoning-effort setting: how deeply a model that
|
|
30
|
+
* decides its own reasoning depth should think (`low`, `medium`, `high`,
|
|
31
|
+
* `xhigh` or `max`). Undefined leaves the choice to the platform's tuning for
|
|
32
|
+
* the chat's model, and the setting is inert for a model that reasons to a
|
|
33
|
+
* fixed budget.
|
|
34
|
+
*/
|
|
35
|
+
defaultEffort?: ChatEffort;
|
|
36
|
+
/**
|
|
37
|
+
* Initial value for the output-allowance setting: the most tokens a turn may
|
|
38
|
+
* produce, reasoning included. Undefined leaves the platform's per-model
|
|
39
|
+
* ceiling in place, which is the usual choice — raise it only for a chat whose
|
|
40
|
+
* answers are genuinely long, or alongside a high {@link defaultEffort}.
|
|
41
|
+
*/
|
|
42
|
+
defaultMaxTokens?: number;
|
|
28
43
|
/**
|
|
29
44
|
* Model id every chat this agent creates is pinned to, unless a per-session
|
|
30
45
|
* `model` is supplied (e.g. by the browser at chat creation). Undefined keeps
|
|
@@ -70,6 +85,8 @@ type Principal = {
|
|
|
70
85
|
sub: string;
|
|
71
86
|
src: string;
|
|
72
87
|
};
|
|
88
|
+
/** Reasoning depth for a model that decides how much to think for itself. */
|
|
89
|
+
export type ChatEffort = 'low' | 'medium' | 'high' | 'xhigh' | 'max';
|
|
73
90
|
export interface GenerativeChatConversationResult {
|
|
74
91
|
events: GenerativeChatRenderEvent[];
|
|
75
92
|
clientToolCalls?: ChatToolCall[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GenerativeChatAgent.d.ts","sourceRoot":"","sources":["../../../ts/GenerativeChatAgent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAGL,KAAK,YAAY,EAMlB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAGL,KAAK,UAAU,EAIhB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAIL,KAAK,yBAAyB,EAM/B,MAAM,2BAA2B,CAAA;AAKlC,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAO5D;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,gBAAgB,EAAE,GAAG,SAAS,CAAC,CAAA;IAC5C;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,CACvB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAClC;;;;;OAKG;IACH,gCAAgC,CAAC,EAAE,CACjC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;CACnC;AAED;;;GAGG;AACH,UAAU,cAAc;IAItB,GAAG,EAAE,SAAS,EAAE,CAAA;IAKhB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,KAAK,SAAS,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"GenerativeChatAgent.d.ts","sourceRoot":"","sources":["../../../ts/GenerativeChatAgent.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAGL,KAAK,YAAY,EAMlB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAGL,KAAK,UAAU,EAIhB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAIL,KAAK,yBAAyB,EAM/B,MAAM,2BAA2B,CAAA;AAKlC,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAO5D;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,UAAU,CAAA;IAC1B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,gBAAgB,EAAE,GAAG,SAAS,CAAC,CAAA;IAC5C;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,CACvB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAClC;;;;;OAKG;IACH,gCAAgC,CAAC,EAAE,CACjC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,KACpB,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;CACnC;AAED;;;GAGG;AACH,UAAU,cAAc;IAItB,GAAG,EAAE,SAAS,EAAE,CAAA;IAKhB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,KAAK,SAAS,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;AAc7C,6EAA6E;AAC7E,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAA;AAuBpE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,yBAAyB,EAAE,CAAA;IACnC,eAAe,CAAC,EAAE,YAAY,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,qBAAa,mBAAmB;;gBAyBlB,OAAO,EAAE,0BAA0B;IAiCzC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6H5C,SAAS,CACb,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAmG9B;;;;;;;OAOG;IACG,qBAAqB,CACzB,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,GAAG,IAAI,GAC5B,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC;CA+hCvD"}
|
|
@@ -65,7 +65,10 @@ export declare function mcpToolErrorMessage(result: unknown): string;
|
|
|
65
65
|
* `text/event-stream` (MCP streamable HTTP) — the first SSE `message` event
|
|
66
66
|
* holding a response (`result` or `error`). Keepalive comments and
|
|
67
67
|
* notifications such as `notifications/progress` are skipped. Throws when the
|
|
68
|
-
* stream ends without a response
|
|
68
|
+
* stream ends without a response — naming the URL, the elapsed time and the
|
|
69
|
+
* frame count — or, when the body is neither SSE nor valid JSON, as with a
|
|
70
|
+
* reverse proxy's HTML error page, an error naming the URL, status and a
|
|
71
|
+
* snippet of the body.
|
|
69
72
|
*/
|
|
70
73
|
export declare function readJsonRpcResponse(response: Response): Promise<JSONRecord>;
|
|
71
74
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"McpClient.d.ts","sourceRoot":"","sources":["../../../ts/McpClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEhD,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEzC,yEAAyE;AACzE,eAAO,MAAM,UAAU,wCAAwC,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAChD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA;IAClE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAgB;;gBAIf,OAAO,EAAE,uBAAuB;IAwB5C,yEAAyE;IACnE,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAMvC;;;;OAIG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,UAAe,GACpB,OAAO,CAAC,SAAS,CAAC;CA6BtB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAO3D;
|
|
1
|
+
{"version":3,"file":"McpClient.d.ts","sourceRoot":"","sources":["../../../ts/McpClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAEhD,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEzC,yEAAyE;AACzE,eAAO,MAAM,UAAU,wCAAwC,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAChD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA;IAClE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAgB;;gBAIf,OAAO,EAAE,uBAAuB;IAwB5C,yEAAyE;IACnE,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAMvC;;;;OAIG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,UAAe,GACpB,OAAO,CAAC,SAAS,CAAC;CA6BtB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAO3D;AAgBD;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,UAAU,CAAC,CAsDrB"}
|
|
@@ -18,12 +18,6 @@
|
|
|
18
18
|
* ```
|
|
19
19
|
*/
|
|
20
20
|
import type { JSONObject, JSONValue } from './Assertions.ts';
|
|
21
|
-
/**
|
|
22
|
-
* Interval between SSE keepalive comments while a streamed request (typically
|
|
23
|
-
* a long tools/call) is still running. Short enough to hold typical client
|
|
24
|
-
* and tunnel idle timeouts open.
|
|
25
|
-
*/
|
|
26
|
-
export declare const SSE_KEEPALIVE_INTERVAL_MS = 15000;
|
|
27
21
|
/** The `arguments` object of a `tools/call` request, as sent by the client. */
|
|
28
22
|
export type McpToolArguments = Record<string, unknown>;
|
|
29
23
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"McpServer.d.ts","sourceRoot":"","sources":["../../../ts/McpServer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;
|
|
1
|
+
{"version":3,"file":"McpServer.d.ts","sourceRoot":"","sources":["../../../ts/McpServer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAa5D,+EAA+E;AAC/E,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEtD;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,UAAU;IAC5D,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,SAAS,CAAA;IACtB,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,CACJ,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,QAAQ,KACd,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAAA;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,QAAQ,SAAS,UAAU;IAC1D,0EAA0E;IAC1E,SAAS,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,CAAA;IACjE;;;;OAIG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,SAAS,CAAC,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;AAOD,MAAM,WAAW,uBAAuB,CAAC,QAAQ,SAAS,UAAU;IAClE;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,aAAa,CAAC,CAAA;IAClE,uEAAuE;IACvE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,QAAQ,CAAA;IACvC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,qBAAa,eAAe,CAAC,QAAQ,SAAS,UAAU,CACtD,YAAW,eAAe,CAAC,QAAQ,CAAC;;gBAGxB,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE;IAIhD,SAAS,IAAI,SAAS,EAAE;IAelB,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,SAAS,CAAC;CAOtB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAgB,CAAC,QAAQ,SAAS,UAAU,GAAG,UAAU;;gBAOlE,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,EAChC,gBAAgB,EACZ,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,QAAQ,CAAC,GAChC,uBAAuB,CAAC,QAAQ,CAAC;IAiBvC;;;;;OAKG;IACG,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;CA6HlD;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,IAAI,EAAE,MAAM,CAAA;gBAEA,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAI1C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,iBAAiB,EAAE,SAAS,EAC5B,OAAO,UAAQ,GACd,SAAS,CAaX"}
|
|
@@ -75,4 +75,40 @@ export declare function getCookie(request: Request, cookieName: string): string
|
|
|
75
75
|
* @returns {Plain} the plain object with zero or more cookie keys.
|
|
76
76
|
*/
|
|
77
77
|
export declare function getCookies(request: Request): Plain;
|
|
78
|
+
/**
|
|
79
|
+
* Whether the client accepts Server-Sent Events, i.e. its `Accept` header
|
|
80
|
+
* includes `text/event-stream`. This is the MCP streamable-HTTP trigger, where
|
|
81
|
+
* the streamed frames are JSON-RPC envelopes every MCP client understands.
|
|
82
|
+
*
|
|
83
|
+
* A platform route streams its own `{ok}`/`{error}` envelope instead, which is
|
|
84
|
+
* not a shape an `Accept` header promises to handle — gate those on
|
|
85
|
+
* {@link wantsKeepaliveStream}, never on this.
|
|
86
|
+
*
|
|
87
|
+
* @param request the request.
|
|
88
|
+
* @returns true when SSE is acceptable to the client.
|
|
89
|
+
*/
|
|
90
|
+
export declare function acceptsEventStream(request: Request): boolean;
|
|
91
|
+
/**
|
|
92
|
+
* Header by which a client declares it can read a platform route's keepalive
|
|
93
|
+
* SSE stream: the route's ordinary `{ok}`/`{error}` envelope delivered as a
|
|
94
|
+
* `message` event after keepalive comments (see `responseSse`).
|
|
95
|
+
*
|
|
96
|
+
* It exists because `Accept: text/event-stream` cannot carry this meaning. An
|
|
97
|
+
* agent sends that header on every platform post so a *tool* call can stream,
|
|
98
|
+
* and agent builds exist that send it while parsing only JSON-RPC-shaped
|
|
99
|
+
* frames — they would silently drop a streamed platform envelope. Apps also pin
|
|
100
|
+
* a versioned library URL, so those builds never update. An explicit opt-in
|
|
101
|
+
* keeps every one of them on the plain JSON response.
|
|
102
|
+
*/
|
|
103
|
+
export declare const STREAM_HEADER = "x-tabserver-stream";
|
|
104
|
+
/** Value of {@link STREAM_HEADER} requesting a keepalive SSE stream. */
|
|
105
|
+
export declare const STREAM_SSE = "sse";
|
|
106
|
+
/**
|
|
107
|
+
* Whether the client declared it can read a keepalive SSE stream from a
|
|
108
|
+
* platform route (see {@link STREAM_HEADER}).
|
|
109
|
+
*
|
|
110
|
+
* @param request the request.
|
|
111
|
+
* @returns true when the route should stream rather than answer plain JSON.
|
|
112
|
+
*/
|
|
113
|
+
export declare function wantsKeepaliveStream(request: Request): boolean;
|
|
78
114
|
//# sourceMappingURL=Requests.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Requests.d.ts","sourceRoot":"","sources":["../../../ts/Requests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AASxC;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMtD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM1D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAKrD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAMlD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM7E;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK,CAUlD"}
|
|
1
|
+
{"version":3,"file":"Requests.d.ts","sourceRoot":"","sources":["../../../ts/Requests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AASxC;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMtD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM1D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAKrD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAMlD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGpD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM7E;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK,CAUlD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAI5D;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,uBAAuB,CAAA;AAEjD,wEAAwE;AACxE,eAAO,MAAM,UAAU,QAAQ,CAAA;AAE/B;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE9D"}
|
|
@@ -20,6 +20,33 @@ export interface Error {
|
|
|
20
20
|
* is sent as {error: 'Authentication Error'} with status 401
|
|
21
21
|
*/
|
|
22
22
|
export declare function response<T>(rvalue: Ok<T> | Error, extraHeaders?: Plain): Response;
|
|
23
|
+
/**
|
|
24
|
+
* Milliseconds between SSE keepalives on a streamed response. Short enough to
|
|
25
|
+
* hold typical client, reverse-proxy and tunnel idle timeouts open.
|
|
26
|
+
*/
|
|
27
|
+
export declare const SSE_KEEPALIVE_INTERVAL_MS = 15000;
|
|
28
|
+
export interface SseOptions {
|
|
29
|
+
/** Milliseconds between keepalives; defaults to {@link SSE_KEEPALIVE_INTERVAL_MS}. */
|
|
30
|
+
keepaliveIntervalMs?: number;
|
|
31
|
+
/**
|
|
32
|
+
* Builds the keepalive frame for tick `ticks` (1-based). Defaults to a bare
|
|
33
|
+
* SSE comment; a caller with a progress channel can send a real event.
|
|
34
|
+
*/
|
|
35
|
+
keepalive?: (ticks: number) => string;
|
|
36
|
+
extraHeaders?: Plain;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Streams one JSON value as Server-Sent Events: keepalives every
|
|
40
|
+
* `keepaliveIntervalMs` while `pending` is unresolved, then the value as a
|
|
41
|
+
* single `message` event, then end of stream. Headers defeat proxy buffering
|
|
42
|
+
* (`X-Accel-Buffering: no`), so an intermediary cannot hold the stream and
|
|
43
|
+
* time the request out while a long handler runs.
|
|
44
|
+
*
|
|
45
|
+
* `pending` should resolve to its own error envelope rather than rejecting;
|
|
46
|
+
* a rejection is emitted as `{error}` as a last resort. Client disconnects
|
|
47
|
+
* cancel the keepalive and drop the late value.
|
|
48
|
+
*/
|
|
49
|
+
export declare function responseSse(pending: Promise<unknown>, options?: SseOptions): Response;
|
|
23
50
|
/**
|
|
24
51
|
* Returns a 404 error response, including
|
|
25
52
|
* the standard JSON error return value.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Responses.d.ts","sourceRoot":"","sources":["../../../ts/Responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAEvC,MAAM,WAAW,EAAE,CAAC,CAAC;IACnB,EAAE,EAAE,CAAC,CAAA;CACN;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,EAAE,KAAK,YA2BtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,IAAI,GAAE,KAEpC,YASA;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,YAAY,GAAE,KAAU,GAAG,QAAQ,CAQ9D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,GAAE,KAAU,GAAG,QAAQ,CASxE;AAED;;;;;;GAMG;AAEH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,IAAI,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,wBAAgB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,CAuBhE"}
|
|
1
|
+
{"version":3,"file":"Responses.d.ts","sourceRoot":"","sources":["../../../ts/Responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAEvC,MAAM,WAAW,EAAE,CAAC,CAAC;IACnB,EAAE,EAAE,CAAC,CAAA;CACN;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,EAAE,KAAK,YA2BtE;AAED;;;GAGG;AACH,eAAO,MAAM,yBAAyB,QAAS,CAAA;AAE/C,MAAM,WAAW,UAAU;IACzB,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IACrC,YAAY,CAAC,EAAE,KAAK,CAAA;CACrB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EACzB,OAAO,GAAE,UAAe,GACvB,QAAQ,CAqDV;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,IAAI,GAAE,KAEpC,YASA;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,YAAY,GAAE,KAAU,GAAG,QAAQ,CAQ9D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,GAAE,KAAU,GAAG,QAAQ,CASxE;AAED;;;;;;GAMG;AAEH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,IAAI,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,wBAAgB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,CAuBhE"}
|