@pixpilot/object 2.3.0 → 2.4.1

package/README.md

@@ -25,6 +25,10 @@ const obj = { user_name: 'john', user_details: { first_name: 'John' } };
 const camelCaseObj = keysToCamelCase(obj);
 // { userName: 'john', userDetails: { firstName: 'John' } }
 
+const guidSafeObj = keysToCamelCase(obj, {
+  shouldConvert: (key) => key !== 'legacy_key',
+});
+
 // Manipulate objects
 const picked = pick({ a: 1, b: 2, c: 3 }, ['a', 'c']); // { a: 1, c: 3 }
 const omitted = omit({ a: 1, b: 2, c: 3 }, ['b']); // { a: 1, c: 3 }
@@ -48,7 +52,7 @@ if (isObject(value)) {
 
 ### Key Transformation
 
-- `keysToCamelCase<T>(obj: T): KeysToCamelCase<T>` - Convert all keys to camelCase
+- `keysToCamelCase<T>(obj: T, options?: { shouldConvert?: (key: string) => boolean }): KeysToCamelCase<T>` - Convert keys to camelCase, except GUID keys and keys rejected by `shouldConvert`
 - `keysToSnakeCase<T>(obj: T): KeysToSnakeCase<T>` - Convert all keys to snake_case
 
 ### Object Manipulation

package/dist/index.d.cts

@@ -3,9 +3,9 @@ import { deepMerge, deepMergeMany } from "./deep-merge.cjs";
 import { deleteObjectPropertyByPath as deleteProperty } from "./delete-object-property-by-path.cjs";
 import { getObjectValueByPath as getProperty } from "./get-object-value-by-path.cjs";
 import { hasObjectValueByPath as hasProperty } from "./has-object-value-by-path.cjs";
-import { KeysToCamelCase, ToCamelCase, keysToCamelCase } from "./keys-to-camel-case.cjs";
+import { KeysToCamelCase, KeysToCamelCaseOptions, ToCamelCase, keysToCamelCase } from "./keys-to-camel-case.cjs";
 import { KeysToSnakeCase, ToSnakeCase, keysToSnakeCase } from "./keys-to-snake-case.cjs";
 import { deepClone, deepEqual, deleteProperty as deleteProperty$1, escapePath, flatKeys, getProperty as getProperty$1, hasProperty as hasProperty$1, mapKeys, mapValues, omit, parsePath, pick, setProperty, stringifyPath, unflatten } from "./manipulation.cjs";
 import { setObjectValueByPath } from "./set-object-value-by-path.cjs";
 import { isEmptyObject, isObject, isPlainObject } from "./type-guards.cjs";
-export { CleanOptions, KeysToCamelCase, KeysToSnakeCase, ToCamelCase, ToSnakeCase, cleanObject, deepClone, deepEqual, deepMerge, deepMergeMany, deleteProperty as deleteObjectPropertyByPath, deleteProperty$1 as deleteProperty, escapePath, flatKeys, getProperty as getObjectValueByPath, getProperty$1 as getProperty, hasProperty as hasObjectValueByPath, hasProperty$1 as hasProperty, isEmptyObject, isObject, isPlainObject, keysToCamelCase, keysToSnakeCase, mapKeys, mapValues, omit, parsePath, pick, setObjectValueByPath, setProperty, stringifyPath, unflatten };
+export { CleanOptions, KeysToCamelCase, KeysToCamelCaseOptions, KeysToSnakeCase, ToCamelCase, ToSnakeCase, cleanObject, deepClone, deepEqual, deepMerge, deepMergeMany, deleteProperty as deleteObjectPropertyByPath, deleteProperty$1 as deleteProperty, escapePath, flatKeys, getProperty as getObjectValueByPath, getProperty$1 as getProperty, hasProperty as hasObjectValueByPath, hasProperty$1 as hasProperty, isEmptyObject, isObject, isPlainObject, keysToCamelCase, keysToSnakeCase, mapKeys, mapValues, omit, parsePath, pick, setObjectValueByPath, setProperty, stringifyPath, unflatten };

package/dist/index.d.ts

@@ -3,9 +3,9 @@ import { deepMerge, deepMergeMany } from "./deep-merge.js";
 import { deleteObjectPropertyByPath as deleteProperty } from "./delete-object-property-by-path.js";
 import { getObjectValueByPath as getProperty } from "./get-object-value-by-path.js";
 import { hasObjectValueByPath as hasProperty } from "./has-object-value-by-path.js";
-import { KeysToCamelCase, ToCamelCase, keysToCamelCase } from "./keys-to-camel-case.js";
+import { KeysToCamelCase, KeysToCamelCaseOptions, ToCamelCase, keysToCamelCase } from "./keys-to-camel-case.js";
 import { KeysToSnakeCase, ToSnakeCase, keysToSnakeCase } from "./keys-to-snake-case.js";
 import { deepClone, deepEqual, deleteProperty as deleteProperty$1, escapePath, flatKeys, getProperty as getProperty$1, hasProperty as hasProperty$1, mapKeys, mapValues, omit, parsePath, pick, setProperty, stringifyPath, unflatten } from "./manipulation.js";
 import { setObjectValueByPath } from "./set-object-value-by-path.js";
 import { isEmptyObject, isObject, isPlainObject } from "./type-guards.js";
-export { CleanOptions, KeysToCamelCase, KeysToSnakeCase, ToCamelCase, ToSnakeCase, cleanObject, deepClone, deepEqual, deepMerge, deepMergeMany, deleteProperty as deleteObjectPropertyByPath, deleteProperty$1 as deleteProperty, escapePath, flatKeys, getProperty as getObjectValueByPath, getProperty$1 as getProperty, hasProperty as hasObjectValueByPath, hasProperty$1 as hasProperty, isEmptyObject, isObject, isPlainObject, keysToCamelCase, keysToSnakeCase, mapKeys, mapValues, omit, parsePath, pick, setObjectValueByPath, setProperty, stringifyPath, unflatten };
+export { CleanOptions, KeysToCamelCase, KeysToCamelCaseOptions, KeysToSnakeCase, ToCamelCase, ToSnakeCase, cleanObject, deepClone, deepEqual, deepMerge, deepMergeMany, deleteProperty as deleteObjectPropertyByPath, deleteProperty$1 as deleteProperty, escapePath, flatKeys, getProperty as getObjectValueByPath, getProperty$1 as getProperty, hasProperty as hasObjectValueByPath, hasProperty$1 as hasProperty, isEmptyObject, isObject, isPlainObject, keysToCamelCase, keysToSnakeCase, mapKeys, mapValues, omit, parsePath, pick, setObjectValueByPath, setProperty, stringifyPath, unflatten };

package/dist/keys-to-camel-case.cjs

@@ -1,15 +1,21 @@
 const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+let __pixpilot_guid = require("@pixpilot/guid");
+__pixpilot_guid = require_rolldown_runtime.__toESM(__pixpilot_guid);
 let __pixpilot_string = require("@pixpilot/string");
 __pixpilot_string = require_rolldown_runtime.__toESM(__pixpilot_string);
 
 //#region src/keys-to-camel-case.ts
-function keysToCamelCase(obj) {
-	if (Array.isArray(obj)) return obj.map(keysToCamelCase);
+function shouldConvertKey(key, options) {
+	if ((0, __pixpilot_guid.isGuidString)(key)) return false;
+	return options?.shouldConvert?.(key) !== false;
+}
+function keysToCamelCase(obj, options) {
+	if (Array.isArray(obj)) return obj.map((value) => keysToCamelCase(value, options));
 	if (obj === null || typeof obj !== "object") return obj;
 	const result = {};
 	for (const [key, value] of Object.entries(obj)) {
-		const camelKey = (0, __pixpilot_string.toCamelCase)(key);
-		result[camelKey] = keysToCamelCase(value);
+		const camelKey = shouldConvertKey(key, options) ? (0, __pixpilot_string.toCamelCase)(key) : key;
+		result[camelKey] = keysToCamelCase(value, options);
 	}
 	return result;
 }

package/dist/keys-to-camel-case.d.cts

@@ -1,4 +1,7 @@
 //#region src/keys-to-camel-case.d.ts
+interface KeysToCamelCaseOptions {
+  shouldConvert?: (key: string) => boolean;
+}
 type CamelizeSegment<S extends string> = S extends '' ? '' : Capitalize<Lowercase<S>>;
 /**
  * Convert snake_case to camelCase at the type level.
@@ -12,6 +15,6 @@ type ToCamelCase<S extends string, IsFirst extends boolean = true> = S extends `
 type Builtin = Date | RegExp | Map<unknown, unknown> | Set<unknown> | WeakMap<object, unknown> | WeakSet<object>;
 type TupleToCamelCase<T extends readonly unknown[]> = { [I in keyof T]: KeysToCamelCase<T[I]> };
 type KeysToCamelCase<T> = T extends Builtin ? T : T extends ((...args: unknown[]) => unknown) ? T : T extends readonly unknown[] ? number extends T['length'] ? KeysToCamelCase<T[number]>[] : TupleToCamelCase<T> : T extends object ? { [K in keyof T as K extends string ? ToCamelCase<K> : K]: KeysToCamelCase<T[K]> } : T;
-declare function keysToCamelCase<T>(obj: T): KeysToCamelCase<T>;
+declare function keysToCamelCase<T>(obj: T, options?: KeysToCamelCaseOptions): KeysToCamelCase<T>;
 //#endregion
-export { KeysToCamelCase, ToCamelCase, keysToCamelCase };
+export { KeysToCamelCase, KeysToCamelCaseOptions, ToCamelCase, keysToCamelCase };

package/dist/keys-to-camel-case.d.ts

@@ -1,4 +1,7 @@
 //#region src/keys-to-camel-case.d.ts
+interface KeysToCamelCaseOptions {
+  shouldConvert?: (key: string) => boolean;
+}
 type CamelizeSegment<S extends string> = S extends '' ? '' : Capitalize<Lowercase<S>>;
 /**
  * Convert snake_case to camelCase at the type level.
@@ -12,6 +15,6 @@ type ToCamelCase<S extends string, IsFirst extends boolean = true> = S extends `
 type Builtin = Date | RegExp | Map<unknown, unknown> | Set<unknown> | WeakMap<object, unknown> | WeakSet<object>;
 type TupleToCamelCase<T extends readonly unknown[]> = { [I in keyof T]: KeysToCamelCase<T[I]> };
 type KeysToCamelCase<T> = T extends Builtin ? T : T extends ((...args: unknown[]) => unknown) ? T : T extends readonly unknown[] ? number extends T['length'] ? KeysToCamelCase<T[number]>[] : TupleToCamelCase<T> : T extends object ? { [K in keyof T as K extends string ? ToCamelCase<K> : K]: KeysToCamelCase<T[K]> } : T;
-declare function keysToCamelCase<T>(obj: T): KeysToCamelCase<T>;
+declare function keysToCamelCase<T>(obj: T, options?: KeysToCamelCaseOptions): KeysToCamelCase<T>;
 //#endregion
-export { KeysToCamelCase, ToCamelCase, keysToCamelCase };
+export { KeysToCamelCase, KeysToCamelCaseOptions, ToCamelCase, keysToCamelCase };

package/dist/keys-to-camel-case.js

@@ -1,13 +1,18 @@
+import { isGuidString } from "@pixpilot/guid";
 import { toCamelCase } from "@pixpilot/string";
 
 //#region src/keys-to-camel-case.ts
-function keysToCamelCase(obj) {
-	if (Array.isArray(obj)) return obj.map(keysToCamelCase);
+function shouldConvertKey(key, options) {
+	if (isGuidString(key)) return false;
+	return options?.shouldConvert?.(key) !== false;
+}
+function keysToCamelCase(obj, options) {
+	if (Array.isArray(obj)) return obj.map((value) => keysToCamelCase(value, options));
 	if (obj === null || typeof obj !== "object") return obj;
 	const result = {};
 	for (const [key, value] of Object.entries(obj)) {
-		const camelKey = toCamelCase(key);
-		result[camelKey] = keysToCamelCase(value);
+		const camelKey = shouldConvertKey(key, options) ? toCamelCase(key) : key;
+		result[camelKey] = keysToCamelCase(value, options);
 	}
 	return result;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/object",
   "type": "module",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "A collection of utility functions for object manipulation and transformation.",
   "author": "Pixpilot <m.doaie@hotmail.com>",
   "license": "MIT",
@@ -27,7 +27,8 @@
   "dependencies": {
     "@fastify/deepmerge": "^3.1.0",
     "dot-prop": "^10.1.0",
-    "@pixpilot/string": "2.4.0"
+    "@pixpilot/guid": "0.0.0",
+    "@pixpilot/string": "2.5.0"
   },
   "devDependencies": {
     "@manypkg/get-packages": "^3.1.0",
@@ -35,9 +36,9 @@
     "eslint": "^9.37.0",
     "tsdown": "^0.15.8",
     "typescript": "^5.9.3",
+    "@internal/eslint-config": "0.3.0",
     "@internal/prettier-config": "0.0.1",
     "@internal/tsconfig": "0.1.0",
-    "@internal/eslint-config": "0.3.0",
     "@internal/tsdown-config": "0.1.0",
     "@internal/vitest-config": "0.1.0"
   },