@solidstarters/solid-core 1.2.155 → 1.2.157

package/package.json

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

@@ -3,6 +3,7 @@ import { registerAs } from '@nestjs/config';
 export default registerAs('common', () => {
     return {
         emailProvider: process.env.COMMON_EMAIL_PROVIDER ?? "SMTPEMailService",
+        whatsappProvider: process.env.COMMON_WHATSAPP_PROVIDER,
         emailTemplateSeederFiles: process.env.COMMON_EMAIL_TEMPLATE_SEEDER_FILES,
         smsProvider: process.env.COMMON_SMS_PROVIDER,
         smsTemplateSeederFiles: process.env.COMMON_SMS_TEMPLATE_SEEDER_FILES,

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

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

package/src/dtos/create-list-of-values.dto.ts

@@ -27,4 +27,11 @@ export class CreateListOfValuesDto {
     @IsInt()
     @ApiProperty()
     sequence: number;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    moduleId: number;
+    @IsString()
+    @IsOptional()
+    moduleUserKey: string;
 }

package/src/dtos/update-list-of-values.dto.ts

@@ -1,4 +1,4 @@
-import { IsInt,IsOptional, IsString, IsNotEmpty, IsBoolean } from 'class-validator';
+import { IsInt, IsOptional, IsString, IsNotEmpty, IsBoolean } from 'class-validator';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class UpdateListOfValuesDto {
@@ -33,4 +33,11 @@ export class UpdateListOfValuesDto {
     @IsInt()
     @ApiProperty()
     sequence: number;
+    @IsOptional()
+    @IsInt()
+    @ApiProperty()
+    moduleId: number;
+    @IsString()
+    @IsOptional()
+    moduleUserKey: string;
 }

package/src/entities/list-of-values.entity.ts

@@ -1,5 +1,6 @@
 import { CommonEntity } from 'src/entities/common.entity'
-import {Entity, Column} from 'typeorm'
+import { Entity, Column, ManyToOne, JoinColumn } from 'typeorm'
+import { ModuleMetadata } from 'src/entities/module-metadata.entity'
 
 @Entity("ss_list_of_values")
 export class ListOfValues extends CommonEntity {
@@ -15,4 +16,7 @@ export class ListOfValues extends CommonEntity {
     default: boolean = false;
     @Column({ type: "int", nullable: true })
     sequence: number;
+    @ManyToOne(() => ModuleMetadata, { onDelete: "CASCADE", nullable: true })
+    @JoinColumn()
+    module: ModuleMetadata;
 }

package/src/factories/whatsapp.factory.ts

@@ -0,0 +1,41 @@
+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 { IWhatsAppTransport } 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 WhatsAppFactory {
+    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>,
+    ) { }
+
+    getWhatsappService(name: string = null): IWhatsAppTransport {
+        // This is the default provider
+        const whatsappServiceName = this.commonConfiguration.whatsappProvider || name;
+        if (!whatsappServiceName) {
+            throw new Error("Unable to resolve whatsapp provider")
+        }
+        const whatsappProviders = this.solidRegistry.getWhatsappProviders();
+        // Return the instance which matches the whatsappServiceName
+        if (!whatsappProviders.length) {
+            // throw new Error("No mail providers are registered.");
+            this.logger.error("No whatsapp providers are registered.");
+        }
+
+        const whatsappServiceProvider = whatsappProviders.find(provider => provider.name === whatsappServiceName);
+
+        return whatsappServiceProvider.instance as IWhatsAppTransport;
+    }
+
+}

package/src/helpers/solid-registry.ts

@@ -66,6 +66,11 @@ export class SolidRegistry {
   private dashboardVariableSelectionProviders: Set<InstanceWrapper> = new Set();
   private dashboardQuestionDataProviders: Set<InstanceWrapper> = new Set();
   private mailProviders: Set<InstanceWrapper> = new Set();
+  private whatsappProviders: Set<InstanceWrapper> = new Set();
+
+  registerWhatsappProvider(whatsappProvider: InstanceWrapper): void {
+    this.whatsappProviders.add(whatsappProvider);
+  }
 
   registerMailProvider(mailProvider: InstanceWrapper): void {
     this.mailProviders.add(mailProvider);
@@ -115,6 +120,10 @@ export class SolidRegistry {
     return Array.from(this.mailProviders);
   }
 
+  getWhatsappProviders(): Array<InstanceWrapper> {
+    return Array.from(this.whatsappProviders);
+  }
+
   getSeeders(): Array<InstanceWrapper> {
     return Array.from(this.seeders);
   }

package/src/index.ts

@@ -193,9 +193,9 @@ export * from './jobs/otp-subscriber.service'
 export * from './jobs/sms-publisher.service'
 export * from './jobs/sms-queue-options'
 export * from './jobs/sms-subscriber.service'
-export * from './jobs/whatsapp-publisher.service'
-export * from './jobs/whatsapp-queue-options'
-export * from './jobs/whatsapp-subscriber.service'
+export * from './jobs/msg91-whatsapp-publisher.service'
+export * from './jobs/msg91-whatsapp-queue-options'
+export * from './jobs/msg91-whatsapp-subscriber.service'
 
 export * from './listeners/user-registration.listener'
 

package/src/interfaces.ts

@@ -134,7 +134,7 @@ export interface IEntityComputedFieldProvider {
   name(): string;
 }
 
-export interface IEntityPreComputeFieldProvider<TTriggerEntity, TContext, TValue=void> extends IEntityComputedFieldProvider {
+export interface IEntityPreComputeFieldProvider<TTriggerEntity, TContext, TValue = void> extends IEntityComputedFieldProvider {
   preComputeValue(triggerEntity: TTriggerEntity, computedFieldMetadata: ComputedFieldMetadata<TContext>): Promise<TValue>;
 }
 
@@ -159,7 +159,7 @@ export class EventDetails<T> {
   ) { }
 }
 
-export interface IMail<TResponse=unknown> {
+export interface IMail<TResponse = unknown> {
   sendEmail(
     to: string,
     subject: string,
@@ -200,6 +200,16 @@ export interface ISMS {
   ): Promise<any>;
 }
 
+export interface IWhatsAppTransport {
+  sendWhatsAppMessage(
+    to: string,
+    templateId: string,
+    parameters: any,
+    parentEntity?: any,
+    parentEntityId?: any
+  ): Promise<any>;
+}
+
 export interface MailAttachmentWrapper {
   relativePath?: string;
   attachment?: MailAttachment;

package/src/jobs/database/{whatsapp-publisher-database.service.ts → msg91-whatsapp-publisher-database.service.ts}

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

package/src/jobs/database/{whatsapp-queue-options-database.ts → msg91-whatsapp-queue-options-database.ts}

@@ -1,6 +1,6 @@
 import { BrokerType } from "src/interfaces";
 
-const WHATSAPP_QUEUE_NAME = 'whatsapp_queue_database';
+const WHATSAPP_QUEUE_NAME = 'msg91_whatsapp_queue_database';
 
 export default {
     name: 'whatsappInstance',

package/src/jobs/database/{whatsapp-subscriber-database.service.ts → msg91-whatsapp-subscriber-database.service.ts}

@@ -1,8 +1,7 @@
 import { Injectable } from '@nestjs/common';
 
-import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
 import { QueueMessage } from 'src/interfaces/mq';
-import whatsappQueueOptions from './whatsapp-queue-options-database';
+import whatsappQueueOptions from './msg91-whatsapp-queue-options-database';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { Msg91WhatsappService } from 'src/services/whatsapp/Msg91WhatsappService';
@@ -11,7 +10,7 @@ import { DatabaseSubscriber } from 'src/services/queues/database-subscriber.serv
 import { PollerService } from 'src/services/poller.service';
 
 @Injectable()
-export class WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
+export class Msg91WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     constructor(
         private readonly whatsappService: Msg91WhatsappService,
         readonly mqMessageService: MqMessageService,
@@ -28,6 +27,6 @@ export class WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.whatsappService.sendSMSSynchronously(message);
+        this.whatsappService.sendWhatsAppMessageSynchronously(message);
     }
 }

package/src/jobs/database/three60-whatsapp-publisher-database.service.ts

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

package/src/jobs/database/three60-whatsapp-queue-options-database.ts

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

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

@@ -0,0 +1,32 @@
+import { Injectable } from '@nestjs/common';
+
+import { QueueMessage } from 'src/interfaces/mq';
+import whatsappQueueOptions from './msg91-whatsapp-queue-options-database';
+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 { PollerService } from 'src/services/poller.service';
+import { Three60WhatsappService } from 'src/services/whatsapp/Three60WhatsappService';
+
+@Injectable()
+export class Three60WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any> {
+    constructor(
+        private readonly whatsappService: Three60WhatsappService,
+        readonly mqMessageService: MqMessageService,
+        readonly mqMessageQueueService: MqMessageQueueService,
+        readonly poller: PollerService,
+    ) {
+        super(mqMessageService, mqMessageQueueService, poller);
+    }
+
+    options(): QueuesModuleOptions {
+        return {
+            ...whatsappQueueOptions
+        }
+    }
+
+    subscribe(message: QueueMessage<any>) {
+        this.whatsappService.sendWhatsAppMessageSynchronously(message);
+    }
+}

package/src/jobs/{whatsapp-publisher.service.ts → msg91-whatsapp-publisher.service.ts}

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

package/src/jobs/msg91-whatsapp-queue-options.ts

@@ -0,0 +1,12 @@
+import { BrokerType } from "../interfaces";
+
+const MSG91_WHATSAPP_QUEUE_NAME = 'mag_91_whatsapp_queue';
+export default {
+    name: 'whatsappInstance',
+    type: BrokerType.RabbitMQ,
+    queueName: MSG91_WHATSAPP_QUEUE_NAME,
+    // receive: async (message: QueueMessage<any>) => { // Default receive handler
+    //     console.log(`Received message: ${JSON.stringify(message)} from queue ${SMS_QUEUE_NAME}`);
+    //     return 'Received';
+    // },
+};

package/src/jobs/{whatsapp-subscriber.service.ts → msg91-whatsapp-subscriber.service.ts}

@@ -2,14 +2,14 @@ import { Injectable } from '@nestjs/common';
 
 import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
 import { QueueMessage } from 'src/interfaces/mq';
-import whatsappQueueOptions from './whatsapp-queue-options';
+import whatsappQueueOptions from './msg91-whatsapp-queue-options';
 import { Msg91WhatsappService } from '../services/whatsapp/Msg91WhatsappService';
 import { MqMessageService } from 'src/services/mq-message.service';
 import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
 import { QueuesModuleOptions } from "../interfaces";
 
 @Injectable()
-export class WhatsappQueueSubscriber extends RabbitMqSubscriber<any> {
+export class Msg91WhatsappQueueSubscriber extends RabbitMqSubscriber<any> {
     constructor(
         private readonly whatsappService: Msg91WhatsappService,
         readonly mqMessageService: MqMessageService,
@@ -25,6 +25,6 @@ export class WhatsappQueueSubscriber extends RabbitMqSubscriber<any> {
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.whatsappService.sendSMSSynchronously(message);
+        this.whatsappService.sendWhatsAppMessageSynchronously(message);
     }
 }

package/src/jobs/three60-whatsapp-publisher.service.ts

@@ -0,0 +1,23 @@
+import { Injectable } from '@nestjs/common';
+
+import { RabbitMqPublisher } from 'src/services/queues/rabbitmq-publisher.service';
+import whatsappQueueOptions from './msg91-whatsapp-queue-options';
+import { MqMessageService } from 'src/services/mq-message.service';
+import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
+import { QueuesModuleOptions } from "../interfaces";
+
+@Injectable()
+export class Three60WhatsappQueuePublisher extends RabbitMqPublisher<any> {
+    constructor(
+        protected readonly mqMessageService: MqMessageService,
+        protected readonly mqMessageQueueService: MqMessageQueueService,
+    ) {
+        super(mqMessageService, mqMessageQueueService);
+    }
+
+    options(): QueuesModuleOptions {
+        return {
+            ...whatsappQueueOptions
+        }
+    }
+}

package/src/jobs/{whatsapp-queue-options.ts → three60-whatsapp-queue-options.ts}

@@ -1,10 +1,10 @@
 import { BrokerType } from "../interfaces";
 
-const WHATSAPP_QUEUE_NAME = 'whatsapp_queue';
+const _WHATSAPP_QUEUE_NAME = 'three60_whatsapp_queue';
 export default {
     name: 'whatsappInstance',
     type: BrokerType.RabbitMQ,
-    queueName: WHATSAPP_QUEUE_NAME,
+    queueName: _WHATSAPP_QUEUE_NAME,
     // receive: async (message: QueueMessage<any>) => { // Default receive handler
     //     console.log(`Received message: ${JSON.stringify(message)} from queue ${SMS_QUEUE_NAME}`);
     //     return 'Received';

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

@@ -0,0 +1,30 @@
+import { Injectable } from '@nestjs/common';
+
+import { RabbitMqSubscriber } from 'src/services/queues/rabbitmq-subscriber.service';
+import { QueueMessage } from 'src/interfaces/mq';
+import whatsappQueueOptions from './msg91-whatsapp-queue-options';
+import { MqMessageService } from 'src/services/mq-message.service';
+import { MqMessageQueueService } from 'src/services/mq-message-queue.service';
+import { QueuesModuleOptions } from "../interfaces";
+import { Three60WhatsappService } from 'src/services/whatsapp/Three60WhatsappService';
+
+@Injectable()
+export class Three60WhatsappQueueSubscriber extends RabbitMqSubscriber<any> {
+    constructor(
+        private readonly whatsappService: Three60WhatsappService,
+        readonly mqMessageService: MqMessageService,
+        readonly mqMessageQueueService: MqMessageQueueService,
+    ) {
+        super(mqMessageService, mqMessageQueueService);
+    }
+
+    options(): QueuesModuleOptions {
+        return {
+            ...whatsappQueueOptions
+        }
+    }
+
+    subscribe(message: QueueMessage<any>) {
+        this.whatsappService.sendWhatsAppMessageSynchronously(message);
+    }
+}

package/src/mappers/list-of-values-mapper.ts

@@ -0,0 +1,17 @@
+import { Injectable } from "@nestjs/common";
+import { ListOfValues } from "src/entities/list-of-values.entity";
+
+@Injectable()
+export class ListOfValuesMapper {
+    toDto(listOfValue: ListOfValues): any {
+        return {
+            type: listOfValue.type,
+            value: listOfValue.value,
+            display: listOfValue.display,
+            description: listOfValue.description,
+            default: listOfValue.default,
+            sequence: listOfValue.sequence,
+            module: listOfValue.module ? listOfValue.module.id : null
+        };
+    }
+}

package/src/seeders/module-metadata-seeder.service.ts

@@ -584,7 +584,7 @@ export class ModuleMetadataSeederService {
             return;
         }
         for (let j = 0; j < listOfValuesDto.length; j++) {
-            await this.listOfValuesService.upsert(listOfValuesDto);
+            await this.listOfValuesService.upsert(listOfValuesDto[j]);
         }
     }
 

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

@@ -3642,6 +3642,23 @@
             "private": false,
             "encrypt": false,
             "isSystem": false
+          },
+          {
+            "name": "module",
+            "displayName": "Module",
+            "type": "relation",
+            "ormType": "integer",
+            "required": false,
+            "unique": false,
+            "index": false,
+            "private": false,
+            "encrypt": false,
+            "relationType": "many-to-one",
+            "relationCreateInverse": false,
+            "relationCoModelSingularName": "moduleMetadata",
+            "relationModelModuleName": "solid-core",
+            "relationCascade": "cascade",
+            "isSystem": true
           }
         ]
       },
@@ -6459,73 +6476,6 @@
         ]
       }
     },
-    {
-      "name": "listOfValues-list-view",
-      "displayName": "List of Values list view",
-      "type": "list",
-      "context": "{}",
-      "moduleUserKey": "solid-core",
-      "modelUserKey": "listOfValues",
-      "layout": {
-        "type": "list",
-        "attrs": {
-          "pagination": true,
-          "pageSizeOptions": [
-            10,
-            25,
-            50
-          ],
-          "enableGlobalSearch": true,
-          "create": true,
-          "edit": true,
-          "delete": true
-        },
-        "children": [
-          {
-            "type": "field",
-            "attrs": {
-              "name": "type",
-              "isSearchable": true
-            }
-          },
-          {
-            "type": "field",
-            "attrs": {
-              "name": "value",
-              "isSearchable": true
-            }
-          },
-          {
-            "type": "field",
-            "attrs": {
-              "name": "display",
-              "isSearchable": true
-            }
-          },
-          {
-            "type": "field",
-            "attrs": {
-              "name": "description",
-              "isSearchable": true
-            }
-          },
-          {
-            "type": "field",
-            "attrs": {
-              "name": "default",
-              "isSearchable": true
-            }
-          },
-          {
-            "type": "field",
-            "attrs": {
-              "name": "sequence",
-              "isSearchable": true
-            }
-          }
-        ]
-      }
-    },
     {
       "name": "listOfValues-form-view",
       "displayName": "List of Values form view",
@@ -6590,6 +6540,12 @@
                     "attrs": {
                       "name": "sequence"
                     }
+                  },
+                  {
+                    "type": "field",
+                    "attrs": {
+                      "name": "module"
+                    }
                   }
                 ]
               }
@@ -6899,78 +6855,12 @@
               "name": "sequence",
               "isSearchable": true
             }
-          }
-        ]
-      }
-    },
-    {
-      "name": "listOfValues-form-view",
-      "displayName": "List of Values form view",
-      "type": "form",
-      "context": "{}",
-      "moduleUserKey": "solid-core",
-      "modelUserKey": "listOfValues",
-      "layout": {
-        "type": "form",
-        "attrs": {
-          "name": "form-1",
-          "label": "Solid List of Values Model",
-          "className": "grid"
-        },
-        "children": [
+          },
           {
-            "type": "sheet",
+            "type": "field",
             "attrs": {
-              "name": "sheet-1"
-            },
-            "children": [
-              {
-                "type": "group",
-                "attrs": {
-                  "name": "group-1",
-                  "label": "",
-                  "className": "col-6"
-                },
-                "children": [
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "type"
-                    }
-                  },
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "value"
-                    }
-                  },
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "display"
-                    }
-                  },
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "description"
-                    }
-                  },
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "default"
-                    }
-                  },
-                  {
-                    "type": "field",
-                    "attrs": {
-                      "name": "sequence"
-                    }
-                  }
-                ]
-              }
-            ]
+              "name": "module"
+            }
           }
         ]
       }