@volorio/games-dice 0.2.0

package/README.md

@@ -0,0 +1,22 @@
+# @volorio/games-dice
+
+Typed browser client for the Volorio Dice game.
+
+Install only the Dice package in the browser app. It depends on `@volorio/games-web` and `@volorio/games-core`; it does not accept a Volorio server API key.
+
+```ts
+import { VolorioDiceClient } from "@volorio/games-dice";
+
+const dice = new VolorioDiceClient({
+  gatewayUrl: "wss://games.volor.io/v1/games/gateway",
+  token: shortLivedGameTokenFromYourBackend,
+  gameInstanceId: "ginst_123",
+  playerId: "user_123",
+});
+
+await dice.connect();
+dice.onRoll((roll) => console.log(roll.playerId, roll.value));
+dice.roll();
+```
+
+Your backend creates the game session and game token through `@volorio/games-node` using the server API key.

package/dist/src/index.d.ts

@@ -0,0 +1,51 @@
+import type { VolorioGameProtocolError, VolorioGameSnapshot } from "@volorio/games-core";
+import { type VolorioGameWebSocketLike } from "@volorio/games-web";
+export interface VolorioDiceClientOptions {
+    gatewayUrl: string;
+    token: string;
+    gameInstanceId: string;
+    playerId: string;
+    websocketFactory?: (url: string) => VolorioGameWebSocketLike;
+    now?: () => number;
+}
+export interface VolorioDiceRoll {
+    playerId: string;
+    value: number;
+    stateVersion: number;
+    eventId: string;
+    occurredAt: string;
+}
+export interface VolorioDiceSnapshotState {
+    rolls: Array<{
+        actionId: string;
+        playerId: string;
+        value: number;
+    }>;
+}
+export type VolorioDiceRollHandler = (roll: VolorioDiceRoll) => void;
+export type VolorioDiceSnapshotHandler = (snapshot: VolorioGameSnapshot<VolorioDiceSnapshotState>) => void;
+export type VolorioDiceErrorHandler = (error: VolorioGameProtocolError | unknown) => void;
+export declare class VolorioDiceClient {
+    private readonly client;
+    private readonly rolls;
+    private readonly rollHandlers;
+    private readonly snapshotHandlers;
+    private readonly errorHandlers;
+    constructor(options: VolorioDiceClientOptions);
+    connect(lastKnownStateVersion?: number): Promise<void>;
+    reconnect(): Promise<void>;
+    disconnect(reason?: string): void;
+    roll(options?: {
+        actionId?: string;
+        expectedVersion?: number;
+    }): void;
+    onRoll(handler: VolorioDiceRollHandler): () => void;
+    onSnapshot(handler: VolorioDiceSnapshotHandler): () => void;
+    onError(handler: VolorioDiceErrorHandler): () => void;
+    getRolls(): VolorioDiceRoll[];
+    getLatestStateVersion(): number;
+    private handleEvent;
+    private handleSnapshot;
+    private emitError;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA4B,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACnH,OAAO,EAAyB,KAAK,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE1F,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,wBAAwB,CAAC;IAC7D,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;CACJ;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;AACrE,MAAM,MAAM,0BAA0B,GAAG,CAAC,QAAQ,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;AAC3G,MAAM,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,KAAK,IAAI,CAAC;AAE1F,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAC/C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgC;IAC7D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAoC;IACrE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;gBAEnD,OAAO,EAAE,wBAAwB;IAO7C,OAAO,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAIjC,IAAI,CAAC,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,IAAI;IAIzE,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,MAAM,IAAI;IAKnD,UAAU,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM,IAAI;IAK3D,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,MAAM,IAAI;IAKrD,QAAQ,IAAI,eAAe,EAAE;IAI7B,qBAAqB,IAAI,MAAM;IAI/B,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,SAAS;CAKlB"}

package/dist/src/index.js

@@ -0,0 +1,95 @@
+import { VolorioGamesWebClient } from "@volorio/games-web";
+export class VolorioDiceClient {
+    client;
+    rolls = [];
+    rollHandlers = [];
+    snapshotHandlers = [];
+    errorHandlers = [];
+    constructor(options) {
+        this.client = new VolorioGamesWebClient(options);
+        this.client.on("event", (event) => this.handleEvent(event));
+        this.client.on("snapshot", (snapshot) => this.handleSnapshot(snapshot));
+        this.client.on("error", (error) => this.emitError(error));
+    }
+    connect(lastKnownStateVersion) {
+        return this.client.connect(lastKnownStateVersion);
+    }
+    reconnect() {
+        return this.client.reconnect();
+    }
+    disconnect(reason) {
+        this.client.disconnect(reason);
+    }
+    roll(options = {}) {
+        this.client.sendAction("dice.roll", {}, options);
+    }
+    onRoll(handler) {
+        this.rollHandlers.push(handler);
+        return () => removeHandler(this.rollHandlers, handler);
+    }
+    onSnapshot(handler) {
+        this.snapshotHandlers.push(handler);
+        return () => removeHandler(this.snapshotHandlers, handler);
+    }
+    onError(handler) {
+        this.errorHandlers.push(handler);
+        return () => removeHandler(this.errorHandlers, handler);
+    }
+    getRolls() {
+        return this.rolls.map((roll) => ({ ...roll }));
+    }
+    getLatestStateVersion() {
+        return this.client.getLatestStateVersion();
+    }
+    handleEvent(event) {
+        if (event.type !== "dice.rolled") {
+            return;
+        }
+        const roll = readDiceRoll(event);
+        this.rolls.push(roll);
+        for (const handler of this.rollHandlers) {
+            handler({ ...roll });
+        }
+    }
+    handleSnapshot(snapshot) {
+        this.rolls.splice(0, this.rolls.length, ...snapshot.state.rolls.map((roll) => ({
+            playerId: roll.playerId,
+            value: roll.value,
+            stateVersion: snapshot.stateVersion,
+            eventId: `snapshot_${snapshot.stateVersion}_${roll.actionId}`,
+            occurredAt: snapshot.createdAt,
+        })));
+        for (const handler of this.snapshotHandlers) {
+            handler({
+                ...snapshot,
+                state: { rolls: snapshot.state.rolls.map((roll) => ({ ...roll })) },
+            });
+        }
+    }
+    emitError(error) {
+        for (const handler of this.errorHandlers) {
+            handler(error);
+        }
+    }
+}
+function readDiceRoll(event) {
+    const payload = event.payload;
+    if (typeof payload.playerId !== "string" || !Number.isInteger(payload.value)) {
+        throw new Error("invalid_dice_roll_event");
+    }
+    const value = payload.value;
+    return {
+        playerId: payload.playerId,
+        value,
+        stateVersion: event.stateVersion,
+        eventId: event.eventId,
+        occurredAt: event.occurredAt,
+    };
+}
+function removeHandler(handlers, handler) {
+    const index = handlers.indexOf(handler);
+    if (index >= 0) {
+        handlers.splice(index, 1);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAiC,MAAM,oBAAoB,CAAC;AA+B1F,MAAM,OAAO,iBAAiB;IACX,MAAM,CAAwB;IAC9B,KAAK,GAAsB,EAAE,CAAC;IAC9B,YAAY,GAA6B,EAAE,CAAC;IAC5C,gBAAgB,GAAiC,EAAE,CAAC;IACpD,aAAa,GAA8B,EAAE,CAAC;IAE/D,YAAY,OAAiC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAiC,CAAC,CAAC,CAAC;QACxF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAyD,CAAC,CAAC,CAAC;QACzH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,CAAC,qBAA8B;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpD,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;IAED,UAAU,CAAC,MAAe;QACxB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,CAAC,UAA2D,EAAE;QAChE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,OAA+B;QACpC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,UAAU,CAAC,OAAmC;QAC5C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CAAC,OAAgC;QACtC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,qBAAqB;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC;IAC7C,CAAC;IAEO,WAAW,CAAC,KAA+B;QACjD,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACxC,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,QAAuD;QAC5E,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,OAAO,EAAE,YAAY,QAAQ,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC7D,UAAU,EAAE,QAAQ,CAAC,SAAS;SAC/B,CAAC,CAAC,CAAC,CAAC;QACL,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,OAAO,CAAC;gBACN,GAAG,QAAQ;gBACX,KAAK,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,EAAE;aACpE,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,KAAc;QAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACzC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAA+B;IACnD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAkD,CAAC;IACzE,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAe,CAAC;IACtC,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK;QACL,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAI,QAAa,EAAE,OAAU;IACjD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACf,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@volorio/games-dice",
+  "version": "0.2.0",
+  "private": false,
+  "description": "Volorio Dice game client built on the Volorio Games Web runtime.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/src",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "test": "pnpm build && rm -rf dist-test && tsc -p tsconfig.json --outDir dist-test && node --test dist-test/test/*.js",
+    "pack:local": "pnpm build && npm pack --pack-destination dist"
+  },
+  "dependencies": {
+    "@volorio/games-core": "^0.2.0",
+    "@volorio/games-web": "^0.2.0"
+  }
+}