Add support for exactOptionalPropertyTypes #385

fabian-hiller · Aug 23, 2024 · 4d8a1db · 4d8a1db
1 parent 63a8965
commit 4d8a1db
Show file tree

Hide file tree

Showing 29 changed files with 224 additions and 148 deletions.
diff --git a/library/CHANGELOG.md b/library/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Add support for `exactOptionalPropertyTypes` config (issue #385)
+
 ## v0.38.0 (August 20, 2024)
 
 - Change `expects` and `expected` property by enclosing combined values in parentheses

diff --git a/library/src/actions/partialCheck/partialCheck.test.ts b/library/src/actions/partialCheck/partialCheck.test.ts
@@ -211,7 +211,6 @@ describe('partialCheck', () => {
  tuple: [123, { key: 'foo' }, 456],
  other: 'bar',
  },
- issues: undefined,
  };
  expect(action._run(dataset, {})).toStrictEqual(dataset);
  });
@@ -227,7 +226,6 @@ describe('partialCheck', () => {
  const dataset: TypedDataset<Input, never> = {
  typed: true,
  value: input,
- issues: undefined,
  };
  expect(action._run(dataset, {})).toStrictEqual({
  ...dataset,

diff --git a/library/src/actions/partialCheck/partialCheckAsync.test.ts b/library/src/actions/partialCheck/partialCheckAsync.test.ts
@@ -215,7 +215,6 @@ describe('partialCheckAsync', () => {
  tuple: [123, { key: 'foo' }, 456],
  other: 'bar',
  },
- issues: undefined,
  };
  expect(await action._run(dataset, {})).toStrictEqual(dataset);
  });
@@ -231,7 +230,6 @@ describe('partialCheckAsync', () => {
  const dataset: TypedDataset<Input, never> = {
  typed: true,
  value: input,
- issues: undefined,
  };
  expect(await action._run(dataset, {})).toStrictEqual({
  ...dataset,

diff --git a/library/src/actions/partialCheck/utils/_isPartiallyTyped/_isPartiallyTyped.test.ts b/library/src/actions/partialCheck/utils/_isPartiallyTyped/_isPartiallyTyped.test.ts
@@ -131,7 +131,6 @@ describe('_isPartiallyTyped', () => {
  const dataset: TypedDataset<Input, never> = {
  typed: true,
  value: input,
- issues: undefined,
  };
  expect(_isPartiallyTyped(dataset, pathList)).toBe(true);
  });

diff --git a/library/src/actions/rawCheck/types.ts b/library/src/actions/rawCheck/types.ts
@@ -24,12 +24,12 @@ export interface RawCheckIssue<TInput> extends BaseIssue<TInput> {
  * Issue info type.
  */
 interface IssueInfo<TInput> {
- label?: string;
- input?: unknown;
- expected?: string;
- received?: string;
- message?: ErrorMessage<RawCheckIssue<TInput>>;
- path?: [IssuePathItem, ...IssuePathItem[]];
+ label?: string | undefined;
+ input?: unknown | undefined;
+ expected?: string | undefined;
+ received?: string | undefined;
+ message?: ErrorMessage<RawCheckIssue<TInput>> | undefined;
+ path?: [IssuePathItem, ...IssuePathItem[]] | undefined;
 }
 
 /**

diff --git a/library/src/actions/rawTransform/types.ts b/library/src/actions/rawTransform/types.ts
@@ -24,12 +24,12 @@ export interface RawTransformIssue<TInput> extends BaseIssue<TInput> {
  * Issue info type.
  */
 interface IssueInfo<TInput> {
- label?: string;
- input?: unknown;
- expected?: string;
- received?: string;
- message?: ErrorMessage<RawTransformIssue<TInput>>;
- path?: [IssuePathItem, ...IssuePathItem[]];
+ label?: string | undefined;
+ input?: unknown | undefined;
+ expected?: string | undefined;
+ received?: string | undefined;
+ message?: ErrorMessage<RawTransformIssue<TInput>> | undefined;
+ path?: [IssuePathItem, ...IssuePathItem[]] | undefined;
 }
 
 /**

diff --git a/library/src/methods/partial/partial.test-d.ts b/library/src/methods/partial/partial.test-d.ts
@@ -44,30 +44,30 @@ describe('partial', () => {
  describe('should infer correct types', () => {
  test('of input', () => {
  expectTypeOf<InferInput<Schema1>>().toEqualTypeOf<{
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  }>();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<{
- key1?: string | undefined;
+ key1?: string;
  key2: number;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key3?: string;
+ key4?: number | null;
  }>();
  });
 
  test('of output', () => {
  expectTypeOf<InferOutput<Schema1>>().toEqualTypeOf<{
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number;
  }>();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<{
- key1?: string | undefined;
+ key1?: string;
  key2: number;
- key3?: string | undefined;
+ key3?: string;
  key4: number;
  }>();
  });
@@ -105,36 +105,36 @@ describe('partial', () => {
  test('of input', () => {
  expectTypeOf<InferInput<Schema1>>().toEqualTypeOf<
  {
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<
  {
  key1: string;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  });
 
  test('of output', () => {
  expectTypeOf<InferOutput<Schema1>>().toEqualTypeOf<
  {
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number;
  } & { [key: string]: boolean }
  >();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<
  {
  key1: string;
- key2?: number | undefined;
- key3?: string | undefined;
+ key2?: number;
+ key3?: string;
  key4: number;
  } & { [key: string]: boolean }
  >();

diff --git a/library/src/methods/partial/partialAsync.test-d.ts b/library/src/methods/partial/partialAsync.test-d.ts
@@ -44,30 +44,30 @@ describe('partialAsync', () => {
  describe('should infer correct types', () => {
  test('of input', () => {
  expectTypeOf<InferInput<Schema1>>().toEqualTypeOf<{
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  }>();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<{
- key1?: string | undefined;
+ key1?: string;
  key2: number;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key3?: string;
+ key4?: number | null;
  }>();
  });
 
  test('of output', () => {
  expectTypeOf<InferOutput<Schema1>>().toEqualTypeOf<{
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number;
  }>();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<{
- key1?: string | undefined;
+ key1?: string;
  key2: number;
- key3?: string | undefined;
+ key3?: string;
  key4: number;
  }>();
  });
@@ -105,36 +105,36 @@ describe('partialAsync', () => {
  test('of input', () => {
  expectTypeOf<InferInput<Schema1>>().toEqualTypeOf<
  {
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<
  {
  key1: string;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | null | undefined;
+ key2?: number;
+ key3?: string;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  });
 
  test('of output', () => {
  expectTypeOf<InferOutput<Schema1>>().toEqualTypeOf<
  {
- key1?: string | undefined;
- key2?: number | undefined;
- key3?: string | undefined;
- key4?: number | undefined;
+ key1?: string;
+ key2?: number;
+ key3?: string;
+ key4?: number;
  } & { [key: string]: boolean }
  >();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<
  {
  key1: string;
- key2?: number | undefined;
- key3?: string | undefined;
+ key2?: number;
+ key3?: string;
  key4: number;
  } & { [key: string]: boolean }
  >();

diff --git a/library/src/methods/required/required.test-d.ts b/library/src/methods/required/required.test-d.ts
@@ -55,9 +55,9 @@ describe('required', () => {
  }>();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<{
  key1: string;
- key2?: number | undefined;
+ key2?: number;
  key3: string;
- key4?: number | null | undefined;
+ key4?: number | null;
  }>();
  });
 
@@ -70,7 +70,7 @@ describe('required', () => {
  }>();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<{
  key1: string;
- key2?: number | undefined;
+ key2?: number;
  key3: string;
  key4: number;
  }>();
@@ -119,10 +119,10 @@ describe('required', () => {
  >();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<
  {
- key1?: string | undefined;
+ key1?: string;
  key2: number;
  key3: string;
- key4?: number | null | undefined;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  });
@@ -138,7 +138,7 @@ describe('required', () => {
  >();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<
  {
- key1?: string | undefined;
+ key1?: string;
  key2: number;
  key3: string;
  key4: number;

diff --git a/library/src/methods/required/requiredAsync.test-d.ts b/library/src/methods/required/requiredAsync.test-d.ts
@@ -63,9 +63,9 @@ describe('requiredAsync', () => {
  }>();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<{
  key1: string;
- key2?: number | undefined;
+ key2?: number;
  key3: string;
- key4?: number | null | undefined;
+ key4?: number | null;
  }>();
  });
 
@@ -78,7 +78,7 @@ describe('requiredAsync', () => {
  }>();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<{
  key1: string;
- key2?: number | undefined;
+ key2?: number;
  key3: string;
  key4: number;
  }>();
@@ -131,10 +131,10 @@ describe('requiredAsync', () => {
  >();
  expectTypeOf<InferInput<Schema2>>().toEqualTypeOf<
  {
- key1?: string | undefined;
+ key1?: string;
  key2: number;
  key3: string;
- key4?: number | null | undefined;
+ key4?: number | null;
  } & { [key: string]: boolean }
  >();
  });
@@ -150,7 +150,7 @@ describe('requiredAsync', () => {
  >();
  expectTypeOf<InferOutput<Schema2>>().toEqualTypeOf<
  {
- key1?: string | undefined;
+ key1?: string;
  key2: number;
  key3: string;
  key4: number;

diff --git a/library/src/schemas/looseObject/looseObject.test-d.ts b/library/src/schemas/looseObject/looseObject.test-d.ts
@@ -54,8 +54,8 @@ describe('looseObject', () => {
  expectTypeOf<InferInput<Schema>>().toEqualTypeOf<
  {
  key1: string;
- key2?: string | undefined;
- key3?: string | null | undefined;
+ key2?: string;
+ key3?: string | null;
  key4: { key: number };
  key5: string;
  } & { [key: string]: unknown }
@@ -67,7 +67,7 @@ describe('looseObject', () => {
  {
  key1: string;
  key2: string;
- key3?: string | null | undefined;
+ key3?: string | null;
  key4: { key: number };
  readonly key5: string;
  } & { [key: string]: unknown }

diff --git a/library/src/schemas/looseObject/looseObject.test.ts b/library/src/schemas/looseObject/looseObject.test.ts
@@ -134,6 +134,7 @@ describe('looseObject', () => {
  test('for optional entry', () => {
  expectNoSchemaIssue(looseObject({ key: optional(string()) }), [
  {},
+ // @ts-expect-error
  { key: undefined },
  { key: 'foo' },
  ]);
@@ -142,6 +143,7 @@ describe('looseObject', () => {
  test('for nullish entry', () => {
  expectNoSchemaIssue(looseObject({ key: nullish(number()) }), [
  {},
+ // @ts-expect-error
  { key: undefined },
  { key: null },
  { key: 123 },