relation-matcher 1.0.13 → 1.1.1

package/src/testing/test-data.ts

@@ -1,172 +1,172 @@
-import type { RelationMapRoot } from "~/types/inputs";
-import type { Simplify } from "~/types/utils";
-
-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",
-		},
-	},
-} satisfies RelationMapRoot<(typeof testData)[number]>;
+import type { RelationMapRoot } from "~/types/inputs";
+import type { Simplify } from "~/types/utils";
+
+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",
+		},
+	},
+} satisfies RelationMapRoot<(typeof testData)[number]>;

package/src/types/generic-bases.ts

@@ -1,9 +1,10 @@
-import type { RelationMapBase, RelationMapJoiner } from "./inputs";
-
-export type TInputBase = Record<string, Record<string, unknown> | null>;
-export type TJoinedFromBase = TInputBase[keyof TInputBase];
-export type TOutputBase<
-	TInput extends TInputBase,
-	TJoinedFrom extends TJoinedFromBase,
-> = RelationMapBase<TInput, TJoinedFrom> &
-	RelationMapJoiner<TInput, TJoinedFrom>;
+import type { RelationMapBase, RelationMapJoiner } from "./inputs";
+
+export type TInputBaseJoin = Record<string, unknown>;
+export type TInputBase = Record<string, TInputBaseJoin | null>;
+export type TJoinedFromBase = TInputBase[keyof TInputBase];
+export type TOutputBase<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+> = RelationMapBase<TInput, TJoinedFrom> &
+	RelationMapJoiner<TInput, TJoinedFrom>;

package/src/types/generic-less.ts

@@ -1,14 +1,20 @@
-import type { TInputBase } from "./generic-bases";
-
-export type Output<TJoinType extends "single" | "array" = "single" | "array"> =
-	OutputJoins & {
-		base: keyof TInputBase;
-		id: string;
-		joinsTo: string;
-		joinsFrom: string;
-		joinType: TJoinType;
-	};
-
-export type OutputJoins = {
-	[k: `_${string}`]: Output;
-};
+import type { TInputBase } from "./generic-bases";
+
+export type OutputBase<
+	TJoinType extends "single" | "array" = "single" | "array",
+> = {
+	base: string;
+	id: string;
+	joinsTo: string;
+	joinsFrom: string;
+	joinType: TJoinType;
+	isNullable?: false;
+};
+
+export type OutputRoot = OutputJoins & { base: string; id: string };
+export type Output<TJoinType extends "single" | "array" = "single" | "array"> =
+	OutputJoins & OutputBase<TJoinType>;
+
+export type OutputJoins = {
+	[k: `_${string}`]: Output;
+};

package/src/types/index.ts

@@ -1,5 +1,5 @@
-export type * from "./generic-bases";
-export type * from "./generic-less";
-export type * from "./return";
-export type * from "./typetest";
-export type * from "./utils";
+export type * from "./generic-bases";
+export type * from "./generic-less";
+export type * from "./return";
+export type * from "./typetest";
+export type * from "./utils";

package/src/types/inputs.ts

@@ -1,30 +1,36 @@
-import type { TInputBase, TJoinedFromBase } from "./generic-bases";
-
-export type RelationMapRoot<TInput extends TInputBase> = {
-	[k in keyof TInput]: {
-		base: k;
-		id: keyof NonNullable<TInput[k]>;
-	} & RelationMapJoiner<TInput, NonNullable<TInput[k]>>;
-}[keyof TInput];
-
-export type RelationMapBase<
-	TInput extends TInputBase,
-	TJoinedFrom extends TJoinedFromBase,
-> = {
-	[k in keyof TInput]: {
-		base: k;
-		/** The id that uniqueness is checked against. Either the primary key of the table, or the id you are joining **to** on a join table. */
-		id: keyof NonNullable<TInput[k]>;
-		joinsTo: keyof NonNullable<TInput[k]>;
-		joinsFrom: keyof NonNullable<TJoinedFrom>;
-		joinType: "single" | "array";
-	} & RelationMapJoiner<TInput, TInput[k]>;
-}[keyof TInput];
-
-export type RelationMapJoiner<
-	TInput extends TInputBase,
-	TJoinedFrom extends TJoinedFromBase,
-> = {
-	[k: `_${string}`]: RelationMapBase<TInput, TJoinedFrom> &
-		RelationMapJoiner<TInput, TJoinedFrom>;
-};
+import type { TInputBase, TJoinedFromBase } from "./generic-bases";
+
+export type RelationMapRoot<TInput extends TInputBase> = {
+	[k in keyof TInput]: {
+		base: k;
+		id: keyof NonNullable<TInput[k]>;
+	} & RelationMapJoiner<TInput, NonNullable<TInput[k]>>;
+}[keyof TInput];
+
+export type IsNullable = { false: false; undefined: undefined };
+
+export type RelationMapBase<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+> = {
+	[k in keyof TInput]: {
+		[n in keyof IsNullable]: {
+			base: k;
+			/** The id that uniqueness is checked against. Either the primary key of the table, or the id you are joining **to** on a join table. */
+			id: keyof NonNullable<TInput[k]>;
+			joinsTo: keyof NonNullable<TInput[k]>;
+			joinsFrom: keyof NonNullable<TJoinedFrom>;
+			joinType: "single" | "array";
+			isNullable?: IsNullable[n];
+		};
+	}[keyof IsNullable] &
+		RelationMapJoiner<TInput, TInput[k]>;
+}[keyof TInput];
+
+export type RelationMapJoiner<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+> = {
+	[k: `_${string}`]: RelationMapBase<TInput, TJoinedFrom> &
+		RelationMapJoiner<TInput, TJoinedFrom>;
+};

package/src/types/return.ts

@@ -1,67 +1,65 @@
-import type { TInputBase, TJoinedFromBase, TOutputBase } from "./generic-bases";
-import type { RelationMapRoot } from "./inputs";
-import type { ExtendsNull, NoUnderscore, Simplify } from "./utils";
-
-export type RelationMapperReturnRoot<
-	TInput extends TInputBase,
-	TOutput extends RelationMapRoot<TInput>,
-> = Simplify<
-	ExtendsNull<TInput[TOutput["base"]]> extends true
-		?
-				| (TInput[TOutput["base"]] &
-						RelationMapperReturnJoinRoot<
-							TInput,
-							TOutput,
-							TOutput["base"]
-						>)
-				| null
-		: TInput[TOutput["base"]] &
-				RelationMapperReturnJoinRoot<TInput, TOutput, TOutput["base"]>
->;
-
-export type RelationMapperReturnJoinRoot<
-	TInput extends TInputBase,
-	TOutput extends RelationMapRoot<TInput>,
-	TInputKey extends keyof TInput,
-> = {
-	[outputKey in NoUnderscore<keyof TOutput>]: RelationMapperReturn<
-		TInput,
-		TInput[TInputKey],
-		TOutput[`_${outputKey}`]
-	>;
-};
-
-/** Fill current object with value specified in base */
-export type RelationMapperReturn<
-	TInput extends TInputBase,
-	TJoinedFrom extends TJoinedFromBase,
-	TOutput extends TOutputBase<TInput, TJoinedFrom>,
-> = TOutput["joinType"] extends "array"
-	? Array<
-			Simplify<
-				TInput[TOutput["base"]] &
-					RelationMapperReturnJoin<TInput, TJoinedFrom, TOutput>
-			>
-		>
-	: ExtendsNull<TInput[TOutput["base"]]> extends true
-		? Simplify<
-				TInput[TOutput["base"]] &
-					RelationMapperReturnJoin<TInput, TJoinedFrom, TOutput>
-			> | null
-		: Simplify<
-				TInput[TOutput["base"]] &
-					RelationMapperReturnJoin<TInput, TJoinedFrom, TOutput>
-			>;
-
-/** Takes underscored values (joins) and replaces their values with the actual output. */
-export type RelationMapperReturnJoin<
-	TInput extends TInputBase,
-	TJoinedFrom extends TJoinedFromBase,
-	TOutput extends TOutputBase<TInput, TJoinedFrom>,
-> = {
-	[k in NoUnderscore<keyof TOutput>]: RelationMapperReturn<
-		TInput,
-		TJoinedFrom,
-		TOutput[`_${k}`]
-	>;
-};
+import type { TInputBase, TJoinedFromBase, TOutputBase } from "./generic-bases";
+import type { RelationMapRoot } from "./inputs";
+import type { ExtendsNull, NoUnderscore, Simplify } from "./utils";
+
+type JoinedRoot<
+	TInput extends TInputBase,
+	TOutput extends RelationMapRoot<TInput>,
+> = TInput[TOutput["base"]] &
+	RelationMapperReturnJoinRoot<TInput, TOutput, TOutput["base"]>;
+
+export type RelationMapperReturnRoot<
+	TInput extends TInputBase,
+	TOutput extends RelationMapRoot<TInput>,
+> = Simplify<
+	ExtendsNull<TInput[TOutput["base"]]> extends true
+		? JoinedRoot<TInput, TOutput> | null
+		: JoinedRoot<TInput, TOutput>
+>;
+
+export type RelationMapperReturnJoinRoot<
+	TInput extends TInputBase,
+	TOutput extends RelationMapRoot<TInput>,
+	TInputKey extends keyof TInput,
+> = {
+	[outputKey in NoUnderscore<keyof TOutput>]: RelationMapperReturn<
+		TInput,
+		TInput[TInputKey],
+		TOutput[`_${outputKey}`]
+	>;
+};
+
+export type Joined<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+	TOutput extends TOutputBase<TInput, TJoinedFrom>,
+> = Simplify<
+	TInput[TOutput["base"]] &
+		RelationMapperReturnJoin<TInput, TJoinedFrom, TOutput>
+>;
+
+/** Fill current object with value specified in base */
+export type RelationMapperReturn<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+	TOutput extends TOutputBase<TInput, TJoinedFrom>,
+> = TOutput["joinType"] extends "array"
+	? Array<Joined<TInput, TJoinedFrom, TOutput>>
+	: ExtendsNull<TInput[TOutput["base"]]> extends true
+		? TOutput["isNullable"] extends false
+			? Joined<TInput, TJoinedFrom, TOutput>
+			: Joined<TInput, TJoinedFrom, TOutput> | null
+		: Joined<TInput, TJoinedFrom, TOutput>;
+
+/** Takes underscored values (joins) and replaces their values with the actual output. */
+export type RelationMapperReturnJoin<
+	TInput extends TInputBase,
+	TJoinedFrom extends TJoinedFromBase,
+	TOutput extends TOutputBase<TInput, TJoinedFrom>,
+> = {
+	[k in NoUnderscore<keyof TOutput>]: RelationMapperReturn<
+		TInput,
+		TJoinedFrom,
+		TOutput[`_${k}`]
+	>;
+};