appstage 0.2.10 → 0.2.11

package/dist/index.cjs

@@ -44,86 +44,6 @@ function emitLog(app, message, payload) {
   return app.events?.emit("log", normalizedPayload);
 }
 
-function toLanguage(locale) {
-  return locale.split(/[-_]/)[0];
-}
-
-async function resolveFilePath({ name, dir = ".", lang, supportedLocales = [], ext, index }) {
-  let cwd = process.cwd();
-  let localeSet = new Set(supportedLocales);
-  let langSet = new Set(supportedLocales.map(toLanguage));
-  let availableNames = [name, ...[...localeSet, ...langSet].map((item) => `${name}.${item}`)];
-  let preferredLangNames;
-  if (lang && (!supportedLocales.length || localeSet.has(lang) || langSet.has(lang))) preferredLangNames = [`${name}.${lang}`, `${name}.${toLanguage(lang)}`];
-  let names = new Set(preferredLangNames ? [...preferredLangNames, ...availableNames] : availableNames);
-  let exts = Array.isArray(ext) ? ext : [ext];
-  for (let item of names) for (let itemExt of exts) {
-    let path = (0, node_path.join)(cwd, dir, `${item}${itemExt ? `.${itemExt}` : ""}`);
-    try {
-      await (0, node_fs_promises.access)(path);
-      return path;
-    } catch {}
-  }
-  if (index) for (let item of names) for (let itemExt of exts) {
-    let path = (0, node_path.join)(cwd, dir, item, `index${itemExt ? `.${itemExt}` : ""}`);
-    try {
-      await (0, node_fs_promises.access)(path);
-      return path;
-    } catch {}
-  }
-}
-
-const defaultExt = ["html", "htm"];
-const defaultName = (req) => req.path.split("/").at(-1);
-/**
-* Serves files from the specified directory path in a locale-aware
-* fashion after applying optional transforms.
-*
-* A file ending with `.<lang>.<ext>` is picked first if the `<lang>`
-* part matches `req.ctx.lang`. If the `supportedLocales` array is
-* provided, the `*.<lang>.<ext>` file is picked only if the given
-* array contains `req.ctx.lang`. Otherwise, a file without the locale
-* in its path (`*.<ext>`) is picked.
-*/
-const dir = ({ path, name = defaultName, ext = defaultExt, transform, supportedLocales, index = true }) => {
-  if (typeof path !== "string") throw new Error(`'path' is not a string`);
-  let transformSet = (Array.isArray(transform) ? transform : [transform]).filter((item) => typeof item === "function");
-  return async (req, res) => {
-    let fileName = typeof name === "function" ? name(req, res) : name;
-    emitLog(req.app, `Name: ${JSON.stringify(fileName)}`, {
-      req,
-      res
-    });
-    if (fileName === void 0) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-      return;
-    }
-    let filePath = await resolveFilePath({
-      name: fileName,
-      dir: path,
-      ext,
-      supportedLocales,
-      lang: req.ctx?.lang,
-      index
-    });
-    emitLog(req.app, `Path: ${JSON.stringify(filePath)}`, {
-      req,
-      res
-    });
-    if (!filePath) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-      return;
-    }
-    let content = (await (0, node_fs_promises.readFile)(filePath)).toString();
-    for (let transformItem of transformSet) content = await transformItem(req, res, {
-      content,
-      path: filePath,
-      name: (0, node_path.basename)(filePath, (0, node_path.extname)(filePath))
-    });
-    res.send(content);
-  };
-};
-
 const maxLanguages = 3;
 async function resolve(...parts) {
   let fullPath = (0, node_path.join)(...parts);
@@ -194,16 +114,17 @@ const files = (params) => {
       return;
     }
     let content = (await (0, node_fs_promises.readFile)(filePath)).toString();
-    let name = (0, node_path.basename)(filePath);
+    let ext = (0, node_path.extname)(filePath);
+    let name = (0, node_path.basename)(filePath, ext);
     for (let transform of p.transform) {
       let result = transform(req, res, {
         content,
-        path,
+        path: filePath,
         name
       });
       content = result instanceof Promise ? await result : result;
     }
-    res.type((0, node_path.extname)(name).slice(1)).send(content);
+    res.type(ext.slice(1)).send(content);
   };
 };
 
@@ -226,6 +147,10 @@ const unhandledRoute = () => async (req, res) => {
   res.status(404).send(await req.app.renderStatus?.(req, res, "unhandled_route"));
 };
 
+function toLanguage(locale) {
+  return locale.split(/[-_]/)[0];
+}
+
 function getEffectiveLocale(preferredLocales, supportedLocales) {
   if (!supportedLocales || supportedLocales.length === 0) return void 0;
   if (!preferredLocales || preferredLocales.length === 0) return supportedLocales[0];
@@ -720,7 +645,6 @@ exports.build = build;
 exports.cli = cli;
 exports.createApp = createApp;
 exports.cspNonce = cspNonce;
-exports.dir = dir;
 exports.emitLog = emitLog;
 exports.files = files;
 exports.getEffectiveLocale = getEffectiveLocale;
@@ -732,7 +656,6 @@ exports.lang = lang;
 exports.log = log;
 exports.renderStatus = renderStatus;
 exports.requestEvents = requestEvents;
-exports.resolveFilePath = resolveFilePath;
 exports.serializeState = serializeState;
 exports.servePipeableStream = servePipeableStream;
 exports.toLanguage = toLanguage;

package/dist/index.d.ts

@@ -16,65 +16,6 @@ type TransformContent = (req: Request, res: Response, params: {
   name?: string;
 }) => string | Promise<string>;
 
-type ResolveFilePathParams = {
-  name: string;
-  dir?: string;
-  lang?: string;
-  supportedLocales?: string[]; /** Allowed file extensions. */
-  ext?: string | string[];
-  /**
-   * Whether an index file should be checked if the resolved file name
-   * doesn't correspond to an existing file.
-   *
-   * @defaultValue `true`
-   */
-  index?: boolean;
-};
-declare function resolveFilePath({
-  name,
-  dir,
-  lang,
-  supportedLocales,
-  ext,
-  index
-}: ResolveFilePathParams): Promise<string | undefined>;
-
-type ZeroTransform = false | null | undefined;
-type DirParams = Partial<Pick<ResolveFilePathParams, "supportedLocales" | "index">> & {
-  /** Directory path to serve files from. */path: string;
-  /**
-   * File name.
-   * By default, the portion of `req.path` after the last slash.
-   */
-  name?: string | undefined | ((req: Request, res: Response) => string | undefined);
-  /**
-   * Allowed file extensions.
-   *
-   * @defaultValue `['html', 'htm']`
-   */
-  ext?: ResolveFilePathParams["ext"];
-  /**
-   * Custom transforms applied to the file content.
-   *
-   * Example: Use `injectNonce` from this package to inject the `nonce`
-   * value generated for the current request into the `{{nonce}}`
-   * placeholders in an HTML file.
-   */
-  transform?: TransformContent | ZeroTransform | (TransformContent | ZeroTransform)[];
-  supportedLocales?: string[];
-};
-/**
- * Serves files from the specified directory path in a locale-aware
- * fashion after applying optional transforms.
- *
- * A file ending with `.<lang>.<ext>` is picked first if the `<lang>`
- * part matches `req.ctx.lang`. If the `supportedLocales` array is
- * provided, the `*.<lang>.<ext>` file is picked only if the given
- * array contains `req.ctx.lang`. Otherwise, a file without the locale
- * in its path (`*.<ext>`) is picked.
- */
-declare const dir$1: Controller<DirParams>;
-
 type FilesParams = {
   base: string | string[];
   path?: string | ((req: Request) => string);
@@ -136,7 +77,7 @@ type LangParams = {
   shouldRedirect?: boolean;
   langCookieOptions?: CookieOptions;
 };
-declare const lang$1: Middleware<LangParams | void>;
+declare const lang: Middleware<LangParams | void>;
 
 /**
  * Adds event handlers, like logging, to essential request phases.
@@ -1179,4 +1120,4 @@ declare function servePipeableStream(req: Request, res: Response): ({
   pipe
 }: PipeableStream, error?: unknown) => Promise<void>;
 
-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 };
+export { Controller, ErrorController, FilesParams, LangParams, LogEventPayload, LogLevel, LogOptions, Middleware, MiddlewareSet, RenderStatus, ReqCtx, TransformContent, build, cli, createApp, cspNonce, emitLog, files, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang, log, renderStatus, requestEvents, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };

package/dist/index.mjs

@@ -18,86 +18,6 @@ function emitLog(app, message, payload) {
   return app.events?.emit("log", normalizedPayload);
 }
 
-function toLanguage(locale) {
-  return locale.split(/[-_]/)[0];
-}
-
-async function resolveFilePath({ name, dir = ".", lang, supportedLocales = [], ext, index }) {
-  let cwd = process.cwd();
-  let localeSet = new Set(supportedLocales);
-  let langSet = new Set(supportedLocales.map(toLanguage));
-  let availableNames = [name, ...[...localeSet, ...langSet].map((item) => `${name}.${item}`)];
-  let preferredLangNames;
-  if (lang && (!supportedLocales.length || localeSet.has(lang) || langSet.has(lang))) preferredLangNames = [`${name}.${lang}`, `${name}.${toLanguage(lang)}`];
-  let names = new Set(preferredLangNames ? [...preferredLangNames, ...availableNames] : availableNames);
-  let exts = Array.isArray(ext) ? ext : [ext];
-  for (let item of names) for (let itemExt of exts) {
-    let path = join(cwd, dir, `${item}${itemExt ? `.${itemExt}` : ""}`);
-    try {
-      await access(path);
-      return path;
-    } catch {}
-  }
-  if (index) for (let item of names) for (let itemExt of exts) {
-    let path = join(cwd, dir, item, `index${itemExt ? `.${itemExt}` : ""}`);
-    try {
-      await access(path);
-      return path;
-    } catch {}
-  }
-}
-
-const defaultExt = ["html", "htm"];
-const defaultName = (req) => req.path.split("/").at(-1);
-/**
-* Serves files from the specified directory path in a locale-aware
-* fashion after applying optional transforms.
-*
-* A file ending with `.<lang>.<ext>` is picked first if the `<lang>`
-* part matches `req.ctx.lang`. If the `supportedLocales` array is
-* provided, the `*.<lang>.<ext>` file is picked only if the given
-* array contains `req.ctx.lang`. Otherwise, a file without the locale
-* in its path (`*.<ext>`) is picked.
-*/
-const dir = ({ path, name = defaultName, ext = defaultExt, transform, supportedLocales, index = true }) => {
-  if (typeof path !== "string") throw new Error(`'path' is not a string`);
-  let transformSet = (Array.isArray(transform) ? transform : [transform]).filter((item) => typeof item === "function");
-  return async (req, res) => {
-    let fileName = typeof name === "function" ? name(req, res) : name;
-    emitLog(req.app, `Name: ${JSON.stringify(fileName)}`, {
-      req,
-      res
-    });
-    if (fileName === void 0) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-      return;
-    }
-    let filePath = await resolveFilePath({
-      name: fileName,
-      dir: path,
-      ext,
-      supportedLocales,
-      lang: req.ctx?.lang,
-      index
-    });
-    emitLog(req.app, `Path: ${JSON.stringify(filePath)}`, {
-      req,
-      res
-    });
-    if (!filePath) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-      return;
-    }
-    let content = (await readFile(filePath)).toString();
-    for (let transformItem of transformSet) content = await transformItem(req, res, {
-      content,
-      path: filePath,
-      name: basename(filePath, extname(filePath))
-    });
-    res.send(content);
-  };
-};
-
 const maxLanguages = 3;
 async function resolve(...parts) {
   let fullPath = join(...parts);
@@ -168,16 +88,17 @@ const files = (params) => {
       return;
     }
     let content = (await readFile(filePath)).toString();
-    let name = basename(filePath);
+    let ext = extname(filePath);
+    let name = basename(filePath, ext);
     for (let transform of p.transform) {
       let result = transform(req, res, {
         content,
-        path,
+        path: filePath,
         name
       });
       content = result instanceof Promise ? await result : result;
     }
-    res.type(extname(name).slice(1)).send(content);
+    res.type(ext.slice(1)).send(content);
   };
 };
 
@@ -200,6 +121,10 @@ const unhandledRoute = () => async (req, res) => {
   res.status(404).send(await req.app.renderStatus?.(req, res, "unhandled_route"));
 };
 
+function toLanguage(locale) {
+  return locale.split(/[-_]/)[0];
+}
+
 function getEffectiveLocale(preferredLocales, supportedLocales) {
   if (!supportedLocales || supportedLocales.length === 0) return void 0;
   if (!preferredLocales || preferredLocales.length === 0) return supportedLocales[0];
@@ -690,4 +615,4 @@ function servePipeableStream(req, res) {
   };
 }
 
-export { build, cli, createApp, cspNonce, dir, emitLog, files, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang, log, renderStatus, requestEvents, resolveFilePath, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };
+export { build, cli, createApp, cspNonce, emitLog, files, getEffectiveLocale, getLocales, getStatusMessage, init, injectNonce, lang, log, renderStatus, requestEvents, serializeState, servePipeableStream, toLanguage, unhandledError, unhandledRoute };

package/index.ts

@@ -1,4 +1,3 @@
-export * from "./src/controllers/dir.ts";
 export * from "./src/controllers/files.ts";
 export * from "./src/controllers/unhandledError.ts";
 export * from "./src/controllers/unhandledRoute.ts";
@@ -27,6 +26,5 @@ export * from "./src/utils/emitLog.ts";
 export * from "./src/utils/getStatusMessage.ts";
 export * from "./src/utils/injectNonce.ts";
 export * from "./src/utils/renderStatus.ts";
-export * from "./src/utils/resolveFilePath.ts";
 export * from "./src/utils/serializeState.ts";
 export * from "./src/utils/servePipeableStream.ts";

package/package.json

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

package/src/controllers/files.ts

@@ -81,10 +81,10 @@ export const files: Controller<string | FilesParams> = (params) => {
       return;
     }
 
-    // path: /x
-    // langs: en, ru
     let filePath: string | null = null;
 
+    // path: /x
+    // langs: en, ru
     for (let k = 0; k < bases.length && filePath === null; k++) {
       let base = bases[k];
 
@@ -145,14 +145,15 @@ export const files: Controller<string | FilesParams> = (params) => {
     }
 
     let content = (await readFile(filePath)).toString();
-    let name = basename(filePath);
+    let ext = extname(filePath);
+    let name = basename(filePath, ext);
 
     for (let transform of p.transform) {
-      let result = transform(req, res, { content, path, name });
+      let result = transform(req, res, { content, path: filePath, name });
 
       content = result instanceof Promise ? await result : result;
     }
 
-    res.type(extname(name).slice(1)).send(content);
+    res.type(ext.slice(1)).send(content);
   };
 };

package/src/controllers/dir.ts

@@ -1,119 +0,0 @@
-import { readFile } from "node:fs/promises";
-import { basename, extname } from "node:path";
-import type { Request, Response } from "express";
-import type { Controller } from "../types/Controller.ts";
-import type { TransformContent } from "../types/TransformContent.ts";
-import { emitLog } from "../utils/emitLog.ts";
-import {
-  type ResolveFilePathParams,
-  resolveFilePath,
-} from "../utils/resolveFilePath.ts";
-
-const defaultExt = ["html", "htm"];
-const defaultName = (req: Request) => req.path.split("/").at(-1);
-
-type ZeroTransform = false | null | undefined;
-
-export type DirParams = Partial<
-  Pick<ResolveFilePathParams, "supportedLocales" | "index">
-> & {
-  /** Directory path to serve files from. */
-  path: string;
-  /**
-   * File name.
-   * By default, the portion of `req.path` after the last slash.
-   */
-  name?:
-    | string
-    | undefined
-    | ((req: Request, res: Response) => string | undefined);
-  /**
-   * Allowed file extensions.
-   *
-   * @defaultValue `['html', 'htm']`
-   */
-  ext?: ResolveFilePathParams["ext"];
-  /**
-   * Custom transforms applied to the file content.
-   *
-   * Example: Use `injectNonce` from this package to inject the `nonce`
-   * value generated for the current request into the `{{nonce}}`
-   * placeholders in an HTML file.
-   */
-  transform?:
-    | TransformContent
-    | ZeroTransform
-    | (TransformContent | ZeroTransform)[];
-  supportedLocales?: string[];
-};
-
-/**
- * Serves files from the specified directory path in a locale-aware
- * fashion after applying optional transforms.
- *
- * A file ending with `.<lang>.<ext>` is picked first if the `<lang>`
- * part matches `req.ctx.lang`. If the `supportedLocales` array is
- * provided, the `*.<lang>.<ext>` file is picked only if the given
- * array contains `req.ctx.lang`. Otherwise, a file without the locale
- * in its path (`*.<ext>`) is picked.
- */
-export const dir: Controller<DirParams> = ({
-  path,
-  name = defaultName,
-  ext = defaultExt,
-  transform,
-  supportedLocales,
-  index = true,
-}) => {
-  if (typeof path !== "string") throw new Error(`'path' is not a string`);
-
-  let transformSet = (
-    Array.isArray(transform) ? transform : [transform]
-  ).filter((item) => typeof item === "function");
-
-  return async (req, res) => {
-    let fileName = typeof name === "function" ? name(req, res) : name;
-
-    emitLog(req.app, `Name: ${JSON.stringify(fileName)}`, {
-      req,
-      res,
-    });
-
-    if (fileName === undefined) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-
-      return;
-    }
-
-    let filePath = await resolveFilePath({
-      name: fileName,
-      dir: path,
-      ext,
-      supportedLocales,
-      lang: req.ctx?.lang,
-      index,
-    });
-
-    emitLog(req.app, `Path: ${JSON.stringify(filePath)}`, {
-      req,
-      res,
-    });
-
-    if (!filePath) {
-      res.status(404).send(await req.app.renderStatus?.(req, res));
-
-      return;
-    }
-
-    let content = (await readFile(filePath)).toString();
-
-    for (let transformItem of transformSet)
-      content = await transformItem(req, res, {
-        content,
-        path: filePath,
-        name: basename(filePath, extname(filePath)),
-      });
-
-    res.send(content);
-  };
-};

package/src/utils/resolveFilePath.ts

@@ -1,78 +0,0 @@
-import { access } from "node:fs/promises";
-import { join } from "node:path";
-import { toLanguage } from "../lib/lang/toLanguage.ts";
-
-export type ResolveFilePathParams = {
-  name: string;
-  dir?: string;
-  lang?: string;
-  supportedLocales?: string[];
-  /** Allowed file extensions. */
-  ext?: string | string[];
-  /**
-   * Whether an index file should be checked if the resolved file name
-   * doesn't correspond to an existing file.
-   *
-   * @defaultValue `true`
-   */
-  index?: boolean;
-};
-
-export async function resolveFilePath({
-  name,
-  dir = ".",
-  lang,
-  supportedLocales = [],
-  ext,
-  index,
-}: ResolveFilePathParams) {
-  let cwd = process.cwd();
-
-  let localeSet = new Set(supportedLocales);
-  let langSet = new Set(supportedLocales.map(toLanguage));
-
-  let availableNames = [
-    name,
-    ...[...localeSet, ...langSet].map((item) => `${name}.${item}`),
-  ];
-
-  let preferredLangNames: string[] | undefined;
-
-  if (
-    lang &&
-    (!supportedLocales.length || localeSet.has(lang) || langSet.has(lang))
-  )
-    preferredLangNames = [`${name}.${lang}`, `${name}.${toLanguage(lang)}`];
-
-  let names = new Set(
-    preferredLangNames
-      ? [...preferredLangNames, ...availableNames]
-      : availableNames,
-  );
-
-  let exts = Array.isArray(ext) ? ext : [ext];
-
-  for (let item of names) {
-    for (let itemExt of exts) {
-      let path = join(cwd, dir, `${item}${itemExt ? `.${itemExt}` : ""}`);
-
-      try {
-        await access(path);
-        return path;
-      } catch {}
-    }
-  }
-
-  if (index) {
-    for (let item of names) {
-      for (let itemExt of exts) {
-        let path = join(cwd, dir, item, `index${itemExt ? `.${itemExt}` : ""}`);
-
-        try {
-          await access(path);
-          return path;
-        } catch {}
-      }
-    }
-  }
-}