@getuserfeedback/react-native 4.0.31 → 5.0.7

package/dist/native-provider.d.ts

@@ -0,0 +1,32 @@
+import { type ComponentType, type ReactElement, type ReactNode } from "react";
+import type { Client, ClientOptions } from "./client.js";
+export type { Client, ClientOptions, FlowRun } from "./client.js";
+/**
+ * Custom WebView implementation used by the native runtime.
+ *
+ * The component must forward every received prop and its ref to a compatible
+ * `react-native-webview` WebView instance. The forwarded ref must expose
+ * `injectJavaScript`.
+ */
+export type NativeWebViewComponent = ComponentType<Record<string, unknown>>;
+/**
+ * Props for the React Native SDK provider.
+ *
+ * Mount the provider above every component that calls `useGetUserFeedback`.
+ *
+ * @see https://getuserfeedback.com/docs/get-started/react-native-sdk
+ */
+export type GetUserFeedbackProviderProps = {
+    /** Application content that can access the SDK client. */
+    children?: ReactNode;
+    /** Public API key and initialization options for this client. */
+    clientOptions: ClientOptions;
+    /** Stable instance identifier. Most apps should let the provider create one. */
+    instanceId?: string;
+    /** Receives runtime and command errors. */
+    onError?: (error: Error) => void;
+    /** Custom WebView implementation used by the Core runtime and projected flows. */
+    webViewComponent?: NativeWebViewComponent;
+};
+export declare function GetUserFeedbackProvider({ children, clientOptions, instanceId: instanceIdProp, onError, webViewComponent, }: GetUserFeedbackProviderProps): ReactElement;
+export declare function useGetUserFeedback(): Client;

package/dist/native-provider.js

@@ -0,0 +1,88 @@
+import { parseInitOptions } from "@getuserfeedback/protocol";
+import { createUniqueId, PRODUCTION_WIDGET_RUNTIME_ENDPOINTS, } from "@getuserfeedback/protocol/host";
+import { createContext, createElement, Fragment, useCallback, useContext, useEffect, useRef, useState, } from "react";
+import { createNativeProviderClientController } from "./native-provider-client-controller.js";
+import { NativeProviderRuntime } from "./native-runtime-root.js";
+const GetUserFeedbackContext = createContext(null);
+const toClientOptionsKey = (value) => {
+    if (value === null || typeof value !== "object") {
+        return JSON.stringify(value);
+    }
+    if (Array.isArray(value)) {
+        return `[${value.map(toClientOptionsKey).join(",")}]`;
+    }
+    const record = value;
+    return `{${Object.keys(record)
+        .filter((key) => record[key] !== undefined)
+        .sort()
+        .map((key) => `${JSON.stringify(key)}:${toClientOptionsKey(record[key])}`)
+        .join(",")}}`;
+};
+export function GetUserFeedbackProvider({ children, clientOptions, instanceId: instanceIdProp, onError, webViewComponent, }) {
+    var _a, _b;
+    const [instanceId] = useState(() => {
+        const normalizedInstanceId = instanceIdProp === null || instanceIdProp === void 0 ? void 0 : instanceIdProp.trim();
+        return normalizedInstanceId && normalizedInstanceId.length > 0
+            ? normalizedInstanceId
+            : createUniqueId("rn");
+    });
+    const normalizedClientOptions = parseInitOptions(clientOptions);
+    const clientOptionsKey = toClientOptionsKey(normalizedClientOptions);
+    const coreUrl = (_b = (_a = normalizedClientOptions.runtimeEndpoints) === null || _a === void 0 ? void 0 : _a.coreUrl) !== null && _b !== void 0 ? _b : PRODUCTION_WIDGET_RUNTIME_ENDPOINTS.coreUrl;
+    const onErrorRef = useRef(onError);
+    onErrorRef.current = onError;
+    const reportError = useCallback((error) => {
+        var _a;
+        try {
+            (_a = onErrorRef.current) === null || _a === void 0 ? void 0 : _a.call(onErrorRef, error);
+        }
+        catch (_b) {
+            // Error observers cannot change runtime cleanup or command settlement.
+        }
+    }, []);
+    const controllerRef = useRef(null);
+    if (controllerRef.current === null) {
+        controllerRef.current = createNativeProviderClientController({
+            instanceId,
+            onError: reportError,
+        });
+    }
+    const controller = controllerRef.current;
+    const lifecycleRevisionRef = useRef(0);
+    useEffect(() => {
+        lifecycleRevisionRef.current += 1;
+        const lifecycleRevision = lifecycleRevisionRef.current;
+        return () => {
+            queueMicrotask(() => {
+                if (lifecycleRevisionRef.current === lifecycleRevision) {
+                    controller.dispose();
+                }
+            });
+        };
+    }, [controller]);
+    const handleCommandSessionChange = useCallback((session) => {
+        if (session === null) {
+            controller.onSessionEnded();
+        }
+    }, [controller]);
+    const handleHandleInvalidated = useCallback((message) => controller.onHandleInvalidated(message), [controller]);
+    return createElement(GetUserFeedbackContext.Provider, { value: controller.client }, createElement(Fragment, null, children, createElement(NativeProviderRuntime, {
+        coreUrl,
+        coreWebViewComponent: webViewComponent,
+        directSessionController: controller.directSessionController,
+        initOptions: normalizedClientOptions,
+        instanceId,
+        key: clientOptionsKey,
+        onCommandSessionChange: handleCommandSessionChange,
+        onError: reportError,
+        onHandleInvalidated: handleHandleInvalidated,
+        viewWebViewComponent: webViewComponent,
+    })));
+}
+export function useGetUserFeedback() {
+    const client = useContext(GetUserFeedbackContext);
+    if (client === null) {
+        throw new Error("useGetUserFeedback must be used inside GetUserFeedbackProvider");
+    }
+    return client;
+}

package/dist/native-runtime-root.d.ts

@@ -8,9 +8,8 @@ import { type NativeDirectCommandSession } from "./native-direct-command-session
 import type { NativeDirectCommandSessionController } from "./native-direct-command-session-controller.js";
 import { type NativeViewHostProjectionProps } from "./native-view-host-projection.js";
 export type NativeRuntimeRootProps = {
-    coreUrl: string;
+    coreUrl?: string;
     coreWebViewComponent?: CoreWebViewHostProps["webViewComponent"];
-    coreWebViewProps?: CoreWebViewHostProps["webViewProps"];
     startupCommands?: NativeRuntimeStartupCommands;
     onCommandSessionChange?: (session: NativeCoreCommandSession | null) => void;
     onError?: (error: Error) => void;
@@ -20,7 +19,6 @@ export type NativeRuntimeRootProps = {
     startupCommandSettlementTimeoutMs?: number;
     viewNativeViewComponent?: NativeViewHostProjectionProps["nativeViewComponent"];
     viewWebViewComponent?: NativeViewHostProjectionProps["webViewComponent"];
-    viewWebViewProps?: NativeViewHostProjectionProps["webViewProps"];
 };
 type NativeRuntimeInitCommand = Omit<CoreCommandEnvelope, "command"> & {
     command: Extract<CoreCommandEnvelope["command"], {
@@ -41,6 +39,6 @@ type NativeProviderRuntimeProps = Omit<NativeRuntimeRootProps, "onCommandSession
     instanceId: string;
     onCommandSessionChange?: (session: NativeDirectCommandSession | null) => void;
 };
-export declare function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, coreWebViewProps, onCommandSessionChange, onError, onHandleInvalidated, onInvalidMessage, onStartupTerminalError, startupCommandSettlementTimeoutMs, startupCommands, viewNativeViewComponent, viewWebViewComponent, viewWebViewProps, }: NativeRuntimeRootProps): ReactElement;
+export declare function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, onCommandSessionChange, onError, onHandleInvalidated, onInvalidMessage, onStartupTerminalError, startupCommandSettlementTimeoutMs, startupCommands, viewNativeViewComponent, viewWebViewComponent, }: NativeRuntimeRootProps): ReactElement;
 export declare function NativeProviderRuntime({ directSessionController, initOptions, initialConfigureOptions, instanceId, onCommandSessionChange, onError, ...runtimeProps }: NativeProviderRuntimeProps): ReactElement;
 export {};

package/dist/native-runtime-root.js

@@ -18,6 +18,7 @@ import { createNativeDirectCommandSession, } from "./native-direct-command-sessi
 import { NativeViewHostProjection, } from "./native-view-host-projection.js";
 import { createNativeViewRecordController, } from "./native-view-record-controller.js";
 import { createProviderCommandEnvelope, REACT_NATIVE_CLIENT_META, } from "./provider-command-helpers.js";
+import { REACT_NATIVE_DEFAULT_CORE_URL } from "./runtime-endpoints.js";
 const DEFAULT_STARTUP_COMMAND_SETTLEMENT_TIMEOUT_MS = 30000;
 async function dispatchStartupCommands(input) {
     for (const command of input.commands) {
@@ -26,7 +27,7 @@ async function dispatchStartupCommands(input) {
         });
     }
 }
-export function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, coreWebViewProps, onCommandSessionChange, onError, onHandleInvalidated, onInvalidMessage, onStartupTerminalError, startupCommandSettlementTimeoutMs = DEFAULT_STARTUP_COMMAND_SETTLEMENT_TIMEOUT_MS, startupCommands, viewNativeViewComponent, viewWebViewComponent, viewWebViewProps, }) {
+export function NativeRuntimeRoot({ coreUrl = REACT_NATIVE_DEFAULT_CORE_URL, coreWebViewComponent, onCommandSessionChange, onError, onHandleInvalidated, onInvalidMessage, onStartupTerminalError, startupCommandSettlementTimeoutMs = DEFAULT_STARTUP_COMMAND_SETTLEMENT_TIMEOUT_MS, startupCommands, viewNativeViewComponent, viewWebViewComponent, }) {
     const [coreHostRevision, setCoreHostRevision] = useState(0);
     const [session, setSession] = useState(null);
     const sessionRef = useRef(null);
@@ -89,6 +90,10 @@ export function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, coreWebViewPr
         });
         const commandChannelOwner = createNativeCoreCommandChannel({
             coreConnection,
+            onSessionFailure: (error) => {
+                reportError(error);
+                coreConnection.disconnect();
+            },
             onHandleInvalidated: (message) => {
                 var _a;
                 try {
@@ -210,7 +215,6 @@ export function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, coreWebViewPr
         onDisconnected: handleDisconnected,
         onInvalidMessage,
         webViewComponent: coreWebViewComponent,
-        webViewProps: coreWebViewProps,
     }), session === null
         ? null
         : createElement(NativeViewHostProjection, {
@@ -219,7 +223,6 @@ export function NativeRuntimeRoot({ coreUrl, coreWebViewComponent, coreWebViewPr
             nativeViewComponent: viewNativeViewComponent,
             onInvalidMessage,
             webViewComponent: viewWebViewComponent,
-            webViewProps: viewWebViewProps,
         }));
 }
 export function NativeProviderRuntime(_a) {

package/dist/native-view-host-projection.d.ts

@@ -5,6 +5,5 @@ export type NativeViewHostProjectionProps = {
     onInvalidMessage?: (error: Error, value: unknown) => void;
     nativeViewComponent?: ComponentType<Record<string, unknown>>;
     webViewComponent?: ComponentType<Record<string, unknown>>;
-    webViewProps?: Record<string, unknown>;
 };
-export declare function NativeViewHostProjection({ controller, nativeViewComponent, onInvalidMessage, webViewComponent, webViewProps, }: NativeViewHostProjectionProps): ReactElement;
+export declare function NativeViewHostProjection({ controller, nativeViewComponent, onInvalidMessage, webViewComponent, }: NativeViewHostProjectionProps): ReactElement;

package/dist/native-view-host-projection.js

@@ -1,7 +1,7 @@
-import { createElement, Fragment, useCallback, useEffect, useLayoutEffect, useMemo, useRef, useSyncExternalStore, } from "react";
+import { createElement, Fragment, useCallback, useEffect, useLayoutEffect, useRef, useSyncExternalStore, } from "react";
 import { NativeViewPresentationSurface } from "./native-view-presentation-surface.js";
 import { ViewWebViewHost } from "./view-webview-host.js";
-function NativeViewHostProjectionEntry({ controller, nativeViewComponent, onInvalidMessage, record, webViewComponent, webViewProps, }) {
+function NativeViewHostProjectionEntry({ controller, nativeViewComponent, onInvalidMessage, record, webViewComponent, }) {
     var _a;
     const detachConnectionRef = useRef(null);
     const detachConnection = useCallback(() => {
@@ -18,7 +18,6 @@ function NativeViewHostProjectionEntry({ controller, nativeViewComponent, onInva
             detachConnectionRef.current = controllerDetach;
         }
     }, [controller, record.allocationId]);
-    const presentedWebViewProps = useMemo(() => (Object.assign(Object.assign({}, webViewProps), { style: [webViewProps === null || webViewProps === void 0 ? void 0 : webViewProps.style, { flex: 1 }] })), [webViewProps]);
     const layoutTransactionId = (_a = record.size) === null || _a === void 0 ? void 0 : _a.layoutTransactionId;
     useLayoutEffect(() => {
         if (!layoutTransactionId) {
@@ -37,19 +36,37 @@ function NativeViewHostProjectionEntry({ controller, nativeViewComponent, onInva
         record.layoutReportRevision,
         record.viewId,
     ]);
+    // Connection readiness is controller-private, so a readiness-only snapshot
+    // update may leave the presented record fields unchanged. The controller's
+    // occurrence latch makes this render-time check idempotent.
+    useLayoutEffect(() => {
+        if (!record.isActive || record.size === null) {
+            return;
+        }
+        controller.acknowledgeViewPresentation({
+            allocationId: record.allocationId,
+            viewId: record.viewId,
+        });
+    });
     useEffect(() => detachConnection, [detachConnection]);
     return createElement(NativeViewPresentationSurface, { nativeViewComponent, record }, createElement(ViewWebViewHost, {
         generation: record.generation,
+        onActivationRetryExhausted: (error) => {
+            controller.failViewAllocation({
+                allocationId: record.allocationId,
+                error,
+                viewId: record.viewId,
+            });
+        },
         onConnected: handleConnected,
         onDisconnected: detachConnection,
         onInvalidMessage,
         srcdoc: record.srcdoc,
         viewId: record.viewId,
         webViewComponent,
-        webViewProps: presentedWebViewProps,
     }));
 }
-export function NativeViewHostProjection({ controller, nativeViewComponent, onInvalidMessage, webViewComponent, webViewProps, }) {
+export function NativeViewHostProjection({ controller, nativeViewComponent, onInvalidMessage, webViewComponent, }) {
     const records = useSyncExternalStore(controller.subscribe, controller.getSnapshot, controller.getSnapshot);
     return createElement(Fragment, null, records.map((record) => createElement(NativeViewHostProjectionEntry, {
         controller,
@@ -57,7 +74,6 @@ export function NativeViewHostProjection({ controller, nativeViewComponent, onIn
         onInvalidMessage,
         record,
         webViewComponent,
-        webViewProps,
         key: record.allocationId,
     })));
 }

package/dist/native-view-presentation-surface.js

@@ -60,6 +60,9 @@ export function NativeViewPresentationSurface({ children, nativeViewComponent, r
         ? record.size.frameAppearance.resolvedBoxShadow
         : undefined);
     const nativeBoxShadow = toNativeWidgetSupportedBoxShadow(shadow, resolveNativeWidgetBoxShadowSupport());
+    const frameShadowStyle = nativeBoxShadow === undefined && shadow.kind === "resolved"
+        ? shadow.fallbackStyle
+        : {};
     const frameOverlayShadowStyle = nativeBoxShadow === undefined ? {} : { boxShadow: nativeBoxShadow };
     const borderStyle = toNativeWidgetResolvedBorderStyle(((_f = (_e = record.size) === null || _e === void 0 ? void 0 : _e.frameAppearance) === null || _f === void 0 ? void 0 : _f.kind) === "page"
         ? record.size.frameAppearance.resolvedBorder
@@ -71,6 +74,8 @@ export function NativeViewPresentationSurface({ children, nativeViewComponent, r
         borderTopRightRadius: cornerRadii.topRight,
     };
     return createElement(NativeView, {
+        accessibilityElementsHidden: !isPresented,
+        importantForAccessibility: isPresented ? "auto" : "no-hide-descendants",
         pointerEvents: isPresented ? "box-none" : "none",
         style: Object.assign(Object.assign(Object.assign({}, HOST_SURFACE_STYLE), (((_g = record.size) === null || _g === void 0 ? void 0 : _g.placement) === "docked-top"
             ? TOP_PLACEMENT_STYLE
@@ -81,7 +86,7 @@ export function NativeViewPresentationSurface({ children, nativeViewComponent, r
     }, createElement(NativeView, {
         pointerEvents: isPresented ? "auto" : "none",
         style: hasMeasuredFrame
-            ? Object.assign(Object.assign(Object.assign({}, MEASURED_VIEW_FRAME_STYLE), cornerRadiusStyle), { height: (_h = record.size) === null || _h === void 0 ? void 0 : _h.height, width: (_j = record.size) === null || _j === void 0 ? void 0 : _j.width }) : PREPARING_VIEW_FRAME_STYLE,
+            ? Object.assign(Object.assign(Object.assign(Object.assign({}, MEASURED_VIEW_FRAME_STYLE), cornerRadiusStyle), frameShadowStyle), { height: (_h = record.size) === null || _h === void 0 ? void 0 : _h.height, width: (_j = record.size) === null || _j === void 0 ? void 0 : _j.width }) : PREPARING_VIEW_FRAME_STYLE,
         testID: `gx-native-view-frame-${record.viewId}`,
     }, createElement(NativeView, {
         style: Object.assign(Object.assign({}, VIEW_FRAME_CONTENT_STYLE), cornerRadiusStyle),

package/dist/native-view-record-controller.d.ts

@@ -1,4 +1,3 @@
-import { type OpenRequestMetadata } from "@getuserfeedback/protocol/internal/core-view-host-actions";
 import { type EventViewSize } from "@getuserfeedback/protocol/internal/view-host-control-messages";
 import type { CoreWebViewHostConnection } from "./core-webview-host-controller.js";
 import type { ViewWebViewHostConnection } from "./view-webview-host-controller.js";
@@ -6,10 +5,8 @@ type NativeViewSizeReport = Omit<EventViewSize, "gen" | "t" | "viewId">;
 export type NativeViewRecord = Readonly<{
     allocationId: number;
     generation: number;
-    instanceId: string;
     isActive: boolean;
     layoutReportRevision: number;
-    openRequest: Readonly<OpenRequestMetadata> | undefined;
     size: NativeViewSizeReport | null;
     srcdoc: string;
     viewId: string;
@@ -25,6 +22,15 @@ export type NativeViewRecordController = {
         layoutTransactionId: string;
         viewId: string;
     }): void;
+    acknowledgeViewPresentation(input: {
+        allocationId: number;
+        viewId: string;
+    }): void;
+    failViewAllocation(input: {
+        allocationId: number;
+        error: unknown;
+        viewId: string;
+    }): void;
     dispose(): void;
     getSnapshot(): readonly NativeViewRecord[];
     subscribe(listener: () => void): () => void;