@nest-omni/core 3.1.1-10 → 3.1.1-9

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@nest-omni/core",
-  "version": "3.1.1-10",
+  "version": "3.1.1-9",
   "description": "A comprehensive NestJS framework for building enterprise-grade applications with best practices",
   "main": "index.js",
   "types": "index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "test": "jest --passWithNoTests",
@@ -100,10 +105,10 @@
   },
   "peerDependenciesMeta": {
     "@dataui/crud": {
-      "optional": false
+      "optional": true
     },
     "@dataui/crud-typeorm": {
-      "optional": false
+      "optional": true
     },
     "@keyv/redis": {
       "optional": true
@@ -115,55 +120,58 @@
       "optional": true
     },
     "@nestjs/bull": {
-      "optional": false
+      "optional": true
     },
     "@nestjs/cache-manager": {
-      "optional": false
+      "optional": true
+    },
+    "@nestjs/microservices": {
+      "optional": true
     },
     "@nestjs/schedule": {
-      "optional": false
+      "optional": true
     },
     "@nestjs/swagger": {
       "optional": true
     },
     "bcrypt": {
-      "optional": false
+      "optional": true
     },
     "bull": {
-      "optional": false
+      "optional": true
     },
     "cache-manager": {
-      "optional": false
+      "optional": true
     },
     "connect-redis": {
-      "optional": false
+      "optional": true
     },
     "express-session": {
-      "optional": false
+      "optional": true
     },
     "keyv": {
-      "optional": false
+      "optional": true
     },
     "mysql2": {
-      "optional": false
+      "optional": true
     },
     "nestjs-cls": {
-      "optional": false
+      "optional": true
     },
     "nestjs-i18n": {
-      "optional": false
+      "optional": true
     },
     "nestjs-pino": {
-      "optional": false
+      "optional": true
     },
     "pino-http": {
-      "optional": false
+      "optional": true
     },
     "pino-pretty": {
-      "optional": false
+      "optional": true
     },
     "typeorm": {
-      "optional": false
+      "optional": true
     }
   }
 }

package/.hygen/new/crud/controller.ejs.t

@@ -1,82 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/<%= h.controllerFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('Controller') %>
----
-<%
-
- ClassName = h.ClassName(name);
- moduleName = h.moduleName(name);
- fileName = h.fileName(name);
- ControllerName = h.ControllerName(name);
- ServiceName = h.ServiceName(name);
- serviceName = h.changeCase.camel(ServiceName);
- createFunctionName = 'create' + ClassName;
- updateFunctionName = 'update' + ClassName;
- deleteFunctionName = 'delete' + ClassName;
- getAllFunctionName = 'getAll' + ClassName;
- getSingleFunctionName = 'getSingle' + ClassName;
- CreateDtoName = h.CreateDtoName(name);
- createDtoName = h.changeCase.camel(CreateDtoName);
- UpdateDtoName = h.UpdateDtoName(name);
- updateDtoName = h.changeCase.camel(UpdateDtoName);
- PageOptionsDtoName = h.PageOptionsDtoName(name);
- pageOptionsDtoName = h.changeCase.camel(PageOptionsDtoName);
- DtoName = h.DtoName(name);
- createDtoFileName = h.createDtoFileName(name);
- dtoFileName = h.dtoFileName(name);
- pageOptionsDtoFileName = h.pageOptionsDtoFileName(name);
- updateDtoFileName = h.updateDtoFileName(name);
- serviceFileName = h.serviceFileName(name);
- EntityName = h.EntityName(name);
- entityName = h.changeCase.camel(EntityName);
- entityFileName = h.entityFileName(name);
- GetDtoName = 'Get' + DtoName;
- getDtoFileName = 'get-' + dtoFileName;
-
-%>import { Body, Controller, Delete, Put, Post } from '@nestjs/common';
-import { ApiBody, ApiOperation, ApiTags } from '@nestjs/swagger';
-import { Crud } from '@dataui/crud';
-
-import { <%= EntityName %> } from './<%= entityFileName %>';
-import { <%= ServiceName %> } from './<%= serviceFileName %>';
-
-import { dto } from './requests';
-import { serialize } from './responses';
-import { targetConstructorToSchema } from '@nest-omni/core/validator-json';
-import { I18nService } from 'nestjs-i18n';
-import { BulkIdDto } from '@nest-omni/core/common/dto/bulk-id.dto';
-
-@Crud({
-  model: { type: <%= EntityName %> },
-  dto,
-  serialize,
-  query: {
-    alwaysPaginate: true,
-  },
-})
-@Controller('<%= h.inflection.pluralize(fileName).toLowerCase() %>')
-@ApiTags('<%= h.inflection.pluralize(fileName).toLowerCase() %>')
-export class <%= ControllerName %> {
-  constructor(
-    public service: <%= ServiceName %>,
-    public i18n: I18nService,
-  ) {}
-
-  @Post('validator')
-  async getCreateRules(): Promise<any> {
-    return targetConstructorToSchema(dto.create, this.i18n);
-  }
-
-  @Put('validator')
-  async getUpdateRules(): Promise<any> {
-    return targetConstructorToSchema(dto.update, this.i18n);
-  }
-
-  @Delete('/bulk')
-  @ApiBody({ type: BulkIdDto })
-  @ApiOperation({ summary: 'bulk deletion of records' })
-  async deleteBulk(@Body() bulkId: BulkIdDto) {
-    return await this.service.deleteBulk(bulkId);
-  }
-}

package/.hygen/new/crud/create.dto.ejs.t

@@ -1,12 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/requests/<%= h.createDtoFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('CreateDTO') %>
----
-<%
-
- ClassName = h.ClassName(name);
- CreateDtoName = h.CreateDtoName(name);
-
-%>import { <%= EntityName %> } from '../<%= entityFileName %>';
-export class <%= CreateDtoName %> extends <%= EntityName %> {}

package/.hygen/new/crud/entity.ejs.t

@@ -1,26 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/<%= h.entityFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('Entity') %>
----
-<%
- ClassName = h.ClassName(name);
- DtoName = h.DtoName(name);
- fieldName = h.changeCase.camel(ClassName);
- dtoFileName = h.dtoFileName(name);
- translationEntityFileName = h.translationEntityFileName(name);
- DtoOptionName = h.DtoOptionName(name);
- TableName = h.TableName(name);
- EntityName = h.EntityName(name);
- TranslationEntityName = h.TranslationEntityName(name);
- translationEntityName = h.changeCase.camel(TranslationEntityName);
-%>import { Entity, Column } from 'typeorm';
-import { StringField } from '@nest-omni/core';
-import { AbstractEntity } from '@nest-omni/core/common/abstract.entity';
-
-@Entity({ name: '<%= TableName %>' })
-export class <%= EntityName %> extends AbstractEntity {
-  @Column({ type: 'varchar', nullable: false })
-  @StringField()
-  name: string;
-}

package/.hygen/new/crud/get.dto.ejs.t

@@ -1,19 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/responses/get-<%= h.dtoFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('DTO') %>
----
-<%
-
- DtoName = h.DtoName(name);
- DtoOptionName = h.DtoOptionName(name);
- EntityName = h.EntityName(name);
- entityName = h.changeCase.camel(EntityName);
- entityFileName = h.entityFileName(name);
-
-  GetDtoName = 'Get' + DtoName;
-  getDtoFileName = 'get-' + dtoFileName;
-
-%>import { <%= EntityName %> } from '../<%= entityFileName %>';
-
-export class <%= GetDtoName %> extends <%= EntityName %> {}

package/.hygen/new/crud/index-dto.ejs.t

@@ -1,29 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/requests/index.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('DTO') %>
----
-<%
-
- DtoName = h.DtoName(name);
- DtoOptionName = h.DtoOptionName(name);
-
- CreateDtoName = h.CreateDtoName(name);
- createDtoName = h.changeCase.camel(CreateDtoName);
- UpdateDtoName = h.UpdateDtoName(name);
- updateDtoName = h.changeCase.camel(UpdateDtoName);
-
- createDtoFileName = h.createDtoFileName(name);
- updateDtoFileName = h.updateDtoFileName(name);
-
- EntityName = h.EntityName(name);
- entityName = h.changeCase.camel(EntityName);
- entityFileName = h.entityFileName(name);
-
-%>import { <%= CreateDtoName %> } from './<%= createDtoFileName %>';
-import { <%= UpdateDtoName %> } from './<%= updateDtoFileName %>';
-
-export const dto = {
-  create: <%= CreateDtoName %>,
-  update: <%= UpdateDtoName %>,
-};

package/.hygen/new/crud/index-response.dto.ejs.t

@@ -1,18 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/responses/index.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('DTO') %>
----
-<%
-
- DtoName = h.DtoName(name);
- dtoFileName = h.dtoFileName(name);
-
- GetDtoName = 'Get' + DtoName;
- getDtoFileName = 'get-' + dtoFileName;
-
-%>import { <%= GetDtoName %> } from './<%= getDtoFileName %>';
-
-export const serialize = {
-  get: <%= GetDtoName %>,
-};

package/.hygen/new/crud/module.ejs.t

@@ -1,32 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/<%= h.moduleFileName(name) %>.ts"
-unless_exists: true
----
-<%
-
- ModuleName = h.ModuleName(name);
- fileName = h.inflection.dasherize(name);
-
- ControllerName = h.ControllerName(name);
- controllerFileName = h.controllerFileName(name);
-
- ServiceName = h.ServiceName(name);
- serviceFileName = h.serviceFileName(name);
-
-  EntityName = h.EntityName(name);
-  entityName = h.changeCase.camel(EntityName);
-  entityFileName = h.entityFileName(name);
-
-%>import { Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
-
-import { <%= ControllerName %> } from './<%= controllerFileName %>';
-import { <%= EntityName %> } from './<%= entityFileName %>';
-import { <%= ServiceName %> } from './<%= serviceFileName %>';
-
-@Module({
-  imports: [TypeOrmModule.forFeature([<%= EntityName %>])],
-  providers: [<%= ServiceName %>],
-  controllers: [<%= ControllerName %>],
-})
-export class <%= ModuleName %> {}

package/.hygen/new/crud/prompt.js

@@ -1,89 +0,0 @@
-'use strict'
-
-module.exports = {
-  prompt: ({ prompter, args }) => {
-    return prompter.prompt([
-      {
-        type: 'input',
-        name: 'name',
-        message: 'Name:',
-        validate(value) {
-          if (!value.length) {
-            return 'Module must have a name.';
-          }
-          return true;
-        },
-      },
-      {
-        type: 'MultiSelect',
-        name: 'blocks',
-        message: 'Blocks:',
-        initial: [
-          'Controller',
-          'CreateCommand',
-          'CreateDTO',
-          'DTO',
-          'Entity',
-          'GetQuery',
-          //'Module',
-          // 'NotFoundException',
-          'PageOptionsDTO',
-          'Repository',
-          'Service',
-          'UpdateDTO'
-        ],
-        choices: [
-          {
-            name: 'Controller',
-            value: 'controller',
-          },
-          {
-            name: 'CreateCommand',
-            value: 'create-command',
-          },
-          {
-            name: 'CreateDTO',
-            value: 'create-dto',
-          },
-          {
-            name: 'DTO',
-            value: 'dto',
-          },
-          {
-            name: 'Entity',
-            value: 'entity',
-          },
-          {
-            name: 'GetQuery',
-            value: 'get-query',
-          },
-          {
-            name: 'NotFoundException',
-            value: 'not-found-exception',
-          },
-          {
-            name: 'PageOptionsDTO',
-            value: 'page-options-dto',
-          },
-          {
-            name: 'Repository',
-            value: 'repository',
-          },
-          {
-            name: 'Service',
-            value: 'service',
-          },
-          {
-            name: 'UpdateDTO',
-            value: 'update-dto',
-          },
-        ],
-      }
-    ])
-    .then(answer => {
-      //// For debugging
-      // console.log(answer)
-      return answer;
-    })
-  }
-}

package/.hygen/new/crud/service.ejs.t

@@ -1,76 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/<%= h.serviceFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('Service') %>
----
-<%
-
- ClassName = h.ClassName(name);
- fieldName = h.changeCase.camel(ClassName);
-
- DtoName = h.DtoName(name);
- dtoFileName = h.dtoFileName(name);
-
-
- CreateCommandName = h.CreateCommandName(name);
- createCommandFileName = h.createCommandFileName(name);
-
-
- EntityName = h.EntityName(name);
- entityName = h.changeCase.camel(EntityName);
- entityFileName = h.entityFileName(name);
-
- ServiceName = h.ServiceName(name);
-
- UpdateDtoName = h.UpdateDtoName(name);
- updateDtoFileName = h.updateDtoFileName(name);
- updateDtoName = h.changeCase.camel(UpdateDtoName);
-
- fileName = h.fileName(name);
-
- RepositoryName = h.RepositoryName(name);
- repositoryName = h.changeCase.camel(RepositoryName);
- repositoryFileName = h.repositoryFileName(name);
-
- NotFoundExceptionName = h.NotFoundExceptionName(name);
- notFoundExceptionFileName = h.notFoundExceptionFileName(name);
-
- createFunctionName = 'create' + ClassName;
- updateFunctionName = 'update' + ClassName;
- deleteFunctionName = 'delete' + ClassName;
- getAllFunctionName = 'getAll' + ClassName;
- getSingleFunctionName = 'getSingle' + ClassName;
- controllerName = moduleName + 'Controller';
- serviceName = moduleName + 'Service';
- CreateDtoName = h.CreateDtoName(name);
- createDtoFileName = h.createDtoFileName(name);
-
- PageOptionsDtoName = h.PageOptionsDtoName(name);
- pageOptionsDtoName = h.changeCase.camel(PageOptionsDtoName);
- pageOptionsDtoFileName = h.pageOptionsDtoFileName(name);
-
-%>import { Injectable } from '@nestjs/common';
-import { InjectRepository } from '@nestjs/typeorm';
-import { TypeOrmCrudService } from '@dataui/crud-typeorm';
-import { I18nService } from 'nestjs-i18n';
-import { BulkIdDto } from '@nest-omni/core/common/dto/bulk-id.dto';
-import { Repository } from 'typeorm';
-import { <%= EntityName %> } from './<%= entityFileName %>';
-
-@Injectable()
-export class <%= ServiceName %> extends TypeOrmCrudService<<%= EntityName %>> {
-  constructor(
-    @InjectRepository(<%= EntityName %>) repo: Repository<<%= EntityName %>>,
-    public i18n: I18nService,
-  ) {
-    super(repo);
-  }
-
-  async deleteBulk(bulkIdDto: BulkIdDto) {
-    return this.repo
-      .createQueryBuilder()
-      .delete()
-      .andWhereInIds(bulkIdDto.id)
-      .execute();
-  }
-}

package/.hygen/new/crud/update.dto.ejs.t

@@ -1,11 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/requests/<%= h.updateDtoFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('UpdateDTO') %>
----
-<%
-
-UpdateDtoName = h.UpdateDtoName(name);
-
-%>import { <%= EntityName %> } from '../<%= entityFileName %>';
-export class <%= UpdateDtoName %> extends <%= EntityName %> {}

package/.hygen/new/module/controller.ejs.t

@@ -1,93 +0,0 @@
----
-to: "src/modules/<%= h.fileName(name) %>/<%= h.controllerFileName(name) %>.ts"
-unless_exists: true
-skip_if: <%= !blocks.includes('Controller') %>
----
-<%
-
- ClassName = h.ClassName(name);
- moduleName = h.moduleName(name);
- fileName = h.fileName(name);
- ControllerName = h.ControllerName(name);
- ServiceName = h.ServiceName(name);
- serviceName = h.changeCase.camel(ServiceName);
- createFunctionName = 'create' + ClassName;
- updateFunctionName = 'update' + ClassName;
- deleteFunctionName = 'delete' + ClassName;
- getAllFunctionName = 'getAll' + ClassName;
- getSingleFunctionName = 'getSingle' + ClassName;
- CreateDtoName = h.CreateDtoName(name);
- createDtoName = h.changeCase.camel(CreateDtoName);
- UpdateDtoName = h.UpdateDtoName(name);
- updateDtoName = h.changeCase.camel(UpdateDtoName);
- PageOptionsDtoName = h.PageOptionsDtoName(name);
- pageOptionsDtoName = h.changeCase.camel(PageOptionsDtoName);
- DtoName = h.DtoName(name);
- createDtoFileName = h.createDtoFileName(name);
- dtoFileName = h.dtoFileName(name);
- pageOptionsDtoFileName = h.pageOptionsDtoFileName(name);
- updateDtoFileName = h.updateDtoFileName(name);
- serviceFileName = h.serviceFileName(name);
-
-%>import {
-  Body,
-  Controller,
-  Delete,
-  Get,
-  HttpCode,
-  HttpStatus,
-  Post,
-  Put,
-  Query,
-} from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
-
-import type { PageDto } from '@nest-omni/core/common/dto/page.dto';
-import { <%= CreateDtoName %> } from './dtos/<%= createDtoFileName %>';
-import type { <%= DtoName %> } from './dtos/<%= dtoFileName %>';
-import { <%= PageOptionsDtoName %> } from './dtos/<%= pageOptionsDtoFileName %>';
-import { <%= UpdateDtoName %> } from './dtos/<%= updateDtoFileName %>';
-import { <%= ServiceName %> } from './<%= serviceFileName %>';
-
-@Controller('<%= h.inflection.pluralize(fileName).toLowerCase() %>')
-@ApiTags('<%= h.inflection.pluralize(fileName).toLowerCase() %>')
-export class <%= ControllerName %> {
-  constructor(private <%= serviceName %>: <%= ServiceName %>) {}
-
-  @Post()
-  @HttpCode(HttpStatus.CREATED)
-  async <%= createFunctionName %>(@Body() <%= createDtoName %>: <%= CreateDtoName %>) {
-    const entity = await this.<%= serviceName %>.<%= createFunctionName %>(<%= createDtoName %>);
-
-    return entity.toDto();
-  }
-
-  @Get()
-  @HttpCode(HttpStatus.OK)
-  <%= getAllFunctionName %>(@Query() <%= pageOptionsDtoName %>: <%= PageOptionsDtoName %>): Promise<PageDto<<%= DtoName %>>> {
-    return this.<%= serviceName %>.<%= getAllFunctionName %>(<%= pageOptionsDtoName %>);
-  }
-
-  @Get(':id')
-  @HttpCode(HttpStatus.OK)
-  async <%= getSingleFunctionName %>(@UUIDParam('id') id: Uuid): Promise<<%= DtoName %>> {
-    const entity = await this.<%= serviceName %>.<%= getSingleFunctionName %>(id);
-
-    return entity.toDto();
-  }
-
-  @Put(':id')
-  @HttpCode(HttpStatus.ACCEPTED)
-  <%= updateFunctionName %>(
-    @UUIDParam('id') id: Uuid,
-    @Body() <%= updateDtoName %>: <%= UpdateDtoName %>,
-  ): Promise<void> {
-    return this.<%= serviceName %>.<%= updateFunctionName %>(id, <%= updateDtoName %>);
-  }
-
-  @Delete(':id')
-  @HttpCode(HttpStatus.ACCEPTED)
-  async <%= deleteFunctionName %>(@UUIDParam('id') id: Uuid): Promise<void> {
-    await this.<%= serviceName %>.<%= deleteFunctionName %>(id);
-  }
-}