[All packages] Internal API changes & Cleanups #149
Merged
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.
📦 Pull Request
Adds a few cleanups to our internal APIs:
SDKBase.endpoint
is now markedprotected
SDKBase.encodedQueryParams
is renamed toSDKBase.parameters
and is now markedprotected
ViewController.encodedQueryParams
is renamed toViewController.parameters
PayloadTransport.encodedQueryParams
is renamed toPayloadTransport.parameters
ViewController
takes just aPayloadTransport
in its constructor;endpoint
andparameters
are inferred from the providedPayloadTransport
@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 amajor
semver bump.🚨 Test instructions
yarn test
patch
: Bug Fix?minor
: New Feature?major
: Breaking Change?skip-release
: It's unnecessary to publish this change.