nuxt-og-image 6.7.6 → 6.7.7

package/dist/cli.d.cts

@@ -1 +0,0 @@
-

package/dist/content.cjs

@@ -1,21 +0,0 @@
-'use strict';
-
-const content = require('nuxtseo-shared/content');
-const zod = require('zod');
-
-const { defineSchema, asCollection, schema } = content.createContentSchemaFactory({
-  fieldName: "ogImage",
-  label: "og-image",
-  docsUrl: "https://nuxtseo.com/og-image/integrations/content",
-  buildSchema: (_z) => _z.object({
-    url: _z.string().optional(),
-    component: _z.string().optional(),
-    props: _z.record(_z.string(), _z.any())
-  }).optional()
-}, zod.z);
-const ogImageSchema = schema.shape.ogImage;
-
-exports.asOgImageCollection = asCollection;
-exports.defineOgImageSchema = defineSchema;
-exports.ogImageSchema = ogImageSchema;
-exports.schema = schema;

package/dist/content.d.cts

@@ -1,16 +0,0 @@
-import * as nuxtseo_shared_content from 'nuxtseo-shared/content';
-import { z } from 'zod';
-
-declare const defineSchema: (options?: nuxtseo_shared_content.ContentSchemaOptions | undefined) => z.ZodOptional<z.ZodObject<{
-    url: z.ZodOptional<z.ZodString>;
-    component: z.ZodOptional<z.ZodString>;
-    props: z.ZodRecord<z.ZodString, z.ZodAny>;
-}, z.core.$strip>>;
-declare const asCollection: <T>(collection: any) => T;
-declare const schema: z.ZodObject<{
-    [x: string]: any;
-}, z.core.$strip>;
-
-declare const ogImageSchema: any;
-
-export { asCollection as asOgImageCollection, defineSchema as defineOgImageSchema, ogImageSchema, schema };

package/dist/module.cjs

@@ -1,39 +0,0 @@
-'use strict';
-
-require('node:crypto');
-require('node:fs');
-require('node:fs/promises');
-require('node:url');
-require('@nuxt/kit');
-require('defu');
-require('fnv1a-64');
-require('nuxt-site-config/kit');
-require('nuxtseo-shared/kit');
-require('pathe');
-require('pkg-types');
-require('std-env');
-const module$1 = require('./shared/nuxt-og-image.CdpC3njh.cjs');
-require('../dist/runtime/logger.js');
-require('oxc-walker');
-require('chrome-launcher');
-require('nypm');
-require('nuxtseo-shared/devtools');
-require('unstorage');
-require('unstorage/drivers/fs-lite');
-require('../dist/runtime/server/og-image/utils/css.js');
-require('magic-string');
-require('strip-literal');
-require('ufo');
-require('unplugin');
-require('@vue/compiler-sfc');
-require('ofetch');
-require('ultrahtml');
-require('../dist/runtime/server/og-image/core/transforms/emojis/emoji-utils.js');
-require('exsolve');
-require('./shared/nuxt-og-image.CMYbz66P.cjs');
-require('magicast');
-require('magicast/helpers');
-
-
-
-module.exports = module$1.module;

package/dist/module.d.cts

@@ -1,219 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { ResvgRenderOptions } from '@resvg/resvg-js';
-import { SatoriOptions } from 'satori';
-import { SharpOptions } from 'sharp';
-import { OgImageComponent, RendererType, OgImageRuntimeConfig, OgImageOptions, CompatibilityFlagEnvOverrides, BrowserConfig } from '../dist/runtime/types.js';
-export { OgImageComponent, OgImageOptions, OgImageRenderEventContext, OgImageRuntimeConfig, RuntimeCompatibilitySchema, VNode } 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 { width: 1200, height: 600, extension: 'png', emojis: 'noto', cacheMaxAgeSeconds: 60 * 60 * 24 * 3 }
-     */
-    defaults: Omit<OgImageOptions, 'component' | 'renderer' | 'props' | 'url' | 'html' | 'key' | 'cacheKey' | '_query' | '_hash' | 'socialPreview'>;
-    /**
-     * 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;
-    /**
-     * Configure the runtime cache storage for generated OG images.
-     * - `true` - Use Nitro's default cache storage (default)
-     * - `false` - Disable caching
-     * - `string` - Use a custom storage mount key (e.g., `'redis'`). You must mount the storage yourself via a Nitro plugin.
-     * - `object` - Provide a driver config that the module will mount for you (build-time only)
-     *
-     * @default true
-     * @see https://nitro.unjs.io/guide/storage#mountpoints
-     * @example runtimeCacheStorage: 'redis' // Use your own mounted 'redis' storage
-     * @example runtimeCacheStorage: { driver: 'redis', host: 'localhost', port: 6379 }
-     */
-    runtimeCacheStorage: boolean | string | (Record<string, any> & {
-        driver: string;
-    });
-    /**
-     * Custom version string for cache key namespacing.
-     *
-     * By default, the module version is used which invalidates cache on upgrades.
-     * Set a static value like `'v1'` to persist cache across module updates.
-     * Set to `false` to disable versioning entirely.
-     *
-     * @default module version
-     * @example cacheVersion: 'v1'
-     * @example cacheVersion: false
-     */
-    cacheVersion?: string | false;
-    /**
-     * Extra component directories that should be used to resolve components.
-     *
-     * @default ['OgImage', 'OgImageCommunity', 'og-image', 'OgImageTemplate']
-     */
-    componentDirs: string[];
-    /**
-     * Manually modify the compatibility.
-     */
-    compatibility?: CompatibilityFlagEnvOverrides;
-    /**
-     * Only allow the prerendering and dev runtimes to generate images.
-     */
-    zeroRuntime?: boolean;
-    /**
-     * Enable persistent build cache for CI environments.
-     * Caches rendered images to disk so they persist between CI runs.
-     *
-     * @default false
-     * @example true
-     * @example { base: '.cache/og-image' }
-     */
-    buildCache?: boolean | {
-        base?: string;
-    };
-    /**
-     * Warn about OG Image components missing renderer suffix in dev mode.
-     * Set to false to suppress warnings for legacy/test components.
-     *
-     * @default true
-     */
-    warnMissingSuffix?: boolean;
-    /**
-     * @deprecated Runtime always uses Iconify API now. Build-time uses local icons if available.
-     * Use `defaults.emojis: false` to disable emoji support entirely.
-     */
-    emojiStrategy?: 'auto' | 'local' | 'fetch';
-    /**
-     * Default cache duration in seconds for generated OG images.
-     *
-     * Controls the internal storage TTL, HTTP Cache-Control headers, and the
-     * auto-configured SWR route rule. Can be overridden per-image via
-     * `defineOgImage`'s `cacheMaxAgeSeconds` option.
-     *
-     * @default 60 * 60 * 24 * 3 (3 days)
-     */
-    cacheMaxAgeSeconds?: number;
-    /**
-     * Font subsets to download when resolving missing font families via fontless.
-     *
-     * Fonts from @nuxt/fonts are always included with all their subsets (devanagari,
-     * cyrillic, etc.). This option only controls which subsets fontless downloads when
-     * supplementing missing families for the Satori renderer.
-     *
-     * @default ['latin']
-     * @example ['latin', 'latin-ext', 'devanagari']
-     */
-    fontSubsets?: string[];
-    /**
-     * Browser renderer configuration.
-     *
-     * When using browser-based rendering (screenshots), configure the browser provider.
-     * For Cloudflare deployments, specify the browser binding name.
-     *
-     * @example { provider: 'cloudflare', binding: 'BROWSER' }
-     */
-    browser?: BrowserConfig;
-    /**
-     * Security limits for image generation. Prevents denial of service via
-     * oversized dimensions, unbounded DPR, or long-running renders.
-     */
-    security?: {
-        /** Maximum allowed width or height in pixels. @default 2048 */
-        maxDimension?: number;
-        /** Maximum device pixel ratio (takumi renderer). @default 2 */
-        maxDpr?: number;
-        /** Render timeout in milliseconds. Returns 408 on timeout. @default 15000 */
-        renderTimeout?: number;
-        /**
-         * Per-image fetch timeout in milliseconds.
-         *
-         * Applies to remote `<img>` / `background-image` fetches done while resolving templates.
-         * A stalled resource can otherwise consume the entire `renderTimeout` budget, which
-         * shows up as near-total request timeouts on edge platforms (e.g. Cloudflare Workers
-         * when the image URL routes back through the same worker).
-         *
-         * @default 3000
-         */
-        imageFetchTimeout?: number;
-        /**
-         * Maximum allowed length (in characters) for the query string on runtime OG image requests.
-         * Requests exceeding this limit receive a 400 response.
-         *
-         * Set to a number to enable (e.g. `2048`). Leave `null` to disable.
-         *
-         * @default null
-         */
-        maxQueryParamSize?: number | null;
-        /**
-         * Restrict runtime image generation to requests whose Host header matches allowed hosts.
-         * - `true`: only allow requests whose Host matches the site config URL host
-         * - `string[]`: allow the site config URL host plus these additional origins
-         * - `false` (default): no host restriction
-         *
-         * Uses h3's `getRequestHost` with `X-Forwarded-Host` support for reverse proxies.
-         * Prerendering and dev mode are never restricted.
-         *
-         * @default false
-         */
-        restrictRuntimeImagesToOrigin?: boolean | string[];
-        /**
-         * Secret for URL signing. When set, all runtime OG image URLs include a
-         * keyed hash signature and the handler rejects requests with missing or
-         * invalid signatures.
-         *
-         * Leave unset to auto-generate a per-build secret (signing on by default).
-         * Set an explicit, stable string for rolling or multi-instance deploys, or
-         * `false` to disable signing entirely. Generate one with:
-         * `npx nuxt-og-image generate-secret`
-         *
-         * Required (explicitly) when `strict` is enabled.
-         */
-        secret?: string | false;
-        /**
-         * Enable strict security mode. When enabled:
-         * - `secret` is required (URL signing)
-         * - The `html` option is disabled (prevents SSRF via inline HTML injection)
-         * - `maxQueryParamSize` defaults to `2048`
-         * - `restrictRuntimeImagesToOrigin` defaults to `true`
-         *
-         * @default false
-         */
-        strict?: boolean;
-    };
-}
-interface ModuleHooks {
-    'nuxt-og-image:components': (ctx: {
-        components: OgImageComponent[];
-        detectedRenderers: Set<RendererType>;
-    }) => Promise<void> | void;
-    'nuxt-og-image:runtime-config': (config: OgImageRuntimeConfig) => Promise<void> | void;
-}
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
-
-export = _default;
-export type { ModuleHooks, ModuleOptions };

package/dist/shared/nuxt-og-image.CMYbz66P.cjs

@@ -1,193 +0,0 @@
-'use strict';
-
-const fs = require('node:fs');
-const magicast = require('magicast');
-const helpers = require('magicast/helpers');
-const pathe = require('pathe');
-const logger_js = require('../../dist/runtime/logger.js');
-
-function parseFontString(font) {
-  const parts = font.split(":");
-  if (parts.length === 3) {
-    return {
-      name: parts[0] || font,
-      style: parts[1] === "ital" ? "italic" : "normal",
-      weight: Number.parseInt(parts[2] || "") || 400
-    };
-  }
-  return {
-    name: parts[0] || font,
-    weight: Number.parseInt(parts[1] || "") || 400,
-    style: "normal"
-  };
-}
-function groupFontsByFamily(fonts) {
-  const families = /* @__PURE__ */ new Map();
-  for (const font of fonts) {
-    const parsed = parseFontString(font);
-    const existing = families.get(parsed.name);
-    if (existing) {
-      existing.weights.add(parsed.weight);
-      existing.styles.add(parsed.style);
-    } else {
-      families.set(parsed.name, {
-        weights: /* @__PURE__ */ new Set([parsed.weight]),
-        styles: /* @__PURE__ */ new Set([parsed.style])
-      });
-    }
-  }
-  return Array.from(families.entries(), ([name, { weights, styles }]) => ({
-    name,
-    weights: [...weights].toSorted((a, b) => a - b),
-    styles: [...styles]
-  }));
-}
-async function migrateFontsConfig(rootDir) {
-  const configPaths = [
-    "nuxt.config.ts",
-    "nuxt.config.js",
-    "nuxt.config.mjs"
-  ];
-  let configPath;
-  for (const p of configPaths) {
-    const fullPath = pathe.join(rootDir, p);
-    if (fs.existsSync(fullPath)) {
-      configPath = fullPath;
-      break;
-    }
-  }
-  if (!configPath) {
-    return { migrated: false, message: "No nuxt.config found" };
-  }
-  const mod = await magicast.loadFile(configPath);
-  const config = mod.exports.default;
-  if (!config?.ogImage?.fonts) {
-    return { migrated: false, message: "No ogImage.fonts config found" };
-  }
-  const oldFonts = config.ogImage.fonts;
-  if (!Array.isArray(oldFonts) || oldFonts.length === 0) {
-    return { migrated: false, message: "ogImage.fonts is empty or invalid" };
-  }
-  const groupedFonts = groupFontsByFamily(oldFonts);
-  if (!config.fonts) {
-    config.fonts = {};
-  }
-  if (!config.fonts.families) {
-    config.fonts.families = [];
-  }
-  const existingFamilies = config.fonts.families;
-  for (const font of groupedFonts) {
-    const existing = existingFamilies.find((f) => f.name === font.name);
-    if (existing) {
-      const existingWeights = new Set(existing.weights || []);
-      for (const w of font.weights) {
-        existingWeights.add(w);
-      }
-      existing.weights = [...existingWeights].toSorted((a, b) => a - b);
-      if (font.styles.includes("italic")) {
-        const existingStyles = new Set(existing.styles || ["normal"]);
-        existingStyles.add("italic");
-        existing.styles = [...existingStyles];
-      }
-      existing.global = true;
-    } else {
-      const family = {
-        name: font.name,
-        weights: font.weights,
-        global: true
-      };
-      if (font.styles.includes("italic")) {
-        family.styles = font.styles;
-      }
-      existingFamilies.push(family);
-    }
-  }
-  helpers.addNuxtModule(mod, "@nuxt/fonts");
-  delete config.ogImage.fonts;
-  if (Object.keys(config.ogImage).length === 0) {
-    delete config.ogImage;
-  }
-  await magicast.writeFile(mod, configPath);
-  const familyNames = groupedFonts.map((f) => f.name).join(", ");
-  return {
-    migrated: true,
-    message: `Migrated fonts (${familyNames}) from ogImage.fonts to @nuxt/fonts`
-  };
-}
-async function migrateDefaultsComponent(rootDir) {
-  const configPaths = [
-    "nuxt.config.ts",
-    "nuxt.config.js",
-    "nuxt.config.mjs"
-  ];
-  let configPath;
-  for (const cp of configPaths) {
-    const fullPath = pathe.join(rootDir, cp);
-    if (fs.existsSync(fullPath)) {
-      configPath = fullPath;
-      break;
-    }
-  }
-  if (!configPath)
-    return { migrated: false, componentName: null, message: "No nuxt.config found" };
-  const mod = await magicast.loadFile(configPath);
-  const config = mod.exports.default;
-  if (!config?.ogImage?.defaults?.component)
-    return { migrated: false, componentName: null, message: "No defaults.component found" };
-  const componentName = String(config.ogImage.defaults.component);
-  delete config.ogImage.defaults.component;
-  if (config.ogImage.defaults && Object.keys(config.ogImage.defaults).length === 0)
-    delete config.ogImage.defaults;
-  if (config.ogImage && Object.keys(config.ogImage).length === 0)
-    delete config.ogImage;
-  await magicast.writeFile(mod, configPath);
-  return { migrated: true, componentName, message: `Removed defaults.component: '${componentName}'` };
-}
-async function promptFontsMigration(rootDir) {
-  logger_js.logger.info("");
-  logger_js.logger.info("Detected deprecated ogImage.fonts configuration.");
-  logger_js.logger.info("");
-  logger_js.logger.info("Inter fonts now work out of the box without any configuration.");
-  logger_js.logger.info("For custom fonts, use @nuxt/fonts:");
-  logger_js.logger.info("");
-  logger_js.logger.info("Before:");
-  logger_js.logger.info("  ogImage: {");
-  logger_js.logger.info("    fonts: ['Inter:400', 'Inter:700']");
-  logger_js.logger.info("  }");
-  logger_js.logger.info("");
-  logger_js.logger.info("After (Inter only): Remove the config entirely \u2014 it works by default.");
-  logger_js.logger.info("");
-  logger_js.logger.info("After (custom fonts):");
-  logger_js.logger.info("  modules: ['@nuxt/fonts', 'nuxt-og-image'],");
-  logger_js.logger.info("  fonts: {");
-  logger_js.logger.info("    families: [");
-  logger_js.logger.info("      { name: 'Roboto', weights: [400, 700], global: true }");
-  logger_js.logger.info("    ]");
-  logger_js.logger.info("  }");
-  logger_js.logger.info("");
-  const migrate = await logger_js.logger.prompt("Automatically migrate nuxt.config?", {
-    type: "confirm",
-    initial: true
-  });
-  if (migrate) {
-    const result = await migrateFontsConfig(rootDir).catch((err) => {
-      logger_js.logger.error(`Migration failed: ${err.message}`);
-      return { migrated: false, message: err.message };
-    });
-    if (result.migrated) {
-      logger_js.logger.success(result.message);
-      logger_js.logger.info("");
-      logger_js.logger.info("Please install @nuxt/fonts:");
-      logger_js.logger.info("  npm add @nuxt/fonts");
-    } else {
-      logger_js.logger.warn(`Could not migrate: ${result.message}`);
-      logger_js.logger.info("Please migrate manually.");
-    }
-  } else {
-    logger_js.logger.info("Skipping automatic migration. Please migrate manually.");
-  }
-}
-
-exports.migrateDefaultsComponent = migrateDefaultsComponent;
-exports.migrateFontsConfig = migrateFontsConfig;
-exports.promptFontsMigration = promptFontsMigration;