Repository navigation
docs: correct setup, requirements and API reference in README and llms.txt - #14
Merged
Merged
Conversation
…s.txt - Require React Native 0.65+, the floor set by AsyncStorage 2.x - Install AsyncStorage 2.x and device-info 15.x in the app itself, since autolinking only links an app's own dependencies and AsyncStorage 3.x registers a different native module name - Add the AppDelegate / SceneDelegate step that forwards links to RCTLinkingManager, and launchMode="singleTask" on Android - Explain that the server serves the AASA and assetlinks.json files - Use https://api.linkforty.com for the hosted service, mark appToken as required there, apiKey as only needed for createLink() - Await init() before onDeepLink() - Document trackRevenue, setExternalUserId, externalUserId, deduplicated, the lack of an offline event queue, and the data the SDK sends - Note what differs on self-hosted Core (createLink templateId, link hosts)
|
🎉 This PR is included in version 1.9.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
Brings the README and
llms.txtin line with the published 1.9.0 package (dist/*.d.tsanddist/*.js). Documentation only: no code or package metadata changes.Setup and requirements
@react-native-async-storage/async-storage@2.2.0, the oldest version^2.2.0allows, declaresreact-native: ^0.0.0-0 || >=0.65 <1.0.@react-native-community/cli-configfindDependencies) only reads the app's ownpackage.json. A barenpm install @react-native-async-storage/async-storagenow installs 3.x, and 3.x registers its native module asRNAsyncStorage, while the SDK's 2.x looks upRNCAsyncStorage. The oldllms.txtline saying the dependencies "are included automatically" is gone.AppDelegatemethods (openURLandcontinueUserActivity) that forward links toRCTLinkingManager, in Swift and Objective-C, plus theSceneDelegatenote. Without them, Universal Links never reach JavaScript.android:launchMode="singleTask".assetlinks.jsonfiles are served by the LinkForty server, fromIOS_TEAM_ID/IOS_BUNDLE_IDandANDROID_PACKAGE_NAME/ANDROID_SHA256_FINGERPRINTSon Core. The old README said to host them yourself.Configuration and API
https://api.linkforty.com.llms.txtsaidgo.linkforty.com.appTokenis required on the hosted service.apiKeyis only needed forcreateLink().init()must be awaited beforeonDeepLink().onDeepLink()throws withoutinit(), and one registered whileinit()is still running only recognizes links on thebaseUrlhost.trackRevenue,setExternalUserId/getExternalUserId,CreateLinkOptions.externalUserId,CreateLinkResult.deduplicated, and theautoTrackNavigation/navigationRefconfig rows.trackEventhas no offline queue: a failed send is logged and dropped.createLink()needs atemplateId(Core has noPOST /api/sdk/v1/links), and links are looked up on thebaseUrlhost only (Core has no link-domains endpoint).llms.txt:clearData()is no longer suggested for user logout, because the next launch reports a new install.@types/react-nativeis a deprecated stub, so it was removed from the instructions. Added a section for a missing native module.The README samples type-check (
tsc --strict) against the packed 1.9.0dist/index.d.ts, with one exception. TheautoTrackNavigationsamples fail with@react-navigation/native7, becausecreateNavigationContainerRef()is not assignable toNavigationContainerRefLike:Route.paramsisReadonly<object | undefined>, notRecord<string, unknown>. That needs a type fix in the SDK and is not part of this PR.