@mrrocket/sdk 0.14.0 → 0.16.0

package/dist/identity.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Identity verification (0.16.0), the browser and app side. After `identify(id)` the SDK's id is your app's own user
+ * id, and that id is no secret (a Clerk id shows in URLs and logs), so on its own it proves nothing: anyone who knows it
+ * could read that person's support chat or post as them. Your server signs the id with the product's server key
+ * (`userHash(user.id)` from `@mrrocket/sdk/next/server`) and you hand the result to `identify(id, props, { hash })`.
+ * From then on every request for that id carries it as `userHash` (a JSON field, a query parameter or a form field), and
+ * MRRocket checks it.
+ *
+ * The hash belongs to one id: it is forgotten on `reset()` (sign-out) and when `identify` is called for another id
+ * without a hash, so it never goes out with someone else's id (MRRocket refuses a hash that does not match with 401).
+ * Shared by the Next.js provider, the script tag and React Native: no React, no browser APIs.
+ */
+/** The third argument of `identify`. */
+export interface IdentifyOptions {
+    /**
+     * The id signed by your server: `await userHash(user.id)` from `@mrrocket/sdk/next/server` (or the same HMAC in any
+     * language). Needed when MRRocket › Settings › Products › Sign-in › "Only signed users" is on.
+     */
+    hash?: string;
+}
+/** The id the SDK holds a hash for, and the hash. */
+export interface Signed {
+    id: string;
+    hash: string;
+}
+/** What to do when MRRocket refuses a request for want of a hash (once per page, in the console). Short: sdk.js has a size budget. */
+export declare const UNSIGNED_HELP = "401: sign the user id on your server with userHash(id) from @mrrocket/sdk/next/server and pass identify(id, props, { hash }).";
+/** Says once per page (or app run) why MRRocket answered 401; other statuses say nothing. */
+export declare const warnUnsigned: (status: number, log?: (message: string) => void) => void;
+/**
+ * The signed id after `identify(id, …, { hash })`: a new hash replaces the old one, the same id without a hash keeps
+ * the one it has, another id without a hash drops it. A hash that is not 64 hex characters (a typo, the server key
+ * itself) is ignored with a warning instead of being sent.
+ */
+export declare const nextSigned: (signed: Signed | null, id: string, hash: unknown, log?: (message: string) => void) => Signed | null;
+/** The hash for `id`, when the SDK holds one for exactly that id. */
+export declare const hashFor: (signed: Signed | null | undefined, id: string | undefined) => string | undefined;
+/**
+ * The hash for a request that carries several items with their own ids (error reports): only when every item that
+ * names someone names the signed id, so a report of an earlier visitor never goes out under this person's hash.
+ */
+export declare const hashForAll: (signed: Signed | null | undefined, ids: (string | undefined)[]) => string | undefined;

package/dist/identity.js

@@ -0,0 +1,24 @@
+// src/identity.ts
+var UNSIGNED_HELP = "401: sign the user id on your server with userHash(id) from @mrrocket/sdk/next/server and pass identify(id, props, { hash }).";
+var warnUnsigned = (status, log = (m) => console.warn(m)) => {
+  const g = globalThis;
+  if (status !== 401 || g.__mrrocketUnsigned) return;
+  g.__mrrocketUnsigned = true;
+  log(`[MRRocket] ${UNSIGNED_HELP}`);
+};
+var nextSigned = (signed, id, hash, log = (m) => console.warn(m)) => {
+  const h = typeof hash === "string" ? hash.trim().toLowerCase() : "";
+  if (/^[0-9a-f]{64}$/.test(h)) return { id, hash: h };
+  if (h) log("[MRRocket] identify: that hash is no userHash(id); not sent.");
+  return signed && signed.id === id ? signed : null;
+};
+var hashFor = (signed, id) => signed && id && signed.id === id ? signed.hash : void 0;
+var hashForAll = (signed, ids) => signed && ids.some((id) => id === signed.id) && ids.every((id) => !id || id === signed.id) ? signed.hash : void 0;
+export {
+  UNSIGNED_HELP,
+  hashFor,
+  hashForAll,
+  nextSigned,
+  warnUnsigned
+};
+//# sourceMappingURL=identity.js.map

package/dist/identity.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/identity.ts"],"sourcesContent":["/**\n * Identity verification (0.16.0), the browser and app side. After `identify(id)` the SDK's id is your app's own user\n * id, and that id is no secret (a Clerk id shows in URLs and logs), so on its own it proves nothing: anyone who knows it\n * could read that person's support chat or post as them. Your server signs the id with the product's server key\n * (`userHash(user.id)` from `@mrrocket/sdk/next/server`) and you hand the result to `identify(id, props, { hash })`.\n * From then on every request for that id carries it as `userHash` (a JSON field, a query parameter or a form field), and\n * MRRocket checks it.\n *\n * The hash belongs to one id: it is forgotten on `reset()` (sign-out) and when `identify` is called for another id\n * without a hash, so it never goes out with someone else's id (MRRocket refuses a hash that does not match with 401).\n * Shared by the Next.js provider, the script tag and React Native: no React, no browser APIs.\n */\n\n/** The third argument of `identify`. */\nexport interface IdentifyOptions {\n    /**\n     * The id signed by your server: `await userHash(user.id)` from `@mrrocket/sdk/next/server` (or the same HMAC in any\n     * language). Needed when MRRocket › Settings › Products › Sign-in › \"Only signed users\" is on.\n     */\n    hash?: string;\n}\n\n/** The id the SDK holds a hash for, and the hash. */\nexport interface Signed {\n    id: string;\n    hash: string;\n}\n\n/** What to do when MRRocket refuses a request for want of a hash (once per page, in the console). Short: sdk.js has a size budget. */\nexport const UNSIGNED_HELP = \"401: sign the user id on your server with userHash(id) from @mrrocket/sdk/next/server and pass identify(id, props, { hash }).\";\n\n/** Says once per page (or app run) why MRRocket answered 401; other statuses say nothing. */\nexport const warnUnsigned = (status: number, log: (message: string) => void = (m) => console.warn(m)) => {\n    const g = globalThis as { __mrrocketUnsigned?: boolean };\n    if (status !== 401 || g.__mrrocketUnsigned) return;\n    g.__mrrocketUnsigned = true;\n    log(`[MRRocket] ${UNSIGNED_HELP}`);\n};\n\n/**\n * The signed id after `identify(id, …, { hash })`: a new hash replaces the old one, the same id without a hash keeps\n * the one it has, another id without a hash drops it. A hash that is not 64 hex characters (a typo, the server key\n * itself) is ignored with a warning instead of being sent.\n */\nexport const nextSigned = (signed: Signed | null, id: string, hash: unknown, log: (message: string) => void = (m) => console.warn(m)): Signed | null => {\n    const h = typeof hash === \"string\" ? hash.trim().toLowerCase() : \"\";\n    if (/^[0-9a-f]{64}$/.test(h)) return { id, hash: h };\n    if (h) log(\"[MRRocket] identify: that hash is no userHash(id); not sent.\");\n    return signed && signed.id === id ? signed : null;\n};\n\n/** The hash for `id`, when the SDK holds one for exactly that id. */\nexport const hashFor = (signed: Signed | null | undefined, id: string | undefined) => (signed && id && signed.id === id ? signed.hash : undefined);\n\n/**\n * The hash for a request that carries several items with their own ids (error reports): only when every item that\n * names someone names the signed id, so a report of an earlier visitor never goes out under this person's hash.\n */\nexport const hashForAll = (signed: Signed | null | undefined, ids: (string | undefined)[]) =>\n    signed && ids.some((id) => id === signed.id) && ids.every((id) => !id || id === signed.id) ? signed.hash : undefined;\n"],"mappings":";AA6BO,IAAM,gBAAgB;AAGtB,IAAM,eAAe,CAAC,QAAgB,MAAiC,CAAC,MAAM,QAAQ,KAAK,CAAC,MAAM;AACrG,QAAM,IAAI;AACV,MAAI,WAAW,OAAO,EAAE,mBAAoB;AAC5C,IAAE,qBAAqB;AACvB,MAAI,cAAc,aAAa,EAAE;AACrC;AAOO,IAAM,aAAa,CAAC,QAAuB,IAAY,MAAe,MAAiC,CAAC,MAAM,QAAQ,KAAK,CAAC,MAAqB;AACpJ,QAAM,IAAI,OAAO,SAAS,WAAW,KAAK,KAAK,EAAE,YAAY,IAAI;AACjE,MAAI,iBAAiB,KAAK,CAAC,EAAG,QAAO,EAAE,IAAI,MAAM,EAAE;AACnD,MAAI,EAAG,KAAI,8DAA8D;AACzE,SAAO,UAAU,OAAO,OAAO,KAAK,SAAS;AACjD;AAGO,IAAM,UAAU,CAAC,QAAmC,OAA4B,UAAU,MAAM,OAAO,OAAO,KAAK,OAAO,OAAO;AAMjI,IAAM,aAAa,CAAC,QAAmC,QAC1D,UAAU,IAAI,KAAK,CAAC,OAAO,OAAO,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,OAAO,OAAO,EAAE,IAAI,OAAO,OAAO;","names":[]}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 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, usePaywall, usePush, useStyles, useVariant, } from "./browser.js";
 export type { PushResult, PushStatus, WebPushOptions } from "./push-web.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, } from "./flows.js";
 export type { FlowsTheme } from "./flows-ui.js";

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    usePaywall,\n    usePush,\n    useStyles,\n    useVariant,\n} from \"./browser\";\nexport type { PushResult, PushStatus, WebPushOptions } from \"./push-web\";\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} from \"./flows\";\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,OACG;AAEP;AAAA,EAgBI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAWP,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 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    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} from \"./flows\";\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,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;AAWP,SAAS,qBAAsH;AAC/H;AAAA,EAII;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;","names":[]}

package/dist/messenger-ui.d.ts

@@ -1,6 +1,6 @@
 /**
- * The web messenger, after Crisp's: a round launcher (hovered, a small card offers "Chat with us" and "Search") and a
- * panel with a bar on top (Home, a "Chat · Help" switch, a ⋮ menu to minimize or widen it). Home shows the greeting,
+ * The web messenger, after Crisp's: a round launcher (hovered, a small card offers "Chat" and "Search") and a panel
+ * with a bar on top (Home, a "Chat · Help" switch while there are both, a ⋮ menu to minimize or widen it). Home shows the greeting,
  * the latest chat and the help search; Chat is the chat with the team, answered in MRRocket › Support by the owner or
  * the Customer experience agent; Help lists the product's published help articles by collection, searchable, read in
  * the panel. While the panel is closed it checks for answers now and then; a new answer plays a short sound, shows a
@@ -11,7 +11,7 @@
  * dynamic import, and `sdk-messenger.js` for the script tag). Every text is set with textContent; articles arrive as
  * blocks, never HTML.
  */
-import { type Api } from "./api-client.js";
+import { type Api, type MessengerCorners, type MessengerPosition } from "./api-client.js";
 export interface MessengerUiOptions {
     host: string;
     apiKey: string;
@@ -23,10 +23,13 @@ export interface MessengerUiOptions {
         name?: string;
         email?: string;
     } | undefined;
+    /** The identity hash of the visitor id now (0.16.0), when the site gave one to identify. */
+    userHash?: () => string | undefined;
     /** Show the round launcher (default true). Without it the panel opens only through `open()`. */
     launcher?: boolean;
-    position?: "bottom-right" | "bottom-left";
-    /** The panel's title. */
+    /** Where the launcher sits (default bottom right); the panel and the cards open from there. */
+    position?: MessengerPosition;
+    /** The team's name beside its mark on Home. */
     title?: string;
     /** The big line on Home and the first line of an empty chat. */
     greeting?: string;
@@ -44,6 +47,18 @@ export interface MessengerUiOptions {
     preview?: boolean;
     theme?: "light" | "dark" | "auto";
     accent?: string;
+    /** Up to two more colors blended with the accent in Home's background glow. */
+    glow?: string[];
+    /** How round panel, bubbles, cards and fields are (default round). */
+    corners?: MessengerCorners;
+    /** The site's own font (default) or the system's. */
+    font?: "site" | "system";
+    /** Home's top: plain (default) or in the accent color. */
+    header?: "plain" | "color";
+    /** "Powered by MRRocket" at the bottom; MRRocket's server says whether the plan may hide it. */
+    branding?: boolean;
+    /** The product's icon at the top left of Home (MRRocket sends the product's favicon); without it the title's first letter. */
+    logo?: string;
     /** MRRocket's own preview: mount inside this element (positioned) instead of the page. */
     container?: HTMLElement;
     /** MRRocket's own preview: answers from here instead of the server. */
@@ -52,7 +67,7 @@ export interface MessengerUiOptions {
     opened?: MessengerView;
 }
 /** What the messenger asks the server (createApi's part it uses). */
-export type MessengerClient = Pick<Api, "chat" | "sendChat" | "articles" | "article" | "rateArticle" | "messengerLook">;
+export type MessengerClient = Pick<Api, "chat" | "sendChat" | "uploadChatFile" | "attachmentUrl" | "articles" | "article" | "rateArticle" | "messengerLook">;
 export type MessengerView = "home" | "messages" | "help";
 export interface MessengerHandle {
     /** Opens the panel, on Home or the given tab; `{ article }` opens a help article. */