Unverified Commit dc57cde3 authored by Shu Ding's avatar Shu Ding Committed by GitHub

Update `@vercel/og` and `satori` vendors (#90933)

The new `@vercel/og` and `satori` include many improvements:
- 2~20x faster image generation (`ImageResponse` API) by using Sharp for
rasterization, and optimized Satori core
- Better CSS/SVG coverage:
  - https://github.com/vercel/satori/issues/736
  - https://github.com/vercel/satori/pull/734
  - https://github.com/vercel/satori/pull/733
  - https://github.com/vercel/satori/pull/732
  - https://github.com/vercel/satori/issues/728
  - https://github.com/vercel/satori/issues/724
  - https://github.com/vercel/satori/pull/717
  - https://github.com/vercel/satori/pull/718
  - https://github.com/vercel/satori/pull/719
- Updated layout engine (https://github.com/vercel/satori/pull/689):
  - Support for `box-sizing`
  - Support for `display: contents`
  - Support for `position: static`
  - Support for `align-content: space-evenly`
  - Better support for `position: absolute`
  - Support for percentage values for `gap`
- Noto Sans → Geist Sans
parent 747d3dc4
...@@ -176,7 +176,7 @@ ...@@ -176,7 +176,7 @@
"@types/yargs": "16.0.11", "@types/yargs": "16.0.11",
"@vercel/devlow-bench": "workspace:*", "@vercel/devlow-bench": "workspace:*",
"@vercel/kv": "3.0.0", "@vercel/kv": "3.0.0",
"@vercel/og": "0.7.2", "@vercel/og": "0.11.1",
"abort-controller": "3.0.0", "abort-controller": "3.0.0",
"alex": "9.1.0", "alex": "9.1.0",
"async-sema": "3.0.1", "async-sema": "3.0.1",
...@@ -281,7 +281,7 @@ ...@@ -281,7 +281,7 @@
"request-promise-core": "1.1.2", "request-promise-core": "1.1.2",
"resolve-from": "5.0.0", "resolve-from": "5.0.0",
"sass": "1.54.0", "sass": "1.54.0",
"satori": "0.15.2", "satori": "0.25.0",
"scheduler-builtin": "npm:scheduler@0.28.0-canary-3bc2d414-20260304", "scheduler-builtin": "npm:scheduler@0.28.0-canary-3bc2d414-20260304",
"scheduler-experimental-builtin": "npm:scheduler@0.0.0-experimental-3bc2d414-20260304", "scheduler-experimental-builtin": "npm:scheduler@0.0.0-experimental-3bc2d414-20260304",
"seedrandom": "3.0.5", "seedrandom": "3.0.5",
......
/**
* Modified version of https://unpkg.com/twemoji@13.1.0/dist/twemoji.esm.js.
*/
export declare function getIconCode(char: string): string;
declare const apis: {
twemoji: (code: any) => string;
openmoji: string;
blobmoji: string;
noto: string;
fluent: (code: any) => string;
fluentFlat: (code: any) => string;
};
export type EmojiType = keyof typeof apis;
export declare function loadEmoji(code: string, type?: EmojiType): Promise<Response>;
export {};
import type { EdgeImageResponse } from '../index.edge';
import { FigmaImageResponseProps } from '../types';
type InternalFigmaImageResponseProps = FigmaImageResponseProps & {
Response: EdgeImageResponse;
};
export declare const FigmaImageResponse: ({ url, template, fonts, imageResponseOptions, Response, }: InternalFigmaImageResponseProps) => Promise<import("../index.edge").ImageResponse>;
export {};
import type { ReactElement } from 'react'; import { ReactElement } from 'react';
import type { ImageResponseOptions, FigmaImageResponseProps } from './types'; import { ImageResponseOptions } from './types.js';
export declare class ImageResponse extends Response { import "next/dist/compiled/@vercel/og/satori";
import 'http';
declare class ImageResponse extends Response {
constructor(element: ReactElement, options?: ImageResponseOptions); constructor(element: ReactElement, options?: ImageResponseOptions);
} }
export declare const experimental_FigmaImageResponse: (props: FigmaImageResponseProps) => Promise<ImageResponse>; type EdgeImageResponse = typeof ImageResponse;
export type EdgeImageResponse = typeof ImageResponse;
export { EdgeImageResponse, ImageResponse, ImageResponseOptions };
/// <reference types="node" /> import { ReactElement } from 'react';
import type { ReactElement } from 'react'; import { ImageResponseOptions, ImageResponseNodeOptions } from './types.js';
import type { ImageResponseNodeOptions, ImageResponseOptions, FigmaImageResponseProps } from './types';
import { Readable } from 'stream'; import { Readable } from 'stream';
export declare class ImageResponse extends Response { import "next/dist/compiled/@vercel/og/satori";
import 'http';
declare class ImageResponse extends Response {
constructor(element: ReactElement, options?: ImageResponseOptions); constructor(element: ReactElement, options?: ImageResponseOptions);
} }
/** /**
...@@ -22,6 +24,7 @@ export declare class ImageResponse extends Response { ...@@ -22,6 +24,7 @@ export declare class ImageResponse extends Response {
* } * }
* ``` * ```
*/ */
export declare function unstable_createNodejsStream(element: ReactElement, options?: Omit<ImageResponseNodeOptions, 'status' | 'statusText' | 'headers'>): Promise<Readable>; declare function unstable_createNodejsStream(element: ReactElement, options?: Omit<ImageResponseNodeOptions, 'status' | 'statusText' | 'headers'>): Promise<Readable>;
export declare const experimental_FigmaImageResponse: (props: FigmaImageResponseProps) => Promise<import("./index.edge").ImageResponse>; type NodeImageResponse = typeof ImageResponse;
export type NodeImageResponse = typeof ImageResponse;
export { ImageResponse, ImageResponseOptions, NodeImageResponse, unstable_createNodejsStream };
export declare class FontDetector {
private rangesByLang;
detect(text: string, fonts: string[]): Promise<{
[lang: string]: string;
}>;
private detectSegment;
private load;
private addDetectors;
}
export declare const languageFontMap: {
'ja-JP': string;
'ko-KR': string;
'zh-CN': string;
'zh-TW': string;
'zh-HK': string;
'th-TH': string;
'bn-IN': string;
'ar-AR': string;
'ta-IN': string;
'ml-IN': string;
'he-IL': string;
'te-IN': string;
devanagari: string;
kannada: string;
symbol: string[];
math: string;
unknown: string;
};
export default function render(satori: any, resvg: any, opts: any, defaultFonts: any, element: any): Promise<Uint8Array>;
{ {
"name": "@vercel/og", "name": "@vercel/og",
"version": "0.7.2", "version": "0.11.1",
"license": "MPL-2.0", "license": "MPL-2.0",
"type": "module", "type": "module",
"main": "./index.node.js", "main": "./index.node.js",
......
import { ReactNode } from 'react'; import { ReactNode } from 'react';
type Yoga = any;
declare const code: { declare const code: {
readonly 'ja-JP': RegExp; readonly 'ja-JP': RegExp;
...@@ -134,6 +133,10 @@ interface TwConfig { ...@@ -134,6 +133,10 @@ interface TwConfig {
}>; }>;
} }
type InitInput = string | Request | URL | Response | BufferSource | Buffer | WebAssembly.Module | Promise<Response | BufferSource | Buffer | WebAssembly.Module>;
declare function init(input: InitInput): Promise<void>;
/** /**
* This module is used to calculate the layout of the current sub-tree. * This module is used to calculate the layout of the current sub-tree.
*/ */
...@@ -149,8 +152,6 @@ interface SatoriNode { ...@@ -149,8 +152,6 @@ interface SatoriNode {
textContent?: string; textContent?: string;
} }
declare function init(yoga: Yoga): void;
type SatoriOptions = ({ type SatoriOptions = ({
width: number; width: number;
height: number; height: number;
......
/// <reference types="node" /> import { SatoriOptions } from "next/dist/compiled/@vercel/og/satori";
/// <reference types="react" /> import { OutgoingHttpHeader } from 'http';
/// <reference types="node" />
/// <reference types="node" /> declare const apis: {
import type { SatoriOptions } from "next/dist/compiled/@vercel/og/satori"; twemoji: (code: any) => string;
import type { EmojiType } from './emoji'; openmoji: string;
import type { OutgoingHttpHeader } from 'http'; blobmoji: string;
noto: string;
fluent: (code: any) => string;
fluentFlat: (code: any) => string;
};
type EmojiType = keyof typeof apis;
type ImageOptions = { type ImageOptions = {
/** /**
* The width of the image. * The width of the image.
...@@ -42,63 +48,12 @@ type ImageOptions = { ...@@ -42,63 +48,12 @@ type ImageOptions = {
*/ */
emoji?: EmojiType; emoji?: EmojiType;
}; };
export type ImageResponseNodeOptions = ImageOptions & { type ImageResponseNodeOptions = ImageOptions & {
status?: number; status?: number;
statusText?: string; statusText?: string;
headers?: OutgoingHttpHeader[]; headers?: OutgoingHttpHeader[];
}; };
export type ImageResponseOptions = ImageOptions & ConstructorParameters<typeof Response>[1]; type ImageResponseOptions = ImageOptions & ConstructorParameters<typeof Response>[1];
export interface FigmaImageResponseProps {
/**
* Link to the Figma template frame.
*
* You can get the URL in Figma by right-clicking a frame and selecting "Copy link".
* @example https://www.figma.com/file/QjGNQixWnhu300e1Xzdl2y/OG-Images?type=design&node-id=11356-2443&mode=design&t=yLROd7ro8mP1PxMY-4
*/
url: string;
/**
* A mapping between Figma layer name and the value you want to replace it with.
*
* @example Sets Figma text layer named "Title" to "How to create OG Images"
* ```js
* { "Title": "How to create OG Images" }
* ```
*
* @example Sets multiple Figma text layers and provides custom styles
* ```js
* {
* "Title": { value: "How to create OG Images", props: { color: "red", centerHorizontally: true } },
* "Description": { value: "A short story", props: { centerHorizontally: true } },
* }
* ```
*
* `centerHorizontally` centers text layer horizontally.
*/
template: Record<string, FigmaComplexTemplate | string>;
/**
* The font names must match the font names in Figma.
*/
fonts?: FontOptions[];
/**
* The same as {@link ImageResponseOptions} except `width` and `height`. `width` and `height` are automatically set from the Figma frame's size.
*/
imageResponseOptions?: Omit<ImageResponseOptions, 'width' | 'height'>;
}
export interface FigmaComplexTemplate {
value: string;
props?: {
centerHorizontally?: boolean;
} & React.CSSProperties;
}
type Weight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900;
type Style = 'normal' | 'italic';
interface FontOptions {
data: Buffer | ArrayBuffer;
name: string;
weight?: Weight;
style?: Style;
lang?: string;
}
declare module 'react' { declare module 'react' {
interface HTMLAttributes<T> { interface HTMLAttributes<T> {
/** /**
...@@ -115,4 +70,5 @@ declare module 'react' { ...@@ -115,4 +70,5 @@ declare module 'react' {
tw?: string; tw?: string;
} }
} }
export {};
export { ImageResponseNodeOptions, ImageResponseOptions };
...@@ -215,15 +215,6 @@ export async function copy_vercel_og(task, opts) { ...@@ -215,15 +215,6 @@ export async function copy_vercel_og(task, opts) {
.source( .source(
join(dirname(require.resolve('satori/package.json')), 'dist/index.d.ts') join(dirname(require.resolve('satori/package.json')), 'dist/index.d.ts')
) )
// eslint-disable-next-line require-yield
.run({ every: true }, function* (file) {
const source = file.data.toString()
// Ignore yoga-wasm-web types
file.data = source.replace(
/import { Yoga } from ['"]yoga-wasm-web['"]/g,
'type Yoga = any'
)
})
.target('src/compiled/@vercel/og/satori') .target('src/compiled/@vercel/og/satori')
await task await task
.source(join(dirname(require.resolve('satori/package.json')), 'LICENSE')) .source(join(dirname(require.resolve('satori/package.json')), 'LICENSE'))
...@@ -240,9 +231,10 @@ export async function copy_vercel_og(task, opts) { ...@@ -240,9 +231,10 @@ export async function copy_vercel_og(task, opts) {
.run({ every: true }, function* (file) { .run({ every: true }, function* (file) {
const source = file.data.toString() const source = file.data.toString()
// Refers to copied satori types // Refers to copied satori types
file.data = source file.data = source.replace(
.replace(/['"]satori['"]/g, '"next/dist/compiled/@vercel/og/satori"') /['"]satori['"]/g,
.replace("typeof import('@resvg/resvg-wasm')", 'any') '"next/dist/compiled/@vercel/og/satori"'
)
}) })
.target('src/compiled/@vercel/og') .target('src/compiled/@vercel/og')
......
...@@ -229,8 +229,8 @@ importers: ...@@ -229,8 +229,8 @@ importers:
specifier: 3.0.0 specifier: 3.0.0
version: 3.0.0 version: 3.0.0
'@vercel/og': '@vercel/og':
specifier: 0.7.2 specifier: 0.11.1
version: 0.7.2 version: 0.11.1
abort-controller: abort-controller:
specifier: 3.0.0 specifier: 3.0.0
version: 3.0.0 version: 3.0.0
...@@ -544,8 +544,8 @@ importers: ...@@ -544,8 +544,8 @@ importers:
specifier: 1.54.0 specifier: 1.54.0
version: 1.54.0 version: 1.54.0
satori: satori:
specifier: 0.15.2 specifier: 0.25.0
version: 0.15.2 version: 0.25.0
scheduler-builtin: scheduler-builtin:
specifier: npm:scheduler@0.28.0-canary-3bc2d414-20260304 specifier: npm:scheduler@0.28.0-canary-3bc2d414-20260304
version: scheduler@0.28.0-canary-3bc2d414-20260304 version: scheduler@0.28.0-canary-3bc2d414-20260304
...@@ -7122,8 +7122,8 @@ packages: ...@@ -7122,8 +7122,8 @@ packages:
engines: {node: '>=16'} engines: {node: '>=16'}
hasBin: true hasBin: true
'@vercel/og@0.7.2': '@vercel/og@0.11.1':
resolution: {integrity: sha512-yOlbztkWaDtPOrCBsV66SpIZvIwRidAe3DiAYxDOjVj2H7HaJm1PDultH9PQO8J+PeT+mFQaNNSxS9yUTo7i9A==} resolution: {integrity: sha512-02rXXRABFq1B03w3aNhcVfxkY+8Ba5QFi4ax0zS0oOiD/LL9WUd/LA7BjVPakrQmVhIBjuo2oBM5U25R9IuXMg==}
engines: {node: '>=16'} engines: {node: '>=16'}
'@vercel/routing-utils@5.2.0': '@vercel/routing-utils@5.2.0':
...@@ -8819,8 +8819,8 @@ packages: ...@@ -8819,8 +8819,8 @@ packages:
peerDependencies: peerDependencies:
postcss: ^8.0.9 postcss: ^8.0.9
css-gradient-parser@0.0.16: css-gradient-parser@0.0.17:
resolution: {integrity: sha512-3O5QdqgFRUbXvK1x5INf1YkBz1UKSWqrd63vWsum8MNHDBYD5urm3QtxZbKU259OrEXNM26lP/MPY3d1IGkBgA==} resolution: {integrity: sha512-w2Xy9UMMwlKtou0vlRnXvWglPAceXCTtcmVSo8ZBUvqCV5aXEFP/PC6d+I464810I9FT++UACwTD5511bmGPUg==}
engines: {node: '>=16'} engines: {node: '>=16'}
css-has-pseudo@3.0.4: css-has-pseudo@3.0.4:
...@@ -16576,8 +16576,8 @@ packages: ...@@ -16576,8 +16576,8 @@ packages:
engines: {node: '>=14.0.0'} engines: {node: '>=14.0.0'}
hasBin: true hasBin: true
satori@0.15.2: satori@0.25.0:
resolution: {integrity: sha512-vu/49vdc8MzV5jUchs3TIRDCOkOvMc1iJ11MrZvhg9tE4ziKIEIBjBZvies6a9sfM2vQ2gc3dXeu6rCK7AztHA==} resolution: {integrity: sha512-utINfLxrYrmSnLvxFT4ZwgwWa8KOjrz7ans32V5wItgHVmzESl/9i33nE38uG0miycab8hUqQtDlOpqrIpB/iw==}
engines: {node: '>=16'} engines: {node: '>=16'}
sax@1.2.4: sax@1.2.4:
...@@ -18873,8 +18873,8 @@ packages: ...@@ -18873,8 +18873,8 @@ packages:
resolution: {integrity: sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw==} resolution: {integrity: sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw==}
engines: {node: '>=18'} engines: {node: '>=18'}
yoga-wasm-web@0.3.3: yoga-layout@3.2.1:
resolution: {integrity: sha512-N+d4UJSJbt/R3wqY7Coqs5pcV0aUj2j9IaQ3rNj9bVCLld8tTGKRa2USARjnvZJWVx1NDmQev8EknoczaOQDOA==} resolution: {integrity: sha512-0LPOt3AxKqMdFBZA3HBAt/t/8vIKq7VaQYbuA8WxCgung+p9TVyKRYdpvCb80HcdTN2NkbIKbhNwKUfm3tQywQ==}
zod-to-json-schema@3.24.6: zod-to-json-schema@3.24.6:
resolution: {integrity: sha512-h/z3PKvcTcTetyjl1fkj79MHNEjm+HpD6NXheWjzOekY7kV+lwDYnHw+ivHkijnCSMz1yJaWBD9vu/Fcmk+vEg==} resolution: {integrity: sha512-h/z3PKvcTcTetyjl1fkj79MHNEjm+HpD6NXheWjzOekY7kV+lwDYnHw+ivHkijnCSMz1yJaWBD9vu/Fcmk+vEg==}
...@@ -24585,11 +24585,12 @@ snapshots: ...@@ -24585,11 +24585,12 @@ snapshots:
- encoding - encoding
- supports-color - supports-color
'@vercel/og@0.7.2': '@vercel/og@0.11.1':
dependencies: dependencies:
'@resvg/resvg-wasm': 2.4.0 '@resvg/resvg-wasm': 2.4.0
satori: 0.15.2 satori: 0.25.0
yoga-wasm-web: 0.3.3 optionalDependencies:
sharp: 0.34.5
'@vercel/routing-utils@5.2.0': '@vercel/routing-utils@5.2.0':
dependencies: dependencies:
...@@ -26597,7 +26598,7 @@ snapshots: ...@@ -26597,7 +26598,7 @@ snapshots:
dependencies: dependencies:
postcss: 8.4.31 postcss: 8.4.31
css-gradient-parser@0.0.16: {} css-gradient-parser@0.0.17: {}
css-has-pseudo@3.0.4(postcss@8.4.31): css-has-pseudo@3.0.4(postcss@8.4.31):
dependencies: dependencies:
...@@ -36678,19 +36679,19 @@ snapshots: ...@@ -36678,19 +36679,19 @@ snapshots:
immutable: 4.3.7 immutable: 4.3.7
source-map-js: 1.2.1 source-map-js: 1.2.1
satori@0.15.2: satori@0.25.0:
dependencies: dependencies:
'@shuding/opentype.js': 1.4.0-beta.0 '@shuding/opentype.js': 1.4.0-beta.0
css-background-parser: 0.1.0 css-background-parser: 0.1.0
css-box-shadow: 1.0.0-3 css-box-shadow: 1.0.0-3
css-gradient-parser: 0.0.16 css-gradient-parser: 0.0.17
css-to-react-native: 3.2.0 css-to-react-native: 3.2.0
emoji-regex-xs: 2.0.1 emoji-regex-xs: 2.0.1
escape-html: 1.0.3 escape-html: 1.0.3
linebreak: 1.1.0 linebreak: 1.1.0
parse-css-color: 0.2.1 parse-css-color: 0.2.1
postcss-value-parser: 4.2.0 postcss-value-parser: 4.2.0
yoga-wasm-web: 0.3.3 yoga-layout: 3.2.1
sax@1.2.4: {} sax@1.2.4: {}
...@@ -39484,7 +39485,7 @@ snapshots: ...@@ -39484,7 +39485,7 @@ snapshots:
yoctocolors-cjs@2.1.3: {} yoctocolors-cjs@2.1.3: {}
yoga-wasm-web@0.3.3: {} yoga-layout@3.2.1: {}
zod-to-json-schema@3.24.6(zod@3.25.76): zod-to-json-schema@3.24.6(zod@3.25.76):
dependencies: dependencies:
...@@ -503,7 +503,7 @@ describe('app dir - metadata dynamic routes', () => { ...@@ -503,7 +503,7 @@ describe('app dir - metadata dynamic routes', () => {
// @vercel/og default font should be traced // @vercel/og default font should be traced
const isTraced = fileTrace.files.some((filePath) => const isTraced = fileTrace.files.some((filePath) =>
filePath.includes('/noto-sans-v27-latin-regular.ttf') filePath.includes('/Geist-Regular.ttf')
) )
expect(isTraced).toBe(true) expect(isTraced).toBe(true)
}) })
......
...@@ -22,7 +22,7 @@ describe('app dir - Metadata API on the Edge runtime', () => { ...@@ -22,7 +22,7 @@ describe('app dir - Metadata API on the Edge runtime', () => {
(file) => { (file) => {
return next return next
.readFileSync(path.join('.next', file)) .readFileSync(path.join('.next', file))
.includes('experimental_FigmaImageResponse') .includes('loadAdditionalAsset')
} }
) )
expect(pageFilesThatHaveImageResponse).not.toBeEmpty() expect(pageFilesThatHaveImageResponse).not.toBeEmpty()
...@@ -39,8 +39,8 @@ describe('app dir - Metadata API on the Edge runtime', () => { ...@@ -39,8 +39,8 @@ describe('app dir - Metadata API on the Edge runtime', () => {
return ( return (
next next
.readFileSync(path.join('.next', file)) .readFileSync(path.join('.next', file))
// This export is not used but it checks if the `@vercel/og` package is shared between the two routes. // It checks if the `@vercel/og` package is shared between the two routes.
.includes('experimental_FigmaImageResponse') .includes('loadAdditionalAsset')
) )
} }
) )
......
...@@ -26,7 +26,7 @@ describe('with babel', () => { ...@@ -26,7 +26,7 @@ describe('with babel', () => {
await retry(async () => { await retry(async () => {
const middleware = await next.readFile('.next/server/middleware.js') const middleware = await next.readFile('.next/server/middleware.js')
// @vercel/og default font should be bundled // @vercel/og default font should be bundled
expect(middleware).not.toContain('noto-sans-v27-latin-regular.ttf') expect(middleware).not.toContain('Geist-Regular.ttf')
}) })
} }
) )
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment