@vrealtime/server 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @vrealtime/server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+vRealTime server: attach any WebSocket, Node serve(), Cloudflare Workers and Durable Objects
+
+Part of [vRealTime](https://github.com/austinchennn/vRT). Licensed under Apache-2.0.

package/dist/capabilities.d.ts

@@ -0,0 +1,13 @@
+import type { Capabilities } from '@vrealtime/core';
+/**
+ * A protocol capability (spec/capabilities.json) this server implements. It is
+ * offered only when the agent's model can support it, e.g. argument streaming.
+ */
+export interface CapabilityRule {
+    token: string;
+    available(model: Capabilities): boolean;
+}
+/** Every capability this server implements. */
+export declare const CAPABILITY_RULES: readonly CapabilityRule[];
+/** The tokens sessions of an agent with this model may negotiate. */
+export declare function supportedCapabilities(model: Capabilities, rules?: readonly CapabilityRule[]): ReadonlySet<string>;

package/dist/capabilities.js

@@ -0,0 +1,11 @@
+import { GLOBAL_TOOL_IDS_V1, TOOL_STREAM_V1 } from '@vrealtime/protocol';
+/** Every capability this server implements. */
+export const CAPABILITY_RULES = [
+    // Any model: without argument streaming a call goes straight from start to arguments-complete.
+    { token: TOOL_STREAM_V1, available: () => true },
+    { token: GLOBAL_TOOL_IDS_V1, available: () => true },
+];
+/** The tokens sessions of an agent with this model may negotiate. */
+export function supportedCapabilities(model, rules = CAPABILITY_RULES) {
+    return new Set(rules.filter((rule) => rule.available(model)).map((rule) => rule.token));
+}

package/dist/index.d.ts

@@ -0,0 +1,137 @@
+import { type AgentDefinition, type AgentSession, type AudioFormat, type Clock, type SessionConfig } from '@vrealtime/core';
+import { Inbox, Outbox, type ServerMessage, type Unsequenced, type WireAudioFormat } from '@vrealtime/protocol';
+/**
+ * The only socket surface the server needs. Runtimes with event-style sockets
+ * (browsers, Deno, Workers, `ws`) can pass the socket as-is; callback-style
+ * runtimes (Bun) call `connection.receive()` and `connection.closed()` instead.
+ */
+export interface WebSocketLike {
+    send(data: string | Uint8Array): void;
+    close(code?: number, reason?: string): void;
+    /** Bytes queued but not yet sent; enables backpressure when present. */
+    readonly bufferedAmount?: number;
+    addEventListener?(type: 'message' | 'close', listener: (event: {
+        data?: unknown;
+    }) => void): void;
+}
+/** Who is connected. `id` identifies the subject: a resume must come from the same `id`. */
+export interface Principal {
+    id: string;
+    [key: string]: unknown;
+}
+export interface AuthRequest {
+    /** `hello.auth`: a short-lived token sent in the first message, never in the URL. */
+    token: string | undefined;
+    /** `hello.context`, e.g. the document the app wants to work on. */
+    context: unknown;
+    /** Set when the client is resuming a session. */
+    sessionId: string | undefined;
+    /** Headers of the upgrade request, when the edge has them (cookies, origin). */
+    headers: Headers | undefined;
+}
+export interface AttachOptions {
+    /**
+     * Called for every `hello`, new or resumed. Return a principal to accept, or
+     * `null` / `undefined` / `false` (or throw) to refuse with `UNAUTHORIZED`.
+     * Without it every connection is accepted.
+     */
+    authenticate?: (request: AuthRequest) => Principal | null | undefined | false | Promise<Principal | null | undefined | false>;
+    /** Per-session config for new sessions (instructions, voice, transcription vocabulary...), from the principal and `hello.context`. */
+    configure?: (principal: Principal | undefined, hello: {
+        context: unknown;
+    }) => Partial<SessionConfig> | Promise<Partial<SessionConfig>>;
+    /** How long a session survives without a socket, waiting for a resume. Default 30 s. */
+    resumeWindowMs?: number;
+    /** Close a socket that sent nothing (not even `ping`) for this long. Default 45 s. */
+    heartbeatTimeoutMs?: number;
+    /** Queue outgoing frames while `bufferedAmount` exceeds this. Default 256 KiB. */
+    highWaterMark?: number;
+    /** Receives `context` messages and `hello.context` from the app. */
+    onContext?: (context: unknown, session: AgentSession) => void;
+    clock?: Clock;
+}
+export interface Connection {
+    /** Feed one incoming WebSocket message (text or binary). */
+    receive(data: unknown): void;
+    /** Tell the server the socket closed. */
+    closed(): void;
+    readonly sessionId: string | undefined;
+}
+export declare function toCoreFormat(format: WireAudioFormat | undefined): AudioFormat | undefined;
+export declare function toWireFormat(format: AudioFormat): WireAudioFormat;
+/** One agent session and everything that must survive a reconnect. */
+declare class LiveSession {
+    #private;
+    private readonly hub;
+    readonly principal: Principal | undefined;
+    readonly id: `${string}-${string}-${string}-${string}-${string}`;
+    readonly outbox: Outbox<ServerMessage>;
+    readonly inbox: Inbox;
+    session: AgentSession;
+    input: AudioFormat;
+    output: AudioFormat;
+    /** Negotiated when the session starts; fixed for its lifetime, resumes included. */
+    capabilities: readonly string[];
+    socket: SocketConnection | undefined;
+    expiry: unknown;
+    constructor(hub: Hub, principal: Principal | undefined);
+    bind(agentSession: AgentSession): void;
+    send(message: Unsequenced<ServerMessage>, epoch?: number): void;
+    /** Opens the session on the bound socket; `resumedFrom` is set on a resume. */
+    sendReady(resumedFrom?: number): void;
+    /** Re-sends everything after the client's last seen seq. False when that is no longer possible. */
+    resend(lastSeen: number): boolean;
+    detach(): void;
+    flush(): void;
+}
+declare class SocketConnection implements Connection {
+    #private;
+    private readonly hub;
+    private readonly socket;
+    private readonly headers?;
+    constructor(hub: Hub, socket: WebSocketLike, headers?: Headers | undefined);
+    get sessionId(): string | undefined;
+    congested(): boolean;
+    send(data: string | Uint8Array): void;
+    close(code: number, reason: string): void;
+    receive(data: unknown): void;
+    closed(): void;
+}
+/** Shares sessions between sockets, so a reconnecting app can resume. */
+export declare class Hub {
+    #private;
+    readonly agent: AgentDefinition;
+    readonly options: AttachOptions;
+    readonly clock: Clock;
+    readonly highWaterMark: number;
+    readonly heartbeatTimeoutMs: number;
+    /** Protocol capabilities sessions may negotiate: what this server implements and the agent's model supports. */
+    readonly capabilities: ReadonlySet<string>;
+    constructor(agent: AgentDefinition, options?: AttachOptions);
+    /** `headers` (of the upgrade request) are passed to `authenticate`. */
+    attach(socket: WebSocketLike, info?: {
+        headers?: Headers;
+    }): Connection;
+    /** Live sessions, connected or waiting for a resume. */
+    get size(): number;
+    close(): Promise<void>;
+    /** @internal */
+    adopt(live: LiveSession): void;
+    /** @internal */
+    find(id: string): LiveSession | undefined;
+    /** @internal */
+    forget(live: LiveSession): void;
+    /** @internal Keeps a socketless session for `resumeWindowMs`, then closes it. */
+    park(live: LiveSession): void;
+    /** @internal */
+    unpark(live: LiveSession): void;
+}
+/**
+ * Serves `agent` over one WebSocket using protocol v1. Sockets attached for the
+ * same agent share a hub, so a reconnecting app can resume its session.
+ * Options apply when the agent's hub is first created.
+ */
+export declare function attach(agent: AgentDefinition, socket: WebSocketLike, options?: AttachOptions, info?: {
+    headers?: Headers;
+}): Connection;
+export {};