nuxt-og-image 2.2.4 → 3.0.0-beta.1

package/dist/client/_nuxt/{error-404.407d76a3.js → error-404.f37119e7.js}

@@ -1 +1 @@
-import{_ as a,u as n,o as r,c as l,a as e,t as s,b as d,w as c,d as p,e as f,p as x,f as h}from"./entry.ac864471.js";const m=t=>(x("data-v-05a2b8a3"),t=t(),h(),t),u={class:"font-sans antialiased bg-white dark:bg-black text-black dark:text-white grid min-h-screen place-content-center overflow-hidden"},g=m(()=>e("div",{class:"fixed left-0 right-0 spotlight z-10"},null,-1)),b={class:"max-w-520px text-center z-20"},_=["textContent"],w=["textContent"],y={class:"w-full flex items-center justify-center"},S={__name:"error-404",props:{appName:{type:String,default:"Nuxt"},version:{type:String,default:""},statusCode:{type:Number,default:404},statusMessage:{type:String,default:"Not Found"},description:{type:String,default:"Sorry, the page you are looking for could not be found."},backHome:{type:String,default:"Go back home"}},setup(t){const o=t;return n({title:`${o.statusCode} - ${o.statusMessage} | ${o.appName}`,script:[],style:[{children:'*,:before,:after{-webkit-box-sizing:border-box;box-sizing:border-box;border-width:0;border-style:solid;border-color:#e0e0e0}*{--tw-ring-inset:var(--tw-empty, );--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:rgba(14, 165, 233, .5);--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000}:root{-moz-tab-size:4;-o-tab-size:4;tab-size:4}a{color:inherit;text-decoration:inherit}body{margin:0;font-family:inherit;line-height:inherit}html{-webkit-text-size-adjust:100%;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";line-height:1.5}h1,p{margin:0}h1{font-size:inherit;font-weight:inherit}'}]}),(k,v)=>{const i=f;return r(),l("div",u,[g,e("div",b,[e("h1",{class:"text-8xl sm:text-10xl font-medium mb-8",textContent:s(t.statusCode)},null,8,_),e("p",{class:"text-xl px-8 sm:px-0 sm:text-4xl font-light mb-16 leading-tight",textContent:s(t.description)},null,8,w),e("div",y,[d(i,{to:"/",class:"gradient-border text-md sm:text-xl py-2 px-4 sm:py-3 sm:px-6 cursor-pointer"},{default:c(()=>[p(s(t.backHome),1)]),_:1})])])])}}},z=a(S,[["__scopeId","data-v-05a2b8a3"]]);export{z as default};
+import{_ as a,u as n,o as r,c as l,a as e,t as s,b as d,w as c,d as p,e as f,p as x,f as h}from"./entry.bdb8a8d5.js";const m=t=>(x("data-v-05a2b8a3"),t=t(),h(),t),u={class:"font-sans antialiased bg-white dark:bg-black text-black dark:text-white grid min-h-screen place-content-center overflow-hidden"},g=m(()=>e("div",{class:"fixed left-0 right-0 spotlight z-10"},null,-1)),b={class:"max-w-520px text-center z-20"},_=["textContent"],w=["textContent"],y={class:"w-full flex items-center justify-center"},S={__name:"error-404",props:{appName:{type:String,default:"Nuxt"},version:{type:String,default:""},statusCode:{type:Number,default:404},statusMessage:{type:String,default:"Not Found"},description:{type:String,default:"Sorry, the page you are looking for could not be found."},backHome:{type:String,default:"Go back home"}},setup(t){const o=t;return n({title:`${o.statusCode} - ${o.statusMessage} | ${o.appName}`,script:[],style:[{children:'*,:before,:after{-webkit-box-sizing:border-box;box-sizing:border-box;border-width:0;border-style:solid;border-color:#e0e0e0}*{--tw-ring-inset:var(--tw-empty, );--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:rgba(14, 165, 233, .5);--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000}:root{-moz-tab-size:4;-o-tab-size:4;tab-size:4}a{color:inherit;text-decoration:inherit}body{margin:0;font-family:inherit;line-height:inherit}html{-webkit-text-size-adjust:100%;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";line-height:1.5}h1,p{margin:0}h1{font-size:inherit;font-weight:inherit}'}]}),(k,v)=>{const i=f;return r(),l("div",u,[g,e("div",b,[e("h1",{class:"text-8xl sm:text-10xl font-medium mb-8",textContent:s(t.statusCode)},null,8,_),e("p",{class:"text-xl px-8 sm:px-0 sm:text-4xl font-light mb-16 leading-tight",textContent:s(t.description)},null,8,w),e("div",y,[d(i,{to:"/",class:"gradient-border text-md sm:text-xl py-2 px-4 sm:py-3 sm:px-6 cursor-pointer"},{default:c(()=>[p(s(t.backHome),1)]),_:1})])])])}}},z=a(S,[["__scopeId","data-v-05a2b8a3"]]);export{z as default};

package/dist/client/_nuxt/{error-500.531c4147.js → error-500.74b0a30f.js}

@@ -1 +1 @@
-import{_ as i,u as a,o as r,c as n,a as e,t as s,p as l,f as d}from"./entry.ac864471.js";const c=t=>(l("data-v-c967d9a9"),t=t(),d(),t),p={class:"font-sans antialiased bg-white dark:bg-black text-black dark:text-white grid min-h-screen place-content-center overflow-hidden"},h=c(()=>e("div",{class:"fixed -bottom-1/2 left-0 right-0 h-1/2 spotlight"},null,-1)),f={class:"max-w-520px text-center"},g=["textContent"],m=["textContent"],x={__name:"error-500",props:{appName:{type:String,default:"Nuxt"},version:{type:String,default:""},statusCode:{type:Number,default:500},statusMessage:{type:String,default:"Server error"},description:{type:String,default:"This page is temporarily unavailable."}},setup(t){const o=t;return a({title:`${o.statusCode} - ${o.statusMessage} | ${o.appName}`,script:[],style:[{children:'*,:before,:after{-webkit-box-sizing:border-box;box-sizing:border-box;border-width:0;border-style:solid;border-color:#e0e0e0}*{--tw-ring-inset:var(--tw-empty, );--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:rgba(14, 165, 233, .5);--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000}:root{-moz-tab-size:4;-o-tab-size:4;tab-size:4}body{margin:0;font-family:inherit;line-height:inherit}html{-webkit-text-size-adjust:100%;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";line-height:1.5}h1,p{margin:0}h1{font-size:inherit;font-weight:inherit}'}]}),(u,b)=>(r(),n("div",p,[h,e("div",f,[e("h1",{class:"text-8xl sm:text-10xl font-medium mb-8",textContent:s(t.statusCode)},null,8,g),e("p",{class:"text-xl px-8 sm:px-0 sm:text-4xl font-light mb-16 leading-tight",textContent:s(t.description)},null,8,m)])]))}},w=i(x,[["__scopeId","data-v-c967d9a9"]]);export{w as default};
+import{_ as i,u as a,o as r,c as n,a as e,t as s,p as l,f as d}from"./entry.bdb8a8d5.js";const c=t=>(l("data-v-c967d9a9"),t=t(),d(),t),p={class:"font-sans antialiased bg-white dark:bg-black text-black dark:text-white grid min-h-screen place-content-center overflow-hidden"},h=c(()=>e("div",{class:"fixed -bottom-1/2 left-0 right-0 h-1/2 spotlight"},null,-1)),f={class:"max-w-520px text-center"},g=["textContent"],m=["textContent"],x={__name:"error-500",props:{appName:{type:String,default:"Nuxt"},version:{type:String,default:""},statusCode:{type:Number,default:500},statusMessage:{type:String,default:"Server error"},description:{type:String,default:"This page is temporarily unavailable."}},setup(t){const o=t;return a({title:`${o.statusCode} - ${o.statusMessage} | ${o.appName}`,script:[],style:[{children:'*,:before,:after{-webkit-box-sizing:border-box;box-sizing:border-box;border-width:0;border-style:solid;border-color:#e0e0e0}*{--tw-ring-inset:var(--tw-empty, );--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:rgba(14, 165, 233, .5);--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000}:root{-moz-tab-size:4;-o-tab-size:4;tab-size:4}body{margin:0;font-family:inherit;line-height:inherit}html{-webkit-text-size-adjust:100%;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";line-height:1.5}h1,p{margin:0}h1{font-size:inherit;font-weight:inherit}'}]}),(u,b)=>(r(),n("div",p,[h,e("div",f,[e("h1",{class:"text-8xl sm:text-10xl font-medium mb-8",textContent:s(t.statusCode)},null,8,g),e("p",{class:"text-xl px-8 sm:px-0 sm:text-4xl font-light mb-16 leading-tight",textContent:s(t.description)},null,8,m)])]))}},w=i(x,[["__scopeId","data-v-c967d9a9"]]);export{w as default};

package/dist/client/index.html

@@ -2,14 +2,14 @@
 <html >
 <head><meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
-<link rel="stylesheet" href="/__nuxt_og_image__/client/_nuxt/entry.39e39f51.css">
-<link rel="modulepreload" as="script" crossorigin href="/__nuxt_og_image__/client/_nuxt/entry.ac864471.js">
-<link rel="prefetch" as="style" href="/__nuxt_og_image__/client/_nuxt/error-404.b751fa02.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt_og_image__/client/_nuxt/error-404.407d76a3.js">
-<link rel="prefetch" as="style" href="/__nuxt_og_image__/client/_nuxt/error-500.69009e70.css">
-<link rel="prefetch" as="script" crossorigin href="/__nuxt_og_image__/client/_nuxt/error-500.531c4147.js">
-<script type="module" src="/__nuxt_og_image__/client/_nuxt/entry.ac864471.js" crossorigin></script><script>"use strict";(()=>{const a=window,e=document.documentElement,m=["dark","light"],c=window.localStorage.getItem("nuxt-color-mode")||"system";let n=c==="system"?f():c;const l=e.getAttribute("data-color-mode-forced");l&&(n=l),i(n),a["__NUXT_COLOR_MODE__"]={preference:c,value:n,getColorScheme:f,addColorScheme:i,removeColorScheme:d};function i(o){const t=""+o+"",s="";e.classList?e.classList.add(t):e.className+=" "+t,s&&e.setAttribute("data-"+s,o)}function d(o){const t=""+o+"",s="";e.classList?e.classList.remove(t):e.className=e.className.replace(new RegExp(t,"g"),""),s&&e.removeAttribute("data-"+s)}function r(o){return a.matchMedia("(prefers-color-scheme"+o+")")}function f(){if(a.matchMedia&&r("").media!=="not all"){for(const o of m)if(r(":"+o).matches)return o}return"light"}})();
+<link rel="stylesheet" href="/__nuxt-og-image/_nuxt/entry.434c2c45.css">
+<link rel="modulepreload" as="script" crossorigin href="/__nuxt-og-image/_nuxt/entry.bdb8a8d5.js">
+<link rel="prefetch" as="style" href="/__nuxt-og-image/_nuxt/error-404.b751fa02.css">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-og-image/_nuxt/error-404.f37119e7.js">
+<link rel="prefetch" as="style" href="/__nuxt-og-image/_nuxt/error-500.69009e70.css">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-og-image/_nuxt/error-500.74b0a30f.js">
+<script type="module" src="/__nuxt-og-image/_nuxt/entry.bdb8a8d5.js" crossorigin></script><script>"use strict";(()=>{const a=window,e=document.documentElement,m=["dark","light"],c=window&&window.localStorage&&window.localStorage.getItem&&window.localStorage.getItem("nuxt-color-mode")||"system";let n=c==="system"?d():c;const l=e.getAttribute("data-color-mode-forced");l&&(n=l),i(n),a["__NUXT_COLOR_MODE__"]={preference:c,value:n,getColorScheme:d,addColorScheme:i,removeColorScheme:f};function i(o){const t=""+o+"",s="";e.classList?e.classList.add(t):e.className+=" "+t,s&&e.setAttribute("data-"+s,o)}function f(o){const t=""+o+"",s="";e.classList?e.classList.remove(t):e.className=e.className.replace(new RegExp(t,"g"),""),s&&e.removeAttribute("data-"+s)}function r(o){return a.matchMedia("(prefers-color-scheme"+o+")")}function d(){if(a.matchMedia&&r("").media!=="not all"){for(const o of m)if(r(":"+o).matches)return o}return"light"}})();
 </script></head>
 <body ><div id="__nuxt"></div><script type="application/json" id="__NUXT_DATA__" data-ssr="false">[{"_errors":1,"serverRendered":2,"data":3,"state":4},{},false,{},{}]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt_og_image__/client",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body>
+<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-og-image",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body>
 </html>

package/dist/module.d.mts

@@ -1,6 +1,16 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { SatoriOptions } from 'satori';
+import { ResvgRenderOptions } from '@resvg/resvg-js';
+import { SharpOptions } from 'sharp';
 
+interface OgImageComponent {
+    path?: string;
+    pascalName: string;
+    kebabName: string;
+    hash: string;
+    category: 'app' | 'official' | 'community' | 'pro';
+    credits?: string;
+}
 interface ScreenshotOptions {
     colorScheme?: 'dark' | 'light';
     selector?: string;
@@ -23,41 +33,43 @@ interface ScreenshotOptions {
     delay?: number;
 }
 interface OgImageOptions extends Partial<ScreenshotOptions> {
+    component?: string;
+    renderer?: 'chromium' | 'satori';
+    extension?: 'png' | 'jpeg' | 'jpg';
+    /**
+     * @deprecated use renderer. Replace `browser` with `chromium`
+     */
     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;
-    alt?: string;
     cache?: boolean;
     cacheKey?: string;
+    resvg?: ResvgRenderOptions;
+    satori?: SatoriOptions;
     /**
      * The time to live of the cache in milliseconds.
      */
     cacheTtl?: number;
-    /**
-     * @deprecated Use `cache` instead
-     */
-    static?: boolean;
     [key: string]: any;
 }
 interface FontConfig {
     name: string;
-    weight: number;
+    weight: string | 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';
-    cssInline?: boolean;
-    node?: boolean;
+    bindings: {
+        chromium: 'node' | false;
+        ['css-inline']: 'node' | false;
+        resvg: 'node' | 'wasm' | false;
+        satori: 'node' | 'yoga-wasm' | false;
+        sharp: 'node' | 'lambda' | false;
+    };
+    wasmStrategy?: 'inline' | 'import' | 'fetch';
     wasmImportQuery?: string;
 }
 
@@ -87,7 +99,19 @@ interface ModuleOptions {
      *
      * @see https://github.com/vercel/satori/blob/main/src/satori.ts#L18
      */
-    satoriOptions: Partial<SatoriOptions>;
+    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?: Partial<SharpOptions>;
     /**
      * Should the playground at <path>/__og_image__ be enabled in development.
      *
@@ -137,32 +161,12 @@ interface ModuleOptions {
      * Manually modify the deployment compatibility.
      */
     runtimeCompatibility?: Partial<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 {
+    'nuxt-og-image:components': (ctx: {
+        components: OgImageComponent[];
+    }) => Promise<void> | void;
     'og-image:config': (config: ModuleOptions) => Promise<void> | void;
-    'og-image:prerenderScreenshots': (queue: OgImageOptions[]) => Promise<void> | void;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.d.ts

@@ -1,6 +1,16 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { SatoriOptions } from 'satori';
+import { ResvgRenderOptions } from '@resvg/resvg-js';
+import { SharpOptions } from 'sharp';
 
+interface OgImageComponent {
+    path?: string;
+    pascalName: string;
+    kebabName: string;
+    hash: string;
+    category: 'app' | 'official' | 'community' | 'pro';
+    credits?: string;
+}
 interface ScreenshotOptions {
     colorScheme?: 'dark' | 'light';
     selector?: string;
@@ -23,41 +33,43 @@ interface ScreenshotOptions {
     delay?: number;
 }
 interface OgImageOptions extends Partial<ScreenshotOptions> {
+    component?: string;
+    renderer?: 'chromium' | 'satori';
+    extension?: 'png' | 'jpeg' | 'jpg';
+    /**
+     * @deprecated use renderer. Replace `browser` with `chromium`
+     */
     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;
-    alt?: string;
     cache?: boolean;
     cacheKey?: string;
+    resvg?: ResvgRenderOptions;
+    satori?: SatoriOptions;
     /**
      * The time to live of the cache in milliseconds.
      */
     cacheTtl?: number;
-    /**
-     * @deprecated Use `cache` instead
-     */
-    static?: boolean;
     [key: string]: any;
 }
 interface FontConfig {
     name: string;
-    weight: number;
+    weight: string | 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';
-    cssInline?: boolean;
-    node?: boolean;
+    bindings: {
+        chromium: 'node' | false;
+        ['css-inline']: 'node' | false;
+        resvg: 'node' | 'wasm' | false;
+        satori: 'node' | 'yoga-wasm' | false;
+        sharp: 'node' | 'lambda' | false;
+    };
+    wasmStrategy?: 'inline' | 'import' | 'fetch';
     wasmImportQuery?: string;
 }
 
@@ -87,7 +99,19 @@ interface ModuleOptions {
      *
      * @see https://github.com/vercel/satori/blob/main/src/satori.ts#L18
      */
-    satoriOptions: Partial<SatoriOptions>;
+    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?: Partial<SharpOptions>;
     /**
      * Should the playground at <path>/__og_image__ be enabled in development.
      *
@@ -137,32 +161,12 @@ interface ModuleOptions {
      * Manually modify the deployment compatibility.
      */
     runtimeCompatibility?: Partial<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 {
+    'nuxt-og-image:components': (ctx: {
+        components: OgImageComponent[];
+    }) => Promise<void> | void;
     'og-image:config': (config: ModuleOptions) => Promise<void> | void;
-    'og-image:prerenderScreenshots': (queue: OgImageOptions[]) => Promise<void> | void;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.json

@@ -5,5 +5,5 @@
     "bridge": false
   },
   "configKey": "ogImage",
-  "version": "2.2.4"
+  "version": "3.0.0-beta.1"
 }