@effing/fn 0.26.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2026, Few Software BV.
+
+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/dist/index.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+import { EffieSources, EffieData, EffieWebUrl } from '@effing/effie';
+import { AnnieStreamOptions } from '@effing/annie';
+
+type Bounds = Readonly<{
+    width: number;
+    height: number;
+}>;
+type RunnerArgs<P> = {
+    props: P;
+    bounds: Bounds;
+};
+type FnKind = "image" | "annie" | "effie";
+type BaseFnModule = {
+    propsSchema: z.ZodSchema<unknown>;
+    previewProps: object;
+};
+type ImageRunnerReturn = Promise<Buffer>;
+type AnnieRunnerReturn = AsyncIterable<Buffer>;
+type EffieRunnerReturn<S extends EffieSources = EffieSources> = Promise<EffieData<S>>;
+type ImageFnModule = BaseFnModule & {
+    runner: (args: RunnerArgs<unknown>) => ImageRunnerReturn;
+};
+type AnnieFnModule = BaseFnModule & {
+    runner: (args: RunnerArgs<unknown>) => AnnieRunnerReturn;
+};
+type EffieFnModule = BaseFnModule & {
+    runner: (args: RunnerArgs<unknown>) => EffieRunnerReturn;
+};
+type FnModule<K extends FnKind> = K extends "image" ? ImageFnModule : K extends "annie" ? AnnieFnModule : EffieFnModule;
+type FnModuleLoader = {
+    loadModule<K extends FnKind>(kind: K, id: string): Promise<FnModule<K>>;
+    listModules(kind: FnKind): string[];
+    hasModule(kind: FnKind, id: string): boolean;
+};
+type FnUrlBuilder = {
+    buildUrl<P extends Record<string, unknown>>(kind: FnKind, id: string, props: P, bounds: Bounds): Promise<EffieWebUrl>;
+};
+
+declare function initFnRuntime(config: {
+    moduleLoader: FnModuleLoader;
+    urlBuilder: FnUrlBuilder;
+}): void;
+declare function fnModule<K extends FnKind>(kind: K, id: string): Promise<FnModule<K>>;
+declare function fnUrl<P extends Record<string, unknown>>(kind: FnKind, id: string, props: P, bounds: Bounds): Promise<EffieWebUrl>;
+declare function fnModuleIds(kind: FnKind): string[];
+declare function fnModuleExists(kind: FnKind, id: string): boolean;
+
+type ImageResponseOptions = {
+    headers?: HeadersInit;
+    cacheControl?: string;
+};
+declare function imageResponse(bytes: Uint8Array, options?: ImageResponseOptions): Response;
+type AnnieResponseOptions = AnnieStreamOptions & {
+    headers?: HeadersInit;
+    cacheControl?: string;
+    filename?: string;
+};
+declare function annieResponse(frames: AsyncIterable<Buffer>, options?: AnnieResponseOptions): Response;
+type EffieResponseOptions = {
+    headers?: HeadersInit;
+    cacheControl?: string;
+};
+declare function effieResponse<S extends EffieSources>(data: EffieData<S>, options?: EffieResponseOptions): Response;
+
+export { type AnnieFnModule, type AnnieResponseOptions, type AnnieRunnerReturn, type Bounds, type EffieFnModule, type EffieResponseOptions, type EffieRunnerReturn, type FnKind, type FnModule, type FnModuleLoader, type FnUrlBuilder, type ImageFnModule, type ImageResponseOptions, type ImageRunnerReturn, type RunnerArgs, annieResponse, effieResponse, fnModule, fnModuleExists, fnModuleIds, fnUrl, imageResponse, initFnRuntime };

package/dist/index.js

@@ -0,0 +1,92 @@
+// src/runtime.ts
+var moduleLoader = null;
+var urlBuilder = null;
+function initFnRuntime(config) {
+  moduleLoader = config.moduleLoader;
+  urlBuilder = config.urlBuilder;
+}
+function getModuleLoader() {
+  if (!moduleLoader) {
+    throw new Error(
+      "attempting to access module loader before initFnRuntime() was called"
+    );
+  }
+  return moduleLoader;
+}
+function getUrlBuilder() {
+  if (!urlBuilder) {
+    throw new Error(
+      "attempting to access URL builder before initFnRuntime() was called"
+    );
+  }
+  return urlBuilder;
+}
+function fnModule(kind, id) {
+  return getModuleLoader().loadModule(kind, id);
+}
+function fnUrl(kind, id, props, bounds) {
+  return getUrlBuilder().buildUrl(kind, id, props, bounds);
+}
+function fnModuleIds(kind) {
+  return getModuleLoader().listModules(kind);
+}
+function fnModuleExists(kind, id) {
+  return getModuleLoader().hasModule(kind, id);
+}
+
+// src/responses.ts
+import { annieStream } from "@effing/annie";
+function detectImageContentType(bytes) {
+  if (bytes[0] === 137 && bytes[1] === 80) return "image/png";
+  if (bytes[0] === 255 && bytes[1] === 216) return "image/jpeg";
+  throw new Error("Unsupported image format: expected PNG or JPEG");
+}
+function imageResponse(bytes, options = {}) {
+  const { headers: extraHeaders, cacheControl = "public, max-age=3600" } = options;
+  const headers = new Headers(extraHeaders);
+  headers.set("Content-Type", detectImageContentType(bytes));
+  if (cacheControl) {
+    headers.set("Cache-Control", cacheControl);
+  }
+  if (!(bytes.buffer instanceof ArrayBuffer)) {
+    throw new TypeError("SharedArrayBuffer is not supported");
+  }
+  return new Response(bytes.buffer, { status: 200, headers });
+}
+function annieResponse(frames, options = {}) {
+  const {
+    headers: extraHeaders,
+    cacheControl = "public, max-age=3600",
+    filename,
+    ...streamOptions
+  } = options;
+  const stream = annieStream(frames, streamOptions);
+  const headers = new Headers(extraHeaders);
+  headers.set("Content-Type", "application/x-tar");
+  if (cacheControl) {
+    headers.set("Cache-Control", cacheControl);
+  }
+  if (filename) {
+    headers.set("Content-Disposition", `inline; filename="${filename}.tar"`);
+  }
+  return new Response(stream, { status: 200, headers });
+}
+function effieResponse(data, options = {}) {
+  const { headers: extraHeaders, cacheControl = "public, max-age=3600" } = options;
+  const headers = new Headers(extraHeaders);
+  if (cacheControl) {
+    headers.set("Cache-Control", cacheControl);
+  }
+  return Response.json(data, { status: 200, headers });
+}
+export {
+  annieResponse,
+  effieResponse,
+  fnModule,
+  fnModuleExists,
+  fnModuleIds,
+  fnUrl,
+  imageResponse,
+  initFnRuntime
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/runtime.ts","../src/responses.ts"],"sourcesContent":["import type { EffieWebUrl } from \"@effing/effie\";\nimport type {\n  Bounds,\n  FnKind,\n  FnModule,\n  FnModuleLoader,\n  FnUrlBuilder,\n} from \"./types\";\n\nlet moduleLoader: FnModuleLoader | null = null;\nlet urlBuilder: FnUrlBuilder | null = null;\n\nexport function initFnRuntime(config: {\n  moduleLoader: FnModuleLoader;\n  urlBuilder: FnUrlBuilder;\n}): void {\n  moduleLoader = config.moduleLoader;\n  urlBuilder = config.urlBuilder;\n}\n\nfunction getModuleLoader(): FnModuleLoader {\n  if (!moduleLoader) {\n    throw new Error(\n      \"attempting to access module loader before initFnRuntime() was called\",\n    );\n  }\n  return moduleLoader;\n}\n\nfunction getUrlBuilder(): FnUrlBuilder {\n  if (!urlBuilder) {\n    throw new Error(\n      \"attempting to access URL builder before initFnRuntime() was called\",\n    );\n  }\n  return urlBuilder;\n}\n\nexport function fnModule<K extends FnKind>(\n  kind: K,\n  id: string,\n): Promise<FnModule<K>> {\n  return getModuleLoader().loadModule(kind, id);\n}\n\nexport function fnUrl<P extends Record<string, unknown>>(\n  kind: FnKind,\n  id: string,\n  props: P,\n  bounds: Bounds,\n): Promise<EffieWebUrl> {\n  return getUrlBuilder().buildUrl(kind, id, props, bounds);\n}\n\nexport function fnModuleIds(kind: FnKind): string[] {\n  return getModuleLoader().listModules(kind);\n}\n\nexport function fnModuleExists(kind: FnKind, id: string): boolean {\n  return getModuleLoader().hasModule(kind, id);\n}\n","import type { EffieData, EffieSources } from \"@effing/effie\";\nimport { annieStream } from \"@effing/annie\";\nimport type { AnnieStreamOptions } from \"@effing/annie\";\n\nexport type ImageResponseOptions = {\n  headers?: HeadersInit;\n  cacheControl?: string;\n};\n\nfunction detectImageContentType(bytes: Uint8Array): string {\n  if (bytes[0] === 0x89 && bytes[1] === 0x50) return \"image/png\";\n  if (bytes[0] === 0xff && bytes[1] === 0xd8) return \"image/jpeg\";\n  throw new Error(\"Unsupported image format: expected PNG or JPEG\");\n}\n\nexport function imageResponse(\n  bytes: Uint8Array,\n  options: ImageResponseOptions = {},\n): Response {\n  const { headers: extraHeaders, cacheControl = \"public, max-age=3600\" } =\n    options;\n\n  const headers = new Headers(extraHeaders);\n  headers.set(\"Content-Type\", detectImageContentType(bytes));\n  if (cacheControl) {\n    headers.set(\"Cache-Control\", cacheControl);\n  }\n\n  if (!(bytes.buffer instanceof ArrayBuffer)) {\n    throw new TypeError(\"SharedArrayBuffer is not supported\");\n  }\n\n  return new Response(bytes.buffer, { status: 200, headers });\n}\n\nexport type AnnieResponseOptions = AnnieStreamOptions & {\n  headers?: HeadersInit;\n  cacheControl?: string;\n  filename?: string;\n};\n\nexport function annieResponse(\n  frames: AsyncIterable<Buffer>,\n  options: AnnieResponseOptions = {},\n): Response {\n  const {\n    headers: extraHeaders,\n    cacheControl = \"public, max-age=3600\",\n    filename,\n    ...streamOptions\n  } = options;\n\n  const stream = annieStream(frames, streamOptions);\n\n  const headers = new Headers(extraHeaders);\n  headers.set(\"Content-Type\", \"application/x-tar\");\n  if (cacheControl) {\n    headers.set(\"Cache-Control\", cacheControl);\n  }\n  if (filename) {\n    headers.set(\"Content-Disposition\", `inline; filename=\"${filename}.tar\"`);\n  }\n\n  return new Response(stream, { status: 200, headers });\n}\n\nexport type EffieResponseOptions = {\n  headers?: HeadersInit;\n  cacheControl?: string;\n};\n\nexport function effieResponse<S extends EffieSources>(\n  data: EffieData<S>,\n  options: EffieResponseOptions = {},\n): Response {\n  const { headers: extraHeaders, cacheControl = \"public, max-age=3600\" } =\n    options;\n\n  const headers = new Headers(extraHeaders);\n  if (cacheControl) {\n    headers.set(\"Cache-Control\", cacheControl);\n  }\n\n  return Response.json(data, { status: 200, headers });\n}\n"],"mappings":";AASA,IAAI,eAAsC;AAC1C,IAAI,aAAkC;AAE/B,SAAS,cAAc,QAGrB;AACP,iBAAe,OAAO;AACtB,eAAa,OAAO;AACtB;AAEA,SAAS,kBAAkC;AACzC,MAAI,CAAC,cAAc;AACjB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,gBAA8B;AACrC,MAAI,CAAC,YAAY;AACf,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEO,SAAS,SACd,MACA,IACsB;AACtB,SAAO,gBAAgB,EAAE,WAAW,MAAM,EAAE;AAC9C;AAEO,SAAS,MACd,MACA,IACA,OACA,QACsB;AACtB,SAAO,cAAc,EAAE,SAAS,MAAM,IAAI,OAAO,MAAM;AACzD;AAEO,SAAS,YAAY,MAAwB;AAClD,SAAO,gBAAgB,EAAE,YAAY,IAAI;AAC3C;AAEO,SAAS,eAAe,MAAc,IAAqB;AAChE,SAAO,gBAAgB,EAAE,UAAU,MAAM,EAAE;AAC7C;;;AC3DA,SAAS,mBAAmB;AAQ5B,SAAS,uBAAuB,OAA2B;AACzD,MAAI,MAAM,CAAC,MAAM,OAAQ,MAAM,CAAC,MAAM,GAAM,QAAO;AACnD,MAAI,MAAM,CAAC,MAAM,OAAQ,MAAM,CAAC,MAAM,IAAM,QAAO;AACnD,QAAM,IAAI,MAAM,gDAAgD;AAClE;AAEO,SAAS,cACd,OACA,UAAgC,CAAC,GACvB;AACV,QAAM,EAAE,SAAS,cAAc,eAAe,uBAAuB,IACnE;AAEF,QAAM,UAAU,IAAI,QAAQ,YAAY;AACxC,UAAQ,IAAI,gBAAgB,uBAAuB,KAAK,CAAC;AACzD,MAAI,cAAc;AAChB,YAAQ,IAAI,iBAAiB,YAAY;AAAA,EAC3C;AAEA,MAAI,EAAE,MAAM,kBAAkB,cAAc;AAC1C,UAAM,IAAI,UAAU,oCAAoC;AAAA,EAC1D;AAEA,SAAO,IAAI,SAAS,MAAM,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC;AAC5D;AAQO,SAAS,cACd,QACA,UAAgC,CAAC,GACvB;AACV,QAAM;AAAA,IACJ,SAAS;AAAA,IACT,eAAe;AAAA,IACf;AAAA,IACA,GAAG;AAAA,EACL,IAAI;AAEJ,QAAM,SAAS,YAAY,QAAQ,aAAa;AAEhD,QAAM,UAAU,IAAI,QAAQ,YAAY;AACxC,UAAQ,IAAI,gBAAgB,mBAAmB;AAC/C,MAAI,cAAc;AAChB,YAAQ,IAAI,iBAAiB,YAAY;AAAA,EAC3C;AACA,MAAI,UAAU;AACZ,YAAQ,IAAI,uBAAuB,qBAAqB,QAAQ,OAAO;AAAA,EACzE;AAEA,SAAO,IAAI,SAAS,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC;AACtD;AAOO,SAAS,cACd,MACA,UAAgC,CAAC,GACvB;AACV,QAAM,EAAE,SAAS,cAAc,eAAe,uBAAuB,IACnE;AAEF,QAAM,UAAU,IAAI,QAAQ,YAAY;AACxC,MAAI,cAAc;AAChB,YAAQ,IAAI,iBAAiB,YAAY;AAAA,EAC3C;AAEA,SAAO,SAAS,KAAK,MAAM,EAAE,QAAQ,KAAK,QAAQ,CAAC;AACrD;","names":[]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@effing/fn",
+  "version": "0.26.1",
+  "description": "Effing function runtime — pluggable module loading and URL building",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@effing/annie": "0.27.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4",
+    "zod": "^3.25.76",
+    "@effing/effie": "0.27.0"
+  },
+  "peerDependencies": {
+    "zod": "^3.0.0",
+    "@effing/effie": "0.27.0"
+  },
+  "keywords": [
+    "effing",
+    "functions",
+    "runtime"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}