feat: improve ts exactOptionalPropertyTypes support

Author: tmm

.changeset/orange-buckets-smoke.md

@@ -0,0 +1,7 @@
+---
+"@wagmi/connectors": patch
+"@wagmi/core": patch
+"@wagmi/cli": patch
+---
+
+Improved TypeScript `'exactOptionalPropertyTypes'` support.

packages/cli/src/commands/generate.ts

@@ -125,7 +125,7 @@ export async function generate(options: Generate = {}) {
     const content = []
     type Output = {
       plugin: Pick<Plugin, 'name'>
-    } & Awaited<ReturnType<Required<Plugin>['run']>>
+    } & Awaited<ReturnType<NonNullable<Plugin['run']>>>
     const outputs: Output[] = []
     spinner.start('Running plugins')
     for (const plugin of plugins) {

packages/cli/src/plugins/actions.test.ts

@@ -4,7 +4,7 @@ import { expect, test } from 'vitest'
 import { actions } from './actions.js'
 
 test('default', async () => {
-  const result = await actions().run({
+  const result = await actions().run?.({
     contracts: [
       {
         name: 'erc20',
@@ -19,11 +19,11 @@ test('default', async () => {
     outputs: [],
   })
 
-  expect(result.imports).toMatchInlineSnapshot(`
+  expect(result?.imports).toMatchInlineSnapshot(`
     "import { createReadContract, createWriteContract, createSimulateContract, createWatchContractEvent } from '@wagmi/core/codegen'
     "
   `)
-  expect(result.content).toMatchInlineSnapshot(`
+  expect(result?.content).toMatchInlineSnapshot(`
     "/**
      * Wraps __{@link readContract}__ with \`abi\` set to __{@link erc20Abi}__
      */
@@ -117,7 +117,7 @@ test('default', async () => {
 })
 
 test('address', async () => {
-  const result = await actions().run({
+  const result = await actions().run?.({
     contracts: [
       {
         name: 'erc20',
@@ -133,7 +133,7 @@ test('address', async () => {
     outputs: [],
   })
 
-  expect(result.content).toMatchInlineSnapshot(`
+  expect(result?.content).toMatchInlineSnapshot(`
     "/**
      * Wraps __{@link readContract}__ with \`abi\` set to __{@link erc20Abi}__
      */
@@ -227,7 +227,7 @@ test('address', async () => {
 })
 
 test('legacy hook names', async () => {
-  const result = await actions({ getActionName: 'legacy' }).run({
+  const result = await actions({ getActionName: 'legacy' }).run?.({
     contracts: [
       {
         name: 'erc20',
@@ -243,7 +243,7 @@ test('legacy hook names', async () => {
     outputs: [],
   })
 
-  expect(result.content).toMatchInlineSnapshot(`
+  expect(result?.content).toMatchInlineSnapshot(`
     "/**
      * Wraps __{@link readContract}__ with \`abi\` set to __{@link erc20Abi}__
      */
@@ -337,7 +337,7 @@ test('legacy hook names', async () => {
 })
 
 test('override package name', async () => {
-  const result = await actions({ overridePackageName: 'wagmi' }).run({
+  const result = await actions({ overridePackageName: 'wagmi' }).run?.({
     contracts: [
       {
         name: 'erc20',
@@ -352,7 +352,7 @@ test('override package name', async () => {
     outputs: [],
   })
 
-  expect(result.imports).toMatchInlineSnapshot(`
+  expect(result?.imports).toMatchInlineSnapshot(`
     "import { createReadContract, createWriteContract, createSimulateContract, createWatchContractEvent } from 'wagmi/codegen'
     "
   `)

packages/cli/src/plugins/blockExplorer.test.ts

@@ -16,8 +16,8 @@ beforeAll(() => server.listen())
 afterEach(() => server.resetHandlers())
 afterAll(() => server.close())
 
-test('fetches ABI', async () => {
-  await expect(
+test('fetches ABI', () => {
+  expect(
     blockExplorer({
       apiKey,
       baseUrl,
@@ -26,27 +26,27 @@ test('fetches ABI', async () => {
   ).resolves.toMatchSnapshot()
 })
 
-test('fetches ABI with multichain deployment', async () => {
-  await expect(
+test('fetches ABI with multichain deployment', () => {
+  expect(
     blockExplorer({
       apiKey,
       baseUrl,
       contracts: [
         { name: 'WagmiMintExample', address: { 1: address, 10: address } },
       ],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchSnapshot()
 })
 
-test('fails to fetch for unverified contract', async () => {
-  await expect(
+test('fails to fetch for unverified contract', () => {
+  expect(
     blockExplorer({
       apiKey,
       baseUrl,
       contracts: [
         { name: 'WagmiMintExample', address: unverifiedContractAddress },
       ],
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     '[Error: Contract source code not verified]',
   )

packages/cli/src/plugins/etherscan.test.ts

@@ -17,61 +17,61 @@ beforeAll(() => server.listen())
 afterEach(() => server.resetHandlers())
 afterAll(() => server.close())
 
-test('fetches ABI', async () => {
-  await expect(
+test('fetches ABI', () => {
+  expect(
     etherscan({
       apiKey,
       chainId: 1,
       contracts: [{ name: 'WagmiMintExample', address }],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchSnapshot()
 })
 
-test('fetches ABI with multichain deployment', async () => {
-  await expect(
+test('fetches ABI with multichain deployment', () => {
+  expect(
     etherscan({
       apiKey,
       chainId: 1,
       contracts: [
         { name: 'WagmiMintExample', address: { 1: address, 10: address } },
       ],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchSnapshot()
 })
 
-test('fails to fetch for unverified contract', async () => {
-  await expect(
+test('fails to fetch for unverified contract', () => {
+  expect(
     etherscan({
       apiKey,
       chainId: 1,
       contracts: [
         { name: 'WagmiMintExample', address: unverifiedContractAddress },
       ],
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     '[Error: Contract source code not verified]',
   )
 })
 
-test('missing address for chainId', async () => {
-  await expect(
+test('missing address for chainId', () => {
+  expect(
     etherscan({
       apiKey,
       chainId: 1,
       // @ts-expect-error `chainId` and `keyof typeof contracts[number].address` mismatch
       contracts: [{ name: 'WagmiMintExample', address: { 10: address } }],
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     `[Error: No address found for chainId "1". Make sure chainId "1" is set as an address.]`,
   )
 })
 
-test('invalid api key', async () => {
-  await expect(
+test('invalid api key', () => {
+  expect(
     etherscan({
       apiKey: invalidApiKey,
       chainId: 1,
       contracts: [{ name: 'WagmiMintExample', address: timeoutAddress }],
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot('[Error: Invalid API Key]')
 })

packages/cli/src/plugins/fetch.test.ts

@@ -33,38 +33,38 @@ const parse: Fetch['parse'] = async ({ response }) => {
   return JSON.parse(data.result)
 }
 
-test('fetches ABI', async () => {
-  await expect(
+test('fetches ABI', () => {
+  expect(
     fetch({
       contracts: [{ name: 'WagmiMintExample', address }],
       request,
       parse,
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchSnapshot()
 })
 
-test('fails to fetch for unverified contract', async () => {
-  await expect(
+test('fails to fetch for unverified contract', () => {
+  expect(
     fetch({
       contracts: [
         { name: 'WagmiMintExample', address: unverifiedContractAddress },
       ],
       request,
       parse,
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     '[Error: Contract source code not verified]',
   )
 })
 
-test('aborts request', async () => {
-  await expect(
+test('aborts request', () => {
+  expect(
     fetch({
       contracts: [{ name: 'WagmiMintExample', address: timeoutAddress }],
       request,
       parse,
       timeoutDuration: 1_000,
-    }).contracts(),
+    }).contracts?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     '[AbortError: This operation was aborted]',
   )
@@ -98,7 +98,7 @@ test('reads from cache', async () => {
       contracts: [contract],
       request,
       parse,
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchInlineSnapshot(`
       [
         {
@@ -149,7 +149,7 @@ test('fails and reads from cache', async () => {
       request,
       parse,
       timeoutDuration: 1,
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchInlineSnapshot(`
       [
         {

packages/cli/src/plugins/foundry.test.ts

@@ -18,7 +18,7 @@ test('forge not installed', async () => {
       forge: {
         path: '/path/to/forge',
       },
-    }).validate(),
+    }).validate?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(`
     [Error: forge must be installed to use Foundry plugin.
     To install, follow the instructions at https://book.getfoundry.sh/getting-started/installation]
@@ -31,7 +31,7 @@ test('project does not exist', async () => {
   spy.mockImplementation(() => dir)
 
   try {
-    await foundry({ project: '../path/to/project' }).validate()
+    await foundry({ project: '../path/to/project' }).validate?.()
   } catch (error) {
     expect(
       (error as Error).message.replace(dirname(dir), '..'),
@@ -44,15 +44,15 @@ test('validates without project', async () => {
   const spy = vi.spyOn(process, 'cwd')
   spy.mockImplementation(() => dir)
 
-  expect(foundry().validate()).resolves.toBeUndefined()
+  expect(foundry().validate?.()).resolves.toBeUndefined()
 })
 
 test('contracts', () => {
   expect(
     foundry({
       project: resolve(__dirname, '__fixtures__/foundry/'),
       exclude: ['Foo.sol/**'],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchInlineSnapshot(`
       [
         {
@@ -106,7 +106,7 @@ test('contracts without project', async () => {
   expect(
     foundry({
       exclude: ['Foo.sol/**'],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchInlineSnapshot(`
       [
         {

packages/cli/src/plugins/hardhat.test.ts

@@ -13,7 +13,7 @@ afterEach(() => {
 test('validate', async () => {
   const temp = f.temp()
   expect(
-    hardhat({ project: temp }).validate(),
+    hardhat({ project: temp }).validate?.(),
   ).rejects.toThrowErrorMatchingInlineSnapshot(
     '[Error: hardhat must be installed to use Hardhat plugin.]',
   )
@@ -25,7 +25,7 @@ test('project does not exist', async () => {
   spy.mockImplementation(() => dir)
 
   try {
-    await hardhat({ project: '../path/to/project' }).validate()
+    await hardhat({ project: '../path/to/project' }).validate?.()
   } catch (error) {
     expect(
       (error as Error).message.replace(dirname(dir), '..'),
@@ -38,7 +38,7 @@ test('contracts', async () => {
     hardhat({
       project: resolve(__dirname, '__fixtures__/hardhat/'),
       exclude: ['Foo.sol/**'],
-    }).contracts(),
+    }).contracts?.(),
   ).resolves.toMatchInlineSnapshot(`
       [
         {