satori-cf 0.0.1

package/README.md

@@ -0,0 +1,37 @@
+# satori-cf
+
+> SVG-only, batch-optimized Open Graph image generation for Cloudflare Workers
+
+See the [main README](../../README.md) for full documentation.
+
+## Installation
+
+```bash
+npm install satori-cf
+```
+
+## Quick Start
+
+```typescript
+import { generateOG, createSVGResponse } from "satori-cf";
+
+export default {
+  async fetch(request: Request): Promise<Response> {
+    const result = await generateOG(
+      `<div style="display: flex; align-items: center; justify-content: center; width: 100%; height: 100%; background: #667eea; color: white; font-size: 60px;">
+        Hello World
+      </div>`
+    );
+
+    if (result.ok) {
+      return createSVGResponse(result.value);
+    }
+
+    return new Response(result.error.message, { status: 500 });
+  },
+};
+```
+
+## License
+
+MIT

package/dist/assets/emoji.d.ts

@@ -0,0 +1,15 @@
+import type { EmojiType } from "../types";
+import type { Font } from "satori";
+type AssetLoaderResult = string | Font[];
+/**
+ * Creates a dynamic asset loader for emojis.
+ * Returns a function compatible with Satori's loadAdditionalAsset option.
+ *
+ * @param options - Options including the emoji provider to use
+ * @returns Asset loader function
+ */
+export declare const loadDynamicAsset: ({ emoji }: {
+    emoji: EmojiType;
+}) => (languageCode: string, segment: string) => Promise<AssetLoaderResult>;
+export {};
+//# sourceMappingURL=emoji.d.ts.map

package/dist/assets/emoji.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emoji.d.ts","sourceRoot":"","sources":["../../src/assets/emoji.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,KAAK,iBAAiB,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC;AA2DzC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,MAe5D,cAAc,MAAM,EACpB,SAAS,MAAM,KACd,OAAO,CAAC,iBAAiB,CAW7B,CAAC"}

package/dist/assets/font.d.ts

@@ -0,0 +1,10 @@
+import type { GoogleFontOptions } from "../types";
+/**
+ * Loads a font from Google Fonts API.
+ * Uses Cloudflare's cache API for efficient caching.
+ *
+ * @param options - Font loading options
+ * @returns ArrayBuffer containing the font data
+ */
+export declare function loadGoogleFont({ family, weight, text, }: GoogleFontOptions): Promise<ArrayBuffer>;
+//# sourceMappingURL=font.d.ts.map

package/dist/assets/font.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"font.d.ts","sourceRoot":"","sources":["../../src/assets/font.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EACN,MAAM,EACN,IAAI,GACL,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CA6C1C"}

package/dist/core/yoga.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Ensures Yoga WASM is initialized exactly once.
+ * Uses promise coalescing to prevent concurrent initialization race conditions.
+ *
+ * @returns Promise that resolves when Yoga is ready
+ */
+export declare function ensureYogaInitialized(): Promise<void>;
+/**
+ * Check if Yoga has been initialized
+ */
+export declare function isInitialized(): boolean;
+//# sourceMappingURL=yoga.d.ts.map

package/dist/core/yoga.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yoga.d.ts","sourceRoot":"","sources":["../../src/core/yoga.ts"],"names":[],"mappings":"AAmBA;;;;;GAKG;AACH,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CA+B3D;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC"}

package/dist/errors.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Base error class for satori-cf errors
+ */
+export declare class SatoriCFError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when WASM initialization fails
+ */
+export declare class WASMInitError extends SatoriCFError {
+    constructor(message: string);
+}
+/**
+ * Error thrown when font loading fails
+ */
+export declare class FontLoadError extends SatoriCFError {
+    constructor(message: string);
+}
+/**
+ * Error thrown when HTML parsing fails
+ */
+export declare class HTMLParseError extends SatoriCFError {
+    constructor(message: string);
+}
+/**
+ * Error thrown when SVG generation fails
+ */
+export declare class SVGGenerationError extends SatoriCFError {
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;gBAClC,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;gBAClC,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,aAAa;gBACnC,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;gBACvC,OAAO,EAAE,MAAM;CAI5B"}

package/dist/generators/batch.d.ts

@@ -0,0 +1,26 @@
+import type { BatchItem, BatchOptions, BatchResult } from "../types";
+/**
+ * Generates multiple OG images as SVG with amortized WASM initialization.
+ * The WASM module is initialized once at the start, and fonts are pre-loaded
+ * for the entire batch.
+ *
+ * @param items - Array of items to generate
+ * @param options - Batch generation options
+ * @returns Array of results with preserved indices
+ *
+ * @example
+ * ```ts
+ * const results = await generateOGBatch([
+ *   { element: <Card title="One" /> },
+ *   { element: <Card title="Two" /> },
+ * ], { concurrency: 5 });
+ *
+ * for (const { index, result } of results) {
+ *   if (result.ok) {
+ *     console.log(`Item ${index}: ${result.value.length} bytes`);
+ *   }
+ * }
+ * ```
+ */
+export declare function generateOGBatch(items: BatchItem[], options?: BatchOptions): Promise<BatchResult[]>;
+//# sourceMappingURL=batch.d.ts.map

package/dist/generators/batch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../src/generators/batch.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGrE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,WAAW,EAAE,CAAC,CAyFxB"}

package/dist/generators/single.d.ts

@@ -0,0 +1,23 @@
+import type { OGOptions, OGResult } from "../types";
+/**
+ * Generates a single OG image as SVG.
+ *
+ * @param element - React element or HTML string to render
+ * @param options - Generation options
+ * @returns Result containing the SVG string or an error
+ *
+ * @example
+ * ```ts
+ * const result = await generateOG(<Card title="Hello" />);
+ * if (result.ok) {
+ *   console.log(result.value); // "<svg..."
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * const result = await generateOG('<div style="color: red">Hello</div>');
+ * ```
+ */
+export declare function generateOG(element: React.ReactNode | string, options?: OGOptions): Promise<OGResult<string>>;
+//# sourceMappingURL=single.d.ts.map

package/dist/generators/single.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"single.d.ts","sourceRoot":"","sources":["../../src/generators/single.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,UAAU,CAC9B,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,EACjC,OAAO,GAAE,SAAc,GACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAoD3B"}

package/dist/generators/stream.d.ts

@@ -0,0 +1,21 @@
+import type { StreamItem, StreamOptions, StreamResult } from "../types";
+/**
+ * Generates OG images as an async generator for streaming large batches.
+ * Uses a prefetch pipeline for optimal throughput while maintaining
+ * memory efficiency.
+ *
+ * @param items - Iterable or AsyncIterable of items to generate
+ * @param options - Stream generation options
+ * @yields Results in order as they complete
+ *
+ * @example
+ * ```ts
+ * for await (const { index, result } of OGStream(items, { prefetch: 3 })) {
+ *   if (result.ok) {
+ *     console.log(`Generated ${index}: ${result.value.length} bytes`);
+ *   }
+ * }
+ * ```
+ */
+export declare function OGStream(items: Iterable<StreamItem> | AsyncIterable<StreamItem>, options?: StreamOptions): AsyncGenerator<StreamResult, void, unknown>;
+//# sourceMappingURL=stream.d.ts.map

package/dist/generators/stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/generators/stream.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAuB,QAAQ,CAC7B,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,EACvD,OAAO,GAAE,aAAkB,GAC1B,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,CA4F7C"}

package/dist/html/parser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Parses HTML into a ReactElementLike object
+ * using Cloudflare Worker's own HTMLRewriter.
+ *
+ * This approach leverages the HTMLRewriter API which is part of
+ * Cloudflare Worker's runtime, making it the fastest way to
+ * transform HTML in this environment.
+ *
+ * @param html - HTML string to parse
+ * @returns Promise resolving to a React-like node or null on error
+ */
+export declare function parseHtml(html: string): Promise<React.ReactNode | null>;
+//# sourceMappingURL=parser.d.ts.map

package/dist/html/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/html/parser.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,CA6C7E"}

package/dist/html/utils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Sanitizes a string for use in JSON
+ */
+export declare const sanitizeJSON: (unsanitized: string) => string;
+/**
+ * Extracts and formats attributes from an HTML element for JSON VDOM
+ */
+export declare const getAttributes: (element: Element) => string;
+/**
+ * Removes trailing comma from a string if present
+ */
+export declare const maybeRemoveTrailingComma: (str: string) => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/html/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/html/utils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,aAAa,MAAM,KAAG,MAQlD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,OAAO,KAAG,MAgDhD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,KAAK,MAAM,KAAG,MAKtD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export { generateOG } from "./generators/single";
+export { generateOGBatch } from "./generators/batch";
+export { OGStream } from "./generators/stream";
+export { loadGoogleFont } from "./assets/font";
+export { loadDynamicAsset } from "./assets/emoji";
+export { parseHtml } from "./html/parser";
+export { createSVGResponse } from "./utils/response";
+export { ensureYogaInitialized, isInitialized } from "./core/yoga";
+export type { OGOptions, OGResult, OGSuccess, OGError, BatchItem, BatchResult, BatchOptions, StreamItem, StreamResult, StreamOptions, GoogleFontOptions, SVGResponseOptions, EmojiType, } from "./types";
+export { SatoriCFError, WASMInitError, FontLoadError, HTMLParseError, SVGGenerationError, } from "./errors";
+//# 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":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG/C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGnE,YAAY,EACV,SAAS,EACT,QAAQ,EACR,SAAS,EACT,OAAO,EACP,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,GACV,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,cAAc,EACd,kBAAkB,GACnB,MAAM,UAAU,CAAC"}