wrangler 0.0.0-e64812e → 0.0.0-e7a0cd5b

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