vayu-ts 0.2.10 → 0.2.12

package/README.md

@@ -193,6 +193,33 @@ await vayu.webhooks.subscribeToOverage('https://your-webhook-url.com/overage');
 // Subscribe to anonymous customer creation notifications
 await vayu.webhooks.subscribeToAnonymousCustomerCreated('https://your-webhook-url.com/your_path');
 
+// Validate webhook security
+app.post('/webhooks', (req, res) => {
+  const payload = JSON.stringify(req.body);
+  const timestamp = Number(req.headers['x-timestamp']);
+  const signature = String(req.headers['x-signature']);
+
+  // Important to login before verifying webhook signatures.
+  await vayu.login();
+  
+  const isValid = vayu.verifyWebhookSignature({
+    payload,
+    timestamp,
+    signature,
+  });
+
+  if (!isValid) {
+    // Handle invalid token.
+  }
+
+  // Proceed with webhook handling
+  console.log('Webhook is valid', JSON.parse(payload));
+  
+  // ... Handle event.
+  
+  res.sendStatus(200);
+});
+
 ```
 
 ## Features

package/dist/openapi/models/GetProductConsumptionResponseProductConsumption.d.ts

@@ -14,7 +14,10 @@ export declare class GetProductConsumptionResponseProductConsumption {
     * The id of the product.
     */
     'productId': string;
-    'productName'?: string;
+    /**
+    * The name of the product.
+    */
+    'productName': string;
     /**
     * The amount of units provisioned to the customer.
     */

package/dist/openapi/models/NotificationEventType.d.ts

@@ -14,5 +14,6 @@ export declare enum NotificationEventType {
     Overage = "Overage",
     UpcomingRenewal = "UpcomingRenewal",
     InvoiceApproved = "InvoiceApproved",
-    CustomerPortalLinkSent = "CustomerPortalLinkSent"
+    CustomerPortalLinkSent = "CustomerPortalLinkSent",
+    CommitmentCrossed = "CommitmentCrossed"
 }

package/dist/openapi/models/NotificationEventType.js

@@ -19,4 +19,5 @@ var NotificationEventType;
     NotificationEventType["UpcomingRenewal"] = "UpcomingRenewal";
     NotificationEventType["InvoiceApproved"] = "InvoiceApproved";
     NotificationEventType["CustomerPortalLinkSent"] = "CustomerPortalLinkSent";
+    NotificationEventType["CommitmentCrossed"] = "CommitmentCrossed";
 })(NotificationEventType = exports.NotificationEventType || (exports.NotificationEventType = {}));

package/dist/openapi/models/ProductConsumption.d.ts

@@ -14,7 +14,10 @@ export declare class ProductConsumption {
     * The id of the product.
     */
     'productId': string;
-    'productName'?: string;
+    /**
+    * The name of the product.
+    */
+    'productName': string;
     /**
     * The amount of units provisioned to the customer.
     */

package/dist/sdk/clients/WebhooksClient.d.ts

@@ -1,7 +1,13 @@
 export declare class WebhooksClient {
     private client;
     constructor();
-    subscribeToOverage(callbackUrl: string): Promise<void>;
+    verifyWebhookSignature({ payload, timestamp, signature, tolerance, }: {
+        payload: string;
+        timestamp: number;
+        signature: string;
+        tolerance?: number;
+    }): boolean;
+    subscribeToCommitmentCrossed(callbackUrl: string): Promise<void>;
     subscribeToAnonymousCustomerCreated(callbackUrl: string): Promise<void>;
     private subscribe;
 }

package/dist/sdk/clients/WebhooksClient.js

@@ -1,16 +1,32 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhooksClient = void 0;
+const crypto_1 = __importDefault(require("crypto"));
 const openapi_1 = require("../../openapi");
+const public_webhook_key_1 = require("../consts/public-webhook-key");
 const services_1 = require("../services");
 class WebhooksClient {
     constructor() {
         this.client = services_1.ConfigurationService.instance.generateNewClient(openapi_1.WebhooksApi);
     }
-    subscribeToOverage(callbackUrl) {
+    verifyWebhookSignature({ payload, timestamp, signature, tolerance = 300, }) {
+        const now = Math.floor(Date.now() / 1000);
+        if (Math.abs(now - timestamp) > tolerance) {
+            return false;
+        }
+        const message = `${timestamp}.${JSON.stringify(payload)}`;
+        const verifier = crypto_1.default.createVerify('RSA-SHA256');
+        verifier.update(message);
+        verifier.end();
+        return verifier.verify(public_webhook_key_1.PUBLIC_WEBHOOK_KEY, signature, 'base64');
+    }
+    subscribeToCommitmentCrossed(callbackUrl) {
         return this.subscribe({
             callbackUrl,
-            eventType: openapi_1.NotificationEventType.Overage,
+            eventType: openapi_1.NotificationEventType.CommitmentCrossed,
         });
     }
     subscribeToAnonymousCustomerCreated(callbackUrl) {

package/dist/sdk/consts/public-webhook-key.d.ts

@@ -0,0 +1 @@
+export declare const PUBLIC_WEBHOOK_KEY = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1JNmKwmOMQ9S7JyQFg2j\n5OHFhLBjqZbgSturKADF9sEH0X21RqzGXefMDmKbXMkcQiamqK9Puoj3N1bFr5lE\nf7EeUUihpcpfaeMNbNr0J8fkaq4YBO6cU3UvexLYr8WKkhaWkxB45TnysVl9FxIw\ne9iI3+QMAs/5DTIc+hAstXim+HfFW8teWYGI55KPjqqAIda3GPpFd4JnlI86TQux\np2nStncGasBpXCww7qXtE1SsM/o3/WQabzmmk4ox6Dt1DeTfMhtK/aOkz9/Cpx8V\nKCxwrKliqSM5Ies/2R4lTIKntqPsIcxxEQnVydL8YAY1uMiePVwgJFP6xRSY6J1H\nBwIDAQAB\n-----END PUBLIC KEY-----";

package/dist/sdk/consts/public-webhook-key.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PUBLIC_WEBHOOK_KEY = void 0;
+exports.PUBLIC_WEBHOOK_KEY = `-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1JNmKwmOMQ9S7JyQFg2j
+5OHFhLBjqZbgSturKADF9sEH0X21RqzGXefMDmKbXMkcQiamqK9Puoj3N1bFr5lE
+f7EeUUihpcpfaeMNbNr0J8fkaq4YBO6cU3UvexLYr8WKkhaWkxB45TnysVl9FxIw
+e9iI3+QMAs/5DTIc+hAstXim+HfFW8teWYGI55KPjqqAIda3GPpFd4JnlI86TQux
+p2nStncGasBpXCww7qXtE1SsM/o3/WQabzmmk4ox6Dt1DeTfMhtK/aOkz9/Cpx8V
+KCxwrKliqSM5Ies/2R4lTIKntqPsIcxxEQnVydL8YAY1uMiePVwgJFP6xRSY6J1H
+BwIDAQAB
+-----END PUBLIC KEY-----`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vayu-ts",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "description": "Simple and easy to use typescript package for utilizing vayu billing system",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",