wrangler 0.0.0-ee0c380 → 0.0.0-ee305dd67

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 (186) hide show
  1. package/README.md +33 -11
  2. package/bin/wrangler.js +86 -67
  3. package/config-schema.json +3123 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +127 -96
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +2 -3
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  21. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  22. package/templates/middleware/middleware-pretty-error.ts +40 -0
  23. package/templates/middleware/middleware-scheduled.ts +29 -0
  24. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  25. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  26. package/templates/modules-watch-stub.js +4 -0
  27. package/templates/new-worker-scheduled.js +17 -0
  28. package/templates/new-worker-scheduled.ts +32 -0
  29. package/templates/new-worker.js +3 -3
  30. package/templates/new-worker.ts +19 -16
  31. package/templates/no-op-worker.js +10 -0
  32. package/templates/pages-dev-pipeline.ts +32 -0
  33. package/templates/pages-dev-util.ts +55 -0
  34. package/templates/pages-shim.ts +9 -0
  35. package/templates/pages-template-plugin.ts +190 -0
  36. package/templates/pages-template-worker.ts +198 -0
  37. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  38. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  39. package/templates/tsconfig-sanity.ts +11 -0
  40. package/templates/tsconfig.init.json +22 -0
  41. package/templates/tsconfig.json +6 -103
  42. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  43. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  44. package/wrangler-dist/ProxyWorker.js +241 -0
  45. package/wrangler-dist/ProxyWorker.js.map +6 -0
  46. package/wrangler-dist/cli.d.ts +26521 -0
  47. package/wrangler-dist/cli.js +164922 -114762
  48. package/Cloudflare_CA.pem +0 -18
  49. package/import_meta_url.js +0 -3
  50. package/miniflare-config-stubs/.env.empty +0 -0
  51. package/miniflare-config-stubs/package.empty.json +0 -1
  52. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  53. package/miniflare-dist/index.mjs +0 -4886
  54. package/pages/functions/buildPlugin.ts +0 -105
  55. package/pages/functions/buildWorker.ts +0 -151
  56. package/pages/functions/filepath-routing.test.ts +0 -234
  57. package/pages/functions/filepath-routing.ts +0 -189
  58. package/pages/functions/identifiers.ts +0 -78
  59. package/pages/functions/routes.ts +0 -156
  60. package/pages/functions/template-plugin.ts +0 -147
  61. package/pages/functions/template-worker.ts +0 -143
  62. package/src/__tests__/config-cache.test.ts +0 -36
  63. package/src/__tests__/configuration.test.ts +0 -3374
  64. package/src/__tests__/dev.test.tsx +0 -980
  65. package/src/__tests__/guess-worker-format.test.ts +0 -85
  66. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  67. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  68. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  69. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  70. package/src/__tests__/helpers/mock-bin.ts +0 -36
  71. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  72. package/src/__tests__/helpers/mock-console.ts +0 -87
  73. package/src/__tests__/helpers/mock-dialogs.ts +0 -90
  74. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  75. package/src/__tests__/helpers/mock-istty.ts +0 -27
  76. package/src/__tests__/helpers/mock-kv.ts +0 -33
  77. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -255
  78. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  79. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  80. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  81. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  82. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  83. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  84. package/src/__tests__/https-options.test.ts +0 -130
  85. package/src/__tests__/index.test.ts +0 -256
  86. package/src/__tests__/init.test.ts +0 -1557
  87. package/src/__tests__/jest.setup.ts +0 -77
  88. package/src/__tests__/kv.test.ts +0 -1481
  89. package/src/__tests__/logger.test.ts +0 -115
  90. package/src/__tests__/package-manager.test.ts +0 -353
  91. package/src/__tests__/pages.test.ts +0 -657
  92. package/src/__tests__/parse.test.ts +0 -330
  93. package/src/__tests__/publish.test.ts +0 -5468
  94. package/src/__tests__/r2.test.ts +0 -233
  95. package/src/__tests__/route.test.ts +0 -45
  96. package/src/__tests__/secret.test.ts +0 -481
  97. package/src/__tests__/tail.test.ts +0 -690
  98. package/src/__tests__/user.test.ts +0 -131
  99. package/src/__tests__/whoami.test.tsx +0 -105
  100. package/src/abort.d.ts +0 -3
  101. package/src/bundle.ts +0 -200
  102. package/src/cfetch/index.ts +0 -121
  103. package/src/cfetch/internal.ts +0 -145
  104. package/src/cli.ts +0 -13
  105. package/src/config/README.md +0 -107
  106. package/src/config/config.ts +0 -234
  107. package/src/config/diagnostics.ts +0 -80
  108. package/src/config/environment.ts +0 -420
  109. package/src/config/index.ts +0 -225
  110. package/src/config/validation-helpers.ts +0 -575
  111. package/src/config/validation.ts +0 -1539
  112. package/src/config-cache.ts +0 -45
  113. package/src/create-worker-preview.ts +0 -185
  114. package/src/create-worker-upload-form.ts +0 -254
  115. package/src/dev/dev-vars.ts +0 -36
  116. package/src/dev/dev.tsx +0 -419
  117. package/src/dev/local.tsx +0 -318
  118. package/src/dev/remote.tsx +0 -227
  119. package/src/dev/use-esbuild.ts +0 -118
  120. package/src/dialogs.tsx +0 -87
  121. package/src/durable.ts +0 -102
  122. package/src/entry.ts +0 -322
  123. package/src/environment-variables.ts +0 -35
  124. package/src/errors.ts +0 -11
  125. package/src/https-options.ts +0 -123
  126. package/src/index.tsx +0 -2809
  127. package/src/inspect.ts +0 -662
  128. package/src/intl-polyfill.d.ts +0 -139
  129. package/src/kv.ts +0 -408
  130. package/src/logger.ts +0 -66
  131. package/src/miniflare-cli/README.md +0 -30
  132. package/src/miniflare-cli/enum-keys.ts +0 -17
  133. package/src/miniflare-cli/index.ts +0 -41
  134. package/src/miniflare-cli/request-context.ts +0 -40
  135. package/src/module-collection.ts +0 -258
  136. package/src/open-in-browser.ts +0 -19
  137. package/src/package-manager.ts +0 -174
  138. package/src/pages.tsx +0 -2027
  139. package/src/parse.ts +0 -202
  140. package/src/paths.ts +0 -26
  141. package/src/proxy.ts +0 -465
  142. package/src/publish.ts +0 -583
  143. package/src/r2.ts +0 -50
  144. package/src/selfsigned.d.ts +0 -29
  145. package/src/sites.tsx +0 -295
  146. package/src/tail/filters.ts +0 -279
  147. package/src/tail/index.ts +0 -299
  148. package/src/tail/printing.ts +0 -67
  149. package/src/update-check.ts +0 -19
  150. package/src/user.tsx +0 -1203
  151. package/src/whoami.tsx +0 -70
  152. package/src/worker.ts +0 -180
  153. package/templates/static-asset-facade.js +0 -47
  154. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  155. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  156. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  157. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  158. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  159. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  160. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  161. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  162. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  163. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  164. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  165. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  166. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  167. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  168. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  169. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  170. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  171. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  172. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  173. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  174. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  175. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  176. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  177. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  178. package/vendor/wrangler-mime/LICENSE +0 -21
  179. package/vendor/wrangler-mime/Mime.js +0 -97
  180. package/vendor/wrangler-mime/README.md +0 -187
  181. package/vendor/wrangler-mime/cli.js +0 -46
  182. package/vendor/wrangler-mime/index.js +0 -4
  183. package/vendor/wrangler-mime/lite.js +0 -4
  184. package/vendor/wrangler-mime/package.json +0 -52
  185. package/vendor/wrangler-mime/types/other.js +0 -1
  186. package/vendor/wrangler-mime/types/standard.js +0 -1
package/README.md CHANGED
@@ -1,9 +1,17 @@
1
- ## ⛅️ wrangler
2
-
3
- > This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler.
1
+ <h1 align="center"> ⛅️ wrangler </h1>
2
+ <section align="center" id="shieldio-badges">
3
+ <a href="https://www.npmjs.com/package/wrangler"><img alt="npm" src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
4
+ <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/workers-sdk?style=flat-square">
5
+ <img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/workers-sdk/main?style=flat-square">
6
+ <a href="https://discord.cloudflare.com"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
7
+ </section>
4
8
 
5
9
  `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
6
10
 
11
+ > [!WARNING]
12
+ >
13
+ > Wrangler v2 is **only receiving critical security updates.** We recommend you [migrate to Wrangler v3](https://developers.cloudflare.com/workers/wrangler/migration/update-v2-to-v3/) if you can.
14
+
7
15
  ## Quick Start
8
16
 
9
17
  ```bash
@@ -11,8 +19,8 @@
11
19
  echo "export default { fetch() { return new Response('hello world') } }" > index.js
12
20
  # try it out
13
21
  npx wrangler dev index.js
14
- # and then publish it
15
- npx wrangler publish index.js --name my-worker
22
+ # and then deploy it
23
+ npx wrangler deploy index.js --name my-worker
16
24
  # visit https://my-worker.<your workers subdomain>.workers.dev
17
25
  ```
18
26
 
@@ -20,10 +28,10 @@ npx wrangler publish index.js --name my-worker
20
28
 
21
29
  ```bash
22
30
  # Generate a new project
23
- npx wrangler init my-worker
31
+ npx wrangler init my-worker --no-delegate-c3
24
32
  # try it out
25
33
  cd my-worker && npm run start
26
- # and then publish it
34
+ # and then deploy it
27
35
  npm run deploy
28
36
  ```
29
37
 
@@ -33,21 +41,35 @@ npm run deploy
33
41
  $ npm install wrangler --save-dev
34
42
  ```
35
43
 
44
+ ## Configuration:
45
+
46
+ Wrangler is configured via a `wrangler.toml` file in the project root. When utilizing the `wrangler init` command, a `wrangler.toml` file will be created for you.
47
+
48
+ Example:
49
+
50
+ ```toml
51
+ name = "my-worker"
52
+ main = "./src/index.ts" # init w/ TypeScript
53
+ compatibility_date = "YYYY-MM-DD"
54
+ ```
55
+
56
+ For more detailed information about configuration, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
57
+
36
58
  ## Commands
37
59
 
38
60
  ### `wrangler init [name]`
39
61
 
40
- Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
62
+ Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).
41
63
 
42
64
  ### `wrangler dev`
43
65
 
44
66
  Start a local development server, with live reloading and devtools.
45
67
 
46
- ### `wrangler publish`
68
+ ### `wrangler deploy`
47
69
 
48
70
  Publish the given script to the worldwide Cloudflare network.
49
71
 
50
- For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
72
+ For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
51
73
 
52
74
  ## Pages
53
75
 
@@ -61,4 +83,4 @@ For more commands and options, refer to the [documentation](https://developers.c
61
83
 
62
84
  ## Documentation
63
85
 
64
- For the latest Wrangler documentation, [click here](https://6b05b6e1.cloudflare-docs-7ou.pages.dev/workers/wrangler/).
86
+ For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
package/bin/wrangler.js CHANGED
@@ -3,78 +3,97 @@ const { spawn } = require("child_process");
3
3
  const path = require("path");
4
4
  const fs = require("fs");
5
5
  const os = require("os");
6
- const semiver = require("semiver");
7
6
 
8
- const MIN_NODE_VERSION = "16.7.0";
7
+ const MIN_NODE_VERSION = "16.13.0";
8
+ const debug =
9
+ process.env["WRANGLER_LOG"] === "debug"
10
+ ? (...args) => console.log(...args)
11
+ : () => {};
9
12
 
10
13
  let wranglerProcess;
11
14
 
12
- async function main() {
13
- if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
14
- // Note Volta and nvm are also recommended in the official docs:
15
- // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
16
- console.error(
17
- `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
18
- You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
15
+ /**
16
+ * Executes ../wrangler-dist/cli.js
17
+ */
18
+ function runWrangler() {
19
+ if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
20
+ // Note Volta and nvm are also recommended in the official docs:
21
+ // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
22
+ console.error(
23
+ `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of Node.js.
24
+
19
25
  Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
20
- );
21
- process.exitCode = 1;
22
- return;
23
- }
24
-
25
- let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
26
- if (pathToCACerts) {
27
- // TODO:
28
- // - should we log a warning here?
29
- // - maybe we can generate a certificate that concatenates with ours?
30
- //
31
- // I do think it'll be rare that someone wants to add a cert AND
32
- // use cloudflare WARP, but let's wait till the situation actually
33
- // arises before we do anything about it
34
- } else {
35
- const osTempDir = os.tmpdir();
36
- const certDir = path.join(osTempDir, "wrangler-cert");
37
- const certPath = path.join(certDir, "Cloudflare_CA.pem");
38
- // copy cert to the system temp dir if needed
39
- if (!fs.existsSync(certPath)) {
40
- fs.mkdirSync(certDir, { recursive: true });
41
- fs.writeFileSync(
42
- certPath,
43
- fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
44
- );
45
- }
46
- pathToCACerts = certPath;
47
- }
48
-
49
- wranglerProcess = spawn(
50
- process.execPath,
51
- [
52
- ...(semiver(process.versions.node, "18.0.0") >= 0
53
- ? ["--no-experimental-fetch"] // TODO: remove this when https://github.com/cloudflare/wrangler2/issues/834 is properly fixed
54
- : []),
55
- "--no-warnings",
56
- "--experimental-vm-modules",
57
- ...process.execArgv,
58
- path.join(__dirname, "../wrangler-dist/cli.js"),
59
- ...process.argv.slice(2),
60
- ],
61
- {
62
- stdio: "inherit",
63
- env: {
64
- ...process.env,
65
- NODE_EXTRA_CA_CERTS: pathToCACerts,
66
- },
67
- }
68
- ).on("exit", (code) =>
69
- process.exit(code === undefined || code === null ? 0 : code)
70
- );
26
+ );
27
+ process.exitCode = 1;
28
+ return;
29
+ }
30
+
31
+ return spawn(
32
+ process.execPath,
33
+ [
34
+ "--no-warnings",
35
+ "--experimental-vm-modules",
36
+ ...process.execArgv,
37
+ path.join(__dirname, "../wrangler-dist/cli.js"),
38
+ ...process.argv.slice(2),
39
+ ],
40
+ {
41
+ stdio: ["inherit", "inherit", "inherit", "ipc"],
42
+ }
43
+ )
44
+ .on("exit", (code) =>
45
+ process.exit(code === undefined || code === null ? 0 : code)
46
+ )
47
+ .on("message", (message) => {
48
+ if (process.send) {
49
+ process.send(message);
50
+ }
51
+ })
52
+ .on("disconnect", () => {
53
+ if (process.disconnect) {
54
+ process.disconnect();
55
+ }
56
+ });
57
+ }
58
+
59
+ // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
60
+
61
+ /**
62
+ MIT License
63
+
64
+ Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
65
+
66
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
67
+
68
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
69
+
70
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
71
+
72
+ */
73
+
74
+ var fn = new Intl.Collator(0, { numeric: 1 }).compare;
75
+
76
+ function semiver(a, b, bool) {
77
+ a = a.split(".");
78
+ b = b.split(".");
79
+
80
+ return (
81
+ fn(a[0], b[0]) ||
82
+ fn(a[1], b[1]) ||
83
+ ((b[2] = b.slice(2).join(".")),
84
+ (bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
85
+ bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
86
+ );
71
87
  }
72
88
 
73
- process.on("SIGINT", () => {
74
- wranglerProcess.kill();
75
- });
76
- process.on("SIGTERM", () => {
77
- wranglerProcess.kill();
78
- });
89
+ // end semiver implementation
79
90
 
80
- void main();
91
+ if (module === require.main) {
92
+ wranglerProcess = runWrangler();
93
+ process.on("SIGINT", () => {
94
+ wranglerProcess && wranglerProcess.kill();
95
+ });
96
+ process.on("SIGTERM", () => {
97
+ wranglerProcess && wranglerProcess.kill();
98
+ });
99
+ }