Skip to content

Upgrading nuxt-og-image 3 to 4

Breaking3.1.1 → 4.2.0Breaking1New2Changed1Fixed21

BreakingUpgrade verdict

1 breaking change.

  • Upgrade nuxt-site-config v3  -  (0e37a).
1 item needs code or config changes

Adds @unhead/ssr ^1.11.20, @unocss/preset-wind3 ^66.0.0, consola ^3.4.0.

Drops @unocss/preset-wind, nuxt-site-config-kit.

Installs 180 packages in all (was 175).

Breaking1
Upgrade nuxt-site-config v3  -  (0e37a).

Generated by DepDelta from published .d.ts files. Not mixed with prose notes.

  • added: export * from './dist/content'
  • added: const schema: zod.ZodObject<{ ogImage: zod.ZodOptional<zod.ZodObject<{ url: zod.ZodOptional<zod.ZodString>; component: zod.ZodOptional<zod.ZodString>; props: zod.ZodRecord<z…
  • added: function asOgImageCollection<T extends ZodRawShape>(collection: Collection<T>): Collection<T>
  • added: type OgImageSchema = TypeOf<typeof schema>
  • changed: property ModuleOptions.strictNuxtContentPaths: boolean → property ModuleOptions.strictNuxtContentPaths?: boolean
  • added: const gray: (s: string) => string
  • added: const logger: import('consola').ConsolaInstance
  • changed: function resolvePathCacheKey(e: H3Event, path?: string): string → function resolvePathCacheKey(e: H3Event, path: string): string
  • changed: function createSvg(event: OgImageRenderEventContext): Promise<string> → function createSvg(event: OgImageRenderEventContext): Promise<string | void>
  • removed: const _default: any
  • removed: default _default
  • added: const _default: any
  • added: default _default
  • removed: const _default: any
  • removed: default _default
  • added: const _default: any
  • added: default _default
  • changed: function generateMeta(url: string, resolvedOptions: OgImageOptions): import('@unhead/schema').Meta<import('@unhead/schema').UserTagConfigWithoutInnerContent>[] → function generateMeta(url: string, resolvedOptions: OgImageOptions): Head['meta']
  • removed: property OgImageRuntimeConfig.hasNuxtContent: boolean
  • changed: property FontConfig.style?: string → property FontConfig.style?: 'normal' | 'ital'
  • changed: type InputFontConfig = (`${string}:${number}` | string | FontConfig) → type InputFontConfig = (`${string}:${number}` | `${string}:${'normal' | 'ital'}:${number}` | string | FontConfig)
  • added: property OgImageRenderEventContext.runtimeConfig: OgImageRuntimeConfig
  • added: property OgImageRenderEventContext.unocss: UnoGenerator
  • added: property OgImageRuntimeConfig.app: { baseURL: string }