@lightsparkdev/lightspark-sdk 0.3.1 → 0.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/lightspark-sdk",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [
@@ -57,37 +57,39 @@
   ],
   "scripts": {
     "build": "tsup --entry src/index.ts --entry src/objects/index.ts --format cjs,esm --dts",
-    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
+    "clean": "rm -rf .turbo && rm -rf dist",
     "dev": "yarn build -- --watch",
     "docs": "typedoc src",
-    "format": "npx prettier --write ./src",
-    "lint": "npx prettier --check ./src",
+    "format": "prettier src --check",
+    "format:fix": "prettier src --write",
+    "lint": "prettier --check ./src",
     "postversion": "yarn build",
-    "test": "tsc --noEmit --project tsconfig-test.json && jest --no-cache --runInBand --bail",
-    "type-check": "tsc --noEmit"
+    "test": "jest --no-cache --runInBand --bail",
+    "types": "tsc"
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@lightsparkdev/core": "0.3.1",
+    "@lightsparkdev/core": "0.3.2",
     "auto-bind": "^5.0.1",
     "crypto": "^1.0.1",
     "crypto-browserify": "^3.12.0",
     "dayjs": "^1.11.7",
     "graphql": "^16.6.0",
     "graphql-ws": "^5.11.3",
-    "typedoc": "^0.24.7",
     "ws": "^8.12.1",
     "zen-observable-ts": "^1.1.0"
   },
   "devDependencies": {
     "@types/crypto-js": "^4.1.1",
+    "@types/jest": "^29.5.2",
     "@types/ws": "^8.5.4",
     "jest": "^29.4.1",
-    "prettier": "^2.8.4",
-    "prettier-plugin-organize-imports": "^3.2.2",
+    "prettier": "2.8.7",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "tsconfig": "*",
+    "tsup": "^6.7.0",
+    "typedoc": "^0.24.7",
     "typescript": "^4.9.5"
   }
 }

package/src/__tests__/webhooks.test.ts

@@ -0,0 +1,26 @@
+import WebhookEventType from "../objects/WebhookEventType.js";
+import { verifyAndParseWebhook } from "../webhooks.js";
+
+describe("Webhooks", () => {
+  test("should verify and parse webhook data", async () => {
+    const eventType = WebhookEventType.NODE_STATUS;
+    const eventId = "1615c8be5aa44e429eba700db2ed8ca5";
+    const entityId = "lightning_node:01882c25-157a-f96b-0000-362d42b64397";
+    const timeStamp = new Date("2023-05-17T23:56:47.874449+00:00");
+    const data = `{"event_type": "NODE_STATUS", "event_id": "1615c8be5aa44e429eba700db2ed8ca5", "timestamp": "2023-05-17T23:56:47.874449+00:00", "entity_id": "lightning_node:01882c25-157a-f96b-0000-362d42b64397"}`;
+    const hexdigest =
+      "62a8829aeb48b4142533520b1f7f86cdb1ee7d718bf3ea15bc1c662d4c453b74";
+    const webhookSecret = "3gZ5oQQUASYmqQNuEk0KambNMVkOADDItIJjzUlAWjX";
+
+    const webhook = await verifyAndParseWebhook(
+      Buffer.from(data, "utf-8"),
+      hexdigest,
+      webhookSecret
+    );
+
+    expect(webhook.entity_id).toBe(entityId);
+    expect(webhook.event_id).toBe(eventId);
+    expect(webhook.event_type).toBe(eventType);
+    expect(webhook.timestamp).toEqual(timeStamp);
+  });
+});

package/src/index.ts

@@ -3,3 +3,4 @@
 export * from "./auth/index.js";
 export { default as LightsparkClient } from "./client.js";
 export * from "./objects/index.js";
+export * from "./webhooks.js";

package/src/webhooks.ts

@@ -0,0 +1,42 @@
+import { createHmac } from "crypto";
+import { WebhookEventType } from "./objects/WebhookEventType.js";
+
+export const WEBHOOKS_SIGNATURE_HEADER = "lightspark-signature";
+
+export interface WebhookEvent {
+  event_type: WebhookEventType;
+  event_id: string;
+  timestamp: Date;
+  entity_id: string;
+}
+
+export const verifyAndParseWebhook = (
+  data: Uint8Array,
+  hexdigest: string,
+  webhook_secret: string
+): Promise<WebhookEvent> => {
+  const sig = createHmac("sha256", webhook_secret).update(data).digest("hex");
+
+  if (sig.toLowerCase() !== hexdigest.toLowerCase()) {
+    throw new Error("Webhook message hash does not match signature");
+  }
+
+  return parseWebhook(data);
+};
+
+const parseWebhook = async (data: Uint8Array): Promise<WebhookEvent> => {
+  let td = TextDecoder;
+  if (typeof td === "undefined") {
+    const tdModule = await import("text-encoding");
+    td = tdModule.TextDecoder;
+  }
+  const dataStr = new td().decode(data);
+  const event = JSON.parse(dataStr);
+
+  return {
+    event_type: WebhookEventType[event.event_type],
+    event_id: event.event_id,
+    timestamp: new Date(event.timestamp),
+    entity_id: event.entity_id,
+  };
+};