@mhmdhammoud/meritt-utils 1.6.1 → 1.6.3

package/example.env

@@ -1,6 +0,0 @@
-ELASTICSEARCH_USERNAME=
-ELASTICSEARCH_PASSWORD=
-ELASTICSEARCH_NODE=
-SERVER_NICKNAME=
-NODE_ENV=
-LOG_LEVEL=info

package/jest.config.js

@@ -1,13 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-	preset: 'ts-jest',
-	testEnvironment: 'node',
-	coverageDirectory: 'coverage',
-	coverageProvider: 'v8',
-	collectCoverageFrom: ['src/**/*.ts', '!test/**/*.ts'],
-	transform: {
-		'^.+\\.(ts)$': 'ts-jest',
-	},
-	transformIgnorePatterns: [],
-	testMatch: ['<rootDir>/src/**/__tests__/**/*.test.ts'],
-}

package/src/__tests__/colorful.test.ts

@@ -1,77 +0,0 @@
-import { Colorful } from '../lib'
-
-describe('Colorful Class', () => {
-	describe('rgbToHex method', () => {
-		it('should convert RGB to HEX', () => {
-			const rgbColor = 'rgb(255, 255, 255)'
-			const hexColor = Colorful.rgbToHex(rgbColor)
-			expect(hexColor).toBe('#ffffff')
-		})
-
-		it('should convert RGBA to HEX', () => {
-			const rgbaColor = 'rgba(255, 0, 0, 0.5)'
-			const hexColor = Colorful.rgbToHex(rgbaColor)
-			expect(hexColor).toBe('#ff0000')
-		})
-
-		it('should throw an error for invalid color format', () => {
-			const invalidColor = 'invalidColor'
-			expect(() => Colorful.rgbToHex(invalidColor)).toThrowError(
-				`Invalid color format '${invalidColor}'. Please provide a valid RGB or RGBA color.`
-			)
-		})
-	})
-
-	describe('hexToRgb method', () => {
-		it('should convert HEX to RGB', () => {
-			const hexColor = '#ffffff'
-			const rgbColor = Colorful.hexToRgb(hexColor)
-			expect(rgbColor).toBe('rgb(255, 255, 255)')
-		})
-	})
-
-	describe('isLightColor method', () => {
-		it('should return true for a light color (HEX format)', () => {
-			const lightHexColor = '#f0f0f0'
-			const isLight = Colorful.isLightColor(lightHexColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (HEX format)', () => {
-			const darkHexColor = '#333333'
-			const isLight = Colorful.isLightColor(darkHexColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should return true for a light color (RGBA format)', () => {
-			const lightRgbaColor = 'rgba(255, 255, 255, 0.5)'
-			const isLight = Colorful.isLightColor(lightRgbaColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (RGBA format)', () => {
-			const darkRgbaColor = 'rgba(0, 0, 0, 0.8)'
-			const isLight = Colorful.isLightColor(darkRgbaColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should return true for a light color (RGB format)', () => {
-			const lightRgbColor = 'rgb(200, 220, 255)'
-			const isLight = Colorful.isLightColor(lightRgbColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (RGB format)', () => {
-			const darkRgbColor = 'rgb(10, 20, 30)'
-			const isLight = Colorful.isLightColor(darkRgbColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should throw an error for an invalid color format', () => {
-			const invalidColor = 'invalid-color'
-			expect(() => Colorful.isLightColor(invalidColor)).toThrowError(
-				"Invalid color format 'invalid-color'. Please provide a valid HEX, RGB, or RGBA color."
-			)
-		})
-	})
-})

package/src/__tests__/formatter.test.ts

@@ -1,96 +0,0 @@
-import { Formatter } from '../lib'
-
-describe('Formatter', () => {
-	describe('toUpperFirst method', () => {
-		it('should format string with - and upper first letter', () => {
-			const formattedString = Formatter.toUpperFirst('hello world')
-			expect(formattedString).toBe('Hello-world')
-		})
-
-		it('should format string with spaces and upper first letter of every word', () => {
-			const formattedString = Formatter.toUpperFirst('hello_world+test')
-			expect(formattedString).toBe('Hello-world-test')
-		})
-
-		it('should throw an error for non-string input', () => {
-			expect(() => Formatter.toUpperFirst(123)).toThrowError(
-				'Provide a valid string'
-			)
-		})
-	})
-
-	describe('camelToKebab method', () => {
-		it('should convert camelCase to kebab-case', () => {
-			const kebabString = Formatter.camelToKebab('camelCaseString')
-			expect(kebabString).toBe('camel-case-string')
-		})
-
-		it('should handle spaces and underscores', () => {
-			const kebabString = Formatter.camelToKebab('hello World_with Spaces')
-			expect(kebabString).toBe('hello-world_with-spaces')
-		})
-
-		it('should throw an error for non-string input', () => {
-			expect(() => Formatter.camelToKebab(123)).toThrowError(
-				'Invalid input. Please provide a valid string.'
-			)
-		})
-	})
-
-	describe('obfuscate method', () => {
-		it('should obfuscate email address', () => {
-			const obfuscatedEmail = Formatter.obfuscate('johndoe@email.com')
-			expect(obfuscatedEmail).toMatch(/^jo.*@.*$/)
-		})
-
-		it('should throw an error for non-string input', () => {
-			//@ts-ignore
-			expect(() => Formatter.obfuscate(123)).toThrowError(
-				'Provide a valid string'
-			)
-		})
-
-		it('should throw an error for an invalid email address', () => {
-			expect(() => Formatter.obfuscate('invalid-email')).toThrowError(
-				'Provide a valid email address'
-			)
-		})
-	})
-
-	describe('toUpperTitle method', () => {
-		it('should capitalize first letter of each word and remove non-alphanumeric characters', () => {
-			const upperTitle = Formatter.toUpperTitle('this is34354345a---sentence')
-			expect(upperTitle).toBe('This Is A Sentence')
-		})
-
-		it('should throw an error for non-string input', () => {
-			expect(() => Formatter.toUpperTitle(123)).toThrowError(
-				'Provide a valid string'
-			)
-		})
-
-		it('should throw an error for empty string', () => {
-			expect(() => Formatter.toUpperTitle('')).toThrowError(
-				'Provide a valid string'
-			)
-		})
-	})
-
-	describe('slugify method', () => {
-		it('should generate a slug from the given string', () => {
-			const slug = Formatter.slugify('Hello World')
-			expect(slug).toBe('hello-world')
-		})
-
-		it('should handle special characters and spaces', () => {
-			const slug = Formatter.slugify('Special Characters % #$ & Space')
-			expect(slug).toBe('special-characters-space')
-		})
-
-		it('should throw an error for non-string input', () => {
-			expect(() => Formatter.slugify(123)).toThrowError(
-				'Provide a valid string'
-			)
-		})
-	})
-})

package/src/__tests__/logger.test.ts

@@ -1,122 +0,0 @@
-import Logger, { isValidLogLevel } from '../lib/logger'
-import { pino } from 'pino'
-
-jest.mock('pino')
-
-const LOGGER_NAME = 'logger-name'
-const PINO_DESTINATION = {}
-const PINO = {
-	info: jest.fn(),
-}
-
-describe('create logger wrapper', () => {
-	test('initially create & configure logger', () => {
-		//@ts-ignore
-		const mock_pino_destination = jest
-			.spyOn(pino, 'destination')
-			//@ts-ignore
-			.mockReturnValue(PINO_DESTINATION)
-		//@ts-ignore
-		const mock_pino = pino.mockReturnValue(PINO)
-
-		/** create logger */
-		const logger = new Logger(LOGGER_NAME)
-
-		expect(logger).toBeDefined()
-		expect(logger['_name']).toBe(LOGGER_NAME)
-		expect(mock_pino).toHaveBeenCalledTimes(1)
-		expect(mock_pino).toHaveBeenCalledWith(
-			{
-				level: 'info',
-				timestamp: expect.any(Function),
-			},
-			PINO_DESTINATION
-		)
-		expect(mock_pino_destination).toHaveBeenCalledWith({
-			minLength: 1024,
-			sync: true,
-		})
-	})
-	test('create repeatedly - stick to pino singleton', () => {
-		//@ts-ignore
-		jest.spyOn(pino, 'destination').mockReturnValue(PINO_DESTINATION)
-		//@ts-ignore
-		const mock_pino = pino.mockReturnValue(PINO)
-		new Logger(LOGGER_NAME)
-		expect(mock_pino).toHaveBeenCalledTimes(1)
-
-		/** create additional logger */
-		new Logger(LOGGER_NAME)
-		/** no new pino created */
-		expect(mock_pino).toHaveBeenCalledTimes(1)
-	})
-})
-describe('validate log level', () => {
-	test('throw on invalid log level', () => {
-		const INVALID_LOG_LEVEL = 'invalid-log-level'
-		expect(() => {
-			isValidLogLevel(INVALID_LOG_LEVEL)
-		}).toThrowError(
-			`Invalid log level "${INVALID_LOG_LEVEL}": only error, warn, info, debug, trace are valid.`
-		)
-	})
-})
-describe('route and format logs', () => {
-	const LOG_EVENT = {
-		code: 'code',
-		msg: 'message',
-	}
-	const DETAILS = {
-		key0: 'val0',
-		key1: 'val1',
-	}
-	test('log info with structured context (single object in context field)', () => {
-		//@ts-ignore
-		jest.spyOn(pino, 'destination').mockReturnValue(PINO_DESTINATION)
-		//@ts-ignore
-		pino.mockReturnValue(PINO)
-		const logger = new Logger(LOGGER_NAME)
-
-		logger.info(LOG_EVENT, DETAILS)
-
-		expect(PINO.info).toHaveBeenCalledWith(
-			expect.objectContaining({
-				component: LOGGER_NAME,
-				code: LOG_EVENT.code,
-				msg: LOG_EVENT.msg,
-				context: { key0: 'val0', key1: 'val1' },
-			})
-		)
-	})
-
-	test('remap reserved elastic field names in context', () => {
-		//@ts-ignore
-		jest.spyOn(pino, 'destination').mockReturnValue(PINO_DESTINATION)
-		//@ts-ignore
-		pino.mockReturnValue(PINO)
-		const logger = new Logger(LOGGER_NAME)
-
-		logger.info(LOG_EVENT, {
-			_id: 'abc123',
-			nested: {
-				_id: 'nested-1',
-				_index: 'bad-index',
-			},
-		})
-
-		// Context holds sanitized structure; reserved names remapped recursively
-		expect(PINO.info).toHaveBeenCalledWith(
-			expect.objectContaining({
-				context: expect.objectContaining({
-					mongo_id: 'abc123',
-					nested: { mongo_id: 'nested-1', es_index: 'bad-index' },
-				}),
-			})
-		)
-		expect(PINO.info).not.toHaveBeenCalledWith(
-			expect.objectContaining({
-				_id: expect.anything(),
-			})
-		)
-	})
-})

package/src/env.d.ts

@@ -1,9 +0,0 @@
-declare namespace NodeJS {
-	export interface ProcessEnv {
-		NODE_ENV: 'development' | 'production' | 'test' | 'local'
-		ELASTICSEARCH_NODE: string
-		ELASTICSEARCH_USERNAME: string
-		ELASTICSEARCH_PASSWORD: string
-		LOG_LEVEL: string
-	}
-}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './lib'

package/src/lib/colorful.ts

@@ -1,167 +0,0 @@
-/*
-	 Author : Mhmd Hammoud https://github.com/mhmdhammoud
-	 Date : 2024-01-20
-	 Description : Color adapter
-	 Version : 1.0
-*/
-class Colorful {
-	/**
-	 * @remarks
-	 *  Receives a color in RGB format and returns it in HEX format
-	 * @param color - Color in RGB format
-	 * @example
-	 * ```ts
-	 * const color = 'rgb(255, 255, 255)';
-	 * const hexColor = rgbToHex(color);
-	 * console.log(hexColor) // #ffffff
-	 * ```
-	 *
-	 * @returns Color in HEX format string
-	 */
-	rgbToHex = (color: string): string => {
-		const componentToHex = (c: any) => {
-			const hex = c.toString(16)
-			return hex.length == 1 ? '0' + hex : hex
-		}
-
-		const rgbaMatch = color.match(
-			/rgba\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3}),\s*((\d+\.)?\d+)\)/
-		)
-		const rgbMatch = color.match(/rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)/)
-
-		let redColor, greenColor, blueColor
-
-		if (rgbaMatch) {
-			redColor = parseInt(rgbaMatch[1], 10)
-			greenColor = parseInt(rgbaMatch[2], 10)
-			blueColor = parseInt(rgbaMatch[3], 10)
-		} else if (rgbMatch) {
-			redColor = parseInt(rgbMatch[1], 10)
-			greenColor = parseInt(rgbMatch[2], 10)
-			blueColor = parseInt(rgbMatch[3], 10)
-		} else {
-			// Both patterns failed to match
-			throw new Error(
-				`Invalid color format '${color}'. Please provide a valid RGB or RGBA color.`
-			)
-		}
-
-		const hexColor =
-			'#' +
-			componentToHex(redColor) +
-			componentToHex(greenColor) +
-			componentToHex(blueColor)
-
-		return hexColor
-	}
-
-	/**
-	 * @remarks
-	 *  Receives a color in HEX format and returns it in RGB format
-	 * @param hexColor - Color in HEX format
-	 * @example
-	 * ```ts
-	 * const hexColor = '#ffffff';
-	 * const rgbColor = hexToRgb(hexColor);
-	 * console.log(rgbColor) // 'rgb(255, 255, 255)'
-	 * ```
-	 *
-	 * @returns Color in RGB format string
-	 */
-	hexToRgb = (hexColor: string): string => {
-		const hex = hexColor.replace(/^#/, '')
-		const bigint = parseInt(hex, 16)
-		const red = (bigint >> 16) & 255
-		const green = (bigint >> 8) & 255
-		const blue = bigint & 255
-		return `rgb(${red}, ${green}, ${blue})`
-	}
-
-	/**
-	 * @remarks
-	 *  Checks whether a given HEX color is light or dark
-	 * @param hexColor - Color in HEX format
-	 * @example
-	 * ```ts
-	 * const hexColor = '#ffffff';
-	 * const isLight = isLightColor(hexColor);
-	 * console.log(isLight); // true or false
-	 * ```
-	 *
-	 * @returns True if the color is light, false if it is dark
-	 */
-	isLightColor = (color: string): boolean => {
-		// Remove spaces
-		const trimmedColor = color.replace(/\s/g, '')
-
-		// Check if the color is in RGBA format
-		const rgbaMatch = trimmedColor.match(
-			/^rgba\((\d+),(\d+),(\d+),(\d+(\.\d+)?)\)$/
-		)
-
-		if (rgbaMatch) {
-			// Extract RGB components from RGBA
-			const r = parseInt(rgbaMatch[1], 10)
-			const g = parseInt(rgbaMatch[2], 10)
-			const b = parseInt(rgbaMatch[3], 10)
-
-			// Calculate the relative luminance without considering alpha
-			const luminance = 0.299 * r + 0.587 * g + 0.114 * b
-
-			// You can adjust the threshold to your preference
-			const threshold = 128
-
-			// Determine whether the color is light or dark
-			return luminance > threshold
-		}
-
-		// Check if the color is in RGB format
-		const rgbMatch = trimmedColor.match(/^rgb\((\d+),(\d+),(\d+)\)$/)
-
-		if (rgbMatch) {
-			// Extract RGB components from RGB
-			const r = parseInt(rgbMatch[1], 10)
-			const g = parseInt(rgbMatch[2], 10)
-			const b = parseInt(rgbMatch[3], 10)
-
-			// Calculate the relative luminance of the color
-			// This formula gives more weight to green as the human eye is more sensitive to it
-			const luminance = 0.299 * r + 0.587 * g + 0.114 * b
-
-			// You can adjust the threshold to your preference
-			const threshold = 128
-
-			// Determine whether the color is light or dark
-			return luminance > threshold
-		}
-
-		// Remove the '#' character if present
-		const hexColor = trimmedColor.replace('#', '')
-
-		// Check if the hex color has a valid format
-		if (!/^[0-9A-Fa-f]{6}$/.test(hexColor)) {
-			throw new Error(
-				`Invalid color format '${color}'. Please provide a valid HEX, RGB, or RGBA color.`
-			)
-		}
-
-		// Convert the hex color to RGB components
-		const r = parseInt(hexColor.slice(0, 2), 16)
-		const g = parseInt(hexColor.slice(2, 4), 16)
-		const b = parseInt(hexColor.slice(4, 6), 16)
-
-		// Calculate the relative luminance of the color
-		// This formula gives more weight to green as the human eye is more sensitive to it
-		const luminance = 0.299 * r + 0.587 * g + 0.114 * b
-
-		// You can adjust the threshold to your preference
-		const threshold = 128
-
-		// Determine whether the color is light or dark
-		return luminance > threshold
-	}
-}
-
-const colorful = new Colorful()
-
-export default colorful