context.dev 0.1.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.
Files changed (325) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/LICENSE +201 -0
  3. package/README.md +370 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +181 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +181 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +465 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +461 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/query.d.mts +5 -0
  199. package/internal/utils/query.d.mts.map +1 -0
  200. package/internal/utils/query.d.ts +5 -0
  201. package/internal/utils/query.d.ts.map +1 -0
  202. package/internal/utils/query.js +23 -0
  203. package/internal/utils/query.js.map +1 -0
  204. package/internal/utils/query.mjs +20 -0
  205. package/internal/utils/query.mjs.map +1 -0
  206. package/internal/utils/sleep.d.mts +2 -0
  207. package/internal/utils/sleep.d.mts.map +1 -0
  208. package/internal/utils/sleep.d.ts +2 -0
  209. package/internal/utils/sleep.d.ts.map +1 -0
  210. package/internal/utils/sleep.js +7 -0
  211. package/internal/utils/sleep.js.map +1 -0
  212. package/internal/utils/sleep.mjs +3 -0
  213. package/internal/utils/sleep.mjs.map +1 -0
  214. package/internal/utils/uuid.d.mts +5 -0
  215. package/internal/utils/uuid.d.mts.map +1 -0
  216. package/internal/utils/uuid.d.ts +5 -0
  217. package/internal/utils/uuid.d.ts.map +1 -0
  218. package/internal/utils/uuid.js +19 -0
  219. package/internal/utils/uuid.js.map +1 -0
  220. package/internal/utils/uuid.mjs +15 -0
  221. package/internal/utils/uuid.mjs.map +1 -0
  222. package/internal/utils/values.d.mts +18 -0
  223. package/internal/utils/values.d.mts.map +1 -0
  224. package/internal/utils/values.d.ts +18 -0
  225. package/internal/utils/values.d.ts.map +1 -0
  226. package/internal/utils/values.js +112 -0
  227. package/internal/utils/values.js.map +1 -0
  228. package/internal/utils/values.mjs +94 -0
  229. package/internal/utils/values.mjs.map +1 -0
  230. package/internal/utils.d.mts +8 -0
  231. package/internal/utils.d.mts.map +1 -0
  232. package/internal/utils.d.ts +8 -0
  233. package/internal/utils.d.ts.map +1 -0
  234. package/internal/utils.js +12 -0
  235. package/internal/utils.js.map +1 -0
  236. package/internal/utils.mjs +9 -0
  237. package/internal/utils.mjs.map +1 -0
  238. package/package.json +149 -0
  239. package/resource.d.mts +2 -0
  240. package/resource.d.mts.map +1 -0
  241. package/resource.d.ts +2 -0
  242. package/resource.d.ts.map +1 -0
  243. package/resource.js +6 -0
  244. package/resource.js.map +1 -0
  245. package/resource.mjs +2 -0
  246. package/resource.mjs.map +1 -0
  247. package/resources/brand.d.mts +3208 -0
  248. package/resources/brand.d.mts.map +1 -0
  249. package/resources/brand.d.ts +3208 -0
  250. package/resources/brand.d.ts.map +1 -0
  251. package/resources/brand.js +168 -0
  252. package/resources/brand.js.map +1 -0
  253. package/resources/brand.mjs +164 -0
  254. package/resources/brand.mjs.map +1 -0
  255. package/resources/index.d.mts +2 -0
  256. package/resources/index.d.mts.map +1 -0
  257. package/resources/index.d.ts +2 -0
  258. package/resources/index.d.ts.map +1 -0
  259. package/resources/index.js +7 -0
  260. package/resources/index.js.map +1 -0
  261. package/resources/index.mjs +3 -0
  262. package/resources/index.mjs.map +1 -0
  263. package/resources.d.mts +2 -0
  264. package/resources.d.mts.map +1 -0
  265. package/resources.d.ts +2 -0
  266. package/resources.d.ts.map +1 -0
  267. package/resources.js +5 -0
  268. package/resources.js.map +1 -0
  269. package/resources.mjs +2 -0
  270. package/resources.mjs.map +1 -0
  271. package/src/api-promise.ts +2 -0
  272. package/src/client.ts +814 -0
  273. package/src/core/README.md +3 -0
  274. package/src/core/api-promise.ts +92 -0
  275. package/src/core/error.ts +130 -0
  276. package/src/core/resource.ts +11 -0
  277. package/src/core/uploads.ts +2 -0
  278. package/src/error.ts +2 -0
  279. package/src/index.ts +22 -0
  280. package/src/internal/README.md +3 -0
  281. package/src/internal/builtin-types.ts +93 -0
  282. package/src/internal/detect-platform.ts +196 -0
  283. package/src/internal/errors.ts +33 -0
  284. package/src/internal/headers.ts +97 -0
  285. package/src/internal/parse.ts +56 -0
  286. package/src/internal/request-options.ts +91 -0
  287. package/src/internal/shim-types.ts +26 -0
  288. package/src/internal/shims.ts +107 -0
  289. package/src/internal/to-file.ts +154 -0
  290. package/src/internal/types.ts +95 -0
  291. package/src/internal/uploads.ts +187 -0
  292. package/src/internal/utils/base64.ts +40 -0
  293. package/src/internal/utils/bytes.ts +32 -0
  294. package/src/internal/utils/env.ts +18 -0
  295. package/src/internal/utils/log.ts +126 -0
  296. package/src/internal/utils/path.ts +88 -0
  297. package/src/internal/utils/query.ts +23 -0
  298. package/src/internal/utils/sleep.ts +3 -0
  299. package/src/internal/utils/uuid.ts +17 -0
  300. package/src/internal/utils/values.ts +105 -0
  301. package/src/internal/utils.ts +9 -0
  302. package/src/lib/.keep +4 -0
  303. package/src/resource.ts +2 -0
  304. package/src/resources/brand.ts +6079 -0
  305. package/src/resources/index.ts +45 -0
  306. package/src/resources.ts +1 -0
  307. package/src/tsconfig.json +11 -0
  308. package/src/uploads.ts +2 -0
  309. package/src/version.ts +1 -0
  310. package/uploads.d.mts +2 -0
  311. package/uploads.d.mts.map +1 -0
  312. package/uploads.d.ts +2 -0
  313. package/uploads.d.ts.map +1 -0
  314. package/uploads.js +6 -0
  315. package/uploads.js.map +1 -0
  316. package/uploads.mjs +2 -0
  317. package/uploads.mjs.map +1 -0
  318. package/version.d.mts +2 -0
  319. package/version.d.mts.map +1 -0
  320. package/version.d.ts +2 -0
  321. package/version.d.ts.map +1 -0
  322. package/version.js +5 -0
  323. package/version.js.map +1 -0
  324. package/version.mjs +2 -0
  325. package/version.mjs.map +1 -0
package/client.d.mts ADDED
@@ -0,0 +1,181 @@
1
+ import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";
2
+ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";
3
+ export type { Logger, LogLevel } from "./internal/utils/log.mjs";
4
+ import * as Opts from "./internal/request-options.mjs";
5
+ import * as Errors from "./core/error.mjs";
6
+ import * as Uploads from "./core/uploads.mjs";
7
+ import * as API from "./resources/index.mjs";
8
+ import { APIPromise } from "./core/api-promise.mjs";
9
+ import { Brand, BrandAIProductParams, BrandAIProductResponse, BrandAIProductsParams, BrandAIProductsResponse, BrandAIQueryParams, BrandAIQueryResponse, BrandFontsParams, BrandFontsResponse, BrandIdentifyFromTransactionParams, BrandIdentifyFromTransactionResponse, BrandPrefetchByEmailParams, BrandPrefetchByEmailResponse, BrandPrefetchParams, BrandPrefetchResponse, BrandRetrieveByEmailParams, BrandRetrieveByEmailResponse, BrandRetrieveByIsinParams, BrandRetrieveByIsinResponse, BrandRetrieveByNameParams, BrandRetrieveByNameResponse, BrandRetrieveByTickerParams, BrandRetrieveByTickerResponse, BrandRetrieveNaicsParams, BrandRetrieveNaicsResponse, BrandRetrieveParams, BrandRetrieveResponse, BrandRetrieveSimplifiedParams, BrandRetrieveSimplifiedResponse, BrandScreenshotParams, BrandScreenshotResponse, BrandStyleguideParams, BrandStyleguideResponse, BrandWebScrapeHTMLParams, BrandWebScrapeHTMLResponse, BrandWebScrapeImagesParams, BrandWebScrapeImagesResponse, BrandWebScrapeMdParams, BrandWebScrapeMdResponse, BrandWebScrapeSitemapParams, BrandWebScrapeSitemapResponse } from "./resources/brand.mjs";
10
+ import { type Fetch } from "./internal/builtin-types.mjs";
11
+ import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
12
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
13
+ import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
14
+ export interface ClientOptions {
15
+ /**
16
+ * Defaults to process.env['CONTEXT_DEV_API_KEY'].
17
+ */
18
+ apiKey?: string | undefined;
19
+ /**
20
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
21
+ *
22
+ * Defaults to process.env['CONTEXT_DEV_BASE_URL'].
23
+ */
24
+ baseURL?: string | null | undefined;
25
+ /**
26
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
27
+ * from the server before timing out a single request.
28
+ *
29
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
30
+ * much longer than this timeout before the promise succeeds or fails.
31
+ *
32
+ * @unit milliseconds
33
+ */
34
+ timeout?: number | undefined;
35
+ /**
36
+ * Additional `RequestInit` options to be passed to `fetch` calls.
37
+ * Properties will be overridden by per-request `fetchOptions`.
38
+ */
39
+ fetchOptions?: MergedRequestInit | undefined;
40
+ /**
41
+ * Specify a custom `fetch` function implementation.
42
+ *
43
+ * If not provided, we expect that `fetch` is defined globally.
44
+ */
45
+ fetch?: Fetch | undefined;
46
+ /**
47
+ * The maximum number of times that the client will retry a request in case of a
48
+ * temporary failure, like a network error or a 5XX error from the server.
49
+ *
50
+ * @default 2
51
+ */
52
+ maxRetries?: number | undefined;
53
+ /**
54
+ * Default headers to include with every request to the API.
55
+ *
56
+ * These can be removed in individual requests by explicitly setting the
57
+ * header to `null` in request options.
58
+ */
59
+ defaultHeaders?: HeadersLike | undefined;
60
+ /**
61
+ * Default query parameters to include with every request to the API.
62
+ *
63
+ * These can be removed in individual requests by explicitly setting the
64
+ * param to `undefined` in request options.
65
+ */
66
+ defaultQuery?: Record<string, string | undefined> | undefined;
67
+ /**
68
+ * Set the log level.
69
+ *
70
+ * Defaults to process.env['CONTEXT_DEV_LOG'] or 'warn' if it isn't set.
71
+ */
72
+ logLevel?: LogLevel | undefined;
73
+ /**
74
+ * Set the logger.
75
+ *
76
+ * Defaults to globalThis.console.
77
+ */
78
+ logger?: Logger | undefined;
79
+ }
80
+ /**
81
+ * API Client for interfacing with the Context Dev API.
82
+ */
83
+ export declare class ContextDev {
84
+ #private;
85
+ apiKey: string;
86
+ baseURL: string;
87
+ maxRetries: number;
88
+ timeout: number;
89
+ logger: Logger;
90
+ logLevel: LogLevel | undefined;
91
+ fetchOptions: MergedRequestInit | undefined;
92
+ private fetch;
93
+ protected idempotencyHeader?: string;
94
+ private _options;
95
+ /**
96
+ * API Client for interfacing with the Context Dev API.
97
+ *
98
+ * @param {string | undefined} [opts.apiKey=process.env['CONTEXT_DEV_API_KEY'] ?? undefined]
99
+ * @param {string} [opts.baseURL=process.env['CONTEXT_DEV_BASE_URL'] ?? https://api.context.dev/v1] - Override the default base URL for the API.
100
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
101
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
102
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
103
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
104
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
105
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
106
+ */
107
+ constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
108
+ /**
109
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
110
+ */
111
+ withOptions(options: Partial<ClientOptions>): this;
112
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
113
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
114
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
115
+ /**
116
+ * Basic re-implementation of `qs.stringify` for primitive types.
117
+ */
118
+ protected stringifyQuery(query: object | Record<string, unknown>): string;
119
+ private getUserAgent;
120
+ protected defaultIdempotencyKey(): string;
121
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
122
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
123
+ /**
124
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
125
+ */
126
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
127
+ /**
128
+ * Used as a callback for mutating the given `RequestInit` object.
129
+ *
130
+ * This is useful for cases where you want to add certain headers based off of
131
+ * the request properties, e.g. `method` or `url`.
132
+ */
133
+ protected prepareRequest(request: RequestInit, { url, options }: {
134
+ url: string;
135
+ options: FinalRequestOptions;
136
+ }): Promise<void>;
137
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
138
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
139
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
140
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
141
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
142
+ private methodRequest;
143
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
144
+ private makeRequest;
145
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
146
+ private shouldRetry;
147
+ private retryRequest;
148
+ private calculateDefaultRetryTimeoutMillis;
149
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
150
+ retryCount?: number;
151
+ }): Promise<{
152
+ req: FinalizedRequestInit;
153
+ url: string;
154
+ timeout: number;
155
+ }>;
156
+ private buildHeaders;
157
+ private _makeAbort;
158
+ private buildBody;
159
+ static ContextDev: typeof ContextDev;
160
+ static DEFAULT_TIMEOUT: number;
161
+ static ContextDevError: typeof Errors.ContextDevError;
162
+ static APIError: typeof Errors.APIError;
163
+ static APIConnectionError: typeof Errors.APIConnectionError;
164
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
165
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
166
+ static NotFoundError: typeof Errors.NotFoundError;
167
+ static ConflictError: typeof Errors.ConflictError;
168
+ static RateLimitError: typeof Errors.RateLimitError;
169
+ static BadRequestError: typeof Errors.BadRequestError;
170
+ static AuthenticationError: typeof Errors.AuthenticationError;
171
+ static InternalServerError: typeof Errors.InternalServerError;
172
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
173
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
174
+ static toFile: typeof Uploads.toFile;
175
+ brand: API.Brand;
176
+ }
177
+ export declare namespace ContextDev {
178
+ export type RequestOptions = Opts.RequestOptions;
179
+ export { Brand as Brand, type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIProductResponse as BrandAIProductResponse, type BrandAIProductsResponse as BrandAIProductsResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandFontsResponse as BrandFontsResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse, type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandWebScrapeHTMLResponse as BrandWebScrapeHTMLResponse, type BrandWebScrapeImagesResponse as BrandWebScrapeImagesResponse, type BrandWebScrapeMdResponse as BrandWebScrapeMdResponse, type BrandWebScrapeSitemapResponse as BrandWebScrapeSitemapResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIProductParams as BrandAIProductParams, type BrandAIProductsParams as BrandAIProductsParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandFontsParams as BrandFontsParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, type BrandWebScrapeHTMLParams as BrandWebScrapeHTMLParams, type BrandWebScrapeImagesParams as BrandWebScrapeImagesParams, type BrandWebScrapeMdParams as BrandWebScrapeMdParams, type BrandWebScrapeSitemapParams as BrandWebScrapeSitemapParams, };
180
+ }
181
+ //# sourceMappingURL=client.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAGT,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EACL,KAAK,EACL,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,kCAAkC,EAClC,oCAAoC,EACpC,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,4BAA4B,EAC5B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,6BAA6B,EAC7B,+BAA+B,EAC/B,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,6BAA6B,EAC9B;OACM,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,UAAU;;IACrB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAyC,EACzC,MAAuC,EACvC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAI5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI5F;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAoBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JnB,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA+BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,SAAS;IA6CjB,MAAM,CAAC,UAAU,oBAAQ;IACzB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;CACxC;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
package/client.d.ts ADDED
@@ -0,0 +1,181 @@
1
+ import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
2
+ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
3
+ export type { Logger, LogLevel } from "./internal/utils/log.js";
4
+ import * as Opts from "./internal/request-options.js";
5
+ import * as Errors from "./core/error.js";
6
+ import * as Uploads from "./core/uploads.js";
7
+ import * as API from "./resources/index.js";
8
+ import { APIPromise } from "./core/api-promise.js";
9
+ import { Brand, BrandAIProductParams, BrandAIProductResponse, BrandAIProductsParams, BrandAIProductsResponse, BrandAIQueryParams, BrandAIQueryResponse, BrandFontsParams, BrandFontsResponse, BrandIdentifyFromTransactionParams, BrandIdentifyFromTransactionResponse, BrandPrefetchByEmailParams, BrandPrefetchByEmailResponse, BrandPrefetchParams, BrandPrefetchResponse, BrandRetrieveByEmailParams, BrandRetrieveByEmailResponse, BrandRetrieveByIsinParams, BrandRetrieveByIsinResponse, BrandRetrieveByNameParams, BrandRetrieveByNameResponse, BrandRetrieveByTickerParams, BrandRetrieveByTickerResponse, BrandRetrieveNaicsParams, BrandRetrieveNaicsResponse, BrandRetrieveParams, BrandRetrieveResponse, BrandRetrieveSimplifiedParams, BrandRetrieveSimplifiedResponse, BrandScreenshotParams, BrandScreenshotResponse, BrandStyleguideParams, BrandStyleguideResponse, BrandWebScrapeHTMLParams, BrandWebScrapeHTMLResponse, BrandWebScrapeImagesParams, BrandWebScrapeImagesResponse, BrandWebScrapeMdParams, BrandWebScrapeMdResponse, BrandWebScrapeSitemapParams, BrandWebScrapeSitemapResponse } from "./resources/brand.js";
10
+ import { type Fetch } from "./internal/builtin-types.js";
11
+ import { HeadersLike, NullableHeaders } from "./internal/headers.js";
12
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
13
+ import { type LogLevel, type Logger } from "./internal/utils/log.js";
14
+ export interface ClientOptions {
15
+ /**
16
+ * Defaults to process.env['CONTEXT_DEV_API_KEY'].
17
+ */
18
+ apiKey?: string | undefined;
19
+ /**
20
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
21
+ *
22
+ * Defaults to process.env['CONTEXT_DEV_BASE_URL'].
23
+ */
24
+ baseURL?: string | null | undefined;
25
+ /**
26
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
27
+ * from the server before timing out a single request.
28
+ *
29
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
30
+ * much longer than this timeout before the promise succeeds or fails.
31
+ *
32
+ * @unit milliseconds
33
+ */
34
+ timeout?: number | undefined;
35
+ /**
36
+ * Additional `RequestInit` options to be passed to `fetch` calls.
37
+ * Properties will be overridden by per-request `fetchOptions`.
38
+ */
39
+ fetchOptions?: MergedRequestInit | undefined;
40
+ /**
41
+ * Specify a custom `fetch` function implementation.
42
+ *
43
+ * If not provided, we expect that `fetch` is defined globally.
44
+ */
45
+ fetch?: Fetch | undefined;
46
+ /**
47
+ * The maximum number of times that the client will retry a request in case of a
48
+ * temporary failure, like a network error or a 5XX error from the server.
49
+ *
50
+ * @default 2
51
+ */
52
+ maxRetries?: number | undefined;
53
+ /**
54
+ * Default headers to include with every request to the API.
55
+ *
56
+ * These can be removed in individual requests by explicitly setting the
57
+ * header to `null` in request options.
58
+ */
59
+ defaultHeaders?: HeadersLike | undefined;
60
+ /**
61
+ * Default query parameters to include with every request to the API.
62
+ *
63
+ * These can be removed in individual requests by explicitly setting the
64
+ * param to `undefined` in request options.
65
+ */
66
+ defaultQuery?: Record<string, string | undefined> | undefined;
67
+ /**
68
+ * Set the log level.
69
+ *
70
+ * Defaults to process.env['CONTEXT_DEV_LOG'] or 'warn' if it isn't set.
71
+ */
72
+ logLevel?: LogLevel | undefined;
73
+ /**
74
+ * Set the logger.
75
+ *
76
+ * Defaults to globalThis.console.
77
+ */
78
+ logger?: Logger | undefined;
79
+ }
80
+ /**
81
+ * API Client for interfacing with the Context Dev API.
82
+ */
83
+ export declare class ContextDev {
84
+ #private;
85
+ apiKey: string;
86
+ baseURL: string;
87
+ maxRetries: number;
88
+ timeout: number;
89
+ logger: Logger;
90
+ logLevel: LogLevel | undefined;
91
+ fetchOptions: MergedRequestInit | undefined;
92
+ private fetch;
93
+ protected idempotencyHeader?: string;
94
+ private _options;
95
+ /**
96
+ * API Client for interfacing with the Context Dev API.
97
+ *
98
+ * @param {string | undefined} [opts.apiKey=process.env['CONTEXT_DEV_API_KEY'] ?? undefined]
99
+ * @param {string} [opts.baseURL=process.env['CONTEXT_DEV_BASE_URL'] ?? https://api.context.dev/v1] - Override the default base URL for the API.
100
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
101
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
102
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
103
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
104
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
105
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
106
+ */
107
+ constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
108
+ /**
109
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
110
+ */
111
+ withOptions(options: Partial<ClientOptions>): this;
112
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
113
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
114
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
115
+ /**
116
+ * Basic re-implementation of `qs.stringify` for primitive types.
117
+ */
118
+ protected stringifyQuery(query: object | Record<string, unknown>): string;
119
+ private getUserAgent;
120
+ protected defaultIdempotencyKey(): string;
121
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
122
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
123
+ /**
124
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
125
+ */
126
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
127
+ /**
128
+ * Used as a callback for mutating the given `RequestInit` object.
129
+ *
130
+ * This is useful for cases where you want to add certain headers based off of
131
+ * the request properties, e.g. `method` or `url`.
132
+ */
133
+ protected prepareRequest(request: RequestInit, { url, options }: {
134
+ url: string;
135
+ options: FinalRequestOptions;
136
+ }): Promise<void>;
137
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
138
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
139
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
140
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
141
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
142
+ private methodRequest;
143
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
144
+ private makeRequest;
145
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
146
+ private shouldRetry;
147
+ private retryRequest;
148
+ private calculateDefaultRetryTimeoutMillis;
149
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
150
+ retryCount?: number;
151
+ }): Promise<{
152
+ req: FinalizedRequestInit;
153
+ url: string;
154
+ timeout: number;
155
+ }>;
156
+ private buildHeaders;
157
+ private _makeAbort;
158
+ private buildBody;
159
+ static ContextDev: typeof ContextDev;
160
+ static DEFAULT_TIMEOUT: number;
161
+ static ContextDevError: typeof Errors.ContextDevError;
162
+ static APIError: typeof Errors.APIError;
163
+ static APIConnectionError: typeof Errors.APIConnectionError;
164
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
165
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
166
+ static NotFoundError: typeof Errors.NotFoundError;
167
+ static ConflictError: typeof Errors.ConflictError;
168
+ static RateLimitError: typeof Errors.RateLimitError;
169
+ static BadRequestError: typeof Errors.BadRequestError;
170
+ static AuthenticationError: typeof Errors.AuthenticationError;
171
+ static InternalServerError: typeof Errors.InternalServerError;
172
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
173
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
174
+ static toFile: typeof Uploads.toFile;
175
+ brand: API.Brand;
176
+ }
177
+ export declare namespace ContextDev {
178
+ export type RequestOptions = Opts.RequestOptions;
179
+ export { Brand as Brand, type BrandRetrieveResponse as BrandRetrieveResponse, type BrandAIProductResponse as BrandAIProductResponse, type BrandAIProductsResponse as BrandAIProductsResponse, type BrandAIQueryResponse as BrandAIQueryResponse, type BrandFontsResponse as BrandFontsResponse, type BrandIdentifyFromTransactionResponse as BrandIdentifyFromTransactionResponse, type BrandPrefetchResponse as BrandPrefetchResponse, type BrandPrefetchByEmailResponse as BrandPrefetchByEmailResponse, type BrandRetrieveByEmailResponse as BrandRetrieveByEmailResponse, type BrandRetrieveByIsinResponse as BrandRetrieveByIsinResponse, type BrandRetrieveByNameResponse as BrandRetrieveByNameResponse, type BrandRetrieveByTickerResponse as BrandRetrieveByTickerResponse, type BrandRetrieveNaicsResponse as BrandRetrieveNaicsResponse, type BrandRetrieveSimplifiedResponse as BrandRetrieveSimplifiedResponse, type BrandScreenshotResponse as BrandScreenshotResponse, type BrandStyleguideResponse as BrandStyleguideResponse, type BrandWebScrapeHTMLResponse as BrandWebScrapeHTMLResponse, type BrandWebScrapeImagesResponse as BrandWebScrapeImagesResponse, type BrandWebScrapeMdResponse as BrandWebScrapeMdResponse, type BrandWebScrapeSitemapResponse as BrandWebScrapeSitemapResponse, type BrandRetrieveParams as BrandRetrieveParams, type BrandAIProductParams as BrandAIProductParams, type BrandAIProductsParams as BrandAIProductsParams, type BrandAIQueryParams as BrandAIQueryParams, type BrandFontsParams as BrandFontsParams, type BrandIdentifyFromTransactionParams as BrandIdentifyFromTransactionParams, type BrandPrefetchParams as BrandPrefetchParams, type BrandPrefetchByEmailParams as BrandPrefetchByEmailParams, type BrandRetrieveByEmailParams as BrandRetrieveByEmailParams, type BrandRetrieveByIsinParams as BrandRetrieveByIsinParams, type BrandRetrieveByNameParams as BrandRetrieveByNameParams, type BrandRetrieveByTickerParams as BrandRetrieveByTickerParams, type BrandRetrieveNaicsParams as BrandRetrieveNaicsParams, type BrandRetrieveSimplifiedParams as BrandRetrieveSimplifiedParams, type BrandScreenshotParams as BrandScreenshotParams, type BrandStyleguideParams as BrandStyleguideParams, type BrandWebScrapeHTMLParams as BrandWebScrapeHTMLParams, type BrandWebScrapeImagesParams as BrandWebScrapeImagesParams, type BrandWebScrapeMdParams as BrandWebScrapeMdParams, type BrandWebScrapeSitemapParams as BrandWebScrapeSitemapParams, };
180
+ }
181
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAGT,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EACL,KAAK,EACL,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,kCAAkC,EAClC,oCAAoC,EACpC,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,4BAA4B,EAC5B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,6BAA6B,EAC7B,+BAA+B,EAC/B,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,6BAA6B,EAC9B;OACM,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,UAAU;;IACrB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAyC,EACzC,MAAuC,EACvC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAI5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI5F;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAoBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JnB,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA+BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,SAAS;IA6CjB,MAAM,CAAC,UAAU,oBAAQ;IACzB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;CACxC;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}