appstage 0.2.8 → 0.2.10

package/dist/index.cjs

@@ -124,6 +124,89 @@ const dir = ({ path, name = defaultName, ext = defaultExt, transform, supportedL
   };
 };
 
+const maxLanguages = 3;
+async function resolve(...parts) {
+  let fullPath = (0, node_path.join)(...parts);
+  try {
+    if ((await (0, node_fs_promises.lstat)(fullPath)).isFile()) return fullPath;
+  } catch {}
+  return null;
+}
+function getLanguageList(req) {
+  let langParam = req.query.lang;
+  if (langParam) return [String(langParam)];
+  let acceptedLanguages = req.acceptsLanguages();
+  let langs = /* @__PURE__ */ new Set();
+  for (let i = 0; i < acceptedLanguages.length && i < maxLanguages; i++) {
+    let s = acceptedLanguages[i];
+    let [lang] = s.split(/[-_]/);
+    if (s === lang) langs.add(s);
+    else {
+      langs.add(s);
+      langs.add(lang);
+    }
+  }
+  return Array.from(langs);
+}
+const defaultExtensions = ["html", "htm"];
+const defaultPath = (req) => req.originalUrl.split("?")[0];
+const defaultLanguages = getLanguageList;
+/**
+* Serves files from the specified directory path in a locale-aware
+* fashion after applying optional transforms.
+*/
+const files = (params) => {
+  let p = typeof params === "string" ? { base: params } : params;
+  let bases = Array.isArray(p.base) ? p.base : [p.base];
+  let exts = p.extensions ?? defaultExtensions;
+  return async (req, res) => {
+    let langs = (p.languages ?? defaultLanguages)(req);
+    let path = typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
+    if (path.includes("../")) {
+      emitLog(req.app, "Invalid path (potential traversal attempt)", { data: { path } });
+      res.status(400).send(await req.app.renderStatus?.(req, res, {
+        code: "invalid_path",
+        path
+      }));
+      return;
+    }
+    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]}`);
+      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]}`);
+    }
+    if (filePath === null) {
+      emitLog(req.app, "Unknown path", { data: { path } });
+      res.status(404).send(await req.app.renderStatus?.(req, res, {
+        code: "unknown_path",
+        path
+      }));
+      return;
+    }
+    if (!p.transform?.length) {
+      res.sendFile(filePath);
+      return;
+    }
+    let content = (await (0, node_fs_promises.readFile)(filePath)).toString();
+    let name = (0, node_path.basename)(filePath);
+    for (let transform of p.transform) {
+      let result = transform(req, res, {
+        content,
+        path,
+        name
+      });
+      content = result instanceof Promise ? await result : result;
+    }
+    res.type((0, node_path.extname)(name).slice(1)).send(content);
+  };
+};
+
 const unhandledError = () => async (err, req, res) => {
   emitLog(req.app, "Unhandled error", {
     level: "error",
@@ -639,6 +722,7 @@ exports.createApp = createApp;
 exports.cspNonce = cspNonce;
 exports.dir = dir;
 exports.emitLog = emitLog;
+exports.files = files;
 exports.getEffectiveLocale = getEffectiveLocale;
 exports.getLocales = getLocales;
 exports.getStatusMessage = getStatusMessage;

package/dist/index.d.ts

@@ -75,6 +75,19 @@ type DirParams = Partial<Pick<ResolveFilePathParams, "supportedLocales" | "index
  */
 declare const dir$1: Controller<DirParams>;
 
+type FilesParams = {
+  base: string | string[];
+  path?: string | ((req: Request) => string);
+  extensions?: string[];
+  languages?: (req: Request) => string[];
+  transform?: TransformContent[];
+};
+/**
+ * Serves files from the specified directory path in a locale-aware
+ * fashion after applying optional transforms.
+ */
+declare const files: Controller<string | FilesParams>;
+
 type ErrorController<T = void> = (params: T) => ErrorRequestHandler;
 
 declare const unhandledError: ErrorController;
@@ -1166,4 +1179,4 @@ declare function servePipeableStream(req: Request, res: Response): ({
   pipe
 }: PipeableStream, error?: unknown) => Promise<void>;
 
-export { Controller, DirParams, ErrorController, LangParams, LogEventPayload, LogLevel, LogOptions, Middleware, MiddlewareSet, RenderStatus, ReqCtx, ResolveFilePathParams, TransformContent, build, cli, createApp, cspNonce, dir$1 as dir, emitLog, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang$1 as lang, log, renderStatus, requestEvents, resolveFilePath, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };
+export { Controller, DirParams, ErrorController, FilesParams, LangParams, LogEventPayload, LogLevel, LogOptions, Middleware, MiddlewareSet, RenderStatus, ReqCtx, ResolveFilePathParams, TransformContent, build, cli, createApp, cspNonce, dir$1 as dir, emitLog, files, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang$1 as lang, log, renderStatus, requestEvents, resolveFilePath, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };

package/dist/index.mjs

@@ -98,6 +98,89 @@ const dir = ({ path, name = defaultName, ext = defaultExt, transform, supportedL
   };
 };
 
+const maxLanguages = 3;
+async function resolve(...parts) {
+  let fullPath = join(...parts);
+  try {
+    if ((await lstat(fullPath)).isFile()) return fullPath;
+  } catch {}
+  return null;
+}
+function getLanguageList(req) {
+  let langParam = req.query.lang;
+  if (langParam) return [String(langParam)];
+  let acceptedLanguages = req.acceptsLanguages();
+  let langs = /* @__PURE__ */ new Set();
+  for (let i = 0; i < acceptedLanguages.length && i < maxLanguages; i++) {
+    let s = acceptedLanguages[i];
+    let [lang] = s.split(/[-_]/);
+    if (s === lang) langs.add(s);
+    else {
+      langs.add(s);
+      langs.add(lang);
+    }
+  }
+  return Array.from(langs);
+}
+const defaultExtensions = ["html", "htm"];
+const defaultPath = (req) => req.originalUrl.split("?")[0];
+const defaultLanguages = getLanguageList;
+/**
+* Serves files from the specified directory path in a locale-aware
+* fashion after applying optional transforms.
+*/
+const files = (params) => {
+  let p = typeof params === "string" ? { base: params } : params;
+  let bases = Array.isArray(p.base) ? p.base : [p.base];
+  let exts = p.extensions ?? defaultExtensions;
+  return async (req, res) => {
+    let langs = (p.languages ?? defaultLanguages)(req);
+    let path = typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
+    if (path.includes("../")) {
+      emitLog(req.app, "Invalid path (potential traversal attempt)", { data: { path } });
+      res.status(400).send(await req.app.renderStatus?.(req, res, {
+        code: "invalid_path",
+        path
+      }));
+      return;
+    }
+    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]}`);
+      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]}`);
+    }
+    if (filePath === null) {
+      emitLog(req.app, "Unknown path", { data: { path } });
+      res.status(404).send(await req.app.renderStatus?.(req, res, {
+        code: "unknown_path",
+        path
+      }));
+      return;
+    }
+    if (!p.transform?.length) {
+      res.sendFile(filePath);
+      return;
+    }
+    let content = (await readFile(filePath)).toString();
+    let name = basename(filePath);
+    for (let transform of p.transform) {
+      let result = transform(req, res, {
+        content,
+        path,
+        name
+      });
+      content = result instanceof Promise ? await result : result;
+    }
+    res.type(extname(name).slice(1)).send(content);
+  };
+};
+
 const unhandledError = () => async (err, req, res) => {
   emitLog(req.app, "Unhandled error", {
     level: "error",
@@ -607,4 +690,4 @@ function servePipeableStream(req, res) {
   };
 }
 
-export { build, cli, createApp, cspNonce, dir, emitLog, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang, log, renderStatus, requestEvents, resolveFilePath, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };
+export { build, cli, createApp, cspNonce, dir, emitLog, files, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang, log, renderStatus, requestEvents, resolveFilePath, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };

package/index.ts

@@ -1,4 +1,5 @@
 export * from "./src/controllers/dir.ts";
+export * from "./src/controllers/files.ts";
 export * from "./src/controllers/unhandledError.ts";
 export * from "./src/controllers/unhandledRoute.ts";
 export * from "./src/lib/lang/getEffectiveLocale.ts";

package/package.json

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

package/src/controllers/files.ts

@@ -0,0 +1,158 @@
+import { lstat, readFile } from "node:fs/promises";
+import { basename, extname, join } from "node:path";
+import type { Request } from "express";
+import type { Controller } from "../types/Controller.ts";
+import type { TransformContent } from "../types/TransformContent.ts";
+import { emitLog } from "../utils/emitLog.ts";
+
+const maxLanguages = 3;
+
+async function resolve(...parts: string[]) {
+  let fullPath = join(...parts);
+  try {
+    if ((await lstat(fullPath)).isFile()) return fullPath;
+  } catch {}
+  return null;
+}
+
+// ["en-US", "ru"] > ["en-US", "en", "ru"]
+function getLanguageList(req: Request) {
+  let langParam = req.query.lang;
+
+  if (langParam) return [String(langParam)];
+
+  let acceptedLanguages = req.acceptsLanguages();
+  let langs = new Set<string>();
+
+  for (let i = 0; i < acceptedLanguages.length && i < maxLanguages; i++) {
+    let s = acceptedLanguages[i];
+    let [lang] = s.split(/[-_]/);
+
+    if (s === lang) langs.add(s);
+    else {
+      langs.add(s);
+      langs.add(lang);
+    }
+  }
+
+  return Array.from(langs);
+}
+
+export type FilesParams = {
+  base: string | string[];
+  path?: string | ((req: Request) => string);
+  extensions?: string[];
+  languages?: (req: Request) => string[];
+  transform?: TransformContent[];
+};
+
+const defaultExtensions = ["html", "htm"];
+const defaultPath = (req: Request) => req.originalUrl.split("?")[0];
+const defaultLanguages = getLanguageList;
+
+/**
+ * Serves files from the specified directory path in a locale-aware
+ * fashion after applying optional transforms.
+ */
+export const files: Controller<string | FilesParams> = (params) => {
+  let p: FilesParams = typeof params === "string" ? { base: params } : params;
+
+  let bases = Array.isArray(p.base) ? p.base : [p.base];
+  let exts = p.extensions ?? defaultExtensions;
+
+  return async (req, res) => {
+    let langs = (p.languages ?? defaultLanguages)(req);
+
+    let path =
+      typeof p.path === "string" ? p.path : (p.path ?? defaultPath)(req);
+
+    if (path.includes("../")) {
+      emitLog(req.app, "Invalid path (potential traversal attempt)", {
+        data: { path },
+      });
+
+      res.status(400).send(
+        await req.app.renderStatus?.(req, res, {
+          code: "invalid_path",
+          path,
+        }),
+      );
+
+      return;
+    }
+
+    // path: /x
+    // langs: en, ru
+    let filePath: string | null = null;
+
+    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]}`);
+
+      // /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.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++) {
+        for (let j = 0; j < exts.length && filePath === null; j++)
+          filePath = await resolve(
+            base,
+            `${path}.${langs[i]}`,
+            `index.${exts[j]}`,
+          );
+      }
+
+      // /x/index.en.html /x/index.en.htm /x/index.ru.html /x/index.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, `index.${langs[i]}.${exts[j]}`);
+      }
+
+      // /x/index.html /x/index.htm
+      for (let i = 0; i < exts.length && filePath === null; i++)
+        filePath = await resolve(base, path, `index.${exts[i]}`);
+    }
+
+    if (filePath === null) {
+      emitLog(req.app, "Unknown path", { data: { path } });
+
+      res.status(404).send(
+        await req.app.renderStatus?.(req, res, {
+          code: "unknown_path",
+          path,
+        }),
+      );
+
+      return;
+    }
+
+    if (!p.transform?.length) {
+      res.sendFile(filePath);
+      return;
+    }
+
+    let content = (await readFile(filePath)).toString();
+    let name = basename(filePath);
+
+    for (let transform of p.transform) {
+      let result = transform(req, res, { content, path, name });
+
+      content = result instanceof Promise ? await result : result;
+    }
+
+    res.type(extname(name).slice(1)).send(content);
+  };
+};