nuxt-og-image 5.1.13 → 6.0.0-beta.1

package/dist/module.d.cts

@@ -3,7 +3,8 @@ import { AddComponentOptions } from '@nuxt/kit';
 import { ResvgRenderOptions } from '@resvg/resvg-js';
 import { SatoriOptions } from 'satori';
 import { SharpOptions } from 'sharp';
-import { OgImageOptions, InputFontConfig, CompatibilityFlagEnvOverrides, OgImageComponent } from '../dist/runtime/types.js';
+import { OgImageComponent, OgImageOptions, CompatibilityFlagEnvOverrides } from '../dist/runtime/types.js';
+export { OgImageComponent, OgImageOptions, OgImageRenderEventContext, OgImageRuntimeConfig, RuntimeCompatibilitySchema, VNode } from '../dist/runtime/types.js';
 
 interface ModuleOptions {
     /**
@@ -20,12 +21,6 @@ interface ModuleOptions {
      * @default { component: 'NuxtSeo', width: 1200, height: 630, cache: true, cacheTtl: 24 * 60 * 60 * 1000 }
      */
     defaults: OgImageOptions;
-    /**
-     * Fonts to use when rendering the og:image.
-     *
-     * @example ['Roboto:400', 'Roboto:700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
-     */
-    fonts: InputFontConfig[];
     /**
      * Options to pass to satori.
      *
@@ -55,19 +50,32 @@ interface ModuleOptions {
      */
     componentOptions?: Pick<AddComponentOptions, 'global'>;
     /**
-     * Modify the cache behavior.
-     *
-     * Passing a boolean will enable or disable the runtime cache with the default options.
-     *
-     * Providing a record will allow you to configure the runtime cache fully.
+     * Configure the runtime cache storage for generated OG images.
+     * - `true` - Use Nitro's default cache storage (default)
+     * - `false` - Disable caching
+     * - `string` - Use a custom storage mount key (e.g., `'redis'`). You must mount the storage yourself via a Nitro plugin.
+     * - `object` - Provide a driver config that the module will mount for you (build-time only)
      *
      * @default true
      * @see https://nitro.unjs.io/guide/storage#mountpoints
-     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
+     * @example runtimeCacheStorage: 'redis' // Use your own mounted 'redis' storage
+     * @example runtimeCacheStorage: { driver: 'redis', host: 'localhost', port: 6379 }
      */
-    runtimeCacheStorage: boolean | (Record<string, any> & {
+    runtimeCacheStorage: boolean | string | (Record<string, any> & {
         driver: string;
     });
+    /**
+     * Custom version string for cache key namespacing.
+     *
+     * By default, the module version is used which invalidates cache on upgrades.
+     * Set a static value like `'v1'` to persist cache across module updates.
+     * Set to `false` to disable versioning entirely.
+     *
+     * @default module version
+     * @example cacheVersion: 'v1'
+     * @example cacheVersion: false
+     */
+    cacheVersion?: string | false;
     /**
      * Extra component directories that should be used to resolve components.
      *
@@ -79,25 +87,55 @@ interface ModuleOptions {
      */
     compatibility?: CompatibilityFlagEnvOverrides;
     /**
-     * Use an alternative host for downloading Google Fonts.
+     * Only allow the prerendering and dev runtimes to generate images.
+     */
+    zeroRuntime?: boolean;
+    /**
+     * Enable persistent build cache for CI environments.
+     * Caches rendered images to disk so they persist between CI runs.
      *
-     * Provide a custom mirror host (e.g., your own proxy server).
-     * Note: The mirror must serve TTF fonts for Satori compatibility.
-     * For China users, consider using local font files via the `path` option instead.
+     * @default false
+     * @example true
+     * @example { base: '.cache/og-image' }
      */
-    googleFontMirror?: string;
+    buildCache?: boolean | {
+        base?: string;
+    };
     /**
-     * Only allow the prerendering and dev runtimes to generate images.
+     * Warn about OG Image components missing renderer suffix in dev mode.
+     * Set to false to suppress warnings for legacy/test components.
+     *
+     * @default true
      */
-    zeroRuntime?: boolean;
+    warnMissingSuffix?: boolean;
+    /**
+     * Strategy for resolving emoji icons.
+     *
+     * - 'auto': Automatically choose based on available dependencies (default)
+     * - 'local': Use local @iconify-json dependencies only
+     * - 'fetch': Use Iconify API to fetch emojis
+     *
+     * @default 'auto'
+     */
+    emojiStrategy?: 'auto' | 'local' | 'fetch';
+    /**
+     * Include query parameters in cache keys.
+     *
+     * When enabled, requests like `/page?foo=bar` will have a separate cache from `/page`.
+     * Enable this if your OG image content depends on query params.
+     *
+     * @default false
+     */
+    cacheQueryParams?: boolean;
     /**
-     * Enable when your nuxt/content files match your pages.
+     * Path to your Tailwind CSS 4 entry file for OG image styling.
      *
-     * This will automatically map the `ogImage` frontmatter key to the correct path.
+     * Use this when using Tailwind 4 with the Vite plugin instead of @nuxtjs/tailwindcss.
+     * The CSS file should include `@import "tailwindcss"` and any `@theme` customizations.
      *
-     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
+     * @example '~/assets/css/main.css'
      */
-    strictNuxtContentPaths?: boolean;
+    tailwindCss?: string;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.d.mts

@@ -3,7 +3,8 @@ import { AddComponentOptions } from '@nuxt/kit';
 import { ResvgRenderOptions } from '@resvg/resvg-js';
 import { SatoriOptions } from 'satori';
 import { SharpOptions } from 'sharp';
-import { OgImageOptions, InputFontConfig, CompatibilityFlagEnvOverrides, OgImageComponent } from '../dist/runtime/types.js';
+import { OgImageComponent, OgImageOptions, CompatibilityFlagEnvOverrides } from '../dist/runtime/types.js';
+export { OgImageComponent, OgImageOptions, OgImageRenderEventContext, OgImageRuntimeConfig, RuntimeCompatibilitySchema, VNode } from '../dist/runtime/types.js';
 
 interface ModuleOptions {
     /**
@@ -20,12 +21,6 @@ interface ModuleOptions {
      * @default { component: 'NuxtSeo', width: 1200, height: 630, cache: true, cacheTtl: 24 * 60 * 60 * 1000 }
      */
     defaults: OgImageOptions;
-    /**
-     * Fonts to use when rendering the og:image.
-     *
-     * @example ['Roboto:400', 'Roboto:700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
-     */
-    fonts: InputFontConfig[];
     /**
      * Options to pass to satori.
      *
@@ -55,19 +50,32 @@ interface ModuleOptions {
      */
     componentOptions?: Pick<AddComponentOptions, 'global'>;
     /**
-     * Modify the cache behavior.
-     *
-     * Passing a boolean will enable or disable the runtime cache with the default options.
-     *
-     * Providing a record will allow you to configure the runtime cache fully.
+     * Configure the runtime cache storage for generated OG images.
+     * - `true` - Use Nitro's default cache storage (default)
+     * - `false` - Disable caching
+     * - `string` - Use a custom storage mount key (e.g., `'redis'`). You must mount the storage yourself via a Nitro plugin.
+     * - `object` - Provide a driver config that the module will mount for you (build-time only)
      *
      * @default true
      * @see https://nitro.unjs.io/guide/storage#mountpoints
-     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
+     * @example runtimeCacheStorage: 'redis' // Use your own mounted 'redis' storage
+     * @example runtimeCacheStorage: { driver: 'redis', host: 'localhost', port: 6379 }
      */
-    runtimeCacheStorage: boolean | (Record<string, any> & {
+    runtimeCacheStorage: boolean | string | (Record<string, any> & {
         driver: string;
     });
+    /**
+     * Custom version string for cache key namespacing.
+     *
+     * By default, the module version is used which invalidates cache on upgrades.
+     * Set a static value like `'v1'` to persist cache across module updates.
+     * Set to `false` to disable versioning entirely.
+     *
+     * @default module version
+     * @example cacheVersion: 'v1'
+     * @example cacheVersion: false
+     */
+    cacheVersion?: string | false;
     /**
      * Extra component directories that should be used to resolve components.
      *
@@ -79,25 +87,55 @@ interface ModuleOptions {
      */
     compatibility?: CompatibilityFlagEnvOverrides;
     /**
-     * Use an alternative host for downloading Google Fonts.
+     * Only allow the prerendering and dev runtimes to generate images.
+     */
+    zeroRuntime?: boolean;
+    /**
+     * Enable persistent build cache for CI environments.
+     * Caches rendered images to disk so they persist between CI runs.
      *
-     * Provide a custom mirror host (e.g., your own proxy server).
-     * Note: The mirror must serve TTF fonts for Satori compatibility.
-     * For China users, consider using local font files via the `path` option instead.
+     * @default false
+     * @example true
+     * @example { base: '.cache/og-image' }
      */
-    googleFontMirror?: string;
+    buildCache?: boolean | {
+        base?: string;
+    };
     /**
-     * Only allow the prerendering and dev runtimes to generate images.
+     * Warn about OG Image components missing renderer suffix in dev mode.
+     * Set to false to suppress warnings for legacy/test components.
+     *
+     * @default true
      */
-    zeroRuntime?: boolean;
+    warnMissingSuffix?: boolean;
+    /**
+     * Strategy for resolving emoji icons.
+     *
+     * - 'auto': Automatically choose based on available dependencies (default)
+     * - 'local': Use local @iconify-json dependencies only
+     * - 'fetch': Use Iconify API to fetch emojis
+     *
+     * @default 'auto'
+     */
+    emojiStrategy?: 'auto' | 'local' | 'fetch';
+    /**
+     * Include query parameters in cache keys.
+     *
+     * When enabled, requests like `/page?foo=bar` will have a separate cache from `/page`.
+     * Enable this if your OG image content depends on query params.
+     *
+     * @default false
+     */
+    cacheQueryParams?: boolean;
     /**
-     * Enable when your nuxt/content files match your pages.
+     * Path to your Tailwind CSS 4 entry file for OG image styling.
      *
-     * This will automatically map the `ogImage` frontmatter key to the correct path.
+     * Use this when using Tailwind 4 with the Vite plugin instead of @nuxtjs/tailwindcss.
+     * The CSS file should include `@import "tailwindcss"` and any `@theme` customizations.
      *
-     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
+     * @example '~/assets/css/main.css'
      */
-    strictNuxtContentPaths?: boolean;
+    tailwindCss?: string;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.d.ts

@@ -3,7 +3,8 @@ import { AddComponentOptions } from '@nuxt/kit';
 import { ResvgRenderOptions } from '@resvg/resvg-js';
 import { SatoriOptions } from 'satori';
 import { SharpOptions } from 'sharp';
-import { OgImageOptions, InputFontConfig, CompatibilityFlagEnvOverrides, OgImageComponent } from '../dist/runtime/types.js';
+import { OgImageComponent, OgImageOptions, CompatibilityFlagEnvOverrides } from '../dist/runtime/types.js';
+export { OgImageComponent, OgImageOptions, OgImageRenderEventContext, OgImageRuntimeConfig, RuntimeCompatibilitySchema, VNode } from '../dist/runtime/types.js';
 
 interface ModuleOptions {
     /**
@@ -20,12 +21,6 @@ interface ModuleOptions {
      * @default { component: 'NuxtSeo', width: 1200, height: 630, cache: true, cacheTtl: 24 * 60 * 60 * 1000 }
      */
     defaults: OgImageOptions;
-    /**
-     * Fonts to use when rendering the og:image.
-     *
-     * @example ['Roboto:400', 'Roboto:700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
-     */
-    fonts: InputFontConfig[];
     /**
      * Options to pass to satori.
      *
@@ -55,19 +50,32 @@ interface ModuleOptions {
      */
     componentOptions?: Pick<AddComponentOptions, 'global'>;
     /**
-     * Modify the cache behavior.
-     *
-     * Passing a boolean will enable or disable the runtime cache with the default options.
-     *
-     * Providing a record will allow you to configure the runtime cache fully.
+     * Configure the runtime cache storage for generated OG images.
+     * - `true` - Use Nitro's default cache storage (default)
+     * - `false` - Disable caching
+     * - `string` - Use a custom storage mount key (e.g., `'redis'`). You must mount the storage yourself via a Nitro plugin.
+     * - `object` - Provide a driver config that the module will mount for you (build-time only)
      *
      * @default true
      * @see https://nitro.unjs.io/guide/storage#mountpoints
-     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
+     * @example runtimeCacheStorage: 'redis' // Use your own mounted 'redis' storage
+     * @example runtimeCacheStorage: { driver: 'redis', host: 'localhost', port: 6379 }
      */
-    runtimeCacheStorage: boolean | (Record<string, any> & {
+    runtimeCacheStorage: boolean | string | (Record<string, any> & {
         driver: string;
     });
+    /**
+     * Custom version string for cache key namespacing.
+     *
+     * By default, the module version is used which invalidates cache on upgrades.
+     * Set a static value like `'v1'` to persist cache across module updates.
+     * Set to `false` to disable versioning entirely.
+     *
+     * @default module version
+     * @example cacheVersion: 'v1'
+     * @example cacheVersion: false
+     */
+    cacheVersion?: string | false;
     /**
      * Extra component directories that should be used to resolve components.
      *
@@ -79,25 +87,55 @@ interface ModuleOptions {
      */
     compatibility?: CompatibilityFlagEnvOverrides;
     /**
-     * Use an alternative host for downloading Google Fonts.
+     * Only allow the prerendering and dev runtimes to generate images.
+     */
+    zeroRuntime?: boolean;
+    /**
+     * Enable persistent build cache for CI environments.
+     * Caches rendered images to disk so they persist between CI runs.
      *
-     * Provide a custom mirror host (e.g., your own proxy server).
-     * Note: The mirror must serve TTF fonts for Satori compatibility.
-     * For China users, consider using local font files via the `path` option instead.
+     * @default false
+     * @example true
+     * @example { base: '.cache/og-image' }
      */
-    googleFontMirror?: string;
+    buildCache?: boolean | {
+        base?: string;
+    };
     /**
-     * Only allow the prerendering and dev runtimes to generate images.
+     * Warn about OG Image components missing renderer suffix in dev mode.
+     * Set to false to suppress warnings for legacy/test components.
+     *
+     * @default true
      */
-    zeroRuntime?: boolean;
+    warnMissingSuffix?: boolean;
+    /**
+     * Strategy for resolving emoji icons.
+     *
+     * - 'auto': Automatically choose based on available dependencies (default)
+     * - 'local': Use local @iconify-json dependencies only
+     * - 'fetch': Use Iconify API to fetch emojis
+     *
+     * @default 'auto'
+     */
+    emojiStrategy?: 'auto' | 'local' | 'fetch';
+    /**
+     * Include query parameters in cache keys.
+     *
+     * When enabled, requests like `/page?foo=bar` will have a separate cache from `/page`.
+     * Enable this if your OG image content depends on query params.
+     *
+     * @default false
+     */
+    cacheQueryParams?: boolean;
     /**
-     * Enable when your nuxt/content files match your pages.
+     * Path to your Tailwind CSS 4 entry file for OG image styling.
      *
-     * This will automatically map the `ogImage` frontmatter key to the correct path.
+     * Use this when using Tailwind 4 with the Vite plugin instead of @nuxtjs/tailwindcss.
+     * The CSS file should include `@import "tailwindcss"` and any `@theme` customizations.
      *
-     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
+     * @example '~/assets/css/main.css'
      */
-    strictNuxtContentPaths?: boolean;
+    tailwindCss?: string;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.json

@@ -4,7 +4,7 @@
     "nuxt": ">=3.16.0"
   },
   "configKey": "ogImage",
-  "version": "5.1.13",
+  "version": "6.0.0-beta.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"