From f734c701709099f38560076ac0983cc17166e150 Mon Sep 17 00:00:00 2001
From: Kharazyan Aram <armxaz@gmail.com>
Date: Sat, 14 Oct 2023 11:12:05 +0400
Subject: [PATCH] fix(propEq): improve propEq typings

* remove unnecessary constraint from propEq value: the function should receive any type values of object, no matter what parameter it received;
* add additional types to use with placeholder
---
 test/anyPass.test.ts |   2 +-
 test/propEq.test.ts  | 114 ++++++++++++++++++++++++++++++++++++++-----
 types/propEq.d.ts    |  36 ++++++++++++--
 3 files changed, 133 insertions(+), 19 deletions(-)

diff --git a/test/anyPass.test.ts b/test/anyPass.test.ts
index ff46aa58..b3f96319 100644
--- a/test/anyPass.test.ts
+++ b/test/anyPass.test.ts
@@ -25,7 +25,7 @@ expectType<boolean>(
   })
 );
 
-expectError(
+expectType<boolean>(
   isVampire({
     age: 21,
     garlic_allergy: true,
diff --git a/test/propEq.test.ts b/test/propEq.test.ts
index dc5b9098..7a6f6c8a 100644
--- a/test/propEq.test.ts
+++ b/test/propEq.test.ts
@@ -1,39 +1,127 @@
 import { expectError, expectType } from 'tsd';
 
-import { propEq } from '../es';
+import {__, propEq} from '../es';
 
 type Obj = {
   union: 'foo' | 'bar';
   str: string;
-  num: number;
+  int: number;
+  numLike: number | `${number}`;
+  optional?: string;
+  nullable: string | null;
   u: undefined;
   n: null;
 };
+type NumArr = number[];
 
+// ######################
 // propEq(val, name, obj)
 expectType<boolean>(propEq('foo', 'union', {} as Obj));
-// non-union string fails
-expectError(propEq('nope', 'union', {} as Obj));
-// completely different type fails
-expectError(propEq(2, 'union', {} as Obj));
+// propEq doesn't create unnecessary values constraint for object
+expectType<boolean>(propEq('1', 'union', {} as Obj));
+// union of number with literal types should work fine
+expectType<boolean>(propEq(1, 'numLike', {} as Obj));
+expectType<boolean>(propEq('1', 'numLike', {} as Obj));
+// optional types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str', 'optional', {} as Obj));
+expectType<boolean>(propEq(undefined, 'optional', {} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1, 'optional', {} as Obj));
+expectError(propEq(null, 'optional', {} as Obj));
+// nullable types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str', 'nullable', {} as Obj));
+expectType<boolean>(propEq(null, 'nullable', {} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1, 'nullable', {} as Obj));
+expectError(propEq(undefined, 'nullable', {} as Obj));
+// unknown field names fails
+expectError(propEq('foo', 'unknown', {} as Obj));
+// should work with arrays as well
+expectType<boolean>(propEq(1, 0, [] as NumArr));
+// numeric array should expect only numbers
+expectError(propEq('foo', 0, [] as NumArr));
+// array can't accept string as prop name
+expectError(propEq(1, 'foo', [] as NumArr));
 
+// ######################
 // propEq(val)(name)(obj)
 expectType<boolean>(propEq('foo')('union')({} as Obj));
 // 'nope' is inferred as 'string' here.
 expectType<boolean>(propEq('nope')('union')({} as Obj));
-// completely different type fails
-expectError(propEq(2)('union')({} as Obj));
+// union of number with literal types should work fine
+expectType<boolean>(propEq(1)('numLike')({} as Obj));
+expectType<boolean>(propEq('1')('numLike')({} as Obj));
+// optional types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str')('optional')({} as Obj));
+expectType<boolean>(propEq(undefined)('optional')({} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1)('optional')({} as Obj));
+expectError(propEq(null)('optional')({} as Obj));
+// nullable types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str')('nullable')({} as Obj));
+expectType<boolean>(propEq(null)('nullable')({} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1)('nullable')({} as Obj));
+expectError(propEq(undefined)('nullable')({} as Obj));
+// unknown field names fails
+expectError(propEq('foo')('unknown')({} as Obj));
 
-// propEq(val)(name), obj)
+// ######################
+// propEq(val)(name, obj)
 expectType<boolean>(propEq('foo')('union', {} as Obj));
 // 'nope' is inferred as 'string' here.
 expectType<boolean>(propEq('nope')('union', {} as Obj));
-// completely different type fails
-expectError(propEq(2)('union', {} as Obj));
+// union of number with literal types should work fine
+expectType<boolean>(propEq(1)('numLike', {} as Obj));
+expectType<boolean>(propEq('1')('numLike', {} as Obj));
+// optional types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str')('optional', {} as Obj));
+expectType<boolean>(propEq(undefined)('optional', {} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1)('optional', {} as Obj));
+expectError(propEq(null)('optional', {} as Obj));
+// nullable types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str')('nullable', {} as Obj));
+expectType<boolean>(propEq(null)('nullable', {} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1)('nullable', {} as Obj));
+expectError(propEq(undefined)('nullable', {} as Obj));
+// unknown field names fails
+expectError(propEq('foo')('unknown', {} as Obj));
 
+// ######################
 // propEq(val, name)(obj)
 expectType<boolean>(propEq('foo', 'union')({} as Obj));
 // 'nope' is inferred as 'string' here.
 expectType<boolean>(propEq('nope', 'union')({} as Obj));
-// completely different type fails
-expectError(propEq(2, 'union')({} as Obj));
+// union of number with literal types should work fine
+expectType<boolean>(propEq(1, 'numLike')({} as Obj));
+expectType<boolean>(propEq('1', 'numLike')({} as Obj));
+// optional types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str', 'optional')({} as Obj));
+expectType<boolean>(propEq(undefined, 'optional')({} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1, 'optional')({} as Obj));
+expectError(propEq(null, 'optional')({} as Obj));
+// nullable types doesn't fire an error, if passed correct types
+expectType<boolean>(propEq('str', 'nullable')({} as Obj));
+expectType<boolean>(propEq(null, 'nullable')({} as Obj));
+// fires an error only on wrong type
+expectError(propEq(1, 'nullable')({} as Obj));
+expectError(propEq(undefined, 'nullable')({} as Obj));
+// unknown field names fails
+expectError(propEq('foo', 'unknown')({} as Obj));
+
+// ##########################
+// propEq(__, name, obj)(val)
+expectType<boolean>(propEq(__, 'union', {} as Obj)('foo'));
+// propEq(val, __, obj)(val)
+expectType<boolean>(propEq('foo', __, {} as Obj)('union'));
+// propEq(__, __, obj)(val, name)
+expectType<boolean>(propEq(__, __, {} as Obj)('foo', 'union'));
+// propEq(__, __, obj)(val)(name)
+expectType<boolean>(propEq(__, __, {} as Obj)('foo')('union'));
+
+expectError(propEq('foo', __, {} as Obj)('unknown'));
+expectError(propEq(__, __, {} as Obj)('foo', 'unknown'));
+expectError(propEq(__, __, {} as Obj)('foo')('unknown'));
diff --git a/types/propEq.d.ts b/types/propEq.d.ts
index e667fb28..b5461f7c 100644
--- a/types/propEq.d.ts
+++ b/types/propEq.d.ts
@@ -1,6 +1,32 @@
-export function propEq<T>(val: T): {
-  <K extends PropertyKey>(name: K): (obj: Record<K, T>) => boolean;
-  <K extends PropertyKey>(name: K, obj: Record<K, T>): boolean;
+import { Placeholder } from 'ramda';
+import { WidenLiterals } from '../util/tools';
+
+export function propEq(__: Placeholder): never;
+export function propEq<V>(val: V): {
+  <K extends PropertyKey>(name: K): K extends number
+    ? (array: Array<WidenLiterals<V>>) => boolean
+    : (obj: Record<K, WidenLiterals<V>>) => boolean;
+  <const U>(__: Placeholder, obj: U): (name: keyof U) => boolean;
+  <K extends keyof U, const U>(name: K, obj: U): boolean;
 };
-export function propEq<T, K extends PropertyKey>(val: T, name: K): (obj: Record<K, T>) => boolean;
-export function propEq<K extends keyof U, U>(val: U[K], name: K, obj: U): boolean;
+export function propEq<K extends PropertyKey>(__: Placeholder, name: K): K extends number ? {
+  <U extends any[]>(__: Placeholder, array: U): (val: WidenLiterals<U[K]>) => boolean;
+  <U extends any[]>(val: WidenLiterals<U[K]>, array: U): boolean
+  <V>(val: V): (array: Array<WidenLiterals<V>>) => boolean
+} : {
+  <U extends Record<K, any>>(__: Placeholder, obj: U): (val: WidenLiterals<U[K]>) => boolean;
+  <U extends Record<K, any>>(val: WidenLiterals<U[K]>, obj: U): boolean
+  <V>(val: V): (obj: Record<K, WidenLiterals<V>>) => boolean
+};
+export function propEq<V, K extends PropertyKey>(val: V, name: K): K extends number ?
+  (array: Array<WidenLiterals<V>>) => boolean :
+  (obj: Record<K, WidenLiterals<V>>) => boolean;
+
+export function propEq<U>(__: Placeholder, ___: Placeholder, obj: U): {
+  <K extends keyof U>(__: Placeholder, name: K): (val: WidenLiterals<U[K]>) => boolean
+  <K extends keyof U>(val: WidenLiterals<U[K]>, name: K): boolean;
+  <K extends keyof U>(val: WidenLiterals<U[K]>): (name: K) => boolean;
+};
+export function propEq<K extends keyof U, const U>(__: Placeholder, name: K, obj: U): (val: WidenLiterals<U[K]>) => boolean;
+export function propEq<K extends keyof U, const U>(val: WidenLiterals<U[K]>, __: Placeholder, obj: U): (name: K) => boolean;
+export function propEq<K extends keyof U, const U>(val: WidenLiterals<U[K]>, name: K, obj: U): boolean;