nuxt-og-image 5.1.10 → 5.1.12

package/dist/runtime/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const logger: import("consola").ConsolaInstance;
+export declare const gray: (s: string) => string;

package/dist/runtime/logger.js

@@ -0,0 +1,8 @@
+import { createConsola } from "consola";
+import { colorize } from "consola/utils";
+export const logger = createConsola({
+  defaults: {
+    tag: "@nuxtjs/og-image"
+  }
+});
+export const gray = (s) => colorize("gray", s);

package/dist/runtime/mock/empty.d.ts

@@ -0,0 +1,2 @@
+import empty from 'mocked-exports/empty';
+export default empty;

package/dist/runtime/mock/empty.js

@@ -0,0 +1,2 @@
+import empty from "mocked-exports/empty";
+export default empty;

package/dist/runtime/mock/proxy-cjs.d.ts

@@ -0,0 +1,2 @@
+import proxy from 'mocked-exports/proxy-cjs';
+export default proxy;

package/dist/runtime/mock/proxy-cjs.js

@@ -0,0 +1,2 @@
+import proxy from "mocked-exports/proxy-cjs";
+export default proxy;

package/dist/runtime/server/og-image/bindings/chromium/chrome-launcher.d.ts

@@ -0,0 +1,2 @@
+import type { Browser } from 'playwright-core';
+export declare function createBrowser(): Promise<Browser | void>;

package/dist/runtime/server/og-image/bindings/chromium/chrome-launcher.js

@@ -0,0 +1,9 @@
+import { Launcher } from "chrome-launcher";
+import playwrightCore from "playwright-core";
+const chromePath = Launcher.getFirstInstallation();
+export async function createBrowser() {
+  return playwrightCore.chromium.launch({
+    headless: true,
+    executablePath: chromePath
+  });
+}

package/dist/runtime/server/og-image/bindings/chromium/on-demand.d.ts

@@ -0,0 +1,2 @@
+import type { Browser } from 'playwright-core';
+export declare function createBrowser(): Promise<Browser | void>;

package/dist/runtime/server/og-image/bindings/chromium/on-demand.js

@@ -0,0 +1,40 @@
+import { createConsola } from "consola";
+import { execa } from "execa";
+import playwrightCore from "playwright-core";
+let installedChromium = false;
+let installChromiumPromise;
+export async function createBrowser() {
+  if (installChromiumPromise)
+    await installChromiumPromise;
+  if (!installedChromium) {
+    installChromiumPromise = new Promise((_resolve) => {
+      const logger = createConsola().withTag("Nuxt OG Image");
+      logger.info("Installing Chromium install for og:image generation...");
+      const installChromeProcess = execa("npx", ["playwright", "install", "chromium"], {
+        stdio: "pipe"
+      });
+      if (installChromeProcess.stderr) {
+        installChromeProcess.stderr.pipe(process.stderr);
+      }
+      if (installChromeProcess.stdout) {
+        installChromeProcess.stdout.pipe(process.stdout);
+      }
+      new Promise((resolve) => {
+        installChromeProcess.on("exit", (e) => {
+          if (e !== 0)
+            logger.error("Failed to install Playwright dependency for og:image generation. Trying anyway...");
+          resolve();
+        });
+      }).then(() => {
+        installChromeProcess.kill();
+        logger.info("Installed Chromium install for og:image generation.");
+        _resolve();
+      });
+    }).then(() => {
+      installedChromium = true;
+    });
+  }
+  return await playwrightCore.chromium.launch({
+    headless: true
+  });
+}

package/dist/runtime/server/og-image/bindings/chromium/playwright.d.ts

@@ -0,0 +1,2 @@
+import type { Browser } from 'playwright-core';
+export declare function createBrowser(): Promise<Browser | void>;

package/dist/runtime/server/og-image/bindings/chromium/playwright.js

@@ -0,0 +1,6 @@
+import playwright from "playwright";
+export async function createBrowser() {
+  return await playwright.chromium.launch({
+    headless: true
+  });
+}

package/dist/runtime/server/og-image/bindings/css-inline/node.d.ts

@@ -0,0 +1,8 @@
+import { inline } from '@css-inline/css-inline';
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    cssInline: {
+        inline: typeof inline;
+    };
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/css-inline/node.js

@@ -0,0 +1,7 @@
+import { inline } from "@css-inline/css-inline";
+export default {
+  initWasmPromise: Promise.resolve(),
+  cssInline: {
+    inline
+  }
+};

package/dist/runtime/server/og-image/bindings/css-inline/wasm-fs.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    initWasmPromise: any;
+    cssInline: {
+        inline: any;
+    };
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/css-inline/wasm-fs.js

@@ -0,0 +1,8 @@
+import { initWasm, inline } from "@css-inline/css-inline-wasm";
+import { readWasmFile } from "../../../util/wasm.js";
+export default {
+  initWasmPromise: initWasm(readWasmFile("@css-inline/css-inline-wasm/index_bg.wasm")),
+  cssInline: {
+    inline
+  }
+};

package/dist/runtime/server/og-image/bindings/css-inline/wasm.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    initWasmPromise: any;
+    cssInline: {
+        inline: any;
+    };
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/css-inline/wasm.js

@@ -0,0 +1,7 @@
+import { initWasm, inline } from "@css-inline/css-inline-wasm";
+export default {
+  initWasmPromise: initWasm(import("@css-inline/css-inline-wasm/index_bg.wasm?module").then((r) => r.default || r)),
+  cssInline: {
+    inline
+  }
+};

package/dist/runtime/server/og-image/bindings/resvg/node.d.ts

@@ -0,0 +1,6 @@
+import { Resvg as _Resvg } from '@resvg/resvg-js';
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    Resvg: typeof _Resvg;
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/resvg/node.js

@@ -0,0 +1,5 @@
+import { Resvg as _Resvg } from "@resvg/resvg-js";
+export default {
+  initWasmPromise: Promise.resolve(),
+  Resvg: _Resvg
+};

package/dist/runtime/server/og-image/bindings/resvg/wasm-fs.d.ts

@@ -0,0 +1,40 @@
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    Resvg: new (svg: Uint8Array | string, options?: import("@resvg/resvg-wasm").ResvgRenderOptions) => {
+        free(): void;
+        render(): {
+            free(): void;
+            asPng(): Uint8Array;
+            readonly height: number;
+            readonly pixels: Uint8Array;
+            readonly width: number;
+        };
+        toString(): string;
+        innerBBox(): {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        } | undefined;
+        getBBox(): {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        } | undefined;
+        cropByBBox(bbox: {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        }): void;
+        imagesToResolve(): any[];
+        resolveImage(href: string, buffer: Uint8Array): void;
+        readonly height: number;
+        readonly width: number;
+    };
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/resvg/wasm-fs.js

@@ -0,0 +1,6 @@
+import { Resvg as _Resvg, initWasm } from "@resvg/resvg-wasm";
+import { readWasmFile } from "../../../util/wasm.js";
+export default {
+  initWasmPromise: initWasm(readWasmFile("@resvg/resvg-wasm/index_bg.wasm")),
+  Resvg: _Resvg
+};

package/dist/runtime/server/og-image/bindings/resvg/wasm.d.ts

@@ -0,0 +1,40 @@
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    Resvg: new (svg: Uint8Array | string, options?: import("@resvg/resvg-wasm").ResvgRenderOptions) => {
+        free(): void;
+        render(): {
+            free(): void;
+            asPng(): Uint8Array;
+            readonly height: number;
+            readonly pixels: Uint8Array;
+            readonly width: number;
+        };
+        toString(): string;
+        innerBBox(): {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        } | undefined;
+        getBBox(): {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        } | undefined;
+        cropByBBox(bbox: {
+            free(): void;
+            height: number;
+            width: number;
+            x: number;
+            y: number;
+        }): void;
+        imagesToResolve(): any[];
+        resolveImage(href: string, buffer: Uint8Array): void;
+        readonly height: number;
+        readonly width: number;
+    };
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/resvg/wasm.js

@@ -0,0 +1,5 @@
+import { Resvg as _Resvg, initWasm } from "@resvg/resvg-wasm";
+export default {
+  initWasmPromise: initWasm(import("@resvg/resvg-wasm/index_bg.wasm?module").then((r) => r.default || r)),
+  Resvg: _Resvg
+};

package/dist/runtime/server/og-image/bindings/satori/node.d.ts

@@ -0,0 +1,6 @@
+import _satori from 'satori';
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    satori: typeof _satori;
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/satori/node.js

@@ -0,0 +1,5 @@
+import _satori from "satori";
+export default {
+  initWasmPromise: Promise.resolve(),
+  satori: _satori
+};

package/dist/runtime/server/og-image/bindings/satori/wasm-fs.d.ts

@@ -0,0 +1,6 @@
+import _satori from 'satori/wasm';
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    satori: typeof _satori;
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/satori/wasm-fs.js

@@ -0,0 +1,13 @@
+import _satori, { init } from "satori/wasm";
+import initYoga from "yoga-wasm-web";
+import { readWasmFile } from "../../../util/wasm.js";
+const wasm = readWasmFile("yoga-wasm-web/dist/yoga.wasm").then(async (yoga) => await initYoga(yoga));
+export default {
+  initWasmPromise: new Promise((resolve) => {
+    wasm.then((yoga) => {
+      init(yoga);
+      resolve();
+    });
+  }),
+  satori: _satori
+};

package/dist/runtime/server/og-image/bindings/satori/wasm.d.ts

@@ -0,0 +1,6 @@
+import _satori from 'satori/wasm';
+declare const _default: {
+    initWasmPromise: Promise<void>;
+    satori: typeof _satori;
+};
+export default _default;

package/dist/runtime/server/og-image/bindings/satori/wasm.js

@@ -0,0 +1,13 @@
+import { init } from "satori";
+import _satori from "satori/wasm";
+import initYoga from "yoga-wasm-web";
+const wasm = import("yoga-wasm-web/dist/yoga.wasm?module").then(async (yoga) => await initYoga(yoga.default || yoga));
+export default {
+  initWasmPromise: new Promise((resolve) => {
+    wasm.then((yoga) => {
+      init(yoga);
+      resolve();
+    });
+  }),
+  satori: _satori
+};

package/dist/runtime/server/og-image/bindings/sharp/node.d.ts

@@ -0,0 +1,2 @@
+import sharp from 'sharp';
+export default sharp;

package/dist/runtime/server/og-image/bindings/sharp/node.js

@@ -0,0 +1,2 @@
+import sharp from "sharp";
+export default sharp;

package/dist/runtime/server/og-image/cache/lru.d.ts

@@ -0,0 +1,9 @@
+import type { Storage } from 'unstorage';
+import type { OgImageOptions } from '../../../types.js';
+export declare const htmlPayloadCache: Storage<{
+    expiresAt: number;
+    value: OgImageOptions;
+}>;
+export declare const prerenderOptionsCache: Storage<OgImageOptions> | undefined;
+export declare const fontCache: Storage<BufferSource>;
+export declare const emojiCache: Storage<string>;

package/dist/runtime/server/og-image/cache/lru.js

@@ -0,0 +1,15 @@
+import { createStorage } from "unstorage";
+import lruCacheDriver from "unstorage/drivers/lru-cache";
+export const htmlPayloadCache = createStorage({
+  // short cache time so we don't need many entries at runtime
+  driver: lruCacheDriver({ max: import.meta.prerender ? 1e4 : 50 })
+});
+export const prerenderOptionsCache = import.meta.prerender ? createStorage({
+  driver: lruCacheDriver({ max: 1e4 })
+}) : void 0;
+export const fontCache = createStorage({
+  driver: lruCacheDriver({ max: 10 })
+});
+export const emojiCache = createStorage({
+  driver: lruCacheDriver({ max: 1e3 })
+});

package/dist/runtime/server/og-image/cache/mock.d.ts

@@ -0,0 +1,9 @@
+import type { Storage } from 'unstorage';
+import type { OgImageOptions } from '../../../types.js';
+export declare const htmlPayloadCache: Storage<{
+    expiresAt: number;
+    value: OgImageOptions;
+}>;
+export declare const prerenderOptionsCache: Storage<OgImageOptions> | undefined;
+export declare const fontCache: Storage<OgImageOptions<"NuxtSeo">>;
+export declare const emojiCache: Storage<string>;

package/dist/runtime/server/og-image/cache/mock.js

@@ -0,0 +1,9 @@
+import { createStorage } from "unstorage";
+import memoryDriver from "unstorage/drivers/memory";
+const storage = createStorage({
+  driver: memoryDriver()
+});
+export const htmlPayloadCache = storage;
+export const prerenderOptionsCache = storage;
+export const fontCache = storage;
+export const emojiCache = storage;

package/dist/runtime/server/og-image/chromium/renderer.d.ts

@@ -0,0 +1,3 @@
+import type { Renderer } from '../../../types.js';
+declare const ChromiumRenderer: Renderer;
+export default ChromiumRenderer;

package/dist/runtime/server/og-image/chromium/renderer.js

@@ -0,0 +1,24 @@
+import { createBrowser } from "#og-image/bindings/chromium";
+import { createError } from "h3";
+import { createScreenshot } from "./screenshot.js";
+const ChromiumRenderer = {
+  name: "chromium",
+  supportedFormats: ["png", "jpeg", "jpg"],
+  async debug() {
+    return {};
+  },
+  async createImage(ctx) {
+    const browser = await createBrowser();
+    const screenshot = await createScreenshot(ctx, browser).catch((e) => e);
+    await browser.close();
+    if (screenshot instanceof Error) {
+      return createError({
+        statusCode: 400,
+        cause: screenshot,
+        statusMessage: `[Nuxt OG Image] Failed to create screenshot ${screenshot.message}.`
+      });
+    }
+    return screenshot;
+  }
+};
+export default ChromiumRenderer;

package/dist/runtime/server/og-image/chromium/screenshot.d.ts

@@ -0,0 +1,4 @@
+import type { Buffer } from 'node:buffer';
+import type { Browser } from 'playwright-core';
+import type { OgImageRenderEventContext } from '../../../types.js';
+export declare function createScreenshot({ basePath, e, options, extension }: OgImageRenderEventContext, browser: Browser): Promise<Buffer>;

package/dist/runtime/server/og-image/chromium/screenshot.js

@@ -0,0 +1,54 @@
+import { useNitroOrigin } from "#site-config/server/composables";
+import { joinURL, withQuery } from "ufo";
+import { toValue } from "vue";
+import { useOgImageRuntimeConfig } from "../../utils.js";
+export async function createScreenshot({ basePath, e, options, extension }, browser) {
+  const { colorPreference } = useOgImageRuntimeConfig();
+  const path = options.component === "PageScreenshot" ? basePath : joinURL("/__og-image__/image", basePath, `og.html`);
+  const page = await browser.newPage({
+    colorScheme: colorPreference || "no-preference",
+    baseURL: useNitroOrigin(e)
+  });
+  try {
+    if (import.meta.prerender && !options.html) {
+      options.html = await e.$fetch(path).catch(() => void 0);
+    }
+    await page.setViewportSize({
+      width: toValue(options.width) || 1200,
+      height: toValue(options.height) || 630
+    });
+    if (options.html) {
+      const html = options.html;
+      await page.evaluate((html2) => {
+        document.open("text/html");
+        document.write(html2);
+        document.close();
+      }, html);
+      await page.waitForLoadState("networkidle");
+    } else {
+      await page.goto(withQuery(path, options.props), {
+        timeout: 1e4,
+        waitUntil: "networkidle"
+      });
+    }
+    const screenshotOptions = {
+      timeout: 1e4,
+      animations: "disabled",
+      type: extension === "png" ? "png" : "jpeg"
+    };
+    const _options = options.screenshot || {};
+    if (_options.delay)
+      await page.waitForTimeout(_options.delay);
+    if (_options.mask) {
+      await page.evaluate((mask) => {
+        for (const el of document.querySelectorAll(mask))
+          el.style.display = "none";
+      }, _options.mask);
+    }
+    if (_options.selector)
+      return await page.locator(_options.selector).screenshot(screenshotOptions);
+    return await page.screenshot(screenshotOptions);
+  } finally {
+    await page.close();
+  }
+}

package/dist/runtime/server/og-image/context.d.ts

@@ -0,0 +1,5 @@
+import type { H3Error, H3Event } from 'h3';
+import type { OgImageOptions, OgImageRenderEventContext } from '../../types.js';
+export declare function resolvePathCacheKey(e: H3Event, path: string): string;
+export declare function resolveContext(e: H3Event): Promise<H3Error | OgImageRenderEventContext>;
+export declare function extractAndNormaliseOgImageOptions(html: string): OgImageOptions | false;