relation-matcher 1.0.8 → 1.0.10

package/jest.config.js

@@ -9,4 +9,5 @@ export default {
 	transform: {
 		...tsJestTransformCfg,
 	},
+	testPathIgnorePatterns: ["/node_modules/", "/dist/"],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "relation-matcher",
-	"version": "1.0.8",
+	"version": "1.0.10",
 	"description": "A utility to convert table data (such as out of a SQL query) into structured JSON.",
 	"license": "ISC",
 	"author": "",
@@ -15,10 +15,10 @@
 	},
 	"private": false,
 	"scripts": {
-		"test": "jest",
+		"test": "jest && tsc --noEmit",
 		"file-output": "tsx --watch src/file-output.ts",
 		"build": "tsc",
-		"build:publish": "yarn run build && npm publish"
+		"build:publish": "yarn run test && yarn run build && npm publish"
 	},
 	"packageManager": "yarn@4.12.0",
 	"devDependencies": {

package/src/index.test.ts

@@ -86,3 +86,20 @@ test("Tests output of mapper.", () => {
 		},
 	});
 });
+
+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

@@ -13,6 +13,12 @@ export const relationMatcherRoot = <
 	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<
@@ -21,15 +27,10 @@ export const relationMatcherRoot = <
 		if (!row) {
 			return final;
 		}
-		// if (final[row[output.id as string] as string]) {
-		// 	return final;
-		// }
 
 		const relations = Object.entries(output).reduce<
 			Record<string, unknown>
 		>((final, [key, value]) => {
-			// Filters out base parameters so value is only joins;
-			// value will be similar to { base: "team_to_user"; joinsTo: "team_id"; joinsFrom: "id"; joinType: "single"; }
 			if (typeof value === "object") {
 				const finalKey = getJoinFinalKey(key);
 
@@ -42,15 +43,7 @@ export const relationMatcherRoot = <
 						baseObjArr.reduce<
 							Record<string, NonNullable<TInputBase[string]>>
 						>((final, item) => {
-							if (
-								!item
-								// final[item[value.id as string] as string]
-							)
-								return final;
-
-							// if (!item[value.joinsFrom as string]) {
-							console.log(item, value.joinsFrom);
-							// }
+							if (!item) return final;
 
 							final[item[value.id as string] as string] = {
 								...item,
@@ -81,14 +74,6 @@ export const relationMatcherRoot = <
 						};
 					}
 				}
-
-				// if (value.joinType === 'array')
-
-				// final[finalKey] = relationMatcherJoiner(
-				// 	invertedInput,
-				// 	value as Output,
-				// 	row[value.joinsFrom as string] as string,
-				// );
 			}
 
 			return final;
@@ -117,7 +102,6 @@ const relationMatcherJoiner = (
 		Record<string, TInputBase[string] | TInputBase[string][] | null>
 	>((final, [key, value]) => {
 		if (typeof value === "object") {
-			// console.log(value.base);
 			const finalKey = key.replace(/^_/, "");
 
 			const matcherFunc = (
@@ -129,13 +113,6 @@ const relationMatcherJoiner = (
 					matcherFunc,
 				) as InvertedInput[number];
 
-				// console.log("BaseObjArr:", baseObjArr);
-				// console.log(
-				// 	"input[value.base]:",
-				// 	input[value.base]?.[0]?.[value.joinsTo],
-				// );
-				// console.log("joiningId", joiningId);
-
 				final[finalKey] = Object.values(
 					baseObjArr.reduce<
 						Record<string, NonNullable<TInputBase[string]>>
@@ -154,22 +131,12 @@ const relationMatcherJoiner = (
 						return final;
 					}, {}),
 				);
-
-				// baseObjArr.map(item => (item ? {
-				// 	...item,
-				// 	...relationMatcherJoiner(input, value, item[value.joinsFrom as keyof TInputBase])
-				// } : null))
 			} else {
 				const item =
 					(input[value.base]!.find(matcherFunc) as
 						| InvertedInput[string][number]
 						| undefined) ?? null;
 
-				// console.log("item:", item);
-				// console.log("input[value.base]:", input[value.base]);
-				// console.log("joiningId:", joiningId);
-				// console.log("value:", value);
-
 				if (item) {
 					final[finalKey] = {
 						...item,

package/src/utils/invertInput.ts

@@ -10,12 +10,12 @@ const invertInput = <TInput extends TInputBase>(
 ): InvertedInput<TInput> => {
 	const invertedInput = inputs.reduce<InvertedInput<TInput>>((final, row) => {
 		Object.entries(row).forEach(([header, value]) => {
-			if (!value) return;
-
 			if (final[header]) {
-				final[header].push(value as TInput[keyof TInput]);
+				if (value) final[header].push(value as TInput[keyof TInput]);
 			} else {
-				final[header as keyof TInput] = [value as TInput[keyof TInput]];
+				final[header as keyof TInput] = value
+					? [value as TInput[keyof TInput]]
+					: [];
 			}
 		});
 

package/tsconfig.json

@@ -19,7 +19,7 @@
 		"lib": ["dom", "dom.iterable", "ES2022"],
 		"declaration": true,
 		// "noEmit": true,
-		"module": "ESNext",
+		"module": "esnext",
 		"moduleResolution": "Bundler",
 		"jsx": "preserve",
 		// "plugins": [{ "name": "next" }],

package/dist/dist/jest.config.js

@@ -1,10 +0,0 @@
-import { createDefaultPreset } from "ts-jest";
-const tsJestTransformCfg = createDefaultPreset().transform;
-/** @type {import("jest").Config} **/
-export default {
-    preset: "ts-jest",
-    testEnvironment: "node",
-    transform: {
-        ...tsJestTransformCfg,
-    },
-};

package/dist/dist/src/index.js

@@ -1,107 +0,0 @@
-import invertInput, {} from "./utils/invertInput";
-import { getJoinFinalKey } from "./utils/keys";
-import { matcherFunc } from "./utils/matcher";
-export const relationMatcherRoot = (inputs, output) => {
-    const invertedInput = invertInput(inputs);
-    const baseItems = invertedInput[output.base].reduce((final, row) => {
-        if (!row) {
-            return final;
-        }
-        // if (final[row[output.id as string] as string]) {
-        // 	return final;
-        // }
-        const relations = Object.entries(output).reduce((final, [key, value]) => {
-            // Filters out base parameters so value is only joins;
-            // value will be similar to { base: "team_to_user"; joinsTo: "team_id"; joinsFrom: "id"; joinType: "single"; }
-            if (typeof value === "object") {
-                const finalKey = getJoinFinalKey(key);
-                if (value.joinType === "array") {
-                    const baseObjArr = invertedInput[value.base].filter(matcherFunc(row, value));
-                    final[finalKey] = Object.values(baseObjArr.reduce((final, item) => {
-                        if (!item
-                        // final[item[value.id as string] as string]
-                        )
-                            return final;
-                        // if (!item[value.joinsFrom as string]) {
-                        console.log(item, value.joinsFrom);
-                        // }
-                        final[item[value.id]] = {
-                            ...item,
-                            ...relationMatcherJoiner(invertedInput, value, item),
-                        };
-                        return final;
-                    }, {}));
-                }
-                else {
-                    const item = invertedInput[value.base].find(matcherFunc(row, value)) ?? null;
-                    if (item) {
-                        final[finalKey] = {
-                            ...item,
-                            ...relationMatcherJoiner(invertedInput, value, item),
-                        };
-                    }
-                }
-                // if (value.joinType === 'array')
-                // final[finalKey] = relationMatcherJoiner(
-                // 	invertedInput,
-                // 	value as Output,
-                // 	row[value.joinsFrom as string] as string,
-                // );
-            }
-            return final;
-        }, {});
-        final[row[output.id]] = { ...row, ...relations };
-        return final;
-    }, {});
-    return baseItems;
-};
-export const relationMatcher = relationMatcherRoot;
-export default relationMatcherRoot;
-const relationMatcherJoiner = (input, output, joiningFrom) => {
-    return Object.entries(output).reduce((final, [key, value]) => {
-        if (typeof value === "object") {
-            // console.log(value.base);
-            const finalKey = key.replace(/^_/, "");
-            const matcherFunc = (item) => item?.[value.joinsTo] === joiningFrom[value.joinsFrom];
-            if (value.joinType === "array") {
-                const baseObjArr = input[value.base].filter(matcherFunc);
-                // console.log("BaseObjArr:", baseObjArr);
-                // console.log(
-                // 	"input[value.base]:",
-                // 	input[value.base]?.[0]?.[value.joinsTo],
-                // );
-                // console.log("joiningId", joiningId);
-                final[finalKey] = Object.values(baseObjArr.reduce((final, item) => {
-                    if (!item)
-                        return final;
-                    const propertyKey = item[value.id];
-                    if (final[propertyKey])
-                        return final;
-                    final[propertyKey] = {
-                        ...item,
-                        ...relationMatcherJoiner(input, value, item),
-                    };
-                    return final;
-                }, {}));
-                // baseObjArr.map(item => (item ? {
-                // 	...item,
-                // 	...relationMatcherJoiner(input, value, item[value.joinsFrom as keyof TInputBase])
-                // } : null))
-            }
-            else {
-                const item = input[value.base].find(matcherFunc) ?? null;
-                // console.log("item:", item);
-                // console.log("input[value.base]:", input[value.base]);
-                // console.log("joiningId:", joiningId);
-                // console.log("value:", value);
-                if (item) {
-                    final[finalKey] = {
-                        ...item,
-                        ...relationMatcherJoiner(input, value, item),
-                    };
-                }
-            }
-        }
-        return final;
-    }, {});
-};

package/dist/dist/src/index.test.js

@@ -1,81 +0,0 @@
-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: [],
-        },
-    });
-});

package/dist/dist/src/testing/file-output.js

@@ -1,9 +0,0 @@
-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();

package/dist/dist/src/testing/test-data.js

@@ -1,164 +0,0 @@
-export const testData = [
-    {
-        users: {
-            id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            clerkId: "user_abc123",
-            email: "alice@example.com",
-            createdAt: "2025-01-12T09:41:22.000Z",
-        },
-        teamToUser: {
-            teamId: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            role: "admin",
-        },
-        teams: {
-            id: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            name: "Red Dragons",
-        },
-        posts: {
-            id: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            title: "First post",
-            published: true,
-        },
-        comments: {
-            id: "9d1a7c3b-2f6a-4f7c-bf4b-8f6e3c5d9e01",
-            postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            body: "Nice post!",
-            authorEmail: "bob@example.com",
-        },
-    },
-    {
-        users: {
-            id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            clerkId: "user_abc123",
-            email: "alice@example.com",
-            createdAt: "2025-01-12T09:41:22.000Z",
-        },
-        teamToUser: {
-            teamId: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            role: "admin",
-        },
-        teams: {
-            id: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            name: "Red Dragons",
-        },
-        posts: {
-            id: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            title: "First post",
-            published: true,
-        },
-        comments: {
-            id: "e3c9b5a2-7f42-4b7e-9e3d-4a6f1d8b2c44",
-            postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            body: "Thanks for sharing",
-            authorEmail: "charlie@example.com",
-        },
-    },
-    {
-        users: {
-            id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            clerkId: "user_abc123",
-            email: "alice@example.com",
-            createdAt: "2025-01-12T09:41:22.000Z",
-        },
-        teamToUser: {
-            teamId: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            role: "admin",
-        },
-        teams: {
-            id: "a2e5a3de-6d14-4e9b-9c9f-3cbb2cdb8a10",
-            name: "Red Dragons",
-        },
-        posts: {
-            id: "6bcb2b74-9b2f-4b38-bdb5-77c2e63d9c10",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            title: "Second post",
-            published: false,
-        },
-        comments: null,
-    },
-    {
-        users: {
-            id: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            clerkId: "user_abc123",
-            email: "alice@example.com",
-            createdAt: "2025-01-12T09:41:22.000Z",
-        },
-        teamToUser: {
-            teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            role: "member",
-        },
-        teams: {
-            id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-            name: "Blue Sharks",
-        },
-        posts: {
-            id: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            userId: "c7a2c1c8-9f4c-4f89-9d72-6b5a2f0c1e01",
-            title: "First post",
-            published: true,
-        },
-        comments: {
-            id: "9d1a7c3b-2f6a-4f7c-bf4b-8f6e3c5d9e01",
-            postId: "f13d8f22-0b61-4d6a-8b1e-5b6b3d0c8a21",
-            body: "Nice post!",
-            authorEmail: "bob@example.com",
-        },
-    },
-    {
-        users: {
-            id: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
-            clerkId: "user_xyz789",
-            email: "dave@example.com",
-            createdAt: "2025-02-03T14:18:10.000Z",
-        },
-        teamToUser: {
-            teamId: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-            userId: "f44a8c17-3c6d-4e38-9f61-0a9f2b1c8d55",
-            role: "admin",
-        },
-        teams: {
-            id: "d91f42a6-8cbb-4e63-9b5c-8d1b4f2a7e77",
-            name: "Blue Sharks",
-        },
-        posts: null,
-        comments: null,
-    },
-];
-export const testSchema = {
-    base: "users",
-    id: "id",
-    _teamToUsers: {
-        base: "teamToUser",
-        id: "teamId",
-        joinsFrom: "id",
-        joinsTo: "userId",
-        joinType: "array",
-        _team: {
-            base: "teams",
-            id: "id",
-            joinsFrom: "teamId",
-            joinsTo: "id",
-            joinType: "single",
-        },
-    },
-    _posts: {
-        base: "posts",
-        id: "id",
-        joinsFrom: "id",
-        joinsTo: "userId",
-        joinType: "array",
-        _comments: {
-            base: "comments",
-            id: "id",
-            joinsFrom: "id",
-            joinsTo: "postId",
-            joinType: "array",
-        },
-    },
-};

package/dist/dist/src/types/generic-bases.js

@@ -1 +0,0 @@
-export {};

package/dist/dist/src/types/generic-less.js

@@ -1 +0,0 @@
-export {};

package/dist/dist/src/types/inputs.js

@@ -1 +0,0 @@
-export {};

package/dist/dist/src/types/return.js

@@ -1 +0,0 @@
-export {};

package/dist/dist/src/types/typetest.js

@@ -1,6 +0,0 @@
-export {};
-// type B = {
-// 	team: Schema["Team"]["$inferSelect"][];
-// 	team_to_user: Schema["TeamToUser"]["$inferSelect"][];
-// };
-//   ^?

package/dist/dist/src/types/utils.js

@@ -1 +0,0 @@
-export {};

package/dist/dist/src/utils/invertInput.js

@@ -1,17 +0,0 @@
-const invertInput = (inputs) => {
-    const invertedInput = inputs.reduce((final, row) => {
-        Object.entries(row).forEach(([header, value]) => {
-            if (!value)
-                return;
-            if (final[header]) {
-                final[header].push(value);
-            }
-            else {
-                final[header] = [value];
-            }
-        });
-        return final;
-    }, {});
-    return invertedInput;
-};
-export default invertInput;

package/dist/dist/src/utils/keys.js

@@ -1 +0,0 @@
-export const getJoinFinalKey = (key) => key.substring(1);

package/dist/dist/src/utils/matcher.js

@@ -1 +0,0 @@
-export const matcherFunc = (row, value) => (item) => row?.[value.joinsFrom] === item?.[value.joinsTo];