nuxt-og-image 3.0.0-rc.8 → 3.0.0

package/dist/runtime/types.d.ts

@@ -1,11 +1,11 @@
-import type { html } from 'satori-html';
-import type { H3Error, H3Event } from 'h3';
+import type { OgImageComponents } from '#nuxt-og-image/components';
 import type { ResvgRenderOptions } from '@resvg/resvg-js';
-import type { SatoriOptions } from 'satori';
 import type { AllowedComponentProps, Component, ComponentCustomProps, VNodeProps } from '@vue/runtime-core';
+import type { H3Error, H3Event } from 'h3';
+import type { NitroApp, NitroOptions } from 'nitropack';
+import type { SatoriOptions } from 'satori';
+import type { html } from 'satori-html';
 import type { SharpOptions } from 'sharp';
-import type { NitroApp, WasmOptions } from 'nitropack';
-import type { OgImageComponents } from '#nuxt-og-image/components';
 export interface OgImageRenderEventContext {
     e: H3Event;
     extension: 'png' | 'jpeg' | 'jpg' | 'svg' | 'html' | 'json';
@@ -14,6 +14,7 @@ export interface OgImageRenderEventContext {
     renderer: Renderer;
     options: OgImageOptions;
     isDebugJsonPayload: boolean;
+    publicStoragePath: string;
     _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';
@@ -22,12 +23,15 @@ export interface OgImageRuntimeConfig {
     satoriOptions: SatoriOptions;
     resvgOptions: ResvgRenderOptions;
     sharpOptions: SharpOptions;
+    publicStoragePath: string;
     defaults: OgImageOptions;
     debug: boolean;
     baseCacheKey: string;
     fonts: FontConfig[];
     hasNuxtIcon: boolean;
     colorPreference: 'light' | 'dark';
+    isNuxtContentDocumentDriven: boolean;
+    zeroRuntime: boolean;
 }
 export interface OgImageComponent {
     path?: string;
@@ -60,7 +64,7 @@ export interface ScreenshotOptions {
 }
 export type OgImagePrebuilt = {
     url: string;
-} & Pick<OgImageOptions, 'width' | 'height' | 'alt'>;
+} & Pick<OgImageOptions, 'width' | 'height' | 'alt' | '_query'>;
 export type DefineOgImageInput = OgImageOptions | OgImagePrebuilt | false;
 export interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
     /**
@@ -117,6 +121,7 @@ export interface FontConfig {
     weight?: string | number;
     path?: string;
     key?: string;
+    absolutePath?: boolean;
 }
 export interface ResolvedFontConfig extends FontConfig {
     cacheKey: string;
@@ -124,12 +129,12 @@ export interface ResolvedFontConfig extends FontConfig {
 }
 export type InputFontConfig = (`${string}:${number}` | string | FontConfig);
 export interface RuntimeCompatibilitySchema {
-    chromium: 'node' | false;
-    ['css-inline']: 'node' | false;
+    chromium: 'chrome-launcher' | 'on-demand' | 'playwright' | false;
+    ['css-inline']: 'node' | 'wasm' | 'wasm-fs' | false;
     resvg: 'node' | 'wasm' | 'wasm-fs' | false;
     satori: 'node' | 'wasm' | 'wasm-fs' | false;
     sharp: 'node' | false;
-    wasm?: WasmOptions;
+    wasm?: NitroOptions['wasm'];
 }
 export type CompatibilityFlags = Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>;
 export interface CompatibilityFlagEnvOverrides {
@@ -151,5 +156,9 @@ export type OgImagePageScreenshotOptions = Omit<OgImageOptions, 'html' | 'render
 export type VNode = ReturnType<typeof html>;
 export interface SatoriTransformer {
     filter: (node: VNode) => boolean;
-    transform: (node: VNode, e: OgImageRenderEventContext) => Promise<void>;
+    transform: (node: VNode, e: OgImageRenderEventContext) => Promise<void> | void;
+}
+export interface SocialPreviewMetaData {
+    twitter?: Record<string, string>;
+    og?: Record<string, string>;
 }

package/dist/types.d.mts

@@ -1,18 +1,7 @@
-
-import type { ModuleOptions, ModuleHooks } from './module'
-
+import type { ModuleHooks } from './module.js'
 
 declare module '@nuxt/schema' {
-  interface NuxtConfig { ['ogImage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['ogImage']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['ogImage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['ogImage']?: ModuleOptions }
   interface NuxtHooks extends ModuleHooks {}
 }
 
-
-export type { ModuleHooks, ModuleOptions, default } from './module'
+export { type ModuleHooks, type ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -1,18 +1,7 @@
-
-import type { ModuleOptions, ModuleHooks } from './module'
-
+import type { ModuleHooks } from './module'
 
 declare module '@nuxt/schema' {
-  interface NuxtConfig { ['ogImage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['ogImage']?: ModuleOptions }
-  interface NuxtHooks extends ModuleHooks {}
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['ogImage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['ogImage']?: ModuleOptions }
   interface NuxtHooks extends ModuleHooks {}
 }
 
-
-export type { ModuleHooks, ModuleOptions, default } from './module'
+export { type ModuleHooks, type ModuleOptions, default } from './module'

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "nuxt-og-image",
   "type": "module",
-  "version": "3.0.0-rc.8",
-  "packageManager": "pnpm@8.12.0",
+  "version": "3.0.0",
   "description": "Enlightened OG Image generation for Nuxt.",
   "author": {
     "website": "https://harlanzw.com",
@@ -11,79 +10,102 @@
   },
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
-  "homepage": "https://github.com/harlan-zw/nuxt-og-image#readme",
+  "homepage": "https://nuxtseo.com/og-image",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/harlan-zw/nuxt-og-image.git"
+    "url": "git+https://github.com/nuxt-modules/og-image.git"
   },
   "bugs": {
-    "url": "https://github.com/harlan-zw/nuxt-og-image/issues"
+    "url": "https://github.com/nuxt-modules/og-image/issues"
   },
   "exports": {
     ".": {
-      "types": "./dist/types.d.ts",
+      "types": "./dist/module.d.ts",
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
     }
   },
   "main": "./dist/module.cjs",
-  "types": "./dist/types.d.ts",
+  "types": "./dist/module.d.ts",
   "files": [
     "dist",
     "virtual.d.ts"
   ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
-    "@iconify-json/noto": "^1.1.17",
-    "@nuxt/devtools-kit": "^1.0.5",
-    "@nuxt/kit": "^3.8.2",
-    "@resvg/resvg-js": "^2.6.0",
-    "@resvg/resvg-wasm": "^2.6.0",
-    "@unocss/core": "^0.58.0",
-    "@unocss/preset-wind": "^0.58.0",
-    "@vueuse/core": "^10.7.0",
-    "chrome-launcher": "^1.1.0",
-    "css-inline": "^0.11.2",
-    "defu": "^6.1.3",
-    "execa": "^8.0.1",
-    "floating-vue": "2.0.0-beta.24",
-    "image-size": "^1.0.2",
-    "nuxt-site-config": "^1.6.7",
-    "nuxt-site-config-kit": "^1.6.7",
-    "nypm": "^0.3.3",
-    "ofetch": "^1.3.3",
+    "@nuxt/devtools-kit": "^1.4.2",
+    "@nuxt/kit": "^3.13.1",
+    "@resvg/resvg-js": "^2.6.2",
+    "@resvg/resvg-wasm": "^2.6.2",
+    "@unocss/core": "^0.62.3",
+    "@unocss/preset-wind": "^0.62.3",
+    "chrome-launcher": "^1.1.2",
+    "defu": "^6.1.4",
+    "execa": "^9.3.1",
+    "image-size": "^1.1.1",
+    "magic-string": "^0.30.11",
+    "nuxt-site-config": "^2.2.17",
+    "nuxt-site-config-kit": "^2.2.17",
+    "nypm": "^0.3.11",
+    "ofetch": "^1.3.4",
     "ohash": "^1.1.3",
-    "pathe": "^1.1.1",
-    "playwright-core": "^1.40.1",
-    "radix3": "^1.1.0",
-    "satori": "0.10.11",
+    "pathe": "^1.1.2",
+    "pkg-types": "^1.2.0",
+    "playwright-core": "^1.47.0",
+    "radix3": "^1.1.2",
+    "satori": "^0.10.14",
     "satori-html": "^0.3.2",
-    "sirv": "^2.0.3",
-    "std-env": "^3.6.0",
-    "terminate": "^2.6.1",
-    "ufo": "^1.3.2",
+    "sirv": "^2.0.4",
+    "std-env": "^3.7.0",
+    "strip-literal": "^2.1.0",
+    "ufo": "^1.5.4",
+    "unplugin": "^1.14.1",
+    "unwasm": "^0.3.9",
     "yoga-wasm-web": "^0.3.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "2.4.4",
-    "@img/sharp-linux-x64": "0.33.0",
-    "@nuxt/content": "^2.9.0",
-    "@nuxt/devtools": "1.0.5",
-    "@nuxt/module-builder": "^0.5.4",
-    "@nuxt/test-utils": "3.8.1",
-    "@nuxt/ui": "^2.11.0",
+    "@antfu/eslint-config": "^3.5.1",
+    "@css-inline/css-inline": "^0.14.1",
+    "@headlessui/vue": "^1.7.23",
+    "@iconify-json/carbon": "^1.2.1",
+    "@iconify-json/logos": "^1.2.0",
+    "@iconify-json/noto": "^1.2.0",
+    "@iconify-json/ri": "^1.2.0",
+    "@iconify-json/tabler": "^1.2.2",
+    "@img/sharp-linux-x64": "0.33.5",
+    "@nuxt/content": "^2.13.2",
+    "@nuxt/devtools": "1.4.2",
+    "@nuxt/devtools-ui-kit": "^1.4.2",
+    "@nuxt/icon": "^1.5.1",
+    "@nuxt/image": "^1.8.0",
+    "@nuxt/module-builder": "^0.8.4",
+    "@nuxt/test-utils": "3.14.1",
+    "@nuxt/ui": "^2.18.4",
+    "@nuxtjs/color-mode": "^3.4.4",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@nuxtjs/i18n": "8.0.0-rc.9",
-    "@nuxtjs/tailwindcss": "^6.10.1",
-    "@unocss/nuxt": "^0.58.0",
-    "bumpp": "^9.2.1",
-    "eslint": "8.55.0",
-    "jest-image-snapshot": "^6.3.0",
-    "nuxt": "^3.8.2",
-    "nuxt-icon": "0.6.7",
-    "playwright": "^1.40.1",
-    "sass": "^1.69.5",
-    "sharp": "^0.33.0",
-    "vitest": "^1.0.4"
+    "@nuxtjs/i18n": "^8.5.3",
+    "@nuxtjs/tailwindcss": "^6.12.1",
+    "@unocss/nuxt": "^0.62.3",
+    "@unocss/preset-icons": "^0.62.3",
+    "@unocss/preset-uno": "^0.62.3",
+    "@unocss/runtime": "^0.62.3",
+    "@vueuse/nuxt": "^11.0.3",
+    "bumpp": "^9.5.2",
+    "eslint": "9.10.0",
+    "jest-image-snapshot": "^6.4.0",
+    "nuxt": "^3.13.1",
+    "playwright": "^1.47.0",
+    "sass": "^1.78.0",
+    "sharp": "^0.33.5",
+    "typescript": "^5.6.2",
+    "unocss": "^0.62.3",
+    "vitest": "^2.0.5"
+  },
+  "resolutions": {
+    "vue": "3.5.4",
+    "vue-router": "4.4.4"
   },
   "build": {
     "externals": [
@@ -91,19 +113,24 @@
       "nitropack",
       "@vue/runtime-core",
       "#nuxt-og-image/components",
-      "sharp"
+      "sharp",
+      "unstorage",
+      "unstorage/drivers/fs",
+      "consola/utils"
     ]
   },
   "scripts": {
-    "stub": "nuxt-build-module build --stub",
-    "build": "pnpm dev:prepare && pnpm build:module && pnpm build:client",
+    "stub": "nuxt-build-module build --stub && nuxt-module-build prepare",
+    "build": "pnpm stub && nuxt-module-build build && pnpm run build:client",
     "build:client": "nuxi generate client",
     "build:module": "nuxt-build-module build",
+    "client:dev": "nuxi dev client --port 3030",
     "lint": "eslint . --fix",
-    "dev": "nuxi dev .playground",
-    "dev:build": "nuxi build .playground",
-    "dev:prepare": "nuxt-module-build build --stub && nuxi prepare .playground",
-    "release": "bumpp package.json --commit --push --tag",
-    "test": "vitest"
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground && nuxi prepare client",
+    "release": "pnpm build && bumpp && pnpm -r publish --no-git-checks",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest integration/endpoints"
   }
 }

package/dist/client/_nuxt/IconCSS.ad457eae.js

@@ -1 +0,0 @@
-import{g as _,h as m,i as d,j as c,r as f,o as I,c as v,n as x,_ as S}from"./entry.6876d7da.js";const y=_({__name:"IconCSS",props:{name:{type:String,required:!0},size:{type:String,default:""}},setup(u){m(e=>({"862fb1b8":p.value}));const t=d(),s=u,l=c(()=>{var e,n;return(n=(e=t.nuxtIcon)==null?void 0:e.aliases)!=null&&n[s.name]?t.nuxtIcon.aliases[s.name]:s.name}),r=c(()=>f(l.value)),p=c(()=>{var o,a;const e=(a=(o=t.nuxtIcon)==null?void 0:o.iconifyApiOptions)==null?void 0:a.url;if(e)try{new URL(e)}catch{console.warn("Nuxt IconCSS: Invalid custom Iconify API URL");return}return`url('${e||"https://api.iconify.design"}/${r.value.prefix}/${r.value.name}.svg')`}),i=c(()=>{var n,o,a;if(!s.size&&typeof((n=t.nuxtIcon)==null?void 0:n.size)=="boolean"&&!((o=t.nuxtIcon)!=null&&o.size))return;const e=s.size||((a=t.nuxtIcon)==null?void 0:a.size)||"1em";return String(Number(e))===e?`${e}px`:e});return(e,n)=>(I(),v("span",{style:x({width:i.value,height:i.value})},null,4))}});const C=S(y,[["__scopeId","data-v-9ed8e03d"]]);export{C as default};

package/dist/client/_nuxt/IconCSS.f0b56d3e.css

@@ -1 +0,0 @@
-span[data-v-9ed8e03d]{background-color:currentColor;display:inline-block;-webkit-mask-image:var(--862fb1b8);mask-image:var(--862fb1b8);-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/builds/meta/d8d0c16f-2709-4917-9aad-088138ea1bcf.json

@@ -1 +0,0 @@
-{"id":"d8d0c16f-2709-4917-9aad-088138ea1bcf","timestamp":1702291956545,"matcher":{"static":{},"wildcard":{},"dynamic":{}},"prerendered":[]}