nuxt-og-image 3.0.0-rc.6 → 3.0.0-rc.61

package/dist/module.d.mts

@@ -3,110 +3,7 @@ import { AddComponentOptions } from '@nuxt/kit';
 import { SatoriOptions } from 'satori';
 import { ResvgRenderOptions } from '@resvg/resvg-js';
 import { SharpOptions } from 'sharp';
-import { WasmOptions } from 'nitropack';
-import { OgImageComponents } from '#nuxt-og-image/components';
-
-type IconifyEmojiIconSets = 'twemoji' | 'noto' | 'fluent-emoji' | 'fluent-emoji-flat' | 'fluent-emoji-high-contrast' | 'noto-v1' | 'emojione' | 'emojione-monotone' | 'emojione-v1' | 'streamline-emojis' | 'openmoji';
-interface OgImageComponent {
-    path?: string;
-    pascalName: string;
-    kebabName: string;
-    hash: string;
-    category: 'app' | 'community' | 'pro';
-    credits?: string;
-}
-interface ScreenshotOptions {
-    colorScheme?: 'dark' | 'light';
-    selector?: string;
-    mask?: string;
-    /**
-     * The width of the screenshot.
-     *
-     * @default 1200
-     */
-    width: number;
-    /**
-     * The height of the screenshot.
-     *
-     * @default 630
-     */
-    height: number;
-    /**
-     * How long to wait before taking the screenshot. Useful for waiting for animations.
-     */
-    delay?: number;
-}
-interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
-    /**
-     * The width of the screenshot.
-     *
-     * @default 1200
-     */
-    width?: number;
-    /**
-     * The height of the screenshot.
-     *
-     * @default 630
-     */
-    height?: number;
-    /**
-     * The alt text for the image.
-     */
-    alt?: string;
-    /**
-     * Use a prebuilt image instead of generating one.
-     *
-     * Should be an absolute URL.
-     */
-    url?: string;
-    /**
-     * The name of the component to render.
-     */
-    component?: T | string;
-    /**
-     * Props to pass to the component.
-     */
-    props?: OgImageComponents[T] | Record<string, any>;
-    renderer?: 'chromium' | 'satori';
-    extension?: 'png' | 'jpeg' | 'jpg';
-    emojis?: IconifyEmojiIconSets;
-    /**
-     * Provide a static HTML template to render the OG Image instead of a component.
-     */
-    html?: string;
-    resvg?: ResvgRenderOptions;
-    satori?: SatoriOptions;
-    screenshot?: Partial<ScreenshotOptions>;
-    sharp?: SharpOptions;
-    fonts?: InputFontConfig[];
-    cacheMaxAgeSeconds?: number;
-    /**
-     * @internal
-     */
-    _query?: Record<string, any>;
-}
-interface FontConfig {
-    name: string;
-    style?: string;
-    weight?: string | number;
-    path?: string;
-    key?: string;
-}
-type InputFontConfig = (`${string}:${number}` | string | FontConfig);
-interface RuntimeCompatibilitySchema {
-    chromium: 'node' | false;
-    ['css-inline']: 'node' | false;
-    resvg: 'node' | 'wasm' | 'wasm-fs' | false;
-    satori: 'node' | 'wasm' | 'wasm-fs' | false;
-    sharp: 'node' | false;
-    wasm?: WasmOptions;
-}
-type CompatibilityFlags = Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>;
-interface CompatibilityFlagEnvOverrides {
-    dev?: CompatibilityFlags;
-    runtime?: CompatibilityFlags;
-    prerender?: CompatibilityFlags;
-}
+import { OgImageOptions, InputFontConfig, CompatibilityFlagEnvOverrides, OgImageComponent } from '../dist/runtime/types.js';
 
 interface ModuleOptions {
     /**
@@ -126,7 +23,7 @@ interface ModuleOptions {
     /**
      * Fonts to use when rendering the og:image.
      *
-     * @example ['Roboto:400,700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
+     * @example ['Roboto:400', 'Roboto:700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
      */
     fonts: InputFontConfig[];
     /**
@@ -146,7 +43,7 @@ interface ModuleOptions {
      *
      * @see https://sharp.pixelplumbing.com/api-constructor
      */
-    sharpOptions?: Partial<SharpOptions>;
+    sharpOptions?: true | Partial<SharpOptions>;
     /**
      * Enables debug logs and a debug endpoint.
      *
@@ -181,6 +78,12 @@ interface ModuleOptions {
      * 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;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.d.ts

@@ -3,110 +3,7 @@ import { AddComponentOptions } from '@nuxt/kit';
 import { SatoriOptions } from 'satori';
 import { ResvgRenderOptions } from '@resvg/resvg-js';
 import { SharpOptions } from 'sharp';
-import { WasmOptions } from 'nitropack';
-import { OgImageComponents } from '#nuxt-og-image/components';
-
-type IconifyEmojiIconSets = 'twemoji' | 'noto' | 'fluent-emoji' | 'fluent-emoji-flat' | 'fluent-emoji-high-contrast' | 'noto-v1' | 'emojione' | 'emojione-monotone' | 'emojione-v1' | 'streamline-emojis' | 'openmoji';
-interface OgImageComponent {
-    path?: string;
-    pascalName: string;
-    kebabName: string;
-    hash: string;
-    category: 'app' | 'community' | 'pro';
-    credits?: string;
-}
-interface ScreenshotOptions {
-    colorScheme?: 'dark' | 'light';
-    selector?: string;
-    mask?: string;
-    /**
-     * The width of the screenshot.
-     *
-     * @default 1200
-     */
-    width: number;
-    /**
-     * The height of the screenshot.
-     *
-     * @default 630
-     */
-    height: number;
-    /**
-     * How long to wait before taking the screenshot. Useful for waiting for animations.
-     */
-    delay?: number;
-}
-interface OgImageOptions<T extends keyof OgImageComponents = 'NuxtSeo'> {
-    /**
-     * The width of the screenshot.
-     *
-     * @default 1200
-     */
-    width?: number;
-    /**
-     * The height of the screenshot.
-     *
-     * @default 630
-     */
-    height?: number;
-    /**
-     * The alt text for the image.
-     */
-    alt?: string;
-    /**
-     * Use a prebuilt image instead of generating one.
-     *
-     * Should be an absolute URL.
-     */
-    url?: string;
-    /**
-     * The name of the component to render.
-     */
-    component?: T | string;
-    /**
-     * Props to pass to the component.
-     */
-    props?: OgImageComponents[T] | Record<string, any>;
-    renderer?: 'chromium' | 'satori';
-    extension?: 'png' | 'jpeg' | 'jpg';
-    emojis?: IconifyEmojiIconSets;
-    /**
-     * Provide a static HTML template to render the OG Image instead of a component.
-     */
-    html?: string;
-    resvg?: ResvgRenderOptions;
-    satori?: SatoriOptions;
-    screenshot?: Partial<ScreenshotOptions>;
-    sharp?: SharpOptions;
-    fonts?: InputFontConfig[];
-    cacheMaxAgeSeconds?: number;
-    /**
-     * @internal
-     */
-    _query?: Record<string, any>;
-}
-interface FontConfig {
-    name: string;
-    style?: string;
-    weight?: string | number;
-    path?: string;
-    key?: string;
-}
-type InputFontConfig = (`${string}:${number}` | string | FontConfig);
-interface RuntimeCompatibilitySchema {
-    chromium: 'node' | false;
-    ['css-inline']: 'node' | false;
-    resvg: 'node' | 'wasm' | 'wasm-fs' | false;
-    satori: 'node' | 'wasm' | 'wasm-fs' | false;
-    sharp: 'node' | false;
-    wasm?: WasmOptions;
-}
-type CompatibilityFlags = Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>;
-interface CompatibilityFlagEnvOverrides {
-    dev?: CompatibilityFlags;
-    runtime?: CompatibilityFlags;
-    prerender?: CompatibilityFlags;
-}
+import { OgImageOptions, InputFontConfig, CompatibilityFlagEnvOverrides, OgImageComponent } from '../dist/runtime/types.js';
 
 interface ModuleOptions {
     /**
@@ -126,7 +23,7 @@ interface ModuleOptions {
     /**
      * Fonts to use when rendering the og:image.
      *
-     * @example ['Roboto:400,700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
+     * @example ['Roboto:400', 'Roboto:700', { path: 'path/to/font.ttf', weight: 400, name: 'MyFont' }]
      */
     fonts: InputFontConfig[];
     /**
@@ -146,7 +43,7 @@ interface ModuleOptions {
      *
      * @see https://sharp.pixelplumbing.com/api-constructor
      */
-    sharpOptions?: Partial<SharpOptions>;
+    sharpOptions?: true | Partial<SharpOptions>;
     /**
      * Enables debug logs and a debug endpoint.
      *
@@ -181,6 +78,12 @@ interface ModuleOptions {
      * 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;
 }
 interface ModuleHooks {
     'nuxt-og-image:components': (ctx: {

package/dist/module.json

@@ -1,9 +1,13 @@
 {
   "name": "nuxt-og-image",
   "compatibility": {
-    "nuxt": "^3.8.2",
+    "nuxt": ">=3.10.3",
     "bridge": false
   },
   "configKey": "ogImage",
-  "version": "3.0.0-rc.6"
+  "version": "3.0.0-rc.60",
+  "builder": {
+    "@nuxt/module-builder": "0.8.1",
+    "unbuild": "2.0.0"
+  }
 }