appstage 0.3.1 → 0.3.5

package/src/middleware/requestEvents.ts

@@ -1,29 +0,0 @@
-import type { Middleware } from "../types/Middleware.ts";
-import { emitLog } from "../utils/emitLog.ts";
-import { getStatusMessage } from "../utils/getStatusMessage.ts";
-
-/**
- * Adds event handlers, like logging, to essential request phases.
- */
-export const requestEvents: Middleware = () => (req, res, next) => {
-  let finished = false;
-
-  res.on("finish", () => {
-    finished = true;
-
-    emitLog(req.app, getStatusMessage("Finished", res.statusCode), {
-      req,
-      res,
-    });
-  });
-
-  res.on("close", () => {
-    if (!finished)
-      emitLog(req.app, getStatusMessage("Closed", res.statusCode), {
-        req,
-        res,
-      });
-  });
-
-  next();
-};

package/src/scripts/bin.ts

@@ -1,40 +0,0 @@
-#!/usr/bin/env node
-import { hasKey, isKey } from "args-json";
-import { cli } from "./cli.ts";
-
-const availableScriptNames = new Set(["build", "dev", "prod"]);
-
-const nodeEnvMap: Record<string, string> = {
-  dev: "development",
-  prod: "production",
-};
-
-async function run() {
-  let [scriptName, ...args] = process.argv.slice(2);
-
-  if (!availableScriptNames.has(scriptName)) {
-    console.error("Provide a script name: 'build', 'dev', or 'prod'");
-    return;
-  }
-
-  if (scriptName === "build") return await cli(args);
-
-  let nodeEnv = nodeEnvMap[scriptName];
-
-  if (nodeEnv !== undefined) process.env.NODE_ENV = nodeEnv;
-
-  if (args.length !== 0 && args[0] && !isKey(args[0])) {
-    process.env.SERVER_URL = args[0];
-    args.shift();
-  }
-
-  if (!hasKey("--client-dir")) args.push("--client-dir", "src/public/-");
-
-  await cli(
-    nodeEnv === "development"
-      ? ["--clean", "--start", "--watch", ...args]
-      : ["--clean", "--start", "--silent", ...args],
-  );
-}
-
-await run();

package/src/scripts/build.ts

@@ -1,80 +0,0 @@
-import { type ChildProcess, spawn } from "node:child_process";
-import { access } from "node:fs/promises";
-import { formatDuration } from "dateshape";
-import type { BuildParams } from "./types/BuildParams.ts";
-import { buildClient } from "./utils/buildClient.ts";
-import { buildServer } from "./utils/buildServer.ts";
-import { buildServerCSS } from "./utils/buildServerCSS.ts";
-import { createPostbuildPlugins } from "./utils/createPostbuildPlugins.ts";
-
-const envFileNames: Record<string, string[]> = {
-  development: [".env.development", ".env.dev"],
-  production: [".env.production", ".env.prod"],
-};
-
-async function getEnvFiles() {
-  let { NODE_ENV } = process.env;
-  let names = [".env"];
-
-  if (NODE_ENV !== undefined && NODE_ENV in envFileNames)
-    names.push(...envFileNames[NODE_ENV]);
-
-  for (let i = names.length - 1; i >= 0; i--) {
-    try {
-      await access(names[i]);
-    } catch {
-      names.splice(i, 1);
-    }
-  }
-
-  return names;
-}
-
-export async function build(params: BuildParams) {
-  let startTime = Date.now();
-  let log = params.silent ? () => {} : console.log;
-
-  log("Build started");
-
-  let serverProcess: ChildProcess | null = null;
-  let inited = false;
-
-  let nodeArgs = [`${params.serverDir}/server/index.js`];
-  let envFiles: string[] | null = null;
-
-  if (params.useEnvFiles !== false) {
-    envFiles = await getEnvFiles();
-    nodeArgs.unshift(...envFiles.map((file) => `--env-file=${file}`));
-  }
-
-  function handleServerRebuild() {
-    if (serverProcess) {
-      serverProcess.kill();
-      serverProcess = null;
-    }
-
-    if (!inited) {
-      log(`Build completed +${formatDuration(Date.now() - startTime)}`);
-
-      if (envFiles) {
-        for (let envFile of envFiles) log(`Using ${envFile}`);
-      }
-
-      inited = true;
-    }
-
-    if (params.start)
-      serverProcess = spawn("node", nodeArgs, { stdio: "inherit" });
-  }
-
-  let { serverPlugins, serverCSSPlugins } = createPostbuildPlugins(
-    params,
-    handleServerRebuild,
-  );
-
-  await Promise.all([
-    buildServer(params, serverPlugins),
-    buildServerCSS(params, serverCSSPlugins),
-    buildClient(params),
-  ]);
-}

package/src/scripts/cli.ts

@@ -1,43 +0,0 @@
-import { rm } from "node:fs/promises";
-import { Args } from "args-json";
-import { build } from "./build.ts";
-import type { BuildParams } from "./types/BuildParams.ts";
-
-async function clean({ serverDir, clientDir }: BuildParams) {
-  let dirs = [`${serverDir}/server`, `${serverDir}/server-css`, clientDir];
-
-  return Promise.all(
-    dirs.map((dir) => rm(dir, { recursive: true, force: true })),
-  );
-}
-
-export async function cli(input: string[] = []) {
-  let args = new Args(input);
-
-  let clientDir = args.getValue("--client-dir");
-  let serverDir = args.getValue("--server-dir", "dist");
-
-  if (!clientDir) throw new Error("Public assets directory is undefined");
-
-  let params: BuildParams = {
-    serverDir,
-    clientDir,
-    silent: args.hasKey("--silent"),
-    watch: args.hasKey("--watch"),
-    watchServer: args.hasKey("--watch-server"),
-    watchClient: args.hasKey("--watch-client"),
-    start: args.hasKey("--start"),
-    useEnvFiles: !args.isExplicitlyOff("--use-env-files"),
-  };
-
-  if (args.hasKey("--no-auto-entries")) params.entriesPath = null;
-
-  if (args.hasKey("--clean-only")) {
-    await clean(params);
-    return;
-  }
-
-  if (args.hasKey("--clean")) await clean(params);
-
-  await build(params);
-}

package/src/scripts/const/commonBuildOptions.ts

@@ -1,13 +0,0 @@
-import type { BuildOptions } from "esbuild";
-
-export const commonBuildOptions: Partial<BuildOptions> = {
-  format: "cjs",
-  jsx: "automatic",
-  jsxDev: process.env.NODE_ENV === "development",
-  loader: {
-    ".png": "dataurl",
-    ".svg": "dataurl",
-    ".html": "text",
-    ".txt": "text",
-  },
-};

package/src/scripts/const/entryExtensions.ts

@@ -1 +0,0 @@
-export const entryExtensions = ["js", "jsx", "ts", "tsx"];

package/src/scripts/types/BuildParams.ts

@@ -1,22 +0,0 @@
-export type BuildParams = {
-  serverDir: string;
-  clientDir: string;
-  silent?: boolean;
-  watch?: boolean;
-  watchClient?: boolean;
-  watchServer?: boolean;
-  start?: boolean;
-  /**
-   * A file path that the automatically picked entry exports will be
-   * written to.
-   *
-   * Set it to `null` to skip the automatic picking of entry exports.
-   *
-   * @default "src/server/entries.ts"
-   */
-  entriesPath?: string | null;
-  /**
-   * @default true
-   */
-  useEnvFiles?: boolean;
-};

package/src/scripts/utils/buildClient.ts

@@ -1,42 +0,0 @@
-import esbuild, { type BuildOptions, type Plugin } from "esbuild";
-import { commonBuildOptions } from "../const/commonBuildOptions.ts";
-import type { BuildParams } from "../types/BuildParams.ts";
-import { getEntryPoints } from "./getEntryPoints.ts";
-
-const entryClientPaths = ["ui/index", "client/index", "index", "src/index"];
-
-/**
- * Builds the client-side code.
- */
-export async function buildClient(
-  { clientDir, watch, watchClient }: BuildParams,
-  plugins?: Plugin[],
-) {
-  let clientEntries = await getEntryPoints(entryClientPaths);
-
-  let buildOptions: BuildOptions = {
-    ...commonBuildOptions,
-    entryPoints: clientEntries.map(({ path, name }) => ({
-      in: path,
-      out: `${name}/index`,
-    })),
-    bundle: true,
-    splitting: true,
-    format: "esm",
-    outdir: clientDir,
-    minify: process.env.NODE_ENV !== "development",
-    plugins,
-  };
-
-  if (watch || watchClient) {
-    let ctx = await esbuild.context(buildOptions);
-
-    await ctx.watch();
-
-    return async () => {
-      await ctx.dispose();
-    };
-  }
-
-  await esbuild.build(buildOptions);
-}

package/src/scripts/utils/buildServer.ts

@@ -1,36 +0,0 @@
-import esbuild, { type BuildOptions, type Plugin } from "esbuild";
-import { commonBuildOptions } from "../const/commonBuildOptions.ts";
-import type { BuildParams } from "../types/BuildParams.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 setEntriesExport(params);
-
-  let buildOptions: BuildOptions = {
-    ...commonBuildOptions,
-    entryPoints: appServerEntryPoints,
-    bundle: true,
-    splitting: true,
-    outdir: `${serverDir}/server`,
-    platform: "node",
-    format: "esm",
-    packages: "external",
-    plugins,
-  };
-
-  if (watch || watchServer) {
-    let ctx = await esbuild.context(buildOptions);
-
-    await ctx.watch();
-
-    return async () => {
-      await ctx.dispose();
-    };
-  }
-
-  await esbuild.build(buildOptions);
-}

package/src/scripts/utils/buildServerCSS.ts

@@ -1,40 +0,0 @@
-import esbuild, { type BuildOptions, type Plugin } from "esbuild";
-import { commonBuildOptions } from "../const/commonBuildOptions.ts";
-import type { BuildParams } from "../types/BuildParams.ts";
-import { getEntryPoints } from "./getEntryPoints.ts";
-
-const entryServerPaths = ["server", "server/index"];
-
-export async function buildServerCSS(
-  { serverDir, watch, watchServer }: BuildParams,
-  plugins?: Plugin[],
-) {
-  let serverEntries = await getEntryPoints(entryServerPaths);
-
-  let buildOptions: BuildOptions = {
-    ...commonBuildOptions,
-    entryPoints: serverEntries.map(({ name, path }) => ({
-      in: path,
-      out: name,
-    })),
-    bundle: true,
-    splitting: false,
-    outdir: `${serverDir}/server-css`,
-    platform: "node",
-    format: "esm",
-    packages: "external",
-    plugins,
-  };
-
-  if (watch || watchServer) {
-    let ctx = await esbuild.context(buildOptions);
-
-    await ctx.watch();
-
-    return async () => {
-      await ctx.dispose();
-    };
-  }
-
-  await esbuild.build(buildOptions);
-}

package/src/scripts/utils/createPostbuildPlugins.ts

@@ -1,66 +0,0 @@
-import { mkdir, readdir, rename, rm } from "node:fs/promises";
-import type { Plugin } from "esbuild";
-import type { BuildParams } from "../types/BuildParams.ts";
-
-export function createPostbuildPlugins(
-  { serverDir, clientDir }: BuildParams,
-  onServerRebuild: (() => void) | (() => Promise<void>),
-) {
-  let serverPlugins: Plugin[] = [
-    {
-      name: "skip-css",
-      setup(build) {
-        /** @see https://github.com/evanw/esbuild/issues/599#issuecomment-745118158 */
-        build.onLoad({ filter: /\.css$/ }, () => ({ contents: "" }));
-      },
-    },
-    {
-      name: "postbuild-server",
-      setup(build) {
-        build.onEnd(() => {
-          onServerRebuild();
-        });
-      },
-    },
-  ];
-
-  let serverCSSPlugins: Plugin[] = [
-    {
-      name: "postbuild-server-css",
-      setup(build) {
-        build.onEnd(async () => {
-          let dir = `${serverDir}/server-css`;
-
-          try {
-            let files = (await readdir(dir)).filter((name) =>
-              name.endsWith(".css"),
-            );
-
-            if (files.length === 0) return;
-
-            await mkdir(clientDir, { recursive: true });
-
-            await Promise.all(
-              files.map(async (name) => {
-                let dir = `${clientDir}/${name.slice(0, -4)}`;
-
-                await mkdir(dir, { recursive: true });
-                await rename(
-                  `${serverDir}/server-css/${name}`,
-                  `${dir}/index.css`,
-                );
-              }),
-            );
-
-            await rm(dir, { recursive: true, force: true });
-          } catch {}
-        });
-      },
-    },
-  ];
-
-  return {
-    serverPlugins,
-    serverCSSPlugins,
-  };
-}

package/src/scripts/utils/getEntries.ts

@@ -1,22 +0,0 @@
-import { lstat, readdir } from "node:fs/promises";
-import { join } from "node:path";
-
-export async function getEntries() {
-  let cwd = process.cwd();
-
-  try {
-    let list = await readdir(join(cwd, "src/entries"));
-
-    let dirs = await Promise.all(
-      list.map(async (name) => {
-        let itemStat = await lstat(join(cwd, "src/entries", name));
-
-        return itemStat.isDirectory() ? name : undefined;
-      }),
-    );
-
-    return dirs.filter((dir) => dir !== undefined);
-  } catch {
-    return [];
-  }
-}

package/src/scripts/utils/getEntryPoints.ts

@@ -1,25 +0,0 @@
-import { getEntries } from "./getEntries.ts";
-import { getFirstAvailable } from "./getFirstAvailable.ts";
-
-type EntryPoint = {
-  name: string;
-  path: string;
-};
-
-export async function getEntryPoints(
-  path: string | string[],
-): Promise<EntryPoint[]> {
-  let entries = await getEntries();
-
-  return (
-    await Promise.all(
-      entries.map(async (name) => {
-        let resolvedPath = await getFirstAvailable(`src/entries/${name}`, path);
-
-        return resolvedPath === undefined
-          ? undefined
-          : { name, path: resolvedPath };
-      }),
-    )
-  ).filter((item) => item !== undefined);
-}

package/src/scripts/utils/getFirstAvailable.ts

@@ -1,22 +0,0 @@
-import { access } from "node:fs/promises";
-import { join } from "node:path";
-import { entryExtensions } from "../const/entryExtensions.ts";
-
-export async function getFirstAvailable(
-  dirPath: string,
-  path: string | string[],
-) {
-  let paths = Array.isArray(path) ? path : [path];
-
-  for (let filePath of paths) {
-    for (let ext of entryExtensions) {
-      let path = join(process.cwd(), dirPath, `${filePath}.${ext}`);
-
-      try {
-        await access(path);
-
-        return path;
-      } catch {}
-    }
-  }
-}

package/src/scripts/utils/setEntriesExport.ts

@@ -1,30 +0,0 @@
-import { writeFile } from "node:fs/promises";
-import type { BuildParams } from "../types/BuildParams.ts";
-import { getEntryPoints } from "./getEntryPoints.ts";
-import { toImportPath } from "./toImportPath.ts";
-
-export async function setEntriesExport({ entriesPath }: BuildParams) {
-  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    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)".
-// Ignore this file if a custom set of entry exports is required.
-${content}
-`,
-  );
-}

package/src/scripts/utils/toImportPath.ts

@@ -1,12 +0,0 @@
-import { join, posix, relative, sep } from "node:path";
-
-export function toImportPath(relativePath: string, referencePath = ".") {
-  let cwd = process.cwd();
-  let importPath = posix.join(
-    ...relative(join(cwd, referencePath), relativePath).split(sep),
-  );
-
-  if (importPath && !/^\.+\//.test(importPath)) importPath = `./${importPath}`;
-
-  return importPath;
-}

package/src/types/Controller.ts

@@ -1,4 +0,0 @@
-import type { RequestHandler } from "express";
-
-/** Defines a final request handler sending a response */
-export type Controller<T = void> = (params: T) => RequestHandler;

package/src/types/ErrorController.ts

@@ -1,3 +0,0 @@
-import type { ErrorRequestHandler } from "express";
-
-export type ErrorController<T = void> = (params: T) => ErrorRequestHandler;

package/src/types/LogEventPayload.ts

@@ -1,12 +0,0 @@
-import type { Request, Response } from "express";
-import type { LogLevel } from "./LogLevel.ts";
-
-export type LogEventPayload = {
-  timestamp?: number;
-  level?: LogLevel;
-  message?: string | Error;
-  status?: number;
-  req?: Request;
-  res?: Response;
-  data?: unknown;
-};

package/src/types/LogLevel.ts

@@ -1 +0,0 @@
-export type LogLevel = "error" | "debug" | "info" | "warn";

package/src/types/Middleware.ts

@@ -1,7 +0,0 @@
-import type { RequestHandler } from "express";
-
-/**
- * Defines an intermediate request handler performing manipulations
- * with request data without sending a response
- */
-export type Middleware<T = void> = (params: T) => RequestHandler;

package/src/types/MiddlewareSet.ts

@@ -1,3 +0,0 @@
-import type { RequestHandler } from "express";
-
-export type MiddlewareSet<T = void> = (params: T) => RequestHandler[];

package/src/types/RenderStatus.ts

@@ -1,9 +0,0 @@
-import type { Request, Response } from "express";
-
-type SendParam = Parameters<Response["send"]>[0];
-
-export type RenderStatus = (
-  req: Request,
-  res: Response,
-  payload?: unknown,
-) => Promise<SendParam>;

package/src/types/ReqCtx.ts

@@ -1,11 +0,0 @@
-/** Session request data collected on the server via `req.ctx` */
-export type ReqCtx = {
-  /** Request ID */
-  id?: string;
-  /** CSP nonce */
-  nonce?: string;
-  /** When the request started to be handled */
-  startTime?: number;
-  /** User locale */
-  lang?: string;
-};

package/src/types/TransformContent.ts

@@ -1,11 +0,0 @@
-import type { Request, Response } from "express";
-
-export type TransformContent = (
-  req: Request,
-  res: Response,
-  params: {
-    content: string;
-    path?: string;
-    name?: string;
-  },
-) => string | Promise<string>;

package/src/types/express.d.ts

@@ -1,15 +0,0 @@
-import EventEmitter from "node:events";
-import type { RenderStatus } from "../types/RenderStatus.ts";
-import type { ReqCtx } from "./ReqCtx.ts";
-
-declare global {
-  namespace Express {
-    interface Request {
-      ctx: ReqCtx;
-    }
-    interface Application {
-      events?: EventEmitter;
-      renderStatus?: RenderStatus;
-    }
-  }
-}

package/src/types/global.d.ts

@@ -1,19 +0,0 @@
-declare module "*.svg" {
-  let content: string;
-
-  export default content;
-}
-
-declare module "*.txt" {
-  let content: string;
-
-  export default content;
-}
-
-declare module "*.html" {
-  let content: string;
-
-  export default content;
-}
-
-declare module "*.css";