nuxt-og-image 2.0.3 → 2.0.5

package/dist/module.mjs

@@ -1,8 +1,10 @@
 import { readFile, writeFile } from 'node:fs/promises';
+import * as fs from 'node:fs';
+import { existsSync } from 'node:fs';
 import { useNuxt, addTemplate, defineNuxtModule, useLogger, createResolver, addServerHandler, addImports, addComponent, hasNuxtModule, addServerPlugin } from '@nuxt/kit';
 import { execa } from 'execa';
 import chalk from 'chalk';
-import defu from 'defu';
+import defu$1, { defu } from 'defu';
 import { toRouteMatcher, createRouter } from 'radix3';
 import { withBase, joinURL } from 'ufo';
 import { resolve, relative, dirname } from 'pathe';
@@ -10,14 +12,16 @@ import { tinyws } from 'tinyws';
 import sirv from 'sirv';
 import { pathExists, copy, mkdirp } from 'fs-extra';
 import { globby } from 'globby';
-import { installNuxtSiteConfig, updateSiteConfig, requireSiteConfig } from 'nuxt-site-config-kit';
+import { installNuxtSiteConfig, updateSiteConfig } from 'nuxt-site-config-kit';
 import { provider } from 'std-env';
+import { hash } from 'ohash';
 import playwrightCore from 'playwright-core';
-import { existsSync } from 'node:fs';
 import { createBirpcGroup } from 'birpc';
 import { stringify, parse } from 'flatted';
 import { addDependency } from 'nypm';
 
+const version = "2.0.5";
+
 async function createBrowser() {
   if (process.dev || process.env.prerender) {
     try {
@@ -186,15 +190,20 @@ function decodeObjectHtmlEntities(obj) {
   });
   return obj;
 }
-function extractOgImageOptions(html) {
+function extractOgImageOptions(html, routeRules) {
   const htmlPayload = html.match(/<script id="nuxt-og-image-options" type="application\/json">(.+?)<\/script>/)?.[1];
   if (!htmlPayload)
     return false;
   let options;
   try {
-    options = JSON.parse(htmlPayload);
+    const payload = JSON.parse(htmlPayload);
+    Object.entries(payload).forEach(([key, value]) => {
+      if (!value)
+        delete payload[key];
+    });
+    options = defu(payload, routeRules);
   } catch (e) {
-    options = false;
+    options = routeRules;
     if (process.dev)
       console.warn("Failed to parse #nuxt-og-image-options", e, options);
   }
@@ -318,7 +327,7 @@ function getNitroProviderCompatibility(defaults, nuxt = useNuxt()) {
       return false;
     compatibility = lookup || {};
   }
-  compatibility = defu(compatibility, defaults);
+  compatibility = defu$1(compatibility, defaults);
   compatibility.inlineCss = compatibility.inlineCss || (compatibility.node ? "node" : "mock");
   return compatibility;
 }
@@ -331,9 +340,9 @@ function ensureDependencies(nuxt, dep) {
 function extendTypes(module, template) {
   const nuxt = useNuxt();
   addTemplate({
-    filename: `${module}.d.ts`,
-    getContents: () => {
-      const s = template();
+    filename: `module/${module}.d.ts`,
+    getContents: async () => {
+      const s = await template();
       return `// Generated by ${module}
 ${s}
 export {}
@@ -341,7 +350,7 @@ export {}
     }
   });
   nuxt.hooks.hook("prepare:types", ({ references }) => {
-    references.push({ path: resolve(nuxt.options.buildDir, `${module}.d.ts`) });
+    references.push({ path: resolve(nuxt.options.buildDir, `module/${module}.d.ts`) });
   });
 }
 
@@ -408,9 +417,6 @@ const module = defineNuxtModule({
       _context: "nuxt-og-image:config",
       url: config.siteUrl || config.host
     });
-    requireSiteConfig("nuxt-og-image", {
-      url: "Required to generate absolute URLs for the og:image."
-    }, { prerender: true });
     nuxt.options.nitro.storage = nuxt.options.nitro.storage || {};
     if (nuxt.options._generate) {
       nuxt.options.nitro.storage["og-image"] = {
@@ -429,12 +435,16 @@ const module = defineNuxtModule({
     };
     nuxt.options.experimental.componentIslands = true;
     extendTypes("nuxt-og-image", () => {
-      return `interface NuxtOgImageNitroRules {
-  ogImage?: false | Record<string, any>
-}
+      return `
+import type { OgImageOptions } from '${resolve("./runtime/types")}'
+
 declare module 'nitropack' {
-  interface NitroRouteRules extends NuxtOgImageNitroRules {}
-  interface NitroRouteConfig extends NuxtOgImageNitroRules {}
+  interface NitroRouteRules {
+    ogImage?: false | OgImageOptions
+  }
+  interface NitroRouteConfig {
+    ogImage?: false | OgImageOptions
+  }
 }`;
     });
     addServerHandler({
@@ -520,13 +530,18 @@ declare module 'nitropack' {
       components.forEach((component) => {
         let valid = false;
         config.componentDirs.forEach((dir) => {
-          if (component.pascalName.startsWith(dir) || component.kebabName.startsWith(dir))
+          if (component.pascalName.startsWith(dir) || component.kebabName.startsWith(dir) || component.shortPath.includes(`/${dir}/`))
             valid = true;
         });
-        if (valid) {
+        if (valid || component.pascalName === "OgImageTemplateFoo") {
           component.island = true;
           component.mode = "server";
-          ogImageComponents.push({ pascalName: component.pascalName, kebabName: component.kebabName });
+          ogImageComponents.push({
+            // purge cache when component changes
+            hash: hash(fs.readFileSync(component.filePath, "utf-8")),
+            pascalName: component.pascalName,
+            kebabName: component.kebabName
+          });
         }
       });
     });
@@ -557,6 +572,7 @@ declare module 'nitropack' {
     nuxt.hooks.hook("modules:done", async () => {
       nuxt.hooks.callHook("og-image:config", config);
       nuxt.options.runtimeConfig["nuxt-og-image"] = {
+        version,
         satoriOptions: config.satoriOptions,
         runtimeSatori: config.runtimeSatori,
         runtimeBrowser: config.runtimeBrowser,
@@ -587,7 +603,7 @@ declare module 'nitropack' {
       };
     });
     nuxt.hooks.hook("nitro:config", async (nitroConfig) => {
-      nitroConfig.externals = defu(nitroConfig.externals || {}, {
+      nitroConfig.externals = defu$1(nitroConfig.externals || {}, {
         inline: [runtimeDir]
       });
       if (config.runtimeBrowser) {
@@ -704,15 +720,14 @@ export async function useProvider(provider) {
         const html = ctx.contents;
         if (!html)
           return;
-        const extractedOptions = extractOgImageOptions(html);
-        const routeRules = defu({}, ..._routeRulesMatcher.matchAll(ctx.route).reverse());
+        const routeRules = defu$1({}, ..._routeRulesMatcher.matchAll(ctx.route).reverse());
+        const extractedOptions = extractOgImageOptions(html, routeRules.ogImage || {});
         if (!extractedOptions || routeRules.ogImage === false)
           return;
         const entry = {
           route: ctx.route,
           path: extractedOptions.component ? `/api/og-image-html?path=${ctx.route}` : ctx.route,
-          ...extractedOptions,
-          ...routeRules.ogImage || {}
+          ...extractedOptions
         };
         if ((nuxt.options._generate || entry.cache) && entry.provider === "browser")
           screenshotQueue.push(entry);
@@ -749,23 +764,29 @@ export async function useProvider(provider) {
           browser = await createBrowser();
           if (browser) {
             nitro.logger.info(`Prerendering ${screenshotQueue.length} og:image screenshots...`);
-            for (const entry of screenshotQueue) {
+            for (const k in screenshotQueue) {
+              let entry = screenshotQueue[k];
               if (entry.route && Object.keys(entry).length === 1) {
                 const html = await $fetch(entry.route, { baseURL: withBase(nuxt.options.app.baseURL, host) });
-                const extractedOptions = extractOgImageOptions(html);
-                const routeRules = defu({}, ..._routeRulesMatcher.matchAll(entry.route).reverse());
-                Object.assign(entry, {
-                  // @ts-expect-error runtime
-                  path: extractedOptions.component ? `/api/og-image-html?path=${entry.route}` : entry.route,
-                  ...extractedOptions,
-                  ...routeRules.ogImage || {}
-                });
+                const routeRules = defu$1({}, ..._routeRulesMatcher.matchAll(entry.route).reverse());
+                const extractedOptions = extractOgImageOptions(html, routeRules.ogImage || {});
+                if (!extractedOptions || routeRules.ogImage === false) {
+                  entry.skip = true;
+                  continue;
+                }
+                screenshotQueue[k] = entry = defu$1(
+                  { path: extractedOptions.component ? `/api/og-image-html?path=${entry.route}` : entry.route },
+                  entry,
+                  extractedOptions
+                );
               }
-              if (entry.component)
+              if (!entry.skip && entry.component)
                 entry.html = await globalThis.$fetch(entry.path);
             }
             for (const k in screenshotQueue) {
               const entry = screenshotQueue[k];
+              if (entry.skip)
+                continue;
               const start = Date.now();
               let hasError = false;
               const dirname2 = joinURL(nitro.options.output.publicDir, entry.route, "/__og_image__/");

package/dist/runtime/browserUtil.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
 import type { Buffer } from 'node:buffer';
 import type { Browser } from 'playwright-core';
-import type { ScreenshotOptions } from '../types';
+import type { ScreenshotOptions } from './types';
 export declare function screenshot(browser: Browser, options: Partial<ScreenshotOptions> & Record<string, any>): Promise<Buffer>;

package/dist/runtime/components/OgImage/Cached.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions } from '../../../types';
+import type { OgImageOptions } from '../../types';
 declare const _default: import("vue").DefineComponent<OgImageOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<OgImageOptions>>, {
     [x: string]: any;
 }, {}>;

package/dist/runtime/components/OgImage/Dynamic.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions } from '../../../types';
+import type { OgImageOptions } from '../../types';
 /**
  * @deprecated Use OgImageWithoutCache
  */

package/dist/runtime/components/OgImage/Screenshot.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageScreenshotOptions } from '../../../types';
+import type { OgImageScreenshotOptions } from '../../types';
 declare const _default: import("vue").DefineComponent<OgImageScreenshotOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<OgImageScreenshotOptions>>, {
     [x: string]: any;
     [x: number]: any;

package/dist/runtime/components/OgImage/Static.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions } from '../../../types';
+import type { OgImageOptions } from '../../types';
 /**
  * @deprecated Use OgImageCached instead
  */

package/dist/runtime/components/OgImage/WithoutCache.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions } from '../../../types';
+import type { OgImageOptions } from '../../types';
 declare const _default: import("vue").DefineComponent<OgImageOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<OgImageOptions>>, {
     [x: string]: any;
 }, {}>;

package/dist/runtime/components/OgImage/index.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions } from '../../../types';
+import type { OgImageOptions } from '../../types';
 declare const _default: import("vue").DefineComponent<OgImageOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<OgImageOptions>>, {
     [x: string]: any;
 }, {}>;

package/dist/runtime/composables/defineOgImage.d.ts

@@ -1,4 +1,4 @@
-import type { OgImageOptions, OgImageScreenshotOptions } from '../../types';
+import type { OgImageOptions, OgImageScreenshotOptions } from '../types';
 export declare function defineOgImageScreenshot(options?: OgImageScreenshotOptions): Promise<void>;
 /**
  * @deprecated Use `defineOgImage` or `defineOgImageCached` instead

package/dist/runtime/composables/util.d.ts

@@ -1,2 +1,2 @@
-import type { OgImageOptions } from '../../types';
+import type { OgImageOptions } from '../types';
 export declare function normaliseOgImageOptions(_options: OgImageOptions): any;

package/dist/runtime/composables/util.mjs

@@ -11,14 +11,11 @@ export function normaliseOgImageOptions(_options) {
     options.provider = "browser";
   if (options.component && componentNames) {
     const originalName = options.component;
-    let isValid = componentNames.some((component) => component.pascalName === originalName || component.kebabName === originalName);
-    if (!isValid) {
-      for (const component of componentNames) {
-        if (component.pascalName.endsWith(originalName) || component.kebabName.endsWith(originalName)) {
-          options.component = component.pascalName;
-          isValid = true;
-          break;
-        }
+    for (const component of componentNames) {
+      if (component.pascalName.endsWith(originalName) || component.kebabName.endsWith(originalName)) {
+        options.component = component.pascalName;
+        options.componentHash = component.hash;
+        break;
       }
     }
   }

package/dist/runtime/nitro/middleware/og.png.mjs

@@ -7,7 +7,7 @@ import { fetchOptions } from "../utils.mjs";
 import { useProvider } from "#nuxt-og-image/provider";
 import { useNitroOrigin, useRuntimeConfig, useStorage } from "#imports";
 export default defineEventHandler(async (e) => {
-  const { runtimeBrowser, runtimeCacheStorage } = useRuntimeConfig()["nuxt-og-image"];
+  const { runtimeBrowser, runtimeCacheStorage, version } = useRuntimeConfig()["nuxt-og-image"];
   const path = parseURL(e.path).pathname;
   if (!path.endsWith("__og_image__/og.png"))
     return;
@@ -25,7 +25,7 @@ export default defineEventHandler(async (e) => {
     });
   }
   const useCache = runtimeCacheStorage && !process.dev && options.cacheTtl && options.cacheTtl > 0 && options.cache;
-  const baseCacheKey = runtimeCacheStorage === "default" ? "/cache/og-image" : "/og-image";
+  const baseCacheKey = runtimeCacheStorage === "default" ? `/cache/og-image${version}` : `/og-image/${version}`;
   const cache = prefixStorage(useStorage(), `${baseCacheKey}/images`);
   const key = [options.path === "/" || !options.path ? "index" : options.path, hash(options)].join(":");
   let png;

package/dist/runtime/nitro/providers/png/resvg-node.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
 import type { ResvgRenderOptions } from '@resvg/resvg-js';
-import type { RuntimeOgImageOptions } from '../../../../types';
+import type { RuntimeOgImageOptions } from '../../../types';
 export default function (svg: string, options: ResvgRenderOptions & RuntimeOgImageOptions): Promise<Buffer>;

package/dist/runtime/nitro/providers/png/resvg-wasm.d.ts

@@ -1,3 +1,3 @@
 import type { ResvgRenderOptions } from '@resvg/resvg-wasm';
-import type { RuntimeOgImageOptions } from '../../../../types';
+import type { RuntimeOgImageOptions } from '../../../types';
 export default function (svg: string, options: ResvgRenderOptions & RuntimeOgImageOptions): Promise<Uint8Array>;

package/dist/runtime/nitro/providers/png/svg2png.d.ts

@@ -1,3 +1,3 @@
 import type { ConvertOptions } from 'svg2png-wasm';
-import type { RuntimeOgImageOptions } from '../../../../types';
+import type { RuntimeOgImageOptions } from '../../../types';
 export default function (svg: string, options: ConvertOptions & RuntimeOgImageOptions): Promise<Uint8Array>;

package/dist/runtime/nitro/providers/satori/yoga-wasm.d.ts

@@ -1,3 +1,3 @@
 import type { SatoriOptions } from 'satori';
-import type { RuntimeOgImageOptions } from '../../../../types';
+import type { RuntimeOgImageOptions } from '../../../types';
 export default function (nodes: string, options: SatoriOptions & RuntimeOgImageOptions): Promise<string>;

package/dist/runtime/nitro/renderers/browser.d.ts

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

package/dist/runtime/nitro/renderers/satori/index.d.ts

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

package/dist/runtime/nitro/renderers/satori/plugins/emojis.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../../../types").SatoriTransformer | import("../../../../../types").SatoriTransformer[];
+declare const _default: import("../../../../types").SatoriTransformer | import("../../../../types").SatoriTransformer[];
 export default _default;

package/dist/runtime/nitro/renderers/satori/plugins/encoding.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../../../types").SatoriTransformer | import("../../../../../types").SatoriTransformer[];
+declare const _default: import("../../../../types").SatoriTransformer | import("../../../../types").SatoriTransformer[];
 export default _default;

package/dist/runtime/nitro/renderers/satori/plugins/flex.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../../../types").SatoriTransformer | import("../../../../../types").SatoriTransformer[];
+declare const _default: import("../../../../types").SatoriTransformer | import("../../../../types").SatoriTransformer[];
 export default _default;

package/dist/runtime/nitro/renderers/satori/plugins/imageSrc.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../../../types").SatoriTransformer | import("../../../../../types").SatoriTransformer[];
+declare const _default: import("../../../../types").SatoriTransformer | import("../../../../types").SatoriTransformer[];
 export default _default;

package/dist/runtime/nitro/renderers/satori/plugins/twClasses.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../../../../types").SatoriTransformer | import("../../../../../types").SatoriTransformer[];
+declare const _default: import("../../../../types").SatoriTransformer | import("../../../../types").SatoriTransformer[];
 export default _default;

package/dist/runtime/nitro/renderers/satori/utils.d.ts

@@ -1,4 +1,4 @@
-import type { FontConfig, RuntimeOgImageOptions, SatoriTransformer, VNode } from '../../../../types';
+import type { FontConfig, RuntimeOgImageOptions, SatoriTransformer, VNode } from '../../../types';
 export declare function loadFont(requestOrigin: string, font: FontConfig): Promise<any>;
 export declare function walkSatoriTree(node: VNode, plugins: (SatoriTransformer | SatoriTransformer[])[], props: RuntimeOgImageOptions): Promise<void>;
 export declare function defineSatoriTransformer(transformer: SatoriTransformer | SatoriTransformer[]): SatoriTransformer | SatoriTransformer[];

package/dist/runtime/nitro/routes/options.d.ts

@@ -1,3 +1,3 @@
-import type { RuntimeOgImageOptions } from '../../../types';
+import type { RuntimeOgImageOptions } from '../../types';
 declare const _default: import("h3").EventHandler<false | RuntimeOgImageOptions>;
 export default _default;

package/dist/runtime/nitro/routes/options.mjs

@@ -16,21 +16,21 @@ export default defineEventHandler(async (e) => {
       statusMessage: `Failed to read the path ${path} for og-image extraction. ${err.message}.`
     });
   }
-  const extractedPayload = extractOgImageOptions(html);
-  if (!extractedPayload) {
-    throw createError({
-      statusCode: 500,
-      statusMessage: `The path ${path} is missing the og-image payload.`
-    });
-  }
   e.node.req.url = path;
   const oldRouteRules = e.context._nitro.routeRules;
   e.context._nitro.routeRules = void 0;
-  const routeRules = getRouteRules(e)?.ogImage;
+  const routeRules = getRouteRules(e)?.ogImage || {};
   e.context._nitro.routeRules = oldRouteRules;
   e.node.req.url = e.path;
   if (routeRules === false)
     return false;
+  const extractedPayload = extractOgImageOptions(html, routeRules);
+  if (!extractedPayload) {
+    throw createError({
+      statusCode: 500,
+      statusMessage: `The path ${path} is missing the og-image payload.`
+    });
+  }
   const { defaults } = useRuntimeConfig()["nuxt-og-image"];
   return defu(
     extractedPayload,

package/dist/runtime/nitro/utils-pure.d.ts

@@ -1,3 +1,3 @@
-import type { OgImageOptions } from '../../types';
+import type { OgImageOptions } from '../types';
 export declare function decodeHtml(html: string): string;
-export declare function extractOgImageOptions(html: string): OgImageOptions | false;
+export declare function extractOgImageOptions(html: string, routeRules: OgImageOptions): OgImageOptions | false;

package/dist/runtime/nitro/utils-pure.mjs

@@ -1,3 +1,4 @@
+import { defu } from "defu";
 export function decodeHtml(html) {
   return html.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&").replace(/&cent;/g, "\xA2").replace(/&pound;/g, "\xA3").replace(/&yen;/g, "\xA5").replace(/&euro;/g, "\u20AC").replace(/&copy;/g, "\xA9").replace(/&reg;/g, "\xAE").replace(/&quot;/g, '"').replace(/&#39;/g, "'").replace(/&#x27;/g, "'").replace(/&#x2F;/g, "/").replace(/&#([0-9]+);/g, (full, int) => {
     return String.fromCharCode(Number.parseInt(int));
@@ -10,15 +11,20 @@ function decodeObjectHtmlEntities(obj) {
   });
   return obj;
 }
-export function extractOgImageOptions(html) {
+export function extractOgImageOptions(html, routeRules) {
   const htmlPayload = html.match(/<script id="nuxt-og-image-options" type="application\/json">(.+?)<\/script>/)?.[1];
   if (!htmlPayload)
     return false;
   let options;
   try {
-    options = JSON.parse(htmlPayload);
+    const payload = JSON.parse(htmlPayload);
+    Object.entries(payload).forEach(([key, value]) => {
+      if (!value)
+        delete payload[key];
+    });
+    options = defu(payload, routeRules);
   } catch (e) {
-    options = false;
+    options = routeRules;
     if (process.dev)
       console.warn("Failed to parse #nuxt-og-image-options", e, options);
   }

package/dist/runtime/nitro/utils.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Buffer } from 'node:buffer';
 import type { H3Event } from 'h3';
-import type { RuntimeOgImageOptions } from '../../types';
+import type { RuntimeOgImageOptions } from '../types';
 export declare function wasmLoader(asyncModuleLoad: Promise<any> | Buffer | string, fallback: string): {
     load(options: RuntimeOgImageOptions): Promise<any>;
 };

package/dist/runtime/nitro/utils.mjs

@@ -37,11 +37,10 @@ export function wasmLoader(asyncModuleLoad, fallback) {
   };
 }
 export async function fetchOptions(e, path) {
-  const { runtimeCacheStorage } = useRuntimeConfig()["nuxt-og-image"];
-  const baseCacheKey = runtimeCacheStorage === "default" ? "/cache/og-image" : "/og-image";
+  const { runtimeCacheStorage, version } = useRuntimeConfig()["nuxt-og-image"];
+  const baseCacheKey = runtimeCacheStorage === "default" ? `/cache/og-image${version}` : `/og-image/${version}`;
   const cache = runtimeCacheStorage || process.env.prerender ? prefixStorage(useStorage(), `${baseCacheKey}/options`) : false;
-  let key = path.replace("/__og_image__/og.png", "");
-  key = key === "/" || !key ? "index" : key;
+  const key = [path === "/" || !path ? "index" : path].join(":");
   let options;
   if (!process.dev && cache && await cache.hasItem(key)) {
     const cachedValue = await cache.getItem(key);
@@ -61,7 +60,7 @@ export async function fetchOptions(e, path) {
       await cache.setItem(key, {
         value: options,
         // cache for 1 minute or 5 seconds, avoids subsequent internal fetches
-        expiresAt: Date.now() + (options.cache ? 60 * 60 * 1e3 : 5 * 1e3)
+        expiresAt: Date.now() + (options.cache ? 60 * 1e3 : 5 * 1e3)
       });
     }
   }

package/dist/runtime/types.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+import type { Buffer } from 'node:buffer';
+import type { html } from 'satori-html';
+import type { ModuleOptions } from '../module';
+export interface ScreenshotOptions {
+    colorScheme?: 'dark' | 'light';
+    selector?: string;
+    mask?: string;
+    /**
+     * The width of the screenshot.
+     *
+     * @default 1200
+     */
+    width: number;
+    /**
+     * The height of the screenshot.
+     *
+     * @default 630
+     */
+    height: number;
+    /**
+     * How long to wait before taking the screenshot. Useful for waiting for animations.
+     */
+    delay?: number;
+}
+export interface OgImageOptions extends Partial<ScreenshotOptions> {
+    provider?: 'browser' | 'satori';
+    title?: string;
+    description?: string;
+    component?: string | null;
+    alt?: string;
+    cache?: boolean;
+    cacheKey?: string;
+    cacheTtl?: number;
+    /**
+     * @deprecated Use `cache` instead
+     */
+    static?: boolean;
+    [key: string]: any;
+}
+export interface RuntimeOgImageOptions extends OgImageOptions {
+    path: string;
+    requestOrigin: string;
+}
+export interface FontConfig {
+    name: string;
+    weight: number;
+    path?: string;
+}
+export type InputFontConfig = (`${string}:${number}` | FontConfig);
+export interface Renderer {
+    name: 'browser' | 'satori';
+    createSvg: (options: RuntimeOgImageOptions) => Promise<string>;
+    createPng: (options: RuntimeOgImageOptions) => Promise<Buffer>;
+    createVNode: (options: RuntimeOgImageOptions) => Promise<VNode>;
+}
+export type OgImageScreenshotOptions = Omit<OgImageOptions, 'component'>;
+export interface PlaygroundServerFunctions {
+    openInEditor(filepath: string): void;
+    getConfig(): ModuleOptions;
+}
+export interface PlaygroundClientFunctions {
+    refresh(type: string): void;
+}
+export type VNode = ReturnType<typeof html>;
+export interface SatoriTransformer {
+    filter: (node: VNode) => boolean;
+    transform: (node: VNode, props: RuntimeOgImageOptions) => Promise<void>;
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "nuxt-og-image",
   "type": "module",
-  "version": "2.0.3",
-  "packageManager": "pnpm@8.6.5",
+  "version": "2.0.5",
+  "packageManager": "pnpm@8.6.6",
   "description": "Enlightened OG Image generation for Nuxt.",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -27,7 +27,7 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.6.1",
+    "@nuxt/kit": "^3.6.2",
     "@resvg/resvg-js": "^2.4.1",
     "@resvg/resvg-wasm": "^2.4.1",
     "@types/fs-extra": "^11.0.1",
@@ -39,12 +39,12 @@
     "fast-glob": "^3.3.0",
     "flatted": "^3.2.7",
     "fs-extra": "^11.1.1",
-    "globby": "^13.2.1",
+    "globby": "^13.2.2",
     "image-size": "^1.0.2",
     "inline-css": "^4.0.2",
     "launch-editor": "^2.6.0",
-    "nuxt-site-config": "^0.8.1",
-    "nuxt-site-config-kit": "^0.8.1",
+    "nuxt-site-config": "^1.0.3",
+    "nuxt-site-config-kit": "^1.0.3",
     "nypm": "^0.2.2",
     "ofetch": "^1.1.1",
     "ohash": "^1.1.2",
@@ -63,20 +63,23 @@
     "yoga-wasm-web": "^0.3.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.39.6",
-    "@nuxt/devtools-edge": "0.6.6-28139075.95f3dd8",
+    "@antfu/eslint-config": "^0.39.7",
+    "@nuxt/devtools-edge": "0.6.6-28142701.2977264",
     "@nuxt/module-builder": "^0.4.0",
-    "@nuxt/test-utils": "3.6.1",
+    "@nuxt/test-utils": "3.6.2",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@types/ws": "^8.5.5",
     "bumpp": "^9.1.1",
     "eslint": "8.44.0",
     "jest-image-snapshot": "^6.1.0",
-    "nuxt": "^3.6.1",
+    "nuxt": "^3.6.2",
     "nuxt-icon": "^0.4.2",
     "playwright": "^1.35.1",
     "sass": "^1.63.6",
-    "vitest": "^0.32.4"
+    "vitest": "^0.33.0"
+  },
+  "resolutions": {
+    "@nuxt/schema": "3.6.2"
   },
   "scripts": {
     "build": "pnpm dev:prepare && pnpm build:module && pnpm build:client",