@mrrocket/sdk 0.14.0 → 0.16.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this package. It follows semantic versioning; before 1.0 a minor version may change an API.
 
+## 0.16.0 (not published yet)
+
+- **Identity verification:** your server signs the user id with the product's server key and the SDK sends that signature as `userHash` with every request for the id, so someone who only knows a user's id can no longer read their support chat, register push for them or post feedback and events as them. Server: `userHash(userId, { serverKey? })` from `@mrrocket/sdk/next/server` (WebCrypto only; Node 18+, Edge, Workers; defaults to `MRROCKET_SERVER_KEY`, throws without a key). The formula for other backends: `hex(HMAC-SHA256(key = SHA-256(server key), message = user id))`.
+- **Client:** `identify(id, props, { hash })` in `useCockpit()`, `window.mrrocket.identify` and the React Native client; `<CockpitProvider userHash>` signs the `distinctId` prop from a server layout. The hash belongs to one id: dropped on `reset()` and on `identify` for another id without one; a value that is not 64 hex characters is never sent. React Native keeps it in memory only.
+- **Sent with:** event batches (one top-level `userHash`, checked per event), errors (only when every report is of the signed id), recordings, push register/unregister, in-app messages, surveys (read, seen, answer), the feedback board (list, post, vote, comments, roadmap, a post), article ratings, messenger reads, messages, uploads (form field) and attachment links (query). A 401 is handled like any failed call and the console says once how to fix it; a recording stops on 401.
+- New exports: the type `IdentifyOptions` (Next.js and React Native), `userHash` and `UserHashOptions` (server). `createApi` takes `userHash`.
+- **Store reviews (React Native):** `useReview().request()` / `client.requestReview()` asks for a review at the moment your app picks (the trigger of an in-app request in MRRocket › Reviews › Requests). It asks MRRocket whether this signed-in person may be asked now (a customer within the request's neutral limits, not asked in 120 days; never by rating or mood), then opens the App Store's or Google Play's own rating dialog through `expo-store-review` (new optional peer dependency) and sends `$review_prompt {campaign, store, action: "requested" | "unavailable"}`; only a requested dialog counts as an invitation. Resolves with `"requested" | "not-now" | "unavailable" | "not-signed-in"` (type `NativeReviewResult`). `GET /api/sdk/inapp` answers `review: { campaign, store }` when the person may be asked; the web has no store dialog and ignores it.
+- `sdk.js` budget 15.75 KB gzip (was 15.25).
+- Version reported in event batches: `0.16.0`.
+
 ## 0.14.0 (not published yet)
 
 - **Paywalls with pages:** a paywall from MRRocket › Conversion › Paywalls can have several pages (benefits, customer quotes, plans), served as the config's new `paywalls` per placement. `usePaywall().open(placement, { onPurchase, plans, onClose })` (Next.js and React Native, drawn by the provider), `mrrocket.paywall.open(…)` (script tag) show them one after another with Back and dots; the last page hands the chosen plan to `onPurchase`, where the app buys it (StoreKit/Play through RevenueCat or Adapty, Stripe Checkout). MRRocket never takes a payment; only after `onPurchase` resolves is the purchase recorded (`false`: the store sheet was cancelled, the paywall stays). Resolves with `{ outcome: "purchased" | "chosen" | "closed", plan, variant, index }`.

package/README.md

@@ -10,7 +10,7 @@ The MRRocket SDK, one package with three ways in:
 
 One provider in your layout (or one script tag) gives MRRocket page views, your events, A/B tests, feature flags and errors that the agents can run and read. MRRocket shows every variant of your real pages, because the SDK can render any variant on request.
 
-Status: 0.8.0, MIT licensed, compiled to ESM JavaScript with type declarations (no `transpilePackages`); the React Native entry is CommonJS for Metro. Works with Next.js 15 and 16, React 18 and 19, on Node and on Cloudflare Workers (OpenNext), and with React Native 0.72+ / Expo. The source lives in the MRRocket repo (`prototype/web/packages/cockpit-next`).
+Status: 0.16.0, MIT licensed, compiled to ESM JavaScript with type declarations (no `transpilePackages`); the React Native entry is CommonJS for Metro. Works with Next.js 15 and 16, React 18 and 19, on Node and on Cloudflare Workers (OpenNext), and with React Native 0.72+ / Expo. The source lives in the MRRocket repo (`prototype/web/packages/cockpit-next`).
 
 ## Install
 
@@ -63,6 +63,7 @@ import { useCockpit } from "@mrrocket/sdk/next";
 const { track, identify } = useCockpit();
 track("checkout_started", { plan: "team" });
 identify(user.id, { plan: user.plan });
+identify(user.id, { plan: user.plan }, { hash }); // signed by your server, see 22. Identity verification
 ```
 
 ## 3. A/B tests
@@ -406,6 +407,8 @@ const cancelFlow = useCancelFlow();
         const result = await cancelFlow.open({
             customer: account.isBusiness ? "business" : "consumer",
             price: { amount: 29, currency: "EUR" }, // optional: shows what the discount costs
+            plan: account.planId, // optional (0.15.0): for offers by plan, your billing's plan id or name
+            customerSince: account.paidSince, // optional (0.15.0): for offers by how long they have paid
             onCancel: (r) => api.cancelSubscription({ reason: r.reason, comment: r.comment }),
             onSave: (r) => api.applyOffer(r.offer), // { kind: "discount", percent, months } | { kind: "pause", months } | { kind: "downgrade", plan } | { kind: "contact" }
         });
@@ -416,6 +419,8 @@ const cancelFlow = useCancelFlow();
 </button>;
 ```
 
+Since 0.15.0 an answer can ask one follow-up question, show a different offer by the follow-up's answer, the plan or how long the customer has paid (the first rule that fits wins; one about the plan or time needs `plan` / `customerSince`), and make a second offer once the first is declined. `result.answer` holds the follow-up's answer.
+
 MRRocket never changes a subscription (its payment key is read-only): `onCancel` and `onSave` are your code. Only after they succeed is the outcome recorded, and MRRocket shows it under Churn as a cancellation or a save with the customer's plan and monthly revenue (matched by your `identify()` id, or the email you passed with it). If one throws, the dialog stays open with "Something went wrong. Please try again." Script tag: `mrrocket.cancelFlow.open({ … })`.
 
 **Onboarding** (Conversion › Onboarding): the tour, checklist and modal steps of a live flow. A flow starts on its own when the person does its trigger: `track("Signed up")` (or `signup`, `sign_up`) for "Signed up", `track("first_export")` for "First export", and the first page or screen for "First launch" / "First visit", once per person. Automatic starts need a signed-in person (`identify`) or stored progress (`consent="cookies"` / `"persistent"`), so nobody gets the same tour on every page. `useCockpit().startOnboarding()` (script tag `mrrocket.onboarding.start()`, React Native `useOnboarding().start()`) starts one whenever you want; `onboarding={false}` on the provider switches the automatic start off. A tour step points at the element marked `data-ck-target="…"` (web); a checklist item with an event ticks itself when you track it. Emails of the flow go out from MRRocket.
@@ -447,6 +452,17 @@ mrrocket.push.subscribe();
 
 `register({ ask: false })` / `subscribe({ ask: false })` only send an existing token or subscription again. `reset()` on React Native takes the token back; on the web call `push.unsubscribe()` before `reset()`. A site with its own service worker adds `importScripts("/mrrocket-sw.js")` to it and calls `subscribe({ serviceWorker: false })`. Opening a MRRocket notification records `$push { action: "opened", message }`.
 
+
+**Store reviews (0.16.0, React Native).** An in-app review request (Reviews › Requests) opens the App Store's or Google Play's own rating dialog at the moment your app picks. Install `expo-store-review`, then after `identify()`:
+
+```tsx
+import { useReview } from "@mrrocket/sdk/react-native";
+const review = useReview();
+// Where the request's trigger happens (the third finished challenge, a 7-day streak …):
+await review.request(); // "requested" | "not-now" | "unavailable" | "not-signed-in"
+```
+
+MRRocket answers whether this person may be asked now (a customer within the request's neutral limits, not asked in 120 days; never by rating or mood) and counts only dialogs that were requested (`$review_prompt`). The store decides whether its dialog shows (Apple: at most three times a year). Websites have no store dialog: ask by email there.
 ## 17. Redirects and redirect tests (0.7.0)
 
 Page redirects (Landing pages › Redirect) and redirect tests ("Whole page" in Experiments) come with the config: the SDK sends the visitor on before the page shows, keeping the query and hash, and the page a test's variant lands on records the exposure (`ck_x=<test>:<variant>`, removed from the address). Nothing to add for the script tag (the optional `ck-hide` snippet stops a flash of the old page). In Next.js `<CockpitProvider>` redirects after the first paint; to answer before rendering, use the proxy helper:
@@ -483,9 +499,11 @@ const messenger = useMessenger();
 <a data-ck-messenger>Chat with us</a>;
 ```
 
-The look and texts (color, light or dark, side, title, greeting, button text, Help tab, sound, preview, asking for an email) are set per product in MRRocket › Support › Messenger and read by the messenger itself (`GET /api/sdk/messenger`), so they change without a deploy. What you pass in code wins.
+The look and texts (color, light or dark, corners, Home's top, font, place, name, greeting, button text, Help tab, sound, preview, asking for an email, and "Powered by MRRocket", which Studio and Agency can switch off) are set per product in MRRocket › Support › Messenger and read by the messenger itself (`GET /api/sdk/messenger`), so they change without a deploy. What you pass in code wins.
 
-Props: `title`, `greeting`, `launcher` (default true), `help` (the Help tab, default true; hidden while there is no published article), `sound` (default true), `preview` (default true), `askEmail` (default true), `position` ("bottom-right", "bottom-left"), `label`, `theme`, `accent`. The panel is plain DOM, loaded with a dynamic import after the page rendered.
+Props: `title`, `greeting`, `launcher` (default true), `help` (the Help tab, default true; hidden while there is no published article), `sound` (default true), `preview` (default true), `askEmail` (default true), `position` ("bottom-right" default, "bottom-left", "bottom-center", "top-left", "top-center", "top-right", "middle-left", "middle-right"), `corners` ("round", "soft", "square"), `header` ("plain", "color"), `font` ("site", "system"), `label`, `theme`, `accent`. The panel is plain DOM, loaded with a dynamic import after the page rendered.
+
+Files (0.15): a paperclip in the message field attaches pictures (PNG, JPEG, WebP, GIF) and PDFs, pasting an image (Cmd/Ctrl+V) or dropping files onto the panel does too, and where the browser has `getDisplayMedia` (not on phones) the paperclip offers "Screenshot of this page": the tab is shared once (`preferCurrentTab`), the messenger hides for one frame, the stream stops. Each file uploads when picked (`POST /api/sdk/messages/attachments`, multipart `key`, `distinctId`, `file`; the server checks the bytes, never SVG, at most 10 MB) and answers a signed id; `sendChat({ body, attachments: [id, …] })` sends up to 4, and the body may then be empty. Sent files come back as `message.attachments` and are read with `api.attachmentUrl(id)` (the visitor's own chat only). Each message also sends `context: { viewport }`; the server adds browser and system from the user agent. In React Native the paperclip shows when `expo-image-picker` is installed (optional peer) and picks from the photo library; the app sends its system and screen size.
 
 Call `identify(user.id, { name, email })` and chats carry the person's name and email (they are not asked). While the panel is open it reads `GET /api/sdk/messages` every 4 seconds; while a visitor waits for an answer every 8 seconds for ten minutes, then every 30. Articles come from `GET /api/sdk/articles` as blocks, written with textContent, never HTML.
 
@@ -495,7 +513,7 @@ On sites with the script tag (Webflow, Framer, WordPress …) add `data-messenge
 <script async src="https://app.mrrocket.dev/sdk.js" data-key="mrr_pub_…" data-messenger="true" data-messenger-title="Acme"></script>
 ```
 
-Also `data-messenger-greeting`, `-label`, `-position="bottom-left"`, and "false" for `-help`, `-sound`, `-preview`, `-ask-email`. `mrrocket.messenger.open()` opens it from your code.
+Also `data-messenger-greeting`, `-label`, `-position="top-right"`, `-corners="soft"`, `-header="color"`, `-font="system"`, and "false" for `-help`, `-sound`, `-preview`, `-ask-email`. `mrrocket.messenger.open()` opens it from your code.
 
 In React Native, `<MRRocketProvider messenger={{ launcher: true }}>` adds the bubble, `useMessenger().open()` opens it from your own button; a new answer shows as a banner at the top, with a light haptic when `expo-haptics` is installed. The provider also shows your live in-app survey (`surveys={false}` to switch off) and the feedback sheet (`useFeedback().open()`). With the person's consent (`replay`) and `react-native-view-shot` installed, the app also records sessions as screen pictures for Sessions: none while the keyboard is open, and `<MRRocketMask>` areas are painted black on the server before storing. Taps go to Heatmaps as clicks on the current screen; the provider then wraps the app in one `View` with `flex: 1` (`heatmaps={false}` to switch off).
 
@@ -579,6 +597,29 @@ mrrocket.paywall.open("pricing_page", { onPurchase: (plan) => fetch("/checkout",
 - **Without pages** a paywall keeps working as texts your own paywall marks (`paywall.<placement>.headline`, `.body`, `.cta`).
 - The script tag loads the paywall dialog from `sdk-flows.js` on the first `open`; `sdk.js` stays within its budget.
 
+## 22. Identity verification (0.16.0)
+
+After `identify(id)` the SDK sends your app's own user id with every request, and that id is no secret (a Clerk id shows in URLs and logs). On its own it proves nothing: someone who knows it could read that person's support chat, register a push device for them or post feedback as them. Identity verification closes that, like Intercom's: your **server** signs the user id with the product's server key, the SDK sends the signature (`userHash`) with every request for that id, and MRRocket checks it.
+
+Next.js, in three lines (the server key is `mrr_sk_…` from MRRocket › Settings › Products › your product › Sign-in, in `MRROCKET_SERVER_KEY`, never `NEXT_PUBLIC_`):
+
+```tsx
+// app/layout.tsx (a server component)
+import { userHash } from "@mrrocket/sdk/next/server";
+
+const hash = user ? await userHash(user.id) : undefined;
+// then either: <CockpitProvider distinctId={user?.id} userHash={hash}>
+// or, in the client component that signs people in: identify(user.id, { email: user.email }, { hash })
+```
+
+- **Script tag:** your server renders the hash into the page, the page passes it on: `mrrocket.identify(user.id, { email }, { hash: "…" })`.
+- **React Native:** your backend returns the hash with the signed-in user (in `/me`, say); call `identify(user.id, props, { hash })` on every start. The server key never goes into the app, and the SDK keeps the hash in memory only.
+- **Other languages:** `userHash = lowercase hex( HMAC-SHA256( key = SHA-256(server key) as its 32 raw bytes, message = user id as UTF-8 ) )`. MRRocket stores only the SHA-256 of the server key, which is why that is the key. Node: `crypto.createHmac("sha256", crypto.createHash("sha256").update(serverKey).digest()).update(userId).digest("hex")`; Python: `hmac.new(hashlib.sha256(server_key.encode()).digest(), user_id.encode(), hashlib.sha256).hexdigest()`; PHP: `hash_hmac("sha256", $userId, hash("sha256", $serverKey, true))`; Ruby: `OpenSSL::HMAC.hexdigest("SHA256", Digest::SHA256.digest(server_key), user_id)`.
+- **What carries it:** events (one `userHash` per batch; MRRocket checks it against each event's id), errors, recordings, push sign-up, in-app messages, surveys, the feedback board, help article ratings and the messenger (its messages, uploads and file links). A JSON field next to `distinctId`, a query parameter on reads, a form field on uploads.
+- **One id, one hash:** the hash is forgotten on `reset()` and when `identify` is called for another id without one, so it never goes out with someone else's id. A value that is not 64 hex characters (the server key pasted by mistake) is never sent; the console says so.
+- **Refused:** a hash that does not match is answered 401; with "Only signed users" on (Sign-in settings), so is a signed-in user's id without one. The SDK never throws for it: the request fails like any other and the console says once how to fix it. Turn "Only signed users" on after the app sends hashes.
+- `userHash()` runs on Node 18+ (Next.js provides WebCrypto there), the Edge runtime and Cloudflare Workers; it throws when there is no server key, so a missing setting shows on your server.
+
 ## Privacy and consent
 
 ```tsx

package/dist/api-client.d.ts

@@ -1,7 +1,3 @@
-/**
- * The SDK's fetch client and the shapes it reads, without React, so the script tag's widgets (src/script) use it too.
- * `./api` re-exports all of it with the `useApi` hook.
- */
 export type PostStatus = "review" | "planned" | "progress" | "shipped";
 export declare const STATUS_LABEL: Record<PostStatus, string>;
 export interface FeedbackBoardInfo {
@@ -76,6 +72,32 @@ export interface SurveyDefinition {
     questions: SurveyQuestion[];
 }
 export 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). */
+export 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;
+}
+/** What the messenger can send: pictures and PDFs, at most 10 MB each, 4 per message. */
+export declare const CHAT_FILE_TYPES: readonly ["image/png", "image/jpeg", "image/webp", "image/gif", "application/pdf"];
+export declare const CHAT_FILE_MAX_BYTES: number;
+export declare const CHAT_FILES_PER_MESSAGE = 4;
+/** A file to upload: a Blob or File on the web, the image picker's `{ uri, name, type }` in React Native. */
+export 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. */
+export 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. */
 export interface ChatMessage {
     id: string;
@@ -87,6 +109,8 @@ export 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). */
 export interface ArticleSummary {
@@ -124,11 +148,25 @@ export 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. */
+export type MessengerPosition = "top-left" | "top-center" | "top-right" | "middle-left" | "middle-right" | "bottom-left" | "bottom-center" | "bottom-right";
+/** How round the messenger is. */
+export type MessengerCorners = "round" | "soft" | "square";
+/** The radii per corner style, in px: the panel or sheet, message bubbles (and their tail), cards, fields and buttons. */
+export declare const CORNERS: Record<MessengerCorners, {
+    panel: number;
+    bubble: number;
+    tail: number;
+    card: number;
+    field: number;
+}>;
 /** The messenger's look and texts as set in MRRocket › Support › Messenger (servers from SDK 0.9 on). */
 export 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;
@@ -140,7 +178,19 @@ export 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 link behind "Powered by MRRocket". */
+export declare const BRAND_URL = "https://mrrocket.dev/?utm_source=messenger&utm_medium=powered-by";
 /** The line under "Send us a message" and in the chat's head. */
 export declare const replyLine: (t: MessengerLook["replyTime"]) => "We usually reply in a few minutes" | "We usually reply within a day" | "We usually reply in a few hours";
 /** Black or white, whichever reads better on the accent (a light custom color gets dark text). */
@@ -167,6 +217,11 @@ interface Conn {
         id?: string;
         [key: string]: unknown;
     };
+    /**
+     * The identity hash of `distinctId` (0.16.0, see identity.ts), sent with every request that names the visitor: a
+     * JSON field next to `distinctId`, a query parameter, a form field. Leave it out for any other id.
+     */
+    userHash?: string;
 }
 /** The small fetch client behind the widgets. Every read takes an AbortSignal so unmounting cancels it. */
 export declare const createApi: (c: Conn) => {
@@ -203,11 +258,18 @@ export 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[];
     }>;

package/dist/api-client.js

@@ -1,10 +1,20 @@
 // src/api-client.ts
+import { warnUnsigned } from "./identity.js";
 var STATUS_LABEL = {
   review: "Under review",
   planned: "Planned",
   progress: "In progress",
   shipped: "Shipped"
 };
+var CHAT_FILE_TYPES = ["image/png", "image/jpeg", "image/webp", "image/gif", "application/pdf"];
+var CHAT_FILE_MAX_BYTES = 10 * 1024 * 1024;
+var CHAT_FILES_PER_MESSAGE = 4;
+var CORNERS = {
+  round: { panel: 22, bubble: 18, tail: 6, card: 16, field: 20 },
+  soft: { panel: 14, bubble: 12, tail: 4, card: 10, field: 10 },
+  square: { panel: 6, bubble: 6, tail: 2, card: 4, field: 4 }
+};
+var BRAND_URL = "https://mrrocket.dev/?utm_source=messenger&utm_medium=powered-by";
 var replyLine = (t) => t === "minutes" ? "We usually reply in a few minutes" : t === "day" ? "We usually reply within a day" : "We usually reply in a few hours";
 var inkOn = (hex) => {
   const m = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i.exec(hex);
@@ -29,13 +39,15 @@ var call = async (url, init, signal) => {
     res = await fetch(url, {
       ...init,
       signal,
-      headers: init?.body ? { "content-type": "application/json" } : void 0
+      // A form (a file upload) sets its own multipart type with the boundary.
+      headers: typeof init?.body === "string" ? { "content-type": "application/json" } : void 0
     });
   } catch (e) {
     if (e.name === "AbortError") throw e;
     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 ?? "";
@@ -47,30 +59,49 @@ 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. */
+    uploadChatFile: (file, signal) => {
+      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(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 })
   };
 };
 export {
   ApiError,
+  BRAND_URL,
+  CHAT_FILES_PER_MESSAGE,
+  CHAT_FILE_MAX_BYTES,
+  CHAT_FILE_TYPES,
+  CORNERS,
   STATUS_LABEL,
   createApi,
   inkOn,

package/dist/api-client.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/api-client.ts"],"sourcesContent":["/**\n * The SDK's fetch client and the shapes it reads, without React, so the script tag's widgets (src/script) use it too.\n * `./api` re-exports all of it with the `useApi` hook.\n */\nexport type PostStatus = \"review\" | \"planned\" | \"progress\" | \"shipped\";\n\nexport const STATUS_LABEL: Record<PostStatus, string> = {\n    review: \"Under review\",\n    planned: \"Planned\",\n    progress: \"In progress\",\n    shipped: \"Shipped\",\n};\n\nexport interface FeedbackBoardInfo {\n    id: string;\n    label: string;\n}\n\nexport interface FeedbackPost {\n    id: string;\n    title: string;\n    body: string;\n    board: string;\n    status: PostStatus;\n    votes: number;\n    comments: number;\n    voted: boolean;\n    createdAt: string;\n    /** \"Lena K.\", \"Anonymous\" or \"Team\". Missing from servers before SDK 0.6. */\n    author?: string;\n}\n\n/** The product's public face for the board's header. */\nexport interface FeedbackProduct {\n    name: string;\n    logo: string | null;\n    /** The domain's favicon, tried when `logo` does not load. Older servers leave it out. */\n    logoFallback?: string | null;\n}\n\nexport interface FeedbackList {\n    boards: FeedbackBoardInfo[];\n    posts: FeedbackPost[];\n    product?: FeedbackProduct;\n}\n\nexport interface FeedbackRoadmap {\n    /** `review` (Backlog) comes from servers of SDK 0.6 on. */\n    columns: { review?: FeedbackPost[]; planned: FeedbackPost[]; progress: FeedbackPost[]; shipped: FeedbackPost[] };\n}\n\nexport interface ChangelogEntry {\n    id: string;\n    title: string;\n    body: string;\n    publishedAt: string;\n}\n\nexport interface FeedbackComment {\n    id: string;\n    body: string;\n    author: string;\n    isTeam: boolean;\n    postedAt: string;\n}\n\nexport type SurveyQuestionKind = \"nps\" | \"rating\" | \"single\" | \"multi\" | \"text\";\n\nexport interface SurveyQuestion {\n    key: string;\n    kind: SurveyQuestionKind;\n    title: string;\n    description?: string;\n    required: boolean;\n    options?: string[];\n    scale?: number;\n    low?: string;\n    high?: string;\n    placeholder?: string;\n}\n\nexport interface SurveyDefinition {\n    id: string;\n    name: string;\n    type: string;\n    thanks: string;\n    questions: SurveyQuestion[];\n}\n\nexport type SurveyAnswer = number | string | string[];\n\n/** One message of the messenger's chat. \"visitor\" is the person on the site; the rest come from the product's team. */\nexport interface ChatMessage {\n    id: string;\n    from: \"visitor\" | \"team\" | \"ai\" | \"auto\";\n    body: string;\n    at: string;\n    /** Help articles an answer drew on (servers from SDK 0.9 on). */\n    articles?: { id: string; title: string }[];\n}\n\n/** A published help article in a list (the messenger's Help tab). */\nexport interface ArticleSummary {\n    id: string;\n    title: string;\n    collection: string;\n    excerpt: string;\n    updatedAt: string;\n}\n\n/** A run of text inside an article block. Links are http(s), mailto or tel only. */\nexport interface ArticleSpan {\n    text: string;\n    href?: string;\n    bold?: boolean;\n    italic?: boolean;\n    code?: boolean;\n}\n\n/** An article's content as blocks, written with textContent (never parsed as HTML). */\nexport type ArticleBlock =\n    | { type: \"h2\" | \"h3\" | \"p\" | \"quote\"; spans: ArticleSpan[] }\n    | { type: \"ul\" | \"ol\"; items: ArticleSpan[][] }\n    | { type: \"code\"; text: string }\n    | { type: \"hr\" };\n\nexport interface Article {\n    id: string;\n    title: string;\n    collection: string;\n    updatedAt: string;\n    blocks: ArticleBlock[];\n}\n\n/** The messenger's look and texts as set in MRRocket › Support › Messenger (servers from SDK 0.9 on). */\nexport interface MessengerLook {\n    accent: string;\n    theme: \"light\" | \"dark\" | \"auto\";\n    position: \"bottom-right\" | \"bottom-left\";\n    title: string;\n    greeting: string;\n    label: string;\n    /** How soon the team usually answers (MRRocket from 0.10; older servers leave it out). */\n    replyTime?: \"minutes\" | \"hours\" | \"day\";\n    /** A round chat button in the app (React Native) too. */\n    appLauncher?: boolean;\n    help: boolean;\n    sound: boolean;\n    preview: boolean;\n    askEmail: boolean;\n}\n\n/** The line under \"Send us a message\" and in the chat's head. */\nexport const replyLine = (t: MessengerLook[\"replyTime\"]) =>\n    t === \"minutes\" ? \"We usually reply in a few minutes\" : t === \"day\" ? \"We usually reply within a day\" : \"We usually reply in a few hours\";\n\n/** Black or white, whichever reads better on the accent (a light custom color gets dark text). */\nexport const inkOn = (hex: string) => {\n    const m = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i.exec(hex);\n    if (!m) return \"#ffffff\";\n    const [r, g, b] = [m[1], m[2], m[3]].map((x) => {\n        const c = parseInt(x, 16) / 255;\n        return c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4;\n    });\n    return 0.2126 * r + 0.7152 * g + 0.0722 * b > 0.45 ? \"#111214\" : \"#ffffff\";\n};\n\n/** The visitor's newest chat (open or closed) and its messages. */\nexport interface ChatThread {\n    conversation: { id: string; status: \"open\" | \"solved\" } | null;\n    messages: ChatMessage[];\n    /** The visitor gave an email already: the messenger stops asking. */\n    hasEmail: boolean;\n}\n\nexport class ApiError extends Error {\n    status: number;\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}\n\ninterface Conn {\n    host: string;\n    apiKey: string;\n    distinctId: string;\n    user?: { id?: string; [key: string]: unknown };\n}\n\n// Not URLSearchParams: React Native's lacks `set` in older versions, and the apps use this client too.\nconst qs = (params: Record<string, string | undefined>) =>\n    Object.entries(params)\n        .filter((e): e is [string, string] => !!e[1])\n        .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)\n        .join(\"&\");\n\nconst call = async <T>(url: string, init: RequestInit | undefined, signal?: AbortSignal): Promise<T> => {\n    let res: Response;\n    try {\n        res = await fetch(url, {\n            ...init,\n            signal,\n            headers: init?.body ? { \"content-type\": \"application/json\" } : undefined,\n        });\n    } catch (e) {\n        if ((e as Error).name === \"AbortError\") throw e;\n        throw new ApiError(\"Could not reach the server. Check your connection and try again.\", 0);\n    }\n    if (!res.ok) {\n        let detail = \"\";\n        try {\n            detail = ((await res.json()) as { error?: string }).error ?? \"\";\n        } catch {\n            // Not JSON; the status is enough.\n        }\n        throw new ApiError(detail || (res.status === 429 ? \"Too many requests. Try again in a minute.\" : \"Something went wrong. Please try again.\"), res.status);\n    }\n    return (await res.json()) as T;\n};\n\n/** The small fetch client behind the widgets. Every read takes an AbortSignal so unmounting cancels it. */\nexport const createApi = (c: Conn) => {\n    const base = `${c.host}/api/sdk`;\n    const who = { key: c.apiKey, distinctId: c.distinctId, user: c.user };\n    const post = <T>(path: string, body: Record<string, unknown>, signal?: AbortSignal) =>\n        call<T>(`${base}${path}`, { method: \"POST\", body: JSON.stringify({ ...who, ...body }) }, signal);\n    return {\n        list: (o: { board?: string; sort?: \"top\" | \"new\"; q?: string }, signal?: AbortSignal) =>\n            call<FeedbackList>(`${base}/feedback?${qs({ key: c.apiKey, distinctId: c.distinctId, board: o.board, sort: o.sort, q: o.q })}`, undefined, signal),\n        post: (id: string, signal?: AbortSignal) =>\n            call<FeedbackPost>(`${base}/feedback/${encodeURIComponent(id)}?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, undefined, signal),\n        roadmap: (signal?: AbortSignal) => call<FeedbackRoadmap>(`${base}/feedback/roadmap?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, undefined, signal),\n        changelog: (signal?: AbortSignal) => call<{ entries: ChangelogEntry[] }>(`${base}/feedback/changelog?${qs({ key: c.apiKey })}`, undefined, signal),\n        submit: (p: { title: string; body?: string; board: string }) => post<FeedbackPost>(\"/feedback\", p),\n        vote: (id: string) => post<{ voted: boolean; votes: number }>(`/feedback/${encodeURIComponent(id)}/vote`, {}),\n        comments: (id: string, signal?: AbortSignal) =>\n            call<{ comments: FeedbackComment[] }>(`${base}/feedback/${encodeURIComponent(id)}/comments?${qs({ key: c.apiKey })}`, undefined, signal),\n        comment: (id: string, body: string) => post<FeedbackComment>(`/feedback/${encodeURIComponent(id)}/comments`, { body }),\n        survey: (url: string, signal?: AbortSignal) =>\n            call<{ survey: SurveyDefinition | null }>(`${base}/surveys?${qs({ key: c.apiKey, distinctId: c.distinctId, url })}`, undefined, signal),\n        seen: (id: string) => post<unknown>(`/surveys/${encodeURIComponent(id)}/seen`, { user: undefined }),\n        respond: (id: string, r: { answers: Record<string, SurveyAnswer>; completed: boolean; seconds: number }) =>\n            post<unknown>(`/surveys/${encodeURIComponent(id)}/respond`, r),\n        chat: (signal?: AbortSignal) => call<ChatThread>(`${base}/messages?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, undefined, signal),\n        sendChat: (m: { body: string; email?: string; url?: string }) => post<ChatThread>(\"/messages\", m),\n        articles: (q?: string, signal?: AbortSignal) => call<{ articles: ArticleSummary[] }>(`${base}/articles?${qs({ key: c.apiKey, q })}`, undefined, signal),\n        article: (id: string, signal?: AbortSignal) =>\n            call<Article>(`${base}/articles/${encodeURIComponent(id)}?${qs({ key: c.apiKey, distinctId: c.distinctId })}`, undefined, signal),\n        messengerLook: (signal?: AbortSignal) => call<MessengerLook>(`${base}/messenger?${qs({ key: c.apiKey })}`, undefined, signal),\n        rateArticle: (id: string, helpful: boolean) => post<{ counted: boolean }>(`/articles/${encodeURIComponent(id)}/rate`, { helpful }),\n    };\n};\n\nexport type Api = ReturnType<typeof createApi>;\n"],"mappings":";AAMO,IAAM,eAA2C;AAAA,EACpD,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AACb;AA8IO,IAAM,YAAY,CAAC,MACtB,MAAM,YAAY,sCAAsC,MAAM,QAAQ,kCAAkC;AAGrG,IAAM,QAAQ,CAAC,QAAgB;AAClC,QAAM,IAAI,8CAA8C,KAAK,GAAG;AAChE,MAAI,CAAC,EAAG,QAAO;AACf,QAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM;AAC5C,UAAM,IAAI,SAAS,GAAG,EAAE,IAAI;AAC5B,WAAO,KAAK,UAAU,IAAI,UAAU,IAAI,SAAS,UAAU;AAAA,EAC/D,CAAC;AACD,SAAO,SAAS,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,YAAY;AACrE;AAUO,IAAM,WAAN,cAAuB,MAAM;AAAA,EAChC;AAAA,EACA,YAAY,SAAiB,QAAgB;AACzC,UAAM,OAAO;AACb,SAAK,SAAS;AAAA,EAClB;AACJ;AAUA,IAAM,KAAK,CAAC,WACR,OAAO,QAAQ,MAAM,EAChB,OAAO,CAAC,MAA6B,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3C,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,EACnE,KAAK,GAAG;AAEjB,IAAM,OAAO,OAAU,KAAa,MAA+B,WAAqC;AACpG,MAAI;AACJ,MAAI;AACA,UAAM,MAAM,MAAM,KAAK;AAAA,MACnB,GAAG;AAAA,MACH;AAAA,MACA,SAAS,MAAM,OAAO,EAAE,gBAAgB,mBAAmB,IAAI;AAAA,IACnE,CAAC;AAAA,EACL,SAAS,GAAG;AACR,QAAK,EAAY,SAAS,aAAc,OAAM;AAC9C,UAAM,IAAI,SAAS,oEAAoE,CAAC;AAAA,EAC5F;AACA,MAAI,CAAC,IAAI,IAAI;AACT,QAAI,SAAS;AACb,QAAI;AACA,gBAAW,MAAM,IAAI,KAAK,GAA0B,SAAS;AAAA,IACjE,QAAQ;AAAA,IAER;AACA,UAAM,IAAI,SAAS,WAAW,IAAI,WAAW,MAAM,8CAA8C,4CAA4C,IAAI,MAAM;AAAA,EAC3J;AACA,SAAQ,MAAM,IAAI,KAAK;AAC3B;AAGO,IAAM,YAAY,CAAC,MAAY;AAClC,QAAM,OAAO,GAAG,EAAE,IAAI;AACtB,QAAM,MAAM,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,YAAY,MAAM,EAAE,KAAK;AACpE,QAAM,OAAO,CAAI,MAAc,MAA+B,WAC1D,KAAQ,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,QAAQ,QAAQ,MAAM,KAAK,UAAU,EAAE,GAAG,KAAK,GAAG,KAAK,CAAC,EAAE,GAAG,MAAM;AACnG,SAAO;AAAA,IACH,MAAM,CAAC,GAAyD,WAC5D,KAAmB,GAAG,IAAI,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,YAAY,OAAO,EAAE,OAAO,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACrJ,MAAM,CAAC,IAAY,WACf,KAAmB,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,WAAW,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACzI,SAAS,CAAC,WAAyB,KAAsB,GAAG,IAAI,qBAAqB,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,WAAW,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACzJ,WAAW,CAAC,WAAyB,KAAoC,GAAG,IAAI,uBAAuB,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACjJ,QAAQ,CAAC,MAAuD,KAAmB,aAAa,CAAC;AAAA,IACjG,MAAM,CAAC,OAAe,KAAwC,aAAa,mBAAmB,EAAE,CAAC,SAAS,CAAC,CAAC;AAAA,IAC5G,UAAU,CAAC,IAAY,WACnB,KAAsC,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,aAAa,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IAC3I,SAAS,CAAC,IAAY,SAAiB,KAAsB,aAAa,mBAAmB,EAAE,CAAC,aAAa,EAAE,KAAK,CAAC;AAAA,IACrH,QAAQ,CAAC,KAAa,WAClB,KAA0C,GAAG,IAAI,YAAY,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,YAAY,IAAI,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IAC1I,MAAM,CAAC,OAAe,KAAc,YAAY,mBAAmB,EAAE,CAAC,SAAS,EAAE,MAAM,OAAU,CAAC;AAAA,IAClG,SAAS,CAAC,IAAY,MAClB,KAAc,YAAY,mBAAmB,EAAE,CAAC,YAAY,CAAC;AAAA,IACjE,MAAM,CAAC,WAAyB,KAAiB,GAAG,IAAI,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,WAAW,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACzI,UAAU,CAAC,MAAsD,KAAiB,aAAa,CAAC;AAAA,IAChG,UAAU,CAAC,GAAY,WAAyB,KAAqC,GAAG,IAAI,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACtJ,SAAS,CAAC,IAAY,WAClB,KAAc,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,WAAW,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACpI,eAAe,CAAC,WAAyB,KAAoB,GAAG,IAAI,cAAc,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IAC5H,aAAa,CAAC,IAAY,YAAqB,KAA2B,aAAa,mBAAmB,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;AAAA,EACrI;AACJ;","names":[]}
+{"version":3,"sources":["../src/api-client.ts"],"sourcesContent":["/**\n * The SDK's fetch client and the shapes it reads, without React, so the script tag's widgets (src/script) use it too.\n * `./api` re-exports all of it with the `useApi` hook.\n */\nimport { warnUnsigned } from \"./identity\";\n\nexport type PostStatus = \"review\" | \"planned\" | \"progress\" | \"shipped\";\n\nexport const STATUS_LABEL: Record<PostStatus, string> = {\n    review: \"Under review\",\n    planned: \"Planned\",\n    progress: \"In progress\",\n    shipped: \"Shipped\",\n};\n\nexport interface FeedbackBoardInfo {\n    id: string;\n    label: string;\n}\n\nexport interface FeedbackPost {\n    id: string;\n    title: string;\n    body: string;\n    board: string;\n    status: PostStatus;\n    votes: number;\n    comments: number;\n    voted: boolean;\n    createdAt: string;\n    /** \"Lena K.\", \"Anonymous\" or \"Team\". Missing from servers before SDK 0.6. */\n    author?: string;\n}\n\n/** The product's public face for the board's header. */\nexport interface FeedbackProduct {\n    name: string;\n    logo: string | null;\n    /** The domain's favicon, tried when `logo` does not load. Older servers leave it out. */\n    logoFallback?: string | null;\n}\n\nexport interface FeedbackList {\n    boards: FeedbackBoardInfo[];\n    posts: FeedbackPost[];\n    product?: FeedbackProduct;\n}\n\nexport interface FeedbackRoadmap {\n    /** `review` (Backlog) comes from servers of SDK 0.6 on. */\n    columns: { review?: FeedbackPost[]; planned: FeedbackPost[]; progress: FeedbackPost[]; shipped: FeedbackPost[] };\n}\n\nexport interface ChangelogEntry {\n    id: string;\n    title: string;\n    body: string;\n    publishedAt: string;\n}\n\nexport interface FeedbackComment {\n    id: string;\n    body: string;\n    author: string;\n    isTeam: boolean;\n    postedAt: string;\n}\n\nexport type SurveyQuestionKind = \"nps\" | \"rating\" | \"single\" | \"multi\" | \"text\";\n\nexport interface SurveyQuestion {\n    key: string;\n    kind: SurveyQuestionKind;\n    title: string;\n    description?: string;\n    required: boolean;\n    options?: string[];\n    scale?: number;\n    low?: string;\n    high?: string;\n    placeholder?: string;\n}\n\nexport interface SurveyDefinition {\n    id: string;\n    name: string;\n    type: string;\n    thanks: string;\n    questions: SurveyQuestion[];\n}\n\nexport type SurveyAnswer = number | string | string[];\n\n/** A file in the messenger's chat: a screenshot, a photo or a PDF the visitor sent (servers from SDK 0.15 on). */\nexport interface ChatFile {\n    /** From an upload: the signed id a message sends. In a message: the file's own id (`attachmentUrl` reads it). */\n    id: string;\n    name: string;\n    type: \"image/png\" | \"image/jpeg\" | \"image/webp\" | \"image/gif\" | \"application/pdf\";\n    /** Bytes. */\n    size: number;\n}\n\n/** What the messenger can send: pictures and PDFs, at most 10 MB each, 4 per message. */\nexport const CHAT_FILE_TYPES = [\"image/png\", \"image/jpeg\", \"image/webp\", \"image/gif\", \"application/pdf\"] as const;\nexport const CHAT_FILE_MAX_BYTES = 10 * 1024 * 1024;\nexport const CHAT_FILES_PER_MESSAGE = 4;\n\n/** A file to upload: a Blob or File on the web, the image picker's `{ uri, name, type }` in React Native. */\nexport type ChatUpload = Blob | { uri: string; name: string; type: string };\n\n/** The bug context a visitor message carries; the server fills browser and system from the user agent when left out. */\nexport interface ChatContext {\n    browser?: string;\n    os?: string;\n    /** \"1440×900\". */\n    viewport?: string;\n}\n\n/** One message of the messenger's chat. \"visitor\" is the person on the site; the rest come from the product's team. */\nexport interface ChatMessage {\n    id: string;\n    from: \"visitor\" | \"team\" | \"ai\" | \"auto\";\n    body: string;\n    at: string;\n    /** Help articles an answer drew on (servers from SDK 0.9 on). */\n    articles?: { id: string; title: string }[];\n    /** Files sent with it (servers from SDK 0.15 on). */\n    attachments?: ChatFile[];\n}\n\n/** A published help article in a list (the messenger's Help tab). */\nexport interface ArticleSummary {\n    id: string;\n    title: string;\n    collection: string;\n    excerpt: string;\n    updatedAt: string;\n}\n\n/** A run of text inside an article block. Links are http(s), mailto or tel only. */\nexport interface ArticleSpan {\n    text: string;\n    href?: string;\n    bold?: boolean;\n    italic?: boolean;\n    code?: boolean;\n}\n\n/** An article's content as blocks, written with textContent (never parsed as HTML). */\nexport type ArticleBlock =\n    | { type: \"h2\" | \"h3\" | \"p\" | \"quote\"; spans: ArticleSpan[] }\n    | { type: \"ul\" | \"ol\"; items: ArticleSpan[][] }\n    | { type: \"code\"; text: string }\n    | { type: \"hr\" };\n\nexport interface Article {\n    id: string;\n    title: string;\n    collection: string;\n    updatedAt: string;\n    blocks: ArticleBlock[];\n}\n\n/** Where the chat button sits: a corner, the middle of the top or bottom edge, or the middle of a side. */\nexport type MessengerPosition = \"top-left\" | \"top-center\" | \"top-right\" | \"middle-left\" | \"middle-right\" | \"bottom-left\" | \"bottom-center\" | \"bottom-right\";\n\n/** How round the messenger is. */\nexport type MessengerCorners = \"round\" | \"soft\" | \"square\";\n\n/** The radii per corner style, in px: the panel or sheet, message bubbles (and their tail), cards, fields and buttons. */\nexport const CORNERS: Record<MessengerCorners, { panel: number; bubble: number; tail: number; card: number; field: number }> = {\n    round: { panel: 22, bubble: 18, tail: 6, card: 16, field: 20 },\n    soft: { panel: 14, bubble: 12, tail: 4, card: 10, field: 10 },\n    square: { panel: 6, bubble: 6, tail: 2, card: 4, field: 4 },\n};\n\n/** The messenger's look and texts as set in MRRocket › Support › Messenger (servers from SDK 0.9 on). */\nexport interface MessengerLook {\n    accent: string;\n    /** Up to two more colors blended into Home's background glow (MRRocket from 0.16; older servers leave it out). */\n    glow?: string[];\n    theme: \"light\" | \"dark\" | \"auto\";\n    position: MessengerPosition;\n    title: string;\n    greeting: string;\n    label: string;\n    /** How soon the team usually answers (MRRocket from 0.10; older servers leave it out). */\n    replyTime?: \"minutes\" | \"hours\" | \"day\";\n    /** A round chat button in the app (React Native) too. */\n    appLauncher?: boolean;\n    help: boolean;\n    sound: boolean;\n    preview: boolean;\n    askEmail: boolean;\n    /** How round panel, bubbles, cards and fields are (MRRocket from 0.15; older servers leave it out: round). */\n    corners?: MessengerCorners;\n    /** The site's own font (the default) or the system's (web only; from 0.15). */\n    font?: \"site\" | \"system\";\n    /** Home's top: plain like the rest, or in the accent color (from 0.15; older servers leave it out: plain). */\n    header?: \"plain\" | \"color\";\n    /** \"Powered by MRRocket\" at the bottom; the server sends false only on plans that may hide it (from 0.15). */\n    branding?: boolean;\n    /** The product's icon (its favicon) at the top left of Home; without it the title's first letter. */\n    logo?: string;\n}\n\n/** The link behind \"Powered by MRRocket\". */\nexport const BRAND_URL = \"https://mrrocket.dev/?utm_source=messenger&utm_medium=powered-by\";\n\n/** The line under \"Send us a message\" and in the chat's head. */\nexport const replyLine = (t: MessengerLook[\"replyTime\"]) =>\n    t === \"minutes\" ? \"We usually reply in a few minutes\" : t === \"day\" ? \"We usually reply within a day\" : \"We usually reply in a few hours\";\n\n/** Black or white, whichever reads better on the accent (a light custom color gets dark text). */\nexport const inkOn = (hex: string) => {\n    const m = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i.exec(hex);\n    if (!m) return \"#ffffff\";\n    const [r, g, b] = [m[1], m[2], m[3]].map((x) => {\n        const c = parseInt(x, 16) / 255;\n        return c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4;\n    });\n    return 0.2126 * r + 0.7152 * g + 0.0722 * b > 0.45 ? \"#111214\" : \"#ffffff\";\n};\n\n/** The visitor's newest chat (open or closed) and its messages. */\nexport interface ChatThread {\n    conversation: { id: string; status: \"open\" | \"solved\" } | null;\n    messages: ChatMessage[];\n    /** The visitor gave an email already: the messenger stops asking. */\n    hasEmail: boolean;\n}\n\nexport class ApiError extends Error {\n    status: number;\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}\n\ninterface Conn {\n    host: string;\n    apiKey: string;\n    distinctId: string;\n    user?: { id?: string; [key: string]: unknown };\n    /**\n     * The identity hash of `distinctId` (0.16.0, see identity.ts), sent with every request that names the visitor: a\n     * JSON field next to `distinctId`, a query parameter, a form field. Leave it out for any other id.\n     */\n    userHash?: string;\n}\n\n// Not URLSearchParams: React Native's lacks `set` in older versions, and the apps use this client too.\nconst qs = (params: Record<string, string | undefined>) =>\n    Object.entries(params)\n        .filter((e): e is [string, string] => !!e[1])\n        .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)\n        .join(\"&\");\n\nconst call = async <T>(url: string, init: RequestInit | undefined, signal?: AbortSignal): Promise<T> => {\n    let res: Response;\n    try {\n        res = await fetch(url, {\n            ...init,\n            signal,\n            // A form (a file upload) sets its own multipart type with the boundary.\n            headers: typeof init?.body === \"string\" ? { \"content-type\": \"application/json\" } : undefined,\n        });\n    } catch (e) {\n        if ((e as Error).name === \"AbortError\") throw e;\n        throw new ApiError(\"Could not reach the server. Check your connection and try again.\", 0);\n    }\n    if (!res.ok) {\n        // A missing or wrong identity hash: the console says once how to sign the user id.\n        warnUnsigned(res.status);\n        let detail = \"\";\n        try {\n            detail = ((await res.json()) as { error?: string }).error ?? \"\";\n        } catch {\n            // Not JSON; the status is enough.\n        }\n        throw new ApiError(detail || (res.status === 429 ? \"Too many requests. Try again in a minute.\" : \"Something went wrong. Please try again.\"), res.status);\n    }\n    return (await res.json()) as T;\n};\n\n/** The small fetch client behind the widgets. Every read takes an AbortSignal so unmounting cancels it. */\nexport const createApi = (c: Conn) => {\n    const base = `${c.host}/api/sdk`;\n    const who = { key: c.apiKey, distinctId: c.distinctId, user: c.user, userHash: c.userHash };\n    // Every query that names the visitor names its hash too.\n    const me = { key: c.apiKey, distinctId: c.distinctId, userHash: c.userHash };\n    const post = <T>(path: string, body: Record<string, unknown>, signal?: AbortSignal) =>\n        call<T>(`${base}${path}`, { method: \"POST\", body: JSON.stringify({ ...who, ...body }) }, signal);\n    return {\n        list: (o: { board?: string; sort?: \"top\" | \"new\"; q?: string }, signal?: AbortSignal) =>\n            call<FeedbackList>(`${base}/feedback?${qs({ ...me, board: o.board, sort: o.sort, q: o.q })}`, undefined, signal),\n        post: (id: string, signal?: AbortSignal) =>\n            call<FeedbackPost>(`${base}/feedback/${encodeURIComponent(id)}?${qs(me)}`, undefined, signal),\n        roadmap: (signal?: AbortSignal) => call<FeedbackRoadmap>(`${base}/feedback/roadmap?${qs(me)}`, undefined, signal),\n        changelog: (signal?: AbortSignal) => call<{ entries: ChangelogEntry[] }>(`${base}/feedback/changelog?${qs({ key: c.apiKey })}`, undefined, signal),\n        submit: (p: { title: string; body?: string; board: string }) => post<FeedbackPost>(\"/feedback\", p),\n        vote: (id: string) => post<{ voted: boolean; votes: number }>(`/feedback/${encodeURIComponent(id)}/vote`, {}),\n        comments: (id: string, signal?: AbortSignal) =>\n            call<{ comments: FeedbackComment[] }>(`${base}/feedback/${encodeURIComponent(id)}/comments?${qs({ key: c.apiKey })}`, undefined, signal),\n        comment: (id: string, body: string) => post<FeedbackComment>(`/feedback/${encodeURIComponent(id)}/comments`, { body }),\n        survey: (url: string, signal?: AbortSignal) =>\n            call<{ survey: SurveyDefinition | null }>(`${base}/surveys?${qs({ ...me, url })}`, undefined, signal),\n        seen: (id: string) => post<unknown>(`/surveys/${encodeURIComponent(id)}/seen`, { user: undefined }),\n        respond: (id: string, r: { answers: Record<string, SurveyAnswer>; completed: boolean; seconds: number }) =>\n            post<unknown>(`/surveys/${encodeURIComponent(id)}/respond`, r),\n        chat: (signal?: AbortSignal) => call<ChatThread>(`${base}/messages?${qs(me)}`, undefined, signal),\n        /** A message; `attachments` are upload ids from `uploadChatFile` (then the body may be empty). */\n        sendChat: (m: { body: string; email?: string; url?: string; attachments?: string[]; context?: ChatContext }) => post<ChatThread>(\"/messages\", m),\n        /** Uploads one picked file for the next message (pictures and PDFs, at most 10 MB); answers its upload id. */\n        uploadChatFile: (file: ChatUpload, signal?: AbortSignal) => {\n            const form = new FormData();\n            form.append(\"key\", c.apiKey);\n            form.append(\"distinctId\", c.distinctId);\n            if (c.userHash) form.append(\"userHash\", c.userHash);\n            if (\"uri\" in file) form.append(\"file\", file as unknown as Blob);\n            else form.append(\"file\", file, (file as Blob & { name?: string }).name || \"file\");\n            return call<ChatFile>(`${base}/messages/attachments`, { method: \"POST\", body: form }, signal);\n        },\n        /** Where a sent file of this visitor's chat is read (an image's src, a PDF's link). */\n        attachmentUrl: (id: string) => `${base}/messages/attachments/${encodeURIComponent(id)}?${qs(me)}`,\n        articles: (q?: string, signal?: AbortSignal) => call<{ articles: ArticleSummary[] }>(`${base}/articles?${qs({ key: c.apiKey, q })}`, undefined, signal),\n        article: (id: string, signal?: AbortSignal) =>\n            call<Article>(`${base}/articles/${encodeURIComponent(id)}?${qs(me)}`, undefined, signal),\n        messengerLook: (signal?: AbortSignal) => call<MessengerLook>(`${base}/messenger?${qs({ key: c.apiKey })}`, undefined, signal),\n        rateArticle: (id: string, helpful: boolean) => post<{ counted: boolean }>(`/articles/${encodeURIComponent(id)}/rate`, { helpful }),\n    };\n};\n\nexport type Api = ReturnType<typeof createApi>;\n"],"mappings":";AAIA,SAAS,oBAAoB;AAItB,IAAM,eAA2C;AAAA,EACpD,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AACb;AA2FO,IAAM,kBAAkB,CAAC,aAAa,cAAc,cAAc,aAAa,iBAAiB;AAChG,IAAM,sBAAsB,KAAK,OAAO;AACxC,IAAM,yBAAyB;AAiE/B,IAAM,UAAkH;AAAA,EAC3H,OAAO,EAAE,OAAO,IAAI,QAAQ,IAAI,MAAM,GAAG,MAAM,IAAI,OAAO,GAAG;AAAA,EAC7D,MAAM,EAAE,OAAO,IAAI,QAAQ,IAAI,MAAM,GAAG,MAAM,IAAI,OAAO,GAAG;AAAA,EAC5D,QAAQ,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE;AAC9D;AAiCO,IAAM,YAAY;AAGlB,IAAM,YAAY,CAAC,MACtB,MAAM,YAAY,sCAAsC,MAAM,QAAQ,kCAAkC;AAGrG,IAAM,QAAQ,CAAC,QAAgB;AAClC,QAAM,IAAI,8CAA8C,KAAK,GAAG;AAChE,MAAI,CAAC,EAAG,QAAO;AACf,QAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM;AAC5C,UAAM,IAAI,SAAS,GAAG,EAAE,IAAI;AAC5B,WAAO,KAAK,UAAU,IAAI,UAAU,IAAI,SAAS,UAAU;AAAA,EAC/D,CAAC;AACD,SAAO,SAAS,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,YAAY;AACrE;AAUO,IAAM,WAAN,cAAuB,MAAM;AAAA,EAChC;AAAA,EACA,YAAY,SAAiB,QAAgB;AACzC,UAAM,OAAO;AACb,SAAK,SAAS;AAAA,EAClB;AACJ;AAeA,IAAM,KAAK,CAAC,WACR,OAAO,QAAQ,MAAM,EAChB,OAAO,CAAC,MAA6B,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3C,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,EACnE,KAAK,GAAG;AAEjB,IAAM,OAAO,OAAU,KAAa,MAA+B,WAAqC;AACpG,MAAI;AACJ,MAAI;AACA,UAAM,MAAM,MAAM,KAAK;AAAA,MACnB,GAAG;AAAA,MACH;AAAA;AAAA,MAEA,SAAS,OAAO,MAAM,SAAS,WAAW,EAAE,gBAAgB,mBAAmB,IAAI;AAAA,IACvF,CAAC;AAAA,EACL,SAAS,GAAG;AACR,QAAK,EAAY,SAAS,aAAc,OAAM;AAC9C,UAAM,IAAI,SAAS,oEAAoE,CAAC;AAAA,EAC5F;AACA,MAAI,CAAC,IAAI,IAAI;AAET,iBAAa,IAAI,MAAM;AACvB,QAAI,SAAS;AACb,QAAI;AACA,gBAAW,MAAM,IAAI,KAAK,GAA0B,SAAS;AAAA,IACjE,QAAQ;AAAA,IAER;AACA,UAAM,IAAI,SAAS,WAAW,IAAI,WAAW,MAAM,8CAA8C,4CAA4C,IAAI,MAAM;AAAA,EAC3J;AACA,SAAQ,MAAM,IAAI,KAAK;AAC3B;AAGO,IAAM,YAAY,CAAC,MAAY;AAClC,QAAM,OAAO,GAAG,EAAE,IAAI;AACtB,QAAM,MAAM,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,YAAY,MAAM,EAAE,MAAM,UAAU,EAAE,SAAS;AAE1F,QAAM,KAAK,EAAE,KAAK,EAAE,QAAQ,YAAY,EAAE,YAAY,UAAU,EAAE,SAAS;AAC3E,QAAM,OAAO,CAAI,MAAc,MAA+B,WAC1D,KAAQ,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,QAAQ,QAAQ,MAAM,KAAK,UAAU,EAAE,GAAG,KAAK,GAAG,KAAK,CAAC,EAAE,GAAG,MAAM;AACnG,SAAO;AAAA,IACH,MAAM,CAAC,GAAyD,WAC5D,KAAmB,GAAG,IAAI,aAAa,GAAG,EAAE,GAAG,IAAI,OAAO,EAAE,OAAO,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACnH,MAAM,CAAC,IAAY,WACf,KAAmB,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,QAAW,MAAM;AAAA,IAChG,SAAS,CAAC,WAAyB,KAAsB,GAAG,IAAI,qBAAqB,GAAG,EAAE,CAAC,IAAI,QAAW,MAAM;AAAA,IAChH,WAAW,CAAC,WAAyB,KAAoC,GAAG,IAAI,uBAAuB,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACjJ,QAAQ,CAAC,MAAuD,KAAmB,aAAa,CAAC;AAAA,IACjG,MAAM,CAAC,OAAe,KAAwC,aAAa,mBAAmB,EAAE,CAAC,SAAS,CAAC,CAAC;AAAA,IAC5G,UAAU,CAAC,IAAY,WACnB,KAAsC,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,aAAa,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IAC3I,SAAS,CAAC,IAAY,SAAiB,KAAsB,aAAa,mBAAmB,EAAE,CAAC,aAAa,EAAE,KAAK,CAAC;AAAA,IACrH,QAAQ,CAAC,KAAa,WAClB,KAA0C,GAAG,IAAI,YAAY,GAAG,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACxG,MAAM,CAAC,OAAe,KAAc,YAAY,mBAAmB,EAAE,CAAC,SAAS,EAAE,MAAM,OAAU,CAAC;AAAA,IAClG,SAAS,CAAC,IAAY,MAClB,KAAc,YAAY,mBAAmB,EAAE,CAAC,YAAY,CAAC;AAAA,IACjE,MAAM,CAAC,WAAyB,KAAiB,GAAG,IAAI,aAAa,GAAG,EAAE,CAAC,IAAI,QAAW,MAAM;AAAA;AAAA,IAEhG,UAAU,CAAC,MAAqG,KAAiB,aAAa,CAAC;AAAA;AAAA,IAE/I,gBAAgB,CAAC,MAAkB,WAAyB;AACxD,YAAM,OAAO,IAAI,SAAS;AAC1B,WAAK,OAAO,OAAO,EAAE,MAAM;AAC3B,WAAK,OAAO,cAAc,EAAE,UAAU;AACtC,UAAI,EAAE,SAAU,MAAK,OAAO,YAAY,EAAE,QAAQ;AAClD,UAAI,SAAS,KAAM,MAAK,OAAO,QAAQ,IAAuB;AAAA,UACzD,MAAK,OAAO,QAAQ,MAAO,KAAkC,QAAQ,MAAM;AAChF,aAAO,KAAe,GAAG,IAAI,yBAAyB,EAAE,QAAQ,QAAQ,MAAM,KAAK,GAAG,MAAM;AAAA,IAChG;AAAA;AAAA,IAEA,eAAe,CAAC,OAAe,GAAG,IAAI,yBAAyB,mBAAmB,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC;AAAA,IAC/F,UAAU,CAAC,GAAY,WAAyB,KAAqC,GAAG,IAAI,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IACtJ,SAAS,CAAC,IAAY,WAClB,KAAc,GAAG,IAAI,aAAa,mBAAmB,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,QAAW,MAAM;AAAA,IAC3F,eAAe,CAAC,WAAyB,KAAoB,GAAG,IAAI,cAAc,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,QAAW,MAAM;AAAA,IAC5H,aAAa,CAAC,IAAY,YAAqB,KAA2B,aAAa,mBAAmB,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;AAAA,EACrI;AACJ;","names":[]}

package/dist/api.d.ts

@@ -9,5 +9,8 @@ export interface Writer {
         email?: string;
     };
 }
-/** The client for the provider's key, host and visitor, or for `as` when given. */
+/**
+ * The client for the provider's key, host and visitor, or for `as` when given. The visitor's identity hash goes along;
+ * `as` (a board identity the visitor typed in) is no signed user and goes without.
+ */
 export declare const useApi: (as?: Writer | null) => Api;

package/dist/api.js

@@ -7,8 +7,9 @@ var useApi = (as) => {
   const ctx = useCtx();
   const distinctId = as?.distinctId ?? ctx.distinctId;
   const user = as ? as.user : ctx.user;
+  const userHash = as ? void 0 : ctx.userHash;
   const { apiKey, host } = ctx;
-  return useMemo(() => createApi({ apiKey, host, distinctId, user }), [apiKey, host, distinctId, user]);
+  return useMemo(() => createApi({ apiKey, host, distinctId, user, userHash }), [apiKey, host, distinctId, user, userHash]);
 };
 export {
   useApi

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/api.ts"],"sourcesContent":["import { useMemo } from \"react\";\nimport { type Api, createApi } from \"./api-client\";\nimport { useCtx } from \"./context\";\n\nexport * from \"./api-client\";\n\n/** Who writes: the provider's visitor, or the name and email a visitor gave the board (see useBoardIdentity). */\nexport interface Writer {\n    distinctId: string;\n    user?: { id?: string; name?: string; email?: string };\n}\n\n/** The client for the provider's key, host and visitor, or for `as` when given. */\nexport const useApi = (as?: Writer | null): Api => {\n    const ctx = useCtx();\n    const distinctId = as?.distinctId ?? ctx.distinctId;\n    const user = as ? as.user : ctx.user;\n    const { apiKey, host } = ctx;\n    return useMemo(() => createApi({ apiKey, host, distinctId, user }), [apiKey, host, distinctId, user]);\n};\n"],"mappings":";AAAA,SAAS,eAAe;AACxB,SAAmB,iBAAiB;AACpC,SAAS,cAAc;AAEvB,cAAc;AASP,IAAM,SAAS,CAAC,OAA4B;AAC/C,QAAM,MAAM,OAAO;AACnB,QAAM,aAAa,IAAI,cAAc,IAAI;AACzC,QAAM,OAAO,KAAK,GAAG,OAAO,IAAI;AAChC,QAAM,EAAE,QAAQ,KAAK,IAAI;AACzB,SAAO,QAAQ,MAAM,UAAU,EAAE,QAAQ,MAAM,YAAY,KAAK,CAAC,GAAG,CAAC,QAAQ,MAAM,YAAY,IAAI,CAAC;AACxG;","names":[]}
+{"version":3,"sources":["../src/api.ts"],"sourcesContent":["import { useMemo } from \"react\";\nimport { type Api, createApi } from \"./api-client\";\nimport { useCtx } from \"./context\";\n\nexport * from \"./api-client\";\n\n/** Who writes: the provider's visitor, or the name and email a visitor gave the board (see useBoardIdentity). */\nexport interface Writer {\n    distinctId: string;\n    user?: { id?: string; name?: string; email?: string };\n}\n\n/**\n * The client for the provider's key, host and visitor, or for `as` when given. The visitor's identity hash goes along;\n * `as` (a board identity the visitor typed in) is no signed user and goes without.\n */\nexport const useApi = (as?: Writer | null): Api => {\n    const ctx = useCtx();\n    const distinctId = as?.distinctId ?? ctx.distinctId;\n    const user = as ? as.user : ctx.user;\n    const userHash = as ? undefined : ctx.userHash;\n    const { apiKey, host } = ctx;\n    return useMemo(() => createApi({ apiKey, host, distinctId, user, userHash }), [apiKey, host, distinctId, user, userHash]);\n};\n"],"mappings":";AAAA,SAAS,eAAe;AACxB,SAAmB,iBAAiB;AACpC,SAAS,cAAc;AAEvB,cAAc;AAYP,IAAM,SAAS,CAAC,OAA4B;AAC/C,QAAM,MAAM,OAAO;AACnB,QAAM,aAAa,IAAI,cAAc,IAAI;AACzC,QAAM,OAAO,KAAK,GAAG,OAAO,IAAI;AAChC,QAAM,WAAW,KAAK,SAAY,IAAI;AACtC,QAAM,EAAE,QAAQ,KAAK,IAAI;AACzB,SAAO,QAAQ,MAAM,UAAU,EAAE,QAAQ,MAAM,YAAY,MAAM,SAAS,CAAC,GAAG,CAAC,QAAQ,MAAM,YAAY,MAAM,QAAQ,CAAC;AAC5H;","names":[]}

package/dist/batch.d.ts

@@ -23,11 +23,13 @@ export interface BatchRequest<E> {
 }
 /**
  * Splits events into request bodies of at most 100 events each, under the size limit. An event too large on its own is
- * dropped (it is in no request).
+ * dropped (it is in no request). `userHash` (0.16.0) is the identity hash of the signed-in person: one per request, and
+ * MRRocket checks it against each event's `distinctId`, so only that person's events count as verified.
  */
-export declare const batchRequests: <E extends CockpitEvent>(key: string, events: E[], sdk: SdkInfo) => BatchRequest<E>[];
+export declare const batchRequests: <E extends CockpitEvent>(key: string, events: E[], sdk: SdkInfo, userHash?: string) => BatchRequest<E>[];
 /**
  * Request bodies of at most 100 events each, under the size limit. An event too large on its own is dropped. `sdk` tells
- * MRRocket which SDK the site runs and whether it reports errors (Build › Errors and Feature flags show it).
+ * MRRocket which SDK the site runs and whether it reports errors (Build › Errors and Feature flags show it); `userHash`
+ * as in `batchRequests`.
  */
-export declare const bodies: (key: string, events: CockpitEvent[], sdk: SdkInfo) => string[];
+export declare const bodies: (key: string, events: CockpitEvent[], sdk: SdkInfo, userHash?: string) => string[];

package/dist/batch.js

@@ -14,8 +14,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 = [];
@@ -39,7 +39,7 @@ var batchRequests = (key, events, sdk) => {
   close();
   return out;
 };
-var bodies = (key, events, sdk) => batchRequests(key, events, sdk).map((r) => r.body);
+var bodies = (key, events, sdk, userHash) => batchRequests(key, events, sdk, userHash).map((r) => r.body);
 export {
   MAX_BATCH,
   MAX_BYTES,

package/dist/batch.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/batch.ts"],"sourcesContent":["/**\n * How events go over the wire to `POST /api/sdk/events`, shared by every runtime (Next.js, the script tag, React\n * Native): request bodies of at most 100 events each, under the server's 64 KB. No React, no browser APIs, no\n * TextEncoder (Hermes on older React Native lacks it), so it runs anywhere.\n */\nimport type { CockpitEvent } from \"./core\";\n\n/** The server takes at most 100 events and 64 KB per request; stay a little under the size. */\nexport const MAX_BATCH = 100;\nexport const MAX_BYTES = 60_000;\n\n/** What a batch says about the SDK that sent it (Build › Errors and Feature flags show it). */\nexport interface SdkInfo {\n    v: string;\n    errors: boolean;\n    /** \"web\" (script tag), \"ios\" or \"android\" (React Native). Missing from the Next.js provider. */\n    platform?: string;\n}\n\n/** UTF-8 length of a string, the way TextEncoder counts it (a lone surrogate becomes U+FFFD, three bytes). */\nexport const byteLength = (s: string) => {\n    let n = 0;\n    for (let i = 0; i < s.length; i++) {\n        const c = s.charCodeAt(i);\n        if (c < 0x80) n += 1;\n        else if (c < 0x800) n += 2;\n        else if (c >= 0xd800 && c <= 0xdbff && i + 1 < s.length && (s.charCodeAt(i + 1) & 0xfc00) === 0xdc00) {\n            n += 4;\n            i++;\n        } else n += 3;\n    }\n    return n;\n};\n\n/** One request: its body and the events in it (so a client can keep the ones that did not arrive). */\nexport interface BatchRequest<E> {\n    body: string;\n    events: E[];\n}\n\n/**\n * Splits events into request bodies of at most 100 events each, under the size limit. An event too large on its own is\n * dropped (it is in no request).\n */\nexport const batchRequests = <E extends CockpitEvent>(key: string, events: E[], sdk: SdkInfo): BatchRequest<E>[] => {\n    const head = `{\"key\":${JSON.stringify(key)},\"sdk\":${JSON.stringify(sdk)},\"events\":[`;\n    const empty = byteLength(head) + 2;\n    const out: BatchRequest<E>[] = [];\n    let chunk: string[] = [];\n    let items: E[] = [];\n    let size = empty;\n    const close = () => {\n        if (chunk.length) out.push({ body: `${head}${chunk.join(\",\")}]}`, events: items });\n        chunk = [];\n        items = [];\n        size = empty;\n    };\n    for (const event of events) {\n        const json = JSON.stringify(event);\n        const n = byteLength(json) + 1;\n        if (empty + n > MAX_BYTES) continue;\n        if (chunk.length === MAX_BATCH || size + n > MAX_BYTES) close();\n        chunk.push(json);\n        items.push(event);\n        size += n;\n    }\n    close();\n    return out;\n};\n\n/**\n * Request bodies of at most 100 events each, under the size limit. An event too large on its own is dropped. `sdk` tells\n * MRRocket which SDK the site runs and whether it reports errors (Build › Errors and Feature flags show it).\n */\nexport const bodies = (key: string, events: CockpitEvent[], sdk: SdkInfo) => batchRequests(key, events, sdk).map((r) => r.body);\n"],"mappings":";AAQO,IAAM,YAAY;AAClB,IAAM,YAAY;AAWlB,IAAM,aAAa,CAAC,MAAc;AACrC,MAAI,IAAI;AACR,WAAS,IAAI,GAAG,IAAI,EAAE,QAAQ,KAAK;AAC/B,UAAM,IAAI,EAAE,WAAW,CAAC;AACxB,QAAI,IAAI,IAAM,MAAK;AAAA,aACV,IAAI,KAAO,MAAK;AAAA,aAChB,KAAK,SAAU,KAAK,SAAU,IAAI,IAAI,EAAE,WAAW,EAAE,WAAW,IAAI,CAAC,IAAI,WAAY,OAAQ;AAClG,WAAK;AACL;AAAA,IACJ,MAAO,MAAK;AAAA,EAChB;AACA,SAAO;AACX;AAYO,IAAM,gBAAgB,CAAyB,KAAa,QAAa,QAAoC;AAChH,QAAM,OAAO,UAAU,KAAK,UAAU,GAAG,CAAC,UAAU,KAAK,UAAU,GAAG,CAAC;AACvE,QAAM,QAAQ,WAAW,IAAI,IAAI;AACjC,QAAM,MAAyB,CAAC;AAChC,MAAI,QAAkB,CAAC;AACvB,MAAI,QAAa,CAAC;AAClB,MAAI,OAAO;AACX,QAAM,QAAQ,MAAM;AAChB,QAAI,MAAM,OAAQ,KAAI,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,KAAK,GAAG,CAAC,MAAM,QAAQ,MAAM,CAAC;AACjF,YAAQ,CAAC;AACT,YAAQ,CAAC;AACT,WAAO;AAAA,EACX;AACA,aAAW,SAAS,QAAQ;AACxB,UAAM,OAAO,KAAK,UAAU,KAAK;AACjC,UAAM,IAAI,WAAW,IAAI,IAAI;AAC7B,QAAI,QAAQ,IAAI,UAAW;AAC3B,QAAI,MAAM,WAAW,aAAa,OAAO,IAAI,UAAW,OAAM;AAC9D,UAAM,KAAK,IAAI;AACf,UAAM,KAAK,KAAK;AAChB,YAAQ;AAAA,EACZ;AACA,QAAM;AACN,SAAO;AACX;AAMO,IAAM,SAAS,CAAC,KAAa,QAAwB,QAAiB,cAAc,KAAK,QAAQ,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI;","names":[]}
+{"version":3,"sources":["../src/batch.ts"],"sourcesContent":["/**\n * How events go over the wire to `POST /api/sdk/events`, shared by every runtime (Next.js, the script tag, React\n * Native): request bodies of at most 100 events each, under the server's 64 KB. No React, no browser APIs, no\n * TextEncoder (Hermes on older React Native lacks it), so it runs anywhere.\n */\nimport type { CockpitEvent } from \"./core\";\n\n/** The server takes at most 100 events and 64 KB per request; stay a little under the size. */\nexport const MAX_BATCH = 100;\nexport const MAX_BYTES = 60_000;\n\n/** What a batch says about the SDK that sent it (Build › Errors and Feature flags show it). */\nexport interface SdkInfo {\n    v: string;\n    errors: boolean;\n    /** \"web\" (script tag), \"ios\" or \"android\" (React Native). Missing from the Next.js provider. */\n    platform?: string;\n}\n\n/** UTF-8 length of a string, the way TextEncoder counts it (a lone surrogate becomes U+FFFD, three bytes). */\nexport const byteLength = (s: string) => {\n    let n = 0;\n    for (let i = 0; i < s.length; i++) {\n        const c = s.charCodeAt(i);\n        if (c < 0x80) n += 1;\n        else if (c < 0x800) n += 2;\n        else if (c >= 0xd800 && c <= 0xdbff && i + 1 < s.length && (s.charCodeAt(i + 1) & 0xfc00) === 0xdc00) {\n            n += 4;\n            i++;\n        } else n += 3;\n    }\n    return n;\n};\n\n/** One request: its body and the events in it (so a client can keep the ones that did not arrive). */\nexport interface BatchRequest<E> {\n    body: string;\n    events: E[];\n}\n\n/**\n * Splits events into request bodies of at most 100 events each, under the size limit. An event too large on its own is\n * dropped (it is in no request). `userHash` (0.16.0) is the identity hash of the signed-in person: one per request, and\n * MRRocket checks it against each event's `distinctId`, so only that person's events count as verified.\n */\nexport const batchRequests = <E extends CockpitEvent>(key: string, events: E[], sdk: SdkInfo, userHash?: string): BatchRequest<E>[] => {\n    const head = `{\"key\":${JSON.stringify(key)},${userHash ? `\"userHash\":${JSON.stringify(userHash)},` : \"\"}\"sdk\":${JSON.stringify(sdk)},\"events\":[`;\n    const empty = byteLength(head) + 2;\n    const out: BatchRequest<E>[] = [];\n    let chunk: string[] = [];\n    let items: E[] = [];\n    let size = empty;\n    const close = () => {\n        if (chunk.length) out.push({ body: `${head}${chunk.join(\",\")}]}`, events: items });\n        chunk = [];\n        items = [];\n        size = empty;\n    };\n    for (const event of events) {\n        const json = JSON.stringify(event);\n        const n = byteLength(json) + 1;\n        if (empty + n > MAX_BYTES) continue;\n        if (chunk.length === MAX_BATCH || size + n > MAX_BYTES) close();\n        chunk.push(json);\n        items.push(event);\n        size += n;\n    }\n    close();\n    return out;\n};\n\n/**\n * Request bodies of at most 100 events each, under the size limit. An event too large on its own is dropped. `sdk` tells\n * MRRocket which SDK the site runs and whether it reports errors (Build › Errors and Feature flags show it); `userHash`\n * as in `batchRequests`.\n */\nexport const bodies = (key: string, events: CockpitEvent[], sdk: SdkInfo, userHash?: string) => batchRequests(key, events, sdk, userHash).map((r) => r.body);\n"],"mappings":";AAQO,IAAM,YAAY;AAClB,IAAM,YAAY;AAWlB,IAAM,aAAa,CAAC,MAAc;AACrC,MAAI,IAAI;AACR,WAAS,IAAI,GAAG,IAAI,EAAE,QAAQ,KAAK;AAC/B,UAAM,IAAI,EAAE,WAAW,CAAC;AACxB,QAAI,IAAI,IAAM,MAAK;AAAA,aACV,IAAI,KAAO,MAAK;AAAA,aAChB,KAAK,SAAU,KAAK,SAAU,IAAI,IAAI,EAAE,WAAW,EAAE,WAAW,IAAI,CAAC,IAAI,WAAY,OAAQ;AAClG,WAAK;AACL;AAAA,IACJ,MAAO,MAAK;AAAA,EAChB;AACA,SAAO;AACX;AAaO,IAAM,gBAAgB,CAAyB,KAAa,QAAa,KAAc,aAAyC;AACnI,QAAM,OAAO,UAAU,KAAK,UAAU,GAAG,CAAC,IAAI,WAAW,cAAc,KAAK,UAAU,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,UAAU,GAAG,CAAC;AACnI,QAAM,QAAQ,WAAW,IAAI,IAAI;AACjC,QAAM,MAAyB,CAAC;AAChC,MAAI,QAAkB,CAAC;AACvB,MAAI,QAAa,CAAC;AAClB,MAAI,OAAO;AACX,QAAM,QAAQ,MAAM;AAChB,QAAI,MAAM,OAAQ,KAAI,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,KAAK,GAAG,CAAC,MAAM,QAAQ,MAAM,CAAC;AACjF,YAAQ,CAAC;AACT,YAAQ,CAAC;AACT,WAAO;AAAA,EACX;AACA,aAAW,SAAS,QAAQ;AACxB,UAAM,OAAO,KAAK,UAAU,KAAK;AACjC,UAAM,IAAI,WAAW,IAAI,IAAI;AAC7B,QAAI,QAAQ,IAAI,UAAW;AAC3B,QAAI,MAAM,WAAW,aAAa,OAAO,IAAI,UAAW,OAAM;AAC9D,UAAM,KAAK,IAAI;AACf,UAAM,KAAK,KAAK;AAChB,YAAQ;AAAA,EACZ;AACA,QAAM;AACN,SAAO;AACX;AAOO,IAAM,SAAS,CAAC,KAAa,QAAwB,KAAc,aAAsB,cAAc,KAAK,QAAQ,KAAK,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI;","names":[]}