@mrrocket/sdk 0.16.0 → 0.17.0

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

@@ -176,8 +176,14 @@ interface MessengerLook {
     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. */
+    /** The logo at the top left of Home: the one uploaded in MRRocket, else the product's favicon; without it the title's first letter. */
     logo?: string;
+    /** The product's favicon, the round mark in the chat's head (from 0.17; without it the title's first letter). */
+    icon?: string;
+    /** The AI agent's name on its answers (from 0.17; empty or left out: "AI agent"). */
+    agentName?: string;
+    /** The AI agent's picture beside its answers (from 0.17). */
+    agentPhoto?: string;
 }
 /** The visitor's newest chat (open or closed) and its messages. */
 interface ChatThread {
@@ -274,7 +280,8 @@ type Api = ReturnType<typeof createApi>;
  *   `onCancel`, and only after they succeed is the outcome recorded.
  * - `$onboarding` `{flow, step?, action: "started" | "shown" | "completed" | "dismissed"}`; since 0.11.0 a wait records
  *   "shown" when the person reaches it and "completed" when it is over, a condition `{action: "answered", answer: "yes"
- *   | "no"}` once it is decided.
+ *   | "no"}` once it is decided; since 0.17.0 a tour a checklist task started records `{action: "started", from}` with
+ *   the checklist's id.
  * - `$inapp` `{message, journey, action: "shown" | "clicked" | "dismissed"}`; the journey moves the person on.
  */
 
@@ -344,6 +351,17 @@ interface CancelFlowConfig {
     offersFor: "business";
 }
 type OnboardingStepKind = "tour" | "checklist" | "modal";
+/** 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";
+/**
+ * 0.17.0: a picture or a video above a tour step's or a modal's text. A video is a YouTube, Vimeo or Loom link (shown
+ * through their privacy-friendly players, see `videoEmbed`) or a video file (mp4, webm).
+ */
+interface FlowMedia {
+    kind: "image" | "video";
+    url: string;
+    alt?: string;
+}
 interface OnboardingStep {
     id: string;
     kind: OnboardingStepKind;
@@ -354,6 +372,14 @@ interface OnboardingStep {
     target?: string;
     /** Checklist items: the event that ticks them (`track("<event>")`). Without it the person ticks it themselves. */
     event?: string;
+    /** 0.17.0, tour steps: which side of the element the bubble takes (flips when there is no room). */
+    placement?: TourPlacement;
+    /** 0.17.0, tour steps and modals: a picture or a video above the text. */
+    media?: FlowMedia;
+    /** 0.17.0, modals: where the button goes (http(s) or a path of the app). */
+    url?: string;
+    /** 0.17.0, checklist items: the id of a tour (another flow) the item starts; finishing the tour ticks the item. */
+    startsTour?: string;
 }
 /** A pause in a flow (0.11.0): the next step shows this long after the one before was done. */
 interface OnboardingWait {
@@ -379,9 +405,15 @@ type OnboardingNode = OnboardingStep | OnboardingWait | OnboardingCondition;
 /** A live onboarding flow's in-app steps (MRRocket › Conversion › Onboarding); its emails go out from MRRocket. */
 interface OnboardingFlow {
     id: string;
+    /** A checklist's heading; for tours and modals the name MRRocket knows them by. */
     name: string;
-    /** When it starts: an event's words ("Signed up", "First export"), or "First launch" / "First visit". */
+    /**
+     * When it starts: an event's words ("Signed up", "First export"), "First launch" / "First visit", since 0.17.0 a page
+     * of the app ("/settings", "/projects/*"), or "From a checklist" (only a checklist task starts it).
+     */
     trigger: string;
+    /** 0.17.0: "signed_in" starts it on its own only for someone the app identified. */
+    audience?: "signed_in";
     /** What every version shows: with `nodes`, only the in-app steps before the first wait or condition. */
     steps: OnboardingStep[];
     /** 0.11.0+: the whole flow with its waits and conditions. Read instead of `steps` when it is there. */
@@ -460,12 +492,15 @@ type FlowView = {
     index: number;
     total: number;
     last: boolean;
-} | {
+}
+/** `tour`: the tour the item starts (0.17.0), when the config has it. */
+ | {
     type: "checklist";
     flow: OnboardingFlow;
     items: {
         step: OnboardingStep;
         done: boolean;
+        tour?: OnboardingFlow;
     }[];
 } | {
     type: "message";
@@ -493,10 +528,12 @@ interface FlowsController {
         confirm(comment?: string): void;
         close(): void;
     };
+    /** `startTour(stepId)` (0.17.0): the tour a checklist item starts; the checklist comes back when it ends. */
     onboarding: {
         next(): void;
         check(stepId: string): void;
         dismiss(): void;
+        startTour(stepId: string): boolean;
     };
     message: {
         click(): void;
@@ -621,7 +658,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.16.0";
+declare const SDK_VERSION = "0.17.0";
 /** One variant of an experiment. `changes` replaces texts that the page marks with `<Text id>`. */
 interface VariantConfig {
     id: VariantId;
@@ -1039,8 +1076,10 @@ interface NativeMessengerOptions {
     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). */
+    /** The logo at the top left of Home (MRRocket sends the uploaded logo, else the product's favicon). */
     logo?: string;
+    /** The AI agent's name on its answers (default "AI agent"). */
+    agentName?: 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). */
@@ -1208,4 +1247,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 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 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, useReview, useText, useVariant };
+export { type AppContext, type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type ChatMessage, type ChatThread, type CockpitConfig, type FeedbackPost, type FlagConfig, 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 OnboardingStep, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type TourPlacement, type VariantId, activeRouteName, createMRRocket, getMRRocket, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, usePaywall, usePush, useReview, useText, useVariant };

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

@@ -176,8 +176,14 @@ interface MessengerLook {
     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. */
+    /** The logo at the top left of Home: the one uploaded in MRRocket, else the product's favicon; without it the title's first letter. */
     logo?: string;
+    /** The product's favicon, the round mark in the chat's head (from 0.17; without it the title's first letter). */
+    icon?: string;
+    /** The AI agent's name on its answers (from 0.17; empty or left out: "AI agent"). */
+    agentName?: string;
+    /** The AI agent's picture beside its answers (from 0.17). */
+    agentPhoto?: string;
 }
 /** The visitor's newest chat (open or closed) and its messages. */
 interface ChatThread {
@@ -274,7 +280,8 @@ type Api = ReturnType<typeof createApi>;
  *   `onCancel`, and only after they succeed is the outcome recorded.
  * - `$onboarding` `{flow, step?, action: "started" | "shown" | "completed" | "dismissed"}`; since 0.11.0 a wait records
  *   "shown" when the person reaches it and "completed" when it is over, a condition `{action: "answered", answer: "yes"
- *   | "no"}` once it is decided.
+ *   | "no"}` once it is decided; since 0.17.0 a tour a checklist task started records `{action: "started", from}` with
+ *   the checklist's id.
  * - `$inapp` `{message, journey, action: "shown" | "clicked" | "dismissed"}`; the journey moves the person on.
  */
 
@@ -344,6 +351,17 @@ interface CancelFlowConfig {
     offersFor: "business";
 }
 type OnboardingStepKind = "tour" | "checklist" | "modal";
+/** 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";
+/**
+ * 0.17.0: a picture or a video above a tour step's or a modal's text. A video is a YouTube, Vimeo or Loom link (shown
+ * through their privacy-friendly players, see `videoEmbed`) or a video file (mp4, webm).
+ */
+interface FlowMedia {
+    kind: "image" | "video";
+    url: string;
+    alt?: string;
+}
 interface OnboardingStep {
     id: string;
     kind: OnboardingStepKind;
@@ -354,6 +372,14 @@ interface OnboardingStep {
     target?: string;
     /** Checklist items: the event that ticks them (`track("<event>")`). Without it the person ticks it themselves. */
     event?: string;
+    /** 0.17.0, tour steps: which side of the element the bubble takes (flips when there is no room). */
+    placement?: TourPlacement;
+    /** 0.17.0, tour steps and modals: a picture or a video above the text. */
+    media?: FlowMedia;
+    /** 0.17.0, modals: where the button goes (http(s) or a path of the app). */
+    url?: string;
+    /** 0.17.0, checklist items: the id of a tour (another flow) the item starts; finishing the tour ticks the item. */
+    startsTour?: string;
 }
 /** A pause in a flow (0.11.0): the next step shows this long after the one before was done. */
 interface OnboardingWait {
@@ -379,9 +405,15 @@ type OnboardingNode = OnboardingStep | OnboardingWait | OnboardingCondition;
 /** A live onboarding flow's in-app steps (MRRocket › Conversion › Onboarding); its emails go out from MRRocket. */
 interface OnboardingFlow {
     id: string;
+    /** A checklist's heading; for tours and modals the name MRRocket knows them by. */
     name: string;
-    /** When it starts: an event's words ("Signed up", "First export"), or "First launch" / "First visit". */
+    /**
+     * When it starts: an event's words ("Signed up", "First export"), "First launch" / "First visit", since 0.17.0 a page
+     * of the app ("/settings", "/projects/*"), or "From a checklist" (only a checklist task starts it).
+     */
     trigger: string;
+    /** 0.17.0: "signed_in" starts it on its own only for someone the app identified. */
+    audience?: "signed_in";
     /** What every version shows: with `nodes`, only the in-app steps before the first wait or condition. */
     steps: OnboardingStep[];
     /** 0.11.0+: the whole flow with its waits and conditions. Read instead of `steps` when it is there. */
@@ -460,12 +492,15 @@ type FlowView = {
     index: number;
     total: number;
     last: boolean;
-} | {
+}
+/** `tour`: the tour the item starts (0.17.0), when the config has it. */
+ | {
     type: "checklist";
     flow: OnboardingFlow;
     items: {
         step: OnboardingStep;
         done: boolean;
+        tour?: OnboardingFlow;
     }[];
 } | {
     type: "message";
@@ -493,10 +528,12 @@ interface FlowsController {
         confirm(comment?: string): void;
         close(): void;
     };
+    /** `startTour(stepId)` (0.17.0): the tour a checklist item starts; the checklist comes back when it ends. */
     onboarding: {
         next(): void;
         check(stepId: string): void;
         dismiss(): void;
+        startTour(stepId: string): boolean;
     };
     message: {
         click(): void;
@@ -621,7 +658,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.16.0";
+declare const SDK_VERSION = "0.17.0";
 /** One variant of an experiment. `changes` replaces texts that the page marks with `<Text id>`. */
 interface VariantConfig {
     id: VariantId;
@@ -1039,8 +1076,10 @@ interface NativeMessengerOptions {
     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). */
+    /** The logo at the top left of Home (MRRocket sends the uploaded logo, else the product's favicon). */
     logo?: string;
+    /** The AI agent's name on its answers (default "AI agent"). */
+    agentName?: 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). */
@@ -1208,4 +1247,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 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 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, useReview, useText, useVariant };
+export { type AppContext, type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type ChatMessage, type ChatThread, type CockpitConfig, type FeedbackPost, type FlagConfig, 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 OnboardingStep, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult, type RegisterForPushOptions, SDK_VERSION, type SurveyDefinition, type TourPlacement, type VariantId, activeRouteName, createMRRocket, getMRRocket, useCancelFlow, useExpoRouterTracking, useFeedback, useFlag, useFlagVariant, useMRRocket, useMessenger, useNavigationTracking, useOnboarding, usePaywall, usePush, useReview, useText, useVariant };