retell-sdk 0.1.0-alpha.1

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 (193) hide show
  1. package/CHANGELOG.md +59 -0
  2. package/LICENSE +201 -0
  3. package/README.md +304 -0
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +90 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +237 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +868 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +837 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +53 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +143 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +127 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +133 -0
  87. package/index.d.ts +133 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +117 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +89 -0
  92. package/index.mjs.map +1 -0
  93. package/package.json +107 -0
  94. package/resource.d.ts +6 -0
  95. package/resource.d.ts.map +1 -0
  96. package/resource.js +11 -0
  97. package/resource.js.map +1 -0
  98. package/resource.mjs +7 -0
  99. package/resource.mjs.map +1 -0
  100. package/resources/agent.d.ts +372 -0
  101. package/resources/agent.d.ts.map +1 -0
  102. package/resources/agent.js +44 -0
  103. package/resources/agent.js.map +1 -0
  104. package/resources/agent.mjs +40 -0
  105. package/resources/agent.mjs.map +1 -0
  106. package/resources/call.d.ts +461 -0
  107. package/resources/call.d.ts.map +1 -0
  108. package/resources/call.js +36 -0
  109. package/resources/call.js.map +1 -0
  110. package/resources/call.mjs +32 -0
  111. package/resources/call.mjs.map +1 -0
  112. package/resources/index.d.ts +5 -0
  113. package/resources/index.d.ts.map +1 -0
  114. package/resources/index.js +13 -0
  115. package/resources/index.js.map +1 -0
  116. package/resources/index.mjs +6 -0
  117. package/resources/index.mjs.map +1 -0
  118. package/resources/llm.d.ts +1355 -0
  119. package/resources/llm.d.ts.map +1 -0
  120. package/resources/llm.js +44 -0
  121. package/resources/llm.js.map +1 -0
  122. package/resources/llm.mjs +40 -0
  123. package/resources/llm.mjs.map +1 -0
  124. package/resources/phone-number.d.ts +78 -0
  125. package/resources/phone-number.d.ts.map +1 -0
  126. package/resources/phone-number.js +44 -0
  127. package/resources/phone-number.js.map +1 -0
  128. package/resources/phone-number.mjs +40 -0
  129. package/resources/phone-number.mjs.map +1 -0
  130. package/shims/node.d.ts +29 -0
  131. package/shims/node.d.ts.map +1 -0
  132. package/shims/node.js +31 -0
  133. package/shims/node.js.map +1 -0
  134. package/shims/node.mjs +5 -0
  135. package/shims/node.mjs.map +1 -0
  136. package/shims/web.d.ts +26 -0
  137. package/shims/web.d.ts.map +1 -0
  138. package/shims/web.js +31 -0
  139. package/shims/web.js.map +1 -0
  140. package/shims/web.mjs +5 -0
  141. package/shims/web.mjs.map +1 -0
  142. package/src/_shims/MultipartBody.ts +9 -0
  143. package/src/_shims/README.md +46 -0
  144. package/src/_shims/auto/runtime-bun.ts +4 -0
  145. package/src/_shims/auto/runtime-node.ts +4 -0
  146. package/src/_shims/auto/runtime.ts +4 -0
  147. package/src/_shims/auto/types-node.ts +4 -0
  148. package/src/_shims/auto/types.d.ts +101 -0
  149. package/src/_shims/auto/types.js +3 -0
  150. package/src/_shims/auto/types.mjs +3 -0
  151. package/src/_shims/bun-runtime.ts +14 -0
  152. package/src/_shims/index.d.ts +81 -0
  153. package/src/_shims/index.js +13 -0
  154. package/src/_shims/index.mjs +7 -0
  155. package/src/_shims/manual-types.d.ts +12 -0
  156. package/src/_shims/manual-types.js +3 -0
  157. package/src/_shims/manual-types.mjs +3 -0
  158. package/src/_shims/node-runtime.ts +83 -0
  159. package/src/_shims/node-types.d.ts +42 -0
  160. package/src/_shims/node-types.js +3 -0
  161. package/src/_shims/node-types.mjs +3 -0
  162. package/src/_shims/registry.ts +67 -0
  163. package/src/_shims/web-runtime.ts +103 -0
  164. package/src/_shims/web-types.d.ts +83 -0
  165. package/src/_shims/web-types.js +3 -0
  166. package/src/_shims/web-types.mjs +3 -0
  167. package/src/core.ts +1146 -0
  168. package/src/error.ts +146 -0
  169. package/src/index.ts +215 -0
  170. package/src/lib/.keep +4 -0
  171. package/src/resource.ts +11 -0
  172. package/src/resources/agent.ts +468 -0
  173. package/src/resources/call.ts +542 -0
  174. package/src/resources/index.ts +21 -0
  175. package/src/resources/llm.ts +1643 -0
  176. package/src/resources/phone-number.ts +111 -0
  177. package/src/shims/node.ts +50 -0
  178. package/src/shims/web.ts +50 -0
  179. package/src/tsconfig.json +11 -0
  180. package/src/uploads.ts +248 -0
  181. package/src/version.ts +1 -0
  182. package/uploads.d.ts +75 -0
  183. package/uploads.d.ts.map +1 -0
  184. package/uploads.js +165 -0
  185. package/uploads.js.map +1 -0
  186. package/uploads.mjs +152 -0
  187. package/uploads.mjs.map +1 -0
  188. package/version.d.ts +2 -0
  189. package/version.d.ts.map +1 -0
  190. package/version.js +5 -0
  191. package/version.js.map +1 -0
  192. package/version.mjs +2 -0
  193. package/version.mjs.map +1 -0
@@ -0,0 +1,111 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import * as Core from "../core";
4
+ import { APIResource } from "../resource";
5
+ import * as PhoneNumberAPI from "./phone-number";
6
+
7
+ export class PhoneNumber extends APIResource {
8
+ /**
9
+ * Buy a new phone number & Bind an agent
10
+ */
11
+ create(body: PhoneNumberCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
12
+ return this._client.post('/create-phone-number', { body, ...options });
13
+ }
14
+
15
+ /**
16
+ * Retrieve details of a specific phone number
17
+ */
18
+ retrieve(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
19
+ return this._client.get(`/get-phone-number/${phoneNumber}`, options);
20
+ }
21
+
22
+ /**
23
+ * Update an existing Retell LLM
24
+ */
25
+ update(
26
+ phoneNumber: string,
27
+ body: PhoneNumberUpdateParams,
28
+ options?: Core.RequestOptions,
29
+ ): Core.APIPromise<PhoneNumberResponse> {
30
+ return this._client.patch(`/update-phone-number/${phoneNumber}`, { body, ...options });
31
+ }
32
+
33
+ /**
34
+ * List all phone numbers
35
+ */
36
+ list(options?: Core.RequestOptions): Core.APIPromise<PhoneNumberListResponse> {
37
+ return this._client.get('/list-phone-numbers', options);
38
+ }
39
+
40
+ /**
41
+ * Delete an existing phone number
42
+ */
43
+ delete(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<void> {
44
+ return this._client.delete(`/delete-phone-number/${phoneNumber}`, {
45
+ ...options,
46
+ headers: { Accept: '*/*', ...options?.headers },
47
+ });
48
+ }
49
+ }
50
+
51
+ export interface PhoneNumberResponse {
52
+ /**
53
+ * Unique id of agent to bind to newly obtained number. The number will
54
+ * automatically use the agent when doing inbound / outbound calls.
55
+ */
56
+ agent_id: string;
57
+
58
+ /**
59
+ * Area code of the number to obtain. Format is a 3 digit integer. Currently only
60
+ * supports US area code.
61
+ */
62
+ area_code: number;
63
+
64
+ /**
65
+ * Last modification timestamp (milliseconds since epoch). Either the time of last
66
+ * update or creation if no updates available.
67
+ */
68
+ last_modification_timestamp: number;
69
+
70
+ /**
71
+ * BCP 47 format of the number (+country code, then number with no space, no
72
+ * special characters), used as the unique identifier for phone number APIs.
73
+ */
74
+ phone_number: string;
75
+
76
+ /**
77
+ * Pretty printed phone number, provided for your reference.
78
+ */
79
+ phone_number_pretty: string;
80
+ }
81
+
82
+ export type PhoneNumberListResponse = Array<PhoneNumberResponse>;
83
+
84
+ export interface PhoneNumberCreateParams {
85
+ /**
86
+ * Unique id of agent to bind to newly obtained number. The number will
87
+ * automatically use the agent when doing inbound / outbound calls.
88
+ */
89
+ agent_id: string;
90
+
91
+ /**
92
+ * Area code of the number to obtain. Format is a 3 digit integer. Currently only
93
+ * supports US area code.
94
+ */
95
+ area_code?: number;
96
+ }
97
+
98
+ export interface PhoneNumberUpdateParams {
99
+ /**
100
+ * Unique id of agent to bind to number. The number will automatically use the
101
+ * agent when doing inbound / outbound calls.
102
+ */
103
+ agent_id: string;
104
+ }
105
+
106
+ export namespace PhoneNumber {
107
+ export import PhoneNumberResponse = PhoneNumberAPI.PhoneNumberResponse;
108
+ export import PhoneNumberListResponse = PhoneNumberAPI.PhoneNumberListResponse;
109
+ export import PhoneNumberCreateParams = PhoneNumberAPI.PhoneNumberCreateParams;
110
+ export import PhoneNumberUpdateParams = PhoneNumberAPI.PhoneNumberUpdateParams;
111
+ }
@@ -0,0 +1,50 @@
1
+ // @ts-ignore
2
+ import * as types from '../_shims/node-types';
3
+ import { setShims } from '../_shims/registry';
4
+ import { getRuntime } from '../_shims/node-runtime';
5
+ setShims(getRuntime());
6
+
7
+ declare module '../_shims/manual-types' {
8
+ export namespace manual {
9
+ // @ts-ignore
10
+ export type Agent = types.Agent;
11
+ // @ts-ignore
12
+ export import fetch = types.fetch;
13
+ // @ts-ignore
14
+ export type Request = types.Request;
15
+ // @ts-ignore
16
+ export type RequestInfo = types.RequestInfo;
17
+ // @ts-ignore
18
+ export type RequestInit = types.RequestInit;
19
+ // @ts-ignore
20
+ export type Response = types.Response;
21
+ // @ts-ignore
22
+ export type ResponseInit = types.ResponseInit;
23
+ // @ts-ignore
24
+ export type ResponseType = types.ResponseType;
25
+ // @ts-ignore
26
+ export type BodyInit = types.BodyInit;
27
+ // @ts-ignore
28
+ export type Headers = types.Headers;
29
+ // @ts-ignore
30
+ export type HeadersInit = types.HeadersInit;
31
+ // @ts-ignore
32
+ export type BlobPropertyBag = types.BlobPropertyBag;
33
+ // @ts-ignore
34
+ export type FilePropertyBag = types.FilePropertyBag;
35
+ // @ts-ignore
36
+ export type FileFromPathOptions = types.FileFromPathOptions;
37
+ // @ts-ignore
38
+ export import FormData = types.FormData;
39
+ // @ts-ignore
40
+ export import File = types.File;
41
+ // @ts-ignore
42
+ export import Blob = types.Blob;
43
+ // @ts-ignore
44
+ export type Readable = types.Readable;
45
+ // @ts-ignore
46
+ export type FsReadStream = types.FsReadStream;
47
+ // @ts-ignore
48
+ export import ReadableStream = types.ReadableStream;
49
+ }
50
+ }
@@ -0,0 +1,50 @@
1
+ // @ts-ignore
2
+ import * as types from '../_shims/web-types';
3
+ import { setShims } from '../_shims/registry';
4
+ import { getRuntime } from '../_shims/web-runtime';
5
+ setShims(getRuntime({ manuallyImported: true }));
6
+
7
+ declare module '../_shims/manual-types' {
8
+ export namespace manual {
9
+ // @ts-ignore
10
+ export type Agent = types.Agent;
11
+ // @ts-ignore
12
+ export import fetch = types.fetch;
13
+ // @ts-ignore
14
+ export type Request = types.Request;
15
+ // @ts-ignore
16
+ export type RequestInfo = types.RequestInfo;
17
+ // @ts-ignore
18
+ export type RequestInit = types.RequestInit;
19
+ // @ts-ignore
20
+ export type Response = types.Response;
21
+ // @ts-ignore
22
+ export type ResponseInit = types.ResponseInit;
23
+ // @ts-ignore
24
+ export type ResponseType = types.ResponseType;
25
+ // @ts-ignore
26
+ export type BodyInit = types.BodyInit;
27
+ // @ts-ignore
28
+ export type Headers = types.Headers;
29
+ // @ts-ignore
30
+ export type HeadersInit = types.HeadersInit;
31
+ // @ts-ignore
32
+ export type BlobPropertyBag = types.BlobPropertyBag;
33
+ // @ts-ignore
34
+ export type FilePropertyBag = types.FilePropertyBag;
35
+ // @ts-ignore
36
+ export type FileFromPathOptions = types.FileFromPathOptions;
37
+ // @ts-ignore
38
+ export import FormData = types.FormData;
39
+ // @ts-ignore
40
+ export import File = types.File;
41
+ // @ts-ignore
42
+ export import Blob = types.Blob;
43
+ // @ts-ignore
44
+ export type Readable = types.Readable;
45
+ // @ts-ignore
46
+ export type FsReadStream = types.FsReadStream;
47
+ // @ts-ignore
48
+ export import ReadableStream = types.ReadableStream;
49
+ }
50
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ // this config is included in the published src directory to prevent TS errors
3
+ // from appearing when users go to source, and VSCode opens the source .ts file
4
+ // via declaration maps
5
+ "include": ["index.ts"],
6
+ "compilerOptions": {
7
+ "target": "es2015",
8
+ "lib": ["DOM"],
9
+ "moduleResolution": "node"
10
+ }
11
+ }
package/src/uploads.ts ADDED
@@ -0,0 +1,248 @@
1
+ import { type RequestOptions } from './core';
2
+ import {
3
+ FormData,
4
+ File,
5
+ type Blob,
6
+ type FilePropertyBag,
7
+ getMultipartRequestOptions,
8
+ type FsReadStream,
9
+ isFsReadStream,
10
+ } from './_shims/index';
11
+ import { MultipartBody } from './_shims/MultipartBody';
12
+ export { fileFromPath } from './_shims/index';
13
+
14
+ type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
15
+ export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
16
+
17
+ /**
18
+ * Typically, this is a native "File" class.
19
+ *
20
+ * We provide the {@link toFile} utility to convert a variety of objects
21
+ * into the File class.
22
+ *
23
+ * For convenience, you can also pass a fetch Response, or in Node,
24
+ * the result of fs.createReadStream().
25
+ */
26
+ export type Uploadable = FileLike | ResponseLike | FsReadStream;
27
+
28
+ /**
29
+ * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
30
+ */
31
+ export interface BlobLike {
32
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
33
+ readonly size: number;
34
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
35
+ readonly type: string;
36
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
37
+ text(): Promise<string>;
38
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
39
+ slice(start?: number, end?: number): BlobLike;
40
+ // unfortunately @types/node-fetch@^2.6.4 doesn't type the arrayBuffer method
41
+ }
42
+
43
+ /**
44
+ * Intended to match web.File, node.File, node-fetch.File, etc.
45
+ */
46
+ export interface FileLike extends BlobLike {
47
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
48
+ readonly lastModified: number;
49
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
50
+ readonly name: string;
51
+ }
52
+
53
+ /**
54
+ * Intended to match web.Response, node.Response, node-fetch.Response, etc.
55
+ */
56
+ export interface ResponseLike {
57
+ url: string;
58
+ blob(): Promise<BlobLike>;
59
+ }
60
+
61
+ export const isResponseLike = (value: any): value is ResponseLike =>
62
+ value != null &&
63
+ typeof value === 'object' &&
64
+ typeof value.url === 'string' &&
65
+ typeof value.blob === 'function';
66
+
67
+ export const isFileLike = (value: any): value is FileLike =>
68
+ value != null &&
69
+ typeof value === 'object' &&
70
+ typeof value.name === 'string' &&
71
+ typeof value.lastModified === 'number' &&
72
+ isBlobLike(value);
73
+
74
+ /**
75
+ * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
76
+ * adds the arrayBuffer() method type because it is available and used at runtime
77
+ */
78
+ export const isBlobLike = (value: any): value is BlobLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
79
+ value != null &&
80
+ typeof value === 'object' &&
81
+ typeof value.size === 'number' &&
82
+ typeof value.type === 'string' &&
83
+ typeof value.text === 'function' &&
84
+ typeof value.slice === 'function' &&
85
+ typeof value.arrayBuffer === 'function';
86
+
87
+ export const isUploadable = (value: any): value is Uploadable => {
88
+ return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
89
+ };
90
+
91
+ export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
92
+
93
+ /**
94
+ * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
95
+ * @param value the raw content of the file. Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
96
+ * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
97
+ * @param {Object=} options additional properties
98
+ * @param {string=} options.type the MIME type of the content
99
+ * @param {number=} options.lastModified the last modified timestamp
100
+ * @returns a {@link File} with the given properties
101
+ */
102
+ export async function toFile(
103
+ value: ToFileInput | PromiseLike<ToFileInput>,
104
+ name?: string | null | undefined,
105
+ options?: FilePropertyBag | undefined,
106
+ ): Promise<FileLike> {
107
+ // If it's a promise, resolve it.
108
+ value = await value;
109
+
110
+ // Use the file's options if there isn't one provided
111
+ options ??= isFileLike(value) ? { lastModified: value.lastModified, type: value.type } : {};
112
+
113
+ if (isResponseLike(value)) {
114
+ const blob = await value.blob();
115
+ name ||= new URL(value.url).pathname.split(/[\\/]/).pop() ?? 'unknown_file';
116
+
117
+ return new File([blob as any], name, options);
118
+ }
119
+
120
+ const bits = await getBytes(value);
121
+
122
+ name ||= getName(value) ?? 'unknown_file';
123
+
124
+ if (!options.type) {
125
+ const type = (bits[0] as any)?.type;
126
+ if (typeof type === 'string') {
127
+ options = { ...options, type };
128
+ }
129
+ }
130
+
131
+ return new File(bits, name, options);
132
+ }
133
+
134
+ async function getBytes(value: ToFileInput): Promise<Array<BlobPart>> {
135
+ let parts: Array<BlobPart> = [];
136
+ if (
137
+ typeof value === 'string' ||
138
+ ArrayBuffer.isView(value) || // includes Uint8Array, Buffer, etc.
139
+ value instanceof ArrayBuffer
140
+ ) {
141
+ parts.push(value);
142
+ } else if (isBlobLike(value)) {
143
+ parts.push(await value.arrayBuffer());
144
+ } else if (
145
+ isAsyncIterableIterator(value) // includes Readable, ReadableStream, etc.
146
+ ) {
147
+ for await (const chunk of value) {
148
+ parts.push(chunk as BlobPart); // TODO, consider validating?
149
+ }
150
+ } else {
151
+ throw new Error(
152
+ `Unexpected data type: ${typeof value}; constructor: ${value?.constructor
153
+ ?.name}; props: ${propsForError(value)}`,
154
+ );
155
+ }
156
+
157
+ return parts;
158
+ }
159
+
160
+ function propsForError(value: any): string {
161
+ const props = Object.getOwnPropertyNames(value);
162
+ return `[${props.map((p) => `"${p}"`).join(', ')}]`;
163
+ }
164
+
165
+ function getName(value: any): string | undefined {
166
+ return (
167
+ getStringFromMaybeBuffer(value.name) ||
168
+ getStringFromMaybeBuffer(value.filename) ||
169
+ // For fs.ReadStream
170
+ getStringFromMaybeBuffer(value.path)?.split(/[\\/]/).pop()
171
+ );
172
+ }
173
+
174
+ const getStringFromMaybeBuffer = (x: string | Buffer | unknown): string | undefined => {
175
+ if (typeof x === 'string') return x;
176
+ if (typeof Buffer !== 'undefined' && x instanceof Buffer) return String(x);
177
+ return undefined;
178
+ };
179
+
180
+ const isAsyncIterableIterator = (value: any): value is AsyncIterableIterator<unknown> =>
181
+ value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
182
+
183
+ export const isMultipartBody = (body: any): body is MultipartBody =>
184
+ body && typeof body === 'object' && body.body && body[Symbol.toStringTag] === 'MultipartBody';
185
+
186
+ /**
187
+ * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
188
+ * Otherwise returns the request as is.
189
+ */
190
+ export const maybeMultipartFormRequestOptions = async <T = Record<string, unknown>>(
191
+ opts: RequestOptions<T>,
192
+ ): Promise<RequestOptions<T | MultipartBody>> => {
193
+ if (!hasUploadableValue(opts.body)) return opts;
194
+
195
+ const form = await createForm(opts.body);
196
+ return getMultipartRequestOptions(form, opts);
197
+ };
198
+
199
+ export const multipartFormRequestOptions = async <T = Record<string, unknown>>(
200
+ opts: RequestOptions<T>,
201
+ ): Promise<RequestOptions<T | MultipartBody>> => {
202
+ const form = await createForm(opts.body);
203
+ return getMultipartRequestOptions(form, opts);
204
+ };
205
+
206
+ export const createForm = async <T = Record<string, unknown>>(body: T | undefined): Promise<FormData> => {
207
+ const form = new FormData();
208
+ await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
209
+ return form;
210
+ };
211
+
212
+ const hasUploadableValue = (value: unknown): boolean => {
213
+ if (isUploadable(value)) return true;
214
+ if (Array.isArray(value)) return value.some(hasUploadableValue);
215
+ if (value && typeof value === 'object') {
216
+ for (const k in value) {
217
+ if (hasUploadableValue((value as any)[k])) return true;
218
+ }
219
+ }
220
+ return false;
221
+ };
222
+
223
+ const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
224
+ if (value === undefined) return;
225
+ if (value == null) {
226
+ throw new TypeError(
227
+ `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
228
+ );
229
+ }
230
+
231
+ // TODO: make nested formats configurable
232
+ if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
233
+ form.append(key, String(value));
234
+ } else if (isUploadable(value)) {
235
+ const file = await toFile(value);
236
+ form.append(key, file as File);
237
+ } else if (Array.isArray(value)) {
238
+ await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
239
+ } else if (typeof value === 'object') {
240
+ await Promise.all(
241
+ Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
242
+ );
243
+ } else {
244
+ throw new TypeError(
245
+ `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
246
+ );
247
+ }
248
+ };
package/src/version.ts ADDED
@@ -0,0 +1 @@
1
+ export const VERSION = '0.1.0-alpha.1'; // x-release-please-version
package/uploads.d.ts ADDED
@@ -0,0 +1,75 @@
1
+ import { type RequestOptions } from "./core.js";
2
+ import { FormData, type Blob, type FilePropertyBag, type FsReadStream } from "./_shims/index.js";
3
+ import { MultipartBody } from "./_shims/MultipartBody.js";
4
+ export { fileFromPath } from "./_shims/index.js";
5
+ type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
6
+ export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
7
+ /**
8
+ * Typically, this is a native "File" class.
9
+ *
10
+ * We provide the {@link toFile} utility to convert a variety of objects
11
+ * into the File class.
12
+ *
13
+ * For convenience, you can also pass a fetch Response, or in Node,
14
+ * the result of fs.createReadStream().
15
+ */
16
+ export type Uploadable = FileLike | ResponseLike | FsReadStream;
17
+ /**
18
+ * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
19
+ */
20
+ export interface BlobLike {
21
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
22
+ readonly size: number;
23
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
24
+ readonly type: string;
25
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
26
+ text(): Promise<string>;
27
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
28
+ slice(start?: number, end?: number): BlobLike;
29
+ }
30
+ /**
31
+ * Intended to match web.File, node.File, node-fetch.File, etc.
32
+ */
33
+ export interface FileLike extends BlobLike {
34
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
35
+ readonly lastModified: number;
36
+ /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
37
+ readonly name: string;
38
+ }
39
+ /**
40
+ * Intended to match web.Response, node.Response, node-fetch.Response, etc.
41
+ */
42
+ export interface ResponseLike {
43
+ url: string;
44
+ blob(): Promise<BlobLike>;
45
+ }
46
+ export declare const isResponseLike: (value: any) => value is ResponseLike;
47
+ export declare const isFileLike: (value: any) => value is FileLike;
48
+ /**
49
+ * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
50
+ * adds the arrayBuffer() method type because it is available and used at runtime
51
+ */
52
+ export declare const isBlobLike: (value: any) => value is BlobLike & {
53
+ arrayBuffer(): Promise<ArrayBuffer>;
54
+ };
55
+ export declare const isUploadable: (value: any) => value is Uploadable;
56
+ export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
57
+ /**
58
+ * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
59
+ * @param value the raw content of the file. Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
60
+ * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
61
+ * @param {Object=} options additional properties
62
+ * @param {string=} options.type the MIME type of the content
63
+ * @param {number=} options.lastModified the last modified timestamp
64
+ * @returns a {@link File} with the given properties
65
+ */
66
+ export declare function toFile(value: ToFileInput | PromiseLike<ToFileInput>, name?: string | null | undefined, options?: FilePropertyBag | undefined): Promise<FileLike>;
67
+ export declare const isMultipartBody: (body: any) => body is MultipartBody;
68
+ /**
69
+ * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
70
+ * Otherwise returns the request as is.
71
+ */
72
+ export declare const maybeMultipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
73
+ export declare const multipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
74
+ export declare const createForm: <T = Record<string, unknown>>(body: T | undefined) => Promise<FormData>;
75
+ //# sourceMappingURL=uploads.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EACL,QAAQ,EAER,KAAK,IAAI,EACT,KAAK,eAAe,EAEpB,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,KAAK,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC9F,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,YAAY,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,6EAA6E;IAC7E,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAE/C;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,oFAAoF;IACpF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc,UAAW,GAAG,0BAIP,CAAC;AAEnC,eAAO,MAAM,UAAU,UAAW,GAAG,sBAKlB,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG;mBAAwC,QAAQ,WAAW,CAAC;CAOxD,CAAC;AAE1C,eAAO,MAAM,YAAY,UAAW,GAAG,wBAEtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAEnG;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAC1B,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,EAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,GACpC,OAAO,CAAC,QAAQ,CAAC,CA0BnB;AAmDD,eAAO,MAAM,eAAe,SAAU,GAAG,0BACsD,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,sGAO5C,CAAC;AAEF,eAAO,MAAM,2BAA2B,sGAKvC,CAAC;AAEF,eAAO,MAAM,UAAU,wDAA6D,QAAQ,QAAQ,CAInG,CAAC"}