wrangler 0.0.0-e043479 → 0.0.0-e0621809

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 (365) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +181 -29
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6368 -0
  6. package/package.json +198 -136
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +238 -0
  9. package/src/__tests__/api-devregistry.test.js +64 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +42 -0
  13. package/src/__tests__/configuration.test.ts +4456 -2178
  14. package/src/__tests__/d1/d1.test.ts +82 -0
  15. package/src/__tests__/d1/execute.test.ts +66 -0
  16. package/src/__tests__/d1/migrate.test.ts +157 -0
  17. package/src/__tests__/d1/splitter.test.ts +255 -0
  18. package/src/__tests__/delete.test.ts +272 -0
  19. package/src/__tests__/deployments.test.ts +369 -0
  20. package/src/__tests__/dev.test.tsx +1605 -235
  21. package/src/__tests__/generate.test.ts +238 -0
  22. package/src/__tests__/get-host-from-url.test.ts +16 -0
  23. package/src/__tests__/guess-worker-format.test.ts +111 -57
  24. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  25. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  26. package/src/__tests__/helpers/mock-account-id.ts +26 -22
  27. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  28. package/src/__tests__/helpers/mock-bin.ts +20 -20
  29. package/src/__tests__/helpers/mock-console.ts +74 -32
  30. package/src/__tests__/helpers/mock-dialogs.ts +107 -33
  31. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  32. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  33. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  34. package/src/__tests__/helpers/mock-istty.ts +74 -0
  35. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  36. package/src/__tests__/helpers/mock-kv.ts +42 -36
  37. package/src/__tests__/helpers/mock-oauth-flow.ts +263 -0
  38. package/src/__tests__/helpers/mock-process.ts +34 -0
  39. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  40. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  41. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  42. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  43. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  44. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  45. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  46. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  47. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  48. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  49. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  50. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  51. package/src/__tests__/helpers/msw/index.ts +52 -0
  52. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  53. package/src/__tests__/helpers/run-in-tmp.ts +29 -20
  54. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  55. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  56. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  58. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  60. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  61. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  62. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  63. package/src/__tests__/https-options.test.ts +163 -0
  64. package/src/__tests__/index.test.ts +264 -850
  65. package/src/__tests__/init.test.ts +3196 -0
  66. package/src/__tests__/jest.setup.ts +158 -48
  67. package/src/__tests__/kv.test.ts +1789 -1398
  68. package/src/__tests__/logger.test.ts +141 -0
  69. package/src/__tests__/logout.test.ts +41 -44
  70. package/src/__tests__/metrics.test.ts +493 -0
  71. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  72. package/src/__tests__/middleware.test.ts +816 -0
  73. package/src/__tests__/mtls-certificates.test.ts +588 -0
  74. package/src/__tests__/package-manager.test.ts +312 -165
  75. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  76. package/src/__tests__/pages/functions-build.test.ts +452 -0
  77. package/src/__tests__/pages/pages.test.ts +81 -0
  78. package/src/__tests__/pages/project-create.test.ts +63 -0
  79. package/src/__tests__/pages/project-list.test.ts +110 -0
  80. package/src/__tests__/pages/project-upload.test.ts +500 -0
  81. package/src/__tests__/pages/publish.test.ts +2820 -0
  82. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  83. package/src/__tests__/parse.test.ts +359 -245
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8373 -2089
  86. package/src/__tests__/pubsub.test.ts +496 -0
  87. package/src/__tests__/queues.test.ts +532 -0
  88. package/src/__tests__/r2.test.ts +369 -193
  89. package/src/__tests__/route.test.ts +45 -0
  90. package/src/__tests__/secret.test.ts +683 -415
  91. package/src/__tests__/tail.test.ts +838 -444
  92. package/src/__tests__/test-old-node-version.js +31 -0
  93. package/src/__tests__/tsconfig-sanity.ts +12 -0
  94. package/src/__tests__/tsconfig.json +8 -0
  95. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  96. package/src/__tests__/type-generation.test.ts +234 -0
  97. package/src/__tests__/user.test.ts +118 -0
  98. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  99. package/src/__tests__/validate-dev-props.test.ts +56 -0
  100. package/src/__tests__/version.test.ts +35 -0
  101. package/src/__tests__/whoami.test.tsx +167 -81
  102. package/src/__tests__/worker-namespace.test.ts +340 -0
  103. package/src/abort.d.ts +3 -0
  104. package/src/api/dev.ts +327 -0
  105. package/src/api/index.ts +11 -0
  106. package/src/api/mtls-certificate.ts +148 -0
  107. package/src/api/pages/create-worker-bundle-contents.ts +75 -0
  108. package/src/api/pages/index.ts +5 -0
  109. package/src/api/pages/publish.tsx +355 -0
  110. package/src/bundle-reporter.ts +68 -0
  111. package/src/bundle.ts +874 -103
  112. package/src/cfetch/index.ts +123 -69
  113. package/src/cfetch/internal.ts +217 -92
  114. package/src/cli.ts +23 -14
  115. package/src/config/README.md +7 -7
  116. package/src/config/config.ts +236 -224
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +545 -256
  119. package/src/config/index.ts +367 -34
  120. package/src/config/validation-helpers.ts +449 -222
  121. package/src/config/validation.ts +2142 -907
  122. package/src/config-cache.ts +85 -0
  123. package/src/create-worker-preview.ts +293 -0
  124. package/src/create-worker-upload-form.ts +342 -0
  125. package/src/d1/backups.tsx +219 -0
  126. package/src/d1/constants.ts +2 -0
  127. package/src/d1/create.tsx +68 -0
  128. package/src/d1/delete.ts +53 -0
  129. package/src/d1/execute.tsx +357 -0
  130. package/src/d1/formatTimeAgo.ts +14 -0
  131. package/src/d1/index.ts +100 -0
  132. package/src/d1/list.tsx +60 -0
  133. package/src/d1/migrations/apply.tsx +212 -0
  134. package/src/d1/migrations/create.tsx +79 -0
  135. package/src/d1/migrations/helpers.ts +172 -0
  136. package/src/d1/migrations/index.ts +3 -0
  137. package/src/d1/migrations/list.tsx +95 -0
  138. package/src/d1/migrations/options.ts +23 -0
  139. package/src/d1/options.ts +22 -0
  140. package/src/d1/splitter.ts +161 -0
  141. package/src/d1/types.ts +25 -0
  142. package/src/d1/utils.ts +49 -0
  143. package/src/delete.ts +100 -0
  144. package/src/deployments.ts +368 -0
  145. package/src/deprecated/index.ts +144 -0
  146. package/src/dev/dev-vars.ts +39 -0
  147. package/src/dev/dev.tsx +600 -0
  148. package/src/dev/get-local-persistence-path.ts +31 -0
  149. package/src/dev/local.tsx +920 -0
  150. package/src/dev/remote.tsx +632 -0
  151. package/src/dev/start-server.ts +540 -0
  152. package/src/dev/use-esbuild.ts +209 -0
  153. package/src/dev/validate-dev-props.ts +40 -0
  154. package/src/dev-registry.ts +201 -0
  155. package/src/dev.tsx +907 -939
  156. package/src/dialogs.ts +136 -0
  157. package/src/dispatch-namespace.ts +211 -0
  158. package/src/docs/index.ts +97 -0
  159. package/src/durable.ts +102 -0
  160. package/src/entry.ts +307 -37
  161. package/src/environment-variables/factory.ts +88 -0
  162. package/src/environment-variables/misc-variables.ts +30 -0
  163. package/src/errors.ts +11 -0
  164. package/src/generate/index.ts +298 -0
  165. package/src/git-client.ts +135 -0
  166. package/src/global-wrangler-config-path.ts +26 -0
  167. package/src/https-options.ts +127 -0
  168. package/src/index.ts +758 -0
  169. package/src/init.ts +1032 -0
  170. package/src/inspect.ts +723 -550
  171. package/src/intl-polyfill.d.ts +139 -0
  172. package/src/is-ci.ts +14 -0
  173. package/src/is-interactive.ts +16 -0
  174. package/src/jest.d.ts +4 -0
  175. package/src/kv/helpers.ts +430 -0
  176. package/src/kv/index.ts +594 -0
  177. package/src/logger.ts +104 -0
  178. package/src/metrics/index.ts +5 -0
  179. package/src/metrics/metrics-config.ts +239 -0
  180. package/src/metrics/metrics-dispatcher.ts +96 -0
  181. package/src/metrics/metrics-usage-headers.ts +24 -0
  182. package/src/metrics/send-event.ts +99 -0
  183. package/src/miniflare-cli/README.md +30 -0
  184. package/src/miniflare-cli/assets.ts +251 -0
  185. package/src/miniflare-cli/index.ts +210 -0
  186. package/src/miniflare-cli/request-context.ts +40 -0
  187. package/src/miniflare-cli/tsconfig.json +9 -0
  188. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  189. package/src/miniflare-cli/types.ts +11 -0
  190. package/src/module-collection.ts +243 -146
  191. package/src/mtls-certificate/cli.ts +155 -0
  192. package/src/open-in-browser.ts +10 -6
  193. package/src/package-manager.ts +183 -90
  194. package/src/pages/build.ts +410 -0
  195. package/src/pages/buildFunctions.ts +140 -0
  196. package/src/pages/constants.ts +18 -0
  197. package/src/pages/deployment-tails.ts +281 -0
  198. package/src/pages/deployments.tsx +84 -0
  199. package/src/pages/dev.ts +716 -0
  200. package/src/pages/errors.ts +67 -0
  201. package/src/pages/functions/buildPlugin.ts +112 -0
  202. package/src/pages/functions/buildWorker.ts +297 -0
  203. package/src/pages/functions/filepath-routing.test.ts +234 -0
  204. package/src/pages/functions/filepath-routing.ts +189 -0
  205. package/src/pages/functions/identifiers.ts +78 -0
  206. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  207. package/src/pages/functions/routes-consolidation.ts +73 -0
  208. package/src/pages/functions/routes-transformation.test.ts +282 -0
  209. package/src/pages/functions/routes-transformation.ts +115 -0
  210. package/src/pages/functions/routes-validation.test.ts +403 -0
  211. package/src/pages/functions/routes-validation.ts +202 -0
  212. package/src/pages/functions/routes.ts +151 -0
  213. package/src/pages/functions/tsconfig.json +8 -0
  214. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  215. package/src/pages/functions.ts +86 -0
  216. package/src/pages/hash.ts +13 -0
  217. package/src/pages/index.ts +102 -0
  218. package/src/pages/projects.tsx +159 -0
  219. package/src/pages/prompt-select-project.tsx +31 -0
  220. package/src/pages/publish.tsx +267 -0
  221. package/src/pages/types.ts +46 -0
  222. package/src/pages/upload.tsx +469 -0
  223. package/src/pages/utils.ts +23 -0
  224. package/src/parse.ts +247 -122
  225. package/src/paths.ts +53 -8
  226. package/src/proxy.ts +636 -318
  227. package/src/publish/index.ts +274 -0
  228. package/src/publish/publish.ts +1065 -0
  229. package/src/pubsub/index.ts +286 -0
  230. package/src/pubsub/pubsub-commands.ts +623 -0
  231. package/src/queues/cli/commands/consumer/add.ts +71 -0
  232. package/src/queues/cli/commands/consumer/index.ts +19 -0
  233. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  234. package/src/queues/cli/commands/create.ts +25 -0
  235. package/src/queues/cli/commands/delete.ts +26 -0
  236. package/src/queues/cli/commands/index.ts +35 -0
  237. package/src/queues/cli/commands/list.ts +25 -0
  238. package/src/queues/client.ts +136 -0
  239. package/src/queues/utils.ts +18 -0
  240. package/src/r2/constants.ts +4 -0
  241. package/src/r2/helpers.ts +132 -0
  242. package/src/r2/index.ts +289 -0
  243. package/src/routes.ts +140 -0
  244. package/src/secret/index.ts +375 -0
  245. package/src/selfsigned.d.ts +29 -0
  246. package/src/sites.ts +372 -0
  247. package/src/tail/createTail.ts +406 -0
  248. package/src/tail/filters.ts +109 -111
  249. package/src/tail/index.ts +208 -296
  250. package/src/tail/printing.ts +107 -47
  251. package/src/tsconfig-sanity.ts +16 -0
  252. package/src/type-generation.ts +181 -0
  253. package/src/update-check.ts +19 -0
  254. package/src/user/access.ts +68 -0
  255. package/src/user/auth-variables.ts +113 -0
  256. package/src/user/choose-account.tsx +39 -0
  257. package/src/user/generate-auth-url.ts +33 -0
  258. package/src/user/generate-random-state.ts +16 -0
  259. package/src/user/index.ts +2 -0
  260. package/src/user/user.ts +1233 -0
  261. package/src/utils/collectKeyValues.ts +14 -0
  262. package/src/utils/render.ts +93 -0
  263. package/src/whoami.ts +135 -0
  264. package/src/worker.ts +264 -0
  265. package/src/yargs-types.ts +37 -0
  266. package/src/zones.ts +191 -0
  267. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  268. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  269. package/templates/__tests__/tsconfig.json +8 -0
  270. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  271. package/templates/checked-fetch.js +23 -0
  272. package/templates/d1-beta-facade.js +244 -0
  273. package/templates/facade.d.ts +14 -0
  274. package/templates/first-party-worker-module-facade.ts +19 -0
  275. package/templates/format-dev-errors.ts +34 -0
  276. package/templates/gitignore +172 -0
  277. package/templates/init-tests/test-jest-new-worker.js +23 -0
  278. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  279. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  280. package/templates/middleware/common.ts +62 -0
  281. package/templates/middleware/loader-modules.ts +84 -0
  282. package/templates/middleware/loader-sw.ts +233 -0
  283. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  284. package/templates/middleware/middleware-pretty-error.ts +40 -0
  285. package/templates/middleware/middleware-scheduled.ts +15 -0
  286. package/templates/new-worker-scheduled.js +17 -0
  287. package/templates/new-worker-scheduled.ts +32 -0
  288. package/templates/new-worker.js +3 -3
  289. package/templates/new-worker.ts +21 -3
  290. package/templates/no-op-worker.js +10 -0
  291. package/templates/pages-dev-pipeline.ts +31 -0
  292. package/templates/pages-dev-util.ts +52 -0
  293. package/templates/pages-shim.ts +12 -0
  294. package/templates/pages-template-plugin.ts +180 -0
  295. package/templates/pages-template-worker.ts +189 -0
  296. package/templates/serve-static-assets.ts +66 -0
  297. package/templates/service-bindings-module-facade.js +55 -0
  298. package/templates/service-bindings-sw-facade.js +42 -0
  299. package/templates/tsconfig-sanity.ts +11 -0
  300. package/templates/tsconfig.init.json +105 -0
  301. package/templates/tsconfig.json +6 -103
  302. package/templates/tsconfig.tsbuildinfo +1 -0
  303. package/wrangler-dist/cli.d.ts +1619 -0
  304. package/wrangler-dist/cli.js +141446 -128789
  305. package/wrangler-dist/wasm-sync.wasm +0 -0
  306. package/pages/functions/buildWorker.ts +0 -62
  307. package/pages/functions/filepath-routing.test.ts +0 -123
  308. package/pages/functions/filepath-routing.ts +0 -178
  309. package/pages/functions/identifiers.ts +0 -78
  310. package/pages/functions/routes.ts +0 -151
  311. package/pages/functions/template-worker.ts +0 -130
  312. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  313. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  314. package/src/__tests__/helpers/mock-user.ts +0 -27
  315. package/src/__tests__/sentry.test.ts +0 -146
  316. package/src/api/form_data.ts +0 -217
  317. package/src/api/preview.ts +0 -147
  318. package/src/api/worker.ts +0 -186
  319. package/src/dialogs.tsx +0 -77
  320. package/src/environment-variables.ts +0 -33
  321. package/src/guess-worker-format.ts +0 -68
  322. package/src/index.tsx +0 -2302
  323. package/src/kv.tsx +0 -339
  324. package/src/pages.tsx +0 -1045
  325. package/src/publish.ts +0 -363
  326. package/src/r2.ts +0 -50
  327. package/src/reporting.ts +0 -115
  328. package/src/sites.tsx +0 -238
  329. package/src/user.tsx +0 -1063
  330. package/src/whoami.tsx +0 -69
  331. package/templates/static-asset-facade.js +0 -47
  332. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  333. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  334. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  335. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  336. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  337. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  338. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  339. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  340. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  341. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  342. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  343. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  344. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  345. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  346. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  347. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  348. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  349. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  350. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  351. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  352. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  353. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  354. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  355. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  356. package/vendor/wrangler-mime/LICENSE +0 -21
  357. package/vendor/wrangler-mime/Mime.js +0 -97
  358. package/vendor/wrangler-mime/README.md +0 -187
  359. package/vendor/wrangler-mime/cli.js +0 -46
  360. package/vendor/wrangler-mime/index.js +0 -4
  361. package/vendor/wrangler-mime/lite.js +0 -4
  362. package/vendor/wrangler-mime/package.json +0 -52
  363. package/vendor/wrangler-mime/types/other.js +0 -1
  364. package/vendor/wrangler-mime/types/standard.js +0 -1
  365. package/wrangler-dist/cli.js.map +0 -7
package/src/kv.tsx DELETED
@@ -1,339 +0,0 @@
1
- import { URLSearchParams } from "node:url";
2
- import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
3
- import type { Config, Environment } from "./config";
4
-
5
- /** The largest number of kv items we can pass to the API in a single request. */
6
- const API_MAX = 10000;
7
- // The const below are halved from the API's true capacity to help avoid
8
- // hammering it with large requests.
9
- const BATCH_KEY_MAX = API_MAX / 2;
10
-
11
- type KvArgs = {
12
- binding?: string;
13
- "namespace-id"?: string;
14
- env?: string;
15
- preview?: boolean;
16
- };
17
-
18
- /**
19
- * Create a new namespace under the given `accountId` with the given `title`.
20
- *
21
- * @returns the generated id of the created namespace.
22
- */
23
- export async function createNamespace(
24
- accountId: string,
25
- title: string
26
- ): Promise<string> {
27
- const response = await fetchResult<{ id: string }>(
28
- `/accounts/${accountId}/storage/kv/namespaces`,
29
- {
30
- method: "POST",
31
- headers: {
32
- "Content-Type": "application/json",
33
- },
34
- body: JSON.stringify({
35
- title,
36
- }),
37
- }
38
- );
39
-
40
- return response.id;
41
- }
42
-
43
- /**
44
- * The information about a namespace that is returned from `listNamespaces()`.
45
- */
46
- export interface KVNamespaceInfo {
47
- id: string;
48
- title: string;
49
- supports_url_encoding?: boolean;
50
- }
51
-
52
- /**
53
- * Fetch a list of all the namespaces under the given `accountId`.
54
- */
55
- export async function listNamespaces(
56
- accountId: string
57
- ): Promise<KVNamespaceInfo[]> {
58
- const pageSize = 100;
59
- let page = 1;
60
- const results: KVNamespaceInfo[] = [];
61
- while (results.length % pageSize === 0) {
62
- const json = await fetchResult<KVNamespaceInfo[]>(
63
- `/accounts/${accountId}/storage/kv/namespaces`,
64
- {},
65
- new URLSearchParams({
66
- per_page: pageSize.toString(),
67
- order: "title",
68
- direction: "asc",
69
- page: page.toString(),
70
- })
71
- );
72
- page++;
73
- results.push(...json);
74
- if (json.length < pageSize) {
75
- break;
76
- }
77
- }
78
- return results;
79
- }
80
-
81
- export interface NamespaceKeyInfo {
82
- name: string;
83
- expiration?: number;
84
- metadata?: { [key: string]: unknown };
85
- }
86
-
87
- export async function listNamespaceKeys(
88
- accountId: string,
89
- namespaceId: string,
90
- prefix = ""
91
- ) {
92
- return await fetchListResult<NamespaceKeyInfo>(
93
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
94
- {},
95
- new URLSearchParams({ prefix })
96
- );
97
- }
98
-
99
- /**
100
- * Information about a key-value pair, including its "metadata" fields.
101
- */
102
- export interface KeyValue {
103
- key: string;
104
- value: string;
105
- expiration?: number;
106
- expiration_ttl?: number;
107
- metadata?: object;
108
- base64?: boolean;
109
- }
110
-
111
- const KeyValueKeys = new Set([
112
- "key",
113
- "value",
114
- "expiration",
115
- "expiration_ttl",
116
- "metadata",
117
- "base64",
118
- ]);
119
-
120
- /**
121
- * Is the given object a valid `KeyValue` type?
122
- */
123
- export function isKeyValue(keyValue: object): keyValue is KeyValue {
124
- const props = Object.keys(keyValue);
125
- if (!props.includes("key") || !props.includes("value")) {
126
- return false;
127
- }
128
- return true;
129
- }
130
-
131
- /**
132
- * Get all the properties on the `keyValue` that are not expected.
133
- */
134
- export function unexpectedKeyValueProps(keyValue: KeyValue): string[] {
135
- const props = Object.keys(keyValue);
136
- return props.filter((prop) => !KeyValueKeys.has(prop));
137
- }
138
-
139
- export async function putKeyValue(
140
- accountId: string,
141
- namespaceId: string,
142
- keyValue: KeyValue
143
- ) {
144
- let searchParams: URLSearchParams | undefined;
145
- if (keyValue.expiration || keyValue.expiration_ttl) {
146
- searchParams = new URLSearchParams();
147
- if (keyValue.expiration) {
148
- searchParams.set("expiration", `${keyValue.expiration}`);
149
- }
150
- if (keyValue.expiration_ttl) {
151
- searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
152
- }
153
- }
154
- return await fetchResult(
155
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${keyValue.key}`,
156
- { method: "PUT", body: keyValue.value },
157
- searchParams
158
- );
159
- }
160
-
161
- export async function getKeyValue(
162
- accountId: string,
163
- namespaceId: string,
164
- key: string
165
- ): Promise<string> {
166
- return await fetchKVGetValue(accountId, namespaceId, key);
167
- }
168
-
169
- export async function putBulkKeyValue(
170
- accountId: string,
171
- namespaceId: string,
172
- keyValues: KeyValue[],
173
- progressCallback: (index: number, total: number) => void
174
- ) {
175
- for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
176
- if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
177
- progressCallback(index, keyValues.length);
178
- }
179
-
180
- await fetchResult(
181
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
182
- {
183
- method: "PUT",
184
- body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
185
- headers: { "Content-Type": "application/json" },
186
- }
187
- );
188
- }
189
- if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
190
- progressCallback(keyValues.length, keyValues.length);
191
- }
192
- }
193
-
194
- export async function deleteBulkKeyValue(
195
- accountId: string,
196
- namespaceId: string,
197
- keys: string[],
198
- progressCallback: (index: number, total: number) => void
199
- ) {
200
- for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
201
- if (progressCallback && keys.length > BATCH_KEY_MAX) {
202
- progressCallback(index, keys.length);
203
- }
204
-
205
- await fetchResult(
206
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
207
- {
208
- method: "DELETE",
209
- body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
210
- headers: { "Content-Type": "application/json" },
211
- }
212
- );
213
- }
214
- if (progressCallback && keys.length > BATCH_KEY_MAX) {
215
- progressCallback(keys.length, keys.length);
216
- }
217
- }
218
-
219
- export function getNamespaceId(
220
- { preview, binding, "namespace-id": namespaceId, env }: KvArgs,
221
- configOrEnv: Config | Environment | undefined
222
- ): string {
223
- // nice
224
- if (namespaceId) {
225
- return namespaceId;
226
- }
227
-
228
- // begin pre-flight checks
229
-
230
- // `--binding` is only valid if there's a wrangler configuration.
231
- if (binding && !configOrEnv) {
232
- throw new Error("--binding specified, but no config file was found.");
233
- }
234
-
235
- // there's no config. abort here
236
- if (!configOrEnv) {
237
- throw new Error(
238
- "Failed to find a config file.\n" +
239
- "Either use --namespace-id to upload directly or create a configuration file with a binding."
240
- );
241
- }
242
-
243
- // they want to use an environment, actually
244
- if (env) {
245
- if (!("env" in configOrEnv) || !configOrEnv.env[env]) {
246
- throw new Error(
247
- `Failed to find environment "${env}" in configuration file!`
248
- );
249
- }
250
- return getNamespaceId(
251
- {
252
- binding,
253
- "namespace-id": namespaceId,
254
- preview,
255
- },
256
- configOrEnv.env[env]
257
- );
258
- }
259
-
260
- // there's no KV namespaces
261
- if (!configOrEnv.kv_namespaces || configOrEnv.kv_namespaces.length === 0) {
262
- throw new Error(
263
- "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
264
- );
265
- }
266
-
267
- const namespace = configOrEnv.kv_namespaces.find(
268
- (ns) => ns.binding === binding
269
- );
270
-
271
- // we couldn't find a namespace with that binding
272
- if (!namespace) {
273
- throw new Error(
274
- `A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
275
- );
276
- }
277
-
278
- // end pre-flight checks
279
-
280
- // we're in preview mode, `--preview true` or `--preview` was passed
281
- if (preview && namespace.preview_id) {
282
- namespaceId = namespace.preview_id;
283
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
284
- return namespaceId;
285
- } else if (preview) {
286
- throw new Error(
287
- `No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
288
- );
289
- }
290
-
291
- // either `--preview false`, or preview wasn't passed
292
- // TODO: should we care? or should we just treat false and undefined the same
293
- const previewIsDefined = typeof preview !== "undefined";
294
-
295
- // --preview false was passed
296
- if (previewIsDefined && namespace.id) {
297
- namespaceId = namespace.id;
298
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
299
- return namespaceId;
300
- } else if (previewIsDefined) {
301
- throw new Error(
302
- `No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
303
- );
304
- }
305
-
306
- // `--preview` wasn't passed
307
- const bindingHasOnlyOneId =
308
- (namespace.id && !namespace.preview_id) ||
309
- (!namespace.id && namespace.preview_id);
310
- if (bindingHasOnlyOneId) {
311
- namespaceId = namespace.id || namespace.preview_id;
312
- } else {
313
- throw new Error(
314
- `${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
315
- );
316
- }
317
-
318
- // shouldn't happen. we should be able to prove this with strong typing.
319
- // TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
320
- if (!namespaceId) {
321
- throw Error(
322
- "Something went wrong trying to determine which namespace to upload to.\n" +
323
- "Please create a github issue with the command you just ran along with your wrangler configuration."
324
- );
325
- }
326
-
327
- return namespaceId;
328
- }
329
-
330
- /**
331
- * KV namespace binding names must be valid JS identifiers.
332
- */
333
- export function isValidNamespaceBinding(
334
- binding: string | undefined
335
- ): binding is string {
336
- return (
337
- typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
338
- );
339
- }