@solidstarters/solid-core 1.2.143 → 1.2.145

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstarters/solid-core",
-  "version": "1.2.143",
+  "version": "1.2.145",
   "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",

package/src/config/common.config.ts

@@ -13,10 +13,11 @@ export default registerAs('common', () => {
             port: +(process.env.COMMON_SMTP_EMAIL_SMTP_PORT ?? 587),
             username: process.env.COMMON_SMTP_EMAIL_USERNAME,
             password: process.env.COMMON_SMTP_EMAIL_PASSWORD,
-            from: process.env.COMMON_SMTP_EMAIL_FROM,
+            from: process.env.COMMON_SMTP_EMAIL_FROM ?? process.env.COMMON_EMAIL_FROM,
         },
         apiMail: {
-            key: process.env.COMMON_API_EMAIL_KEY
+            key: process.env.COMMON_API_EMAIL_KEY,
+            from: process.env.COMMON_EMAIL_FROM
         },
         msg91Sms: {
             url: process.env.COMMON_MSG91_SMS_URL,

package/src/constants/error-messages.ts

@@ -0,0 +1,123 @@
+// backend/common/constants/error-messages.ts
+
+export const ERROR_MESSAGES = {
+    //authentication errors
+    USER_NOT_FOUND: 'User does not exist.',
+    USER_NOT_ACTIVE: 'User profile is not activated.',
+    USER_INACTIVE: 'User is inactive.',
+    PASSWORD_INCORRECT: 'Password does not match.',
+    PUBLIC_REGISTRATION_DISABLED: 'Public registrations are disabled.',
+    UNIQUE_CONSTRAINT_VIOLATION: 'A unique constraint violation occurred.',
+    PASSWORDLESS_REGISTRATION_DISABLED: 'Passwordless registration is not enabled.',
+    REGISTRATION_REQUIRES_CONTACT: 'Either mobile or email is required for initiating registration.',
+    EMAIL_REQUIRED_FOR_VALIDATION: 'Email is required for email validation source.',
+    MOBILE_REQUIRED_FOR_VALIDATION: 'Mobile is required for mobile validation source.',
+    USER_ALREADY_EXISTS: 'User already exists. Please sign in.',
+    VALIDATION_SOURCE_REQUIRED: 'At least one validation source is required.',
+    INVALID_OTP: 'Invalid OTP.',
+    OTP_EXPIRED: 'OTP has expired.',
+    INVALID_VERIFICATION_TYPE: 'Invalid type. Must be either email or mobile.',
+    NON_LOCAL_PROVIDER: 'User seems to have used a passwordless mode to authenticate.',
+    USER_ID_MISMATCH: "User ID's do not match.",
+    USERNAME_MISMATCH: "User username's do not match.",
+    INCORRECT_CURRENT_PASSWORD: 'Incorrect current password specified.',
+    PASSWORD_REUSED: 'This password was previously used, please use a different password.',
+    INVALID_VERIFICATION_TOKEN: 'Invalid verification token',
+    ACCESS_DENIED: 'Access denied',
+    INVALID_USER_PROFILE: 'Invalid user profile',
+    GOOGLE_OAUTH_PROFILE_FETCH_FAILED: 'Failed to fetch user profile from Google OAuth service',
+    LOGOUT_FAILED: 'Logout failed due to an unexpected error.',
+
+    INVALID_CREDENTIALS: 'Invalid username or password specified.',
+    LOGIN_FAILED: 'Login Failed',
+    OLD_PASSWORD_INCORRECT: 'You have specified an incorrect old password.',
+    INVALID_NEW_PASSWORD: 'Invalid new password.',
+    PASSWORDS_DO_NOT_MATCH: 'New passwords are not matching.',
+
+    // user management errors
+    DELETE_SELF_NOT_ALLOWED: 'Deleting logged-in user is not allowed.',
+    DELETE_IDS_REQUIRED: 'At least one ID is required for deletion.',
+    USER_MISSING_ID: 'User must exist before initializing roles.',
+    ROLES_NOT_FOUND: (roles: string[]) => `The following roles were not found: ${roles.join(', ')}`,
+    USER_NOT_FOUND_BY_USERNAME: (username: string) => `User with username '${username}' not found.`,
+    ROLE_NOT_FOUND: (roleName: string) => `Role '${roleName}' not found.`,
+    PERMISSION_NOT_EXIST: (permission: string) => `Permission '${permission}' does not exist.`,
+
+    // session errors
+    SESSION_INVALID: 'Your session is no longer valid. Please log in again.',
+    SESSION_EXPIRED: 'Your session has expired. Please log in again.',
+
+    // filter errors
+    GROUP_BY_LIMIT: 'buildFilterQuery: Only 1 Group by field is supported currently.',
+    INVALID_GROUP_BY_COUNT: 'Exactly one groupBy field is required to count grouped records.',
+
+    // general errors
+    FORBIDDEN: 'Forbidden',
+
+
+    // database errors
+    DUPLICATE_ENTRY: 'Duplicate entry. A record with similar unique fields already exists.',
+
+    // validation errors
+    ID_REQUIRED_FOR_UPDATE: 'Id is required for update.',
+    ID_REQUIRED_FOR_DELETE: 'Id is required for deletion.',
+
+    // CRUD service errors
+    RELATION_TYPE_NOT_SUPPORTED: 'Relation type not supported in CRUD service.',
+    NO_SOFT_DELETED_RECORD_FOUND: 'No soft-deleted record found with the given ID.',
+    CONFLICTING_RECORD_ON_UNARCHIVE: 'Another record is conflicting with the record you are attempting to Un-Archive, either delete or change the other record so as to avoid this conflict.',
+    NO_SOFT_DELETED_RECORDS_FOUND: 'No matching soft-deleted records found.',
+    EMPTY_PATH_PARTS: 'Path parts cannot be empty',
+
+
+    // CSV/Excel service errors
+    MISSING_HEADERS_OR_FUNCTION: 'Either headers or data records function must be provided.',
+    INVALID_CHUNK_SIZE: 'Chunk size must be greater than 0 when data records function is provided.',
+    INVALID_FORMAT: (format: string) => `Invalid ${format} format`,
+
+
+    //field errors
+    INVALID_INVERSE_FIELD_TYPE: 'Only relation fields can have inverse fields.',
+    MODEL_AND_MODULE_REQUIRED_TO_UPDATE_INVERSE_FIELD: 'Model and module are required to update inverse field.',
+    MODEL_NAME_AND_MODULE_NAME_REQUIRED_TO_CREATE_INVERSE_FIELD: 'Model name and module name are required to create inverse field.',
+    FIELD_NOT_FOUND: (id: number | string) => `No field with id #${id} exists`,
+    PROVIDER_NOT_FOUND: (provider: string) => `Field incorrectly configured. No provider with name ${provider} registered in backend.`,
+    FILE_WRITE_FAILED: 'File creation failed, rolling back transaction',
+
+    // file service errors
+    FILE_NOT_FOUND: 'File not found',
+    FILE_COPY_ERROR: 'Error copying file',
+    S3_CLIENT_NOT_INITIALIZED: 'S3 Client not initialized. Please check the S3 configuration.',
+
+    // model errors
+    MODEL_METADATA_NOT_FOUND: (id: string | number) => `Model metadata with ID ${id} not found.`,
+    MODEL_SERVICE_NOT_FOUND: (model: string) => `Model service for ${model} not found.`,
+    RELATION_CO_MODEL_NOT_DEFINED_FOR_FIELD: (fieldName: string) => `Relation coModelSingularName is not defined for relation field ${fieldName}`,
+    MODEL_NOT_FOUND: (singularName?: string) => `Model${singularName ? ` with singular name "${singularName}"` : ''} not found.`,
+    MODEL_REQUIRED_FOR_CODE_GENERATION: 'Model ID or Model Name is required for generating code.',
+
+    //module errors
+    MODULE_NOT_FOUND: (moduleName: string) => `Module with name ${moduleName} not found.`,
+    MODULE_ID_NOT_FOUND: (id: string | number) => `Module with ID ${id} not found.`,
+
+    //entity errors
+    ENTITY_NOT_FOUND: (entity?: string | number) => `Entity${entity ? ' ' + entity : ''} not found.`,
+    ENTITY_NAME_REQUIRED: 'Entity name is required to find the entity.',
+    ENTITY_ID_REQUIRED: 'Entity ID is required to find the entity.',
+
+    // import errors
+    NO_ERROR_LOG_FOR_IMPORT: (id: string | number) => `No error log entries found for import transaction ID ${id}.`,
+    FILE_READ_FAILED_FROM_URL: (url: string) => `Failed to read file from URL: ${url}`,
+
+    // media storage provider errors
+    MEDIA_STORAGE_PROVIDER_ID_NOT_FOUND: (id: number | string) => `Media Storage Provider with #${id} not found.`,
+    MEDIA_STORAGE_PROVIDER_NOT_FOUND: 'Media Storage Provider not found',
+
+    // SQL errors
+    UNSUPPORTED_SQL_OPERATOR: (operator: string) => `Unsupported SQL operator: ${operator}`,
+
+    // AI interaction errors
+    PYTHON_EXECUTABLE_NOT_CONFIGURED: 'SolidX AI MCP python executable or client path not configured.',
+    UNABLE_TO_RESOLVE_SOLID_COMMAND: 'Unable to resolve a solid_ command that was used to come up with this response.',
+    UNABLE_TO_RESOLVE_MCP_HANDLER: 'Unable to resolve a mcp tool handler.',
+};

package/src/constants/success-messages.ts

@@ -0,0 +1,13 @@
+export const SUCCESS_MESSAGES = {
+    OTP_SENT_SUCCESS_REGISTRATION: 'User registration initiated. OTP sent to the user.',
+    OTP_SENT_SUCCESS_LOGIN: 'User login initiated. OTP sent to the user.',
+    FORGOT_PASSWORD_TOKEN_SENT: 'Forgot password - token generated and sent.',
+    FORGOT_PASSWORD_CONFIRMED: 'Forgot password confirmed.',
+    LOGOUT_SUCCESS: 'Logged out successfully',
+    USER_REGISTERED: 'User registered successfully.',
+
+    // CRUD service messages
+    RECORD_RECOVERED: 'Record successfully recovered',
+    SELECTED_RECORDS_RECOVERED: 'Selected records successfully recovered',
+
+};

package/src/index.ts

@@ -5,7 +5,7 @@ export * from './commands/remove-fields.command'
 export * from './commands/seed.command'
 
 export * from './config/app-builder.config'
-export * from './config/common.config'
+export {default as commonConfig} from './config/common.config'
 export * from './config/iam.config'
 export * from './config/cache.options'
 
@@ -216,8 +216,8 @@ export * from './services/field-metadata.service'
 export * from './services/file.service'
 export * from './services/hashing.service'
 export * from './services/list-of-values.service'
-export * from './services/mail/ElasticEmailService'
-export * from './services/mail/SMTPEmailService'
+export * from './services/mail/elastic-email.service'
+export * from './services/mail/smtp-email.service'
 export * from './services/media-storage-provider-metadata-seeder.service'
 export * from './services/media-storage-provider-metadata.service'
 export * from './services/media.service'
@@ -257,6 +257,10 @@ export * from './services/import-transaction.service'
 export * from './services/import-transaction-error-log.service'
 export * from './services/excel.service'
 export * from './services/csv.service'
+export * from './services/queues/publisher-factory.service'
+export * from './services/queues/database-publisher.service'
+export * from './services/queues/database-subscriber.service'
+
 // Repositories
 export * from './repository/solid-base.repository'
 export * from './repository/security-rule.repository'
@@ -282,4 +286,6 @@ export * from './interfaces'
 export * from './solid-core.module'
 
 export * from './winston.logger'
-export { default as datetimeTransformer } from './transformers/datetime-transformer'
+export { default as datetimeTransformer } from './transformers/datetime-transformer'
+
+export { ERROR_MESSAGES } from './constants/error-messages'

package/src/interfaces.ts

@@ -201,11 +201,11 @@ export interface MailAttachmentWrapper {
 
 export interface MailAttachment {
   filename: string;
-  templatePath?: string;
-  templateParams?: any;
+  templatePath?: string; // deprecated
+  templateParams?: any; // deprecated
   content?: string | Buffer;
   contentType?: string;
-  path?: string;
+  path?: string; //Filesystem absolute path or URL. 
 }
 
 export enum BrokerType {

package/src/jobs/api-email-subscriber.service.ts

@@ -3,7 +3,7 @@ import { Injectable } from '@nestjs/common';
 import mailQueueOptions from './api-email-queue-options';
 import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
 import { QueueMessage } from 'src/interfaces/mq';
-import { ElasticEmailService } from '../services/mail/ElasticEmailService';
+import { ElasticEmailService } from '../services/mail/elastic-email.service';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { QueuesModuleOptions } from "../interfaces";

package/src/jobs/database/api-email-subscriber-database.service.ts

@@ -4,7 +4,7 @@ import mailQueueOptions from './api-email-queue-options-database';
 import { QueueMessage } from 'src/interfaces/mq';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
-import { ElasticEmailService } from 'src/services/mail/ElasticEmailService';
+import { ElasticEmailService } from 'src/services/mail/elastic-email.service';
 import { QueuesModuleOptions } from 'src/interfaces';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
 

package/src/jobs/database/email-subscriber-database.service.ts

@@ -5,7 +5,7 @@ import { QueueMessage } from 'src/interfaces/mq';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
-import { SMTPEMailService } from 'src/services/mail/SMTPEmailService';
+import { SMTPEMailService } from 'src/services/mail/smtp-email.service';
 import { QueuesModuleOptions } from 'src/interfaces';
 
 @Injectable()

package/src/jobs/email-subscriber.service.ts

@@ -3,7 +3,7 @@ import { Injectable } from '@nestjs/common';
 import mailQueueOptions from './email-queue-options';
 import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
 import { QueueMessage } from 'src/interfaces/mq';
-import { SMTPEMailService } from '../services/mail/SMTPEmailService';
+import { SMTPEMailService } from '../services/mail/smtp-email.service';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { QueuesModuleOptions } from "../interfaces";

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

@@ -5387,27 +5387,27 @@
     },
     {
       "displayName": "Email list action",
-      "name": "email-list-action",
+      "name": "emailTemplate-list-action",
       "type": "solid",
       "domain": "",
       "context": "",
       "customComponent": "",
       "customIsModal": true,
       "serverEndpoint": "",
-      "viewUserKey": "email-list-view",
+      "viewUserKey": "emailTemplate-list-view",
       "moduleUserKey": "solid-core",
       "modelUserKey": "emailTemplate"
     },
     {
       "displayName": "SMS list action",
-      "name": "sms-list-action",
+      "name": "smsTemplate-list-action",
       "type": "solid",
       "domain": "",
       "context": "",
       "customComponent": "",
       "customIsModal": true,
       "serverEndpoint": "",
-      "viewUserKey": "sms-list-view",
+      "viewUserKey": "smsTemplate-list-view",
       "moduleUserKey": "solid-core",
       "modelUserKey": "smsTemplate"
     },
@@ -5755,17 +5755,17 @@
     },
     {
       "displayName": "Email",
-      "name": "email-menu-item",
+      "name": "emailTemplate-menu-item",
       "sequenceNumber": 1,
-      "actionUserKey": "email-list-action",
+      "actionUserKey": "emailTemplate-list-action",
       "moduleUserKey": "solid-core",
       "parentMenuItemUserKey": "notification-menu-item"
     },
     {
       "displayName": "SMS",
-      "name": "sms-menu-item",
+      "name": "smsTemplate-menu-item",
       "sequenceNumber": 1,
-      "actionUserKey": "sms-list-action",
+      "actionUserKey": "smsTemplate-list-action",
       "moduleUserKey": "solid-core",
       "parentMenuItemUserKey": "notification-menu-item"
     },
@@ -10672,7 +10672,7 @@
       }
     },
     {
-      "name": "email-list-view",
+      "name": "emailTemplate-list-view",
       "displayName": "Email",
       "type": "list",
       "context": "{}",
@@ -10706,7 +10706,7 @@
       }
     },
     {
-      "name": "email-form-view",
+      "name": "emailTemplate-form-view",
       "displayName": "Email",
       "type": "form",
       "context": "{}",
@@ -10805,7 +10805,7 @@
       }
     },
     {
-      "name": "sms-list-view",
+      "name": "smsTemplate-list-view",
       "displayName": "SMS Template",
       "type": "list",
       "context": "{}",
@@ -10839,7 +10839,7 @@
       }
     },
     {
-      "name": "sms-form-view",
+      "name": "smsTemplate-form-view",
       "displayName": "SMS Template",
       "type": "form",
       "context": "{}",

package/src/services/ai-interaction.service.ts

@@ -17,6 +17,7 @@ import { PublisherFactory } from './queues/publisher-factory.service';
 import { RequestContextService } from './request-context.service';
 import { ActiveUserData } from 'src/interfaces/active-user-data.interface';
 import { McpToolResponseHandlerFactory } from './mcp-tool-response-handlers/mcp-tool-response-handler-factory.service';
+import { ERROR_MESSAGES } from 'src/constants/error-messages';
 
 @Injectable()
 export class AiInteractionService extends CRUDService<AiInteraction> {
@@ -78,7 +79,7 @@ export class AiInteractionService extends CRUDService<AiInteraction> {
 
     // TODO: We can return an error if the above env variables are not properly setup...
     if (!pythonExecutable || !mcpClient) {
-      throw new BadRequestException('SolidX AI MCP python executable or client path not configured.');
+      throw new BadRequestException(ERROR_MESSAGES.PYTHON_EXECUTABLE_NOT_CONFIGURED);
     }
 
     // Check if both paths are valid and accessible
@@ -187,7 +188,7 @@ export class AiInteractionService extends CRUDService<AiInteraction> {
     const toolsInvoked = metadata['tools_invoked'];
     if (!toolsInvoked) {
       // TODO: RESPONSE SHAPE ALERT Check if we want to control the shape of the response....
-      throw new Error('Unable to resolve a solid_ command that was used to come up with this response.');
+      throw new Error(ERROR_MESSAGES.UNABLE_TO_RESOLVE_SOLID_COMMAND);
     }
 
     // TODO: OPTIMISATION for chained tool invocation, for now we are assuming only 1 tool was used.
@@ -198,7 +199,7 @@ export class AiInteractionService extends CRUDService<AiInteraction> {
     const mcpToolHandler = this.mcpToolResponseHandlerFactory.getInstance(toolInvoked);
     if (!mcpToolHandler) {
       // TODO: RESPONSE SHAPE ALERT Check if we want to control the shape of the response....
-      throw new Error('Unable to resolve a mcp tool handler.');
+      throw new Error(ERROR_MESSAGES.UNABLE_TO_RESOLVE_MCP_HANDLER);
     }
 
     const handlerApplicationResponse = await mcpToolHandler.apply(aiInteraction);