@solidstarters/solid-core 1.2.134 → 1.2.135

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

@@ -0,0 +1,53 @@
+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 { UpdateQuestionDto } from 'src/dtos/update-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(() => UpdateQuestionDto)
+    questions: UpdateQuestionDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty()
+    questionsIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    questionsCommand: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    moduleId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    moduleUserKey: string;
+}

package/src/dtos/create-question-sql-dataset-config.dto.ts

@@ -0,0 +1,42 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsOptional, IsInt, IsJSON } from 'class-validator';
+
+export class CreateQuestionSqlDatasetConfigDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    datasetName: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "This is the display name for the dataset configuration, which can be used in UI components to represent the dataset in a user-friendly manner." })
+    datasetDisplayName: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is a description of the dataset configuration, providing context and details about its purpose." })
+    description: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    sql: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    labelColumnName: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    valueColumnName: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Related Question Model" })
+    questionId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Question Model" })
+    questionUserKey: string;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "This allows you to set the dataset options e.g border-color, background-color, etc. This is a JSON object that can be used to customize the dataset appearance or behavior in the UI." })
+    options: any;
+}

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

@@ -0,0 +1,58 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsOptional, IsJSON, IsInt, ValidateNested, IsArray } from 'class-validator';
+import { Type } from 'class-transformer';
+import { UpdateQuestionSqlDatasetConfigDto } from 'src/dtos/update-question-sql-dataset-config.dto';
+
+export class CreateQuestionDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    sourceType: string;
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty()
+    visualisedAs: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is only applicable when sourceType is set to provider. It allows the user to select any pre-existing Dashboard Question Data provider implementation used to fetch a dynamic dropdown of values to choose from when this question is presented to the user." })
+    providerName: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardUserKey: string;
+    @IsOptional()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => UpdateQuestionSqlDatasetConfigDto)
+    questionSqlDatasetConfigs: UpdateQuestionSqlDatasetConfigDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    questionSqlDatasetConfigsIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    questionSqlDatasetConfigsCommand: string;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "This is a JSON object representing each labels display and color options for the bar chart" })
+    chartOptions: any;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the SQL query to fetch the label values for the question" })
+    labelSql: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the SQL query to fetch the KPI value for the question" })
+    kpiSql: string;
+}

package/src/dtos/dashboard-variable-selection-dynamic-query.dto.ts

@@ -0,0 +1,29 @@
+
+import { ApiProperty } from "@nestjs/swagger";
+import { Transform, Type } from "class-transformer";
+import { IsNumber, IsOptional, IsString } from "class-validator";
+import { PaginationQueryDto } from "src/dtos/pagination-query.dto";
+import integerTransformer from "../transformers/integer-transformer";
+
+export class DashboardVariableSelectionDynamicQueryDto extends PaginationQueryDto {
+    constructor(variableId: number, query: string, limit: number, offset: number) {
+        super(limit, offset);
+        this.variableId = variableId;
+        this.query = query;
+    }
+
+    @ApiProperty({ description: "Field ID of the field against which the dynamic value provider is registered.", type: Number })
+    @IsNumber()
+    @Transform(integerTransformer)
+    variableId: number;
+
+    @ApiProperty({ description: "Search query string", type: String })
+    @IsString()
+    @IsOptional()
+    query?: any;
+
+    @ApiProperty({ description: "Value of a single dynamic option", type: String })
+    @IsString()
+    @IsOptional()
+    optionValue?: string = '';
+}

package/src/dtos/invoke-ai-prompt.dto.ts

@@ -0,0 +1,6 @@
+import { IsString } from 'class-validator';
+
+export class InvokeAiPromptDto {
+    @IsString()
+    prompt: string;
+}

package/src/dtos/update-ai-interaction.dto.ts

@@ -0,0 +1,65 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+export class UpdateAiInteractionDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+@IsOptional()
+@IsInt()
+@ApiProperty()
+userId: number;
+
+@IsString()
+@IsOptional()
+@ApiProperty()
+userUserKey: string;
+
+@IsNotEmpty()
+@IsOptional()
+@IsString()
+@ApiProperty()
+threadId: string;
+
+@IsNotEmpty()
+@IsOptional()
+@IsString()
+@ApiProperty()
+role: string;
+
+@IsNotEmpty()
+@IsOptional()
+@IsString()
+@ApiProperty()
+message: string;
+
+@IsOptional()
+@IsString()
+@ApiProperty()
+contentType: string;
+
+@IsOptional()
+@IsString()
+@ApiProperty()
+status: string;
+
+@IsOptional()
+@IsString()
+@ApiProperty()
+errorMessage: string;
+
+@IsOptional()
+@IsString()
+@ApiProperty()
+modelUsed: string;
+
+@IsOptional()
+@IsInt()
+@ApiProperty()
+responseTimeMs: number;
+
+@IsOptional()
+@IsJSON()
+@ApiProperty()
+metadata: any;
+}

package/src/dtos/update-dashboard-variable.dto.ts

@@ -0,0 +1,54 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsJSON, IsBoolean } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateDashboardVariableDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    variableName: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    variableType: string;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty()
+    selectionStaticValues: any;
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    selectionDynamicSourceType: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "SQL query to fetch the data for this variable when it is rendered at runtime. This is only applicable when selectionDynamicSourceType is set to SQL." })
+    selectionDynamicSQL: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is only applicable when selectionDynamicSourceType is set to provider. It allows the user to select any pre-existing Dashboard SelectionDynamicProvider implementation used to fetch a dynamic dropdown of values to choose from when this variable is presented to the user." })
+    selectionDynamicProviderName: string;
+    @IsOptional()
+    @IsBoolean()
+    @ApiProperty({ description: "This is relevant only for variables of type \"selectionStatic\" or \"selectionDynamic\". When set to true, it allows the user to select multiple values from the dropdown." })
+    isMultiSelect: boolean;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardUserKey: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the default value for this variable when it is rendered at runtime. It can be a static value for this variable when it is rendered at runtime." })
+    defaultValue: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the default operator for this variable when it is rendered at runtime. It can be a static value for this variable when it is rendered at runtime." })
+    defaultOperator: string;
+}

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

@@ -0,0 +1,57 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, ValidateNested, IsArray, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { UpdateDashboardVariableDto } from 'src/dtos/update-dashboard-variable.dto';
+import { UpdateQuestionDto } from 'src/dtos/update-question.dto';
+
+export class UpdateDashboardDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @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(() => UpdateQuestionDto)
+    questions: UpdateQuestionDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty()
+    questionsIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    questionsCommand: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    moduleId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    moduleUserKey: string;
+}

package/src/dtos/update-question-sql-dataset-config.dto.ts

@@ -0,0 +1,49 @@
+import { IsInt, IsOptional, IsString, IsNotEmpty, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateQuestionSqlDatasetConfigDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    datasetName: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the display name for the dataset configuration, which can be used in UI components to represent the dataset in a user-friendly manner." })
+    datasetDisplayName: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is a description of the dataset configuration, providing context and details about its purpose." })
+    description: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    sql: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    labelColumnName: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    valueColumnName: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Related Question Model" })
+    questionId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Question Model" })
+    questionUserKey: string;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "This allows you to set the dataset options e.g border-color, background-color, etc. This is a JSON object that can be used to customize the dataset appearance or behavior in the UI." })
+    options: any;
+}

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

@@ -0,0 +1,63 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsJSON, ValidateNested, IsArray } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { UpdateQuestionSqlDatasetConfigDto } from 'src/dtos/update-question-sql-dataset-config.dto';
+
+export class UpdateQuestionDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    name: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    sourceType: string;
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    visualisedAs: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is only applicable when sourceType is set to provider. It allows the user to select any pre-existing Dashboard Question Data provider implementation used to fetch a dynamic dropdown of values to choose from when this question is presented to the user." })
+    providerName: string;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardId: number;
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Dashboard Model" })
+    dashboardUserKey: string;
+    @IsOptional()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => UpdateQuestionSqlDatasetConfigDto)
+    questionSqlDatasetConfigs: UpdateQuestionSqlDatasetConfigDto[];
+    @IsOptional()
+    @IsArray()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    questionSqlDatasetConfigsIds: number[];
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Related Question SQL Dataset Config Model" })
+    questionSqlDatasetConfigsCommand: string;
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "This is a JSON object representing each labels display and color options for the bar chart" })
+    chartOptions: any;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the SQL query to fetch the label values for the question" })
+    labelSql: string;
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "This is the SQL query to fetch the KPI value for the question" })
+    kpiSql: string;
+}

package/src/entities/ai-interaction.entity.ts

@@ -0,0 +1,39 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import {Entity, JoinColumn, ManyToOne, Index, Column} from 'typeorm';
+import { User } from 'src/entities/user.entity'
+@Entity("ss_ai_interactions")
+export class AiInteraction extends CommonEntity{
+@Index()
+@ManyToOne(() => User, { onDelete: "CASCADE", nullable: false })
+@JoinColumn()
+user: User;
+
+@Index()
+@Column({ type: "varchar" })
+threadId: string;
+
+@Column({ type: "varchar" })
+role: string;
+
+@Column({ type: "text" })
+message: string;
+
+@Column({ type: "varchar", nullable: true })
+contentType: string;
+
+@Index()
+@Column({ type: "varchar", nullable: true })
+status: string;
+
+@Column({ type: "text", nullable: true })
+errorMessage: string;
+
+@Column({ type: "varchar", nullable: true })
+modelUsed: string;
+
+@Column({ type: "integer", nullable: true })
+responseTimeMs: number;
+
+@Column({ type: "jsonb", nullable: true })
+metadata: any;
+}

package/src/entities/dashboard-variable.entity.ts

@@ -0,0 +1,30 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import {Entity, Column, Index, JoinColumn, ManyToOne} from 'typeorm';
+import { Dashboard } from 'src/entities/dashboard.entity'
+
+@Entity("ss_dashboard_variable")
+export class DashboardVariable extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    variableName: string;
+    @Index()
+    @Column({ type: "varchar" })
+    variableType: string;
+    @Column({ type: "jsonb", nullable: true })
+    selectionStaticValues: any;
+    @Column({ nullable: true })
+    selectionDynamicSourceType: string;
+    @Column({ type: "text", nullable: true })
+    selectionDynamicSQL: string;
+    @Column({ type: "varchar", nullable: true })
+    selectionDynamicProviderName: string;
+    @Column({ type: "boolean", nullable: true, default: true })
+    isMultiSelect: boolean = true;
+    @ManyToOne(() => Dashboard, { onDelete: "CASCADE", nullable: true })
+    @JoinColumn()
+    dashboard: Dashboard;
+    @Column({ type: "text", nullable: true })
+    defaultValue: string;
+    @Column({ type: "varchar", nullable: true })
+    defaultOperator: string;
+}

package/src/entities/dashboard.entity.ts

@@ -0,0 +1,21 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import { Entity, Column, Index, OneToMany, JoinColumn, ManyToOne } from 'typeorm';
+import { DashboardVariable } from 'src/entities/dashboard-variable.entity';
+import { Question } from 'src/entities/question.entity';
+import { ModuleMetadata } from 'src/entities/module-metadata.entity'
+
+@Entity("ss_dashboard")
+export class Dashboard extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    name: string;
+    @Column({ type: "text" })
+    layoutJson: any;
+    @OneToMany(() => DashboardVariable, dashboardVariable => dashboardVariable.dashboard, { cascade: true })
+    dashboardVariables: DashboardVariable[];
+    @OneToMany(() => Question, question => question.dashboard, { cascade: true })
+    questions: Question[];
+    @ManyToOne(() => ModuleMetadata, { onDelete: "CASCADE", nullable: false })
+    @JoinColumn()
+    module: ModuleMetadata;
+}

package/src/entities/question-sql-dataset-config.entity.ts

@@ -0,0 +1,25 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import { Entity, Column, Index, JoinColumn, ManyToOne } from 'typeorm';
+import { Question } from 'src/entities/question.entity'
+
+@Entity("ss_question_sql_dataset_config")
+export class QuestionSqlDatasetConfig extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    datasetName: string;
+    @Column({ type: "varchar" })
+    datasetDisplayName: string;
+    @Column({ type: "text", nullable: true })
+    description: string;
+    @Column({ type: "text" })
+    sql: string;
+    @Column({ type: "varchar" })
+    labelColumnName: string;
+    @Column({ type: "varchar" })
+    valueColumnName: string;
+    @ManyToOne(() => Question, { onDelete: "CASCADE", nullable: false })
+    @JoinColumn()
+    question: Question;
+    @Column({ type: "text", nullable: true })
+    options: any;
+}

package/src/entities/question.entity.ts

@@ -0,0 +1,30 @@
+import { CommonEntity } from 'src/entities/common.entity'
+import { Entity, Column, Index, JoinColumn, ManyToOne, OneToMany } from 'typeorm';
+import { Dashboard } from 'src/entities/dashboard.entity';
+import { QuestionSqlDatasetConfig } from 'src/entities/question-sql-dataset-config.entity'
+
+@Entity("ss_question")
+export class Question extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    name: string;
+    @Index()
+    @Column({})
+    sourceType: string;
+    @Index()
+    @Column({})
+    visualisedAs: string;
+    @Column({ type: "varchar", nullable: true })
+    providerName: string;
+    @ManyToOne(() => Dashboard, { onDelete: "CASCADE", nullable: true })
+    @JoinColumn()
+    dashboard: Dashboard;
+    @OneToMany(() => QuestionSqlDatasetConfig, questionSqlDatasetConfig => questionSqlDatasetConfig.question, { cascade: true })
+    questionSqlDatasetConfigs: QuestionSqlDatasetConfig[];
+    @Column({ type: "jsonb", nullable: true })
+    chartOptions: any;
+    @Column({ type: "text", nullable: true })
+    labelSql: string;
+    @Column({ type: "text", nullable: true })
+    kpiSql: string;
+}