core-services-sdk 1.3.55 → 1.3.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.55",
+  "version": "1.3.56",
   "main": "src/index.js",
   "type": "module",
   "types": "types/index.d.ts",
@@ -34,6 +34,7 @@
     "google-libphonenumber": "^3.2.42",
     "http-status": "^2.1.0",
     "knex": "^3.1.0",
+    "lodash-es": "^4.17.21",
     "mongodb": "^6.18.0",
     "nodemailer": "^7.0.5",
     "p-retry": "^7.0.0",

package/src/core/case-mapper.js

@@ -0,0 +1,60 @@
+import { mapKeys, snakeCase, camelCase } from 'lodash-es'
+import { sanitizeObjectAllowProps } from './sanitize-objects.js'
+
+/**
+ * Converts object keys from camelCase to snake_case.
+ *
+ * Optionally restricts the conversion to a whitelist of allowed properties.
+ * If no allowed properties are provided, all object keys are converted.
+ *
+ * @param {Object} obj - The source object with camelCase keys.
+ * @param {...string|string[]} allowedProps - Optional list (or arrays) of allowed property names.
+ * @returns {Object} A new object with keys converted to snake_case.
+ *
+ * @example
+ * toSnakeCase({ userId: '1', createdAt: 'now' })
+ * // { user_id: '1', created_at: 'now' }
+ *
+ * @example
+ * toSnakeCase({ userId: '1', createdAt: 'now' }, ['userId'])
+ * // { user_id: '1' }
+ */
+export function toSnakeCase(obj, ...allowedProps) {
+  const allowedPropsFixed = allowedProps.flat()
+  const objFiltered = allowedPropsFixed.length
+    ? sanitizeObjectAllowProps(obj, allowedPropsFixed)
+    : obj
+
+  return mapKeys(objFiltered, (_value, key) => {
+    return snakeCase(key)
+  })
+}
+
+/**
+ * Converts object keys from snake_case to camelCase.
+ *
+ * Optionally restricts the conversion to a whitelist of allowed properties.
+ * If no allowed properties are provided, all object keys are converted.
+ *
+ * @param {Object} obj - The source object with snake_case keys.
+ * @param {...string|string[]} allowedProps - Optional list (or arrays) of allowed property names.
+ * @returns {Object} A new object with keys converted to camelCase.
+ *
+ * @example
+ * toCamelCase({ user_id: '1', created_at: 'now' })
+ * // { userId: '1', createdAt: 'now' }
+ *
+ * @example
+ * toCamelCase({ user_id: '1', created_at: 'now' }, ['user_id'])
+ * // { userId: '1' }
+ */
+export function toCamelCase(obj, ...allowedProps) {
+  const allowedPropsFixed = allowedProps.flat()
+  const objFiltered = allowedPropsFixed.length
+    ? sanitizeObjectAllowProps(obj, allowedPropsFixed)
+    : obj
+
+  return mapKeys(objFiltered, (_value, key) => {
+    return camelCase(key)
+  })
+}

package/src/core/index.js

@@ -1,4 +1,5 @@
 export * from './regex-utils.js'
+export * from './case-mapper.js'
 export * from './otp-generators.js'
 export * from './sanitize-objects.js'
 export * from './normalize-min-max.js'

package/tests/core/case-mapper.unit.test.js

@@ -0,0 +1,111 @@
+import { describe, it, expect } from 'vitest'
+
+import { toSnakeCase, toCamelCase } from '../../src/core/case-mapper.js'
+
+describe('toSnakeCase', () => {
+  it('converts all keys from camelCase to snake_case', () => {
+    const input = {
+      userId: '1',
+      createdAt: 'now',
+    }
+
+    const result = toSnakeCase(input)
+
+    expect(result).toEqual({
+      user_id: '1',
+      created_at: 'now',
+    })
+  })
+
+  it('converts only allowed properties when allowedProps are provided', () => {
+    const input = {
+      userId: '1',
+      createdAt: 'now',
+    }
+
+    const result = toSnakeCase(input, ['userId'])
+
+    expect(result).toEqual({
+      user_id: '1',
+    })
+  })
+
+  it('supports allowedProps passed as multiple arguments', () => {
+    const input = {
+      userId: '1',
+      createdAt: 'now',
+      updatedAt: 'later',
+    }
+
+    const result = toSnakeCase(input, 'userId', 'updatedAt')
+
+    expect(result).toEqual({
+      user_id: '1',
+      updated_at: 'later',
+    })
+  })
+
+  it('returns an empty object when allowedProps do not match any keys', () => {
+    const input = {
+      userId: '1',
+    }
+
+    const result = toSnakeCase(input, ['nonExistingKey'])
+
+    expect(result).toEqual({})
+  })
+})
+
+describe('toCamelCase', () => {
+  it('converts all keys from snake_case to camelCase', () => {
+    const input = {
+      user_id: '1',
+      created_at: 'now',
+    }
+
+    const result = toCamelCase(input)
+
+    expect(result).toEqual({
+      userId: '1',
+      createdAt: 'now',
+    })
+  })
+
+  it('converts only allowed properties when allowedProps are provided', () => {
+    const input = {
+      user_id: '1',
+      created_at: 'now',
+    }
+
+    const result = toCamelCase(input, ['user_id'])
+
+    expect(result).toEqual({
+      userId: '1',
+    })
+  })
+
+  it('supports allowedProps passed as multiple arguments', () => {
+    const input = {
+      user_id: '1',
+      created_at: 'now',
+      updated_at: 'later',
+    }
+
+    const result = toCamelCase(input, 'user_id', 'updated_at')
+
+    expect(result).toEqual({
+      userId: '1',
+      updatedAt: 'later',
+    })
+  })
+
+  it('returns an empty object when allowedProps do not match any keys', () => {
+    const input = {
+      user_id: '1',
+    }
+
+    const result = toCamelCase(input, ['non_existing_key'])
+
+    expect(result).toEqual({})
+  })
+})

package/types/core/case-mapper.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Converts object keys from camelCase to snake_case.
+ *
+ * Optionally restricts the conversion to a whitelist of allowed properties.
+ * If no allowed properties are provided, all object keys are converted.
+ *
+ * @param {Object} obj - The source object with camelCase keys.
+ * @param {...string|string[]} allowedProps - Optional list (or arrays) of allowed property names.
+ * @returns {Object} A new object with keys converted to snake_case.
+ *
+ * @example
+ * toSnakeCase({ userId: '1', createdAt: 'now' })
+ * // { user_id: '1', created_at: 'now' }
+ *
+ * @example
+ * toSnakeCase({ userId: '1', createdAt: 'now' }, ['userId'])
+ * // { user_id: '1' }
+ */
+export function toSnakeCase(
+  obj: any,
+  ...allowedProps: (string | string[])[]
+): any
+/**
+ * Converts object keys from snake_case to camelCase.
+ *
+ * Optionally restricts the conversion to a whitelist of allowed properties.
+ * If no allowed properties are provided, all object keys are converted.
+ *
+ * @param {Object} obj - The source object with snake_case keys.
+ * @param {...string|string[]} allowedProps - Optional list (or arrays) of allowed property names.
+ * @returns {Object} A new object with keys converted to camelCase.
+ *
+ * @example
+ * toCamelCase({ user_id: '1', created_at: 'now' })
+ * // { userId: '1', createdAt: 'now' }
+ *
+ * @example
+ * toCamelCase({ user_id: '1', created_at: 'now' }, ['user_id'])
+ * // { userId: '1' }
+ */
+export function toCamelCase(
+  obj: any,
+  ...allowedProps: (string | string[])[]
+): any

package/types/core/index.d.ts

@@ -1,4 +1,5 @@
 export * from './regex-utils.js'
+export * from './case-mapper.js'
 export * from './otp-generators.js'
 export * from './sanitize-objects.js'
 export * from './normalize-min-max.js'