@solidstarters/solid-core 1.2.93 → 1.2.95

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstarters/solid-core",
-  "version": "1.2.93",
+  "version": "1.2.95",
   "description": "This module is a NestJS module containing all the required core providers required by a Solid application",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,6 +48,7 @@
     "fast-csv": "^5.0.2",
     "handlebars": "^4.7.8",
     "ioredis": "^5.4.1",
+    "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
     "luxon": "^3.4.4",
     "mailgen": "^2.0.28",

package/src/controllers/locale.controller.ts

@@ -0,0 +1,94 @@
+import { Controller, Post, Body, Param, UploadedFiles, UseInterceptors, Put, Get, Query, Delete, Patch } from '@nestjs/common';
+import { AnyFilesInterceptor } from "@nestjs/platform-express";
+import { ApiBearerAuth, ApiQuery, ApiTags } from '@nestjs/swagger';
+import { SolidRequestContextDecorator } from 'src/decorators/solid-request-context.decorator';
+import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
+import { LocaleService } from 'src/services/locale.service';
+import { CreateLocaleDto } from 'src/dtos/create-locale.dto';
+import { UpdateLocaleDto } from 'src/dtos/update-locale.dto';
+
+enum ShowSoftDeleted {
+  INCLUSIVE = "inclusive",
+  EXCLUSIVE = "exclusive",
+}
+
+@ApiTags('Solid Core')
+@Controller('locale')
+export class LocaleController {
+  constructor(private readonly service: LocaleService) { }
+
+  @ApiBearerAuth("jwt")
+  @Post()
+  @UseInterceptors(AnyFilesInterceptor())
+  create(@Body() createDto: CreateLocaleDto, @UploadedFiles() files: Array<Express.Multer.File>) {
+    return this.service.create(createDto, files);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Post('/bulk')
+  @UseInterceptors(AnyFilesInterceptor())
+  insertMany(@Body() createDtos: CreateLocaleDto[], @UploadedFiles() filesArray: Express.Multer.File[][] = []) {
+    return this.service.insertMany(createDtos, filesArray);
+  }
+
+
+  @ApiBearerAuth("jwt")
+  @Put(':id')
+  @UseInterceptors(AnyFilesInterceptor())
+  update(@Param('id') id: number, @Body() updateDto: UpdateLocaleDto, @UploadedFiles() files: Array<Express.Multer.File>) {
+    return this.service.update(id, updateDto, files);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Patch(':id')
+  @UseInterceptors(AnyFilesInterceptor())
+  partialUpdate(@Param('id') id: number, @Body() updateDto: UpdateLocaleDto, @UploadedFiles() files: Array<Express.Multer.File>) {
+    return this.service.update(id, updateDto, files, true);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Post('/bulk-recover')
+  async recoverMany(@Body() ids: number[]) {
+    return this.service.recoverMany(ids);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Get('/recover/:id')
+  async recover(@Param('id') id: number) {
+    return this.service.recover(id);
+  }
+
+  @ApiBearerAuth("jwt")
+  @ApiQuery({ name: 'showSoftDeleted', required: false, enum: ShowSoftDeleted })
+  @ApiQuery({ name: 'limit', required: false, type: Number })
+  @ApiQuery({ name: 'offset', required: false, type: Number })
+  @ApiQuery({ name: 'fields', required: false, type: Array })
+  @ApiQuery({ name: 'sort', required: false, type: Array })
+  @ApiQuery({ name: 'groupBy', required: false, type: Array })
+  @ApiQuery({ name: 'populate', required: false, type: Array })
+  @ApiQuery({ name: 'populateMedia', required: false, type: Array })
+  @ApiQuery({ name: 'filters', required: false, type: Array })
+  @Get()
+  async findMany(@Query() query: any) {
+    return this.service.find(query);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Get(':id')
+  async findOne(@Param('id') id: string, @Query() query: any) {
+    return this.service.findOne(+id, query);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Delete('/bulk')
+  async deleteMany(@Body() ids: number[]) {
+    return this.service.deleteMany(ids);
+  }
+
+  @ApiBearerAuth("jwt")
+  @Delete(':id')
+  async delete(@Param('id') id: number) {
+    return this.service.delete(id);
+  }
+
+}

package/src/dtos/basic-filters.dto.ts

@@ -2,6 +2,7 @@
 import { ApiProperty } from "@nestjs/swagger";
 import { IsEnum, IsOptional } from "class-validator";
 import { PaginationQueryDto } from "./pagination-query.dto";
+import { Timestamp } from "typeorm";
 
 export enum SoftDeleteFilter {
     INCLUSIVE = "inclusive",
@@ -32,7 +33,6 @@ export class BasicFilterDto extends PaginationQueryDto {
     @ApiProperty({ description: "populateMedia" })
     readonly populateMedia?: string[];
 
-
     // @IsOptional()
     // @ApiProperty({ description: "filters" })
     // readonly filters: any[];
@@ -52,4 +52,16 @@ export class BasicFilterDto extends PaginationQueryDto {
     @IsOptional()
     @ApiProperty({ description: "groupFilter" })
     groupFilter?: BasicFilterDto
+
+    @IsOptional()
+    @ApiProperty({ description: "locale" })
+    readonly locale?: string;
+
+    @IsOptional()
+    @ApiProperty({ description: "status publish draft" })
+    readonly status?: string;
+
+    // @IsOptional()
+    // @ApiProperty({ description: "default locale id" })
+    // readonly defaultEntityLocaleId?: number;
 }

package/src/dtos/create-locale.dto.ts

@@ -0,0 +1,17 @@
+import { IsString, IsBoolean, IsOptional, IsNotEmpty } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class CreateLocaleDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    locale: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    displayName: string;
+    @IsNotEmpty()
+    @IsBoolean()
+    @ApiProperty()
+    isDefault: boolean = true;
+}

package/src/dtos/create-model-metadata.dto.ts

@@ -63,10 +63,14 @@ export class CreateModelMetadataDto {
     @IsBoolean()
     readonly enableAuditTracking: boolean
 
-    @ApiProperty({ description: "Enable Soft Delete" })
+    @ApiProperty({ description: "Internationalisation" })
     @IsBoolean()
     readonly internationalisation: boolean
 
+    @ApiProperty({ description: "Draft publish workflow" })
+    @IsBoolean()
+    readonly draftPublishWorkflow: boolean
+
     @ApiProperty({ description: "Related module id" })
     @IsInt()
     @IsOptional()

package/src/dtos/update-locale.dto.ts

@@ -0,0 +1,23 @@
+import { IsString, IsBoolean, IsOptional, IsInt, IsNotEmpty } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateLocaleDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    locale: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    displayName: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsBoolean()
+    @ApiProperty()
+    isDefault: boolean;
+}

package/src/entities/common.entity.ts

@@ -1,4 +1,5 @@
-import { PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, DeleteDateColumn } from "typeorm"
+import { PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, DeleteDateColumn, Index, ManyToOne, JoinColumn } from "typeorm"
+import { Locale } from "./locale.entity";
 
 export abstract class CommonEntity {
     @PrimaryGeneratedColumn({ type: 'integer' })
@@ -15,4 +16,13 @@ export abstract class CommonEntity {
 
     @Column({ name: "deletedTracker", default: "not-deleted" })
     deletedTracker: string;
+
+    @Column({ type: "timestamp", name: 'published_at', default: null ,nullable: true})
+    publishedAt: Date;
+
+    @Column({ type: "varchar", name: 'locale_name', default: null })
+    localeName: string;
+
+    @Column({ type: "int", name: 'default_entity_locale_id', default: null })
+    defaultEntityLocaleId: number;
 }

package/src/entities/locale.entity.ts

@@ -0,0 +1,14 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import { Entity, Column, Index, ManyToOne } from 'typeorm';
+
+@Entity("ss_locale")
+export class Locale extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    locale: string;
+    @Column({ type: "varchar" })
+    displayName: string;
+    @Index()
+    @Column({ type: "boolean", default: true })
+    isDefault: boolean = true;
+}

package/src/entities/model-metadata.entity.ts

@@ -39,6 +39,9 @@ export class ModelMetadata extends CommonEntity {
     @Column({ name: "internationalisation", default: false })
     internationalisation: boolean;
 
+    @Column({ name: "draftPublishWorkflow", default: false })
+    draftPublishWorkflow: boolean;
+
     @OneToMany(() => FieldMetadata, (field) => field.model)
     fields: FieldMetadata[];
 

package/src/helpers/field-crud-managers/ManyToManyRelationFieldCrudManager.ts

@@ -190,10 +190,11 @@ export class ManyToManyRelationFieldCrudManager implements FieldCrudManager {
         return this.options.required;
     }
 
+    // TODO: We have moved this to SolidRegistry service, refactor to use that service.
     // Returns the entity target class from the entity name
     private getEntityTarget(entityName: string): any { //TODO Can be refactored to use this function from crud helper service
         const entityMetadatas = this.options.entityManager.connection.entityMetadatas;
         const entityMetadata = entityMetadatas.find(em => em.name === entityName);
         return entityMetadata.target;
     }
-}
+}

package/src/helpers/field-crud-managers/OneToManyRelationFieldCrudManager.ts

@@ -195,6 +195,7 @@ export class OneToManyRelationFieldCrudManager implements FieldCrudManager {
         return this.options.required;
     }
 
+    // TODO: We have moved this to SolidRegistry service, refactor to use that service.
     // Returns the entity target class from the entity name
     private getEntityTarget(entityName: string): any { //TODO Can be refactored to use this function from crud helper service
         const entityMetadatas = this.options.entityManager.connection.entityMetadatas;

package/src/helpers/module-metadata-helper.service.ts

@@ -35,5 +35,4 @@ export class ModuleMetadataHelperService {
         }
         return filePath;
     }
-
 }

package/src/helpers/solid-registry.ts

@@ -2,6 +2,7 @@ import { Injectable } from '@nestjs/common';
 import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
 import { ISelectionProvider, ISelectionProviderContext } from "../interfaces";
 import { SecurityRule } from 'src/entities/security-rule.entity';
+import { EntityManager } from 'typeorm';
 
 type ControllerMetadata = {
   name: string;
@@ -41,7 +42,7 @@ export class SolidRegistry {
   private computedFieldProviders: Set<InstanceWrapper> = new Set();
   private solidDatabaseModules: Set<InstanceWrapper> = new Set();
   private controllers: Set<ControllerMetadata> = new Set();
-  private modules : Set<InstanceWrapper> = new Set();
+  private modules: Set<InstanceWrapper> = new Set();
   private securityRules: SecurityRule[] = [];
 
   registerController(name: string, methodNames: string[]): void {
@@ -116,7 +117,7 @@ export class SolidRegistry {
     this.securityRules = securityRules;
   }
 
-  getSecurityRules(modelSingularName:string, roleNames: string[] = []): SecurityRule[] {
+  getSecurityRules(modelSingularName: string, roleNames: string[] = []): SecurityRule[] {
     // If no role is provided, return all security rules for the model
     if (roleNames.length === 0) {
       return this.securityRules.filter((rule) => rule.modelMetadata.singularName === modelSingularName);
@@ -126,4 +127,12 @@ export class SolidRegistry {
       return rule.modelMetadata.singularName === modelSingularName && roleNames.includes(rule.role.name);
     });
   }
+
+  // Returns the entity target class from the entity name
+  getEntityTarget(entityManager: EntityManager, entityName: string): any { //TODO Can be refactored to use this function from crud helper service
+    const entityMetadatas = entityManager.connection.entityMetadatas;
+    const entityMetadata = entityMetadatas.find(em => em.name === entityName);
+    return entityMetadata.target;
+  }
+
 }

package/src/index.ts

@@ -45,6 +45,7 @@ export * from './dtos/create-user.dto'
 export * from './dtos/create-view-metadata.dto'
 export * from './dtos/create-chatter-message.dto'
 export * from './dtos/create-chatter-message-details.dto'
+export * from './dtos/create-locale.dto'
 export * from './dtos/fetch-roles.dto'
 export * from './dtos/initiate-forgot-password.dto'
 export * from './dtos/mutate-role-permissions.dto'
@@ -84,7 +85,7 @@ export * from './dtos/create-security-rule.dto'
 export * from './dtos/update-security-rule.dto'
 export * from './dtos/update-chatter-message.dto'
 export * from './dtos/update-chatter-message-details.dto'
-
+export * from './dtos/update-locale.dto'
 export * from './entities/action-metadata.entity'
 export * from './entities/common.entity'
 export * from './entities/email-attachment.entity'
@@ -115,7 +116,7 @@ export * from './entities/export-template.entity'
 export * from './entities/export-transaction.entity'
 export * from './entities/import-transaction.entity'
 export * from './entities/import-transaction-error-log.entity'
-
+export * from './entities/locale.entity'
 export * from './enums/auth-type.enum'
 
 export * from './filters/http-exception.filter'
@@ -232,6 +233,7 @@ export * from './services/security-rule.service'
 export * from './services/request-context.service'
 export * from './services/chatter-message.service'
 export * from './services/chatter-message-details.service'
+export * from './services/locale.service'
 // Repositories
 export * from './repository/solid-base.repository'
 export * from './repository/security-rule.repository'
@@ -256,4 +258,5 @@ export * from './constants'
 export * from './interfaces'
 export * from './solid-core.module'
 
- export * from './winston.logger'
+export * from './winston.logger'
+export * from './transformers/datetime-transformer'

package/src/seeders/seed-data/solid-core-metadata.json

@@ -263,6 +263,20 @@
             "columnName": "internationalisation",
             "isSystem": true
           },
+          {
+            "name": "draftPublishWorkflow",
+            "displayName": "Draft Publish Workflow",
+            "type": "boolean",
+            "ormType": "boolean",
+            "defaultValue": "false",
+            "required": false,
+            "unique": false,
+            "index": false,
+            "private": false,
+            "encrypt": false,
+            "columnName": "draftPublishWorkflow",
+            "isSystem": true
+          },
           {
             "name": "module",
             "displayName": "Module",
@@ -3785,6 +3799,58 @@
             "isSystem": true
           }
         ]
+      },
+      {
+        "singularName": "locale",
+        "pluralName": "locales",
+        "displayName": "locale",
+        "description": "This is used to maintain model locales",
+        "dataSource": "default",
+        "dataSourceType": "postgres",
+        "tableName": "ss_locale",
+        "fields": [
+          {
+            "name": "locale",
+            "displayName": "Locale",
+            "type": "selectionDynamic",
+            "ormType": "varchar",
+            "length": 256,
+            "required": true,
+            "index": true,
+            "isSystem": true,
+            "selectionValueType": "string",
+            "selectionDynamicProvider": "LocaleListSelectionProvider",
+            "selectionDynamicProviderCtxt": "{}",
+            "isUserKey": true
+          },
+          {
+            "name": "displayName",
+            "displayName": "Display Name",
+            "type": "shortText",
+            "ormType": "varchar",
+            "length": 512,
+            "required": true,
+            "unique": true,
+            "index": true,
+            "private": false,
+            "encrypt": false,
+            "isSystem": true,
+            "isUserKey": false
+          },
+          {
+            "name": "isDefault",
+            "displayName": "Is Default",
+            "type": "boolean",
+            "ormType": "boolean",
+            "defaultValue": "false",
+            "required": true,
+            "unique": false,
+            "index": true,
+            "private": false,
+            "encrypt": false,
+            "isSystem": true
+          }
+        ]
       }
     ]
   },
@@ -3968,6 +4034,19 @@
       "moduleUserKey": "solid-core",
       "modelUserKey": "chatterMessageDetails"
     },
+    {
+      "displayName": "locale list action",
+      "name": "locale-list-action",
+      "type": "solid",
+      "domain": "",
+      "context": "",
+      "customComponent": "",
+      "customIsModal": false,
+      "serverEndpoint": "",
+      "viewUserKey": "locale-list-view",
+      "moduleUserKey": "solid-core",
+      "modelUserKey": "locale"
+    },
     {
       "displayName": "User list action",
       "name": "user-list-action",
@@ -4136,6 +4215,19 @@
       "viewUserKey": "importTransaction-list-view",
       "moduleUserKey": "solid-core",
       "modelUserKey": "importTransaction"
+    },
+    {
+      "displayName": "locale List View",
+      "name": "locale-list-view",
+      "type": "solid",
+      "domain": "",
+      "context": "",
+      "customComponent": "/admin/address-master/locale/all",
+      "customIsModal": true,
+      "serverEndpoint": "",
+      "viewUserKey": "locale-list-view",
+      "moduleUserKey": "solid-core",
+      "modelUserKey": "locale"
     }
   ],
   "menus": [
@@ -4378,6 +4470,14 @@
       "actionUserKey": "importTransaction-list-view",
       "moduleUserKey": "solid-core",
       "parentMenuItemUserKey": ""
+    },
+    {
+      "displayName": "Locale",
+      "name": "locale",
+      "sequenceNumber": 10,
+      "actionUserKey": "locale-list-action",
+      "moduleUserKey": "solid-core",
+      "parentMenuItemUserKey": "other-menu-item"
     }
   ],
   "views": [
@@ -5772,6 +5872,109 @@
         ]
       }
     },
+    {
+      "name": "locale-list-view",
+      "displayName": "Locale Model",
+      "type": "list",
+      "context": "{}",
+      "moduleUserKey": "solid-core",
+      "modelUserKey": "locale",
+      "layout": {
+        "type": "list",
+        "attrs": {
+          "pagination": true,
+          "pageSizeOptions": [
+            10,
+            25,
+            50
+          ],
+          "enableGlobalSearch": true,
+          "create": true,
+          "edit": true,
+          "delete": true
+        },
+        "children": [
+          {
+            "type": "field",
+            "attrs": {
+              "name": "locale",
+              "isSearchable": true
+            }
+          },
+          {
+            "type": "field",
+            "attrs": {
+              "name": "displayName",
+              "isSearchable": true
+            }
+          },
+          {
+            "type": "field",
+            "attrs": {
+              "name": "isDefault",
+              "isSearchable": false
+            }
+          }
+        ]
+      }
+    },
+    {
+      "name": "locale-form-view",
+      "displayName": "locale Model",
+      "type": "form",
+      "context": "{}",
+      "moduleUserKey": "solid-core",
+      "modelUserKey": "locale",
+      "layout": {
+        "type": "form",
+        "attrs": {
+          "name": "form-1",
+          "label": "locale model",
+          "className": "grid"
+        },
+        "children": [
+          {
+            "type": "sheet",
+            "attrs": {
+              "name": "sheet-1"
+            },
+            "children": [
+              {
+                "type": "group",
+                "attrs": {
+                  "name": "group-1",
+                  "label": "",
+                  "className": "col-6"
+                },
+                "children": [
+                  {
+                    "type": "field",
+                    "attrs": {
+                      "name": "locale",
+                      "isSearchable": true
+                    }
+                  },
+                  {
+                    "type": "field",
+                    "attrs": {
+                      "name": "displayName",
+                      "isSearchable": true
+                    }
+                  },
+                  {
+                    "type": "field",
+                    "attrs": {
+                      "name": "isDefault",
+                      "isSearchable": true
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    },
     {
       "name": "viewMetadata-list-view",
       "displayName": "View Metadata list view",