nuxt-og-image 2.0.0-beta.9 → 2.0.1

package/dist/module.d.ts

@@ -24,30 +24,136 @@ interface ScreenshotOptions {
 }
 interface OgImageOptions extends Partial<ScreenshotOptions> {
     provider?: 'browser' | 'satori';
-    static?: boolean;
     title?: string;
     description?: string;
     component?: string | null;
     alt?: string;
+    cache?: boolean;
+    cacheKey?: string;
+    cacheTtl?: number;
+    /**
+     * @deprecated Use `cache` instead
+     */
+    static?: boolean;
     [key: string]: any;
 }
+interface FontConfig {
+    name: string;
+    weight: number;
+    path?: string;
+}
+type InputFontConfig = (`${string}:${number}` | FontConfig);
+
+interface RuntimeCompatibilitySchema {
+    browser: false | 'playwright' | 'lambda' | 'universal';
+    satori: false | 'default' | 'yoga-wasm';
+    wasm: 'inline' | 'import' | 'fetch';
+    png: 'resvg-wasm' | 'svg2png' | 'resvg-node';
+    inlineCss?: 'node' | 'mock';
+    node?: boolean;
+    wasmImportQuery?: string;
+}
 
 interface ModuleOptions {
     /**
-     * The hostname of your website.
-     * @deprecated use `siteUrl`
+     * Whether the og:image images should be generated.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Default data used within the payload to generate the OG Image.
+     *
+     * You can use this to change the default template, image sizing and more.
+     *
+     * @default { component: 'OgImageTemplateFallback', width: 1200, height: 630, cache: true, cacheTtl: 24 * 60 * 60 * 1000 }
      */
-    host?: string;
-    siteUrl: string;
     defaults: OgImageOptions;
-    fonts: `${string}:${number}`[];
+    /**
+     * Fonts to use when rendering the og:image.
+     *
+     * @example ['Roboto:400,700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
+     */
+    fonts: InputFontConfig[];
+    /**
+     * Options to pass to satori.
+     *
+     * @see https://github.com/vercel/satori/blob/main/src/satori.ts#L18
+     */
     satoriOptions: Partial<SatoriOptions>;
-    forcePrerender: boolean;
-    satoriProvider: boolean;
-    browserProvider: boolean;
-    experimentalInlineWasm: boolean;
-    experimentalRuntimeBrowser: boolean;
+    /**
+     * Should the playground at <path>/__og_image__ be enabled in development.
+     *
+     * @default true
+     */
     playground: boolean;
+    /**
+     * Include Satori runtime.
+     *
+     * @default true
+     */
+    runtimeSatori: boolean;
+    /**
+     * Include the Browser runtime.
+     * This will need to be manually enabled for production environments.
+     *
+     * @default `process.dev`
+     */
+    runtimeBrowser: boolean;
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @false false
+     */
+    debug: boolean;
+    /**
+     * 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.
+     *
+     * @default true
+     * @see https://nitro.unjs.io/guide/storage#mountpoints
+     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
+     */
+    runtimeCacheStorage: boolean | (Record<string, any> & {
+        driver: string;
+    });
+    /**
+     * Extra component directories that should be used to resolve components.
+     *
+     * @default ['OgImage', 'OgImageTemplate']
+     */
+    componentDirs: string[];
+    /**
+     * Manually modify the deployment compatibility.
+     *
+     * @default { browser: 'playwright', satori: 'default', wasm: 'fetch', png: 'resvg-node' }
+     */
+    runtimeCompatibility: RuntimeCompatibilitySchema;
+    /**
+     * The url of your site.
+     * Used to generate absolute URLs for the og:image.
+     *
+     * Note: This is only required when prerendering your site.
+     *
+     * @deprecated Provide `url` through site config instead: `{ site: { url: <value> }}`.
+     * This is powered by the `nuxt-site-config` module.
+     * @see https://github.com/harlan-zw/nuxt-site-config
+     */
+    host?: string;
+    /**
+     * The url of your site.
+     * Used to generate absolute URLs for the og:image.
+     *
+     * Note: This is only required when prerendering your site.
+     *
+     * @deprecated Provide `url` through site config instead: `{ site: { url: <value> }}`.
+     * This is powered by the `nuxt-site-config` module.
+     * @see https://github.com/harlan-zw/nuxt-site-config
+     */
+    siteUrl?: string;
 }
 interface ModuleHooks {
     'og-image:config': (config: ModuleOptions) => Promise<void> | void;

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "nuxt-og-image",
   "compatibility": {
-    "nuxt": "^3.3.1",
+    "nuxt": "^3.6.1",
     "bridge": false
   },
   "configKey": "ogImage",
-  "version": "2.0.0-beta.9"
+  "version": "2.0.1"
 }