@ale-rainbow/web-sdk 5.1.0

package/lib/services/callLog/p2pRecap.service.d.ts

@@ -0,0 +1,206 @@
+import type { P2PRecap, RecapViewer } from "../../models/p2pRecap.model";
+import { Service } from "../../services/service";
+import type { User, Bubble } from "../../models";
+import { RBEvent } from "../../models";
+import type { Subscription } from "rxjs";
+/** @internal */
+export declare const P2P_RECAP_SVC = "P2PRecapService";
+/**
+ * @eventProperty
+ * @internal
+ * `P2PRecapServiceEvents` specific events
+ */
+export declare enum P2PRecapServiceEvents {
+    /**
+     * @eventProperty
+     * Sent when a new P2P recording recap is created.
+     */
+    ON_P2P_RECAP_CREATED = "ON_P2P_RECAP_CREATED",
+    /**
+     * @eventProperty
+     * Sent when a P2P recording recap is ready.
+     */
+    ON_P2P_RECAP_READY = "ON_P2P_RECAP_READY",
+    /**
+     * @eventProperty
+     * Sent when a P2P recording recap is removed.
+     */
+    ON_P2P_RECAP_REMOVED = "ON_P2P_RECAP_REMOVED",
+    /**
+     * @eventProperty
+     * Sent when a P2P recording recap is shared with the connected user (received as viewer).
+     */
+    ON_P2P_RECAP_SHARED = "ON_P2P_RECAP_SHARED"
+}
+/**
+ * Parameters used to launch the transcription / summary of a P2P call recording.
+ * Mapped 1:1 on the body of `POST /api/rainbow/aihub/v1.0/enduser/callrecord/transcribe/:fileDescriptorId`.
+ */
+export declare class P2PRecapParams {
+    transcription: boolean;
+    summary: boolean;
+    language: string;
+    summaryPrompt?: string;
+    recordingName?: string;
+}
+/** @internal */
+export interface P2PRecapService {
+    /**
+     * Subscribe to P2PRecapService service events.
+     * @internal
+     */
+    subscribe: (handler: (event: RBEvent<P2PRecapServiceEvents>) => void, eventNames?: P2PRecapServiceEvents | P2PRecapServiceEvents[]) => Subscription;
+    /**
+     * Get all P2P recaps that belong to the connected user, optionally filtered by callId.
+     */
+    getP2PRecaps: (callId?: string) => Promise<P2PRecap[]>;
+    /**
+     * Get a P2P recap from cache by its id.
+     */
+    getRecapFromCacheById: (recapId: string) => P2PRecap;
+    /**
+     * Refresh the recordings list after a `call_record` file upload notified over XMPP.
+     */
+    refreshAfterCallRecordUpload: () => Promise<void>;
+    /**
+     * Announce that a recording with no transcription/summary is ready (available in the recordings folder).
+     * Such recordings get no server-side `<callrecord>` "ready" message, so the client emits ON_P2P_RECAP_READY.
+     */
+    announceCallRecordReady: (fileId: string) => Promise<void>;
+    /**
+     * Refresh the recaps after a recording was shared with the connected user (XMPP viewer_added),
+     * then emit ON_P2P_RECAP_SHARED with the newly shared recap.
+     */
+    refreshAfterCallRecordShared: (fileId: string) => Promise<void>;
+    /**
+     * Drop a recording that is no longer shared with the connected user (XMPP viewer_removed) from the
+     * cache and emit ON_P2P_RECAP_REMOVED so the recordings list stops showing it without a reload.
+     */
+    removeSharedCallRecord: (fileId: string) => void;
+    /**
+     * Launch the transcription / summary of an already-uploaded P2P recording file.
+     * @param fileDescriptorId - id of the uploaded recording file descriptor
+     * @param params - transcription / summary parameters
+     */
+    launchTranscription: (fileDescriptorId: string, params?: P2PRecapParams) => Promise<void>;
+    /**
+     * Share a P2P recording with a user or a bubble.
+     */
+    shareP2PRecap: (recap: P2PRecap, destination: Bubble | User) => Promise<void>;
+    /**
+     * Stop sharing a P2P recording with a given viewer.
+     */
+    unshareP2PRecap: (recap: P2PRecap, viewer: RecapViewer) => Promise<void>;
+    /**
+     * Delete a P2P recording.
+     */
+    deleteP2PRecap: (recap: P2PRecap) => Promise<void>;
+    /**
+     * Retry the transcription / summary of a P2P recording.
+     */
+    retryP2PRecap: (recap: P2PRecap) => Promise<void>;
+    /**
+     * Get the list of the available custom prompts for the P2P recap transcription / summary.
+     */
+    getCustomPromptsForTranscription: () => Promise<{
+        name: string;
+        id: string;
+        isPredefined?: boolean;
+        typeOfPrompt?: string;
+    }[]>;
+    /**
+     * Store the transcription params chosen in the start popup (layer 2), keyed by callId, so layer 3
+     * can retrieve them when the recording stops and the file is uploaded.
+     */
+    setPendingTranscriptionParams: (callId: string, params: P2PRecapParams) => void;
+    /**
+     * Retrieve (and remove) the transcription params previously stored for a callId.
+     */
+    consumePendingTranscriptionParams: (callId: string) => P2PRecapParams | undefined;
+}
+/**
+ * The module is responsible for the transcription / summary of P2P call recordings.
+ * @internal
+ */
+export declare class P2PRecapServiceRB extends Service implements P2PRecapService {
+    private authService;
+    private logger;
+    private xmppService;
+    private errorHelperService;
+    private fileStorageService;
+    private fetchPromise?;
+    private eventsSubject;
+    private recaps?;
+    private customPrompts;
+    private pendingTranscriptionParams;
+    private messageHandlerRef?;
+    static getInstance(): P2PRecapServiceRB;
+    static build(): P2PRecapServiceRB;
+    protected constructor();
+    start(): void;
+    stop(): void;
+    reconnect(): void;
+    subscribe(handler: (event: RBEvent<P2PRecapServiceEvents>) => void, eventNames?: P2PRecapServiceEvents | P2PRecapServiceEvents[]): Subscription;
+    private sendEvent;
+    /**
+     * XMPP listener for P2P recording / transcription results.
+     * Parses `<callrecord xmlns="jabber:iq:configuration">` management messages (create/update/delete),
+     * updates the cached recaps and emits ON_P2P_RECAP_CREATED / READY / REMOVED.
+     */
+    private attachEventListeners;
+    getP2PRecaps(callId?: string, forceUpdate?: boolean): Promise<P2PRecap[]>;
+    /**
+     * Fetch the P2P call-record file descriptors from the server and map them to P2P recaps.
+     */
+    private fetchP2PRecordingFilesFromServer;
+    /**
+     * Adapt a raw call-record file descriptor (GET /callrecord item) into the normalized shape
+     * consumed by P2PRecapRB.updateFromData. The audio file is the call_record descriptor itself;
+     * the transcription/summary files live under tags.callTranscript.records.
+     */
+    private buildRecapDataFromCallRecord;
+    /**
+     * Called when a `call_record` file-descriptor event is received over XMPP (upload/update): the file must
+     * NOT be added to the regular file storage — instead refresh the recordings list and notify the UI.
+     */
+    refreshAfterCallRecordUpload(): Promise<void>;
+    announceCallRecordReady(fileId: string): Promise<void>;
+    refreshAfterCallRecordShared(fileId: string): Promise<void>;
+    removeSharedCallRecord(fileId: string): void;
+    private filterByCallId;
+    private normalizeCallId;
+    getRecapFromCacheById(recapId: string): P2PRecap;
+    /**
+     * Launch the transcription / summary of an already-uploaded P2P recording file.
+     * TODO(server): endpoint + body shape are provisional.
+     */
+    launchTranscription(fileDescriptorId: string, params?: P2PRecapParams): Promise<void>;
+    getCustomPromptsForTranscription(): Promise<{
+        name: string;
+        id: string;
+        isPredefined?: boolean;
+        typeOfPrompt?: string;
+    }[]>;
+    setPendingTranscriptionParams(callId: string, params: P2PRecapParams): void;
+    consumePendingTranscriptionParams(callId: string): P2PRecapParams | undefined;
+    /**
+     * A call_record is a plain file descriptor, so sharing = adding a viewer to it. The FD isn't kept in local
+     * storage, so we refresh the recap's viewers locally to fire ON_RECAP_VIEWERS_CHANGE.
+     */
+    shareP2PRecap(recap: P2PRecap, destination: Bubble | User): Promise<void>;
+    /**
+     * Unshare a P2P recap: remove the viewer from the call_record file descriptor, then refresh the recap's
+     * viewers locally.
+     */
+    unshareP2PRecap(recap: P2PRecap, viewer: RecapViewer): Promise<void>;
+    /**
+     * Delete a P2P recap: removes the call-record file descriptor (the server cleans up the generated
+     * transcription/summary files attached to it), then drops it from cache and notifies.
+     */
+    deleteP2PRecap(recap: P2PRecap): Promise<void>;
+    /**
+     * TODO(server): retry the AI processing of a P2P recap.
+     */
+    retryP2PRecap(recap: P2PRecap): Promise<void>;
+}
+//# sourceMappingURL=p2pRecap.service.d.ts.map

package/lib/services/callLog/p2pRecap.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p2pRecap.service.d.ts","sourceRoot":"","sources":["../../../src/services/callLog/p2pRecap.service.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,QAAQ,EAA+B,WAAW,EAAkB,MAAM,4CAA4C,CAAC;AAGrI,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAEhE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAOzC,gBAAgB;AAChB,eAAO,MAAM,aAAa,oBAAoB,CAAC;AAE/C;;;;GAIG;AACH,oBAAY,qBAAqB;IAE7B;;;OAGG;IACH,oBAAoB,yBAAyB;IAE7C;;;OAGG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,oBAAoB,yBAAyB;IAE7C;;;OAGG;IACH,mBAAmB,wBAAwB;CAC9C;AAED;;;GAGG;AACH,qBAAa,cAAc;IAChB,aAAa,EAAE,OAAO,CAAQ;IAC9B,OAAO,EAAE,OAAO,CAAQ;IAExB,QAAQ,EAAE,MAAM,CAAU;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAkCD,gBAAgB;AAChB,MAAM,WAAW,eAAe;IAE5B;;;OAGG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,qBAAqB,CAAC,KAAK,IAAI,EAAE,UAAU,CAAC,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,KAAK,YAAY,CAAC;IAEpJ;;OAEG;IACH,YAAY,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvD;;OAEG;IACH,qBAAqB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC;IAErD;;OAEG;IACH,4BAA4B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;OAGG;IACH,uBAAuB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;OAGG;IACH,4BAA4B,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;OAGG;IACH,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEjD;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1F;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;OAEG;IACH,eAAe,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,gCAAgC,EAAE,MAAM,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;KAAE,EAAE,CAAC,CAAC;IAEhI;;;OAGG;IACH,6BAA6B,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,iCAAiC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,cAAc,GAAG,SAAS,CAAC;CACrF;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,OAAQ,YAAW,eAAe;IACrE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,kBAAkB,CAAwD;IAGlF,OAAO,CAAC,YAAY,CAAC,CAAsB;IAC3C,OAAO,CAAC,aAAa,CAA0F;IAC/G,OAAO,CAAC,MAAM,CAAC,CAAa;IAC5B,OAAO,CAAC,aAAa,CAAsF;IAE3G,OAAO,CAAC,0BAA0B,CAAkE;IAEpG,OAAO,CAAC,iBAAiB,CAAC,CAAiB;WAE7B,WAAW;WACX,KAAK;IACnB,SAAS;IAEF,KAAK,IAAI,IAAI;IAUb,IAAI,IAAI,IAAI;IAcZ,SAAS,IAAI,IAAI;IAWjB,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,qBAAqB,CAAC,KAAK,IAAI,EAAE,UAAU,CAAC,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,GAAG,YAAY;IAkBtJ,OAAO,CAAC,SAAS;IAIjB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IA+Ef,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAY7F;;OAEG;YACW,gCAAgC;IAsB9C;;;;OAIG;IACH,OAAO,CAAC,4BAA4B;IA4BpC;;;OAGG;IACU,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;IAS7C,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYtD,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjE,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQnD,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,eAAe;IAIhB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ;IAIvD;;;OAGG;IACU,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,EAAE,MAAM,GAAE,cAAqC,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB3G,gCAAgC,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;KAAE,EAAE,CAAC;IAsBjI,6BAA6B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,IAAI;IAK3E,iCAAiC,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAMpF;;;OAGG;IACU,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtF;;;OAGG;IACU,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASjF;;;OAGG;IACU,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAe3D;;OAEG;IACU,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7D"}