wrangler 0.0.0-e95e5a0 → 0.0.0-e98613f8

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 (305) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +26 -4
  3. package/bin/wrangler.js +166 -34
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +1456 -21
  6. package/package.json +191 -148
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +209 -0
  9. package/src/__tests__/api-devregistry.test.js +56 -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 +30 -24
  13. package/src/__tests__/configuration.test.ts +3970 -3114
  14. package/src/__tests__/d1.test.ts +80 -0
  15. package/src/__tests__/delete.test.ts +263 -0
  16. package/src/__tests__/deployments.test.ts +91 -0
  17. package/src/__tests__/dev.test.tsx +1528 -737
  18. package/src/__tests__/dialogs.test.tsx +40 -0
  19. package/src/__tests__/generate.test.ts +235 -0
  20. package/src/__tests__/get-host-from-url.test.ts +16 -0
  21. package/src/__tests__/guess-worker-format.test.ts +68 -68
  22. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  23. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +216 -94
  26. package/src/__tests__/helpers/mock-console.ts +58 -39
  27. package/src/__tests__/helpers/mock-dialogs.ts +114 -51
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  30. package/src/__tests__/helpers/mock-istty.ts +65 -18
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +229 -228
  34. package/src/__tests__/helpers/mock-process.ts +39 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  38. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  39. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  40. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  41. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  42. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  43. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  44. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  45. package/src/__tests__/helpers/msw/index.ts +21 -0
  46. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  47. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  48. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  49. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  53. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  54. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  55. package/src/__tests__/https-options.test.ts +142 -109
  56. package/src/__tests__/index.test.ts +246 -231
  57. package/src/__tests__/init.test.ts +2887 -1488
  58. package/src/__tests__/jest.setup.ts +163 -30
  59. package/src/__tests__/kv.test.ts +1660 -1439
  60. package/src/__tests__/logger.test.ts +100 -74
  61. package/src/__tests__/logout.test.ts +47 -0
  62. package/src/__tests__/metrics.test.ts +450 -0
  63. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  64. package/src/__tests__/middleware.test.ts +726 -0
  65. package/src/__tests__/package-manager.test.ts +312 -165
  66. package/src/__tests__/pages-deployment-tail.test.ts +820 -0
  67. package/src/__tests__/pages.test.ts +2435 -322
  68. package/src/__tests__/parse.test.ts +253 -245
  69. package/src/__tests__/paths.test.ts +39 -0
  70. package/src/__tests__/publish.test.ts +7536 -4778
  71. package/src/__tests__/pubsub.test.ts +370 -0
  72. package/src/__tests__/queues.test.ts +522 -0
  73. package/src/__tests__/r2.test.ts +388 -209
  74. package/src/__tests__/route.test.ts +18 -18
  75. package/src/__tests__/secret.test.ts +624 -426
  76. package/src/__tests__/tail.test.ts +776 -567
  77. package/src/__tests__/test-old-node-version.js +31 -0
  78. package/src/__tests__/type-generation.test.ts +226 -0
  79. package/src/__tests__/user.test.ts +117 -119
  80. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  81. package/src/__tests__/validate-dev-props.test.ts +56 -0
  82. package/src/__tests__/version.test.ts +35 -0
  83. package/src/__tests__/whoami.test.tsx +264 -91
  84. package/src/__tests__/worker-namespace.test.ts +326 -0
  85. package/src/abort.d.ts +3 -0
  86. package/src/api/dev.ts +210 -0
  87. package/src/api/index.ts +2 -0
  88. package/src/bundle-reporter.tsx +68 -0
  89. package/src/bundle.ts +789 -135
  90. package/src/cfetch/index.ts +123 -67
  91. package/src/cfetch/internal.ts +216 -90
  92. package/src/cli.ts +23 -8
  93. package/src/config/config.ts +236 -195
  94. package/src/config/diagnostics.ts +61 -61
  95. package/src/config/environment.ts +506 -339
  96. package/src/config/index.ts +309 -38
  97. package/src/config/validation-helpers.ts +379 -357
  98. package/src/config/validation.ts +1942 -1263
  99. package/src/config-cache.ts +81 -41
  100. package/src/create-worker-preview.ts +239 -132
  101. package/src/create-worker-upload-form.ts +300 -224
  102. package/src/d1/backups.tsx +223 -0
  103. package/src/d1/constants.ts +2 -0
  104. package/src/d1/create.tsx +63 -0
  105. package/src/d1/delete.tsx +56 -0
  106. package/src/d1/execute.tsx +352 -0
  107. package/src/d1/formatTimeAgo.ts +14 -0
  108. package/src/d1/index.ts +101 -0
  109. package/src/d1/list.tsx +48 -0
  110. package/src/d1/migrations/apply.tsx +184 -0
  111. package/src/d1/migrations/create.tsx +77 -0
  112. package/src/d1/migrations/helpers.ts +147 -0
  113. package/src/d1/migrations/index.tsx +3 -0
  114. package/src/d1/migrations/list.tsx +79 -0
  115. package/src/d1/migrations/options.ts +18 -0
  116. package/src/d1/options.ts +22 -0
  117. package/src/d1/types.tsx +24 -0
  118. package/src/d1/utils.ts +48 -0
  119. package/src/delete.ts +108 -0
  120. package/src/deployments.ts +77 -0
  121. package/src/deprecated/index.ts +438 -0
  122. package/src/dev/dev-vars.ts +20 -17
  123. package/src/dev/dev.tsx +549 -353
  124. package/src/dev/get-local-persistence-path.tsx +31 -0
  125. package/src/dev/local.tsx +870 -292
  126. package/src/dev/remote.tsx +591 -201
  127. package/src/dev/start-server.ts +539 -0
  128. package/src/dev/use-esbuild.ts +183 -97
  129. package/src/dev/validate-dev-props.ts +31 -0
  130. package/src/dev-registry.tsx +201 -0
  131. package/src/dev.tsx +913 -0
  132. package/src/dialogs.tsx +146 -65
  133. package/src/dispatch-namespace.ts +207 -0
  134. package/src/durable.ts +102 -0
  135. package/src/entry.ts +248 -186
  136. package/src/environment-variables.ts +38 -23
  137. package/src/errors.ts +6 -6
  138. package/src/git-client.ts +135 -0
  139. package/src/global-wrangler-config-path.ts +26 -0
  140. package/src/https-options.ts +84 -80
  141. package/src/index.tsx +636 -2617
  142. package/src/init.ts +970 -0
  143. package/src/inspect.ts +706 -562
  144. package/src/intl-polyfill.d.ts +123 -123
  145. package/src/is-ci.ts +14 -0
  146. package/src/is-interactive.ts +16 -0
  147. package/src/kv/helpers.ts +430 -0
  148. package/src/kv/index.ts +596 -0
  149. package/src/logger.ts +67 -41
  150. package/src/metrics/index.ts +5 -0
  151. package/src/metrics/metrics-config.ts +239 -0
  152. package/src/metrics/metrics-dispatcher.ts +96 -0
  153. package/src/metrics/metrics-usage-headers.ts +24 -0
  154. package/src/metrics/send-event.ts +96 -0
  155. package/src/miniflare-cli/assets.ts +220 -0
  156. package/src/miniflare-cli/index.ts +205 -33
  157. package/src/miniflare-cli/request-context.ts +18 -18
  158. package/src/module-collection.ts +221 -212
  159. package/src/open-in-browser.ts +5 -14
  160. package/src/package-manager.ts +182 -90
  161. package/src/pages/build.tsx +270 -0
  162. package/src/pages/constants.ts +18 -0
  163. package/src/pages/deployment-tails.tsx +284 -0
  164. package/src/pages/deployments.tsx +84 -0
  165. package/src/pages/dev.tsx +706 -0
  166. package/src/pages/errors.ts +66 -0
  167. package/src/pages/functions/buildPlugin.ts +107 -0
  168. package/src/pages/functions/buildWorker.ts +166 -0
  169. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  170. package/src/pages/functions/filepath-routing.ts +189 -0
  171. package/src/pages/functions/identifiers.ts +78 -0
  172. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  173. package/src/pages/functions/routes-consolidation.ts +73 -0
  174. package/src/pages/functions/routes-transformation.test.ts +282 -0
  175. package/src/pages/functions/routes-transformation.ts +115 -0
  176. package/src/pages/functions/routes-validation.test.ts +403 -0
  177. package/src/pages/functions/routes-validation.ts +202 -0
  178. package/src/pages/functions/routes.ts +151 -0
  179. package/src/pages/functions.tsx +82 -0
  180. package/src/pages/hash.tsx +13 -0
  181. package/src/pages/index.tsx +102 -0
  182. package/src/pages/projects.tsx +169 -0
  183. package/src/pages/prompt-select-project.tsx +31 -0
  184. package/src/pages/publish.tsx +451 -0
  185. package/src/pages/types.ts +41 -0
  186. package/src/pages/upload.tsx +426 -0
  187. package/src/pages/utils.ts +23 -0
  188. package/src/parse.ts +223 -120
  189. package/src/paths.ts +53 -8
  190. package/src/proxy.ts +628 -383
  191. package/src/publish/index.ts +270 -0
  192. package/src/publish/publish.ts +1035 -0
  193. package/src/pubsub/index.ts +286 -0
  194. package/src/pubsub/pubsub-commands.tsx +624 -0
  195. package/src/queues/cli/commands/consumer/add.ts +71 -0
  196. package/src/queues/cli/commands/consumer/index.ts +22 -0
  197. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  198. package/src/queues/cli/commands/create.ts +25 -0
  199. package/src/queues/cli/commands/delete.ts +26 -0
  200. package/src/queues/cli/commands/index.ts +36 -0
  201. package/src/queues/cli/commands/list.ts +25 -0
  202. package/src/queues/client.ts +135 -0
  203. package/src/queues/utils.ts +18 -0
  204. package/src/r2/constants.ts +4 -0
  205. package/src/r2/helpers.ts +131 -0
  206. package/src/r2/index.ts +289 -0
  207. package/src/routes.ts +140 -0
  208. package/src/secret/index.ts +378 -0
  209. package/src/selfsigned.d.ts +23 -23
  210. package/src/sites.tsx +281 -202
  211. package/src/tail/createTail.ts +379 -0
  212. package/src/tail/filters.ts +108 -110
  213. package/src/tail/index.ts +211 -296
  214. package/src/tail/printing.ts +86 -46
  215. package/src/type-generation.ts +173 -0
  216. package/src/update-check.ts +11 -11
  217. package/src/user/access.ts +69 -0
  218. package/src/user/choose-account.tsx +69 -0
  219. package/src/user/env-vars.ts +46 -0
  220. package/src/user/generate-auth-url.ts +33 -0
  221. package/src/user/generate-random-state.ts +16 -0
  222. package/src/user/index.ts +3 -0
  223. package/src/user/user.tsx +1198 -0
  224. package/src/utils/collectKeyValues.ts +14 -0
  225. package/src/whoami.tsx +141 -42
  226. package/src/worker.ts +174 -101
  227. package/src/yargs-types.ts +24 -0
  228. package/src/zones.ts +191 -0
  229. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  230. package/templates/checked-fetch.js +17 -0
  231. package/templates/d1-beta-facade.js +205 -0
  232. package/templates/first-party-worker-module-facade.ts +18 -0
  233. package/templates/format-dev-errors.ts +32 -0
  234. package/templates/init-tests/test-jest-new-worker.js +25 -0
  235. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  236. package/templates/middleware/common.ts +62 -0
  237. package/templates/middleware/loader-modules.ts +84 -0
  238. package/templates/middleware/loader-sw.ts +227 -0
  239. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  240. package/templates/middleware/middleware-pretty-error.ts +40 -0
  241. package/templates/middleware/middleware-scheduled.ts +15 -0
  242. package/templates/new-worker-scheduled.js +17 -0
  243. package/templates/new-worker-scheduled.ts +32 -0
  244. package/templates/new-worker.js +3 -3
  245. package/templates/new-worker.ts +18 -3
  246. package/templates/no-op-worker.js +10 -0
  247. package/templates/pages-dev-pipeline.ts +28 -0
  248. package/templates/pages-dev-util.ts +52 -0
  249. package/templates/pages-shim.ts +9 -0
  250. package/templates/pages-template-plugin.ts +171 -0
  251. package/templates/pages-template-worker.ts +189 -0
  252. package/templates/serve-static-assets.ts +63 -0
  253. package/templates/service-bindings-module-facade.js +54 -0
  254. package/templates/service-bindings-sw-facade.js +42 -0
  255. package/templates/tsconfig.json +96 -95
  256. package/wrangler-dist/cli.d.ts +893 -0
  257. package/wrangler-dist/cli.js +95201 -44118
  258. package/pages/functions/buildPlugin.ts +0 -92
  259. package/pages/functions/buildWorker.ts +0 -138
  260. package/pages/functions/filepath-routing.ts +0 -189
  261. package/pages/functions/identifiers.ts +0 -78
  262. package/pages/functions/routes.ts +0 -156
  263. package/pages/functions/template-plugin.ts +0 -146
  264. package/pages/functions/template-worker.ts +0 -143
  265. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  266. package/src/kv.ts +0 -319
  267. package/src/miniflare-cli/enum-keys.ts +0 -17
  268. package/src/pages.tsx +0 -1866
  269. package/src/publish.ts +0 -469
  270. package/src/r2.ts +0 -50
  271. package/src/user.tsx +0 -1193
  272. package/templates/static-asset-facade.js +0 -47
  273. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  274. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  275. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  276. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  277. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  278. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  279. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  280. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  281. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  282. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  283. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  284. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  286. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  287. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  288. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  289. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  290. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  291. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  292. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  293. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  294. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  295. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  296. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  297. package/vendor/wrangler-mime/LICENSE +0 -21
  298. package/vendor/wrangler-mime/Mime.js +0 -97
  299. package/vendor/wrangler-mime/README.md +0 -187
  300. package/vendor/wrangler-mime/cli.js +0 -46
  301. package/vendor/wrangler-mime/index.js +0 -4
  302. package/vendor/wrangler-mime/lite.js +0 -4
  303. package/vendor/wrangler-mime/package.json +0 -52
  304. package/vendor/wrangler-mime/types/other.js +0 -1
  305. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -5,196 +5,260 @@
5
5
  * This could be the top-level default environment, or a specific named environment.
6
6
  */
7
7
  export interface Environment
8
- extends EnvironmentInheritable,
9
- EnvironmentNonInheritable {}
8
+ extends EnvironmentInheritable,
9
+ EnvironmentNonInheritable {}
10
+
11
+ export type SimpleRoute = string;
12
+ export type ZoneIdRoute = {
13
+ pattern: string;
14
+ zone_id: string;
15
+ custom_domain?: boolean;
16
+ };
17
+ export type ZoneNameRoute = {
18
+ pattern: string;
19
+ zone_name: string;
20
+ custom_domain?: boolean;
21
+ };
22
+ export type CustomDomainRoute = { pattern: string; custom_domain: boolean };
23
+ export type Route =
24
+ | SimpleRoute
25
+ | ZoneIdRoute
26
+ | ZoneNameRoute
27
+ | CustomDomainRoute;
10
28
 
11
29
  /**
12
30
  * The `EnvironmentInheritable` interface declares all the configuration fields for an environment
13
31
  * that can be inherited (and overridden) from the top-level environment.
14
32
  */
15
33
  interface EnvironmentInheritable {
16
- /**
17
- * The name of your worker. Alphanumeric + dashes only.
18
- *
19
- * @inheritable
20
- */
21
- name: string | undefined;
22
-
23
- /**
24
- * This is the ID of the account associated with your zone.
25
- * You might have more than one account, so make sure to use
26
- * the ID of the account associated with the zone/route you
27
- * provide, if you provide one. It can also be specified through
28
- * the CLOUDFLARE_ACCOUNT_ID environment variable.
29
- *
30
- * @inheritable
31
- */
32
- account_id: string | undefined;
33
-
34
- /**
35
- * A date in the form yyyy-mm-dd, which will be used to determine
36
- * which version of the Workers runtime is used.
37
- *
38
- * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
39
- *
40
- * @inheritable
41
- */
42
- compatibility_date: string | undefined;
43
-
44
- /**
45
- * A list of flags that enable features from upcoming features of
46
- * the Workers runtime, usually used together with compatibility_flags.
47
- *
48
- * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
49
- *
50
- * @inheritable
51
- */
52
- compatibility_flags: string[];
53
-
54
- /**
55
- * The entrypoint/path to the JavaScript file that will be executed.
56
- */
57
- main: string | undefined;
58
-
59
- /**
60
- * Whether we use <name>.<subdomain>.workers.dev to
61
- * test and deploy your worker.
62
- *
63
- * @default `true` (This is a breaking change from wrangler 1)
64
- * @breaking
65
- * @inheritable
66
- */
67
- workers_dev: boolean | undefined;
68
-
69
- /**
70
- * A list of routes that your worker should be published to.
71
- * Only one of `routes` or `route` is required.
72
- *
73
- * Only required when workers_dev is false, and there's no scheduled worker (see `triggers`)
74
- *
75
- * @inheritable
76
- */
77
- routes:
78
- | (
79
- | string
80
- | { pattern: string; zone_id: string }
81
- | { pattern: string; zone_name: string }
82
- )[]
83
- | undefined;
84
-
85
- /**
86
- * A route that your worker should be published to. Literally
87
- * the same as routes, but only one.
88
- * Only one of `routes` or `route` is required.
89
- *
90
- * Only required when workers_dev is false, and there's no scheduled worker
91
- *
92
- * @inheritable
93
- */
94
- route:
95
- | (
96
- | string
97
- | { pattern: string; zone_id: string }
98
- | { pattern: string; zone_name: string }
99
- )
100
- | undefined;
101
-
102
- /**
103
- * Path to a custom tsconfig
104
- */
105
- tsconfig: string | undefined;
106
-
107
- /**
108
- * The function to use to replace jsx syntax.
109
- *
110
- * @default `"React.createElement"`
111
- * @inheritable
112
- */
113
- jsx_factory: string;
114
-
115
- /**
116
- * The function to use to replace jsx fragment syntax.
117
- *
118
- * @default `"React.Fragment"`
119
- * @inheritable
120
- */
121
- jsx_fragment: string;
122
-
123
- /**
124
- * "Cron" definitions to trigger a worker's "scheduled" function.
125
- *
126
- * Lets you call workers periodically, much like a cron job.
127
- *
128
- * More details here https://developers.cloudflare.com/workers/platform/cron-triggers
129
- *
130
- * @default `{crons:[]}`
131
- * @inheritable
132
- */
133
- triggers: { crons: string[] };
134
-
135
- /**
136
- * Specifies the Usage Model for your Worker. There are two options -
137
- * [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and
138
- * [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model).
139
- * For newly created Workers, if the Usage Model is omitted
140
- * it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model).
141
- * For existing Workers, if the Usage Model is omitted, it will be
142
- * set to the Usage Model configured in the dashboard for that Worker.
143
- *
144
- * @inheritable
145
- */
146
- usage_model: "bundled" | "unbound" | undefined;
147
-
148
- /**
149
- * An ordered list of rules that define which modules to import,
150
- * and what type to import them as. You will need to specify rules
151
- * to use Text, Data, and CompiledWasm modules, or when you wish to
152
- * have a .js file be treated as an ESModule instead of CommonJS.
153
- *
154
- * @inheritable
155
- */
156
- rules: Rule[];
157
-
158
- /**
159
- * Configures a custom build step to be run by Wrangler when building your Worker.
160
- *
161
- * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
162
- * for more details.
163
- *
164
- * @default {}
165
- */
166
- build: {
167
- /** The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used. */
168
- command?: string;
169
- /** The directory in which the command is executed. */
170
- cwd?: string;
171
- /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
172
- watch_dir?: string;
173
- /**
174
- * Deprecated field previously used to configure the build and upload of the script.
175
- * @deprecated
176
- */
177
- upload?: DeprecatedUpload;
178
- };
179
-
180
- /**
181
- * Minify the script before uploading.
182
- * @inheritable
183
- */
184
- minify: boolean | undefined;
185
-
186
- /**
187
- * Add polyfills for node builtin modules and globals
188
- */
189
- node_compat: boolean | undefined;
190
-
191
- /**
192
- * TODO: remove this as it has been deprecated.
193
- *
194
- * This is just here for now because the `route` commands use it.
195
- * So we need to include it in this type so it is available.
196
- */
197
- zone_id?: string;
34
+ /**
35
+ * The name of your worker. Alphanumeric + dashes only.
36
+ *
37
+ * @inheritable
38
+ */
39
+ name: string | undefined;
40
+
41
+ /**
42
+ * This is the ID of the account associated with your zone.
43
+ * You might have more than one account, so make sure to use
44
+ * the ID of the account associated with the zone/route you
45
+ * provide, if you provide one. It can also be specified through
46
+ * the CLOUDFLARE_ACCOUNT_ID environment variable.
47
+ *
48
+ * @inheritable
49
+ */
50
+ account_id: string | undefined;
51
+
52
+ /**
53
+ * A date in the form yyyy-mm-dd, which will be used to determine
54
+ * which version of the Workers runtime is used.
55
+ *
56
+ * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
57
+ *
58
+ * @inheritable
59
+ */
60
+ compatibility_date: string | undefined;
61
+
62
+ /**
63
+ * A list of flags that enable features from upcoming features of
64
+ * the Workers runtime, usually used together with compatibility_flags.
65
+ *
66
+ * More details at https://developers.cloudflare.com/workers/platform/compatibility-dates
67
+ *
68
+ * @inheritable
69
+ */
70
+ compatibility_flags: string[];
71
+
72
+ /**
73
+ * The entrypoint/path to the JavaScript file that will be executed.
74
+ */
75
+ main: string | undefined;
76
+
77
+ /**
78
+ * Whether we use <name>.<subdomain>.workers.dev to
79
+ * test and deploy your worker.
80
+ *
81
+ * @default `true` (This is a breaking change from wrangler 1)
82
+ * @breaking
83
+ * @inheritable
84
+ */
85
+ workers_dev: boolean | undefined;
86
+
87
+ /**
88
+ * A list of routes that your worker should be published to.
89
+ * Only one of `routes` or `route` is required.
90
+ *
91
+ * Only required when workers_dev is false, and there's no scheduled worker (see `triggers`)
92
+ *
93
+ * @inheritable
94
+ */
95
+ routes: Route[] | undefined;
96
+
97
+ /**
98
+ * A route that your worker should be published to. Literally
99
+ * the same as routes, but only one.
100
+ * Only one of `routes` or `route` is required.
101
+ *
102
+ * Only required when workers_dev is false, and there's no scheduled worker
103
+ *
104
+ * @inheritable
105
+ */
106
+ route: Route | undefined;
107
+
108
+ /**
109
+ * Path to a custom tsconfig
110
+ */
111
+ tsconfig: string | undefined;
112
+
113
+ /**
114
+ * The function to use to replace jsx syntax.
115
+ *
116
+ * @default `"React.createElement"`
117
+ * @inheritable
118
+ */
119
+ jsx_factory: string;
120
+
121
+ /**
122
+ * The function to use to replace jsx fragment syntax.
123
+ *
124
+ * @default `"React.Fragment"`
125
+ * @inheritable
126
+ */
127
+ jsx_fragment: string;
128
+
129
+ /**
130
+ * "Cron" definitions to trigger a worker's "scheduled" function.
131
+ *
132
+ * Lets you call workers periodically, much like a cron job.
133
+ *
134
+ * More details here https://developers.cloudflare.com/workers/platform/cron-triggers
135
+ *
136
+ * @default `{crons:[]}`
137
+ * @inheritable
138
+ */
139
+ triggers: { crons: string[] };
140
+
141
+ /**
142
+ * Specifies the Usage Model for your Worker. There are two options -
143
+ * [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and
144
+ * [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model).
145
+ * For newly created Workers, if the Usage Model is omitted
146
+ * it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model).
147
+ * For existing Workers, if the Usage Model is omitted, it will be
148
+ * set to the Usage Model configured in the dashboard for that Worker.
149
+ *
150
+ * @inheritable
151
+ */
152
+ usage_model: "bundled" | "unbound" | undefined;
153
+
154
+ /**
155
+ * An ordered list of rules that define which modules to import,
156
+ * and what type to import them as. You will need to specify rules
157
+ * to use Text, Data, and CompiledWasm modules, or when you wish to
158
+ * have a .js file be treated as an ESModule instead of CommonJS.
159
+ *
160
+ * @inheritable
161
+ */
162
+ rules: Rule[];
163
+
164
+ /**
165
+ * Configures a custom build step to be run by Wrangler when building your Worker.
166
+ *
167
+ * Refer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build)
168
+ * for more details.
169
+ *
170
+ * @default {}
171
+ */
172
+ build: {
173
+ /** The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used. */
174
+ command?: string;
175
+ /** The directory in which the command is executed. */
176
+ cwd?: string;
177
+ /** The directory to watch for changes while using wrangler dev, defaults to the current working directory */
178
+ watch_dir?: string | string[];
179
+ /**
180
+ * Deprecated field previously used to configure the build and upload of the script.
181
+ * @deprecated
182
+ */
183
+ upload?: DeprecatedUpload;
184
+ };
185
+
186
+ /**
187
+ * Skip internal build steps and directly publish script
188
+ * @inheritable
189
+ */
190
+ no_bundle: boolean | undefined;
191
+
192
+ /**
193
+ * Minify the script before uploading.
194
+ * @inheritable
195
+ */
196
+ minify: boolean | undefined;
197
+
198
+ /**
199
+ * Add polyfills for node builtin modules and globals
200
+ * @inheritable
201
+ */
202
+ node_compat: boolean | undefined;
203
+
204
+ /**
205
+ * Specifies namespace bindings that are bound to this Worker environment.
206
+ *
207
+ * NOTE: This field is not automatically inherited from the top level environment,
208
+ * and so must be specified in every named environment.
209
+ *
210
+ * @default `[]`
211
+ * @nonInheritable
212
+ */
213
+ dispatch_namespaces: {
214
+ /** The binding name used to refer to the bound service. */
215
+ binding: string;
216
+ /** The namespace to bind to. */
217
+ namespace: string;
218
+ }[];
219
+
220
+ /**
221
+ * Designates this worker as an internal-only "first-party" worker.
222
+ */
223
+ first_party_worker: boolean | undefined;
224
+
225
+ /**
226
+ * TODO: remove this as it has been deprecated.
227
+ *
228
+ * This is just here for now because the `route` commands use it.
229
+ * So we need to include it in this type so it is available.
230
+ */
231
+ zone_id?: string;
232
+
233
+ /**
234
+ * Specify a compiled capnp schema to use
235
+ * Then add a binding per field in the top level message that you will send to logfwdr
236
+ *
237
+ * @default `{schema:undefined,bindings:[]}`
238
+ * @inheritable
239
+ */
240
+ logfwdr: {
241
+ /** capnp schema filename */
242
+ schema: string | undefined;
243
+ bindings: {
244
+ /** The binding name used to refer to logfwdr */
245
+ name: string;
246
+ /** The destination for this logged message */
247
+ destination: string;
248
+ }[];
249
+ };
250
+
251
+ /**
252
+ * Send Trace Events from this worker to Workers Logpush.
253
+ *
254
+ * This will not configure a corresponding Logpush job automatically.
255
+ *
256
+ * For more information about Workers Logpush, see:
257
+ * https://blog.cloudflare.com/logpush-for-workers/
258
+ *
259
+ * @inheritable
260
+ */
261
+ logpush: boolean | undefined;
198
262
  }
199
263
 
200
264
  /**
@@ -205,165 +269,268 @@ interface EnvironmentInheritable {
205
269
  * for each named environment.
206
270
  */
207
271
  interface EnvironmentNonInheritable {
208
- /**
209
- * A map of environment variables to set when deploying your worker.
210
- *
211
- * NOTE: This field is not automatically inherited from the top level environment,
212
- * and so must be specified in every named environment.
213
- *
214
- * @default `{}`
215
- * @nonInheritable
216
- */
217
- vars: { [key: string]: unknown };
218
-
219
- /**
220
- * A list of durable objects that your worker should be bound to.
221
- *
222
- * For more information about Durable Objects, see the documentation at
223
- * https://developers.cloudflare.com/workers/learning/using-durable-objects
224
- *
225
- * NOTE: This field is not automatically inherited from the top level environment,
226
- * and so must be specified in every named environment.
227
- *
228
- * @default `{bindings:[]}`
229
- * @nonInheritable
230
- */
231
- durable_objects: {
232
- bindings: {
233
- /** The name of the binding used to refer to the Durable Object */
234
- name: string;
235
- /** The exported class name of the Durable Object */
236
- class_name: string;
237
- /** The script where the Durable Object is defined (if it's external to this worker) */
238
- script_name?: string;
239
- }[];
240
- };
241
-
242
- /**
243
- * These specify any Workers KV Namespaces you want to
244
- * access from inside your Worker.
245
- *
246
- * To learn more about KV Namespaces,
247
- * see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works
248
- *
249
- * NOTE: This field is not automatically inherited from the top level environment,
250
- * and so must be specified in every named environment.
251
- *
252
- * @default `[]`
253
- * @nonInheritable
254
- */
255
- kv_namespaces: {
256
- /** The binding name used to refer to the KV Namespace */
257
- binding: string;
258
- /** The ID of the KV namespace */
259
- id: string;
260
- /** The ID of the KV namespace used during `wrangler dev` */
261
- preview_id?: string;
262
- }[];
263
-
264
- /**
265
- * Specifies R2 buckets that are bound to this Worker environment.
266
- *
267
- * NOTE: This field is not automatically inherited from the top level environment,
268
- * and so must be specified in every named environment.
269
- *
270
- * @default `[]`
271
- * @nonInheritable
272
- */
273
- r2_buckets: {
274
- /** The binding name used to refer to the R2 bucket in the worker. */
275
- binding: string;
276
- /** The name of this R2 bucket at the edge. */
277
- bucket_name: string;
278
- /** The preview name of this R2 bucket at the edge. */
279
- preview_bucket_name?: string;
280
- }[];
281
-
282
- /**
283
- * "Unsafe" tables for features that aren't directly supported by wrangler.
284
- *
285
- * NOTE: This field is not automatically inherited from the top level environment,
286
- * and so must be specified in every named environment.
287
- *
288
- * @default `{ bindings: [] }`
289
- * @nonInheritable
290
- */
291
- unsafe: {
292
- /**
293
- * A set of bindings that should be put into a Worker's upload metadata without changes. These
294
- * can be used to implement bindings for features that haven't released and aren't supported
295
- * directly by wrangler or miniflare.
296
- *
297
- * @default []
298
- */
299
- bindings: {
300
- name: string;
301
- type: string;
302
- [key: string]: unknown;
303
- }[];
304
- };
272
+ /**
273
+ * A map of values to substitute when deploying your worker.
274
+ *
275
+ * NOTE: This field is not automatically inherited from the top level environment,
276
+ * and so must be specified in every named environment.
277
+ *
278
+ * @default `{}`
279
+ * @nonInheritable
280
+ */
281
+ define: Record<string, string>;
282
+ /**
283
+ * A map of environment variables to set when deploying your worker.
284
+ *
285
+ * NOTE: This field is not automatically inherited from the top level environment,
286
+ * and so must be specified in every named environment.
287
+ *
288
+ * @default `{}`
289
+ * @nonInheritable
290
+ */
291
+ vars: { [key: string]: unknown };
292
+
293
+ /**
294
+ * A list of durable objects that your worker should be bound to.
295
+ *
296
+ * For more information about Durable Objects, see the documentation at
297
+ * https://developers.cloudflare.com/workers/learning/using-durable-objects
298
+ *
299
+ * NOTE: This field is not automatically inherited from the top level environment,
300
+ * and so must be specified in every named environment.
301
+ *
302
+ * @default `{bindings:[]}`
303
+ * @nonInheritable
304
+ */
305
+ durable_objects: {
306
+ bindings: {
307
+ /** The name of the binding used to refer to the Durable Object */
308
+ name: string;
309
+ /** The exported class name of the Durable Object */
310
+ class_name: string;
311
+ /** The script where the Durable Object is defined (if it's external to this worker) */
312
+ script_name?: string;
313
+ /** The service environment of the script_name to bind to */
314
+ environment?: string;
315
+ }[];
316
+ };
317
+
318
+ /**
319
+ * These specify any Workers KV Namespaces you want to
320
+ * access from inside your Worker.
321
+ *
322
+ * To learn more about KV Namespaces,
323
+ * see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works
324
+ *
325
+ * NOTE: This field is not automatically inherited from the top level environment,
326
+ * and so must be specified in every named environment.
327
+ *
328
+ * @default `[]`
329
+ * @nonInheritable
330
+ */
331
+ kv_namespaces: {
332
+ /** The binding name used to refer to the KV Namespace */
333
+ binding: string;
334
+ /** The ID of the KV namespace */
335
+ id: string;
336
+ /** The ID of the KV namespace used during `wrangler dev` */
337
+ preview_id?: string;
338
+ }[];
339
+
340
+ /**
341
+ * Specifies Queues that are bound to this Worker environment.
342
+ *
343
+ * NOTE: This field is not automatically inherited from the top level environment,
344
+ * and so must be specified in every named environment.
345
+ *
346
+ * @default `{}`
347
+ * @nonInheritable
348
+ */
349
+ queues: {
350
+ /** Producer bindings */
351
+ producers?: {
352
+ /** The binding name used to refer to the Queue in the worker. */
353
+ binding: string;
354
+
355
+ /** The name of this Queue. */
356
+ queue: string;
357
+ }[];
358
+
359
+ /** Consumer configuration */
360
+ consumers?: {
361
+ /** The name of the queue from which this script should consume. */
362
+ queue: string;
363
+
364
+ /** The maximum number of messages per batch */
365
+ max_batch_size?: number;
366
+
367
+ /** The maximum number of seconds to wait to fill a batch with messages. */
368
+ max_batch_timeout?: number;
369
+
370
+ /** The maximum number of retries for each message. */
371
+ max_retries?: number;
372
+
373
+ /** The queue to send messages that failed to be consumed. */
374
+ dead_letter_queue?: string;
375
+ }[];
376
+ };
377
+
378
+ /**
379
+ * Specifies R2 buckets that are bound to this Worker environment.
380
+ *
381
+ * NOTE: This field is not automatically inherited from the top level environment,
382
+ * and so must be specified in every named environment.
383
+ *
384
+ * @default `[]`
385
+ * @nonInheritable
386
+ */
387
+ r2_buckets: {
388
+ /** The binding name used to refer to the R2 bucket in the worker. */
389
+ binding: string;
390
+ /** The name of this R2 bucket at the edge. */
391
+ bucket_name: string;
392
+ /** The preview name of this R2 bucket at the edge. */
393
+ preview_bucket_name?: string;
394
+ }[];
395
+
396
+ /**
397
+ * Specifies D1 databases that are bound to this Worker environment.
398
+ *
399
+ * NOTE: This field is not automatically inherited from the top level environment,
400
+ * and so must be specified in every named environment.
401
+ *
402
+ * @default `[]`
403
+ * @nonInheritable
404
+ */
405
+ d1_databases: {
406
+ /** The binding name used to refer to the D1 database in the worker. */
407
+ binding: string;
408
+ /** The name of this D1 database. */
409
+ database_name: string;
410
+ /** The UUID of this D1 database (not required). */
411
+ database_id: string;
412
+ /** The UUID of this D1 database for Wrangler Dev (if specified). */
413
+ preview_database_id?: string;
414
+ /** The name of the migrations table for this D1 database (defaults to 'd1_migrations'). */
415
+ migrations_table?: string;
416
+ /** The path to the directory of migrations for this D1 database (defaults to './migrations'). */
417
+ migrations_dir?: string;
418
+ /** Internal use only. */
419
+ database_internal_env?: string;
420
+ }[];
421
+
422
+ /**
423
+ * Specifies service bindings (worker-to-worker) that are bound to this Worker environment.
424
+ *
425
+ * NOTE: This field is not automatically inherited from the top level environment,
426
+ * and so must be specified in every named environment.
427
+ *
428
+ * @default `[]`
429
+ * @nonInheritable
430
+ */
431
+ services:
432
+ | {
433
+ /** The binding name used to refer to the bound service. */
434
+ binding: string;
435
+ /** The name of the service. */
436
+ service: string;
437
+ /** The environment of the service (e.g. production, staging, etc). */
438
+ environment?: string;
439
+ }[]
440
+ | undefined;
441
+
442
+ /**
443
+ * "Unsafe" tables for features that aren't directly supported by wrangler.
444
+ *
445
+ * NOTE: This field is not automatically inherited from the top level environment,
446
+ * and so must be specified in every named environment.
447
+ *
448
+ * @default `{ bindings: [] }`
449
+ * @nonInheritable
450
+ */
451
+ unsafe: {
452
+ /**
453
+ * A set of bindings that should be put into a Worker's upload metadata without changes. These
454
+ * can be used to implement bindings for features that haven't released and aren't supported
455
+ * directly by wrangler or miniflare.
456
+ *
457
+ * @default []
458
+ */
459
+ bindings: {
460
+ name: string;
461
+ type: string;
462
+ [key: string]: unknown;
463
+ }[];
464
+ };
305
465
  }
306
466
 
307
467
  /**
308
468
  * The environment configuration properties that have been deprecated.
309
469
  */
310
470
  interface EnvironmentDeprecated {
311
- /**
312
- * The zone ID of the zone you want to deploy to. You can find this
313
- * in your domain page on the dashboard.
314
- *
315
- * @deprecated This is unnecessary since we can deduce this from routes directly.
316
- */
317
- zone_id?: string;
318
-
319
- /**
320
- * A list of services that your worker should be bound to.
321
- *
322
- * @default `[]`
323
- * @deprecated DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.
324
- */
325
- experimental_services?: {
326
- /** The binding name used to refer to the Service */
327
- name: string;
328
- /** The name of the Service being bound */
329
- service: string;
330
- /** The Service's environment */
331
- environment: string;
332
- }[];
471
+ /**
472
+ * The zone ID of the zone you want to deploy to. You can find this
473
+ * in your domain page on the dashboard.
474
+ *
475
+ * @deprecated This is unnecessary since we can deduce this from routes directly.
476
+ */
477
+ zone_id?: string;
478
+
479
+ /**
480
+ * Legacy way of defining KVNamespaces that is no longer supported.
481
+ *
482
+ * @deprecated DO NOT USE. This was a legacy bug from wrangler 1, that we do not want to support.
483
+ */
484
+ "kv-namespaces"?: string;
485
+
486
+ /**
487
+ * A list of services that your worker should be bound to.
488
+ *
489
+ * @default `[]`
490
+ * @deprecated DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.
491
+ */
492
+ experimental_services?: {
493
+ /** The binding name used to refer to the Service */
494
+ name: string;
495
+ /** The name of the Service being bound */
496
+ service: string;
497
+ /** The Service's environment */
498
+ environment: string;
499
+ }[];
333
500
  }
334
501
 
335
502
  /**
336
503
  * Deprecated upload configuration.
337
504
  */
338
505
  export interface DeprecatedUpload {
339
- /**
340
- * The format of the Worker script.
341
- *
342
- * @deprecated We infer the format automatically now.
343
- */
344
- format?: "modules" | "service-worker";
345
-
346
- /**
347
- * The directory you wish to upload your worker from,
348
- * relative to the wrangler.toml file.
349
- *
350
- * Defaults to the directory containing the wrangler.toml file.
351
- *
352
- * @deprecated
353
- */
354
- dir?: string;
355
-
356
- /**
357
- * The path to the Worker script, relative to `upload.dir`.
358
- *
359
- * @deprecated This will be replaced by a command line argument.
360
- */
361
- main?: string;
362
-
363
- /**
364
- * @deprecated This is now defined at the top level `rules` field.
365
- */
366
- rules?: Environment["rules"];
506
+ /**
507
+ * The format of the Worker script.
508
+ *
509
+ * @deprecated We infer the format automatically now.
510
+ */
511
+ format?: "modules" | "service-worker";
512
+
513
+ /**
514
+ * The directory you wish to upload your worker from,
515
+ * relative to the wrangler.toml file.
516
+ *
517
+ * Defaults to the directory containing the wrangler.toml file.
518
+ *
519
+ * @deprecated
520
+ */
521
+ dir?: string;
522
+
523
+ /**
524
+ * The path to the Worker script, relative to `upload.dir`.
525
+ *
526
+ * @deprecated This will be replaced by a command line argument.
527
+ */
528
+ main?: string;
529
+
530
+ /**
531
+ * @deprecated This is now defined at the top level `rules` field.
532
+ */
533
+ rules?: Environment["rules"];
367
534
  }
368
535
 
369
536
  /**
@@ -378,17 +545,17 @@ export type RawEnvironment = Partial<Environment> & EnvironmentDeprecated;
378
545
  * A bundling resolver rule, defining the modules type for paths that match the specified globs.
379
546
  */
380
547
  export type Rule = {
381
- type: ConfigModuleRuleType;
382
- globs: string[];
383
- fallthrough?: boolean;
548
+ type: ConfigModuleRuleType;
549
+ globs: string[];
550
+ fallthrough?: boolean;
384
551
  };
385
552
 
386
553
  /**
387
554
  * The possible types for a `Rule`.
388
555
  */
389
556
  export type ConfigModuleRuleType =
390
- | "ESModule"
391
- | "CommonJS"
392
- | "CompiledWasm"
393
- | "Text"
394
- | "Data";
557
+ | "ESModule"
558
+ | "CommonJS"
559
+ | "CompiledWasm"
560
+ | "Text"
561
+ | "Data";