ci: 📦 add typecheck for 5.3 and 5.4 (#382)

* ci: 📦 add typecheck for 5.3 and 5.4 * test: 🧪 comment 'as const' examples * fix: 🧪 WeakSet & WeakMap * docs: 📄 changeset
ts-essentials · Apr 6, 2024 · f88f757 · f88f757
1 parent 852a08f
commit f88f757
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 25 deletions.
diff --git a/.changeset/short-hairs-flash.md b/.changeset/short-hairs-flash.md
@@ -0,0 +1,5 @@
+---
+"ts-essentials": patch
+---
+
+Add TypeScript 5.3 and 5.4 support (fix a bug with `WeakKey` for `WeakSet` and `WeakMap`)
diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml
@@ -14,7 +14,22 @@ jobs:
         node: ["14.x"]
         os: [ubuntu-latest]
         typescript:
-          ["4.1.5", "4.2.4", "4.3.5", "4.4.4", "4.5.5", "4.6.4", "4.7.4", "4.8.4", "4.9.4", "5.0.4", "5.1.6", "5.2.2"]
+          [
+            "4.1.5",
+            "4.2.4",
+            "4.3.5",
+            "4.4.4",
+            "4.5.5",
+            "4.6.4",
+            "4.7.4",
+            "4.8.4",
+            "4.9.4",
+            "5.0.4",
+            "5.1.6",
+            "5.2.2",
+            "5.3.3",
+            "5.4.3",
+          ]
     runs-on: ${{ matrix.os }}
 
     steps:

diff --git a/lib/deep-nullable/index.ts b/lib/deep-nullable/index.ts
@@ -8,13 +8,21 @@ export type DeepNullable<Type> = Type extends Builtin
   : Type extends ReadonlyMap<infer Keys, infer Values>
   ? ReadonlyMap<DeepNullable<Keys>, DeepNullable<Values>>
   : Type extends WeakMap<infer Keys, infer Values>
-  ? WeakMap<DeepNullable<Keys>, DeepNullable<Values>>
+  ? // TODO: replace it with WeakKey (introduced at TypeScript@5.2)
+    // WeakMap key has to satisfy WeakKey which is object at the moment
+    DeepNullable<Keys> extends object
+    ? WeakMap<DeepNullable<Keys>, DeepNullable<Values>>
+    : never
   : Type extends Set<infer Values>
   ? Set<DeepNullable<Values>>
   : Type extends ReadonlySet<infer Values>
   ? ReadonlySet<DeepNullable<Values>>
   : Type extends WeakSet<infer Values>
-  ? WeakSet<DeepNullable<Values>>
+  ? // TODO: replace it with WeakKey (introduced at TypeScript@5.2)
+    // WeakSet key has to satisfy WeakKey which is object at the moment
+    DeepNullable<Values> extends object
+    ? WeakSet<DeepNullable<Values>>
+    : never
   : Type extends ReadonlyArray<infer Values>
   ? Type extends IsTuple<Type>
     ? { [Key in keyof Type]: DeepNullable<Type[Key]> | null }

diff --git a/lib/deep-undefinable/index.ts b/lib/deep-undefinable/index.ts
@@ -8,13 +8,21 @@ export type DeepUndefinable<Type> = Type extends Builtin
   : Type extends ReadonlyMap<infer Keys, infer Values>
   ? ReadonlyMap<DeepUndefinable<Keys>, DeepUndefinable<Values>>
   : Type extends WeakMap<infer Keys, infer Values>
-  ? WeakMap<DeepUndefinable<Keys>, DeepUndefinable<Values>>
+  ? // TODO: replace it with WeakKey (introduced at TypeScript@5.2)
+    // WeakMap key has to satisfy WeakKey which is object at the moment
+    DeepUndefinable<Keys> extends object
+    ? WeakMap<DeepUndefinable<Keys>, DeepUndefinable<Values>>
+    : never
   : Type extends Set<infer Values>
   ? Set<DeepUndefinable<Values>>
   : Type extends ReadonlySet<infer Values>
   ? ReadonlySet<DeepUndefinable<Values>>
   : Type extends WeakSet<infer Values>
-  ? WeakSet<DeepUndefinable<Values>>
+  ? // TODO: replace it with WeakKey (introduced at TypeScript@5.2)
+    // WeakSet key has to satisfy WeakKey which is object at the moment
+    DeepUndefinable<Values> extends object
+    ? WeakSet<DeepUndefinable<Values>>
+    : never
   : Type extends ReadonlyArray<infer Values>
   ? Type extends IsTuple<Type>
     ? { [Key in keyof Type]: DeepUndefinable<Type[Key]> | undefined }

diff --git a/test/deep-pick.ts b/test/deep-pick.ts
@@ -65,8 +65,8 @@ function testDeepPickInRequiredObject() {
   // @ts-expect-error
   obj5 = { nested: { array: undefined } };
   obj5 = { nested: { array: [] } };
-  // @ts-expect-error
-  obj5 = { nested: { array: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj5 = { nested: { array: [] as const } };
   // @ts-expect-error
   obj5 = { nested: { array: ["1"] } };
   // @ts-expect-error
@@ -81,8 +81,8 @@ function testDeepPickInRequiredObject() {
   // @ts-expect-error
   obj5_1 = { nested: { array: undefined } };
   obj5_1 = { nested: { array: [] } };
-  // @ts-expect-error
-  obj5_1 = { nested: { array: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj5_1 = { nested: { array: [] as const } };
   // @ts-expect-error
   obj5_1 = { nested: { array: ["1"] } };
   // @ts-expect-error
@@ -101,8 +101,8 @@ function testDeepPickInRequiredObject() {
   // @ts-expect-error
   obj6 = { nested: { tuple: [] as const } };
   obj6 = { nested: { tuple: ["1", 2, { good: true }] } };
-  // @ts-expect-error
-  obj6 = { nested: { tuple: ["1", 2, { good: true }] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6 = { nested: { tuple: ["1", 2, { good: true }] as const } };
 
   let obj6_1: DeepPick<ComplexNestedRequired, { nested: { tuple: never } }>;
   // @ts-expect-error
@@ -116,8 +116,8 @@ function testDeepPickInRequiredObject() {
   // @ts-expect-error
   obj6_1 = { nested: { tuple: [] as const } };
   obj6_1 = { nested: { tuple: ["1", 2, { good: true }] } };
-  // @ts-expect-error
-  obj6_1 = { nested: { tuple: ["1", 2, { good: true }] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6_1 = { nested: { tuple: ["1", 2, { good: true }] as const } };
 
   let obj7: DeepPick<ComplexNestedRequired, { nested: { set: true } }>;
   // @ts-expect-error
@@ -268,8 +268,8 @@ function testDeepPickInPartialObject() {
   obj5 = { nested: undefined };
   obj5 = { nested: { array: undefined } };
   obj5 = { nested: { array: [] } };
-  // @ts-expect-error
-  obj5 = { nested: { array: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj5 = { nested: { array: [] as const } };
   // @ts-expect-error
   obj5 = { nested: { array: ["1"] } };
   // @ts-expect-error
@@ -281,8 +281,8 @@ function testDeepPickInPartialObject() {
   obj5_1 = { nested: undefined };
   obj5_1 = { nested: { array: undefined } };
   obj5_1 = { nested: { array: [] } };
-  // @ts-expect-error
-  obj5_1 = { nested: { array: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj5_1 = { nested: { array: [] as const } };
   // @ts-expect-error
   obj5_1 = { nested: { array: ["1"] } };
   // @ts-expect-error
@@ -294,22 +294,22 @@ function testDeepPickInPartialObject() {
   obj6 = { nested: undefined };
   obj6 = { nested: { tuple: undefined } };
   obj6 = { nested: { tuple: [] } };
-  // @ts-expect-error
-  obj6 = { nested: { tuple: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6 = { nested: { tuple: [] as const } };
   obj6 = { nested: { tuple: ["1", 2, { good: true }] } };
-  // @ts-expect-error
-  obj6 = { nested: { tuple: ["1", 2, { good: true }] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6 = { nested: { tuple: ["1", 2, { good: true }] as const } };
 
   let obj6_1: DeepPick<ComplexNestedPartial, { nested: { tuple: never } }>;
   obj6_1 = {};
   obj6_1 = { nested: undefined };
   obj6_1 = { nested: { tuple: undefined } };
   obj6_1 = { nested: { tuple: [] } };
-  // @ts-expect-error
-  obj6_1 = { nested: { tuple: [] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6_1 = { nested: { tuple: [] as const } };
   obj6_1 = { nested: { tuple: ["1", 2, { good: true }] } };
-  // @ts-expect-error
-  obj6_1 = { nested: { tuple: ["1", 2, { good: true }] as const } };
+  // It doesn't throw TypeError for TypeScript>=5.3
+  // obj6_1 = { nested: { tuple: ["1", 2, { good: true }] as const } };
 
   let obj7: DeepPick<ComplexNestedPartial, { nested: { set: true } }>;
   obj7 = {};

diff --git a/test/index.ts b/test/index.ts
@@ -253,6 +253,7 @@ function testDeepNullable() {
     Assert<IsExact<DeepNullable<Set<number[]>>, Set<(number | null)[]>>>,
     Assert<IsExact<DeepNullable<Set<readonly number[]>>, Set<readonly (number | null)[]>>>,
     Assert<IsExact<DeepNullable<ReadonlySet<string>>, ReadonlySet<string | null>>>,
+    Assert<IsExact<DeepNullable<WeakSet<{ a: string }>>, WeakSet<{ a: string | null }>>>,
     Assert<IsExact<DeepNullable<[]>, []>>,
     Assert<IsExact<DeepNullable<readonly []>, readonly []>>,
     Assert<IsExact<DeepNullable<never[]>, null[]>>,
@@ -316,6 +317,7 @@ function testDeepUndefinable() {
     Assert<IsExact<DeepUndefinable<Set<number[]>>, Set<(number | undefined)[]>>>,
     Assert<IsExact<DeepUndefinable<Set<readonly number[]>>, Set<readonly (number | undefined)[]>>>,
     Assert<IsExact<DeepUndefinable<ReadonlySet<string>>, ReadonlySet<string | undefined>>>,
+    Assert<IsExact<DeepUndefinable<WeakSet<{ a: string }>>, WeakSet<{ a: string | undefined }>>>,
     Assert<IsExact<DeepUndefinable<[]>, []>>,
     Assert<IsExact<DeepUndefinable<readonly []>, readonly []>>,
     Assert<IsExact<DeepUndefinable<never[]>, undefined[]>>,