wrangler 0.0.0-e3e3243 → 0.0.0-e4047cab

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 (310) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +166 -31
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6263 -21
  6. package/package.json +191 -141
  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 +42 -0
  13. package/src/__tests__/configuration.test.ts +3971 -2810
  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 +1521 -526
  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 +74 -57
  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 +219 -93
  26. package/src/__tests__/helpers/mock-console.ts +68 -32
  27. package/src/__tests__/helpers/mock-dialogs.ts +121 -33
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  30. package/src/__tests__/helpers/mock-istty.ts +74 -0
  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 +256 -0
  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 +28 -22
  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 +31 -0
  54. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  55. package/src/__tests__/https-options.test.ts +144 -108
  56. package/src/__tests__/index.test.ts +248 -967
  57. package/src/__tests__/init.test.ts +2900 -0
  58. package/src/__tests__/jest.setup.ts +167 -34
  59. package/src/__tests__/kv.test.ts +1661 -1366
  60. package/src/__tests__/logger.test.ts +141 -0
  61. package/src/__tests__/logout.test.ts +36 -41
  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 +2437 -77
  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 +7569 -3445
  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 -193
  74. package/src/__tests__/route.test.ts +22 -22
  75. package/src/__tests__/secret.test.ts +626 -407
  76. package/src/__tests__/tail.test.ts +779 -442
  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 +129 -0
  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 +266 -88
  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 +791 -123
  90. package/src/cfetch/index.ts +123 -67
  91. package/src/cfetch/internal.ts +216 -92
  92. package/src/cli.ts +23 -14
  93. package/src/config/README.md +1 -1
  94. package/src/config/config.ts +236 -179
  95. package/src/config/diagnostics.ts +61 -61
  96. package/src/config/environment.ts +506 -316
  97. package/src/config/index.ts +310 -38
  98. package/src/config/validation-helpers.ts +385 -342
  99. package/src/config/validation.ts +1970 -1099
  100. package/src/config-cache.ts +85 -0
  101. package/src/create-worker-preview.ts +240 -124
  102. package/src/create-worker-upload-form.ts +300 -201
  103. package/src/d1/backups.tsx +223 -0
  104. package/src/d1/constants.ts +2 -0
  105. package/src/d1/create.tsx +63 -0
  106. package/src/d1/delete.tsx +56 -0
  107. package/src/d1/execute.tsx +352 -0
  108. package/src/d1/formatTimeAgo.ts +14 -0
  109. package/src/d1/index.ts +101 -0
  110. package/src/d1/list.tsx +48 -0
  111. package/src/d1/migrations/apply.tsx +184 -0
  112. package/src/d1/migrations/create.tsx +77 -0
  113. package/src/d1/migrations/helpers.ts +147 -0
  114. package/src/d1/migrations/index.tsx +3 -0
  115. package/src/d1/migrations/list.tsx +79 -0
  116. package/src/d1/migrations/options.ts +18 -0
  117. package/src/d1/options.ts +22 -0
  118. package/src/d1/types.tsx +24 -0
  119. package/src/d1/utils.ts +48 -0
  120. package/src/delete.ts +108 -0
  121. package/src/deployments.ts +77 -0
  122. package/src/deprecated/index.ts +438 -0
  123. package/src/dev/dev-vars.ts +39 -0
  124. package/src/dev/dev.tsx +550 -328
  125. package/src/dev/get-local-persistence-path.tsx +31 -0
  126. package/src/dev/local.tsx +871 -213
  127. package/src/dev/remote.tsx +592 -192
  128. package/src/dev/start-server.ts +539 -0
  129. package/src/dev/use-esbuild.ts +184 -84
  130. package/src/dev/validate-dev-props.ts +31 -0
  131. package/src/dev-registry.tsx +201 -0
  132. package/src/dev.tsx +904 -0
  133. package/src/dialogs.tsx +150 -59
  134. package/src/dispatch-namespace.ts +207 -0
  135. package/src/durable.ts +102 -0
  136. package/src/entry.ts +260 -171
  137. package/src/environment-variables.ts +40 -23
  138. package/src/errors.ts +11 -0
  139. package/src/git-client.ts +124 -0
  140. package/src/global-wrangler-config-path.ts +26 -0
  141. package/src/https-options.ts +85 -80
  142. package/src/index.tsx +639 -2341
  143. package/src/init.ts +970 -0
  144. package/src/inspect.ts +707 -557
  145. package/src/intl-polyfill.d.ts +123 -123
  146. package/src/is-ci.ts +14 -0
  147. package/src/is-interactive.ts +16 -0
  148. package/src/kv/helpers.ts +430 -0
  149. package/src/kv/index.ts +596 -0
  150. package/src/logger.ts +92 -0
  151. package/src/metrics/index.ts +5 -0
  152. package/src/metrics/metrics-config.ts +239 -0
  153. package/src/metrics/metrics-dispatcher.ts +96 -0
  154. package/src/metrics/metrics-usage-headers.ts +24 -0
  155. package/src/metrics/send-event.ts +96 -0
  156. package/src/miniflare-cli/assets.ts +220 -0
  157. package/src/miniflare-cli/index.ts +206 -30
  158. package/src/miniflare-cli/request-context.ts +40 -0
  159. package/src/module-collection.ts +222 -213
  160. package/src/open-in-browser.ts +8 -16
  161. package/src/package-manager.ts +183 -90
  162. package/src/pages/build.tsx +270 -0
  163. package/src/pages/constants.ts +18 -0
  164. package/src/pages/deployment-tails.tsx +284 -0
  165. package/src/pages/deployments.tsx +84 -0
  166. package/src/pages/dev.tsx +706 -0
  167. package/src/pages/errors.ts +66 -0
  168. package/src/pages/functions/buildPlugin.ts +107 -0
  169. package/src/pages/functions/buildWorker.ts +166 -0
  170. package/src/pages/functions/filepath-routing.test.ts +234 -0
  171. package/src/pages/functions/filepath-routing.ts +189 -0
  172. package/src/pages/functions/identifiers.ts +78 -0
  173. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  174. package/src/pages/functions/routes-consolidation.ts +73 -0
  175. package/src/pages/functions/routes-transformation.test.ts +282 -0
  176. package/src/pages/functions/routes-transformation.ts +115 -0
  177. package/src/pages/functions/routes-validation.test.ts +403 -0
  178. package/src/pages/functions/routes-validation.ts +202 -0
  179. package/src/pages/functions/routes.ts +151 -0
  180. package/src/pages/functions.tsx +82 -0
  181. package/src/pages/hash.tsx +13 -0
  182. package/src/pages/index.tsx +102 -0
  183. package/src/pages/projects.tsx +169 -0
  184. package/src/pages/prompt-select-project.tsx +31 -0
  185. package/src/pages/publish.tsx +451 -0
  186. package/src/pages/types.ts +41 -0
  187. package/src/pages/upload.tsx +426 -0
  188. package/src/pages/utils.ts +23 -0
  189. package/src/parse.ts +224 -121
  190. package/src/paths.ts +53 -8
  191. package/src/proxy.ts +629 -375
  192. package/src/publish/index.ts +270 -0
  193. package/src/publish/publish.ts +1035 -0
  194. package/src/pubsub/index.ts +286 -0
  195. package/src/pubsub/pubsub-commands.tsx +624 -0
  196. package/src/queues/cli/commands/consumer/add.ts +71 -0
  197. package/src/queues/cli/commands/consumer/index.ts +22 -0
  198. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  199. package/src/queues/cli/commands/create.ts +25 -0
  200. package/src/queues/cli/commands/delete.ts +26 -0
  201. package/src/queues/cli/commands/index.ts +36 -0
  202. package/src/queues/cli/commands/list.ts +25 -0
  203. package/src/queues/client.ts +135 -0
  204. package/src/queues/utils.ts +18 -0
  205. package/src/r2/constants.ts +4 -0
  206. package/src/r2/helpers.ts +131 -0
  207. package/src/r2/index.ts +289 -0
  208. package/src/routes.ts +140 -0
  209. package/src/secret/index.ts +378 -0
  210. package/src/selfsigned.d.ts +23 -23
  211. package/src/sites.tsx +283 -191
  212. package/src/tail/createTail.ts +379 -0
  213. package/src/tail/filters.ts +108 -110
  214. package/src/tail/index.ts +211 -296
  215. package/src/tail/printing.ts +92 -47
  216. package/src/type-generation.ts +173 -0
  217. package/src/update-check.ts +19 -0
  218. package/src/user/access.ts +69 -0
  219. package/src/user/choose-account.tsx +69 -0
  220. package/src/user/env-vars.ts +46 -0
  221. package/src/user/generate-auth-url.ts +33 -0
  222. package/src/user/generate-random-state.ts +16 -0
  223. package/src/user/index.ts +3 -0
  224. package/src/user/user.tsx +1198 -0
  225. package/src/utils/collectKeyValues.ts +14 -0
  226. package/src/whoami.tsx +142 -42
  227. package/src/worker.ts +182 -100
  228. package/src/yargs-types.ts +24 -0
  229. package/src/zones.ts +191 -0
  230. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  231. package/templates/checked-fetch.js +17 -0
  232. package/templates/d1-beta-facade.js +205 -0
  233. package/templates/first-party-worker-module-facade.ts +18 -0
  234. package/templates/format-dev-errors.ts +32 -0
  235. package/templates/gitignore +171 -0
  236. package/templates/init-tests/test-jest-new-worker.js +25 -0
  237. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  238. package/templates/middleware/common.ts +62 -0
  239. package/templates/middleware/loader-modules.ts +84 -0
  240. package/templates/middleware/loader-sw.ts +227 -0
  241. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  242. package/templates/middleware/middleware-pretty-error.ts +40 -0
  243. package/templates/middleware/middleware-scheduled.ts +15 -0
  244. package/templates/new-worker-scheduled.js +17 -0
  245. package/templates/new-worker-scheduled.ts +32 -0
  246. package/templates/new-worker.js +3 -3
  247. package/templates/new-worker.ts +18 -3
  248. package/templates/no-op-worker.js +10 -0
  249. package/templates/pages-dev-pipeline.ts +28 -0
  250. package/templates/pages-dev-util.ts +52 -0
  251. package/templates/pages-shim.ts +9 -0
  252. package/templates/pages-template-plugin.ts +171 -0
  253. package/templates/pages-template-worker.ts +189 -0
  254. package/templates/serve-static-assets.ts +63 -0
  255. package/templates/service-bindings-module-facade.js +54 -0
  256. package/templates/service-bindings-sw-facade.js +42 -0
  257. package/templates/tsconfig.json +96 -95
  258. package/wrangler-dist/cli.d.ts +893 -0
  259. package/wrangler-dist/cli.js +116816 -94969
  260. package/miniflare-dist/index.mjs.map +0 -7
  261. package/pages/functions/buildWorker.ts +0 -62
  262. package/pages/functions/filepath-routing.test.ts +0 -223
  263. package/pages/functions/filepath-routing.ts +0 -181
  264. package/pages/functions/identifiers.ts +0 -78
  265. package/pages/functions/routes.ts +0 -151
  266. package/pages/functions/template-worker.ts +0 -130
  267. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  268. package/src/__tests__/sentry.test.ts +0 -146
  269. package/src/kv.ts +0 -319
  270. package/src/miniflare-cli/enum-keys.ts +0 -17
  271. package/src/pages.tsx +0 -1061
  272. package/src/publish.ts +0 -350
  273. package/src/r2.ts +0 -50
  274. package/src/reporting.ts +0 -131
  275. package/src/user.tsx +0 -1127
  276. package/templates/static-asset-facade.js +0 -47
  277. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  278. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  279. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  280. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  281. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  282. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  283. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  284. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  286. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  287. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  288. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  289. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  290. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  291. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  292. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  293. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  294. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  295. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  296. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  297. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  298. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  299. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  300. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  301. package/vendor/wrangler-mime/LICENSE +0 -21
  302. package/vendor/wrangler-mime/Mime.js +0 -97
  303. package/vendor/wrangler-mime/README.md +0 -187
  304. package/vendor/wrangler-mime/cli.js +0 -46
  305. package/vendor/wrangler-mime/index.js +0 -4
  306. package/vendor/wrangler-mime/lite.js +0 -4
  307. package/vendor/wrangler-mime/package.json +0 -52
  308. package/vendor/wrangler-mime/types/other.js +0 -1
  309. package/vendor/wrangler-mime/types/standard.js +0 -1
  310. package/wrangler-dist/cli.js.map +0 -7
@@ -1,62 +0,0 @@
1
- import path from "node:path";
2
- import { build } from "esbuild";
3
-
4
- type Options = {
5
- routesModule: string;
6
- outfile: string;
7
- minify?: boolean;
8
- sourcemap?: boolean;
9
- fallbackService?: string;
10
- watch?: boolean;
11
- onEnd?: () => void;
12
- };
13
-
14
- export function buildWorker({
15
- routesModule,
16
- outfile = "bundle.js",
17
- minify = false,
18
- sourcemap = false,
19
- fallbackService = "ASSETS",
20
- watch = false,
21
- onEnd = () => {},
22
- }: Options) {
23
- return build({
24
- entryPoints: [
25
- path.resolve(__dirname, "../pages/functions/template-worker.ts"),
26
- ],
27
- inject: [routesModule],
28
- bundle: true,
29
- format: "esm",
30
- target: "esnext",
31
- outfile,
32
- minify,
33
- sourcemap,
34
- watch,
35
- allowOverwrite: true,
36
- define: {
37
- __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
38
- },
39
- plugins: [
40
- {
41
- name: "wrangler notifier and monitor",
42
- setup(pluginBuild) {
43
- pluginBuild.onEnd((result) => {
44
- if (result.errors.length > 0) {
45
- console.error(
46
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
47
- );
48
- } else if (result.warnings.length > 0) {
49
- console.warn(
50
- `${result.warnings.length} warning(s) when compiling Worker.`
51
- );
52
- onEnd();
53
- } else {
54
- console.log("Compiled Worker successfully.");
55
- onEnd();
56
- }
57
- });
58
- },
59
- },
60
- ],
61
- });
62
- }
@@ -1,223 +0,0 @@
1
- import { writeFileSync, mkdirSync } from "fs";
2
- import { runInTempDir } from "../../src/__tests__/helpers/run-in-tmp";
3
- import { toUrlPath } from "../../src/paths";
4
- import { compareRoutes, generateConfigFromFileTree } from "./filepath-routing";
5
- import type { UrlPath } from "../../src/paths";
6
- import type { HTTPMethod, RouteConfig } from "./routes";
7
-
8
- describe("filepath-routing", () => {
9
- describe("compareRoutes()", () => {
10
- test("routes / last", () => {
11
- expect(
12
- compareRoutes(routeConfig("/"), routeConfig("/foo"))
13
- ).toBeGreaterThanOrEqual(1);
14
- expect(
15
- compareRoutes(routeConfig("/"), routeConfig("/:foo"))
16
- ).toBeGreaterThanOrEqual(1);
17
- expect(
18
- compareRoutes(routeConfig("/"), routeConfig("/:foo*"))
19
- ).toBeGreaterThanOrEqual(1);
20
- });
21
-
22
- test("routes with fewer segments come after those with more segments", () => {
23
- expect(
24
- compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar"))
25
- ).toBeGreaterThanOrEqual(1);
26
- expect(
27
- compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar/cat"))
28
- ).toBeGreaterThanOrEqual(1);
29
- });
30
-
31
- test("routes with wildcard segments come after those without", () => {
32
- expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/foo"))).toBe(1);
33
- expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/:foo"))).toBe(
34
- 1
35
- );
36
- });
37
-
38
- test("routes with dynamic segments come after those without", () => {
39
- expect(compareRoutes(routeConfig("/:foo"), routeConfig("/foo"))).toBe(1);
40
- });
41
-
42
- test("routes with dynamic segments occurring earlier come after those with dynamic segments in later positions", () => {
43
- expect(
44
- compareRoutes(routeConfig("/foo/:id/bar"), routeConfig("/foo/bar/:id"))
45
- ).toBe(1);
46
- });
47
-
48
- test("routes with no HTTP method come after those specifying a method", () => {
49
- expect(
50
- compareRoutes(routeConfig("/foo"), routeConfig("/foo", "GET"))
51
- ).toBe(1);
52
- });
53
-
54
- test("two equal routes are sorted according to their original position in the list", () => {
55
- expect(
56
- compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo", "GET"))
57
- ).toBe(0);
58
- });
59
-
60
- test("it returns -1 if the first argument should appear first in the list", () => {
61
- expect(
62
- compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo"))
63
- ).toBe(-1);
64
- });
65
- });
66
-
67
- describe("generateConfigFromFileTree", () => {
68
- runInTempDir();
69
-
70
- it("should generate a route entry for each file in the tree", async () => {
71
- writeFileSync(
72
- "foo.ts",
73
- `
74
- export function onRequestGet() {}
75
- export function onRequestPost() {}
76
- `
77
- );
78
- writeFileSync(
79
- "bar.ts",
80
- `
81
- export function onRequestPut() {}
82
- export function onRequestDelete() {}
83
- `
84
- );
85
-
86
- mkdirSync("todos");
87
-
88
- writeFileSync(
89
- "todos/[id].ts",
90
- `
91
- export function onRequestPost() {}
92
- export function onRequestDelete() {}
93
- `
94
- );
95
-
96
- mkdirSync("authors");
97
- mkdirSync("authors/[authorId]");
98
- mkdirSync("authors/[authorId]/todos");
99
-
100
- writeFileSync(
101
- "authors/[authorId]/todos/[todoId].ts",
102
- `
103
- export function onRequestPost() {}
104
- `
105
- );
106
-
107
- mkdirSync("books");
108
-
109
- writeFileSync(
110
- "books/[[title]].ts",
111
- `
112
- export function onRequestPost() {}
113
- `
114
- );
115
-
116
- mkdirSync("cats");
117
- mkdirSync("cats/[[breed]]");
118
-
119
- writeFileSync(
120
- "cats/[[breed]]/blah.ts",
121
- `
122
- export function onRequestPost() {}
123
- `
124
- );
125
-
126
- // This won't actually work at runtime.
127
- writeFileSync(
128
- "cats/[[breed]]/[[name]].ts",
129
- `
130
- export function onRequestPost() {}
131
- `
132
- );
133
-
134
- const entries = await generateConfigFromFileTree({
135
- baseDir: ".",
136
- baseURL: "/base" as UrlPath,
137
- });
138
- expect(entries).toMatchInlineSnapshot(`
139
- Object {
140
- "routes": Array [
141
- Object {
142
- "method": "POST",
143
- "module": Array [
144
- "authors/[authorId]/todos/[todoId].ts:onRequestPost",
145
- ],
146
- "routePath": "/base/authors/:authorId/todos/:todoId",
147
- },
148
- Object {
149
- "method": "POST",
150
- "module": Array [
151
- "cats/[[breed]]/blah.ts:onRequestPost",
152
- ],
153
- "routePath": "/base/cats/:breed*/blah",
154
- },
155
- Object {
156
- "method": "POST",
157
- "module": Array [
158
- "cats/[[breed]]/[[name]].ts:onRequestPost",
159
- ],
160
- "routePath": "/base/cats/:breed*/:name*",
161
- },
162
- Object {
163
- "method": "DELETE",
164
- "module": Array [
165
- "todos/[id].ts:onRequestDelete",
166
- ],
167
- "routePath": "/base/todos/:id",
168
- },
169
- Object {
170
- "method": "POST",
171
- "module": Array [
172
- "todos/[id].ts:onRequestPost",
173
- ],
174
- "routePath": "/base/todos/:id",
175
- },
176
- Object {
177
- "method": "POST",
178
- "module": Array [
179
- "books/[[title]].ts:onRequestPost",
180
- ],
181
- "routePath": "/base/books/:title*",
182
- },
183
- Object {
184
- "method": "DELETE",
185
- "module": Array [
186
- "bar.ts:onRequestDelete",
187
- ],
188
- "routePath": "/base/bar",
189
- },
190
- Object {
191
- "method": "PUT",
192
- "module": Array [
193
- "bar.ts:onRequestPut",
194
- ],
195
- "routePath": "/base/bar",
196
- },
197
- Object {
198
- "method": "GET",
199
- "module": Array [
200
- "foo.ts:onRequestGet",
201
- ],
202
- "routePath": "/base/foo",
203
- },
204
- Object {
205
- "method": "POST",
206
- "module": Array [
207
- "foo.ts:onRequestPost",
208
- ],
209
- "routePath": "/base/foo",
210
- },
211
- ],
212
- }
213
- `);
214
- });
215
- });
216
- });
217
-
218
- function routeConfig(routePath: string, method?: string): RouteConfig {
219
- return {
220
- routePath: toUrlPath(routePath),
221
- method: method as HTTPMethod,
222
- };
223
- }
@@ -1,181 +0,0 @@
1
- import fs from "node:fs/promises";
2
- import path from "node:path";
3
- import { build } from "esbuild";
4
- import { toUrlPath } from "../../src/paths";
5
- import type { UrlPath } from "../../src/paths";
6
- import type { HTTPMethod, RouteConfig } from "./routes";
7
-
8
- export async function generateConfigFromFileTree({
9
- baseDir,
10
- baseURL,
11
- }: {
12
- baseDir: string;
13
- baseURL: UrlPath;
14
- }) {
15
- let routeEntries: RouteConfig[] = [];
16
-
17
- if (!baseURL.startsWith("/")) {
18
- baseURL = `/${baseURL}` as UrlPath;
19
- }
20
-
21
- if (baseURL.endsWith("/")) {
22
- baseURL = baseURL.slice(0, -1) as UrlPath;
23
- }
24
-
25
- await forEachFile(baseDir, async (filepath) => {
26
- const ext = path.extname(filepath);
27
- if (/^\.(mjs|js|ts|tsx|jsx)$/.test(ext)) {
28
- const { metafile } = await build({
29
- metafile: true,
30
- write: false,
31
- bundle: false,
32
- entryPoints: [path.resolve(filepath)],
33
- });
34
- const exportNames: string[] = [];
35
- if (metafile) {
36
- for (const output in metafile?.outputs) {
37
- exportNames.push(...metafile.outputs[output].exports);
38
- }
39
- }
40
- for (const exportName of exportNames) {
41
- const [match, method = ""] = (exportName.match(
42
- /^onRequest(Get|Post|Put|Patch|Delete|Options|Head)?$/
43
- ) ?? []) as (string | undefined)[];
44
-
45
- if (match) {
46
- const basename = path.basename(filepath).slice(0, -ext.length);
47
-
48
- const isIndexFile = basename === "index";
49
- // TODO: deprecate _middleware_ in favor of _middleware
50
- const isMiddlewareFile =
51
- basename === "_middleware" || basename === "_middleware_";
52
-
53
- let routePath = path
54
- .relative(baseDir, filepath)
55
- .slice(0, -ext.length);
56
-
57
- if (isIndexFile || isMiddlewareFile) {
58
- routePath = path.dirname(routePath);
59
- }
60
-
61
- if (routePath === ".") {
62
- routePath = "";
63
- }
64
-
65
- routePath = `${baseURL}/${routePath}`;
66
-
67
- routePath = routePath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
68
- routePath = routePath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
69
-
70
- // These are used as module specifiers so UrlPaths are okay to use even on Windows
71
- const modulePath = toUrlPath(path.relative(baseDir, filepath));
72
-
73
- const routeEntry: RouteConfig = {
74
- routePath: toUrlPath(routePath),
75
- method: method.toUpperCase() as HTTPMethod,
76
- [isMiddlewareFile ? "middleware" : "module"]: [
77
- `${modulePath}:${exportName}`,
78
- ],
79
- };
80
-
81
- routeEntries.push(routeEntry);
82
- }
83
- }
84
- }
85
- });
86
- // Combine together any routes (index routes) which contain both a module and a middleware
87
- routeEntries = routeEntries.reduce(
88
- (acc: typeof routeEntries, { routePath, ...rest }) => {
89
- const existingRouteEntry = acc.find(
90
- (routeEntry) =>
91
- routeEntry.routePath === routePath &&
92
- routeEntry.method === rest.method
93
- );
94
- if (existingRouteEntry !== undefined) {
95
- Object.assign(existingRouteEntry, rest);
96
- } else {
97
- acc.push({ routePath, ...rest });
98
- }
99
- return acc;
100
- },
101
- []
102
- );
103
-
104
- routeEntries.sort((a, b) => compareRoutes(a, b));
105
-
106
- return {
107
- routes: routeEntries,
108
- };
109
- }
110
-
111
- // Ensure routes are produced in order of precedence so that
112
- // more specific routes aren't occluded from matching due to
113
- // less specific routes appearing first in the route list.
114
- export function compareRoutes(
115
- { routePath: routePathA, method: methodA }: RouteConfig,
116
- { routePath: routePathB, method: methodB }: RouteConfig
117
- ) {
118
- function parseRoutePath(routePath: UrlPath): string[] {
119
- return routePath.slice(1).split("/").filter(Boolean);
120
- }
121
-
122
- const segmentsA = parseRoutePath(routePathA);
123
- const segmentsB = parseRoutePath(routePathB);
124
-
125
- // sort routes with fewer segments after those with more segments
126
- if (segmentsA.length !== segmentsB.length) {
127
- return segmentsB.length - segmentsA.length;
128
- }
129
-
130
- for (let i = 0; i < segmentsA.length; i++) {
131
- const isWildcardA = segmentsA[i].includes("*");
132
- const isWildcardB = segmentsB[i].includes("*");
133
- const isParamA = segmentsA[i].includes(":");
134
- const isParamB = segmentsB[i].includes(":");
135
-
136
- // sort wildcard segments after non-wildcard segments
137
- if (isWildcardA && !isWildcardB) return 1;
138
- if (!isWildcardA && isWildcardB) return -1;
139
-
140
- // sort dynamic param segments after non-param segments
141
- if (isParamA && !isParamB) return 1;
142
- if (!isParamA && isParamB) return -1;
143
- }
144
-
145
- // sort routes that specify an HTTP before those that don't
146
- if (methodA && !methodB) return -1;
147
- if (!methodA && methodB) return 1;
148
-
149
- // all else equal, just sort the paths lexicographically
150
- return routePathA.localeCompare(routePathB);
151
- }
152
-
153
- async function forEachFile<T>(
154
- baseDir: string,
155
- fn: (filepath: string) => T | Promise<T>
156
- ) {
157
- const searchPaths = [baseDir];
158
- const returnValues: T[] = [];
159
-
160
- while (isNotEmpty(searchPaths)) {
161
- const cwd = searchPaths.shift();
162
- const dir = await fs.readdir(cwd, { withFileTypes: true });
163
- for (const entry of dir) {
164
- const pathname = path.join(cwd, entry.name);
165
- if (entry.isDirectory()) {
166
- searchPaths.push(pathname);
167
- } else if (entry.isFile()) {
168
- returnValues.push(await fn(pathname));
169
- }
170
- }
171
- }
172
-
173
- return returnValues;
174
- }
175
-
176
- interface NonEmptyArray<T> extends Array<T> {
177
- shift(): T;
178
- }
179
- function isNotEmpty<T>(array: T[]): array is NonEmptyArray<T> {
180
- return array.length > 0;
181
- }
@@ -1,78 +0,0 @@
1
- export const RESERVED_KEYWORDS = [
2
- "do",
3
- "if",
4
- "in",
5
- "for",
6
- "let",
7
- "new",
8
- "try",
9
- "var",
10
- "case",
11
- "else",
12
- "enum",
13
- "eval",
14
- "null",
15
- "this",
16
- "true",
17
- "void",
18
- "with",
19
- "await",
20
- "break",
21
- "catch",
22
- "class",
23
- "const",
24
- "false",
25
- "super",
26
- "throw",
27
- "while",
28
- "yield",
29
- "delete",
30
- "export",
31
- "import",
32
- "public",
33
- "return",
34
- "static",
35
- "switch",
36
- "typeof",
37
- "default",
38
- "extends",
39
- "finally",
40
- "package",
41
- "private",
42
- "continue",
43
- "debugger",
44
- "function",
45
- "arguments",
46
- "interface",
47
- "protected",
48
- "implements",
49
- "instanceof",
50
- "NaN",
51
- "Infinity",
52
- "undefined",
53
- ];
54
-
55
- export const reservedKeywordRegex = new RegExp(
56
- `^${RESERVED_KEYWORDS.join("|")}$`
57
- );
58
-
59
- export const identifierStartRegex = /[$_\p{ID_Start}]/u;
60
-
61
- export const identifierPartRegex = /[$_\u200C\u200D\p{ID_Continue}]/u;
62
-
63
- export const identifierNameRegex =
64
- /^(?:[$_\p{ID_Start}])(?:[$_\u200C\u200D\p{ID_Continue}])*$/u;
65
-
66
- export const validIdentifierRegex = new RegExp(
67
- `(?!(${reservedKeywordRegex.source})$)${identifierNameRegex.source}`,
68
- "u"
69
- );
70
-
71
- export const isValidIdentifier = (identifier: string) =>
72
- validIdentifierRegex.test(identifier);
73
-
74
- export const normalizeIdentifier = (identifier: string) =>
75
- identifier.replace(
76
- /(?:^[^$_\p{ID_Start}])|[^$_\u200C\u200D\p{ID_Continue}]/gu,
77
- "_"
78
- );
@@ -1,151 +0,0 @@
1
- import fs from "node:fs/promises";
2
- import path from "node:path";
3
- import { isValidIdentifier, normalizeIdentifier } from "./identifiers";
4
- import type { UrlPath } from "../../src/paths";
5
-
6
- export const HTTP_METHODS = [
7
- "HEAD",
8
- "OPTIONS",
9
- "GET",
10
- "POST",
11
- "PUT",
12
- "PATCH",
13
- "DELETE",
14
- ] as const;
15
- export type HTTPMethod = typeof HTTP_METHODS[number];
16
- export function isHTTPMethod(
17
- maybeHTTPMethod: string
18
- ): maybeHTTPMethod is HTTPMethod {
19
- return (HTTP_METHODS as readonly string[]).includes(maybeHTTPMethod);
20
- }
21
-
22
- export type RoutesCollection = Array<{
23
- routePath: UrlPath;
24
- method?: HTTPMethod;
25
- modules: string[];
26
- middlewares: string[];
27
- }>;
28
-
29
- export type Config = {
30
- routes?: RouteConfig[];
31
- schedules?: unknown;
32
- };
33
-
34
- export type RouteConfig = {
35
- routePath: UrlPath;
36
- method?: HTTPMethod;
37
- middleware?: string | string[];
38
- module?: string | string[];
39
- };
40
-
41
- type ImportMap = Map<
42
- string,
43
- {
44
- filepath: string;
45
- name: string;
46
- identifier: string;
47
- }
48
- >;
49
-
50
- type Arguments = {
51
- config: Config;
52
- outfile: string;
53
- srcDir: string;
54
- };
55
-
56
- export async function writeRoutesModule({
57
- config,
58
- srcDir,
59
- outfile = "_routes.js",
60
- }: Arguments) {
61
- const { importMap, routes } = parseConfig(config, srcDir);
62
- const routesModule = generateRoutesModule(importMap, routes);
63
-
64
- await fs.writeFile(outfile, routesModule);
65
-
66
- return outfile;
67
- }
68
-
69
- export function parseConfig(config: Config, baseDir: string) {
70
- const routes: RoutesCollection = [];
71
- const importMap: ImportMap = new Map();
72
- const identifierCount = new Map<string, number>(); // to keep track of identifier collisions
73
-
74
- function parseModuleIdentifiers(paths: string | string[] | undefined) {
75
- if (typeof paths === "undefined") {
76
- paths = [];
77
- }
78
-
79
- if (typeof paths === "string") {
80
- paths = [paths];
81
- }
82
-
83
- return paths.map((modulePath) => {
84
- const [filepath, name = "default"] = modulePath.split(":");
85
- let { identifier } = importMap.get(modulePath) ?? {};
86
-
87
- const resolvedPath = path.resolve(baseDir, filepath);
88
-
89
- // ensure the filepath isn't attempting to resolve to anything outside of the project
90
- if (path.relative(baseDir, resolvedPath).startsWith("..")) {
91
- throw new Error(`Invalid module path "${filepath}"`);
92
- }
93
-
94
- // ensure the module name (if provided) is a valid identifier to guard against injection attacks
95
- if (name !== "default" && !isValidIdentifier(name)) {
96
- throw new Error(`Invalid module identifier "${name}"`);
97
- }
98
-
99
- if (!identifier) {
100
- identifier = normalizeIdentifier(`__${filepath}_${name}`);
101
-
102
- let count = identifierCount.get(identifier) ?? 0;
103
- identifierCount.set(identifier, ++count);
104
-
105
- if (count > 1) {
106
- identifier += `_${count}`;
107
- }
108
-
109
- importMap.set(modulePath, { filepath: resolvedPath, name, identifier });
110
- }
111
-
112
- return identifier;
113
- });
114
- }
115
-
116
- for (const { routePath, method, ...props } of config.routes ?? []) {
117
- routes.push({
118
- routePath,
119
- method,
120
- middlewares: parseModuleIdentifiers(props.middleware),
121
- modules: parseModuleIdentifiers(props.module),
122
- });
123
- }
124
-
125
- return { routes, importMap };
126
- }
127
-
128
- export function generateRoutesModule(
129
- importMap: ImportMap,
130
- routes: RoutesCollection
131
- ) {
132
- return `${[...importMap.values()]
133
- .map(
134
- ({ filepath, name, identifier }) =>
135
- `import { ${name} as ${identifier} } from ${JSON.stringify(filepath)}`
136
- )
137
- .join("\n")}
138
-
139
- export const routes = [
140
- ${routes
141
- .map(
142
- (route) => ` {
143
- routePath: "${route.routePath}",
144
- method: "${route.method}",
145
- middlewares: [${route.middlewares.join(", ")}],
146
- modules: [${route.modules.join(", ")}],
147
- },`
148
- )
149
- .join("\n")}
150
- ]`;
151
- }