@userflow-tech/react-native 0.4.2 → 0.4.3

package/README.md

@@ -1,10 +1,17 @@
-# `@userflow-tech/react-native`
+# Userflow React Native SDK
 
-Official Userflow SDK for React Native and Expo. Deliver guided flows, tooltips,
-modals, and banners authored in the Userflow dashboard — without shipping a new
-app release for every content change.
+> ⚠️ This SDK is under active development and evolving quickly.
 
-> Early development. APIs may change.
+Release notes are tracked in the [Userflow React Native SDK Guide](https://app.notion.com/p/Userflow-React-Native-SDK-Guide-3fba9809ce89800682c3ea9078b0f210?source=copy_link).
+
+`@userflow-tech/react-native` is the official Userflow SDK for React Native and
+Expo. Deliver guided flows, tooltips, modals, and banners authored in the
+Userflow dashboard — without shipping a new app release for every content
+change.
+
+The SDK connects to the Userflow backend using the same protocol as
+userflow.js, so flows built in the Userflow dashboard work across web and
+mobile from a single place.
 
 ## Requirements
 
@@ -399,6 +406,12 @@ To preview draft flows from the Userflow builder onto a device (QR / deep link):
 }
 ```
 
+`schemeId` is the env's `scheme_id` from the dashboard, copied exactly. It is
+`userflow-` followed by an opaque id. Do not rely on its shape. Preview links
+(`…://?token=…`) and pairing links (`…://?pairing_token=…`) both ride that one
+scheme. Expo Router needs no extra host files for these root-form URLs, and
+pairing works in every build, including release.
+
 Deep-link / pairing helpers:
 
 | Member                  | Description                                                                                                                                                                                                                  |
@@ -414,7 +427,20 @@ Full scheme registration, Linking ownership, and verify commands:
 
 ## Connection resilience
 
-Recovery from a dropped or silently-dead socket works out of the box:
+After `Userflow.init`, the SDK suspends the socket when the app leaves the
+foreground (after a short grace window) and resumes on return:
+
+| Away duration         | Behavior                                             |
+| --------------------- | ---------------------------------------------------- |
+| < 3 seconds        | No suspend/resume (transient blur / quick switch)    |
+| 3 seconds – 5 minutes | Reconnect and **keep** the mid-flow session          |
+| ≥ 5 minutes           | **Clear** the local mid-flow session, then reconnect |
+
+Foreground idle for 5 minutes also suspends (skipped while any mid-flow session
+is active).
+
+Recovery from a dropped or silently-dead socket works out of the box, with no
+extra dependencies or host setup:
 
 1. Reconnect ladder on socket `close` / `error`
 2. Adaptive heartbeat with a short reply deadline
@@ -516,16 +542,38 @@ These guides also ship in the package, under
 | [docs/identity-verification.md](https://unpkg.com/@userflow-tech/react-native/docs/identity-verification.md) | HMAC signature on your backend                              |
 | [docs/troubleshooting.md](https://unpkg.com/@userflow-tech/react-native/docs/troubleshooting.md)             | Symptom → cause for common integration failures             |
 
-## Experimental
+## Current status
+
+### Shipped
+
+- Flow rendering — tooltips and modals
+- Manual element targeting (`userflowId` / `testID` / `nativeID`, or `useUserflowAnchor`)
+- Screen tracking — Expo Router (`UserflowExpoRouterScreenTracker`) and React
+  Navigation (`WithUserflowReactNavigation`); must be mounted by the host
+- User & group attributes (`identify`, `identifyAnonymous`, `group`) and custom events (`track`)
+- Embed banners (overlay and inline `EmbedBannerPlaceholder`)
+- Client conditions — `ELEMENT` PRESENT / NOT_PRESENT on manual anchors and
+  AUTO selectors (guarded: weak evidence stays unknown)
+- Connection lifecycle — suspend/resume, reconnect, optional NetInfo
+
+### Experimental
 
 - AUTO / codeless element targeting (exact-id fast path + scored matcher;
   scored path needs Babel full mode to populate the auto-anchor registry).
   See [docs/anchoring.md](https://unpkg.com/@userflow-tech/react-native/docs/anchoring.md).
-- Build-time stamping with `@userflow-tech/react-native/babel-plugin`. Jest
+- Build-time stamping with `@userflow-tech/react-native/babel-plugin`
+  (`stampOnly: true` stamps `nativeID` only; full mode is the default). Jest
   runs the plugin too, which changes snapshots. Read
   [Babel plugin and snapshot tests](#babel-plugin-and-snapshot-tests) before
   enabling it.
 
+### Not available yet
+
+- `INPUT_VALUE` / `FILLED_IN_INPUT` client conditions
+
+Flows gated on unsupported client conditions stay unknown and **never start**.
+See [docs/troubleshooting.md](https://unpkg.com/@userflow-tech/react-native/docs/troubleshooting.md).
+
 ## Install diagnostics
 
 In development, the first `Userflow.init` checks native module registration and
@@ -667,9 +715,7 @@ instead. Snapshots then gain only `nativeID` and `collapsable`, and stamped file
 skip the SDK import. The plugin's `exclude` option does not help here: it skips
 the files it lists, not the components a test renders.
 
-## What is not available yet
+## Related
 
-- `INPUT_VALUE` / `FILLED_IN_INPUT` client conditions
-
-Flows gated on unsupported client conditions stay unknown and **never start**.
-See [docs/troubleshooting.md](https://unpkg.com/@userflow-tech/react-native/docs/troubleshooting.md).
+- [Userflow](https://userflow.com)
+- [userflow.js](https://github.com/userflow/userflow.js) — Web SDK

package/lib/commonjs/version.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.SDK_VERSION = void 0;
 /** Generated by scripts/write-version.mjs — do not edit. */
-const SDK_VERSION = exports.SDK_VERSION = '0.4.2';
+const SDK_VERSION = exports.SDK_VERSION = '0.4.3';
 //# sourceMappingURL=version.js.map

package/lib/module/version.js

@@ -1,5 +1,5 @@
 "use strict";
 
 /** Generated by scripts/write-version.mjs — do not edit. */
-export const SDK_VERSION = '0.4.2';
+export const SDK_VERSION = '0.4.3';
 //# sourceMappingURL=version.js.map

package/lib/typescript/commonjs/src/version.d.ts

@@ -1,3 +1,3 @@
 /** Generated by scripts/write-version.mjs — do not edit. */
-export declare const SDK_VERSION = "0.4.2";
+export declare const SDK_VERSION = "0.4.3";
 //# sourceMappingURL=version.d.ts.map

package/lib/typescript/module/src/version.d.ts

@@ -1,3 +1,3 @@
 /** Generated by scripts/write-version.mjs — do not edit. */
-export declare const SDK_VERSION = "0.4.2";
+export declare const SDK_VERSION = "0.4.3";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@userflow-tech/react-native",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Userflow SDK for React Native — onboarding flows, tooltips, and modals.",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./lib/commonjs/index.js",

package/src/version.ts

@@ -1,2 +1,2 @@
 /** Generated by scripts/write-version.mjs — do not edit. */
-export const SDK_VERSION = '0.4.2';
+export const SDK_VERSION = '0.4.3';

package/vendor/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@userflow-tech/core",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Userflow React Native SDK core — platform-agnostic engine and protocol client.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",

package/vendor/protocol/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@userflow-tech/protocol",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Userflow React Native SDK protocol — wire contracts and shared types.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",