astro-og-images 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Francesco Di Donato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,134 @@
+# astro-og-images
+
+Generate static Open Graph images during Astro builds from code-owned templates.
+
+It renders a Satori template to SVG, rasterizes it with Resvg, and writes the final PNG into your Astro `dist` folder. In dev, queued images are served by Astro middleware.
+
+## Install
+
+```sh
+pnpm add astro-og-images
+```
+
+`sharp` is optional and installed by default through `optionalDependencies`. It is used only to compress PNG output. If your target environment cannot install native packages, set `compression: false`.
+
+## Astro Config
+
+```js
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import { astroOgImages } from "astro-og-images";
+
+export default defineConfig({
+  integrations: [
+    astroOgImages({
+      outputDir: "og",
+      compression: true,
+    }),
+  ],
+});
+```
+
+## Generate An Image
+
+```tsx
+// src/og/card.tsx
+export function Card({ title }: { title: string }) {
+  return (
+    <div
+      style={{
+        width: "100%",
+        height: "100%",
+        display: "flex",
+        alignItems: "center",
+        padding: 80,
+        background: "#101014",
+        color: "white",
+        fontFamily: "Inter",
+        fontSize: 72,
+        fontWeight: 700,
+      }}
+    >
+      {title}
+    </div>
+  );
+}
+```
+
+```astro
+---
+import { getOgImage } from "astro-og-images";
+import { Card } from "../og/card";
+
+const image = await getOgImage({
+  template: Card,
+  props: { title: "Hello OG" },
+  path: "hello",
+  fonts: [
+    {
+      name: "Inter",
+      path: "./public/fonts/Inter-Bold.ttf",
+      weight: 700,
+    },
+  ],
+});
+---
+
+<meta property="og:image" content={new URL(image.src, Astro.site)} />
+```
+
+The default output is `/og/hello.png` at `1200x630`.
+
+## Compression
+
+Compression is enabled by default and uses `sharp` to keep social images small.
+
+```js
+astroOgImages({
+  compression: {
+    png: {
+      compressionLevel: 9,
+      palette: false,
+    },
+  },
+});
+```
+
+Disable it when native dependencies are not available:
+
+```js
+astroOgImages({
+  compression: false,
+});
+```
+
+## Image Component
+
+For inline previews, import the Astro component:
+
+```astro
+---
+import OgImage from "astro-og-images/component";
+import { Card } from "../og/card";
+---
+
+<OgImage
+  template={Card}
+  props={{ title: "Hello OG" }}
+  path="hello"
+  fonts={[{ name: "Inter", path: "./public/fonts/Inter-Bold.ttf", weight: 700 }]}
+  alt=""
+/>
+```
+
+## Caveats
+
+- Only PNG output is supported.
+- At least one local font is required.
+- Templates must use styles supported by Satori.
+- Each output path must map to one unique template and props set during build.
+- Compression requires `sharp`; install it or set `compression: false`.
+
+## License
+
+MIT

package/dist/compression.d.ts

@@ -0,0 +1,4 @@
+import type { NormalizedOgImageCompressionOptions, OgImageCompression } from "./types.js";
+export declare function normalizeCompression(compression: OgImageCompression | NormalizedOgImageCompressionOptions | undefined): false | NormalizedOgImageCompressionOptions;
+export declare function compressPng(buffer: Buffer, compression: false | NormalizedOgImageCompressionOptions): Promise<Buffer>;
+//# sourceMappingURL=compression.d.ts.map

package/dist/compression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compression.d.ts","sourceRoot":"","sources":["../src/compression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,kBAAkB,GAAG,mCAAmC,GAAG,SAAS,GAChF,KAAK,GAAG,mCAAmC,CAoB7C;AAED,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,KAAK,GAAG,mCAAmC,GACvD,OAAO,CAAC,MAAM,CAAC,CAwBjB"}

package/dist/compression.js

@@ -0,0 +1,41 @@
+export function normalizeCompression(compression) {
+    if (compression === false)
+        return false;
+    if (compression === true || compression === undefined) {
+        return {
+            png: {
+                compressionLevel: 9,
+                palette: false,
+            },
+        };
+    }
+    return {
+        png: {
+            compressionLevel: compression.png?.compressionLevel ?? 9,
+            palette: compression.png?.palette ?? false,
+            quality: compression.png?.quality,
+            effort: compression.png?.effort,
+        },
+    };
+}
+export async function compressPng(buffer, compression) {
+    if (!compression)
+        return buffer;
+    let sharp;
+    try {
+        const sharpModule = (await import("sharp"));
+        sharp = sharpModule.default ?? sharpModule;
+    }
+    catch {
+        throw new Error("astro-og-images compression requires sharp. Install sharp or set compression: false.");
+    }
+    return sharp(buffer)
+        .png({
+        compressionLevel: compression.png.compressionLevel,
+        palette: compression.png.palette,
+        quality: compression.png.quality,
+        effort: compression.png.effort,
+    })
+        .toBuffer();
+}
+//# sourceMappingURL=compression.js.map

package/dist/compression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compression.js","sourceRoot":"","sources":["../src/compression.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,oBAAoB,CAClC,WAAiF;IAEjF,IAAI,WAAW,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IAExC,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO;YACL,GAAG,EAAE;gBACH,gBAAgB,EAAE,CAAC;gBACnB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,EAAE;YACH,gBAAgB,EAAE,WAAW,CAAC,GAAG,EAAE,gBAAgB,IAAI,CAAC;YACxD,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO,IAAI,KAAK;YAC1C,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO;YACjC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM;SAChC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAc,EACd,WAAwD;IAExD,IAAI,CAAC,WAAW;QAAE,OAAO,MAAM,CAAC;IAGhC,IAAI,KAAmB,CAAC;IACxB,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAEzC,CAAC;QACF,KAAK,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,CAAC;SACjB,GAAG,CAAC;QACH,gBAAgB,EAAE,WAAW,CAAC,GAAG,CAAC,gBAAgB;QAClD,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,OAAO;QAChC,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,OAAO;QAChC,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM;KAC/B,CAAC;SACD,QAAQ,EAAE,CAAC;AAChB,CAAC"}

package/dist/hash.d.ts

@@ -0,0 +1,3 @@
+export declare function sha256(input: string | Buffer): string;
+export declare function stableStringify(value: unknown): string;
+//# sourceMappingURL=hash.d.ts.map

package/dist/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../src/hash.ts"],"names":[],"mappings":"AAEA,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEtD"}

package/dist/hash.js

@@ -0,0 +1,28 @@
+import { createHash } from "node:crypto";
+export function sha256(input) {
+    return createHash("sha256").update(input).digest("hex");
+}
+export function stableStringify(value) {
+    return JSON.stringify(normalizeValue(value));
+}
+function normalizeValue(value) {
+    if (value instanceof Date) {
+        return value.toISOString();
+    }
+    if (typeof value === "function") {
+        return value.toString();
+    }
+    if (typeof value === "bigint") {
+        return value.toString();
+    }
+    if (Array.isArray(value)) {
+        return value.map(normalizeValue);
+    }
+    if (value && typeof value === "object") {
+        return Object.fromEntries(Object.entries(value)
+            .sort(([a], [b]) => a.localeCompare(b))
+            .map(([key, nestedValue]) => [key, normalizeValue(nestedValue)]));
+    }
+    return value;
+}
+//# sourceMappingURL=hash.js.map

package/dist/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../src/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,UAAU,MAAM,CAAC,KAAsB;IAC3C,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;aAClB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aACtC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CACnE,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { astroOgImages } from "./integration.js";
+export { getOgImage } from "./registry.js";
+export type { GetOgImageOptions, OgImageCompression, OgImageCompressionOptions, OgImageFont, OgImageFontStyle, OgImageFontWeight, OgImageFormat, OgImageIntegrationOptions, OgImagePngCompressionOptions, OgImageResult, OgImageSize, OgImageTemplate, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,YAAY,EACV,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,4BAA4B,EAC5B,aAAa,EACb,WAAW,EACX,eAAe,GAChB,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { astroOgImages } from "./integration.js";
+export { getOgImage } from "./registry.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC"}

package/dist/integration.d.ts

@@ -0,0 +1,27 @@
+import type { OgImageIntegrationOptions } from "./types.js";
+type AstroLogger = {
+    info(message: string): void;
+    error(message: string): void;
+};
+type AstroIntegration = {
+    name: string;
+    hooks: {
+        "astro:config:setup": (args: {
+            config: {
+                root: URL;
+            };
+            command: "dev" | "build" | "preview" | "sync";
+        }) => void;
+        "astro:server:setup": (args: {
+            server: any;
+            logger: AstroLogger;
+        }) => void;
+        "astro:build:done": (args: {
+            dir: URL;
+            logger: AstroLogger;
+        }) => Promise<void>;
+    };
+};
+export declare function astroOgImages(options?: OgImageIntegrationOptions): AstroIntegration;
+export {};
+//# sourceMappingURL=integration.d.ts.map

package/dist/integration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.d.ts","sourceRoot":"","sources":["../src/integration.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAE5D,KAAK,WAAW,GAAG;IACjB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,oBAAoB,EAAE,CAAC,IAAI,EAAE;YAC3B,MAAM,EAAE;gBAAE,IAAI,EAAE,GAAG,CAAA;aAAE,CAAC;YACtB,OAAO,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;SAC/C,KAAK,IAAI,CAAC;QACX,oBAAoB,EAAE,CAAC,IAAI,EAAE;YAAE,MAAM,EAAE,GAAG,CAAC;YAAC,MAAM,EAAE,WAAW,CAAA;SAAE,KAAK,IAAI,CAAC;QAC3E,kBAAkB,EAAE,CAAC,IAAI,EAAE;YAAE,GAAG,EAAE,GAAG,CAAC;YAAC,MAAM,EAAE,WAAW,CAAA;SAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KAChF,CAAC;CACH,CAAC;AAEF,wBAAgB,aAAa,CAC3B,OAAO,GAAE,yBAA8B,GACtC,gBAAgB,CAgDlB"}

package/dist/integration.js

@@ -0,0 +1,52 @@
+import { fileURLToPath } from "node:url";
+import { configureOgImages, flushQueuedOgImagesToDir, getQueuedOgImageCount, isQueuedOgImagePath, renderQueuedOgImage, } from "./registry.js";
+export function astroOgImages(options = {}) {
+    return {
+        name: "astro-og-images",
+        hooks: {
+            "astro:config:setup": ({ config, command }) => {
+                configureOgImages({
+                    rootDir: fileURLToPath(config.root),
+                    outputDir: options.outputDir ?? "og",
+                    cacheDir: options.cacheDir ?? ".astro/og-images",
+                    cache: options.cache ?? true,
+                    compression: options.compression,
+                    command,
+                });
+            },
+            "astro:server:setup": ({ server, logger }) => {
+                server.middlewares.use(async (request, response, next) => {
+                    if (!request.url)
+                        return next();
+                    const pathname = new URL(request.url, "http://localhost").pathname;
+                    if (!isQueuedOgImagePath(pathname))
+                        return next();
+                    try {
+                        const buffer = await renderQueuedOgImage(pathname);
+                        if (!buffer)
+                            return next();
+                        response.statusCode = 200;
+                        response.setHeader("Content-Type", "image/png");
+                        response.setHeader("Cache-Control", "no-cache");
+                        response.end(buffer);
+                    }
+                    catch (error) {
+                        logger.error(error instanceof Error ? error.message : String(error));
+                        response.statusCode = 500;
+                        response.end("Failed to render OG image.");
+                    }
+                });
+            },
+            "astro:build:done": async ({ dir, logger }) => {
+                const queued = getQueuedOgImageCount();
+                if (queued === 0) {
+                    logger.info("No OG images queued.");
+                    return;
+                }
+                const written = await flushQueuedOgImagesToDir(dir);
+                logger.info(`Generated ${written} OG image${written === 1 ? "" : "s"}.`);
+            },
+        },
+    };
+}
+//# sourceMappingURL=integration.js.map

package/dist/integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.js","sourceRoot":"","sources":["../src/integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,eAAe,CAAC;AAoBvB,MAAM,UAAU,aAAa,CAC3B,UAAqC,EAAE;IAEvC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE;YACL,oBAAoB,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE;gBAC5C,iBAAiB,CAAC;oBAChB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC;oBACnC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI;oBACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,kBAAkB;oBAChD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;oBAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;YACD,oBAAoB,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC3C,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,OAAY,EAAE,QAAa,EAAE,IAAgB,EAAE,EAAE;oBAC7E,IAAI,CAAC,OAAO,CAAC,GAAG;wBAAE,OAAO,IAAI,EAAE,CAAC;oBAEhC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC,QAAQ,CAAC;oBACnE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC;wBAAE,OAAO,IAAI,EAAE,CAAC;oBAElD,IAAI,CAAC;wBACH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,QAAQ,CAAC,CAAC;wBACnD,IAAI,CAAC,MAAM;4BAAE,OAAO,IAAI,EAAE,CAAC;wBAE3B,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;wBAC1B,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;wBAChD,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;wBAChD,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBACvB,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,MAAM,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;wBACrE,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;wBAC1B,QAAQ,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;oBAC7C,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YACD,kBAAkB,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC5C,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAC;gBACvC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;oBACjB,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;oBACpC,OAAO;gBACT,CAAC;gBAED,MAAM,OAAO,GAAG,MAAM,wBAAwB,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,IAAI,CAAC,aAAa,OAAO,YAAY,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YAC3E,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/paths.d.ts

@@ -0,0 +1,5 @@
+export declare function cleanOutputDir(outputDir: string): string;
+export declare function ensureFormatExtension(path: string, format: string): string;
+export declare function normalizePublicPath(inputPath: string, outputDir: string, format: string): string;
+export declare function resolveFromRoot(pathOrUrl: string | URL, rootDir: string): string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAGA,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGxD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACb,MAAM,CAQR;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAMhF"}

package/dist/paths.js

@@ -0,0 +1,24 @@
+import { isAbsolute, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+export function cleanOutputDir(outputDir) {
+    const cleaned = outputDir.replace(/^\/+|\/+$/g, "");
+    return cleaned || "og";
+}
+export function ensureFormatExtension(path, format) {
+    return /\.[a-z0-9]+$/i.test(path) ? path : `${path}.${format}`;
+}
+export function normalizePublicPath(inputPath, outputDir, format) {
+    const cleanedOutputDir = cleanOutputDir(outputDir);
+    const withoutLeadingSlash = inputPath.replace(/^\/+/, "");
+    const withOutputDir = withoutLeadingSlash.startsWith(`${cleanedOutputDir}/`)
+        ? withoutLeadingSlash
+        : `${cleanedOutputDir}/${withoutLeadingSlash}`;
+    return `/${ensureFormatExtension(withOutputDir, format)}`;
+}
+export function resolveFromRoot(pathOrUrl, rootDir) {
+    if (pathOrUrl instanceof URL) {
+        return fileURLToPath(pathOrUrl);
+    }
+    return isAbsolute(pathOrUrl) ? pathOrUrl : resolve(rootDir, pathOrUrl);
+}
+//# sourceMappingURL=paths.js.map

package/dist/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,cAAc,CAAC,SAAiB;IAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACpD,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAY,EAAE,MAAc;IAChE,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,SAAiB,EACjB,SAAiB,EACjB,MAAc;IAEd,MAAM,gBAAgB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,mBAAmB,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC1D,MAAM,aAAa,GAAG,mBAAmB,CAAC,UAAU,CAAC,GAAG,gBAAgB,GAAG,CAAC;QAC1E,CAAC,CAAC,mBAAmB;QACrB,CAAC,CAAC,GAAG,gBAAgB,IAAI,mBAAmB,EAAE,CAAC;IAEjD,OAAO,IAAI,qBAAqB,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,SAAuB,EAAE,OAAe;IACtE,IAAI,SAAS,YAAY,GAAG,EAAE,CAAC;QAC7B,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACzE,CAAC"}

package/dist/registry.d.ts

@@ -0,0 +1,17 @@
+import type { GetOgImageOptions, NormalizedOgImageCompressionOptions, OgImageIntegrationOptions, OgImageResult } from "./types.js";
+interface OgImageRuntime {
+    rootDir: string;
+    outputDir: string;
+    cacheDir: string;
+    cache: boolean;
+    command: "dev" | "build" | "preview" | "sync";
+    compression: false | NormalizedOgImageCompressionOptions;
+}
+export declare function configureOgImages(options: OgImageIntegrationOptions & Partial<Pick<OgImageRuntime, "rootDir" | "command">>): void;
+export declare function getOgImage<Props>(options: GetOgImageOptions<Props>): Promise<OgImageResult>;
+export declare function getQueuedOgImageCount(): number;
+export declare function isQueuedOgImagePath(pathname: string): boolean;
+export declare function renderQueuedOgImage(pathname: string): Promise<Buffer | null>;
+export declare function flushQueuedOgImagesToDir(outputDirUrl: URL): Promise<number>;
+export {};
+//# sourceMappingURL=registry.d.ts.map

package/dist/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACV,iBAAiB,EACjB,mCAAmC,EAEnC,yBAAyB,EAEzB,aAAa,EAEd,MAAM,YAAY,CAAC;AAEpB,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9C,WAAW,EAAE,KAAK,GAAG,mCAAmC,CAAC;CAC1D;AA4BD,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,yBAAyB,GAChC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,SAAS,CAAC,CAAC,GACrD,IAAI,CAcN;AAED,wBAAsB,UAAU,CAAC,KAAK,EACpC,OAAO,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAChC,OAAO,CAAC,aAAa,CAAC,CA0DxB;AAED,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAKlF;AAED,wBAAsB,wBAAwB,CAAC,YAAY,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAajF"}

package/dist/registry.js

@@ -0,0 +1,160 @@
+import { constants } from "node:fs";
+import { access, mkdir, readFile, stat, writeFile, } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { normalizeCompression } from "./compression.js";
+import { sha256, stableStringify } from "./hash.js";
+import { cleanOutputDir, normalizePublicPath, resolveFromRoot } from "./paths.js";
+import { renderOgImageJob } from "./renderer.js";
+const DEFAULT_SIZE = {
+    width: 1200,
+    height: 630,
+};
+const STORE_KEY = Symbol.for("astro-og-images.store");
+const store = (globalThis[STORE_KEY] ??= {
+    runtime: {
+        rootDir: process.cwd(),
+        outputDir: "og",
+        cacheDir: join(process.cwd(), ".astro", "og-images"),
+        cache: true,
+        command: "build",
+        compression: normalizeCompression(undefined),
+    },
+    jobs: new Map(),
+});
+export function configureOgImages(options) {
+    const rootDir = options.rootDir ?? store.runtime.rootDir;
+    const outputDir = cleanOutputDir(options.outputDir ?? store.runtime.outputDir);
+    store.runtime = {
+        rootDir,
+        outputDir,
+        cacheDir: options.cacheDir
+            ? resolveFromRoot(options.cacheDir, rootDir)
+            : join(rootDir, ".astro", "og-images"),
+        cache: options.cache ?? store.runtime.cache,
+        command: options.command ?? store.runtime.command,
+        compression: normalizeCompression(options.compression ?? store.runtime.compression),
+    };
+}
+export async function getOgImage(options) {
+    const format = options.format ?? "png";
+    const size = {
+        width: options.size?.width ?? DEFAULT_SIZE.width,
+        height: options.size?.height ?? DEFAULT_SIZE.height,
+    };
+    const publicPath = normalizePublicPath(options.path, store.runtime.outputDir, format);
+    const signature = stableStringify({
+        template: options.template,
+        props: options.props,
+        size,
+        fonts: options.fonts,
+        format,
+        debug: options.debug ?? false,
+    });
+    const existing = store.jobs.get(publicPath);
+    const job = {
+        publicPath,
+        template: options.template,
+        props: options.props,
+        size,
+        fonts: options.fonts,
+        format,
+        debug: options.debug ?? false,
+        signature,
+    };
+    if (existing && existing.signature !== signature) {
+        if (store.runtime.command === "dev") {
+            store.jobs.set(publicPath, job);
+            return {
+                src: publicPath,
+                width: size.width,
+                height: size.height,
+                format,
+            };
+        }
+        throw new Error(`Conflicting OG image jobs registered for ${publicPath}. Use a unique path per image.`);
+    }
+    if (!existing) {
+        store.jobs.set(publicPath, job);
+    }
+    return {
+        src: publicPath,
+        width: size.width,
+        height: size.height,
+        format,
+    };
+}
+export function getQueuedOgImageCount() {
+    return store.jobs.size;
+}
+export function isQueuedOgImagePath(pathname) {
+    return store.jobs.has(pathname);
+}
+export async function renderQueuedOgImage(pathname) {
+    const job = store.jobs.get(pathname);
+    if (!job)
+        return null;
+    return renderWithCache(job);
+}
+export async function flushQueuedOgImagesToDir(outputDirUrl) {
+    const outputRoot = fileURLToPath(outputDirUrl);
+    let written = 0;
+    for (const job of store.jobs.values()) {
+        const buffer = await renderWithCache(job);
+        const destination = join(outputRoot, job.publicPath.replace(/^\/+/, ""));
+        await mkdir(dirname(destination), { recursive: true });
+        await writeFile(destination, buffer);
+        written += 1;
+    }
+    return written;
+}
+async function renderWithCache(job) {
+    const hash = await computeJobHash(job);
+    const cacheFile = join(store.runtime.cacheDir, `${hash}.${job.format}`);
+    if (store.runtime.cache && (await exists(cacheFile))) {
+        return readFile(cacheFile);
+    }
+    const buffer = await renderOgImageJob(job, store.runtime.rootDir, store.runtime.compression);
+    if (store.runtime.cache) {
+        await mkdir(store.runtime.cacheDir, { recursive: true });
+        await writeFile(cacheFile, buffer);
+    }
+    return buffer;
+}
+async function computeJobHash(job) {
+    const fontHashes = await Promise.all(job.fonts.map(async (font) => {
+        const fontPath = resolveFromRoot(font.path, store.runtime.rootDir);
+        const [contents, metadata] = await Promise.all([
+            readFile(fontPath),
+            stat(fontPath),
+        ]);
+        return {
+            name: font.name,
+            path: fontPath,
+            weight: font.weight,
+            style: font.style,
+            lang: font.lang,
+            size: metadata.size,
+            hash: sha256(contents),
+        };
+    }));
+    return sha256(stableStringify({
+        template: job.template,
+        props: job.props,
+        size: job.size,
+        fonts: fontHashes,
+        format: job.format,
+        debug: job.debug,
+        compression: store.runtime.compression,
+    }));
+}
+async function exists(path) {
+    try {
+        await access(path, constants.F_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=registry.js.map

package/dist/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,MAAM,EACN,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAoBjD,MAAM,YAAY,GAAgB;IAChC,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,GAAG;CACZ,CAAC;AAOF,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;AAEtD,MAAM,KAAK,GAAG,CAAE,UAAsD,CACpE,SAAS,CACV,KAAK;IACJ,OAAO,EAAE;QACP,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;QACtB,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC;QACpD,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,OAAO;QAChB,WAAW,EAAE,oBAAoB,CAAC,SAAS,CAAC;KAC7C;IACD,IAAI,EAAE,IAAI,GAAG,EAA2B;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,OACsD;IAEtD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;IACzD,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E,KAAK,CAAC,OAAO,GAAG;QACd,OAAO;QACP,SAAS;QACT,QAAQ,EAAE,OAAO,CAAC,QAAQ;YACxB,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC;YAC5C,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC;QACxC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK;QAC3C,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO;QACjD,WAAW,EAAE,oBAAoB,CAAC,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;KACpF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,OAAiC;IAEjC,MAAM,MAAM,GAAkB,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC;IACtD,MAAM,IAAI,GAAgB;QACxB,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,IAAI,YAAY,CAAC,KAAK;QAChD,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,YAAY,CAAC,MAAM;KACpD,CAAC;IACF,MAAM,UAAU,GAAG,mBAAmB,CACpC,OAAO,CAAC,IAAI,EACZ,KAAK,CAAC,OAAO,CAAC,SAAS,EACvB,MAAM,CACP,CAAC;IACF,MAAM,SAAS,GAAG,eAAe,CAAC;QAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM;QACN,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;KAC9B,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAsB;QAC7B,UAAU;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM;QACN,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;QAC7B,SAAS;KACV,CAAC;IAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACjD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YAChC,OAAO;gBACL,GAAG,EAAE,UAAU;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM;aACP,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CACb,4CAA4C,UAAU,gCAAgC,CACvF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,OAAO;QACL,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB;IACnC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,QAAgB;IACxD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IAEtB,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,YAAiB;IAC9D,MAAM,UAAU,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC/C,IAAI,OAAO,GAAG,CAAC,CAAC;IAEhB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC;IACf,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAe;IAC5C,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAExE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,GAAG,EACH,KAAK,CAAC,OAAO,CAAC,OAAO,EACrB,KAAK,CAAC,OAAO,CAAC,WAAW,CAC1B,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,GAAe;IAC3C,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnE,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC7C,QAAQ,CAAC,QAAQ,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC;SACf,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC;SACvB,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CACX,eAAe,CAAC;QACd,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW;KACvC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/renderer.d.ts

@@ -0,0 +1,3 @@
+import type { NormalizedOgImageCompressionOptions, OgImageJob } from "./types.js";
+export declare function renderOgImageJob(job: OgImageJob, rootDir: string, compression: false | NormalizedOgImageCompressionOptions): Promise<Buffer>;
+//# sourceMappingURL=renderer.d.ts.map

package/dist/renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,mCAAmC,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIlF,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,KAAK,GAAG,mCAAmC,GACvD,OAAO,CAAC,MAAM,CAAC,CAyCjB"}

package/dist/renderer.js

@@ -0,0 +1,42 @@
+import { readFile } from "node:fs/promises";
+import { createRequire } from "node:module";
+import satori from "satori";
+import { compressPng } from "./compression.js";
+import { resolveFromRoot } from "./paths.js";
+const require = createRequire(import.meta.url);
+export async function renderOgImageJob(job, rootDir, compression) {
+    if (job.format !== "png") {
+        throw new Error(`Unsupported OG image format: ${job.format}`);
+    }
+    if (job.fonts.length === 0) {
+        throw new Error("At least one local font is required to render an OG image.");
+    }
+    const fontFiles = job.fonts.map((font) => resolveFromRoot(font.path, rootDir));
+    const fonts = await Promise.all(job.fonts.map(async (font, index) => ({
+        name: font.name,
+        data: await readFile(fontFiles[index]),
+        weight: font.weight,
+        style: font.style,
+        lang: font.lang,
+    })));
+    const element = await job.template(job.props);
+    const satoriOptions = {
+        width: job.size.width,
+        height: job.size.height,
+        fonts,
+        debug: job.debug,
+    };
+    const svg = await satori(element, satoriOptions);
+    const { Resvg } = require("@resvg/resvg-js");
+    const renderer = new Resvg(svg, {
+        fitTo: { mode: "original" },
+        font: {
+            loadSystemFonts: false,
+            fontFiles,
+            defaultFontFamily: job.fonts[0]?.name,
+        },
+        logLevel: "warn",
+    });
+    return compressPng(renderer.render().asPng(), compression);
+}
+//# sourceMappingURL=renderer.js.map

package/dist/renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAG7C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,GAAe,EACf,OAAe,EACf,WAAwD;IAExD,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAW,MAAM,OAAO,CAAC,GAAG,CACrC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,MAAM,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,IAAI,EAAE,IAAI,CAAC,IAAI;KAChB,CAAC,CAAC,CACJ,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,aAAa,GAAkB;QACnC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK;QACrB,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM;QACvB,KAAK;QACL,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB,CAAC;IAEF,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAuC,EAAE,aAAa,CAAC,CAAC;IACjF,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAqC,CAAC;IACjF,MAAM,QAAQ,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE;QAC9B,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;QAC3B,IAAI,EAAE;YACJ,eAAe,EAAE,KAAK;YACtB,SAAS;YACT,iBAAiB,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI;SACtC;QACD,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;AAC7D,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,65 @@
+export type OgImageFormat = "png";
+export type OgImageFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900;
+export type OgImageFontStyle = "normal" | "italic";
+export interface OgImageSize {
+    width: number;
+    height: number;
+}
+export interface OgImageFont {
+    name: string;
+    path: string | URL;
+    weight?: OgImageFontWeight;
+    style?: OgImageFontStyle;
+    lang?: string;
+}
+export type OgImageTemplate<Props> = (props: Props) => unknown | Promise<unknown>;
+export interface GetOgImageOptions<Props = Record<string, unknown>> {
+    template: OgImageTemplate<Props>;
+    props: Props;
+    path: string;
+    size?: Partial<OgImageSize>;
+    fonts: OgImageFont[];
+    format?: OgImageFormat;
+    debug?: boolean;
+}
+export interface OgImageResult {
+    src: string;
+    width: number;
+    height: number;
+    format: OgImageFormat;
+}
+export interface OgImagePngCompressionOptions {
+    compressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    palette?: boolean;
+    quality?: number;
+    effort?: number;
+}
+export interface OgImageCompressionOptions {
+    png?: OgImagePngCompressionOptions;
+}
+export type OgImageCompression = boolean | OgImageCompressionOptions;
+export interface OgImageIntegrationOptions {
+    outputDir?: string;
+    cacheDir?: string;
+    cache?: boolean;
+    compression?: OgImageCompression;
+}
+export interface OgImageJob<Props = unknown> {
+    publicPath: string;
+    template: OgImageTemplate<Props>;
+    props: Props;
+    size: OgImageSize;
+    fonts: OgImageFont[];
+    format: OgImageFormat;
+    debug: boolean;
+    signature: string;
+}
+export interface NormalizedOgImageCompressionOptions {
+    png: {
+        compressionLevel: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+        palette: boolean;
+        quality?: number;
+        effort?: number;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,iBAAiB,GACzB,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;AAER,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEnD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAElF,MAAM,WAAW,iBAAiB,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChE,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,GAAG,CAAC,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,yBAAyB,CAAC;AAErE,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,WAAW,UAAU,CAAC,KAAK,GAAG,OAAO;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,GAAG,EAAE;QACH,gBAAgB,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/examples/basic/card.tsx

@@ -0,0 +1,20 @@
+export function Card({ title }: { title: string }) {
+  return (
+    <div
+      style={{
+        width: "100%",
+        height: "100%",
+        display: "flex",
+        alignItems: "center",
+        padding: 80,
+        background: "#101014",
+        color: "white",
+        fontFamily: "Inter",
+        fontSize: 72,
+        fontWeight: 700,
+      }}
+    >
+      {title}
+    </div>
+  );
+}

package/examples/basic/usage.astro

@@ -0,0 +1,13 @@
+---
+import { getOgImage } from "astro-og-images";
+import { Card } from "./card";
+
+const image = await getOgImage({
+  template: Card,
+  props: { title: "Hello OG" },
+  path: "hello",
+  fonts: [{ name: "Inter", path: "./public/fonts/Inter-Bold.ttf", weight: 700 }],
+});
+---
+
+<meta property="og:image" content={new URL(image.src, Astro.site)} />

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "astro-og-images",
+  "version": "0.1.0",
+  "description": "Generate static Open Graph images from code-owned templates during Astro builds.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Francesco Di Donato",
+  "homepage": "https://github.com/didof/astro-og-images#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/didof/astro-og-images.git"
+  },
+  "bugs": {
+    "url": "https://github.com/didof/astro-og-images/issues"
+  },
+  "keywords": [
+    "astro",
+    "open-graph",
+    "og-image",
+    "social-image",
+    "satori",
+    "resvg"
+  ],
+  "engines": {
+    "node": ">=18.17"
+  },
+  "files": [
+    "dist",
+    "src/OgImage.astro",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./component": "./src/OgImage.astro",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@resvg/resvg-js": "^2.6.2",
+    "satori": "^0.26.0"
+  },
+  "optionalDependencies": {
+    "sharp": "^0.34.2"
+  },
+  "peerDependencies": {
+    "astro": ">=4.0.0 <6.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "25.6.0",
+    "@types/react": "^19.2.14",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}

package/src/OgImage.astro

@@ -0,0 +1,30 @@
+---
+import { getOgImage, type GetOgImageOptions } from "astro-og-images";
+
+interface Props extends GetOgImageOptions<Record<string, unknown>> {
+  alt?: string;
+  class?: string;
+  loading?: "eager" | "lazy";
+  decoding?: "async" | "auto" | "sync";
+}
+
+const {
+  alt = "",
+  class: className,
+  loading = "lazy",
+  decoding = "async",
+  ...options
+} = Astro.props;
+
+const image = await getOgImage(options);
+---
+
+<img
+  src={image.src}
+  width={image.width}
+  height={image.height}
+  alt={alt}
+  class={className}
+  loading={loading}
+  decoding={decoding}
+/>