appstage 0.2.11 → 0.2.12

package/dist/bin.js

@@ -460,7 +460,7 @@ async function buildClient({ clientDir, watch, watchClient }, plugins) {
 // src/scripts/utils/buildServer.ts
 import esbuild2 from "esbuild";
 
-// src/scripts/utils/populateEntries.ts
+// src/scripts/utils/setEntriesExport.ts
 import { writeFile } from "node:fs/promises";
 
 // src/scripts/utils/toImportPath.ts
@@ -474,25 +474,24 @@ function toImportPath(relativePath, referencePath = ".") {
   return importPath;
 }
 
-// src/scripts/utils/populateEntries.ts
-async function populateEntries({ entriesPath }) {
+// src/scripts/utils/setEntriesExport.ts
+async function setEntriesExport({ entriesPath }) {
   if (entriesPath === null) return;
   let serverEntries = await getEntryPoints(["server", "server/index"]);
   let content = "";
   if (serverEntries.length === 0) content = "export const entries = [];";
   else {
     content = "export const entries = (\n  await Promise.all([";
-    for (let i = 0; i < serverEntries.length; i++) {
+    for (let i = 0; i < serverEntries.length; i++)
       content += `
-    // ${serverEntries[i].name}
     import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
-    }
     content += "\n  ])\n).map(({ server }) => server);";
   }
   await writeFile(
     entriesPath ?? "src/server/entries.ts",
     `// Populated automatically during the build phase by picking
-// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)"
+// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)".
+// Ignore this file if a custom set of entry exports is required.
 ${content}
 `
   );
@@ -502,7 +501,7 @@ ${content}
 var appServerEntryPoints = ["src/server/index.ts"];
 async function buildServer(params, plugins) {
   let { serverDir, watch, watchServer } = params;
-  await populateEntries(params);
+  await setEntriesExport(params);
   let buildOptions = {
     ...commonBuildOptions,
     entryPoints: appServerEntryPoints,

package/dist/index.cjs

@@ -68,6 +68,15 @@ function getLanguageList(req) {
   }
   return Array.from(langs);
 }
+function matches(x, matcher) {
+  if (matcher === null || matcher === void 0) return true;
+  if (typeof matcher === "function") return matcher(x);
+  let patterns = Array.isArray(matcher) ? matcher : [matcher];
+  for (let pattern of patterns) if (pattern instanceof RegExp) {
+    if (pattern.test(x)) return true;
+  } else if (pattern === x) return true;
+  return false;
+}
 const defaultExtensions = ["html", "htm"];
 const defaultPath = (req) => req.originalUrl.split("?")[0];
 const defaultLanguages = getLanguageList;
@@ -82,6 +91,14 @@ const files = (params) => {
   return async (req, res) => {
     let langs = (p.languages ?? defaultLanguages)(req);
     let path = typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
+    if (!matches(path, p.matches)) {
+      emitLog(req.app, "Unmatched path", { data: { path } });
+      res.status(404).send(await req.app.renderStatus?.(req, res, {
+        code: "unmatched_path",
+        path
+      }));
+      return;
+    }
     if (path.includes("../")) {
       emitLog(req.app, "Invalid path (potential traversal attempt)", { data: { path } });
       res.status(400).send(await req.app.renderStatus?.(req, res, {
@@ -93,10 +110,12 @@ const files = (params) => {
     let filePath = null;
     for (let k = 0; k < bases.length && filePath === null; k++) {
       let base = bases[k];
-      for (let i = 0; i < langs.length && filePath === null; i++) filePath = await resolve(base, `${path}.${langs[i]}`);
-      if (filePath === null) filePath = await resolve(base, path);
-      for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
-      for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, `${path}.${exts[i]}`);
+      if (!path.endsWith("/")) {
+        for (let i = 0; i < langs.length && filePath === null; i++) filePath = await resolve(base, `${path}.${langs[i]}`);
+        if (filePath === null) filePath = await resolve(base, path);
+        for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
+        for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, `${path}.${exts[i]}`);
+      }
       for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}`, `index.${exts[j]}`);
       for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, path, `index.${langs[i]}.${exts[j]}`);
       for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, path, `index.${exts[i]}`);
@@ -410,19 +429,19 @@ function toImportPath(relativePath, referencePath = ".") {
   return importPath;
 }
 
-async function populateEntries({ entriesPath }) {
+async function setEntriesExport({ entriesPath }) {
   if (entriesPath === null) return;
   let serverEntries = await getEntryPoints(["server", "server/index"]);
   let content = "";
   if (serverEntries.length === 0) content = "export const entries = [];";
   else {
     content = "export const entries = (\n  await Promise.all([";
-    for (let i = 0; i < serverEntries.length; i++) content += `\n    // ${serverEntries[i].name}
-    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
+    for (let i = 0; i < serverEntries.length; i++) content += `\n    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
     content += "\n  ])\n).map(({ server }) => server);";
   }
   await (0, node_fs_promises.writeFile)(entriesPath ?? "src/server/entries.ts", `// Populated automatically during the build phase by picking
-// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)"
+// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)".
+// Ignore this file if a custom set of entry exports is required.
 ${content}
 `);
 }
@@ -430,7 +449,7 @@ ${content}
 const appServerEntryPoints = ["src/server/index.ts"];
 async function buildServer(params, plugins) {
   let { serverDir, watch, watchServer } = params;
-  await populateEntries(params);
+  await setEntriesExport(params);
   let buildOptions = {
     ...commonBuildOptions,
     entryPoints: appServerEntryPoints,

package/dist/index.d.ts

@@ -16,9 +16,11 @@ type TransformContent = (req: Request, res: Response, params: {
   name?: string;
 }) => string | Promise<string>;
 
+type StringMatcher = string | RegExp | (string | RegExp)[] | ((x: string) => boolean) | null;
 type FilesParams = {
   base: string | string[];
-  path?: string | ((req: Request) => string);
+  path?: string | ((req: Request) => string); /** Specifies which paths should be accepted. */
+  matches?: StringMatcher;
   extensions?: string[];
   languages?: (req: Request) => string[];
   transform?: TransformContent[];

package/dist/index.mjs

@@ -42,6 +42,15 @@ function getLanguageList(req) {
   }
   return Array.from(langs);
 }
+function matches(x, matcher) {
+  if (matcher === null || matcher === void 0) return true;
+  if (typeof matcher === "function") return matcher(x);
+  let patterns = Array.isArray(matcher) ? matcher : [matcher];
+  for (let pattern of patterns) if (pattern instanceof RegExp) {
+    if (pattern.test(x)) return true;
+  } else if (pattern === x) return true;
+  return false;
+}
 const defaultExtensions = ["html", "htm"];
 const defaultPath = (req) => req.originalUrl.split("?")[0];
 const defaultLanguages = getLanguageList;
@@ -56,6 +65,14 @@ const files = (params) => {
   return async (req, res) => {
     let langs = (p.languages ?? defaultLanguages)(req);
     let path = typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
+    if (!matches(path, p.matches)) {
+      emitLog(req.app, "Unmatched path", { data: { path } });
+      res.status(404).send(await req.app.renderStatus?.(req, res, {
+        code: "unmatched_path",
+        path
+      }));
+      return;
+    }
     if (path.includes("../")) {
       emitLog(req.app, "Invalid path (potential traversal attempt)", { data: { path } });
       res.status(400).send(await req.app.renderStatus?.(req, res, {
@@ -67,10 +84,12 @@ const files = (params) => {
     let filePath = null;
     for (let k = 0; k < bases.length && filePath === null; k++) {
       let base = bases[k];
-      for (let i = 0; i < langs.length && filePath === null; i++) filePath = await resolve(base, `${path}.${langs[i]}`);
-      if (filePath === null) filePath = await resolve(base, path);
-      for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
-      for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, `${path}.${exts[i]}`);
+      if (!path.endsWith("/")) {
+        for (let i = 0; i < langs.length && filePath === null; i++) filePath = await resolve(base, `${path}.${langs[i]}`);
+        if (filePath === null) filePath = await resolve(base, path);
+        for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
+        for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, `${path}.${exts[i]}`);
+      }
       for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, `${path}.${langs[i]}`, `index.${exts[j]}`);
       for (let i = 0; i < langs.length && filePath === null; i++) for (let j = 0; j < exts.length && filePath === null; j++) filePath = await resolve(base, path, `index.${langs[i]}.${exts[j]}`);
       for (let i = 0; i < exts.length && filePath === null; i++) filePath = await resolve(base, path, `index.${exts[i]}`);
@@ -384,19 +403,19 @@ function toImportPath(relativePath, referencePath = ".") {
   return importPath;
 }
 
-async function populateEntries({ entriesPath }) {
+async function setEntriesExport({ entriesPath }) {
   if (entriesPath === null) return;
   let serverEntries = await getEntryPoints(["server", "server/index"]);
   let content = "";
   if (serverEntries.length === 0) content = "export const entries = [];";
   else {
     content = "export const entries = (\n  await Promise.all([";
-    for (let i = 0; i < serverEntries.length; i++) content += `\n    // ${serverEntries[i].name}
-    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
+    for (let i = 0; i < serverEntries.length; i++) content += `\n    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
     content += "\n  ])\n).map(({ server }) => server);";
   }
   await writeFile(entriesPath ?? "src/server/entries.ts", `// Populated automatically during the build phase by picking
-// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)"
+// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)".
+// Ignore this file if a custom set of entry exports is required.
 ${content}
 `);
 }
@@ -404,7 +423,7 @@ ${content}
 const appServerEntryPoints = ["src/server/index.ts"];
 async function buildServer(params, plugins) {
   let { serverDir, watch, watchServer } = params;
-  await populateEntries(params);
+  await setEntriesExport(params);
   let buildOptions = {
     ...commonBuildOptions,
     entryPoints: appServerEntryPoints,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appstage",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "description": "",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/controllers/files.ts

@@ -5,6 +5,13 @@ import type { Controller } from "../types/Controller.ts";
 import type { TransformContent } from "../types/TransformContent.ts";
 import { emitLog } from "../utils/emitLog.ts";
 
+type StringMatcher =
+  | string
+  | RegExp
+  | (string | RegExp)[]
+  | ((x: string) => boolean)
+  | null;
+
 const maxLanguages = 3;
 
 async function resolve(...parts: string[]) {
@@ -38,9 +45,27 @@ function getLanguageList(req: Request) {
   return Array.from(langs);
 }
 
+function matches(x: string, matcher: StringMatcher | undefined) {
+  if (matcher === null || matcher === undefined) return true;
+
+  if (typeof matcher === "function") return matcher(x);
+
+  let patterns = Array.isArray(matcher) ? matcher : [matcher];
+
+  for (let pattern of patterns) {
+    if (pattern instanceof RegExp) {
+      if (pattern.test(x)) return true;
+    } else if (pattern === x) return true;
+  }
+
+  return false;
+}
+
 export type FilesParams = {
   base: string | string[];
   path?: string | ((req: Request) => string);
+  /** Specifies which paths should be accepted. */
+  matches?: StringMatcher;
   extensions?: string[];
   languages?: (req: Request) => string[];
   transform?: TransformContent[];
@@ -66,6 +91,19 @@ export const files: Controller<string | FilesParams> = (params) => {
     let path =
       typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
 
+    if (!matches(path, p.matches)) {
+      emitLog(req.app, "Unmatched path", { data: { path } });
+
+      res.status(404).send(
+        await req.app.renderStatus?.(req, res, {
+          code: "unmatched_path",
+          path,
+        }),
+      );
+
+      return;
+    }
+
     if (path.includes("../")) {
       emitLog(req.app, "Invalid path (potential traversal attempt)", {
         data: { path },
@@ -88,22 +126,24 @@ export const files: Controller<string | FilesParams> = (params) => {
     for (let k = 0; k < bases.length && filePath === null; k++) {
       let base = bases[k];
 
-      // /x.en /x.ru
-      for (let i = 0; i < langs.length && filePath === null; i++)
-        filePath = await resolve(base, `${path}.${langs[i]}`);
+      if (!path.endsWith("/")) {
+        // /x.en /x.ru
+        for (let i = 0; i < langs.length && filePath === null; i++)
+          filePath = await resolve(base, `${path}.${langs[i]}`);
 
-      // /x
-      if (filePath === null) filePath = await resolve(base, path);
+        // /x
+        if (filePath === null) filePath = await resolve(base, path);
 
-      // /x.en.html /x.en.htm /x.ru.html /x.ru.htm
-      for (let i = 0; i < langs.length && filePath === null; i++) {
-        for (let j = 0; j < exts.length && filePath === null; j++)
-          filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
-      }
+        // /x.en.html /x.en.htm /x.ru.html /x.ru.htm
+        for (let i = 0; i < langs.length && filePath === null; i++) {
+          for (let j = 0; j < exts.length && filePath === null; j++)
+            filePath = await resolve(base, `${path}.${langs[i]}.${exts[j]}`);
+        }
 
-      // /x.html /x.htm
-      for (let i = 0; i < exts.length && filePath === null; i++)
-        filePath = await resolve(base, `${path}.${exts[i]}`);
+        // /x.html /x.htm
+        for (let i = 0; i < exts.length && filePath === null; i++)
+          filePath = await resolve(base, `${path}.${exts[i]}`);
+      }
 
       // /x.en/index.html /x.en/index.htm /x.ru/index.html /x.ru/index.htm
       for (let i = 0; i < langs.length && filePath === null; i++) {

package/src/scripts/utils/buildServer.ts

@@ -1,14 +1,14 @@
 import esbuild, { type BuildOptions, type Plugin } from "esbuild";
 import { commonBuildOptions } from "../const/commonBuildOptions.ts";
 import type { BuildParams } from "../types/BuildParams.ts";
-import { populateEntries } from "./populateEntries.ts";
+import { setEntriesExport } from "./setEntriesExport.ts";
 
 const appServerEntryPoints = ["src/server/index.ts"];
 
 export async function buildServer(params: BuildParams, plugins?: Plugin[]) {
   let { serverDir, watch, watchServer } = params;
 
-  await populateEntries(params);
+  await setEntriesExport(params);
 
   let buildOptions: BuildOptions = {
     ...commonBuildOptions,

package/src/scripts/utils/{populateEntries.ts → setEntriesExport.ts}

@@ -3,7 +3,7 @@ import type { BuildParams } from "../types/BuildParams.ts";
 import { getEntryPoints } from "./getEntryPoints.ts";
 import { toImportPath } from "./toImportPath.ts";
 
-export async function populateEntries({ entriesPath }: BuildParams) {
+export async function setEntriesExport({ entriesPath }: BuildParams) {
   if (entriesPath === null) return;
 
   let serverEntries = await getEntryPoints(["server", "server/index"]);
@@ -13,10 +13,8 @@ export async function populateEntries({ entriesPath }: BuildParams) {
   else {
     content = "export const entries = (\n  await Promise.all([";
 
-    for (let i = 0; i < serverEntries.length; i++) {
-      content += `\n    // ${serverEntries[i].name}
-    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
-    }
+    for (let i = 0; i < serverEntries.length; i++)
+      content += `\n    import("${toImportPath(serverEntries[i].path, "src/server")}"),`;
 
     content += "\n  ])\n).map(({ server }) => server);";
   }
@@ -24,7 +22,8 @@ export async function populateEntries({ entriesPath }: BuildParams) {
   await writeFile(
     entriesPath ?? "src/server/entries.ts",
     `// Populated automatically during the build phase by picking
-// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)"
+// all server exports from "src/entries/<entry_name>/server(/index)?.(js|ts)".
+// Ignore this file if a custom set of entry exports is required.
 ${content}
 `,
   );