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.

Sign up for GitHub

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

Jump to bottom

[All packages] Internal API changes & Cleanups #149

Merged
merged 5 commits into from
Nov 17, 2020
Merged

[All packages] Internal API changes & Cleanups #149

merged 5 commits into from
Nov 17, 2020

Conversation

smithki
Copy link
Contributor

@smithki smithki commented Nov 12, 2020 •
edited
Loading

📦 Pull Request

Adds a few cleanups to our internal APIs:

  • SDKBase.endpoint is now marked protected
  • SDKBase.encodedQueryParams is renamed to SDKBase.parameters and is now marked protected
  • ViewController.encodedQueryParams is renamed to ViewController.parameters
  • PayloadTransport.encodedQueryParams is renamed to PayloadTransport.parameters
  • ViewController takes just a PayloadTransport in its constructor; endpoint and parameters are inferred from the provided PayloadTransport
  • Adds @magic-sdk/commons package to expose a listing of public APIs common across platform entry points (Web, CDN, and React Native)

Integrations should be unaffected by these changes, but due to several "public" APIs changing (i.e.: encodedQueryParams -> parameters), we'll mark this as a major semver bump.

🚨 Test instructions

yarn test

⚠️ Don't forget to add a semver label!

  • patch: Bug Fix?
  • minor: New Feature?
  • major: Breaking Change?
  • skip-release: It's unnecessary to publish this change.

@smithki smithki added the minor Increment the minor version when merged label Nov 12, 2020
@smithki smithki requested a review from Ethella November 12, 2020 21:24
@smithki smithki self-assigned this Nov 12, 2020
@smithki smithki added major Increment the major version when merged and removed minor Increment the minor version when merged labels Nov 13, 2020
@smithki smithki merged commit 8a86d4b into master Nov 17, 2020
@smithki smithki deleted the chore/all_packages/a_few_api_cleanups branch November 17, 2020 04:29
@smithki
Copy link
Contributor Author

smithki commented Nov 17, 2020

🚀 PR was released in @magic-sdk/[email protected], @magic-sdk/[email protected], @magic-sdk/[email protected], @magic-sdk/[email protected], [email protected] 🚀

@smithki smithki added the released This issue/pull request has been released. label Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ethella Ethella Awaiting requested review from Ethella

Assignees

@smithki smithki

Labels
major Increment the major version when merged released This issue/pull request has been released.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@smithki