@dereekb/nestjs 13.4.0 → 13.4.1

package/vapiai/index.cjs.js

@@ -238,25 +238,26 @@ function _ts_generator$2(thisArg, body) {
     }
 }
 /**
- * Verifies a VapiAi webhook event header.
+ * Creates a verifier for Vapi AI webhook events.
  *
- * @param vapiSecretTokenGetter The VapiAi secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a VapiAi webhook event.
+ * Supports secret token, HMAC SHA-256, and no-op verification modes based on the provided configuration.
+ *
+ * @param config - the verification configuration including secret tokens, verification type, and signature prefix
+ * @returns a VapiAiWebhookEventVerifier function that validates incoming webhook requests
  */ function vapiAiWebhookEventVerifier(config) {
     var _ref;
     var inputVerificationType = config.verificationType, inputSecret = config.secret, inputHmacSecret = config.hmacSecret, inputSignaturePrefix = config.signaturePrefix;
     var verificationType = inputVerificationType !== null && inputVerificationType !== void 0 ? inputVerificationType : inputHmacSecret != null ? 'hmac' : 'secret'; // default to secret always, never default to none
     var secretToken = (_ref = verificationType === 'hmac' ? inputHmacSecret !== null && inputHmacSecret !== void 0 ? inputHmacSecret : inputSecret : inputSecret) !== null && _ref !== void 0 ? _ref : '';
     var signaturePrefix = inputSignaturePrefix !== null && inputSignaturePrefix !== void 0 ? inputSignaturePrefix : '';
-    function verifyNone(input) {
+    function verifyNone(_input) {
         return true;
     }
     function verifySecret(input) {
         var request = input.request;
         var headers = request.headers;
         var vapiSecret = headers['x-vapi-secret'];
-        var valid = vapiSecret === secretToken;
-        return valid;
+        return vapiSecret === secretToken;
     }
     function verifyHmac(input) {
         var request = input.request, requestBodyString = input.requestBodyString;
@@ -266,11 +267,10 @@ function _ts_generator$2(thisArg, body) {
         var message = "".concat(timestamp, ".").concat(requestBodyString);
         var hashForVerify = crypto.createHmac('sha256', secretToken).update(message).digest('hex');
         var signature = "".concat(signaturePrefix).concat(hashForVerify);
-        var valid = vapiSignature === signature;
-        return valid;
+        return vapiSignature === signature;
     }
     var verify = verificationType === 'hmac' ? verifyHmac : verificationType === 'secret' ? verifySecret : verifyNone;
-    return function(request, rawBody) {
+    return function(request, _rawBody) {
         return _async_to_generator$2(function() {
             var requestBodyString, valid, requestBody, result;
             return _ts_generator$2(this, function(_state) {
@@ -830,7 +830,14 @@ function _class_call_check$3(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function vapiaiWebhookServiceConfigFactory(configService) {
+/**
+ * Factory that creates a VapiAiWebhookServiceConfig from environment variables.
+ *
+ * Reads the webhook secret, HMAC secret, verification type, and signature prefix from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiWebhookServiceConfig
+ */ function vapiaiWebhookServiceConfigFactory(configService) {
     var config = {
         webhookConfig: {
             secret: configService.get(VAPI_AI_WEBHOOK_SECRET_TOKEN_ENV_VAR),
@@ -842,7 +849,11 @@ function vapiaiWebhookServiceConfigFactory(configService) {
     VapiAiWebhookServiceConfig.assertValidConfig(config);
     return config;
 }
-exports.VapiAiWebhookModule = function VapiAiWebhookModule() {
+/**
+ * NestJS module that handles incoming Vapi AI webhook events.
+ *
+ * Provides the VapiAiWebhookService and controller for verifying and processing Vapi AI webhook payloads.
+ */ exports.VapiAiWebhookModule = function VapiAiWebhookModule() {
     _class_call_check$3(this, VapiAiWebhookModule);
 };
 exports.VapiAiWebhookModule = __decorate([
@@ -989,7 +1000,14 @@ function _class_call_check(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function vapiaiServiceConfigFactory(configService) {
+/**
+ * Factory that creates a VapiAiServiceConfig from environment variables.
+ *
+ * Reads the Vapi AI secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiServiceConfig
+ */ function vapiaiServiceConfigFactory(configService) {
     var config = {
         vapiai: {
             config: {
@@ -1000,7 +1018,11 @@ function vapiaiServiceConfigFactory(configService) {
     VapiAiServiceConfig.assertValidConfig(config);
     return config;
 }
-exports.VapiAiModule = function VapiAiModule() {
+/**
+ * NestJS module that provides the VapiAiApi service.
+ *
+ * Reads the Vapi AI secret token from environment variables for API authentication.
+ */ exports.VapiAiModule = function VapiAiModule() {
     _class_call_check(this, VapiAiModule);
 };
 exports.VapiAiModule = __decorate([

package/vapiai/index.esm.js

@@ -236,25 +236,26 @@ function _ts_generator$2(thisArg, body) {
     }
 }
 /**
- * Verifies a VapiAi webhook event header.
+ * Creates a verifier for Vapi AI webhook events.
  *
- * @param vapiSecretTokenGetter The VapiAi secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a VapiAi webhook event.
+ * Supports secret token, HMAC SHA-256, and no-op verification modes based on the provided configuration.
+ *
+ * @param config - the verification configuration including secret tokens, verification type, and signature prefix
+ * @returns a VapiAiWebhookEventVerifier function that validates incoming webhook requests
  */ function vapiAiWebhookEventVerifier(config) {
     var _ref;
     var inputVerificationType = config.verificationType, inputSecret = config.secret, inputHmacSecret = config.hmacSecret, inputSignaturePrefix = config.signaturePrefix;
     var verificationType = inputVerificationType !== null && inputVerificationType !== void 0 ? inputVerificationType : inputHmacSecret != null ? 'hmac' : 'secret'; // default to secret always, never default to none
     var secretToken = (_ref = verificationType === 'hmac' ? inputHmacSecret !== null && inputHmacSecret !== void 0 ? inputHmacSecret : inputSecret : inputSecret) !== null && _ref !== void 0 ? _ref : '';
     var signaturePrefix = inputSignaturePrefix !== null && inputSignaturePrefix !== void 0 ? inputSignaturePrefix : '';
-    function verifyNone(input) {
+    function verifyNone(_input) {
         return true;
     }
     function verifySecret(input) {
         var request = input.request;
         var headers = request.headers;
         var vapiSecret = headers['x-vapi-secret'];
-        var valid = vapiSecret === secretToken;
-        return valid;
+        return vapiSecret === secretToken;
     }
     function verifyHmac(input) {
         var request = input.request, requestBodyString = input.requestBodyString;
@@ -264,11 +265,10 @@ function _ts_generator$2(thisArg, body) {
         var message = "".concat(timestamp, ".").concat(requestBodyString);
         var hashForVerify = createHmac('sha256', secretToken).update(message).digest('hex');
         var signature = "".concat(signaturePrefix).concat(hashForVerify);
-        var valid = vapiSignature === signature;
-        return valid;
+        return vapiSignature === signature;
     }
     var verify = verificationType === 'hmac' ? verifyHmac : verificationType === 'secret' ? verifySecret : verifyNone;
-    return function(request, rawBody) {
+    return function(request, _rawBody) {
         return _async_to_generator$2(function() {
             var requestBodyString, valid, requestBody, result;
             return _ts_generator$2(this, function(_state) {
@@ -828,7 +828,14 @@ function _class_call_check$3(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function vapiaiWebhookServiceConfigFactory(configService) {
+/**
+ * Factory that creates a VapiAiWebhookServiceConfig from environment variables.
+ *
+ * Reads the webhook secret, HMAC secret, verification type, and signature prefix from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiWebhookServiceConfig
+ */ function vapiaiWebhookServiceConfigFactory(configService) {
     var config = {
         webhookConfig: {
             secret: configService.get(VAPI_AI_WEBHOOK_SECRET_TOKEN_ENV_VAR),
@@ -840,7 +847,11 @@ function vapiaiWebhookServiceConfigFactory(configService) {
     VapiAiWebhookServiceConfig.assertValidConfig(config);
     return config;
 }
-var VapiAiWebhookModule = function VapiAiWebhookModule() {
+/**
+ * NestJS module that handles incoming Vapi AI webhook events.
+ *
+ * Provides the VapiAiWebhookService and controller for verifying and processing Vapi AI webhook payloads.
+ */ var VapiAiWebhookModule = function VapiAiWebhookModule() {
     _class_call_check$3(this, VapiAiWebhookModule);
 };
 VapiAiWebhookModule = __decorate([
@@ -987,7 +998,14 @@ function _class_call_check(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function vapiaiServiceConfigFactory(configService) {
+/**
+ * Factory that creates a VapiAiServiceConfig from environment variables.
+ *
+ * Reads the Vapi AI secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiServiceConfig
+ */ function vapiaiServiceConfigFactory(configService) {
     var config = {
         vapiai: {
             config: {
@@ -998,7 +1016,11 @@ function vapiaiServiceConfigFactory(configService) {
     VapiAiServiceConfig.assertValidConfig(config);
     return config;
 }
-var VapiAiModule = function VapiAiModule() {
+/**
+ * NestJS module that provides the VapiAiApi service.
+ *
+ * Reads the Vapi AI secret token from environment variables for API authentication.
+ */ var VapiAiModule = function VapiAiModule() {
     _class_call_check(this, VapiAiModule);
 };
 VapiAiModule = __decorate([

package/vapiai/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/nestjs/vapiai",
-  "version": "13.4.0",
+  "version": "13.4.1",
   "peerDependencies": {
-    "@dereekb/date": "13.4.0",
-    "@dereekb/model": "13.4.0",
-    "@dereekb/nestjs": "13.4.0",
-    "@dereekb/rxjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
+    "@dereekb/date": "13.4.1",
+    "@dereekb/model": "13.4.1",
+    "@dereekb/nestjs": "13.4.1",
+    "@dereekb/rxjs": "13.4.1",
+    "@dereekb/util": "13.4.1",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",
     "@vapi-ai/server-sdk": "^0.11.0",

package/vapiai/src/lib/vapiai.api.d.ts

@@ -1,6 +1,6 @@
 import { VapiClient } from '@vapi-ai/server-sdk';
 import { VapiAiServiceConfig } from './vapiai.config';
-import { type VapiCallWithTranscript } from './vapiai.type';
+import { type VapiCallId, type VapiCallWithTranscript } from './vapiai.type';
 export declare class VapiAiApi {
     readonly config: VapiAiServiceConfig;
     readonly vapiClient: VapiClient;
@@ -11,5 +11,5 @@ export declare class VapiAiApi {
      * @param callId
      * @returns
      */
-    getCall(callId: string): Promise<VapiCallWithTranscript>;
+    getCall(callId: VapiCallId): Promise<VapiCallWithTranscript>;
 }

package/vapiai/src/lib/vapiai.module.d.ts

@@ -1,5 +1,18 @@
 import { ConfigService } from '@nestjs/config';
 import { VapiAiServiceConfig } from './vapiai.config';
+/**
+ * Factory that creates a VapiAiServiceConfig from environment variables.
+ *
+ * Reads the Vapi AI secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiServiceConfig
+ */
 export declare function vapiaiServiceConfigFactory(configService: ConfigService): VapiAiServiceConfig;
+/**
+ * NestJS module that provides the VapiAiApi service.
+ *
+ * Reads the Vapi AI secret token from environment variables for API authentication.
+ */
 export declare class VapiAiModule {
 }

package/vapiai/src/lib/webhook/webhook.vapiai.module.d.ts

@@ -1,5 +1,18 @@
 import { VapiAiWebhookServiceConfig } from './webhook.vapi.config';
 import { ConfigService } from '@nestjs/config';
+/**
+ * Factory that creates a VapiAiWebhookServiceConfig from environment variables.
+ *
+ * Reads the webhook secret, HMAC secret, verification type, and signature prefix from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated VapiAiWebhookServiceConfig
+ */
 export declare function vapiaiWebhookServiceConfigFactory(configService: ConfigService): VapiAiWebhookServiceConfig;
+/**
+ * NestJS module that handles incoming Vapi AI webhook events.
+ *
+ * Provides the VapiAiWebhookService and controller for verifying and processing Vapi AI webhook payloads.
+ */
 export declare class VapiAiWebhookModule {
 }

package/vapiai/src/lib/webhook/webhook.vapiai.verify.d.ts

@@ -37,9 +37,11 @@ export interface VapiAiWebhookEventVerificationResult {
  */
 export type VapiAiWebhookEventVerifier = (req: Request, rawBody: Buffer) => Promise<VapiAiWebhookEventVerificationResult>;
 /**
- * Verifies a VapiAi webhook event header.
+ * Creates a verifier for Vapi AI webhook events.
  *
- * @param vapiSecretTokenGetter The VapiAi secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a VapiAi webhook event.
+ * Supports secret token, HMAC SHA-256, and no-op verification modes based on the provided configuration.
+ *
+ * @param config - the verification configuration including secret tokens, verification type, and signature prefix
+ * @returns a VapiAiWebhookEventVerifier function that validates incoming webhook requests
  */
 export declare function vapiAiWebhookEventVerifier(config: VapiApiWebhookEventVerificationConfig): VapiAiWebhookEventVerifier;