@prairielearn/compiled-assets 3.0.14 → 3.0.16

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @prairielearn/compiled-assets
 
+## 3.0.16
+
+### Patch Changes
+
+- deb4635: Drop `express` dependency
+
+## 3.0.15
+
+### Patch Changes
+
+- cec09b5: Upgrade all JavaScript dependencies
+- Updated dependencies [cec09b5]
+  - @prairielearn/html@4.0.14
+
 ## 3.0.14
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { RequestHandler } from 'express';
+import { type IncomingMessage, type ServerResponse } from 'node:http';
 import { type HtmlSafeString } from '@prairielearn/html';
 type AssetsManifest = Record<string, string>;
 export interface CompiledAssetsOptions {
@@ -21,7 +21,7 @@ export declare function init(newOptions: Partial<CompiledAssetsOptions>): Promis
  */
 export declare function close(): Promise<void>;
 export declare function assertConfigured(): void;
-export declare function handler(): RequestHandler;
+export declare function handler(): ((req: any, res: any, next: any) => any) | ((req: IncomingMessage, res: ServerResponse) => void);
 export declare function compiledScriptPath(sourceFile: string): string;
 export declare function compiledStylesheetPath(sourceFile: string): string;
 export declare function compiledScriptTag(sourceFile: string): HtmlSafeString;

package/dist/index.js

@@ -1,4 +1,4 @@
-import http from 'node:http';
+import http, {} from 'node:http';
 import path from 'path';
 import esbuild, {} from 'esbuild';
 import expressStaticGzip from 'express-static-gzip';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,OAAO,EAAE,EAAiB,MAAM,SAAS,CAAC;AAEjD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAuB,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE/D,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IAC1C,eAAe,EAAE,UAAU;IAC3B,cAAc,EAAE,gBAAgB;IAChC,UAAU,EAAE,SAAS;CACtB,CAAC;AAmBF,IAAI,OAAO,GAAoC,EAAE,GAAG,eAAe,EAAE,CAAC;AACtE,IAAI,cAAc,GAAgC,IAAI,CAAC;AACvD,IAAI,aAAa,GAA+B,IAAI,CAAC;AACrD,IAAI,mBAAmB,GAAoB,IAAI,CAAC;AAEhD,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,UAA0C;IACnE,OAAO,GAAG;QACR,GAAG,eAAe;QAClB,GAAG,UAAU;KACd,CAAC;IAEF,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,UAAU,IAAI,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,6CAA6C;QAC7C,EAAE;QACF,0EAA0E;QAC1E,8DAA8D;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,EAAE,uBAAuB,CAAC,CAAC;QACpF,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAE7C,wEAAwE;QACxE,oCAAoC;QACpC,mBAAmB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QAExF,cAAc,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC;YACrC,WAAW,EAAE,WAAW;YACxB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,MAAM;YACd,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,MAAM;aACjB;YACD,OAAO,EAAE,OAAO,CAAC,eAAe;YAChC,MAAM,EAAE,OAAO,CAAC,cAAc;YAC9B,UAAU,EAAE,cAAc;SAC3B,CAAC,CAAC;QAEH,aAAa,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK;IACzB,cAAc,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,gBAAgB,EAAE,CAAC;IAEnB,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;QAClB,0EAA0E;QAC1E,sEAAsE;QACtE,6CAA6C;QAC7C,OAAO,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE;YAChD,YAAY,EAAE,IAAI;YAClB,2CAA2C;YAC3C,eAAe,EAAE,CAAC,IAAI,CAAC;YACvB,WAAW,EAAE;gBACX,MAAM,EAAE,UAAU;gBAClB,SAAS,EAAE,IAAI;aAChB;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC;IAE/B,6EAA6E;IAC7E,2BAA2B;IAC3B,OAAO,UAAU,GAAG,EAAE,GAAG;QACvB,2EAA2E;QAC3E,6CAA6C;QAC7C,mFAAmF;QACnF,wDAAwD;QACxD,4EAA4E;QAC5E,oEAAoE;QACpE,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;QAC3B,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAClC,OAAO,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC3B;YACE,QAAQ,EAAE,WAAW;YACrB,IAAI;YACJ,IAAI,EAAE,GAAG,CAAC,GAAG;YACb,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,OAAO;SACR,EACD,CAAC,QAAQ,EAAE,EAAE;YACX,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC5D,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,CAAC,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC;AAED,IAAI,cAAc,GAA0B,IAAI,CAAC;AACjD,SAAS,YAAY;IACnB,gBAAgB,EAAE,CAAC;IAEnB,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QACxE,cAAc,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAmB,CAAC;IACnE,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,YAAY,CAAC,IAA+B,EAAE,UAAkB;IACvE,gBAAgB,EAAE,CAAC;IACnB,MAAM,cAAc,GAAG,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC;IAE/C,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,2EAA2E;QAC3E,2EAA2E;QAC3E,2EAA2E;QAC3E,gDAAgD;QAChD,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,cAAc,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,WAAW,UAAU,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;IAChC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,WAAW,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAkB;IACnD,OAAO,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAkB;IACvD,OAAO,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO,IAAI,CAAA,gBAAgB,kBAAkB,CAAC,UAAU,CAAC,aAAa,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACtD,OAAO,IAAI,CAAA,gCAAgC,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC;AACtF,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,eAAuB,EAAE,cAAsB;IACxE,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAEnC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAClF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC;QACtC,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,MAAM;SACjB;QACD,UAAU,EAAE,qBAAqB;QACjC,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,cAAc;QACtB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC,QAAQ,CAAC;AAC9B,CAAC;AAED,SAAS,YAAY,CACnB,QAAkB,EAClB,eAAuB,EACvB,cAAsB;IAEtB,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;QAC9D,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,eAAuB,EACvB,cAAsB;IAEtB,yEAAyE;IACzE,MAAM,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAEhC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAE3C,OAAO,QAAQ,CAAC;AAClB,CAAC","sourcesContent":["import http from 'node:http';\nimport path from 'path';\n\nimport esbuild, { type Metafile } from 'esbuild';\nimport type { RequestHandler } from 'express';\nimport expressStaticGzip from 'express-static-gzip';\nimport fs from 'fs-extra';\nimport { globby } from 'globby';\n\nimport { type HtmlSafeString, html } from '@prairielearn/html';\n\nconst DEFAULT_OPTIONS = {\n  dev: process.env.NODE_ENV !== 'production',\n  sourceDirectory: './assets',\n  buildDirectory: './public/build',\n  publicPath: '/build/',\n};\n\ntype AssetsManifest = Record<string, string>;\n\nexport interface CompiledAssetsOptions {\n  /**\n   * Whether the app is running in dev mode. If dev mode is enabled, then\n   * assets will be built on the fly as they're requested. Otherwise, assets\n   * should have been pre-compiled to the `buildDirectory` directory.\n   */\n  dev?: boolean;\n  /** Root directory of assets. */\n  sourceDirectory?: string;\n  /** Directory where the built assets will be output to. */\n  buildDirectory?: string;\n  /** The path that assets will be served from, e.g. `/build/`. */\n  publicPath?: string;\n}\n\nlet options: Required<CompiledAssetsOptions> = { ...DEFAULT_OPTIONS };\nlet esbuildContext: esbuild.BuildContext | null = null;\nlet esbuildServer: esbuild.ServeResult | null = null;\nlet relativeSourcePaths: string[] | null = null;\n\nexport async function init(newOptions: Partial<CompiledAssetsOptions>): Promise<void> {\n  options = {\n    ...DEFAULT_OPTIONS,\n    ...newOptions,\n  };\n\n  if (!options.publicPath.endsWith('/')) {\n    options.publicPath += '/';\n  }\n\n  if (options.dev) {\n    // Use esbuild's asset server in development.\n    //\n    // Note that esbuild doesn't support globs, so the server will not pick up\n    // new entrypoints that are added while the server is running.\n    const sourceGlob = path.join(options.sourceDirectory, '*', '*.{js,ts,jsx,tsx,css}');\n    const sourcePaths = await globby(sourceGlob);\n\n    // Save the result of globbing for the source paths so that we can later\n    // check if a given filename exists.\n    relativeSourcePaths = sourcePaths.map((p) => path.relative(options.sourceDirectory, p));\n\n    esbuildContext = await esbuild.context({\n      entryPoints: sourcePaths,\n      target: 'es2017',\n      format: 'iife',\n      sourcemap: 'inline',\n      bundle: true,\n      write: false,\n      loader: {\n        '.woff': 'file',\n        '.woff2': 'file',\n      },\n      outbase: options.sourceDirectory,\n      outdir: options.buildDirectory,\n      entryNames: '[dir]/[name]',\n    });\n\n    esbuildServer = await esbuildContext.serve({ host: '0.0.0.0' });\n  }\n}\n\n/**\n * Shuts down the development assets compiler if it is running.\n */\nexport async function close() {\n  esbuildContext?.dispose();\n}\n\nexport function assertConfigured(): void {\n  if (!options) {\n    throw new Error('@prairielearn/compiled-assets was not configured');\n  }\n}\n\nexport function handler(): RequestHandler {\n  assertConfigured();\n\n  if (!options?.dev) {\n    // We're running in production: serve all assets from the build directory.\n    // Set headers to cache for as long as possible, since the assets will\n    // include content hashes in their filenames.\n    return expressStaticGzip(options?.buildDirectory, {\n      enableBrotli: true,\n      // Prefer Brotli if the client supports it.\n      orderPreference: ['br'],\n      serveStatic: {\n        maxAge: '31557600',\n        immutable: true,\n      },\n    });\n  }\n\n  if (!esbuildServer) {\n    throw new Error('esbuild server not initialized');\n  }\n\n  const { port } = esbuildServer;\n\n  // We're running in dev mode, so we need to boot up esbuild to start building\n  // and watching our assets.\n  return function (req, res) {\n    // esbuild will reject requests that come from hosts other than the host on\n    // which the esbuild dev server is listening:\n    // https://github.com/evanw/esbuild/commit/de85afd65edec9ebc44a11e245fd9e9a2e99760d\n    // https://github.com/evanw/esbuild/releases/tag/v0.25.0\n    // We work around this by modifying the request headers to make it look like\n    // the request is coming from localhost, which esbuild won't reject.\n    const headers = structuredClone(req.headers);\n    headers.host = 'localhost';\n    delete headers['x-forwarded-for'];\n    delete headers['x-forwarded-host'];\n    delete headers['x-forwarded-proto'];\n    delete headers['referer'];\n\n    const proxyReq = http.request(\n      {\n        hostname: '127.0.0.1',\n        port,\n        path: req.url,\n        method: req.method,\n        headers,\n      },\n      (proxyRes) => {\n        res.writeHead(proxyRes.statusCode ?? 500, proxyRes.headers);\n        proxyRes.pipe(res, { end: true });\n      },\n    );\n    req.pipe(proxyReq, { end: true });\n  };\n}\n\nlet cachedManifest: AssetsManifest | null = null;\nfunction readManifest(): AssetsManifest {\n  assertConfigured();\n\n  if (!cachedManifest) {\n    const manifestPath = path.join(options.buildDirectory, 'manifest.json');\n    cachedManifest = fs.readJSONSync(manifestPath) as AssetsManifest;\n  }\n\n  return cachedManifest;\n}\n\nfunction compiledPath(type: 'scripts' | 'stylesheets', sourceFile: string): string {\n  assertConfigured();\n  const sourceFilePath = `${type}/${sourceFile}`;\n\n  if (options.dev) {\n    // To ensure that errors that would be raised in production are also raised\n    // in development, we'll check for the existence of the asset file on disk.\n    // This mirrors the production check of the file in the manifest: if a file\n    // exists on disk, it should be in the manifest.\n    if (!relativeSourcePaths?.find((p) => p === sourceFilePath)) {\n      throw new Error(`Unknown ${type} asset: ${sourceFile}`);\n    }\n\n    return options.publicPath + sourceFilePath.replace(/\\.(js|ts)x?$/, '.js');\n  }\n\n  const manifest = readManifest();\n  const assetPath = manifest[sourceFilePath];\n  if (!assetPath) {\n    throw new Error(`Unknown ${type} asset: ${sourceFile}`);\n  }\n\n  return options.publicPath + assetPath;\n}\n\nexport function compiledScriptPath(sourceFile: string): string {\n  return compiledPath('scripts', sourceFile);\n}\n\nexport function compiledStylesheetPath(sourceFile: string): string {\n  return compiledPath('stylesheets', sourceFile);\n}\n\nexport function compiledScriptTag(sourceFile: string): HtmlSafeString {\n  return html`<script src=\"${compiledScriptPath(sourceFile)}\"></script>`;\n}\n\nexport function compiledStylesheetTag(sourceFile: string): HtmlSafeString {\n  return html`<link rel=\"stylesheet\" href=\"${compiledStylesheetPath(sourceFile)}\" />`;\n}\n\nasync function buildAssets(sourceDirectory: string, buildDirectory: string) {\n  await fs.ensureDir(buildDirectory);\n\n  const files = await globby(path.join(sourceDirectory, '*/*.{js,jsx,ts,tsx,css}'));\n  const buildResult = await esbuild.build({\n    entryPoints: files,\n    target: 'es2017',\n    format: 'iife',\n    sourcemap: 'linked',\n    bundle: true,\n    minify: true,\n    loader: {\n      '.woff': 'file',\n      '.woff2': 'file',\n    },\n    entryNames: '[dir]/[name]-[hash]',\n    outbase: sourceDirectory,\n    outdir: buildDirectory,\n    metafile: true,\n  });\n\n  return buildResult.metafile;\n}\n\nfunction makeManifest(\n  metafile: Metafile,\n  sourceDirectory: string,\n  buildDirectory: string,\n): Record<string, string> {\n  const manifest: Record<string, string> = {};\n  Object.entries(metafile.outputs).forEach(([outputPath, meta]) => {\n    if (!meta.entryPoint) return;\n\n    const entryPath = path.relative(sourceDirectory, meta.entryPoint);\n    const assetPath = path.relative(buildDirectory, outputPath);\n    manifest[entryPath] = assetPath;\n  });\n  return manifest;\n}\n\nexport async function build(\n  sourceDirectory: string,\n  buildDirectory: string,\n): Promise<AssetsManifest> {\n  // Remove existing assets to ensure that no stale assets are left behind.\n  await fs.remove(buildDirectory);\n\n  const metafile = await buildAssets(sourceDirectory, buildDirectory);\n  const manifest = makeManifest(metafile, sourceDirectory, buildDirectory);\n  const manifestPath = path.join(buildDirectory, 'manifest.json');\n  await fs.writeJSON(manifestPath, manifest);\n\n  return manifest;\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,EAA6C,MAAM,WAAW,CAAC;AAC5E,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,OAAO,EAAE,EAAiB,MAAM,SAAS,CAAC;AACjD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAuB,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE/D,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IAC1C,eAAe,EAAE,UAAU;IAC3B,cAAc,EAAE,gBAAgB;IAChC,UAAU,EAAE,SAAS;CACtB,CAAC;AAmBF,IAAI,OAAO,GAAoC,EAAE,GAAG,eAAe,EAAE,CAAC;AACtE,IAAI,cAAc,GAAgC,IAAI,CAAC;AACvD,IAAI,aAAa,GAA+B,IAAI,CAAC;AACrD,IAAI,mBAAmB,GAAoB,IAAI,CAAC;AAEhD,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,UAA0C;IACnE,OAAO,GAAG;QACR,GAAG,eAAe;QAClB,GAAG,UAAU;KACd,CAAC;IAEF,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,UAAU,IAAI,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,6CAA6C;QAC7C,EAAE;QACF,0EAA0E;QAC1E,8DAA8D;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,EAAE,uBAAuB,CAAC,CAAC;QACpF,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAE7C,wEAAwE;QACxE,oCAAoC;QACpC,mBAAmB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QAExF,cAAc,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC;YACrC,WAAW,EAAE,WAAW;YACxB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,MAAM;YACd,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,MAAM;aACjB;YACD,OAAO,EAAE,OAAO,CAAC,eAAe;YAChC,MAAM,EAAE,OAAO,CAAC,cAAc;YAC9B,UAAU,EAAE,cAAc;SAC3B,CAAC,CAAC;QAEH,aAAa,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK;IACzB,cAAc,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,gBAAgB,EAAE,CAAC;IAEnB,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;QAClB,0EAA0E;QAC1E,sEAAsE;QACtE,6CAA6C;QAC7C,OAAO,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE;YAChD,YAAY,EAAE,IAAI;YAClB,2CAA2C;YAC3C,eAAe,EAAE,CAAC,IAAI,CAAC;YACvB,WAAW,EAAE;gBACX,MAAM,EAAE,UAAU;gBAClB,SAAS,EAAE,IAAI;aAChB;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC;IAE/B,6EAA6E;IAC7E,2BAA2B;IAC3B,OAAO,UAAU,GAAoB,EAAE,GAAmB;QACxD,2EAA2E;QAC3E,6CAA6C;QAC7C,mFAAmF;QACnF,wDAAwD;QACxD,4EAA4E;QAC5E,oEAAoE;QACpE,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;QAC3B,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAClC,OAAO,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC3B;YACE,QAAQ,EAAE,WAAW;YACrB,IAAI;YACJ,IAAI,EAAE,GAAG,CAAC,GAAG;YACb,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,OAAO;SACR,EACD,CAAC,QAAQ,EAAE,EAAE;YACX,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC5D,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,CAAC,CACF,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC;AACJ,CAAC;AAED,IAAI,cAAc,GAA0B,IAAI,CAAC;AACjD,SAAS,YAAY;IACnB,gBAAgB,EAAE,CAAC;IAEnB,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QACxE,cAAc,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,CAAmB,CAAC;IACnE,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,YAAY,CAAC,IAA+B,EAAE,UAAkB;IACvE,gBAAgB,EAAE,CAAC;IACnB,MAAM,cAAc,GAAG,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC;IAE/C,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,2EAA2E;QAC3E,2EAA2E;QAC3E,2EAA2E;QAC3E,gDAAgD;QAChD,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,cAAc,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,WAAW,UAAU,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;IAChC,MAAM,SAAS,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,WAAW,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAkB;IACnD,OAAO,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAkB;IACvD,OAAO,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO,IAAI,CAAA,gBAAgB,kBAAkB,CAAC,UAAU,CAAC,aAAa,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACtD,OAAO,IAAI,CAAA,gCAAgC,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC;AACtF,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,eAAuB,EAAE,cAAsB;IACxE,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAEnC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAClF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC;QACtC,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE;YACN,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,MAAM;SACjB;QACD,UAAU,EAAE,qBAAqB;QACjC,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,cAAc;QACtB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC,QAAQ,CAAC;AAC9B,CAAC;AAED,SAAS,YAAY,CACnB,QAAkB,EAClB,eAAuB,EACvB,cAAsB;IAEtB,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;QAC9D,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5D,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,eAAuB,EACvB,cAAsB;IAEtB,yEAAyE;IACzE,MAAM,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAEhC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAE3C,OAAO,QAAQ,CAAC;AAClB,CAAC","sourcesContent":["import http, { type IncomingMessage, type ServerResponse } from 'node:http';\nimport path from 'path';\n\nimport esbuild, { type Metafile } from 'esbuild';\nimport expressStaticGzip from 'express-static-gzip';\nimport fs from 'fs-extra';\nimport { globby } from 'globby';\n\nimport { type HtmlSafeString, html } from '@prairielearn/html';\n\nconst DEFAULT_OPTIONS = {\n  dev: process.env.NODE_ENV !== 'production',\n  sourceDirectory: './assets',\n  buildDirectory: './public/build',\n  publicPath: '/build/',\n};\n\ntype AssetsManifest = Record<string, string>;\n\nexport interface CompiledAssetsOptions {\n  /**\n   * Whether the app is running in dev mode. If dev mode is enabled, then\n   * assets will be built on the fly as they're requested. Otherwise, assets\n   * should have been pre-compiled to the `buildDirectory` directory.\n   */\n  dev?: boolean;\n  /** Root directory of assets. */\n  sourceDirectory?: string;\n  /** Directory where the built assets will be output to. */\n  buildDirectory?: string;\n  /** The path that assets will be served from, e.g. `/build/`. */\n  publicPath?: string;\n}\n\nlet options: Required<CompiledAssetsOptions> = { ...DEFAULT_OPTIONS };\nlet esbuildContext: esbuild.BuildContext | null = null;\nlet esbuildServer: esbuild.ServeResult | null = null;\nlet relativeSourcePaths: string[] | null = null;\n\nexport async function init(newOptions: Partial<CompiledAssetsOptions>): Promise<void> {\n  options = {\n    ...DEFAULT_OPTIONS,\n    ...newOptions,\n  };\n\n  if (!options.publicPath.endsWith('/')) {\n    options.publicPath += '/';\n  }\n\n  if (options.dev) {\n    // Use esbuild's asset server in development.\n    //\n    // Note that esbuild doesn't support globs, so the server will not pick up\n    // new entrypoints that are added while the server is running.\n    const sourceGlob = path.join(options.sourceDirectory, '*', '*.{js,ts,jsx,tsx,css}');\n    const sourcePaths = await globby(sourceGlob);\n\n    // Save the result of globbing for the source paths so that we can later\n    // check if a given filename exists.\n    relativeSourcePaths = sourcePaths.map((p) => path.relative(options.sourceDirectory, p));\n\n    esbuildContext = await esbuild.context({\n      entryPoints: sourcePaths,\n      target: 'es2017',\n      format: 'iife',\n      sourcemap: 'inline',\n      bundle: true,\n      write: false,\n      loader: {\n        '.woff': 'file',\n        '.woff2': 'file',\n      },\n      outbase: options.sourceDirectory,\n      outdir: options.buildDirectory,\n      entryNames: '[dir]/[name]',\n    });\n\n    esbuildServer = await esbuildContext.serve({ host: '0.0.0.0' });\n  }\n}\n\n/**\n * Shuts down the development assets compiler if it is running.\n */\nexport async function close() {\n  esbuildContext?.dispose();\n}\n\nexport function assertConfigured(): void {\n  if (!options) {\n    throw new Error('@prairielearn/compiled-assets was not configured');\n  }\n}\n\nexport function handler() {\n  assertConfigured();\n\n  if (!options?.dev) {\n    // We're running in production: serve all assets from the build directory.\n    // Set headers to cache for as long as possible, since the assets will\n    // include content hashes in their filenames.\n    return expressStaticGzip(options?.buildDirectory, {\n      enableBrotli: true,\n      // Prefer Brotli if the client supports it.\n      orderPreference: ['br'],\n      serveStatic: {\n        maxAge: '31557600',\n        immutable: true,\n      },\n    });\n  }\n\n  if (!esbuildServer) {\n    throw new Error('esbuild server not initialized');\n  }\n\n  const { port } = esbuildServer;\n\n  // We're running in dev mode, so we need to boot up esbuild to start building\n  // and watching our assets.\n  return function (req: IncomingMessage, res: ServerResponse) {\n    // esbuild will reject requests that come from hosts other than the host on\n    // which the esbuild dev server is listening:\n    // https://github.com/evanw/esbuild/commit/de85afd65edec9ebc44a11e245fd9e9a2e99760d\n    // https://github.com/evanw/esbuild/releases/tag/v0.25.0\n    // We work around this by modifying the request headers to make it look like\n    // the request is coming from localhost, which esbuild won't reject.\n    const headers = structuredClone(req.headers);\n    headers.host = 'localhost';\n    delete headers['x-forwarded-for'];\n    delete headers['x-forwarded-host'];\n    delete headers['x-forwarded-proto'];\n    delete headers['referer'];\n\n    const proxyReq = http.request(\n      {\n        hostname: '127.0.0.1',\n        port,\n        path: req.url,\n        method: req.method,\n        headers,\n      },\n      (proxyRes) => {\n        res.writeHead(proxyRes.statusCode ?? 500, proxyRes.headers);\n        proxyRes.pipe(res, { end: true });\n      },\n    );\n    req.pipe(proxyReq, { end: true });\n  };\n}\n\nlet cachedManifest: AssetsManifest | null = null;\nfunction readManifest(): AssetsManifest {\n  assertConfigured();\n\n  if (!cachedManifest) {\n    const manifestPath = path.join(options.buildDirectory, 'manifest.json');\n    cachedManifest = fs.readJSONSync(manifestPath) as AssetsManifest;\n  }\n\n  return cachedManifest;\n}\n\nfunction compiledPath(type: 'scripts' | 'stylesheets', sourceFile: string): string {\n  assertConfigured();\n  const sourceFilePath = `${type}/${sourceFile}`;\n\n  if (options.dev) {\n    // To ensure that errors that would be raised in production are also raised\n    // in development, we'll check for the existence of the asset file on disk.\n    // This mirrors the production check of the file in the manifest: if a file\n    // exists on disk, it should be in the manifest.\n    if (!relativeSourcePaths?.find((p) => p === sourceFilePath)) {\n      throw new Error(`Unknown ${type} asset: ${sourceFile}`);\n    }\n\n    return options.publicPath + sourceFilePath.replace(/\\.(js|ts)x?$/, '.js');\n  }\n\n  const manifest = readManifest();\n  const assetPath = manifest[sourceFilePath];\n  if (!assetPath) {\n    throw new Error(`Unknown ${type} asset: ${sourceFile}`);\n  }\n\n  return options.publicPath + assetPath;\n}\n\nexport function compiledScriptPath(sourceFile: string): string {\n  return compiledPath('scripts', sourceFile);\n}\n\nexport function compiledStylesheetPath(sourceFile: string): string {\n  return compiledPath('stylesheets', sourceFile);\n}\n\nexport function compiledScriptTag(sourceFile: string): HtmlSafeString {\n  return html`<script src=\"${compiledScriptPath(sourceFile)}\"></script>`;\n}\n\nexport function compiledStylesheetTag(sourceFile: string): HtmlSafeString {\n  return html`<link rel=\"stylesheet\" href=\"${compiledStylesheetPath(sourceFile)}\" />`;\n}\n\nasync function buildAssets(sourceDirectory: string, buildDirectory: string) {\n  await fs.ensureDir(buildDirectory);\n\n  const files = await globby(path.join(sourceDirectory, '*/*.{js,jsx,ts,tsx,css}'));\n  const buildResult = await esbuild.build({\n    entryPoints: files,\n    target: 'es2017',\n    format: 'iife',\n    sourcemap: 'linked',\n    bundle: true,\n    minify: true,\n    loader: {\n      '.woff': 'file',\n      '.woff2': 'file',\n    },\n    entryNames: '[dir]/[name]-[hash]',\n    outbase: sourceDirectory,\n    outdir: buildDirectory,\n    metafile: true,\n  });\n\n  return buildResult.metafile;\n}\n\nfunction makeManifest(\n  metafile: Metafile,\n  sourceDirectory: string,\n  buildDirectory: string,\n): Record<string, string> {\n  const manifest: Record<string, string> = {};\n  Object.entries(metafile.outputs).forEach(([outputPath, meta]) => {\n    if (!meta.entryPoint) return;\n\n    const entryPath = path.relative(sourceDirectory, meta.entryPoint);\n    const assetPath = path.relative(buildDirectory, outputPath);\n    manifest[entryPath] = assetPath;\n  });\n  return manifest;\n}\n\nexport async function build(\n  sourceDirectory: string,\n  buildDirectory: string,\n): Promise<AssetsManifest> {\n  // Remove existing assets to ensure that no stale assets are left behind.\n  await fs.remove(buildDirectory);\n\n  const metafile = await buildAssets(sourceDirectory, buildDirectory);\n  const manifest = makeManifest(metafile, sourceDirectory, buildDirectory);\n  const manifestPath = path.join(buildDirectory, 'manifest.json');\n  await fs.writeJSON(manifestPath, manifest);\n\n  return manifest;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/compiled-assets",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "type": "module",
   "repository": {
     "type": "git",
@@ -15,25 +15,25 @@
     "test": "c8 mocha src/**/*.test.ts"
   },
   "dependencies": {
-    "@prairielearn/html": "^4.0.13",
+    "@prairielearn/html": "^4.0.14",
     "commander": "^13.1.0",
-    "esbuild": "^0.25.2",
-    "express": "^4.21.2",
+    "esbuild": "^0.25.3",
     "express-static-gzip": "^2.2.0",
     "fs-extra": "^11.3.0",
     "globby": "^14.1.0",
-    "pretty-bytes": "^6.1.1",
+    "pretty-bytes": "^7.0.0",
     "tmp-promise": "^3.0.3"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
-    "@types/node": "^20.17.30",
+    "@types/node": "^20.17.32",
     "c8": "^10.1.3",
     "chai": "^5.2.0",
+    "express": "^4.21.2",
     "get-port": "^7.1.0",
     "mocha": "^11.1.0",
     "node-fetch": "^3.3.2",
-    "tsx": "^4.19.3",
+    "tsx": "^4.19.4",
     "typescript": "^5.8.3"
   },
   "c8": {

package/src/index.ts

@@ -1,8 +1,7 @@
-import http from 'node:http';
+import http, { type IncomingMessage, type ServerResponse } from 'node:http';
 import path from 'path';
 
 import esbuild, { type Metafile } from 'esbuild';
-import type { RequestHandler } from 'express';
 import expressStaticGzip from 'express-static-gzip';
 import fs from 'fs-extra';
 import { globby } from 'globby';
@@ -93,7 +92,7 @@ export function assertConfigured(): void {
   }
 }
 
-export function handler(): RequestHandler {
+export function handler() {
   assertConfigured();
 
   if (!options?.dev) {
@@ -119,7 +118,7 @@ export function handler(): RequestHandler {
 
   // We're running in dev mode, so we need to boot up esbuild to start building
   // and watching our assets.
-  return function (req, res) {
+  return function (req: IncomingMessage, res: ServerResponse) {
     // esbuild will reject requests that come from hosts other than the host on
     // which the esbuild dev server is listening:
     // https://github.com/evanw/esbuild/commit/de85afd65edec9ebc44a11e245fd9e9a2e99760d