feat(object): ✨ Improve renamer parameter (#83)

Author: xeho91

.changeset/tender-rabbits-prove.md

@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-object": minor
+---
+
+Add `index` to `renameObjectKeys()`-> `renamer(key, index)`

packages/object/source/keys/keys.test.ts

@@ -1,29 +1,52 @@
-import { returns } from "@terminal-nerds/snippets-test/unit";
+import { SAMPLE_PRIMITIVES } from "@terminal-nerds/snippets-test/sample";
+import { returns, throws } from "@terminal-nerds/snippets-test/unit";
 import { describe, it } from "vitest";
+import { ZodError } from "zod";
 
 import { renameObjectKeys } from "./keys.ts";
 
 const SAMPLE_OBJECT = {
-	1: "one",
+	one: "one",
 	two: 2,
-	3: "threethree",
+	three: "threethree",
 	four: "444444",
-	5: 5,
+	five: 5,
 } as const;
 
 describe("renameObjectKeys(object, renamer)", () => {
+	it(throws(ZodError).on(`passed non-object`).samples(SAMPLE_PRIMITIVES), ({ expect }) => {
+		for (const sample of SAMPLE_PRIMITIVES) {
+			// @ts-ignore Testing
+			expect(() => renameObjectKeys(sample, (key) => key)).toThrowError(ZodError);
+		}
+	});
+
+	it(
+		throws(ZodError)
+			.on(`passed sample object`)
+			.sample(SAMPLE_OBJECT)
+			.and(`with renamer returning non-string value`),
+		({ expect }) => {
+			// @ts-ignore Testing
+			expect(() => renameObjectKeys(SAMPLE_OBJECT, () => void 0)).toThrowError(ZodError);
+		},
+	);
+
 	const expected = {
-		"11": "one",
-		"two1": 2,
-		"31": "threethree",
-		"four1": "444444",
-		"51": 5,
+		one1: "one",
+		two2: 2,
+		three3: "threethree",
+		four4: "444444",
+		five5: 5,
 	} as const;
 
 	it(
-		returns(expected).on(`passed sample object`).sample(SAMPLE_OBJECT).and(`with renamer appending 1 to each key`),
+		returns(expected)
+			.on(`passed sample object`)
+			.sample(SAMPLE_OBJECT)
+			.and(`with renamer appending {index + 1} to each key`),
 		({ expect }) => {
-			expect(renameObjectKeys(SAMPLE_OBJECT, (key) => `${key}1` as const)).toEqual(expected);
+			expect(renameObjectKeys(SAMPLE_OBJECT, (key, index) => `${key}${index + 1}` as const)).toEqual(expected);
 		},
 	);
 });

packages/object/source/keys/keys.ts

@@ -1,18 +1,28 @@
 import { z } from "zod";
 
+import { validateObject } from "../schema/schema.ts";
+
 export const OBJECT_KEY_SCHEMA = z.number().or(z.string()).or(z.symbol());
 
-const RENAMER_SCHEMA = z.function().args(OBJECT_KEY_SCHEMA).returns(OBJECT_KEY_SCHEMA);
+const RENAMER_SCHEMA = z.function().args(OBJECT_KEY_SCHEMA, z.number().optional()).returns(OBJECT_KEY_SCHEMA);
 
 export type ObjectKey = number | string | symbol;
 
 export function renameObjectKeys<OldKey extends ObjectKey, Value, NewKey extends ObjectKey>(
 	object: Record<OldKey, Value>,
-	renamer: (key: OldKey) => NewKey,
+	renamer: (key: OldKey, index: number) => NewKey,
 ): Record<NewKey, Value> {
+	validateObject(object);
 	RENAMER_SCHEMA.parse(renamer);
 
+	function handleRename(key: OldKey, index: number) {
+		return OBJECT_KEY_SCHEMA.parse(renamer(key, index));
+	}
+
 	return Object.fromEntries(
-		(Object.entries(object) as Array<[OldKey, Value]>).map(([key, value]) => [renamer(key), value]),
+		(Object.entries(object) as Array<[OldKey, Value]>).map(([key, value], index) => [
+			handleRename(key, index),
+			value,
+		]),
 	) as Record<NewKey, Value>;
 }