feat: added places module with all features; fixed some serverless pr…

…oblems and permissions in serverless.yml; fixed some logic in users/ module

README.md

@@ -14,5 +14,8 @@ Run those commands in the terminal:
 4. curl http://localhost:8000/service/status
 
 ## To deploy (aws provider)
-1. Install serverless framework ([Click here] (https://www.serverless.com/framework/docs/getting-started))
+1. Install [serverless framework](https://github.com/nestjs/typescript-starter)
 2. run this command: serverless deploy
+
+## Postman Documentation
+[Version 0.0.1](https://documenter.getpostman.com/view/1334597/2s8YzZNe9C)

config/env/local.env

@@ -1,2 +1,2 @@
-DB_RUN_LOCAL=true
+DB_RUN_LOCAL=false
 DB_TABLE_SUFFIX=dev

package.json

@@ -9,9 +9,9 @@
     "prebuild": "rimraf dist",
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "start": "STAGE=local nest start --watch",
-    "start:debug": "STAGE=local nest start --debug --watch",
-    "start:prod": "STAGE=prd node dist/main",
+    "start": "stage=local nest start --watch",
+    "start:debug": "stage=local nest start --debug --watch",
+    "start:prod": "stage=prd node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "test:watch": "jest --watch",
@@ -23,7 +23,6 @@
     "deploy:prd": "nest build && serverless deploy --aws-profile hubia-deploy --stage prd"
   },
   "dependencies": {
-    "@aws/dynamodb-data-mapper": "^0.7.3",
     "@aws/dynamodb-data-mapper-annotations": "^0.7.3",
     "@nestjs/common": "^9.0.0",
     "@nestjs/config": "^2.2.0",

serverless.yml

@@ -6,6 +6,26 @@ provider:
   region: us-east-1
   apiName: ${self:service}-${self:custom.stage}
 
+  iamRoleStatements:
+    - Effect: Allow
+      Action:
+        - dynamodb:Query
+        - dynamodb:Scan
+        - dynamodb:GetItem
+        - dynamodb:PutItem
+        - dynamodb:UpdateItem
+        - dynamodb:DeleteItem
+      Resource:
+        - "arn:aws:dynamodb:${self:provider.region}:*:table/hub-users-${self:custom.stage}"
+        - "arn:aws:dynamodb:${self:provider.region}:*:table/hub-places-${self:custom.stage}"
+    - Effect: Allow
+      Action:
+        - dynamodb:Query
+        - dynamodb:Scan
+      Resource: 
+        - "arn:aws:dynamodb:${self:provider.region}:*:table/hub-users-${self:custom.stage}/index/*"
+        - "arn:aws:dynamodb:${self:provider.region}:*:table/hub-places-${self:custom.stage}/index/*"
+
   stackTags:
     service: ${self:service}
     stage:   ${self:custom.stage}
@@ -86,4 +106,32 @@ resources:
             Projection:
               NonKeyAttributes:
                 - id
-              ProjectionType: INCLUDE
+              ProjectionType: INCLUDE
+
+    PlacesTable:
+      Type: AWS::DynamoDB::Table
+      Properties:
+        TableName: hub-places-${self:custom.stage}
+        BillingMode: PAY_PER_REQUEST
+        AttributeDefinitions:
+          - AttributeName: id
+            AttributeType: S
+          - AttributeName: ownerId
+            AttributeType: S
+        KeySchema:
+          - AttributeName: id
+            KeyType: HASH
+        GlobalSecondaryIndexes:
+          - IndexName: GsiOwner
+            KeySchema:
+            - AttributeName: ownerId
+              KeyType: HASH
+            Projection:
+              NonKeyAttributes:
+                - id
+              ProjectionType: INCLUDE
+
+    S3:
+      Type: AWS::S3::Bucket
+      Properties:
+        BucketName: ${self:service}-${self:custom.stage}

src/app.module.ts

@@ -4,14 +4,16 @@ import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { AuthModule } from './auth/auth.module';
 import { UsersModule } from './users/users.module';
+import { PlacesModule } from './places/places.module';
 
 const STAGE = process.env.STAGE;
 
 @Module({
   imports: [
-    ConfigModule.forRoot({ envFilePath: `${process.cwd()}/config/env/${process.env.STAGE}.env` }),
+    ConfigModule.forRoot({ envFilePath: `${process.cwd()}/config/env/${process.env.stage}.env` }),
     UsersModule,
-    AuthModule
+    AuthModule,
+    PlacesModule
   ],
   controllers: [AppController],
   providers: [AppService]

src/app.service.ts

@@ -9,7 +9,7 @@ export class AppService {
     return {
       startedAt: this.startedAt,
       name: "hub_delivery_api",
-      env: process.env.STAGE,
+      env: process.env.stage,
       debugDb: process.env.DB_RUN_LOCAL,
       suffixDb: process.env.DB_TABLE_SUFFIX
     }

src/commons/exceptions/error-def.entity.ts

@@ -17,5 +17,10 @@ export enum ErrorsType {
 
 export const ErrorsConst = {
   alreadyExists: new ErrorDef({code: 1, description: "alreadyExists", type: ErrorsType.LOGIC}),
-  invalidInput: new ErrorDef({code: 2, description: "invalidInput", type: ErrorsType.LOGIC})
+  invalidInput: new ErrorDef({code: 2, description: "invalidInput", type: ErrorsType.LOGIC}),
+  notAllowed: new ErrorDef({code: 3, description: "notAllowed", type: ErrorsType.LOGIC}),
+  resourceNotFound: new ErrorDef({code: 4, description: "resourceNotFound", type: ErrorsType.LOGIC}),
+
+
+
 }

src/index.ts

@@ -5,13 +5,20 @@ import { Server } from 'http';
 import { ExpressAdapter } from '@nestjs/platform-express';
 import * as awsServerlessExpress from 'aws-serverless-express';
 import * as express from 'express';
+import { ValidationPipe } from '@nestjs/common';
+import { HttpServiceExceptionFilter } from './commons/filters/http-service-exception.filter';
 
 let cachedServer: Server;
 
 const bootstrapServer = async (): Promise<Server> => {
   const expressApp = express();
   const adapter = new ExpressAdapter(expressApp);
-  const app = await NestFactory.create(AppModule, adapter);
+  const app = await NestFactory.create(AppModule, adapter, {
+    logger: console
+  });
+
+  app.useGlobalPipes(new ValidationPipe());
+  app.useGlobalFilters(new HttpServiceExceptionFilter());
   app.enableCors();
   await app.init();
   return awsServerlessExpress.createServer(expressApp);

src/places/dto/address.dto.ts

@@ -0,0 +1,22 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+
+export class AddressDto {
+  @IsNotEmpty()
+  zipcode: number;
+  @IsNotEmpty()
+  street: string;
+  @IsNotEmpty()
+  number: string;
+  complement: string;
+  @IsNotEmpty()
+  city: string;
+  @IsNotEmpty()
+  @Length(2, 2)
+  state: string;
+  @IsNotEmpty()
+  district: string;
+  @IsNotEmpty()
+  lat: number;
+  @IsNotEmpty()
+  lng: number;
+}

src/places/dto/create-place.dto.ts

@@ -0,0 +1,19 @@
+import { Address } from "../entities/address.entity";
+import { Types } from "../entities/place.entity";
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject, ValidateNested } from "class-validator";
+import { Type } from 'class-transformer';
+import { AddressDto } from "./address.dto";
+
+export class CreatePlaceDto {
+  @IsNotEmpty()
+  title: string;
+  @IsNotEmpty()  
+  whatsappContact: string;
+  imageUrl: string;
+
+  @IsNotEmptyObject()
+  @IsObject()
+  @ValidateNested()
+  @Type(() => AddressDto)
+  address: AddressDto;
+}

src/places/dto/menu-section-item.dto.ts

@@ -0,0 +1,15 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+import { MultipleChoiceOptionsDto } from "./multiple-choice.dto";
+import { OneChoiceOptionDto } from "./one-choice-option.dto";
+
+export class MenuSectionItemDto {
+  id: string;
+  placeId: string;
+  sectionId: string;
+  title: string;
+  description: string;
+  value: number;
+  imageUrl: string;
+  oneChoiceOptions: OneChoiceOptionDto[];
+  multipleChoiceOptions: MultipleChoiceOptionsDto[];
+}

src/places/dto/menu-section.dto.ts

@@ -0,0 +1,7 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+
+export class MenuSectionDto {
+  id: string;
+  placeId: string;
+  title: string;
+}

src/places/dto/multiple-choice.dto.ts

@@ -0,0 +1,9 @@
+import { OptionDto } from "./option.dto";
+
+
+export class MultipleChoiceOptionsDto {
+  title: string;
+  options: OptionDto[];
+  min: number;
+  max: number;
+}

src/places/dto/one-choice-option.dto.ts

@@ -0,0 +1,7 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+import { OptionDto } from "./option.dto";
+
+export class OneChoiceOptionDto {
+  title: string;
+  options: OptionDto[];
+}

src/places/dto/option.dto.ts

@@ -0,0 +1,7 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+
+export class OptionDto {
+  title: string;
+  description: string;
+  value: number;
+}

src/places/dto/update-place.dto.ts

@@ -0,0 +1,4 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { CreatePlaceDto } from './create-place.dto';
+
+export class UpdatePlaceDto extends PartialType(CreatePlaceDto) {}

src/places/entities/address.entity.ts

@@ -0,0 +1,21 @@
+export class Address {
+  public constructor(init?:Partial<Address>) {
+    Object.assign(this, init);
+  }
+
+  id: string;
+  zipcode: number;
+  street: string;
+  number: string;
+  complement: string;
+  city: string;
+  state: string;
+  district: string;
+  //
+  // GoogleMaps
+  completeByGeo: string;
+  lat: number;
+  lng: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

src/places/entities/menu-section-item.ts

@@ -0,0 +1,18 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+import { MultipleChoiceOptions } from "./multiple-choice";
+import { OneChoiceOption } from "./one-choice-option";
+
+export class MenuSectionItem {
+  public constructor(init?:Partial<MenuSectionItem>) {
+    Object.assign(this, init);
+  }
+
+  id: string;
+  sectionId: string;
+  title: string;
+  description: string;
+  value: number;
+  imageUrl: string;
+  oneChoiceOptions: OneChoiceOption[];
+  multipleChoiceOptions: MultipleChoiceOptions[];
+}

src/places/entities/menu-section.ts

@@ -0,0 +1,13 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+import { MenuSectionItem } from "./menu-section-item";
+
+export class MenuSection {
+  public constructor(init?:Partial<MenuSection>) {
+    Object.assign(this, init);
+  }
+
+  id: string;
+  placeId: string;
+  title: string;
+  itens: MenuSectionItem[];
+}

src/places/entities/multiple-choice.ts

@@ -0,0 +1,9 @@
+import { Option } from "./option";
+
+
+export class MultipleChoiceOptions {
+  title: string;
+  options: Option[];
+  min: number;
+  max: number;
+}

src/places/entities/one-choice-option.ts

@@ -0,0 +1,7 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+import { Option } from "./option";
+
+export class OneChoiceOption {
+  title: string;
+  options: Option[];
+}

src/places/entities/option.ts

@@ -0,0 +1,7 @@
+import { IsEmail, IsNotEmpty, Length, IsNotEmptyObject, IsObject } from "class-validator";
+
+export class Option {
+  title: string;
+  description: string;
+  value: number;
+}