@pristine-ts/aws 0.0.209 → 0.0.210

package/dist/types/clients/s3.client.d.ts

@@ -2,18 +2,81 @@ import { LogHandlerInterface } from "@pristine-ts/logging";
 import { S3ClientInterface } from "../interfaces/s3-client.interface";
 import { GetObjectCommandOutput, S3Client as AWSS3Client } from "@aws-sdk/client-s3";
 import { S3PresignedOperationTypeEnum } from "../enums/s3-presigned-operation-type.enum";
+/**
+ * The client to use to interact with AWS S3. It is a wrapper around the AWSS3Client of @aws-sdk/client-s3.
+ * It is tagged so it can be injected using S3ClientInterface.
+ */
 export declare class S3Client implements S3ClientInterface {
     private readonly logHandler;
     private readonly region;
+    /**
+     * The instantiated client from the @aws-sdk/client-s3 library.
+     * @private
+     */
     private client;
+    /**
+     * The client to use to interact with AWS S3. It is a wrapper around the AWSS3Client of @aws-sdk/client-s3.
+     * @param logHandler The log handler used to output logs.
+     * @param region The aws region for which the client will be used.
+     */
     constructor(logHandler: LogHandlerInterface, region: string);
+    /**
+     * Returns the instantiated AWSS3Client from the @aws-sdk/client-s3 library
+     */
     getClient(): AWSS3Client;
+    /**
+     * Gets an object and all its details from S3.
+     * @param bucketName The bucket name where to get the object.
+     * @param key The key of the object.
+     */
     get(bucketName: string, key: string): Promise<GetObjectCommandOutput>;
+    /**
+     * Gets an object's body as an array buffer from S3.
+     * @param bucketName The bucket name where to get the object.
+     * @param key The key of the object.
+     */
     getObjectBodyAsArrayBuffer(bucketName: string, key: string): Promise<ArrayBuffer>;
+    /**
+     * Lists the keys of a bucket.
+     * @param bucketName The name of the bucket.
+     */
     listKeys(bucketName: string): Promise<string[]>;
+    /**
+     * Lists the object of a bucket.
+     * @param bucketName The name of the bucket.
+     */
     listObjects(bucketName: string): Promise<any[]>;
+    /**
+     * Uploads an object to a bucket of S3.
+     * @param bucketName The name of the bucket.
+     * @param key The key for the new object.
+     * @param data The data to upload.
+     * @param contentEncoding The encoding of the data to upload.
+     * @param contentType The content type of the data to upload.
+     */
     upload(bucketName: string, key: string, data: any, contentEncoding?: string, contentType?: string): Promise<void>;
+    /**
+     * Creates a pre signed url to allow a third party to take action on S3.
+     * @param bucketName The name of the bucket.
+     * @param key The key for the object on which the action will be allowed.
+     * @param operation The operation that will be allowed.
+     * @param fileName If operation is Get, then a filename can be provided for the name of the file that will be downloaded.
+     * @param expiresIn The amount on time in seconds before the pre signed url expires.
+     */
     createSignedUrl(bucketName: string, key: string, operation: S3PresignedOperationTypeEnum, fileName?: string, expiresIn?: number): Promise<string>;
+    /**
+     * Creates the S3 command for a pre signed url.
+     * @param operation The operation that the pre signed url will allow.
+     * @param bucketName The name of the bucket.
+     * @param key The key for the object on which the action will be allowed.
+     * @param fileName If operation is Get, then a filename can be provided for the name of the file that will be downloaded.
+     * @private
+     */
     private getCommandForPresign;
+    /**
+     * Transforms a stream to an array buffer.
+     * @param stream The stream to transform.
+     * @private
+     */
     private streamToArrayBuffer;
 }

package/dist/types/clients/sqs.client.d.ts

@@ -1,17 +1,32 @@
 import { LogHandlerInterface } from "@pristine-ts/logging";
+import { SQSClient } from "@aws-sdk/client-sqs";
 import { SqsMessageSentConfirmationModel } from "../models/sqs-message-sent-confirmation.model";
 import { SqsClientInterface } from "../interfaces/sqs-client.interface";
+/**
+ * The client to use to interact with AWS SQS. It is a wrapper around the SQSClient of @aws-sdk/client-sqs.
+ * It is tagged so it can be injected using SqsClientInterface.
+ */
 export declare class SqsClient implements SqsClientInterface {
     private readonly logHandler;
     private readonly region;
+    /**
+     * The client to use to interact with AWS SQS. It is a wrapper around the SQSClient of @aws-sdk/client-sqs.
+     * @param logHandler The log handler used to output logs.
+     * @param region The aws region for which the client will be used.
+     */
     constructor(logHandler: LogHandlerInterface, region: string);
+    /**
+     * Returns the instantiated SQSClient from the @aws-sdk/client-sqs library.
+     * @param endpoint The endpoint for which the SQS client is created.
+     */
+    getClient(endpoint?: string): SQSClient;
     /**
      * Sends a message to the specified Queue URL.
-     * @param queueUrl
-     * @param body
-     * @param messageGroupId
-     * @param delaySeconds
-     * @param endpoint
+     * @param queueUrl The queue url where to send the message.
+     * @param body The body of the message to send in the queue.
+     * @param messageGroupId The message group id for FIFO queues.
+     * @param delaySeconds The length of time, in seconds, for which to delay a specific message.
+     * @param endpoint The endpoint for SQS.
      */
     send(queueUrl: string, body: string, messageGroupId?: string, delaySeconds?: number, endpoint?: string): Promise<SqsMessageSentConfirmationModel>;
 }

package/dist/types/decorators/dynamic-table-name.decorator.d.ts

@@ -1,4 +1,7 @@
 import { DynamicTableNameModel } from "../models/dynamic-table-name.model";
+/**
+ * The registry where the table names used for DynamoDb are saved.
+ */
 export declare const dynamicTableNameRegistry: DynamicTableNameModel[];
 /**
  * This decorator is to be put on a class that will be used with DynamoDb.

package/dist/types/enums/event-bridge-event-type.enum.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Event types coming from Event Bridge.
+ */
 export declare enum EventBridgeEventTypeEnum {
     ScheduledEvent = "SCHEDULED_EVENT",
     Event = "EVENT_BRIDGE_EVENT"

package/dist/types/errors/dynamodb-item-already-exists.error.d.ts

@@ -1,7 +1,13 @@
+import { DynamodbError } from "./dynamodb.error";
 /**
- * This Error represents a Dynamodb error when the item already exists.
+ * This Error is for when an item already exists in DynamoDB.
  */
-import { DynamodbError } from "./dynamodb.error";
 export declare class DynamodbItemAlreadyExistsError extends DynamodbError {
+    /**
+     * This Error is for when an item already exists in DynamoDB.
+     * @param originalError The original error that was caught.
+     * @param tableName The name of the DynamoDB table where the error happened.
+     * @param primaryKey The primary key of the item that caused the error.
+     */
     constructor(originalError?: Error, tableName?: string, primaryKey?: string);
 }

package/dist/types/errors/dynamodb-item-not-found.error.d.ts

@@ -1,7 +1,17 @@
+import { DynamodbError } from "./dynamodb.error";
 /**
- * This Error represents a Dynamodb error when the item is not found.
+ * This Error is for when an item is not found in the DynamoDB table.
+ * This error is not exported outside of this module as it should not be used.
+ * When an item is not found it should not throw an error but rather return null.
  */
-import { DynamodbError } from "./dynamodb.error";
 export declare class DynamodbItemNotFoundError extends DynamodbError {
+    /**
+     * This Error is for when an item is not found in the DynamoDB table.
+     * This error is not exported outside of this module as it should not be used.
+     * When an item is not found it should not throw an error but rather return null.
+     * @param originalError The original error that was caught.
+     * @param tableName The name of the DynamoDB table where the error happened.
+     * @param primaryKey The primary key of the item that caused the error.
+     */
     constructor(originalError?: Error, tableName?: string, primaryKey?: string);
 }

package/dist/types/errors/dynamodb-table-not-found.error.d.ts

@@ -1,7 +1,12 @@
+import { DynamodbError } from "./dynamodb.error";
 /**
  * This Error represents a Dynamodb error when the table is not found.
  */
-import { DynamodbError } from "./dynamodb.error";
 export declare class DynamodbTableNotFoundError extends DynamodbError {
+    /**
+     * This Error represents a Dynamodb error when the table is not found.
+     * @param originalError The original error that was caught.
+     * @param tableName The table name that does not exist.
+     */
     constructor(originalError?: Error, tableName?: string);
 }

package/dist/types/errors/dynamodb-validation.error.d.ts

@@ -1,7 +1,13 @@
+import { DynamodbError } from "./dynamodb.error";
 /**
  * This Error represents a Dynamodb error when there is a validation error.
  */
-import { DynamodbError } from "./dynamodb.error";
 export declare class DynamodbValidationError extends DynamodbError {
+    /**
+     *  This Error represents a Dynamodb error when there is a validation error.
+     * @param originalError The original error that was caught.
+     * @param tableName The name of the DynamoDB table where the error happened.
+     * @param primaryKey The primary key of the item that caused the error.
+     */
     constructor(originalError?: Error, tableName?: string, primaryKey?: string);
 }

package/dist/types/errors/dynamodb.error.d.ts

@@ -1,10 +1,17 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
- * This Error represents a 404 error.
+ * This Error is the base class for DynamoDB errors.
  */
-import { LoggableError } from "@pristine-ts/common";
 export declare class DynamodbError extends LoggableError {
     readonly originalError?: Error | undefined;
     readonly tableName?: string | undefined;
     readonly primaryKey?: string | undefined;
+    /**
+     * This Error is the base class for DynamoDB errors.
+     * @param message The message of the error.
+     * @param originalError The original error that was caught.
+     * @param tableName The name of the DynamoDB table where the error happened.
+     * @param primaryKey The primary key of the item that caused the error.
+     */
     constructor(message?: string, originalError?: Error | undefined, tableName?: string | undefined, primaryKey?: string | undefined);
 }

package/dist/types/errors/event-bridge-send-message.error.d.ts

@@ -1,7 +1,11 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error represents an error when trying to send a message to Sqs
  */
-import { LoggableError } from "@pristine-ts/common";
 export declare class EventBridgeSendMessageError extends LoggableError {
+    /**
+     * This Error represents an error when trying to send a message to Sqs
+     * @param originalError The original error that was caught.
+     */
     constructor(originalError?: Error);
 }

package/dist/types/errors/sqs-send-message.error.d.ts

@@ -1,7 +1,15 @@
+import { LoggableError } from "@pristine-ts/common";
 /**
  * This Error represents an error when trying to send a message to Sqs
  */
-import { LoggableError } from "@pristine-ts/common";
 export declare class SqsSendMessageError extends LoggableError {
+    /**
+     * This Error represents an error when trying to send a message to Sqs
+     * @param originalError The original error that was caught.
+     * @param queueUrl The url of the queue where the message was trying to be sent.
+     * @param body The body trying to be sent.
+     * @param messageGroupId The message group id (used for FIFO queues) of the message trying to be sent.
+     * @param delaySeconds The delay set for the message trying to be sent.
+     */
     constructor(originalError?: Error, queueUrl?: string, body?: string, messageGroupId?: string, delaySeconds?: number);
 }

package/dist/types/errors/ssm-resolver.error.d.ts

@@ -3,5 +3,11 @@ import { LoggableError } from "@pristine-ts/common";
  * This Error represents an error when resolving in SSM.
  */
 export declare class SSMResolverError extends LoggableError {
+    /**
+     * This Error represents an error when resolving in SSM.
+     * @param message The error message.
+     * @param value The value trying to be resolved.
+     * @param originalError The original error that was caught.
+     */
     constructor(message: string, value: any, originalError?: any);
 }

package/dist/types/event-payloads/event-bridge.payload.d.ts

@@ -1,3 +1,6 @@
+/**
+ * The Pristine event payload type of a parsed Event Bridge event
+ */
 export declare class EventBridgePayload {
     id: string;
     detailType: string;

package/dist/types/interfaces/dynamodb-client.interface.d.ts

@@ -6,6 +6,7 @@ import { FindBySecondaryIndexOptions } from "../options/find-by-secondary-index.
 import { ListResult } from "../results/list.result";
 /**
  * The DynamodbClient Interface defines the methods that a Dynamodb Client must implement.
+ * When injecting the Dynamodb client the 'DynamodbClientInterface' tag should be used.
  */
 export interface DynamodbClientInterface {
     /**

package/dist/types/interfaces/event-bridge-client.interface.d.ts

@@ -1,4 +1,20 @@
 import { EventBridgeMessageModel } from "../models/event-bridge-message.model";
+import { EventBridgeClient as AwsEventBridgeClient } from "@aws-sdk/client-eventbridge";
+/**
+ * The EventBridgeClient Interface defines the methods that an Event bridge client must implement.
+ * When injecting the event bridge client the 'EventBridgeClientInterface' tag should be used.
+ */
 export interface EventBridgeClientInterface {
+    /**
+     * Returns the instantiated AwsEventBridgeClient from the @aws-sdk/client-eventbridge library.
+     * @param endpoint The endpoint for which the Event Bridge client is created.
+     */
+    getClient(endpoint?: string): AwsEventBridgeClient;
+    /**
+     * Sends an event to event bridge.
+     * @param eventBridgeMessages The messages to send to event bridge.
+     * @param eventBusName The event bus name where to send the messages.
+     * @param endpoint The endpoint for event bridge.
+     */
     send(eventBridgeMessages: EventBridgeMessageModel | EventBridgeMessageModel[], eventBusName: string, endpoint?: string): Promise<void>;
 }

package/dist/types/interfaces/s3-client.interface.d.ts

@@ -1,11 +1,52 @@
 import { S3PresignedOperationTypeEnum } from "../enums/s3-presigned-operation-type.enum";
 import { GetObjectCommandOutput, S3Client as AWSS3Client } from "@aws-sdk/client-s3";
+/**
+ * The S3Client Interface defines the methods that an S3 client must implement.
+ * When injecting the S3 client the 'S3ClientInterface' tag should be used.
+ */
 export interface S3ClientInterface {
+    /**
+     * Returns the instantiated AWSS3Client from the @aws-sdk/client-s3 library
+     */
     getClient(): AWSS3Client;
+    /**
+     * Gets an object and all its details from S3.
+     * @param bucketName The bucket name where to get the object.
+     * @param key The key of the object.
+     */
     get(bucketName: string, key: string): Promise<GetObjectCommandOutput>;
+    /**
+     * Gets an object's body as an array buffer from S3.
+     * @param bucketName The bucket name where to get the object.
+     * @param key The key of the object.
+     */
     getObjectBodyAsArrayBuffer(bucketName: string, key: string): Promise<ArrayBuffer>;
+    /**
+     * Lists the keys of a bucket.
+     * @param bucketName The name of the bucket.
+     */
     listKeys(bucketName: string): Promise<string[]>;
+    /**
+     * Lists the object of a bucket.
+     * @param bucketName The name of the bucket.
+     */
     listObjects(bucketName: string): Promise<any[]>;
+    /**
+     * Uploads an object to a bucket of S3.
+     * @param bucketName The name of the bucket.
+     * @param key The key for the new object.
+     * @param data The data to upload.
+     * @param contentEncoding The encoding of the data to upload.
+     * @param contentType The content type of the data to upload.
+     */
     upload(bucketName: string, key: string, data: any, contentEncoding?: string, contentType?: string): Promise<void>;
+    /**
+     * Creates a pre signed url to allow a third party to take action on S3.
+     * @param bucketName The name of the bucket.
+     * @param key The key for the object on which the action will be allowed.
+     * @param operation The operation that will be allowed.
+     * @param fileName If operation is Get, then a filename can be provided for the name of the file that will be downloaded.
+     * @param expiresIn The amount on time in seconds before the pre signed url expires.
+     */
     createSignedUrl(bucketName: string, key: string, operation: S3PresignedOperationTypeEnum, fileName?: string, expiresIn?: number): Promise<string>;
 }

package/dist/types/interfaces/sqs-client.interface.d.ts

@@ -1,4 +1,22 @@
 import { SqsMessageSentConfirmationModel } from "../models/sqs-message-sent-confirmation.model";
+import { SQSClient } from "@aws-sdk/client-sqs";
+/**
+ * The S3Client Interface defines the methods that an S3 client must implement.
+ * When injecting the S3 client the 'S3ClientInterface' tag should be used.
+ */
 export interface SqsClientInterface {
+    /**
+     * Returns the instantiated SQSClient from the @aws-sdk/client-sqs library.
+     * @param endpoint The endpoint for which the SQS client is created.
+     */
+    getClient(endpoint?: string): SQSClient;
+    /**
+     * Sends a message to the specified Queue URL.
+     * @param queueUrl The queue url where to send the message.
+     * @param body The body of the message to send in the queue.
+     * @param messageGroupId The message group id for FIFO queues.
+     * @param delaySeconds The length of time, in seconds, for which to delay a specific message.
+     * @param endpoint The endpoint for SQS.
+     */
     send(queueUrl: string, body: string, messageGroupId?: string, delaySeconds?: number, endpoint?: string): Promise<SqsMessageSentConfirmationModel>;
 }

package/dist/types/mappers/dynamodb-event.mapper.d.ts

@@ -1,5 +1,10 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { DynamodbEventPayload } from "../event-payloads/dynamodb.event-payload";
+/**
+ * Mapper to map the DynamoDb event into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class DynamodbEventMapper implements EventMapperInterface<DynamodbEventPayload, void> {
     /**
      * Finds the enum value corresponding to the event name.
@@ -20,12 +25,27 @@ export declare class DynamodbEventMapper implements EventMapperInterface<Dynamod
      */
     map(rawEvent: any, executionContext: ExecutionContextInterface<any>): EventsExecutionOptionsInterface<DynamodbEventPayload>;
     /**
-     * Determines if the parser supports the event.
+     * Determines if the parser supports mapping the raw event to a Pristine event.
+     * This mapper only supports raw Dynamodb events.
      * @param event The event to verify if the parser supports.
      * @param executionContext The ExecutionContext from where the event is triggered. It can easily be used to determine
      * where the current service is hosted.
      */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<DynamodbEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to a Dynamodb response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<DynamodbEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/mappers/event-bridge-event.mapper.d.ts

@@ -1,8 +1,39 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { EventBridgePayload } from "../event-payloads/event-bridge.payload";
+/**
+ * Mapper to map the Event bridge event into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class EventBridgeEventMapper implements EventMapperInterface<EventBridgePayload, void> {
+    /**
+     * Maps the Event bridge raw event into a Pristine event.
+     * @param rawEvent The raw Event bridge event
+     * @param executionContext The ExecutionContext from where the event is triggered.
+     */
     map(rawEvent: any, executionContext: ExecutionContextInterface<any>): EventsExecutionOptionsInterface<EventBridgePayload>;
+    /**
+     * Determines if the parser supports mapping the raw event to a Pristine event.
+     * This mapper only supports raw Event Bridge events.
+     * @param event The event to verify if the parser supports.
+     * @param executionContext The ExecutionContext from where the event is triggered. It can easily be used to determine
+     * where the current service is hosted.
+     */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<EventBridgePayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to an Event Bridge response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<EventBridgePayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/mappers/kafka-event.mapper.d.ts

@@ -1,5 +1,10 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { KafkaEventPayload } from "../event-payloads/kafka.event-payload";
+/**
+ * Mapper to map the Kafka event from the AWS kafka connector into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class KafkaEventMapper implements EventMapperInterface<KafkaEventPayload, void> {
     /**
      * Parses the Kafka event from the AWS kafka connector into a Pristine event.
@@ -15,6 +20,20 @@ export declare class KafkaEventMapper implements EventMapperInterface<KafkaEvent
      * where the current service is hosted.
      */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<KafkaEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to a Kafka event response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<KafkaEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/mappers/s3-event.mapper.d.ts

@@ -1,5 +1,10 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { S3EventPayload } from "../event-payloads/s3.event-payload";
+/**
+ * Mapper to map the S3 event into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class S3EventMapper implements EventMapperInterface<S3EventPayload, void> {
     /**
      * Finds the enum value corresponding to the event name.
@@ -21,6 +26,20 @@ export declare class S3EventMapper implements EventMapperInterface<S3EventPayloa
      * where the current service is hosted.
      */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<S3EventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to an S3 event response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<S3EventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/mappers/sns-event.mapper.d.ts

@@ -1,5 +1,10 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { SnsEventPayload } from "../event-payloads/sns.event-payload";
+/**
+ * Mapper to map the Sns event into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class SnsEventMapper implements EventMapperInterface<SnsEventPayload, void> {
     /**
      * Finds the enum value corresponding to the event name.
@@ -21,6 +26,20 @@ export declare class SnsEventMapper implements EventMapperInterface<SnsEventPayl
      * where the current service is hosted.
      */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<SnsEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to an Sns event response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<SnsEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/mappers/sqs-event.mapper.d.ts

@@ -1,5 +1,10 @@
 import { EventMapperInterface, EventResponse, ExecutionContextInterface, EventsExecutionOptionsInterface } from "@pristine-ts/core";
 import { SqsEventPayload } from "../event-payloads/sqs.event-payload";
+/**
+ * Mapper to map the Sqs event into a Pristine event.
+ * It is tagged as an ServiceDefinitionTagEnum.EventMapper so that it can be injected with all the other event mappers.
+ * It is module scoped so that it gets injected only if the AWS module is imported.
+ */
 export declare class SqsEventMapper implements EventMapperInterface<SqsEventPayload, void> {
     /**
      * Parses the SQS event into a Pristine event.
@@ -15,6 +20,20 @@ export declare class SqsEventMapper implements EventMapperInterface<SqsEventPayl
      * where the current service is hosted.
      */
     supportsMapping(event: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Determines if the parser supports mapping the Pristine event to an event response.
+     * For now it does not support a response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     supportsReverseMapping(eventResponse: EventResponse<SqsEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): boolean;
+    /**
+     * Reverse maps the Pristine event into an event response.
+     * For now it does not mapping a Pristine event to an Sqs event response.
+     * @param eventResponse The event response.
+     * @param response The response.
+     * @param executionContext The execution context of the event.
+     */
     reverseMap(eventResponse: EventResponse<SqsEventPayload, void>, response: any, executionContext: ExecutionContextInterface<any>): void;
 }

package/dist/types/models/event-bridge-message.model.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Model representing an Event bridge message.
+ */
 export declare class EventBridgeMessageModel {
     resources: string[];
     detailType: string;

package/dist/types/models/models.d.ts

@@ -1,6 +1,7 @@
 export * from "./dynamic-table-name.model";
 export * from "./dynamodb.model";
 export * from "./dynamodb-keys.model";
+export * from "./event-bridge-message.model";
 export * from "./identity.model";
 export * from "./kafka-message.model";
 export * from "./request-parameters.model";

package/dist/types/models/sqs-message-sent-confirmation.model.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Model representing the confirmation when an Sqs message is properly sent.
+ */
 export declare class SqsMessageSentConfirmationModel {
     messageId?: string;
 }