webflow-api 3.0.1 → 3.1.1

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.0.1";
+exports.SDK_VERSION = "3.1.1";

package/dist/wrapper/WebflowClient.d.ts

@@ -1,8 +1,11 @@
 import { WebflowClient as FernClient } from "../Client";
 import { OauthScope } from "../api/types/OAuthScope";
+import { Client as Webhooks } from "./WebhooksClient";
 export declare class WebflowClient extends FernClient {
     protected readonly _options: FernClient.Options;
     constructor(_options: FernClient.Options);
+    protected _webhooks: Webhooks | undefined;
+    get webhooks(): Webhooks;
     /**
      * @param clientId The OAuth client ID
      * @param state The state

package/dist/wrapper/WebflowClient.js

@@ -41,11 +41,16 @@ const Client_1 = require("../Client");
 const core = __importStar(require("../core"));
 const errors = __importStar(require("../errors"));
 const version_1 = require("../version");
+const WebhooksClient_1 = require("./WebhooksClient");
 class WebflowClient extends Client_1.WebflowClient {
     constructor(_options) {
         super(_options);
         this._options = _options;
     }
+    get webhooks() {
+        var _a;
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient_1.Client(this._options)));
+    }
     /**
      * @param clientId The OAuth client ID
      * @param state The state

package/dist/wrapper/WebhooksClient.d.ts

@@ -0,0 +1,39 @@
+import { Webhooks } from "../api/resources/webhooks/client/Client";
+declare module "../api/resources/webhooks/client/Client" {
+    namespace Webhooks {
+        interface RequestSignatureDetails {
+            /** The headers of the incoming webhook request as a record-like object */
+            headers: Record<string, string>;
+            /** The body of the incoming webhook request as a string */
+            body: string;
+            /** The secret key generated when creating the webhook or the OAuth client secret */
+            secret: string;
+        }
+    }
+}
+export declare class Client extends Webhooks {
+    protected readonly _options: Webhooks.Options;
+    constructor(_options: Webhooks.Options);
+    /**
+     * Verify that the signature on the webhook message is from Webflow
+     * @link https://developers.webflow.com/data/docs/working-with-webhooks#validating-request-signatures
+     *
+     * @param {Webhooks.RequestSignatureDetails.headers} requestSignatureDetails - details of the incoming webhook request
+     * @example
+     *     function incomingWebhookRouteHandler(req, res) {
+     *       const headers = req.headers;
+     *       const body = JSON.stringify(req.body);
+     *       const secret = getWebhookSecret(WEBHOOK_ID);
+     *       const isAuthenticated = await client.webhooks.verifySignature({ headers, body, secret });
+     *
+     *       if (isAuthenticated) {
+     *           // Process the webhook
+     *       } else {
+     *           // Alert the user that the webhook is not authenticated
+     *       }
+     *       res.sendStatus(200);
+     *     }
+     *
+     */
+    verifySignature({ headers, body, secret }: Webhooks.RequestSignatureDetails): Promise<boolean>;
+}

package/dist/wrapper/WebhooksClient.js

@@ -0,0 +1,66 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const Client_1 = require("../api/resources/webhooks/client/Client");
+const crypto_1 = __importDefault(require("crypto"));
+class Client extends Client_1.Webhooks {
+    constructor(_options) {
+        super(_options);
+        this._options = _options;
+    }
+    /**
+     * Verify that the signature on the webhook message is from Webflow
+     * @link https://developers.webflow.com/data/docs/working-with-webhooks#validating-request-signatures
+     *
+     * @param {Webhooks.RequestSignatureDetails.headers} requestSignatureDetails - details of the incoming webhook request
+     * @example
+     *     function incomingWebhookRouteHandler(req, res) {
+     *       const headers = req.headers;
+     *       const body = JSON.stringify(req.body);
+     *       const secret = getWebhookSecret(WEBHOOK_ID);
+     *       const isAuthenticated = await client.webhooks.verifySignature({ headers, body, secret });
+     *
+     *       if (isAuthenticated) {
+     *           // Process the webhook
+     *       } else {
+     *           // Alert the user that the webhook is not authenticated
+     *       }
+     *       res.sendStatus(200);
+     *     }
+     *
+     */
+    verifySignature({ headers, body, secret }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Creates a HMAC signature following directions from https://developers.webflow.com/data/docs/working-with-webhooks#steps-to-validate-the-request-signature
+            const createHmac = (signingSecret, message) => __awaiter(this, void 0, void 0, function* () {
+                const encoder = new TextEncoder();
+                // Encode the signingSecret key
+                // @ts-expect-error TS2339: Property 'subtle' does not exist on type 'typeof import("crypto")'.
+                const key = yield crypto_1.default.subtle.importKey("raw", encoder.encode(signingSecret), { name: "HMAC", hash: "SHA-256" }, false, ["sign"]);
+                // Encode the message and compute HMAC signature
+                // @ts-expect-error TS2339: Property 'subtle' does not exist on type 'typeof import("crypto")'.
+                const signature = yield crypto_1.default.subtle.sign("HMAC", key, encoder.encode(message));
+                // Convert signature to hex string
+                return Array.from(new Uint8Array(signature))
+                    .map((b) => b.toString(16).padStart(2, "0"))
+                    .join("");
+            });
+            const message = `${headers["x-webflow-timestamp"]}:${body}`;
+            const generatedSignature = yield createHmac(secret, message);
+            return headers["x-webflow-signature"] === generatedSignature;
+        });
+    }
+}
+exports.Client = Client;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "webflow-api",
-    "version": "3.0.1",
+    "version": "3.1.1",
     "private": false,
     "repository": "https://github.com/webflow/js-webflow-api",
     "main": "./index.js",
@@ -18,7 +18,8 @@
         "node-fetch": "2.7.0",
         "qs": "6.11.2",
         "readable-stream": "^4.5.2",
-        "js-base64": "3.7.2"
+        "js-base64": "3.7.2",
+        "crypto-browserify": "^3.12.1"
     },
     "devDependencies": {
         "@types/url-join": "4.0.1",
@@ -38,6 +39,7 @@
     "browser": {
         "fs": false,
         "os": false,
-        "path": false
+        "path": false,
+        "crypto": false
     }
 }