modulepreload-koa/createModulePreloadMiddleware.mjs

Koa middleware for generating modulepreload link relations for a Link entity-header based on the requested JavaScript modules import graph.

// @ts-check

import path from "node:path";
import createResolveLinkRelations from "modulepreload-link-relations/createResolveLinkRelations.mjs";
import formatLinkHeaderRelations from "modulepreload-link-relations/formatLinkHeaderRelations.mjs";

/** @typedef {import('koa').Middleware} Middleware **/
/** @typedef {import('modulepreload-link-relations/createResolveLinkRelations.mjs').AsyncMapLike} AsyncMapLike */

const defaultOptions = {
  extensions: ["mjs", "js"],
};

/**
 * Creates a middleware function that adds a Link header containing modulepreload link relationships to JavaScript module requests.
 * @param {string} appPath Path to the application root directory, eg "app".
 * @param {object} [userOptions] The options object.
 * @param {Array<string>} [userOptions.extensions] The file extensions to consider for module scripts.
 * @param {string} [userOptions.importMap] Import map.
 * @param {AsyncMapLike} [userOptions.cache] A custom cache.
 * @returns {Middleware} The middleware function.
 */
export default function createModulePreloadMiddleware(
  appPath,
  userOptions = {},
) {
  const options = {
    ...defaultOptions,
    ...userOptions,
  };

  const resolveLinkRelations = createResolveLinkRelations(appPath, {
    importMap: options.importMap,
    cache: options.cache,
  });

  return async function modulePreloadMiddleware(ctx, next) {
    const url = ctx.req.url;
    const file = ctx.req.url?.slice(1);
    const fileExt = file && path.extname(file).slice(1);

    if (url && fileExt && options.extensions.includes(fileExt)) {
      const linkRelations = await resolveLinkRelations(url);

      if (linkRelations) {
        ctx.append("Link", formatLinkHeaderRelations(linkRelations));
      }
    }

    await next();
  };
}