@getuserfeedback/react-native 5.5.1 → 5.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +28 -3
- package/dist/native-provider.d.ts +4 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -17,6 +17,10 @@ type HostContext = Extract<PublicCommandPayload, {
|
|
|
17
17
|
kind: "updateHostContext";
|
|
18
18
|
}>["context"];
|
|
19
19
|
type CommandOptions = {
|
|
20
|
+
/**
|
|
21
|
+
* @deprecated Omit this option. The SDK owns command identity and transport
|
|
22
|
+
* correlation.
|
|
23
|
+
*/
|
|
20
24
|
idempotencyKey?: string;
|
|
21
25
|
};
|
|
22
26
|
/** A customer-defined action implemented by the React Native host app. */
|
|
@@ -24,11 +28,21 @@ export type NativeActionRegistration = Extract<ActionRegistration, {
|
|
|
24
28
|
kind: "custom";
|
|
25
29
|
}>;
|
|
26
30
|
/** React Native provider initialization options. */
|
|
27
|
-
export type ClientOptions = Omit<InitOptions, "capabilities" | "hostActions" | "hostCapabilities"> & {
|
|
31
|
+
export type ClientOptions = Omit<InitOptions, "capabilities" | "clientMeta" | "hostActions" | "hostCapabilities" | "runtimeEndpoints"> & {
|
|
28
32
|
/** Widget actions implemented by the current app version. */
|
|
29
33
|
actions?: NativeActionRegistration[] | undefined;
|
|
30
34
|
/** Capabilities supported by the current app version. */
|
|
31
35
|
capabilities?: CapabilitiesInput | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* @deprecated Omit this option. The provider stamps canonical React Native
|
|
38
|
+
* client metadata.
|
|
39
|
+
*/
|
|
40
|
+
clientMeta?: InitOptions["clientMeta"];
|
|
41
|
+
/**
|
|
42
|
+
* @deprecated Internal runtime override. Application code should use the
|
|
43
|
+
* SDK's pinned runtime.
|
|
44
|
+
*/
|
|
45
|
+
runtimeEndpoints?: InitOptions["runtimeEndpoints"];
|
|
32
46
|
};
|
|
33
47
|
/** Operations for one on-demand flow lifecycle. */
|
|
34
48
|
export interface FlowRun {
|
|
@@ -49,6 +63,10 @@ export interface FlowRun {
|
|
|
49
63
|
* @see https://getuserfeedback.com/docs/reference/react-native-sdk-reference
|
|
50
64
|
*/
|
|
51
65
|
export interface Client {
|
|
66
|
+
/**
|
|
67
|
+
* @deprecated Runtime identity is SDK-owned. Do not persist or branch on this
|
|
68
|
+
* value.
|
|
69
|
+
*/
|
|
52
70
|
readonly instanceId: string;
|
|
53
71
|
/**
|
|
54
72
|
* Updates authentication, consent, and other client configuration.
|
|
@@ -89,8 +107,15 @@ export interface Client {
|
|
|
89
107
|
onOpenRequested: (callback: OpenRequestedCallback) => () => void;
|
|
90
108
|
/** Resets widget state, authentication, and the current user identity. */
|
|
91
109
|
reset: (options?: CommandOptions) => Promise<void>;
|
|
92
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* Updates current-route and host-supplied targeting context. URL and page
|
|
112
|
+
* fields can enrich events and consent-gated telemetry; `env` and `storage`
|
|
113
|
+
* are local-targeting inputs only.
|
|
114
|
+
*/
|
|
93
115
|
updateHostContext: (context: HostContext, options?: CommandOptions) => Promise<void>;
|
|
94
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* Emits an ephemeral signal for local engagement targeting. This does not
|
|
118
|
+
* persist a customer occurrence; use `track()` or `screen()` for that.
|
|
119
|
+
*/
|
|
95
120
|
emitHostSignal: (name: string, data?: unknown, options?: CommandOptions) => Promise<void>;
|
|
96
121
|
}
|
|
@@ -23,7 +23,10 @@ export type GetUserFeedbackProviderProps = {
|
|
|
23
23
|
children?: ReactNode;
|
|
24
24
|
/** Public API key and initialization options for this client. */
|
|
25
25
|
clientOptions: ClientOptions;
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* @deprecated Omit this prop. The provider owns runtime identity and creates
|
|
28
|
+
* a stable identifier for its mounted lifetime.
|
|
29
|
+
*/
|
|
27
30
|
instanceId?: string;
|
|
28
31
|
/** Receives runtime and command errors. */
|
|
29
32
|
onError?: (error: Error) => void;
|
package/dist/version.js
CHANGED
|
@@ -3,4 +3,4 @@ const reactNativeSdkVersion = typeof __GX_REACT_NATIVE_SDK_VERSION__ === "string
|
|
|
3
3
|
: "";
|
|
4
4
|
// Build scripts patch this fallback to the package version for published artifacts.
|
|
5
5
|
// Source-linked workspace usage keeps the local fallback.
|
|
6
|
-
export const REACT_NATIVE_SDK_VERSION = reactNativeSdkVersion.length > 0 ? reactNativeSdkVersion : "5.
|
|
6
|
+
export const REACT_NATIVE_SDK_VERSION = reactNativeSdkVersion.length > 0 ? reactNativeSdkVersion : "5.6.1";
|