wrangler 0.0.0-e7a0cd5b → 0.0.0-e7c06d78

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 (264) hide show
  1. package/README.md +13 -15
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3059 -0
  4. package/package.json +196 -191
  5. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  6. package/templates/__tests__/tsconfig.json +8 -0
  7. package/templates/checked-fetch.js +19 -6
  8. package/templates/facade.d.ts +19 -0
  9. package/templates/gitignore +2 -3
  10. package/templates/init-tests/test-jest-new-worker.js +3 -5
  11. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  12. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  13. package/templates/middleware/common.ts +9 -4
  14. package/templates/middleware/loader-modules.ts +94 -44
  15. package/templates/middleware/loader-sw.ts +48 -32
  16. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  17. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  18. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  19. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  20. package/templates/modules-watch-stub.js +4 -0
  21. package/templates/new-worker-scheduled.ts +1 -1
  22. package/templates/new-worker.ts +4 -1
  23. package/templates/pages-dev-pipeline.ts +6 -2
  24. package/templates/pages-dev-util.ts +4 -1
  25. package/templates/pages-shim.ts +1 -1
  26. package/templates/pages-template-plugin.ts +33 -14
  27. package/templates/pages-template-worker.ts +12 -3
  28. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  29. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  30. package/templates/tsconfig-sanity.ts +11 -0
  31. package/templates/tsconfig.init.json +22 -0
  32. package/templates/tsconfig.json +5 -103
  33. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  34. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  35. package/wrangler-dist/ProxyWorker.js +240 -0
  36. package/wrangler-dist/ProxyWorker.js.map +6 -0
  37. package/wrangler-dist/cli.d.ts +26010 -512
  38. package/wrangler-dist/cli.js +164971 -116798
  39. package/wrangler-dist/wasm-sync.wasm +0 -0
  40. package/Cloudflare_CA.pem +0 -18
  41. package/import_meta_url.js +0 -3
  42. package/miniflare-config-stubs/.env.empty +0 -0
  43. package/miniflare-config-stubs/package.empty.json +0 -1
  44. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  45. package/miniflare-dist/index.mjs +0 -6316
  46. package/src/__tests__/access.test.ts +0 -25
  47. package/src/__tests__/api-dev.test.ts +0 -209
  48. package/src/__tests__/api-devregistry.test.js +0 -57
  49. package/src/__tests__/api.test.ts +0 -80
  50. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  51. package/src/__tests__/config-cache.test.ts +0 -42
  52. package/src/__tests__/configuration.test.ts +0 -4028
  53. package/src/__tests__/d1.test.ts +0 -72
  54. package/src/__tests__/delete.test.ts +0 -230
  55. package/src/__tests__/deployments.test.ts +0 -95
  56. package/src/__tests__/dev.test.tsx +0 -1509
  57. package/src/__tests__/dialogs.test.tsx +0 -40
  58. package/src/__tests__/generate.test.ts +0 -235
  59. package/src/__tests__/get-host-from-url.test.ts +0 -16
  60. package/src/__tests__/guess-worker-format.test.ts +0 -85
  61. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  62. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  66. package/src/__tests__/helpers/mock-console.ts +0 -106
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  68. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  69. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  70. package/src/__tests__/helpers/mock-istty.ts +0 -74
  71. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  72. package/src/__tests__/helpers/mock-kv.ts +0 -33
  73. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  74. package/src/__tests__/helpers/mock-process.ts +0 -39
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  78. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -59
  79. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  80. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  81. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  82. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  83. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  84. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -22
  85. package/src/__tests__/helpers/msw/index.ts +0 -21
  86. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  87. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  88. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  89. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  90. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  91. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  92. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  93. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  94. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  95. package/src/__tests__/https-options.test.ts +0 -163
  96. package/src/__tests__/index.test.ts +0 -262
  97. package/src/__tests__/init.test.ts +0 -2900
  98. package/src/__tests__/jest.setup.ts +0 -202
  99. package/src/__tests__/kv.test.ts +0 -1675
  100. package/src/__tests__/logger.test.ts +0 -141
  101. package/src/__tests__/metrics.test.ts +0 -450
  102. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  103. package/src/__tests__/middleware.test.ts +0 -726
  104. package/src/__tests__/package-manager.test.ts +0 -353
  105. package/src/__tests__/pages.test.ts +0 -2223
  106. package/src/__tests__/parse.test.ts +0 -330
  107. package/src/__tests__/paths.test.ts +0 -39
  108. package/src/__tests__/publish.test.ts +0 -7660
  109. package/src/__tests__/pubsub.test.ts +0 -370
  110. package/src/__tests__/queues.test.ts +0 -371
  111. package/src/__tests__/r2.test.ts +0 -376
  112. package/src/__tests__/route.test.ts +0 -45
  113. package/src/__tests__/secret.test.ts +0 -644
  114. package/src/__tests__/tail.test.ts +0 -800
  115. package/src/__tests__/test-old-node-version.js +0 -31
  116. package/src/__tests__/type-generation.test.ts +0 -217
  117. package/src/__tests__/user.test.ts +0 -155
  118. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  119. package/src/__tests__/validate-dev-props.test.ts +0 -56
  120. package/src/__tests__/version.test.ts +0 -35
  121. package/src/__tests__/whoami.test.tsx +0 -278
  122. package/src/__tests__/worker-namespace.test.ts +0 -326
  123. package/src/abort.d.ts +0 -3
  124. package/src/api/dev.ts +0 -208
  125. package/src/api/index.ts +0 -2
  126. package/src/bundle-reporter.tsx +0 -68
  127. package/src/bundle.ts +0 -785
  128. package/src/cfetch/index.ts +0 -160
  129. package/src/cfetch/internal.ts +0 -263
  130. package/src/cli.ts +0 -28
  131. package/src/config/README.md +0 -107
  132. package/src/config/config.ts +0 -275
  133. package/src/config/diagnostics.ts +0 -80
  134. package/src/config/environment.ts +0 -563
  135. package/src/config/index.ts +0 -342
  136. package/src/config/validation-helpers.ts +0 -597
  137. package/src/config/validation.ts +0 -2113
  138. package/src/config-cache.ts +0 -85
  139. package/src/create-worker-preview.ts +0 -282
  140. package/src/create-worker-upload-form.ts +0 -321
  141. package/src/d1/backups.tsx +0 -218
  142. package/src/d1/create.tsx +0 -54
  143. package/src/d1/delete.tsx +0 -56
  144. package/src/d1/execute.tsx +0 -299
  145. package/src/d1/formatTimeAgo.ts +0 -14
  146. package/src/d1/index.ts +0 -76
  147. package/src/d1/list.tsx +0 -48
  148. package/src/d1/options.ts +0 -12
  149. package/src/d1/types.tsx +0 -14
  150. package/src/d1/utils.ts +0 -39
  151. package/src/delete.ts +0 -108
  152. package/src/deployments.ts +0 -74
  153. package/src/deprecated/index.ts +0 -438
  154. package/src/dev/dev-vars.ts +0 -39
  155. package/src/dev/dev.tsx +0 -587
  156. package/src/dev/get-local-persistence-path.tsx +0 -31
  157. package/src/dev/local.tsx +0 -717
  158. package/src/dev/remote.tsx +0 -603
  159. package/src/dev/start-server.ts +0 -513
  160. package/src/dev/use-esbuild.ts +0 -204
  161. package/src/dev/validate-dev-props.ts +0 -31
  162. package/src/dev-registry.tsx +0 -201
  163. package/src/dev.tsx +0 -869
  164. package/src/dialogs.tsx +0 -163
  165. package/src/dispatch-namespace.ts +0 -207
  166. package/src/durable.ts +0 -102
  167. package/src/entry.ts +0 -329
  168. package/src/environment-variables.ts +0 -50
  169. package/src/errors.ts +0 -11
  170. package/src/git-client.ts +0 -124
  171. package/src/global-wrangler-config-path.ts +0 -26
  172. package/src/https-options.ts +0 -127
  173. package/src/index.tsx +0 -684
  174. package/src/init.ts +0 -970
  175. package/src/inspect.ts +0 -767
  176. package/src/intl-polyfill.d.ts +0 -139
  177. package/src/is-ci.ts +0 -14
  178. package/src/is-interactive.ts +0 -16
  179. package/src/kv/helpers.ts +0 -430
  180. package/src/kv/index.ts +0 -596
  181. package/src/logger.ts +0 -92
  182. package/src/metrics/index.ts +0 -5
  183. package/src/metrics/metrics-config.ts +0 -239
  184. package/src/metrics/metrics-dispatcher.ts +0 -96
  185. package/src/metrics/metrics-usage-headers.ts +0 -24
  186. package/src/metrics/send-event.ts +0 -94
  187. package/src/miniflare-cli/README.md +0 -30
  188. package/src/miniflare-cli/assets.ts +0 -215
  189. package/src/miniflare-cli/index.ts +0 -213
  190. package/src/miniflare-cli/request-context.ts +0 -40
  191. package/src/module-collection.ts +0 -267
  192. package/src/open-in-browser.ts +0 -17
  193. package/src/package-manager.ts +0 -219
  194. package/src/pages/build.tsx +0 -238
  195. package/src/pages/constants.ts +0 -18
  196. package/src/pages/deployments.tsx +0 -106
  197. package/src/pages/dev.tsx +0 -693
  198. package/src/pages/errors.ts +0 -66
  199. package/src/pages/functions/buildPlugin.ts +0 -110
  200. package/src/pages/functions/buildWorker.ts +0 -156
  201. package/src/pages/functions/filepath-routing.test.ts +0 -234
  202. package/src/pages/functions/filepath-routing.ts +0 -189
  203. package/src/pages/functions/identifiers.ts +0 -78
  204. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  205. package/src/pages/functions/routes-consolidation.ts +0 -73
  206. package/src/pages/functions/routes-transformation.test.ts +0 -282
  207. package/src/pages/functions/routes-transformation.ts +0 -115
  208. package/src/pages/functions/routes-validation.test.ts +0 -403
  209. package/src/pages/functions/routes-validation.ts +0 -202
  210. package/src/pages/functions/routes.ts +0 -151
  211. package/src/pages/functions.tsx +0 -82
  212. package/src/pages/hash.tsx +0 -13
  213. package/src/pages/index.tsx +0 -94
  214. package/src/pages/projects.tsx +0 -169
  215. package/src/pages/publish.tsx +0 -436
  216. package/src/pages/types.ts +0 -49
  217. package/src/pages/upload.tsx +0 -425
  218. package/src/pages/utils.ts +0 -12
  219. package/src/parse.ts +0 -286
  220. package/src/paths.ts +0 -71
  221. package/src/proxy.ts +0 -689
  222. package/src/publish/index.ts +0 -270
  223. package/src/publish/publish.ts +0 -1035
  224. package/src/pubsub/index.ts +0 -286
  225. package/src/pubsub/pubsub-commands.tsx +0 -624
  226. package/src/queues/cli/commands/consumer/add.ts +0 -71
  227. package/src/queues/cli/commands/consumer/index.ts +0 -22
  228. package/src/queues/cli/commands/consumer/remove.ts +0 -38
  229. package/src/queues/cli/commands/create.ts +0 -25
  230. package/src/queues/cli/commands/delete.ts +0 -26
  231. package/src/queues/cli/commands/index.ts +0 -33
  232. package/src/queues/cli/commands/list.ts +0 -25
  233. package/src/queues/client.ts +0 -135
  234. package/src/r2/helpers.ts +0 -131
  235. package/src/r2/index.ts +0 -277
  236. package/src/routes.ts +0 -140
  237. package/src/secret/index.ts +0 -379
  238. package/src/selfsigned.d.ts +0 -29
  239. package/src/sites.tsx +0 -372
  240. package/src/tail/createTail.ts +0 -315
  241. package/src/tail/filters.ts +0 -277
  242. package/src/tail/index.ts +0 -214
  243. package/src/tail/printing.ts +0 -107
  244. package/src/type-generation.ts +0 -159
  245. package/src/update-check.ts +0 -19
  246. package/src/user/access.ts +0 -69
  247. package/src/user/choose-account.tsx +0 -69
  248. package/src/user/env-vars.ts +0 -46
  249. package/src/user/generate-auth-url.ts +0 -33
  250. package/src/user/generate-random-state.ts +0 -16
  251. package/src/user/index.ts +0 -3
  252. package/src/user/user.tsx +0 -1192
  253. package/src/utils/collectKeyValues.ts +0 -14
  254. package/src/whoami.tsx +0 -169
  255. package/src/worker.ts +0 -242
  256. package/src/yargs-types.ts +0 -20
  257. package/src/zones.ts +0 -191
  258. package/templates/d1-beta-facade.js +0 -174
  259. package/templates/experimental-local-cache-stubs.js +0 -27
  260. package/templates/first-party-worker-module-facade.ts +0 -18
  261. package/templates/format-dev-errors.ts +0 -32
  262. package/templates/serve-static-assets.ts +0 -63
  263. package/templates/service-bindings-module-facade.js +0 -54
  264. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,139 +0,0 @@
1
- /**
2
- * TODO Remove once https://github.com/microsoft/TypeScript/pull/47254 lands
3
- */
4
- declare namespace Intl {
5
- interface DateTimeFormatOptions {
6
- formatMatcher?: "basic" | "best fit" | "best fit" | undefined;
7
- dateStyle?: "full" | "long" | "medium" | "short" | undefined;
8
- timeStyle?: "full" | "long" | "medium" | "short" | undefined;
9
- dayPeriod?: "narrow" | "short" | "long" | undefined;
10
- fractionalSecondDigits?: 0 | 1 | 2 | 3 | undefined;
11
- }
12
-
13
- interface ResolvedDateTimeFormatOptions {
14
- formatMatcher?: "basic" | "best fit" | "best fit";
15
- dateStyle?: "full" | "long" | "medium" | "short";
16
- timeStyle?: "full" | "long" | "medium" | "short";
17
- hourCycle?: "h11" | "h12" | "h23" | "h24";
18
- dayPeriod?: "narrow" | "short" | "long";
19
- fractionalSecondDigits?: 0 | 1 | 2 | 3;
20
- }
21
-
22
- interface NumberFormat {
23
- formatRange(startDate: number | bigint, endDate: number | bigint): string;
24
- formatRangeToParts(
25
- startDate: number | bigint,
26
- endDate: number | bigint
27
- ): NumberFormatPart[];
28
- }
29
-
30
- /**
31
- * The locale matching algorithm to use.
32
- *
33
- * [MDN](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_negotiation).
34
- */
35
- type ListFormatLocaleMatcher = "lookup" | "best fit";
36
-
37
- /**
38
- * The format of output message.
39
- *
40
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat#parameters).
41
- */
42
- type ListFormatType = "conjunction" | "disjunction" | "unit";
43
-
44
- /**
45
- * The length of the formatted message.
46
- *
47
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat#parameters).
48
- */
49
- type ListFormatStyle = "long" | "short" | "narrow";
50
-
51
- /**
52
- * An object with some or all properties of the `Intl.ListFormat` constructor `options` parameter.
53
- *
54
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat#parameters).
55
- */
56
- interface ListFormatOptions {
57
- /** The locale matching algorithm to use. For information about this option, see [Intl page](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_negotiation). */
58
- localeMatcher?: ListFormatLocaleMatcher;
59
- /** The format of output message. */
60
- type?: ListFormatType;
61
- /** The length of the internationalized message. */
62
- style?: ListFormatStyle;
63
- }
64
-
65
- interface ListFormat {
66
- /**
67
- * Returns a string with a language-specific representation of the list.
68
- *
69
- * @param list - An iterable object, such as an [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array).
70
- *
71
- * @throws `TypeError` if `list` includes something other than the possible values.
72
- *
73
- * @returns {string} A language-specific formatted string representing the elements of the list.
74
- *
75
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/format).
76
- */
77
- format(list: Iterable<string>): string;
78
-
79
- /**
80
- * Returns an Array of objects representing the different components that can be used to format a list of values in a locale-aware fashion.
81
- *
82
- * @param list - An iterable object, such as an [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array), to be formatted according to a locale.
83
- *
84
- * @throws `TypeError` if `list` includes something other than the possible values.
85
- *
86
- * @returns {{ type: "element" | "literal", value: string; }[]} An Array of components which contains the formatted parts from the list.
87
- *
88
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/formatToParts).
89
- */
90
- formatToParts(
91
- list: Iterable<string>
92
- ): { type: "element" | "literal"; value: string }[];
93
- }
94
-
95
- const ListFormat: {
96
- prototype: ListFormat;
97
-
98
- /**
99
- * Creates [Intl.ListFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat) objects that
100
- * enable language-sensitive list formatting.
101
- *
102
- * @param locales - A string with a [BCP 47 language tag](http://tools.ietf.org/html/rfc5646), or an array of such strings.
103
- * For the general form and interpretation of the `locales` argument,
104
- * see the [`Intl` page](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation).
105
- *
106
- * @param options - An [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat#parameters)
107
- * with some or all options of `ListFormatOptions`.
108
- *
109
- * @returns [Intl.ListFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat) object.
110
- *
111
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat).
112
- */
113
- new (
114
- locales?: BCP47LanguageTag | BCP47LanguageTag[],
115
- options?: ListFormatOptions
116
- ): ListFormat;
117
-
118
- /**
119
- * Returns an array containing those of the provided locales that are
120
- * supported in list formatting without having to fall back to the runtime's default locale.
121
- *
122
- * @param locales - A string with a [BCP 47 language tag](http://tools.ietf.org/html/rfc5646), or an array of such strings.
123
- * For the general form and interpretation of the `locales` argument,
124
- * see the [`Intl` page](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation).
125
- *
126
- * @param options - An [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/supportedLocalesOf#parameters).
127
- * with some or all possible options.
128
- *
129
- * @returns An array of strings representing a subset of the given locale tags that are supported in list
130
- * formatting without having to fall back to the runtime's default locale.
131
- *
132
- * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/supportedLocalesOf).
133
- */
134
- supportedLocalesOf(
135
- locales: BCP47LanguageTag | BCP47LanguageTag[],
136
- options?: Pick<ListFormatOptions, "localeMatcher">
137
- ): BCP47LanguageTag[];
138
- };
139
- }
package/src/is-ci.ts DELETED
@@ -1,14 +0,0 @@
1
- import isCI from "is-ci";
2
-
3
- /**
4
- * Use this object to find out if we are currently running in a continuous integration environment.
5
- *
6
- * The isCI constant imported above cannot be easily mocked for testing.
7
- * By wrapping this up in a method on an object, it results in clean and testable code.
8
- */
9
- export const CI = {
10
- /** Is Wrangler currently running in a CI? */
11
- isCI() {
12
- return isCI;
13
- },
14
- };
@@ -1,16 +0,0 @@
1
- /**
2
- * Test whether the process is "interactive".
3
- * Reasons it may not be interactive: it could be running in CI,
4
- * or you're piping values from / to another process, etc
5
- */
6
- export default function isInteractive(): boolean {
7
- if (process.env.CF_PAGES === "1") {
8
- return false;
9
- }
10
-
11
- try {
12
- return Boolean(process.stdin.isTTY && process.stdout.isTTY);
13
- } catch {
14
- return false;
15
- }
16
- }
package/src/kv/helpers.ts DELETED
@@ -1,430 +0,0 @@
1
- import { URLSearchParams } from "node:url";
2
- import { FormData } from "undici";
3
- import { fetchListResult, fetchResult, fetchKVGetValue } from "../cfetch";
4
- import { logger } from "../logger";
5
- import type { Config } from "../config";
6
-
7
- /** The largest number of kv items we can pass to the API in a single request. */
8
- const API_MAX = 10000;
9
- // The const below are halved from the API's true capacity to help avoid
10
- // hammering it with large requests.
11
- const BATCH_KEY_MAX = API_MAX / 2;
12
-
13
- type KvArgs = {
14
- binding?: string;
15
- "namespace-id"?: string;
16
- preview?: boolean;
17
- };
18
-
19
- /**
20
- * Create a new namespace under the given `accountId` with the given `title`.
21
- *
22
- * @returns the generated id of the created namespace.
23
- */
24
- export async function createKVNamespace(
25
- accountId: string,
26
- title: string
27
- ): Promise<string> {
28
- const response = await fetchResult<{ id: string }>(
29
- `/accounts/${accountId}/storage/kv/namespaces`,
30
- {
31
- method: "POST",
32
- headers: {
33
- "Content-Type": "application/json",
34
- },
35
- body: JSON.stringify({
36
- title,
37
- }),
38
- }
39
- );
40
-
41
- return response.id;
42
- }
43
-
44
- /**
45
- * The information about a namespace that is returned from `listNamespaces()`.
46
- */
47
- export interface KVNamespaceInfo {
48
- id: string;
49
- title: string;
50
- supports_url_encoding?: boolean;
51
- }
52
-
53
- /**
54
- * Fetch a list of all the namespaces under the given `accountId`.
55
- */
56
- export async function listKVNamespaces(
57
- accountId: string
58
- ): Promise<KVNamespaceInfo[]> {
59
- const pageSize = 100;
60
- let page = 1;
61
- const results: KVNamespaceInfo[] = [];
62
- while (results.length % pageSize === 0) {
63
- const json = await fetchResult<KVNamespaceInfo[]>(
64
- `/accounts/${accountId}/storage/kv/namespaces`,
65
- {},
66
- new URLSearchParams({
67
- per_page: pageSize.toString(),
68
- order: "title",
69
- direction: "asc",
70
- page: page.toString(),
71
- })
72
- );
73
- page++;
74
- results.push(...json);
75
- if (json.length < pageSize) {
76
- break;
77
- }
78
- }
79
- return results;
80
- }
81
-
82
- export interface NamespaceKeyInfo {
83
- name: string;
84
- expiration?: number;
85
- metadata?: { [key: string]: unknown };
86
- }
87
-
88
- export async function listKVNamespaceKeys(
89
- accountId: string,
90
- namespaceId: string,
91
- prefix = ""
92
- ) {
93
- return await fetchListResult<NamespaceKeyInfo>(
94
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
95
- {},
96
- new URLSearchParams({ prefix })
97
- );
98
- }
99
-
100
- export async function deleteKVNamespace(
101
- accountId: string,
102
- namespaceId: string
103
- ) {
104
- return await fetchResult<{ id: string }>(
105
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
106
- { method: "DELETE" }
107
- );
108
- }
109
-
110
- /**
111
- * Information about a key-value pair, including its "metadata" fields.
112
- */
113
- export interface KeyValue {
114
- key: string;
115
- value: string | Buffer;
116
- expiration?: number;
117
- expiration_ttl?: number;
118
- metadata?: object;
119
- base64?: boolean;
120
- }
121
-
122
- const KeyValueKeys = new Set([
123
- "key",
124
- "value",
125
- "expiration",
126
- "expiration_ttl",
127
- "metadata",
128
- "base64",
129
- ]);
130
-
131
- /**
132
- * The object has the specified property.
133
- */
134
- function hasProperty<T extends object>(
135
- obj: object,
136
- property: keyof T
137
- ): obj is T {
138
- return property in obj;
139
- }
140
-
141
- /**
142
- * The object has a required property of the specified type.
143
- */
144
- function hasTypedProperty<T extends object>(
145
- obj: object,
146
- property: keyof T,
147
- type: string
148
- ): obj is T {
149
- return hasProperty(obj, property) && typeof obj[property] === type;
150
- }
151
-
152
- /**
153
- * The object an optional property, of the specified type.
154
- */
155
- function hasOptionalTypedProperty<T extends object>(
156
- obj: object,
157
- property: keyof T,
158
- type: string
159
- ): obj is Omit<T, typeof property> | T {
160
- return !hasProperty(obj, property) || typeof obj[property] === type;
161
- }
162
-
163
- /**
164
- * Is the given object a valid `KeyValue` type?
165
- */
166
- export function isKVKeyValue(keyValue: unknown): keyValue is KeyValue {
167
- if (
168
- keyValue === null ||
169
- typeof keyValue !== "object" ||
170
- !hasTypedProperty(keyValue, "key", "string") ||
171
- !hasTypedProperty(keyValue, "value", "string") ||
172
- !hasOptionalTypedProperty(keyValue, "expiration", "number") ||
173
- !hasOptionalTypedProperty(keyValue, "expiration_ttl", "number") ||
174
- !hasOptionalTypedProperty(keyValue, "base64", "boolean") ||
175
- !hasOptionalTypedProperty(keyValue, "metadata", "object")
176
- ) {
177
- return false;
178
- }
179
- return true;
180
- }
181
-
182
- /**
183
- * Get all the properties on the `keyValue` that are not expected.
184
- */
185
- export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
186
- const props = Object.keys(keyValue);
187
- return props.filter((prop) => !KeyValueKeys.has(prop));
188
- }
189
-
190
- /**
191
- * Turn object with fields into FormData
192
- */
193
- function asFormData(fields: Record<string, unknown>): FormData {
194
- const formData = new FormData();
195
-
196
- for (const [name, value] of Object.entries(fields)) {
197
- formData.append(name, value);
198
- }
199
-
200
- return formData;
201
- }
202
-
203
- export async function putKVKeyValue(
204
- accountId: string,
205
- namespaceId: string,
206
- keyValue: KeyValue
207
- ) {
208
- let searchParams: URLSearchParams | undefined;
209
- if (keyValue.expiration || keyValue.expiration_ttl) {
210
- searchParams = new URLSearchParams();
211
- if (keyValue.expiration) {
212
- searchParams.set("expiration", `${keyValue.expiration}`);
213
- }
214
- if (keyValue.expiration_ttl) {
215
- searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
216
- }
217
- }
218
- return await fetchResult(
219
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
220
- keyValue.key
221
- )}`,
222
- {
223
- method: "PUT",
224
- body: keyValue.metadata
225
- ? asFormData({
226
- value: keyValue.value,
227
- metadata: JSON.stringify(keyValue.metadata),
228
- })
229
- : keyValue.value,
230
- },
231
- searchParams
232
- );
233
- }
234
-
235
- export async function getKVKeyValue(
236
- accountId: string,
237
- namespaceId: string,
238
- key: string
239
- ): Promise<ArrayBuffer> {
240
- return await fetchKVGetValue(accountId, namespaceId, encodeURIComponent(key));
241
- }
242
-
243
- export async function deleteKVKeyValue(
244
- accountId: string,
245
- namespaceId: string,
246
- key: string
247
- ) {
248
- return await fetchResult(
249
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
250
- key
251
- )}`,
252
- { method: "DELETE" }
253
- );
254
- }
255
-
256
- /**
257
- * Formatter for converting e.g. 5328 --> 5,328
258
- */
259
- const formatNumber = new Intl.NumberFormat("en-US", {
260
- notation: "standard",
261
- }).format;
262
-
263
- /**
264
- * Helper function for bulk requests, logs ongoing output to console.
265
- */
266
- function logBulkProgress(
267
- operation: "put" | "delete",
268
- index: number,
269
- total: number
270
- ) {
271
- logger.log(
272
- `${operation === "put" ? "Uploaded" : "Deleted"} ${Math.floor(
273
- (100 * index) / total
274
- )}% (${formatNumber(index)} out of ${formatNumber(total)})`
275
- );
276
- }
277
-
278
- export async function putKVBulkKeyValue(
279
- accountId: string,
280
- namespaceId: string,
281
- keyValues: KeyValue[],
282
- quiet = false
283
- ) {
284
- for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
285
- if (!quiet && keyValues.length > BATCH_KEY_MAX) {
286
- logBulkProgress("put", index, keyValues.length);
287
- }
288
-
289
- await fetchResult(
290
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
291
- {
292
- method: "PUT",
293
- body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
294
- headers: { "Content-Type": "application/json" },
295
- }
296
- );
297
- }
298
-
299
- if (!quiet && keyValues.length > BATCH_KEY_MAX) {
300
- logBulkProgress("put", keyValues.length, keyValues.length);
301
- }
302
- }
303
-
304
- export async function deleteKVBulkKeyValue(
305
- accountId: string,
306
- namespaceId: string,
307
- keys: string[],
308
- quiet = false
309
- ) {
310
- for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
311
- if (!quiet && keys.length > BATCH_KEY_MAX) {
312
- logBulkProgress("delete", index, keys.length);
313
- }
314
-
315
- await fetchResult(
316
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
317
- {
318
- method: "DELETE",
319
- body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
320
- headers: { "Content-Type": "application/json" },
321
- }
322
- );
323
- }
324
- if (!quiet && keys.length > BATCH_KEY_MAX) {
325
- logBulkProgress("delete", keys.length, keys.length);
326
- }
327
- }
328
-
329
- export function getKVNamespaceId(
330
- { preview, binding, "namespace-id": namespaceId }: KvArgs,
331
- config: Config
332
- ): string {
333
- // nice
334
- if (namespaceId) {
335
- return namespaceId;
336
- }
337
-
338
- // begin pre-flight checks
339
-
340
- // `--binding` is only valid if there's a wrangler configuration.
341
- if (binding && !config) {
342
- throw new Error("--binding specified, but no config file was found.");
343
- }
344
-
345
- // there's no config. abort here
346
- if (!config) {
347
- throw new Error(
348
- "Failed to find a config file.\n" +
349
- "Either use --namespace-id to upload directly or create a configuration file with a binding."
350
- );
351
- }
352
-
353
- // there's no KV namespaces
354
- if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
355
- throw new Error(
356
- "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
357
- );
358
- }
359
-
360
- const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
361
-
362
- // we couldn't find a namespace with that binding
363
- if (!namespace) {
364
- throw new Error(
365
- `A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
366
- );
367
- }
368
-
369
- // end pre-flight checks
370
-
371
- // we're in preview mode, `--preview true` or `--preview` was passed
372
- if (preview && namespace.preview_id) {
373
- namespaceId = namespace.preview_id;
374
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
375
- return namespaceId;
376
- } else if (preview) {
377
- throw new Error(
378
- `No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
379
- );
380
- }
381
-
382
- // either `--preview false`, or preview wasn't passed
383
- // TODO: should we care? or should we just treat false and undefined the same
384
- const previewIsDefined = typeof preview !== "undefined";
385
-
386
- // --preview false was passed
387
- if (previewIsDefined && namespace.id) {
388
- namespaceId = namespace.id;
389
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
390
- return namespaceId;
391
- } else if (previewIsDefined) {
392
- throw new Error(
393
- `No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
394
- );
395
- }
396
-
397
- // `--preview` wasn't passed
398
- const bindingHasOnlyOneId =
399
- (namespace.id && !namespace.preview_id) ||
400
- (!namespace.id && namespace.preview_id);
401
- if (bindingHasOnlyOneId) {
402
- namespaceId = namespace.id || namespace.preview_id;
403
- } else {
404
- throw new Error(
405
- `${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
406
- );
407
- }
408
-
409
- // shouldn't happen. we should be able to prove this with strong typing.
410
- // TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
411
- if (!namespaceId) {
412
- throw Error(
413
- "Something went wrong trying to determine which namespace to upload to.\n" +
414
- "Please create a github issue with the command you just ran along with your wrangler configuration."
415
- );
416
- }
417
-
418
- return namespaceId;
419
- }
420
-
421
- /**
422
- * KV namespace binding names must be valid JS identifiers.
423
- */
424
- export function isValidKVNamespaceBinding(
425
- binding: string | undefined
426
- ): binding is string {
427
- return (
428
- typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
429
- );
430
- }