@solidxai/core 0.0.2

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

@@ -0,0 +1,61 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, ValidateNested, IsArray, IsOptional, IsJSON, IsInt } from 'class-validator';
+import { Type } from 'class-transformer';
+import { UpdateDashboardVariableDto } from 'src/dtos/update-dashboard-variable.dto';
+import { UpdateDashboardQuestionDto } from 'src/dtos/update-dashboard-question.dto';
+
+export class CreateDashboardDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsJSON()
+    @ApiProperty()
+    layoutJson: any;
+    @IsOptional()
+    @ApiProperty()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => UpdateDashboardVariableDto)
+    dashboardVariables: UpdateDashboardVariableDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty()
+    dashboardVariablesIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    dashboardVariablesCommand: string;
+    @IsOptional()
+    @ApiProperty()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => UpdateDashboardQuestionDto)
+    questions: UpdateDashboardQuestionDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty()
+    questionsIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    questionsCommand: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    moduleId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    moduleUserKey: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    displayName: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is a description of the dashboard configuration, providing context and details about the dashboard." })
+    description: string;
+}

package/src/dtos/create-email-attachment.dto.ts

@@ -0,0 +1,29 @@
+import { IsInt, IsNotEmpty, IsOptional, IsString, Matches } from "class-validator";
+import { ApiProperty } from '@nestjs/swagger';
+
+export class CreateEmailAttachmentDto {
+    @IsNotEmpty()
+    @Matches(/[a-z]+(-[a-z]+)*/)
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    displayName: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    relativePath: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    url: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    template: string;
+    @IsOptional()
+    @IsInt()
+    emailTemplateId: number;
+}

package/src/dtos/create-email-template.dto.ts

@@ -0,0 +1,41 @@
+import { IsArray, IsBoolean, IsEmail, IsNotEmpty, IsOptional, MaxLength, MinLength, ValidateNested, Matches, IsString } from 'class-validator';
+import { CreateEmailAttachmentDto } from './create-email-attachment.dto';
+import { Type } from 'class-transformer';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class CreateEmailTemplateDto {
+    @IsNotEmpty()
+    @Matches(/[a-z]+(-[a-z]+)*/)
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    displayName: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    body: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    subject: string = "{}";
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    description: string;
+    @IsOptional()
+    @IsBoolean()
+    @ApiProperty()
+    active: boolean = true;
+    @IsOptional()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => CreateEmailAttachmentDto)
+    attachments: CreateEmailAttachmentDto[];
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    type: string;
+}

package/src/dtos/create-export-template.dto.ts

@@ -0,0 +1,27 @@
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsBoolean, IsOptional, IsInt, IsJSON } from 'class-validator';
+export class CreateExportTemplateDto {
+@IsNotEmpty()
+@IsString()
+templateName: string;
+
+@IsNotEmpty()
+@IsString()
+templateFormat: string;
+
+@IsOptional()
+@IsBoolean()
+notifyOnEmail: boolean = true;
+
+@IsNotEmpty()
+@IsJSON()
+fields: any;
+
+@IsOptional()
+@IsInt()
+modelMetadataId: number;
+
+@IsString()
+@IsOptional()
+modelMetadataUserKey: string;
+}

package/src/dtos/create-export-transaction.dto.ts

@@ -0,0 +1,26 @@
+import { IsDate } from 'class-validator';
+import { IsNotEmpty, IsString, IsOptional, IsInt } from 'class-validator';
+export class CreateExportTransactionDto {
+constructor(data: Partial<CreateExportTransactionDto>) {
+    Object.assign(this, data);
+}    
+@IsNotEmpty()
+@IsDate()
+datetime: Date;
+
+@IsNotEmpty()
+@IsString()
+status: string;
+
+@IsOptional()
+@IsString()
+error: string;
+
+@IsOptional()
+@IsInt()
+exportTemplateId: number;
+
+@IsString()
+@IsOptional()
+exportTemplateUserKey: string;
+}

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

@@ -0,0 +1,467 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Transform, Type } from 'class-transformer';
+
+import {
+  IsArray,
+  IsBoolean,
+  IsEnum,
+  IsIn,
+  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 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',
+  simplejson = 'simple-json'
+}
+
+export enum MSSQLType {
+  int = "int",
+  bigint = "bigint",
+  decimal = "decimal",
+  numeric = "numeric",
+  varchar = "varchar",
+  nvarchar = "nvarchar",
+  simplejson = "simple-json",
+  text = "text",
+  bit = "bit",
+  date = "date",
+  datetime = "datetime",
+  datetime2 = "datetime2",
+  time = "time",
+  uniqueidentifier = "uniqueidentifier"
+}
+
+export const ALL_ORM_TYPES = [
+  ...Object.values(PSQLType),
+  ...Object.values(MSSQLType),
+  ...Object.values(MySQLType),
+] as const;
+
+export type OrmType = typeof ALL_ORM_TYPES[number];
+
+// export type OrmType = PSQLType | MySQLType | MSSQLType;
+
+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',
+  oneToMany = 'one-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 enum ComputedFieldTriggerOperation {
+  beforeInsert = "before-insert",
+  afterInsert = "after-insert",
+  beforeUpdate = "before-update",
+  afterUpdate = "after-update",
+  beforeRemove = "before-delete",
+  afterRemove = "after-delete",
+}
+
+export class ComputedFieldTriggerConfig {
+  moduleName: string; // Name of the module where the computed field is defined
+  modelName: string;
+  operations: ComputedFieldTriggerOperation[]; // List of operations where this computed field should be triggered
+}
+
+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', })
+  @IsIn(ALL_ORM_TYPES)
+  @IsOptional()
+  readonly ormType: OrmType;
+
+  @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()
+  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()
+  relationCoModelSingularName: 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()
+  relationCoModelFieldName: string;
+
+  @ApiProperty({ description: 'Only for type=relation, many-to-many. This field is used to set the owner of the many-to-many relation' })
+  @IsOptional()
+  isRelationManyToManyOwner: boolean;
+
+
+  @ApiProperty({ description: 'Only for type=relation, many-to-many. This field is used to store fixed filters that needs to applied on related model' })
+  @IsOptional()
+  relationFieldFixedFilter: 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;
+
+  @IsArray()
+  @Type(() => ComputedFieldTriggerConfig)
+  @IsOptional()
+  computedFieldTriggerConfig: ComputedFieldTriggerConfig[];
+
+  @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
+
+  @ApiProperty({ description: 'Relation CoModel Column Name of Field', })
+  @IsString()
+  @IsOptional()
+  relationCoModelColumnName: string
+
+  @ApiProperty({ description: "Is User Key" })
+  @IsOptional()
+  @IsBoolean()
+  readonly isUserKey: boolean
+
+  @ApiProperty({ description: 'Relation Join Table Name of Field', })
+  @IsString()
+  @IsOptional()
+  relationJoinTableName: string
+
+  @ApiProperty({ description: 'Enable Audit Tracking for this field', })
+  @IsOptional()
+  @IsBoolean()
+  enableAuditTracking?: boolean;
+
+  @IsOptional()
+  @ApiProperty({ description: 'Is MultiSelect Field', })
+  @IsBoolean()
+  isMultiSelect: boolean;
+
+  @IsOptional()
+  @ApiProperty({ description: 'Is Primary Key Field', })
+  @IsBoolean()
+  isPrimaryKey?: boolean;
+}

package/src/dtos/create-import-transaction-error-log.dto.ts

@@ -0,0 +1,34 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsInt, IsJSON, IsOptional } from 'class-validator';
+
+export class CreateImportTransactionErrorLogDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    importTransactionErrorLogId: string;
+    @IsNotEmpty()
+    @IsInt()
+    @ApiProperty()
+    rowNumber: number;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty()
+    rowData: any;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    importTransactionId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    importTransactionUserKey: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    errorMessage: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    errorTrace: string;
+}