satori-cf 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,169 @@
+import type { Font } from "satori";
+/**
+ * Emoji provider types
+ */
+export type EmojiType = "twemoji" | "openmoji" | "blobmoji" | "noto" | "fluent" | "fluentFlat";
+/**
+ * Options for generating OG images
+ */
+export interface OGOptions {
+    /**
+     * The width of the image.
+     * @default 1200
+     */
+    width?: number;
+    /**
+     * The height of the image.
+     * @default 630
+     */
+    height?: number;
+    /**
+     * Array of fonts to use for rendering.
+     * If not provided, a default font will be loaded.
+     */
+    fonts?: Font[];
+    /**
+     * Emoji provider to use for rendering emojis.
+     */
+    emoji?: EmojiType;
+    /**
+     * Enable debug mode (disables caching).
+     */
+    debug?: boolean;
+}
+/**
+ * Success result type
+ */
+export interface OGSuccess<T> {
+    ok: true;
+    value: T;
+}
+/**
+ * Error result type
+ */
+export interface OGError {
+    ok: false;
+    error: Error;
+}
+/**
+ * Discriminated union for results
+ */
+export type OGResult<T> = OGSuccess<T> | OGError;
+/**
+ * Item for batch processing
+ */
+export interface BatchItem {
+    /**
+     * The React element or HTML string to render
+     */
+    element: React.ReactNode | string;
+    /**
+     * Optional per-item options (merged with batch defaults)
+     */
+    options?: Partial<OGOptions>;
+}
+/**
+ * Result for a single batch item
+ */
+export interface BatchResult {
+    /**
+     * Index of the item in the original batch
+     */
+    index: number;
+    /**
+     * The result of the generation
+     */
+    result: OGResult<string>;
+}
+/**
+ * Options for batch processing
+ */
+export interface BatchOptions extends OGOptions {
+    /**
+     * Maximum number of concurrent generations.
+     * @default 5
+     */
+    concurrency?: number;
+    /**
+     * Stop processing on first error.
+     * @default false
+     */
+    failFast?: boolean;
+}
+/**
+ * Item for stream processing
+ */
+export interface StreamItem {
+    /**
+     * The React element or HTML string to render
+     */
+    element: React.ReactNode | string;
+    /**
+     * Optional per-item options
+     */
+    options?: Partial<OGOptions>;
+}
+/**
+ * Result yielded by the stream
+ */
+export interface StreamResult {
+    /**
+     * Index of the item
+     */
+    index: number;
+    /**
+     * The result of the generation
+     */
+    result: OGResult<string>;
+}
+/**
+ * Options for stream processing
+ */
+export interface StreamOptions extends OGOptions {
+    /**
+     * Number of items to prefetch ahead.
+     * @default 3
+     */
+    prefetch?: number;
+}
+/**
+ * Options for Google Font loading
+ */
+export interface GoogleFontOptions {
+    /**
+     * Font family name
+     */
+    family: string;
+    /**
+     * Font weight
+     */
+    weight?: number;
+    /**
+     * Specific text to subset the font for
+     */
+    text?: string;
+}
+/**
+ * Options for creating SVG response
+ */
+export interface SVGResponseOptions {
+    /**
+     * Custom headers to add to the response
+     */
+    headers?: HeadersInit;
+    /**
+     * HTTP status code
+     * @default 200
+     */
+    status?: number;
+    /**
+     * HTTP status text
+     */
+    statusText?: string;
+    /**
+     * Disable caching (sets no-cache headers)
+     * @default false
+     */
+    debug?: boolean;
+}
+//# 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,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,YAAY,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,EAAE,EAAE,IAAI,CAAC;IACT,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,KAAK,CAAC;IACV,KAAK,EAAE,KAAK,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB"}

package/dist/utils/response.d.ts

@@ -0,0 +1,18 @@
+import type { SVGResponseOptions } from "../types";
+/**
+ * Creates a Response object with appropriate headers for SVG content.
+ *
+ * @param svg - The SVG string to return
+ * @param options - Response options
+ * @returns A Response object with the SVG content
+ *
+ * @example
+ * ```ts
+ * const result = await generateOG(element);
+ * if (result.ok) {
+ *   return createSVGResponse(result.value);
+ * }
+ * ```
+ */
+export declare function createSVGResponse(svg: string, options?: SVGResponseOptions): Response;
+//# sourceMappingURL=response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/utils/response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,kBAAuB,GAC/B,QAAQ,CAcV"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "satori-cf",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "SVG-only, batch-optimized Open Graph image generation for Cloudflare Workers",
+  "author": "Pavle Dzuverovic",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PavleDz/satori-cf"
+  },
+  "keywords": [
+    "satori",
+    "cloudflare",
+    "workers",
+    "og",
+    "open-graph",
+    "svg",
+    "image-generation",
+    "social-cards"
+  ],
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "node bin/build.js",
+    "ts": "tsc --noEmit"
+  },
+  "dependencies": {
+    "just-camel-case": "^6.2.0",
+    "satori": "^0.15.2",
+    "yoga-wasm-web": "0.3.3"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20250610.0",
+    "@types/node": "^20.19.0",
+    "@types/react": "^19.0.0",
+    "esbuild": "^0.19.12",
+    "esbuild-plugin-d.ts": "^1.3.1",
+    "typescript": "^5.8.3"
+  }
+}