@maioradv/nestjs-core 1.0.1 → 1.0.2

package/lib/dto/pagination/paginated-response.decorator.ts

@@ -1,49 +0,0 @@
-import { HttpStatus, Type, applyDecorators } from "@nestjs/common";
-import { ApiExtraModels, ApiOkResponse, ApiResponseOptions, getSchemaPath } from "@nestjs/swagger";
-import PaginatedMetaDto from "./paginated-meta.dto";
-import PaginatedDto from "./paginated.dto";
-import { RelationDefs, handleRelationsForSwagger } from "@/decorators";
-
-const ApiPaginatedResponse = <TModel extends Type<any>>(
-  model: TModel,
-  relations?:RelationDefs,
-  options?: ApiResponseOptions,
-) => {
-  const {properties,extraModels} = relations ? handleRelationsForSwagger(relations) : {properties:undefined,extraModels:[]}
-  return applyDecorators(
-    ApiExtraModels(PaginatedMetaDto, PaginatedDto, model, ...extraModels),
-    ApiOkResponse({
-      status:HttpStatus.OK,
-      description:`${model.name}s`,
-      schema: {
-        title: `Paginated${model.name}Dto`,
-        allOf: [
-          { $ref: getSchemaPath(PaginatedDto) },
-          {
-            properties: {
-              data: {
-                
-                type: 'array',
-                items: { 
-                  title:`${model.name}s`,
-                  allOf:[
-                    { $ref: getSchemaPath(model) },
-                    {
-                      properties:properties
-                    }
-                  ]
-                },          
-              },
-              meta: {
-                $ref: getSchemaPath(PaginatedMetaDto)
-              },
-            },
-          },
-        ],
-      },
-      ...options
-    }),
-  );
-};
-
-export default ApiPaginatedResponse

package/lib/dto/pagination/paginated.dto.ts

@@ -1,15 +0,0 @@
-import { ApiProperty } from "@nestjs/swagger";
-import PaginatedMetaDto from "./paginated-meta.dto";
-
-export default class PaginatedDto<T> {
-  @ApiProperty()
-  readonly data: T[];
-
-  @ApiProperty()
-  readonly meta: PaginatedMetaDto;
-
-  constructor(data: T[], meta: PaginatedMetaDto) {
-    this.data = data
-    this.meta = meta
-  }
-}

package/lib/dto/pagination/pagination-params.decorator.ts

@@ -1,21 +0,0 @@
-import { Type, applyDecorators } from "@nestjs/common";
-import { ApiExtraModels, ApiQuery, getSchemaPath } from "@nestjs/swagger";
-import PaginatedQueryDto from "./paginated-query.dto";
-
-const ApiPaginationParams = <TModel extends Type<any>>() => {
-  return applyDecorators(
-    ApiExtraModels(PaginatedQueryDto),
-    ApiQuery({
-      required: false,
-      name: 'pagination',
-      style: 'deepObject',
-      explode: true,
-      type: 'object',
-      schema: {
-        $ref: getSchemaPath(PaginatedQueryDto),
-      },
-    })
-  );
-};
-
-export default ApiPaginationParams

package/lib/dto/sorting/enums.ts

@@ -1,4 +0,0 @@
-export enum Sorting {
-  asc = 'asc',
-  desc = 'desc'
-}

package/lib/dto/sorting/index.ts

@@ -1,3 +0,0 @@
-export * from './enums'
-export * from './sorting-params.decorator'
-export * from './models'

package/lib/dto/sorting/models.ts

@@ -1,47 +0,0 @@
-import { IsEnum, IsOptional } from 'class-validator';
-import { Sorting } from '@/dto/sorting';
-import { ApiPropertyOptional } from '@nestjs/swagger';
-
-export class SortingDto implements DefaultSortingI {
-  @ApiPropertyOptional({enum: Sorting})
-  @IsEnum(Sorting)
-  @IsOptional()
-  id?: Sorting;
-
-  @ApiPropertyOptional({enum: Sorting})
-  @IsEnum(Sorting)
-  @IsOptional()
-  createdAt?: Sorting;
-
-  @ApiPropertyOptional({enum: Sorting})
-  @IsEnum(Sorting)
-  @IsOptional()
-  updatedAt?: Sorting;
-
-  get orderBy() {
-    return Object.entries(this).map(entry => {
-      return {[entry[0]]: entry[1]};
-    });
-  }
-
-  get orderByRDB() {
-    return Object.entries(this).map(entry => {
-      return {column:entry[0], order:entry[1]};
-    });
-  }
-}
-
-export interface DefaultSortingI {
-  id?: Sorting;
-  createdAt?: Sorting;
-  updatedAt?: Sorting;
-  get orderBy();
-}
-
-export interface SortingQueryI<T extends SortingDto> {
-  sorting?:T
-}
-
-export type SortingFieldsOf<T, P extends keyof T = Exclude<keyof T,keyof DefaultSortingI | 'metafields' | 'translations'>> = {
-  [K in P]?: Sorting
-}

package/lib/dto/sorting/sorting-params.decorator.ts

@@ -1,35 +0,0 @@
-import { Type as TypeI, applyDecorators } from "@nestjs/common";
-import { ApiExtraModels, ApiPropertyOptional, ApiQuery, getSchemaPath } from "@nestjs/swagger";
-import { Transform, Type, plainToClass } from "class-transformer";
-import { IsOptional, ValidateNested } from "class-validator";
-
-export const ApiSortingParams = <TModel extends TypeI<any>>(
-  model: TModel,
-) => {
-  return applyDecorators(
-    ApiExtraModels(model),
-    ApiQuery({
-      required: false,
-      name: 'sorting',
-      style: 'deepObject',
-      explode: true,
-      type: 'object',
-      example:'',
-      schema: {
-        $ref: getSchemaPath(model),
-      },
-    })
-  );
-};
-
-export const IsSortingObject = <TModel extends TypeI<any>>(
-  model: TModel,
-) => {
-  return applyDecorators(
-    ApiPropertyOptional({type:model}),
-    ValidateNested(),
-    Transform(({value}) => plainToClass(model, JSON.parse(value))),
-    Type(() => model),
-    IsOptional()
-  );
-};

package/lib/errors/index.ts

@@ -1 +0,0 @@
-export * from './validation.error'

package/lib/errors/validation.error.ts

@@ -1,9 +0,0 @@
-import { BadRequestException } from "@nestjs/common";
-
-export const VALIDATION_EXCEPTION_CODE = 'VALIDATION_ERROR'
-
-export class ValidationException extends BadRequestException {
-  constructor(objectOrError?: any) {
-    super(objectOrError,VALIDATION_EXCEPTION_CODE);
-  }
-}

package/lib/filters/all-exception.filter.ts

@@ -1,33 +0,0 @@
-import { ExceptionFilter, Catch, ArgumentsHost, HttpStatus } from '@nestjs/common';
-import { GqlContextType } from '@nestjs/graphql';
-import { Request, Response } from 'express';
-
-@Catch()
-export class AllExceptionsFilter implements ExceptionFilter {
-  catch(exception: any, host: ArgumentsHost): void {
-    if(host.getType<GqlContextType>() === 'graphql') {
-      return exception;
-    }
-    const ctx = host.switchToHttp();
-    const response = ctx.getResponse<Response>();
-    const request = ctx.getRequest<Request>();
-    const status = HttpStatus.INTERNAL_SERVER_ERROR;
-
-    const data = process.env.NODE_ENV == 'development' ? {
-      statusCode: status,
-      method: request.method,
-      path: request.url,
-      type: exception.name,
-      code: exception.code,
-      message: exception.message ?? 'Internal Server Error',
-      stack: exception.stack?.split('\n')
-    } : {
-      statusCode: status,
-      message: 'Internal Server Error',
-    }
-    
-    response
-      .status(status)
-      .send(data);
-  }
-}

package/lib/filters/http-exception.filter.ts

@@ -1,32 +0,0 @@
-import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
-import { GqlContextType } from '@nestjs/graphql';
-import { Request, Response } from 'express';
-
-@Catch(HttpException)
-export class HttpExceptionFilter implements ExceptionFilter {
-  catch(exception: HttpException, host: ArgumentsHost) {
-    if(host.getType<GqlContextType>() === 'graphql') {
-      return exception;
-    }
-    const ctx = host.switchToHttp();
-    const response = ctx.getResponse<Response>();
-    const request = ctx.getRequest<Request>();
-    const status = exception.getStatus();
-
-    const data = process.env.NODE_ENV == 'development' ? {
-      statusCode: status,
-      method: request.method,
-      path: request.url,
-      type: exception.name,
-      message: exception.message,
-      stack: exception.stack?.split('\n')
-    } : {
-      statusCode: status,
-      message: exception.message,
-    }
-   
-    response
-      .status(status)
-      .send(data);
-  }
-}

package/lib/filters/index.ts

@@ -1,3 +0,0 @@
-export * from './all-exception.filter'
-export * from './http-exception.filter'
-export * from './validation-exception.filter'

package/lib/filters/validation-exception.filter.ts

@@ -1,21 +0,0 @@
-import { ExceptionFilter, Catch, ArgumentsHost, HttpException, BadRequestException } from '@nestjs/common';
-import { GqlContextType } from '@nestjs/graphql';
-import { Request, Response } from 'express';
-import { ValidationException } from '../errors/validation.error';
-
-@Catch(BadRequestException)
-export class ValidationExceptionFilter implements ExceptionFilter {
-  catch(exception: BadRequestException, host: ArgumentsHost) {
-    if(host.getType<GqlContextType>() === 'graphql') {
-      return exception;
-    }
-    
-    const ctx = host.switchToHttp();
-    const response = ctx.getResponse<Response>();
-    const status = exception.getStatus();
-   
-    response
-      .status(status)
-      .send(exception['response']);
-  }
-}

package/lib/index.ts

@@ -1,6 +0,0 @@
-export * from './utils'
-export * from './decorators'
-export * from './dto'
-export * from './errors'
-export * from './filters'
-export * from './logger'

package/lib/logger/index.ts

@@ -1 +0,0 @@
-export * from './logger-factory'

package/lib/logger/logger-factory.ts

@@ -1,42 +0,0 @@
-import { LoggerService } from '@nestjs/common';
-import { WinstonModule, WinstonModuleOptions, utilities } from 'nest-winston';
-import { format, transports } from 'winston';
-import DailyRotateFile from "winston-daily-rotate-file";
-import { joinFromRoot } from '../utils';
-
-export const LoggerFactory = (appName: string): LoggerService => {
-  return WinstonModule.createLogger(LoggerFactoryOptions(appName))
-}
-
-export const LoggerFactoryOptions = (appName:string): WinstonModuleOptions => {
-  const relativePath = `../logs/${appName}`
-  return {
-    transports: [
-      new DailyRotateFile({
-        filename: joinFromRoot(relativePath,`%DATE%-error.log`), 
-        level: 'error',
-        format: format.combine(format.timestamp({format:'YYYY-MM-DDTHH:mm:ssZZ'}), format.ms(), format.json()),
-        datePattern: 'YYYY-MM-DD',
-        zippedArchive: true,
-        maxFiles: '30d',
-      }),
-      new DailyRotateFile({
-        filename: joinFromRoot(relativePath,`%DATE%-combined.log`),
-        format: format.combine(format.timestamp({format:'YYYY-MM-DDTHH:mm:ssZZ'}), format.ms(), format.json()),
-        datePattern: 'YYYY-MM-DD',
-        zippedArchive: true,
-        maxFiles: '30d',
-      }),
-      new transports.Console({
-        format: format.combine(
-          format.timestamp(),
-          format.ms(),
-          utilities.format.nestLike(appName, {
-            colors: true,
-            prettyPrint: true,
-          }),
-        ),
-      }),
-    ],
-  }
-}

package/lib/utils/chunk.helper.ts

@@ -1,4 +0,0 @@
-export const chunk = <T>(arr:T[], size:number): (T[])[] =>
-  Array.from({ length: Math.ceil(arr.length / size) }, (v, i) =>
-    arr.slice(i * size, i * size + size)
-  );

package/lib/utils/index.ts

@@ -1,5 +0,0 @@
-export * from './chunk.helper'
-export * from './path.helper'
-export * from './slug.helper'
-export * from './storage.helper'
-export * from './types.helper'

package/lib/utils/path.helper.ts

@@ -1,5 +0,0 @@
-import { join } from 'path';
-
-export const ROOT_PATH = join(__dirname,'..','../../')
-
-export const joinFromRoot = (...paths:string[]):string => join(ROOT_PATH,...paths)

package/lib/utils/slug.helper.ts

@@ -1,22 +0,0 @@
-export default class Slugger {
-  private unique;
-  constructor(private readonly word: string) {}
-
-  public get(): string {
-    return this.word.trim().normalize("NFD").replace(/[\u0300-\u036f]/g, '').replace(/[^a-z0-9\s]/gi, '').replaceAll(' ','-').toLowerCase() + (this.unique ? '-'+this.randomString(5) : '')
-  }
-
-  public makeUnique() {
-    this.unique = true
-  }
-
-  private randomString(length:number) {
-    let result = '';
-    const characters = 'abcdefghijklmnopqrstuvwxyz';
-    const charactersLength = characters.length;
-    for (let i = 0; i < length; i++) {
-      result += characters.charAt(Math.floor(Math.random() * charactersLength));
-    }
-    return result;
-  }
-}

package/lib/utils/storage.helper.ts

@@ -1,39 +0,0 @@
-import * as fs from 'fs';
-import { promisify } from 'util';
-import { join, dirname } from 'path';
-import { EOL } from 'os';
-
-export default class StorageHelper {
-  public rootPath = join(__dirname,'..','../../public')
-
-  public async read(path:string): Promise<string | Buffer> {
-    const realPath = join(this.rootPath,path)
-    const readFile = promisify(fs.readFile);
-    return await readFile(realPath, {});
-  }
-
-  public async write(path:string,data:string): Promise<void> {
-    const realPath = join(this.rootPath,path)
-    this.safeDirectory(realPath)
-    const writeFile = promisify(fs.writeFile);
-    return await writeFile(realPath, data, 'utf8');
-  }
-
-  public async append(path:string,data:string): Promise<void> {
-    const realPath = join(this.rootPath,path)
-    this.safeDirectory(realPath)
-    const appendFile = promisify(fs.appendFile);
-    return await appendFile(realPath, data + EOL);
-  }
-
-  public async delete(path:string): Promise<void> {
-    const realPath = join(this.rootPath,path)
-    const unlink = promisify(fs.unlink);
-    return fs.existsSync(realPath) ? await unlink(realPath) : null;
-  }
-
-  private safeDirectory(path:string) {
-    const dirPath = dirname(path)
-    if(!fs.existsSync(dirPath)) fs.mkdirSync(dirPath,{recursive:true});
-  }
-}

package/lib/utils/types.helper.ts

@@ -1,3 +0,0 @@
-export type ExcludeMethods<T> = { [K in keyof T as (T[K] extends Function ? never : K)]: T[K] }
-export type WithRelations<T,R extends object> = T & R
-export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "declaration": true,
-    "removeComments": true,
-    "noLib": false,
-    "emitDecoratorMetadata": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "target": "ES2021",
-    "sourceMap": false,
-    "outDir": "./dist",
-    "rootDir": "./lib",
-    "skipLibCheck": true,
-    "paths": {
-      "@/*": ["./lib/*"],
-    }
-  },
-  "include": ["lib/**/*"],
-  "exclude": ["node_modules", "**/*.spec.ts", "tests"]
-}