relation-matcher 1.0.12 → 1.1.0

package/package.json

@@ -1,36 +1,36 @@
-{
-	"name": "relation-matcher",
-	"version": "1.0.12",
-	"description": "A utility to convert table data (such as out of a SQL query) into structured JSON.",
-	"license": "ISC",
-	"author": "",
-	"type": "module",
-	"main": "dist/src/index.js",
-	"types": "dist/src/index.d.ts",
-	"exports": {
-		".": {
-			"default": "./dist/src/index.js",
-			"types": "./dist/src/index.d.ts"
-		},
-		"./types": {
-			"default": "./dist/src/types/index.js",
-			"types": "./dist/src/types/index.d.ts"
-		},
-		"./source": "./src/index.ts",
-		"./source/types": "./src/types/index.ts"
-	},
-	"scripts": {
-		"test": "jest && tsc --noEmit",
-		"file-output": "tsx --watch src/file-output.ts",
-		"build": "tsc",
-		"build:publish": "yarn run test && yarn run build && npm publish"
-	},
-	"packageManager": "yarn@4.13.0",
-	"devDependencies": {
-		"@types/jest": "^30.0.0",
-		"@types/node": "^25.0.10",
-		"jest": "^30.2.0",
-		"ts-jest": "^29.4.6",
-		"typescript": "^5.9.3"
-	}
-}
+{
+	"name": "relation-matcher",
+	"version": "1.1.0",
+	"description": "A utility to convert table data (such as out of a SQL query) into structured JSON.",
+	"license": "ISC",
+	"author": "",
+	"type": "module",
+	"main": "dist/src/index.js",
+	"types": "dist/src/index.d.ts",
+	"exports": {
+		".": {
+			"default": "./dist/src/index.js",
+			"types": "./dist/src/index.d.ts"
+		},
+		"./types": {
+			"default": "./dist/src/types/index.js",
+			"types": "./dist/src/types/index.d.ts"
+		},
+		"./source": "./src/index.ts",
+		"./source/types": "./src/types/index.ts"
+	},
+	"scripts": {
+		"test": "jest && tsc --noEmit",
+		"file-output": "tsx --watch src/file-output.ts",
+		"build": "tsc",
+		"build:publish": "yarn run test && yarn run build && npm publish"
+	},
+	"packageManager": "yarn@4.13.0",
+	"devDependencies": {
+		"@types/jest": "^30.0.0",
+		"@types/node": "^25.0.10",
+		"jest": "^30.2.0",
+		"ts-jest": "^29.4.6",
+		"typescript": "^5.9.3"
+	}
+}

package/src/index.test.ts

@@ -1,105 +1,105 @@
-import { relationMatcherRoot } from ".";
-import { testData, testSchema } from "./testing/test-data";
-
-test("Tests output of mapper.", () => {
-	const relationMatcherData = relationMatcherRoot(testData, testSchema);
-
-	console.log(JSON.stringify(relationMatcherData, null, "\t"));
-
-	expect(relationMatcherData).toStrictEqual({
-		"c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01": {
-			id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-			clerkId: "user_abc123",
-			email: "alice@example.com",
-			createdAt: "2025-01-12T09:41:22.000Z",
-
-			teamToUsers: [
-				{
-					teamId: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-					role: "admin",
-					team: {
-						id: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-						name: "Red Dragons",
-					},
-				},
-				{
-					teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-					role: "member",
-					team: {
-						id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-						name: "Blue Sharks",
-					},
-				},
-			],
-
-			posts: [
-				{
-					id: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-					title: "First post",
-					published: true,
-					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-					comments: [
-						{
-							id: "9d1a7c3b-2f6a-4f7c-bf4b-8f6e3c5d9e01",
-							body: "Nice post!",
-							postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-							authorEmail: "bob@example.com",
-						},
-						{
-							id: "e3c9b5a2-7f42-4b7e-9e3d-4a6f1d8b2c44",
-							body: "Thanks for sharing",
-							postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-							authorEmail: "charlie@example.com",
-						},
-					],
-				},
-				{
-					id: "6bcb2b74-9b2f-4b38-bdb5-77c2e63d9c10",
-					title: "Second post",
-					published: false,
-					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-					comments: [],
-				},
-			],
-		},
-		"f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55": {
-			id: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
-			clerkId: "user_xyz789",
-			email: "dave@example.com",
-			createdAt: "2025-02-03T14:18:10.000Z",
-
-			teamToUsers: [
-				{
-					teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-					userId: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
-					role: "admin",
-					team: {
-						id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-						name: "Blue Sharks",
-					},
-				},
-			],
-
-			posts: [],
-		},
-	});
-});
-
-test("Tests empty input.", () => {
-	type InputRow = {
-		user: {
-			clerk_id: string;
-		};
-	};
-
-	const input: InputRow[] = [];
-
-	expect(
-		relationMatcherRoot(input, {
-			base: "user",
-			id: "clerk_id",
-		}),
-	).toStrictEqual({});
-});
+import { relationMatcherRoot } from ".";
+import { testData, testSchema } from "./testing/test-data";
+
+test("Tests output of mapper.", () => {
+	const relationMatcherData = relationMatcherRoot(testData, testSchema);
+
+	console.log(JSON.stringify(relationMatcherData, null, "\t"));
+
+	expect(relationMatcherData).toStrictEqual({
+		"c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01": {
+			id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
+			clerkId: "user_abc123",
+			email: "alice@example.com",
+			createdAt: "2025-01-12T09:41:22.000Z",
+
+			teamToUsers: [
+				{
+					teamId: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
+					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
+					role: "admin",
+					team: {
+						id: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
+						name: "Red Dragons",
+					},
+				},
+				{
+					teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
+					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
+					role: "member",
+					team: {
+						id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
+						name: "Blue Sharks",
+					},
+				},
+			],
+
+			posts: [
+				{
+					id: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
+					title: "First post",
+					published: true,
+					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
+					comments: [
+						{
+							id: "9d1a7c3b-2f6a-4f7c-bf4b-8f6e3c5d9e01",
+							body: "Nice post!",
+							postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
+							authorEmail: "bob@example.com",
+						},
+						{
+							id: "e3c9b5a2-7f42-4b7e-9e3d-4a6f1d8b2c44",
+							body: "Thanks for sharing",
+							postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
+							authorEmail: "charlie@example.com",
+						},
+					],
+				},
+				{
+					id: "6bcb2b74-9b2f-4b38-bdb5-77c2e63d9c10",
+					title: "Second post",
+					published: false,
+					userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
+					comments: [],
+				},
+			],
+		},
+		"f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55": {
+			id: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
+			clerkId: "user_xyz789",
+			email: "dave@example.com",
+			createdAt: "2025-02-03T14:18:10.000Z",
+
+			teamToUsers: [
+				{
+					teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
+					userId: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
+					role: "admin",
+					team: {
+						id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
+						name: "Blue Sharks",
+					},
+				},
+			],
+
+			posts: [],
+		},
+	});
+});
+
+test("Tests empty input.", () => {
+	type InputRow = {
+		user: {
+			clerk_id: string;
+		};
+	};
+
+	const input: InputRow[] = [];
+
+	expect(
+		relationMatcherRoot(input, {
+			base: "user",
+			id: "clerk_id",
+		}),
+	).toStrictEqual({});
+});

package/src/index.ts

@@ -1,151 +1,160 @@
-import type { TInputBase } from "./types/generic-bases";
-import type { Output } from "./types/generic-less";
-import type { RelationMapRoot } from "./types/inputs";
-import type { RelationMapperReturnRoot } from "./types/return";
-import invertInput, { type InvertedInput } from "./utils/invertInput";
-import { getJoinFinalKey } from "./utils/keys";
-import { matcherFunc } from "./utils/matcher";
-
-export const relationMatcherRoot = <
-	TInput extends TInputBase,
-	TOutputRoot extends RelationMapRoot<TInput>,
->(
-	inputs: TInput[],
-	output: TOutputRoot,
-): Record<string, RelationMapperReturnRoot<TInput, TOutputRoot>> => {
-	if (!inputs.length) return {};
-
-	if (!Array.isArray(inputs)) {
-		throw new Error("Input must be an array.");
-	}
-
-	const invertedInput = invertInput<TInput>(inputs);
-
-	const baseItems = invertedInput[output.base].reduce<
-		Record<string, TInput[TOutputRoot["base"]]>
-	>((final, row) => {
-		if (!row) {
-			return final;
-		}
-
-		const relations = Object.entries(output).reduce<
-			Record<string, unknown>
-		>((final, [key, value]) => {
-			if (typeof value === "object") {
-				const finalKey = getJoinFinalKey(key);
-
-				if (value.joinType === "array") {
-					const baseObjArr = invertedInput[value.base]!.filter(
-						matcherFunc(row, value as Output),
-					) as TInputBase[string][];
-
-					final[finalKey] = Object.values(
-						baseObjArr.reduce<
-							Record<string, NonNullable<TInputBase[string]>>
-						>((final, item) => {
-							if (!item) return final;
-
-							final[item[value.id as string] as string] = {
-								...item,
-								...relationMatcherJoiner(
-									invertedInput,
-									value as Output,
-									item,
-								),
-							};
-
-							return final;
-						}, {}),
-					);
-				} else {
-					const item =
-						(invertedInput[value.base]!.find(
-							matcherFunc(row, value as Output),
-						) as TInputBase[string] | undefined) ?? null;
-
-					if (item) {
-						final[finalKey] = {
-							...item,
-							...relationMatcherJoiner(
-								invertedInput,
-								value as Output,
-								item,
-							),
-						};
-					}
-				}
-			}
-
-			return final;
-		}, {}) as TInput[TOutputRoot["base"]];
-
-		final[row[output.id as string] as string] = { ...row, ...relations };
-
-		return final;
-	}, {});
-
-	return baseItems as unknown as Record<
-		string,
-		RelationMapperReturnRoot<TInput, TOutputRoot>
-	>;
-};
-
-export const relationMatcher = relationMatcherRoot;
-export default relationMatcherRoot;
-
-const relationMatcherJoiner = (
-	input: InvertedInput,
-	output: Output,
-	joiningFrom: Record<string, unknown>,
-) => {
-	return Object.entries(output).reduce<
-		Record<string, TInputBase[string] | TInputBase[string][] | null>
-	>((final, [key, value]) => {
-		if (typeof value === "object") {
-			const finalKey = key.replace(/^_/, "");
-
-			const matcherFunc = (
-				item: InvertedInput[keyof InvertedInput][number],
-			) => item?.[value.joinsTo] === joiningFrom[value.joinsFrom];
-
-			if (value.joinType === "array") {
-				const baseObjArr = input[value.base]!.filter(
-					matcherFunc,
-				) as InvertedInput[number];
-
-				final[finalKey] = Object.values(
-					baseObjArr.reduce<
-						Record<string, NonNullable<TInputBase[string]>>
-					>((final, item) => {
-						if (!item) return final;
-
-						const propertyKey = item[value.id as string] as string;
-
-						if (final[propertyKey]) return final;
-
-						final[propertyKey] = {
-							...item,
-							...relationMatcherJoiner(input, value, item),
-						};
-
-						return final;
-					}, {}),
-				);
-			} else {
-				const item =
-					(input[value.base]!.find(matcherFunc) as
-						| InvertedInput[string][number]
-						| undefined) ?? null;
-
-				if (item) {
-					final[finalKey] = {
-						...item,
-						...relationMatcherJoiner(input, value, item),
-					};
-				}
-			}
-		}
-
-		return final;
-	}, {});
-};
+import type { TInputBase } from "./types/generic-bases";
+import type { Output } from "./types/generic-less";
+import type { RelationMapRoot } from "./types/inputs";
+import type { RelationMapperReturnRoot } from "./types/return";
+import invertInput, { type InvertedInput } from "./utils/invertInput";
+import { getJoinFinalKey } from "./utils/keys";
+import { matcherFunc } from "./utils/matcher";
+
+export const relationMatcherRoot = <
+	TInput extends TInputBase,
+	TOutputRoot extends RelationMapRoot<TInput>,
+>(
+	inputs: TInput[],
+	output: TOutputRoot,
+): Record<string, RelationMapperReturnRoot<TInput, TOutputRoot>> => {
+	if (!inputs.length) return {};
+
+	if (!Array.isArray(inputs)) {
+		throw new Error("Input must be an array.");
+	}
+
+	const invertedInput = invertInput<TInput>(inputs);
+
+	const baseItems = invertedInput[output.base].reduce<
+		Record<string, TInput[TOutputRoot["base"]]>
+	>((final, row) => {
+		if (!row) {
+			return final;
+		}
+
+		const relations = Object.entries(output).reduce<
+			Record<string, unknown>
+		>((final, [key, value]) => {
+			if (typeof value === "object") {
+				const finalKey = getJoinFinalKey(key);
+
+				if (value.joinType === "array") {
+					const baseObjArr = invertedInput[value.base]!.filter(
+						matcherFunc(row, value as Output),
+					) as TInputBase[string][];
+
+					final[finalKey] = Object.values(
+						baseObjArr.reduce<
+							Record<string, NonNullable<TInputBase[string]>>
+						>((final, item) => {
+							if (!item) return final;
+
+							final[item[value.id as string] as string] = {
+								...item,
+								...relationMatcherJoiner(
+									invertedInput,
+									value as Output,
+									item,
+								),
+							};
+
+							return final;
+						}, {}),
+					);
+				} else {
+					const item =
+						(invertedInput[value.base]!.find(
+							matcherFunc(row, value as Output),
+						) as TInputBase[string] | undefined) ?? null;
+
+					if (item) {
+						final[finalKey] = {
+							...item,
+							...relationMatcherJoiner(
+								invertedInput,
+								value as Output,
+								item,
+							),
+						};
+					}
+				}
+			}
+
+			return final;
+		}, {}) as TInput[TOutputRoot["base"]];
+
+		final[row[output.id as string] as string] = { ...row, ...relations };
+
+		return final;
+	}, {});
+
+	return baseItems as unknown as Record<
+		string,
+		RelationMapperReturnRoot<TInput, TOutputRoot>
+	>;
+};
+
+export const relationMatcher = relationMatcherRoot;
+export default relationMatcherRoot;
+
+const relationMatcherJoiner = (
+	input: InvertedInput,
+	output: Output,
+	joiningFrom: Record<string, unknown>,
+) => {
+	return Object.entries(output).reduce<
+		Record<string, TInputBase[string] | TInputBase[string][] | null>
+	>((final, [key, value]) => {
+		if (typeof value === "object") {
+			const finalKey = getJoinFinalKey(key);
+
+			const matcherFunc = (
+				item: InvertedInput[keyof InvertedInput][number],
+			) => item?.[value.joinsTo] === joiningFrom[value.joinsFrom];
+
+			if (!input[value.base])
+				throw new Error(`Input is missing rows for ${value.base}.`);
+
+			if (value.joinType === "array") {
+				const baseObjArr = input[value.base]!.filter(
+					matcherFunc,
+				) as InvertedInput[number];
+
+				final[finalKey] = Object.values(
+					baseObjArr.reduce<
+						Record<string, NonNullable<TInputBase[string]>>
+					>((final, item) => {
+						if (!item) return final;
+
+						const propertyKey = item[value.id as string] as string;
+
+						if (final[propertyKey]) return final;
+
+						final[propertyKey] = {
+							...item,
+							...relationMatcherJoiner(input, value, item),
+						};
+
+						return final;
+					}, {}),
+				);
+			} else {
+				const item =
+					(input[value.base]!.find(matcherFunc) as
+						| InvertedInput[string][number]
+						| undefined) ?? null;
+
+				if (item === null && value.isNullable === false) {
+					throw new Error(
+						"Value should exist as output schema defines it as nullable. Instead found null in array",
+					);
+				}
+
+				if (item) {
+					final[finalKey] = {
+						...item,
+						...relationMatcherJoiner(input, value, item),
+					};
+				}
+			}
+		}
+
+		return final;
+	}, {});
+};

package/src/testing/file-output.ts

@@ -1,15 +1,15 @@
-import fs from "fs/promises";
-import path from "path";
-import { relationMatcherRoot } from "..";
-import { testData, testSchema } from "./test-data";
-
-const main = async () => {
-	const result = relationMatcherRoot(testData, testSchema);
-
-	await fs.writeFile(
-		path.join(process.cwd(), "/result.json"),
-		JSON.stringify(result, null, "\t"),
-	);
-};
-
-void main();
+import fs from "fs/promises";
+import path from "path";
+import { relationMatcherRoot } from "..";
+import { testData, testSchema } from "./test-data";
+
+const main = async () => {
+	const result = relationMatcherRoot(testData, testSchema);
+
+	await fs.writeFile(
+		path.join(process.cwd(), "/result.json"),
+		JSON.stringify(result, null, "\t"),
+	);
+};
+
+void main();