@mrrocket/sdk 0.18.0 → 0.22.0

package/dist/react-native/index.d.ts

@@ -61,6 +61,11 @@ interface SurveyQuestion {
     description?: string;
     required: boolean;
     options?: string[];
+    /**
+     * 0.21.0: what each option says in the visitor's language, parallel to `options`. An answer is still recorded as the
+     * `options` value, so rules and numbers do not split by language.
+     */
+    labels?: string[];
     scale?: number;
     low?: string;
     high?: string;
@@ -165,6 +170,8 @@ interface MessengerLook {
     /** A round chat button in the app (React Native) too. */
     appLauncher?: boolean;
     help: boolean;
+    /** The Updates tab with the published changelog (MRRocket from 0.22; older servers leave it out). */
+    updates?: boolean;
     sound: boolean;
     preview: boolean;
     askEmail: boolean;
@@ -185,13 +192,24 @@ interface MessengerLook {
     /** The AI agent's picture beside its answers (from 0.17). */
     agentPhoto?: string;
 }
-/** The visitor's newest chat (open or closed) and its messages. */
+/** One of the visitor's conversations in their list (0.19). */
+interface ChatSummary {
+    id: string;
+    status: "open" | "solved";
+    /** The visitor's first words. */
+    subject: string;
+    /** The newest message, its body cut to a preview. */
+    last: ChatMessage | null;
+}
+/** One chat (the one asked for, else the visitor's newest, open or closed) and its messages. */
 interface ChatThread {
     conversation: {
         id: string;
         status: "open" | "solved";
     } | null;
     messages: ChatMessage[];
+    /** All the visitor's conversations, the latest activity first (0.19). */
+    conversations?: ChatSummary[];
     /** The visitor gave an email already: the messenger stops asking. */
     hasEmail: boolean;
 }
@@ -243,10 +261,15 @@ declare const createApi: (c: Conn) => {
         completed: boolean;
         seconds: number;
     }) => Promise<unknown>;
-    chat: (signal?: AbortSignal) => Promise<ChatThread>;
-    /** A message; `attachments` are upload ids from `uploadChatFile` (then the body may be empty). */
+    /** One chat by id, else the visitor's newest; `conversations` lists them all. */
+    chat: (signal?: AbortSignal, conversation?: string) => Promise<ChatThread>;
+    /**
+     * A message; `attachments` are upload ids from `uploadChatFile` (then the body may be empty). `conversation` is
+     * the chat it answers, or "new" to start one; without it, the running chat or else a new one.
+     */
     sendChat: (m: {
         body: string;
+        conversation?: string;
         email?: string;
         url?: string;
         attachments?: string[];
@@ -303,8 +326,10 @@ interface CancelOffer {
 /** 0.15.0: a second question after an answer ("What would be a fair price?"); no answers means a free text. */
 interface CancelFollowUp {
     question: string;
-    /** The choices, in order; empty for a free text. */
+    /** The choices, in order; empty for a free text. What is recorded and what rules compare, whatever the language. */
     answers: string[];
+    /** 0.21.0: what each choice says in the visitor's language, parallel to `answers`; shown instead of them. */
+    answerLabels?: string[];
 }
 /**
  * 0.15.0: a different offer for some customers of one answer. Every condition that is set must hold; the first rule
@@ -387,11 +412,15 @@ type FlowIcon = {
 };
 /** 0.18.0: what plays when someone finishes a checklist, a tour or the questions. */
 type FinishAnimation = "none" | "confetti" | "fireworks" | "stars";
-/** 0.18.0: one question of a Questions item: one choice of 2 to 6 options, or a short text. */
+/**
+ * 0.18.0: one question of a Questions item: one choice of 2 to 6 options, or a short text. 0.21.0: a number scale, an
+ * "Other" with the person's own words, and a Skip button. An older app shows a scale as a text field, leaves "Other"
+ * out, and offers no Skip (its close button still ends the window).
+ */
 interface OnboardingQuestion {
     /** The answer's name on the contact (`onboarding.<key>`) and in "People who answered …". */
     key: string;
-    type: "choice" | "text";
+    type: "choice" | "text" | "scale";
     /** Choice: the options, in order; `id` is what is stored, `label` what people read. */
     options?: {
         id: string;
@@ -399,6 +428,19 @@ interface OnboardingQuestion {
     }[];
     /** Text: the field's hint. */
     placeholder?: string;
+    /** 0.21.0, choice: one more option where people type their own words, stored as `other:<words>`. */
+    other?: boolean;
+    /** 0.21.0: the words of that option; "Other" when unset. */
+    otherLabel?: string;
+    /** 0.21.0, scale: the lowest and highest number, and the words under both ends. */
+    min?: number;
+    max?: number;
+    lowLabel?: string;
+    highLabel?: string;
+    /** 0.21.0: people may go on without answering. */
+    optional?: boolean;
+    /** 0.21.0: the words of that button; "Skip" when unset. */
+    skipLabel?: string;
 }
 /** 0.17.0: where a tour bubble sits next to its element; "auto" (and no value) puts it below, else above, as before. */
 type TourPlacement = "auto" | "top" | "bottom" | "left" | "right";
@@ -628,6 +670,8 @@ interface FlowsController {
         startTour(stepId: string): boolean;
         open(stepId: string): boolean;
         answer(value: string): void;
+        /** 0.21.0: goes on from an optional question without an answer. */
+        skip(): void;
         back(): void;
         item(id: string): OnboardingItemState | null;
         seen(id: string): void;
@@ -782,7 +826,7 @@ interface PaywallHost {
 
 type VariantId = string;
 /** This build of the SDK. Sent with the config request so MRRocket knows what the site runs (error tracking, flags). */
-declare const SDK_VERSION = "0.18.0";
+declare const SDK_VERSION = "0.22.0";
 /** One variant of an experiment. `changes` replaces texts that the page marks with `<Text id>`. */
 interface VariantConfig {
     id: VariantId;
@@ -816,6 +860,10 @@ interface RedirectConfig {
 interface CockpitConfig {
     /** The product the public key belongs to. */
     project: string;
+    /** The language the server chose for the words below, like "de" (`lang` on the request). SDK 0.21.0+. */
+    lang?: string;
+    /** The SDK's own words: English source word to translation (see words.ts). Absent for English. SDK 0.21.0+. */
+    words?: Record<string, string>;
     experiments: ExperimentConfig[];
     /** The product's affiliate program: how many days a partner's referral is kept. Missing without a program. */
     referral?: {
@@ -983,6 +1031,11 @@ interface MRRocketOptions {
     maxQueue?: number;
     /** Log what the SDK does to the console. */
     debug?: boolean;
+    /**
+     * 0.21.0: the language of the SDK's words and of what the server answers, like "de-AT", for an app with its own
+     * language switch. Default: the phone's. `setLocale` does the same from anywhere.
+     */
+    locale?: string;
     /** Onboarding flows start on their own when the person does their trigger (default true). False: only `startOnboarding()`. */
     onboarding?: boolean;
     /**
@@ -1137,6 +1190,24 @@ interface MRRocketClient {
 /** The name of the screen a React Navigation state shows: the focused route, followed into nested navigators. */
 declare const activeRouteName: (state: unknown) => string | undefined;
 
+type OnboardingReportType = "questions" | "checklist" | "tour";
+interface OnboardingReportOptions {
+    /** Every step's id in the order people meet them, so a step only some people see keeps its place. */
+    order?: string[];
+    /** "questions" (the default), a "checklist" or a "tour". */
+    type?: OnboardingReportType;
+}
+interface OnboardingReport {
+    /** The person sees this step; `title` is its name in MRRocket. Sent once per step and page. */
+    saw(step: string, title: string): void;
+    /** The person answered a question with one of its options: its id, and its words in MRRocket. */
+    answered(question: string, answer: string, label?: string): void;
+    /** The person did this task or tour step. */
+    done(step: string): void;
+    /** The person closed it or skipped the rest, at this step if you name one. */
+    closed(step?: string): void;
+}
+
 interface UseOnboarding {
     /** The item as MRRocket published it, or null while the config is loading, or when it is not live. */
     item: OnboardingFlow | null;
@@ -1251,6 +1322,11 @@ declare const MRRocketMessenger: ({ client, appearance, options: given }: {
     options?: NativeMessengerOptions;
 }) => react.FunctionComponentElement<Record<string, unknown>> | null;
 
+/** An app with its own language switch says the language here; undefined goes back to the device's. Re-reads the config. */
+declare const setLocale: (locale?: string) => void;
+/** The app's choice, else the phone's (React Native), else the browser's. */
+declare const currentLocale: () => string | undefined;
+
 /**
  * Hides what it wraps in session recordings: its area is painted black on every frame before the frame is stored. Use
  * it for anything private on screen (balances, addresses, messages). Text fields need no wrapper: nothing is recorded
@@ -1375,6 +1451,15 @@ declare const useReview: () => {
  *     if (!item || done) return null;
  */
 declare const useOnboarding: (id?: string) => UseOnboarding;
+/**
+ * 0.22.0: for an onboarding that lives in your own code. Nothing to set up in MRRocket: the first report makes the item
+ * under Onboarding, and MRRocket shows who saw each step and what they answered. It follows the person's consent.
+ *
+ *     const report = useOnboardingReport("Welcome questions", { order: ["goal", "role"] });
+ *     report.saw("goal", "What brings you here?");
+ *     report.answered("goal", "dream", "Dream game");
+ */
+declare const useOnboardingReport: (name: string, options?: OnboardingReportOptions) => OnboardingReport;
 /** A feature flag from MRRocket › Build › Feature flags: true while it is on for this person; false while off, unknown or loading. */
 declare const useFlag: (key: string) => boolean;
 /** The variant of a multivariate flag ("control", "test" …), or null while it is off. */
@@ -1409,4 +1494,4 @@ declare const useExpoRouterTracking: () => void;
  */
 declare const useNavigationTracking: () => (state: unknown) => void;
 
-export { type AppContext, type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type ChatMessage, type ChatThread, type CockpitConfig, type FeedbackPost, type FinishAnimation, type FlagConfig, type FlowIcon, type FlowMedia, type FlowView, type IdentifyOptions, type InAppMessage, type KeyValueStorage, type MRRocketClient, MRRocketFeedback, MRRocketFlows, MRRocketMask, MRRocketMessenger, type MRRocketOptions, MRRocketProvider, type MRRocketProviderProps, MRRocketSurveys, type NativeAppearance, type NativeConsent, type NativeFeedbackOptions, type NativeMessengerOptions, type NativePushResult, type NativePushStatus, type NativeReviewResult, type OnboardingFlow, type OnboardingItemState, type OnboardingQuestion, type OnboardingStep, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type TaskOpens, type TourPlacement, type UseOnboarding, type VariantId, activeRouteName, createMRRocket, getMRRocket, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, usePaywall, usePush, useReview, useText, useVariant };
+export { type AppContext, type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type ChatMessage, type ChatThread, type CockpitConfig, type FeedbackPost, type FinishAnimation, type FlagConfig, type FlowIcon, type FlowMedia, type FlowView, type IdentifyOptions, type InAppMessage, type KeyValueStorage, type MRRocketClient, MRRocketFeedback, MRRocketFlows, MRRocketMask, MRRocketMessenger, type MRRocketOptions, MRRocketProvider, type MRRocketProviderProps, MRRocketSurveys, type NativeAppearance, type NativeConsent, type NativeFeedbackOptions, type NativeMessengerOptions, type NativePushResult, type NativePushStatus, type NativeReviewResult, type OnboardingFlow, type OnboardingItemState, type OnboardingQuestion, type OnboardingReport, type OnboardingReportOptions, type OnboardingReportType, type OnboardingStep, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type TaskOpens, type TourPlacement, type UseOnboarding, type VariantId, activeRouteName, createMRRocket, currentLocale, getMRRocket, setLocale, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, useOnboardingReport, usePaywall, usePush, useReview, useText, useVariant };