@tidblink/server 0.0.0-stage → 0.4.0-rc.0

package/dist/realtime.d.ts

@@ -0,0 +1,90 @@
+export type RealtimeLanguage = "zh-CN" | "en-US";
+export type RealtimeEndpointingMode = "client" | "server";
+export interface RealtimePcm16AudioFormat {
+    encoding: "pcm16";
+    sampleRate: number;
+    channels: 1;
+}
+export interface RealtimeOpusAudioFormat {
+    encoding: "opus";
+    sampleRate: number;
+    channels: 1;
+    packetDurationMs: number;
+    bitrate?: 16000 | 24000 | 32000;
+}
+export type RealtimeAudioFormat = RealtimePcm16AudioFormat | RealtimeOpusAudioFormat;
+export interface RealtimeModel {
+    id: string;
+    label: string;
+    available: boolean;
+    isDefault: boolean;
+    languages: RealtimeLanguage[];
+    endpointingModes: RealtimeEndpointingMode[];
+    audio: {
+        input: RealtimeAudioFormat[];
+        output: RealtimeAudioFormat[];
+    };
+}
+export interface RealtimeModelCatalog {
+    defaultModel: string | null;
+    models: RealtimeModel[];
+}
+export interface RealtimeVoiceSetting {
+    language: RealtimeLanguage;
+}
+export interface RealtimeModelSelection {
+    model: string | null;
+    revision: number;
+    etag: string;
+    voice: RealtimeVoiceSetting | null;
+}
+export interface RealtimeSessionSelectionFields {
+    realtimeModel: string | null;
+    realtimeModelRevision: number;
+    realtimeModelEtag: string;
+    realtimeVoice: RealtimeVoiceSetting | null;
+}
+export declare const realtimeModelSelectionFrom: (session: RealtimeSessionSelectionFields) => RealtimeModelSelection;
+export interface RealtimeAudioFormats {
+    input: RealtimeAudioFormat;
+    output: RealtimeAudioFormat;
+}
+export interface OpenRealtimeConnectionInput {
+    audio?: Partial<RealtimeAudioFormats>;
+    metadata?: Record<string, string>;
+}
+export interface RealtimeConnection {
+    object: "realtime_connection";
+    id: string;
+    sessionId: string;
+    provider: {
+        name: string;
+        region: string | null;
+        model: string | null;
+    };
+    status: "connecting" | "active" | "paused" | "ended";
+    audio: RealtimeAudioFormats;
+    activeTaskTurnId: string | null;
+    usage: {
+        inputAudioSec: number;
+        outputAudioSec: number;
+        thoughtTokens: number;
+        textTokens: number;
+    };
+    metadata: Record<string, string>;
+    createdAt: string;
+    endedAt: string | null;
+}
+export interface RealtimeConnectGrant {
+    websocketUrl: string;
+    connectToken: string;
+    connectTokenExpiresAt: string;
+}
+export interface OpenRealtimeConnectionResult extends RealtimeConnectGrant {
+    realtimeConnection: RealtimeConnection;
+}
+export declare const requireRealtimeModelSelectionReceipt: (value: unknown, requestId: string) => RealtimeModelSelection;
+export declare const requireOpenRealtimeConnectionReceipt: (value: unknown, requestId: string) => OpenRealtimeConnectionResult;
+export declare const requireRealtimeConnectGrantReceipt: (value: unknown, requestId: string) => RealtimeConnectGrant;
+export declare const requireRealtimeConnectionReceipt: (value: unknown, requestId: string) => RealtimeConnection;
+//# sourceMappingURL=realtime.d.ts.map

package/dist/realtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,CAAC;AACjD,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE1D,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,CAAC;IACZ,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;CACjC;AAED,MAAM,MAAM,mBAAmB,GAC3B,wBAAwB,GACxB,uBAAuB,CAAC;AAE5B,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;IAC5C,KAAK,EAAE;QACL,KAAK,EAAE,mBAAmB,EAAE,CAAC;QAC7B,MAAM,EAAE,mBAAmB,EAAE,CAAC;KAC/B,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,8BAA8B;IAC7C,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAC5C;AAED,eAAO,MAAM,0BAA0B,GACrC,SAAS,8BAA8B,KACtC,sBAKD,CAAC;AAEH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,qBAAqB,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB,CAAC;IACF,MAAM,EAAE,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;IACrD,KAAK,EAAE,oBAAoB,CAAC;IAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,KAAK,EAAE;QACL,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;IACxE,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AA6FD,eAAO,MAAM,oCAAoC,GAC/C,OAAO,OAAO,EACd,WAAW,MAAM,KAChB,sBAeF,CAAC;AAEF,eAAO,MAAM,oCAAoC,GAC/C,OAAO,OAAO,EACd,WAAW,MAAM,KAChB,4BAQF,CAAC;AAEF,eAAO,MAAM,kCAAkC,GAC7C,OAAO,OAAO,EACd,WAAW,MAAM,KAChB,oBAIF,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,OAAO,OAAO,EACd,WAAW,MAAM,KAChB,kBAIF,CAAC"}

package/dist/realtime.js

@@ -0,0 +1,111 @@
+import { OutcomeUnknownError } from "./errors.js";
+export const realtimeModelSelectionFrom = (session) => ({
+    model: session.realtimeModel,
+    revision: session.realtimeModelRevision,
+    etag: session.realtimeModelEtag,
+    voice: session.realtimeVoice,
+});
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const isString = (value) => typeof value === "string" && value.length > 0;
+const isNullableString = (value) => value === null || typeof value === "string";
+const isNumber = (value) => typeof value === "number" && Number.isFinite(value) && value >= 0;
+const isDateTime = (value) => typeof value === "string" && Number.isFinite(Date.parse(value));
+const isAudioFormat = (value) => {
+    if (!isRecord(value) ||
+        !isNumber(value.sampleRate) ||
+        value.sampleRate <= 0 ||
+        value.channels !== 1)
+        return false;
+    if (value.encoding === "pcm16")
+        return true;
+    return (value.encoding === "opus" &&
+        Number.isInteger(value.packetDurationMs) &&
+        isNumber(value.packetDurationMs) &&
+        value.packetDurationMs > 0 &&
+        (value.bitrate === undefined ||
+            value.bitrate === 16000 ||
+            value.bitrate === 24000 ||
+            value.bitrate === 32000));
+};
+const isRealtimeConnection = (value) => {
+    if (!isRecord(value))
+        return false;
+    const provider = value.provider;
+    const audio = value.audio;
+    const usage = value.usage;
+    const metadata = value.metadata;
+    return (value.object === "realtime_connection" &&
+        isString(value.id) &&
+        isString(value.sessionId) &&
+        isRecord(provider) &&
+        isString(provider.name) &&
+        isNullableString(provider.region) &&
+        isNullableString(provider.model) &&
+        ["connecting", "active", "paused", "ended"].includes(String(value.status)) &&
+        isRecord(audio) &&
+        isAudioFormat(audio.input) &&
+        isAudioFormat(audio.output) &&
+        isNullableString(value.activeTaskTurnId) &&
+        isRecord(usage) &&
+        isNumber(usage.inputAudioSec) &&
+        isNumber(usage.outputAudioSec) &&
+        Number.isInteger(usage.thoughtTokens) &&
+        isNumber(usage.thoughtTokens) &&
+        Number.isInteger(usage.textTokens) &&
+        isNumber(usage.textTokens) &&
+        isRecord(metadata) &&
+        Object.values(metadata).every((entry) => typeof entry === "string") &&
+        isDateTime(value.createdAt) &&
+        (value.endedAt === null || isDateTime(value.endedAt)));
+};
+const isConnectGrant = (value) => {
+    if (!isRecord(value) || !isString(value.websocketUrl))
+        return false;
+    let protocol;
+    try {
+        protocol = new URL(value.websocketUrl).protocol;
+    }
+    catch {
+        return false;
+    }
+    return ((protocol === "ws:" || protocol === "wss:") &&
+        typeof value.connectToken === "string" &&
+        /^rct_[A-Za-z0-9_-]{43}$/u.test(value.connectToken) &&
+        isDateTime(value.connectTokenExpiresAt));
+};
+const unusableReceipt = (operation, requestId) => {
+    throw new OutcomeUnknownError(`TiDB Link accepted ${operation} but returned an unusable receipt`, { requestId });
+};
+export const requireRealtimeModelSelectionReceipt = (value, requestId) => {
+    if (!isRecord(value))
+        return unusableReceipt("the Realtime Model selection", requestId);
+    const voice = value.realtimeVoice;
+    if (!isNullableString(value.realtimeModel) ||
+        !Number.isInteger(value.realtimeModelRevision) ||
+        !isNumber(value.realtimeModelRevision) ||
+        value.realtimeModelRevision <= 0 ||
+        !isString(value.realtimeModelEtag) ||
+        (voice !== null &&
+            (!isRecord(voice) ||
+                (voice.language !== "zh-CN" && voice.language !== "en-US"))))
+        return unusableReceipt("the Realtime Model selection", requestId);
+    return realtimeModelSelectionFrom(value);
+};
+export const requireOpenRealtimeConnectionReceipt = (value, requestId) => {
+    if (!isRecord(value) ||
+        !isRealtimeConnection(value.realtimeConnection) ||
+        !isConnectGrant(value))
+        return unusableReceipt("the Realtime Connection request", requestId);
+    return value;
+};
+export const requireRealtimeConnectGrantReceipt = (value, requestId) => {
+    if (!isConnectGrant(value))
+        return unusableReceipt("the Realtime connect-token request", requestId);
+    return value;
+};
+export const requireRealtimeConnectionReceipt = (value, requestId) => {
+    if (!isRecord(value) || !isRealtimeConnection(value.realtimeConnection))
+        return unusableReceipt("the Realtime Connection mutation", requestId);
+    return value.realtimeConnection;
+};
+//# sourceMappingURL=realtime.js.map

package/dist/realtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.js","sourceRoot":"","sources":["../src/realtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AA2DlD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,OAAuC,EACf,EAAE,CAAC,CAAC;IAC5B,KAAK,EAAE,OAAO,CAAC,aAAa;IAC5B,QAAQ,EAAE,OAAO,CAAC,qBAAqB;IACvC,IAAI,EAAE,OAAO,CAAC,iBAAiB;IAC/B,KAAK,EAAE,OAAO,CAAC,aAAa;CAC7B,CAAC,CAAC;AA8CH,MAAM,QAAQ,GAAG,CAAC,KAAc,EAA0B,EAAE,CAC1D,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACvE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAChD,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAA0B,EAAE,CAClE,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC9C,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACpE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAmB,EAAE,CACrD,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAElE,MAAM,aAAa,GAAG,CAAC,KAAc,EAAgC,EAAE;IACrE,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAC3B,KAAK,CAAC,UAAU,IAAI,CAAC;QACrB,KAAK,CAAC,QAAQ,KAAK,CAAC;QAEpB,OAAO,KAAK,CAAC;IACf,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IAC5C,OAAO,CACL,KAAK,CAAC,QAAQ,KAAK,MAAM;QACzB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC;QACxC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC;QAChC,KAAK,CAAC,gBAAgB,GAAG,CAAC;QAC1B,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS;YAC1B,KAAK,CAAC,OAAO,KAAK,KAAK;YACvB,KAAK,CAAC,OAAO,KAAK,KAAK;YACvB,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,CAC3B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAA+B,EAAE;IAC3E,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IAChC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC1B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IAChC,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,qBAAqB;QACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;QACzB,QAAQ,CAAC,QAAQ,CAAC;QAClB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;QACvB,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChC,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAClD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CACrB;QACD,QAAQ,CAAC,KAAK,CAAC;QACf,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1B,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;QAC3B,gBAAgB,CAAC,KAAK,CAAC,gBAAgB,CAAC;QACxC,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;QAC9B,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC;QACrC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;QAC7B,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;QAClC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;QAC1B,QAAQ,CAAC,QAAQ,CAAC;QAClB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;QACnE,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3B,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CACtD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAiC,EAAE;IACvE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;QAAE,OAAO,KAAK,CAAC;IACpE,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,CAAC,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,MAAM,CAAC;QAC3C,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ;QACtC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QACnD,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAS,EAAE;IACtE,MAAM,IAAI,mBAAmB,CAC3B,sBAAsB,SAAS,mCAAmC,EAClE,EAAE,SAAS,EAAE,CACd,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,KAAc,EACd,SAAiB,EACO,EAAE;IAC1B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,eAAe,CAAC,8BAA8B,EAAE,SAAS,CAAC,CAAC;IACxF,MAAM,KAAK,GAAG,KAAK,CAAC,aAAa,CAAC;IAClC,IACE,CAAC,gBAAgB,CAAC,KAAK,CAAC,aAAa,CAAC;QACtC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC;QAC9C,CAAC,QAAQ,CAAC,KAAK,CAAC,qBAAqB,CAAC;QACtC,KAAK,CAAC,qBAAqB,IAAI,CAAC;QAChC,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC;QAClC,CAAC,KAAK,KAAK,IAAI;YACb,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACf,CAAC,KAAK,CAAC,QAAQ,KAAK,OAAO,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC;QAEhE,OAAO,eAAe,CAAC,8BAA8B,EAAE,SAAS,CAAC,CAAC;IACpE,OAAO,0BAA0B,CAAC,KAAkD,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAClD,KAAc,EACd,SAAiB,EACa,EAAE;IAChC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,CAAC,oBAAoB,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAC/C,CAAC,cAAc,CAAC,KAAK,CAAC;QAEtB,OAAO,eAAe,CAAC,iCAAiC,EAAE,SAAS,CAAC,CAAC;IACvE,OAAO,KAAgD,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAChD,KAAc,EACd,SAAiB,EACK,EAAE;IACxB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;QACxB,OAAO,eAAe,CAAC,oCAAoC,EAAE,SAAS,CAAC,CAAC;IAC1E,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,KAAc,EACd,SAAiB,EACG,EAAE;IACtB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACrE,OAAO,eAAe,CAAC,kCAAkC,EAAE,SAAS,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC,kBAAkB,CAAC;AAClC,CAAC,CAAC"}

package/dist/session-connection.d.ts

@@ -0,0 +1,144 @@
+import type { BackendConnectionPool } from "./backend-pool.js";
+import { type ClientToolDeclaration } from "./client-tools.js";
+import { type RealtimeResponseEvent, type RealtimeTranscriptEvent, type SessionEvent } from "./events.js";
+import { HttpClient } from "./http.js";
+import { type OpenRealtimeConnectionInput, type RealtimeConnectGrant } from "./realtime.js";
+import { type SendOptions } from "./session-send.js";
+import type { TurnResult } from "./turn.js";
+/** What a Client Tool handler learns about the call it runs. */
+export interface ClientToolCallContext {
+    callId: string;
+    sessionId: string;
+    userId: string;
+    turnId: string;
+    /** The tool's name. */
+    name: string;
+    /** Submit the result before this time; the core then reports the effect as unknown. */
+    deadlineAt: Date;
+    /** Aborts when the deadline passes. */
+    signal: AbortSignal;
+}
+/**
+ * One Client Tool: its declaration, which the model sees, and the function
+ * that executes it, usually by forwarding the call to a device.
+ */
+export interface ClientToolHandler {
+    description: string;
+    /** JSON Schema of the arguments. */
+    parameters: Record<string, unknown>;
+    /**
+     * Execute one call. Return the text the model receives; other values are
+     * sent as JSON. Throw to report a failure, whose message the model sees.
+     */
+    run(args: Record<string, unknown>, context: ClientToolCallContext): unknown;
+}
+export type ClientToolHandlers = Record<string, ClientToolHandler>;
+/** A completed Realtime user transcript. */
+export type RealtimeTranscript = RealtimeTranscriptEvent["data"];
+/** A completed Realtime model response. */
+export type RealtimeResponse = RealtimeResponseEvent["data"];
+export interface ConnectOptions {
+    /**
+     * The Session's Client Tools by name. Each attach replaces the Session's
+     * whole Client Tool set with these declarations, and this connection
+     * executes their calls. Omit to keep the stored set unchanged.
+     */
+    tools?: ClientToolHandlers;
+    /**
+     * Receive events only, while another connection executes the Session's
+     * Client Tools. An observing connection never takes the Session from an
+     * executing one and cannot declare tools.
+     */
+    observe?: boolean;
+    /**
+     * Resume after this event: the cursor of the last event you processed,
+     * saved through `onCursor`. Without it, delivery starts after the
+     * Session's latest event and history is not replayed.
+     */
+    cursor?: string;
+    /** Called after each event's callbacks complete, with its cursor. Persist it to resume. */
+    onCursor?: (cursor: string) => void | Promise<void>;
+    /** Every event of the Session, in order, including types the SDK does not know. */
+    onEvent?: (event: SessionEvent) => void | Promise<void>;
+    /** Each completed Realtime user transcript. */
+    onTranscript?: (transcript: RealtimeTranscript) => void | Promise<void>;
+    /** Each completed Realtime model response. */
+    onResponse?: (response: RealtimeResponse) => void | Promise<void>;
+    /**
+     * Errors that do not end the connection: a callback that threw, an
+     * invalid event, a tool result the core did not accept. Without it they
+     * are rethrown asynchronously, which by default ends a Node.js process.
+     */
+    onError?: (error: unknown) => void;
+}
+/** Why a Session connection ended. */
+export type SessionConnectionEnd = 
+/** `close()` or `OrganizationClient.close()`. */
+{
+    reason: "closed";
+}
+/** Another connection attached the Session for execution. */
+ | {
+    reason: "superseded";
+}
+/** The Session was deleted. */
+ | {
+    reason: "session_deleted";
+}
+/** The connection could not be restored, for example after the Organization API Key was revoked. */
+ | {
+    reason: "error";
+    error: unknown;
+};
+/**
+ * A Session attached over this process's Backend Connections. It receives
+ * the Session's events, in order and without gaps, across reconnects and
+ * replica moves, until `close()` or until `closed` reports why it ended.
+ */
+export declare class SessionConnection {
+    #private;
+    readonly sessionId: string;
+    readonly userId: string;
+    /** Resolves once, with why the connection ended. */
+    readonly closed: Promise<SessionConnectionEnd>;
+    /** @internal Use `session.connect()`. */
+    constructor(pool: BackendConnectionPool, http: HttpClient, userId: string, sessionId: string, options: ConnectOptions, declarations: ClientToolDeclaration[] | undefined);
+    /**
+     * Cursor of the last event whose callbacks completed, or the Session's
+     * position when the connection attached if none has arrived since.
+     */
+    get cursor(): string | undefined;
+    /** The Session's attachment generation from the latest attach. */
+    get generation(): number | undefined;
+    /**
+     * Release the Session. Events stop, and calls published later go to no one
+     * until another connection attaches. Calls already running finish and
+     * their results are still submitted.
+     */
+    close(): Promise<void>;
+    /**
+     * Send a user message over the connection and wait for the Turn it starts,
+     * or the active Turn it steers. `onProgress` receives the assistant's draft
+     * from the pushed events; the result is read once the Turn finished, with
+     * the same shape and errors as `session.turn()`. A message whose answer was
+     * lost to a reconnect is sent again with the same `clientEventId`, which
+     * the core deduplicates.
+     */
+    send(text: string | [string, ...string[]], options?: SendOptions): Promise<TurnResult>;
+    /**
+     * Prepare the Session's Realtime connection and return what a device needs
+     * to join it directly: the WebSocket URL and a short-lived connect token.
+     * When a Realtime connection is already live, a new token for it is
+     * returned instead and `audio` is not applied.
+     */
+    realtimeGrant(input?: OpenRealtimeConnectionInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<RealtimeConnectGrant>;
+    /** @internal */
+    attach(): Promise<void>;
+}
+/** Check `connect()` options and turn tool handlers into declarations. */
+export declare function connectDeclarations(options: ConnectOptions): ClientToolDeclaration[] | undefined;
+/** Open a Session connection; resolves once the first attach took effect. */
+export declare function connectSession(http: HttpClient, pool: BackendConnectionPool | undefined, userId: string | undefined, sessionId: string, options?: ConnectOptions): Promise<SessionConnection>;
+//# sourceMappingURL=session-connection.d.ts.map

package/dist/session-connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-connection.d.ts","sourceRoot":"","sources":["../src/session-connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,qBAAqB,EAGtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAGL,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAoC,MAAM,WAAW,CAAC;AACzE,OAAO,EAGL,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EAC1B,MAAM,eAAe,CAAC;AACvB,OAAO,EAGL,KAAK,WAAW,EACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,gEAAgE;AAChE,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,uFAAuF;IACvF,UAAU,EAAE,IAAI,CAAC;IACjB,uCAAuC;IACvC,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC;;;OAGG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC;CACZ;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAEnE,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;AACjE,2CAA2C;AAC3C,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,mFAAmF;IACnF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,+CAA+C;IAC/C,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,8CAA8C;IAC9C,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC;AAED,sCAAsC;AACtC,MAAM,MAAM,oBAAoB;AAC9B,iDAAiD;AAC/C;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE;AACtB,6DAA6D;GAC3D;IAAE,MAAM,EAAE,YAAY,CAAA;CAAE;AAC1B,+BAA+B;GAC7B;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE;AAC/B,oGAAoG;GAClG;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAUxC;;;;GAIG;AACH,qBAAa,iBAAiB;;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAmB/C,yCAAyC;gBAEvC,IAAI,EAAE,qBAAqB,EAC3B,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,cAAc,EACvB,YAAY,EAAE,qBAAqB,EAAE,GAAG,SAAS;IA8BnD;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED,kEAAkE;IAClE,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B;;;;;;;OAOG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EACpC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC;IAetB;;;;;OAKG;IACG,aAAa,CACjB,KAAK,GAAE,2BAAgC,EACvC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GACjC,OAAO,CAAC,oBAAoB,CAAC;IA0BhC,gBAAgB;IACV,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAoJ9B;AAED,0EAA0E;AAC1E,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,cAAc,GACtB,qBAAqB,EAAE,GAAG,SAAS,CAsCrC;AAED,6EAA6E;AAC7E,wBAAsB,cAAc,CAClC,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,qBAAqB,GAAG,SAAS,EACvC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,CAS5B"}