npm - @moku-labs/web - Versions diffs - 1.5.1 → 1.5.3 - Mend

@moku-labs/web 1.5.1 → 1.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.cjs CHANGED Viewed

@@ -3992,10 +3992,31 @@ function wrap(body) {
 	return `<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>404 — Not Found</title></head><body>${body}</body></html>`;
 }
 /**
+* Resolve the 404 page HTML from `config.notFound`. Precedence: `path` (a
+* complete page file, read verbatim) > `body` (a fragment, wrapped in the
+* minimal shell) > the built-in default.
+*
+* @param notFound - The `config.notFound` value (already known to be truthy).
+* @returns The complete HTML document to write.
+* @example
+* ```ts
+* const html = await resolveHtml({ path: "src/404.html" });
+* ```
+*/
+async function resolveHtml(notFound) {
+	if (typeof notFound === "object" && notFound.path) try {
+		return await (0, node_fs_promises.readFile)(notFound.path, "utf8");
+	} catch (error) {
+		throw new Error(`build:not-found — could not read notFound.path "${notFound.path}"`, { cause: error });
+	}
+	return wrap(typeof notFound === "object" && notFound.body ? notFound.body : DEFAULT_BODY);
+}
+/**
 * Emits `outDir/404.html`. When `config.notFound` is `true`, writes the built-in
-* default page; when it is `{ body }`, writes the supplied HTML body content
-* verbatim inside the document shell. No-op (returns `null`) when `notFound` is
-* false/unset.
+* default page; `{ body }` writes the supplied HTML body content inside the
+* minimal document shell; `{ path }` writes the referenced HTML page file
+* verbatim (the app owns the whole document). No-op (returns `null`) when
+* `notFound` is false/unset.
 *
 * @param ctx - Plugin context (provides `config`, `log`).
 * @returns The written file path, or `null` when disabled.
@@ -4010,10 +4031,10 @@ async function generateNotFound(ctx) {
 		ctx.log.debug("build:not-found", { skipped: true });
 		return null;
 	}
-	const body = typeof notFound === "object" && notFound.body ? notFound.body : DEFAULT_BODY;
+	const html = await resolveHtml(notFound);
 	await (0, node_fs_promises.mkdir)(outDir, { recursive: true });
 	const file = node_path$1.default.join(outDir, "404.html");
-	await (0, node_fs_promises.writeFile)(file, wrap(body), "utf8");
+	await (0, node_fs_promises.writeFile)(file, html, "utf8");
 	ctx.log.debug("build:not-found", { path: file });
 	return { path: file };
 }
@@ -4390,9 +4411,10 @@ async function generateOgImages(ctx, options = {}) {
 		fonts,
 		...renderHook
 	});
+	const siteCardRender = typeof config.defaultCard === "function" ? config.defaultCard : defaultSiteCard;
 	const renderSitePng = options.renderPng ?? makeDefaultRenderer({
 		fonts,
-		render: defaultSiteCard
+		render: siteCardRender
 	});
 	const siteName = resolveSiteName(ctx);
 	const defaultLocale = ctx.require(i18nPlugin).defaultLocale();
@@ -4418,7 +4440,7 @@ async function generateOgImages(ctx, options = {}) {
 			outDir
 		}, tally);
 	})));
-	const defaultCard = config.defaultCard === true;
+	const defaultCard = config.defaultCard === true || typeof config.defaultCard === "function";
 	if (defaultCard) {
 		const png = await renderSitePng({
 			title: siteName,

package/dist/index.d.cts CHANGED Viewed

@@ -1633,12 +1633,16 @@ interface OgImageConfig {
   /** Explicit named fonts loaded once per build (overrides the first-file scan). */
   fonts?: OgFont[];
   /**
-   * When `true`, also render a single SITE-LEVEL default card to `<outDir>/og-default.png`
-   * — a generic site name + description on a dark background, using the same loaded fonts (the
-   * per-article `render` hook is NOT applied). Point `head.defaultOgImage` at `"/og-default.png"`
-   * to use it as the og:image fallback for non-article pages. Default `false`.
+   * Also render a single SITE-LEVEL default card to `<outDir>/og-default.png`, used (via
+   * `head.defaultOgImage: "/og-default.png"`) as the og:image fallback for non-article pages.
+   * Rendered ONCE with the same loaded fonts; the per-article `render` hook is NOT applied.
+   *
+   * - `true` → the built-in generic card (site name over its description on a dark background).
+   * - a render function → your OWN card, e.g. `defaultCard: MySiteCard` (a `(input) => VNode`,
+   *   the same shape as `render`); `input.siteName`/`input.description` carry the site identity.
+   * - `false`/omitted → no card (default).
    */
-  defaultCard?: boolean;
+  defaultCard?: boolean | ((input: RichOgInput) => import("preact").VNode);
 }
 /**
  * Public configuration for the `build` plugin. Flags give opt-in granularity over
@@ -1659,12 +1663,18 @@ type Config$3 = {
   injectAssets?: boolean; /** Directory copied verbatim into `outDir` (skipped silently if absent). Default `"public"`. */
   publicDir?: string;
   /**
-   * Emit `outDir/404.html`. `true` for the built-in default page, or
-   * `{ body }` to supply the page's literal HTML body content (written into the
-   * 404 page verbatim). Default `false`.
+   * Emit `outDir/404.html`. One of:
+   * - `true` — the built-in default page.
+   * - `{ body }` — literal HTML body content, wrapped in a minimal document shell.
+   * - `{ path }` — path to a complete HTML page file (resolved from the project
+   *   root), written out VERBATIM so the app owns the whole document (its own
+   *   `<head>`, asset links, and body).
+   *
+   * `path` takes precedence over `body` when both are set. Default `false`.
    */
   notFound?: boolean | {
     body?: string;
+    path?: string;
   }; /** Emit per-path i18n bare-path redirect HTML pages. Default `false`. */
   localeRedirects?: boolean; /** Authoritative client bundle entry path (overrides the conventional scan). */
   clientEntry?: string;

package/dist/index.d.mts CHANGED Viewed

@@ -1633,12 +1633,16 @@ interface OgImageConfig {
   /** Explicit named fonts loaded once per build (overrides the first-file scan). */
   fonts?: OgFont[];
   /**
-   * When `true`, also render a single SITE-LEVEL default card to `<outDir>/og-default.png`
-   * — a generic site name + description on a dark background, using the same loaded fonts (the
-   * per-article `render` hook is NOT applied). Point `head.defaultOgImage` at `"/og-default.png"`
-   * to use it as the og:image fallback for non-article pages. Default `false`.
+   * Also render a single SITE-LEVEL default card to `<outDir>/og-default.png`, used (via
+   * `head.defaultOgImage: "/og-default.png"`) as the og:image fallback for non-article pages.
+   * Rendered ONCE with the same loaded fonts; the per-article `render` hook is NOT applied.
+   *
+   * - `true` → the built-in generic card (site name over its description on a dark background).
+   * - a render function → your OWN card, e.g. `defaultCard: MySiteCard` (a `(input) => VNode`,
+   *   the same shape as `render`); `input.siteName`/`input.description` carry the site identity.
+   * - `false`/omitted → no card (default).
    */
-  defaultCard?: boolean;
+  defaultCard?: boolean | ((input: RichOgInput) => import("preact").VNode);
 }
 /**
  * Public configuration for the `build` plugin. Flags give opt-in granularity over
@@ -1659,12 +1663,18 @@ type Config$3 = {
   injectAssets?: boolean; /** Directory copied verbatim into `outDir` (skipped silently if absent). Default `"public"`. */
   publicDir?: string;
   /**
-   * Emit `outDir/404.html`. `true` for the built-in default page, or
-   * `{ body }` to supply the page's literal HTML body content (written into the
-   * 404 page verbatim). Default `false`.
+   * Emit `outDir/404.html`. One of:
+   * - `true` — the built-in default page.
+   * - `{ body }` — literal HTML body content, wrapped in a minimal document shell.
+   * - `{ path }` — path to a complete HTML page file (resolved from the project
+   *   root), written out VERBATIM so the app owns the whole document (its own
+   *   `<head>`, asset links, and body).
+   *
+   * `path` takes precedence over `body` when both are set. Default `false`.
    */
   notFound?: boolean | {
     body?: string;
+    path?: string;
   }; /** Emit per-path i18n bare-path redirect HTML pages. Default `false`. */
   localeRedirects?: boolean; /** Authoritative client bundle entry path (overrides the conventional scan). */
   clientEntry?: string;

package/dist/index.mjs CHANGED Viewed

@@ -3979,10 +3979,31 @@ function wrap(body) {
 	return `<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>404 — Not Found</title></head><body>${body}</body></html>`;
 }
 /**
+* Resolve the 404 page HTML from `config.notFound`. Precedence: `path` (a
+* complete page file, read verbatim) > `body` (a fragment, wrapped in the
+* minimal shell) > the built-in default.
+*
+* @param notFound - The `config.notFound` value (already known to be truthy).
+* @returns The complete HTML document to write.
+* @example
+* ```ts
+* const html = await resolveHtml({ path: "src/404.html" });
+* ```
+*/
+async function resolveHtml(notFound) {
+	if (typeof notFound === "object" && notFound.path) try {
+		return await readFile(notFound.path, "utf8");
+	} catch (error) {
+		throw new Error(`build:not-found — could not read notFound.path "${notFound.path}"`, { cause: error });
+	}
+	return wrap(typeof notFound === "object" && notFound.body ? notFound.body : DEFAULT_BODY);
+}
+/**
 * Emits `outDir/404.html`. When `config.notFound` is `true`, writes the built-in
-* default page; when it is `{ body }`, writes the supplied HTML body content
-* verbatim inside the document shell. No-op (returns `null`) when `notFound` is
-* false/unset.
+* default page; `{ body }` writes the supplied HTML body content inside the
+* minimal document shell; `{ path }` writes the referenced HTML page file
+* verbatim (the app owns the whole document). No-op (returns `null`) when
+* `notFound` is false/unset.
 *
 * @param ctx - Plugin context (provides `config`, `log`).
 * @returns The written file path, or `null` when disabled.
@@ -3997,10 +4018,10 @@ async function generateNotFound(ctx) {
 		ctx.log.debug("build:not-found", { skipped: true });
 		return null;
 	}
-	const body = typeof notFound === "object" && notFound.body ? notFound.body : DEFAULT_BODY;
+	const html = await resolveHtml(notFound);
 	await mkdir(outDir, { recursive: true });
 	const file = path.join(outDir, "404.html");
-	await writeFile(file, wrap(body), "utf8");
+	await writeFile(file, html, "utf8");
 	ctx.log.debug("build:not-found", { path: file });
 	return { path: file };
 }
@@ -4377,9 +4398,10 @@ async function generateOgImages(ctx, options = {}) {
 		fonts,
 		...renderHook
 	});
+	const siteCardRender = typeof config.defaultCard === "function" ? config.defaultCard : defaultSiteCard;
 	const renderSitePng = options.renderPng ?? makeDefaultRenderer({
 		fonts,
-		render: defaultSiteCard
+		render: siteCardRender
 	});
 	const siteName = resolveSiteName(ctx);
 	const defaultLocale = ctx.require(i18nPlugin).defaultLocale();
@@ -4405,7 +4427,7 @@ async function generateOgImages(ctx, options = {}) {
 			outDir
 		}, tally);
 	})));
-	const defaultCard = config.defaultCard === true;
+	const defaultCard = config.defaultCard === true || typeof config.defaultCard === "function";
 	if (defaultCard) {
 		const png = await renderSitePng({
 			title: siteName,

package/package.json CHANGED Viewed

@@ -113,5 +113,5 @@
     "test:cli-e2e": "bun test src/plugins/cli/__tests__/e2e/",
     "test:coverage": "vitest run --project unit --project integration --coverage"
   },
-  "version": "1.5.1"
+  "version": "1.5.3"
 }