Skip to content

Commit

Permalink
migration guide updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dtroupe-plaid committed Nov 8, 2023
1 parent 57dd1b3 commit 3061ae4
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions v11-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# React Native Plaid Link V11 Migration Guide

Welcome to the React Native Plaid Link V11 Migration Guide! This document provides a detailed walkthrough for upgrading your Plaid integration from Plaid Link 9.x/10.x to 11.x. By following these steps, you can ensure a smooth transition and take advantage of the latest features and improvements in Plaid Link.

## Overview

The upgrade from Plaid Link 9.x/10.x to 11.x introduces several important changes. It's crucial to understand these modifications to ensure your integration remains robust and error-free.
Expand All @@ -10,29 +8,19 @@ The upgrade from Plaid Link 9.x/10.x to 11.x introduces several important change

#### React Native Changes

1. **BREAKING -Authentication Method Changes**: Public key authentication support has been deprecated. It's imperative to migrate to Link Tokens. If you haven't already, follow Plaid's [migration guide](https://plaid.com/docs/link-token-migration-guide) for detailed instructions on transitioning to Link Tokens.
1. **BREAKING - Authentication Method Changes**: Public key authentication support has been removed. It's imperative to migrate to Link Tokens. If your integration uses the public key, use the [migration guide](https://plaid.com/docs/link-token-migration-guide) for detailed instructions on transitioning to Link tokens.

2. **BREAKING OAuth Redirect Handling**: The deprecated `useDeepLinkRedirector` method for OAuth redirects has been removed. If your code relies on this method, it can be safely removed as it's no longer required.

3. **React Native Version Compatibility**: You can now use Plaid Link with any version of React Native. However, we recommend using a version that is [not archived](https://reactnative.dev/versions) for optimal performance and compatibility.

#### iOS Changes

1. **BREAKING iOS Version Support**: Plaid Link no longer supports iOS 11, 12, and 13. If your application still targets these iOS versions, you must either continue using SDK 9.x/10.x or update your app to support newer iOS versions compatible with iOS SDK V5.x.
1. **BREAKING - iOS Version Support**: Plaid Link no longer supports iOS 11, 12, and 13. If your application still targets these iOS versions, you must either continue using SDK 9.x/10.x or update your app to support newer iOS versions compatible with iOS SDK V5.x.

2. **BREAKING iOS Event Metadata Encoding**: Event metadata keys are now encoded in `snake_case` instead of `camelCase` to match Android behavior. For example, `errorType` is now encoded as `error_type`. Update your code to handle these changes correctly. Refer to [ios/RNLinksdk.m](https://github.com/plaid/react-native-plaid-link-sdk/blob/2431c5427a21610ad97d7202ba205e6b63d1b84f/ios/RNLinksdk.m) for the full set of iOS keys.
2. **BREAKING - iOS Event Metadata Encoding**: Event metadata keys are now encoded in `snake_case` instead of `camelCase` to match Android behavior. For example, `errorType` is now encoded as `error_type`. Update your code to handle these changes correctly. Refer to [ios/RNLinksdk.m](https://github.com/plaid/react-native-plaid-link-sdk/blob/2431c5427a21610ad97d7202ba205e6b63d1b84f/ios/RNLinksdk.m) for the full set of iOS keys.

#### Android Changes

1. **Upgrade to Kotlin 1.8**
The Link Android SDK now uses Kotlin 1.8. Ensure your project is updated to this version to maintain compatibility.

## Review Your Codebase

Carefully review your existing codebase and apply the necessary adjustments to accommodate these changes. Failing to do so might lead to integration issues and a less-than-optimal user experience.

By following these guidelines, you can successfully migrate your Plaid integration from Plaid Link 9.x/10.x to 11.x. Should you need additional assistance or have queries, don't hesitate to contact Plaid's [Support Team](https://dashboard.plaid.com/support/new).

If you encounter any issues or have feedback regarding the migration or the updated library, provide your input to the maintainers via GitHub issues or other communication channels mentioned in the repository.

Happy coding!

0 comments on commit 3061ae4

Please sign in to comment.