add faker generator and settings

Author: Raphael67

src/generation/generators/faker.generator.ts

@@ -0,0 +1,15 @@
+import { faker } from '@faker-js/faker';
+import { AbstractGenerator } from './generators';
+
+export class FakerGenerator extends AbstractGenerator<string> {
+    public validate(): boolean {
+        if (this.column.template === undefined)
+            throw new Error(`faker template required for type faker: ${this.table.name}.${this.column.name}`);
+        return true;
+    }
+
+    public generate(rowIndex: number, row: { [key: string]: any; }): string {
+        faker.locale = this.column.locale || 'en';
+        return faker.fake(this.column.template!);
+    }
+}

src/generation/generators/generators.ts

@@ -13,6 +13,7 @@ export enum Generators {
     values = 'values',
     foreignKey = 'foreignKey',
     function = 'function',
+    faker = 'faker',
 }
 
 export abstract class AbstractGenerator<T>{
@@ -22,7 +23,7 @@ export abstract class AbstractGenerator<T>{
         protected column: CustomizedColumn,
     ) { }
 
-    public static validate(table: CustomizedTable, column: CustomizedColumn): boolean { return true };
+    public static validate(table: CustomizedTable, column: CustomizedColumn): boolean { return true; };
 
     public async init(): Promise<AbstractGenerator<T>> { return this; }
 

src/generation/generators/index.ts

@@ -4,6 +4,7 @@ import { CustomizedColumn, CustomizedTable } from '../../schema/customized-schem
 import { BitGenerator } from './bit.generator';
 import { BooleanGenerator } from './boolean.generator';
 import { DateGenerator } from './date.generator';
+import { FakerGenerator } from './faker.generator';
 import { ForeignKeyGenerator } from './foreignkey.generator';
 import { FunctionGenerator } from './function.generator';
 import { AbstractGenerator, Generators } from './generators';
@@ -55,6 +56,9 @@ export class GeneratorBuilder {
             case Generators.function:
                 FunctionGenerator.validate(table, column);
                 break;
+            case Generators.faker:
+                FakerGenerator.validate(table, column);
+                break;
             case Generators.none:
             default:
                 throw new Error(`No generator defined for column: ${table.name}.${column.name}`);
@@ -98,6 +102,9 @@ export class GeneratorBuilder {
             case Generators.function:
                 generator = new FunctionGenerator(this.random, this.table, column);
                 break;
+            case Generators.faker:
+                generator = new FakerGenerator(this.random, this.table, column);
+                break;
             case Generators.none:
             default:
                 throw new Error(`No generator defined for column: ${this.table.name}.${column.name}`);

src/schema/custom-schema.class.ts

@@ -83,6 +83,8 @@ export class CustomTable {
     addLines?: number;
     @IsBoolean()
     disableTriggers?: boolean;
+    @IsString()
+    template?: any;
 }
 
 type CustomColumn = { name: string; } & Partial<Column>;

src/schema/customized-schema.class.ts

@@ -78,6 +78,7 @@ export class CustomizedSchema extends CustomSchema {
             if (customColumn.unique !== undefined) customizedColumnBuilder.set('unique', customColumn.unique);
             if (customColumn.unsigned !== undefined) customizedColumnBuilder.set('unsigned', customColumn.unsigned);
             if (customColumn.customFunction !== undefined) customizedColumnBuilder.set('customFunction', customColumn.customFunction);
+            if (customColumn.template !== undefined) customizedColumnBuilder.set('template', customColumn.template);
             if (customColumn?.foreignKey) {
                 customizedColumnBuilder.set('foreignKey', customColumn.foreignKey);
                 customizedTable.referencedTables.push(customColumn.foreignKey.table);

src/schema/schema.class.ts

@@ -1,5 +1,5 @@
-import { IsArray, ValidateNested, IsString, IsBoolean, IsNumber, IsOptional, validateOrReject } from 'class-validator';
-import { Type, plainToClass, classToPlain } from 'class-transformer';
+import { classToPlain, plainToClass, Type } from 'class-transformer';
+import { IsArray, IsBoolean, IsNumber, IsOptional, IsString, ValidateNested, validateOrReject } from 'class-validator';
 import { Generators } from '../generation/generators/generators';
 
 export class Schema {
@@ -82,4 +82,10 @@ export class Column {
     @IsOptional()
     @IsString()
     customFunction?: string;
+    @IsOptional()
+    @IsString()
+    template?: string;
+    @IsOptional()
+    @IsString()
+    locale?: string;
 }