wrangler 0.0.0-fb43821 → 0.0.0-fbfc24d7

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 (221) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +51 -14
  3. package/bin/wrangler.js +160 -28
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +5542 -0
  6. package/package.json +172 -113
  7. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  8. package/src/__tests__/config-cache.test.ts +42 -0
  9. package/src/__tests__/configuration.test.ts +4026 -0
  10. package/src/__tests__/dev.test.tsx +1316 -0
  11. package/src/__tests__/generate.test.ts +91 -0
  12. package/src/__tests__/guess-worker-format.test.ts +85 -0
  13. package/src/__tests__/{clipboardy-mock.js → helpers/clipboardy-mock.js} +0 -0
  14. package/src/__tests__/helpers/cmd-shim.d.ts +11 -0
  15. package/src/__tests__/helpers/mock-account-id.ts +48 -0
  16. package/src/__tests__/helpers/mock-bin.ts +36 -0
  17. package/src/__tests__/helpers/mock-cfetch.ts +296 -0
  18. package/src/__tests__/helpers/mock-console.ts +97 -0
  19. package/src/__tests__/helpers/mock-dialogs.ts +153 -0
  20. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  21. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  22. package/src/__tests__/helpers/mock-istty.ts +74 -0
  23. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  24. package/src/__tests__/helpers/mock-kv.ts +33 -0
  25. package/src/__tests__/helpers/mock-oauth-flow.ts +250 -0
  26. package/src/__tests__/helpers/mock-process.ts +39 -0
  27. package/src/__tests__/helpers/mock-stdin.ts +108 -0
  28. package/src/__tests__/helpers/mock-web-socket.ts +29 -0
  29. package/src/__tests__/helpers/run-in-tmp.ts +38 -0
  30. package/src/__tests__/helpers/run-wrangler.ts +16 -0
  31. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  32. package/src/__tests__/helpers/write-wrangler-toml.ts +17 -0
  33. package/src/__tests__/https-options.test.ts +163 -0
  34. package/src/__tests__/index.test.ts +242 -419
  35. package/src/__tests__/init.test.ts +2170 -0
  36. package/src/__tests__/jest.setup.ts +157 -0
  37. package/src/__tests__/kv.test.ts +1671 -0
  38. package/src/__tests__/logger.test.ts +141 -0
  39. package/src/__tests__/metrics.test.ts +450 -0
  40. package/src/__tests__/package-manager.test.ts +353 -0
  41. package/src/__tests__/pages.test.ts +1275 -0
  42. package/src/__tests__/parse.test.ts +330 -0
  43. package/src/__tests__/publish.test.ts +6903 -0
  44. package/src/__tests__/pubsub.test.ts +367 -0
  45. package/src/__tests__/r2.test.ts +336 -0
  46. package/src/__tests__/route.test.ts +45 -0
  47. package/src/__tests__/secret.test.ts +492 -0
  48. package/src/__tests__/tail.test.ts +802 -0
  49. package/src/__tests__/test-old-node-version.js +31 -0
  50. package/src/__tests__/user.test.ts +155 -0
  51. package/src/__tests__/validate-dev-props.test.ts +56 -0
  52. package/src/__tests__/version.test.ts +35 -0
  53. package/src/__tests__/whoami.test.tsx +289 -0
  54. package/src/__tests__/worker-namespace.test.ts +329 -0
  55. package/src/abort.d.ts +3 -0
  56. package/src/api/dev.ts +93 -0
  57. package/src/api/index.ts +1 -0
  58. package/src/bundle-reporter.tsx +29 -0
  59. package/src/bundle.ts +473 -0
  60. package/src/cfetch/index.ts +121 -0
  61. package/src/cfetch/internal.ts +237 -0
  62. package/src/cli.ts +25 -8
  63. package/src/config/README.md +107 -0
  64. package/src/config/config.ts +263 -0
  65. package/src/config/diagnostics.ts +80 -0
  66. package/src/config/environment.ts +485 -0
  67. package/src/config/index.ts +251 -0
  68. package/src/config/validation-helpers.ts +597 -0
  69. package/src/config/validation.ts +1862 -0
  70. package/src/config-cache.ts +85 -0
  71. package/src/create-worker-preview.ts +257 -0
  72. package/src/create-worker-upload-form.ts +288 -0
  73. package/src/dev/dev-vars.ts +36 -0
  74. package/src/dev/dev.tsx +545 -0
  75. package/src/dev/local.tsx +449 -0
  76. package/src/dev/remote.tsx +421 -0
  77. package/src/dev/use-esbuild.ts +178 -0
  78. package/src/dev/validate-dev-props.ts +31 -0
  79. package/src/dev-registry.tsx +160 -0
  80. package/src/dev.tsx +612 -764
  81. package/src/dialogs.tsx +117 -59
  82. package/src/dispatch-namespace.ts +206 -0
  83. package/src/durable.ts +102 -0
  84. package/src/entry.ts +328 -0
  85. package/src/environment-variables.ts +35 -0
  86. package/src/errors.ts +11 -0
  87. package/src/faye-websocket.d.ts +6 -0
  88. package/src/generate.ts +131 -0
  89. package/src/git-client.ts +42 -0
  90. package/src/global-wrangler-config-path.ts +26 -0
  91. package/src/https-options.ts +127 -0
  92. package/src/index.tsx +2213 -1857
  93. package/src/init.ts +622 -0
  94. package/src/inspect.ts +747 -0
  95. package/src/intl-polyfill.d.ts +139 -0
  96. package/src/is-ci.ts +14 -0
  97. package/src/is-interactive.ts +12 -0
  98. package/src/kv.ts +430 -0
  99. package/src/logger.ts +73 -0
  100. package/src/metrics/index.ts +5 -0
  101. package/src/metrics/metrics-config.ts +239 -0
  102. package/src/metrics/metrics-dispatcher.ts +96 -0
  103. package/src/metrics/metrics-usage-headers.ts +24 -0
  104. package/src/metrics/send-event.ts +92 -0
  105. package/src/miniflare-cli/README.md +30 -0
  106. package/src/miniflare-cli/assets.ts +554 -0
  107. package/src/miniflare-cli/enum-keys.ts +17 -0
  108. package/src/miniflare-cli/index.ts +207 -0
  109. package/src/miniflare-cli/request-context.ts +40 -0
  110. package/src/module-collection.ts +247 -53
  111. package/src/open-in-browser.ts +17 -0
  112. package/src/package-manager.ts +219 -0
  113. package/src/pages/build.tsx +238 -0
  114. package/src/pages/constants.ts +12 -0
  115. package/src/pages/deployments.tsx +106 -0
  116. package/src/pages/dev.tsx +528 -0
  117. package/src/pages/errors.ts +22 -0
  118. package/src/pages/functions/buildPlugin.ts +109 -0
  119. package/src/pages/functions/buildWorker.ts +155 -0
  120. package/src/pages/functions/filepath-routing.test.ts +234 -0
  121. package/src/pages/functions/filepath-routing.ts +189 -0
  122. package/src/pages/functions/identifiers.ts +78 -0
  123. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  124. package/src/pages/functions/routes-consolidation.ts +73 -0
  125. package/src/pages/functions/routes-transformation.test.ts +271 -0
  126. package/src/pages/functions/routes-transformation.ts +122 -0
  127. package/src/pages/functions/routes.ts +151 -0
  128. package/src/pages/functions.tsx +96 -0
  129. package/src/pages/index.tsx +94 -0
  130. package/src/pages/projects.tsx +169 -0
  131. package/src/pages/publish.tsx +391 -0
  132. package/src/pages/types.ts +49 -0
  133. package/src/pages/upload.tsx +413 -0
  134. package/src/pages/utils.ts +12 -0
  135. package/src/parse.ts +286 -0
  136. package/src/paths.ts +26 -0
  137. package/src/preview.ts +31 -0
  138. package/src/proxy.ts +486 -0
  139. package/src/publish.ts +796 -335
  140. package/src/pubsub/index.ts +286 -0
  141. package/src/pubsub/pubsub-commands.tsx +623 -0
  142. package/src/r2.ts +131 -0
  143. package/src/selfsigned.d.ts +29 -0
  144. package/src/sites.tsx +357 -100
  145. package/src/tail/filters.ts +281 -0
  146. package/src/tail/index.ts +312 -0
  147. package/src/tail/printing.ts +107 -0
  148. package/src/update-check.ts +19 -0
  149. package/src/user/choose-account.tsx +69 -0
  150. package/src/user/env-vars.ts +46 -0
  151. package/src/user/generate-auth-url.ts +33 -0
  152. package/src/user/generate-random-state.ts +16 -0
  153. package/src/user/index.ts +3 -0
  154. package/src/user/user.tsx +1191 -0
  155. package/src/whoami.tsx +169 -0
  156. package/src/worker.ts +203 -0
  157. package/src/zones.ts +167 -0
  158. package/templates/checked-fetch.js +17 -0
  159. package/templates/first-party-worker-module-facade.ts +18 -0
  160. package/templates/format-dev-errors.ts +32 -0
  161. package/templates/gitignore +171 -0
  162. package/templates/new-worker-scheduled.js +17 -0
  163. package/templates/new-worker-scheduled.ts +32 -0
  164. package/templates/new-worker.js +15 -0
  165. package/templates/new-worker.ts +30 -0
  166. package/templates/no-op-worker.js +10 -0
  167. package/templates/pages-shim.ts +9 -0
  168. package/templates/pages-template-plugin.ts +167 -0
  169. package/templates/pages-template-worker.ts +172 -0
  170. package/templates/serve-static-assets.ts +63 -0
  171. package/templates/service-bindings-module-facade.js +54 -0
  172. package/templates/service-bindings-sw-facade.js +42 -0
  173. package/templates/tsconfig.json +105 -0
  174. package/wrangler-dist/cli.d.ts +338 -0
  175. package/wrangler-dist/cli.js +127880 -101761
  176. package/src/__tests__/mock-cfetch.js +0 -42
  177. package/src/api/form_data.ts +0 -141
  178. package/src/api/inspect.ts +0 -430
  179. package/src/api/preview.ts +0 -128
  180. package/src/api/worker.ts +0 -161
  181. package/src/cfetch.ts +0 -72
  182. package/src/config.ts +0 -122
  183. package/src/kv.tsx +0 -211
  184. package/src/pages.tsx +0 -818
  185. package/src/tail.tsx +0 -71
  186. package/src/user.tsx +0 -1029
  187. package/static-asset-facade.js +0 -47
  188. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  189. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  190. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  191. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  192. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  193. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  194. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  195. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  196. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  197. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  198. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  199. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  200. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  201. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  202. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  203. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  204. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  205. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  206. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  207. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  208. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  209. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  210. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  211. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  212. package/vendor/wrangler-mime/LICENSE +0 -21
  213. package/vendor/wrangler-mime/Mime.js +0 -97
  214. package/vendor/wrangler-mime/README.md +0 -187
  215. package/vendor/wrangler-mime/cli.js +0 -46
  216. package/vendor/wrangler-mime/index.js +0 -4
  217. package/vendor/wrangler-mime/lite.js +0 -4
  218. package/vendor/wrangler-mime/package.json +0 -52
  219. package/vendor/wrangler-mime/types/other.js +0 -1
  220. package/vendor/wrangler-mime/types/standard.js +0 -1
  221. package/wrangler-dist/cli.js.map +0 -7
@@ -0,0 +1,155 @@
1
+ import { access, cp, lstat, rm } from "node:fs/promises";
2
+ import { join, resolve } from "node:path";
3
+ import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
4
+ import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
5
+ import { build } from "esbuild";
6
+ import { nanoid } from "nanoid";
7
+
8
+ type Options = {
9
+ routesModule: string;
10
+ outfile: string;
11
+ minify?: boolean;
12
+ sourcemap?: boolean;
13
+ fallbackService?: string;
14
+ watch?: boolean;
15
+ onEnd?: () => void;
16
+ buildOutputDirectory?: string;
17
+ nodeCompat?: boolean;
18
+ };
19
+
20
+ export function buildWorker({
21
+ routesModule,
22
+ outfile = "bundle.js",
23
+ minify = false,
24
+ sourcemap = false,
25
+ fallbackService = "ASSETS",
26
+ watch = false,
27
+ onEnd = () => {},
28
+ buildOutputDirectory,
29
+ nodeCompat,
30
+ }: Options) {
31
+ return build({
32
+ entryPoints: [resolve(__dirname, "../templates/pages-template-worker.ts")],
33
+ inject: [routesModule],
34
+ bundle: true,
35
+ format: "esm",
36
+ target: "esnext",
37
+ loader: {
38
+ ".html": "text",
39
+ ".txt": "text",
40
+ },
41
+ outfile,
42
+ minify,
43
+ sourcemap,
44
+ watch,
45
+ allowOverwrite: true,
46
+ define: {
47
+ __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
48
+ ...(nodeCompat ? { global: "globalThis" } : {}),
49
+ },
50
+ plugins: [
51
+ {
52
+ name: "wrangler notifier and monitor",
53
+ setup(pluginBuild) {
54
+ pluginBuild.onEnd((result) => {
55
+ if (result.errors.length > 0) {
56
+ console.error(
57
+ `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
58
+ );
59
+ } else if (result.warnings.length > 0) {
60
+ console.warn(
61
+ `${result.warnings.length} warning(s) when compiling Worker.`
62
+ );
63
+ onEnd();
64
+ } else {
65
+ console.log("Compiled Worker successfully.");
66
+ onEnd();
67
+ }
68
+ });
69
+ },
70
+ },
71
+ {
72
+ name: "Assets",
73
+ setup(pluginBuild) {
74
+ const identifiers = new Map<string, string>();
75
+
76
+ pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
77
+ const directory = resolve(
78
+ args.resolveDir,
79
+ args.path.slice("assets:".length)
80
+ );
81
+
82
+ const exists = await access(directory)
83
+ .then(() => true)
84
+ .catch(() => false);
85
+
86
+ const isDirectory =
87
+ exists && (await lstat(directory)).isDirectory();
88
+
89
+ if (!isDirectory) {
90
+ return {
91
+ errors: [
92
+ {
93
+ text: `'${directory}' does not exist or is not a directory.`,
94
+ },
95
+ ],
96
+ };
97
+ }
98
+
99
+ // TODO: Consider hashing the contents rather than using a unique identifier every time?
100
+ identifiers.set(directory, nanoid());
101
+ if (!buildOutputDirectory) {
102
+ console.warn(
103
+ "You're attempting to import static assets as part of your Pages Functions, but have not specified a directory in which to put them. You must use 'wrangler pages dev <directory>' rather than 'wrangler pages dev -- <command>' to import static assets in Functions."
104
+ );
105
+ }
106
+ return { path: directory, namespace: "assets" };
107
+ });
108
+
109
+ pluginBuild.onLoad(
110
+ { filter: /.*/, namespace: "assets" },
111
+ async (args) => {
112
+ const identifier = identifiers.get(args.path);
113
+
114
+ if (buildOutputDirectory) {
115
+ const staticAssetsOutputDirectory = join(
116
+ buildOutputDirectory,
117
+ "cdn-cgi",
118
+ "pages-plugins",
119
+ identifier as string
120
+ );
121
+ await rm(staticAssetsOutputDirectory, {
122
+ force: true,
123
+ recursive: true,
124
+ });
125
+ await cp(args.path, staticAssetsOutputDirectory, {
126
+ force: true,
127
+ recursive: true,
128
+ });
129
+
130
+ return {
131
+ // TODO: Watch args.path for changes and re-copy when updated
132
+ contents: `export const onRequest = ({ request, env, functionPath }) => {
133
+ const url = new URL(request.url)
134
+ const relativePathname = \`/\${url.pathname.split(functionPath)[1] || ''}\`.replace(/^\\/\\//, '/');
135
+ url.pathname = '/cdn-cgi/pages-plugins/${identifier}' + relativePathname
136
+ request = new Request(url.toString(), request)
137
+ return env.ASSETS.fetch(request)
138
+ }`,
139
+ };
140
+ }
141
+ }
142
+ );
143
+ },
144
+ },
145
+ ...(nodeCompat
146
+ ? [
147
+ NodeGlobalsPolyfills({
148
+ buffer: true,
149
+ }),
150
+ NodeModulesPolyfills(),
151
+ ]
152
+ : []),
153
+ ],
154
+ });
155
+ }
@@ -0,0 +1,234 @@
1
+ import { writeFileSync, mkdirSync } from "fs";
2
+ import { runInTempDir } from "../../__tests__/helpers/run-in-tmp";
3
+ import { toUrlPath } from "../../paths";
4
+ import { compareRoutes, generateConfigFromFileTree } from "./filepath-routing";
5
+ import type { UrlPath } from "../../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
+ "mountPath": "/base/authors/:authorId/todos",
147
+ "routePath": "/base/authors/:authorId/todos/:todoId",
148
+ },
149
+ Object {
150
+ "method": "POST",
151
+ "module": Array [
152
+ "cats/[[breed]]/blah.ts:onRequestPost",
153
+ ],
154
+ "mountPath": "/base/cats/:breed*",
155
+ "routePath": "/base/cats/:breed*/blah",
156
+ },
157
+ Object {
158
+ "method": "POST",
159
+ "module": Array [
160
+ "cats/[[breed]]/[[name]].ts:onRequestPost",
161
+ ],
162
+ "mountPath": "/base/cats/:breed*",
163
+ "routePath": "/base/cats/:breed*/:name*",
164
+ },
165
+ Object {
166
+ "method": "DELETE",
167
+ "module": Array [
168
+ "todos/[id].ts:onRequestDelete",
169
+ ],
170
+ "mountPath": "/base/todos",
171
+ "routePath": "/base/todos/:id",
172
+ },
173
+ Object {
174
+ "method": "POST",
175
+ "module": Array [
176
+ "todos/[id].ts:onRequestPost",
177
+ ],
178
+ "mountPath": "/base/todos",
179
+ "routePath": "/base/todos/:id",
180
+ },
181
+ Object {
182
+ "method": "POST",
183
+ "module": Array [
184
+ "books/[[title]].ts:onRequestPost",
185
+ ],
186
+ "mountPath": "/base/books",
187
+ "routePath": "/base/books/:title*",
188
+ },
189
+ Object {
190
+ "method": "DELETE",
191
+ "module": Array [
192
+ "bar.ts:onRequestDelete",
193
+ ],
194
+ "mountPath": "/base/",
195
+ "routePath": "/base/bar",
196
+ },
197
+ Object {
198
+ "method": "PUT",
199
+ "module": Array [
200
+ "bar.ts:onRequestPut",
201
+ ],
202
+ "mountPath": "/base/",
203
+ "routePath": "/base/bar",
204
+ },
205
+ Object {
206
+ "method": "GET",
207
+ "module": Array [
208
+ "foo.ts:onRequestGet",
209
+ ],
210
+ "mountPath": "/base/",
211
+ "routePath": "/base/foo",
212
+ },
213
+ Object {
214
+ "method": "POST",
215
+ "module": Array [
216
+ "foo.ts:onRequestPost",
217
+ ],
218
+ "mountPath": "/base/",
219
+ "routePath": "/base/foo",
220
+ },
221
+ ],
222
+ }
223
+ `);
224
+ });
225
+ });
226
+ });
227
+
228
+ function routeConfig(routePath: string, method?: string): RouteConfig {
229
+ return {
230
+ routePath: toUrlPath(routePath),
231
+ mountPath: toUrlPath("/"),
232
+ method: method as HTTPMethod,
233
+ };
234
+ }
@@ -0,0 +1,189 @@
1
+ import fs from "node:fs/promises";
2
+ import path from "node:path";
3
+ import { build } from "esbuild";
4
+ import { toUrlPath } from "../../paths";
5
+ import type { UrlPath } from "../../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
+ let mountPath = path.dirname(routePath);
57
+
58
+ if (isIndexFile || isMiddlewareFile) {
59
+ routePath = path.dirname(routePath);
60
+ }
61
+
62
+ if (routePath === ".") {
63
+ routePath = "";
64
+ }
65
+ if (mountPath === ".") {
66
+ mountPath = "";
67
+ }
68
+
69
+ routePath = `${baseURL}/${routePath}`;
70
+ mountPath = `${baseURL}/${mountPath}`;
71
+
72
+ routePath = routePath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
73
+ routePath = routePath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
74
+ mountPath = mountPath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
75
+ mountPath = mountPath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
76
+
77
+ // These are used as module specifiers so UrlPaths are okay to use even on Windows
78
+ const modulePath = toUrlPath(path.relative(baseDir, filepath));
79
+
80
+ const routeEntry: RouteConfig = {
81
+ routePath: toUrlPath(routePath),
82
+ mountPath: toUrlPath(mountPath),
83
+ method: method.toUpperCase() as HTTPMethod,
84
+ [isMiddlewareFile ? "middleware" : "module"]: [
85
+ `${modulePath}:${exportName}`,
86
+ ],
87
+ };
88
+
89
+ routeEntries.push(routeEntry);
90
+ }
91
+ }
92
+ }
93
+ });
94
+ // Combine together any routes (index routes) which contain both a module and a middleware
95
+ routeEntries = routeEntries.reduce(
96
+ (acc: typeof routeEntries, { routePath, ...rest }) => {
97
+ const existingRouteEntry = acc.find(
98
+ (routeEntry) =>
99
+ routeEntry.routePath === routePath &&
100
+ routeEntry.method === rest.method
101
+ );
102
+ if (existingRouteEntry !== undefined) {
103
+ Object.assign(existingRouteEntry, rest);
104
+ } else {
105
+ acc.push({ routePath, ...rest });
106
+ }
107
+ return acc;
108
+ },
109
+ []
110
+ );
111
+
112
+ routeEntries.sort((a, b) => compareRoutes(a, b));
113
+
114
+ return {
115
+ routes: routeEntries,
116
+ };
117
+ }
118
+
119
+ // Ensure routes are produced in order of precedence so that
120
+ // more specific routes aren't occluded from matching due to
121
+ // less specific routes appearing first in the route list.
122
+ export function compareRoutes(
123
+ { routePath: routePathA, method: methodA }: RouteConfig,
124
+ { routePath: routePathB, method: methodB }: RouteConfig
125
+ ) {
126
+ function parseRoutePath(routePath: UrlPath): string[] {
127
+ return routePath.slice(1).split("/").filter(Boolean);
128
+ }
129
+
130
+ const segmentsA = parseRoutePath(routePathA);
131
+ const segmentsB = parseRoutePath(routePathB);
132
+
133
+ // sort routes with fewer segments after those with more segments
134
+ if (segmentsA.length !== segmentsB.length) {
135
+ return segmentsB.length - segmentsA.length;
136
+ }
137
+
138
+ for (let i = 0; i < segmentsA.length; i++) {
139
+ const isWildcardA = segmentsA[i].includes("*");
140
+ const isWildcardB = segmentsB[i].includes("*");
141
+ const isParamA = segmentsA[i].includes(":");
142
+ const isParamB = segmentsB[i].includes(":");
143
+
144
+ // sort wildcard segments after non-wildcard segments
145
+ if (isWildcardA && !isWildcardB) return 1;
146
+ if (!isWildcardA && isWildcardB) return -1;
147
+
148
+ // sort dynamic param segments after non-param segments
149
+ if (isParamA && !isParamB) return 1;
150
+ if (!isParamA && isParamB) return -1;
151
+ }
152
+
153
+ // sort routes that specify an HTTP before those that don't
154
+ if (methodA && !methodB) return -1;
155
+ if (!methodA && methodB) return 1;
156
+
157
+ // all else equal, just sort the paths lexicographically
158
+ return routePathA.localeCompare(routePathB);
159
+ }
160
+
161
+ async function forEachFile<T>(
162
+ baseDir: string,
163
+ fn: (filepath: string) => T | Promise<T>
164
+ ) {
165
+ const searchPaths = [baseDir];
166
+ const returnValues: T[] = [];
167
+
168
+ while (isNotEmpty(searchPaths)) {
169
+ const cwd = searchPaths.shift();
170
+ const dir = await fs.readdir(cwd, { withFileTypes: true });
171
+ for (const entry of dir) {
172
+ const pathname = path.join(cwd, entry.name);
173
+ if (entry.isDirectory()) {
174
+ searchPaths.push(pathname);
175
+ } else if (entry.isFile()) {
176
+ returnValues.push(await fn(pathname));
177
+ }
178
+ }
179
+ }
180
+
181
+ return returnValues;
182
+ }
183
+
184
+ interface NonEmptyArray<T> extends Array<T> {
185
+ shift(): T;
186
+ }
187
+ function isNotEmpty<T>(array: T[]): array is NonEmptyArray<T> {
188
+ return array.length > 0;
189
+ }
@@ -0,0 +1,78 @@
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
+ );