@yellowpanther/shared 1.0.0

package/README.md

@@ -0,0 +1,21 @@
+# @yellowpanther/shared
+
+Reusable shared utilities for Yellow Panther CMS microservices.
+
+## Features
+
+- Redis client setup for BullMQ queues
+- Queue registry for background jobs
+- Config loader (env-based)
+- Common Sequelize DB client
+- Auth utilities (JWT with HttpOnly cookies)
+- Common middleware (logger, error handler)
+- Shared Sequelize models (User, Tag, Category, Language, etc.)
+- Common API routes (Tag, Category, Language)
+
+## Usage
+
+### Install locally (for development)
+
+```bash
+npm link

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@yellowpanther/shared",
+  "version": "1.0.0",
+  "description": "Reusable shared utilities for YP microservices (e.g., redis, queue, config)",
+  "author": "Yellow Panther",
+  "main": "src/index.js",
+  "type": "commonjs",
+  "files": [
+    "src",
+    "package.json",
+    "README.md"
+  ],
+  "exports": {
+    "./config": "./src/config/index.js",
+    "./redis/redisClient": "./src/redis/redisClient.js",
+    "./queue/compressionQueue": "./src/queue/compressionQueue.js",
+    "./queue/newsTranslationQueue": "./src/queue/newsTranslationQueue.js",
+    "./queue/queueRegistry": "./src/queue/queueRegistry.js"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "format": "prettier --write ."
+  },
+  "license": "MIT"
+}

package/src/config/index.js

@@ -0,0 +1,168 @@
+const dotenv = require('dotenv');
+const path = require('path');
+const Joi = require('joi');
+
+dotenv.config({ path: path.join(__dirname, '../../.env') });
+
+const envValidation = Joi.object()
+  .keys({
+    APP_NAME: Joi.string().default('ip-cms'),
+    NODE_ENV: Joi.string().valid('development', 'production', 'test').required(),
+    PORT: Joi.number().default(4006),
+    DB_HOST: Joi.string().default('localhost'),
+    DB_USER: Joi.string().required(),
+    DB_PASS: Joi.string().required(),
+    DB_NAME: Joi.string().required(),
+    JWT_SECRET: Joi.string().required().description('JWT secret key'),
+    JWT_ACCESS_EXPIRATION_MINUTES: Joi.number().default(30),
+    JWT_REFRESH_EXPIRATION_DAYS: Joi.number().default(30),
+    JWT_RESET_PASSWORD_EXPIRATION_MINUTES: Joi.number().default(10),
+    JWT_VERIFY_EMAIL_EXPIRATION_MINUTES: Joi.number().default(10),
+    JWT_2FA_EXPIRATION_MINUTES: Joi.number().default(30),
+    LOG_FOLDER: Joi.string().required(),
+    LOG_FILE: Joi.string().required(),
+    LOG_LEVEL: Joi.string().required(),
+
+    REDIS_HOST: Joi.string().default('127.0.0.1'),
+    REDIS_PORT: Joi.number().default(6379),
+    REDIS_USE_PASSWORD: Joi.string().default('no'),
+    REDIS_PASSWORD: Joi.string(),
+
+    SMTP_HOST: Joi.string(),
+    SMTP_PORT: Joi.string(),
+    SMTP_SECURE: Joi.string(),
+    SMTP_USER: Joi.string(),
+    SMTP_PASS: Joi.string(),
+    SMTP_FROM_NAME: Joi.string(),
+    SMTP_FROM_EMAIL: Joi.string(),
+    FRONTEND_BASE_URL: Joi.string(),
+
+    COOKIE_SECURE: Joi.string().valid('true', 'false').default('false'),
+    COOKIE_SAME_SITE: Joi.string().valid('Strict', 'Lax', 'None').default('Strict'),
+    COOKIE_DOMAIN: Joi.string().default('localhost'),
+    ACCESS_TOKEN_COOKIE_EXPIRE: Joi.number().default(3600000),
+    REFRESH_TOKEN_COOKIE_EXPIRE: Joi.number().default(604800000),
+
+    STORAGE_DRIVER: Joi.string().required(),
+    LOCAL_UPLOAD_PATH: Joi.string().required(),
+    AWS_ACCESS_KEY_ID: Joi.string().required(),
+    AWS_SECRET_ACCESS_KEY: Joi.string().required(),
+    AWS_REGION: Joi.string().required(),
+    AWS_S3_BUCKET_NAME: Joi.string().required(),
+    MEDIA_BASE_URL: Joi.string().required(),
+
+    COMPRESSION_PROFILE: Joi.string().valid('low', 'medium', 'high').default('medium'),
+    IMAGE_COMPRESSION_THRESHOLD: Joi.number().default(300 * 1024),
+    IMAGE_COMPRESSION_QUALITY: Joi.number(),
+    IMAGE_MAX_WIDTH: Joi.number(),
+    IMAGE_KEEP_ORIGINAL_EXTENSION: Joi.boolean().default(true),
+    VIDEO_COMPRESSION_THRESHOLD: Joi.number().default(1024 * 1024),
+    VIDEO_COMPRESSION_CRF_LOW: Joi.number().default(30),
+    VIDEO_COMPRESSION_CRF_MEDIUM: Joi.number().default(28),
+    VIDEO_COMPRESSION_CRF_HIGH: Joi.number().default(24),
+    PDF_COMPRESSION_ENABLED: Joi.boolean().default(true),
+    PDF_COMPRESSION_QUALITY: Joi.string().default('ebook')
+    
+  })
+  .unknown();
+
+const { value: envVar, error } = envValidation
+  .prefs({ errors: { label: 'key' }, convert: true })
+  .validate(process.env);
+
+if (error) {
+  throw new Error(`Config validation error: ${error.message}`);
+}
+
+const profile = envVar.COMPRESSION_PROFILE || 'medium';
+
+const imagePresets = {
+  low: { quality: envVar.COMPRESSION_IMAGE_LOW_QUALITY, maxWidth: envVar.COMPRESSION_IMAGE_LOW_WIDTH },
+  medium: { quality: envVar.COMPRESSION_IMAGE_MEDIUM_QUALITY, maxWidth: envVar.COMPRESSION_IMAGE_MEDIUM_WIDTH },
+  high: { quality: envVar.COMPRESSION_IMAGE_HIGH_QUALITY, maxWidth: envVar.COMPRESSION_IMAGE_HIGH_WIDTH }
+};
+
+const videoPresets = {
+  low: envVar.VIDEO_COMPRESSION_CRF_LOW,
+  medium: envVar.VIDEO_COMPRESSION_CRF_MEDIUM,
+  high: envVar.VIDEO_COMPRESSION_CRF_HIGH
+};
+
+module.exports = {
+  name: process.env.APP_NAME || 'ip-cms',
+  nodeEnv: envVar.NODE_ENV,
+  port: envVar.PORT,
+  dbHost: envVar.DB_HOST,
+  dbUser: envVar.DB_USER,
+  dbPass: envVar.DB_PASS,
+  dbName: envVar.DB_NAME,
+  app: {
+    name: process.env.APP_NAME || 'ip-cms',
+    env: process.env.NODE_ENV || 'development',
+    port: process.env.PORT || 3000
+  },
+  jwt: {
+    secret: envVar.JWT_SECRET,
+    accessExpirationMinutes: envVar.JWT_ACCESS_EXPIRATION_MINUTES,
+    refreshExpirationDays: envVar.JWT_REFRESH_EXPIRATION_DAYS,
+    resetPasswordExpirationMinutes: envVar.JWT_RESET_PASSWORD_EXPIRATION_MINUTES,
+    verifyEmailExpirationMinutes: envVar.JWT_VERIFY_EMAIL_EXPIRATION_MINUTES,
+    twoFAExpirationMinutes: envVar.JWT_2FA_EXPIRATION_MINUTES,
+  },
+  logConfig: {
+    logFolder: envVar.LOG_FOLDER,
+    logFile: envVar.LOG_FILE,
+    logLevel: envVar.LOG_LEVEL,
+  },
+  redis: {
+    host: process.env.REDIS_HOST || 'localhost',
+    port: parseInt(process.env.REDIS_PORT || '6379', 10),
+    password: process.env.REDIS_PASSWORD || '',
+    usePassword: process.env.REDIS_USE_PASSWORD || 'NO'
+  },
+  smtp: {
+      host: process.env.SMTP_HOST,
+      port: process.env.SMTP_PORT,
+      secure: process.env.SMTP_SECURE === 'true',
+      user: process.env.SMTP_USER,
+      pass: process.env.SMTP_PASS,
+      fromName: process.env.SMTP_FROM_NAME,
+      fromEmail: process.env.SMTP_FROM_EMAIL
+  },
+  frontendBaseUrl: process.env.FRONTEND_BASE_URL || 'http://localhost:4001',
+  cookie: {
+      secure: envVar.COOKIE_SECURE === 'true',
+      sameSite: envVar.COOKIE_SAME_SITE || 'None',
+      domain: '', // envVar.COOKIE_DOMAIN || '.ypstagingserver.com',
+      accessExpire: parseInt(envVar.ACCESS_TOKEN_COOKIE_EXPIRE) || 60 * 60 * 1000, // 1 hour
+      refreshExpire: parseInt(envVar.REFRESH_TOKEN_COOKIE_EXPIRE) || 7 * 24 * 60 * 60 * 1000, // 7 days
+  },
+  storage: {
+    driver: envVar.STORAGE_DRIVER || 'local', // 's3' or 'local',
+    localUploadPath: envVar.LOCAL_UPLOAD_PATH || 'uploads/',
+    mediaBaseUrl: envVar.MEDIA_BASE_URL,
+    s3: {
+      accessKeyId: envVar.AWS_ACCESS_KEY_ID,
+      secretAccessKey: envVar.AWS_SECRET_ACCESS_KEY,
+      region: envVar.AWS_REGION,
+      bucket: envVar.AWS_S3_BUCKET_NAME,
+    },
+  },
+  compression: {
+    profile,
+    image: {
+      quality: parseInt(imagePresets[profile].quality, 10),
+      maxWidth: parseInt(imagePresets[profile].maxWidth, 10),
+      threshold: parseInt(envVar.IMAGE_COMPRESSION_THRESHOLD, 10),
+      keepOriginalExtension: envVar.IMAGE_KEEP_ORIGINAL_EXTENSION === true || envVar.IMAGE_KEEP_ORIGINAL_EXTENSION === 'true',
+    },
+    video: {
+      crf: parseInt(videoPresets[profile], 10),
+      threshold: parseInt(envVar.VIDEO_COMPRESSION_THRESHOLD, 10),
+    },
+    pdf: {
+      enabled: envVar.PDF_COMPRESSION_ENABLED === true || envVar.PDF_COMPRESSION_ENABLED === 'true',
+      quality: envVar.PDF_COMPRESSION_QUALITY
+    }
+  }
+};

package/src/index.js

@@ -0,0 +1,13 @@
+module.exports = {
+  // ✅ Redis
+  redisClient: require('./redis/redisClient'),
+
+  // ✅ Config
+  config: require('./config'),
+
+  // ✅ Queues
+  compressionQueue: require('./queue/compressionQueue'),
+  addCompressionJob: require('./queue/compressionQueue').addCompressionJob,
+  newsTranslateQueue: require('./queue/newsTranslateQueue'),
+  addNewsTranslationJob: require('./queue/newsTranslateQueue').addNewsTranslationJob
+};

package/src/queue/compressionQueue.js

@@ -0,0 +1,34 @@
+const { Queue } = require('bullmq');
+const redisClient = require('../redis/redisClient');
+
+const compressionQueue = new Queue('file-compression-queue', {
+  connection: redisClient,
+  defaultJobOptions: {
+    removeOnComplete: {
+      age: 3600, // remove jobs after 1 hour
+      count: 1000 // or keep latest 1000
+    },
+    removeOnFail: {
+      age: 86400 // remove failed jobs after 24h
+    },
+    attempts: 3,
+    backoff: {
+      type: 'exponential',
+      delay: 5000
+    }
+  }
+});
+
+/**
+ * Add a compression job
+ * @param {Object} jobData
+ * @returns {Promise<void>}
+ */
+async function addCompressionJob(jobData) {
+  await compressionQueue.add('compress-file', jobData);
+}
+
+module.exports = {
+  compressionQueue,
+  addCompressionJob
+};

package/src/queue/index.js

@@ -0,0 +1,8 @@
+const { compressionQueue } = require('./compressionQueue');
+
+const allQueues = [compressionQueue];
+
+module.exports = {
+  allQueues,
+  queueAdapters: allQueues.map(q => ({ name: q.name, bullMqAdapter: q }))
+};

package/src/queue/newsTranslateQueue.js

@@ -0,0 +1,29 @@
+const { Queue } = require('bullmq');
+const redisClient = require('../redis/redisClient');
+
+const newsTranslationQueue = new Queue('newsTranslationQueue', {
+  connection: redisClient,
+  defaultJobOptions: {
+    removeOnComplete: false,
+    removeOnFail: false,
+    attempts: 3,
+    backoff: {
+      type: 'exponential',
+      delay: 1000
+    }
+  }
+});
+
+/**
+ * Add a news translation job
+ * @param {Object} jobData
+ * @returns {Promise<void>}
+ */
+async function addNewsTranslationJob({ news_id, user_id, translation, blocks }) {
+  await newsTranslationQueue.add('translateNews', { news_id, user_id, translation, blocks });
+}
+
+module.exports = {
+  newsTranslationQueue,
+  addNewsTranslationJob
+};

package/src/queue/queueRegistry.js

@@ -0,0 +1,15 @@
+const { compressionQueue } = require('../queue/compressionQueue');
+const { newsTranslationQueue } = require('./newsTranslateQueue');
+// You can register more queues here like translationQueue, videoProcessingQueue, etc.
+
+module.exports = [
+  {
+    name: 'compressionQueue',
+    instance: compressionQueue
+  },
+  {
+    name: 'newsTranslationQueue',
+    instance: newsTranslationQueue
+  }
+  // Add more { name, instance } here
+];

package/src/redis/redisClient.js

@@ -0,0 +1,17 @@
+const Redis = require('ioredis');
+require('dotenv').config();
+
+const redisClient = new Redis(process.env.REDIS_URL, {
+  maxRetriesPerRequest: null,
+  enableReadyCheck: true
+});
+
+redisClient.on('connect', () => {
+  console.log('✅ Shared Redis client connected');
+});
+
+redisClient.on('error', err => {
+  console.error('❌ Redis connection error:', err);
+});
+
+module.exports = redisClient;