@tiledev/sdk-apptile-live-selling 0.8.0 → 0.9.0

package/dist/commentHistory.d.ts

@@ -0,0 +1,66 @@
+import type { LiveComment } from './types';
+/**
+ * How many of the most recent lines to hand over. The pane shows a handful and scrolls; a rejoining
+ * shopper wants the tail of the conversation, not an hour of it.
+ */
+export declare const COMMENT_HISTORY_WINDOW = 40;
+/**
+ * Asked for wider than the window because the gateway stores every line two to four times: forty
+ * lines can take four times as many rows, and a tighter read would come back with ten.
+ */
+export declare const COMMENT_HISTORY_FETCH_LIMIT: number;
+/**
+ * Two identical lines closer together than this are the store's own copies, not someone saying the
+ * same thing twice. Generous — the copies seen land milliseconds apart — because the costs are
+ * lopsided: collapsing a genuine repeat loses one line, keeping the copies makes the pane look broken.
+ */
+export declare const DUPLICATE_ROW_WINDOW_MS = 5000;
+/**
+ * The name the host dashboard stores the host's OWN lines under. The room broadcasts the same lines
+ * under the brand (`LiveStream.hostName`), and a shopper reading "You" would think they had said it.
+ */
+export declare const HOST_SELF_NAME = "You";
+/** One row of `/live-streaming/comments`. */
+export interface RawHistoryComment {
+    comment_id?: string | number | null;
+    comment?: string | null;
+    user_name?: string | null;
+    source?: string | null;
+    /** The host mutes a viewer for everyone by flagging their lines rather than deleting them. */
+    muted?: boolean | null;
+    /** Milliseconds since the show started; what the rows are ordered by. */
+    relative_timestamp?: number | string | null;
+}
+/**
+ * The gateway's rows as comments, oldest first, the last `COMMENT_HISTORY_WINDOW` of them.
+ *
+ * - Muted lines and empty lines are left out.
+ * - Sorted rather than reversed: the wire is newest first today, but the order is the service's to
+ *   change. Ties keep the order they arrived in.
+ * - A run of identical lines (same speaker, same words) within `DUPLICATE_ROW_WINDOW_MS` of the last
+ *   one kept is one line.
+ * - `isOwn` is false on every line: each stored row carries the HOST account's `user_id`, viewer lines
+ *   included, so nothing says which device wrote it. `mergeCommentHistory` re-marks by name.
+ */
+export declare function toCommentHistory(rows: unknown): LiveComment[];
+export interface CommentHistoryContext {
+    /** `LiveStream.hostName` — what the room calls the host, and what "You" in the history means. */
+    hostName: string | null;
+    /** The name this device comments under (`session.viewerName`), to mark its earlier lines as its own. */
+    ownName: string | null;
+}
+/**
+ * History in front of the comments the room has delivered, with nothing said twice.
+ *
+ * - A history line is dropped when the room already delivered the same speaker saying the same words.
+ *   "You" counts as the host for that comparison, because the dashboard stores the host's lines as
+ *   "You" while the room broadcasts them under the brand — the duplicated "won the Giveaway" line.
+ * - A history line is also dropped when its words match one of this device's own delivered lines,
+ *   whatever name it carries: a comment sent in the same moment as a sign-in can carry another name.
+ * - A kept "You" line is renamed to the host, and a kept USER line under this device's name is marked
+ *   `isOwn`.
+ *
+ * Returns `live` itself when there is nothing to add, so an unchanged list costs no render.
+ */
+export declare function mergeCommentHistory(history: LiveComment[], live: LiveComment[], context: CommentHistoryContext): LiveComment[];
+//# sourceMappingURL=commentHistory.d.ts.map

package/dist/commentHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commentHistory.d.ts","sourceRoot":"","sources":["../src/commentHistory.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAiB,WAAW,EAAE,MAAM,SAAS,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,2BAA2B,QAA6B,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,OAAQ,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8FAA8F;IAC9F,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC7C;AAOD;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,EAAE,CA8B7D;AAED,MAAM,WAAW,qBAAqB;IACpC,iGAAiG;IACjG,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,wGAAwG;IACxG,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EAAE,EACtB,IAAI,EAAE,WAAW,EAAE,EACnB,OAAO,EAAE,qBAAqB,GAC7B,WAAW,EAAE,CAsBf"}

package/dist/commentHistory.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HOST_SELF_NAME = exports.DUPLICATE_ROW_WINDOW_MS = exports.COMMENT_HISTORY_FETCH_LIMIT = exports.COMMENT_HISTORY_WINDOW = void 0;
+exports.toCommentHistory = toCommentHistory;
+exports.mergeCommentHistory = mergeCommentHistory;
+/**
+ * What the room said before this viewer arrived — ported from Freckled Poppy's `liveCommentHistory.ts`
+ * and the merge on its Live screen.
+ *
+ * A live room's comments arrive over the Zego room and nowhere else, so the pane started EMPTY every
+ * time the session did — and the session starts from nothing on every launch. A shopper who reopens the
+ * app comes back to a show they were part of and cannot see a word of it.
+ *
+ * `/live-streaming/comments?streaming_id=…` closes that gap: anonymous, company header only, newest
+ * first, and **filled while the show is on air** (for a finished recording the same route answers an
+ * empty list; a replay's chat comes from the CDN file instead — see `replays.comments`).
+ *
+ * Pure, so it is tested without a room: `toCommentHistory` reads the gateway's rows, and
+ * `mergeCommentHistory` puts them in front of what the room has delivered since.
+ */
+const showNames_1 = require("./showNames");
+/**
+ * How many of the most recent lines to hand over. The pane shows a handful and scrolls; a rejoining
+ * shopper wants the tail of the conversation, not an hour of it.
+ */
+exports.COMMENT_HISTORY_WINDOW = 40;
+/**
+ * Asked for wider than the window because the gateway stores every line two to four times: forty
+ * lines can take four times as many rows, and a tighter read would come back with ten.
+ */
+exports.COMMENT_HISTORY_FETCH_LIMIT = exports.COMMENT_HISTORY_WINDOW * 4;
+/**
+ * Two identical lines closer together than this are the store's own copies, not someone saying the
+ * same thing twice. Generous — the copies seen land milliseconds apart — because the costs are
+ * lopsided: collapsing a genuine repeat loses one line, keeping the copies makes the pane look broken.
+ */
+exports.DUPLICATE_ROW_WINDOW_MS = 5000;
+/**
+ * The name the host dashboard stores the host's OWN lines under. The room broadcasts the same lines
+ * under the brand (`LiveStream.hostName`), and a shopper reading "You" would think they had said it.
+ */
+exports.HOST_SELF_NAME = 'You';
+function toCommentSource(source) {
+    const upper = source === null || source === void 0 ? void 0 : source.trim().toUpperCase();
+    return upper === 'HOST' || upper === 'MODERATOR' || upper === 'TIP' ? upper : 'USER';
+}
+/**
+ * The gateway's rows as comments, oldest first, the last `COMMENT_HISTORY_WINDOW` of them.
+ *
+ * - Muted lines and empty lines are left out.
+ * - Sorted rather than reversed: the wire is newest first today, but the order is the service's to
+ *   change. Ties keep the order they arrived in.
+ * - A run of identical lines (same speaker, same words) within `DUPLICATE_ROW_WINDOW_MS` of the last
+ *   one kept is one line.
+ * - `isOwn` is false on every line: each stored row carries the HOST account's `user_id`, viewer lines
+ *   included, so nothing says which device wrote it. `mergeCommentHistory` re-marks by name.
+ */
+function toCommentHistory(rows) {
+    var _a, _b;
+    if (!Array.isArray(rows))
+        return [];
+    const said = rows
+        .map((raw, index) => ({ raw, index }))
+        .filter((row) => !!row.raw && typeof row.raw.comment === 'string' && !!row.raw.comment.trim() && !row.raw.muted)
+        .map((row) => { var _a; return ({ ...row, atMs: Number((_a = row.raw.relative_timestamp) !== null && _a !== void 0 ? _a : 0) || 0 }); })
+        .sort((a, b) => a.atMs - b.atMs || a.index - b.index);
+    const lastSaidAt = new Map();
+    const kept = [];
+    for (const { raw, index, atMs } of said) {
+        const text = String(raw.comment);
+        // Never an email: the stored rows keep whatever an older app published (`publicName`).
+        const userName = (_a = (0, showNames_1.publicName)(raw.user_name)) !== null && _a !== void 0 ? _a : 'Anonymous';
+        const sameLine = `${userName}\u0000${text}`;
+        const previous = lastSaidAt.get(sameLine);
+        if (previous !== undefined && atMs - previous <= exports.DUPLICATE_ROW_WINDOW_MS)
+            continue;
+        lastSaidAt.set(sameLine, atMs);
+        kept.push({
+            id: `history-${(_b = raw.comment_id) !== null && _b !== void 0 ? _b : index}`,
+            text,
+            userName,
+            source: toCommentSource(raw.source),
+            isOwn: false,
+        });
+    }
+    return kept.slice(-exports.COMMENT_HISTORY_WINDOW);
+}
+/**
+ * History in front of the comments the room has delivered, with nothing said twice.
+ *
+ * - A history line is dropped when the room already delivered the same speaker saying the same words.
+ *   "You" counts as the host for that comparison, because the dashboard stores the host's lines as
+ *   "You" while the room broadcasts them under the brand — the duplicated "won the Giveaway" line.
+ * - A history line is also dropped when its words match one of this device's own delivered lines,
+ *   whatever name it carries: a comment sent in the same moment as a sign-in can carry another name.
+ * - A kept "You" line is renamed to the host, and a kept USER line under this device's name is marked
+ *   `isOwn`.
+ *
+ * Returns `live` itself when there is nothing to add, so an unchanged list costs no render.
+ */
+function mergeCommentHistory(history, live, context) {
+    var _a, _b;
+    if (!history.length)
+        return live;
+    const host = ((_a = context.hostName) === null || _a === void 0 ? void 0 : _a.trim()) || null;
+    const ownName = ((_b = context.ownName) === null || _b === void 0 ? void 0 : _b.trim()) || null;
+    const speaker = (name) => {
+        const trimmed = name.trim();
+        return trimmed === exports.HOST_SELF_NAME && host ? host : trimmed;
+    };
+    const sameLine = (comment) => `${speaker(comment.userName)}\u0000${comment.text}`;
+    const delivered = new Set(live.map(sameLine));
+    const ownWords = new Set(live.filter((comment) => comment.isOwn).map((comment) => comment.text));
+    const earlier = history
+        .filter((comment) => !delivered.has(sameLine(comment)) && !ownWords.has(comment.text))
+        .map((comment) => {
+        const userName = speaker(comment.userName);
+        const isOwn = comment.isOwn || (comment.source === 'USER' && !!ownName && userName === ownName);
+        return userName === comment.userName && isOwn === comment.isOwn
+            ? comment
+            : { ...comment, userName, isOwn };
+    });
+    return earlier.length ? [...earlier, ...live] : live;
+}
+//# sourceMappingURL=commentHistory.js.map

package/dist/commentHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commentHistory.js","sourceRoot":"","sources":["../src/commentHistory.ts"],"names":[],"mappings":";;;AAuEA,4CA8BC;AAsBD,kDA0BC;AArJD;;;;;;;;;;;;;;GAcG;AACH,2CAAyC;AAGzC;;;GAGG;AACU,QAAA,sBAAsB,GAAG,EAAE,CAAC;AAEzC;;;GAGG;AACU,QAAA,2BAA2B,GAAG,8BAAsB,GAAG,CAAC,CAAC;AAEtE;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,IAAK,CAAC;AAE7C;;;GAGG;AACU,QAAA,cAAc,GAAG,KAAK,CAAC;AAcpC,SAAS,eAAe,CAAC,MAAiC;IACxD,MAAM,KAAK,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,GAAG,WAAW,EAAE,CAAC;IAC3C,OAAO,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;AACvF,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAAC,IAAa;;IAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,IAAI,GAAI,IAAqC;SAChD,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;SACrC,MAAM,CACL,CAAC,GAAG,EAAoD,EAAE,CACxD,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CACjG;SACA,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAC,OAAA,CAAC,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,MAAA,GAAG,CAAC,GAAG,CAAC,kBAAkB,mCAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,EAAA,CAAC;SAC9E,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAExD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,MAAM,IAAI,GAAkB,EAAE,CAAC;IAC/B,KAAK,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjC,uFAAuF;QACvF,MAAM,QAAQ,GAAG,MAAA,IAAA,sBAAU,EAAC,GAAG,CAAC,SAAS,CAAC,mCAAI,WAAW,CAAC;QAC1D,MAAM,QAAQ,GAAG,GAAG,QAAQ,SAAS,IAAI,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,IAAI,GAAG,QAAQ,IAAI,+BAAuB;YAAE,SAAS;QACnF,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC;YACR,EAAE,EAAE,WAAW,MAAA,GAAG,CAAC,UAAU,mCAAI,KAAK,EAAE;YACxC,IAAI;YACJ,QAAQ;YACR,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC;YACnC,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,8BAAsB,CAAC,CAAC;AAC7C,CAAC;AASD;;;;;;;;;;;;GAYG;AACH,SAAgB,mBAAmB,CACjC,OAAsB,EACtB,IAAmB,EACnB,OAA8B;;IAE9B,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACjC,MAAM,IAAI,GAAG,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,IAAI,EAAE,KAAI,IAAI,CAAC;IAC9C,MAAM,OAAO,GAAG,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,IAAI,EAAE,KAAI,IAAI,CAAC;IAChD,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,OAAO,OAAO,KAAK,sBAAc,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7D,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,OAAoB,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,OAAO,CAAC,IAAI,EAAE,CAAC;IAE/F,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjG,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACrF,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACf,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,OAAO,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC;QAChG,OAAO,QAAQ,KAAK,OAAO,CAAC,QAAQ,IAAI,KAAK,KAAK,OAAO,CAAC,KAAK;YAC7D,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvD,CAAC"}

package/dist/engine.native.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"engine.native.d.ts","sourceRoot":"","sources":["../src/engine.native.ts"],"names":[],"mappings":"AAmCA,OAAO,KAAK,EAKV,UAAU,EAMX,MAAM,SAAS,CAAC;AA+3BjB,eAAO,MAAM,MAAM,EAAE,UAAmC,CAAC"}
+{"version":3,"file":"engine.native.d.ts","sourceRoot":"","sources":["../src/engine.native.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,eAAO,MAAM,MAAM,EAAE,UAMnB,CAAC"}