[Snyk] Upgrade expect-type from 0.15.0 to 0.19.0

[Carolinewly]

Snyk has created this PR to upgrade expect-type from 0.15.0 to 0.19.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

---

• The recommended version is 10 versions ahead of your current version.

• The recommended version was released on 4 months ago.

Release notes

Package name: expect-type

• 0.19.0 - 2024-03-21
  

  What's Changed

  • Fix .omit() to work similarly to Omit by @ aryaemami59 in #54
  • Add JSDocs to everything by @ aryaemami59 in #56
  • Remove test import in README.md by @ aryaemami59 in #65

  Full Changelog: 0.18.0...0.19.0

• 0.18.0 - 2024-02-26
  

  What's Changed

  • Add .pick and .omit by @ aryaemami59 in #51

  New Contributors

  • @ aryaemami59 made their first contribution in #51

  Full Changelog: v0.17.3...0.18.0

• 0.17.3 - 2023-10-03
  
  • docs: why-is-my-assertion-failing 907b8aa
  • I think the previous build was out of date somehow too, so see https://github.com/mmkal/expect-type/releases/v0.17.2

  v0.17.3-0...v0.17.3

• 0.17.3-0 - 2023-10-03
  

  0.17.3-0

• 0.17.2 - 2023-10-03
  
  • Improve tuple errors (#40) 4b38117

  Diff(truncated - scroll right!):

  test('toEqualTypeOf with tuples', () => {
    const assertion = `expectTypeOf<[[number], [1], []]>().toEqualTypeOf<[[number], [2], []]>()`
    expect(tsErrors(assertion)).toMatchInlineSnapshot(`
  -    "test/test.ts:999:999 - error TS2344: Type '[[number], [2], []]' does not satisfy the constraint '{ [x: number]: { [x: number]: number; [iterator]: (() => IterableIterator<1>) | (() => IterableIterator<number>) | (() => IterableIterator<never>); [unscopables]: (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }) | (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }) | (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }); length: 0 | 1; toString:  ... truncated!!!!'.
  -      Types of property 'sort' are incompatible.
  -        Type '(compareFn?: ((a: [] | [number] | [2], b: [] | [number] | [2]) => number) | undefined) => [[number], [2], []]' is not assignable to type '\\"Expected: function, Actual: function\\"'.
  +    "test/test.ts:999:999 - error TS2344: Type '[[number], [2], []]' does not satisfy the constraint '{ 0: { 0: number; }; 1: { 0: \\"Expected: literal number: 2, Actual: literal number: 1\\"; }; 2: {}; }'.
  +      The types of '1[0]' are incompatible between these types.
  +        Type '2' is not assignable to type '\\"Expected: literal number: 2, Actual: literal number: 1\\"'.
      999 expectTypeOf<[[number], [1], []]>().toEqualTypeOf<[[number], [2], []]>()
                                                            ~~~~~~~~~~~~~~~~~~~"
    `)
  })

  v0.17.1...v0.17.2

• 0.17.1 - 2023-10-03
  
  • disallow .not and .branded together cf38918

  (this was actually documented in the v0.17.0 release but really it was only pushed here)

  v0.17.0...v0.17.1

• 0.17.0 - 2023-10-03
  

  #16 went in to - hopefully - significantly improve the error messages produce on failing assertions. Here's an example of how vitest's failing tests were improved:

  Before:

  

  After:

  

  Docs copied from the readme about how to interpret these error messages

  ---

  Error messages

  When types don't match, .toEqualTypeOf and .toMatchTypeOf use a special helper type to produce error messages that are as actionable as possible. But there's a bit of an nuance to understanding them. Since the assertions are written "fluently", the failure should be on the "expected" type, not the "actual" type (expect<Actual>().toEqualTypeOf<Expected>()). This means that type errors can be a little confusing - so this library produces a MismatchInfo type to try to make explicit what the expectation is. For example:

  expectTypeOf({a: 1}).toEqualTypeOf<{a: string}>()

  Is an assertion that will fail, since {a: 1} has type {a: number} and not {a: string}. The error message in this case will read something like this:

  test/test.ts:999:999 - error TS2344: Type '{ a: string; }' does not satisfy the constraint '{ a: \"Expected: string, Actual: number\"; }'.
  Types of property 'a' are incompatible.
  Type 'string' is not assignable to type '\"Expected: string, Actual: number\"'.

  999 expectTypeOf({a: 1}).toEqualTypeOf<{a: string}>()


  Note that the type constraint reported is a human-readable messaging specifying both the "expected" and "actual" types. Rather than taking the sentence Types of property 'a' are incompatible // Type 'string' is not assignable to type "Expected: string, Actual: number" literally - just look at the property name ('a') and the message: Expected: string, Actual: number. This will tell you what's wrong, in most cases. Extremely complex types will of course be more effort to debug, and may require some experimentation. Please raise an issue if the error messages are actually misleading.

  The toBe... methods (like toBeString, toBeNumber, toBeVoid etc.) fail by resolving to a non-callable type when the Actual type under test doesn't match up. For example, the failure for an assertion like expectTypeOf(1).toBeString() will look something like this:

  test/test.ts:999:999 - error TS2349: This expression is not callable.
  Type 'ExpectString<number>' has no call signatures.

  999 expectTypeOf(1).toBeString()
~~~~~~~~~~


  The This expression is not callable part isn't all that helpful - the meaningful error is the next line, Type 'ExpectString<number> has no call signatures. This essentially means you passed a number but asserted it should be a string.

  If TypeScript added support for "throw" types these error messagess could be improved. Until then they will take a certain amount of squinting.

  Concrete "expected" objects vs typeargs

  Error messages for an assertion like this:

  expectTypeOf({a: 1}).toEqualTypeOf({a: ''})

  Will be less helpful than for an assertion like this:

  expectTypeOf({a: 1}).toEqualTypeOf<{a: string}>()

  This is because the TypeScript compiler needs to infer the typearg for the .toEqualTypeOf({a: ''}) style, and this library can only mark it as a failure by comparing it against a generic Mismatch type. So, where possible, use a typearg rather than a concrete type for .toEqualTypeOf and toMatchTypeOf. If it's much more convenient to compare two concrete types, you can use typeof:

  const one = valueFromFunctionOne({some: {complex: inputs}})
  const two = valueFromFunctionTwo({some: {other: inputs}})

  expectTypeOf(one).toEqualTypeof<typeof two>()

  ---

  Kinda-breaking changes: essentially none, but technically, .branded no longer returns a "full" ExpectTypeOf instance at compile-time. Previously you could do this:

  expectTypeOf<{a: {b: 1} & {c: 1}}>().branded.not.toEqualTypeOf<{a: {b: 1; c: ''}}>()
  expectTypeOf<{a: {b: 1} & {c: 1}}>().not.branded.toEqualTypeOf<{a: {b: 1; c: ''}}>()

  Now that won't work (and it was always slightly nonsensical), so you'd have to use // @ ts-expect-error instead of not if you have a negated case where you need branded:

  // @ ts-expect-error
  expectTypeOf<{a: {b: 1} & {c: 1}}>().branded.not.toEqualTypeOf<{a: {b: 1; c: ''}}>()

  ---

  What's Changed

  • Improve CLI error messages by @ mmkal in #16
  • expect-type is usually a dev dependency by @ SerkanSipahi in #39

  New Contributors

  • @ SerkanSipahi made their first contribution in #39

  Full Changelog: v0.16.0...v0.17.0

• 0.17.0-2 - 2023-10-02
  

  0.17.0-2

• 0.17.0-1 - 2023-10-01
• 0.16.0 - 2023-05-29
• 0.15.0 - 2022-10-21

from expect-type GitHub release notes

---

Important

• Check the changes in this PR to ensure they won't cause issues with your project.
• This PR was automatically created by Snyk using the credentials of a real user.

---

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

• 🧐 View latest project report
• 📜 Customise PR templates
• 🛠 Adjust upgrade PR settings
• 🔕 Ignore this dependency or unsubscribe from future upgrade PRs