@soonit/rspress-plugin-og 0.0.2 → 0.1.0

package/dist/index.d.mts

@@ -1,13 +1,7 @@
-import { t as Options } from "./types-ChngGzQc.mjs";
-import * as _rspress_core0 from "@rspress/core";
-import { PageIndexInfo } from "@rspress/core";
+import { t as Options } from "./types-7FdncbbI.mjs";
+import { RspressPlugin } from "@rspress/core";
 
 //#region src/index.d.ts
-declare function export_default(userOptions: Options): {
-  name: string;
-  config(config: _rspress_core0.UserConfig): _rspress_core0.UserConfig;
-  extendPageData: (pageData: PageIndexInfo) => void;
-  afterBuild(config: _rspress_core0.UserConfig): Promise<void>;
-};
+declare function export_default(userOptions: Options): RspressPlugin;
 //#endregion
 export { export_default as default };

package/dist/index.mjs

@@ -1,7 +1,9 @@
 import { dirname, join, relative } from "node:path";
+import { performance } from "node:perf_hooks";
 import node_process, { cwd } from "node:process";
 import { Buffer } from "node:buffer";
 import { existsSync, mkdirSync, readFileSync } from "node:fs";
+import { Resvg } from "@resvg/resvg-js";
 import sharp from "sharp";
 import node_os from "node:os";
 import node_tty from "node:tty";
@@ -48,79 +50,45 @@ function createOgImageTypeHead() {
 //#endregion
 //#region ../core/src/og.ts
 const templates = /* @__PURE__ */ new Map();
+const baseImages = /* @__PURE__ */ new Map();
 function escapeHtml(unsafe) {
 	return unsafe.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
 }
-/**
-* Wrap a title string into at most three lines with a best-effort “do not break words” strategy.
-*
-* The input is first split by explicit newlines into paragraphs (empty lines are ignored). Then each
-* paragraph is wrapped into lines whose length does not exceed {@link maxSizePerLine} when possible:
-*
-* - If the paragraph contains whitespace, it is tokenized by whitespace and tokens are joined with a
-*   single space.
-* - If the paragraph contains no whitespace (e.g. CJK text), it is tokenized by individual characters.
-* - If a single token is longer than the line limit, it is hard-split into fixed-size chunks.
-*
-* Wrapping stops once three lines have been produced in total.
-*
-* @param input - The title text to wrap. `null`/`undefined`/empty (after trimming) results in `[]`.
-* @param maxSizePerLine - Maximum allowed character count per line. Values `<= 0` are treated as `1`.
-* @returns An array of wrapped lines, with a maximum length of 3.
-*/
-function wrapTitleToLines(input, maxSizePerLine) {
-	const text = (input ?? "").trim();
-	if (!text) return [];
-	const max = Math.max(1, maxSizePerLine || 1);
-	const paragraphs = text.split(/\r?\n+/).map((s) => s.trim()).filter(Boolean);
-	const out = [];
-	for (const para of paragraphs) {
-		if (out.length >= 3) break;
-		const tokens = /\s/.test(para) ? para.split(/\s+/).filter(Boolean) : [...para];
-		let line = "";
-		for (const token of tokens) {
-			if (out.length >= 3) break;
-			const next = line ? /\s/.test(para) ? `${line} ${token}` : `${line}${token}` : token;
-			if (next.length <= max) {
-				line = next;
-				continue;
-			}
-			if (line) {
-				out.push(line);
-				line = "";
-				if (out.length >= 3) break;
-			}
-			if (token.length > max) {
-				const chunks = token.match(new RegExp(`.{1,${max}}`, "g")) ?? [];
-				for (const chunk of chunks) {
-					if (out.length >= 3) break;
-					if (chunk.length === max) out.push(chunk);
-					else line = chunk;
-				}
-			} else line = token;
-		}
-		if (out.length >= 3) break;
-		if (line) out.push(line);
-	}
-	return out.slice(0, 3);
-}
 async function generateOgImage({ title }, output, options) {
 	if (existsSync(output)) return;
 	if (!templates.has(options.ogTemplate)) templates.set(options.ogTemplate, readFileSync(options.ogTemplate, "utf-8"));
 	const ogTemplate = templates.get(options.ogTemplate);
-	mkdirSync(dirname(output), { recursive: true });
-	const lines = wrapTitleToLines(title, options.maxTitleSizePerLine);
-	if (lines.length === 0) {
-		console.warn("[vitepress-plugin-og] Missing page title, skip og image generation.");
-		return;
+	if (!baseImages.has(options.ogTemplate)) {
+		const baseSvg = ogTemplate.replace(/\{\{[^}]+\}\}/g, "").replace(/<text[^>]*>[\s\S]*?<\/text>/g, "");
+		const baseImageBuffer = await sharp(Buffer.from(baseSvg)).resize(1200, 630).png().toBuffer();
+		baseImages.set(options.ogTemplate, baseImageBuffer);
 	}
-	const data = {
+	mkdirSync(dirname(output), { recursive: true });
+	const lines = title.trim().split(new RegExp(`(.{0,${options.maxTitleSizePerLine}})(?:\\s|$)`, "g")).filter(Boolean);
+	const textLayerBuffer = new Resvg(createTextLayerSvg(ogTemplate, {
 		line1: lines[0] ? escapeHtml(lines[0]) : "",
 		line2: lines[1] ? escapeHtml(lines[1]) : "",
 		line3: lines[2] ? escapeHtml(lines[2]) : ""
-	};
-	const svg = ogTemplate.replace(/\{\{([^}]+)\}\}/g, (_, name) => data[name] || "");
-	await sharp(Buffer.from(svg), options.sharpOptions).resize(1200, 630).png().toFile(output);
+	}), {
+		fitTo: {
+			mode: "width",
+			value: 1200
+		},
+		font: { loadSystemFonts: false },
+		shapeRendering: 0,
+		textRendering: 2,
+		imageRendering: 1,
+		dpi: 96,
+		...options.resvgOptions
+	}).render().asPng();
+	await sharp(baseImages.get(options.ogTemplate)).composite([{
+		input: textLayerBuffer,
+		blend: "over"
+	}]).png().toFile(output);
+}
+function createTextLayerSvg(template, data) {
+	const processedText = (template.match(/<text[^>]*>[\s\S]*?<\/text>/g) || []).map((element) => element.replace(/\{\{([^}]+)\}\}/g, (_, name) => data[name] || ""));
+	return `${template.match(/<svg[^>]*>/)?.[0] || "<svg>"}${processedText.join("")}</svg>`;
 }
 
 //#endregion
@@ -377,15 +345,16 @@ let src_logger = createLogger();
 
 //#endregion
 //#region src/options.ts
-function resolveOptions(userOptions) {
-	return {
+async function resolveOptions(userOptions) {
+	const options = {
 		domain: "",
 		outDir: "og",
 		ogTemplate: "og-template.svg",
 		maxTitleSizePerLine: 30,
-		sharpOptions: {},
 		...userOptions
 	};
+	if (typeof options.resvgOptions === "function") options.resvgOptions = await options.resvgOptions();
+	return options;
 }
 
 //#endregion
@@ -393,7 +362,7 @@ function resolveOptions(userOptions) {
 const NAME = "rspress-plugin-og";
 const LOG_PREFIX = `[${NAME}]`;
 function src_default(userOptions) {
-	const options = resolveOptions(userOptions);
+	let options;
 	const images = /* @__PURE__ */ new Map();
 	const headCreators = [
 		(url) => createTwitterImageHead(url),
@@ -405,7 +374,8 @@ function src_default(userOptions) {
 	];
 	return {
 		name: NAME,
-		config(config) {
+		async config(config) {
+			options = await resolveOptions(userOptions);
 			config.head = [...config.head || [], ...headCreators.map((creator) => (route) => {
 				const imageInfo = images.get(route.routePath);
 				if (!imageInfo) return;
@@ -428,10 +398,12 @@ function src_default(userOptions) {
 		async afterBuild(config) {
 			const outputFolder = join(cwd(), config.outDir ?? "doc_build", options.outDir);
 			src_logger.info(`${LOG_PREFIX} Generating OG images to ${relative(cwd(), outputFolder)} ...`);
+			const start = performance.now();
 			await Promise.all(Array.from(images.entries()).map(([_, { title, imageName }]) => {
 				return generateOgImage({ title }, join(outputFolder, imageName), options);
 			}));
-			src_logger.success(`${LOG_PREFIX} ${images.size} OG images generated.`);
+			const duration = (performance.now() - start) / 1e3;
+			src_logger.success(`${LOG_PREFIX} ${images.size} OG images generated in ${duration.toFixed(2)}s.`);
 		}
 	};
 }

package/dist/types-7FdncbbI.d.mts

@@ -0,0 +1,94 @@
+import { Buffer } from "node:buffer";
+
+//#region ../core/src/types.d.ts
+
+/**
+ * resvg render options
+ * @see https://github.com/yisibl/resvg-js
+ */
+interface ResvgRenderOptions {
+  /**
+   * Custom font data
+   */
+  font?: {
+    fontBuffers?: Buffer[];
+    loadSystemFonts?: boolean;
+    defaultFontFamily?: string;
+    defaultFontSize?: number;
+    serifFamily?: string;
+    sansSerifFamily?: string;
+    cursiveFamily?: string;
+    fantasyFamily?: string;
+    monospaceFamily?: string;
+  };
+  /**
+   * DPI for rendering
+   * @default 96
+   */
+  dpi?: number;
+  /**
+   * Shape rendering mode
+   */
+  shapeRendering?: 0 | 1 | 2;
+  /**
+   * Text rendering mode
+   */
+  textRendering?: 0 | 1 | 2;
+  /**
+   * Image rendering mode
+   */
+  imageRendering?: 0 | 1;
+  /**
+   * Fit to dimensions
+   */
+  fitTo?: {
+    mode: 'original' | 'width' | 'height' | 'zoom';
+    value?: number;
+  };
+  /**
+   * Background color
+   */
+  background?: string;
+  /**
+   * Log level for resvg
+   */
+  logLevel?: 'off' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
+}
+interface Options {
+  /**
+   * The domain to use for the generated OG image URLs.
+   */
+  domain: string;
+  /**
+   * Output directory for the generated OG images.
+   *
+   * @default 'og'
+   */
+  outDir?: string;
+  /**
+   * Maximum number of characters per line in the title.
+   *
+   * @default 30
+   */
+  maxTitleSizePerLine?: number;
+  /**
+   * The path to the OG image template file.
+   *
+   * @default '.vitepress/og-template.svg' for VitePress
+   * @default 'og-template.svg' for Rspress
+   */
+  ogTemplate?: string;
+  /**
+   * Options for resvg rendering
+   */
+  resvgOptions?: ResvgRenderOptions | (() => Promise<ResvgRenderOptions> | ResvgRenderOptions);
+}
+interface ResolvedOptions extends Required<Omit<Options, 'resvgOptions'>> {
+  resvgOptions?: ResvgRenderOptions;
+}
+//#endregion
+//#region src/types.d.ts
+interface Options$1 extends Options {}
+interface ResolvedOptions$1 extends ResolvedOptions {}
+//#endregion
+export { ResolvedOptions$1 as n, Options$1 as t };

package/dist/types.d.mts

@@ -1,2 +1,2 @@
-import { n as ResolvedOptions, t as Options } from "./types-ChngGzQc.mjs";
+import { n as ResolvedOptions, t as Options } from "./types-7FdncbbI.mjs";
 export { Options, ResolvedOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@soonit/rspress-plugin-og",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Automatically generate Open Graph images for your Rspress pages.",
   "author": "Estéban Soubiran <esteban@soubiran.dev>",
   "license": "MIT",
@@ -11,9 +11,6 @@
     "type": "git",
     "url": "https://github.com/Barbapapazes/vitepress-plugin-og"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "bugs": "https://github.com/Barbapapazes/vitepress-plugin-og/issues",
   "exports": {
     ".": {
@@ -38,6 +35,7 @@
     "@rspress/core": "^2.0.0-rc.1 || ^2.0.0"
   },
   "dependencies": {
+    "@resvg/resvg-js": "^2.6.2",
     "sharp": "^0.34.5",
     "ufo": "^1.6.1"
   },

package/dist/types-ChngGzQc.d.mts

@@ -1,41 +0,0 @@
-import sharp from "sharp";
-
-//#region ../core/src/types.d.ts
-interface Options {
-  /**
-   * The domain to use for the generated OG image URLs.
-   */
-  domain: string;
-  /**
-   * Output directory for the generated OG images.
-   *
-   * @default 'og'
-   */
-  outDir?: string;
-  /**
-   * Maximum number of characters per line in the title.
-   *
-   * @default 30
-   */
-  maxTitleSizePerLine?: number;
-  /**
-   * The path to the OG image template file.
-   *
-   * @default '.vitepress/og-template.svg' for VitePress
-   * @default 'og-template.svg' for Rspress
-   */
-  ogTemplate?: string;
-  /**
-   * Options to pass to the `sharp` image processing library.
-   *
-   * @default {}
-   */
-  sharpOptions?: sharp.SharpOptions;
-}
-interface ResolvedOptions extends Required<Options> {}
-//#endregion
-//#region src/types.d.ts
-interface Options$1 extends Options {}
-interface ResolvedOptions$1 extends ResolvedOptions {}
-//#endregion
-export { ResolvedOptions$1 as n, Options$1 as t };