reactor-effect-client 0.7.0 → 0.8.0

package/dist/internal/reactorTest/sessions.d.ts

@@ -0,0 +1,364 @@
+import * as Duration from "effect/Duration";
+import * as Effect from "effect/Effect";
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import * as Scope from "effect/Scope";
+import type { Entry, SessionInfo } from "../../ReactorTest.js";
+import type { Link } from "./peer.js";
+import type { Sampler } from "./timing.js";
+/**
+ * A session-scoped token request, as Reactor's authentication docs state it:
+ * one `session` entry naming at least one model, optionally sessions to bind,
+ * up to 500 sessions and sessions of one second to a day.
+ */
+export declare const Authorization: Schema.Struct<{
+    readonly type: Schema.Literal<"session">;
+    readonly resources: Schema.Struct<{
+        readonly models: Schema.Struct<{
+            readonly match: Schema.NonEmptyArray<Schema.String>;
+        }>;
+        readonly sessions: Schema.optionalKey<Schema.Struct<{
+            readonly bind: Schema.NonEmptyArray<Schema.String>;
+        }>>;
+    }>;
+    readonly constraints: Schema.optionalKey<Schema.Struct<{
+        readonly max_sessions: Schema.optionalKey<Schema.Int>;
+        readonly max_session_duration_seconds: Schema.optionalKey<Schema.Int>;
+    }>>;
+}>;
+declare const Refusal_base: Schema.Class<Refusal, Schema.TaggedStruct<"Refusal", {
+    readonly status: Schema.Int;
+    readonly code: Schema.String;
+    readonly reason: Schema.String;
+    /** Seconds to wait, sent as `Retry-After` and `retry_after_seconds`. */
+    readonly retryAfter: Schema.optionalKey<Schema.Int>;
+}>, import("effect/Cause").YieldableError>;
+/** A request the simulated coordinator refuses, with the status a client sees. */
+export declare class Refusal extends Refusal_base {
+}
+/** Where a recording's segments are served: another origin, as a CDN's would be. */
+export declare const clips = "https://clips.reactor.test";
+/**
+ * A registered connection slot. Several can carry one session at once; an
+ * offer on a slot binds its transport, and a later offer on the same slot,
+ * a reconnect, replaces it.
+ */
+export interface Slot {
+    /** Once offered, the answer and when it is ready. */
+    readonly answer: {
+        readonly at: number;
+        readonly sdp: string;
+    } | undefined;
+    /** The transport the slot's last offer named. */
+    readonly link: Link | undefined;
+    /** Its transport is connected and both its channels are open. */
+    readonly open: boolean;
+}
+export declare const make: (options: {
+    readonly apiKey: string;
+    readonly generationCapacity: number;
+    readonly playoutCapacity: number;
+    readonly creditsPerSecond: number;
+    readonly creditsPerDollar: number;
+    readonly concurrentSessions: number;
+    readonly sessionsPerMinute: number;
+    readonly width: number;
+    readonly height: number;
+    readonly candidate: "host" | "relay" | "srflx";
+    readonly referenceAudio: boolean;
+    readonly recorder: boolean;
+    readonly faults: readonly ({
+        readonly _tag: "RefuseAllocation";
+        readonly nth?: number;
+        readonly status?: number;
+    } | {
+        readonly _tag: "IgnoreSessionLimit";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "RepeatSession";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "UnnamedAllocation";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "StallAllocation";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "RefuseConnect";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "RefuseReconnect";
+        readonly nth?: number;
+        readonly status?: number;
+        readonly retryAfter?: Duration.Duration;
+    } | {
+        readonly _tag: "DropReply";
+        readonly nth?: number;
+        readonly command: string;
+        readonly applied?: boolean;
+    } | {
+        readonly _tag: "LateReply";
+        readonly nth?: number;
+        readonly command: string;
+        readonly after: Duration.Duration;
+    } | {
+        readonly _tag: "StallBuild";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "FailBuild";
+        readonly nth?: number;
+        readonly reason?: string;
+    } | {
+        readonly _tag: "Disconnect";
+        readonly nth?: number;
+        readonly after: Duration.Duration;
+    } | {
+        readonly _tag: "Expire";
+        readonly after: Duration.Duration;
+    } | {
+        readonly _tag: "IgnoreCap";
+    } | {
+        readonly _tag: "SlowDelete";
+        readonly for: Duration.Duration;
+    } | {
+        readonly _tag: "IgnoreDelete";
+    } | {
+        readonly _tag: "MissingSession";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "Video";
+        readonly video: "absent" | "black" | "frozen";
+    } | {
+        readonly _tag: "NoAudio";
+    } | {
+        readonly _tag: "InvalidImage";
+        readonly nth?: number;
+    } | {
+        readonly _tag: "OverGrant";
+        readonly nth?: number;
+        readonly grant?: "bound" | "expired" | "longer" | "silent" | "uncapped";
+    } | {
+        readonly _tag: "LateRecording";
+        readonly nth?: number;
+        readonly by: Duration.Duration;
+    } | {
+        readonly _tag: "Moderate";
+        readonly nth?: number;
+        readonly prompt?: string;
+        readonly action?: "terminate" | "warn";
+        readonly verdict?: boolean;
+    })[];
+}, timing: Sampler) => Effect.Effect<{
+    options: {
+        readonly apiKey: string;
+        readonly generationCapacity: number;
+        readonly playoutCapacity: number;
+        readonly creditsPerSecond: number;
+        readonly creditsPerDollar: number;
+        readonly concurrentSessions: number;
+        readonly sessionsPerMinute: number;
+        readonly width: number;
+        readonly height: number;
+        readonly candidate: "host" | "relay" | "srflx";
+        readonly referenceAudio: boolean;
+        readonly recorder: boolean;
+        readonly faults: readonly ({
+            readonly _tag: "RefuseAllocation";
+            readonly nth?: number;
+            readonly status?: number;
+        } | {
+            readonly _tag: "IgnoreSessionLimit";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "RepeatSession";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "UnnamedAllocation";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "StallAllocation";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "RefuseConnect";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "RefuseReconnect";
+            readonly nth?: number;
+            readonly status?: number;
+            readonly retryAfter?: Duration.Duration;
+        } | {
+            readonly _tag: "DropReply";
+            readonly nth?: number;
+            readonly command: string;
+            readonly applied?: boolean;
+        } | {
+            readonly _tag: "LateReply";
+            readonly nth?: number;
+            readonly command: string;
+            readonly after: Duration.Duration;
+        } | {
+            readonly _tag: "StallBuild";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "FailBuild";
+            readonly nth?: number;
+            readonly reason?: string;
+        } | {
+            readonly _tag: "Disconnect";
+            readonly nth?: number;
+            readonly after: Duration.Duration;
+        } | {
+            readonly _tag: "Expire";
+            readonly after: Duration.Duration;
+        } | {
+            readonly _tag: "IgnoreCap";
+        } | {
+            readonly _tag: "SlowDelete";
+            readonly for: Duration.Duration;
+        } | {
+            readonly _tag: "IgnoreDelete";
+        } | {
+            readonly _tag: "MissingSession";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "Video";
+            readonly video: "absent" | "black" | "frozen";
+        } | {
+            readonly _tag: "NoAudio";
+        } | {
+            readonly _tag: "InvalidImage";
+            readonly nth?: number;
+        } | {
+            readonly _tag: "OverGrant";
+            readonly nth?: number;
+            readonly grant?: "bound" | "expired" | "longer" | "silent" | "uncapped";
+        } | {
+            readonly _tag: "LateRecording";
+            readonly nth?: number;
+            readonly by: Duration.Duration;
+        } | {
+            readonly _tag: "Moderate";
+            readonly nth?: number;
+            readonly prompt?: string;
+            readonly action?: "terminate" | "warn";
+            readonly verdict?: boolean;
+        })[];
+    };
+    timing: Sampler;
+    nextPeer: Effect.Effect<string, never, never>;
+    attach: (link: Link) => Effect.Effect<void, never, never>;
+    detach: (peerId: string) => Effect.Effect<void, never, never>;
+    answered: (peerId: string) => Effect.Effect<void, never, never>;
+    receive: (peerId: string, channel: "control" | "data", bytes: Uint8Array) => Effect.Effect<void, never, never>;
+    pricing: {
+        settings: {
+            currency_code: string;
+            credits_per_dollar: number;
+        };
+        models: {
+            name: string;
+            rate: {
+                amount_per_sec: number;
+                unit: string;
+                denomination: string;
+            };
+        }[];
+    };
+    mint: (key: string | undefined, authorization: (typeof Authorization)["Type"], expiresAfter: number | undefined) => Effect.Effect<{
+        jwt: string;
+        expires_at: number;
+        authorization_details?: {
+            type: "session";
+            resources: {
+                models: {
+                    match: readonly [string, ...string[]];
+                };
+                sessions?: {
+                    bind: string[] | readonly [string, ...string[]];
+                };
+            };
+            constraints: {
+                max_sessions: number;
+                max_session_duration_seconds?: number | null;
+            };
+        }[];
+    }, Refusal, never>;
+    create: (jwt: string | undefined, model: string, webrtc: boolean, client: SessionInfo["client"]) => Effect.Effect<{
+        state: "ACTIVE" | "CLOSED" | "INACTIVE" | "PENDING" | "STOPPING";
+        capabilities?: {
+            protocol_version: string;
+            tracks: ({
+                name: "main_video";
+                kind: string;
+                direction: string;
+            } | {
+                name: "main_audio";
+                kind: string;
+                direction: string;
+            })[];
+            emission_fps: 24;
+        };
+        selected_transport?: {
+            protocol: string;
+            version: string;
+        };
+    }, Refusal, never>;
+    read: (jwt: string | undefined, id: string) => Effect.Effect<{
+        session_id: string;
+        state: "ACTIVE" | "CLOSED" | "INACTIVE" | "PENDING" | "STOPPING";
+        capabilities?: {
+            protocol_version: string;
+            tracks: ({
+                name: "main_video";
+                kind: string;
+                direction: string;
+            } | {
+                name: "main_audio";
+                kind: string;
+                direction: string;
+            })[];
+            emission_fps: 24;
+        };
+        selected_transport?: {
+            protocol: string;
+            version: string;
+        };
+    }, Refusal, never>;
+    upload: (jwt: string | undefined, id: string, name: string, size: number) => Effect.Effect<string, Refusal, never>;
+    stored: (slot: string, bytes: number) => Effect.Effect<undefined, Refusal, never>;
+    remove: (jwt: string | undefined, id: string) => Effect.Effect<void, Refusal, never>;
+    iceServers: (jwt: string | undefined, id: string) => Effect.Effect<{
+        ice_servers: {
+            uris: string[];
+            credentials: null;
+        }[];
+    }, Refusal, never>;
+    register: (jwt: string | undefined, id: string) => Effect.Effect<{
+        connection_id: number;
+    }, Refusal, never>;
+    offer: (jwt: string | undefined, id: string, cid: number, sdp: string, replace: boolean) => Effect.Effect<undefined, Refusal, never>;
+    answer: (jwt: string | undefined, id: string, cid: number) => Effect.Effect<Option.None<{
+        sdp_answer: string;
+        connection_id: number;
+    }> | Option.Some<{
+        sdp_answer: string;
+        connection_id: number;
+    }>, Refusal, never>;
+    candidates: (jwt: string | undefined, id: string, cid: number) => Effect.Effect<Slot, Refusal, never>;
+    /** A recording's HLS playlist for a bearer that acts on its session; none until it is ready. */
+    playlist: (jwt: string | undefined, id: string) => Effect.Effect<Option.None<string> | Option.Some<string>, Refusal, never>;
+    /** A recording's segment, served to whoever holds its URL, as a CDN would. */
+    segment: (id: string, file: string) => Effect.Effect<Uint8Array<ArrayBuffer>, Refusal, never>;
+    info: Effect.Effect<SessionInfo[], never, never>;
+    billing: Effect.Effect<{
+        seconds: number;
+        usd: number;
+    }, never, never>;
+    log: Effect.Effect<readonly Entry[], never, never>;
+    /** Adds to the log, as the coordinator does for each request it serves. */
+    note: (entry: Omit<Entry, "at">) => Effect.Effect<void, never, never>;
+    inject: (fault: import("../../ReactorTest.js").Fault) => Effect.Effect<void, never, never>;
+}, never, Scope.Scope>;
+export type Sessions = Effect.Success<ReturnType<typeof make>>;
+export {};
+//# sourceMappingURL=sessions.d.ts.map

package/dist/internal/reactorTest/sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/internal/reactorTest/sessions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,EAAW,KAAK,EAAW,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAIjF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAG3C;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;EAgBxB,CAAC;;;;;IASD,wEAAwE;;;AAP1E,kFAAkF;AAClF,qBAAa,OAAQ,SAAQ,YAQ3B;CAAG;AAYL,oFAAoF;AACpF,eAAO,MAAM,KAAK,+BAA+B,CAAC;AA8BlD;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB,qDAAqD;IACrD,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAC3E,iDAAiD;IACjD,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;IAChC,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAsDD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA6NE,IAAI;qBACF,MAAM;uBAQJ,MAAM;sBAOP,MAAM,WAAW,SAAS,GAAG,MAAM,SAAS,UAAU;;;YAU1D,aAAa;YAAS,kBAAkB;;;;;gBAK9C,cAAc;gBACd,IAAI;gBACJ,YAAY;;;;gBAMb,MAAM,GAAG,SAAS,iBACR,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,gBAC/B,MAAM,GAAG,SAAS;;;;kBAwCtB,SAAS;;;oBAEH,KAAK;;;oBACwB,IAAI;;;;;;;;;kBA2B5C,MAAM,GAAG,SAAS,SAChB,MAAM,UACL,OAAO,UACP,WAAW,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;YApVL,QAAQ;YAAY,OAAO;;;gBAmbzC,MAAM,GAAG,SAAS,MAAM,MAAM;;;;;;;;;;;;;;;;;YAnbhB,QAAQ;YAAY,OAAO;;;kBA0bvC,MAAM,GAAG,SAAS,MAAM,MAAM,QAAQ,MAAM,QAAQ,MAAM;mBASzD,MAAM,SAAS,MAAM;kBAMtB,MAAM,GAAG,SAAS,MAAM,MAAM;sBAgB1B,MAAM,GAAG,SAAS,MAAM,MAAM;;;;;;oBAIhC,MAAM,GAAG,SAAS,MAAM,MAAM;;;iBAWjC,MAAM,GAAG,SAAS,MAAM,MAAM,OAAO,MAAM,OAAO,MAAM,WAAW,OAAO;kBAqCzE,MAAM,GAAG,SAAS,MAAM,MAAM,OAAO,MAAM;;;;;;;sBAQvC,MAAM,GAAG,SAAS,MAAM,MAAM,OAAO,MAAM;IAG7D,gGAAgG;oBAChF,MAAM,GAAG,SAAS,MAAM,MAAM;IAuB9C,8EAA8E;kBAChE,MAAM,QAAQ,MAAM;;;;;;;IA6ClC,2EAA2E;kBA1jBzD,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC;;sBA8jBrC,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC"}