relation-matcher 1.0.13 → 1.1.1

package/src/types/typetest.ts

@@ -1,84 +1,87 @@
-import type { RelationMapperReturnRoot } from "./return";
-import type { DeepSimplify, ExtendsNull, Simplify } from "./utils";
-
-export type A = DeepSimplify<
-	RelationMapperReturnRoot<
-		{
-			team: {
-				created_at: Date;
-				updated_at: Date | null;
-				id: string;
-				team_name: string;
-				club_name: string;
-				club_postcode: string;
-			};
-			team_to_user: {
-				created_at: Date;
-				updated_at: Date | null;
-				user_clerk_id: string;
-				team_id: string;
-			} | null;
-		},
-		{
-			base: "team";
-			id: "id";
-
-			_teamToUser: {
-				base: "team_to_user";
-				id: "user_clerk_id";
-				joinsTo: "team_id";
-				joinsFrom: "id";
-				joinType: "single";
-
-				_team: {
-					base: "team";
-					id: "id";
-					joinsFrom: "team_id";
-					joinsTo: "id";
-					joinType: "array";
-				};
-			};
-		}
-	>,
-	Date | null | number
->;
-
-type B = RelationMapperReturnRoot<
-	{
-		user: {
-			clerk_id: string;
-		};
-		team_to_user: {
-			team_id: string;
-			user_clerk_id: string;
-		} | null;
-	},
-	{
-		base: "user";
-		id: "clerk_id";
-
-		_teamToUser: {
-			base: "team_to_user";
-			id: "team_id";
-			joinsFrom: "clerk_id";
-			joinsTo: "user_clerk_id";
-			joinType: "single";
-
-			_user: {
-				base: "user";
-				id: "clerk_id";
-				joinsFrom: "user_clerk_id";
-				joinsTo: "clerk_id";
-				joinType: "array";
-			};
-		};
-	}
->;
-
-type C = Simplify<B>;
-//   ^?
-
-type D = ExtendsNull<{
-	team_id: string;
-	user_clerk_id: string;
-} | null>;
+import type { RelationMapperReturnRoot } from "./return";
+import type { DeepSimplify, ExtendsNull, Simplify } from "./utils";
+
+type E = true extends undefined ? true : false;
+
+export type A = DeepSimplify<
+	RelationMapperReturnRoot<
+		{
+			team: {
+				created_at: Date;
+				updated_at: Date | null;
+				id: string;
+				team_name: string;
+				club_name: string;
+				club_postcode: string;
+			};
+			team_to_user: {
+				created_at: Date;
+				updated_at: Date | null;
+				user_clerk_id: string;
+				team_id: string;
+			} | null;
+		},
+		{
+			base: "team";
+			id: "id";
+
+			_teamToUser: {
+				base: "team_to_user";
+				id: "user_clerk_id";
+				joinsTo: "team_id";
+				joinsFrom: "id";
+				joinType: "single";
+				isNullable: false;
+
+				_team: {
+					base: "team";
+					id: "id";
+					joinsFrom: "team_id";
+					joinsTo: "id";
+					joinType: "array";
+				};
+			};
+		}
+	>,
+	Date | null | number
+>;
+
+type B = RelationMapperReturnRoot<
+	{
+		user: {
+			clerk_id: string;
+		};
+		team_to_user: {
+			team_id: string;
+			user_clerk_id: string;
+		} | null;
+	},
+	{
+		base: "user";
+		id: "clerk_id";
+
+		_teamToUser: {
+			base: "team_to_user";
+			id: "team_id";
+			joinsFrom: "clerk_id";
+			joinsTo: "user_clerk_id";
+			joinType: "single";
+
+			_user: {
+				base: "user";
+				id: "clerk_id";
+				joinsFrom: "user_clerk_id";
+				joinsTo: "clerk_id";
+				joinType: "array";
+			};
+		};
+	}
+>;
+
+type C = Simplify<B>;
+//   ^?
+
+type D = ExtendsNull<{
+	team_id: string;
+	user_clerk_id: string;
+} | null>;

package/src/types/utils.ts

@@ -1,28 +1,33 @@
-export type Simplify<T> = {
-	[k in keyof T]: T[k];
-} & {};
-
-export type DeepSimplify<TInput, TDontSimplify> = {
-	[k in keyof TInput]: TInput[k] extends TDontSimplify
-		? TInput[k]
-		: DeepSimplify<TInput[k], TDontSimplify>;
-} & {};
-
-export type NoUnderscore<T extends string | number | symbol> =
-	T extends `_${infer Result}` ? Result : never;
-
-export type DeepNonNullable<T extends object> = {
-	[k in keyof T]: T[k] extends infer NonNull | null ? NonNull : T[k];
-};
-
-export type ArrayOrSingle<
-	T,
-	TType extends "single" | "array",
-> = TType extends "array" ? Array<T> : T;
-
-export type IsNullIfNull<
-	TIsNull extends object | null,
-	TReturn extends object | never = never,
-> = TIsNull extends infer T ? (T & TReturn) | null : TIsNull & TReturn;
-
-export type ExtendsNull<T> = null extends T ? true : false;
+export type Simplify<T> = {
+	[k in keyof T]: T[k];
+} & {};
+
+export type DeepSimplify<TInput, TDontSimplify> = {
+	[k in keyof TInput]: TInput[k] extends TDontSimplify
+		? TInput[k]
+		: DeepSimplify<TInput[k], TDontSimplify>;
+} & {};
+
+export type NoUnderscore<T extends string | number | symbol> =
+	T extends `_${infer Result}` ? Result : never;
+
+export type DeepNonNullable<T extends object> = {
+	[k in keyof T]: T[k] extends infer NonNull | null ? NonNull : T[k];
+};
+
+export type ArrayOrSingle<
+	T,
+	TType extends "single" | "array",
+> = TType extends "array" ? Array<T> : T;
+
+export type IsNullIfNull<
+	TIsNull extends object | null,
+	TReturn extends object | never = never,
+> = TIsNull extends infer T ? (T & TReturn) | null : TIsNull & TReturn;
+
+export type ExtendsNull<T> = null extends T ? true : false;
+
+export type MaybeNull<T> = T | null;
+export type MaybeArray<T> = T | T[];
+
+export type SRecord<T> = Record<string, T>;

package/src/utils/invertInput.ts

@@ -1,28 +1,27 @@
-import type { TInputBase } from "~/types/generic-bases";
-
-export type InvertedInput<TInput extends TInputBase = TInputBase> = Record<
-	keyof TInput,
-	TInput[keyof TInput][]
->;
-
-const invertInput = <TInput extends TInputBase>(
-	inputs: TInputBase[],
-): InvertedInput<TInput> => {
-	const invertedInput = inputs.reduce<InvertedInput<TInput>>((final, row) => {
-		Object.entries(row).forEach(([header, value]) => {
-			if (final[header]) {
-				if (value) final[header].push(value as TInput[keyof TInput]);
-			} else {
-				final[header as keyof TInput] = value
-					? [value as TInput[keyof TInput]]
-					: [];
-			}
-		});
-
-		return final;
-	}, {} as InvertedInput<TInput>);
-
-	return invertedInput;
-};
-
-export default invertInput;
+import type { TInputBase } from "~/types/generic-bases";
+
+export type InvertedInputRow<TInput extends TInputBase = TInputBase> =
+	TInput[keyof TInput][];
+export type InvertedInput<TInput extends TInputBase = TInputBase> = Record<
+	keyof TInput,
+	InvertedInputRow<TInput>
+>;
+
+const invertInput = <TInput extends TInputBase>(
+	inputs: TInputBase[],
+): InvertedInput<TInput> => {
+	const invertedInput = inputs.reduce<InvertedInput<TInput>>((final, row) => {
+		Object.entries(row).forEach(([header, value]) => {
+			final[header as keyof TInput] ??= [];
+
+			// Instantiated above.
+			if (value) final[header]!.push(value as TInput[keyof TInput]);
+		});
+
+		return final;
+	}, {} as InvertedInput<TInput>);
+
+	return invertedInput;
+};
+
+export default invertInput;

package/src/utils/isNullable.ts

@@ -0,0 +1,11 @@
+/** Asserts that if `isNullable` is false then item is not null. */
+export const assertIsNullable = (
+	item: Record<string, unknown> | null,
+	isNullable: false | undefined,
+) => {
+	if (isNullable === false && item === null) {
+		throw new Error(
+			"Value should exist as output schema defines it as nullable. Instead found null in array",
+		);
+	}
+};

package/src/utils/joins.ts

@@ -0,0 +1,22 @@
+import type { OutputBase, TInputBase } from "~/types";
+import type { InvertedInput, InvertedInputRow } from "./invertInput";
+import { type MatcherFunc } from "./matcher";
+
+export const singleJoinBase = <TValue extends OutputBase<"single">>(
+	input: InvertedInputRow,
+	matcherFunc: MatcherFunc,
+): Record<string, unknown> | null => {
+	const item =
+		(input.find(matcherFunc) as TInputBase[string] | undefined) ?? null;
+
+	return item;
+};
+
+export const arrayJoinBase = <TValue extends OutputBase<"single">>(
+	input: InvertedInputRow,
+	matcherFunc: MatcherFunc,
+): Record<string, unknown>[] => {
+	const item = input.filter(matcherFunc);
+
+	return item;
+};

package/src/utils/keys.ts

@@ -1 +1,7 @@
-export const getJoinFinalKey = (key: string) => key.substring(1);
+export const getJoinFinalKey = (key: string) => {
+	if (key[0] !== "_") {
+		throw new Error("Joining key must start with underscore.");
+	}
+
+	return key.substring(1);
+};

package/src/utils/matcher.ts

@@ -1,8 +1,16 @@
-import type { TInputBase } from "~/types/generic-bases";
-import type { InvertedInput } from "./invertInput";
-import type { Output } from "~/types/generic-less";
-
-export const matcherFunc =
-	<TInput extends TInputBase>(row: TInput[keyof TInput], value: Output) =>
-	(item: InvertedInput[keyof InvertedInput][number]) =>
-		row?.[value.joinsFrom as string] === item?.[value.joinsTo as string];
+import type { TInputBase, TInputBaseJoin } from "~/types/generic-bases";
+import type { InvertedInput } from "./invertInput";
+import type { Output } from "~/types/generic-less";
+
+export type MatcherFunc = (
+	item: TInputBaseJoin | null,
+) => item is TInputBaseJoin;
+
+export const createMatcherFunc =
+	<TInput extends TInputBase>(
+		row: TInput[keyof TInput],
+		value: Output,
+	): MatcherFunc =>
+	(item): item is TInputBaseJoin =>
+		!!item &&
+		row?.[value.joinsFrom as string] === item?.[value.joinsTo as string];