@merkaly/api 0.1.5 → 0.1.9-2

package/package.json

@@ -1,87 +1,80 @@
 {
   "name": "@merkaly/api",
-  "version": "0.1.5",
+  "version": "0.1.9-2",
   "description": "NestJS Backend ApiRest Service",
   "author": "Randy Tellez Galan <kronhyx@gmail.com>",
   "license": "UNLICENSED",
   "main": "src",
-  "files": [
-    "!src/app.*.*",
-    "!src/**/*.module.*",
-    "!src/**/*.controller.*",
-    "!src/**/*.repository.*",
-    "src/**/*.entity.ts",
-    "src/**/*.validator.ts"
-  ],
   "scripts": {
-    "prebuild": "npm run clean",
-    "prepack": "npm run build",
-    "build": "tsc --b",
+    "prebuild": "yarn run clean",
+    "prepack": "yarn build",
+    "build": "nest build",
     "clean": "tsc -b --clean",
     "start": "nest start --preserveWatchOutput",
-    "dev": "npm run clean && npm start -- --watch",
-    "start:debug": "npm run dev -- --debug ",
+    "dev": "yarn run clean && npm start -- --watch",
+    "start:debug": "yarn dev -- --debug ",
     "start:prod": "node dist/index.js",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" . ",
     "test": "jest",
-    "test:watch": "npm run test -- --watch",
-    "test:cov": "npm run test -- --coverage",
+    "test:watch": "yarn test -- --watch",
+    "test:cov": "yarn test -- --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "semantic-release": "npm run build:package && semantic-release"
+    "semantic-release": "yarn run build:package && semantic-release"
   },
   "dependencies": {
+    "@nestjs/axios": "^0.0.5",
     "@nestjs/swagger": "^5.0.9",
     "@types/auth0": "^2.33.4",
-    "@types/node": "^16.0.0",
+    "@types/node": "^17.0.2",
     "auth0": "^2.35.0",
-    "class-transformer": "^0.4.0",
+    "class-transformer": "^0.5.1",
     "class-validator": "^0.13.1",
-    "fireorm": "^0.22.0",
+    "fireorm": "^0.23.0",
     "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^13.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
     "@elastic/elasticsearch": "^7.13.0",
-    "@nestjs/cli": "8.1.1",
-    "@nestjs/common": "8.0.6",
+    "@nestjs/cli": "8.2.0",
+    "@nestjs/common": "8.2.6",
     "@nestjs/config": "^1.0.0",
-    "@nestjs/core": "8.0.6",
+    "@nestjs/core": "8.2.6",
     "@nestjs/elasticsearch": "8.0.0",
     "@nestjs/event-emitter": "^1.0.0",
     "@nestjs/jwt": "8.0.0",
-    "@nestjs/passport": "8.0.1",
-    "@nestjs/platform-express": "8.0.6",
-    "@nestjs/schematics": "8.0.2",
-    "@nestjs/testing": "8.0.6",
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
+    "@nestjs/passport": "8.1.0",
+    "@nestjs/platform-express": "8.2.6",
+    "@nestjs/schematics": "8.0.5",
+    "@nestjs/testing": "8.2.6",
+    "@semantic-release/exec": "^6.0.1",
+    "@semantic-release/git": "^10.0.0",
     "@types/express": "^4.17.12",
-    "@types/faker": "^5.5.6",
+    "@types/faker": "^5.5.9",
     "@types/jest": "^27.0.0",
     "@types/multer": "^1.4.7",
     "@types/passport-jwt": "^3.0.5",
     "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "4.29.2",
-    "@typescript-eslint/parser": "4.29.2",
+    "@typescript-eslint/eslint-plugin": "4.33.0",
+    "@typescript-eslint/parser": "4.33.0",
+    "commitlint": "^16.1.0",
     "eslint": "7.32.0",
     "eslint-plugin-import": "^2.23.4",
     "faker": "^5.5.3",
-    "firebase": "^8.6.8",
-    "firebase-admin": "^9.9.0",
+    "firebase": "^9.0.0",
+    "firebase-admin": "^10.0.2",
     "husky": "^7.0.0",
-    "jest": "27.0.6",
+    "jest": "27.4.7",
     "passport": "^0.4.1",
     "passport-jwt": "^4.0.0",
     "rimraf": "^3.0.2",
     "rxjs": "^7.2.0",
-    "semantic-release": "^17.4.4",
+    "semantic-release": "^18.0.0",
     "supertest": "^6.1.3",
     "swagger-ui-express": "^4.1.5",
-    "ts-jest": "27.0.5",
+    "ts-jest": "27.1.3",
     "ts-loader": "^9.2.3",
     "ts-node": "^10.0.0",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^4.3.4"
+    "tsconfig-paths": "^3.9.0"
   },
   "repository": {
     "type": "git",

package/src/account/organizations/members/member.validator.d.ts

@@ -0,0 +1,2 @@
+export declare type AddOrganizationMembers = string[];
+export declare type RemoveOrganizationMembers = string[];

package/src/account/organizations/members/member.validator.ts

@@ -0,0 +1,3 @@
+export type AddOrganizationMembers = string[]
+
+export type RemoveOrganizationMembers = string[]

package/src/account/organizations/organization.entity.d.ts

@@ -1,3 +1,4 @@
+import { Organization } from 'auth0';
 import AppEntity from '../../app.entity';
 export interface OrganizationBrandingColors {
     page_background: string;
@@ -7,9 +8,10 @@ export interface OrganizationBranding {
     logo_url: string;
     colors: OrganizationBrandingColors;
 }
-export declare class OrganizationEntity extends AppEntity {
+export declare class OrganizationEntity extends AppEntity implements Organization {
     static readonly $path = "organizations";
     name: string;
     display_name: string;
     branding: OrganizationBranding;
+    metadata: Record<string, string>;
 }

package/src/account/organizations/organization.entity.ts

@@ -1,3 +1,4 @@
+import { Organization } from 'auth0'
 import AppEntity from '../../app.entity'
 
 export interface OrganizationBrandingColors {
@@ -10,7 +11,7 @@ export interface OrganizationBranding {
   colors: OrganizationBrandingColors
 }
 
-export class OrganizationEntity extends AppEntity {
+export class OrganizationEntity extends AppEntity implements Organization {
   static readonly $path = 'organizations'
 
   public name: string
@@ -18,4 +19,6 @@ export class OrganizationEntity extends AppEntity {
   public display_name: string
 
   public branding: OrganizationBranding
+
+  public metadata: Record<string, string>
 }

package/src/account/organizations/organization.validator.ts

@@ -1,41 +1,52 @@
+import { ApiProperty } from '@nestjs/swagger'
 import { IsHexColor, IsOptional, IsString, IsUrl } from 'class-validator'
+import { company, image, internet, lorem } from 'faker'
 
 export class CreateOrganizationValidator {
 
   @IsString()
+  @ApiProperty({ example: lorem.word(8) })
   name: string
 
   @IsString()
+  @ApiProperty({ example: company.companyName() })
   display_name: string
 
   @IsUrl({})
   @IsOptional()
+  @ApiProperty({ required: false, example: image.avatar() })
   logo_url?: string
 
   @IsHexColor()
   @IsOptional()
+  @ApiProperty({ required: false, example: internet.color() })
   primary_color?: string
 
   @IsHexColor()
   @IsOptional()
+  @ApiProperty({ required: false, example: internet.color() })
   secondary_color?: string
 }
 
 export class UpdateOrganizationValidator {
   @IsString()
   @IsOptional()
+  @ApiProperty({ required: false })
   display_name?: string
 
   @IsUrl()
   @IsOptional()
+  @ApiProperty({ required: false, example: image.avatar() })
   logo_url?: string
 
   @IsHexColor()
   @IsOptional()
+  @ApiProperty({ required: false, example: internet.color() })
   primary_color?: string
 
   @IsString()
   @IsHexColor()
   @IsOptional()
+  @ApiProperty({ required: false, example: internet.color() })
   secondary_color?: string
 }

package/src/account/roles/users/user.validator.d.ts

@@ -1,4 +1,2 @@
-export declare class AddRoleUserValidator {
-    name: string;
-    description: string;
-}
+export declare type AddRoleUsers = string[];
+export declare type RemoveRoleUsers = string[];

package/src/account/roles/users/user.validator.ts

@@ -1,10 +1,3 @@
-import { IsOptional, IsString } from 'class-validator'
+export type AddRoleUsers = string[]
 
-export class AddRoleUserValidator {
-  @IsString()
-  name: string
-
-  @IsString()
-  @IsOptional()
-  description: string
-}
+export type RemoveRoleUsers = string[]

package/src/account/users/roles/role.validator.d.ts

@@ -1,4 +1,2 @@
-export declare class AddRoleValidator {
-    name: string;
-    description: string;
-}
+export declare type AddUserRole = string[];
+export declare type RemoveUserRole = string[];

package/src/account/users/roles/role.validator.ts

@@ -1,10 +1,3 @@
-import { IsOptional, IsString } from 'class-validator'
+export type AddUserRole = string[]
 
-export class AddRoleValidator {
-  @IsString()
-  name: string
-
-  @IsString()
-  @IsOptional()
-  description: string
-}
+export type RemoveUserRole = string[]

package/src/account/users/user.validator.d.ts

@@ -2,10 +2,10 @@ import { UpdateUserData, UserData } from 'auth0';
 export declare class CreateUserValidator implements UserData {
     email: string;
     password: string;
-    phone_number: string;
     name: string;
 }
 export declare class UpdateUserValidator implements UpdateUserData {
-    phone_number: string;
-    name: string;
+    name?: string;
+    nickname?: string;
+    picture?: string;
 }

package/src/account/users/user.validator.ts

@@ -1,5 +1,5 @@
 import { UpdateUserData, UserData } from 'auth0'
-import { IsEmail, IsOptional, IsString } from 'class-validator'
+import { IsEmail, IsOptional, IsString, IsUrl } from 'class-validator'
 
 export class CreateUserValidator implements UserData {
   @IsEmail()
@@ -8,10 +8,6 @@ export class CreateUserValidator implements UserData {
   @IsString()
   password: string
 
-  @IsOptional()
-  @IsString()
-  phone_number: string
-
   @IsOptional()
   @IsString()
   name: string
@@ -21,9 +17,13 @@ export class CreateUserValidator implements UserData {
 export class UpdateUserValidator implements UpdateUserData {
   @IsOptional()
   @IsString()
-  phone_number: string
+  name?: string
 
   @IsOptional()
   @IsString()
-  name: string
+  nickname?: string
+
+  @IsOptional()
+  @IsUrl()
+  picture?: string
 }

package/src/app.d.ts

@@ -0,0 +1 @@
+export {};

package/src/app.emitter.d.ts

@@ -0,0 +1,16 @@
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { event, eventNS } from 'eventemitter2';
+export declare enum AbstractEvent {
+    ENTITY_LISTED = "entity.*.listed",
+    ENTITY_READED = "entity.*.readed",
+    ENTITY_CREATED = "entity.*.created",
+    ENTITY_UPDATED = "entity.*.updated",
+    ENTITY_DELETED = "entity.*.deleted",
+    ENTITY_NOT_FOUND = "entity.*.not_found",
+    ENTITY_SYNCED = "entity.*.synced"
+}
+export default class AppEmitter {
+    protected readonly emitter: EventEmitter2;
+    emit(event: event | eventNS, ...values: any[]): boolean;
+    private handleAllEvents;
+}

package/src/app.emitter.ts

@@ -0,0 +1,27 @@
+import { Inject, Injectable, Logger } from '@nestjs/common'
+import { EventEmitter2, OnEvent } from '@nestjs/event-emitter'
+import { event, eventNS } from 'eventemitter2'
+
+export enum AbstractEvent {
+  ENTITY_LISTED = 'entity.*.listed',
+  ENTITY_READED = 'entity.*.readed',
+  ENTITY_CREATED = 'entity.*.created',
+  ENTITY_UPDATED = 'entity.*.updated',
+  ENTITY_DELETED = 'entity.*.deleted',
+  ENTITY_NOT_FOUND = 'entity.*.not_found',
+  ENTITY_SYNCED = 'entity.*.synced',
+}
+
+@Injectable()
+export default class AppEmitter {
+  @Inject() protected readonly emitter: EventEmitter2
+
+  public emit (event: event | eventNS, ...values: any[]) {
+    return this.emitter.emit(event, values)
+  }
+
+  @OnEvent('*.*.*')
+  private handleAllEvents (payload: any, name: string) {
+    return Logger.debug(`Event '${name}' has emitted an ${typeof payload}`, AppEmitter.name)
+  }
+}

package/src/app.entity.d.ts

@@ -0,0 +1,7 @@
+import { TransformFnParams } from 'class-transformer';
+import { IEntity } from 'fireorm';
+export default abstract class AppEntity implements IEntity {
+    static readonly $path: string;
+    id: string;
+    static transformSubCollection({ value }: TransformFnParams): string;
+}

package/src/app.entity.ts

@@ -1,5 +1,4 @@
 import { TransformFnParams } from 'class-transformer'
-import { firestore } from 'firebase-admin'
 import { IEntity } from 'fireorm'
 
 export default abstract class AppEntity implements IEntity {
@@ -11,10 +10,4 @@ export default abstract class AppEntity implements IEntity {
     return value.path
   }
 
-  public static async setReference (value: string): Promise<any> {
-    const { ref } = await firestore().collection(this.$path).doc(value).get()
-
-    return ref
-  }
-
 }

package/src/app.routes.d.ts

@@ -0,0 +1,3 @@
+import { RouteTree } from '@nestjs/core/router/interfaces/routes.interface';
+declare const routes: RouteTree[];
+export default routes;

package/src/app.routes.ts

@@ -0,0 +1,61 @@
+import { RouteTree } from '@nestjs/core/router/interfaces/routes.interface'
+import { $AccountPath, OrganizationEntity, RoleEntity, UserEntity } from './account'
+import AccountModule from './account/account.module'
+import { $AuthPath as AccountAuthPath } from './account/auth'
+import AuthModule from './account/auth/auth.module'
+import MemberModule from './account/organizations/members/member.module'
+import OrganizationModule from './account/organizations/organization.module'
+import RoleModule from './account/roles/role.module'
+import RoleUserModule from './account/roles/users/user.module'
+import UserRoleModule from './account/users/roles/role.module'
+import UserModule from './account/users/user.module'
+import { $InventoryPath, ProductEntity } from './inventory'
+import BrandModule from './inventory/brands/brand.module'
+import CategoryModule from './inventory/categories/category.module'
+import InventoryModule from './inventory/inventory.module'
+import MediaModule from './inventory/products/media/media.module'
+import ProductModule from './inventory/products/product.module'
+import VariantModule from './inventory/products/variants/variant.module'
+import PropertyModule from './inventory/properties/property.module'
+import { $StorePath, OrderEntity } from './store'
+import CartModule from './store/carts/cart.module'
+import ItemModule from './store/orders/items/item.module'
+import OrderModule from './store/orders/order.module'
+import StoreModule from './store/store.module'
+
+const addModule = (module, children = [], path = '/'): RouteTree => ({ path, module, children })
+
+const routes = [
+  addModule(AuthModule, [], AccountAuthPath),
+
+  addModule(AccountModule, [
+    addModule(UserModule, [
+      addModule(UserRoleModule, [], UserEntity.$path)
+    ]),
+    addModule(OrganizationModule, [
+      addModule(MemberModule, [], OrganizationEntity.$path)
+    ]),
+    addModule(RoleModule, [
+      addModule(RoleUserModule, [], RoleEntity.$path)
+    ])
+  ], $AccountPath),
+
+  addModule(InventoryModule, [
+    addModule(BrandModule),
+    addModule(CategoryModule),
+    addModule(PropertyModule),
+    addModule(ProductModule, [
+      addModule(VariantModule, [], ProductEntity.$path),
+      addModule(MediaModule, [], ProductEntity.$path)
+    ])
+  ], $InventoryPath),
+
+  addModule(StoreModule, [
+    addModule(CartModule),
+    addModule(OrderModule, [
+      addModule(ItemModule, [], OrderEntity.$path)
+    ])
+  ], $StorePath)
+]
+
+export default routes

package/src/app.ts

@@ -1,40 +0,0 @@
-import { ClassSerializerInterceptor, Logger, ValidationPipe } from '@nestjs/common'
-import { NestApplication, NestFactory, Reflector } from '@nestjs/core'
-import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
-import { credential, initializeApp } from 'firebase-admin'
-import { initialize } from 'fireorm'
-// import AuthGuard from './account/auth/auth.guard'
-import AppConfig from './app.config'
-import AppModule from './app.module'
-
-(async () => {
-  //Initializing Firebase connection
-  const firebase = initializeApp({
-    credential: credential.applicationDefault(),
-    storageBucket: AppConfig.firebase.storageBucket
-  })
-
-  initialize(firebase.firestore())
-
-  const app = await NestFactory.create(AppModule, { cors: true })
-
-  const builder = new DocumentBuilder()
-    .setTitle(AppConfig.server.name)
-    .setDescription(AppConfig.server.description)
-    .setVersion(AppConfig.server.version)
-    .build()
-
-  //Creating Swagger Doc for API
-  const document = SwaggerModule.createDocument(app, builder)
-  SwaggerModule.setup('/', app, document)
-
-  const reflector = app.get(Reflector)
-  // const authGuard = app.get(AuthGuard)
-
-  return app
-    .useGlobalInterceptors(new ClassSerializerInterceptor(reflector))
-    // .useGlobalGuards(authGuard)
-    .useGlobalPipes(new ValidationPipe({ whitelist: true }))
-    .listen(AppConfig.server.port)
-    .then(() => Logger.verbose(`Running on port: ${AppConfig.server.port}`, NestApplication.name))
-})()