Add definition files for Connectors and Actions + Move /types to /src/types #266
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Moved types to src/types * Added defintion files for connectors * Create definition file for actions
|
Coverage report can be checked at https://chili-dev.azureedge.net/sdk/coverage/266/coverage.html |
Matthiee
reviewed
Mar 31, 2023
+ Cleanup shared definitions
brapoprod
previously approved these changes
Mar 31, 2023
|
please fix linting issues |
Remove redundant functions Co-authored-by: Matthias Beerens <3512339+Matthiee@users.noreply.github.com>
…i-publish/editor-sdk into feature/add-quickjs-typings
Matthiee
approved these changes
Apr 5, 2023
pietervp
requested review from
abdelhalimkhouas,
alexandraFlavia9,
pkgacek and
srares76
as code owners
brapoprod
approved these changes
Apr 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The rationale behind this is that the existing
/typesfolder was somehow misplaced under the root folder. These concrete types are part of thesrcof this repository and their location in the tree should reflect that. If consumers of SDK did not import the types 'directly' (import ... from '@chili-publish/studio-sdk/types/commontypes'), this change should be transparent for them. Although any place that abused the Ts imports will be exposed after this PR gets merged.Also generated documentation will change slightly, see changes in
tsconfig.json.The root
types/folder is meant to expose Ts definition files. These definition files define functionality implemented elsewhere, in this case in the plugin system of the engine. These definitions define all functionality that will be injected in the QuickJS runtime context, either when using actions, or implementing a connector. By exposing these type definitions, we enable code completion when writing said custom actions / connectors.