@antha/multiplayer-core 0.17.0 → 0.18.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ 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 './multiplayer-player-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';

package/dist/index.js

@@ -4,6 +4,7 @@ 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 './multiplayer-player-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';

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

@@ -195,7 +195,7 @@ export declare class MultiplayerControllerRoomListEvent extends MultiplayerContr
  * @category Internal
  */
 export type MultiplayerControllerRoomListListener = (rooms: Readonly<MultiplayerClientRooms>) => MaybePromise<void>;
-declare const MultiplayerControllerClientEvent_base: (new (eventInitDict: {
+declare const MultiplayerControllerClientStatusEvent_base: (new (eventInitDict: {
     bubbles?: boolean;
     cancelable?: boolean;
     composed?: boolean;
@@ -250,7 +250,7 @@ declare const MultiplayerControllerClientEvent_base: (new (eventInitDict: {
     newMember: ClientId;
     lostHost: ClientId;
     lostMember: ClientId;
-}, "newHost" | "newMember" | "lostHost" | "lostMember">>, "multiplayer-controller-client">) & Pick<{
+}, "newHost" | "newMember" | "lostHost" | "lostMember">>, "multiplayer-controller-client-status">) & Pick<{
     new (type: string, eventInitDict?: EventInit): Event;
     prototype: Event;
     readonly NONE: 0;
@@ -282,7 +282,7 @@ declare const MultiplayerControllerClientEvent_base: (new (eventInitDict: {
     newMember: ClientId;
     lostHost: ClientId;
     lostMember: ClientId;
-}, "newHost" | "newMember" | "lostHost" | "lostMember">>, "multiplayer-controller-client">, "type">;
+}, "newHost" | "newMember" | "lostHost" | "lostMember">>, "multiplayer-controller-client-status">, "type">;
 /**
  * This is fired in the following situations:
  *
@@ -293,7 +293,7 @@ declare const MultiplayerControllerClientEvent_base: (new (eventInitDict: {
  *
  * @category Events
  */
-export declare class MultiplayerControllerClientEvent extends MultiplayerControllerClientEvent_base {
+export declare class MultiplayerControllerClientStatusEvent extends MultiplayerControllerClientStatusEvent_base {
 }
 declare const MultiplayerControllerConnectionEvent_base: (new (eventInitDict: {
     bubbles?: boolean;
@@ -320,7 +320,7 @@ export declare class MultiplayerControllerConnectionEvent extends MultiplayerCon
  *
  * @category Internal
  */
-export type AllMultiplayerRoomControllerEvents<Message extends JsonCompatibleValue> = MultiplayerControllerMessageEvent<Message> | MultiplayerControllerRoomListEvent | MultiplayerControllerClientEvent | MultiplayerControllerConnectionEvent;
+export type AllMultiplayerRoomControllerEvents<Message extends JsonCompatibleValue> = MultiplayerControllerMessageEvent<Message> | MultiplayerControllerRoomListEvent | MultiplayerControllerClientStatusEvent | MultiplayerControllerConnectionEvent;
 /**
  * A generic multiplayer room controller. It manages API connectivity, room discovery, WebRTC
  * signaling, and generic room messages. It does not impose a game-state synchronization strategy.
@@ -333,14 +333,14 @@ export declare class MultiplayerRoomController<Message extends JsonCompatibleVal
     static readonly events: {
         MultiplayerControllerMessageEvent: typeof MultiplayerControllerMessageEvent;
         MultiplayerControllerRoomListEvent: typeof MultiplayerControllerRoomListEvent;
-        MultiplayerControllerClientEvent: typeof MultiplayerControllerClientEvent;
+        MultiplayerControllerClientStatusEvent: typeof MultiplayerControllerClientStatusEvent;
         MultiplayerControllerConnectionEvent: typeof MultiplayerControllerConnectionEvent;
     };
     /** All events emitted by this controller. */
     readonly events: {
         MultiplayerControllerMessageEvent: typeof MultiplayerControllerMessageEvent;
         MultiplayerControllerRoomListEvent: typeof MultiplayerControllerRoomListEvent;
-        MultiplayerControllerClientEvent: typeof MultiplayerControllerClientEvent;
+        MultiplayerControllerClientStatusEvent: typeof MultiplayerControllerClientStatusEvent;
         MultiplayerControllerConnectionEvent: typeof MultiplayerControllerConnectionEvent;
     };
     static readonly knownErrors: {

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

@@ -60,7 +60,7 @@ export class MultiplayerControllerRoomListEvent extends defineTypedCustomEvent()
  *
  * @category Events
  */
-export class MultiplayerControllerClientEvent extends defineTypedCustomEvent()('multiplayer-controller-client') {
+export class MultiplayerControllerClientStatusEvent extends defineTypedCustomEvent()('multiplayer-controller-client-status') {
 }
 /**
  * Fires when the controller's connection state is updated.
@@ -81,7 +81,7 @@ export class MultiplayerRoomController extends ListenTarget {
     static events = {
         MultiplayerControllerMessageEvent,
         MultiplayerControllerRoomListEvent,
-        MultiplayerControllerClientEvent,
+        MultiplayerControllerClientStatusEvent,
         MultiplayerControllerConnectionEvent,
     };
     /** All events emitted by this controller. */
@@ -242,7 +242,7 @@ export class MultiplayerRoomController extends ListenTarget {
             this.dispatch(new MultiplayerControllerMessageEvent(event.sourceClientId, event.detail));
         });
         currentConnection.listen(WebrtcMultiplayerConnectionUpdateEvent, (event) => {
-            this.dispatch(new MultiplayerControllerClientEvent({
+            this.dispatch(new MultiplayerControllerClientStatusEvent({
                 detail: event.detail,
             }));
         });

package/dist/multiplayer-player-id.d.ts

@@ -0,0 +1,53 @@
+import { type Branded } from '@augment-vir/common';
+import { type ClientId } from './multiplayer-id.js';
+/**
+ * Separator for client id and player position in {@link MultiplayerPlayerId}.
+ *
+ * @category Internal
+ */
+export declare const multiplayerPlayerIdSeparator = ":";
+/**
+ * Raw, unbranded multiplayer id string for {@link MultiplayerPlayerId}.
+ *
+ * @category Internal
+ */
+export type RawMultiplayerIdString = `${string}${typeof multiplayerPlayerIdSeparator}${string}`;
+/**
+ * Identifies one player slot belonging to a multiplayer client.
+ *
+ * @category Internal
+ */
+export type MultiplayerPlayerId = Branded<RawMultiplayerIdString, 'multiplayer-player-id'>;
+/**
+ * Checks only that a value is a string; it does not validate the encoded client id or player
+ * position.
+ *
+ * @category Internal
+ */
+export declare const multiplayerPlayerIdShape: import("object-shape-tester").Shape<import("@sinclair/typebox").TUnsafe<MultiplayerPlayerId>>;
+/**
+ * The client and local slot encoded in a {@link MultiplayerPlayerId}.
+ *
+ * @category Internal
+ */
+export type MultiplayerPlayerIdParts = {
+    clientId: ClientId;
+    playerPosition: string;
+};
+/**
+ * Combines a peer id and its local player slot into a stable multiplayer player id.
+ *
+ * @category Util
+ */
+export declare function createMultiplayerPlayerId({ clientId, playerPosition, }: Readonly<{
+    clientId: ClientId;
+    playerPosition: string;
+}>): NoInfer<MultiplayerPlayerId>;
+/**
+ * Splits a multiplayer player id back into its peer id and local player slot.
+ *
+ * @category Util
+ */
+export declare function extractMultiplayerPlayerIdParts({ playerId, }: Readonly<{
+    playerId: MultiplayerPlayerId;
+}>): MultiplayerPlayerIdParts;

package/dist/multiplayer-player-id.js

@@ -0,0 +1,45 @@
+import { assert } from '@augment-vir/assert';
+import { applyBrand } from '@augment-vir/common';
+import { assertWrapValidShape, typedStringShape } from 'object-shape-tester';
+import { multiplayerIdShapes } from './multiplayer-id.js';
+/**
+ * Separator for client id and player position in {@link MultiplayerPlayerId}.
+ *
+ * @category Internal
+ */
+export const multiplayerPlayerIdSeparator = ':';
+/**
+ * Checks only that a value is a string; it does not validate the encoded client id or player
+ * position.
+ *
+ * @category Internal
+ */
+export const multiplayerPlayerIdShape = typedStringShape();
+/**
+ * Combines a peer id and its local player slot into a stable multiplayer player id.
+ *
+ * @category Util
+ */
+export function createMultiplayerPlayerId({ clientId, playerPosition, }) {
+    const validatedClientId = assertWrapValidShape(clientId, multiplayerIdShapes.client());
+    const playerId = `${validatedClientId}${multiplayerPlayerIdSeparator}${playerPosition}`;
+    assert.isNotIn(multiplayerPlayerIdSeparator, validatedClientId, 'Invalid client id.');
+    assert.isNotIn(multiplayerPlayerIdSeparator, playerPosition, 'Invalid client id.');
+    assert.isNotEmpty(playerPosition, 'Invalid player position.');
+    return applyBrand(playerId);
+}
+/**
+ * Splits a multiplayer player id back into its peer id and local player slot.
+ *
+ * @category Util
+ */
+export function extractMultiplayerPlayerIdParts({ playerId, }) {
+    const [clientId, playerPosition, ...extraParts] = playerId.split(multiplayerPlayerIdSeparator);
+    assert.isTruthy(clientId, 'Invalid multiplayer id.');
+    assert.isTruthy(playerPosition, 'Invalid multiplayer id.');
+    assert.isEmpty(extraParts, 'Invalid multiplayer id.');
+    return {
+        clientId: assertWrapValidShape(clientId, multiplayerIdShapes.client()),
+        playerPosition,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/multiplayer-core",
-    "version": "0.17.0",
+    "version": "0.18.0",
     "description": "Core functionalities for Antha multiplayer mods.",
     "keywords": [
         "vir",