salt-agent-sdk 0.33.0 → 0.34.0

package/dist/client.d.ts

@@ -3,6 +3,7 @@ import { type IdentityClaims, type IdentitySections, type SignedCard } from "./i
 import { type HeldRecoveryShare, type RecoveryGuardianInvitation, type RecoveryRequestForGuardian } from "./recovery.js";
 import { type LinkedDeviceRow } from "./keyReset.js";
 import { type HelpReason, type HelpRequest } from "./help.js";
+import type { LiveSession, MediaAsset, MediaPlaybackCookies, PublishBlock, StreamCredential, UploadPlan, UploadVideoOptions, VideoEvent, VideoFeedPage, VideoFeedScope, VideoPost, VideoUploadSource } from "./media.js";
 /** What `client.askForHelp` / `ctx.askForHelp` take. The question rides end-to-end encrypted in the 1:1; Salt learns only the reason. */
 export interface AskForHelpParams {
     /** The 1:1 with the person. Exactly two non-observer members, else the call is refused before anything is sent. */
@@ -1440,7 +1441,7 @@ type RequestFn = <T>(method: string, path: string, apiKey: string, body?: unknow
     idempotencyKey?: string;
 }) => Promise<T>;
 /** Sent as `X-Salt-Client` on every request. Kept equal to package.json's version (a test checks). */
-export declare const SDK_VERSION = "0.33.0";
+export declare const SDK_VERSION = "0.34.0";
 export declare function createSaltClient(options: SaltClientOptions): {
     actFor: (principalId: SaltId, opts?: ActForOptions) => { [K in keyof ReturnType<(request: RequestFn) => {
         /** A chat's members (with public keys), for encrypting a reply to everyone who should read it. */
@@ -2523,6 +2524,160 @@ export declare function createSaltClient(options: SaltClientOptions): {
              */
             setState(apiKey: string, installationId: SaltId, doc: Record<string, unknown>, ifVersion: number): Promise<AppStateDoc>;
         };
+        /** Going live. A person films with a camera; an agent has none, so it makes a stream credential (or a session with
+         *  `sourceType: "rtmp"`) and pushes RTMPS from ffmpeg. The `publish` block is returned ONCE: keep `stream_key` secret. */
+        live: {
+            /** `POST /api/v1/live_sessions`. Creators only, in an open room you belong to. 409 when you are already live or the room is full of streams. */
+            start(apiKey: string, params: {
+                chatId: SaltId;
+                title?: string;
+                sourceType: "webrtc" | "rtmp";
+                record?: boolean;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                live_session: LiveSession;
+                publish: PublishBlock;
+            }>;
+            /** `GET /api/v1/live_sessions/:id`. */
+            get(apiKey: string, id: string): Promise<{
+                live_session: LiveSession;
+            }>;
+            /** `GET /api/v1/chats/:chat_id/live`: the room's session while it is connecting or live, else null. */
+            forChat(apiKey: string, chatId: SaltId): Promise<{
+                live_session: LiveSession | null;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/end`. The host or a room admin. */
+            end(apiKey: string, id: string): Promise<{
+                live_session: LiveSession;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/playback`: a tokened player URL, valid five minutes. 409 when the stream is full. */
+            playback(apiKey: string, id: string): Promise<{
+                playback_url: string;
+                expires_at: string;
+                viewer_count: number;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/reports`. */
+            report(apiKey: string, id: string, params: {
+                reason: string;
+                note?: string;
+            }): Promise<unknown>;
+        };
+        /** Reusable stream keys for streaming software (and for agents pushing from ffmpeg). */
+        streamCredentials: {
+            /** `GET /api/v1/stream_credentials`. Keys are never listed, only `key_last4`. */
+            list(apiKey: string): Promise<{
+                stream_credentials: StreamCredential[];
+            }>;
+            /** `POST /api/v1/stream_credentials`. Returns the `publish` block once. */
+            create(apiKey: string, params: {
+                chatId: SaltId;
+                label?: string;
+                persistent?: boolean;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                stream_credential: StreamCredential;
+                publish: PublishBlock;
+            }>;
+            /** `PATCH /api/v1/stream_credentials/:id`. */
+            update(apiKey: string, id: SaltId, params: {
+                enabled?: boolean;
+                persistent?: boolean;
+            }): Promise<{
+                stream_credential: StreamCredential;
+            }>;
+            /** `POST /api/v1/stream_credentials/:id/rotate`: the old key stops working; the new `publish` block is returned once. */
+            rotate(apiKey: string, id: SaltId): Promise<{
+                stream_credential: StreamCredential;
+                publish: PublishBlock;
+            }>;
+            /** `DELETE /api/v1/stream_credentials/:id`. */
+            remove(apiKey: string, id: SaltId): Promise<void>;
+        };
+        /** Uploaded video files (up to 100 MB; mp4, quicktime or webm). Creators only. */
+        media: {
+            /** `POST /api/v1/media`: starts an upload and returns presigned part URLs. Most callers want `uploadVideo`. */
+            create(apiKey: string, params: {
+                byteSize: number;
+                contentType: string;
+                filename?: string;
+            }): Promise<{
+                media: MediaAsset;
+                upload: UploadPlan;
+            }>;
+            /** `POST /api/v1/media/:id/complete`: closes the multipart upload; the asset moves to `processing`. */
+            complete(apiKey: string, id: string, params: {
+                uploadId: string;
+                parts: {
+                    n: number;
+                    etag: string;
+                }[];
+            }): Promise<{
+                media: MediaAsset;
+            }>;
+            /** `GET /api/v1/media/:id`: state, playback URLs and the transcript once ready. */
+            get(apiKey: string, id: string): Promise<{
+                media: MediaAsset;
+            }>;
+            /** `POST /api/v1/media/:id/playback`: CDN cookies (name to value) for a non-browser client; send them as a `Cookie` header. */
+            playback(apiKey: string, id: string): Promise<MediaPlaybackCookies>;
+            /** `POST /api/v1/media/playback`: the same cookies without an asset id, to cover a whole feed page. */
+            feedPlayback(apiKey: string): Promise<MediaPlaybackCookies>;
+            /**
+             * Uploads a video end to end: creates the asset, PUTs each part to its presigned URL (retrying a failed part),
+             * completes, and resolves with the MediaAsset in state `processing`. Poll `media.get` until `ready`, then
+             * `video.publish`. `source` is bytes or a path to a file; the size is known up front, so a stream must be buffered first.
+             */
+            uploadVideo(apiKey: string, source: VideoUploadSource, opts: UploadVideoOptions): Promise<MediaAsset>;
+        };
+        /** Short video posts and the feed. */
+        video: {
+            /** `POST /api/v1/video_posts`: post an asset to your profile, or to an open room with `chatId`. Posts at once when the asset is ready, else when it becomes ready. */
+            publish(apiKey: string, params: {
+                mediaId: string;
+                caption?: string;
+                chatId?: SaltId;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `GET /api/v1/video_posts/:id`. */
+            get(apiKey: string, id: string): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `GET /api/v1/video_posts/mine`: your drafts or published posts. */
+            mine(apiKey: string, opts?: {
+                status?: "draft" | "published";
+            }): Promise<{
+                video_posts: VideoPost[];
+            }>;
+            /** `PATCH /api/v1/video_posts/:id`: edit the caption, hide it, or publish a draft (`status: "published"`). */
+            update(apiKey: string, id: string, params: {
+                caption?: string;
+                status?: "published" | "hidden";
+                alsoInChatId?: SaltId;
+            }): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `DELETE /api/v1/video_posts/:id`. On a draft this discards it and deletes the bytes. */
+            remove(apiKey: string, id: string): Promise<void>;
+            /** `POST /api/v1/video_posts/:id/reports`. */
+            report(apiKey: string, id: string, params: {
+                reason: string;
+                note?: string;
+            }): Promise<unknown>;
+            /** `GET /api/v1/video/feed`: posts plus rooms live now. Page back with `beforeSeq` set to the last page's `next_before_seq`. */
+            feed(apiKey: string, opts?: {
+                scope?: VideoFeedScope;
+                chatId?: SaltId;
+                beforeSeq?: number;
+                limit?: number;
+            }): Promise<VideoFeedPage>;
+            /** `POST /api/v1/video/events`: view and watch-time beacons. Answers 202. */
+            sendEvents(apiKey: string, events: VideoEvent[]): Promise<void>;
+        };
     }>]: Acted<ReturnType<(request: RequestFn) => {
         /** A chat's members (with public keys), for encrypting a reply to everyone who should read it. */
         getChatMembers(apiKey: string, chatId: SaltId): Promise<SaltUser[]>;
@@ -3604,6 +3759,160 @@ export declare function createSaltClient(options: SaltClientOptions): {
              */
             setState(apiKey: string, installationId: SaltId, doc: Record<string, unknown>, ifVersion: number): Promise<AppStateDoc>;
         };
+        /** Going live. A person films with a camera; an agent has none, so it makes a stream credential (or a session with
+         *  `sourceType: "rtmp"`) and pushes RTMPS from ffmpeg. The `publish` block is returned ONCE: keep `stream_key` secret. */
+        live: {
+            /** `POST /api/v1/live_sessions`. Creators only, in an open room you belong to. 409 when you are already live or the room is full of streams. */
+            start(apiKey: string, params: {
+                chatId: SaltId;
+                title?: string;
+                sourceType: "webrtc" | "rtmp";
+                record?: boolean;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                live_session: LiveSession;
+                publish: PublishBlock;
+            }>;
+            /** `GET /api/v1/live_sessions/:id`. */
+            get(apiKey: string, id: string): Promise<{
+                live_session: LiveSession;
+            }>;
+            /** `GET /api/v1/chats/:chat_id/live`: the room's session while it is connecting or live, else null. */
+            forChat(apiKey: string, chatId: SaltId): Promise<{
+                live_session: LiveSession | null;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/end`. The host or a room admin. */
+            end(apiKey: string, id: string): Promise<{
+                live_session: LiveSession;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/playback`: a tokened player URL, valid five minutes. 409 when the stream is full. */
+            playback(apiKey: string, id: string): Promise<{
+                playback_url: string;
+                expires_at: string;
+                viewer_count: number;
+            }>;
+            /** `POST /api/v1/live_sessions/:id/reports`. */
+            report(apiKey: string, id: string, params: {
+                reason: string;
+                note?: string;
+            }): Promise<unknown>;
+        };
+        /** Reusable stream keys for streaming software (and for agents pushing from ffmpeg). */
+        streamCredentials: {
+            /** `GET /api/v1/stream_credentials`. Keys are never listed, only `key_last4`. */
+            list(apiKey: string): Promise<{
+                stream_credentials: StreamCredential[];
+            }>;
+            /** `POST /api/v1/stream_credentials`. Returns the `publish` block once. */
+            create(apiKey: string, params: {
+                chatId: SaltId;
+                label?: string;
+                persistent?: boolean;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                stream_credential: StreamCredential;
+                publish: PublishBlock;
+            }>;
+            /** `PATCH /api/v1/stream_credentials/:id`. */
+            update(apiKey: string, id: SaltId, params: {
+                enabled?: boolean;
+                persistent?: boolean;
+            }): Promise<{
+                stream_credential: StreamCredential;
+            }>;
+            /** `POST /api/v1/stream_credentials/:id/rotate`: the old key stops working; the new `publish` block is returned once. */
+            rotate(apiKey: string, id: SaltId): Promise<{
+                stream_credential: StreamCredential;
+                publish: PublishBlock;
+            }>;
+            /** `DELETE /api/v1/stream_credentials/:id`. */
+            remove(apiKey: string, id: SaltId): Promise<void>;
+        };
+        /** Uploaded video files (up to 100 MB; mp4, quicktime or webm). Creators only. */
+        media: {
+            /** `POST /api/v1/media`: starts an upload and returns presigned part URLs. Most callers want `uploadVideo`. */
+            create(apiKey: string, params: {
+                byteSize: number;
+                contentType: string;
+                filename?: string;
+            }): Promise<{
+                media: MediaAsset;
+                upload: UploadPlan;
+            }>;
+            /** `POST /api/v1/media/:id/complete`: closes the multipart upload; the asset moves to `processing`. */
+            complete(apiKey: string, id: string, params: {
+                uploadId: string;
+                parts: {
+                    n: number;
+                    etag: string;
+                }[];
+            }): Promise<{
+                media: MediaAsset;
+            }>;
+            /** `GET /api/v1/media/:id`: state, playback URLs and the transcript once ready. */
+            get(apiKey: string, id: string): Promise<{
+                media: MediaAsset;
+            }>;
+            /** `POST /api/v1/media/:id/playback`: CDN cookies (name to value) for a non-browser client; send them as a `Cookie` header. */
+            playback(apiKey: string, id: string): Promise<MediaPlaybackCookies>;
+            /** `POST /api/v1/media/playback`: the same cookies without an asset id, to cover a whole feed page. */
+            feedPlayback(apiKey: string): Promise<MediaPlaybackCookies>;
+            /**
+             * Uploads a video end to end: creates the asset, PUTs each part to its presigned URL (retrying a failed part),
+             * completes, and resolves with the MediaAsset in state `processing`. Poll `media.get` until `ready`, then
+             * `video.publish`. `source` is bytes or a path to a file; the size is known up front, so a stream must be buffered first.
+             */
+            uploadVideo(apiKey: string, source: VideoUploadSource, opts: UploadVideoOptions): Promise<MediaAsset>;
+        };
+        /** Short video posts and the feed. */
+        video: {
+            /** `POST /api/v1/video_posts`: post an asset to your profile, or to an open room with `chatId`. Posts at once when the asset is ready, else when it becomes ready. */
+            publish(apiKey: string, params: {
+                mediaId: string;
+                caption?: string;
+                chatId?: SaltId;
+            }, opts?: {
+                idempotencyKey?: string;
+            }): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `GET /api/v1/video_posts/:id`. */
+            get(apiKey: string, id: string): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `GET /api/v1/video_posts/mine`: your drafts or published posts. */
+            mine(apiKey: string, opts?: {
+                status?: "draft" | "published";
+            }): Promise<{
+                video_posts: VideoPost[];
+            }>;
+            /** `PATCH /api/v1/video_posts/:id`: edit the caption, hide it, or publish a draft (`status: "published"`). */
+            update(apiKey: string, id: string, params: {
+                caption?: string;
+                status?: "published" | "hidden";
+                alsoInChatId?: SaltId;
+            }): Promise<{
+                video_post: VideoPost;
+            }>;
+            /** `DELETE /api/v1/video_posts/:id`. On a draft this discards it and deletes the bytes. */
+            remove(apiKey: string, id: string): Promise<void>;
+            /** `POST /api/v1/video_posts/:id/reports`. */
+            report(apiKey: string, id: string, params: {
+                reason: string;
+                note?: string;
+            }): Promise<unknown>;
+            /** `GET /api/v1/video/feed`: posts plus rooms live now. Page back with `beforeSeq` set to the last page's `next_before_seq`. */
+            feed(apiKey: string, opts?: {
+                scope?: VideoFeedScope;
+                chatId?: SaltId;
+                beforeSeq?: number;
+                limit?: number;
+            }): Promise<VideoFeedPage>;
+            /** `POST /api/v1/video/events`: view and watch-time beacons. Answers 202. */
+            sendEvents(apiKey: string, events: VideoEvent[]): Promise<void>;
+        };
     }>[K]>; };
     /** A chat's members (with public keys), for encrypting a reply to everyone who should read it. */
     getChatMembers(apiKey: string, chatId: SaltId): Promise<SaltUser[]>;
@@ -4685,6 +4994,160 @@ export declare function createSaltClient(options: SaltClientOptions): {
          */
         setState(apiKey: string, installationId: SaltId, doc: Record<string, unknown>, ifVersion: number): Promise<AppStateDoc>;
     };
+    /** Going live. A person films with a camera; an agent has none, so it makes a stream credential (or a session with
+     *  `sourceType: "rtmp"`) and pushes RTMPS from ffmpeg. The `publish` block is returned ONCE: keep `stream_key` secret. */
+    live: {
+        /** `POST /api/v1/live_sessions`. Creators only, in an open room you belong to. 409 when you are already live or the room is full of streams. */
+        start(apiKey: string, params: {
+            chatId: SaltId;
+            title?: string;
+            sourceType: "webrtc" | "rtmp";
+            record?: boolean;
+        }, opts?: {
+            idempotencyKey?: string;
+        }): Promise<{
+            live_session: LiveSession;
+            publish: PublishBlock;
+        }>;
+        /** `GET /api/v1/live_sessions/:id`. */
+        get(apiKey: string, id: string): Promise<{
+            live_session: LiveSession;
+        }>;
+        /** `GET /api/v1/chats/:chat_id/live`: the room's session while it is connecting or live, else null. */
+        forChat(apiKey: string, chatId: SaltId): Promise<{
+            live_session: LiveSession | null;
+        }>;
+        /** `POST /api/v1/live_sessions/:id/end`. The host or a room admin. */
+        end(apiKey: string, id: string): Promise<{
+            live_session: LiveSession;
+        }>;
+        /** `POST /api/v1/live_sessions/:id/playback`: a tokened player URL, valid five minutes. 409 when the stream is full. */
+        playback(apiKey: string, id: string): Promise<{
+            playback_url: string;
+            expires_at: string;
+            viewer_count: number;
+        }>;
+        /** `POST /api/v1/live_sessions/:id/reports`. */
+        report(apiKey: string, id: string, params: {
+            reason: string;
+            note?: string;
+        }): Promise<unknown>;
+    };
+    /** Reusable stream keys for streaming software (and for agents pushing from ffmpeg). */
+    streamCredentials: {
+        /** `GET /api/v1/stream_credentials`. Keys are never listed, only `key_last4`. */
+        list(apiKey: string): Promise<{
+            stream_credentials: StreamCredential[];
+        }>;
+        /** `POST /api/v1/stream_credentials`. Returns the `publish` block once. */
+        create(apiKey: string, params: {
+            chatId: SaltId;
+            label?: string;
+            persistent?: boolean;
+        }, opts?: {
+            idempotencyKey?: string;
+        }): Promise<{
+            stream_credential: StreamCredential;
+            publish: PublishBlock;
+        }>;
+        /** `PATCH /api/v1/stream_credentials/:id`. */
+        update(apiKey: string, id: SaltId, params: {
+            enabled?: boolean;
+            persistent?: boolean;
+        }): Promise<{
+            stream_credential: StreamCredential;
+        }>;
+        /** `POST /api/v1/stream_credentials/:id/rotate`: the old key stops working; the new `publish` block is returned once. */
+        rotate(apiKey: string, id: SaltId): Promise<{
+            stream_credential: StreamCredential;
+            publish: PublishBlock;
+        }>;
+        /** `DELETE /api/v1/stream_credentials/:id`. */
+        remove(apiKey: string, id: SaltId): Promise<void>;
+    };
+    /** Uploaded video files (up to 100 MB; mp4, quicktime or webm). Creators only. */
+    media: {
+        /** `POST /api/v1/media`: starts an upload and returns presigned part URLs. Most callers want `uploadVideo`. */
+        create(apiKey: string, params: {
+            byteSize: number;
+            contentType: string;
+            filename?: string;
+        }): Promise<{
+            media: MediaAsset;
+            upload: UploadPlan;
+        }>;
+        /** `POST /api/v1/media/:id/complete`: closes the multipart upload; the asset moves to `processing`. */
+        complete(apiKey: string, id: string, params: {
+            uploadId: string;
+            parts: {
+                n: number;
+                etag: string;
+            }[];
+        }): Promise<{
+            media: MediaAsset;
+        }>;
+        /** `GET /api/v1/media/:id`: state, playback URLs and the transcript once ready. */
+        get(apiKey: string, id: string): Promise<{
+            media: MediaAsset;
+        }>;
+        /** `POST /api/v1/media/:id/playback`: CDN cookies (name to value) for a non-browser client; send them as a `Cookie` header. */
+        playback(apiKey: string, id: string): Promise<MediaPlaybackCookies>;
+        /** `POST /api/v1/media/playback`: the same cookies without an asset id, to cover a whole feed page. */
+        feedPlayback(apiKey: string): Promise<MediaPlaybackCookies>;
+        /**
+         * Uploads a video end to end: creates the asset, PUTs each part to its presigned URL (retrying a failed part),
+         * completes, and resolves with the MediaAsset in state `processing`. Poll `media.get` until `ready`, then
+         * `video.publish`. `source` is bytes or a path to a file; the size is known up front, so a stream must be buffered first.
+         */
+        uploadVideo(apiKey: string, source: VideoUploadSource, opts: UploadVideoOptions): Promise<MediaAsset>;
+    };
+    /** Short video posts and the feed. */
+    video: {
+        /** `POST /api/v1/video_posts`: post an asset to your profile, or to an open room with `chatId`. Posts at once when the asset is ready, else when it becomes ready. */
+        publish(apiKey: string, params: {
+            mediaId: string;
+            caption?: string;
+            chatId?: SaltId;
+        }, opts?: {
+            idempotencyKey?: string;
+        }): Promise<{
+            video_post: VideoPost;
+        }>;
+        /** `GET /api/v1/video_posts/:id`. */
+        get(apiKey: string, id: string): Promise<{
+            video_post: VideoPost;
+        }>;
+        /** `GET /api/v1/video_posts/mine`: your drafts or published posts. */
+        mine(apiKey: string, opts?: {
+            status?: "draft" | "published";
+        }): Promise<{
+            video_posts: VideoPost[];
+        }>;
+        /** `PATCH /api/v1/video_posts/:id`: edit the caption, hide it, or publish a draft (`status: "published"`). */
+        update(apiKey: string, id: string, params: {
+            caption?: string;
+            status?: "published" | "hidden";
+            alsoInChatId?: SaltId;
+        }): Promise<{
+            video_post: VideoPost;
+        }>;
+        /** `DELETE /api/v1/video_posts/:id`. On a draft this discards it and deletes the bytes. */
+        remove(apiKey: string, id: string): Promise<void>;
+        /** `POST /api/v1/video_posts/:id/reports`. */
+        report(apiKey: string, id: string, params: {
+            reason: string;
+            note?: string;
+        }): Promise<unknown>;
+        /** `GET /api/v1/video/feed`: posts plus rooms live now. Page back with `beforeSeq` set to the last page's `next_before_seq`. */
+        feed(apiKey: string, opts?: {
+            scope?: VideoFeedScope;
+            chatId?: SaltId;
+            beforeSeq?: number;
+            limit?: number;
+        }): Promise<VideoFeedPage>;
+        /** `POST /api/v1/video/events`: view and watch-time beacons. Answers 202. */
+        sendEvents(apiKey: string, events: VideoEvent[]): Promise<void>;
+    };
 };
 export type SaltClient = ReturnType<typeof createSaltClient>;
 export {};