fix(useOverlay): support infering close argument from complex emits

[Teages]

🔗 Linked issue

Resolves #4413

upstream issue: microsoft/TypeScript#32164

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The PR added the support of infering close argument from complex emits, so that we can get the result type of lazy components.

const lazyDialog = overlay.create(LazyDialog)
const dialog = lazyDialog.open()
const result = await dialog.result
//    ^ now it is not `never`

Verify the changes in TypeScript Playground

The PR supports 16 more overloads, I think that is enough.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly. (N/A)

[pkg-pr-new]

npm i https://pkg.pr.new/@nuxt/ui@4414

commit: 77686cb

[genu]

@Teages This is a very strange workaround. Is this necessary to have type inference for lazy loaded components?

[Teages]

@Teages This is a very strange workaround. Is this necessary to have type inference for lazy loaded components?

@genu Yes, I think it is pretty useful and lazy compnent is also used in example. The first time I used it I wouldn't have known where I screwed up, if I hadn't looked at the type.

The primary goal is to fix the type of lazy loaded components. But the problem will also happens when it have any other emits with have no argument.

The recursive solution in the original issue may be more regular, but I think it is too complex for the problem we need to resolve.

[genu]

@Teages I took some time to try to replicate the problem, but I haven't been able to identify this edge case. can you share how you are overloading the emits?

Do you mean something like this?

const emit = defineEmits<{
  (event: 'close', result: string): void
  (event: 'close', result: number): void
  (event: 'close', result: boolean): void
  (event: 'close', result: { message: string, code: number }): void

}>()

[Teages]

@genu Did you look into the playground I provided? Before the PR / After this PR

Something like this will break the current type:

const emit = defineEmits<{
  (event: 'close', result: string): void
  (event: 'hydrated'): void // added by lazy component
}>()

[Teages]

oops I chose the wrong way to sync to the base. nothing edited in the prev force push

[genu]

Thanks @Teages That makes better sense now.

I've added a comment block to explain a little bit the background behind this and included a link to the original typescript discussion.

Feel free to make any more changes.

I think its good to go 👍 🚀