@antha/multiplayer-core 0.0.1

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 electrovir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @antha/multiplayer-core
+
+Core multiplayer room, API, and WebRTC utilities for Antha.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from './multiplayer-api/errors.js';
+export * from './multiplayer-api/multiplayer-api.js';
+export * from './multiplayer-api/multiplayer-client.js';
+export * from './multiplayer-api/multiplayer-controller.js';
+export * from './multiplayer-api/multiplayer-socket-messages.js';
+export * from './multiplayer-id.js';
+export * from './room-handler-server/mock-room-handler-server-api-client.js';
+export * from './room-handler-server/multiplayer-room-handler.js';
+export * from './webrtc/web-rtc-communication.js';
+export * from './webrtc/webrtc-controller.js';
+export * from './webrtc/webrtc-multiplayer-controller.js';

package/dist/index.js

@@ -0,0 +1,11 @@
+export * from './multiplayer-api/errors.js';
+export * from './multiplayer-api/multiplayer-api.js';
+export * from './multiplayer-api/multiplayer-client.js';
+export * from './multiplayer-api/multiplayer-controller.js';
+export * from './multiplayer-api/multiplayer-socket-messages.js';
+export * from './multiplayer-id.js';
+export * from './room-handler-server/mock-room-handler-server-api-client.js';
+export * from './room-handler-server/multiplayer-room-handler.js';
+export * from './webrtc/web-rtc-communication.js';
+export * from './webrtc/webrtc-controller.js';
+export * from './webrtc/webrtc-multiplayer-controller.js';

package/dist/multiplayer-api/errors.d.ts

@@ -0,0 +1,13 @@
+import { type SetOptionalAndNullable } from '@augment-vir/common';
+import { type RoomInput } from '../webrtc/webrtc-multiplayer-controller.js';
+/**
+ * This error is thrown when a multiplayer room connection is established but then intentionally
+ * rejected by the host client.
+ *
+ * @category Error
+ */
+export declare class RoomRejectionError extends Error {
+    readonly name = "RoomRejectionError";
+    readonly room: Readonly<Omit<RoomInput, 'roomPassword'>>;
+    constructor(room: Readonly<SetOptionalAndNullable<RoomInput, 'roomPassword'>>);
+}

package/dist/multiplayer-api/errors.js

@@ -0,0 +1,15 @@
+import { omitObjectKeys } from '@augment-vir/common';
+/**
+ * This error is thrown when a multiplayer room connection is established but then intentionally
+ * rejected by the host client.
+ *
+ * @category Error
+ */
+export class RoomRejectionError extends Error {
+    name = 'RoomRejectionError';
+    room;
+    constructor(room) {
+        super('Room connection rejected');
+        this.room = omitObjectKeys(room, ['roomPassword']);
+    }
+}

package/dist/multiplayer-api/multiplayer-api.d.ts

@@ -0,0 +1,215 @@
+import { type WebSocketClientMessageType, type WebSocketHostMessageType } from '@rest-vir/api';
+/**
+ * Shape definition for {@link MultiplayerClientRoom}.
+ *
+ * @category Internal
+ */
+export declare const multiplayerClientRoomShape: import("object-shape-tester").Shape<{
+    roomName: string;
+    roomId: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<import("../multiplayer-id.js").RoomId>>;
+    clientCount: number;
+    hasRoomPassword: boolean;
+}>;
+/**
+ * Room stats presented to clients when they fetch the current list of rooms.
+ *
+ * @category Internal
+ */
+export type MultiplayerClientRoom = typeof multiplayerClientRoomShape.runtimeType;
+/**
+ * Shape definition for {@link MultiplayerClientRooms}.
+ *
+ * @category Internal
+ */
+export declare const multiplayerClientRoomsShape: import("object-shape-tester").Shape<import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<Partial<Record<import("../multiplayer-id.js").RoomId, {
+    roomId: import("../multiplayer-id.js").RoomId;
+    roomName: string;
+    clientCount: number;
+    hasRoomPassword: boolean;
+}>>>>>;
+/**
+ * A collection of {@link MultiplayerClientRoom} instances.
+ *
+ * @category Internal
+ */
+export type MultiplayerClientRooms = typeof multiplayerClientRoomsShape.runtimeType;
+/**
+ * The default, or starting, port for the multiplayer API.
+ *
+ * @category Internal
+ */
+export declare const defaultMultiplayerApiPort = 9348;
+/**
+ * The default multiplayer API origin.
+ *
+ * @category Internal
+ */
+export declare const defaultMultiplayerApiOrigin: string;
+/**
+ * Multiplayer API root endpoint.
+ *
+ * @category Internal
+ */
+export declare const multiplayerRootEndpoint: Readonly<{
+    path: "/";
+    requests: {
+        readonly GET: {
+            readonly responses: {
+                readonly 200: {
+                    readonly responseData: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"ok">>;
+                };
+            };
+        };
+    };
+}>;
+/**
+ * Multiplayer API health endpoint.
+ *
+ * @category Internal
+ */
+export declare const multiplayerHealthEndpoint: Readonly<{
+    path: "/health";
+    requests: {
+        readonly GET: {
+            readonly responses: {
+                readonly 200: {
+                    readonly responseData: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<"ok">>;
+                };
+            };
+        };
+    };
+}>;
+/**
+ * Multiplayer room listing endpoint.
+ *
+ * @category Internal
+ */
+export declare const multiplayerRoomsEndpoint: Readonly<{
+    path: "/rooms";
+    requests: {
+        readonly GET: {
+            readonly responses: {
+                readonly 200: {
+                    readonly responseData: import("object-shape-tester").Shape<import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<Partial<Record<import("../multiplayer-id.js").RoomId, {
+                        roomId: import("../multiplayer-id.js").RoomId;
+                        roomName: string;
+                        clientCount: number;
+                        hasRoomPassword: boolean;
+                    }>>>>>;
+                };
+            };
+            readonly searchParams: {
+                readonly gameId: import("object-shape-tester").Shape<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TString]>>;
+            };
+        };
+    };
+}>;
+/**
+ * Multiplayer signaling WebSocket.
+ *
+ * @category Internal
+ */
+export declare const multiplayerConnectWebSocket: Readonly<{
+    path: "/connect";
+    clientMessage: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
+        clientId: import("../multiplayer-id.js").ClientId;
+        roomId: import("../multiplayer-id.js").RoomId;
+        roomName: string;
+    } & {
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.Answer;
+        data: {
+            type: import("../index.js").MultiplayerWebSocketMessageType.Answer;
+            sdp: string;
+        } | {
+            rejected: true;
+        };
+    }> | import("@sinclair/typebox").TUnsafe<{
+        clientId: import("../multiplayer-id.js").ClientId;
+        roomId: import("../multiplayer-id.js").RoomId;
+        roomName: string;
+    } & {
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.HostPing;
+        clientSecret: string;
+        clientCount: number;
+        roomPassword: string;
+    }> | import("@sinclair/typebox").TUnsafe<{
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        clientId: import("../multiplayer-id.js").ClientId;
+        roomId: import("../multiplayer-id.js").RoomId;
+        roomName: string;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.Offer;
+        data: {
+            type: import("../index.js").MultiplayerWebSocketMessageType.Offer;
+            sdp: string;
+        };
+    } & {
+        clientSecret: string;
+        roomPassword: string;
+    }>)[]>>;
+    hostMessage: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
+        clientId: import("../multiplayer-id.js").ClientId;
+        roomId: import("../multiplayer-id.js").RoomId;
+        roomName: string;
+    } & {
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.Answer;
+        data: {
+            type: import("../index.js").MultiplayerWebSocketMessageType.Answer;
+            sdp: string;
+        } | {
+            rejected: true;
+        };
+    }> | import("@sinclair/typebox").TUnsafe<{
+        clientId: import("../multiplayer-id.js").ClientId;
+        roomId: import("../multiplayer-id.js").RoomId;
+        roomName: string;
+    } & {
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.Offer;
+        data: {
+            type: import("../index.js").MultiplayerWebSocketMessageType.Offer;
+            sdp: string;
+        };
+    }> | import("@sinclair/typebox").TUnsafe<{
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.OfferResult;
+        hostClientId: import("../multiplayer-id.js").ClientId;
+    }> | import("@sinclair/typebox").TUnsafe<{
+        messageId: import("../multiplayer-id.js").SocketMessageId;
+    } & {
+        type: import("../index.js").MultiplayerWebSocketMessageType.Error;
+        errorMessage: string;
+    }>)[]>>;
+    searchParams: {
+        readonly gameId: import("object-shape-tester").Shape<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TString]>>;
+    };
+}>;
+/**
+ * Message sent from a multiplayer WebSocket client.
+ *
+ * @category Internal
+ */
+export type MultiplayerConnectClientMessage = WebSocketClientMessageType<typeof multiplayerConnectWebSocket>;
+/**
+ * Message sent from the multiplayer WebSocket host.
+ *
+ * @category Internal
+ */
+export type MultiplayerConnectHostMessage = WebSocketHostMessageType<typeof multiplayerConnectWebSocket>;
+/**
+ * The multiplayer API definition.
+ *
+ * @category Internal
+ */
+export declare const multiplayerApi: import("@rest-vir/api").ApiDefinition<"/" | "/health" | "/rooms", "/connect">;
+/** @category Internal */
+export type MultiplayerApi = typeof multiplayerApi;

package/dist/multiplayer-api/multiplayer-api.js

@@ -0,0 +1,123 @@
+import { defineApi, defineEndpoint, defineWebSocket, HttpMethod, HttpStatus, } from '@rest-vir/api';
+import { defineShape, exactShape, recordShape, tupleShape, unionShape } from 'object-shape-tester';
+import { buildUrl } from 'url-vir';
+import { multiplayerIdShapes } from '../multiplayer-id.js';
+import { answerMessageShape, errorMessageShape, forwardedOfferMessageShape, hostPingMessageShape, offerMessageShape, offerResultShape, } from './multiplayer-socket-messages.js';
+/**
+ * Shape definition for {@link MultiplayerClientRoom}.
+ *
+ * @category Internal
+ */
+export const multiplayerClientRoomShape = defineShape({
+    roomName: '',
+    roomId: multiplayerIdShapes.room(),
+    clientCount: -1,
+    hasRoomPassword: false,
+});
+/**
+ * Shape definition for {@link MultiplayerClientRooms}.
+ *
+ * @category Internal
+ */
+export const multiplayerClientRoomsShape = defineShape(recordShape({
+    keys: multiplayerIdShapes.room(),
+    values: multiplayerClientRoomShape,
+    partial: true,
+}));
+/**
+ * The default, or starting, port for the multiplayer API.
+ *
+ * @category Internal
+ */
+export const defaultMultiplayerApiPort = 9348;
+/**
+ * The default multiplayer API origin.
+ *
+ * @category Internal
+ */
+export const defaultMultiplayerApiOrigin = buildUrl('http://localhost', {
+    port: defaultMultiplayerApiPort,
+}).origin;
+/**
+ * Multiplayer API root endpoint.
+ *
+ * @category Internal
+ */
+export const multiplayerRootEndpoint = defineEndpoint({
+    path: '/',
+    requests: {
+        [HttpMethod.Get]: {
+            responses: {
+                [HttpStatus.Ok]: {
+                    responseData: exactShape('ok'),
+                },
+            },
+        },
+    },
+});
+/**
+ * Multiplayer API health endpoint.
+ *
+ * @category Internal
+ */
+export const multiplayerHealthEndpoint = defineEndpoint({
+    path: '/health',
+    requests: {
+        [HttpMethod.Get]: {
+            responses: {
+                [HttpStatus.Ok]: {
+                    responseData: exactShape('ok'),
+                },
+            },
+        },
+    },
+});
+/**
+ * Multiplayer room listing endpoint.
+ *
+ * @category Internal
+ */
+export const multiplayerRoomsEndpoint = defineEndpoint({
+    path: '/rooms',
+    requests: {
+        [HttpMethod.Get]: {
+            responses: {
+                [HttpStatus.Ok]: {
+                    responseData: multiplayerClientRoomsShape,
+                },
+            },
+            searchParams: {
+                gameId: tupleShape(''),
+            },
+        },
+    },
+});
+/**
+ * Multiplayer signaling WebSocket.
+ *
+ * @category Internal
+ */
+export const multiplayerConnectWebSocket = defineWebSocket({
+    path: '/connect',
+    clientMessage: unionShape(answerMessageShape, offerMessageShape, hostPingMessageShape),
+    hostMessage: unionShape(answerMessageShape, forwardedOfferMessageShape, offerResultShape, errorMessageShape),
+    searchParams: {
+        gameId: tupleShape(''),
+    },
+});
+/**
+ * The multiplayer API definition.
+ *
+ * @category Internal
+ */
+export const multiplayerApi = defineApi({
+    apiName: 'multiplayer-api',
+    endpoints: [
+        multiplayerRootEndpoint,
+        multiplayerHealthEndpoint,
+        multiplayerRoomsEndpoint,
+    ],
+    webSockets: [
+        multiplayerConnectWebSocket,
+    ],
+});

package/dist/multiplayer-api/multiplayer-client.d.ts

@@ -0,0 +1,25 @@
+import { RestVirClient, type FindPortOptions } from '@rest-vir/api';
+/**
+ * The output from {@link createMultiplayerApiClient}, regardless of what the given `serverOrigin`
+ * is.
+ *
+ * @category Main
+ */
+export type MultiplayerApiClient = Awaited<ReturnType<typeof createMultiplayerApiClient>>;
+/**
+ * Creates an API client for accessing the multiplayer server at the given origin.
+ *
+ * @category Main
+ */
+export declare function createMultiplayerApiClient({ backendOrigin, portScanOptions, }: {
+    backendOrigin?: string | undefined;
+    /**
+     * Set to `undefined` or `false` to disable port scanning. Set to `true` to enable port
+     * scanning. Set to an options object to configure port scanning.
+     */
+    portScanOptions: undefined | Omit<FindPortOptions, 'startOrigin'> | boolean;
+}): Promise<RestVirClient<{
+    apiName: string;
+    endpoints: Readonly<Record<"/" | "/health" | "/rooms", Readonly<import("@rest-vir/api").EndpointDefinition>>>;
+    webSockets: Readonly<Record<"/connect", Readonly<import("@rest-vir/api").WebSocketDefinition>>>;
+}>>;

package/dist/multiplayer-api/multiplayer-client.js

@@ -0,0 +1,18 @@
+import { check } from '@augment-vir/assert';
+import { findDevServerPort, RestVirClient } from '@rest-vir/api';
+import { defaultMultiplayerApiOrigin, multiplayerApi } from './multiplayer-api.js';
+/**
+ * Creates an API client for accessing the multiplayer server at the given origin.
+ *
+ * @category Main
+ */
+export async function createMultiplayerApiClient({ backendOrigin, portScanOptions, }) {
+    const initialOrigin = backendOrigin || defaultMultiplayerApiOrigin;
+    const foundPort = portScanOptions
+        ? await findDevServerPort(multiplayerApi, {
+            startOrigin: initialOrigin,
+            ...(!check.isBoolean(portScanOptions) && portScanOptions),
+        })
+        : undefined;
+    return new RestVirClient(multiplayerApi, foundPort?.origin || initialOrigin);
+}