nuxt-og-image 2.1.2 → 2.2.0

package/dist/module.mjs

@@ -21,7 +21,7 @@ import { createBirpcGroup } from 'birpc';
 import { stringify, parse } from 'flatted';
 import { addDependency } from 'nypm';
 
-const version = "2.1.2";
+const version = "2.2.0";
 
 async function createBrowser() {
   if (process.dev || process.env.prerender) {
@@ -265,7 +265,8 @@ const cloudflare = {
 const awsLambda = {
   browser: false,
   // too difficult to support
-  wasm: "inline"
+  wasm: "inline",
+  cssInline: false
 };
 const RuntimeCompatibility = {
   "nitro-dev": {
@@ -276,7 +277,8 @@ const RuntimeCompatibility = {
     browser: false,
     satori: "yoga-wasm",
     wasm: "inline",
-    png: "resvg-wasm"
+    png: "resvg-wasm",
+    cssInline: false
   },
   "aws-lambda": awsLambda,
   "netlify": awsLambda,
@@ -321,7 +323,7 @@ function detectTarget(options = {}) {
 function getNitroPreset(nuxt = useNuxt()) {
   return process.env.NITRO_PRESET || nuxt.options.nitro.preset || detectTarget() || "node-server";
 }
-function getNitroProviderCompatibility(defaults, nuxt = useNuxt()) {
+function getNitroProviderCompatibility(overrides, nuxt = useNuxt()) {
   let compatibility;
   if (provider === "stackblitz") {
     compatibility = RuntimeCompatibility.stackblitz;
@@ -337,8 +339,7 @@ function getNitroProviderCompatibility(defaults, nuxt = useNuxt()) {
       return false;
     compatibility = lookup || {};
   }
-  compatibility = defu$1(compatibility, defaults);
-  compatibility.cssInline = compatibility.cssInline || (compatibility.node ? "node" : "mock");
+  compatibility = defu$1(overrides, compatibility, DefaultRuntimeCompatibility);
   return compatibility;
 }
 function ensureDependencies(nuxt, dep) {
@@ -390,7 +391,6 @@ const module = defineNuxtModule({
         cache: true,
         cacheTtl: 24 * 60 * 60 * 1e3
       },
-      runtimeCompatibility: DefaultRuntimeCompatibility,
       componentDirs: ["OgImage", "OgImageTemplate"],
       runtimeSatori: true,
       runtimeBrowser: nuxt.options.dev,
@@ -410,7 +410,7 @@ const module = defineNuxtModule({
     }
     const { resolve } = createResolver(import.meta.url);
     logger.debug("Using Nitro preset", getNitroPreset());
-    const nitroCompatibility = getNitroProviderCompatibility(config.runtimeCompatibility);
+    const nitroCompatibility = getNitroProviderCompatibility(config.runtimeCompatibility || {});
     logger.debug("Nitro compatibility", nitroCompatibility);
     const nitroTarget = process.env.NITRO_PRESET || nuxt.options.nitro.preset || provider;
     if (!nitroCompatibility) {
@@ -580,11 +580,6 @@ declare module 'nitropack' {
       if (nitroCompatibility.satori === "yoga-wasm")
         customAssetDirs.push(resolve("./runtime/public-assets-optional/yoga"));
     }
-    nuxt.hooks.hook("vite:extend", async ({ config: config2 }) => {
-      config2.optimizeDeps = config2.optimizeDeps || {};
-      config2.optimizeDeps.include = config2.optimizeDeps.include || [];
-      config2.optimizeDeps.include.push("css-inline");
-    });
     nuxt.hooks.hook("modules:done", async () => {
       nuxt.hooks.callHook("og-image:config", config);
       nuxt.options.runtimeConfig["nuxt-og-image"] = {

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

@@ -52,8 +52,8 @@ export default defineEventHandler(async (e) => {
     }
   }
   if (png) {
-    if (cacheEnabled) {
-      setHeader(e, "Cache-Control", "public, max-age=31536000");
+    if (cacheEnabled && options.cacheTtl) {
+      setHeader(e, "Cache-Control", `public, max-age=${options.cacheTtl}`);
     } else {
       setHeader(e, "Cache-Control", "no-cache, no-store, must-revalidate");
       setHeader(e, "Pragma", "no-cache");

package/dist/runtime/nitro/renderers/browser.mjs

@@ -17,11 +17,15 @@ const BrowserRenderer = {
     let res = null;
     if (browser) {
       try {
-        res = await screenshot(browser, {
-          ...options,
-          host: options.requestOrigin,
-          path: `/api/og-image-html?path=${options.path}`
-        });
+        if (options.html) {
+          res = await screenshot(browser, options);
+        } else {
+          res = await screenshot(browser, {
+            ...options,
+            host: options.requestOrigin,
+            path: `/api/og-image-html?path=${options.path}`
+          });
+        }
       } finally {
         await browser.close();
       }

package/dist/runtime/nitro/renderers/satori/index.mjs

@@ -23,13 +23,13 @@ const SatoriRenderer = {
     return pngCreator(svg, options);
   },
   createVNode: async function createVNode(options) {
-    const html = await globalThis.$fetch("/api/og-image-html", {
+    const html = options.html || await globalThis.$fetch("/api/og-image-html", {
       params: {
         path: options.path,
         options: JSON.stringify(options)
       }
     });
-    const body = html.match(/<body[^>]*>([\s\S]*)<\/body>/)?.[1] || "";
+    const body = html.match(/<body[^>]*>([\s\S]*)<\/body>/)?.[1] || html;
     const satoriTree = convertHtmlToSatori(body);
     await walkSatoriTree(satoriTree, [
       emojis,

package/dist/runtime/types.d.ts

@@ -25,6 +25,10 @@ export interface ScreenshotOptions {
 }
 export interface OgImageOptions extends Partial<ScreenshotOptions> {
     provider?: 'browser' | 'satori';
+    /**
+     * Provide a static HTML template to render the OG Image instead of a component.
+     */
+    html?: string;
     title?: string;
     description?: string;
     component?: string | null;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "nuxt-og-image",
   "type": "module",
-  "version": "2.1.2",
-  "packageManager": "pnpm@8.9.0",
+  "version": "2.2.0",
+  "packageManager": "pnpm@8.9.2",
   "description": "Enlightened OG Image generation for Nuxt.",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -27,15 +27,15 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.7.4",
-    "@resvg/resvg-js": "^2.4.1",
-    "@resvg/resvg-wasm": "^2.4.1",
-    "@types/fs-extra": "^11.0.2",
+    "@nuxt/kit": "^3.8.0",
+    "@resvg/resvg-js": "^2.6.0",
+    "@resvg/resvg-wasm": "^2.6.0",
+    "@types/fs-extra": "^11.0.3",
     "birpc": "0.2.14",
     "chalk": "^5.3.0",
     "chrome-launcher": "^1.1.0",
     "css-inline": "^0.11.0",
-    "defu": "^6.1.2",
+    "defu": "^6.1.3",
     "execa": "^8.0.1",
     "fast-glob": "^3.3.1",
     "flatted": "^3.2.9",
@@ -49,7 +49,7 @@
     "ofetch": "^1.3.3",
     "ohash": "^1.1.3",
     "pathe": "^1.1.1",
-    "playwright-core": "^1.38.1",
+    "playwright-core": "^1.39.0",
     "radix3": "^1.1.0",
     "satori": "0.10.9",
     "satori-html": "^0.3.2",
@@ -64,19 +64,19 @@
     "yoga-wasm-web": "^0.3.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "1.0.0-beta.26",
-    "@nuxt/devtools": "1.0.0-beta.1",
+    "@antfu/eslint-config": "1.0.0-beta.29",
+    "@nuxt/devtools": "1.0.0",
     "@nuxt/module-builder": "^0.5.2",
-    "@nuxt/test-utils": "3.7.4",
+    "@nuxt/test-utils": "3.8.0",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@types/ws": "^8.5.7",
+    "@types/ws": "^8.5.8",
     "bumpp": "^9.2.0",
-    "eslint": "8.51.0",
+    "eslint": "8.52.0",
     "jest-image-snapshot": "^6.2.0",
-    "nuxt": "^3.7.4",
-    "nuxt-icon": "^0.5.0",
-    "playwright": "^1.38.1",
-    "sass": "^1.69.2",
+    "nuxt": "^3.8.0",
+    "nuxt-icon": "0.5.0",
+    "playwright": "^1.39.0",
+    "sass": "^1.69.5",
     "vitest": "^0.34.6"
   },
   "scripts": {
@@ -86,7 +86,7 @@
     "lint": "eslint . --fix",
     "dev": "nuxi dev .playground",
     "dev:build": "nuxi build .playground",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare .playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxi prepare .playground",
     "release": "bumpp package.json --commit --push --tag",
     "test": "vitest build"
   }

package/dist/client/_nuxt/IconCSS.28ef6808.css

@@ -1 +0,0 @@
-span[data-v-ab9ed42e]{background-color:currentColor;display:inline-block;-webkit-mask-image:var(--7bad2e10);mask-image:var(--7bad2e10);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:100% 100%;mask-size:100% 100%;vertical-align:middle}

package/dist/client/_nuxt/IconCSS.5401fcdb.js

@@ -1 +0,0 @@
-import{g as l,H as _,I as d,n as o,o as m,c as f,s as S,_ as g}from"./entry.0d40575d.js";const x=l({__name:"IconCSS",props:{name:{type:String,required:!0},size:{type:String,default:""}},setup(r){const n=r;_(e=>({"7bad2e10":u.value}));const s=d(),p=o(()=>{var e;return((((e=s.nuxtIcon)==null?void 0:e.aliases)||{})[n.name]||n.name).replace(/^i-/,"")}),u=o(()=>`url('https://api.iconify.design/${p.value.replace(":","/")}.svg')`),a=o(()=>{var t,c,i;if(!n.size&&typeof((t=s.nuxtIcon)==null?void 0:t.size)=="boolean"&&!((c=s.nuxtIcon)!=null&&c.size))return;const e=n.size||((i=s.nuxtIcon)==null?void 0:i.size)||"1em";return String(Number(e))===e?`${e}px`:e});return(e,t)=>(m(),f("span",{style:S({width:a.value,height:a.value})},null,4))}});const z=g(x,[["__scopeId","data-v-ab9ed42e"]]);export{z as default};