@sensiblestats/widget-sdk 0.74.0 → 0.75.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sensiblestats/widget-sdk
 
+## 0.75.0
+
+### Minor Changes
+
+- Personal greeting sections, a Favourites tab, and a combo_add event when a builder combo is added to the slip.
+
+## 0.74.1
+
+### Patch Changes
+
+- Send the visitor ids (`operatorUserId`, `anonymousUserId`) in the `X-SS-Operator-User-Id` and `X-SS-Anonymous-User-Id` request headers on every gateway call instead of the query string and JSON body. Blank ids, and ids the gateway would reject (non-ASCII or over 128 characters), send no header; `sendSignal` then falls back to the anonymous id. Public function signatures are unchanged.
+
 ## 0.74.0
 
 ### Minor Changes

package/README.md

@@ -22,13 +22,17 @@ for await (const ev of client.chat({ message: 'odds for Arsenal?' })) {
 await client.chat({ message: 'odds for Arsenal?' }, { onAnswer: a => render(a.text) })
 
 // Multi-turn
-const convo = client.conversation({ operatorUserId: 'u_42' })
+const convo = client.conversation({ operatorUserId: '6f1c2a9e-4b7d-4e2a-9c3f-8a5d1e7b2c40' })
 await convo.send({ message: 'and their recent form?' })
 
 // Signals
-await client.sendSignal({ signalType: 'MatchPageView', entityType: 'Match', entityName: 'Arsenal vs Chelsea', operatorUserId: 'u_42' })
+await client.sendSignal({ signalType: 'MatchPageView', entityType: 'Match', entityName: 'Arsenal vs Chelsea', operatorUserId: '6f1c2a9e-4b7d-4e2a-9c3f-8a5d1e7b2c40' })
 ```
 
+Visitor ids (`operatorUserId`, `anonymousUserId`) are passed to the SDK as before. On the wire they travel in the `X-SS-Operator-User-Id` and `X-SS-Anonymous-User-Id` request headers on every gateway call, never in the URL or the JSON body; a blank id sends no header. Ids must be printable ASCII, at most 128 characters (surrounding spaces are trimmed); an id that does not qualify is not sent, as if it were blank.
+
+`operatorUserId` is sent from the browser: use a random, non-guessable value you map to the user on your side (a UUID works), never an account number, email, username or sequential id.
+
 Page grounding: `ChatInput.page` is a `PageContext` (`{ sport: 'football' | 'nba', kind?: 'section' | 'competition' | 'match', matchId?, competitionId? }`). Send it on the session-start greeting only; the server ignores it on any other request. `ChatGrounding.sport` names the sport of a tapped grounding. Greeting dashboard tiles may carry `meta` (a short line in the hero's top row where a price would go) and `imageCodes` (team abbreviations drawn as text marks when there are no images).
 
 Errors are typed: `AuthError` (401), `ForbiddenError` (403), `RateLimitError` (429), `UpstreamError` (5xx), `NetworkError`, `ParseError`.

package/dist/index.cjs

@@ -110,6 +110,23 @@ function headersFor(cfg, json) {
   if (cfg.client) h["X-SS-Client"] = cfg.client;
   return h;
 }
+var OPERATOR_USER_ID_HEADER = "X-SS-Operator-User-Id";
+var ANONYMOUS_USER_ID_HEADER = "X-SS-Anonymous-User-Id";
+var SENDABLE_ID = /^[\x20-\x7E]{1,128}$/;
+function isSendableId(id) {
+  const v = id?.trim();
+  return !!v && SENDABLE_ID.test(v);
+}
+function identityHeaders(operatorUserId, anonymousUserId) {
+  const h = {};
+  if (isSendableId(operatorUserId)) h[OPERATOR_USER_ID_HEADER] = operatorUserId.trim();
+  if (isSendableId(anonymousUserId)) h[ANONYMOUS_USER_ID_HEADER] = anonymousUserId.trim();
+  return h;
+}
+function splitIdentity(body) {
+  const { operatorUserId, anonymousUserId, ...rest } = body;
+  return { identity: identityHeaders(operatorUserId, anonymousUserId), rest };
+}
 function endpoint(cfg, path) {
   return `${cfg.baseUrl.replace(/\/+$/, "")}/v1/${encodeURIComponent(cfg.operatorId)}/${path}`;
 }
@@ -151,11 +168,11 @@ async function chatError(res) {
 function isAbort(error) {
   return error instanceof Error && error.name === "AbortError";
 }
-async function send(cfg, path, body, signal) {
+async function send(cfg, path, body, signal, identity = {}) {
   try {
     return await cfg.fetch(endpoint(cfg, path), {
       method: "POST",
-      headers: headersFor(cfg, true),
+      headers: { ...headersFor(cfg, true), ...identity },
       body: JSON.stringify(body),
       signal
     });
@@ -165,24 +182,35 @@ async function send(cfg, path, body, signal) {
   }
 }
 async function postChat(cfg, input, signal) {
-  const res = await send(cfg, "chat", input, signal);
+  const { userContext, ...rest } = input;
+  let body = rest;
+  let identity = {};
+  if (userContext) {
+    const split = splitIdentity(userContext);
+    identity = split.identity;
+    body = Object.keys(split.rest).length > 0 ? { ...rest, userContext: split.rest } : rest;
+  }
+  const res = await send(cfg, "chat", body, signal, identity);
   if (!res.ok || res.body == null) throw await chatError(res);
   return res;
 }
 async function postSignal(cfg, wireBody, signal) {
-  const res = await send(cfg, "signals", wireBody, signal);
+  const { identity, rest } = splitIdentity(wireBody);
+  const res = await send(cfg, "signals", rest, signal, identity);
   if (!res.ok) throw toWidgetError(res.status, res.headers.get("Retry-After"));
 }
 async function postEvents(cfg, batch) {
-  const res = await send(cfg, "events", batch);
+  const { identity, rest } = splitIdentity(batch);
+  const res = await send(cfg, "events", rest, void 0, identity);
   if (!res.ok) throw toWidgetError(res.status, res.headers.get("Retry-After"));
 }
 function postEventsKeepalive(cfg, batch) {
   try {
+    const { identity, rest } = splitIdentity(batch);
     void cfg.fetch(endpoint(cfg, "events"), {
       method: "POST",
-      headers: headersFor(cfg, true),
-      body: JSON.stringify(batch),
+      headers: { ...headersFor(cfg, true), ...identity },
+      body: JSON.stringify(rest),
       keepalive: true
     }).catch(() => {
     });
@@ -232,8 +260,8 @@ async function postPlayerProps(cfg, matchId, sport) {
 async function postSchedule(cfg, localDate, utcOffsetMinutes, operatorUserId, anonymousUserId) {
   const res = await cfg.fetch(endpoint(cfg, "live-monitor/schedule"), {
     method: "POST",
-    headers: headersFor(cfg, true),
-    body: JSON.stringify({ localDate, utcOffsetMinutes, sports: ["basketball", "americanfootball"], operatorUserId, anonymousUserId })
+    headers: { ...headersFor(cfg, true), ...identityHeaders(operatorUserId, anonymousUserId) },
+    body: JSON.stringify({ localDate, utcOffsetMinutes, sports: ["basketball", "americanfootball"] })
   });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`live-monitor/schedule ${res.status}`);
@@ -242,8 +270,8 @@ async function postSchedule(cfg, localDate, utcOffsetMinutes, operatorUserId, an
 async function postLeagueStar(cfg, competitionId, starred, operatorUserId, anonymousUserId) {
   const res = await cfg.fetch(endpoint(cfg, `leagues/${competitionId}/star`), {
     method: "POST",
-    headers: headersFor(cfg, true),
-    body: JSON.stringify({ starred, operatorUserId, anonymousUserId })
+    headers: { ...headersFor(cfg, true), ...identityHeaders(operatorUserId, anonymousUserId) },
+    body: JSON.stringify({ starred })
   });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`leagues/star ${res.status}`);
@@ -268,7 +296,7 @@ function q(parts) {
   return kept.length ? `?${kept.join("&")}` : "";
 }
 async function getGames(cfg, operatorUserId, gameDay) {
-  const res = await cfg.fetch(endpoint(cfg, "games" + q({ operatorUserId, gameDay })), { method: "GET", headers: headersFor(cfg, false) });
+  const res = await cfg.fetch(endpoint(cfg, "games" + q({ gameDay })), { method: "GET", headers: { ...headersFor(cfg, false), ...identityHeaders(operatorUserId) } });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`games ${res.status}`);
   return await res.json();
@@ -280,23 +308,24 @@ async function getGameConfig(cfg, gameId, fixtureId, gameDay, locale) {
   return await res.json();
 }
 async function getGameResult(cfg, gameId, operatorUserId, fixtureId, gameDay, locale) {
-  const res = await cfg.fetch(endpoint(cfg, `games/${encodeURIComponent(gameId)}/result` + q({ operatorUserId, fixtureId, gameDay, locale })), { method: "GET", headers: headersFor(cfg, false) });
+  const res = await cfg.fetch(endpoint(cfg, `games/${encodeURIComponent(gameId)}/result` + q({ fixtureId, gameDay, locale })), { method: "GET", headers: { ...headersFor(cfg, false), ...identityHeaders(operatorUserId) } });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`game-result ${res.status}`);
   return await res.json();
 }
 async function postPlay(cfg, gameId, body, locale) {
+  const { identity, rest } = splitIdentity(body);
   const res = await cfg.fetch(endpoint(cfg, `games/${encodeURIComponent(gameId)}/plays` + q({ locale })), {
     method: "POST",
-    headers: headersFor(cfg, true),
-    body: JSON.stringify(body)
+    headers: { ...headersFor(cfg, true), ...identity },
+    body: JSON.stringify(rest)
   });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`play ${res.status}`);
   return await res.json();
 }
 async function getLeaderboard(cfg, operatorUserId, week) {
-  const res = await cfg.fetch(endpoint(cfg, "games/leaderboard" + q({ operatorUserId, week })), { method: "GET", headers: headersFor(cfg, false) });
+  const res = await cfg.fetch(endpoint(cfg, "games/leaderboard" + q({ week })), { method: "GET", headers: { ...headersFor(cfg, false), ...identityHeaders(operatorUserId) } });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`leaderboard ${res.status}`);
   return await res.json();
@@ -338,11 +367,68 @@ async function getClubRecords(cfg, limit) {
   return await res.json();
 }
 async function getPricePresets(cfg, locale, operatorUserId, options) {
-  const res = await cfg.fetch(endpoint(cfg, "price-presets" + q({ locale, operatorUserId, pool: options?.pool })), { method: "GET", headers: headersFor(cfg, false) });
+  const res = await cfg.fetch(endpoint(cfg, "price-presets" + q({ locale, pool: options?.pool })), { method: "GET", headers: { ...headersFor(cfg, false), ...identityHeaders(operatorUserId) } });
   if (res.status === 404) return null;
   if (!res.ok) throw new Error(`price-presets ${res.status}`);
   return await res.json();
 }
+async function getBuilderGrid(cfg, locale, req) {
+  const query = q({
+    locale,
+    sport: req.sport,
+    legs: req.legs,
+    total: req.total,
+    marketKey: req.marketKey ?? void 0,
+    matchIds: req.widen ? void 0 : req.matchIds.join(","),
+    widen: req.widen ? "true" : void 0
+  });
+  const res = await cfg.fetch(endpoint(cfg, "price-presets" + query), {
+    method: "GET",
+    headers: { ...headersFor(cfg, false), ...identityHeaders(req.operatorUserId, req.anonymousUserId) }
+  });
+  if (res.status === 404) return null;
+  if (!res.ok) throw new Error(`price-presets ${res.status}`);
+  return await res.json();
+}
+function favouritePath(kind, id) {
+  return `favourites/${encodeURIComponent(kind)}/${encodeURIComponent(id)}`;
+}
+function favouritesFetch(cfg, method, path, operatorUserId, anonymousUserId) {
+  return cfg.fetch(endpoint(cfg, path), { method, headers: { ...headersFor(cfg, false), ...identityHeaders(operatorUserId, anonymousUserId) } });
+}
+async function getFavourites(cfg, sport, operatorUserId, anonymousUserId) {
+  const res = await favouritesFetch(cfg, "GET", "favourites" + q({ sport }), operatorUserId, anonymousUserId);
+  if (res.status === 400) {
+    const body = await res.json().catch(() => null);
+    return body?.code === "NoAcceptedIdentity" ? "noAcceptedIdentity" : null;
+  }
+  if (!res.ok) return null;
+  return await res.json();
+}
+var MIN_FAVOURITES_QUERY = 2;
+async function searchFavourites(cfg, sport, query, kind, operatorUserId, anonymousUserId) {
+  const text = query.trim();
+  if (text.length < MIN_FAVOURITES_QUERY) return [];
+  const res = await favouritesFetch(cfg, "GET", "favourites/search" + q({ sport, q: text, kind }), operatorUserId, anonymousUserId);
+  if (!res.ok) return null;
+  return (await res.json()).results;
+}
+async function putFavourite(cfg, kind, id, operatorUserId, anonymousUserId) {
+  const res = await favouritesFetch(cfg, "PUT", favouritePath(kind, id), operatorUserId, anonymousUserId);
+  if (res.ok) return await res.json();
+  if (res.status !== 409) return null;
+  const body = await res.json().catch(() => null);
+  return body?.status === "atCap" ? { status: "atCap", count: body.count, cap: body.cap } : null;
+}
+async function deleteFavourite(cfg, kind, id, operatorUserId, anonymousUserId) {
+  return (await favouritesFetch(cfg, "DELETE", favouritePath(kind, id), operatorUserId, anonymousUserId)).ok;
+}
+async function clearFavourites(cfg, sport, operatorUserId, anonymousUserId) {
+  return (await favouritesFetch(cfg, "DELETE", "favourites" + q({ sport }), operatorUserId, anonymousUserId)).ok;
+}
+async function hideFavourite(cfg, kind, id, operatorUserId, anonymousUserId) {
+  return (await favouritesFetch(cfg, "POST", `${favouritePath(kind, id)}/hide`, operatorUserId, anonymousUserId)).ok;
+}
 
 // src/ndjson.ts
 function parseLine(line) {
@@ -538,7 +624,7 @@ var Conversation = class {
   }
   sendSignal(input) {
     const operatorUserId = input.operatorUserId ?? this.context?.operatorUserId;
-    const anonymousUserId = operatorUserId ? void 0 : input.anonymousUserId ?? this.context?.anonymousUserId;
+    const anonymousUserId = isSendableId(operatorUserId) ? void 0 : input.anonymousUserId ?? this.context?.anonymousUserId;
     if (!operatorUserId && !anonymousUserId) {
       throw new Error("operatorUserId or anonymousUserId is required (set it on conversation() or pass it to sendSignal)");
     }
@@ -562,12 +648,33 @@ var Conversation = class {
   getPricePresets(locale, options) {
     return getPricePresets(this.cfg, locale, this.context?.operatorUserId, options);
   }
+  getBuilderGrid(locale, req) {
+    return getBuilderGrid(this.cfg, locale, req);
+  }
   getSchedule(localDate, utcOffsetMinutes, operatorUserId, anonymousUserId) {
     return postSchedule(this.cfg, localDate, utcOffsetMinutes, operatorUserId, anonymousUserId);
   }
   starLeague(competitionId, starred, operatorUserId, anonymousUserId) {
     return postLeagueStar(this.cfg, competitionId, starred, operatorUserId, anonymousUserId);
   }
+  getFavourites(sport, operatorUserId, anonymousUserId) {
+    return getFavourites(this.cfg, sport, operatorUserId, anonymousUserId);
+  }
+  searchFavourites(sport, query, kind, operatorUserId, anonymousUserId) {
+    return searchFavourites(this.cfg, sport, query, kind, operatorUserId, anonymousUserId);
+  }
+  putFavourite(kind, id, operatorUserId, anonymousUserId) {
+    return putFavourite(this.cfg, kind, id, operatorUserId, anonymousUserId);
+  }
+  deleteFavourite(kind, id, operatorUserId, anonymousUserId) {
+    return deleteFavourite(this.cfg, kind, id, operatorUserId, anonymousUserId);
+  }
+  clearFavourites(sport, operatorUserId, anonymousUserId) {
+    return clearFavourites(this.cfg, sport, operatorUserId, anonymousUserId);
+  }
+  hideFavourite(kind, id, operatorUserId, anonymousUserId) {
+    return hideFavourite(this.cfg, kind, id, operatorUserId, anonymousUserId);
+  }
   getStates(matchIds, nbaGameIds, nflGameIds) {
     return postStates(this.cfg, matchIds, nbaGameIds, nflGameIds);
   }
@@ -617,7 +724,8 @@ var IMMEDIATE = /* @__PURE__ */ new Set([
   "slip_click",
   "slip_result",
   "slip_remove",
-  "bet_placed"
+  "bet_placed",
+  "combo_add"
 ]);
 var DEFERRED = /* @__PURE__ */ new Set(["match_view"]);
 var DEFAULT_BATCH_INTERVAL_MS = 1e4;