feat: Add overlayAsync implementation

XionWCFM commented 4 months ago

Description

This change implements the openAsync method for overly-kit's promise support discussed in #47.

Related Issue: Fixes #47

Changes

The openAsync method is added to the overlay object of event.ts that is exposed externally

Motivation and Context

Although overlay-kit emphasizes support for promises in its documentation, there was a problem with boilerplate due to the lack of explicit support for promises.

To address this issue, we add openAsync explicit support for promises.

How Has This Been Tested?

I tested through test code that the parameters passed to openAsync's close method return resolved values, and that the close method properly closes the overlay on the screen.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Documentation update

Checklist

[x] I have performed a self-review of my own code.
[x] My code is commented, particularly in hard-to-understand areas.
[ ] I have made corresponding changes to the documentation.
[x] My changes generate no new warnings.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] New and existing unit tests pass locally with my changes.
[ ] Any dependent changes have been merged and published in downstream modules.

Further Comments

In order to adhere to the DRY principle and minimize modifications to existing code, openAsync was implemented in the form of wrapping open. Is this implementation acceptable?
The close method of openAsync is implemented to require parameters. The reason I implemented it this way is because if an optional parameter is allowed, type assertion through as is required internally, which makes it type-safe, or there is the inconvenience of the user having to infer undefind even though the confirmation value is actually passed. I also chose a type-safe implementation because we believed that the core of Promise use cases lies in using checked values. I'm curious about your opinion on this part.
Would it be a good idea to add docs for openAsync in that PR? If I had to add it, I would like to know which document it would be best to add it to. I am prepared when it comes to writing documents.