wrangler 0.0.0-e64812e → 0.0.0-e8e684c7

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 (214) hide show
  1. package/README.md +27 -3
  2. package/bin/wrangler.js +150 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +663 -7
  5. package/package.json +173 -152
  6. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  7. package/src/__tests__/config-cache.test.ts +30 -24
  8. package/src/__tests__/configuration.test.ts +4015 -3363
  9. package/src/__tests__/dev.test.tsx +1290 -952
  10. package/src/__tests__/generate.test.ts +91 -0
  11. package/src/__tests__/guess-worker-format.test.ts +68 -68
  12. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  13. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  14. package/src/__tests__/helpers/mock-bin.ts +20 -20
  15. package/src/__tests__/helpers/mock-cfetch.ts +179 -94
  16. package/src/__tests__/helpers/mock-console.ts +49 -39
  17. package/src/__tests__/helpers/mock-dialogs.ts +94 -71
  18. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  19. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  20. package/src/__tests__/helpers/mock-istty.ts +65 -18
  21. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  22. package/src/__tests__/helpers/mock-kv.ts +26 -26
  23. package/src/__tests__/helpers/mock-oauth-flow.ts +223 -228
  24. package/src/__tests__/helpers/mock-process.ts +39 -0
  25. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  26. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  27. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  28. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  29. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  30. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  31. package/src/__tests__/https-options.test.ts +142 -109
  32. package/src/__tests__/index.test.ts +222 -233
  33. package/src/__tests__/init.test.ts +2139 -1603
  34. package/src/__tests__/jest.setup.ts +114 -34
  35. package/src/__tests__/kv.test.ts +1222 -1032
  36. package/src/__tests__/logger.test.ts +100 -74
  37. package/src/__tests__/metrics.test.ts +450 -0
  38. package/src/__tests__/package-manager.test.ts +303 -303
  39. package/src/__tests__/pages.test.ts +1173 -652
  40. package/src/__tests__/parse.test.ts +252 -252
  41. package/src/__tests__/publish.test.ts +6788 -5301
  42. package/src/__tests__/pubsub.test.ts +367 -0
  43. package/src/__tests__/r2.test.ts +328 -225
  44. package/src/__tests__/route.test.ts +18 -18
  45. package/src/__tests__/secret.test.ts +470 -459
  46. package/src/__tests__/tail.test.ts +676 -564
  47. package/src/__tests__/test-old-node-version.js +31 -0
  48. package/src/__tests__/user.test.ts +136 -112
  49. package/src/__tests__/validate-dev-props.test.ts +56 -0
  50. package/src/__tests__/version.test.ts +35 -0
  51. package/src/__tests__/whoami.test.tsx +267 -83
  52. package/src/__tests__/worker-namespace.test.ts +329 -0
  53. package/src/abort.d.ts +1 -1
  54. package/src/api/dev.ts +93 -0
  55. package/src/api/index.ts +1 -0
  56. package/src/bundle-reporter.tsx +29 -0
  57. package/src/bundle.ts +430 -157
  58. package/src/cfetch/index.ts +80 -80
  59. package/src/cfetch/internal.ts +244 -91
  60. package/src/cli.ts +21 -7
  61. package/src/config/config.ts +224 -195
  62. package/src/config/diagnostics.ts +61 -61
  63. package/src/config/environment.ts +422 -357
  64. package/src/config/index.ts +219 -193
  65. package/src/config/validation-helpers.ts +379 -357
  66. package/src/config/validation.ts +1690 -1367
  67. package/src/config-cache.ts +81 -41
  68. package/src/create-worker-preview.ts +208 -136
  69. package/src/create-worker-upload-form.ts +275 -238
  70. package/src/dev/dev-vars.ts +13 -13
  71. package/src/dev/dev.tsx +477 -351
  72. package/src/dev/local.tsx +426 -295
  73. package/src/dev/remote.tsx +406 -211
  74. package/src/dev/use-esbuild.ts +154 -94
  75. package/src/dev/validate-dev-props.ts +31 -0
  76. package/src/dev-registry.tsx +160 -0
  77. package/src/dev.tsx +696 -0
  78. package/src/dialogs.tsx +97 -97
  79. package/src/dispatch-namespace.ts +206 -0
  80. package/src/durable.ts +87 -87
  81. package/src/entry.ts +234 -228
  82. package/src/environment-variables.ts +23 -23
  83. package/src/errors.ts +6 -6
  84. package/src/faye-websocket.d.ts +6 -0
  85. package/src/generate.ts +131 -0
  86. package/src/git-client.ts +42 -0
  87. package/src/global-wrangler-config-path.ts +26 -0
  88. package/src/https-options.ts +84 -80
  89. package/src/index.tsx +2164 -2768
  90. package/src/init.ts +622 -0
  91. package/src/inspect.ts +678 -593
  92. package/src/intl-polyfill.d.ts +123 -123
  93. package/src/is-ci.ts +14 -0
  94. package/src/is-interactive.ts +12 -0
  95. package/src/kv.ts +299 -277
  96. package/src/logger.ts +46 -39
  97. package/src/metrics/index.ts +5 -0
  98. package/src/metrics/metrics-config.ts +239 -0
  99. package/src/metrics/metrics-dispatcher.ts +96 -0
  100. package/src/metrics/metrics-usage-headers.ts +24 -0
  101. package/src/metrics/send-event.ts +92 -0
  102. package/src/miniflare-cli/assets.ts +554 -0
  103. package/src/miniflare-cli/enum-keys.ts +8 -8
  104. package/src/miniflare-cli/index.ts +198 -32
  105. package/src/miniflare-cli/request-context.ts +18 -18
  106. package/src/module-collection.ts +212 -212
  107. package/src/open-in-browser.ts +4 -6
  108. package/src/package-manager.ts +173 -128
  109. package/src/pages/build.tsx +238 -0
  110. package/src/pages/constants.ts +12 -0
  111. package/src/pages/deployments.tsx +106 -0
  112. package/src/pages/dev.tsx +528 -0
  113. package/src/pages/errors.ts +22 -0
  114. package/src/pages/functions/buildPlugin.ts +109 -0
  115. package/src/pages/functions/buildWorker.ts +155 -0
  116. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  117. package/src/pages/functions/filepath-routing.ts +189 -0
  118. package/src/pages/functions/identifiers.ts +78 -0
  119. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  120. package/src/pages/functions/routes-consolidation.ts +73 -0
  121. package/src/pages/functions/routes-transformation.test.ts +271 -0
  122. package/src/pages/functions/routes-transformation.ts +122 -0
  123. package/src/pages/functions/routes.ts +151 -0
  124. package/src/pages/functions.tsx +96 -0
  125. package/src/pages/index.tsx +94 -0
  126. package/src/pages/projects.tsx +169 -0
  127. package/src/pages/publish.tsx +391 -0
  128. package/src/pages/types.ts +49 -0
  129. package/src/pages/upload.tsx +413 -0
  130. package/src/pages/utils.ts +12 -0
  131. package/src/parse.ts +209 -125
  132. package/src/paths.ts +6 -6
  133. package/src/preview.ts +31 -0
  134. package/src/proxy.ts +410 -389
  135. package/src/publish.ts +773 -534
  136. package/src/pubsub/index.ts +286 -0
  137. package/src/pubsub/pubsub-commands.tsx +623 -0
  138. package/src/r2.ts +100 -19
  139. package/src/selfsigned.d.ts +23 -23
  140. package/src/sites.tsx +278 -201
  141. package/src/tail/filters.ts +111 -109
  142. package/src/tail/index.ts +230 -217
  143. package/src/tail/printing.ts +86 -46
  144. package/src/update-check.ts +11 -11
  145. package/src/user/choose-account.tsx +69 -0
  146. package/src/user/env-vars.ts +46 -0
  147. package/src/user/generate-auth-url.ts +33 -0
  148. package/src/user/generate-random-state.ts +16 -0
  149. package/src/user/index.ts +3 -0
  150. package/src/user/user.tsx +1191 -0
  151. package/src/whoami.tsx +141 -42
  152. package/src/worker.ts +123 -99
  153. package/src/zones.ts +167 -0
  154. package/templates/checked-fetch.js +17 -0
  155. package/templates/first-party-worker-module-facade.ts +18 -0
  156. package/templates/format-dev-errors.ts +32 -0
  157. package/templates/new-worker-scheduled.js +3 -3
  158. package/templates/new-worker-scheduled.ts +15 -15
  159. package/templates/new-worker.js +3 -3
  160. package/templates/new-worker.ts +15 -15
  161. package/templates/no-op-worker.js +10 -0
  162. package/templates/pages-shim.ts +9 -0
  163. package/templates/pages-template-plugin.ts +167 -0
  164. package/templates/pages-template-worker.ts +172 -0
  165. package/templates/serve-static-assets.ts +63 -0
  166. package/templates/service-bindings-module-facade.js +54 -0
  167. package/templates/service-bindings-sw-facade.js +42 -0
  168. package/templates/tsconfig.json +95 -95
  169. package/wrangler-dist/cli.d.ts +338 -0
  170. package/wrangler-dist/cli.js +95449 -67524
  171. package/pages/functions/buildPlugin.ts +0 -105
  172. package/pages/functions/buildWorker.ts +0 -151
  173. package/pages/functions/filepath-routing.ts +0 -189
  174. package/pages/functions/identifiers.ts +0 -78
  175. package/pages/functions/routes.ts +0 -156
  176. package/pages/functions/template-plugin.ts +0 -147
  177. package/pages/functions/template-worker.ts +0 -143
  178. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  179. package/src/pages.tsx +0 -2038
  180. package/src/user.tsx +0 -1203
  181. package/templates/static-asset-facade.js +0 -47
  182. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  183. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  184. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  185. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  186. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  187. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  188. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  189. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  190. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  191. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  192. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  193. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  194. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  195. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  196. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  197. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  198. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  199. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  200. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  201. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  202. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  203. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  204. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  205. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  206. package/vendor/wrangler-mime/LICENSE +0 -21
  207. package/vendor/wrangler-mime/Mime.js +0 -97
  208. package/vendor/wrangler-mime/README.md +0 -187
  209. package/vendor/wrangler-mime/cli.js +0 -46
  210. package/vendor/wrangler-mime/index.js +0 -4
  211. package/vendor/wrangler-mime/lite.js +0 -4
  212. package/vendor/wrangler-mime/package.json +0 -52
  213. package/vendor/wrangler-mime/types/other.js +0 -1
  214. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,105 +0,0 @@
1
- import { access, lstat } from "node:fs/promises";
2
- import { dirname, relative, 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
-
7
- type Options = {
8
- routesModule: string;
9
- outfile: string;
10
- minify?: boolean;
11
- sourcemap?: boolean;
12
- watch?: boolean;
13
- nodeCompat?: boolean;
14
- onEnd?: () => void;
15
- };
16
-
17
- export function buildPlugin({
18
- routesModule,
19
- outfile = "bundle.js",
20
- minify = false,
21
- sourcemap = false,
22
- watch = false,
23
- nodeCompat,
24
- onEnd = () => {},
25
- }: Options) {
26
- return build({
27
- entryPoints: [resolve(__dirname, "../pages/functions/template-plugin.ts")],
28
- inject: [routesModule],
29
- bundle: true,
30
- format: "esm",
31
- target: "esnext",
32
- outfile,
33
- minify,
34
- sourcemap,
35
- watch,
36
- allowOverwrite: true,
37
- define: { ...(nodeCompat ? { global: "globalThis" } : {}) },
38
- plugins: [
39
- {
40
- name: "wrangler notifier and monitor",
41
- setup(pluginBuild) {
42
- pluginBuild.onEnd((result) => {
43
- if (result.errors.length > 0) {
44
- console.error(
45
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
46
- );
47
- } else if (result.warnings.length > 0) {
48
- console.warn(
49
- `${result.warnings.length} warning(s) when compiling Worker.`
50
- );
51
- onEnd();
52
- } else {
53
- console.log("Compiled Worker successfully.");
54
- onEnd();
55
- }
56
- });
57
- },
58
- },
59
- {
60
- name: "Assets",
61
- setup(pluginBuild) {
62
- if (pluginBuild.initialOptions.outfile) {
63
- const outdir = dirname(pluginBuild.initialOptions.outfile);
64
-
65
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
66
- const directory = resolve(
67
- args.resolveDir,
68
- args.path.slice("assets:".length)
69
- );
70
-
71
- const exists = await access(directory)
72
- .then(() => true)
73
- .catch(() => false);
74
-
75
- const isDirectory =
76
- exists && (await lstat(directory)).isDirectory();
77
-
78
- if (!isDirectory) {
79
- return {
80
- errors: [
81
- {
82
- text: `'${directory}' does not exist or is not a directory.`,
83
- },
84
- ],
85
- };
86
- }
87
-
88
- const path = `assets:./${relative(outdir, directory)}`;
89
-
90
- return { path, external: true, namespace: "assets" };
91
- });
92
- }
93
- },
94
- },
95
- ...(nodeCompat
96
- ? [
97
- NodeGlobalsPolyfills({
98
- buffer: true,
99
- }),
100
- NodeModulesPolyfills(),
101
- ]
102
- : []),
103
- ],
104
- });
105
- }
@@ -1,151 +0,0 @@
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, "../pages/functions/template-worker.ts")],
33
- inject: [routesModule],
34
- bundle: true,
35
- format: "esm",
36
- target: "esnext",
37
- outfile,
38
- minify,
39
- sourcemap,
40
- watch,
41
- allowOverwrite: true,
42
- define: {
43
- __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
44
- ...(nodeCompat ? { global: "globalThis" } : {}),
45
- },
46
- plugins: [
47
- {
48
- name: "wrangler notifier and monitor",
49
- setup(pluginBuild) {
50
- pluginBuild.onEnd((result) => {
51
- if (result.errors.length > 0) {
52
- console.error(
53
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
54
- );
55
- } else if (result.warnings.length > 0) {
56
- console.warn(
57
- `${result.warnings.length} warning(s) when compiling Worker.`
58
- );
59
- onEnd();
60
- } else {
61
- console.log("Compiled Worker successfully.");
62
- onEnd();
63
- }
64
- });
65
- },
66
- },
67
- {
68
- name: "Assets",
69
- setup(pluginBuild) {
70
- const identifiers = new Map<string, string>();
71
-
72
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
73
- const directory = resolve(
74
- args.resolveDir,
75
- args.path.slice("assets:".length)
76
- );
77
-
78
- const exists = await access(directory)
79
- .then(() => true)
80
- .catch(() => false);
81
-
82
- const isDirectory =
83
- exists && (await lstat(directory)).isDirectory();
84
-
85
- if (!isDirectory) {
86
- return {
87
- errors: [
88
- {
89
- text: `'${directory}' does not exist or is not a directory.`,
90
- },
91
- ],
92
- };
93
- }
94
-
95
- // TODO: Consider hashing the contents rather than using a unique identifier every time?
96
- identifiers.set(directory, nanoid());
97
- if (!buildOutputDirectory) {
98
- console.warn(
99
- "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."
100
- );
101
- }
102
- return { path: directory, namespace: "assets" };
103
- });
104
-
105
- pluginBuild.onLoad(
106
- { filter: /.*/, namespace: "assets" },
107
- async (args) => {
108
- const identifier = identifiers.get(args.path);
109
-
110
- if (buildOutputDirectory) {
111
- const staticAssetsOutputDirectory = join(
112
- buildOutputDirectory,
113
- "cdn-cgi",
114
- "pages-plugins",
115
- identifier as string
116
- );
117
- await rm(staticAssetsOutputDirectory, {
118
- force: true,
119
- recursive: true,
120
- });
121
- await cp(args.path, staticAssetsOutputDirectory, {
122
- force: true,
123
- recursive: true,
124
- });
125
-
126
- return {
127
- // TODO: Watch args.path for changes and re-copy when updated
128
- contents: `export const onRequest = ({ request, env, functionPath }) => {
129
- const url = new URL(request.url)
130
- const relativePathname = \`/\${url.pathname.split(functionPath)[1] || ''}\`.replace(/^\\/\\//, '/');
131
- url.pathname = '/cdn-cgi/pages-plugins/${identifier}' + relativePathname
132
- request = new Request(url.toString(), request)
133
- return env.ASSETS.fetch(request)
134
- }`,
135
- };
136
- }
137
- }
138
- );
139
- },
140
- },
141
- ...(nodeCompat
142
- ? [
143
- NodeGlobalsPolyfills({
144
- buffer: true,
145
- }),
146
- NodeModulesPolyfills(),
147
- ]
148
- : []),
149
- ],
150
- });
151
- }
@@ -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
- }
@@ -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,156 +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
- mountPath: UrlPath;
25
- method?: HTTPMethod;
26
- modules: string[];
27
- middlewares: string[];
28
- }>;
29
-
30
- export type Config = {
31
- routes?: RouteConfig[];
32
- schedules?: unknown;
33
- };
34
-
35
- export type RouteConfig = {
36
- routePath: UrlPath;
37
- mountPath: UrlPath;
38
- method?: HTTPMethod;
39
- middleware?: string | string[];
40
- module?: string | string[];
41
- };
42
-
43
- type ImportMap = Map<
44
- string,
45
- {
46
- filepath: string;
47
- name: string;
48
- identifier: string;
49
- }
50
- >;
51
-
52
- type Arguments = {
53
- config: Config;
54
- outfile: string;
55
- srcDir: string;
56
- };
57
-
58
- export async function writeRoutesModule({
59
- config,
60
- srcDir,
61
- outfile = "_routes.js",
62
- }: Arguments) {
63
- const { importMap, routes } = parseConfig(config, srcDir);
64
- const routesModule = generateRoutesModule(importMap, routes);
65
-
66
- await fs.writeFile(outfile, routesModule);
67
-
68
- return outfile;
69
- }
70
-
71
- export function parseConfig(config: Config, baseDir: string) {
72
- const routes: RoutesCollection = [];
73
- const importMap: ImportMap = new Map();
74
- const identifierCount = new Map<string, number>(); // to keep track of identifier collisions
75
-
76
- function parseModuleIdentifiers(paths: string | string[] | undefined) {
77
- if (typeof paths === "undefined") {
78
- paths = [];
79
- }
80
-
81
- if (typeof paths === "string") {
82
- paths = [paths];
83
- }
84
-
85
- return paths.map((modulePath) => {
86
- const [filepath, name = "default"] = modulePath.split(":");
87
- let { identifier } = importMap.get(modulePath) ?? {};
88
-
89
- const resolvedPath = path.resolve(baseDir, filepath);
90
-
91
- // ensure the filepath isn't attempting to resolve to anything outside of the project
92
- if (path.relative(baseDir, resolvedPath).startsWith("..")) {
93
- throw new Error(`Invalid module path "${filepath}"`);
94
- }
95
-
96
- // ensure the module name (if provided) is a valid identifier to guard against injection attacks
97
- if (name !== "default" && !isValidIdentifier(name)) {
98
- throw new Error(`Invalid module identifier "${name}"`);
99
- }
100
-
101
- if (!identifier) {
102
- identifier = normalizeIdentifier(`__${filepath}_${name}`);
103
-
104
- let count = identifierCount.get(identifier) ?? 0;
105
- identifierCount.set(identifier, ++count);
106
-
107
- if (count > 1) {
108
- identifier += `_${count}`;
109
- }
110
-
111
- importMap.set(modulePath, { filepath: resolvedPath, name, identifier });
112
- }
113
-
114
- return identifier;
115
- });
116
- }
117
-
118
- for (const { routePath, mountPath, method, ...props } of config.routes ??
119
- []) {
120
- routes.push({
121
- routePath,
122
- mountPath,
123
- method,
124
- middlewares: parseModuleIdentifiers(props.middleware),
125
- modules: parseModuleIdentifiers(props.module),
126
- });
127
- }
128
-
129
- return { routes, importMap };
130
- }
131
-
132
- export function generateRoutesModule(
133
- importMap: ImportMap,
134
- routes: RoutesCollection
135
- ) {
136
- return `${[...importMap.values()]
137
- .map(
138
- ({ filepath, name, identifier }) =>
139
- `import { ${name} as ${identifier} } from ${JSON.stringify(filepath)}`
140
- )
141
- .join("\n")}
142
-
143
- export const routes = [
144
- ${routes
145
- .map(
146
- (route) => ` {
147
- routePath: "${route.routePath}",
148
- mountPath: "${route.mountPath}",
149
- method: "${route.method}",
150
- middlewares: [${route.middlewares.join(", ")}],
151
- modules: [${route.modules.join(", ")}],
152
- },`
153
- )
154
- .join("\n")}
155
- ]`;
156
- }