@relaybox/rest - npm Package Compare versions

Comparing version 1.11.0 to 1.11.1

dist/relaybox.d.ts

@@ -59,5 +59,9 @@ import { ExtendedJwtPayload } from './types/jwt.types';
     /**
-     * Verify webhook sugnature
+     * Verify the authenticity of a webhook request using the webhook signing key.
+     * @param {WebhookPayload} webhookPayload - The body of the webhook request.
+     * @param {string} requestSignature - The signature of the webhook request found at the `X-Relaybox-Webhook-Signature` header.
+     * @param {string} signingKey - The webhook signing key generated in the Relaybox dashboard.
+     * @returns {boolean} Whether the request is authentic.
      */
     verifyWebhookSignature(webhookPayload: WebhookPayload, requestSignature: string, signingKey: string): boolean;
 }

dist/relaybox.js

@@ -127,3 +127,7 @@ "use strict";
     /**
-     * Verify webhook sugnature
+     * Verify the authenticity of a webhook request using the webhook signing key.
+     * @param {WebhookPayload} webhookPayload - The body of the webhook request.
+     * @param {string} requestSignature - The signature of the webhook request found at the `X-Relaybox-Webhook-Signature` header.
+     * @param {string} signingKey - The webhook signing key generated in the Relaybox dashboard.
+     * @returns {boolean} Whether the request is authentic.
      */
@@ -130,0 +134,0 @@ verifyWebhookSignature(webhookPayload, requestSignature, signingKey) {

package.json

 {
   "name": "@relaybox/rest",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "description": "RelayBox REST Services SDK. Enables seemless integration between server-side applications and RelayBox's authentication and realtime services. It provides robust functionality for generating authentication tokens, publishing events, and interacting efficiently with RelayBox's suite of services.",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

34321

increased by2.51%

Lines of code

609

increased by1.33%

No dependency changes