nuxt-og-image 4.0.3 → 4.1.1

package/dist/module.d.cts

@@ -0,0 +1,108 @@
+import * as _nuxt_schema from '@nuxt/schema';
+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';
+
+interface ModuleOptions {
+    /**
+     * 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: '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.
+     *
+     * @see https://github.com/vercel/satori/blob/main/src/satori.ts#L18
+     */
+    satoriOptions?: Partial<SatoriOptions>;
+    /**
+     * Options to pass to resvg.
+     *
+     * @see https://github.com/yisibl/resvg-js/blob/main/wasm/index.d.ts#L39
+     */
+    resvgOptions?: Partial<ResvgRenderOptions>;
+    /**
+     * Options to pass to sharp.
+     *
+     * @see https://sharp.pixelplumbing.com/api-constructor
+     */
+    sharpOptions?: true | Partial<SharpOptions>;
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @false false
+     */
+    debug: boolean;
+    /**
+     * Options to pass to the <OgImage> and <OgImageScreenshot> component.
+     */
+    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.
+     *
+     * @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 compatibility.
+     */
+    compatibility?: CompatibilityFlagEnvOverrides;
+    /**
+     * Use an alternative host for downloading Google Fonts. This is used to support China where Google Fonts is blocked.
+     *
+     * When `true` is set will use `fonts.font.im`, otherwise will use a string as the host.
+     */
+    googleFontMirror?: true | string;
+    /**
+     * Only allow the prerendering and dev runtimes to generate images.
+     */
+    zeroRuntime?: boolean;
+    /**
+     * Enable when your nuxt/content files match your pages.
+     *
+     * This will automatically map the `ogImage` frontmatter key to the correct path.
+     *
+     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
+     */
+    strictNuxtContentPaths?: boolean;
+}
+interface ModuleHooks {
+    'nuxt-og-image:components': (ctx: {
+        components: OgImageComponent[];
+    }) => Promise<void> | void;
+    'nuxt-og-image:runtime-config': (config: ModuleOptions) => Promise<void> | void;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { type ModuleHooks, type ModuleOptions, _default as default };

package/dist/module.d.mts

@@ -95,7 +95,7 @@ interface ModuleOptions {
      *
      * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
      */
-    strictNuxtContentPaths: boolean;
+    strictNuxtContentPaths?: boolean;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.d.ts

@@ -95,7 +95,7 @@ interface ModuleOptions {
      *
      * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
      */
-    strictNuxtContentPaths: boolean;
+    strictNuxtContentPaths?: boolean;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.json

@@ -5,7 +5,7 @@
     "bridge": false
   },
   "configKey": "ogImage",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import * as fs from 'node:fs';
 import { existsSync } from 'node:fs';
 import { readFile, writeFile } from 'node:fs/promises';
-import { useNuxt, tryResolveModule, addTemplate, resolvePath, loadNuxtModuleInstance, createResolver, defineNuxtModule, addImports, addBuildPlugin, hasNuxtModule, addServerPlugin, addServerHandler, addComponentsDir, addComponent, addPlugin } from '@nuxt/kit';
+import { useNuxt, tryResolveModule, addTemplate, resolvePath, loadNuxtModuleInstance, createResolver, defineNuxtModule, addImports, addBuildPlugin, hasNuxtModule, hasNuxtModuleCompatibility, addServerPlugin, addServerHandler, addComponentsDir, addComponent, addPlugin } from '@nuxt/kit';
 import { defu } from 'defu';
 import { installNuxtSiteConfig } from 'nuxt-site-config/kit';
 import { hash } from 'ohash';
@@ -650,7 +650,14 @@ const module = defineNuxtModule({
       }
     });
     await installNuxtSiteConfig();
-    if (hasNuxtModule("@nuxt/content")) {
+    const usingNuxtContent = hasNuxtModule("@nuxt/content");
+    const isNuxtContentV3 = usingNuxtContent && await hasNuxtModuleCompatibility("@nuxt/content", "^3");
+    const isNuxtContentV2 = usingNuxtContent && await hasNuxtModuleCompatibility("@nuxt/content", "^2");
+    if (isNuxtContentV3) {
+      if (typeof config.strictNuxtContentPaths !== "undefined") {
+        logger.warn("The `strictNuxtContentPaths` option is deprecated and has no effect in Nuxt Content v3.");
+      }
+    } else if (isNuxtContentV2) {
       addServerPlugin(resolve("./runtime/server/plugins/nuxt-content"));
     }
     if (!config.fonts.length) {
@@ -894,7 +901,6 @@ declare module '#og-image/unocss-config' {
         fonts: normalisedFonts,
         hasNuxtIcon: hasNuxtModule("nuxt-icon") || hasNuxtModule("@nuxt/icon"),
         colorPreference,
-        hasNuxtContent: hasNuxtModule("@nuxt/content"),
         strictNuxtContentPaths: config.strictNuxtContentPaths,
         // @ts-expect-error runtime type
         isNuxtContentDocumentDriven: config.strictNuxtContentPaths || !!nuxt.options.content?.documentDriven

package/dist/runtime/types.d.ts

@@ -34,7 +34,6 @@ export interface OgImageRuntimeConfig {
     fonts: FontConfig[];
     hasNuxtIcon: boolean;
     colorPreference: 'light' | 'dark';
-    hasNuxtContent: boolean;
     isNuxtContentDocumentDriven: boolean;
     strictNuxtContentPaths: boolean;
     zeroRuntime: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-og-image",
   "type": "module",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Enlightened OG Image generation for Nuxt.",
   "author": {
     "website": "https://harlanzw.com",
@@ -23,24 +23,37 @@
       "types": "./dist/module.d.ts",
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
+    },
+    "./content": {
+      "types": "./dist/content.d.ts",
+      "import": "./dist/content.mjs",
+      "require": "./dist/content.cjs"
     }
   },
   "main": "./dist/module.cjs",
   "types": "./dist/module.d.ts",
   "files": [
     "dist",
-    "virtual.d.ts"
+    "virtual.d.ts",
+    "content.d.ts"
   ],
   "engines": {
     "node": ">=18.0.0"
   },
+  "typesVersions": {
+    "*": {
+      "content": [
+        "dist/content"
+      ]
+    }
+  },
   "dependencies": {
-    "@nuxt/devtools-kit": "^1.7.0",
-    "@nuxt/kit": "^3.15.1",
+    "@nuxt/devtools-kit": "2.0.0-beta.3",
+    "@nuxt/kit": "^3.15.2",
     "@resvg/resvg-js": "^2.6.2",
     "@resvg/resvg-wasm": "^2.6.2",
-    "@unocss/core": "^65.4.0",
-    "@unocss/preset-wind": "^65.4.0",
+    "@unocss/core": "^65.4.2",
+    "@unocss/preset-wind": "^65.4.2",
     "chrome-launcher": "^1.1.2",
     "consola": "^3.4.0",
     "defu": "^6.1.4",
@@ -51,15 +64,15 @@
     "nypm": "^0.4.1",
     "ofetch": "^1.4.1",
     "ohash": "^1.1.4",
-    "pathe": "^2.0.1",
-    "pkg-types": "^1.3.0",
+    "pathe": "^2.0.2",
+    "pkg-types": "^1.3.1",
     "playwright-core": "^1.49.1",
     "radix3": "^1.1.2",
     "satori": "^0.12.1",
     "satori-html": "^0.3.2",
     "sirv": "^3.0.0",
     "std-env": "^3.8.0",
-    "strip-literal": "^2.1.1",
+    "strip-literal": "^3.0.0",
     "ufo": "^1.5.4",
     "unplugin": "^2.1.2",
     "unwasm": "^0.3.9",
@@ -75,52 +88,37 @@
     "@iconify-json/ri": "^1.2.5",
     "@iconify-json/tabler": "^1.2.14",
     "@img/sharp-linux-x64": "0.33.5",
-    "@nuxt/content": "^2.13.4",
-    "@nuxt/devtools": "1.7.0",
-    "@nuxt/devtools-ui-kit": "^1.7.0",
+    "@nuxt/content": "^3.0.0",
+    "@nuxt/devtools": "2.0.0-beta.3",
+    "@nuxt/devtools-ui-kit": "2.0.0-beta.3",
     "@nuxt/icon": "^1.10.3",
     "@nuxt/image": "^1.9.0",
     "@nuxt/module-builder": "^0.8.4",
     "@nuxt/test-utils": "3.15.4",
-    "@nuxt/ui": "^2.20.0",
+    "@nuxt/ui": "^2.21.0",
     "@nuxtjs/color-mode": "^3.5.2",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
     "@nuxtjs/i18n": "^9.1.1",
-    "@nuxtjs/tailwindcss": "^6.13.0",
-    "@unocss/nuxt": "^65.4.0",
-    "@unocss/preset-icons": "^65.4.0",
-    "@unocss/preset-uno": "^65.4.0",
-    "@unocss/runtime": "^65.4.0",
+    "@nuxtjs/tailwindcss": "^6.13.1",
+    "@unocss/nuxt": "^65.4.2",
+    "@unocss/preset-icons": "^65.4.2",
+    "@unocss/preset-uno": "^65.4.2",
+    "@unocss/runtime": "^65.4.2",
     "@vueuse/nuxt": "^12.4.0",
-    "bumpp": "^9.10.0",
+    "bumpp": "^9.10.1",
     "eslint": "9.18.0",
     "jest-image-snapshot": "^6.4.0",
-    "nuxt": "^3.15.1",
+    "nuxt": "^3.15.2",
     "playwright": "^1.49.1",
-    "sass": "^1.83.3",
+    "sass": "^1.83.4",
     "sharp": "^0.33.5",
     "typescript": "5.6.3",
-    "unocss": "^65.4.0",
+    "unocss": "^65.4.2",
     "vitest": "^2.1.8"
   },
   "resolutions": {
     "typescript": "5.6.3"
   },
-  "build": {
-    "externals": [
-      "nuxt",
-      "#app",
-      "nuxt/app",
-      "h3",
-      "nitropack",
-      "@vue/runtime-core",
-      "#og-image/components",
-      "sharp",
-      "unstorage",
-      "unstorage/drivers/fs",
-      "consola/utils"
-    ]
-  },
   "scripts": {
     "stub": "nuxt-build-module build --stub && nuxt-module-build prepare",
     "build": "pnpm stub && nuxt-module-build build && pnpm run build:client",

package/dist/client/_nuxt/builds/meta/1ef0ae85-3c8a-4505-a09a-e29f0083c0f4.json

@@ -1 +0,0 @@
-{"id":"1ef0ae85-3c8a-4505-a09a-e29f0083c0f4","timestamp":1736829719867,"matcher":{"static":{},"wildcard":{},"dynamic":{}},"prerendered":[]}

package/dist/client/_nuxt/error-404.CnNYq3i9.css

@@ -1 +0,0 @@
-.spotlight[data-v-ac6d9968]{background:linear-gradient(45deg,#00dc82,#36e4da 50%,#0047e1);bottom:-30vh;filter:blur(20vh);height:40vh}.gradient-border[data-v-ac6d9968]{-webkit-backdrop-filter:blur(10px);backdrop-filter:blur(10px);border-radius:.5rem;position:relative}@media (prefers-color-scheme:light){.gradient-border[data-v-ac6d9968]{background-color:#ffffff4d}.gradient-border[data-v-ac6d9968]:before{background:linear-gradient(90deg,#e2e2e2,#e2e2e2 25%,#00dc82,#36e4da 75%,#0047e1)}}@media (prefers-color-scheme:dark){.gradient-border[data-v-ac6d9968]{background-color:#1414144d}.gradient-border[data-v-ac6d9968]:before{background:linear-gradient(90deg,#303030,#303030 25%,#00dc82,#36e4da 75%,#0047e1)}}.gradient-border[data-v-ac6d9968]:before{background-size:400% auto;border-radius:.5rem;bottom:0;content:"";left:0;-webkit-mask:linear-gradient(#fff 0 0) content-box,linear-gradient(#fff 0 0);mask:linear-gradient(#fff 0 0) content-box,linear-gradient(#fff 0 0);-webkit-mask-composite:xor;mask-composite:exclude;opacity:.5;padding:2px;position:absolute;right:0;top:0;transition:background-position .3s ease-in-out,opacity .2s ease-in-out;width:100%}.gradient-border[data-v-ac6d9968]:hover:before{background-position:-50% 0;opacity:1}.fixed[data-v-ac6d9968]{position:fixed}.left-0[data-v-ac6d9968]{left:0}.right-0[data-v-ac6d9968]{right:0}.z-10[data-v-ac6d9968]{z-index:10}.z-20[data-v-ac6d9968]{z-index:20}.grid[data-v-ac6d9968]{display:grid}.mb-16[data-v-ac6d9968]{margin-bottom:4rem}.mb-8[data-v-ac6d9968]{margin-bottom:2rem}.max-w-520px[data-v-ac6d9968]{max-width:520px}.min-h-screen[data-v-ac6d9968]{min-height:100vh}.w-full[data-v-ac6d9968]{width:100%}.flex[data-v-ac6d9968]{display:flex}.cursor-pointer[data-v-ac6d9968]{cursor:pointer}.place-content-center[data-v-ac6d9968]{place-content:center}.items-center[data-v-ac6d9968]{align-items:center}.justify-center[data-v-ac6d9968]{justify-content:center}.overflow-hidden[data-v-ac6d9968]{overflow:hidden}.bg-white[data-v-ac6d9968]{--un-bg-opacity:1;background-color:rgb(255 255 255/var(--un-bg-opacity))}.px-4[data-v-ac6d9968]{padding-left:1rem;padding-right:1rem}.px-8[data-v-ac6d9968]{padding-left:2rem;padding-right:2rem}.py-2[data-v-ac6d9968]{padding-bottom:.5rem;padding-top:.5rem}.text-center[data-v-ac6d9968]{text-align:center}.text-8xl[data-v-ac6d9968]{font-size:6rem;line-height:1}.text-xl[data-v-ac6d9968]{font-size:1.25rem;line-height:1.75rem}.text-black[data-v-ac6d9968]{--un-text-opacity:1;color:rgb(0 0 0/var(--un-text-opacity))}.font-light[data-v-ac6d9968]{font-weight:300}.font-medium[data-v-ac6d9968]{font-weight:500}.leading-tight[data-v-ac6d9968]{line-height:1.25}.font-sans[data-v-ac6d9968]{font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji}.antialiased[data-v-ac6d9968]{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}@media (prefers-color-scheme:dark){.dark\:bg-black[data-v-ac6d9968]{--un-bg-opacity:1;background-color:rgb(0 0 0/var(--un-bg-opacity))}.dark\:text-white[data-v-ac6d9968]{--un-text-opacity:1;color:rgb(255 255 255/var(--un-text-opacity))}}@media (min-width:640px){.sm\:px-0[data-v-ac6d9968]{padding-left:0;padding-right:0}.sm\:px-6[data-v-ac6d9968]{padding-left:1.5rem;padding-right:1.5rem}.sm\:py-3[data-v-ac6d9968]{padding-bottom:.75rem;padding-top:.75rem}.sm\:text-4xl[data-v-ac6d9968]{font-size:2.25rem;line-height:2.5rem}.sm\:text-xl[data-v-ac6d9968]{font-size:1.25rem;line-height:1.75rem}}

package/dist/client/_nuxt/error-500.BlU6WHQT.css

@@ -1 +0,0 @@
-.spotlight[data-v-2bc02a3b]{background:linear-gradient(45deg,#00dc82,#36e4da 50%,#0047e1);filter:blur(20vh)}.fixed[data-v-2bc02a3b]{position:fixed}.-bottom-1\/2[data-v-2bc02a3b]{bottom:-50%}.left-0[data-v-2bc02a3b]{left:0}.right-0[data-v-2bc02a3b]{right:0}.grid[data-v-2bc02a3b]{display:grid}.mb-16[data-v-2bc02a3b]{margin-bottom:4rem}.mb-8[data-v-2bc02a3b]{margin-bottom:2rem}.h-1\/2[data-v-2bc02a3b]{height:50%}.max-w-520px[data-v-2bc02a3b]{max-width:520px}.min-h-screen[data-v-2bc02a3b]{min-height:100vh}.place-content-center[data-v-2bc02a3b]{place-content:center}.overflow-hidden[data-v-2bc02a3b]{overflow:hidden}.bg-white[data-v-2bc02a3b]{--un-bg-opacity:1;background-color:rgb(255 255 255/var(--un-bg-opacity))}.px-8[data-v-2bc02a3b]{padding-left:2rem;padding-right:2rem}.text-center[data-v-2bc02a3b]{text-align:center}.text-8xl[data-v-2bc02a3b]{font-size:6rem;line-height:1}.text-xl[data-v-2bc02a3b]{font-size:1.25rem;line-height:1.75rem}.text-black[data-v-2bc02a3b]{--un-text-opacity:1;color:rgb(0 0 0/var(--un-text-opacity))}.font-light[data-v-2bc02a3b]{font-weight:300}.font-medium[data-v-2bc02a3b]{font-weight:500}.leading-tight[data-v-2bc02a3b]{line-height:1.25}.font-sans[data-v-2bc02a3b]{font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji}.antialiased[data-v-2bc02a3b]{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}@media (prefers-color-scheme:dark){.dark\:bg-black[data-v-2bc02a3b]{--un-bg-opacity:1;background-color:rgb(0 0 0/var(--un-bg-opacity))}.dark\:text-white[data-v-2bc02a3b]{--un-text-opacity:1;color:rgb(255 255 255/var(--un-text-opacity))}}@media (min-width:640px){.sm\:px-0[data-v-2bc02a3b]{padding-left:0;padding-right:0}.sm\:text-4xl[data-v-2bc02a3b]{font-size:2.25rem;line-height:2.5rem}}