@labyrinthe/connect 0.0.0-stage → 1.2.0

package/dist/express.cjs

@@ -0,0 +1,87 @@
+'use strict';
+
+var connect = require('@labyrinthe/connect');
+
+// src/express.ts
+function labyrintheWebhook(options = {}) {
+  return async (req, res, next) => {
+    let event;
+    try {
+      const secret = options.secret ?? readEnv("LABYRINTHE_WEBHOOK_SECRET");
+      if (secret === void 0 || secret === "") {
+        throw new Error("No webhook secret: pass `secret` or set LABYRINTHE_WEBHOOK_SECRET.");
+      }
+      const rawBody = await readRawBody(req);
+      const signature = header(req, "x-signature");
+      event = await connect.Webhooks.constructEvent(
+        rawBody,
+        signature,
+        secret,
+        options.toleranceSeconds === void 0 ? {} : { toleranceSeconds: options.toleranceSeconds }
+      );
+    } catch (error) {
+      if (error instanceof connect.SignatureVerificationError || error instanceof connect.InvalidWebhookPayloadError) {
+        send(res, 400, { error: { code: error.code, message: error.message } });
+        return;
+      }
+      next(error);
+      return;
+    }
+    if (options.onEvent === void 0) {
+      req.labyrintheEvent = event;
+      next();
+      return;
+    }
+    try {
+      await options.onEvent(event, req, res);
+      if (res.headersSent !== true) {
+        send(res, 200, { received: true });
+      }
+    } catch (error) {
+      next(error);
+    }
+  };
+}
+async function readRawBody(req) {
+  const body = req.body;
+  if (typeof body === "string" || body instanceof Uint8Array) {
+    return body;
+  }
+  if (body !== void 0 && body !== null && !(typeof body === "object" && Object.keys(body).length === 0)) {
+    throw new Error(
+      "The webhook body was already parsed (express.json()?): mount labyrintheWebhook() before it, or use express.raw({ type: 'application/json' }) on this route."
+    );
+  }
+  const chunks = [];
+  let length = 0;
+  for await (const chunk of req) {
+    const bytes2 = typeof chunk === "string" ? new TextEncoder().encode(chunk) : chunk;
+    chunks.push(bytes2);
+    length += bytes2.length;
+  }
+  const bytes = new Uint8Array(length);
+  let offset = 0;
+  for (const chunk of chunks) {
+    bytes.set(chunk, offset);
+    offset += chunk.length;
+  }
+  return bytes;
+}
+function header(req, name) {
+  const value = req.headers[name];
+  return Array.isArray(value) ? value[0] : value;
+}
+function send(res, status, body) {
+  res.statusCode = status;
+  res.setHeader("Content-Type", "application/json");
+  res.end(JSON.stringify(body));
+}
+function readEnv(name) {
+  try {
+    return globalThis.process?.env?.[name];
+  } catch {
+    return void 0;
+  }
+}
+
+exports.labyrintheWebhook = labyrintheWebhook;

package/dist/express.d.cts

@@ -0,0 +1,49 @@
+import { WebhookEvent } from '@labyrinthe/connect';
+export { WebhookEvent } from '@labyrinthe/connect';
+
+/**
+ * Express (and Connect / plain `node:http`) webhook middleware.
+ *
+ *     import express from 'express';
+ *     import { labyrintheWebhook } from '@labyrinthe/connect/express';
+ *
+ *     app.post('/webhooks/labyrinthe', labyrintheWebhook({
+ *       secret: process.env.LABYRINTHE_WEBHOOK_SECRET!,
+ *       onEvent: async (event) => { … },
+ *     }));
+ *
+ * Mount it BEFORE `express.json()` for this route (or use `express.raw({ type: 'application/json' })`):
+ * the signature is computed on the raw body.
+ */
+
+/** The parts of an Express / Node request the middleware reads. */
+interface WebhookRequest extends AsyncIterable<unknown> {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    /** Set by the middleware when there is no `onEvent`. */
+    labyrintheEvent?: WebhookEvent;
+}
+/** The parts of an Express / Node response the middleware uses. */
+interface WebhookResponse {
+    statusCode: number;
+    headersSent?: boolean;
+    setHeader(name: string, value: string): unknown;
+    end(body?: string): unknown;
+}
+type NextFunction = (error?: unknown) => void;
+interface LabyrintheWebhookOptions {
+    /** Endpoint secret (client area > Developers > Webhooks). Defaults to `process.env.LABYRINTHE_WEBHOOK_SECRET`. */
+    secret?: string;
+    /** Max age of a delivery, in seconds (default 300; 0 disables the check). */
+    toleranceSeconds?: number;
+    /**
+     * Handles a verified event; the middleware then answers 200. If it throws,
+     * the error goes to `next(error)` (Express answers 500 and the delivery is
+     * retried). Without `onEvent`, the event is set on `req.labyrintheEvent`
+     * and `next()` is called.
+     */
+    onEvent?: (event: WebhookEvent, req: WebhookRequest, res: WebhookResponse) => unknown;
+}
+declare function labyrintheWebhook(options?: LabyrintheWebhookOptions): (req: WebhookRequest, res: WebhookResponse, next: NextFunction) => Promise<void>;
+
+export { type LabyrintheWebhookOptions, type NextFunction, type WebhookRequest, type WebhookResponse, labyrintheWebhook };

package/dist/express.d.ts

@@ -0,0 +1,49 @@
+import { WebhookEvent } from '@labyrinthe/connect';
+export { WebhookEvent } from '@labyrinthe/connect';
+
+/**
+ * Express (and Connect / plain `node:http`) webhook middleware.
+ *
+ *     import express from 'express';
+ *     import { labyrintheWebhook } from '@labyrinthe/connect/express';
+ *
+ *     app.post('/webhooks/labyrinthe', labyrintheWebhook({
+ *       secret: process.env.LABYRINTHE_WEBHOOK_SECRET!,
+ *       onEvent: async (event) => { … },
+ *     }));
+ *
+ * Mount it BEFORE `express.json()` for this route (or use `express.raw({ type: 'application/json' })`):
+ * the signature is computed on the raw body.
+ */
+
+/** The parts of an Express / Node request the middleware reads. */
+interface WebhookRequest extends AsyncIterable<unknown> {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    /** Set by the middleware when there is no `onEvent`. */
+    labyrintheEvent?: WebhookEvent;
+}
+/** The parts of an Express / Node response the middleware uses. */
+interface WebhookResponse {
+    statusCode: number;
+    headersSent?: boolean;
+    setHeader(name: string, value: string): unknown;
+    end(body?: string): unknown;
+}
+type NextFunction = (error?: unknown) => void;
+interface LabyrintheWebhookOptions {
+    /** Endpoint secret (client area > Developers > Webhooks). Defaults to `process.env.LABYRINTHE_WEBHOOK_SECRET`. */
+    secret?: string;
+    /** Max age of a delivery, in seconds (default 300; 0 disables the check). */
+    toleranceSeconds?: number;
+    /**
+     * Handles a verified event; the middleware then answers 200. If it throws,
+     * the error goes to `next(error)` (Express answers 500 and the delivery is
+     * retried). Without `onEvent`, the event is set on `req.labyrintheEvent`
+     * and `next()` is called.
+     */
+    onEvent?: (event: WebhookEvent, req: WebhookRequest, res: WebhookResponse) => unknown;
+}
+declare function labyrintheWebhook(options?: LabyrintheWebhookOptions): (req: WebhookRequest, res: WebhookResponse, next: NextFunction) => Promise<void>;
+
+export { type LabyrintheWebhookOptions, type NextFunction, type WebhookRequest, type WebhookResponse, labyrintheWebhook };

package/dist/express.js

@@ -0,0 +1,85 @@
+import { Webhooks, SignatureVerificationError, InvalidWebhookPayloadError } from '@labyrinthe/connect';
+
+// src/express.ts
+function labyrintheWebhook(options = {}) {
+  return async (req, res, next) => {
+    let event;
+    try {
+      const secret = options.secret ?? readEnv("LABYRINTHE_WEBHOOK_SECRET");
+      if (secret === void 0 || secret === "") {
+        throw new Error("No webhook secret: pass `secret` or set LABYRINTHE_WEBHOOK_SECRET.");
+      }
+      const rawBody = await readRawBody(req);
+      const signature = header(req, "x-signature");
+      event = await Webhooks.constructEvent(
+        rawBody,
+        signature,
+        secret,
+        options.toleranceSeconds === void 0 ? {} : { toleranceSeconds: options.toleranceSeconds }
+      );
+    } catch (error) {
+      if (error instanceof SignatureVerificationError || error instanceof InvalidWebhookPayloadError) {
+        send(res, 400, { error: { code: error.code, message: error.message } });
+        return;
+      }
+      next(error);
+      return;
+    }
+    if (options.onEvent === void 0) {
+      req.labyrintheEvent = event;
+      next();
+      return;
+    }
+    try {
+      await options.onEvent(event, req, res);
+      if (res.headersSent !== true) {
+        send(res, 200, { received: true });
+      }
+    } catch (error) {
+      next(error);
+    }
+  };
+}
+async function readRawBody(req) {
+  const body = req.body;
+  if (typeof body === "string" || body instanceof Uint8Array) {
+    return body;
+  }
+  if (body !== void 0 && body !== null && !(typeof body === "object" && Object.keys(body).length === 0)) {
+    throw new Error(
+      "The webhook body was already parsed (express.json()?): mount labyrintheWebhook() before it, or use express.raw({ type: 'application/json' }) on this route."
+    );
+  }
+  const chunks = [];
+  let length = 0;
+  for await (const chunk of req) {
+    const bytes2 = typeof chunk === "string" ? new TextEncoder().encode(chunk) : chunk;
+    chunks.push(bytes2);
+    length += bytes2.length;
+  }
+  const bytes = new Uint8Array(length);
+  let offset = 0;
+  for (const chunk of chunks) {
+    bytes.set(chunk, offset);
+    offset += chunk.length;
+  }
+  return bytes;
+}
+function header(req, name) {
+  const value = req.headers[name];
+  return Array.isArray(value) ? value[0] : value;
+}
+function send(res, status, body) {
+  res.statusCode = status;
+  res.setHeader("Content-Type", "application/json");
+  res.end(JSON.stringify(body));
+}
+function readEnv(name) {
+  try {
+    return globalThis.process?.env?.[name];
+  } catch {
+    return void 0;
+  }
+}
+
+export { labyrintheWebhook };