@solidstarters/solid-core 1.2.146 → 1.2.148

package/package.json

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

@@ -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/index.ts

@@ -243,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'

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,
@@ -172,7 +172,7 @@ export interface IMail {
     cc?: string[],
     bcc?: string[],
     from?: string,
-  ): Promise<void>;
+  ): Promise<TResponse>;
 
   sendEmailUsingTemplate(
     to: string,
@@ -186,18 +186,18 @@ export interface IMail {
     cc?: string[],
     bcc?: string[],
     from?: string,
-  ): Promise<void>;
+  ): 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/smtp-email-subscriber-database.service.ts

@@ -7,6 +7,7 @@ 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 SmtpEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
@@ -14,8 +15,9 @@ export class SmtpEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
         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/seeders/module-metadata-seeder.service.ts

@@ -195,7 +195,7 @@ export class ModuleMetadataSeederService {
             // Sms templates
             this.logger.log(`[Start] Processing sms templates for ${moduleMetadata.name}`);
             const smsTemplates: CreateSmsTemplateDto[] = overallMetadata.smsTemplates;
-            await this.seedSmsTemplates(smsTemplates);
+            await this.seedSmsTemplates(smsTemplates, moduleMetadata);
             this.logger.log(`[End] Processing sms templates for ${moduleMetadata.name}`);
 
             // Settings
@@ -259,7 +259,7 @@ export class ModuleMetadataSeederService {
             'AuthenticationController.logout'
         ]
         await this.roleService.addPermissionToRole('Internal User', internalRolePermission);
-        await this.roleService.addPermissionToRole('Public', ['SettingController.wrapSettings','AuthenticationController.logout']);
+        await this.roleService.addPermissionToRole('Public', ['SettingController.wrapSettings', 'AuthenticationController.logout']);
         this.logger.log(`All Seeders finished`);
         this.logger.log(`Newly created username is: ${usersDetail?.length > 0 ? usersDetail[0]?.username : ''} and password is ${usersDetail?.length > 0 ? usersDetail[0]?.password : ''}`);
     }
@@ -350,7 +350,7 @@ export class ModuleMetadataSeederService {
 
     }
 
-    async seedSmsTemplates(smsTemplates: CreateSmsTemplateDto[]) {
+    async seedSmsTemplates(smsTemplates: CreateSmsTemplateDto[], moduleMetadata: CreateModuleMetadataDto) {
         if (!smsTemplates) {
             return;
         }
@@ -360,23 +360,26 @@ export class ModuleMetadataSeederService {
             this.logger.log(`Found ${smsTemplate.name} sms template`);
 
             // We need to load the actual template contents. 
-            if (smsTemplate.body) {
-                // const smsTemplateFilePath = path.join(process.cwd(), smsTemplate.body);
-                // smsTemplate.body = fs.readFileSync(smsTemplateFilePath, 'utf-8').toString()
-
+            if (moduleMetadata.name === 'solid-core') {
                 const modulePath = path.dirname(require.resolve('@solidstarters/solid-core'));
-
-                // Resolve the `src` folder
                 const seedDataPath = path.join(modulePath, '../src/seeders/seed-data/sms-templates');
-
-                // Example usage
                 const filePath = path.join(seedDataPath, smsTemplate.body);
-
-
-                smsTemplate.body = fs.readFileSync(filePath, 'utf-8').toString();
-
+                this.logger.log(`Seeding sms template from solid-core at path: ${filePath}`);
+                if (fs.existsSync(filePath)) {
+                    smsTemplate.body = fs.readFileSync(filePath, 'utf-8').toString();
+                }
+            }
+            else {
+                // Check if file exists
+                const emailTemplateHandlebar = `module-metadata/${moduleMetadata.name}/sms-templates/${smsTemplate.body}`
+                const fullPath = path.join(process.cwd(), emailTemplateHandlebar);
+                this.logger.log(`Seeding custom sms template from consuming model at path: ${fullPath}`);
+                if (fs.existsSync(fullPath)) {
+                    smsTemplate.body = fs.readFileSync(fullPath, 'utf-8').toString();
+                }
             }
 
+
             // Save to DB.
             await this.smsTemplateService.removeByName(smsTemplate.name);
             await this.smsTemplateService.create(smsTemplate);

package/src/services/mail/smtp-email.service.ts

@@ -47,7 +47,7 @@ export class SMTPEMailService implements IMail {
         cc?: string[],
         bcc?: string[],
         from?: string
-    ): Promise<void> {
+    ) {
         // Load template and evaluate it.
         const emailTemplate = await this.emailTemplateService.findOneByName(templateName);
         if (!emailTemplate) {
@@ -63,7 +63,7 @@ export class SMTPEMailService implements IMail {
         const subject = subjectTemplate(templateParams);
 
         // Finally send the email.
-        await this.sendEmail(to, subject, body, shouldQueueEmails, wrapperAttachments, attachments, parentEntity, parentEntityId, cc, bcc, from);
+        return await this.sendEmail(to, subject, body, shouldQueueEmails, wrapperAttachments, attachments, parentEntity, parentEntityId, cc, bcc, from);
     }
 
     async sendEmail(
@@ -78,7 +78,7 @@ export class SMTPEMailService implements IMail {
         cc?: string[],
         bcc?: string[],
         from?: string
-    ): Promise<void> {
+    ) {
         const message = {
             payload: {
                 from: from || this.commonConfiguration.smtpMail.from,
@@ -95,33 +95,34 @@ export class SMTPEMailService implements IMail {
 
         // Send using queue if the developer has explicitly invoked with true.
         if (shouldQueueEmails === true) {
-            this.sendEmailAsynchronously(message);
+            return this.sendEmailAsynchronously(message);
         }
         // If developer has not, however system config mandates that we send using queue, still we send.
         else if (shouldQueueEmails == false && this.commonConfiguration.shouldQueueEmails === true) {
-            this.sendEmailAsynchronously(message);
+            return this.sendEmailAsynchronously(message);
         }
-        // Else we send synch
+        // Else we send synchronously
         else {
-            await this.sendEmailSynchronously(message);
+            return await this.sendEmailSynchronously(message);
         }
     }
 
     async sendEmailAsynchronously(message) {
         const { to, subject, body } = message.payload;
-        // this.notificationPublisherService.publish(message);
-        // this.emailPublisher.publish(message);
-        // this.emailDbPublisher.publish(message);
-
-        this.publisherFactory.publish(message, 'SmtpEmailQueuePublisher');
-
         this.logger.debug(`Queueing email to ${to} with subject ${subject} and body ${body}`);
+        return this.publisherFactory.publish(message, 'SmtpEmailQueuePublisher');
     }
 
-    async sendEmailSynchronously(message: QueueMessage<any>): Promise<void> {
-        const { from, to, subject, body, attachments, cc, bcc } = message.payload;
+    async sendEmailSynchronously(message: QueueMessage<any>) {
+        const { from, to, subject, body, attachments = [], cc, bcc } = message.payload;
 
-        const attachmentsList = attachments.map((attachment: MailAttachment) => {
+        // if any of the required fields are missing, throw an error.
+        if (!from || !to || !subject || !body) {
+            this.logger.error(`Required fields are missing in the email message: ${JSON.stringify(message.payload)}`);
+            return;
+        }
+
+        const attachmentsList = attachments?.map((attachment: MailAttachment) => {
             const attachmentEntry = {
                 filename: attachment.filename,
                 contentType: attachment.contentType,
@@ -133,7 +134,7 @@ export class SMTPEMailService implements IMail {
                 attachmentEntry['content'] = attachment.content;
             }
             return attachmentEntry;
-        });
+        }) || [];
 
         // throw new Error('Random error....');
         const r = await this.transporter.sendMail({