@pieai/swimmer-game-server-kit 0.2.5 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -1
- package/dist/colyseus-adapter.js +25 -1
- package/dist/colyseus-adapter.js.map +1 -1
- package/dist/definition.d.ts +4 -0
- package/dist/definition.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,7 +62,7 @@ Install the exact reviewed npm version:
|
|
|
62
62
|
```json
|
|
63
63
|
{
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@pieai/swimmer-game-server-kit": "0.2.
|
|
65
|
+
"@pieai/swimmer-game-server-kit": "0.2.6"
|
|
66
66
|
}
|
|
67
67
|
}
|
|
68
68
|
```
|
|
@@ -138,6 +138,20 @@ server-side `allowReconnection`; an application-specific seat reservation alone
|
|
|
138
138
|
does not enable that transport flow. Intentional `leave()` does not emit a user
|
|
139
139
|
connection-failure callback and remains safe after the transport already closed.
|
|
140
140
|
|
|
141
|
+
A world with product-owned, reauthenticated seat recovery may implement
|
|
142
|
+
`emptyRoomGraceSeconds(): number`. After its last admitted transport leaves, the
|
|
143
|
+
Kit keeps that exact world and its simulation alive for that bounded duration.
|
|
144
|
+
Only a successful new admission clears the timer; failed/unauthorized attempts
|
|
145
|
+
cannot extend it. The product chooses the remaining window (zero for deliberate
|
|
146
|
+
departure), and still validates who can take each seat. This grants neither SDK
|
|
147
|
+
reconnection tokens nor automatic retries. Default/zero keeps Colyseus's ordinary
|
|
148
|
+
empty-room disposal, including rooms where nobody ever completed admission.
|
|
149
|
+
Invalid/nonfinite or timer-overflow durations fail closed. Expiry and shutdown
|
|
150
|
+
retire the world once and clear the timer; no permanent empty rooms are created.
|
|
151
|
+
|
|
152
|
+
This uses the official room `autoDispose`, `clock` and `disconnect` lifecycle,
|
|
153
|
+
not private Colyseus fields: https://docs.colyseus.io/room
|
|
154
|
+
|
|
141
155
|
## Auth Usage
|
|
142
156
|
|
|
143
157
|
```ts
|
package/dist/colyseus-adapter.js
CHANGED
|
@@ -7,6 +7,7 @@ export function createSwimmerColyseusRoom(definition) {
|
|
|
7
7
|
maxClients = definition.maxClients;
|
|
8
8
|
playerBySessionId = new Map();
|
|
9
9
|
world;
|
|
10
|
+
emptyRoomTimer;
|
|
10
11
|
async onAuth(_client, options) {
|
|
11
12
|
return authenticateRoomJoin(options, createAuthInput(definition));
|
|
12
13
|
}
|
|
@@ -42,8 +43,11 @@ export function createSwimmerColyseusRoom(definition) {
|
|
|
42
43
|
if (!playerId) {
|
|
43
44
|
throw new Error('Room is full.');
|
|
44
45
|
}
|
|
45
|
-
this.playerBySessionId.set(client.sessionId, playerId);
|
|
46
46
|
this.world.connectPlayer(playerId, joinContext);
|
|
47
|
+
this.playerBySessionId.set(client.sessionId, playerId);
|
|
48
|
+
this.emptyRoomTimer?.clear();
|
|
49
|
+
this.emptyRoomTimer = undefined;
|
|
50
|
+
this.autoDispose = true;
|
|
47
51
|
this.broadcastSnapshot();
|
|
48
52
|
}
|
|
49
53
|
onLeave(client) {
|
|
@@ -52,9 +56,29 @@ export function createSwimmerColyseusRoom(definition) {
|
|
|
52
56
|
return;
|
|
53
57
|
this.playerBySessionId.delete(client.sessionId);
|
|
54
58
|
this.world.disconnectPlayer(playerId);
|
|
59
|
+
if (this.playerBySessionId.size === 0 && this.clients.length === 0) {
|
|
60
|
+
const seconds = this.world.emptyRoomGraceSeconds?.() ?? 0;
|
|
61
|
+
if (!Number.isFinite(seconds) || seconds < 0 || seconds * 1000 > 2_147_483_647) {
|
|
62
|
+
throw new Error('Invalid empty-room grace period.');
|
|
63
|
+
}
|
|
64
|
+
if (seconds > 0) {
|
|
65
|
+
// The official room lifecycle would otherwise dispose the last
|
|
66
|
+
// client's world immediately. Keep its simulation alive, not its old
|
|
67
|
+
// transport/credentials. Rejoining still runs normal Auth/assignment.
|
|
68
|
+
this.autoDispose = false;
|
|
69
|
+
this.emptyRoomTimer = this.clock.setTimeout(() => {
|
|
70
|
+
this.emptyRoomTimer = undefined;
|
|
71
|
+
if (this.playerBySessionId.size === 0) {
|
|
72
|
+
void this.disconnect().catch(() => console.error('Empty room could not retire.'));
|
|
73
|
+
}
|
|
74
|
+
}, seconds * 1000);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
55
77
|
this.broadcastSnapshot();
|
|
56
78
|
}
|
|
57
79
|
onDispose() {
|
|
80
|
+
this.emptyRoomTimer?.clear();
|
|
81
|
+
this.emptyRoomTimer = undefined;
|
|
58
82
|
this.world?.dispose?.();
|
|
59
83
|
}
|
|
60
84
|
broadcastSnapshot(snapshot = this.world.snapshot()) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"colyseus-adapter.js","sourceRoot":"","sources":["../src/colyseus-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAwB,MAAM,WAAW,CAAC;AACvE,OAAO,EACL,0BAA0B,GAI3B,MAAM,iBAAiB,CAAC;AAQzB,MAAM,UAAU,yBAAyB,CAMvC,UAA6E;IAE7E,MAAM,QAAQ,GAAG,0BAA0B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEjE,OAAO,MAAM,4BAA6B,SAAQ,IAA0B;QACjE,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QAC3B,iBAAiB,GAAG,IAAI,GAAG,EAAqB,CAAC;QAC1D,KAAK,CAAgE;
|
|
1
|
+
{"version":3,"file":"colyseus-adapter.js","sourceRoot":"","sources":["../src/colyseus-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAwB,MAAM,WAAW,CAAC;AACvE,OAAO,EACL,0BAA0B,GAI3B,MAAM,iBAAiB,CAAC;AAQzB,MAAM,UAAU,yBAAyB,CAMvC,UAA6E;IAE7E,MAAM,QAAQ,GAAG,0BAA0B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEjE,OAAO,MAAM,4BAA6B,SAAQ,IAA0B;QACjE,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QAC3B,iBAAiB,GAAG,IAAI,GAAG,EAAqB,CAAC;QAC1D,KAAK,CAAgE;QACrE,cAAc,CAAsD;QAEnE,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,OAAkD;YACvF,OAAO,oBAAoB,CAAC,OAAO,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;QACpE,CAAC;QAEQ,QAAQ,CAAC,OAAiC;YACjD,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,WAAW,CACjC,OAAO,KAAK,SAAS;gBACnB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;gBACzB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,CACpD,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAErC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;gBACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC9D,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;oBACrD,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAS,OAAO,CAAC,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC3C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC9D,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;gBAC/B,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE;gBAC9B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;gBACzC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC,EAAE,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;QAEQ,MAAM,CACb,MAAc,EACd,OAAkD,EAClD,IAAuD;YAEvD,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;YACnC,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAChD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;QAEQ,OAAO,CAAC,MAAc;YAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ;gBAAE,OAAO;YACtB,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAChD,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,IAAI,CAAC,CAAC;gBAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,IAAI,GAAG,aAAa,EAAE,CAAC;oBAC/E,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;gBACtD,CAAC;gBACD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;oBAChB,+DAA+D;oBAC/D,qEAAqE;oBACrE,sEAAsE;oBACtE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;oBACzB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE;wBAC/C,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;wBAChC,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;4BACtC,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;wBACpF,CAAC;oBACH,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC;gBACrB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;QAEQ,SAAS;YAChB,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC;QAC1B,CAAC;QAEO,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACxD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAqC,CAAC,CAAC;QACzF,CAAC;QAEO,SAAS,CAAC,MAAc,EAAE,OAAe;YAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3C,CAAC;QAEO,WAAW,CAAC,MAAc;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;gBACnD,OAAO;YACT,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5E,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,UAAgE;IACvF,MAAM,KAAK,GAA+C;QACxD,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC;IACF,IAAI,UAAU,CAAC,IAAI,EAAE,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACrD,KAAK,CAAC,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC;IAC9D,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,EAAE,mBAAmB,KAAK,SAAS,EAAE,CAAC;QACvD,KAAK,CAAC,mBAAmB,GAAG,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC;IAClE,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,EAAE,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACrD,KAAK,CAAC,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC;IAC9D,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/C,KAAK,CAAC,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,MAAc,EACd,OAA6D,EAC7D,IAAkE;IAElE,OAAO;QACL,WAAW,EAAE,IAAI,EAAE,WAAW,IAAI,OAAO,EAAE,WAAW,IAAI,OAAO;QACjE,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,EAAE;QACxB,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,SAAS;YACzD,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;YACnC,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,EAAE,CAAC,OAAO,IAAI,EAAE,CAAiB;QACxC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,MAAM,EAAE,IAAI,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM,IAAI,EAAE;QAC7C,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,KAAK;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAS,OAAgB;IAClD,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QACjE,OAAQ,OAA6B,CAAC,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,OAAiB,CAAC;AAC3B,CAAC"}
|
package/dist/definition.d.ts
CHANGED
|
@@ -15,6 +15,10 @@ export interface SwimmerGameWorld<TInput, TSnapshot extends object, TPlayerId ex
|
|
|
15
15
|
assignPlayer(client: SwimmerJoinContext<TJoinOptions>): TPlayerId | null;
|
|
16
16
|
connectPlayer(playerId: TPlayerId, client: SwimmerJoinContext<TJoinOptions>): void;
|
|
17
17
|
disconnectPlayer(playerId: TPlayerId): void;
|
|
18
|
+
/** Optional bounded retention after the last admitted transport leaves.
|
|
19
|
+
* Called once for that departure, not for rejected joins. Zero/absence keeps
|
|
20
|
+
* Colyseus auto-disposal. Retention grants no seat or authentication rights. */
|
|
21
|
+
emptyRoomGraceSeconds?(): number;
|
|
18
22
|
restart?(actor?: TPlayerId): void;
|
|
19
23
|
setInput(playerId: TPlayerId, input: TInput): void;
|
|
20
24
|
snapshot(): TSnapshot;
|
package/dist/definition.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":"AAqEA,MAAM,CAAC,MAAM,0BAA0B,GAAwB;IAC7D,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAM/B,UAA6E;IAE7E,6BAA6B,CAAC,UAAU,CAAC,CAAC;IAC1C,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,QAAkD;IAElD,OAAO;QACL,GAAG,0BAA0B;QAC7B,GAAG,QAAQ;KACZ,CAAC;AACJ,CAAC;AAED,SAAS,6BAA6B,CAAC,UAAkD;IACvF,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACnF,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC5F,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,0BAA0B,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvF,CAAC;AACH,CAAC"}
|