@mrrocket/sdk 0.15.0 → 0.16.0

package/dist/react-native/index.js

@@ -43,6 +43,7 @@ __export(native_exports, {
   useOnboarding: () => useOnboarding,
   usePaywall: () => usePaywall,
   usePush: () => usePush,
+  useReview: () => useReview,
   useText: () => useText,
   useVariant: () => useVariant
 });
@@ -50,7 +51,7 @@ module.exports = __toCommonJS(native_exports);
 var import_react3 = require("react");
 
 // src/core.ts
-var SDK_VERSION = "0.15.0";
+var SDK_VERSION = "0.16.0";
 var propOf = (person, name) => {
   const want = name.trim().toLowerCase();
   for (const [k, v] of Object.entries(person)) if (k.toLowerCase() === want) return v;
@@ -172,6 +173,23 @@ var textChanges = (config, distinctId, preview) => {
 };
 var newDistinctId = () => typeof crypto !== "undefined" && "randomUUID" in crypto ? crypto.randomUUID() : `ck_${Math.random().toString(36).slice(2)}${Date.now().toString(36)}`;
 
+// 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 h3 = typeof hash === "string" ? hash.trim().toLowerCase() : "";
+  if (/^[0-9a-f]{64}$/.test(h3)) return { id, hash: h3 };
+  if (h3) 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;
+
 // src/api-client.ts
 var CHAT_FILE_MAX_BYTES = 10 * 1024 * 1024;
 var CHAT_FILES_PER_MESSAGE = 4;
@@ -212,6 +230,7 @@ var call = async (url, init, signal) => {
     throw new ApiError("Could not reach the server. Check your connection and try again.", 0);
   }
   if (!res.ok) {
+    warnUnsigned(res.status);
     let detail = "";
     try {
       detail = (await res.json()).error ?? "";
@@ -223,21 +242,22 @@ var call = async (url, init, signal) => {
 };
 var createApi = (c) => {
   const base = `${c.host}/api/sdk`;
-  const who = { key: c.apiKey, distinctId: c.distinctId, user: c.user };
+  const who = { key: c.apiKey, distinctId: c.distinctId, user: c.user, userHash: c.userHash };
+  const me = { key: c.apiKey, distinctId: c.distinctId, userHash: c.userHash };
   const post = (path, body, signal) => call(`${base}${path}`, { method: "POST", body: JSON.stringify({ ...who, ...body }) }, signal);
   return {
-    list: (o, signal) => call(`${base}/feedback?${qs({ key: c.apiKey, distinctId: c.distinctId, board: o.board, sort: o.sort, q: o.q })}`, void 0, signal),
-    post: (id, signal) => call(`${base}/feedback/${encodeURIComponent(id)}?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, void 0, signal),
-    roadmap: (signal) => call(`${base}/feedback/roadmap?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, void 0, signal),
+    list: (o, signal) => call(`${base}/feedback?${qs({ ...me, board: o.board, sort: o.sort, q: o.q })}`, void 0, signal),
+    post: (id, signal) => call(`${base}/feedback/${encodeURIComponent(id)}?${qs(me)}`, void 0, signal),
+    roadmap: (signal) => call(`${base}/feedback/roadmap?${qs(me)}`, void 0, signal),
     changelog: (signal) => call(`${base}/feedback/changelog?${qs({ key: c.apiKey })}`, void 0, signal),
     submit: (p) => post("/feedback", p),
     vote: (id) => post(`/feedback/${encodeURIComponent(id)}/vote`, {}),
     comments: (id, signal) => call(`${base}/feedback/${encodeURIComponent(id)}/comments?${qs({ key: c.apiKey })}`, void 0, signal),
     comment: (id, body) => post(`/feedback/${encodeURIComponent(id)}/comments`, { body }),
-    survey: (url, signal) => call(`${base}/surveys?${qs({ key: c.apiKey, distinctId: c.distinctId, url })}`, void 0, signal),
+    survey: (url, signal) => call(`${base}/surveys?${qs({ ...me, url })}`, void 0, signal),
     seen: (id) => post(`/surveys/${encodeURIComponent(id)}/seen`, { user: void 0 }),
     respond: (id, r) => post(`/surveys/${encodeURIComponent(id)}/respond`, r),
-    chat: (signal) => call(`${base}/messages?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, void 0, signal),
+    chat: (signal) => call(`${base}/messages?${qs(me)}`, void 0, signal),
     /** A message; `attachments` are upload ids from `uploadChatFile` (then the body may be empty). */
     sendChat: (m) => post("/messages", m),
     /** Uploads one picked file for the next message (pictures and PDFs, at most 10 MB); answers its upload id. */
@@ -245,14 +265,15 @@ var createApi = (c) => {
       const form = new FormData();
       form.append("key", c.apiKey);
       form.append("distinctId", c.distinctId);
+      if (c.userHash) form.append("userHash", c.userHash);
       if ("uri" in file) form.append("file", file);
       else form.append("file", file, file.name || "file");
       return call(`${base}/messages/attachments`, { method: "POST", body: form }, signal);
     },
     /** Where a sent file of this visitor's chat is read (an image's src, a PDF's link). */
-    attachmentUrl: (id) => `${base}/messages/attachments/${encodeURIComponent(id)}?${qs({ key: c.apiKey, distinctId: c.distinctId })}`,
+    attachmentUrl: (id) => `${base}/messages/attachments/${encodeURIComponent(id)}?${qs(me)}`,
     articles: (q, signal) => call(`${base}/articles?${qs({ key: c.apiKey, q })}`, void 0, signal),
-    article: (id, signal) => call(`${base}/articles/${encodeURIComponent(id)}?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, void 0, signal),
+    article: (id, signal) => call(`${base}/articles/${encodeURIComponent(id)}?${qs(me)}`, void 0, signal),
     messengerLook: (signal) => call(`${base}/messenger?${qs({ key: c.apiKey })}`, void 0, signal),
     rateArticle: (id, helpful) => post(`/articles/${encodeURIComponent(id)}/rate`, { helpful })
   };
@@ -274,8 +295,8 @@ var byteLength = (s) => {
   }
   return n;
 };
-var batchRequests = (key, events, sdk) => {
-  const head = `{"key":${JSON.stringify(key)},"sdk":${JSON.stringify(sdk)},"events":[`;
+var batchRequests = (key, events, sdk, userHash) => {
+  const head = `{"key":${JSON.stringify(key)},${userHash ? `"userHash":${JSON.stringify(userHash)},` : ""}"sdk":${JSON.stringify(sdk)},"events":[`;
   const empty = byteLength(head) + 2;
   const out = [];
   let chunk = [];
@@ -317,6 +338,7 @@ var describeError = (error) => {
 var CANCEL_EVENT = "$cancel_flow";
 var ONBOARDING_EVENT = "$onboarding";
 var INAPP_EVENT = "$inapp";
+var REVIEW_EVENT = "$review_prompt";
 var PLAIN_CANCEL = {
   version: 0,
   question: "",
@@ -1047,7 +1069,7 @@ var createRecorder = (deps, st) => {
     const batch = frames.splice(0, frames.length);
     const ms = marks.splice(0, marks.length);
     const size = deps.screen();
-    const { distinctId, identified } = st.who();
+    const { distinctId, identified, userHash } = st.who();
     const body = JSON.stringify({
       key: st.apiKey,
       consent: { replay: true },
@@ -1059,11 +1081,12 @@ var createRecorder = (deps, st) => {
       meta: { first: batch[0].t, last: batch[batch.length - 1].t, vw: size ? Math.round(size.w) : null, vh: size ? Math.round(size.h) : null, marks: ms },
       distinctId,
       identified,
+      ...userHash ? { userHash } : {},
       trigger: r.trigger,
       app: st.app
     });
     const status = await deps.send(body);
-    if (status === 403 || status === 409 || status === 413) r.stopped = true;
+    if (status === 401 || status === 403 || status === 409 || status === 413) r.stopped = true;
   };
   const tick = async () => {
     if (busy || !st.allowed() || !st.config()) return;
@@ -1223,6 +1246,7 @@ var createClient = (options, deps) => {
   let installId = null;
   let memoryId = newDistinctId();
   let identified;
+  let signed = null;
   let person;
   let config = null;
   let queue = [];
@@ -1257,6 +1281,13 @@ var createClient = (options, deps) => {
   const errorQueue = [];
   const errorsSeen = /* @__PURE__ */ new Set();
   let errorsSent = 0;
+  const fetchInApp = async (id) => {
+    if (!apiKey) return null;
+    const hash = hashOf(id);
+    const r = await deps.fetch(`${host}/api/sdk/inapp?key=${encodeURIComponent(apiKey)}&distinctId=${encodeURIComponent(id)}${hash ? `&userHash=${hash}` : ""}`, { method: "GET" });
+    warnUnsigned(r.status, deps.log);
+    return r.ok ? await r.json() : null;
+  };
   const paywall = createPaywallHost({ config: () => config, distinctId: () => distinctId(), track: (event, props) => record(event, props) });
   const flows = createFlows({
     track: (event, props) => record(event, props),
@@ -1267,11 +1298,7 @@ var createClient = (options, deps) => {
       set: (k, v) => void set(k, v)
     } : null,
     openUrl: deps.openUrl,
-    fetchInApp: async (id) => {
-      if (!apiKey) return null;
-      const r = await deps.fetch(`${host}/api/sdk/inapp?key=${encodeURIComponent(apiKey)}&distinctId=${encodeURIComponent(id)}`, { method: "GET" });
-      return r.ok ? await r.json() : null;
-    }
+    fetchInApp: (id) => fetchInApp(id)
   });
   const refreshFlows = () => {
     if (!isReady || closed) return;
@@ -1334,6 +1361,7 @@ var createClient = (options, deps) => {
   };
   const distinctId = () => identified ?? (consent === "persistent" && installId ? installId : memoryId);
   const sendId = () => consent === "persistent" ? distinctId() : identified;
+  const hashOf = (id) => hashFor(signed, id);
   const touchSession = () => {
     const t = now();
     if (!session || t - session.last >= SESSION_TIMEOUT_MS) session = { id: newDistinctId(), last: t };
@@ -1371,6 +1399,7 @@ var createClient = (options, deps) => {
     const timer = ctl ? setTimeoutFn(() => ctl.abort(), REQUEST_TIMEOUT_MS) : null;
     try {
       const r = await deps.fetch(`${host}${path}`, { method: "POST", headers: { "content-type": "application/json" }, body, signal: ctl?.signal });
+      warnUnsigned(r.status, deps.log);
       return r.status;
     } catch {
       return 0;
@@ -1382,7 +1411,7 @@ var createClient = (options, deps) => {
     if (!queue.length || consent === "off" || !apiKey) return;
     if (now() < backoffUntil) return;
     const snapshot = queue.slice();
-    const requests = batchRequests(apiKey, snapshot, sdk);
+    const requests = batchRequests(apiKey, snapshot, sdk, hashOf(sendId()));
     const included = new Set(requests.flatMap((r) => r.events));
     const done = /* @__PURE__ */ new Set();
     for (const r of requests) {
@@ -1393,7 +1422,7 @@ var createClient = (options, deps) => {
         backoffUntil = 0;
       } else if (status >= 400 && status < 500 && status !== 408 && status !== 429) {
         r.events.forEach((e) => done.add(e));
-        warn(`Events were rejected with ${status}. Check the public key (MRRocket \u203A Settings \u203A Products) and the host.`);
+        if (status !== 401) warn(`Events were rejected with ${status}. Check the public key (MRRocket \u203A Settings \u203A Products) and the host.`);
       } else {
         failures++;
         backoffUntil = now() + Math.min(MAX_BACKOFF_MS, 1e3 * 2 ** failures);
@@ -1432,8 +1461,9 @@ var createClient = (options, deps) => {
     }
     while (errorQueue.length) {
       const batch = errorQueue.splice(0, 4);
-      const status = await post("/api/sdk/errors", JSON.stringify({ key: apiKey, sdk, errors: batch }));
-      if (status >= 400 && status < 500 && status !== 429) warn(`Error reports were rejected with ${status}. Check the public key and the host.`);
+      const userHash = hashForAll(signed, batch.map((r) => r.distinctId));
+      const status = await post("/api/sdk/errors", JSON.stringify({ key: apiKey, ...userHash ? { userHash } : {}, sdk, errors: batch }));
+      if (status >= 400 && status < 500 && status !== 429 && status !== 401) warn(`Error reports were rejected with ${status}. Check the public key and the host.`);
     }
   };
   const capture = (error, mechanism, fatal = false) => {
@@ -1491,7 +1521,7 @@ var createClient = (options, deps) => {
       allowed: () => replayOn && loaded && !closed && consent !== "off" && !!apiKey,
       config: () => config?.replay,
       session: () => session?.id ?? touchSession(),
-      who: () => ({ distinctId: sendId(), identified: !!identified }),
+      who: () => ({ distinctId: sendId(), identified: !!identified, userHash: hashOf(sendId()) }),
       apiKey,
       app: context
     }
@@ -1541,6 +1571,7 @@ var createClient = (options, deps) => {
   };
   let pushToken = null;
   let pushFor;
+  let pushHash;
   let pushOff = null;
   const opened = /* @__PURE__ */ new Set();
   const onPushOpen = (data) => {
@@ -1568,18 +1599,20 @@ var createClient = (options, deps) => {
     if (!apiKey || consent === "off") return { status: "error", reason: !apiKey ? "No public key." : "The consent is off." };
     if (!identified) return { status: "not-signed-in" };
     const who = identified;
+    const userHash = hashOf(who);
     try {
       const permission = await deps.push.permission(o.ask !== false);
       if (permission !== "granted") return { status: permission === "denied" ? "denied" : "not-asked" };
       const token = await deps.push.token(o.projectId);
       if (!token) return { status: "unavailable", reason: "This device has no push token (a simulator, or no EAS project id)." };
-      const status = await post("/api/sdk/push", JSON.stringify({ key: apiKey, distinctId: who, platform: "expo", token, app: context }));
+      const status = await post("/api/sdk/push", JSON.stringify({ key: apiKey, distinctId: who, userHash, platform: "expo", token, app: context }));
       if (status < 200 || status >= 300) {
         warn(`Push registration was rejected with ${status || "no answer"}. Check the public key and the host.`);
         return { status: "error", reason: `MRRocket answered ${status || "nothing"}.` };
       }
       pushToken = token;
       pushFor = who;
+      pushHash = userHash;
       listenForOpens();
       debug("Registered for push.");
       return { status: "registered", token };
@@ -1591,9 +1624,28 @@ var createClient = (options, deps) => {
     const token = pushToken;
     if (!token || !apiKey) return false;
     pushToken = null;
-    const status = await post("/api/sdk/push", JSON.stringify({ key: apiKey, distinctId: pushFor, platform: "expo", token, remove: true }));
+    const status = await post("/api/sdk/push", JSON.stringify({ key: apiKey, distinctId: pushFor, userHash: pushHash, platform: "expo", token, remove: true }));
     return status >= 200 && status < 300;
   };
+  let reviewing = false;
+  const requestReview = async () => {
+    if (!deps.storeReview) return "unavailable";
+    await loadedNow();
+    if (!apiKey || consent === "off") return "not-now";
+    if (!identified) return "not-signed-in";
+    if (reviewing) return "not-now";
+    reviewing = true;
+    try {
+      const ask = (await fetchInApp(identified).catch(() => null))?.review;
+      if (!ask) return "not-now";
+      const asked = await deps.storeReview.request().catch(() => false);
+      record(REVIEW_EVENT, { campaign: ask.campaign, store: ask.store, action: asked ? "requested" : "unavailable" });
+      void flush();
+      return asked ? "requested" : "unavailable";
+    } finally {
+      reviewing = false;
+    }
+  };
   let resolveReady = () => {
   };
   const ready = new Promise((r) => {
@@ -1723,13 +1775,14 @@ var createClient = (options, deps) => {
       record("$screen", { ...props, path, screen: name, ...previous ? { previous } : {} });
       recorder?.mark({ kind: "pageview", path });
     },
-    identify: (id, props) => {
+    identify: (id, props, options2) => {
       if (typeof id !== "string" || !id) return;
       if (!loaded) {
-        early.push(() => client.identify(id, props));
+        early.push(() => client.identify(id, props, options2));
         return;
       }
       const previous = sendId();
+      signed = nextSigned(signed, id, options2?.hash, deps.log);
       identified = id;
       person = { ...props, id };
       record("$identify", { ...props, id, ...previous && previous !== id ? { previousId: previous } : {} });
@@ -1743,7 +1796,9 @@ var createClient = (options, deps) => {
         return;
       }
       if (pushToken) void unregisterForPush();
+      void flush();
       identified = void 0;
+      signed = null;
       person = void 0;
       session = null;
       utm = null;
@@ -1822,6 +1877,7 @@ var createClient = (options, deps) => {
     paywall,
     registerForPush,
     unregisterForPush,
+    requestReview,
     flows,
     flush,
     ready,
@@ -1837,7 +1893,7 @@ var createClient = (options, deps) => {
       if (!apiKey || consent === "off") return null;
       const known = client.getUser();
       const user = as?.name || as?.email ? { ...known, ...as.name ? { name: as.name } : {}, ...as.email ? { email: as.email } : {} } : known;
-      return createApi({ host, apiKey, distinctId: distinctId(), user });
+      return createApi({ host, apiKey, distinctId: distinctId(), user, userHash: hashOf(distinctId()) });
     },
     isSurveyDone: (id) => surveysDone.has(id),
     markSurveyDone: (id) => {
@@ -2227,6 +2283,12 @@ try {
 } catch {
   expoLocalization = null;
 }
+var expoStoreReview = null;
+try {
+  expoStoreReview = require("expo-store-review");
+} catch {
+  expoStoreReview = null;
+}
 var viewShot = null;
 try {
   viewShot = require("react-native-view-shot");
@@ -2330,6 +2392,17 @@ var recorderDeps = () => {
     masks: measureMasks
   };
 };
+var storeReview = () => {
+  const m = expoStoreReview;
+  if (!m?.requestReview) return null;
+  return {
+    request: async () => {
+      if (m.isAvailableAsync && !await m.isAvailableAsync()) return false;
+      await m.requestReview();
+      return true;
+    }
+  };
+};
 var nativeDeps = (overrides = {}) => ({
   storage: overrides.storage !== void 0 ? overrides.storage : asyncStorage(),
   fetch: ((url, init) => fetch(url, init)),
@@ -2344,6 +2417,7 @@ var nativeDeps = (overrides = {}) => ({
   initialUrl: () => RN2.Linking.getInitialURL(),
   openUrl: (url) => void RN2.Linking.openURL(url).catch(() => void 0),
   push: expoPush(),
+  storeReview: storeReview(),
   recorder: recorderDeps()
 });
 var optionalModules = () => ({
@@ -2352,6 +2426,7 @@ var optionalModules = () => ({
   expoApplication: !!expoApplication,
   expoLocalization: !!expoLocalization,
   expoNotifications: !!expoNotifications,
+  expoStoreReview: !!expoStoreReview?.requestReview,
   viewShot: !!viewShot?.captureScreen
 });
 
@@ -3570,6 +3645,10 @@ var usePaywall = () => {
   const client = useClient();
   return { open: client.openPaywall };
 };
+var useReview = () => {
+  const client = useClient();
+  return { request: client.requestReview };
+};
 var useOnboarding = () => {
   const client = useClient();
   return { start: client.startOnboarding };