@merkaly/api 0.2.5-4 → 0.2.5-6

package/.bin/deploy.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+rm -frd ./.output
+
+yarn clean
+
+#yarn console deploy mongo
+#yarn console deploy auth0
+
+yarn build

package/.bin/package.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+rm -frd ./.output
+
+yarn build -p tsconfig.package.json
+
+sed "s/extends Document //" .output/abstracts/abstract.entity.d.ts > .output/abstracts/abstract.entity.ts.d
+mv .output/abstracts/abstract.entity.ts.d .output/abstracts/abstract.entity.d.ts
+
+sed "s/import { Document } from \'mongoose\';//" .output/abstracts/abstract.entity.d.ts > .output/abstracts/abstract.entity.ts.d
+mv .output/abstracts/abstract.entity.ts.d .output/abstracts/abstract.entity.d.ts
+
+find .output -name '*.entity.js' -delete

package/.docker/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:16
+
+WORKDIR /usr/src
+
+ENV HOST 0.0.0.0
+ENV PORT 6500
+
+ARG SENTRY_DSN
+ENV SENTRY_DSN $SENTRY_DSN
+
+COPY package.json ./
+
+RUN yarn
+
+COPY . .
+
+RUN yarn build
+
+EXPOSE ${PORT}
+
+CMD yarn start:prod

package/.dockerignore

@@ -0,0 +1,12 @@
+/.git
+/.github
+/.husky
+/node_modules
+
+# environment vars
+.env
+
+# nestjs compiled files
+/**/*.js
+/**/*.map
+/**/*.d.ts

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  # Fetch and update latest `npm` packages
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '00:00'
+    open-pull-requests-limit: 3
+    reviewers:
+      - kronhyx
+    assignees:
+      - kronhyx
+    commit-message:
+      prefix: chore
+      prefix-development: chore
+      include: scope

package/.github/semantic.yml

@@ -0,0 +1,5 @@
+# Always validate the PR title AND all the commits
+titleAndCommits: true
+# Allows use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true

package/.github/workflows/pull_request.yml

@@ -0,0 +1,35 @@
+name: PullRequest & Push master
+
+env:
+    NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@master
+
+      - name: Setup node env 🏗
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18
+
+      - name: Install dependencies 🛠️
+        run: yarn
+
+      - name: Lint code 👀️
+        run: yarn lint
+
+#      - name: Run tests 🧪
+#        run: yarn test
+
+      - name: Build code 🛠️
+        run: yarn build

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/app.ts

@@ -0,0 +1,11 @@
+import { INestApplication, ValidationPipe } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+
+export function createNestApp(app: INestApplication) {
+  const config = new DocumentBuilder().build();
+
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('/', app, document);
+
+  return app.useGlobalPipes(new ValidationPipe({ whitelist: true, transform: true }));
+}

package/authCertificate.pem

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIDAzCCAeugAwIBAgIJHHJE5ykX1iXdMA0GCSqGSIb3DQEBCwUAMB8xHTAbBgNV
+BAMTFG1lcmthbHkudXMuYXV0aDAuY29tMB4XDTIwMTEwNTIwMzY1MVoXDTM0MDcx
+NTIwMzY1MVowHzEdMBsGA1UEAxMUbWVya2FseS51cy5hdXRoMC5jb20wggEiMA0G
+CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCcZcJZ3OxWI+Gxp9a5GGY9035+FulG
+8+EWuIvRMCL1cUT5RMfib5/I66T3wipHw8t/yKO/Rjdx8uRUTZE94OuCbSI/qK7R
+bQHdpvUw9B9W3lwwyJ+AjklDOYS91apJcn4g/poMQ5G9vdQsP6u1P176Bjkx0pxH
+qx3XBbPf61IIb7Jv1yiyc6sQDHyR3ZUQPrDgjNgu30pTOxjQIOnnzSoCn/n0QjWA
+O9JcMyO2kI6+dNJnWBfs7BhCz4fPJA6IfU57vaq50sSH99/DEbc7SDJh+Ty1z4iW
+dX/4h+6GNtIUqBh35+fz606tN1x+RSET+/oDAHI78+KB8AkC4rTmdIBRAgMBAAGj
+QjBAMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ8n4kEQjFyA504p+iJj2zr7
+vpiPMA4GA1UdDwEB/wQEAwIChDANBgkqhkiG9w0BAQsFAAOCAQEAGHMjDFX1myDL
+eHqlwxQTYJk1+sc68rfUxB70a/MU5OMZ8z53YTDbkeOhlsmrIuDMhIt3ZVHizWka
+nITpKzU7cuRLJEyozps2bZyX/8QaoKwTkqV5IUV4W9FoL8K8A/zTOKp2H/T8WiSu
+5b29cltqXYrsWj2La3Fm0uaqupfweZgwLN/z/wRg+k7ZzAaHdAehZ9DW2mUkgqHg
+5z6f4SOvTvyTAcphG4tqeFk4YjV4OQcBSuDsnLxs1mQpQ12eA2gmoRQ3W70zRtdI
+1UzqunyLrz5Pt59fitaSeXfthfFNKW67zSfGfJhoqngIuxG/+UaAaDRx/LBJjO0O
+4/ztS0AZ/A==
+-----END CERTIFICATE-----

package/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/package.json

@@ -1,105 +1,93 @@
 {
   "name": "@merkaly/api",
-  "version": "0.2.5-4",
-  "description": "NestJS Backend ApiRest Service",
+  "version": "0.2.5-6",
   "repository": {
     "type": "git",
     "url": "https://github.com/merkaly-io/api.git"
   },
   "license": "UNLICENSED",
-  "author": "Randy Tellez Galan <kronhyx@gmail.com>",
-  "main": "./.output/main",
-  "types": "./.output/types.d.ts",
-  "files": [
-    ".output"
-  ],
   "scripts": {
-    "prebuild": "yarn run clean",
     "build": "nest build",
     "clean": "tsc -b --clean",
     "console": "yarn clean && ts-node -r tsconfig-paths/register ./src/app.console.ts",
-    "dev": "yarn start --watch",
-    "lint": "eslint \"{src,test}/**/*.ts\" . ",
-    "migrate": "tsc --target es5 --experimentalDecorators ./src/migrations/*.ts && migrate --config ./src/app.migration.ts",
-    "prepack": ".bin/package.sh",
+    "dev": "nest start --watch",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "postpack": "yarn run clean",
-    "semantic-release": "yarn run build:package && semantic-release",
-    "start": "nest start",
-    "start:prod": "node ./src/main.js",
+    "prebuild": "yarn run clean",
+    "prepack": ".bin/package.sh",
+    "start": "node dist/src/main",
     "test": "jest",
-    "test:cov": "yarn test -- --coverage",
+    "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:watch": "yarn test -- --watch"
-  },
-  "lint-staged": {
-    "*.**": "yarn lint --cache --fix"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@nestjs/common": "^9.0.11",
-    "@nestjs/swagger": "^6.1.0",
-    "@types/auth0": "^3.3.1",
+    "auth0": "^4.2.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
-    "mongoose": "^6",
-    "reflect-metadata": "^0.1.13"
+    "mongoose": "^7.5.3",
+    "reflect-metadata": "^0.1.14"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^17.0.0",
-    "@faker-js/faker": "^8.0.0",
-    "@google-cloud/storage": "^6.4.1",
-    "@nestjs/axios": "^2.0.0",
-    "@nestjs/cli": "^9.1.1",
-    "@nestjs/config": "^2.2.0",
-    "@nestjs/core": "^9.0.11",
-    "@nestjs/event-emitter": "^1.3.1",
-    "@nestjs/jwt": "^10.0.2",
-    "@nestjs/mongoose": "^9.2.0",
-    "@nestjs/passport": "^9.0.0",
-    "@nestjs/platform-express": "^9.0.11",
-    "@nestjs/platform-socket.io": "^9.4.0",
-    "@nestjs/schematics": "^9.0.1",
-    "@nestjs/testing": "^9.0.11",
-    "@nestjs/websockets": "^9.4.0",
-    "@types/cache-manager": "^4.0.1",
-    "@types/express": "^4.17.12",
-    "@types/jest": "^27.0.0",
-    "@types/multer": "^1.4.7",
-    "@types/node": "^20.1.0",
-    "@types/passport-jwt": "^3.0.5",
-    "@types/supertest": "^2.0.11",
-    "@types/uuid": "^9.0.1",
-    "@typescript-eslint/eslint-plugin": "4.33.0",
-    "@typescript-eslint/parser": "4.33.0",
-    "auth0": "^3.2.0",
-    "axios": "^1.3.4",
-    "cache-manager": "^5.0.0",
-    "commitlint": "^17.0.1",
-    "eslint": "7.32.0",
-    "eslint-plugin-import": "^2.23.4",
-    "express": "^4.17.3",
-    "husky": "^8.0.1",
-    "jest": "27.5.1",
-    "lint-staged": "^13.0.3",
-    "migrate-mongoose": "^4.0.0",
-    "nestjs-console": "^8.0.0",
+    "@faker-js/faker": "^8.3.1",
+    "@nestjs/cli": "^10.2.1",
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/config": "^3.1.1",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/jwt": "^10.2.0",
+    "@nestjs/mongoose": "^10.0.1",
+    "@nestjs/passport": "^10.0.3",
+    "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/schematics": "^10.0.3",
+    "@nestjs/swagger": "^7.1.16",
+    "@nestjs/testing": "^9.0.0",
+    "@types/express": "^4.17.21",
+    "@types/jest": "29.5.11",
+    "@types/multer": "^1.4.11",
+    "@types/node": "20.10.3",
+    "@types/passport-jwt": "^3.0.13",
+    "@types/supertest": "^2.0.16",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "29.7.0",
+    "mongoose": "^7.5.3",
+    "nestjs-console": "^9.0.0",
     "passport": "^0.6.0",
-    "passport-jwt": "^4.0.0",
-    "rimraf": "^5.0.0",
+    "passport-jwt": "^4.0.1",
+    "prettier": "^2.3.2",
+    "reflect-metadata": "^0.1.14",
     "rxjs": "^7.2.0",
-    "short-unique-id": "^4.4.4",
+    "source-map-support": "^0.5.20",
     "supertest": "^6.1.3",
-    "swagger-ui-express": "^4.3.0",
-    "ts-jest": "27.1.3",
-    "ts-loader": "^9.2.3",
+    "ts-jest": "29.1.1",
+    "ts-loader": "^9.5.1",
     "ts-node": "^10.0.0",
-    "tsconfig-paths": "^4.0.0",
-    "typescript": "4.4.4",
-    "webpack": "^5"
-  },
-  "publishConfig": {
-    "access": "public"
+    "tsconfig-paths": "4.2.0",
+    "typescript": "<5.2.0"
   },
-  "engines": {
-    "node": ">=16"
+  "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/src/abstracts/abstarct.repository.ts

@@ -0,0 +1,62 @@
+import { GoneException, Logger, NotFoundException } from '@nestjs/common';
+import { FilterQuery, HydratedDocument, Model, PopulateOptions } from 'mongoose';
+import { AbstractEntity } from './abstract.entity';
+import { FindResult, FindValidator, ReadValidator } from './abstract.validator';
+
+export abstract class AbstractRepository<E extends AbstractEntity = AbstractEntity> {
+  protected abstract $model: Model<AbstractEntity>;
+
+  public find(validator: FindValidator<E> = {}, ...params: unknown[]): Promise<FindResult<E>> {
+    const filters: FilterQuery<E> = { deletedAt: null, ...validator.filters };
+
+    const query = this.$model.find<E>(filters);
+    const counter = this.$model.count(filters);
+
+    const skip = validator.page * validator.limit - validator.limit;
+
+    !validator.sort?.createdAt && (validator.sort = { ...validator.sort, createdAt: 'desc' });
+
+    validator.page && query.skip(skip);
+    validator.sort && query.sort(validator.sort);
+
+    validator.join && query.populate(validator.join as (PopulateOptions | string)[]);
+
+    validator.limit && query.limit(validator.limit);
+
+    return Promise.all([counter.count(), query.exec()]).then(([total, items]) => ({
+      items,
+      page: validator.page,
+      total,
+    }));
+  }
+
+  public async read(id: string, validator?: ReadValidator) {
+    const entity = await this.$model.findById<HydratedDocument<E>>(id);
+
+    if (!entity) {
+      throw new NotFoundException();
+    }
+
+    if (entity.deletedAt) {
+      throw new GoneException();
+    }
+
+    if (validator?.join) {
+      await entity
+        .populate(validator.join as [])
+        .catch(() => Logger.warn(`Issue populating fields with id: ${entity._id}`));
+    }
+
+    return entity;
+  }
+
+  public abstract create(validator: unknown, ...params: unknown[]): any;
+
+  public abstract update(id: string, validator: unknown): any;
+
+  public async delete(id: string) {
+    await this.read(id);
+
+    return this.$model.deleteOne({ _id: id });
+  }
+}

package/src/abstracts/abstract.controller.ts

@@ -0,0 +1,18 @@
+import { AbstractRepository } from './abstarct.repository';
+import { IdMongoValidator, ReadValidator } from './abstract.validator';
+
+export abstract class AbstractController {
+  protected abstract readonly $repository: AbstractRepository;
+
+  protected find?(...params: unknown[]) {
+    return this.$repository.find();
+  }
+
+  protected read?({ id }: IdMongoValidator, validator?: ReadValidator) {
+    return this.$repository.read(id, validator);
+  }
+
+  protected delete?({ id }: IdMongoValidator) {
+    return this.$repository.delete(id);
+  }
+}

package/src/abstracts/abstract.entity.ts

@@ -0,0 +1,22 @@
+import { Prop } from '@nestjs/mongoose';
+import { Schema as MongoSchema } from 'mongoose';
+
+export const $collection = {
+  timestamps: true,
+  toJSON: { versionKey: false, virtuals: true },
+};
+
+export type MaybeEntity<T extends AbstractEntity> = T;
+
+export abstract class AbstractEntity {
+  public readonly _id = String();
+
+  @Prop({ type: MongoSchema.Types.Date })
+  public readonly createdAt: Date;
+
+  @Prop({ type: MongoSchema.Types.Date })
+  public readonly updatedAt?: Date = null;
+
+  @Prop({ default: null, type: MongoSchema.Types.Date })
+  public readonly deletedAt?: Date = null;
+}

package/src/abstracts/abstract.router.ts

@@ -0,0 +1,7 @@
+export abstract class AbstractRouter {
+  public static readonly path: string;
+
+  public static readonly module: typeof AbstractRouter;
+
+  public static readonly children? = [];
+}

package/src/abstracts/abstract.validator.ts

@@ -0,0 +1,61 @@
+import { Transform } from 'class-transformer';
+import { IsInt, IsMongoId, isObject, IsOptional } from 'class-validator';
+import { FilterQuery, PopulateOptions, SortOrder } from 'mongoose';
+import { AbstractEntity } from './abstract.entity';
+
+export abstract class AbstractValidator {}
+
+export type FindResult<I> = { items: I[]; page: number; total: number };
+
+export type KeyOfType<T, V> = keyof {
+  [P in keyof T as T[P] extends V ? P : string]: any;
+};
+
+export class IdMongoValidator {
+  @IsMongoId()
+  public id: string;
+}
+
+export class ReadValidator<E = AbstractEntity> extends AbstractValidator {
+  @Transform(({ value }) => {
+    try {
+      return JSON.parse(value);
+    } catch (e: unknown) {
+      return value;
+    }
+  })
+  @IsOptional()
+  public join?: (PopulateOptions | KeyOfType<E, AbstractEntity | AbstractEntity[]>)[] = [];
+}
+
+export class FindValidator<E = AbstractEntity> extends ReadValidator<E> {
+  @Transform(({ value }) => (value ? Number(value) : 10))
+  @IsInt()
+  @IsOptional()
+  public limit? = 10;
+
+  @Transform(({ value }) => (value ? Number(value) : 1))
+  @IsInt()
+  @IsOptional()
+  public page? = 1;
+
+  @Transform(({ value }) => {
+    if (isObject(value)) {
+      return value;
+    }
+
+    return value && JSON.parse(value);
+  })
+  @IsOptional()
+  public sort?: Partial<Record<keyof E, SortOrder>> = {};
+
+  @Transform(({ value }) => {
+    if (isObject(value)) {
+      return value;
+    }
+
+    return value && JSON.parse(value);
+  })
+  @IsOptional()
+  public filters?: FilterQuery<E> = {};
+}

package/src/app.config.ts

@@ -0,0 +1,59 @@
+import { config } from 'dotenv';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import * as process from 'process';
+
+config();
+
+export abstract class AppConfig {
+  public static get SENTRY() {
+    return {
+      dsn: process.env.SENTRY_DSN,
+      debug: process.env.NODE_ENV !== 'production',
+      environment: process.env.NODE_ENV,
+    };
+  }
+
+  public static get SERVER() {
+    return {
+      description: String(process.env.npm_package_description),
+      isDEV: process.env.NODE_ENV !== 'production',
+      name: String(process.env.npm_package_name),
+      port: Number(process.env.PORT || 6500),
+      version: String(process.env.npm_package_version),
+    };
+  }
+
+  public static get MONGO() {
+    const { MONGO_PASSWORD, MONGO_USER, MONGO_HOST } = process.env;
+
+    return {
+      host: MONGO_HOST,
+      user: MONGO_USER,
+      pass: MONGO_PASSWORD,
+      retryWrites: true,
+      w: 'majority',
+    };
+  }
+
+  public static get STORAGE() {
+    const serviceAccount = readFileSync(join(process.cwd(), '/serviceAccount.json'));
+    const credentials = JSON.parse(serviceAccount.toString());
+
+    return {
+      projectId: 'api-merkaly-io',
+      bucketName: process.env.GCP_BUCKET_NAME,
+      serviceAccount: credentials,
+    };
+  }
+
+  public static get AUTH0() {
+    const domain = 'merkaly.us.auth0.com';
+    const audience = `https://${domain}/api/v2/`;
+    const client = 'eApUjfHoWlMPcTUuU1lqvE517q0KzTh9';
+    const secret = String(process.env.AUTH0_CLIENT_SECRET);
+    const certificate = process.env.AUTH_CERTIFICATE || readFileSync(join(process.cwd(), '/authCertificate.pem'));
+
+    return { domain, audience, client, secret, certificate };
+  }
+}

package/src/app.console.ts

@@ -0,0 +1,24 @@
+import { BootstrapConsole } from 'nestjs-console';
+import process from 'process';
+import { AppModule } from './app.module';
+
+const bootstrap = new BootstrapConsole({
+  module: AppModule,
+  useDecorators: true,
+});
+
+bootstrap.init().then(async (app) => {
+  try {
+    await app.init();
+
+    await bootstrap.boot();
+
+    await app.close();
+  } catch (e) {
+    console.error(e);
+
+    await app.close();
+
+    process.exit(1);
+  }
+});

package/src/app.guard.ts

@@ -0,0 +1,39 @@
+import { ExecutionContext, Inject, Injectable, UnauthorizedException } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { AuthGuard as JwtGuard } from '@nestjs/passport';
+import { IS_PUBLIC_KEY } from './decorators/public.decorator';
+import { DecodedUser } from './decorators/user.decorator';
+
+declare module 'express' {
+  interface Request {
+    user?: DecodedUser;
+  }
+}
+
+@Injectable()
+export class AuthGuard extends JwtGuard('jwt') {
+  public isPublic = false;
+  @Inject()
+  private reflector: Reflector;
+
+  public async canActivate(context: ExecutionContext): Promise<any> {
+    this.isPublic = this.reflector.getAllAndOverride<boolean>(IS_PUBLIC_KEY, [
+      context.getHandler(),
+      context.getClass(),
+    ]);
+
+    return super.canActivate(context);
+  }
+
+  public handleRequest(err: Record<string, unknown>, user: DecodedUser): any {
+    if (err) {
+      throw err;
+    }
+
+    if (!user && !this.isPublic) {
+      throw new UnauthorizedException();
+    }
+
+    return user || undefined;
+  }
+}