@nimble-way/nimble-js 0.5.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 (352) hide show
  1. package/CHANGELOG.md +164 -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 +239 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +239 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +530 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +526 -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/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +137 -0
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +2 -0
  234. package/resource.d.ts.map +1 -0
  235. package/resource.js +6 -0
  236. package/resource.js.map +1 -0
  237. package/resource.mjs +2 -0
  238. package/resource.mjs.map +1 -0
  239. package/resources/agent.d.mts +356 -0
  240. package/resources/agent.d.mts.map +1 -0
  241. package/resources/agent.d.ts +356 -0
  242. package/resources/agent.d.ts.map +1 -0
  243. package/resources/agent.js +34 -0
  244. package/resources/agent.js.map +1 -0
  245. package/resources/agent.mjs +30 -0
  246. package/resources/agent.mjs.map +1 -0
  247. package/resources/crawl.d.mts +465 -0
  248. package/resources/crawl.d.mts.map +1 -0
  249. package/resources/crawl.d.ts +465 -0
  250. package/resources/crawl.d.ts.map +1 -0
  251. package/resources/crawl.js +34 -0
  252. package/resources/crawl.js.map +1 -0
  253. package/resources/crawl.mjs +30 -0
  254. package/resources/crawl.mjs.map +1 -0
  255. package/resources/index.d.mts +6 -0
  256. package/resources/index.d.mts.map +1 -0
  257. package/resources/index.d.ts +6 -0
  258. package/resources/index.d.ts.map +1 -0
  259. package/resources/index.js +13 -0
  260. package/resources/index.js.map +1 -0
  261. package/resources/index.mjs +6 -0
  262. package/resources/index.mjs.map +1 -0
  263. package/resources/shared.d.mts +452 -0
  264. package/resources/shared.d.mts.map +1 -0
  265. package/resources/shared.d.ts +452 -0
  266. package/resources/shared.d.ts.map +1 -0
  267. package/resources/shared.js +4 -0
  268. package/resources/shared.js.map +1 -0
  269. package/resources/shared.mjs +3 -0
  270. package/resources/shared.mjs.map +1 -0
  271. package/resources/tasks.d.mts +183 -0
  272. package/resources/tasks.d.mts.map +1 -0
  273. package/resources/tasks.d.ts +183 -0
  274. package/resources/tasks.d.ts.map +1 -0
  275. package/resources/tasks.js +28 -0
  276. package/resources/tasks.js.map +1 -0
  277. package/resources/tasks.mjs +24 -0
  278. package/resources/tasks.mjs.map +1 -0
  279. package/resources/top-level.d.mts +847 -0
  280. package/resources/top-level.d.mts.map +1 -0
  281. package/resources/top-level.d.ts +847 -0
  282. package/resources/top-level.d.ts.map +1 -0
  283. package/resources/top-level.js +4 -0
  284. package/resources/top-level.js.map +1 -0
  285. package/resources/top-level.mjs +3 -0
  286. package/resources/top-level.mjs.map +1 -0
  287. package/resources.d.mts +2 -0
  288. package/resources.d.mts.map +1 -0
  289. package/resources.d.ts +2 -0
  290. package/resources.d.ts.map +1 -0
  291. package/resources.js +5 -0
  292. package/resources.js.map +1 -0
  293. package/resources.mjs +2 -0
  294. package/resources.mjs.map +1 -0
  295. package/src/api-promise.ts +2 -0
  296. package/src/client.ts +893 -0
  297. package/src/core/README.md +3 -0
  298. package/src/core/api-promise.ts +92 -0
  299. package/src/core/error.ts +130 -0
  300. package/src/core/resource.ts +11 -0
  301. package/src/core/uploads.ts +2 -0
  302. package/src/error.ts +2 -0
  303. package/src/index.ts +22 -0
  304. package/src/internal/README.md +3 -0
  305. package/src/internal/builtin-types.ts +93 -0
  306. package/src/internal/detect-platform.ts +196 -0
  307. package/src/internal/errors.ts +33 -0
  308. package/src/internal/headers.ts +97 -0
  309. package/src/internal/parse.ts +56 -0
  310. package/src/internal/request-options.ts +91 -0
  311. package/src/internal/shim-types.ts +26 -0
  312. package/src/internal/shims.ts +107 -0
  313. package/src/internal/to-file.ts +154 -0
  314. package/src/internal/types.ts +95 -0
  315. package/src/internal/uploads.ts +187 -0
  316. package/src/internal/utils/base64.ts +40 -0
  317. package/src/internal/utils/bytes.ts +32 -0
  318. package/src/internal/utils/env.ts +18 -0
  319. package/src/internal/utils/log.ts +126 -0
  320. package/src/internal/utils/path.ts +88 -0
  321. package/src/internal/utils/sleep.ts +3 -0
  322. package/src/internal/utils/uuid.ts +17 -0
  323. package/src/internal/utils/values.ts +105 -0
  324. package/src/internal/utils.ts +8 -0
  325. package/src/lib/.keep +4 -0
  326. package/src/resource.ts +2 -0
  327. package/src/resources/agent.ts +548 -0
  328. package/src/resources/crawl.ts +1493 -0
  329. package/src/resources/index.ts +39 -0
  330. package/src/resources/shared.ts +816 -0
  331. package/src/resources/tasks.ts +240 -0
  332. package/src/resources/top-level.ts +3665 -0
  333. package/src/resources.ts +1 -0
  334. package/src/tsconfig.json +11 -0
  335. package/src/uploads.ts +2 -0
  336. package/src/version.ts +1 -0
  337. package/uploads.d.mts +2 -0
  338. package/uploads.d.mts.map +1 -0
  339. package/uploads.d.ts +2 -0
  340. package/uploads.d.ts.map +1 -0
  341. package/uploads.js +6 -0
  342. package/uploads.js.map +1 -0
  343. package/uploads.mjs +2 -0
  344. package/uploads.mjs.map +1 -0
  345. package/version.d.mts +2 -0
  346. package/version.d.mts.map +1 -0
  347. package/version.d.ts +2 -0
  348. package/version.d.ts.map +1 -0
  349. package/version.js +5 -0
  350. package/version.js.map +1 -0
  351. package/version.mjs +2 -0
  352. package/version.mjs.map +1 -0
package/client.d.ts ADDED
@@ -0,0 +1,239 @@
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 * as TopLevelAPI from "./resources/top-level.js";
9
+ import { ExtractAsyncParams, ExtractAsyncResponse, ExtractParams, ExtractResponse, MapParams, MapResponse, SearchParams, SearchResponse } from "./resources/top-level.js";
10
+ import { APIPromise } from "./core/api-promise.js";
11
+ import { Agent, AgentGetResponse, AgentListParams, AgentListResponse, AgentRunAsyncParams, AgentRunAsyncResponse, AgentRunParams, AgentRunResponse } from "./resources/agent.js";
12
+ import { Crawl, CrawlListParams, CrawlListResponse, CrawlRunParams, CrawlRunResponse, CrawlStatusResponse, CrawlTerminateResponse } from "./resources/crawl.js";
13
+ import { TaskGetResponse, TaskListParams, TaskListResponse, TaskResultsResponse, Tasks } from "./resources/tasks.js";
14
+ import { type Fetch } from "./internal/builtin-types.js";
15
+ import { HeadersLike, NullableHeaders } from "./internal/headers.js";
16
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
17
+ import { type LogLevel, type Logger } from "./internal/utils/log.js";
18
+ export interface ClientOptions {
19
+ /**
20
+ * Defaults to process.env['NIMBLE_API_KEY'].
21
+ */
22
+ apiKey?: string | null | undefined;
23
+ /**
24
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
25
+ *
26
+ * Defaults to process.env['NIMBLE_BASE_URL'].
27
+ */
28
+ baseURL?: string | null | undefined;
29
+ /**
30
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
31
+ * from the server before timing out a single request.
32
+ *
33
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
34
+ * much longer than this timeout before the promise succeeds or fails.
35
+ *
36
+ * @unit milliseconds
37
+ */
38
+ timeout?: number | undefined;
39
+ /**
40
+ * Additional `RequestInit` options to be passed to `fetch` calls.
41
+ * Properties will be overridden by per-request `fetchOptions`.
42
+ */
43
+ fetchOptions?: MergedRequestInit | undefined;
44
+ /**
45
+ * Specify a custom `fetch` function implementation.
46
+ *
47
+ * If not provided, we expect that `fetch` is defined globally.
48
+ */
49
+ fetch?: Fetch | undefined;
50
+ /**
51
+ * The maximum number of times that the client will retry a request in case of a
52
+ * temporary failure, like a network error or a 5XX error from the server.
53
+ *
54
+ * @default 2
55
+ */
56
+ maxRetries?: number | undefined;
57
+ /**
58
+ * Default headers to include with every request to the API.
59
+ *
60
+ * These can be removed in individual requests by explicitly setting the
61
+ * header to `null` in request options.
62
+ */
63
+ defaultHeaders?: HeadersLike | undefined;
64
+ /**
65
+ * Default query parameters to include with every request to the API.
66
+ *
67
+ * These can be removed in individual requests by explicitly setting the
68
+ * param to `undefined` in request options.
69
+ */
70
+ defaultQuery?: Record<string, string | undefined> | undefined;
71
+ /**
72
+ * Set the log level.
73
+ *
74
+ * Defaults to process.env['NIMBLE_LOG'] or 'warn' if it isn't set.
75
+ */
76
+ logLevel?: LogLevel | undefined;
77
+ /**
78
+ * Set the logger.
79
+ *
80
+ * Defaults to globalThis.console.
81
+ */
82
+ logger?: Logger | undefined;
83
+ }
84
+ /**
85
+ * API Client for interfacing with the Nimble API.
86
+ */
87
+ export declare class Nimble {
88
+ #private;
89
+ apiKey: string | null;
90
+ baseURL: string;
91
+ maxRetries: number;
92
+ timeout: number;
93
+ logger: Logger;
94
+ logLevel: LogLevel | undefined;
95
+ fetchOptions: MergedRequestInit | undefined;
96
+ private fetch;
97
+ protected idempotencyHeader?: string;
98
+ private _options;
99
+ /**
100
+ * API Client for interfacing with the Nimble API.
101
+ *
102
+ * @param {string | null | undefined} [opts.apiKey=process.env['NIMBLE_API_KEY'] ?? null]
103
+ * @param {string} [opts.baseURL=process.env['NIMBLE_BASE_URL'] ?? https://sdk.nimbleway.com] - Override the default base URL for the API.
104
+ * @param {number} [opts.timeout=3 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
105
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
106
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
107
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
108
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
109
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
110
+ */
111
+ constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
112
+ /**
113
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
114
+ */
115
+ withOptions(options: Partial<ClientOptions>): this;
116
+ /**
117
+ * Extract
118
+ *
119
+ * @example
120
+ * ```ts
121
+ * const response = await client.extract({ url: 'url' });
122
+ * ```
123
+ */
124
+ extract(body: TopLevelAPI.ExtractParams, options?: RequestOptions): APIPromise<TopLevelAPI.ExtractResponse>;
125
+ /**
126
+ * Extract Async Endpoint
127
+ *
128
+ * @example
129
+ * ```ts
130
+ * const response = await client.extractAsync({ url: 'url' });
131
+ * ```
132
+ */
133
+ extractAsync(body: TopLevelAPI.ExtractAsyncParams, options?: RequestOptions): APIPromise<TopLevelAPI.ExtractAsyncResponse>;
134
+ /**
135
+ * Create map task
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * const response = await client.map({ url: 'url' });
140
+ * ```
141
+ */
142
+ map(body: TopLevelAPI.MapParams, options?: RequestOptions): APIPromise<TopLevelAPI.MapResponse>;
143
+ /**
144
+ * Search
145
+ *
146
+ * @example
147
+ * ```ts
148
+ * const response = await client.search({ query: 'x' });
149
+ * ```
150
+ */
151
+ search(body: TopLevelAPI.SearchParams, options?: RequestOptions): APIPromise<TopLevelAPI.SearchResponse>;
152
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
153
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
154
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
155
+ /**
156
+ * Basic re-implementation of `qs.stringify` for primitive types.
157
+ */
158
+ protected stringifyQuery(query: Record<string, unknown>): string;
159
+ private getUserAgent;
160
+ protected defaultIdempotencyKey(): string;
161
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
162
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
163
+ /**
164
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
165
+ */
166
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
167
+ /**
168
+ * Used as a callback for mutating the given `RequestInit` object.
169
+ *
170
+ * This is useful for cases where you want to add certain headers based off of
171
+ * the request properties, e.g. `method` or `url`.
172
+ */
173
+ protected prepareRequest(request: RequestInit, { url, options }: {
174
+ url: string;
175
+ options: FinalRequestOptions;
176
+ }): Promise<void>;
177
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
178
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
179
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
180
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
181
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
182
+ private methodRequest;
183
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
184
+ private makeRequest;
185
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
186
+ private shouldRetry;
187
+ private retryRequest;
188
+ private calculateDefaultRetryTimeoutMillis;
189
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
190
+ retryCount?: number;
191
+ }): Promise<{
192
+ req: FinalizedRequestInit;
193
+ url: string;
194
+ timeout: number;
195
+ }>;
196
+ private buildHeaders;
197
+ private _makeAbort;
198
+ private buildBody;
199
+ static Nimble: typeof Nimble;
200
+ static DEFAULT_TIMEOUT: number;
201
+ static NimbleError: typeof Errors.NimbleError;
202
+ static APIError: typeof Errors.APIError;
203
+ static APIConnectionError: typeof Errors.APIConnectionError;
204
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
205
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
206
+ static NotFoundError: typeof Errors.NotFoundError;
207
+ static ConflictError: typeof Errors.ConflictError;
208
+ static RateLimitError: typeof Errors.RateLimitError;
209
+ static BadRequestError: typeof Errors.BadRequestError;
210
+ static AuthenticationError: typeof Errors.AuthenticationError;
211
+ static InternalServerError: typeof Errors.InternalServerError;
212
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
213
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
214
+ static toFile: typeof Uploads.toFile;
215
+ agent: API.Agent;
216
+ crawl: API.Crawl;
217
+ tasks: API.Tasks;
218
+ }
219
+ export declare namespace Nimble {
220
+ export type RequestOptions = Opts.RequestOptions;
221
+ export { type ExtractResponse as ExtractResponse, type ExtractAsyncResponse as ExtractAsyncResponse, type MapResponse as MapResponse, type SearchResponse as SearchResponse, type ExtractParams as ExtractParams, type ExtractAsyncParams as ExtractAsyncParams, type MapParams as MapParams, type SearchParams as SearchParams, };
222
+ export { Agent as Agent, type AgentListResponse as AgentListResponse, type AgentGetResponse as AgentGetResponse, type AgentRunResponse as AgentRunResponse, type AgentRunAsyncResponse as AgentRunAsyncResponse, type AgentListParams as AgentListParams, type AgentRunParams as AgentRunParams, type AgentRunAsyncParams as AgentRunAsyncParams, };
223
+ export { Crawl as Crawl, type CrawlListResponse as CrawlListResponse, type CrawlRunResponse as CrawlRunResponse, type CrawlStatusResponse as CrawlStatusResponse, type CrawlTerminateResponse as CrawlTerminateResponse, type CrawlListParams as CrawlListParams, type CrawlRunParams as CrawlRunParams, };
224
+ export { Tasks as Tasks, type TaskListResponse as TaskListResponse, type TaskGetResponse as TaskGetResponse, type TaskResultsResponse as TaskResultsResponse, type TaskListParams as TaskListParams, };
225
+ export type AutoScrollAction = API.AutoScrollAction;
226
+ export type ClickAction = API.ClickAction;
227
+ export type EvalAction = API.EvalAction;
228
+ export type FetchAction = API.FetchAction;
229
+ export type FillAction = API.FillAction;
230
+ export type GetCookiesAction = API.GetCookiesAction;
231
+ export type GotoAction = API.GotoAction;
232
+ export type PressAction = API.PressAction;
233
+ export type ScreenshotAction = API.ScreenshotAction;
234
+ export type ScrollAction = API.ScrollAction;
235
+ export type WaitAction = API.WaitAction;
236
+ export type WaitForElementAction = API.WaitForElementAction;
237
+ export type WaitForNavigationAction = API.WaitForNavigationAction;
238
+ }
239
+ //# 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;OAET,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,KAAK,WAAW;OAChB,EACL,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,eAAe,EACf,SAAS,EACT,WAAW,EACX,YAAY,EACZ,cAAc,EACf;OACM,EAAE,UAAU,EAAE;OACd,EACL,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EACjB;OACM,EACL,KAAK,EACL,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,sBAAsB,EACvB;OACM,EACL,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,KAAK,EACN;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,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;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,MAAM;;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,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,OAAoC,EACpC,MAA0C,EAC1C,GAAG,IAAI,EACR,GAAE,aAAkB;IA2BrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD;;;;;;;OAOG;IACH,OAAO,CACL,IAAI,EAAE,WAAW,CAAC,aAAa,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,eAAe,CAAC;IAI1C;;;;;;;OAOG;IACH,YAAY,CACV,IAAI,EAAE,WAAW,CAAC,kBAAkB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,oBAAoB,CAAC;IAI/C;;;;;;;OAOG;IACH,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC;IAI/F;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC;IAIxG,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;cAa5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAO5F;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBhE,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;IAmBT;;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,MAAM,gBAAQ;IACrB,MAAM,CAAC,eAAe,SAAU;IAEhC,MAAM,CAAC,WAAW,4BAAsB;IACxC,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;IACvC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;CACxC;AAMD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC1C,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IACxC,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC1C,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IACxC,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IACxC,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC1C,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC5C,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IACxC,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5D,MAAM,MAAM,uBAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;CACnE"}