wrangler 0.0.0-e3cab74 → 0.0.0-e3d46ab3

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 (158) hide show
  1. package/README.md +47 -16
  2. package/bin/wrangler.js +95 -32
  3. package/config-schema.json +2939 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +135 -84
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +167 -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 +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-pretty-error.ts +40 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -0
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.js +17 -0
  26. package/templates/new-worker-scheduled.ts +32 -0
  27. package/templates/new-worker.js +3 -3
  28. package/templates/new-worker.ts +22 -4
  29. package/templates/no-op-worker.js +10 -0
  30. package/templates/pages-dev-pipeline.ts +32 -0
  31. package/templates/pages-dev-util.ts +55 -0
  32. package/templates/pages-shim.ts +9 -0
  33. package/templates/pages-template-plugin.ts +190 -0
  34. package/templates/pages-template-worker.ts +198 -0
  35. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  36. package/templates/startDevWorker/ProxyWorker.ts +334 -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/InspectorProxyWorker.js +464 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +240 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +24056 -0
  45. package/wrangler-dist/cli.js +199391 -131806
  46. package/wrangler-dist/wasm-sync.wasm +0 -0
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/pages/functions/buildWorker.ts +0 -62
  52. package/pages/functions/filepath-routing.test.ts +0 -123
  53. package/pages/functions/filepath-routing.ts +0 -178
  54. package/pages/functions/identifiers.ts +0 -78
  55. package/pages/functions/routes.ts +0 -151
  56. package/pages/functions/template-worker.ts +0 -130
  57. package/src/__tests__/configuration.test.ts +0 -2185
  58. package/src/__tests__/dev.test.tsx +0 -113
  59. package/src/__tests__/guess-worker-format.test.ts +0 -66
  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 -30
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  66. package/src/__tests__/helpers/mock-console.ts +0 -62
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  68. package/src/__tests__/helpers/mock-kv.ts +0 -40
  69. package/src/__tests__/helpers/mock-user.ts +0 -27
  70. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  71. package/src/__tests__/helpers/run-in-tmp.ts +0 -29
  72. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  73. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  74. package/src/__tests__/index.test.ts +0 -866
  75. package/src/__tests__/jest.setup.ts +0 -57
  76. package/src/__tests__/kv.test.ts +0 -1141
  77. package/src/__tests__/logout.test.ts +0 -50
  78. package/src/__tests__/package-manager.test.ts +0 -206
  79. package/src/__tests__/parse.test.ts +0 -322
  80. package/src/__tests__/publish.test.ts +0 -2406
  81. package/src/__tests__/r2.test.ts +0 -198
  82. package/src/__tests__/secret.test.ts +0 -326
  83. package/src/__tests__/sentry.test.ts +0 -146
  84. package/src/__tests__/tail.test.ts +0 -564
  85. package/src/__tests__/whoami.test.tsx +0 -86
  86. package/src/api/form_data.ts +0 -217
  87. package/src/api/preview.ts +0 -147
  88. package/src/api/worker.ts +0 -186
  89. package/src/bundle.ts +0 -133
  90. package/src/cfetch/index.ts +0 -104
  91. package/src/cfetch/internal.ts +0 -133
  92. package/src/cli.ts +0 -19
  93. package/src/config/README.md +0 -107
  94. package/src/config/config.ts +0 -265
  95. package/src/config/diagnostics.ts +0 -80
  96. package/src/config/environment.ts +0 -305
  97. package/src/config/index.ts +0 -52
  98. package/src/config/validation-helpers.ts +0 -370
  99. package/src/config/validation.ts +0 -1017
  100. package/src/dev.tsx +0 -961
  101. package/src/dialogs.tsx +0 -77
  102. package/src/entry.ts +0 -57
  103. package/src/environment-variables.ts +0 -33
  104. package/src/guess-worker-format.ts +0 -68
  105. package/src/index.tsx +0 -2327
  106. package/src/inspect.ts +0 -609
  107. package/src/kv.tsx +0 -275
  108. package/src/module-collection.ts +0 -170
  109. package/src/open-in-browser.ts +0 -13
  110. package/src/package-manager.ts +0 -126
  111. package/src/pages.tsx +0 -1045
  112. package/src/parse.ts +0 -183
  113. package/src/paths.ts +0 -26
  114. package/src/proxy.ts +0 -376
  115. package/src/publish.ts +0 -368
  116. package/src/r2.ts +0 -50
  117. package/src/reporting.ts +0 -115
  118. package/src/sites.tsx +0 -241
  119. package/src/tail/filters.ts +0 -279
  120. package/src/tail/index.ts +0 -299
  121. package/src/tail/printing.ts +0 -62
  122. package/src/user.tsx +0 -1049
  123. package/src/whoami.tsx +0 -69
  124. package/templates/static-asset-facade.js +0 -47
  125. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  126. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  127. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  128. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  129. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  130. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  131. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  132. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  133. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  134. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  135. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  136. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  137. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  138. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  139. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  140. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  141. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  142. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  143. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  144. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  145. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  146. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  147. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  148. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  149. package/vendor/wrangler-mime/LICENSE +0 -21
  150. package/vendor/wrangler-mime/Mime.js +0 -97
  151. package/vendor/wrangler-mime/README.md +0 -187
  152. package/vendor/wrangler-mime/cli.js +0 -46
  153. package/vendor/wrangler-mime/index.js +0 -4
  154. package/vendor/wrangler-mime/lite.js +0 -4
  155. package/vendor/wrangler-mime/package.json +0 -52
  156. package/vendor/wrangler-mime/types/other.js +0 -1
  157. package/vendor/wrangler-mime/types/standard.js +0 -1
  158. package/wrangler-dist/cli.js.map +0 -7
Binary file
@@ -1,3 +0,0 @@
1
- // as per https://github.com/evanw/esbuild/issues/1492
2
- // to make some libs work
3
- export const import_meta_url = require("url").pathToFileURL(__filename);
File without changes
@@ -1 +0,0 @@
1
- {}
File without changes
@@ -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,123 +0,0 @@
1
- import { writeFileSync } 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
- const entries = await generateConfigFromFileTree({
87
- baseDir: ".",
88
- baseURL: "/base" as UrlPath,
89
- });
90
- expect(entries).toEqual({
91
- routes: [
92
- {
93
- method: "DELETE",
94
- module: ["bar.ts:onRequestDelete"],
95
- routePath: "/base/bar",
96
- },
97
- {
98
- method: "PUT",
99
- module: ["bar.ts:onRequestPut"],
100
- routePath: "/base/bar",
101
- },
102
- {
103
- method: "GET",
104
- module: ["foo.ts:onRequestGet"],
105
- routePath: "/base/foo",
106
- },
107
- {
108
- method: "POST",
109
- module: ["foo.ts:onRequestPost"],
110
- routePath: "/base/foo",
111
- },
112
- ],
113
- });
114
- });
115
- });
116
- });
117
-
118
- function routeConfig(routePath: string, method?: string): RouteConfig {
119
- return {
120
- routePath: toUrlPath(routePath),
121
- method: method as HTTPMethod,
122
- };
123
- }
@@ -1,178 +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.replace(/\[(.+)]/g, ":$1"); // transform [id] => :id
69
-
70
- const routeEntry: RouteConfig = {
71
- routePath: toUrlPath(routePath),
72
- method: method.toUpperCase() as HTTPMethod,
73
- [isMiddlewareFile ? "middleware" : "module"]: [
74
- `${path.relative(baseDir, filepath)}:${exportName}`,
75
- ],
76
- };
77
-
78
- routeEntries.push(routeEntry);
79
- }
80
- }
81
- }
82
- });
83
- // Combine together any routes (index routes) which contain both a module and a middleware
84
- routeEntries = routeEntries.reduce(
85
- (acc: typeof routeEntries, { routePath, ...rest }) => {
86
- const existingRouteEntry = acc.find(
87
- (routeEntry) =>
88
- routeEntry.routePath === routePath &&
89
- routeEntry.method === rest.method
90
- );
91
- if (existingRouteEntry !== undefined) {
92
- Object.assign(existingRouteEntry, rest);
93
- } else {
94
- acc.push({ routePath, ...rest });
95
- }
96
- return acc;
97
- },
98
- []
99
- );
100
-
101
- routeEntries.sort((a, b) => compareRoutes(a, b));
102
-
103
- return {
104
- routes: routeEntries,
105
- };
106
- }
107
-
108
- // Ensure routes are produced in order of precedence so that
109
- // more specific routes aren't occluded from matching due to
110
- // less specific routes appearing first in the route list.
111
- export function compareRoutes(
112
- { routePath: routePathA, method: methodA }: RouteConfig,
113
- { routePath: routePathB, method: methodB }: RouteConfig
114
- ) {
115
- function parseRoutePath(routePath: UrlPath): string[] {
116
- return routePath.slice(1).split("/").filter(Boolean);
117
- }
118
-
119
- const segmentsA = parseRoutePath(routePathA);
120
- const segmentsB = parseRoutePath(routePathB);
121
-
122
- // sort routes with fewer segments after those with more segments
123
- if (segmentsA.length !== segmentsB.length) {
124
- return segmentsB.length - segmentsA.length;
125
- }
126
-
127
- for (let i = 0; i < segmentsA.length; i++) {
128
- const isWildcardA = segmentsA[i].includes("*");
129
- const isWildcardB = segmentsB[i].includes("*");
130
- const isParamA = segmentsA[i].includes(":");
131
- const isParamB = segmentsB[i].includes(":");
132
-
133
- // sort wildcard segments after non-wildcard segments
134
- if (isWildcardA && !isWildcardB) return 1;
135
- if (!isWildcardA && isWildcardB) return -1;
136
-
137
- // sort dynamic param segments after non-param segments
138
- if (isParamA && !isParamB) return 1;
139
- if (!isParamA && isParamB) return -1;
140
- }
141
-
142
- // sort routes that specify an HTTP before those that don't
143
- if (methodA && !methodB) return -1;
144
- if (!methodA && methodB) return 1;
145
-
146
- // all else equal, just sort the paths lexicographically
147
- return routePathA.localeCompare(routePathB);
148
- }
149
-
150
- async function forEachFile<T>(
151
- baseDir: string,
152
- fn: (filepath: string) => T | Promise<T>
153
- ) {
154
- const searchPaths = [baseDir];
155
- const returnValues: T[] = [];
156
-
157
- while (isNotEmpty(searchPaths)) {
158
- const cwd = searchPaths.shift();
159
- const dir = await fs.readdir(cwd, { withFileTypes: true });
160
- for (const entry of dir) {
161
- const pathname = path.join(cwd, entry.name);
162
- if (entry.isDirectory()) {
163
- searchPaths.push(pathname);
164
- } else if (entry.isFile()) {
165
- returnValues.push(await fn(pathname));
166
- }
167
- }
168
- }
169
-
170
- return returnValues;
171
- }
172
-
173
- interface NonEmptyArray<T> extends Array<T> {
174
- shift(): T;
175
- }
176
- function isNotEmpty<T>(array: T[]): array is NonEmptyArray<T> {
177
- return array.length > 0;
178
- }
@@ -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
- }