@guidelytech/react-native 0.8.0 → 0.10.0

package/dist/index.d.cts

@@ -4,7 +4,7 @@ import { SelectorStrategy, MessengerConfig, MessengerMessage, MessengerConversat
 export { GuideStep, PublishedGuide, SdkConfigResponse } from '@guidelytech/shared';
 import { FlagsClientOptions, FlagsClient, JsonValue, FlagValue, FlagDetails, FlagsBootstrap, Attributes } from '@guidelytech/flags';
 export { Attributes, EvaluationResult, FlagDetails, FlagsBootstrap, FlagsClient, FlagsClientOptions, FlagsPayload, InMemoryStickyBucketStore, JsonValue, createFlagsClient } from '@guidelytech/flags';
-import { KeyValueStore, ChecklistProgressState, GuidelyEnvironment, ConsentState, GuidelyUser, GuidelyAccount, GuideLocalState, SessionState } from '@guidelytech/sdk-core/headless';
+import { KeyValueStore, ServerHealth, ChecklistProgressState, GuidelyEnvironment, ConsentState, GuidelyUser, GuidelyAccount, GuideLocalState, SessionState } from '@guidelytech/sdk-core/headless';
 export { ChecklistProgressState, ConsentState, GuidelyAccount, GuidelyEnvironment, GuidelyUser } from '@guidelytech/sdk-core/headless';
 import { ViewProps, StyleProp, ViewStyle, View, GestureResponderEvent } from 'react-native';
 
@@ -135,6 +135,8 @@ interface MessengerDeps {
     onMessage: (message: MessengerMessage, conversation: MessengerConversation) => void;
     onStartGuide: (key: string) => void;
     onError: (err: unknown) => void;
+    /** The SDK API's circuit breaker, told how each reply stream went. */
+    health?: ServerHealth;
     /** Poll intervals (ms): open thread, and unread badge otherwise. */
     pollMs?: {
         thread: number;
@@ -216,8 +218,9 @@ interface GuidelyOptions {
     /** Base URL of your Guidely deployment, e.g. `https://guidelytech.com`. */
     apiUrl?: string;
     /**
-     * Where identity, cached config and queued events are persisted. Pass AsyncStorage
-     * (`@react-native-async-storage/async-storage`); without it state lasts only for the app session.
+     * Where identity, cached config, queued events and unsent survey answers are persisted. Pass AsyncStorage
+     * (`@react-native-async-storage/async-storage`); without it state lasts only for the app session,
+     * so anything not yet sent during a Guidely outage is lost when the app restarts.
      */
     storage?: GuidelyStorage;
     debug?: boolean;
@@ -331,7 +334,7 @@ interface UiState {
 }
 
 declare const SDK_NAME = "@guidelytech/react-native";
-declare const SDK_VERSION = "0.8.0";
+declare const SDK_VERSION = "0.10.0";
 declare const DEFAULT_API_URL = "https://guidelytech.com";
 /** Host-platform services the engine needs; the provider supplies React Native implementations. */
 interface PlatformBridge {
@@ -362,6 +365,8 @@ declare class GuidelyClient {
     private readonly store;
     private readonly emitter;
     private queue;
+    /** Survey answers, guide completions/dismissals and checklist progress, kept until the server has them. */
+    private outbox;
     private config;
     private configFetchedAt;
     private etag;
@@ -411,6 +416,8 @@ declare class GuidelyClient {
     private wireTimers;
     /** Re-fetches the published config and re-evaluates triggers. */
     refresh(): Promise<void>;
+    /** Re-renders after a config change (refresh, or a config that arrived after start). */
+    private applyConfigChange;
     /** Called by the provider with React Native `AppState` changes. */
     setAppState(state: "active" | "background" | "inactive" | string): void;
     private sessionExpired;
@@ -459,6 +466,8 @@ declare class GuidelyClient {
     private recordImpression;
     private recordEnd;
     private syncGuideState;
+    /** Queues a write in the persisted outbox (sent now, or once the API is reachable again). */
+    private sendDurably;
     private show;
     private showFlow;
     private showChecklist;
@@ -574,6 +583,7 @@ declare class GuidelyClient {
         audienceIds: string[];
         session: MobileSession;
         pendingEvents: number;
+        pendingWrites: number;
         targets: string[];
         flagsReady: boolean;
     };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { SelectorStrategy, MessengerConfig, MessengerMessage, MessengerConversat
 export { GuideStep, PublishedGuide, SdkConfigResponse } from '@guidelytech/shared';
 import { FlagsClientOptions, FlagsClient, JsonValue, FlagValue, FlagDetails, FlagsBootstrap, Attributes } from '@guidelytech/flags';
 export { Attributes, EvaluationResult, FlagDetails, FlagsBootstrap, FlagsClient, FlagsClientOptions, FlagsPayload, InMemoryStickyBucketStore, JsonValue, createFlagsClient } from '@guidelytech/flags';
-import { KeyValueStore, ChecklistProgressState, GuidelyEnvironment, ConsentState, GuidelyUser, GuidelyAccount, GuideLocalState, SessionState } from '@guidelytech/sdk-core/headless';
+import { KeyValueStore, ServerHealth, ChecklistProgressState, GuidelyEnvironment, ConsentState, GuidelyUser, GuidelyAccount, GuideLocalState, SessionState } from '@guidelytech/sdk-core/headless';
 export { ChecklistProgressState, ConsentState, GuidelyAccount, GuidelyEnvironment, GuidelyUser } from '@guidelytech/sdk-core/headless';
 import { ViewProps, StyleProp, ViewStyle, View, GestureResponderEvent } from 'react-native';
 
@@ -135,6 +135,8 @@ interface MessengerDeps {
     onMessage: (message: MessengerMessage, conversation: MessengerConversation) => void;
     onStartGuide: (key: string) => void;
     onError: (err: unknown) => void;
+    /** The SDK API's circuit breaker, told how each reply stream went. */
+    health?: ServerHealth;
     /** Poll intervals (ms): open thread, and unread badge otherwise. */
     pollMs?: {
         thread: number;
@@ -216,8 +218,9 @@ interface GuidelyOptions {
     /** Base URL of your Guidely deployment, e.g. `https://guidelytech.com`. */
     apiUrl?: string;
     /**
-     * Where identity, cached config and queued events are persisted. Pass AsyncStorage
-     * (`@react-native-async-storage/async-storage`); without it state lasts only for the app session.
+     * Where identity, cached config, queued events and unsent survey answers are persisted. Pass AsyncStorage
+     * (`@react-native-async-storage/async-storage`); without it state lasts only for the app session,
+     * so anything not yet sent during a Guidely outage is lost when the app restarts.
      */
     storage?: GuidelyStorage;
     debug?: boolean;
@@ -331,7 +334,7 @@ interface UiState {
 }
 
 declare const SDK_NAME = "@guidelytech/react-native";
-declare const SDK_VERSION = "0.8.0";
+declare const SDK_VERSION = "0.10.0";
 declare const DEFAULT_API_URL = "https://guidelytech.com";
 /** Host-platform services the engine needs; the provider supplies React Native implementations. */
 interface PlatformBridge {
@@ -362,6 +365,8 @@ declare class GuidelyClient {
     private readonly store;
     private readonly emitter;
     private queue;
+    /** Survey answers, guide completions/dismissals and checklist progress, kept until the server has them. */
+    private outbox;
     private config;
     private configFetchedAt;
     private etag;
@@ -411,6 +416,8 @@ declare class GuidelyClient {
     private wireTimers;
     /** Re-fetches the published config and re-evaluates triggers. */
     refresh(): Promise<void>;
+    /** Re-renders after a config change (refresh, or a config that arrived after start). */
+    private applyConfigChange;
     /** Called by the provider with React Native `AppState` changes. */
     setAppState(state: "active" | "background" | "inactive" | string): void;
     private sessionExpired;
@@ -459,6 +466,8 @@ declare class GuidelyClient {
     private recordImpression;
     private recordEnd;
     private syncGuideState;
+    /** Queues a write in the persisted outbox (sent now, or once the API is reachable again). */
+    private sendDurably;
     private show;
     private showFlow;
     private showChecklist;
@@ -574,6 +583,7 @@ declare class GuidelyClient {
         audienceIds: string[];
         session: MobileSession;
         pendingEvents: number;
+        pendingWrites: number;
         targets: string[];
         flagsReady: boolean;
     };