@solidstarters/solid-core 1.2.0

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

@@ -0,0 +1,385 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+
+import {
+  IsArray,
+  IsBoolean,
+  IsEnum,
+  IsInt,
+  IsOptional,
+  IsString,
+  Matches,
+  ValidateIf
+} from 'class-validator';
+export enum RelationFieldsCommand {
+  set = "set",
+  clear = "clear",
+  link = "link",
+  unlink = "unlink",
+  create = "create",
+  update = "update",
+  delete = "delete"
+}
+
+export enum SolidFieldType {
+  // numeric types
+  int = 'int',
+  bigint = 'bigint',
+  // float = 'float',
+  // double = 'double',
+  decimal = 'decimal',
+
+  // text types
+  shortText = 'shortText',
+  longtext = 'longText',
+  richText = 'richText',
+  json = 'json',
+
+  // boolean types
+  boolean = 'boolean',
+
+  // date
+  date = 'date',
+  datetime = 'datetime',
+  time = 'time',
+
+  // relation
+  relation = 'relation',
+
+  // media
+  mediaSingle = 'mediaSingle',
+  mediaMultiple = 'mediaMultiple',
+
+  email = 'email',
+  password = 'password',
+
+  // selection
+  selectionStatic = 'selectionStatic',
+  selectionDynamic = 'selectionDynamic',
+
+  computed = 'computed',
+
+  uuid = 'uuid'
+}
+
+export enum OrmType {
+  MySQLType,
+}
+
+export enum MySQLType { //FIXME Currently this type is being used in the definition, Need to use OrmType instead
+  // Numeric types
+  int = 'int',
+  decimal = 'decimal',
+  double = 'double',
+
+  // Text types
+  // fieldType=shortText
+  varchar = 'varchar',
+  // fieldType=longText
+  text = 'shortText',
+  mediumtext = 'mediumtext',
+  longtext = 'longtext',
+
+  // Boolean types
+  // fieldType=boolean
+  bool = 'bool',
+  boolean = 'boolean',
+
+  //Date Types
+  date = 'date',
+  datetime = 'datetime',
+  timestamp = 'timestamp',
+  time = 'time',
+
+  // Other types
+  json = 'json',
+
+}
+
+export enum PSQLType { //FIXME Currently this type is being used in the definition, Need to use OrmType instead
+  // Numeric types
+  integer = 'integer',
+  decimal = 'decimal',
+  bigint = 'bigint',
+
+  // Text types
+  varchar = 'varchar',
+  text = 'text',
+
+  // Boolean types
+  boolean = 'boolean',
+
+  // Date types
+  timestamp = 'timestamp',
+  timestamptz = 'timestamptz',
+  time = 'time',
+  date = 'date',
+
+  // Other types
+  json = 'json',
+  jsonb = 'jsonb',
+}
+
+
+export enum EncryptionType {
+  aes128 = 'aes-128',
+  aes256 = 'aes-256',
+}
+
+export enum DecryptWhenType {
+  beforeTransit = 'before-transit',
+  afterTransit = 'after-transit',
+}
+
+export enum MediaType {
+  image = 'image',
+  audio = 'audio',
+  video = 'video',
+  // document = 'document',
+  file = 'file',
+}
+
+export enum RelationType {
+  manyToOne = 'many-to-one',
+  manyTomany = 'many-to-many',
+}
+
+export enum CascadeType {
+  setNull = 'set null',
+  restrict = 'restrict',
+  cascade = 'cascade',
+}
+
+// export enum MediaStorageProviderType {
+//   database = 'database',
+//   file = 'file',
+//   s3 = 's3',
+// }
+
+export enum SelectionValueType {
+  string = 'string',
+  int = 'int',
+}
+
+export enum ComputedFieldValueType {
+  string = 'string',
+  int = 'int',
+  decimal = 'decimal',
+  boolean = 'boolean',
+  date = 'date',
+  datetime = 'datetime',
+}
+
+export class CreateFieldMetadataDto {
+  @ApiProperty({ description: 'Name of your field, this is also the name of the column or attribute', })
+  // @Matches(/[a-z]+(_[a-z]+)*/, { message: 'Field name should follow snake case conventions only with all lower case.', })
+  @IsString()
+  name: string;
+
+  @ApiProperty({ description: 'Display name of your field' })
+  @IsString()
+  readonly displayName: string;
+
+
+  @ApiProperty({ description: 'Description of your field' })
+  @IsOptional()
+  @IsString()
+  readonly description: string;
+
+  // @ApiProperty({ description: "Help text associated with this field" })
+  // @IsString()
+  // readonly helpText: string;
+
+  @ApiProperty({ description: 'Field can have types' })
+  @IsEnum(SolidFieldType)
+  readonly type: SolidFieldType;
+
+  @ApiProperty({ description: 'Related model id' })
+  @IsInt()
+  @IsOptional()
+  readonly modelId: number;
+
+  //For all types of fields
+  @ApiProperty({ description: 'Field can have orm types specific to your database', })
+  @IsEnum(PSQLType)
+  @IsOptional()
+  readonly ormType: PSQLType;
+
+  @ApiProperty({ description: 'Length of the field. Only for type=text' })
+  @IsInt()
+  @IsOptional()
+  readonly length: number;
+
+  @ApiProperty({ description: 'Default value of the field' })
+  @IsString()
+  @IsOptional()
+  readonly defaultValue: string;
+
+  @ApiProperty({ description: 'Format regex pattern for the field. Only for type=text, longText, email, password', })
+  @IsString()
+  @IsOptional()
+  readonly regexPattern: string;
+
+  @ApiProperty({ description: 'If the regex pattern matching fails, then what is the error message to be displayed', })
+  @IsString()
+  @IsOptional()
+  readonly regexPatternNotMatchingErrorMsg: string;
+
+  @ApiProperty({ description: 'Is the field mandatory?' })
+  @IsBoolean()
+  readonly required: boolean;
+
+  @ApiProperty({ description: 'Is the field value unique?' })
+  @IsBoolean()
+  @IsOptional()
+  readonly unique: boolean;
+
+  @ApiProperty({ description: 'Is the field symmetric encrypted?' })
+  @IsBoolean()
+  readonly encrypt: boolean;
+
+  @ApiProperty({ description: 'Type of encryption. Only if encrypt=true' })
+  @IsEnum(EncryptionType)
+  @IsOptional()
+  readonly encryptionType: EncryptionType;
+
+  //Pending
+  @ApiProperty({ description: 'At what point do we want to decrypt the data? Only if encrypt=true', })
+  @IsEnum(DecryptWhenType)
+  @IsOptional()
+  decryptWhen: DecryptWhenType;
+
+  @ApiProperty({ description: 'Is the field indexed? For all types, except:richText, longText', })
+  @IsBoolean()
+  index: boolean;
+
+  @ApiProperty({ description: 'for text fields, this is length. for numeric fields, this is the range of values allowed. Only for type=shortText,longText,richText,json,int,decimal,date,dateTime,time', })
+  @IsInt()
+  @IsOptional()
+  @Transform(({ obj }) => obj.length ?? undefined) // Automatically sets max = length
+  @ValidateIf((obj) => obj.length !== undefined)  // Only validate if length is provided
+  max: number;
+
+  @ApiProperty({ description: 'for text fields, this is length. for numeric fields, this is the range of values allowed. Only for type=shortText,longText,richText,json,int,decimal,date,dateTime,time', })
+  @IsInt()
+  @IsOptional()
+  min: number;
+
+  @ApiProperty({ description: 'Is the field private?' })
+  @IsBoolean()
+  private: boolean;
+
+  @ApiProperty({ description: 'Allowed media types for the field. Only for type=mediaSingle,mediaMultiple', })
+  @IsEnum(MediaType, { each: true })
+  @IsOptional()
+  mediaTypes: MediaType[];
+
+  @ApiProperty({ description: 'Maximum size of the media in KB. Only for type=mediaSingle,mediaMultiple', })
+  @IsInt()
+  @IsOptional()
+  mediaMaxSizeKb: number;
+
+  @ApiProperty({ description: 'Configured Media storage provider. Only for type=mediaSingle,mediaMultiple', })
+  @IsInt()
+  @IsOptional()
+  mediaStorageProviderId?: number;
+
+  @ApiProperty({ description: 'Configured Media storage provider. Only for type=mediaSingle,mediaMultiple. When you need to specify the storage provider by name.', })
+  @IsInt()
+  @IsOptional()
+  mediaStorageProviderUserKey?: string;
+
+  // @ApiProperty({ description: 'Is the media embedded in the entity table? Only for type=mediaSingle', })
+  // @IsBoolean()
+  // @IsOptional()
+  // mediaEmbedded: boolean;
+
+  @ApiProperty({ description: 'Relation Type. Only for type=relation' })
+  @IsEnum(RelationType)
+  @IsOptional()
+  relationType: RelationType;
+
+  @ApiProperty({ description: 'Related model for the relation. Only for type=relation' })
+  @IsString()
+  @IsOptional()
+  relationModelSingularName: string;
+
+  @ApiProperty({ description: 'Create inverse relation. Only for type=relation', })
+  @IsBoolean()
+  @IsOptional()
+  relationCreateInverse: boolean;
+
+  @ApiProperty({ description: 'Cascade type. Only for type=relation' })
+  @IsEnum(CascadeType)
+  @IsOptional()
+  relationCascade: CascadeType;
+
+  @ApiProperty({ description: 'Related field module. Only required for type=relation, if the related field belongs to a different module' })
+  @IsOptional()
+  relationModelModuleName: string;
+
+  @ApiProperty({ description: 'Related field module. Only required for type=relation and relationType=many-to-many, i.e if the related many to many field belongs to a different model' })
+  @IsOptional()
+  relationModelFieldName: string;
+
+  @ApiProperty({
+    description:
+      'Dynamic provider for selection. Only for type=selectionDynamic',
+  })
+  @IsString()
+  @IsOptional()
+  selectionDynamicProvider: string;
+
+  @ApiProperty({ description: 'Dynamic provider Context. Only for type=selectionDynamic', })
+  @IsString()
+  @IsOptional()
+  selectionDynamicProviderCtxt: string;
+
+  @ApiProperty({ description: 'Static values for selection. Only for type=selectionStatic', })
+  @IsArray()
+  @IsString({ each: true })
+  @Matches(/^[\w\s\d-]+:[\w\s-]+$/, { each: true })
+  @IsOptional()
+  selectionStaticValues: string[];
+
+  @ApiProperty({ description: 'Type of value for selection. Applicable for type=selectionStatic,selectionDynamic', })
+  @IsEnum(SelectionValueType)
+  @IsOptional()
+  selectionValueType: SelectionValueType;
+
+  @ApiProperty({ description: 'Computed Field Value Provider. Only for type=computed', })
+  @IsString()
+  @IsOptional()
+  computedFieldValueProvider: string;
+
+  @ApiProperty({ description: 'Computed Field Value Provider Context. Only for type=computed', })
+  @IsString()
+  @IsOptional()
+  computedFieldValueProviderCtxt: string;
+
+  @ApiProperty({ description: 'Computed field value type. Only for type=computed', })
+  @IsEnum(ComputedFieldValueType)
+  @IsOptional()
+  computedFieldValueType: ComputedFieldValueType;
+
+  @IsOptional()
+  @ApiProperty({ description: 'Uuid.', })
+  @IsString()
+  @IsOptional()
+  uuid: string;
+
+  @IsOptional()
+  @ApiProperty({ description: 'System fields are not included in the code generation, the assumption being that system fields have manually written code.', })
+  @IsBoolean()
+  isSystem: boolean;
+
+  @IsOptional()
+  @ApiProperty({ description: 'Marked for removal, this is used to soft delete the field.', })
+  @IsBoolean()
+  isMarkedForRemoval: boolean;
+
+  @ApiProperty({ description: 'Column Name of Field', })
+  @IsString()
+  @IsOptional()
+  columnName: string
+}

package/src/dtos/create-list-of-values.dto.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+export class CreateListOfValuesDto {
+
+    @ApiProperty({ description: "Type of the LOV" })
+    readonly type : string;
+
+    @ApiProperty({ description: "Value of the LOV" })
+    readonly value: string;
+
+    @ApiProperty({ description: "Display of the LOV" })
+    readonly display: string;
+
+    @ApiProperty({ description: "Description of the LOV" })
+    readonly description: string;
+
+    @ApiProperty({ description: "Default value of the LOV type" })
+    readonly default : boolean;
+
+    @ApiProperty({ description: "Sequence of the LOV" })
+    readonly sequence: number;
+}

package/src/dtos/create-media-storage-provider-metadata.dto.ts

@@ -0,0 +1,37 @@
+import { IsBoolean, IsEnum, IsNotEmpty, IsOptional, IsString, isBoolean } from "class-validator";
+export enum MediaStorageProviderType {
+    Filesystem = 'filesystem',
+    AwsS3 = 'aws-s3',
+    AzureBlobStorage = 'azure-blob-storage'
+}
+export class CreateMediaStorageProviderMetadataDto {
+    // name
+    @IsNotEmpty()
+    @IsString()
+    readonly name : string;
+
+    // type filesystem|aws-s3|azure-blob-storage
+    @IsNotEmpty()
+    @IsEnum(MediaStorageProviderType)
+    readonly type : MediaStorageProviderType;
+
+    // region
+    @IsString()
+    @IsOptional()
+    readonly region : string;
+
+    // bucketName
+    @IsString()
+    @IsOptional()
+    readonly bucketName : string;
+
+    // isPublic
+    @IsOptional()
+    @IsBoolean()
+    readonly isPublic : boolean;
+
+    // localPath
+    @IsString()
+    @IsOptional()
+    readonly localPath : string;
+}

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

@@ -0,0 +1,23 @@
+import { IsBoolean, IsEnum, IsInt, IsNotEmpty, IsOptional, IsString, isBoolean } from "class-validator";
+export class CreateMediaDto {
+
+    @IsNotEmpty()
+    @IsInt()
+    entityId: number;
+
+    @IsNotEmpty()
+    @IsInt()
+    modelMetadataId: number; 
+
+    @IsNotEmpty()
+    @IsString()
+    relativeUri: string;
+    
+    @IsNotEmpty()
+    @IsInt()
+    mediaStorageProviderMetadataId: number;
+
+    @IsNotEmpty()
+    @IsInt()
+    fieldMetadataId: number; 
+}

package/src/dtos/create-menu-item-metadata.dto.ts

@@ -0,0 +1,60 @@
+import { IsNumber, IsString } from 'class-validator';
+import { Matches } from 'class-validator';
+import { IsNotEmpty, IsInt, IsOptional, ValidateNested, IsArray } from 'class-validator';
+import { Transform, Type } from 'class-transformer';
+import { UpdateRoleMetadataDto } from './update-role-metadata.dto';
+import arrayTransformer from '../transformers/array-transformer';
+export class CreateMenuItemMetadataDto {
+    @IsNotEmpty()
+    @Matches(/[a-z]+(-[a-z]+)*/)
+    @IsString()
+    name: string;
+
+    @IsNotEmpty()
+    @IsString()
+    displayName: string;
+
+    @IsOptional()
+    @IsInt()
+    moduleId: number;
+
+    @IsString()
+    @IsOptional()
+    moduleUserKey: string;
+
+    @IsOptional()
+    @IsInt()
+    parentMenuItemId: number;
+
+    @IsString()
+    @IsOptional()
+    parentMenuItemUserKey: string;
+
+    @IsOptional()
+    @IsInt()
+    actionId: number;
+
+    @IsString()
+    @IsOptional()
+    actionUserKey: string;
+
+    @IsOptional()
+    @IsArray()
+    @Transform(arrayTransformer)
+    @ValidateNested({ each: true })
+    @Type(() => UpdateRoleMetadataDto)
+    roles: UpdateRoleMetadataDto[];
+
+    @IsOptional()
+    @IsArray()
+    rolesIds: number[];
+
+    @IsString()
+    @IsOptional()
+    rolesCommand: string;
+
+    @IsOptional()
+    @IsNumber()
+    sequenceNumber: number;
+
+}

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

@@ -0,0 +1,12 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+export class CreateMessageDto {
+    readonly retryCount: number;
+    readonly retryInterval: number;
+    readonly messageType: string;
+    readonly stage: string;
+    readonly input: string;
+    readonly parentEntityId: number;
+    readonly parentEntity: string;
+    readonly queueName: string;
+}

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

@@ -0,0 +1,101 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { Type } from "class-transformer";
+import { IsArray, IsBoolean, IsInt, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
+import { CreateFieldMetadataDto } from "./create-field-metadata.dto";
+import { IsNotInEnum } from "src/decorators/is-not-in-enum.decorator";
+import { RESERVED_SOLID_KEYWORDS } from "src/helpers/solid-registry";
+
+export enum DatasourceType {
+    // numeric types
+    // mongodb = 'mongodb',
+    // rdbms = 'rdbms',
+
+    mysql = 'mysql',
+    postgres = 'postgres',
+    mssql = 'mssql',
+    oracle = 'oracle',
+    mariadb = 'mariadb',
+}
+
+export class CreateModelMetadataDto {
+    @ApiProperty({ description: "Display name of your model" })
+    @Matches(/[a-z]+(-[a-z]+)*/, {
+        message: "Model name should follow snake case conventions only with all lower case."
+    })
+    @IsNotInEnum(RESERVED_SOLID_KEYWORDS)
+    readonly singularName: string;
+
+    @ApiProperty({ description: "Name of your module" })
+    @Matches(/[a-z]+(_[a-z]+)*/, {
+        message: "Only snake case allowed for module table name, also only lower case."
+    })
+    @IsOptional()
+    readonly tableName?: string;
+
+    @ApiProperty({ description: "Display name of your model" })
+    @Matches(/[a-z]+(-[a-z]+)*/, {
+        message: "Model name should follow snake case conventions only with all lower case."
+    })
+    readonly pluralName: string;
+
+    @ApiProperty({ description: "Display name of your model" })
+    @IsString()
+    readonly displayName: string;
+
+    @ApiProperty({ description: "Describe your model" })
+    @IsString()
+    readonly description: string;
+
+    @ApiProperty({ description: "The data source to use with this model" })
+    // @IsEnum(DataSource)
+    @IsString()
+    readonly dataSource: string;
+
+    @ApiProperty({ description: "You can have models linked to MongoDB or to an RDBMS" })
+    @IsString()
+    readonly dataSourceType: string;
+
+    @ApiProperty({ description: "Enable Soft Delete" })
+    @IsBoolean()
+    readonly enableSoftDelete: boolean;
+
+    @ApiProperty({ description: "Enable Soft Delete" })
+    @IsBoolean()
+    readonly enableAuditTracking: boolean
+
+    @ApiProperty({ description: "Enable Soft Delete" })
+    @IsBoolean()
+    readonly internationalisation: boolean
+
+    @ApiProperty({ description: "Related module id" })
+    @IsInt()
+    @IsOptional()
+    moduleId: number;
+
+    @IsString()
+    @IsOptional()
+    moduleUserKey?: string;
+
+    @ApiProperty({ description: "Related user key field id" })
+    @IsInt()
+    @IsOptional()
+    userKeyFieldId: number;
+
+    @IsString()
+    @IsOptional()
+    userKeyFieldUserKey?: string;
+
+    @ApiProperty({ description: "Fields associated with this model" })
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => CreateFieldMetadataDto)
+    fields: CreateFieldMetadataDto[];
+
+    @ApiProperty({ description: "Is Exportable" })
+    @IsBoolean()
+    readonly isExportable: boolean
+
+    @ApiProperty({ description: 'System models are not included in the code generation, the assumption being that system models have manually written code.', })
+    @IsBoolean()
+    isSystem: boolean;
+}

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

@@ -0,0 +1,52 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { Type } from "class-transformer";
+import { IsArray, IsBoolean, IsEnum, IsNumber, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
+import { CreateModelMetadataDto } from "./create-model-metadata.dto";
+import { IsNotInEnum } from "src/decorators/is-not-in-enum.decorator";
+import { RESERVED_SOLID_KEYWORDS } from "src/helpers/solid-registry";
+
+export class CreateModuleMetadataDto {
+    @ApiProperty({ description: "Name of your module" })
+    @Matches(/[a-z]+(-[a-z]+)*/, {
+        message: "Only kebab case allowed for module name, also only lower case."
+    })
+    @IsNotInEnum(RESERVED_SOLID_KEYWORDS)
+    readonly name: string;
+
+    @ApiProperty({ description: "Display name of your module" })
+    @IsString()
+    readonly displayName: string;
+
+    @ApiProperty({ description: "Describe your module" })
+    @IsString()
+    readonly description: string;
+
+    @ApiProperty({ description: "Icon file to be used for your module, if file specified then this field can be empty. Else if you have a preuploaded Icon somewhere you can simply specify the Url here. " })
+    @IsString()
+    @IsOptional()
+    menuIconUrl: string;
+
+    @ApiProperty({ description: "The default data source to use with this module" })
+    // @IsEnum(DataSource)
+    @IsOptional()
+    readonly defaultDataSource: string;
+
+    @ApiProperty({ description: "Fields associated with this model" })
+    @IsArray()
+    @IsOptional()
+    @ValidateNested({ each: true })
+    @Type(() => CreateModelMetadataDto)
+    models: CreateModelMetadataDto[];
+
+    @ApiProperty({ description: 'System modules are not included in the code generation, the assumption being that system modules have manually written code.', })
+    @IsBoolean()
+    isSystem: boolean;
+
+
+    @ApiProperty({ description: "The Position of Module in Menu " })
+    // @IsEnum(DataSource)
+    @IsOptional()
+    @IsNumber()
+    menuSequenceNumber? :number
+
+}