@solidstarters/solid-core 1.2.145 → 1.2.148

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstarters/solid-core",
-  "version": "1.2.145",
+  "version": "1.2.148",
   "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",
@@ -67,6 +67,7 @@
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",
     "swagger-ui-express": "^5.0.0",
+    "twilio": "^5.8.0",
     "uuid": "^9.0.1",
     "xlsx": "^0.18.5"
   },
@@ -87,10 +88,10 @@
     "@nestjs/typeorm": "^10.0.1",
     "nest-commander": "^3.12.5",
     "nest-winston": "^1.9.7",
+    "nestjs-cls": "^5.4.3",
     "typeorm": "^0.3.20",
     "typeorm-naming-strategies": "^4.1.0",
-    "winston": "^3.17.0",
-    "nestjs-cls": "^5.4.3"
+    "winston": "^3.17.0"
   },
   "devDependencies": {
     "@angular-devkit/schematics": "^19.2.6",

package/src/config/common.config.ts

@@ -2,7 +2,7 @@ import { registerAs } from '@nestjs/config';
 
 export default registerAs('common', () => {
     return {
-        emailProvider: process.env.COMMON_EMAIL_PROVIDER,
+        emailProvider: process.env.COMMON_EMAIL_PROVIDER ?? "SMTPEMailService",
         emailTemplateSeederFiles: process.env.COMMON_EMAIL_TEMPLATE_SEEDER_FILES,
         smsProvider: process.env.COMMON_SMS_PROVIDER,
         smsTemplateSeederFiles: process.env.COMMON_SMS_TEMPLATE_SEEDER_FILES,
@@ -23,6 +23,11 @@ export default registerAs('common', () => {
             url: process.env.COMMON_MSG91_SMS_URL,
             apiKey: process.env.COMMON_MSG91_SMS_API_KEY,
         },
+        twilio: {
+            accountSid: process.env.COMMON_TWILIO_ACCOUNT_SID,
+            authToken: process.env.COMMON_TWILIO_AUTH_TOKEN,
+            number: process.env.COMMON_TWILIO_NUMBER,
+        },
         shortUrl: {
             apiUrl: process.env.COMMON_SHORT_URL_API_URL,
             apiKey: process.env.COMMON_SHORT_URL_API_KEY,

package/src/decorators/mail-provider.decorator.ts

@@ -0,0 +1,7 @@
+export const IS_MAIL_PROVIDER = 'IS_MAIL_PROVIDER';
+
+export const MailProvider = () => {
+    return (target: Function) => {
+        Reflect.defineMetadata(IS_MAIL_PROVIDER, true, target);
+    };
+};

package/src/factories/mail.factory.ts

@@ -0,0 +1,38 @@
+import { Inject, Injectable, Logger } from "@nestjs/common";
+import { ConfigType } from "@nestjs/config";
+import { ModuleRef } from "@nestjs/core";
+import commonConfig from "src/config/common.config";
+import { SolidRegistry } from "src/helpers/solid-registry";
+import { IMail } from "src/interfaces";
+
+function norm(s?: string) {
+    return s?.trim().toLowerCase();
+}
+
+// This factory will be use to return a mail service instance, using the configured environment variables
+@Injectable()
+export class MailFactory {
+    private readonly logger = new Logger(this.constructor.name);
+    constructor(
+        private readonly moduleRef: ModuleRef, // Use the module ref to dynamically resolve the mail service
+        private readonly solidRegistry: SolidRegistry,
+        @Inject(commonConfig.KEY)
+        private readonly commonConfiguration: ConfigType<typeof commonConfig>,
+    ) { }
+
+
+    getMailService(): IMail {
+        const mailServiceName = this.commonConfiguration.emailProvider;
+        const mailProviders = this.solidRegistry.getMailProviders();
+        // Return the instance which matches the mailServiceName
+        if (!mailProviders.length) {
+            // throw new Error("No mail providers are registered.");
+            this.logger.error("No mail providers are registered.");
+        }
+
+        const mailServiceProvider = mailProviders.find(provider => provider.name === mailServiceName);
+
+        return mailServiceProvider.instance as IMail;
+    }
+
+}

package/src/helpers/solid-registry.ts

@@ -65,6 +65,11 @@ export class SolidRegistry {
   private computedFieldMetadata: ComputedFieldMetadata[] = [];
   private dashboardVariableSelectionProviders: Set<InstanceWrapper> = new Set();
   private dashboardQuestionDataProviders: Set<InstanceWrapper> = new Set();
+  private mailProviders: Set<InstanceWrapper> = new Set();
+
+  registerMailProvider(mailProvider: InstanceWrapper): void {
+    this.mailProviders.add(mailProvider);
+  }
 
   registerController(name: string, methodNames: string[]): void {
     this.controllers.add({ name: name, methods: methodNames });
@@ -106,6 +111,10 @@ export class SolidRegistry {
     this.modules = new Set(modules);
   }
 
+  getMailProviders(): Array<InstanceWrapper> {
+    return Array.from(this.mailProviders);
+  }
+
   getSeeders(): Array<InstanceWrapper> {
     return Array.from(this.seeders);
   }

package/src/index.ts

@@ -21,6 +21,8 @@ export * from './decorators/roles.decorator'
 export * from './decorators/selection-provider.decorator'
 export * from './decorators/solid-database-module.decorator'
 export * from './decorators/solid-service.decorator'
+export * from './decorators/mail-provider.decorator'
+
 export * from './dtos/basic-filters.dto'
 export * from './dtos/solid-request-context.dto'
 export * from './dtos/change-password.dto'
@@ -177,9 +179,9 @@ export * from './services/scheduled-jobs/scheduler.service';
 export * from './jobs/api-email-publisher.service'
 export * from './jobs/api-email-queue-options'
 export * from './jobs/api-email-subscriber.service'
-export * from './jobs/email-publisher.service'
-export * from './jobs/email-queue-options'
-export * from './jobs/email-subscriber.service'
+export { SmtpEmailQueuePublisherRabbitmq, SmtpEmailQueuePublisherRabbitmq as EmailQueuePublisher } from './jobs/smtp-email-publisher.service' // alias for backward compatibility
+export * from './jobs/smtp-email-queue-options'
+export { SmtpEmailQueueSubscriberRabbitmq, SmtpEmailQueueSubscriberRabbitmq as EmailQueueSubscriber } from './jobs/smtp-email-subscriber.service' // alias for backward compatibility
 export * from './jobs/otp-publisher.service'
 export * from './jobs/otp-queue-options'
 export * from './jobs/otp-subscriber.service'
@@ -241,6 +243,8 @@ export * from './services/short-url/tiny-url.service'
 export * from './services/sms/Msg91BaseSMSService' //rename
 export * from './services/sms/Msg91OTPService' //rename
 export * from './services/sms/Msg91SMSService' //rename
+export * from './services/sms/TwilioSMSService' //rename
+export * from './services/poller.service'
 export * from './services/sms-template.service'
 export * from './services/solid-introspect.service'
 export * from './services/user.service'
@@ -261,6 +265,9 @@ export * from './services/queues/publisher-factory.service'
 export * from './services/queues/database-publisher.service'
 export * from './services/queues/database-subscriber.service'
 
+// Factories
+export * from './factories/mail.factory'
+
 // Repositories
 export * from './repository/solid-base.repository'
 export * from './repository/security-rule.repository'

package/src/interfaces.ts

@@ -159,7 +159,7 @@ export class EventDetails<T> {
   ) { }
 }
 
-export interface IMail {
+export interface IMail<TResponse=unknown> {
   sendEmail(
     to: string,
     subject: string,
@@ -169,7 +169,10 @@ export interface IMail {
     attachments?: MailAttachment[],
     parentEntity?: any,
     parentEntityId?: any,
-  ): Promise<void>;
+    cc?: string[],
+    bcc?: string[],
+    from?: string,
+  ): Promise<TResponse>;
 
   sendEmailUsingTemplate(
     to: string,
@@ -180,18 +183,21 @@ export interface IMail {
     attachments?: MailAttachment[],
     parentEntity?: any,
     parentEntityId?: any,
-  ): Promise<void>;
+    cc?: string[],
+    bcc?: string[],
+    from?: string,
+  ): Promise<TResponse>;
 }
 
 export interface ISMS {
-  sendSMS(to: string, body: string, shouldQueueSms: boolean): Promise<void>;
+  sendSMS(to: string, body: string, shouldQueueSms: boolean): Promise<any>;
 
   sendSMSUsingTemplate(
     to: string,
     templateName: string,
     templateParams: any,
     shouldQueueSms: boolean,
-  ): Promise<void>;
+  ): Promise<any>;
 }
 
 export interface MailAttachmentWrapper {

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

@@ -7,6 +7,7 @@ import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { ElasticEmailService } from 'src/services/mail/elastic-email.service';
 import { QueuesModuleOptions } from 'src/interfaces';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class ApiEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
@@ -14,8 +15,9 @@ export class ApiEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
         private readonly emailService: ElasticEmailService,
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

package/src/jobs/database/computed-field-evaluation-subscriber.service.ts

@@ -7,15 +7,17 @@ import { MqMessageService } from "src/services/mq-message.service";
 import { DatabaseSubscriber } from "src/services/queues/database-subscriber.service";
 import { ComputedFieldEvaluationPayload } from "src/subscribers/computed-entity-field.subscriber";
 import computedFieldEvaluationQueueOptions from "./computed-field-evaluation-queue-options";
+import { PollerService } from "src/services/poller.service";
 
 @Injectable()
 export class ComputedFieldEvaluationSubscriber extends DatabaseSubscriber<ComputedFieldEvaluationPayload> {
     constructor(
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
-        readonly solidRegistry: SolidRegistry
+        readonly solidRegistry: SolidRegistry,
+        readonly poller: PollerService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

package/src/jobs/database/generate-code-subscriber-database.service.ts

@@ -8,6 +8,7 @@ import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.serv
 import generateCodeQueueOptions from './generate-code-queue-options-database';
 import { SolidFieldType } from 'src/dtos/create-field-metadata.dto';
 import { ModelMetadataService } from 'src/services/model-metadata.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class GenerateCodeSubscriberDatabase extends DatabaseSubscriber<CodeGenerationOptions> {
@@ -16,10 +17,11 @@ export class GenerateCodeSubscriberDatabase extends DatabaseSubscriber<CodeGener
     constructor(
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
         @Inject(forwardRef(() => ModelMetadataService))
         readonly modelMetadataService: ModelMetadataService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

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

@@ -7,15 +7,17 @@ import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
 import { Msg91OTPService } from 'src/services/sms/Msg91OTPService';
 import { QueuesModuleOptions } from 'src/interfaces';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class OTPQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     constructor(
         private readonly otpService: Msg91OTPService,
         readonly mqMessageService: MqMessageService,
+        readonly poller: PollerService,
         readonly mqMessageQueueService: MqMessageQueueService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

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

@@ -7,6 +7,7 @@ import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { Msg91SMSService } from 'src/services/sms/Msg91SMSService';
 import { QueuesModuleOptions } from 'src/interfaces';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class SmsQueueSubscriberDatabase extends DatabaseSubscriber<any> {
@@ -14,8 +15,9 @@ export class SmsQueueSubscriberDatabase extends DatabaseSubscriber<any> {
         private readonly smsService: Msg91SMSService,
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {
@@ -25,6 +27,6 @@ export class SmsQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.smsService.sendSMSSynchronously(message);
+        return this.smsService.sendSMSSynchronously(message);
     }
 }

package/src/jobs/database/{email-publisher-database.service.ts → smtp-email-publisher-database.service.ts}

@@ -1,13 +1,13 @@
 import { Injectable } from '@nestjs/common';
 
-import mailQueueOptions from './email-queue-options-database';
+import mailQueueOptions from './smtp-email-queue-options-database';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { QueuesModuleOptions } from 'src/interfaces';
 import { DatabasePublisher } from 'src/services/queues/database-publisher.service';
 
 @Injectable()
-export class EmailQueuePublisherDatabase extends DatabasePublisher<any> {
+export class SmtpEmailQueuePublisherDatabase extends DatabasePublisher<any> {
     constructor(
         protected readonly mqMessageService: MqMessageService,
         protected readonly mqMessageQueueService: MqMessageQueueService,

package/src/jobs/database/{email-subscriber-database.service.ts → smtp-email-subscriber-database.service.ts}

@@ -1,21 +1,23 @@
 import { Injectable } from '@nestjs/common';
 
-import mailQueueOptions from './email-queue-options-database';
+import mailQueueOptions from './smtp-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 { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
 import { SMTPEMailService } from 'src/services/mail/smtp-email.service';
 import { QueuesModuleOptions } from 'src/interfaces';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
-export class EmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
+export class SmtpEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     constructor(
         private readonly emailService: SMTPEMailService,
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

package/src/jobs/database/test-queue-subscriber-database.service.ts

@@ -6,6 +6,7 @@ import { MqMessageService } from '../../services/mq-message.service';
 import { MqMessageQueueService } from '../../services/mq-message-queue.service';
 import { QueuesModuleOptions } from "../../interfaces";
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class TestQueueSubscriberDatabase extends DatabaseSubscriber<any> {
@@ -13,8 +14,9 @@ export class TestQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     constructor(
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

package/src/jobs/database/trigger-mcp-client-subscriber-database.service.ts

@@ -7,6 +7,7 @@ import { QueuesModuleOptions, TriggerMcpClientOptions } from "../../interfaces";
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
 import triggerMcpClientQueueOptions from "./trigger-mcp-client-queue-options";
 import { AiInteractionService } from 'src/services/ai-interaction.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class TriggerMcpClientSubscriberDatabase extends DatabaseSubscriber<TriggerMcpClientOptions> {
@@ -15,9 +16,10 @@ export class TriggerMcpClientSubscriberDatabase extends DatabaseSubscriber<Trigg
     constructor(
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
         readonly aiInteractionService: AiInteractionService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

package/src/jobs/database/twilio-sms-publisher-database.service.ts

@@ -0,0 +1,23 @@
+import { Injectable } from '@nestjs/common';
+
+import smsQueueOptions from './twilio-sms-queue-database-options';
+import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
+import { MqMessageService } from 'src/services/mq-message.service';
+import { QueuesModuleOptions } from 'src/interfaces';
+import { DatabasePublisher } from 'src/services/queues/database-publisher.service';
+
+@Injectable()
+export class TwilioSmsQueuePublisherDatabase extends DatabasePublisher<any> {
+    constructor(
+        protected readonly mqMessageService: MqMessageService,
+        protected readonly mqMessageQueueService: MqMessageQueueService,
+    ) {
+        super(mqMessageService, mqMessageQueueService);
+    }
+
+    options(): QueuesModuleOptions {
+        return {
+            ...smsQueueOptions
+        }
+    }
+}

package/src/jobs/database/twilio-sms-queue-database-options.ts

@@ -0,0 +1,9 @@
+import { BrokerType } from "src/interfaces";
+
+const SMS_QUEUE_NAME = 'twilio_sms_queue_database';
+
+export default {
+    name: 'twilioSmsInstance',
+    type: BrokerType.Database,
+    queueName: SMS_QUEUE_NAME,
+};

package/src/jobs/database/twilio-sms-subscriber-database.service.ts

@@ -0,0 +1,32 @@
+import { Injectable } from '@nestjs/common';
+
+import { QueueMessage } from 'src/interfaces/mq';
+import smsQueueOptions from './twilio-sms-queue-database-options';
+import { MqMessageService } from 'src/services/mq-message.service';
+import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
+import { QueuesModuleOptions } from 'src/interfaces';
+import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
+import { TwilioSMSService } from 'src/services/sms/TwilioSMSService';
+import { PollerService } from 'src/services/poller.service';
+
+@Injectable()
+export class TwilioSmsQueueSubscriberDatabase extends DatabaseSubscriber<any> {
+    constructor(
+        private readonly smsService: TwilioSMSService,
+        readonly mqMessageService: MqMessageService,
+        readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
+    ) {
+        super(mqMessageService, mqMessageQueueService, poller);
+    }
+
+    options(): QueuesModuleOptions {
+        return {
+            ...smsQueueOptions
+        }
+    }
+
+    subscribe(message: QueueMessage<any>) {
+        return this.smsService.sendSMSSynchronously(message);
+    }
+}

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

@@ -8,6 +8,7 @@ import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { Msg91WhatsappService } from 'src/services/whatsapp/Msg91WhatsappService';
 import { QueuesModuleOptions } from 'src/interfaces';
 import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.service';
+import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
 export class WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
@@ -15,8 +16,9 @@ export class WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
         private readonly whatsappService: Msg91WhatsappService,
         readonly mqMessageService: MqMessageService,
         readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
     ) {
-        super(mqMessageService, mqMessageQueueService);
+        super(mqMessageService, mqMessageQueueService, poller);
     }
 
     options(): QueuesModuleOptions {

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

@@ -25,6 +25,6 @@ export class SmsQueueSubscriber extends RabbitMqSubscriber<any> {
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.smsService.sendSMSSynchronously(message);
+        return this.smsService.sendSMSSynchronously(message);
     }
 }

package/src/jobs/{email-publisher.service.ts → smtp-email-publisher.service.ts}

@@ -1,13 +1,13 @@
 import { Injectable } from '@nestjs/common';
 
 import { RabbitMqPublisher } from 'src/services/queues/rabbitmq-publisher.service';
-import mailQueueOptions from './email-queue-options';
+import mailQueueOptions from './smtp-email-queue-options';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { QueuesModuleOptions } from "../interfaces";
 
 @Injectable()
-export class EmailQueuePublisher extends RabbitMqPublisher<any> {
+export class SmtpEmailQueuePublisherRabbitmq extends RabbitMqPublisher<any> {
     constructor(
         protected readonly mqMessageService: MqMessageService,
         protected readonly mqMessageQueueService: MqMessageQueueService,

package/src/jobs/{email-subscriber.service.ts → smtp-email-subscriber.service.ts}

@@ -1,6 +1,6 @@
 import { Injectable } from '@nestjs/common';
 
-import mailQueueOptions from './email-queue-options';
+import mailQueueOptions from './smtp-email-queue-options';
 import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
 import { QueueMessage } from 'src/interfaces/mq';
 import { SMTPEMailService } from '../services/mail/smtp-email.service';
@@ -9,7 +9,7 @@ import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { QueuesModuleOptions } from "../interfaces";
 
 @Injectable()
-export class EmailQueueSubscriber extends RabbitMqSubscriber<any> {
+export class SmtpEmailQueueSubscriberRabbitmq extends RabbitMqSubscriber<any> {
     constructor(
         private readonly emailService: SMTPEMailService,
         readonly mqMessageService: MqMessageService,