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

package/dist/runtime/types.d.ts

@@ -1,28 +1,31 @@
 import type { OgImageComponents } from '#og-image/components';
 import type { ResvgRenderOptions } from '@resvg/resvg-js';
-import type { UnoGenerator } from '@unocss/core';
 import type { AllowedComponentProps, Component, ComponentCustomProps, VNodeProps } from '@vue/runtime-core';
 import type { H3Error, H3Event } from 'h3';
-import type { NitroOptions } from 'nitropack';
-import type { NitroApp } from 'nitropack/types';
+import type { Hookable } from 'hookable';
+import type { NitroRuntimeHooks } from 'nitropack/types';
 import type { SatoriOptions } from 'satori';
 import type { html } from 'satori-html';
 import type { JpegOptions, SharpOptions } from 'sharp';
 import type { Ref } from 'vue';
+interface NitroApp {
+    hooks: Hookable<NitroRuntimeHooks>;
+    [key: string]: any;
+}
 export interface OgImageRenderEventContext {
-    unocss: UnoGenerator;
     e: H3Event;
     extension: 'png' | 'jpeg' | 'jpg' | 'svg' | 'html' | 'json';
     key: string;
     basePath: string;
     renderer: Renderer;
     options: OgImageOptions;
-    isDebugJsonPayload: boolean;
+    isDevToolsContextRequest: boolean;
     publicStoragePath: string;
     runtimeConfig: OgImageRuntimeConfig;
     _nitro: NitroApp;
 }
 export type IconifyEmojiIconSets = 'twemoji' | 'noto' | 'fluent-emoji' | 'fluent-emoji-flat' | 'fluent-emoji-high-contrast' | 'noto-v1' | 'emojione' | 'emojione-monotone' | 'emojione-v1' | 'streamline-emojis' | 'openmoji';
+export type EmojiStrategy = 'auto' | 'local' | 'fetch';
 export interface OgImageRuntimeConfig {
     version: string;
     satoriOptions: SatoriOptions;
@@ -32,17 +35,24 @@ export interface OgImageRuntimeConfig {
     defaults: OgImageOptions;
     debug: boolean;
     baseCacheKey: string;
-    fonts: FontConfig[];
     hasNuxtIcon: boolean;
+    hasNuxtContent?: boolean;
     colorPreference: 'light' | 'dark';
     isNuxtContentDocumentDriven: boolean;
-    strictNuxtContentPaths: boolean;
     zeroRuntime: boolean;
+    cacheQueryParams: boolean;
     componentDirs?: string[];
+    /** Directory for persistent build cache (CI caching) */
+    buildCacheDir?: string;
+    /** Source directory for auto-eject (dev only) */
+    srcDir?: string;
+    /** Path to community templates (dev only) */
+    communityTemplatesDir?: string;
     app: {
         baseURL: string;
     };
 }
+export type RendererType = 'satori' | 'chromium' | 'takumi';
 export interface OgImageComponent {
     path?: string;
     pascalName: string;
@@ -50,6 +60,7 @@ export interface OgImageComponent {
     hash: string;
     category: 'app' | 'community' | 'pro';
     credits?: string;
+    renderer: RendererType;
 }
 export interface ScreenshotOptions {
     colorScheme?: 'dark' | 'light';
@@ -75,7 +86,7 @@ export interface ScreenshotOptions {
 export interface OgImagePrebuilt extends OgImageOptions {
 }
 export type DefineOgImageInput = OgImageOptions | OgImagePrebuilt | false;
-export interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
+export interface OgImageOptions<T extends keyof OgImageComponents = keyof OgImageComponents> {
     /**
      * The width of the screenshot.
      *
@@ -106,8 +117,13 @@ export interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
      * Props to pass to the component.
      */
     props?: OgImageComponents[T] | Record<string, any>;
-    renderer?: 'chromium' | 'satori';
-    extension?: 'png' | 'jpeg' | 'jpg';
+    /**
+     * Override renderer. Only used internally for screenshots.
+     * For normal usage, renderer is determined by component filename suffix.
+     * @internal
+     */
+    renderer?: RendererType;
+    extension?: 'png' | 'jpeg' | 'jpg' | 'svg' | 'html';
     emojis?: IconifyEmojiIconSets;
     /**
      * Provide a static HTML template to render the OG Image instead of a component.
@@ -117,7 +133,13 @@ export interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
     satori?: SatoriOptions;
     screenshot?: Partial<ScreenshotOptions>;
     sharp?: SharpOptions & JpegOptions;
-    fonts?: InputFontConfig[];
+    takumi?: {
+        format?: 'png' | 'jpeg' | 'webp';
+        persistentImages?: Array<{
+            src: string;
+            data: ArrayBuffer;
+        }>;
+    };
     cacheMaxAgeSeconds?: number;
     /**
      * Social preview metadata
@@ -128,27 +150,43 @@ export interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
      * @internal
      */
     _query?: Record<string, any>;
+    /**
+     * Hash for cache lookup when URL is too long for filesystem
+     * @internal
+     */
+    _hash?: string;
+    /**
+     * Allow multiple og images to be generated for the same route by setting a unique key.
+     */
+    key?: string;
+    /**
+     * Custom cache key for this OG image.
+     *
+     * When set, this key is used directly for caching instead of the auto-generated key.
+     */
+    cacheKey?: string;
 }
 export interface FontConfig {
-    name: string;
-    style?: 'normal' | 'ital';
-    weight?: string | number;
-    path?: string;
-    key?: string;
-    absolutePath?: boolean;
+    family: string;
+    weight: number;
+    style: 'normal' | 'italic';
+    src: string;
+    localPath: string;
 }
-export interface ResolvedFontConfig extends FontConfig {
+export interface SatoriFontConfig extends FontConfig {
     cacheKey: string;
-    data?: BufferSource;
+    name: string;
+    data: BufferSource;
 }
-export type InputFontConfig = (`${string}:${number}` | `${string}:${'normal' | 'ital'}:${number}` | string | FontConfig);
 export interface RuntimeCompatibilitySchema {
     chromium: 'chrome-launcher' | 'on-demand' | 'playwright' | false;
     ['css-inline']: 'node' | 'wasm' | 'wasm-fs' | false;
-    resvg: 'node' | 'wasm' | 'wasm-fs' | false;
+    resvg: 'node' | 'node-dev' | 'wasm' | 'wasm-fs' | false;
     satori: 'node' | 'wasm' | 'wasm-fs' | false;
+    takumi: 'node' | 'wasm' | false;
     sharp: 'node' | false;
-    wasm?: NitroOptions['wasm'];
+    emoji?: 'local' | 'fetch';
+    wasm?: any;
 }
 export type CompatibilityFlags = Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>;
 export interface CompatibilityFlagEnvOverrides {
@@ -160,18 +198,25 @@ export type RendererOptions = Omit<OgImageOptions, 'extension'> & {
     extension: Omit<OgImageOptions['extension'], 'html'>;
 };
 export interface Renderer {
-    name: 'chromium' | 'satori';
+    name: 'chromium' | 'satori' | 'takumi';
     supportedFormats: Partial<RendererOptions['extension']>[];
     createImage: (e: OgImageRenderEventContext) => Promise<H3Error | BufferSource | Buffer | Uint8Array | void | undefined>;
     debug: (e: OgImageRenderEventContext) => Promise<Record<string, any>>;
 }
 export type ExtractComponentProps<T extends Component> = T extends new (...args: any) => any ? Omit<InstanceType<T>['$props'], keyof ComponentCustomProps | keyof VNodeProps | keyof AllowedComponentProps> : never;
-export type OgImagePageScreenshotOptions = Omit<OgImageOptions, 'html' | 'renderer' | 'component' | 'satori' | 'resvg' | 'sharp'>;
-export type VNode = ReturnType<typeof html>;
+export type OgImagePageScreenshotOptions = Omit<OgImageOptions, 'html' | 'component' | 'satori' | 'resvg' | 'sharp'>;
+export type VNode = ReturnType<typeof html> & {
+    _emojiMatches?: RegExpMatchArray | null;
+};
 export interface SatoriTransformer {
     filter: (node: VNode) => boolean;
     transform: (node: VNode, e: OgImageRenderEventContext) => Promise<void> | void;
 }
+export interface DevToolsMetaDataExtraction {
+    key: string;
+    twitter?: Record<string, string>;
+    og?: Record<string, string>;
+}
 export interface SocialPreviewMetaData {
     twitter?: Record<string, string>;
     og?: Record<string, string> & {
@@ -185,3 +230,4 @@ export interface SocialPreviewMetaData {
 export interface RouteRulesOgImage extends Partial<OgImageOptions> {
     [key: string]: any;
 }
+export {};