@mrrocket/sdk 0.13.0 → 0.15.0

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

@@ -78,6 +78,28 @@ interface SurveyDefinition {
     questions: SurveyQuestion[];
 }
 type SurveyAnswer = number | string | string[];
+/** A file in the messenger's chat: a screenshot, a photo or a PDF the visitor sent (servers from SDK 0.15 on). */
+interface ChatFile {
+    /** From an upload: the signed id a message sends. In a message: the file's own id (`attachmentUrl` reads it). */
+    id: string;
+    name: string;
+    type: "image/png" | "image/jpeg" | "image/webp" | "image/gif" | "application/pdf";
+    /** Bytes. */
+    size: number;
+}
+/** A file to upload: a Blob or File on the web, the image picker's `{ uri, name, type }` in React Native. */
+type ChatUpload = Blob | {
+    uri: string;
+    name: string;
+    type: string;
+};
+/** The bug context a visitor message carries; the server fills browser and system from the user agent when left out. */
+interface ChatContext {
+    browser?: string;
+    os?: string;
+    /** "1440×900". */
+    viewport?: string;
+}
 /** One message of the messenger's chat. "visitor" is the person on the site; the rest come from the product's team. */
 interface ChatMessage {
     id: string;
@@ -89,6 +111,8 @@ interface ChatMessage {
         id: string;
         title: string;
     }[];
+    /** Files sent with it (servers from SDK 0.15 on). */
+    attachments?: ChatFile[];
 }
 /** A published help article in a list (the messenger's Help tab). */
 interface ArticleSummary {
@@ -126,11 +150,17 @@ interface Article {
     updatedAt: string;
     blocks: ArticleBlock[];
 }
+/** Where the chat button sits: a corner, the middle of the top or bottom edge, or the middle of a side. */
+type MessengerPosition = "top-left" | "top-center" | "top-right" | "middle-left" | "middle-right" | "bottom-left" | "bottom-center" | "bottom-right";
+/** How round the messenger is. */
+type MessengerCorners = "round" | "soft" | "square";
 /** The messenger's look and texts as set in MRRocket › Support › Messenger (servers from SDK 0.9 on). */
 interface MessengerLook {
     accent: string;
+    /** Up to two more colors blended into Home's background glow (MRRocket from 0.16; older servers leave it out). */
+    glow?: string[];
     theme: "light" | "dark" | "auto";
-    position: "bottom-right" | "bottom-left";
+    position: MessengerPosition;
     title: string;
     greeting: string;
     label: string;
@@ -142,6 +172,16 @@ interface MessengerLook {
     sound: boolean;
     preview: boolean;
     askEmail: boolean;
+    /** How round panel, bubbles, cards and fields are (MRRocket from 0.15; older servers leave it out: round). */
+    corners?: MessengerCorners;
+    /** The site's own font (the default) or the system's (web only; from 0.15). */
+    font?: "site" | "system";
+    /** Home's top: plain like the rest, or in the accent color (from 0.15; older servers leave it out: plain). */
+    header?: "plain" | "color";
+    /** "Powered by MRRocket" at the bottom; the server sends false only on plans that may hide it (from 0.15). */
+    branding?: boolean;
+    /** The product's icon (its favicon) at the top left of Home; without it the title's first letter. */
+    logo?: string;
 }
 /** The visitor's newest chat (open or closed) and its messages. */
 interface ChatThread {
@@ -197,11 +237,18 @@ declare const createApi: (c: Conn) => {
         seconds: number;
     }) => Promise<unknown>;
     chat: (signal?: AbortSignal) => Promise<ChatThread>;
+    /** A message; `attachments` are upload ids from `uploadChatFile` (then the body may be empty). */
     sendChat: (m: {
         body: string;
         email?: string;
         url?: string;
+        attachments?: string[];
+        context?: ChatContext;
     }) => Promise<ChatThread>;
+    /** Uploads one picked file for the next message (pictures and PDFs, at most 10 MB); answers its upload id. */
+    uploadChatFile: (file: ChatUpload, signal?: AbortSignal) => Promise<ChatFile>;
+    /** Where a sent file of this visitor's chat is read (an image's src, a PDF's link). */
+    attachmentUrl: (id: string) => string;
     articles: (q?: string, signal?: AbortSignal) => Promise<{
         articles: ArticleSummary[];
     }>;
@@ -243,6 +290,29 @@ interface CancelOffer {
     plan?: string;
     planName?: string;
 }
+/** 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. */
+    answers: string[];
+}
+/**
+ * 0.15.0: a different offer for some customers of one answer. Every condition that is set must hold; the first rule
+ * that matches wins, else the answer's own offer. `offer: null` means no offer (straight to the confirmation).
+ */
+interface CancelRule {
+    when: {
+        /** The follow-up's answer, as written. */
+        answer?: string;
+        /** The customer's plan: its id or name as MRRocket knows it from the payment provider (any of a list). */
+        plan?: string | string[];
+        /** A customer for fewer than this many months. */
+        tenureUnder?: number;
+        /** A customer for at least this many months. */
+        tenureOver?: number;
+    };
+    offer: CancelOffer | null;
+}
 /** The product's live cancel flow (MRRocket › Churn › Cancel flow). */
 interface CancelFlowConfig {
     /** Grows with every publish. */
@@ -255,6 +325,12 @@ interface CancelFlowConfig {
     }[];
     /** The offer per answer id. */
     offers: Record<string, CancelOffer>;
+    /** 0.15.0: the follow-up question per answer id. */
+    followUps?: Record<string, CancelFollowUp>;
+    /** 0.15.0: the rules per answer id, checked in order before its offer. */
+    rules?: Record<string, CancelRule[]>;
+    /** 0.15.0: what one answer offers after its first offer was declined. */
+    second?: Record<string, CancelOffer>;
     confirm: {
         title: string;
         body: string;
@@ -326,6 +402,8 @@ interface CancelFlowResult {
     outcome: "cancelled" | "saved" | "kept";
     reason?: string;
     reasonLabel?: string;
+    /** 0.15.0: the answer to the follow-up question. */
+    answer?: string;
     offer?: CancelOffer;
     /** What the customer wrote on the confirmation, if anything. */
     comment?: string;
@@ -344,6 +422,10 @@ interface CancelFlowOptions {
         currency: string;
         interval?: "month" | "year";
     };
+    /** 0.15.0: the customer's plan (its id or name in your billing), for offers that depend on it. */
+    plan?: string;
+    /** 0.15.0: since when they pay (a date, ISO string or ms), for offers that depend on how long. */
+    customerSince?: Date | string | number;
     /** The customer confirmed: cancel the subscription in your code. Throwing keeps the dialog open with an error. */
     onCancel?: (result: CancelFlowResult) => unknown;
     /** The customer took an offer: apply it in your code (coupon, pause, plan change). Throwing keeps the dialog open. */
@@ -354,11 +436,16 @@ interface CancelFlowOptions {
 /** What a renderer draws. */
 type FlowView = {
     type: "cancel";
-    screen: "survey" | "offer" | "confirm";
+    screen: "survey" | "followup" | "offer" | "confirm";
     flow: CancelFlowConfig;
     /** The answer picked on the survey. */
     reason?: string;
+    /** 0.15.0: the follow-up question on its screen, and its answer so far. */
+    followUp?: CancelFollowUp;
+    answer?: string;
     offer?: CancelOffer;
+    /** 0.15.0: 2 for the offer after a declined one. */
+    round?: 1 | 2;
     price?: CancelFlowOptions["price"];
     busy: boolean;
     error?: string;
@@ -395,8 +482,10 @@ interface FlowsController {
     view(): FlowView | null;
     subscribe(listener: () => void): () => void;
     /** `accept(comment)`: a "Talk to us" offer sends what the customer wrote with it. */
+    /** `answer(text)`: the follow-up's choice or free text (0.15.0); `next()` moves on from the survey and the follow-up. */
     cancel: {
         pick(reason: string): void;
+        answer(text: string): void;
         next(): void;
         accept(comment?: string): void;
         decline(): void;
@@ -414,6 +503,116 @@ interface FlowsController {
     };
 }
 
+/**
+ * Paywalls with several pages (SDK 0.14.0): what MRRocket's config serves under `paywalls` (one per placement, built
+ * in MRRocket › Conversion › Paywalls) and a small controller that walks the person through its pages, page after page,
+ * until the last one hands the chosen plan to the app. No DOM and no React: the web renderer (`mountPaywall` in
+ * flows-ui.ts, loaded only when a paywall opens) and the React Native one (native/flows-view.ts) draw `view()` and
+ * call the actions.
+ *
+ * MRRocket never takes a payment. The last page's button calls the app's `onPurchase(plan)`, which buys through the
+ * app's own store code (StoreKit or Play through RevenueCat or Adapty, or Stripe Checkout on the web); only when it
+ * resolves is the purchase recorded. It throwing keeps the paywall open with an error, resolving `false` (the person
+ * closed the store sheet) keeps it open without one.
+ *
+ * A running test on the paywall (`experiment`) gives each person their variant's pages, by the same stable hash as
+ * every other test (`assign`), and records `$exposure` when the paywall opens. What it records, as normal events under
+ * the SDK's analytics consent:
+ * - `$paywall` `{paywall, placement, variant, page, index, action: "page"}` the first time each page shows in a run,
+ *   so MRRocket shows how many reach page 2 and 3;
+ * - `{action: "purchased", plan}` after `onPurchase` went through (a test's purchase goal counts it), and
+ *   `{action: "closed", index}` when the person closed it.
+ */
+
+/** One page of a paywall. Plans pages list the plans and buy; the others say why and go on. */
+interface PaywallPage {
+    id: string;
+    /** "benefits": a list of what the person gets; "proof": quotes of happy customers; "plans": the plans and the buy button. */
+    kind: "benefits" | "proof" | "plans";
+    title: string;
+    body?: string;
+    /** Benefits: one line each. */
+    items?: string[];
+    /** Proof: what customers said, and who. */
+    quotes?: {
+        text: string;
+        by?: string;
+    }[];
+    /** The button: "Continue" on the way, the buy button on the plans page ("Start free trial"). */
+    button?: string;
+}
+/** A plan the paywall offers. `id` is what the app buys: the store product id or the Stripe price, as set in MRRocket. */
+interface PaywallPlan {
+    id: string;
+    name: string;
+    /** As shown ("€59.99 / year"). The app's own store prices win when it passes `plans`. */
+    price: string;
+    /** A line under it ("€5 a month", "7 days free"). */
+    note?: string;
+}
+/** A published paywall as the config serves it. */
+interface PaywallConfig {
+    id: string;
+    /** The placement's key (`onboarding_end`), what the app opens: `paywall.open("onboarding_end")`. */
+    placement: string;
+    /** The running test on it, a key of `experiments`; each of its variants has pages under `variants`. */
+    experiment?: string;
+    /** Control (the live paywall) first. */
+    variants: {
+        id: VariantId;
+        pages: PaywallPage[];
+    }[];
+    plans: PaywallPlan[];
+    /** The plan picked before the person picks one. */
+    highlight?: string;
+}
+interface PaywallResult {
+    /**
+     * "purchased": `onPurchase` went through; "chosen": the person picked a plan and there is no `onPurchase`, so the app
+     * buys it now (the store's purchase still counts for a test through RevenueCat or Adapty); "closed": the person
+     * closed it (or there was no paywall).
+     */
+    outcome: "purchased" | "chosen" | "closed";
+    plan?: PaywallPlan;
+    paywall?: string;
+    variant?: VariantId;
+    /** The page the person was on, from 0. */
+    index: number;
+}
+interface PaywallOptions {
+    /**
+     * Buy the plan in your code (RevenueCat `purchasePackage`, Adapty `makePurchase`, Stripe Checkout). Throwing keeps
+     * the paywall open with an error; `false` keeps it open without one (the person cancelled the store sheet).
+     */
+    onPurchase?: (plan: PaywallPlan) => unknown;
+    /** Your store's plans with their local prices, by the same ids; they replace what MRRocket has for them. */
+    plans?: PaywallPlan[];
+    onClose?: (result: PaywallResult) => void;
+}
+interface PaywallView {
+    paywall: PaywallConfig;
+    variant: VariantId;
+    page: PaywallPage;
+    index: number;
+    total: number;
+    last: boolean;
+    plans: PaywallPlan[];
+    /** The picked plan's id. */
+    plan?: string;
+    busy: boolean;
+    error?: string;
+}
+interface PaywallHost {
+    /** Opens the paywall of a placement; resolves when it is bought or closed (at once with "closed" when there is none). */
+    open(placement: string, options?: PaywallOptions): Promise<PaywallResult>;
+    view(): PaywallView | null;
+    subscribe(listener: () => void): () => void;
+    next(): void;
+    back(): void;
+    pick(planId: string): void;
+    close(): void;
+}
+
 /**
  * The part of the SDK that runs anywhere: experiment config, variant assignment, preview links and event shapes.
  * No React, no browser APIs, so the server helper, the proxy helper and the client share it.
@@ -421,7 +620,7 @@ interface FlowsController {
 
 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.13.0";
+declare const SDK_VERSION = "0.15.0";
 /** One variant of an experiment. `changes` replaces texts that the page marks with `<Text id>`. */
 interface VariantConfig {
     id: VariantId;
@@ -478,6 +677,8 @@ interface CockpitConfig {
     messages?: boolean;
     /** Page redirects set in MRRocket; the SDK sends visitors on before the page shows (`redirectFor`). SDK 0.7.0+. */
     redirects?: RedirectConfig[];
+    /** Published paywalls with their pages, per placement (MRRocket › Conversion › Paywalls), for `paywall.open()`. SDK 0.14.0+. */
+    paywalls?: PaywallConfig[];
 }
 /** One condition of a flag's audience, on a property of the person (`identify(id, props)`), the id or the page. */
 interface FlagCondition {
@@ -668,6 +869,14 @@ interface MRRocketClient {
     openCancelFlow(options?: CancelFlowOptions): Promise<CancelFlowResult>;
     /** Starts an onboarding flow now (the first live one without an id). False when there is none. */
     startOnboarding(id?: string): boolean;
+    /**
+     * Shows the paywall of a placement built in MRRocket › Paywalls page by page (drawn by `<MRRocketProvider>`). Its
+     * last page hands the chosen plan to `onPurchase`, where your code buys it (RevenueCat, Adapty, StoreKit, Play);
+     * MRRocket never takes a payment. Pass your store's `plans` to show their local prices.
+     */
+    openPaywall(placement: string, options?: PaywallOptions): Promise<PaywallResult>;
+    /** The open paywall for a renderer (the provider's, or your own). */
+    paywall: PaywallHost;
     /**
      * Push notifications from your Lifecycle journeys for the signed-in person (call `identify` first). Asks the
      * permission (unless `ask: false`), gets the Expo push token and sends it to MRRocket. Needs `expo-notifications`.
@@ -720,8 +929,9 @@ interface NativeAppearance {
     theme?: "light" | "dark" | "auto";
     accent?: string;
 }
-declare const MRRocketFlows: ({ flows, appearance }: {
+declare const MRRocketFlows: ({ flows, paywall, appearance }: {
     flows: FlowsController;
+    paywall?: PaywallHost;
     appearance?: NativeAppearance;
 }) => react.FunctionComponentElement<Record<string, unknown>> | null;
 
@@ -774,15 +984,22 @@ declare const useMessenger: () => {
 interface NativeMessengerOptions {
     /** A round chat button (default false: open it with `useMessenger().open()` from your own button). */
     launcher?: boolean;
-    /** Where the chat button sits (default bottom right). */
-    position?: "bottom-right" | "bottom-left";
+    /** Where the chat button sits: a corner, the middle of the top or bottom edge, or the middle of a side (default bottom right). */
+    position?: MessengerPosition;
     /** Text beside the chat button's icon; empty: the round button. */
     label?: string;
+    /** The name beside the team's mark at the top of Home (MRRocket fills in the product's name). */
     title?: string;
     /** The big line on Home and the first line of an empty chat. */
     greeting?: string;
-    /** How soon the team usually answers, said under "Send us a message" and in the chat's head. */
+    /** How soon the team usually answers, said on Home. */
     replyTime?: "minutes" | "hours" | "day";
+    /** How round bubbles, cards and fields are (default round; the sheet itself keeps the system's corners). */
+    corners?: MessengerCorners;
+    /** Home's top: plain like the rest (default), or in the accent color with raised cards. */
+    header?: "plain" | "color";
+    /** The product's icon at the top left of Home (MRRocket sends the product's favicon). */
+    logo?: string;
     /** Ask people the app did not identify with an email for an email (optional for them). Default true. */
     askEmail?: boolean;
     /** The Help tab with your published help articles (default true; hidden while there are none). */
@@ -891,6 +1108,16 @@ declare const usePush: () => {
     register: MRRocketClient["registerForPush"];
     unregister: MRRocketClient["unregisterForPush"];
 };
+/**
+ * The paywalls built in MRRocket › Paywalls, page by page; the provider draws them. The last page hands the chosen plan
+ * to `onPurchase`, where your code buys it. MRRocket never takes a payment.
+ *
+ *     const paywall = usePaywall();
+ *     paywall.open("onboarding_end", { plans: storePlans, onPurchase: (plan) => Purchases.purchasePackage(packages[plan.id]) });
+ */
+declare const usePaywall: () => {
+    open: MRRocketClient["openPaywall"];
+};
 /** Starts an onboarding flow now (the first live one without an id), whatever its trigger. */
 declare const useOnboarding: () => {
     start: (id?: string) => boolean;
@@ -929,4 +1156,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 FlagConfig, type FlowView, 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 OnboardingFlow, type OnboardingStep, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type VariantId, activeRouteName, createMRRocket, getMRRocket, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, usePush, useText, useVariant };
+export { type AppContext, type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type ChatMessage, type ChatThread, type CockpitConfig, type FeedbackPost, type FlagConfig, type FlowView, 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 OnboardingFlow, type OnboardingStep, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type VariantId, activeRouteName, createMRRocket, getMRRocket, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, usePaywall, usePush, useText, useVariant };