@solidstarters/solid-core 1.2.4 → 1.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstarters/solid-core",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "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/commands/refresh-model.command.ts

@@ -37,7 +37,7 @@ export class RefreshModelCommand extends CommandRunner {
   }
 
   @Option({
-    flags: '-id, --modelId [model ID]',
+    flags: '-id, --id [model ID]',
     description: 'Model ID from the ss_model_metadata table',
   })
   parseModelId(val: string): number {
@@ -46,7 +46,7 @@ export class RefreshModelCommand extends CommandRunner {
 
     // Accept the module name as an argument
     @Option({
-      flags: '-n, --modelName [model name]',
+      flags: '-n, --name [model name]',
       description: 'Model Name from the ss_model_metadata table',
     })
     parseModelName(val: string): string {

package/src/commands/refresh-module.command.ts

@@ -37,7 +37,7 @@ export class RefreshModuleCommand extends CommandRunner {
 
 
   @Option({
-    flags: '-id, --moduleId [module ID]',
+    flags: '-id, --id [module ID]',
     description: 'Module ID from the ss_module_metadata table',
   })
   parseModuleId(val: string): number {
@@ -46,7 +46,7 @@ export class RefreshModuleCommand extends CommandRunner {
 
     // Accept the module name as an argument
     @Option({
-      flags: '-n, --moduleName [module name]',
+      flags: '-n, --name [module name]',
       description: 'Module Name from the ss_module_metadata table',
     })
     parseModuleName(val: string): string {

package/src/commands/seed.command.ts

@@ -46,7 +46,8 @@ export class SeedCommand extends CommandRunner {
   @Option({
     flags: '-s, --seeder [seeder name]',
     description: 'The seeder to run.',
-    required: true
+    required: true,
+    defaultValue: 'ModuleMetadataSeederService'
   })
   parseString(val: string): string {
     return val;

package/src/config/cache.options.ts

@@ -0,0 +1,36 @@
+import { CacheModuleAsyncOptions } from '@nestjs/cache-manager';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { redisStore } from 'cache-manager-redis-store';
+import { isNumber } from 'class-validator';
+
+export const RedisOptions: CacheModuleAsyncOptions = {
+    isGlobal: true,
+    imports: [ConfigModule],
+    useFactory: async (configService: ConfigService) => {
+        if (!isRedisConfigured(configService)) {
+            return {
+                ttl: 0
+            } // This defaults to in-memory cache
+        }
+        const store = await createRedisStore(configService);
+        return {
+            store: () => store,
+        };
+    },
+    inject: [ConfigService],
+};
+
+async function createRedisStore(configService: ConfigService<Record<string, unknown>, false>) {
+    return await redisStore({
+        socket: {
+            host: configService.get<string>('REDIS_HOST'),
+            port: parseInt(configService.get<string>('REDIS_PORT')!),
+        },
+    });
+}
+
+function isRedisConfigured(configService: ConfigService): boolean {
+    const host = configService.get<string>('REDIS_HOST');
+    const port = configService.get<string>('REDIS_PORT');
+    return host && port && isNumber(parseInt(port));
+}

package/src/config/common.config.ts

@@ -36,9 +36,13 @@ export default registerAs('common', () => {
         awsS3Credentials: {
             S3_AWS_ACCESS_KEY: process.env.S3_AWS_ACCESS_KEY,
             S3_AWS_SECRET_KEY: process.env.S3_AWS_SECRET_KEY,
-            S3_AWS_BUCKET_NAME: process.env.S3_AWS_BUCKET_NAME,
-            S3_AWS_REGION_HOST: process.env.S3_AWS_REGION_HOST,
             S3_AWS_REGION_NAME: process.env.S3_AWS_REGION_NAME
         }
     };
 });
+
+export interface AwsS3Config {
+    S3_AWS_ACCESS_KEY: string;
+    S3_AWS_SECRET_KEY: string;
+    S3_AWS_REGION_NAME: string;
+}

package/src/index.ts

@@ -8,7 +8,7 @@ export * from './commands/seed.command'
 export * from './config/app-builder.config'
 export * from './config/common.config'
 export * from './config/iam.config'
-export * from './config/redis.options'
+export * from './config/cache.options'
 
 export * from './decorators/active-user.decorator'
 export * from './decorators/auth.decorator'

package/src/services/file.service.ts

@@ -3,7 +3,7 @@ import * as fs from 'fs';
 // import * as AWS from 'aws-sdk';
 import { S3Client, PutObjectCommand, DeleteObjectCommand, ObjectCannedACL } from '@aws-sdk/client-s3';
 import { ConfigType } from '@nestjs/config';
-import commonConfig from '../config/common.config';
+import commonConfig, { AwsS3Config } from '../config/common.config';
 
 
 
@@ -18,14 +18,13 @@ export class FileService {
     private readonly commonConfiguration: ConfigType<typeof commonConfig>,
 
   ) {
+    if (!this.isValidS3Config(this.commonConfiguration.awsS3Credentials)) { return }
     this.s3Client = new S3Client({
       region: this.commonConfiguration.awsS3Credentials.S3_AWS_REGION_NAME,
       credentials: {
         accessKeyId: this.commonConfiguration.awsS3Credentials.S3_AWS_ACCESS_KEY,
         secretAccessKey: this.commonConfiguration.awsS3Credentials.S3_AWS_SECRET_KEY,
       },
-      // endpoint: `https://${process.env.S3_AWS_BUCKET_NAME}.s3.${process.env.S3_AWS_REGION_NAME}.amazonaws.com`, // Correct regional endpoint
-
     });
   }
 
@@ -84,6 +83,7 @@ export class FileService {
   }
 
   async copyToS3(filePath: string, ContentType: string, fileName: string, bucketName: string): Promise<string> {
+    this.checkIfS3ClientExists();
     try {
       // Read Image File TO Fetch Buffer 
       const data = await this.readImageFile(filePath);
@@ -109,7 +109,12 @@ export class FileService {
     }
   }
 
+  private checkIfS3ClientExists() {
+    if (!this.s3Client) { throw new Error('S3 Client not initialized. Please check the S3 configuration'); }
+  }
+
   async copyToS3WithPublic(filePath: string, ContentType: string, fileName: string, bucketName: string): Promise<string> {
+    this.checkIfS3ClientExists();
     try {
       // Read Image File TO Fetch Buffer 
       const data = await this.readImageFile(filePath);
@@ -136,7 +141,7 @@ export class FileService {
   }
 
   async deleteFromS3(fileName: string, bucketName: string): Promise<string> {
-
+    this.checkIfS3ClientExists();
     const params = {
       Bucket: bucketName,  // your S3 bucket name
       Key: fileName        // the name of the file you want to delete    
@@ -146,4 +151,8 @@ export class FileService {
     const response = await this.s3Client.send(command);
     return fileName
   }
+
+  private isValidS3Config(config: AwsS3Config): boolean {
+    return !!config.S3_AWS_ACCESS_KEY && !!config.S3_AWS_SECRET_KEY && !!config.S3_AWS_REGION_NAME;
+  }
 }

package/src/services/rabbitmq-publisher.service.ts

@@ -1,30 +1,50 @@
-import { v4 as uuidv4 } from 'uuid';
-import { Injectable, Logger } from '@nestjs/common';
+import { Logger } from '@nestjs/common';
 import * as amqp from 'amqplib';
+import { v4 as uuidv4 } from 'uuid';
+import { QueuesModuleOptions } from "../interfaces";
 import { QueueMessage, QueuePublisher } from '../interfaces/mq';
 import { MqMessageQueueService } from './mq-message-queue.service';
 import { MqMessageService } from './mq-message.service';
-import { QueuesModuleOptions } from "../interfaces";
 
-@Injectable()
 export abstract class RabbitMqPublisher<T> implements QueuePublisher<T> { // TODO This can be made a generic type for better type visibility
     private readonly logger = new Logger(RabbitMqPublisher.name);
+    private readonly url: string;
+    private readonly serviceRole: string;
 
     constructor(
         protected readonly mqMessageService: MqMessageService,
         protected readonly mqMessageQueueService: MqMessageQueueService,
     ) {
-        const url = process.env.QUEUES_RABBIT_MQ_URL;
-        this.logger.debug(`RabbitMqPublisher instance created with options: ${JSON.stringify(this.options())} and url: ${url}`);
+        this.url = process.env.QUEUES_RABBIT_MQ_URL;
+        this.serviceRole = process.env.QUEUES_SERVICE_ROLE;
+        if (!this.url) {
+            this.logger.debug('RabbitMqPublisher url is not defined in the environment variables');
+        }
+        if (!this.serviceRole) {
+            this.logger.debug('Queue service Role is not defined in the environment variables');
+        }
+        this.logger.debug(`RabbitMqPublisher instance created with options: ${JSON.stringify(this.options())} and url: ${this.url}`);
     }
 
     abstract options(): QueuesModuleOptions;
 
     async publish(message: QueueMessage<T>): Promise<string> {
-        const url = process.env.QUEUES_RABBIT_MQ_URL;
-        this.logger.debug(`RabbitMqPublisher publishing with options: ${JSON.stringify(this.options())} and url: ${url}`);
+        if (!this.url) {
+            this.logger.error('RabbitMqPublisher url is not defined in the environment variables');
+            throw new Error('RabbitMqPublisher url is not defined in the environment variables');
+        }
+        if (!this.serviceRole) {
+            this.logger.error('Queue service Role is not defined in the environment variables');
+            throw new Error('Queue service Role is not defined in the environment variables');
+        }
+        if (this.serviceRole === 'subscriber') {
+            this.logger.error('Queue service Role is subscriber, cannot publish messages');
+            throw new Error('Queue service Role is subscriber, cannot publish messages');
+        }
+
+        this.logger.debug(`RabbitMqPublisher publishing with options: ${JSON.stringify(this.options())} and url: ${this.url}`);
 
-        const connection = await amqp.connect(url);
+        const connection = await amqp.connect(this.url);
         // this.logger.debug(`RabbitMqPublisher publisher connected options: ${JSON.stringify(this.options())} and url: ${url}`);
 
         const channel = await connection.createChannel();
@@ -117,5 +137,6 @@ export abstract class RabbitMqPublisher<T> implements QueuePublisher<T> { // TOD
         }
 
     }
+    
 
 }

package/src/services/rabbitmq-subscriber.service.ts

@@ -1,41 +1,50 @@
-import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
+import { Logger, OnModuleInit } from '@nestjs/common';
 import * as amqp from 'amqplib';
+import { QueuesModuleOptions } from "../interfaces";
 import { QueueMessage, QueueSubscriber } from '../interfaces/mq';
-import { MqMessageService } from './mq-message.service';
 import { MqMessageQueueService } from './mq-message-queue.service';
-import { QueuesModuleOptions } from "../interfaces";
+import { MqMessageService } from './mq-message.service';
 
 
-@Injectable()
 export abstract class RabbitMqSubscriber<T> implements OnModuleInit, QueueSubscriber<T> { // TODO This can be made a generic type for better type visibility
     private readonly logger = new Logger(RabbitMqSubscriber.name);
+    private readonly url: string;
+    private readonly serviceRole: string;
 
     constructor(
         protected readonly mqMessageService: MqMessageService,
         protected readonly mqMessageQueueService: MqMessageQueueService,
     ) {
+        this.url = process.env.QUEUES_RABBIT_MQ_URL;
+        this.serviceRole = process.env.SERVICE_ROLE;
+        if (!this.url) {
+            this.logger.debug('RabbitMqPublisher url is not defined in the environment variables');
+        }
+        if (!this.serviceRole) {
+            this.logger.debug('Queue service Role is not defined in the environment variables');
+        }
+        this.logger.debug(`RabbitMqSubscriber instance created with options: ${JSON.stringify(this.options())} and url: ${this.url}`);
     }
 
     abstract subscribe(message: QueueMessage<T>);
 
     abstract options(): QueuesModuleOptions;
 
-    // setReceiveHandler(receiveHandler: (message: any) => Promise<any>): void {
-    //     this.options.receive = receiveHandler; // Overwrite the default receive handler
-    // }
-
     async onModuleInit(): Promise<void> {
         // we will start subscriber only if the current service role is subscriber. 
-        if (['both', 'subscriber'].includes(process.env.QUEUES_SERVICE_ROLE)) {
-
-            const url = process.env.QUEUES_RABBIT_MQ_URL;
-            if (!url) {
+        if (['both', 'subscriber'].includes(this.serviceRole)) {
+            if (!this.url) {
+                this.logger.error('RabbitMqPublisher url is not defined in the environment variables');
+                throw new Error('RabbitMqPublisher url is not defined in the environment variables');
+            }
+    
+            if (!this.url) {
                 this.logger.warn(`Unable to create RabbitMqSubscriber instance: ${JSON.stringify(this.options())} as rabbitmq url is not configured.`);
                 return;
             }
 
             // this.logger.debug(`RabbitMqSubscriber instance created with options: ${JSON.stringify(this.options())} and url: ${url}`);
-            const connection = await amqp.connect(url);
+            const connection = await amqp.connect(this.url);
             // this.logger.debug(`RabbitMqSubscriber connection established: ${JSON.stringify(this.options())} and url: ${url}`);
 
             const channel = await connection.createChannel();
@@ -104,7 +113,7 @@ export abstract class RabbitMqSubscriber<T> implements OnModuleInit, QueueSubscr
                 {},
             );
 
-            this.logger.debug(`RabbitMqSubscriber ready to consume messages: ${JSON.stringify(this.options())} and url: ${url}`);
+            this.logger.debug(`RabbitMqSubscriber ready to consume messages: ${JSON.stringify(this.options())} and url: ${this.url}`);
         }
 
     }

package/src/solid-core-cli.module.ts

@@ -5,7 +5,7 @@ import { WinstonLoggerConfig } from './winston.logger';
 import { WinstonModule } from 'nest-winston';
 import { CacheModule } from '@nestjs/cache-manager';
 import { EventEmitterModule } from '@nestjs/event-emitter';
-import { RedisOptions } from './config/redis.options';
+import { RedisOptions } from './config/cache.options';
 import { ConfigModule } from '@nestjs/config';
 import Joi from '@hapi/joi';
 

package/dist/config/redis.options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis.options.d.ts","sourceRoot":"","sources":["../../src/config/redis.options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAIhE,eAAO,MAAM,YAAY,EAAE,uBAe1B,CAAC"}

package/dist/config/redis.options.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisOptions = void 0;
-const config_1 = require("@nestjs/config");
-const cache_manager_redis_store_1 = require("cache-manager-redis-store");
-exports.RedisOptions = {
-    isGlobal: true,
-    imports: [config_1.ConfigModule],
-    useFactory: async (configService) => {
-        const store = await (0, cache_manager_redis_store_1.redisStore)({
-            socket: {
-                host: configService.get('REDIS_HOST'),
-                port: parseInt(configService.get('REDIS_PORT')),
-            },
-        });
-        return {
-            store: () => store,
-        };
-    },
-    inject: [config_1.ConfigService],
-};
-//# sourceMappingURL=redis.options.js.map

package/dist/config/redis.options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis.options.js","sourceRoot":"","sources":["../../src/config/redis.options.ts"],"names":[],"mappings":";;;AACA,2CAA6D;AAC7D,yEAAuD;AAE1C,QAAA,YAAY,GAA4B;IACjD,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,CAAC,qBAAY,CAAC;IACvB,UAAU,EAAE,KAAK,EAAE,aAA4B,EAAE,EAAE;QAC/C,MAAM,KAAK,GAAG,MAAM,IAAA,sCAAU,EAAC;YAC3B,MAAM,EAAE;gBACJ,IAAI,EAAE,aAAa,CAAC,GAAG,CAAS,YAAY,CAAC;gBAC7C,IAAI,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAS,YAAY,CAAE,CAAC;aAC3D;SACJ,CAAC,CAAC;QACH,OAAO;YACH,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK;SACrB,CAAC;IACN,CAAC;IACD,MAAM,EAAE,CAAC,sBAAa,CAAC;CAC1B,CAAC"}

package/src/config/redis.options.ts

@@ -1,20 +0,0 @@
-import { CacheModuleAsyncOptions } from '@nestjs/cache-manager';
-import { ConfigModule, ConfigService } from '@nestjs/config';
-import { redisStore } from 'cache-manager-redis-store';
-
-export const RedisOptions: CacheModuleAsyncOptions = {
-    isGlobal: true,
-    imports: [ConfigModule],
-    useFactory: async (configService: ConfigService) => {
-        const store = await redisStore({
-            socket: {
-                host: configService.get<string>('REDIS_HOST'),
-                port: parseInt(configService.get<string>('REDIS_PORT')!),
-            },
-        });
-        return {
-            store: () => store,
-        };
-    },
-    inject: [ConfigService],
-};