@dereekb/nestjs 13.4.0 → 13.4.2

package/mailgun/src/lib/mailgun.d.ts

@@ -8,7 +8,7 @@ export type MailgunTemplateKey = string;
  *
  * Each value is converted to a JSON string before being sent to Mailgun server.
  */
-export type MailgunTemplateVariables = Record<string, any>;
+export type MailgunTemplateVariables = Record<string, unknown>;
 export interface MailgunRecipient extends NameEmailPair {
     readonly userVariables?: Maybe<MailgunTemplateVariables>;
 }
@@ -152,14 +152,14 @@ export interface MailgunTemplateEmailRequestFinalizeRecipientVariablesFunctionIn
  *
  * Can directly modify the input object or return a new object to replace the recipient variables
  */
-export type MailgunTemplateEmailRequestFinalizeRecipientVariablesFunction = (recipientVariables: Record<EmailAddress, Record<string, any>>, input: MailgunTemplateEmailRequestFinalizeRecipientVariablesFunctionInput) => Maybe<Record<EmailAddress, Record<string, any>>>;
+export type MailgunTemplateEmailRequestFinalizeRecipientVariablesFunction = (recipientVariables: Record<EmailAddress, Record<string, unknown>>, input: MailgunTemplateEmailRequestFinalizeRecipientVariablesFunctionInput) => Maybe<Record<EmailAddress, Record<string, unknown>>>;
 export type MailgunEmailMessageSendResult = MessagesSendResult;
 export type MailgunAPIResponse = APIResponse;
 export declare const DEFAULT_RECIPIENT_VARIABLE_PREFIX = "recipient-";
 export declare const MAILGUN_REPLY_TO_EMAIL_HEADER_DATA_VARIABLE_KEY = "h:Reply-To";
 export interface ConvertMailgunTemplateEmailRequestToMailgunMessageDataConfig extends MailgunTemplateEmailRequestRecipientVariablesConfig {
     readonly request: MailgunTemplateEmailRequest;
-    readonly defaultSender?: string;
+    readonly defaultSender?: EmailParticipantString;
     readonly isTestingEnvironment?: boolean;
 }
 /**
@@ -167,13 +167,30 @@ export interface ConvertMailgunTemplateEmailRequestToMailgunMessageDataConfig ex
  */
 export declare const MAX_BATCH_SEND_RECIPIENTS = 1000;
 /**
- * Converts a MailgunTemplateEmailRequest to a MailgunMessageData.
+ * Converts a {@link MailgunTemplateEmailRequest} into Mailgun-compatible {@link MailgunMessageData},
+ * applying sender defaults, recipient variable prefixing, and test environment overrides.
  *
- * @param config
- * @returns
+ * @param config - The conversion configuration containing the email request, default sender, and recipient variable settings.
+ * @returns The constructed {@link MailgunMessageData} ready to be sent via the Mailgun API.
  */
 export declare function convertMailgunTemplateEmailRequestToMailgunMessageData(config: ConvertMailgunTemplateEmailRequestToMailgunMessageDataConfig): MailgunMessageData;
+/**
+ * Converts an array of MailgunRecipient objects to formatted email address strings.
+ *
+ * Each recipient is formatted as "Name <email>" when a name is present, or just the email address.
+ *
+ * @param recipients - the recipients to convert
+ * @returns an array of formatted email address strings
+ */
 export declare function convertMailgunRecipientsToStrings(recipients: MailgunRecipient[]): EmailParticipantString[];
+/**
+ * Converts a MailgunRecipient to a formatted email address string.
+ *
+ * Returns "Name <email>" when a name is present, or just the email address otherwise.
+ *
+ * @param recipient - the recipient to convert
+ * @returns a formatted email participant string
+ */
 export declare function convertMailgunRecipientToString(recipient: MailgunRecipient): EmailParticipantString;
 /**
  * Encodes a value to a string for use as a Mailgun template variable. Throws an error if the value is not supported.
@@ -181,4 +198,4 @@ export declare function convertMailgunRecipientToString(recipient: MailgunRecipi
  * @param value The value to encode.
  * @returns The encoded value, or undefined if the value is null or undefined.
  */
-export declare function encodeMailgunTemplateVariableValue(value: any): Maybe<string>;
+export declare function encodeMailgunTemplateVariableValue(value: unknown): Maybe<string>;

package/mailgun/src/lib/mailgun.service.d.ts

@@ -2,6 +2,7 @@ import { ServerEnvironmentService } from '@dereekb/nestjs';
 import { type MailgunTemplateEmailRequest, type MailgunEmailMessageSendResult } from './mailgun';
 import { MailgunApi } from './mailgun.api';
 export declare class MailgunService {
+    private readonly logger;
     private readonly _mailgunApi;
     private readonly _serverEnvironmentService;
     constructor(mailgunApi: MailgunApi, serverEnvironmentService: ServerEnvironmentService);

package/mailgun/src/lib/mailgun.service.module.d.ts

@@ -1,6 +1,21 @@
 import { ServerEnvironmentService } from '@dereekb/nestjs';
 import { ConfigService } from '@nestjs/config';
 import { MailgunServiceConfig } from './mailgun.config';
+/**
+ * Factory that creates a MailgunServiceConfig from environment variables.
+ *
+ * Automatically switches to sandbox credentials when USE_MAILGUN_SANDBOX is true or the environment is a test environment.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @param serverEnvironmentService - service indicating the current server environment
+ * @returns a validated MailgunServiceConfig
+ */
 export declare function mailgunServiceConfigFactory(configService: ConfigService, serverEnvironmentService: ServerEnvironmentService): MailgunServiceConfig;
+/**
+ * NestJS module that provides the MailgunApi and MailgunService for sending emails.
+ *
+ * Reads Mailgun credentials and sender configuration from environment variables,
+ * with automatic fallback to sandbox settings in test environments.
+ */
 export declare class MailgunServiceModule {
 }

package/mailgun/src/lib/mailgun.util.d.ts

@@ -72,6 +72,9 @@ export interface MailgunRecipientBatchSendTarget extends MailgunRecipient {
 export type MailgunRecipientBatchSendTargetFromReplyToBatchGroupKey = string;
 /**
  * Creates a composite key from the from/replyTo email addresses used to group MailgunRecipientBatchSendTarget values.
+ *
+ * @param recipient - the batch send target whose from/replyTo addresses are used as the grouping key
+ * @returns a string key in the form "f:{fromEmail}|r:{replyToEmail}" used to group recipients into batches
  */
 export declare function mailgunRecipientBatchSendTargetFromReplyToBatchGroupKey(recipient: MailgunRecipientBatchSendTarget): MailgunRecipientBatchSendTargetFromReplyToBatchGroupKey;
 /**

package/openai/index.cjs.js

@@ -66,7 +66,6 @@ var openaiEventHandlerFactory = util.handlerFactory(function(x) {
 });
 var openaiEventHandlerConfigurerFactory = util.handlerConfigurerFactory({
     configurerForAccessor: function configurerForAccessor(accessor) {
-        // eslint-disable-next-line
         var fnWithKey = util.handlerMappedSetFunctionFactory(accessor, openAIWebhookEvent);
         var configurer = _object_spread_props(_object_spread({}, accessor), {
             handleBatchCancelled: fnWithKey('batch.cancelled'),
@@ -389,13 +388,13 @@ function _ts_generator$2(thisArg, body) {
     }
 }
 /**
- * Verifies a OpenAI webhook event header.
+ * Verifies an OpenAI webhook event header using the OpenAI client's built-in signature verification.
  *
- * @param vapiSecretTokenGetter The OpenAI secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a OpenAI webhook event.
+ * @param config - The verification config containing the OpenAI webhook secret and client.
+ * @returns A function that verifies an OpenAI webhook event.
  */ function openAIWebhookEventVerifier(config) {
     var secret = config.secret, client = config.client;
-    return function(request, rawBody) {
+    return function(request, _rawBody) {
         return _async_to_generator$2(function() {
             var headers, requestBodyString, event, valid, e, result;
             return _ts_generator$2(this, function(_state) {
@@ -903,7 +902,14 @@ function _class_call_check$1(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function openAIServiceConfigFactory(configService) {
+/**
+ * Factory that creates an OpenAIServiceConfig from environment variables.
+ *
+ * Reads the API key, base URL, organization ID, and project ID from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIServiceConfig
+ */ function openAIServiceConfigFactory(configService) {
     var _configService_get;
     var config = {
         openai: {
@@ -918,7 +924,11 @@ function openAIServiceConfigFactory(configService) {
     OpenAIServiceConfig.assertValidConfig(config);
     return config;
 }
-exports.OpenAIModule = function OpenAIModule() {
+/**
+ * NestJS module that provides the OpenAIApi service.
+ *
+ * Reads the OpenAI API key, organization ID, and project ID from environment variables.
+ */ exports.OpenAIModule = function OpenAIModule() {
     _class_call_check$1(this, OpenAIModule);
 };
 exports.OpenAIModule = __decorate([
@@ -947,7 +957,14 @@ function _class_call_check(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function openAIWebhookServiceConfigFactory(configService) {
+/**
+ * Factory that creates an OpenAIWebhookServiceConfig from environment variables.
+ *
+ * Reads the OpenAI webhook secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIWebhookServiceConfig
+ */ function openAIWebhookServiceConfigFactory(configService) {
     var config = {
         openaiWebhook: {
             webhookSecret: configService.get(OPENAI_WEBHOOK_SECRET_TOKEN_ENV_VAR)
@@ -956,7 +973,11 @@ function openAIWebhookServiceConfigFactory(configService) {
     OpenAIWebhookServiceConfig.assertValidConfig(config);
     return config;
 }
-exports.OpenAIWebhookModule = function OpenAIWebhookModule() {
+/**
+ * NestJS module that handles incoming OpenAI webhook events.
+ *
+ * Provides the OpenAIWebhookService and controller for verifying and processing webhook payloads.
+ */ exports.OpenAIWebhookModule = function OpenAIWebhookModule() {
     _class_call_check(this, OpenAIWebhookModule);
 };
 exports.OpenAIWebhookModule = __decorate([
@@ -1004,7 +1025,7 @@ exports.OpenAIWebhookModule = __decorate([
     try {
         jsonResponse = JSON.parse(output_text);
         jsonResponseFieldMap = openAIJsonResponseFieldsMap(jsonResponse);
-    } catch (e) {
+    } catch (unused) {
     // ignore
     }
     return {

package/openai/index.esm.js

@@ -64,7 +64,6 @@ var openaiEventHandlerFactory = handlerFactory(function(x) {
 });
 var openaiEventHandlerConfigurerFactory = handlerConfigurerFactory({
     configurerForAccessor: function configurerForAccessor(accessor) {
-        // eslint-disable-next-line
         var fnWithKey = handlerMappedSetFunctionFactory(accessor, openAIWebhookEvent);
         var configurer = _object_spread_props(_object_spread({}, accessor), {
             handleBatchCancelled: fnWithKey('batch.cancelled'),
@@ -387,13 +386,13 @@ function _ts_generator$2(thisArg, body) {
     }
 }
 /**
- * Verifies a OpenAI webhook event header.
+ * Verifies an OpenAI webhook event header using the OpenAI client's built-in signature verification.
  *
- * @param vapiSecretTokenGetter The OpenAI secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a OpenAI webhook event.
+ * @param config - The verification config containing the OpenAI webhook secret and client.
+ * @returns A function that verifies an OpenAI webhook event.
  */ function openAIWebhookEventVerifier(config) {
     var secret = config.secret, client = config.client;
-    return function(request, rawBody) {
+    return function(request, _rawBody) {
         return _async_to_generator$2(function() {
             var headers, requestBodyString, event, valid, e, result;
             return _ts_generator$2(this, function(_state) {
@@ -901,7 +900,14 @@ function _class_call_check$1(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function openAIServiceConfigFactory(configService) {
+/**
+ * Factory that creates an OpenAIServiceConfig from environment variables.
+ *
+ * Reads the API key, base URL, organization ID, and project ID from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIServiceConfig
+ */ function openAIServiceConfigFactory(configService) {
     var _configService_get;
     var config = {
         openai: {
@@ -916,7 +922,11 @@ function openAIServiceConfigFactory(configService) {
     OpenAIServiceConfig.assertValidConfig(config);
     return config;
 }
-var OpenAIModule = function OpenAIModule() {
+/**
+ * NestJS module that provides the OpenAIApi service.
+ *
+ * Reads the OpenAI API key, organization ID, and project ID from environment variables.
+ */ var OpenAIModule = function OpenAIModule() {
     _class_call_check$1(this, OpenAIModule);
 };
 OpenAIModule = __decorate([
@@ -945,7 +955,14 @@ function _class_call_check(instance, Constructor) {
         throw new TypeError("Cannot call a class as a function");
     }
 }
-function openAIWebhookServiceConfigFactory(configService) {
+/**
+ * Factory that creates an OpenAIWebhookServiceConfig from environment variables.
+ *
+ * Reads the OpenAI webhook secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIWebhookServiceConfig
+ */ function openAIWebhookServiceConfigFactory(configService) {
     var config = {
         openaiWebhook: {
             webhookSecret: configService.get(OPENAI_WEBHOOK_SECRET_TOKEN_ENV_VAR)
@@ -954,7 +971,11 @@ function openAIWebhookServiceConfigFactory(configService) {
     OpenAIWebhookServiceConfig.assertValidConfig(config);
     return config;
 }
-var OpenAIWebhookModule = function OpenAIWebhookModule() {
+/**
+ * NestJS module that handles incoming OpenAI webhook events.
+ *
+ * Provides the OpenAIWebhookService and controller for verifying and processing webhook payloads.
+ */ var OpenAIWebhookModule = function OpenAIWebhookModule() {
     _class_call_check(this, OpenAIWebhookModule);
 };
 OpenAIWebhookModule = __decorate([
@@ -1002,7 +1023,7 @@ OpenAIWebhookModule = __decorate([
     try {
         jsonResponse = JSON.parse(output_text);
         jsonResponseFieldMap = openAIJsonResponseFieldsMap(jsonResponse);
-    } catch (e) {
+    } catch (unused) {
     // ignore
     }
     return {

package/openai/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/nestjs/openai",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "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.2",
+    "@dereekb/model": "13.4.2",
+    "@dereekb/nestjs": "13.4.2",
+    "@dereekb/rxjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",
     "express": "^5.0.0",

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

@@ -1,5 +1,18 @@
 import { ConfigService } from '@nestjs/config';
 import { OpenAIServiceConfig } from './openai.config';
+/**
+ * Factory that creates an OpenAIServiceConfig from environment variables.
+ *
+ * Reads the API key, base URL, organization ID, and project ID from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIServiceConfig
+ */
 export declare function openAIServiceConfigFactory(configService: ConfigService): OpenAIServiceConfig;
+/**
+ * NestJS module that provides the OpenAIApi service.
+ *
+ * Reads the OpenAI API key, organization ID, and project ID from environment variables.
+ */
 export declare class OpenAIModule {
 }

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

@@ -1,5 +1,18 @@
 import { OpenAIWebhookServiceConfig } from './webhook.openai.config';
 import { ConfigService } from '@nestjs/config';
+/**
+ * Factory that creates an OpenAIWebhookServiceConfig from environment variables.
+ *
+ * Reads the OpenAI webhook secret token from environment variables.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated OpenAIWebhookServiceConfig
+ */
 export declare function openAIWebhookServiceConfigFactory(configService: ConfigService): OpenAIWebhookServiceConfig;
+/**
+ * NestJS module that handles incoming OpenAI webhook events.
+ *
+ * Provides the OpenAIWebhookService and controller for verifying and processing webhook payloads.
+ */
 export declare class OpenAIWebhookModule {
 }

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

@@ -28,9 +28,9 @@ export interface OpenAIWebhookEventVerificationErrorResult {
  */
 export type OpenAIWebhookEventVerifier = (req: Request, rawBody: Buffer) => Promise<OpenAIWebhookEventVerificationResult>;
 /**
- * Verifies a OpenAI webhook event header.
+ * Verifies an OpenAI webhook event header using the OpenAI client's built-in signature verification.
  *
- * @param vapiSecretTokenGetter The OpenAI secret token. The Vapi client allows for using an AsyncGetterOrValue type, so the verifier supports that as well.
- * @returns A function that verifies a OpenAI webhook event.
+ * @param config - The verification config containing the OpenAI webhook secret and client.
+ * @returns A function that verifies an OpenAI webhook event.
  */
 export declare function openAIWebhookEventVerifier(config: OpenAIWebhookEventVerificationConfig): OpenAIWebhookEventVerifier;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/nestjs",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "types": "./src/index.d.ts",
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
@@ -50,7 +50,7 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.4.0",
+    "@dereekb/util": "13.4.2",
     "discord.js": "^14.25.1",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",

package/src/lib/decorators/local.decorator.d.ts

@@ -3,4 +3,12 @@ import { type ExecutionContext } from '@nestjs/common';
  * Returns true if the request is from localhost.
  */
 export declare const IsRequestFromLocalHost: (...dataOrPipes: unknown[]) => ParameterDecorator;
+/**
+ * Returns true if the request's origin header indicates the request came from localhost.
+ *
+ * Checks for both http://localhost and https://localhost origins.
+ *
+ * @param context - the NestJS execution context containing the HTTP request
+ * @returns true if the request origin is localhost
+ */
 export declare function isLocalhost(context: ExecutionContext): boolean;

package/src/lib/decorators/rawbody.d.ts

@@ -3,19 +3,6 @@ import { type ParsedUrlQuery } from 'querystring';
  * Buffer type alias representing a raw HTTP request body before any parsing.
  */
 export type RawBodyBuffer = Buffer;
-/**
- * NestJS parameter decorator that reads the raw request body directly from the incoming stream.
- *
- * Requires the request to still be readable (i.e., no prior body-parsing middleware has consumed it).
- *
- * @throws {BadRequestException} When the request stream is not readable
- *
- * @example
- * ```typescript
- * @Post('webhook')
- * handleWebhook(@ParseRawBody() body: RawBodyBuffer) { ... }
- * ```
- */
 export declare const ParseRawBody: (...dataOrPipes: any[]) => ParameterDecorator;
 /**
  * NestJS parameter decorator that retrieves the already-parsed raw body buffer from `req.body`.

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

@@ -1,5 +1,18 @@
 import { ConfigService } from '@nestjs/config';
 import { ClientAppServiceConfig } from './client.config';
+/**
+ * Factory that creates a ClientAppServiceConfig from environment variables.
+ *
+ * Reads the client web app URL from the CLIENT_WEB_APP_URL environment variable.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated ClientAppServiceConfig
+ */
 export declare function clientAppConfigFactory(configService: ConfigService): ClientAppServiceConfig;
+/**
+ * NestJS module that provides the ClientAppService for accessing client application configuration.
+ *
+ * Reads the client web app URL from environment variables and makes it available via ClientAppService.
+ */
 export declare class ClientAppModule {
 }

package/src/lib/module/env/env.config.d.ts

@@ -1,3 +1,4 @@
+import { type Maybe, type WebsiteUrl } from '@dereekb/util';
 /**
  * A server environment configuration.
  *
@@ -9,11 +10,11 @@ export declare abstract class ServerEnvironmentConfig {
     /**
      * Whether or not this is a production environment.
      */
-    abstract production: boolean;
+    abstract readonly production: boolean;
     /**
      * Whether or not this is a staging environment.
      */
-    abstract staging?: boolean;
+    abstract readonly staging?: boolean;
     /**
      * (Optional) Whether or not custom "developer tools" should be enabled.
      *
@@ -21,11 +22,11 @@ export declare abstract class ServerEnvironmentConfig {
      *
      * This is always false when production is true.
      */
-    abstract developerToolsEnabled?: boolean;
+    abstract readonly developerToolsEnabled?: boolean;
     /**
      * The primary URL of the application (e.g., 'https://app.example.com').
      *
      * Should not end with a trailing slash.
      */
-    abstract appUrl?: string;
+    abstract readonly appUrl?: Maybe<WebsiteUrl>;
 }

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

@@ -1,4 +1,6 @@
 /**
- * Checks process.env.NODE_ENV for "test"
+ * Checks process.env.NODE_ENV for "test".
+ *
+ * @returns true if the current Node environment is "test", false otherwise
  */
 export declare function isTestNodeEnv(): boolean;

package/src/lib/module/env/env.nest.d.ts

@@ -4,4 +4,12 @@ import { type ServerEnvironmentConfig } from './env.config';
  * Token to access a configured ServerEnvironmentServiceConfig for the app.
  */
 export declare const SERVER_ENV_TOKEN: InjectionToken;
+/**
+ * Creates a NestJS Provider that supplies a ServerEnvironmentConfig under the SERVER_ENV_TOKEN injection token.
+ *
+ * Use this to register a server environment configuration instance with the NestJS dependency injection container.
+ *
+ * @param env - the server environment config to provide
+ * @returns a NestJS Provider that supplies the config under SERVER_ENV_TOKEN
+ */
 export declare function serverEnvTokenProvider<T extends ServerEnvironmentConfig = ServerEnvironmentConfig>(env: T): Provider;

package/src/lib/module/env/env.service.d.ts

@@ -1,3 +1,4 @@
+import { type Maybe, type WebsiteUrl } from '@dereekb/util';
 import { type ServerEnvironmentConfig } from './env.config';
 export declare class ServerEnvironmentService {
     readonly env: ServerEnvironmentConfig;
@@ -6,5 +7,5 @@ export declare class ServerEnvironmentService {
     get isProduction(): boolean;
     get isStaging(): boolean;
     get developerToolsEnabled(): boolean;
-    get appUrl(): string | undefined;
+    get appUrl(): Maybe<WebsiteUrl>;
 }

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

@@ -4,9 +4,17 @@ export type AdditionalModuleMetadata = Partial<ModuleMetadata>;
 /**
  * Merges two module metadata entries together.
  *
- * @param base
- * @param additional
- * @returns
+ * @param base - the base module metadata
+ * @param additional - additional metadata to merge in
+ * @returns the merged module metadata
  */
 export declare function mergeModuleMetadata(base: ModuleMetadata, additional?: AdditionalModuleMetadata): ModuleMetadata;
+/**
+ * Extracts the injection tokens from an array (or single value) of NestJS Providers.
+ *
+ * For class providers, returns the class itself; for object providers, returns the provide token.
+ *
+ * @param providers - the providers to extract tokens from
+ * @returns an array of injection tokens
+ */
 export declare function injectionTokensFromProviders(providers: ArrayOrValue<Provider<unknown>>): InjectionToken[];

package/src/lib/util/encryption/json.encrypt.d.ts

@@ -6,6 +6,9 @@ export type AES256GCMEncryptionSecret = string;
 /**
  * Validates that the given secret is a 64-character hexadecimal string (32 bytes for AES-256).
  *
+ * @param secret - the hex-encoded secret key string to validate
+ * @returns true if the secret is exactly 64 valid hex characters, false otherwise
+ *
  * @example
  * ```typescript
  * isValidAES256GCMEncryptionSecret('a'.repeat(64)); // true

package/stripe/index.cjs.js

@@ -73,15 +73,22 @@ exports.StripeWebhookEventType = void 0;
 /**
  * Creates a StripeWebhookEvent and treats the data as the input type.
  *
- * @param event
- * @returns
+ * @param event - the raw Stripe event
+ * @returns a typed StripeWebhookEvent
  */ function stripeWebhookEvent(event) {
     return {
         event: event,
         data: event.data.object
     };
 }
-function stripeWebhookEventMapper(mapFn) {
+/**
+ * Creates a mapper function that transforms a raw Stripe.Event into a StripeWebhookEvent using the provided mapping function.
+ *
+ * Use this when the event data object needs custom transformation before being wrapped in a StripeWebhookEvent.
+ *
+ * @param mapFn - function to transform the event data object
+ * @returns a function that converts a raw Stripe.Event into a StripeWebhookEvent
+ */ function stripeWebhookEventMapper(mapFn) {
     return function(event) {
         return {
             event: event,
@@ -94,7 +101,6 @@ var stripeEventHandlerFactory = util.handlerFactory(function(x) {
 });
 var stripeEventHandlerConfigurerFactory = util.handlerConfigurerFactory({
     configurerForAccessor: function configurerForAccessor(accessor) {
-        // eslint-disable-next-line
         var fnWithKey = util.handlerMappedSetFunctionFactory(accessor, stripeWebhookEvent);
         var configurer = _object_spread_props(_object_spread({}, accessor), {
             handleCheckoutSessionComplete: fnWithKey(exports.StripeWebhookEventType.CHECKOUT_SESSION_COMPLETED),
@@ -220,7 +226,11 @@ function _define_property$2(obj, key, value) {
     }
     return obj;
 }
-exports.StripeApi = /*#__PURE__*/ function() {
+/**
+ * Injectable service that wraps the Stripe SDK for payment operations.
+ *
+ * Provides methods for constructing and verifying Stripe webhook events.
+ */ exports.StripeApi = /*#__PURE__*/ function() {
     function StripeApi(config) {
         _class_call_check$4(this, StripeApi);
         _define_property$2(this, "config", void 0);
@@ -232,7 +242,12 @@ exports.StripeApi = /*#__PURE__*/ function() {
         {
             // MARK: Event
             /**
-     * Verifies the event and reads the stripe signature from a request.
+     * Verifies the Stripe signature and constructs a Stripe.Event from an incoming webhook request.
+     *
+     * @param req - the incoming Express request containing the stripe-signature header
+     * @param rawBody - the raw request body buffer required for signature verification
+     * @returns the verified and parsed Stripe.Event
+     * @throws {BadRequestException} when the stripe-signature header is missing or verification fails
      */ key: "readStripeEventFromWebhookRequest",
             value: function readStripeEventFromWebhookRequest(req, rawBody) {
                 var signature = req.get('stripe-signature');
@@ -243,7 +258,7 @@ exports.StripeApi = /*#__PURE__*/ function() {
                 try {
                     event = this.stripe.webhooks.constructEvent(rawBody, signature, this.config.stripe.webhookSecret);
                 } catch (e) {
-                    throw new common.BadRequestException("stripe signature read error: ".concat(e === null || e === void 0 ? void 0 : e.message));
+                    throw new common.BadRequestException("stripe signature read error: ".concat(e.message));
                 }
                 return event;
             }
@@ -682,7 +697,14 @@ function _class_call_check$1(instance, Constructor) {
     }
 }
 var STRIPE_DEFAULT_API_VERSION = '2020-08-27';
-function stripeServiceConfigFactory(configService) {
+/**
+ * Factory that creates a StripeServiceConfig from environment variables.
+ *
+ * Reads STRIPE_SECRET and STRIPE_WEBHOOK_SECRET from environment variables using the default API version.
+ *
+ * @param configService - NestJS config service for reading environment variables
+ * @returns a validated StripeServiceConfig
+ */ function stripeServiceConfigFactory(configService) {
     var config = {
         stripe: {
             secret: configService.get('STRIPE_SECRET'),
@@ -695,7 +717,11 @@ function stripeServiceConfigFactory(configService) {
     StripeServiceConfig.assertValidConfig(config);
     return config;
 }
-exports.StripeModule = function StripeModule() {
+/**
+ * NestJS module that provides the StripeApi service.
+ *
+ * Reads Stripe API credentials and webhook secret from environment variables.
+ */ exports.StripeModule = function StripeModule() {
     _class_call_check$1(this, StripeModule);
 };
 exports.StripeModule = __decorate([