@soonit/rspress-plugin-og 0.0.1 → 0.0.5

package/dist/index.d.mts

@@ -1,13 +1,7 @@
-import { t as Options } from "./types-d5VtTQ1o.mjs";
-import * as _rspress_core0 from "@rspress/core";
-import { PageIndexInfo } from "@rspress/core";
+import { t as Options } from "./types-R_GC9oNb.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,8 +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 sharp from "sharp";
+import { writeFile } from "node:fs/promises";
+import { Resvg } from "@resvg/resvg-js";
 import node_os from "node:os";
 import node_tty from "node:tty";
 import { joinURL } from "ufo";
@@ -51,19 +52,81 @@ const templates = /* @__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 = title.trim().split(new RegExp(`(.{0,${options.maxTitleSizePerLine}})(?:\\s|$)`, "g")).filter(Boolean);
+	const lines = wrapTitleToLines(title, options.maxTitleSizePerLine);
+	if (lines.length === 0) {
+		console.warn("[vitepress-plugin-og] Missing page title, skip og image generation.");
+		return;
+	}
 	const data = {
 		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)).resize(1200, 630).png().toFile(output);
+	await writeFile(output, new Resvg(ogTemplate.replace(/\{\{([^}]+)\}\}/g, (_, name) => data[name] || ""), {
+		fitTo: {
+			mode: "width",
+			value: 1200
+		},
+		...options.resvgOptions
+	}).render().asPng());
 }
 
 //#endregion
@@ -320,14 +383,17 @@ 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,
+		resvgOptions: void 0,
 		...userOptions
 	};
+	if (typeof options.resvgOptions === "function") options.resvgOptions = await options.resvgOptions();
+	return options;
 }
 
 //#endregion
@@ -335,7 +401,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),
@@ -347,7 +413,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;
@@ -370,10 +437,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-d5VtTQ1o.d.mts → types-R_GC9oNb.d.mts}

@@ -1,3 +1,5 @@
+import { ResvgRenderOptions } from "@resvg/resvg-js";
+
 //#region ../core/src/types.d.ts
 interface Options {
   /**
@@ -23,8 +25,14 @@ interface Options {
    * @default 'og-template.svg' for Rspress
    */
   ogTemplate?: string;
+  /**
+   * Options for resvg rendering
+   */
+  resvgOptions?: ResvgRenderOptions | (() => Promise<ResvgRenderOptions>);
+}
+interface ResolvedOptions extends Required<Omit<Options, 'resvgOptions'>> {
+  resvgOptions?: ResvgRenderOptions;
 }
-interface ResolvedOptions extends Required<Options> {}
 //#endregion
 //#region src/types.d.ts
 interface Options$1 extends Options {}

package/dist/types.d.mts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@soonit/rspress-plugin-og",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "Automatically generate Open Graph images for your Rspress pages.",
   "author": "Estéban Soubiran <esteban@soubiran.dev>",
   "license": "MIT",
@@ -12,10 +12,6 @@
     "url": "https://github.com/Barbapapazes/vitepress-plugin-og"
   },
   "bugs": "https://github.com/Barbapapazes/vitepress-plugin-og/issues",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
   "exports": {
     ".": {
       "types": "./dist/index.d.mts",
@@ -39,7 +35,7 @@
     "@rspress/core": "^2.0.0-rc.1 || ^2.0.0"
   },
   "dependencies": {
-    "sharp": "^0.34.5",
+    "@resvg/resvg-js": "^2.6.2",
     "ufo": "^1.6.1"
   },
   "devDependencies": {