Add webhook helper (#7)

Author: silas

.github/workflows/test.yaml

@@ -15,8 +15,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  sdk:
-    name: SDK
+  node:
+    name: Node
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -44,3 +44,19 @@ jobs:
 
       - name: Test
         run: make test
+
+  deno:
+    name: Deno
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+
+      - name: Check
+        run: deno check src/mod.ts

.gitignore

@@ -1,4 +1,5 @@
 .typescript
 dist
+examples/**/deno.json
 node_modules
 tsconfig.tsbuildinfo

Makefile

@@ -12,6 +12,10 @@ fmt:
 .PHONY: lint
 lint:
 	@pnpm prettier --check .
+	@pnpm eslint src test
+ifneq (, $(shell command -v deno))
+	@deno check src/mod.ts
+endif
 
 .PHONY: test
 test:

eslint.config.mjs

@@ -0,0 +1,22 @@
+// @ts-check
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+    },
+  },
+);

examples/bun-webhook/main.ts

@@ -0,0 +1,39 @@
+import { Webhook } from "@userhub/sdk";
+
+async function main() {
+  const port = process.env.PORT || "8000";
+
+  const signingSecret = process.env.SIGNING_SECRET;
+  if (!signingSecret) {
+    console.error("SIGNING_SECRET required");
+    process.exit(1);
+  }
+
+  const webhook = new Webhook(signingSecret);
+
+  webhook.onEvent((event) => {
+    console.log("Event:", event.type);
+
+    if (event.type === "organizations.changed") {
+      const organization = event.organizationsChanged?.organization;
+      console.log(
+        " - Organization:",
+        organization?.id,
+        organization?.displayName,
+      );
+    } else if (event.type === "users.changed") {
+      const user = event.usersChanged?.user;
+      console.log(" - User:", user?.id, user?.displayName);
+    }
+  });
+
+  Bun.serve({
+    port,
+
+    async fetch(req: Request): Promise<Response> {
+      return await webhook.handleFromWeb(req);
+    },
+  });
+}
+
+main().catch(console.error);

examples/deno-webhook/main.ts

@@ -0,0 +1,35 @@
+import { Webhook } from "npm:@userhub/sdk@latest";
+
+async function main() {
+  const port = parseInt(Deno.env.get("PORT") || "8000", 10);
+
+  const signingSecret = Deno.env.get("SIGNING_SECRET") || "";
+  if (!signingSecret) {
+    console.error("SIGNING_SECRET required");
+    Deno.exit(1);
+  }
+
+  const webhook = new Webhook(signingSecret);
+
+  webhook.onEvent((event) => {
+    console.log("Event:", event.type);
+
+    if (event.type === "organizations.changed") {
+      const organization = event.organizationsChanged?.organization;
+      console.log(
+        " - Organization:",
+        organization?.id,
+        organization?.displayName,
+      );
+    } else if (event.type === "users.changed") {
+      const user = event.usersChanged?.user;
+      console.log(" - User:", user?.id, user?.displayName);
+    }
+  });
+
+  Deno.serve({ port }, async (req: Request): Promise<Response> => {
+    return await webhook.handleFromWeb(req);
+  });
+}
+
+main().catch(console.error);

examples/node-webhook/main.mjs

@@ -0,0 +1,59 @@
+import { Webhook, WebhookRequest } from "@userhub/sdk/webhook";
+import { createServer } from "http";
+
+async function main() {
+  const port = process.env.PORT || "8000";
+
+  const signingSecret = process.env.SIGNING_SECRET;
+  if (!signingSecret) {
+    console.error("SIGNING_SECRET required");
+    process.exit(1);
+  }
+
+  const webhook = new Webhook(signingSecret);
+
+  webhook.onEvent((event) => {
+    console.log("Event:", event.type);
+
+    if (event.type === "organizations.changed") {
+      const organization = event.organizationsChanged.organization;
+      console.log(
+        " - Organization:",
+        organization.id,
+        organization.displayName,
+      );
+    } else if (event.type === "users.changed") {
+      const user = event.usersChanged.user;
+      console.log(" - User:", user.id, user.displayName);
+    }
+  });
+
+  const server = createServer((req, res) => {
+    const chunks = [];
+
+    req.on("data", (v) => {
+      chunks.push(v);
+    });
+
+    req.on("end", async () => {
+      const r = await webhook.handle(
+        new WebhookRequest({
+          body: chunks.join(""),
+          headers: req.headers,
+        }),
+      );
+
+      res.statusCode = r.statusCode;
+      for (const [name, value] of r.headers.entries()) {
+        res.setHeader(name, value);
+      }
+      res.end(r.body);
+    });
+  });
+
+  server.listen(port, () => {
+    console.log(`Listening on ${port}`);
+  });
+}
+
+main().catch(console.error);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@userhub/sdk",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "UserHub JavaScript SDK",
   "license": "MIT",
   "author": "UserHub (https://userhub.com/)",
@@ -14,12 +14,12 @@
   },
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/mod.js",
+      "import": "./dist/mod.mjs",
+      "types": "./dist/mod.d.ts"
     }
   },
-  "module": "./dist/index.mjs",
+  "module": "./dist/mod.mjs",
   "files": [
     "/dist"
   ],
@@ -30,12 +30,14 @@
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@tsconfig/node18": "^18.2.2",
-    "@types/node": "^20.11.19",
+    "@tsconfig/node18": "^18",
+    "@types/node": "^18",
+    "eslint": "^8.57.0",
     "prettier": "^3.2.5",
     "prettier-package-json": "^2.8.0",
     "tsup": "^8.0.2",
     "typescript": "^5.3.3",
+    "typescript-eslint": "^7.0.2",
     "vitest": "^1.3.0"
   },
   "keywords": [