prime-sdk 1.0.0

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "prime-sdk",
+  "version": "1.0.0",
+  "description": "swiss army knife",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "",
+  "private": false,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@aws-sdk/client-sqs": "^3.569.0",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.2.2",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/platform-express": "^10.0.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.0.0",
+    "@nestjs/schematics": "^10.0.0",
+    "@nestjs/testing": "^10.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "@types/supertest": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/queue-publish.bash

@@ -0,0 +1,4 @@
+awslocal sqs send-message --queue-url=http://localhost:4566/000000000000/teste --message-body='{
+	"token": "NWMwOWRiM2MzNTk3MDViMWI4YjRmODZhNzBjOThkYWFmZmZiODQ4ODM4Nzc2OGJkYjE2OWIyZDFlYTFkNDc0MWRlZDFhNjk2NjM4ZjM3NGMwZDlhNmY0ZDY2Y2FlM2U0ODQ0NzU3ZmYwMTFiMjdlZjkyMzg2YThkZDUwYmUzNjAwNTkzZGYwZGY3M2ZhNzFhNzExM2U2ZWRkOGIxYjNjNzMwMDA0ZTRmYTM3MGZiMGZhYmU1NTYwNzFiYTIyYmYwM2RiY2ZiMjBkYmM5Y2JmNzI1NmM4NjE3ZGRjOWIzN2FlZWJlNzc2N2YxYTQ4N2E5MWRhYWUzOTE4Y2M1Yzg2MmUwMzA5ZjQyZWI0OTIyZTBmYTk2ZGUyYmFiY2FjNjhmMWI0ZWEyNTBiMDc5MzVkZmNmMjRiMzIzZjdkYjY0ODkzYWJhZTc2NzIzOGY2OTBlOTM4NTBkMWY4ZWQ3MDNiYQ==",
+	"fkUsersRequestVerification": 9
+}'

package/queue.bash

@@ -0,0 +1,7 @@
+awslocal sqs delete-queue --queue-url=http://localhost:4566/000000000000/teste
+awslocal sqs create-queue --queue-name teste
+awslocal sqs purge-queue --queue-url=http://localhost:4566/000000000000/teste
+
+awslocal sns delete-topic --topic-arn arn:aws:sns:us-east-1:000000000000:identity-validation-requested
+awslocal sns create-topic --name identity-validation-requested
+awslocal sns subscribe --topic-arn arn:aws:sns:us-east-1:000000000000:identity-validation-requested --protocol sqs --notification-endpoint arn:aws:sqs:us-east-1:000000000000:teste --attributes RawMessageDelivery=true

package/src/app.module.ts

@@ -0,0 +1,19 @@
+import { Module } from '@nestjs/common';
+import { AppService } from './app.service';
+import { QueueModule } from './lib/queue/queue.module';
+
+@Module({
+  imports: [
+    QueueModule.forRoot({
+      credentials: {
+        accessKeyId: '000000000',
+        secretAccessKey: '000000000',
+      },
+      endpoint: 'http://localhost:4566/',
+      region: 'us-east-1',
+    }),
+  ],
+  providers: [AppService],
+  exports: [],
+})
+export class AppModule {}

package/src/app.service.ts

@@ -0,0 +1,26 @@
+import { Injectable } from '@nestjs/common';
+import { IConsumer } from './lib/queue/interfaces/consumer.interface';
+import { Message } from '@aws-sdk/client-sqs';
+import { Queue } from './lib/queue/queue';
+
+@Injectable()
+export class AppService implements IConsumer {
+  constructor(private readonly queueHandler: Queue) {
+    this.queueHandler.handler({
+      QueueUrl: `${'teste'}`,
+      context: this,
+      bulk: 1,
+      waitTimeSeconds: 20,
+    });
+  }
+
+  handleMessage(message: Message | Message[]): Promise<void> {
+    console.log(message);
+    return;
+  }
+
+  handleError(error: unknown): Promise<void> {
+    console.log(error);
+    return;
+  }
+}

package/src/external/aws/sqs/sqs.provider.ts

@@ -0,0 +1,39 @@
+import { SQSClient } from '@aws-sdk/client-sqs';
+import { DynamicModule } from '@nestjs/common';
+
+export type SqsSetup = {
+  region: string;
+  endpoint: string;
+  credentials: {
+    accessKeyId: string;
+    secretAccessKey: string;
+  };
+};
+
+const SqsProvider = (params: SqsSetup) => {
+  return {
+    provide: 'CONNECTION_SQS',
+    useFactory: () => {
+      return new SQSClient({
+        region: params.region,
+        endpoint: params.endpoint,
+        credentials: {
+          accessKeyId: params.credentials.accessKeyId,
+          secretAccessKey: params.credentials.secretAccessKey,
+        },
+      });
+    },
+  };
+};
+
+export class SqsModule {
+  static forRoot(params: SqsSetup): DynamicModule {
+    const sqsProvider = SqsProvider(params);
+
+    return {
+      module: SqsModule,
+      providers: [sqsProvider],
+      exports: [sqsProvider],
+    };
+  }
+}

package/src/external/aws/sqs/sqs.service.ts

@@ -0,0 +1,50 @@
+import {
+  DeleteMessageCommand,
+  ReceiveMessageCommand,
+  ReceiveMessageResult,
+  SQSClient,
+} from '@aws-sdk/client-sqs';
+import { Inject, Injectable } from '@nestjs/common';
+import { IQueue } from 'src/lib/queue/interfaces/queue.interface';
+
+@Injectable()
+export class Sqs implements IQueue {
+  private queueUrl: string;
+  private bulk: number;
+  private waitTimeSeconds: number;
+
+  constructor(@Inject('CONNECTION_SQS') private readonly client: SQSClient) {}
+
+  setup({ waitTimeSeconds, bulk, queueUrl }) {
+    this.waitTimeSeconds = waitTimeSeconds;
+    this.bulk = bulk;
+    this.queueUrl = queueUrl;
+  }
+
+  async sendCommand(
+    command: ReceiveMessageCommand | DeleteMessageCommand,
+  ): Promise<unknown> {
+    return this.client.send(command);
+  }
+
+  async receiveMessages(): Promise<ReceiveMessageResult> {
+    const input = {
+      QueueUrl: this.queueUrl,
+      MaxNumberOfMessages: this.bulk,
+      WaitTimeSeconds: this.waitTimeSeconds,
+    };
+
+    const command = new ReceiveMessageCommand(input);
+
+    return (await this.sendCommand(command)) as ReceiveMessageResult;
+  }
+
+  async deleteMessage(receiptHandle): Promise<unknown> {
+    const deleteCommand = new DeleteMessageCommand({
+      QueueUrl: this.queueUrl,
+      ReceiptHandle: receiptHandle,
+    });
+
+    return await this.sendCommand(deleteCommand);
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+import { QueueModule } from './lib/queue/queue.module';
+import { Queue } from './lib/queue/queue';
+import { IConsumer } from './lib/queue/interfaces/consumer.interface';
+
+export { QueueModule, Queue, IConsumer };

package/src/lib/events/events.ts

@@ -0,0 +1,4 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class Events {}

package/src/lib/queue/interfaces/consumer.interface.ts

@@ -0,0 +1,8 @@
+import { Message } from '@aws-sdk/client-sqs';
+
+export interface IConsumer {
+  handleMessage(message: Array<Message> | Message): Promise<void>;
+  handleError(error: unknown): Promise<void>;
+}
+
+export const IConsumer = Symbol('IConsumer');

package/src/lib/queue/interfaces/queue.interface.ts

@@ -0,0 +1,9 @@
+import { Message, ReceiveMessageResult } from '@aws-sdk/client-sqs';
+
+export interface IQueue {
+  deleteMessage(message: Array<Message> | Message): Promise<unknown>;
+  receiveMessages(): Promise<ReceiveMessageResult>;
+  setup({ waitTimeSeconds, bulk, queueUrl }): void;
+}
+
+export const IQueue = Symbol('IQueue');

package/src/lib/queue/queue.module.ts

@@ -0,0 +1,17 @@
+import { DynamicModule, Module } from '@nestjs/common';
+import { Queue } from './queue';
+import { IQueue } from './interfaces/queue.interface';
+import { Sqs } from '../../external/aws/sqs/sqs.service';
+import { SqsModule, SqsSetup } from '../../external/aws/sqs/sqs.provider';
+
+@Module({})
+export class QueueModule {
+  static forRoot(params: SqsSetup): DynamicModule {
+    return {
+      module: QueueModule,
+      imports: [SqsModule.forRoot(params)],
+      providers: [Queue, { provide: IQueue, useClass: Sqs }],
+      exports: [Queue, { provide: IQueue, useClass: Sqs }],
+    };
+  }
+}

package/src/lib/queue/queue.ts

@@ -0,0 +1,80 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { QueueConfig } from './types/queue.type';
+import { IConsumer } from './interfaces/consumer.interface';
+import { IQueue } from './interfaces/queue.interface';
+import { Message, ReceiveMessageResult } from '@aws-sdk/client-sqs';
+
+@Injectable()
+export class Queue {
+  private queueUrl: string = null;
+
+  private bulk: number = 1;
+
+  private context: IConsumer = null;
+
+  private inWork: boolean = false;
+
+  private waitTimeSeconds: number = 20;
+
+  constructor(@Inject(IQueue) private readonly broker: IQueue) {}
+
+  async handler({
+    QueueUrl = null,
+    context = null,
+    bulk = 1,
+    waitTimeSeconds = 20,
+  }: QueueConfig): Promise<void> {
+    this.queueUrl = QueueUrl;
+    this.bulk = bulk;
+    this.context = context;
+    this.waitTimeSeconds = waitTimeSeconds;
+
+    this.broker.setup({
+      waitTimeSeconds: this.waitTimeSeconds,
+      bulk: this.bulk,
+      queueUrl: this.queueUrl,
+    });
+
+    while (!this.inWork) {
+      await this.run();
+    }
+  }
+
+  async run() {
+    this.inWork = true;
+    const response = await this.receiveMessages();
+
+    try {
+      if (this.bulk === 1) {
+        const message = response.Messages?.[0] || null;
+
+        if (message) {
+          await this.context.handleMessage(message);
+
+          await this.deleteMessage(message.ReceiptHandle);
+        }
+
+        this.inWork = false;
+
+        return;
+      }
+
+      await this.context.handleMessage(response.Messages);
+
+      response.Messages.forEach(async (message: Message) => {
+        await this.deleteMessage(message.ReceiptHandle);
+      });
+    } catch (error) {
+      await this.context.handleError(error);
+    }
+    this.inWork = false;
+  }
+
+  async receiveMessages(): Promise<ReceiveMessageResult> {
+    return await this.broker.receiveMessages();
+  }
+
+  async deleteMessage(receiptHandle): Promise<unknown> {
+    return await this.broker.deleteMessage(receiptHandle);
+  }
+}

package/src/lib/queue/types/queue.type.ts

@@ -0,0 +1,8 @@
+import { IConsumer } from '../interfaces/consumer.interface';
+
+export type QueueConfig = {
+  QueueUrl: string;
+  context: IConsumer;
+  bulk: number;
+  waitTimeSeconds?: number;
+};

package/src/lib/storage/storage.ts

@@ -0,0 +1,4 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class Storage {}

package/src/main.ts

@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(3000);
+}
+bootstrap();

package/test/app.e2e-spec.ts

@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}