patch-recorder 0.1.0 → 0.2.0

package/src/utils.ts

@@ -1,4 +1,4 @@
-import type {PatchesOptions, GetItemIdConfig, GetItemIdFunction} from './types.js';
+import type {GetItemIdConfig, GetItemIdFunction, PatchPath} from './types.js';
 
 /**
  * Type guard to check if a value is a plain object (not null, not array, not Map/Set)
@@ -37,25 +37,12 @@ export function isSet(value: unknown): value is Set<unknown> {
 /**
  * Format a path array to either array format or JSON Pointer string format
  */
-export function formatPath(
-	path: (string | number)[],
-	options: {internalPatchesOptions: PatchesOptions},
-): string | (string | number)[] {
-	if (
-		options.internalPatchesOptions &&
-		typeof options.internalPatchesOptions === 'object' &&
-		options.internalPatchesOptions.pathAsArray === false
-	) {
-		// Convert to JSON Pointer string format (RFC 6901)
-		if (path.length === 0) {
-			return '';
-		}
-		return '/' + path
-			.map((part) => String(part).replace(/~/g, '~0').replace(/\//g, '~1'))
-			.join('/');
+export function formatPath(path: PatchPath): string {
+	// Convert to JSON Pointer string format (RFC 6901)
+	if (path.length === 0) {
+		return '';
 	}
-
-	return path;
+	return '/' + path.map((part) => String(part).replace(/~/g, '~0').replace(/\//g, '~1')).join('/');
 }
 
 /**
@@ -148,16 +135,16 @@ export function cloneIfNeeded<T>(value: T): T {
 }
 
 /**
-	* Find a getItemId function for a given path.
-	* The function is looked up by traversing the getItemId config object
-	* using the parent path (all elements except the last one).
-	*
-	* @example
-	* // For path ['items', 3] with config { items: (item) => item.id }
-	* // Returns the function (item) => item.id
-	*/
+ * Find a getItemId function for a given path.
+ * The function is looked up by traversing the getItemId config object
+ * using the parent path (all elements except the last one).
+ *
+ * @example
+ * // For path ['items', 3] with config { items: (item) => item.id }
+ * // Returns the function (item) => item.id
+ */
 export function findGetItemIdFn(
-	path: (string | number)[],
+	path: PatchPath,
 	getItemIdConfig: GetItemIdConfig | undefined,
 ): GetItemIdFunction | undefined {
 	if (!getItemIdConfig || path.length === 0) {
@@ -190,6 +177,11 @@ export function findGetItemIdFn(
 			return undefined;
 		}
 
+		if (typeof key === 'object' || typeof key === 'symbol') {
+			// there is no way to match an object or symbol key in the config
+			return undefined;
+		}
+
 		current = (current as GetItemIdConfig)[key];
 	}
 
@@ -200,3 +192,64 @@ export function findGetItemIdFn(
 
 	return undefined;
 }
+
+/**
+ * Convert a path array or string to a string key for optimized lookup.
+ * Uses null character (\x00) as delimiter since it's unlikely in property names.
+ * This is significantly faster than JSON.stringify for the common case.
+ *
+ * @param path - The path array or string to convert
+ * @returns A string key representation of the path
+ */
+export function pathToKey(path: PatchPath): string {
+	// If path is already a string, use it directly
+	if (typeof path === 'string') {
+		return path;
+	}
+	// Otherwise convert array to string
+	if (path.length === 0) {
+		return '';
+	}
+	if (path.length === 1) {
+		const elem = path[0];
+		if (typeof elem === 'symbol') {
+			return elem.toString();
+		}
+		if (typeof elem === 'object') {
+			return JSON.stringify(elem);
+		}
+		return String(elem);
+	}
+	return path.map((elem) => {
+		if (typeof elem === 'symbol') {
+			return elem.toString();
+		}
+		if (typeof elem === 'object') {
+			return JSON.stringify(elem);
+		}
+		return String(elem);
+	}).join('\x00');
+}
+
+/**
+ * Convert a string key back to a path array.
+ * This is the inverse of pathToKey.
+ *
+ * @param key - The string key to convert
+ * @returns The path array
+ */
+export function keyToPath(key: string): (string | number)[] {
+	if (key === '') {
+		return [];
+	}
+	if (key.indexOf('\x00') === -1) {
+		// No delimiter, single element
+		// Try to parse as number for consistency
+		const num = Number(key);
+		return isNaN(num) ? [key] : [num];
+	}
+	return key.split('\x00').map((part) => {
+		const num = Number(part);
+		return isNaN(num) ? part : num;
+	});
+}