@savvy-web/bundler 2.4.23 → 2.5.0

package/index.d.ts

@@ -1,4 +1,4 @@
-import { AmbientDtsEntry, BuildFormat, BuildPlatform, BuildReport, BuildTargetGroupsOptions, CssOptions, ExeConfig, GenerateMetaOptions, Json, JsxConfig, LooseFiles, MetaOptions, MetaResult, NextVersions, OgImageInfo, PublishTargets, RenderedOutput, RunExeBuildOptions, TargetGroupRef, TargetResolution, TsconfigJsx, TsdoctorMetaOptions, defaultManifestTransform, extractAmbientDts } from "@savvy-web/tsdown-plugins";
+import { AmbientDtsEntry, BuildFormat, BuildPlatform, BuildReport, BuildTargetGroupsOptions, CssOptions, ExeConfig, GenerateMetaOptions, Json, JsxConfig, LooseFiles, MetaOptions, MetaResult, NextVersions, OgImageGenerator, OgImageInfo, PublishTargets, RenderedOutput, RunExeBuildOptions, TargetGroupRef, TargetResolution, TsconfigJsx, TsdoctorMetaOptions, defaultManifestTransform, extractAmbientDts } from "@savvy-web/tsdown-plugins";
 import { Plugin, Plugin as Plugin$1 } from "rolldown";
 //#region src/config.d.ts
 /** @public */
@@ -290,5 +290,5 @@ export declare function runBuild(config: BuildConfig, options: RunOptions): Prom
  */
 export declare function build(input?: BuildConfigInput, overrides?: Partial<RunOptions>): Promise<void>;
 //#endregion
-export { type AmbientDtsEntry, type BuildConfig, type BuildConfigInput, type BuildEntryOverride, type OgImageInfo, type OutputConfig, type ParsedArgs, type Plugin, type RunOptions, type TsdoctorMetaOptions, defaultManifestTransform, extractAmbientDts };
+export { type AmbientDtsEntry, type BuildConfig, type BuildConfigInput, type BuildEntryOverride, type OgImageGenerator, type OgImageInfo, type OutputConfig, type ParsedArgs, type Plugin, type RunOptions, type TsdoctorMetaOptions, defaultManifestTransform, extractAmbientDts };
 //# sourceMappingURL=index.d.ts.map

package/og.d.ts

@@ -1,4 +1,4 @@
-import { OgImageInfo } from "@savvy-web/tsdown-plugins";
+import { OgImageGenerator } from "@savvy-web/tsdown-plugins";
 //#region src/og.d.ts
 /**
  * Colors for the default Open Graph card.
@@ -19,6 +19,10 @@ export interface SatoriOgOptions {
  * 1200×630 PNG, rendered through the optional peers `satori` and `@resvg/resvg-js`. The peers
  * load lazily on first render, so a build that does not generate an image never needs them.
  *
+ * The returned generator carries a `cacheSalt` (this package's version, the peers' versions and
+ * the colors), so its renders are cached across builds by default; `openGraph.cacheSalt: false`
+ * turns that off.
+ *
  * @example
  * ```ts
  * import { defineBuild } from "@savvy-web/bundler";
@@ -32,7 +36,7 @@ export interface SatoriOgOptions {
  * @public
  */
 export declare const ogImage: {
-  satori(options?: SatoriOgOptions): (info: OgImageInfo) => Promise<Uint8Array>;
+  satori(options?: SatoriOgOptions): OgImageGenerator;
 };
 //#endregion
 //# sourceMappingURL=og.d.ts.map

package/og.js

@@ -1,4 +1,5 @@
-import { existsSync } from "node:fs";
+import { createRequire } from "node:module";
+import { existsSync, readFileSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import { fileURLToPath } from "node:url";
 
@@ -16,6 +17,15 @@ function fontPath() {
 	}
 	throw new Error("ogImage.satori() could not locate its bundled font assets/Inter-SemiBold.ttf");
 }
+/** The installed version of an optional renderer peer, or `"absent"` (rendering then fails, and nothing is cached). */
+function peerVersion(name) {
+	try {
+		const manifest = createRequire(import.meta.url).resolve(`${name}/package.json`);
+		return JSON.parse(readFileSync(manifest, "utf-8")).version ?? "unknown";
+	} catch {
+		return "absent";
+	}
+}
 async function loadRenderers() {
 	try {
 		const [{ default: satori }, { Resvg }] = await Promise.all([import("satori"), import("@resvg/resvg-js")]);
@@ -87,6 +97,10 @@ function card(info, colors) {
 * 1200×630 PNG, rendered through the optional peers `satori` and `@resvg/resvg-js`. The peers
 * load lazily on first render, so a build that does not generate an image never needs them.
 *
+* The returned generator carries a `cacheSalt` (this package's version, the peers' versions and
+* the colors), so its renders are cached across builds by default; `openGraph.cacheSalt: false`
+* turns that off.
+*
 * @example
 * ```ts
 * import { defineBuild } from "@savvy-web/bundler";
@@ -105,7 +119,14 @@ const ogImage = { satori(options = {}) {
 		background: options.background ?? "#0f172a",
 		foreground: options.foreground ?? "#f8fafc"
 	};
-	return async (info) => {
+	const cacheSalt = JSON.stringify({
+		renderer: "@savvy-web/bundler/og#satori",
+		version: "2.5.0",
+		satori: peerVersion("satori"),
+		resvg: peerVersion("@resvg/resvg-js"),
+		colors
+	});
+	const render = async (info) => {
 		const { satori, Resvg } = await loadRenderers();
 		const font = await readFile(fontPath());
 		const svg = await satori(card(info, colors), {
@@ -123,6 +144,7 @@ const ogImage = { satori(options = {}) {
 			value: 1200
 		} }).render().asPng());
 	};
+	return Object.assign(render, { cacheSalt });
 } };
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/bundler",
-	"version": "2.4.23",
+	"version": "2.5.0",
 	"private": false,
 	"description": "Zero-config tsdown-based bundler for Silk Suite TypeScript packages",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/bundler",
@@ -37,7 +37,7 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@savvy-web/tsdown-plugins": "2.8.21",
+		"@savvy-web/tsdown-plugins": "2.9.0",
 		"@tsdown/exe": "^0.23.0",
 		"effect": "^4.0.2",
 		"rolldown": "^1.2.12",