@mrrocket/sdk 0.18.0 → 0.22.0

package/dist/i18n.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/i18n.ts"],"sourcesContent":["/**\n * The SDK's own words in the visitor's language. English is the source: `t(\"Send\")` answers the translation the config\n * brought, or \"Send\". Plurals are separate source words (\"1 reply\", \"{n} replies\"), never glued together. Every literal\n * passed to `t` and `tf` is listed in words.ts for the server (scripts/check-words.mjs keeps the two equal).\n *\n * The state sits on `globalThis` because the script tag's files (sdk.js, sdk-flows.js, sdk-messenger.js) are separate\n * bundles: the words sdk.js read must reach the dialogs it loads later. Only the browser and the app write to it: on\n * a server this object is shared by all requests.\n */\ninterface Shared {\n    words?: Record<string, string>;\n    /** The language the server chose, like \"de\". */\n    lang?: string;\n    /** The app's own choice (`setLocale`, the `locale` option). */\n    locale?: string;\n    /** React Native: the phone's language. */\n    device?: string;\n    version: number;\n    onWords: Set<() => void>;\n    onLocale: Set<() => void>;\n}\n\nconst g = globalThis as unknown as { __mrrocketI18n?: Shared };\nconst s: Shared = (g.__mrrocketI18n ??= { version: 0, onWords: new Set(), onLocale: new Set() });\n\nconst tell = (listeners: Set<() => void>) => {\n    for (const fn of [...listeners]) {\n        try {\n            fn();\n        } catch {\n            // One renderer must not stop another.\n        }\n    }\n};\n\n/** The translation, or the English word. */\nexport const t = (word: string): string => s.words?.[word] || word;\n\n/** The same, then fills `{n}`-style placeholders. */\nexport const tf = (word: string, vars: Record<string, string | number>): string => t(word).replace(/\\{(\\w+)\\}/g, (all, k: string) => (k in vars ? String(vars[k]) : all));\n\n/** Replaces the dictionary; `lang` is the language it is in. */\nexport const setWords = (words?: Record<string, string>, lang?: string) => {\n    const same = s.lang === lang && JSON.stringify(s.words ?? {}) === JSON.stringify(words ?? {});\n    s.words = words;\n    s.lang = lang;\n    if (same) return;\n    s.version++;\n    tell(s.onWords);\n};\n\n/** \"de_AT\" reads as \"de-AT\"; something that is no language tag counts as none (dates would throw on it). */\nconst tidy = (locale?: string) => {\n    const tag = locale?.trim().replace(/_/g, \"-\");\n    if (!tag) return undefined;\n    try {\n        return Intl.getCanonicalLocales(tag)[0];\n    } catch (e) {\n        return e instanceof RangeError ? undefined : tag;\n    }\n};\n\n/** An app with its own language switch says the language here; undefined goes back to the device's. Re-reads the config. */\nexport const setLocale = (locale?: string) => {\n    const next = tidy(locale);\n    if (next === s.locale) return;\n    s.locale = next;\n    s.version++;\n    tell(s.onWords);\n    tell(s.onLocale);\n};\n\n/** React Native: the phone's language, used unless the app chose one. */\nexport const setDeviceLocale = (locale?: string) => {\n    s.device = tidy(locale);\n};\n\n/** The app's choice, else the phone's (React Native), else the browser's. */\nexport const currentLocale = (): string | undefined => s.locale ?? s.device ?? ((typeof navigator !== \"undefined\" && navigator.language) || undefined);\n\n/** `&lang=de-AT` for a URL that already has a query, or nothing while no language is known. */\nexport const langParam = () => {\n    const l = currentLocale();\n    return l ? `&lang=${encodeURIComponent(l)}` : \"\";\n};\n\n/** The language the words on screen are in, for `lang` on the SDK's own root elements. */\nexport const wordsLang = () => s.lang;\n\n/** Grows whenever the words or the language change. */\nexport const wordsVersion = () => s.version;\n\n/** Runs when the words or the language changed: what is on screen draws again. Returns how to stop. */\nexport const onWords = (fn: () => void) => {\n    s.onWords.add(fn);\n    return () => {\n        s.onWords.delete(fn);\n    };\n};\n\n/** Runs when the app chose another language: the config is read again. Returns how to stop. */\nexport const onLocale = (fn: () => void) => {\n    s.onLocale.add(fn);\n    return () => {\n        s.onLocale.delete(fn);\n    };\n};\n"],"mappings":";AAsBA,IAAM,IAAI;AACV,IAAM,IAAa,EAAE,mBAAmB,EAAE,SAAS,GAAG,SAAS,oBAAI,IAAI,GAAG,UAAU,oBAAI,IAAI,EAAE;AAE9F,IAAM,OAAO,CAAC,cAA+B;AACzC,aAAW,MAAM,CAAC,GAAG,SAAS,GAAG;AAC7B,QAAI;AACA,SAAG;AAAA,IACP,QAAQ;AAAA,IAER;AAAA,EACJ;AACJ;AAGO,IAAM,IAAI,CAAC,SAAyB,EAAE,QAAQ,IAAI,KAAK;AAGvD,IAAM,KAAK,CAAC,MAAc,SAAkD,EAAE,IAAI,EAAE,QAAQ,cAAc,CAAC,KAAK,MAAe,KAAK,OAAO,OAAO,KAAK,CAAC,CAAC,IAAI,GAAI;AAGjK,IAAM,WAAW,CAAC,OAAgC,SAAkB;AACvE,QAAM,OAAO,EAAE,SAAS,QAAQ,KAAK,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,KAAK,UAAU,SAAS,CAAC,CAAC;AAC5F,IAAE,QAAQ;AACV,IAAE,OAAO;AACT,MAAI,KAAM;AACV,IAAE;AACF,OAAK,EAAE,OAAO;AAClB;AAGA,IAAM,OAAO,CAAC,WAAoB;AAC9B,QAAM,MAAM,QAAQ,KAAK,EAAE,QAAQ,MAAM,GAAG;AAC5C,MAAI,CAAC,IAAK,QAAO;AACjB,MAAI;AACA,WAAO,KAAK,oBAAoB,GAAG,EAAE,CAAC;AAAA,EAC1C,SAAS,GAAG;AACR,WAAO,aAAa,aAAa,SAAY;AAAA,EACjD;AACJ;AAGO,IAAM,YAAY,CAAC,WAAoB;AAC1C,QAAM,OAAO,KAAK,MAAM;AACxB,MAAI,SAAS,EAAE,OAAQ;AACvB,IAAE,SAAS;AACX,IAAE;AACF,OAAK,EAAE,OAAO;AACd,OAAK,EAAE,QAAQ;AACnB;AAGO,IAAM,kBAAkB,CAAC,WAAoB;AAChD,IAAE,SAAS,KAAK,MAAM;AAC1B;AAGO,IAAM,gBAAgB,MAA0B,EAAE,UAAU,EAAE,WAAY,OAAO,cAAc,eAAe,UAAU,YAAa;AAGrI,IAAM,YAAY,MAAM;AAC3B,QAAM,IAAI,cAAc;AACxB,SAAO,IAAI,SAAS,mBAAmB,CAAC,CAAC,KAAK;AAClD;AAGO,IAAM,YAAY,MAAM,EAAE;AAG1B,IAAM,eAAe,MAAM,EAAE;AAG7B,IAAM,UAAU,CAAC,OAAmB;AACvC,IAAE,QAAQ,IAAI,EAAE;AAChB,SAAO,MAAM;AACT,MAAE,QAAQ,OAAO,EAAE;AAAA,EACvB;AACJ;AAGO,IAAM,WAAW,CAAC,OAAmB;AACxC,IAAE,SAAS,IAAI,EAAE;AACjB,SAAO,MAAM;AACT,MAAE,SAAS,OAAO,EAAE;AAAA,EACxB;AACJ;","names":[]}

package/dist/index.d.ts

@@ -1,10 +1,13 @@
-export { type ChangelogEntry, type ChatMessage, type ChatThread, type CockpitProviderProps, type CockpitUser, type FeedbackBoardInfo, type FeedbackBoardProps, type FeedbackComment, type FeedbackList, type FeedbackPost, type FeedbackRoadmap, type FeedbackWidgetProps, type MessengerProps, type PostStatus, type SurveyAnswer, type SurveyDefinition, type SurveyQuestion, type SurveyQuestionKind, CockpitProvider, Experiment, FeedbackBoard, FeedbackWidget, Messenger, Survey, Text, WIDGET_CSS, createApi, useCancelFlow, useCockpit, useFeedback, useFlag, useFlagVariant, useMessenger, useOnboarding, usePaywall, usePush, useStyles, useVariant, } from "./browser.js";
+export { type ChangelogEntry, type ChatMessage, type ChatSummary, type ChatThread, type CockpitProviderProps, type CockpitUser, type FeedbackBoardInfo, type FeedbackBoardProps, type FeedbackComment, type FeedbackList, type FeedbackPost, type FeedbackRoadmap, type FeedbackWidgetProps, type MessengerProps, type PostStatus, type SurveyAnswer, type SurveyDefinition, type SurveyQuestion, type SurveyQuestionKind, CockpitProvider, Experiment, FeedbackBoard, FeedbackWidget, Messenger, Survey, Text, WIDGET_CSS, createApi, useCancelFlow, useCockpit, useFeedback, useFlag, useFlagVariant, useMessenger, useOnboarding, useOnboardingReport, usePaywall, usePush, useStyles, useVariant, } from "./browser.js";
 export type { PushResult, PushStatus, WebPushOptions } from "./push-web.js";
+/** 0.21.0: the language of the SDK's words, for an app with its own language switch. */
+export { currentLocale, setLocale } from "./i18n.js";
 /** `identify(id, props, { hash })` (0.16.0); the hash comes from `userHash()` in `@mrrocket/sdk/next/server`. */
 export type { IdentifyOptions } from "./identity.js";
 export { type CockpitConfig, type CockpitEvent, type ConsentChoice, type ConsentMode, type ReplayConfig, type ErrorReport, type ExperimentConfig, type FlagCondition, type FlagConditionSet, type FlagConfig, type FlagPerson, type RedirectConfig, type RedirectDecision, type VariantConfig, type VariantId, EMBED_PARAM, EXPOSURE_PARAM, SDK_VERSION, ID_COOKIE, PREVIEW_PARAM, SESSION_COOKIE, assign, evaluateFlag, parsePreview, previewHref, redirectFor, } from "./core.js";
 export { type CancelFlowConfig, type CancelFlowOptions, type CancelFlowResult, type CancelOffer, type InAppMessage, type OnboardingFlow, type OnboardingStep, type FlowMedia, type TourPlacement, type TaskOpens, type FlowIcon, type FinishAnimation, type OnboardingQuestion, type OnboardingItemState, videoEmbed, } from "./flows.js";
 export type { UseOnboarding } from "./onboarding-state.js";
+export type { OnboardingReport, OnboardingReportOptions, OnboardingReportType } from "./onboarding-report.js";
 export { FLOW_ICONS, FLOW_ICON_NAMES, type BuiltinIcon } from "./icons.js";
 export type { FlowsTheme } from "./flows-ui.js";
 export { PAYWALL_EVENT, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult } from "./paywall.js";

package/dist/index.js

@@ -16,11 +16,13 @@ import {
   useFlagVariant,
   useMessenger,
   useOnboarding,
+  useOnboardingReport,
   usePaywall,
   usePush,
   useStyles,
   useVariant
 } from "./browser.js";
+import { currentLocale, setLocale } from "./i18n.js";
 import {
   EMBED_PARAM,
   EXPOSURE_PARAM,
@@ -67,6 +69,7 @@ export {
   WIDGET_CSS,
   assign,
   createApi,
+  currentLocale,
   evaluateFlag,
   getReferral,
   parsePreview,
@@ -75,6 +78,7 @@ export {
   redirectFor,
   referralForCheckout,
   referralLink,
+  setLocale,
   useCancelFlow,
   useCockpit,
   useFeedback,
@@ -82,6 +86,7 @@ export {
   useFlagVariant,
   useMessenger,
   useOnboarding,
+  useOnboardingReport,
   usePaywall,
   usePush,
   useStyles,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {\n    type ChangelogEntry,\n    type ChatMessage,\n    type ChatThread,\n    type CockpitProviderProps,\n    type CockpitUser,\n    type FeedbackBoardInfo,\n    type FeedbackBoardProps,\n    type FeedbackComment,\n    type FeedbackList,\n    type FeedbackPost,\n    type FeedbackRoadmap,\n    type FeedbackWidgetProps,\n    type MessengerProps,\n    type PostStatus,\n    type SurveyAnswer,\n    type SurveyDefinition,\n    type SurveyQuestion,\n    type SurveyQuestionKind,\n    CockpitProvider,\n    Experiment,\n    FeedbackBoard,\n    FeedbackWidget,\n    Messenger,\n    Survey,\n    Text,\n    WIDGET_CSS,\n    createApi,\n    useCancelFlow,\n    useCockpit,\n    useFeedback,\n    useFlag,\n    useFlagVariant,\n    useMessenger,\n    useOnboarding,\n    usePaywall,\n    usePush,\n    useStyles,\n    useVariant,\n} from \"./browser\";\nexport type { PushResult, PushStatus, WebPushOptions } from \"./push-web\";\n/** `identify(id, props, { hash })` (0.16.0); the hash comes from `userHash()` in `@mrrocket/sdk/next/server`. */\nexport type { IdentifyOptions } from \"./identity\";\nexport {\n    type CockpitConfig,\n    type CockpitEvent,\n    type ConsentChoice,\n    type ConsentMode,\n    type ReplayConfig,\n    type ErrorReport,\n    type ExperimentConfig,\n    type FlagCondition,\n    type FlagConditionSet,\n    type FlagConfig,\n    type FlagPerson,\n    type RedirectConfig,\n    type RedirectDecision,\n    type VariantConfig,\n    type VariantId,\n    EMBED_PARAM,\n    EXPOSURE_PARAM,\n    SDK_VERSION,\n    ID_COOKIE,\n    PREVIEW_PARAM,\n    SESSION_COOKIE,\n    assign,\n    evaluateFlag,\n    parsePreview,\n    previewHref,\n    redirectFor,\n} from \"./core\";\nexport {\n    type CancelFlowConfig,\n    type CancelFlowOptions,\n    type CancelFlowResult,\n    type CancelOffer,\n    type InAppMessage,\n    type OnboardingFlow,\n    type OnboardingStep,\n    type FlowMedia,\n    type TourPlacement,\n    type TaskOpens,\n    type FlowIcon,\n    type FinishAnimation,\n    type OnboardingQuestion,\n    type OnboardingItemState,\n    videoEmbed,\n} from \"./flows\";\nexport type { UseOnboarding } from \"./onboarding-state\";\nexport { FLOW_ICONS, FLOW_ICON_NAMES, type BuiltinIcon } from \"./icons\";\nexport type { FlowsTheme } from \"./flows-ui\";\nexport { PAYWALL_EVENT, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult } from \"./paywall\";\nexport {\n    type AttributionMode,\n    type CheckoutReferral,\n    type Referral,\n    REFERRAL_COOKIE,\n    getReferral,\n    readReferralCookie,\n    referralForCheckout,\n    referralLink,\n} from \"./referral\";\n"],"mappings":";AAAA;AAAA,EAmBI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAIP;AAAA,EAgBI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP;AAAA,EAeI;AAAA,OACG;AAEP,SAAS,YAAY,uBAAyC;AAE9D,SAAS,qBAAsH;AAC/H;AAAA,EAII;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {\n    type ChangelogEntry,\n    type ChatMessage,\n    type ChatSummary,\n    type ChatThread,\n    type CockpitProviderProps,\n    type CockpitUser,\n    type FeedbackBoardInfo,\n    type FeedbackBoardProps,\n    type FeedbackComment,\n    type FeedbackList,\n    type FeedbackPost,\n    type FeedbackRoadmap,\n    type FeedbackWidgetProps,\n    type MessengerProps,\n    type PostStatus,\n    type SurveyAnswer,\n    type SurveyDefinition,\n    type SurveyQuestion,\n    type SurveyQuestionKind,\n    CockpitProvider,\n    Experiment,\n    FeedbackBoard,\n    FeedbackWidget,\n    Messenger,\n    Survey,\n    Text,\n    WIDGET_CSS,\n    createApi,\n    useCancelFlow,\n    useCockpit,\n    useFeedback,\n    useFlag,\n    useFlagVariant,\n    useMessenger,\n    useOnboarding,\n    useOnboardingReport,\n    usePaywall,\n    usePush,\n    useStyles,\n    useVariant,\n} from \"./browser\";\nexport type { PushResult, PushStatus, WebPushOptions } from \"./push-web\";\n/** 0.21.0: the language of the SDK's words, for an app with its own language switch. */\nexport { currentLocale, setLocale } from \"./i18n\";\n/** `identify(id, props, { hash })` (0.16.0); the hash comes from `userHash()` in `@mrrocket/sdk/next/server`. */\nexport type { IdentifyOptions } from \"./identity\";\nexport {\n    type CockpitConfig,\n    type CockpitEvent,\n    type ConsentChoice,\n    type ConsentMode,\n    type ReplayConfig,\n    type ErrorReport,\n    type ExperimentConfig,\n    type FlagCondition,\n    type FlagConditionSet,\n    type FlagConfig,\n    type FlagPerson,\n    type RedirectConfig,\n    type RedirectDecision,\n    type VariantConfig,\n    type VariantId,\n    EMBED_PARAM,\n    EXPOSURE_PARAM,\n    SDK_VERSION,\n    ID_COOKIE,\n    PREVIEW_PARAM,\n    SESSION_COOKIE,\n    assign,\n    evaluateFlag,\n    parsePreview,\n    previewHref,\n    redirectFor,\n} from \"./core\";\nexport {\n    type CancelFlowConfig,\n    type CancelFlowOptions,\n    type CancelFlowResult,\n    type CancelOffer,\n    type InAppMessage,\n    type OnboardingFlow,\n    type OnboardingStep,\n    type FlowMedia,\n    type TourPlacement,\n    type TaskOpens,\n    type FlowIcon,\n    type FinishAnimation,\n    type OnboardingQuestion,\n    type OnboardingItemState,\n    videoEmbed,\n} from \"./flows\";\nexport type { UseOnboarding } from \"./onboarding-state\";\nexport type { OnboardingReport, OnboardingReportOptions, OnboardingReportType } from \"./onboarding-report\";\nexport { FLOW_ICONS, FLOW_ICON_NAMES, type BuiltinIcon } from \"./icons\";\nexport type { FlowsTheme } from \"./flows-ui\";\nexport { PAYWALL_EVENT, type PaywallConfig, type PaywallOptions, type PaywallPage, type PaywallPlan, type PaywallResult } from \"./paywall\";\nexport {\n    type AttributionMode,\n    type CheckoutReferral,\n    type Referral,\n    REFERRAL_COOKIE,\n    getReferral,\n    readReferralCookie,\n    referralForCheckout,\n    referralLink,\n} from \"./referral\";\n"],"mappings":";AAAA;AAAA,EAoBI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAGP,SAAS,eAAe,iBAAiB;AAGzC;AAAA,EAgBI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP;AAAA,EAeI;AAAA,OACG;AAGP,SAAS,YAAY,uBAAyC;AAE9D,SAAS,qBAAsH;AAC/H;AAAA,EAII;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;","names":[]}

package/dist/messenger-ui.d.ts

@@ -7,6 +7,9 @@
  * count on the launcher and a preview card above it. Opening, closing, switching and new messages move softly
  * (none of it with reduced motion).
  *
+ * A visitor can have several conversations (0.19): Home's "Ask a question" starts a new one, the field inside a chat
+ * answers in that chat, and Home and Messages list the others.
+ *
  * Plain DOM, no React, so `<Messenger />` (Next.js) and the script tag share it; both load it only when it is used (a
  * dynamic import, and `sdk-messenger.js` for the script tag). Every text is set with textContent; articles arrive as
  * blocks, never HTML.
@@ -41,6 +44,8 @@ export interface MessengerUiOptions {
     replyTime?: "minutes" | "hours" | "day";
     /** The Help tab with the product's published help articles (default true; hidden while there are none). */
     help?: boolean;
+    /** The Updates tab with your published changelog (default true; hidden while there are none). */
+    updates?: boolean;
     /** A short sound when an answer arrives (default true). */
     sound?: boolean;
     /** A preview of a new answer above the closed launcher (default true). */
@@ -73,8 +78,8 @@ export interface MessengerUiOptions {
     opened?: MessengerView;
 }
 /** What the messenger asks the server (createApi's part it uses). */
-export type MessengerClient = Pick<Api, "chat" | "sendChat" | "uploadChatFile" | "attachmentUrl" | "articles" | "article" | "rateArticle" | "messengerLook">;
-export type MessengerView = "home" | "messages" | "help";
+export type MessengerClient = Pick<Api, "chat" | "sendChat" | "uploadChatFile" | "attachmentUrl" | "articles" | "article" | "rateArticle" | "messengerLook" | "changelog">;
+export type MessengerView = "home" | "messages" | "help" | "updates";
 export interface MessengerHandle {
     /** Opens the panel, on Home or the given tab; `{ article }` opens a help article. */
     open(view?: MessengerView | {
@@ -89,6 +94,7 @@ export interface MessengerHandle {
  * Mounts the messenger with its look from MRRocket (Support › Messenger) underneath what the code passes: an option the
  * code sets wins, one it leaves out comes from MRRocket, then the default. Calls made before the look arrived wait.
  * A repeat visit starts with the look this browser saw last; a look that arrives later than that (changed, or slower
- * than LOOK_WAIT_MS) replaces the launcher while the panel is closed, or once it closes.
+ * than LOOK_WAIT_MS) replaces the launcher while the panel is closed, or once it closes. New words or another language
+ * do the same: the messenger is built anew, with the look read again in another language.
  */
 export declare const mountMessenger: (o: MessengerUiOptions) => MessengerHandle;