Add TypeScript type declarations #43
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds TypeScript type declarations for the SDK, generated from:
@jambonz/verb-specifications(webhook verbs)Changes
types/jambonz-node-client.d.ts— Generated type declarationsscripts/generate-types.js— Script to regenerate typesschema/calls.yaml+schema/platform.yaml— OpenAPI specs (retrieved from Jambonz Fern Documentation repo)package.json— Addedtypesfield andgenerate-typesscript.eslintignore— Ignore types directoryUsage
TypeScript users will now get full type support when importing the package.
Types can be regenerated with:
npm run generate-typesUpdating Types
When the API is updated in the future, replace the YAML files in
/schemawith the updated versions and regenerate the types: