Merge pull request #4 from knovator/APIs-project_template

APIs for Project & Template

apps/api/package.json

@@ -19,6 +19,7 @@
   },
   "dependencies": {
     "@impler/dal": "workspace:^1.0.0",
+    "@impler/shared": "workspace:^1.0.0",
     "@nestjs/common": "^9.1.2",
     "@nestjs/core": "^9.1.2",
     "@nestjs/platform-express": "^9.1.2",

apps/api/src/app/project/dtos/create-project-request.dto.ts

@@ -1,5 +1,7 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { IsDefined, IsString, Validate } from 'class-validator';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsDefined, IsOptional, IsString, Validate } from 'class-validator';
+import { Transform } from 'class-transformer';
+import { changeToCode } from '@impler/shared';
 import { UniqueValidator } from '../../shared/framework/IsUniqueValidator';
 
 export class CreateProjectRequestDto {
@@ -18,5 +20,13 @@ export class CreateProjectRequestDto {
   @Validate(UniqueValidator, ['Project', 'code'], {
     message: 'Code is already taken',
   })
+  @Transform((value) => changeToCode(value.value))
   code: string;
+
+  @ApiPropertyOptional({
+    description: 'Name of authentication header to sent along the request',
+  })
+  @IsString()
+  @IsOptional()
+  authHeaderName: string;
 }

apps/api/src/app/project/dtos/project-response.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { IsDefined, IsString } from 'class-validator';
+import { IsDefined, IsOptional, IsString } from 'class-validator';
 
 export class ProjectResponseDto {
   @ApiPropertyOptional({
@@ -22,4 +22,11 @@ export class ProjectResponseDto {
   @IsString()
   @IsDefined()
   code: string;
+
+  @ApiPropertyOptional({
+    description: 'Name of authentication header to sent along the request',
+  })
+  @IsString()
+  @IsOptional()
+  authHeaderName?: string;
 }

apps/api/src/app/project/dtos/update-project-request.dto.ts

@@ -1,11 +1,18 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { IsDefined, IsString } from 'class-validator';
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { IsOptional, IsString } from 'class-validator';
 
 export class UpdateProjectRequestDto {
-  @ApiProperty({
+  @ApiPropertyOptional({
     description: 'Name of the project',
   })
   @IsString()
-  @IsDefined()
+  @IsOptional()
   name: string;
+
+  @ApiPropertyOptional({
+    description: 'Name of authentication header to sent along the request',
+  })
+  @IsString()
+  @IsOptional()
+  authHeaderName: string;
 }

apps/api/src/app/project/project.controller.ts

@@ -45,6 +45,7 @@ export class ProjectController {
       CreateProjectCommand.create({
         code: body.code,
         name: body.name,
+        authHeaderName: body.authHeaderName,
       })
     );
   }
@@ -61,7 +62,7 @@ export class ProjectController {
     @Param('projectId', ValidateMongoId) projectId: string
   ): Promise<ProjectResponseDto> {
     const document = await this.updateProjectUsecase.execute(
-      UpdateProjectCommand.create({ name: body.name }),
+      UpdateProjectCommand.create({ name: body.name, authHeaderName: body.authHeaderName }),
       projectId
     );
     if (!document) {

apps/api/src/app/project/usecases/create-project/create-project.command.ts

@@ -1,4 +1,4 @@
-import { IsDefined, IsString } from 'class-validator';
+import { IsDefined, IsOptional, IsString } from 'class-validator';
 import { BaseCommand } from '../../../shared/commands/base.command';
 
 export class CreateProjectCommand extends BaseCommand {
@@ -9,4 +9,8 @@ export class CreateProjectCommand extends BaseCommand {
   @IsDefined()
   @IsString()
   code: string;
+
+  @IsOptional()
+  @IsString()
+  authHeaderName: string;
 }

apps/api/src/app/project/usecases/get-projects/get-projects.usecase.ts

@@ -14,6 +14,7 @@ export class GetProjects {
         _id: project._id,
         name: project.name,
         code: project.code,
+        authHeaderName: project.authHeaderName,
       };
     });
   }

apps/api/src/app/project/usecases/update-project/update-project.command.ts

@@ -1,8 +1,12 @@
-import { IsDefined, IsString } from 'class-validator';
+import { IsOptional, IsString } from 'class-validator';
 import { BaseCommand } from '../../../shared/commands/base.command';
 
 export class UpdateProjectCommand extends BaseCommand {
-  @IsDefined()
+  @IsOptional()
   @IsString()
   name: string;
+
+  @IsOptional()
+  @IsString()
+  authHeaderName: string;
 }

apps/api/src/app/template/dtos/create-template-request.dto.ts

@@ -1,4 +1,6 @@
 import { ApiProperty } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+import { changeToCode } from '@impler/shared';
 import { IsDefined, IsString, Validate, IsNumber } from 'class-validator';
 import { UniqueValidator } from '../../shared/framework/IsUniqueValidator';
 
@@ -18,6 +20,7 @@ export class CreateTemplateRequestDto {
   @Validate(UniqueValidator, ['Template', 'code'], {
     message: 'Code is already taken',
   })
+  @Transform((value) => changeToCode(value.value))
   code: string;
 
   @ApiProperty({

libs/dal/src/repositories/project/project.entity.ts

@@ -4,4 +4,6 @@ export class ProjectEntity {
   name: string;
 
   code: string;
+
+  authHeaderName: string;
 }

libs/dal/src/repositories/project/project.schema.ts

@@ -10,6 +10,9 @@ const projectSchema = new Schema(
     code: {
       type: Schema.Types.String,
     },
+    authHeaderName: {
+      type: Schema.Types.String,
+    },
   },
   { ...schemaOptions }
 );

libs/shared/.dockerignore

@@ -0,0 +1 @@
+node_modules

libs/shared/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['../../.eslintrc.js'],
+};

libs/shared/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["src"],
+  "ext": "ts",
+  "ignore": ["src/**/*.spec.ts"],
+  "exec": "ts-node -r tsconfig-paths/register src/main.app.ts"
+}

libs/shared/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@impler/shared",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "start": "npm run start:dev",
+    "afterinstall": "pnpm build",
+    "prebuild": "rimraf dist",
+    "build": "cross-env node_modules/.bin/tsc -p tsconfig.build.json",
+    "build:watch": "cross-env node_modules/.bin/tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "start:dev": "pnpm build:watch",
+    "precommit": "lint-staged",
+    "lint": "eslint src",
+    "lint:fix": "pnpm lint -- --fix",
+    "test": "",
+    "test:watch": ""
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.18",
+    "typescript": "^4.8.3"
+  },
+  "dependencies": {
+    "rimraf": "^3.0.2"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": ["prettier --ignore-path .eslintignore --write"],
+    "{*.json,.{babelrc,eslintrc,prettierrc,stylelintrc}}": [
+      "prettier --ignore-path .eslintignore --parser json --write"
+    ],
+    "*.{html,md,yml}": ["prettier --ignore-path .eslintignore --single-quote --write"]
+  }
+}

libs/shared/src/index.ts

@@ -0,0 +1 @@
+export * from './utils/helpers';

libs/shared/src/utils/helpers.ts

@@ -0,0 +1,5 @@
+export const changeToCode = (str = '') =>
+  str
+    ?.replace(/[^\s\w]/gi, '')
+    ?.toUpperCase()
+    ?.replace(/ /g, '_');

libs/shared/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["node"]
+  },
+  "include": ["src/**/*"]
+}

libs/shared/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}

package.json

@@ -13,7 +13,8 @@
     "prebuild": "nx run-many --target=prebuild --all",
     "build": "nx run-many --target=build --all",
     "build:api": "nx build @impler/api",
-    "build:dal": "nx build @impler/dal"
+    "build:dal": "nx build @impler/dal",
+    "build:shared": "nx build @impler/shared"
   },
   "keywords": [
     "data-import",