mblabs-roccato-backend-commons 1.0.7 → 1.1.0

package/src/interfaces/sendgrid.ts

@@ -5,26 +5,24 @@ interface Credentials {
 export namespace Sendgrid {
   export namespace SendMail {
     export interface Request {
-      data: {
-        to: string;
-        from: string;
-        subject?: string;
-        text?: string;
-        html?: string;
-        template?: string;
-        substitutions?: Record<string, unknown>;
-        attachments?: {
-          content: string;
-          filename: string;
-          type?: string;
-          disposition?: string;
-        }[];
-      };
+      to: string;
+      from: string;
+      subject?: string;
+      text?: string;
+      html?: string;
+      template?: string;
+      substitutions?: Record<string, unknown>;
+      attachments?: {
+        content: string;
+        filename: string;
+        type?: string;
+        disposition?: string;
+      }[];
       credentials: Credentials;
     }
   }
 }
 
 export interface ISendgridService {
-  sendMail(req: Sendgrid.SendMail.Request): Promise<void>;
+  sendMail (req: Sendgrid.SendMail.Request): Promise<void>;
 }

package/src/services/aws/cloudwatch.ts

@@ -3,105 +3,105 @@ import { CloudWatchLogs } from '@aws-sdk/client-cloudwatch-logs';
 import { AmazonCloudwatch, IAmazonCloudwatchService } from '../../interfaces/aws';
 
 class AmazonCloudwatchService implements IAmazonCloudwatchService {
-  public async createLogEvent ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request): Promise<void> {
+  public async createLogEvent (req: AmazonCloudwatch.CreateLogEvent.Request): Promise<void> {
     const client: CloudWatchLogs = new CloudWatchLogs({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    await this.createLogGroup({ credentials, data });
-    await this.createLogStream({ credentials, data });
+    await this.createLogGroup(req);
+    await this.createLogStream(req);
 
     await client.putLogEvents({
-      logGroupName: data.group,
-      logStreamName: data.stream,
-      logEvents: data.events,
+      logGroupName: req.group,
+      logStreamName: req.stream,
+      logEvents: req.events,
     });
   }
 
-  private async getLogGroupByName ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
-    const logGroups = await this.listApplicationLogGroups({ credentials, data });
+  private async getLogGroupByName (req: AmazonCloudwatch.CreateLogEvent.Request) {
+    const logGroups = await this.listApplicationLogGroups(req);
 
-    return logGroups.find((logGroup) => logGroup.logGroupName === data.group);
+    return logGroups.find((logGroup) => logGroup.logGroupName === req.group);
   }
 
-  private async getLogStreamByName ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
-    const logStreams = await this.listApplicationLogStreams({ credentials, data });
+  private async getLogStreamByName (req: AmazonCloudwatch.CreateLogEvent.Request) {
+    const logStreams = await this.listApplicationLogStreams(req);
 
-    return logStreams.find((logStream) => logStream.logStreamName === data.stream);
+    return logStreams.find((logStream) => logStream.logStreamName === req.stream);
   }
 
-  private async listApplicationLogGroups ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
+  private async listApplicationLogGroups (req: AmazonCloudwatch.CreateLogEvent.Request) {
     const client: CloudWatchLogs = new CloudWatchLogs({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
     const { logGroups } = await client.describeLogGroups({
-      logGroupNamePrefix: data.application,
+      logGroupNamePrefix: req.application,
     });
 
     return logGroups;
   }
 
-  private async listApplicationLogStreams ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
+  private async listApplicationLogStreams (req: AmazonCloudwatch.CreateLogEvent.Request) {
     const client: CloudWatchLogs = new CloudWatchLogs({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
     const { logStreams } = await client.describeLogStreams({
-      logGroupName: data.group,
+      logGroupName: req.group,
     });
 
     return logStreams;
   }
 
-  private async createLogGroup ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
-    const logGroup = await this.getLogGroupByName({ credentials, data });
+  private async createLogGroup (req: AmazonCloudwatch.CreateLogEvent.Request) {
+    const logGroup = await this.getLogGroupByName(req);
 
     if (!logGroup) {
       const client: CloudWatchLogs = new CloudWatchLogs({
         credentials: {
-          accessKeyId: credentials.accessKey,
-          secretAccessKey: credentials.secretKey,
+          accessKeyId: req.credentials.accessKey,
+          secretAccessKey: req.credentials.secretKey,
         },
-        region: credentials.region,
+        region: req.credentials.region,
       });
 
       await client.createLogGroup({
-        logGroupName: data.group,
+        logGroupName: req.group,
       });
     }
   }
 
-  private async createLogStream ({ credentials, data }: AmazonCloudwatch.CreateLogEvent.Request) {
-    const logStream = await this.getLogStreamByName({ credentials, data });
+  private async createLogStream (req: AmazonCloudwatch.CreateLogEvent.Request) {
+    const logStream = await this.getLogStreamByName(req);
 
     if (!logStream) {
       const client: CloudWatchLogs = new CloudWatchLogs({
         credentials: {
-          accessKeyId: credentials.accessKey,
-          secretAccessKey: credentials.secretKey,
+          accessKeyId: req.credentials.accessKey,
+          secretAccessKey: req.credentials.secretKey,
         },
-        region: credentials.region,
+        region: req.credentials.region,
       });
 
       await client.createLogStream({
-        logGroupName: data.group,
-        logStreamName: data.stream,
+        logGroupName: req.group,
+        logStreamName: req.stream,
       });
     }
   }
 }
 
-export default new AmazonCloudwatchService();
+export default new AmazonCloudwatchService();

package/src/services/aws/pinpoint.ts

@@ -3,16 +3,16 @@ import { PinpointClient, SendMessagesCommand, SendMessagesCommandInput } from '@
 import { AmazonPinpoint, IAmazonPinpointService } from '../../interfaces/aws';
 
 class AmazonPinpointService implements IAmazonPinpointService {
-  async sendMail ({ credentials, data }: AmazonPinpoint.SendMail.Request): Promise<void> {
+  async sendMail (req: AmazonPinpoint.SendMail.Request): Promise<void> {
     const client = new PinpointClient({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const recipient = Array.isArray(data.emails) ? data.emails : [ data.emails ];
+    const recipient = Array.isArray(req.emails) ? req.emails : [ req.emails ];
 
     const addresses = recipient.reduce(
       (acc, curr) => ({
@@ -24,7 +24,7 @@ class AmazonPinpointService implements IAmazonPinpointService {
       {}
     );
 
-    const substitutions = Object.entries(data.variables || {}).reduce(
+    const substitutions = Object.entries(req.variables || {}).reduce(
       (acc, [ key, value ]) => ({
         ...acc,
         [key]: [ value ],
@@ -33,21 +33,21 @@ class AmazonPinpointService implements IAmazonPinpointService {
     );
 
     const payload: SendMessagesCommandInput = {
-      ApplicationId: data.application,
+      ApplicationId: req.applicationId,
       MessageRequest: {
         Addresses: addresses,
         MessageConfiguration: {
           EmailMessage: {
-            FromAddress: data.from,
+            FromAddress: req.from,
             Substitutions: substitutions,
             SimpleEmail: {
               Subject: {
                 Charset: 'utf-8',
-                Data: data.subject,
+                Data: req.subject,
               },
               TextPart: {
                 Charset: 'utf-8',
-                Data: data.text,
+                Data: req.text,
               },
             },
           },
@@ -58,16 +58,16 @@ class AmazonPinpointService implements IAmazonPinpointService {
     await client.send(new SendMessagesCommand(payload));
   }
 
-  async sendTemplateMail ({ credentials, data }: AmazonPinpoint.SendTemplateMail.Request): Promise<void> {
+  async sendTemplateMail (req: AmazonPinpoint.SendTemplateMail.Request): Promise<void> {
     const client = new PinpointClient({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const recipient = Array.isArray(data.emails) ? data.emails : [ data.emails ];
+    const recipient = Array.isArray(req.emails) ? req.emails : [ req.emails ];
 
     const addresses = recipient.reduce(
       (acc, curr) => ({
@@ -79,7 +79,7 @@ class AmazonPinpointService implements IAmazonPinpointService {
       {}
     );
 
-    const substitutions = Object.entries(data.variables || {}).reduce(
+    const substitutions = Object.entries(req.variables || {}).reduce(
       (acc, [ key, value ]) => ({
         ...acc,
         [key]: [ value ],
@@ -88,18 +88,18 @@ class AmazonPinpointService implements IAmazonPinpointService {
     );
 
     const payload: SendMessagesCommandInput = {
-      ApplicationId: data.application,
+      ApplicationId: req.applicationId,
       MessageRequest: {
         Addresses: addresses,
         MessageConfiguration: {
           EmailMessage: {
-            FromAddress: data.from,
+            FromAddress: req.from,
             Substitutions: substitutions,
           },
         },
         TemplateConfiguration: {
           EmailTemplate: {
-            Name: data.template,
+            Name: req.template,
             Version: 'latest',
           },
         },
@@ -109,16 +109,16 @@ class AmazonPinpointService implements IAmazonPinpointService {
     await client.send(new SendMessagesCommand(payload));
   }
 
-  async sendSMS ({ credentials, data }: AmazonPinpoint.SendSMS.Request): Promise<void> {
+  async sendSMS (req: AmazonPinpoint.SendSMS.Request): Promise<void> {
     const client = new PinpointClient({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const recipient = Array.isArray(data.phones) ? data.phones : [ data.phones ];
+    const recipient = Array.isArray(req.phones) ? req.phones : [ req.phones ];
 
     const addresses = recipient.reduce(
       (acc, curr) => ({
@@ -130,7 +130,7 @@ class AmazonPinpointService implements IAmazonPinpointService {
       {}
     );
 
-    const substitutions = Object.entries(data.variables || {}).reduce(
+    const substitutions = Object.entries(req.variables || {}).reduce(
       (acc, [ key, value ]) => ({
         ...acc,
         [key]: [ value ],
@@ -139,14 +139,14 @@ class AmazonPinpointService implements IAmazonPinpointService {
     );
 
     const payload: SendMessagesCommandInput = {
-      ApplicationId: data.application,
+      ApplicationId: req.applicationId,
       MessageRequest: {
         Addresses: addresses,
         MessageConfiguration: {
           SMSMessage: {
-            Body: data.text,
-            MessageType: data.type,
-            SenderId: data.sender,
+            Body: req.text,
+            MessageType: req.type,
+            SenderId: req.sender,
             Substitutions: substitutions,
           },
         },
@@ -157,4 +157,4 @@ class AmazonPinpointService implements IAmazonPinpointService {
   }
 }
 
-export default new AmazonPinpointService();
+export default new AmazonPinpointService();

package/src/services/aws/s3.ts

@@ -11,119 +11,115 @@ import { AmazonS3, IAmazonS3Service } from '../../interfaces/aws';
 import FileService from '../../services/file';
 
 class AmazonS3Service implements IAmazonS3Service {
-  async uploadBase64 ({ credentials, data }: AmazonS3.UploadBase64.Request): Promise<AmazonS3.UploadBase64.Response> {
+  async uploadBase64 (req: AmazonS3.UploadBase64.Request): Promise<AmazonS3.UploadBase64.Response> {
     const client = new S3({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const { buffer, extension } = FileService.getBase64Metadata(data.file);
+    const { buffer, extension } = FileService.getBase64Metadata(req.file);
 
-    const key = data.options?.filename
-      ? data.options?.filename
+    const key = req.options?.filename
+      ? req.options?.filename
       : FileService.getUniqueFilename(extension);
 
     const payload: PutObjectCommandInput = {
-      Key: this.getBucketPath(key, data.options?.folder),
+      Key: this.getBucketPath(key, req.options?.folder),
       Body: buffer,
-      ContentEncoding: data.options?.contentEncoding,
-      ContentType: data.options?.contentType,
-      Bucket: data.bucket,
-      ACL: data.options?.isPrivate ? 'private' : 'public-read',
+      ContentEncoding: req.options?.contentEncoding,
+      ContentType: req.options?.contentType,
+      Bucket: req.bucket,
+      ACL: req.options?.isPrivate ? 'private' : 'public-read',
     };
 
     await client.putObject(payload);
 
     const { url } = await this.getSignedUrl({
-      data: {
-        bucket: data.bucket,
-        filename: key,
-        folder: data.options?.folder,
-        isUpload: false,
-      },
-      credentials,
+      bucket: req.bucket,
+      credentials: req.credentials,
+      filename: key,
+      folder: req.options?.folder,
+      isUpload: false,
     });
 
     return {
       key: payload.Key,
-      bucket: data.bucket,
+      bucket: req.bucket,
       url,
     };
   }
 
-  async uploadBuffer ({ credentials, data }: AmazonS3.UploadBuffer.Request): Promise<AmazonS3.UploadBuffer.Response> {
+  async uploadBuffer (req: AmazonS3.UploadBuffer.Request): Promise<AmazonS3.UploadBuffer.Response> {
     const client = new S3({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const key = data.options?.filename
-      ? data.options?.filename
+    const key = req.options?.filename
+      ? req.options?.filename
       : FileService.getUniqueFilename('');
 
     const payload: PutObjectCommandInput = {
-      Key: this.getBucketPath(key, data.options?.folder),
-      Body: data.file,
-      ContentEncoding: data.options?.contentEncoding,
-      ContentType: data.options?.contentType,
-      Bucket: data.bucket,
-      ACL: data.options?.isPrivate ? 'private' : 'public-read',
+      Key: this.getBucketPath(key, req.options?.folder),
+      Body: req.file,
+      ContentEncoding: req.options?.contentEncoding,
+      ContentType: req.options?.contentType,
+      Bucket: req.bucket,
+      ACL: req.options?.isPrivate ? 'private' : 'public-read',
     };
 
     await client.putObject(payload);
 
     const { url } = await this.getSignedUrl({
-      data: {
-        bucket: data.bucket,
-        filename: key,
-        folder: data.options?.folder,
-        isUpload: false,
-      },
-      credentials,
+      bucket: req.bucket,
+      credentials: req.credentials,
+      filename: key,
+      folder: req.options?.folder,
+      isUpload: false,
     });
 
     return {
       key: payload.Key,
-      bucket: data.bucket,
+      bucket: req.bucket,
       url,
     };
   }
 
-  async deleteFile ({ credentials, data }: AmazonS3.DeleteFile.Request): Promise<void> {
+  async deleteFile (req: AmazonS3.DeleteFile.Request): Promise<void> {
     const client = new S3({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
     const payload: DeleteObjectCommandInput = {
-      Key: this.getBucketPath(data.filename, data.folder),
-      Bucket: data.bucket,
+      Key: this.getBucketPath(req.filename, req.folder),
+      Bucket: req.bucket,
     };
 
     await client.deleteObject(payload);
   }
 
-  async listFiles ({ credentials, data }: AmazonS3.ListFiles.Request): Promise<AmazonS3.ListFiles.Response> {
+  async listFiles (req: AmazonS3.ListFiles.Request): Promise<AmazonS3.ListFiles.Response> {
     const client = new S3({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
     const { Contents } = await client.listObjectsV2({
-      Bucket: data.bucket,
-      Prefix: data.folder,
+      Bucket: req.bucket,
+      Prefix: req.folder,
     });
 
     return {
@@ -131,21 +127,21 @@ class AmazonS3Service implements IAmazonS3Service {
     };
   }
 
-  async getSignedUrl ({ credentials, data }: AmazonS3.GetSignedUrl.Request): Promise<AmazonS3.GetSignedUrl.Response> {
+  async getSignedUrl (req: AmazonS3.GetSignedUrl.Request): Promise<AmazonS3.GetSignedUrl.Response> {
     const client = new S3({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
     const payload = {
-      Key: this.getBucketPath(data.filename, data.folder),
-      Bucket: data.bucket,
+      Key: this.getBucketPath(req.filename, req.folder),
+      Bucket: req.bucket,
     };
 
-    const method = data.isUpload
+    const method = req.isUpload
       ? new PutObjectCommand(payload)
       : new GetObjectCommand(payload);
 

package/src/services/aws/secret-manager.ts

@@ -4,19 +4,18 @@ import { AmazonSecretManager, IAmazonSecretManagerService } from '../../interfac
 import { parseRecord } from '../../utils/parser';
 
 class AmazonSecretManagerService implements IAmazonSecretManagerService {
-  public async getSecret<T> ({
-    credentials,
-    data,
-  }: AmazonSecretManager.GetSecret.Request): Promise<AmazonSecretManager.GetSecret.Response<T>> {
+  public async getSecret<T> (
+    req: AmazonSecretManager.GetSecret.Request
+  ): Promise<AmazonSecretManager.GetSecret.Response<T>> {
     const client: SecretsManager = new SecretsManager({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const { SecretString, SecretBinary } = await client.getSecretValue({ SecretId: data.secret });
+    const { SecretString, SecretBinary } = await client.getSecretValue({ SecretId: req.secretId });
 
     if (SecretString) {
       const secret = parseRecord(SecretString) as T;

package/src/services/aws/sqs.ts

@@ -4,36 +4,33 @@ import { AmazonSQS, IAmazonSQSService } from '../../interfaces/aws';
 import { parseRecord } from '../../utils';
 
 class AmazonSQSService implements IAmazonSQSService {
-  async publishMessage ({ credentials, data }: AmazonSQS.PublishMessage.Request): Promise<void> {
+  async publishMessage (req: AmazonSQS.PublishMessage.Request): Promise<void> {
     const client: SQS = new SQS({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const { QueueUrl } = await client.getQueueUrl({ QueueName: data.queue });
+    const { QueueUrl } = await client.getQueueUrl({ QueueName: req.queue });
 
     await client.sendMessage({
-      MessageBody: JSON.stringify(data.message),
+      MessageBody: JSON.stringify(req.message),
       QueueUrl,
     });
   }
 
-  async consumeMessage<T> ({
-    credentials,
-    data,
-  }: AmazonSQS.ConsumeMessage.Request): Promise<AmazonSQS.ConsumeMessage.Response<T>> {
+  async consumeMessage<T> (req: AmazonSQS.ConsumeMessage.Request): Promise<AmazonSQS.ConsumeMessage.Response<T>> {
     const client: SQS = new SQS({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const { QueueUrl } = await client.getQueueUrl({ QueueName: data.queue });
+    const { QueueUrl } = await client.getQueueUrl({ QueueName: req.queue });
 
     const { Messages } = await client.receiveMessage({
       QueueUrl,
@@ -60,19 +57,16 @@ class AmazonSQSService implements IAmazonSQSService {
     };
   }
 
-  async consumeMessages<T> ({
-    credentials,
-    data,
-  }: AmazonSQS.ConsumeMessages.Request): Promise<AmazonSQS.ConsumeMessages.Response<T>> {
+  async consumeMessages<T> (req: AmazonSQS.ConsumeMessages.Request): Promise<AmazonSQS.ConsumeMessages.Response<T>> {
     const client: SQS = new SQS({
       credentials: {
-        accessKeyId: credentials.accessKey,
-        secretAccessKey: credentials.secretKey,
+        accessKeyId: req.credentials.accessKey,
+        secretAccessKey: req.credentials.secretKey,
       },
-      region: credentials.region,
+      region: req.credentials.region,
     });
 
-    const { QueueUrl } = await client.getQueueUrl({ QueueName: data.queue });
+    const { QueueUrl } = await client.getQueueUrl({ QueueName: req.queue });
 
     const { Messages } = await client.receiveMessage({
       QueueUrl,
@@ -104,4 +98,4 @@ class AmazonSQSService implements IAmazonSQSService {
   }
 }
 
-export default new AmazonSQSService();
+export default new AmazonSQSService();