wrangler 0.0.0-e492c10 → 0.0.0-e4aff81a

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 (178) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +30 -12
  3. package/bin/wrangler.js +118 -39
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +132 -71
  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 +17 -0
  11. package/templates/gitignore +1 -0
  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 +137 -0
  17. package/templates/middleware/loader-sw.ts +228 -0
  18. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +33 -0
  20. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  21. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  22. package/templates/middleware/middleware-pretty-error.ts +40 -0
  23. package/templates/middleware/middleware-scheduled.ts +15 -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 +22 -4
  31. package/templates/no-op-worker.js +10 -0
  32. package/templates/pages-dev-pipeline.ts +31 -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/tsconfig-sanity.ts +11 -0
  38. package/templates/tsconfig.init.json +105 -0
  39. package/templates/tsconfig.json +6 -103
  40. package/wrangler-dist/cli.d.ts +1739 -0
  41. package/wrangler-dist/cli.js +139641 -101308
  42. package/wrangler-dist/wasm-sync.wasm +0 -0
  43. package/import_meta_url.js +0 -3
  44. package/miniflare-config-stubs/.env.empty +0 -0
  45. package/miniflare-config-stubs/package.empty.json +0 -1
  46. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  47. package/miniflare-dist/index.mjs +0 -4886
  48. package/pages/functions/buildPlugin.ts +0 -92
  49. package/pages/functions/buildWorker.ts +0 -138
  50. package/pages/functions/filepath-routing.test.ts +0 -234
  51. package/pages/functions/filepath-routing.ts +0 -189
  52. package/pages/functions/identifiers.ts +0 -78
  53. package/pages/functions/routes.ts +0 -156
  54. package/pages/functions/template-plugin.ts +0 -146
  55. package/pages/functions/template-worker.ts +0 -143
  56. package/src/__tests__/config-cache.test.ts +0 -36
  57. package/src/__tests__/configuration.test.ts +0 -3125
  58. package/src/__tests__/dev.test.tsx +0 -827
  59. package/src/__tests__/guess-worker-format.test.ts +0 -85
  60. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  61. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  62. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  66. package/src/__tests__/helpers/mock-console.ts +0 -87
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -90
  68. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  69. package/src/__tests__/helpers/mock-istty.ts +0 -27
  70. package/src/__tests__/helpers/mock-kv.ts +0 -33
  71. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -255
  72. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  73. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  74. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  75. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  76. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  77. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  78. package/src/__tests__/https-options.test.ts +0 -130
  79. package/src/__tests__/index.test.ts +0 -242
  80. package/src/__tests__/init.test.ts +0 -1516
  81. package/src/__tests__/jest.setup.ts +0 -77
  82. package/src/__tests__/kv.test.ts +0 -1442
  83. package/src/__tests__/logger.test.ts +0 -115
  84. package/src/__tests__/package-manager.test.ts +0 -206
  85. package/src/__tests__/pages.test.ts +0 -327
  86. package/src/__tests__/parse.test.ts +0 -326
  87. package/src/__tests__/publish.test.ts +0 -4948
  88. package/src/__tests__/r2.test.ts +0 -210
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -446
  91. package/src/__tests__/tail.test.ts +0 -690
  92. package/src/__tests__/user.test.ts +0 -131
  93. package/src/__tests__/whoami.test.tsx +0 -105
  94. package/src/bundle.ts +0 -169
  95. package/src/cfetch/index.ts +0 -104
  96. package/src/cfetch/internal.ts +0 -137
  97. package/src/cli.ts +0 -13
  98. package/src/config/README.md +0 -107
  99. package/src/config/config.ts +0 -234
  100. package/src/config/diagnostics.ts +0 -80
  101. package/src/config/environment.ts +0 -394
  102. package/src/config/index.ts +0 -63
  103. package/src/config/validation-helpers.ts +0 -575
  104. package/src/config/validation.ts +0 -1424
  105. package/src/config-cache.ts +0 -45
  106. package/src/create-worker-preview.ts +0 -175
  107. package/src/create-worker-upload-form.ts +0 -240
  108. package/src/dev/dev-vars.ts +0 -36
  109. package/src/dev/dev.tsx +0 -418
  110. package/src/dev/local.tsx +0 -312
  111. package/src/dev/remote.tsx +0 -213
  112. package/src/dev/use-esbuild.ts +0 -118
  113. package/src/dialogs.tsx +0 -87
  114. package/src/entry.ts +0 -267
  115. package/src/environment-variables.ts +0 -35
  116. package/src/errors.ts +0 -11
  117. package/src/https-options.ts +0 -123
  118. package/src/index.tsx +0 -2698
  119. package/src/inspect.ts +0 -623
  120. package/src/intl-polyfill.d.ts +0 -139
  121. package/src/kv.ts +0 -319
  122. package/src/logger.ts +0 -66
  123. package/src/miniflare-cli/README.md +0 -30
  124. package/src/miniflare-cli/enum-keys.ts +0 -17
  125. package/src/miniflare-cli/index.ts +0 -41
  126. package/src/miniflare-cli/request-context.ts +0 -40
  127. package/src/module-collection.ts +0 -258
  128. package/src/open-in-browser.ts +0 -26
  129. package/src/package-manager.ts +0 -127
  130. package/src/pages.tsx +0 -1875
  131. package/src/parse.ts +0 -185
  132. package/src/paths.ts +0 -26
  133. package/src/proxy.ts +0 -449
  134. package/src/publish.ts +0 -469
  135. package/src/r2.ts +0 -50
  136. package/src/selfsigned.d.ts +0 -29
  137. package/src/sites.tsx +0 -293
  138. package/src/tail/filters.ts +0 -279
  139. package/src/tail/index.ts +0 -299
  140. package/src/tail/printing.ts +0 -67
  141. package/src/update-check.ts +0 -19
  142. package/src/user.tsx +0 -1203
  143. package/src/whoami.tsx +0 -70
  144. package/src/worker.ts +0 -172
  145. package/templates/static-asset-facade.js +0 -47
  146. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  147. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  148. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  149. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  150. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  151. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  152. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  153. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  154. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  155. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  156. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  157. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  158. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  159. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  160. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  161. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  162. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  163. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  164. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  165. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  166. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  167. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  168. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  169. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  170. package/vendor/wrangler-mime/LICENSE +0 -21
  171. package/vendor/wrangler-mime/Mime.js +0 -97
  172. package/vendor/wrangler-mime/README.md +0 -187
  173. package/vendor/wrangler-mime/cli.js +0 -46
  174. package/vendor/wrangler-mime/index.js +0 -4
  175. package/vendor/wrangler-mime/lite.js +0 -4
  176. package/vendor/wrangler-mime/package.json +0 -52
  177. package/vendor/wrangler-mime/types/other.js +0 -1
  178. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,92 +0,0 @@
1
- import { access, lstat } from "node:fs/promises";
2
- import { dirname, relative, resolve } from "node:path";
3
- import { build } from "esbuild";
4
-
5
- type Options = {
6
- routesModule: string;
7
- outfile: string;
8
- minify?: boolean;
9
- sourcemap?: boolean;
10
- watch?: boolean;
11
- onEnd?: () => void;
12
- };
13
-
14
- export function buildPlugin({
15
- routesModule,
16
- outfile = "bundle.js",
17
- minify = false,
18
- sourcemap = false,
19
- watch = false,
20
- onEnd = () => {},
21
- }: Options) {
22
- return build({
23
- entryPoints: [resolve(__dirname, "../pages/functions/template-plugin.ts")],
24
- inject: [routesModule],
25
- bundle: true,
26
- format: "esm",
27
- target: "esnext",
28
- outfile,
29
- minify,
30
- sourcemap,
31
- watch,
32
- allowOverwrite: true,
33
- plugins: [
34
- {
35
- name: "wrangler notifier and monitor",
36
- setup(pluginBuild) {
37
- pluginBuild.onEnd((result) => {
38
- if (result.errors.length > 0) {
39
- console.error(
40
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
41
- );
42
- } else if (result.warnings.length > 0) {
43
- console.warn(
44
- `${result.warnings.length} warning(s) when compiling Worker.`
45
- );
46
- onEnd();
47
- } else {
48
- console.log("Compiled Worker successfully.");
49
- onEnd();
50
- }
51
- });
52
- },
53
- },
54
- {
55
- name: "Assets",
56
- setup(pluginBuild) {
57
- if (pluginBuild.initialOptions.outfile) {
58
- const outdir = dirname(pluginBuild.initialOptions.outfile);
59
-
60
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
61
- const directory = resolve(
62
- args.resolveDir,
63
- args.path.slice("assets:".length)
64
- );
65
-
66
- const exists = await access(directory)
67
- .then(() => true)
68
- .catch(() => false);
69
-
70
- const isDirectory =
71
- exists && (await lstat(directory)).isDirectory();
72
-
73
- if (!isDirectory) {
74
- return {
75
- errors: [
76
- {
77
- text: `'${directory}' does not exist or is not a directory.`,
78
- },
79
- ],
80
- };
81
- }
82
-
83
- const path = `assets:./${relative(outdir, directory)}`;
84
-
85
- return { path, external: true, namespace: "assets" };
86
- });
87
- }
88
- },
89
- },
90
- ],
91
- });
92
- }
@@ -1,138 +0,0 @@
1
- import { access, cp, lstat, rm } from "node:fs/promises";
2
- import { join, resolve } from "node:path";
3
- import { build } from "esbuild";
4
- import { nanoid } from "nanoid";
5
-
6
- type Options = {
7
- routesModule: string;
8
- outfile: string;
9
- minify?: boolean;
10
- sourcemap?: boolean;
11
- fallbackService?: string;
12
- watch?: boolean;
13
- onEnd?: () => void;
14
- buildOutputDirectory?: string;
15
- };
16
-
17
- export function buildWorker({
18
- routesModule,
19
- outfile = "bundle.js",
20
- minify = false,
21
- sourcemap = false,
22
- fallbackService = "ASSETS",
23
- watch = false,
24
- onEnd = () => {},
25
- buildOutputDirectory,
26
- }: Options) {
27
- return build({
28
- entryPoints: [resolve(__dirname, "../pages/functions/template-worker.ts")],
29
- inject: [routesModule],
30
- bundle: true,
31
- format: "esm",
32
- target: "esnext",
33
- outfile,
34
- minify,
35
- sourcemap,
36
- watch,
37
- allowOverwrite: true,
38
- define: {
39
- __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
40
- },
41
- plugins: [
42
- {
43
- name: "wrangler notifier and monitor",
44
- setup(pluginBuild) {
45
- pluginBuild.onEnd((result) => {
46
- if (result.errors.length > 0) {
47
- console.error(
48
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
49
- );
50
- } else if (result.warnings.length > 0) {
51
- console.warn(
52
- `${result.warnings.length} warning(s) when compiling Worker.`
53
- );
54
- onEnd();
55
- } else {
56
- console.log("Compiled Worker successfully.");
57
- onEnd();
58
- }
59
- });
60
- },
61
- },
62
- {
63
- name: "Assets",
64
- setup(pluginBuild) {
65
- const identifiers = new Map<string, string>();
66
-
67
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
68
- const directory = resolve(
69
- args.resolveDir,
70
- args.path.slice("assets:".length)
71
- );
72
-
73
- const exists = await access(directory)
74
- .then(() => true)
75
- .catch(() => false);
76
-
77
- const isDirectory =
78
- exists && (await lstat(directory)).isDirectory();
79
-
80
- if (!isDirectory) {
81
- return {
82
- errors: [
83
- {
84
- text: `'${directory}' does not exist or is not a directory.`,
85
- },
86
- ],
87
- };
88
- }
89
-
90
- // TODO: Consider hashing the contents rather than using a unique identifier every time?
91
- identifiers.set(directory, nanoid());
92
- if (!buildOutputDirectory) {
93
- console.warn(
94
- "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."
95
- );
96
- }
97
- return { path: directory, namespace: "assets" };
98
- });
99
-
100
- pluginBuild.onLoad(
101
- { filter: /.*/, namespace: "assets" },
102
- async (args) => {
103
- const identifier = identifiers.get(args.path);
104
-
105
- if (buildOutputDirectory) {
106
- const staticAssetsOutputDirectory = join(
107
- buildOutputDirectory,
108
- "cdn-cgi",
109
- "pages-plugins",
110
- identifier as string
111
- );
112
- await rm(staticAssetsOutputDirectory, {
113
- force: true,
114
- recursive: true,
115
- });
116
- await cp(args.path, staticAssetsOutputDirectory, {
117
- force: true,
118
- recursive: true,
119
- });
120
-
121
- return {
122
- // TODO: Watch args.path for changes and re-copy when updated
123
- contents: `export const onRequest = ({ request, env, functionPath }) => {
124
- const url = new URL(request.url)
125
- const relativePathname = url.pathname.split(functionPath)[1] || "/";
126
- url.pathname = '/cdn-cgi/pages-plugins/${identifier}' + relativePathname
127
- request = new Request(url.toString(), request)
128
- return env.ASSETS.fetch(request)
129
- }`,
130
- };
131
- }
132
- }
133
- );
134
- },
135
- },
136
- ],
137
- });
138
- }
@@ -1,234 +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
- "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
- }
@@ -1,189 +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
- 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
- }