Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.0.0 Add Typescript support #185

Merged
merged 80 commits into from
Feb 4, 2025
Merged

V2.0.0 Add Typescript support #185

merged 80 commits into from
Feb 4, 2025

Conversation

lucasassisrosa
Copy link
Contributor

@lucasassisrosa lucasassisrosa commented Sep 24, 2024

Addresses #32

This PR will remain open while v2.0.0 is in alpha

I have labeled some files as important for check when reviewing. Please use the file filter to omit the "excluded files" when reviewing.

  • resources
  • tests
  • base files

Manual testing

  • Check README instructions on testing and typescript
  • Run npm run lint
  • Run npm run build
    • Check output in dist folder
  • Check types in types folder
  • Run npm run test
  • to run a SDK usage examples:
    • in the root dir, run npm link
    • go to examples/call-control or examples/messaging
    • run npm link telnyx
    • run export TELNYX_API_KEY=` (this should use PROD API Key)
    • run npm run start

* update deps and add typescript default config

* update prettier config
* update deps and add typescript default config

* convert Telnyx main to typescript

* bump version to v2 alpha

* update changelog

* convert Error and Telnyx method to typescript

* update utils

* convert autoPagination, makeRequest, TelnyxMethod and Webhooks

* convert TelnyxResource

* remove extra lint file

* add types folder

* update code comments on framework naming

* specify error types

* update eslint rules

* add types generated from openapi specs

* add TelnyxIncomingHttpHeaders type

* add BalanceResource type defs
* update deps and add typescript default config

* convert Telnyx main to typescript

* bump version to v2 alpha

* update changelog

* convert Error and Telnyx method to typescript

* update utils

* convert autoPagination, makeRequest, TelnyxMethod and Webhooks

* convert TelnyxResource

* remove extra lint file

* add types folder

* update code comments on framework naming

* specify error types

* update eslint rules

* add types generated from openapi specs

* add TelnyxIncomingHttpHeaders type

* add BalanceResource type defs

* convert resource files and tests to typescript

* update overall test setup

* add autoPagination, telnyx, utils and Balance specs

* add Webhooks tests

* add autoPagination, telnyx.node, TelnyxResource, Webhooks and utils test

* add MessagingProfiles resource

* remove stale coverage report on README
src/utils.ts Dismissed Show dismissed Hide dismissed
src/utils.ts Fixed Show fixed Hide fixed
types/TelnyxAPI.d.ts Outdated Show resolved Hide resolved
@lucasassisrosa lucasassisrosa added the help wanted Extra attention is needed label Sep 25, 2024
##
## v2

### v2.0.0-alpha.0
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

important

types/TelnyxAPI.d.ts Outdated Show resolved Hide resolved
types/index.d.ts Outdated Show resolved Hide resolved
@lucasassisrosa
Copy link
Contributor Author

PR check failed cause /number_order_documents endpoints were removed. I'm removing these endpoints from SDK to match

Copy link
Collaborator

@ADandyGuyInSpace ADandyGuyInSpace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Tests passing and we are much improved/

@lucasassisrosa
Copy link
Contributor Author

Beta 5 to fix #191 and #192

@lucasassisrosa
Copy link
Contributor Author

Beta 6 and 2.0.0 to fix #194

@lucasassisrosa lucasassisrosa merged commit 66d6d0d into master Feb 4, 2025
5 checks passed
@lucasassisrosa lucasassisrosa deleted the v2.0.0 branch February 4, 2025 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

7 participants