vayu-ts 0.2.11 → 0.2.13

package/README.md

@@ -16,7 +16,10 @@ npm i vayu-ts
 
 ### Initialization
 
-Initialize the Vayu API client. The `baseUrl` parameter is optional and defaults to Vayu's public API servers.
+Initialize the Vayu API client. 
+> ⚠️ **The `CLIENT_ID` environment variable is required to use the Vayu API client.**
+
+The `baseUrl` parameter is optional and defaults to Vayu's public API servers.
 
 ```typescript
 import { Vayu } from 'vayu-ts';
@@ -193,6 +196,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/sdk/services/configuration.service.d.ts

@@ -7,6 +7,7 @@ export declare class ConfigurationService {
     static initialize(apiKey: string, baseServer: BaseServerConfiguration): ConfigurationService;
     static generateServerConfiguration(baseUrl?: string): BaseServerConfiguration;
     private accessToken;
+    private clientId;
     private expiresAt;
     constructor(apiKey: string, baseServer: BaseServerConfiguration);
     generateNewClient<T extends {

package/dist/sdk/services/configuration.service.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationService = void 0;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const openapi_1 = require("../../openapi");
+const utils_1 = require("../utils");
+const CLIENT_ID_ENV_VAR_NAME = 'CLIENT_ID';
 const EXPIRATION_THRESHOLD = 1000 * 60 * 5;
 const BASE_URLS_MAP = new Map([
     ['https://connect.withvayu.com', openapi_1.server1],
@@ -37,6 +39,7 @@ class ConfigurationService {
         this.apiKey = apiKey;
         this.baseServer = baseServer;
         this.expiresAt = Date.now();
+        this.clientId = (0, utils_1.getRequiredEnvVar)(CLIENT_ID_ENV_VAR_NAME);
     }
     generateNewClient(ClientClass) {
         this.validateIsLoggedIn();
@@ -81,6 +84,7 @@ class ConfigurationService {
                             await this.generateToken();
                         }
                         context.setHeaderParam('Authorization', `Bearer ${this.accessToken}`);
+                        context.setHeaderParam('x-api-key', this.clientId);
                         return context;
                     },
                     post: async (context) => (context),

package/dist/sdk/utils/env-vars.d.ts

@@ -0,0 +1,2 @@
+export declare function getEnvVar<EnumType extends string = string>(name: string): EnumType;
+export declare function getRequiredEnvVar<EnumType extends string = string>(name: string): EnumType;

package/dist/sdk/utils/env-vars.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredEnvVar = exports.getEnvVar = void 0;
+function getEnvVar(name) {
+    return process.env[name];
+}
+exports.getEnvVar = getEnvVar;
+function getRequiredEnvVar(name) {
+    const envVarValue = getEnvVar(name);
+    if (!envVarValue) {
+        throw new Error(`Environment variable ${name} is required`);
+    }
+    return envVarValue;
+}
+exports.getRequiredEnvVar = getRequiredEnvVar;

package/dist/sdk/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './env-vars';

package/dist/sdk/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./env-vars"), exports);

package/package.json

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