@quiverai/sdk 0.1.3 → 0.1.5

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.
Files changed (185) hide show
  1. package/README.md +8 -11
  2. package/_speakeasy/.github/action-inputs-config.json +53 -0
  3. package/_speakeasy/.github/action-security-config.json +88 -0
  4. package/dist/commonjs/funcs/modelsListModels.js +1 -1
  5. package/dist/commonjs/funcs/modelsRetrieveModel.js +1 -1
  6. package/dist/commonjs/funcs/svgCheckVectorizability.js +1 -1
  7. package/dist/commonjs/funcs/svgCreateSVGAnimation.js +1 -1
  8. package/dist/commonjs/funcs/svgCreateSVGCollection.js +1 -1
  9. package/dist/commonjs/funcs/svgCreateSVGEdit.js +1 -1
  10. package/dist/commonjs/funcs/svgCreateSVGGeneration.js +1 -1
  11. package/dist/commonjs/funcs/svgCreateSVGVectorization.js +1 -1
  12. package/dist/commonjs/lib/config.d.ts +3 -3
  13. package/dist/commonjs/lib/config.js +3 -3
  14. package/dist/commonjs/lib/config.js.map +1 -1
  15. package/dist/esm/funcs/modelsListModels.js +1 -1
  16. package/dist/esm/funcs/modelsRetrieveModel.js +1 -1
  17. package/dist/esm/funcs/svgCheckVectorizability.js +1 -1
  18. package/dist/esm/funcs/svgCreateSVGAnimation.js +1 -1
  19. package/dist/esm/funcs/svgCreateSVGCollection.js +1 -1
  20. package/dist/esm/funcs/svgCreateSVGEdit.js +1 -1
  21. package/dist/esm/funcs/svgCreateSVGGeneration.js +1 -1
  22. package/dist/esm/funcs/svgCreateSVGVectorization.js +1 -1
  23. package/dist/esm/lib/config.d.ts +3 -3
  24. package/dist/esm/lib/config.js +3 -3
  25. package/dist/esm/lib/config.js.map +1 -1
  26. package/examples/package-lock.json +611 -0
  27. package/jsr.json +1 -1
  28. package/package.json +5 -1
  29. package/src/funcs/modelsListModels.ts +1 -1
  30. package/src/funcs/modelsRetrieveModel.ts +1 -1
  31. package/src/funcs/svgCheckVectorizability.ts +1 -1
  32. package/src/funcs/svgCreateSVGAnimation.ts +1 -1
  33. package/src/funcs/svgCreateSVGCollection.ts +1 -1
  34. package/src/funcs/svgCreateSVGEdit.ts +1 -1
  35. package/src/funcs/svgCreateSVGGeneration.ts +1 -1
  36. package/src/funcs/svgCreateSVGVectorization.ts +1 -1
  37. package/src/lib/config.ts +3 -3
  38. package/.speakeasy/temp/reformatted4022478357.json +0 -3500
  39. package/.speakeasy/temp/registry_9588e5.json +0 -1
  40. package/examples/node_modules/.package-lock.json +0 -161
  41. package/examples/node_modules/@esbuild/darwin-arm64/package.json +0 -20
  42. package/examples/node_modules/@types/node/assert/strict.d.ts +0 -8
  43. package/examples/node_modules/@types/node/assert.d.ts +0 -1062
  44. package/examples/node_modules/@types/node/async_hooks.d.ts +0 -605
  45. package/examples/node_modules/@types/node/buffer.buffer.d.ts +0 -471
  46. package/examples/node_modules/@types/node/buffer.d.ts +0 -1936
  47. package/examples/node_modules/@types/node/child_process.d.ts +0 -1475
  48. package/examples/node_modules/@types/node/cluster.d.ts +0 -577
  49. package/examples/node_modules/@types/node/compatibility/disposable.d.ts +0 -16
  50. package/examples/node_modules/@types/node/compatibility/index.d.ts +0 -9
  51. package/examples/node_modules/@types/node/compatibility/indexable.d.ts +0 -20
  52. package/examples/node_modules/@types/node/compatibility/iterators.d.ts +0 -21
  53. package/examples/node_modules/@types/node/console.d.ts +0 -452
  54. package/examples/node_modules/@types/node/constants.d.ts +0 -21
  55. package/examples/node_modules/@types/node/crypto.d.ts +0 -4590
  56. package/examples/node_modules/@types/node/dgram.d.ts +0 -597
  57. package/examples/node_modules/@types/node/diagnostics_channel.d.ts +0 -578
  58. package/examples/node_modules/@types/node/dns/promises.d.ts +0 -479
  59. package/examples/node_modules/@types/node/dns.d.ts +0 -871
  60. package/examples/node_modules/@types/node/domain.d.ts +0 -170
  61. package/examples/node_modules/@types/node/events.d.ts +0 -977
  62. package/examples/node_modules/@types/node/fs/promises.d.ts +0 -1270
  63. package/examples/node_modules/@types/node/fs.d.ts +0 -4375
  64. package/examples/node_modules/@types/node/globals.d.ts +0 -172
  65. package/examples/node_modules/@types/node/globals.typedarray.d.ts +0 -38
  66. package/examples/node_modules/@types/node/http.d.ts +0 -2049
  67. package/examples/node_modules/@types/node/http2.d.ts +0 -2631
  68. package/examples/node_modules/@types/node/https.d.ts +0 -578
  69. package/examples/node_modules/@types/node/index.d.ts +0 -93
  70. package/examples/node_modules/@types/node/inspector.generated.d.ts +0 -3966
  71. package/examples/node_modules/@types/node/module.d.ts +0 -539
  72. package/examples/node_modules/@types/node/net.d.ts +0 -1012
  73. package/examples/node_modules/@types/node/os.d.ts +0 -506
  74. package/examples/node_modules/@types/node/package.json +0 -140
  75. package/examples/node_modules/@types/node/path.d.ts +0 -200
  76. package/examples/node_modules/@types/node/perf_hooks.d.ts +0 -961
  77. package/examples/node_modules/@types/node/process.d.ts +0 -1957
  78. package/examples/node_modules/@types/node/punycode.d.ts +0 -117
  79. package/examples/node_modules/@types/node/querystring.d.ts +0 -152
  80. package/examples/node_modules/@types/node/readline/promises.d.ts +0 -162
  81. package/examples/node_modules/@types/node/readline.d.ts +0 -589
  82. package/examples/node_modules/@types/node/repl.d.ts +0 -430
  83. package/examples/node_modules/@types/node/sea.d.ts +0 -153
  84. package/examples/node_modules/@types/node/stream/consumers.d.ts +0 -38
  85. package/examples/node_modules/@types/node/stream/promises.d.ts +0 -90
  86. package/examples/node_modules/@types/node/stream/web.d.ts +0 -533
  87. package/examples/node_modules/@types/node/stream.d.ts +0 -1675
  88. package/examples/node_modules/@types/node/string_decoder.d.ts +0 -67
  89. package/examples/node_modules/@types/node/test.d.ts +0 -1787
  90. package/examples/node_modules/@types/node/timers/promises.d.ts +0 -108
  91. package/examples/node_modules/@types/node/timers.d.ts +0 -286
  92. package/examples/node_modules/@types/node/tls.d.ts +0 -1255
  93. package/examples/node_modules/@types/node/trace_events.d.ts +0 -197
  94. package/examples/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +0 -468
  95. package/examples/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +0 -34
  96. package/examples/node_modules/@types/node/ts5.6/index.d.ts +0 -93
  97. package/examples/node_modules/@types/node/tty.d.ts +0 -208
  98. package/examples/node_modules/@types/node/url.d.ts +0 -964
  99. package/examples/node_modules/@types/node/util.d.ts +0 -2331
  100. package/examples/node_modules/@types/node/v8.d.ts +0 -809
  101. package/examples/node_modules/@types/node/vm.d.ts +0 -1001
  102. package/examples/node_modules/@types/node/wasi.d.ts +0 -181
  103. package/examples/node_modules/@types/node/web-globals/abortcontroller.d.ts +0 -34
  104. package/examples/node_modules/@types/node/web-globals/domexception.d.ts +0 -68
  105. package/examples/node_modules/@types/node/web-globals/events.d.ts +0 -97
  106. package/examples/node_modules/@types/node/web-globals/fetch.d.ts +0 -46
  107. package/examples/node_modules/@types/node/worker_threads.d.ts +0 -715
  108. package/examples/node_modules/@types/node/zlib.d.ts +0 -540
  109. package/examples/node_modules/dotenv/config.d.ts +0 -1
  110. package/examples/node_modules/dotenv/config.js +0 -9
  111. package/examples/node_modules/dotenv/lib/cli-options.js +0 -17
  112. package/examples/node_modules/dotenv/lib/env-options.js +0 -28
  113. package/examples/node_modules/dotenv/lib/main.d.ts +0 -162
  114. package/examples/node_modules/dotenv/lib/main.js +0 -386
  115. package/examples/node_modules/dotenv/package.json +0 -62
  116. package/examples/node_modules/esbuild/install.js +0 -289
  117. package/examples/node_modules/esbuild/lib/main.d.ts +0 -716
  118. package/examples/node_modules/esbuild/lib/main.js +0 -2242
  119. package/examples/node_modules/esbuild/package.json +0 -49
  120. package/examples/node_modules/get-tsconfig/dist/index.mjs +0 -7
  121. package/examples/node_modules/get-tsconfig/package.json +0 -46
  122. package/examples/node_modules/resolve-pkg-maps/dist/index.mjs +0 -1
  123. package/examples/node_modules/resolve-pkg-maps/package.json +0 -42
  124. package/examples/node_modules/tsx/dist/cjs/api/index.mjs +0 -1
  125. package/examples/node_modules/tsx/dist/cjs/index.mjs +0 -1
  126. package/examples/node_modules/tsx/dist/cli.mjs +0 -55
  127. package/examples/node_modules/tsx/dist/client-BQVF1NaW.mjs +0 -1
  128. package/examples/node_modules/tsx/dist/esm/api/index.mjs +0 -1
  129. package/examples/node_modules/tsx/dist/esm/index.mjs +0 -2
  130. package/examples/node_modules/tsx/dist/get-pipe-path-BHW2eJdv.mjs +0 -1
  131. package/examples/node_modules/tsx/dist/index-7AaEi15b.mjs +0 -14
  132. package/examples/node_modules/tsx/dist/index-gbaejti9.mjs +0 -1
  133. package/examples/node_modules/tsx/dist/lexer-DQCqS3nf.mjs +0 -3
  134. package/examples/node_modules/tsx/dist/loader.mjs +0 -1
  135. package/examples/node_modules/tsx/dist/node-features-_8ZFwP_x.mjs +0 -1
  136. package/examples/node_modules/tsx/dist/package-CeBgXWuR.mjs +0 -1
  137. package/examples/node_modules/tsx/dist/patch-repl.mjs +0 -1
  138. package/examples/node_modules/tsx/dist/preflight.mjs +0 -1
  139. package/examples/node_modules/tsx/dist/register-B7jrtLTO.mjs +0 -1
  140. package/examples/node_modules/tsx/dist/register-CFH5oNdT.mjs +0 -4
  141. package/examples/node_modules/tsx/dist/repl.mjs +0 -3
  142. package/examples/node_modules/tsx/dist/require-DQxpCAr4.mjs +0 -1
  143. package/examples/node_modules/tsx/dist/suppress-warnings.mjs +0 -1
  144. package/examples/node_modules/tsx/dist/temporary-directory-CwHp0_NW.mjs +0 -1
  145. package/examples/node_modules/tsx/dist/types-Cxp8y2TL.d.ts +0 -5
  146. package/examples/node_modules/tsx/package.json +0 -68
  147. package/examples/node_modules/undici-types/agent.d.ts +0 -31
  148. package/examples/node_modules/undici-types/api.d.ts +0 -43
  149. package/examples/node_modules/undici-types/balanced-pool.d.ts +0 -29
  150. package/examples/node_modules/undici-types/cache.d.ts +0 -36
  151. package/examples/node_modules/undici-types/client.d.ts +0 -108
  152. package/examples/node_modules/undici-types/connector.d.ts +0 -34
  153. package/examples/node_modules/undici-types/content-type.d.ts +0 -21
  154. package/examples/node_modules/undici-types/cookies.d.ts +0 -28
  155. package/examples/node_modules/undici-types/diagnostics-channel.d.ts +0 -66
  156. package/examples/node_modules/undici-types/dispatcher.d.ts +0 -256
  157. package/examples/node_modules/undici-types/env-http-proxy-agent.d.ts +0 -21
  158. package/examples/node_modules/undici-types/errors.d.ts +0 -149
  159. package/examples/node_modules/undici-types/eventsource.d.ts +0 -61
  160. package/examples/node_modules/undici-types/fetch.d.ts +0 -209
  161. package/examples/node_modules/undici-types/file.d.ts +0 -39
  162. package/examples/node_modules/undici-types/filereader.d.ts +0 -54
  163. package/examples/node_modules/undici-types/formdata.d.ts +0 -108
  164. package/examples/node_modules/undici-types/global-dispatcher.d.ts +0 -9
  165. package/examples/node_modules/undici-types/global-origin.d.ts +0 -7
  166. package/examples/node_modules/undici-types/handlers.d.ts +0 -15
  167. package/examples/node_modules/undici-types/header.d.ts +0 -4
  168. package/examples/node_modules/undici-types/index.d.ts +0 -71
  169. package/examples/node_modules/undici-types/interceptors.d.ts +0 -17
  170. package/examples/node_modules/undici-types/mock-agent.d.ts +0 -50
  171. package/examples/node_modules/undici-types/mock-client.d.ts +0 -25
  172. package/examples/node_modules/undici-types/mock-errors.d.ts +0 -12
  173. package/examples/node_modules/undici-types/mock-interceptor.d.ts +0 -93
  174. package/examples/node_modules/undici-types/mock-pool.d.ts +0 -25
  175. package/examples/node_modules/undici-types/package.json +0 -55
  176. package/examples/node_modules/undici-types/patch.d.ts +0 -33
  177. package/examples/node_modules/undici-types/pool-stats.d.ts +0 -19
  178. package/examples/node_modules/undici-types/pool.d.ts +0 -39
  179. package/examples/node_modules/undici-types/proxy-agent.d.ts +0 -28
  180. package/examples/node_modules/undici-types/readable.d.ts +0 -65
  181. package/examples/node_modules/undici-types/retry-agent.d.ts +0 -8
  182. package/examples/node_modules/undici-types/retry-handler.d.ts +0 -116
  183. package/examples/node_modules/undici-types/util.d.ts +0 -18
  184. package/examples/node_modules/undici-types/webidl.d.ts +0 -228
  185. package/examples/node_modules/undici-types/websocket.d.ts +0 -150
@@ -1,108 +0,0 @@
1
- import { URL } from 'url'
2
- import { TlsOptions } from 'tls'
3
- import Dispatcher from './dispatcher'
4
- import buildConnector from "./connector";
5
-
6
- type ClientConnectOptions = Omit<Dispatcher.ConnectOptions, "origin">;
7
-
8
- /**
9
- * A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection. Pipelining is disabled by default.
10
- */
11
- export class Client extends Dispatcher {
12
- constructor(url: string | URL, options?: Client.Options);
13
- /** Property to get and set the pipelining factor. */
14
- pipelining: number;
15
- /** `true` after `client.close()` has been called. */
16
- closed: boolean;
17
- /** `true` after `client.destroyed()` has been called or `client.close()` has been called and the client shutdown has completed. */
18
- destroyed: boolean;
19
-
20
- // Override dispatcher APIs.
21
- override connect(
22
- options: ClientConnectOptions
23
- ): Promise<Dispatcher.ConnectData>;
24
- override connect(
25
- options: ClientConnectOptions,
26
- callback: (err: Error | null, data: Dispatcher.ConnectData) => void
27
- ): void;
28
- }
29
-
30
- export declare namespace Client {
31
- export interface OptionsInterceptors {
32
- Client: readonly Dispatcher.DispatchInterceptor[];
33
- }
34
- export interface Options {
35
- /** TODO */
36
- interceptors?: OptionsInterceptors;
37
- /** The maximum length of request headers in bytes. Default: Node.js' `--max-http-header-size` or `16384` (16KiB). */
38
- maxHeaderSize?: number;
39
- /** The amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers (Node 14 and above only). Default: `300e3` milliseconds (300s). */
40
- headersTimeout?: number;
41
- /** @deprecated unsupported socketTimeout, use headersTimeout & bodyTimeout instead */
42
- socketTimeout?: never;
43
- /** @deprecated unsupported requestTimeout, use headersTimeout & bodyTimeout instead */
44
- requestTimeout?: never;
45
- /** TODO */
46
- connectTimeout?: number;
47
- /** The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use `0` to disable it entirely. Default: `300e3` milliseconds (300s). */
48
- bodyTimeout?: number;
49
- /** @deprecated unsupported idleTimeout, use keepAliveTimeout instead */
50
- idleTimeout?: never;
51
- /** @deprecated unsupported keepAlive, use pipelining=0 instead */
52
- keepAlive?: never;
53
- /** the timeout, in milliseconds, after which a socket without active requests will time out. Monitors time between activity on a connected socket. This value may be overridden by *keep-alive* hints from the server. Default: `4e3` milliseconds (4s). */
54
- keepAliveTimeout?: number;
55
- /** @deprecated unsupported maxKeepAliveTimeout, use keepAliveMaxTimeout instead */
56
- maxKeepAliveTimeout?: never;
57
- /** the maximum allowed `idleTimeout`, in milliseconds, when overridden by *keep-alive* hints from the server. Default: `600e3` milliseconds (10min). */
58
- keepAliveMaxTimeout?: number;
59
- /** A number of milliseconds subtracted from server *keep-alive* hints when overriding `idleTimeout` to account for timing inaccuracies caused by e.g. transport latency. Default: `1e3` milliseconds (1s). */
60
- keepAliveTimeoutThreshold?: number;
61
- /** TODO */
62
- socketPath?: string;
63
- /** The amount of concurrent requests to be sent over the single TCP/TLS connection according to [RFC7230](https://tools.ietf.org/html/rfc7230#section-6.3.2). Default: `1`. */
64
- pipelining?: number;
65
- /** @deprecated use the connect option instead */
66
- tls?: never;
67
- /** If `true`, an error is thrown when the request content-length header doesn't match the length of the request body. Default: `true`. */
68
- strictContentLength?: boolean;
69
- /** TODO */
70
- maxCachedSessions?: number;
71
- /** TODO */
72
- maxRedirections?: number;
73
- /** TODO */
74
- connect?: buildConnector.BuildOptions | buildConnector.connector;
75
- /** TODO */
76
- maxRequestsPerClient?: number;
77
- /** TODO */
78
- localAddress?: string;
79
- /** Max response body size in bytes, -1 is disabled */
80
- maxResponseSize?: number;
81
- /** Enables a family autodetection algorithm that loosely implements section 5 of RFC 8305. */
82
- autoSelectFamily?: boolean;
83
- /** The amount of time in milliseconds to wait for a connection attempt to finish before trying the next address when using the `autoSelectFamily` option. */
84
- autoSelectFamilyAttemptTimeout?: number;
85
- /**
86
- * @description Enables support for H2 if the server has assigned bigger priority to it through ALPN negotiation.
87
- * @default false
88
- */
89
- allowH2?: boolean;
90
- /**
91
- * @description Dictates the maximum number of concurrent streams for a single H2 session. It can be overridden by a SETTINGS remote frame.
92
- * @default 100
93
- */
94
- maxConcurrentStreams?: number
95
- }
96
- export interface SocketInfo {
97
- localAddress?: string
98
- localPort?: number
99
- remoteAddress?: string
100
- remotePort?: number
101
- remoteFamily?: string
102
- timeout?: number
103
- bytesWritten?: number
104
- bytesRead?: number
105
- }
106
- }
107
-
108
- export default Client;
@@ -1,34 +0,0 @@
1
- import { TLSSocket, ConnectionOptions } from 'tls'
2
- import { IpcNetConnectOpts, Socket, TcpNetConnectOpts } from 'net'
3
-
4
- export default buildConnector
5
- declare function buildConnector (options?: buildConnector.BuildOptions): buildConnector.connector
6
-
7
- declare namespace buildConnector {
8
- export type BuildOptions = (ConnectionOptions | TcpNetConnectOpts | IpcNetConnectOpts) & {
9
- allowH2?: boolean;
10
- maxCachedSessions?: number | null;
11
- socketPath?: string | null;
12
- timeout?: number | null;
13
- port?: number;
14
- keepAlive?: boolean | null;
15
- keepAliveInitialDelay?: number | null;
16
- }
17
-
18
- export interface Options {
19
- hostname: string
20
- host?: string
21
- protocol: string
22
- port: string
23
- servername?: string
24
- localAddress?: string | null
25
- httpSocket?: Socket
26
- }
27
-
28
- export type Callback = (...args: CallbackArgs) => void
29
- type CallbackArgs = [null, Socket | TLSSocket] | [Error, null]
30
-
31
- export interface connector {
32
- (options: buildConnector.Options, callback: buildConnector.Callback): void
33
- }
34
- }
@@ -1,21 +0,0 @@
1
- /// <reference types="node" />
2
-
3
- interface MIMEType {
4
- type: string
5
- subtype: string
6
- parameters: Map<string, string>
7
- essence: string
8
- }
9
-
10
- /**
11
- * Parse a string to a {@link MIMEType} object. Returns `failure` if the string
12
- * couldn't be parsed.
13
- * @see https://mimesniff.spec.whatwg.org/#parse-a-mime-type
14
- */
15
- export function parseMIMEType (input: string): 'failure' | MIMEType
16
-
17
- /**
18
- * Convert a MIMEType object to a string.
19
- * @see https://mimesniff.spec.whatwg.org/#serialize-a-mime-type
20
- */
21
- export function serializeAMimeType (mimeType: MIMEType): string
@@ -1,28 +0,0 @@
1
- /// <reference types="node" />
2
-
3
- import type { Headers } from './fetch'
4
-
5
- export interface Cookie {
6
- name: string
7
- value: string
8
- expires?: Date | number
9
- maxAge?: number
10
- domain?: string
11
- path?: string
12
- secure?: boolean
13
- httpOnly?: boolean
14
- sameSite?: 'Strict' | 'Lax' | 'None'
15
- unparsed?: string[]
16
- }
17
-
18
- export function deleteCookie (
19
- headers: Headers,
20
- name: string,
21
- attributes?: { name?: string, domain?: string }
22
- ): void
23
-
24
- export function getCookies (headers: Headers): Record<string, string>
25
-
26
- export function getSetCookies (headers: Headers): Cookie[]
27
-
28
- export function setCookie (headers: Headers, cookie: Cookie): void
@@ -1,66 +0,0 @@
1
- import { Socket } from "net";
2
- import { URL } from "url";
3
- import Connector from "./connector";
4
- import Dispatcher from "./dispatcher";
5
-
6
- declare namespace DiagnosticsChannel {
7
- interface Request {
8
- origin?: string | URL;
9
- completed: boolean;
10
- method?: Dispatcher.HttpMethod;
11
- path: string;
12
- headers: any;
13
- }
14
- interface Response {
15
- statusCode: number;
16
- statusText: string;
17
- headers: Array<Buffer>;
18
- }
19
- type Error = unknown;
20
- interface ConnectParams {
21
- host: URL["host"];
22
- hostname: URL["hostname"];
23
- protocol: URL["protocol"];
24
- port: URL["port"];
25
- servername: string | null;
26
- }
27
- type Connector = Connector.connector;
28
- export interface RequestCreateMessage {
29
- request: Request;
30
- }
31
- export interface RequestBodySentMessage {
32
- request: Request;
33
- }
34
- export interface RequestHeadersMessage {
35
- request: Request;
36
- response: Response;
37
- }
38
- export interface RequestTrailersMessage {
39
- request: Request;
40
- trailers: Array<Buffer>;
41
- }
42
- export interface RequestErrorMessage {
43
- request: Request;
44
- error: Error;
45
- }
46
- export interface ClientSendHeadersMessage {
47
- request: Request;
48
- headers: string;
49
- socket: Socket;
50
- }
51
- export interface ClientBeforeConnectMessage {
52
- connectParams: ConnectParams;
53
- connector: Connector;
54
- }
55
- export interface ClientConnectedMessage {
56
- socket: Socket;
57
- connectParams: ConnectParams;
58
- connector: Connector;
59
- }
60
- export interface ClientConnectErrorMessage {
61
- error: Error;
62
- socket: Socket;
63
- connectParams: ConnectParams;
64
- connector: Connector;
65
- }
66
- }
@@ -1,256 +0,0 @@
1
- import { URL } from 'url'
2
- import { Duplex, Readable, Writable } from 'stream'
3
- import { EventEmitter } from 'events'
4
- import { Blob } from 'buffer'
5
- import { IncomingHttpHeaders } from './header'
6
- import BodyReadable from './readable'
7
- import { FormData } from './formdata'
8
- import Errors from './errors'
9
-
10
- type AbortSignal = unknown;
11
-
12
- export default Dispatcher
13
-
14
- /** Dispatcher is the core API used to dispatch requests. */
15
- declare class Dispatcher extends EventEmitter {
16
- /** Dispatches a request. This API is expected to evolve through semver-major versions and is less stable than the preceding higher level APIs. It is primarily intended for library developers who implement higher level APIs on top of this. */
17
- dispatch(options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean;
18
- /** Starts two-way communications with the requested resource. */
19
- connect(options: Dispatcher.ConnectOptions): Promise<Dispatcher.ConnectData>;
20
- connect(options: Dispatcher.ConnectOptions, callback: (err: Error | null, data: Dispatcher.ConnectData) => void): void;
21
- /** Compose a chain of dispatchers */
22
- compose(dispatchers: Dispatcher.DispatcherComposeInterceptor[]): Dispatcher.ComposedDispatcher;
23
- compose(...dispatchers: Dispatcher.DispatcherComposeInterceptor[]): Dispatcher.ComposedDispatcher;
24
- /** Performs an HTTP request. */
25
- request(options: Dispatcher.RequestOptions): Promise<Dispatcher.ResponseData>;
26
- request(options: Dispatcher.RequestOptions, callback: (err: Error | null, data: Dispatcher.ResponseData) => void): void;
27
- /** For easy use with `stream.pipeline`. */
28
- pipeline(options: Dispatcher.PipelineOptions, handler: Dispatcher.PipelineHandler): Duplex;
29
- /** A faster version of `Dispatcher.request`. */
30
- stream(options: Dispatcher.RequestOptions, factory: Dispatcher.StreamFactory): Promise<Dispatcher.StreamData>;
31
- stream(options: Dispatcher.RequestOptions, factory: Dispatcher.StreamFactory, callback: (err: Error | null, data: Dispatcher.StreamData) => void): void;
32
- /** Upgrade to a different protocol. */
33
- upgrade(options: Dispatcher.UpgradeOptions): Promise<Dispatcher.UpgradeData>;
34
- upgrade(options: Dispatcher.UpgradeOptions, callback: (err: Error | null, data: Dispatcher.UpgradeData) => void): void;
35
- /** Closes the client and gracefully waits for enqueued requests to complete before invoking the callback (or returning a promise if no callback is provided). */
36
- close(): Promise<void>;
37
- close(callback: () => void): void;
38
- /** Destroy the client abruptly with the given err. All the pending and running requests will be asynchronously aborted and error. Waits until socket is closed before invoking the callback (or returning a promise if no callback is provided). Since this operation is asynchronously dispatched there might still be some progress on dispatched requests. */
39
- destroy(): Promise<void>;
40
- destroy(err: Error | null): Promise<void>;
41
- destroy(callback: () => void): void;
42
- destroy(err: Error | null, callback: () => void): void;
43
-
44
- on(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
45
- on(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
46
- on(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
47
- on(eventName: 'drain', callback: (origin: URL) => void): this;
48
-
49
-
50
- once(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
51
- once(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
52
- once(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
53
- once(eventName: 'drain', callback: (origin: URL) => void): this;
54
-
55
-
56
- off(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
57
- off(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
58
- off(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
59
- off(eventName: 'drain', callback: (origin: URL) => void): this;
60
-
61
-
62
- addListener(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
63
- addListener(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
64
- addListener(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
65
- addListener(eventName: 'drain', callback: (origin: URL) => void): this;
66
-
67
- removeListener(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
68
- removeListener(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
69
- removeListener(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
70
- removeListener(eventName: 'drain', callback: (origin: URL) => void): this;
71
-
72
- prependListener(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
73
- prependListener(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
74
- prependListener(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
75
- prependListener(eventName: 'drain', callback: (origin: URL) => void): this;
76
-
77
- prependOnceListener(eventName: 'connect', callback: (origin: URL, targets: readonly Dispatcher[]) => void): this;
78
- prependOnceListener(eventName: 'disconnect', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
79
- prependOnceListener(eventName: 'connectionError', callback: (origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void): this;
80
- prependOnceListener(eventName: 'drain', callback: (origin: URL) => void): this;
81
-
82
- listeners(eventName: 'connect'): ((origin: URL, targets: readonly Dispatcher[]) => void)[]
83
- listeners(eventName: 'disconnect'): ((origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void)[];
84
- listeners(eventName: 'connectionError'): ((origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void)[];
85
- listeners(eventName: 'drain'): ((origin: URL) => void)[];
86
-
87
- rawListeners(eventName: 'connect'): ((origin: URL, targets: readonly Dispatcher[]) => void)[]
88
- rawListeners(eventName: 'disconnect'): ((origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void)[];
89
- rawListeners(eventName: 'connectionError'): ((origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError) => void)[];
90
- rawListeners(eventName: 'drain'): ((origin: URL) => void)[];
91
-
92
- emit(eventName: 'connect', origin: URL, targets: readonly Dispatcher[]): boolean;
93
- emit(eventName: 'disconnect', origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError): boolean;
94
- emit(eventName: 'connectionError', origin: URL, targets: readonly Dispatcher[], error: Errors.UndiciError): boolean;
95
- emit(eventName: 'drain', origin: URL): boolean;
96
- }
97
-
98
- declare namespace Dispatcher {
99
- export interface ComposedDispatcher extends Dispatcher {}
100
- export type DispatcherComposeInterceptor = (dispatch: Dispatcher['dispatch']) => Dispatcher['dispatch'];
101
- export interface DispatchOptions {
102
- origin?: string | URL;
103
- path: string;
104
- method: HttpMethod;
105
- /** Default: `null` */
106
- body?: string | Buffer | Uint8Array | Readable | null | FormData;
107
- /** Default: `null` */
108
- headers?: IncomingHttpHeaders | string[] | Iterable<[string, string | string[] | undefined]> | null;
109
- /** Query string params to be embedded in the request URL. Default: `null` */
110
- query?: Record<string, any>;
111
- /** Whether the requests can be safely retried or not. If `false` the request won't be sent until all preceding requests in the pipeline have completed. Default: `true` if `method` is `HEAD` or `GET`. */
112
- idempotent?: boolean;
113
- /** Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to `true` further pipelining will be avoided on the same connection until headers have been received. */
114
- blocking?: boolean;
115
- /** Upgrade the request. Should be used to specify the kind of upgrade i.e. `'Websocket'`. Default: `method === 'CONNECT' || null`. */
116
- upgrade?: boolean | string | null;
117
- /** The amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers. Defaults to 300 seconds. */
118
- headersTimeout?: number | null;
119
- /** The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use 0 to disable it entirely. Defaults to 300 seconds. */
120
- bodyTimeout?: number | null;
121
- /** Whether the request should stablish a keep-alive or not. Default `false` */
122
- reset?: boolean;
123
- /** Whether Undici should throw an error upon receiving a 4xx or 5xx response from the server. Defaults to false */
124
- throwOnError?: boolean;
125
- /** For H2, it appends the expect: 100-continue header, and halts the request body until a 100-continue is received from the remote server*/
126
- expectContinue?: boolean;
127
- }
128
- export interface ConnectOptions {
129
- origin: string | URL;
130
- path: string;
131
- /** Default: `null` */
132
- headers?: IncomingHttpHeaders | string[] | null;
133
- /** Default: `null` */
134
- signal?: AbortSignal | EventEmitter | null;
135
- /** This argument parameter is passed through to `ConnectData` */
136
- opaque?: unknown;
137
- /** Default: 0 */
138
- maxRedirections?: number;
139
- /** Default: false */
140
- redirectionLimitReached?: boolean;
141
- /** Default: `null` */
142
- responseHeader?: 'raw' | null;
143
- }
144
- export interface RequestOptions extends DispatchOptions {
145
- /** Default: `null` */
146
- opaque?: unknown;
147
- /** Default: `null` */
148
- signal?: AbortSignal | EventEmitter | null;
149
- /** Default: 0 */
150
- maxRedirections?: number;
151
- /** Default: false */
152
- redirectionLimitReached?: boolean;
153
- /** Default: `null` */
154
- onInfo?: (info: { statusCode: number, headers: Record<string, string | string[]> }) => void;
155
- /** Default: `null` */
156
- responseHeader?: 'raw' | null;
157
- /** Default: `64 KiB` */
158
- highWaterMark?: number;
159
- }
160
- export interface PipelineOptions extends RequestOptions {
161
- /** `true` if the `handler` will return an object stream. Default: `false` */
162
- objectMode?: boolean;
163
- }
164
- export interface UpgradeOptions {
165
- path: string;
166
- /** Default: `'GET'` */
167
- method?: string;
168
- /** Default: `null` */
169
- headers?: IncomingHttpHeaders | string[] | null;
170
- /** A string of comma separated protocols, in descending preference order. Default: `'Websocket'` */
171
- protocol?: string;
172
- /** Default: `null` */
173
- signal?: AbortSignal | EventEmitter | null;
174
- /** Default: 0 */
175
- maxRedirections?: number;
176
- /** Default: false */
177
- redirectionLimitReached?: boolean;
178
- /** Default: `null` */
179
- responseHeader?: 'raw' | null;
180
- }
181
- export interface ConnectData {
182
- statusCode: number;
183
- headers: IncomingHttpHeaders;
184
- socket: Duplex;
185
- opaque: unknown;
186
- }
187
- export interface ResponseData {
188
- statusCode: number;
189
- headers: IncomingHttpHeaders;
190
- body: BodyReadable & BodyMixin;
191
- trailers: Record<string, string>;
192
- opaque: unknown;
193
- context: object;
194
- }
195
- export interface PipelineHandlerData {
196
- statusCode: number;
197
- headers: IncomingHttpHeaders;
198
- opaque: unknown;
199
- body: BodyReadable;
200
- context: object;
201
- }
202
- export interface StreamData {
203
- opaque: unknown;
204
- trailers: Record<string, string>;
205
- }
206
- export interface UpgradeData {
207
- headers: IncomingHttpHeaders;
208
- socket: Duplex;
209
- opaque: unknown;
210
- }
211
- export interface StreamFactoryData {
212
- statusCode: number;
213
- headers: IncomingHttpHeaders;
214
- opaque: unknown;
215
- context: object;
216
- }
217
- export type StreamFactory = (data: StreamFactoryData) => Writable;
218
- export interface DispatchHandlers {
219
- /** Invoked before request is dispatched on socket. May be invoked multiple times when a request is retried when the request at the head of the pipeline fails. */
220
- onConnect?(abort: (err?: Error) => void): void;
221
- /** Invoked when an error has occurred. */
222
- onError?(err: Error): void;
223
- /** Invoked when request is upgraded either due to a `Upgrade` header or `CONNECT` method. */
224
- onUpgrade?(statusCode: number, headers: Buffer[] | string[] | null, socket: Duplex): void;
225
- /** Invoked when response is received, before headers have been read. **/
226
- onResponseStarted?(): void;
227
- /** Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers. */
228
- onHeaders?(statusCode: number, headers: Buffer[], resume: () => void, statusText: string): boolean;
229
- /** Invoked when response payload data is received. */
230
- onData?(chunk: Buffer): boolean;
231
- /** Invoked when response payload and trailers have been received and the request has completed. */
232
- onComplete?(trailers: string[] | null): void;
233
- /** Invoked when a body chunk is sent to the server. May be invoked multiple times for chunked requests */
234
- onBodySent?(chunkSize: number, totalBytesSent: number): void;
235
- }
236
- export type PipelineHandler = (data: PipelineHandlerData) => Readable;
237
- export type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
238
-
239
- /**
240
- * @link https://fetch.spec.whatwg.org/#body-mixin
241
- */
242
- interface BodyMixin {
243
- readonly body?: never;
244
- readonly bodyUsed: boolean;
245
- arrayBuffer(): Promise<ArrayBuffer>;
246
- blob(): Promise<Blob>;
247
- bytes(): Promise<Uint8Array>;
248
- formData(): Promise<never>;
249
- json(): Promise<unknown>;
250
- text(): Promise<string>;
251
- }
252
-
253
- export interface DispatchInterceptor {
254
- (dispatch: Dispatcher['dispatch']): Dispatcher['dispatch']
255
- }
256
- }
@@ -1,21 +0,0 @@
1
- import Agent from './agent'
2
- import Dispatcher from './dispatcher'
3
-
4
- export default EnvHttpProxyAgent
5
-
6
- declare class EnvHttpProxyAgent extends Dispatcher {
7
- constructor(opts?: EnvHttpProxyAgent.Options)
8
-
9
- dispatch(options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean;
10
- }
11
-
12
- declare namespace EnvHttpProxyAgent {
13
- export interface Options extends Agent.Options {
14
- /** Overrides the value of the HTTP_PROXY environment variable */
15
- httpProxy?: string;
16
- /** Overrides the value of the HTTPS_PROXY environment variable */
17
- httpsProxy?: string;
18
- /** Overrides the value of the NO_PROXY environment variable */
19
- noProxy?: string;
20
- }
21
- }