wrangler 0.0.0-e3a458e → 0.0.0-e3c036d7

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 (361) 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 +193 -142
  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 +4454 -2590
  14. package/src/__tests__/d1/d1.test.ts +82 -0
  15. package/src/__tests__/d1/execute.test.ts +64 -0
  16. package/src/__tests__/d1/migrate.test.ts +155 -0
  17. package/src/__tests__/d1/splitter.test.ts +255 -0
  18. package/src/__tests__/delete.test.ts +266 -0
  19. package/src/__tests__/deployments.test.ts +129 -0
  20. package/src/__tests__/dev.test.tsx +1589 -432
  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 +113 -51
  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 +24 -24
  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 +68 -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 +41 -28
  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 +93 -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 +50 -0
  52. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  53. package/src/__tests__/helpers/run-in-tmp.ts +28 -22
  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 +8 -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 +144 -108
  64. package/src/__tests__/index.test.ts +258 -975
  65. package/src/__tests__/init.test.ts +3165 -0
  66. package/src/__tests__/jest.setup.ts +154 -48
  67. package/src/__tests__/kv.test.ts +1789 -1372
  68. package/src/__tests__/logger.test.ts +141 -0
  69. package/src/__tests__/logout.test.ts +36 -41
  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 +585 -0
  74. package/src/__tests__/package-manager.test.ts +312 -165
  75. package/src/__tests__/pages/deployment-list.test.ts +78 -0
  76. package/src/__tests__/pages/functions-build.test.ts +453 -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 +108 -0
  80. package/src/__tests__/pages/project-upload.test.ts +481 -0
  81. package/src/__tests__/pages/publish.test.ts +2745 -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 +8209 -2558
  86. package/src/__tests__/pubsub.test.ts +493 -0
  87. package/src/__tests__/queues.test.ts +529 -0
  88. package/src/__tests__/r2.test.ts +369 -193
  89. package/src/__tests__/route.test.ts +22 -22
  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 +166 -94
  102. package/src/__tests__/worker-namespace.test.ts +339 -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 +375 -0
  110. package/src/bundle-reporter.ts +68 -0
  111. package/src/bundle.ts +858 -110
  112. package/src/cfetch/index.ts +123 -69
  113. package/src/cfetch/internal.ts +217 -98
  114. package/src/cli.ts +23 -14
  115. package/src/config/README.md +7 -7
  116. package/src/config/config.ts +232 -229
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +542 -256
  119. package/src/config/index.ts +367 -34
  120. package/src/config/validation-helpers.ts +415 -286
  121. package/src/config/validation.ts +2137 -942
  122. package/src/config-cache.ts +85 -0
  123. package/src/create-worker-preview.ts +251 -124
  124. package/src/create-worker-upload-form.ts +326 -201
  125. package/src/d1/backups.tsx +215 -0
  126. package/src/d1/constants.ts +2 -0
  127. package/src/d1/create.tsx +64 -0
  128. package/src/d1/delete.ts +53 -0
  129. package/src/d1/execute.tsx +354 -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 +206 -0
  134. package/src/d1/migrations/create.tsx +76 -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 +92 -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 +116 -0
  145. package/src/deprecated/index.ts +144 -0
  146. package/src/dev/dev-vars.ts +39 -0
  147. package/src/dev/dev.tsx +544 -306
  148. package/src/dev/get-local-persistence-path.ts +31 -0
  149. package/src/dev/local.tsx +906 -233
  150. package/src/dev/remote.tsx +621 -192
  151. package/src/dev/start-server.ts +540 -0
  152. package/src/dev/use-esbuild.ts +189 -80
  153. package/src/dev/validate-dev-props.ts +40 -0
  154. package/src/dev-registry.ts +201 -0
  155. package/src/dev.tsx +928 -0
  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 +277 -109
  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 +85 -80
  168. package/src/index.ts +705 -0
  169. package/src/init.ts +1023 -0
  170. package/src/inspect.ts +722 -557
  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 +98 -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 +241 -227
  191. package/src/mtls-certificate/cli.ts +155 -0
  192. package/src/open-in-browser.ts +8 -16
  193. package/src/package-manager.ts +183 -90
  194. package/src/pages/build.ts +252 -0
  195. package/src/pages/buildFunctions.ts +133 -0
  196. package/src/pages/constants.ts +18 -0
  197. package/src/pages/deployment-tails.ts +281 -0
  198. package/src/pages/deployments.tsx +86 -0
  199. package/src/pages/dev.ts +726 -0
  200. package/src/pages/errors.ts +66 -0
  201. package/src/pages/functions/buildPlugin.ts +97 -0
  202. package/src/pages/functions/buildWorker.ts +294 -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 +162 -0
  219. package/src/pages/prompt-select-project.tsx +31 -0
  220. package/src/pages/publish.tsx +276 -0
  221. package/src/pages/types.ts +46 -0
  222. package/src/pages/upload.tsx +449 -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 +629 -375
  227. package/src/publish/index.ts +274 -0
  228. package/src/publish/publish.ts +1076 -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 +65 -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 +135 -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 +23 -23
  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/whoami.ts +135 -0
  263. package/src/worker.ts +201 -100
  264. package/src/yargs-types.ts +37 -0
  265. package/src/zones.ts +191 -0
  266. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  267. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  268. package/templates/__tests__/tsconfig.json +8 -0
  269. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  270. package/templates/checked-fetch.js +23 -0
  271. package/templates/d1-beta-facade.js +241 -0
  272. package/templates/facade.d.ts +14 -0
  273. package/templates/first-party-worker-module-facade.ts +19 -0
  274. package/templates/format-dev-errors.ts +34 -0
  275. package/templates/gitignore +172 -0
  276. package/templates/init-tests/test-jest-new-worker.js +23 -0
  277. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  278. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  279. package/templates/middleware/common.ts +62 -0
  280. package/templates/middleware/loader-modules.ts +84 -0
  281. package/templates/middleware/loader-sw.ts +233 -0
  282. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  283. package/templates/middleware/middleware-pretty-error.ts +40 -0
  284. package/templates/middleware/middleware-scheduled.ts +15 -0
  285. package/templates/new-worker-scheduled.js +17 -0
  286. package/templates/new-worker-scheduled.ts +32 -0
  287. package/templates/new-worker.js +3 -3
  288. package/templates/new-worker.ts +21 -3
  289. package/templates/no-op-worker.js +10 -0
  290. package/templates/pages-dev-pipeline.ts +31 -0
  291. package/templates/pages-dev-util.ts +52 -0
  292. package/templates/pages-shim.ts +12 -0
  293. package/templates/pages-template-plugin.ts +180 -0
  294. package/templates/pages-template-worker.ts +189 -0
  295. package/templates/serve-static-assets.ts +66 -0
  296. package/templates/service-bindings-module-facade.js +55 -0
  297. package/templates/service-bindings-sw-facade.js +42 -0
  298. package/templates/tsconfig-sanity.ts +11 -0
  299. package/templates/tsconfig.init.json +106 -0
  300. package/templates/tsconfig.json +6 -103
  301. package/templates/tsconfig.tsbuildinfo +1 -0
  302. package/wrangler-dist/cli.d.ts +1624 -0
  303. package/wrangler-dist/cli.js +139300 -128984
  304. package/wrangler-dist/wasm-sync.wasm +0 -0
  305. package/pages/functions/buildWorker.ts +0 -62
  306. package/pages/functions/filepath-routing.test.ts +0 -223
  307. package/pages/functions/filepath-routing.ts +0 -181
  308. package/pages/functions/identifiers.ts +0 -78
  309. package/pages/functions/routes.ts +0 -151
  310. package/pages/functions/template-worker.ts +0 -130
  311. package/src/__tests__/dev2.test.tsx +0 -154
  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__/pages.test.ts +0 -44
  315. package/src/__tests__/sentry.test.ts +0 -146
  316. package/src/dialogs.tsx +0 -77
  317. package/src/environment-variables.ts +0 -33
  318. package/src/index.tsx +0 -2365
  319. package/src/kv.ts +0 -339
  320. package/src/pages.tsx +0 -1045
  321. package/src/publish.ts +0 -354
  322. package/src/r2.ts +0 -50
  323. package/src/reporting.ts +0 -131
  324. package/src/sites.tsx +0 -273
  325. package/src/user.tsx +0 -1118
  326. package/src/whoami.tsx +0 -69
  327. package/templates/static-asset-facade.js +0 -47
  328. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  329. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  330. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  331. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  332. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  333. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  334. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  335. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  336. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  337. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  338. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  339. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  340. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  341. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  342. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  343. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  344. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  345. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  346. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  347. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  348. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  349. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  350. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  351. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  352. package/vendor/wrangler-mime/LICENSE +0 -21
  353. package/vendor/wrangler-mime/Mime.js +0 -97
  354. package/vendor/wrangler-mime/README.md +0 -187
  355. package/vendor/wrangler-mime/cli.js +0 -46
  356. package/vendor/wrangler-mime/index.js +0 -4
  357. package/vendor/wrangler-mime/lite.js +0 -4
  358. package/vendor/wrangler-mime/package.json +0 -52
  359. package/vendor/wrangler-mime/types/other.js +0 -1
  360. package/vendor/wrangler-mime/types/standard.js +0 -1
  361. package/wrangler-dist/cli.js.map +0 -7
@@ -0,0 +1,594 @@
1
+ import { StringDecoder } from "node:string_decoder";
2
+ import { readConfig } from "../config";
3
+ import { confirm } from "../dialogs";
4
+ import {
5
+ demandOneOfOption,
6
+ printWranglerBanner,
7
+ CommandLineArgsError,
8
+ } from "../index";
9
+ import { logger } from "../logger";
10
+ import * as metrics from "../metrics";
11
+ import { parseJSON, readFileSync, readFileSyncToBuffer } from "../parse";
12
+ import { requireAuth } from "../user";
13
+ import {
14
+ createKVNamespace,
15
+ deleteKVNamespace,
16
+ getKVNamespaceId,
17
+ isValidKVNamespaceBinding,
18
+ listKVNamespaces,
19
+ deleteKVBulkKeyValue,
20
+ deleteKVKeyValue,
21
+ getKVKeyValue,
22
+ isKVKeyValue,
23
+ listKVNamespaceKeys,
24
+ putKVBulkKeyValue,
25
+ putKVKeyValue,
26
+ unexpectedKVKeyValueProps,
27
+ } from "./helpers";
28
+ import type { CommonYargsArgv } from "../yargs-types";
29
+ import type { KeyValue } from "./helpers";
30
+
31
+ export function kvNamespace(kvYargs: CommonYargsArgv) {
32
+ return kvYargs
33
+ .command(
34
+ "create <namespace>",
35
+ "Create a new namespace",
36
+ (yargs) => {
37
+ return yargs
38
+ .positional("namespace", {
39
+ describe: "The name of the new namespace",
40
+ type: "string",
41
+ demandOption: true,
42
+ })
43
+ .option("preview", {
44
+ type: "boolean",
45
+ describe: "Interact with a preview namespace",
46
+ });
47
+ },
48
+ async (args) => {
49
+ await printWranglerBanner();
50
+
51
+ if (!isValidKVNamespaceBinding(args.namespace)) {
52
+ throw new CommandLineArgsError(
53
+ `The namespace binding name "${args.namespace}" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.`
54
+ );
55
+ }
56
+
57
+ const config = readConfig(args.config, args);
58
+ if (!config.name) {
59
+ logger.warn(
60
+ "No configured name present, using `worker` as a prefix for the title"
61
+ );
62
+ }
63
+
64
+ const name = config.name || "worker";
65
+ const environment = args.env ? `-${args.env}` : "";
66
+ const preview = args.preview ? "_preview" : "";
67
+ const title = `${name}${environment}-${args.namespace}${preview}`;
68
+
69
+ const accountId = await requireAuth(config);
70
+
71
+ // TODO: generate a binding name stripping non alphanumeric chars
72
+
73
+ logger.log(`🌀 Creating namespace with title "${title}"`);
74
+ const namespaceId = await createKVNamespace(accountId, title);
75
+ await metrics.sendMetricsEvent("create kv namespace", {
76
+ sendMetrics: config.send_metrics,
77
+ });
78
+
79
+ logger.log("✨ Success!");
80
+ const envString = args.env ? ` under [env.${args.env}]` : "";
81
+ const previewString = args.preview ? "preview_" : "";
82
+ logger.log(
83
+ `Add the following to your configuration file in your kv_namespaces array${envString}:`
84
+ );
85
+ logger.log(
86
+ `{ binding = "${args.namespace}", ${previewString}id = "${namespaceId}" }`
87
+ );
88
+
89
+ // TODO: automatically write this block to the wrangler.toml config file??
90
+ }
91
+ )
92
+ .command(
93
+ "list",
94
+ "Outputs a list of all KV namespaces associated with your account id.",
95
+ (listArgs) => listArgs,
96
+ async (args) => {
97
+ const config = readConfig(args.config, args);
98
+
99
+ const accountId = await requireAuth(config);
100
+
101
+ // TODO: we should show bindings if they exist for given ids
102
+
103
+ logger.log(
104
+ JSON.stringify(await listKVNamespaces(accountId), null, " ")
105
+ );
106
+ await metrics.sendMetricsEvent("list kv namespaces", {
107
+ sendMetrics: config.send_metrics,
108
+ });
109
+ }
110
+ )
111
+ .command(
112
+ "delete",
113
+ "Deletes a given namespace.",
114
+ (yargs) => {
115
+ return yargs
116
+ .option("binding", {
117
+ type: "string",
118
+ requiresArg: true,
119
+ describe: "The name of the namespace to delete",
120
+ })
121
+ .option("namespace-id", {
122
+ type: "string",
123
+ requiresArg: true,
124
+ describe: "The id of the namespace to delete",
125
+ })
126
+ .check(demandOneOfOption("binding", "namespace-id"))
127
+ .option("preview", {
128
+ type: "boolean",
129
+ describe: "Interact with a preview namespace",
130
+ });
131
+ },
132
+ async (args) => {
133
+ await printWranglerBanner();
134
+ const config = readConfig(args.config, args);
135
+
136
+ let id;
137
+ try {
138
+ id = getKVNamespaceId(args, config);
139
+ } catch (e) {
140
+ throw new CommandLineArgsError(
141
+ "Not able to delete namespace.\n" + ((e as Error).message ?? e)
142
+ );
143
+ }
144
+
145
+ const accountId = await requireAuth(config);
146
+
147
+ logger.log(`Deleting KV namespace ${id}.`);
148
+ await deleteKVNamespace(accountId, id);
149
+ logger.log(`Deleted KV namespace ${id}.`);
150
+ await metrics.sendMetricsEvent("delete kv namespace", {
151
+ sendMetrics: config.send_metrics,
152
+ });
153
+
154
+ // TODO: recommend they remove it from wrangler.toml
155
+
156
+ // test-mf wrangler kv:namespace delete --namespace-id 2a7d3d8b23fc4159b5afa489d6cfd388
157
+ // Are you sure you want to delete namespace 2a7d3d8b23fc4159b5afa489d6cfd388? [y/n]
158
+ // n
159
+ // 💁 Not deleting namespace 2a7d3d8b23fc4159b5afa489d6cfd388
160
+ // ➜ test-mf wrangler kv:namespace delete --namespace-id 2a7d3d8b23fc4159b5afa489d6cfd388
161
+ // Are you sure you want to delete namespace 2a7d3d8b23fc4159b5afa489d6cfd388? [y/n]
162
+ // y
163
+ // 🌀 Deleting namespace 2a7d3d8b23fc4159b5afa489d6cfd388
164
+ // ✨ Success
165
+ // ⚠️ Make sure to remove this "kv-namespace" entry from your configuration file!
166
+ // ➜ test-mf
167
+
168
+ // TODO: do it automatically
169
+
170
+ // TODO: delete the preview namespace as well?
171
+ }
172
+ );
173
+ }
174
+
175
+ export const kvKey = (kvYargs: CommonYargsArgv) => {
176
+ return kvYargs
177
+ .command(
178
+ "put <key> [value]",
179
+ "Writes a single key/value pair to the given namespace.",
180
+ (yargs) => {
181
+ return yargs
182
+ .positional("key", {
183
+ type: "string",
184
+ describe: "The key to write to",
185
+ demandOption: true,
186
+ })
187
+ .positional("value", {
188
+ type: "string",
189
+ describe: "The value to write",
190
+ })
191
+ .option("binding", {
192
+ type: "string",
193
+ requiresArg: true,
194
+ describe: "The binding of the namespace to write to",
195
+ })
196
+ .option("namespace-id", {
197
+ type: "string",
198
+ requiresArg: true,
199
+ describe: "The id of the namespace to write to",
200
+ })
201
+ .check(demandOneOfOption("binding", "namespace-id"))
202
+ .option("preview", {
203
+ type: "boolean",
204
+ describe: "Interact with a preview namespace",
205
+ })
206
+ .option("ttl", {
207
+ type: "number",
208
+ describe: "Time for which the entries should be visible",
209
+ })
210
+ .option("expiration", {
211
+ type: "number",
212
+ describe: "Time since the UNIX epoch after which the entry expires",
213
+ })
214
+ .option("metadata", {
215
+ type: "string",
216
+ describe: "Arbitrary JSON that is associated with a key",
217
+ coerce: (jsonStr: string): KeyValue["metadata"] => {
218
+ try {
219
+ return JSON.parse(jsonStr);
220
+ } catch (_) {}
221
+ },
222
+ })
223
+ .option("path", {
224
+ type: "string",
225
+ requiresArg: true,
226
+ describe: "Read value from the file at a given path",
227
+ })
228
+ .check(demandOneOfOption("value", "path"));
229
+ },
230
+ async ({ key, ttl, expiration, metadata, ...args }) => {
231
+ await printWranglerBanner();
232
+ const config = readConfig(args.config, args);
233
+ const namespaceId = getKVNamespaceId(args, config);
234
+ // One of `args.path` and `args.value` must be defined
235
+ const value = args.path
236
+ ? readFileSyncToBuffer(args.path)
237
+ : // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
238
+ args.value!;
239
+
240
+ const metadataLog = metadata
241
+ ? ` with metadata "${JSON.stringify(metadata)}"`
242
+ : "";
243
+
244
+ if (args.path) {
245
+ logger.log(
246
+ `Writing the contents of ${args.path} to the key "${key}" on namespace ${namespaceId}${metadataLog}.`
247
+ );
248
+ } else {
249
+ logger.log(
250
+ `Writing the value "${value}" to key "${key}" on namespace ${namespaceId}${metadataLog}.`
251
+ );
252
+ }
253
+
254
+ const accountId = await requireAuth(config);
255
+
256
+ await putKVKeyValue(accountId, namespaceId, {
257
+ key,
258
+ value,
259
+ expiration,
260
+ expiration_ttl: ttl,
261
+ metadata: metadata as KeyValue["metadata"],
262
+ });
263
+ await metrics.sendMetricsEvent("write kv key-value", {
264
+ sendMetrics: config.send_metrics,
265
+ });
266
+ }
267
+ )
268
+ .command(
269
+ "list",
270
+ "Outputs a list of all keys in a given namespace.",
271
+ (yargs) => {
272
+ return yargs
273
+ .option("binding", {
274
+ type: "string",
275
+ requiresArg: true,
276
+ describe: "The name of the namespace to list",
277
+ })
278
+ .option("namespace-id", {
279
+ type: "string",
280
+ requiresArg: true,
281
+ describe: "The id of the namespace to list",
282
+ })
283
+ .check(demandOneOfOption("binding", "namespace-id"))
284
+ .option("preview", {
285
+ type: "boolean",
286
+ // In the case of listing keys we will default to non-preview mode
287
+ default: false,
288
+ describe: "Interact with a preview namespace",
289
+ })
290
+ .option("prefix", {
291
+ type: "string",
292
+ requiresArg: true,
293
+ describe: "A prefix to filter listed keys",
294
+ });
295
+ },
296
+ async ({ prefix, ...args }) => {
297
+ // TODO: support for limit+cursor (pagination)
298
+ const config = readConfig(args.config, args);
299
+ const namespaceId = getKVNamespaceId(args, config);
300
+
301
+ const accountId = await requireAuth(config);
302
+
303
+ const results = await listKVNamespaceKeys(
304
+ accountId,
305
+ namespaceId,
306
+ prefix
307
+ );
308
+ logger.log(JSON.stringify(results, undefined, 2));
309
+ await metrics.sendMetricsEvent("list kv keys", {
310
+ sendMetrics: config.send_metrics,
311
+ });
312
+ }
313
+ )
314
+ .command(
315
+ "get <key>",
316
+ "Reads a single value by key from the given namespace.",
317
+ (yargs) => {
318
+ return yargs
319
+ .positional("key", {
320
+ describe: "The key value to get.",
321
+ type: "string",
322
+ demandOption: true,
323
+ })
324
+ .option("binding", {
325
+ type: "string",
326
+ requiresArg: true,
327
+ describe: "The name of the namespace to get from",
328
+ })
329
+ .option("namespace-id", {
330
+ type: "string",
331
+ requiresArg: true,
332
+ describe: "The id of the namespace to get from",
333
+ })
334
+ .check(demandOneOfOption("binding", "namespace-id"))
335
+ .option("preview", {
336
+ type: "boolean",
337
+ describe: "Interact with a preview namespace",
338
+ })
339
+ .option("preview", {
340
+ type: "boolean",
341
+ // In the case of getting key values we will default to non-preview mode
342
+ default: false,
343
+ describe: "Interact with a preview namespace",
344
+ })
345
+ .option("text", {
346
+ type: "boolean",
347
+ default: false,
348
+ describe: "Decode the returned value as a utf8 string",
349
+ });
350
+ },
351
+ async ({ key, ...args }) => {
352
+ const config = readConfig(args.config, args);
353
+ const namespaceId = getKVNamespaceId(args, config);
354
+
355
+ const accountId = await requireAuth(config);
356
+ const bufferKVValue = Buffer.from(
357
+ await getKVKeyValue(accountId, namespaceId, key)
358
+ );
359
+
360
+ if (args.text) {
361
+ const decoder = new StringDecoder("utf8");
362
+ logger.log(decoder.write(bufferKVValue));
363
+ } else {
364
+ process.stdout.write(bufferKVValue);
365
+ }
366
+ await metrics.sendMetricsEvent("read kv value", {
367
+ sendMetrics: config.send_metrics,
368
+ });
369
+ }
370
+ )
371
+ .command(
372
+ "delete <key>",
373
+ "Removes a single key value pair from the given namespace.",
374
+ (yargs) => {
375
+ return yargs
376
+ .positional("key", {
377
+ describe: "The key value to delete",
378
+ type: "string",
379
+ demandOption: true,
380
+ })
381
+ .option("binding", {
382
+ type: "string",
383
+ requiresArg: true,
384
+ describe: "The name of the namespace to delete from",
385
+ })
386
+ .option("namespace-id", {
387
+ type: "string",
388
+ requiresArg: true,
389
+ describe: "The id of the namespace to delete from",
390
+ })
391
+ .check(demandOneOfOption("binding", "namespace-id"))
392
+ .option("preview", {
393
+ type: "boolean",
394
+ describe: "Interact with a preview namespace",
395
+ });
396
+ },
397
+ async ({ key, ...args }) => {
398
+ await printWranglerBanner();
399
+ const config = readConfig(args.config, args);
400
+ const namespaceId = getKVNamespaceId(args, config);
401
+
402
+ logger.log(`Deleting the key "${key}" on namespace ${namespaceId}.`);
403
+
404
+ const accountId = await requireAuth(config);
405
+
406
+ await deleteKVKeyValue(accountId, namespaceId, key);
407
+ await metrics.sendMetricsEvent("delete kv key-value", {
408
+ sendMetrics: config.send_metrics,
409
+ });
410
+ }
411
+ );
412
+ };
413
+
414
+ export const kvBulk = (kvYargs: CommonYargsArgv) => {
415
+ return kvYargs
416
+ .command(
417
+ "put <filename>",
418
+ "Upload multiple key-value pairs to a namespace",
419
+ (yargs) => {
420
+ return yargs
421
+ .positional("filename", {
422
+ describe: `The JSON file of key-value pairs to upload, in form [{"key":..., "value":...}"...]`,
423
+ type: "string",
424
+ demandOption: true,
425
+ })
426
+ .option("binding", {
427
+ type: "string",
428
+ requiresArg: true,
429
+ describe: "The name of the namespace to insert values into",
430
+ })
431
+ .option("namespace-id", {
432
+ type: "string",
433
+ requiresArg: true,
434
+ describe: "The id of the namespace to insert values into",
435
+ })
436
+ .check(demandOneOfOption("binding", "namespace-id"))
437
+ .option("preview", {
438
+ type: "boolean",
439
+ describe: "Interact with a preview namespace",
440
+ });
441
+ },
442
+ async ({ filename, ...args }) => {
443
+ await printWranglerBanner();
444
+ // The simplest implementation I could think of.
445
+ // This could be made more efficient with a streaming parser/uploader
446
+ // but we'll do that in the future if needed.
447
+
448
+ const config = readConfig(args.config, args);
449
+ const namespaceId = getKVNamespaceId(args, config);
450
+ const content = parseJSON(readFileSync(filename), filename);
451
+
452
+ if (!Array.isArray(content)) {
453
+ throw new Error(
454
+ `Unexpected JSON input from "${filename}".\n` +
455
+ `Expected an array of key-value objects but got type "${typeof content}".`
456
+ );
457
+ }
458
+
459
+ const errors: string[] = [];
460
+ const warnings: string[] = [];
461
+ for (let i = 0; i < content.length; i++) {
462
+ const keyValue = content[i];
463
+ if (!isKVKeyValue(keyValue)) {
464
+ errors.push(
465
+ `The item at index ${i} is ${JSON.stringify(keyValue)}`
466
+ );
467
+ } else {
468
+ const props = unexpectedKVKeyValueProps(keyValue);
469
+ if (props.length > 0) {
470
+ warnings.push(
471
+ `The item at index ${i} contains unexpected properties: ${JSON.stringify(
472
+ props
473
+ )}.`
474
+ );
475
+ }
476
+ }
477
+ }
478
+ if (warnings.length > 0) {
479
+ logger.warn(
480
+ `Unexpected key-value properties in "${filename}".\n` +
481
+ warnings.join("\n")
482
+ );
483
+ }
484
+ if (errors.length > 0) {
485
+ throw new Error(
486
+ `Unexpected JSON input from "${filename}".\n` +
487
+ `Each item in the array should be an object that matches:\n\n` +
488
+ `interface KeyValue {\n` +
489
+ ` key: string;\n` +
490
+ ` value: string;\n` +
491
+ ` expiration?: number;\n` +
492
+ ` expiration_ttl?: number;\n` +
493
+ ` metadata?: object;\n` +
494
+ ` base64?: boolean;\n` +
495
+ `}\n\n` +
496
+ errors.join("\n")
497
+ );
498
+ }
499
+
500
+ const accountId = await requireAuth(config);
501
+ await putKVBulkKeyValue(accountId, namespaceId, content);
502
+ await metrics.sendMetricsEvent("write kv key-values (bulk)", {
503
+ sendMetrics: config.send_metrics,
504
+ });
505
+
506
+ logger.log("Success!");
507
+ }
508
+ )
509
+ .command(
510
+ "delete <filename>",
511
+ "Delete multiple key-value pairs from a namespace",
512
+ (yargs) => {
513
+ return yargs
514
+ .positional("filename", {
515
+ describe: `The JSON file of keys to delete, in the form ["key1", "key2", ...]`,
516
+ type: "string",
517
+ demandOption: true,
518
+ })
519
+ .option("binding", {
520
+ type: "string",
521
+ requiresArg: true,
522
+ describe: "The name of the namespace to delete from",
523
+ })
524
+ .option("namespace-id", {
525
+ type: "string",
526
+ requiresArg: true,
527
+ describe: "The id of the namespace to delete from",
528
+ })
529
+ .check(demandOneOfOption("binding", "namespace-id"))
530
+ .option("preview", {
531
+ type: "boolean",
532
+ describe: "Interact with a preview namespace",
533
+ })
534
+ .option("force", {
535
+ type: "boolean",
536
+ alias: "f",
537
+ describe: "Do not ask for confirmation before deleting",
538
+ });
539
+ },
540
+ async ({ filename, ...args }) => {
541
+ await printWranglerBanner();
542
+ const config = readConfig(args.config, args);
543
+ const namespaceId = getKVNamespaceId(args, config);
544
+
545
+ if (!args.force) {
546
+ const result = await confirm(
547
+ `Are you sure you want to delete all the keys read from "${filename}" from kv-namespace with id "${namespaceId}"?`
548
+ );
549
+ if (!result) {
550
+ logger.log(`Not deleting keys read from "${filename}".`);
551
+ return;
552
+ }
553
+ }
554
+
555
+ const content = parseJSON(readFileSync(filename), filename) as string[];
556
+
557
+ if (!Array.isArray(content)) {
558
+ throw new Error(
559
+ `Unexpected JSON input from "${filename}".\n` +
560
+ `Expected an array of strings but got:\n${content}`
561
+ );
562
+ }
563
+
564
+ const errors: string[] = [];
565
+ for (let i = 0; i < content.length; i++) {
566
+ const key = content[i];
567
+ if (typeof key !== "string") {
568
+ errors.push(
569
+ `The item at index ${i} is type: "${typeof key}" - ${JSON.stringify(
570
+ key
571
+ )}`
572
+ );
573
+ }
574
+ }
575
+
576
+ if (errors.length > 0) {
577
+ throw new Error(
578
+ `Unexpected JSON input from "${filename}".\n` +
579
+ `Expected an array of strings.\n` +
580
+ errors.join("\n")
581
+ );
582
+ }
583
+
584
+ const accountId = await requireAuth(config);
585
+
586
+ await deleteKVBulkKeyValue(accountId, namespaceId, content);
587
+ await metrics.sendMetricsEvent("delete kv key-values (bulk)", {
588
+ sendMetrics: config.send_metrics,
589
+ });
590
+
591
+ logger.log("Success!");
592
+ }
593
+ );
594
+ };
package/src/logger.ts ADDED
@@ -0,0 +1,104 @@
1
+ import { format } from "node:util";
2
+ import chalk from "chalk";
3
+ import CLITable from "cli-table3";
4
+ import { formatMessagesSync } from "esbuild";
5
+ import { getEnvironmentVariableFactory } from "./environment-variables/factory";
6
+ import type { BuildFailure } from "esbuild";
7
+ export const LOGGER_LEVELS = {
8
+ none: -1,
9
+ error: 0,
10
+ warn: 1,
11
+ info: 2,
12
+ log: 3,
13
+ debug: 4,
14
+ } as const;
15
+
16
+ export type LoggerLevel = keyof typeof LOGGER_LEVELS;
17
+
18
+ /** A map from LOGGER_LEVEL to the error `kind` needed by `formatMessagesSync()`. */
19
+ const LOGGER_LEVEL_FORMAT_TYPE_MAP = {
20
+ error: "error",
21
+ warn: "warning",
22
+ info: undefined,
23
+ log: undefined,
24
+ debug: undefined,
25
+ } as const;
26
+
27
+ const getLogLevelFromEnv = getEnvironmentVariableFactory({
28
+ variableName: "WRANGLER_LOG",
29
+ defaultValue: () => "log",
30
+ });
31
+
32
+ export type TableRow<Keys extends string> = Record<Keys, string>;
33
+
34
+ class Logger {
35
+ constructor() {}
36
+
37
+ loggerLevel: LoggerLevel = (getLogLevelFromEnv() as LoggerLevel) ?? "log";
38
+ columns = process.stdout.columns;
39
+
40
+ debug = (...args: unknown[]) => this.doLog("debug", args);
41
+ info = (...args: unknown[]) => this.doLog("info", args);
42
+ log = (...args: unknown[]) => this.doLog("log", args);
43
+ warn = (...args: unknown[]) => this.doLog("warn", args);
44
+ error = (...args: unknown[]) => this.doLog("error", args);
45
+ table<Keys extends string>(data: TableRow<Keys>[]) {
46
+ const keys: Keys[] =
47
+ data.length === 0 ? [] : (Object.keys(data[0]) as Keys[]);
48
+ const t = new CLITable({
49
+ head: keys.map((k) => chalk.bold.blue(k)),
50
+ });
51
+ t.push(...data.map((row) => keys.map((k) => row[k])));
52
+ return this.doLog("log", [t.toString()]);
53
+ }
54
+
55
+ private doLog(messageLevel: Exclude<LoggerLevel, "none">, args: unknown[]) {
56
+ if (LOGGER_LEVELS[this.loggerLevel] >= LOGGER_LEVELS[messageLevel]) {
57
+ console[messageLevel](this.formatMessage(messageLevel, format(...args)));
58
+ }
59
+ }
60
+
61
+ private formatMessage(
62
+ level: Exclude<LoggerLevel, "none">,
63
+ message: string
64
+ ): string {
65
+ const kind = LOGGER_LEVEL_FORMAT_TYPE_MAP[level];
66
+ if (kind) {
67
+ // Format the message using the esbuild formatter.
68
+ // The first line of the message is the main `text`,
69
+ // subsequent lines are put into the `notes`.
70
+ const [firstLine, ...otherLines] = message.split("\n");
71
+ const notes =
72
+ otherLines.length > 0
73
+ ? otherLines.map((text) => ({ text }))
74
+ : undefined;
75
+ return formatMessagesSync([{ text: firstLine, notes }], {
76
+ color: true,
77
+ kind,
78
+ terminalWidth: this.columns,
79
+ })[0];
80
+ } else {
81
+ return message;
82
+ }
83
+ }
84
+ }
85
+
86
+ /**
87
+ * A drop-in replacement for `console` for outputting logging messages.
88
+ *
89
+ * Errors and Warnings will get additional formatting to highlight them to the user.
90
+ * You can also set a `logger.loggerLevel` value to one of "debug", "log", "warn" or "error",
91
+ * to filter out logging messages.
92
+ */
93
+ export const logger = new Logger();
94
+
95
+ /**
96
+ * Logs all errors/warnings associated with an esbuild BuildFailure in the same
97
+ * style esbuild would.
98
+ */
99
+ export function logBuildFailure(failure: BuildFailure) {
100
+ let logs = formatMessagesSync(failure.errors, { kind: "error", color: true });
101
+ for (const log of logs) console.error(log);
102
+ logs = formatMessagesSync(failure.warnings, { kind: "warning", color: true });
103
+ for (const log of logs) console.warn(log);
104
+ }
@@ -0,0 +1,5 @@
1
+ export { getMetricsDispatcher } from "./metrics-dispatcher";
2
+ export type { Properties } from "./metrics-dispatcher";
3
+ export { getMetricsConfig } from "./metrics-config";
4
+ export * from "./send-event";
5
+ export { getMetricsUsageHeaders } from "./metrics-usage-headers";