@zaisma/game-server 1.8.0 → 1.10.0

package/src/room.d.ts

@@ -98,7 +98,8 @@ export interface Room {
     /**
      * When Zaisma will end this match, an ISO time, or null. Set once the game's hosting on Zaisma rooms
      * pauses for the month (its free allowance, or its developer's budget or credit, is used), an hour after
-     * the pause, so your game can save and tell its players (onEnding runs then); never set on your own server.
+     * the pause, so your game can save and tell its players (onEnding runs then); back to null when Zaisma calls the
+     * end off because the game's hosting started again (onEndingCancelled runs then). Never set on your own server.
      */
     readonly endsAt: string | null;
     /** Shown in room lists (the game page and Zaisma.rooms.list). A hidden room still works by code and link. */
@@ -541,6 +542,12 @@ export interface GameServer<S = any> {
      * the "ending" event. Never runs on your own server.
      */
     onEnding?(state: S, room: Room): HandlerResult<S>;
+    /**
+     * Zaisma called off the end onEnding announced, because the game's hosting started again (credit came in, its
+     * budget was raised or the month reset): room.endsAt is null again, the match goes on and takes new players.
+     * Runs once; each player's game also gets the "endingCancelled" event. Never runs on your own server.
+     */
+    onEndingCancelled?(state: S, room: Room): HandlerResult<S>;
     /**
      * The room restarted (Zaisma restarts its rooms on every update, and your own server may restart) and
      * came back with the state it last saved: restoreInfo.savedAt says when, and restoreInfo.lostDurationSec
@@ -634,7 +641,7 @@ export declare function readJoinAnswer(answer: unknown): {
     mistake: GameServerError;
 };
 /** Everything a game server object may have, in the order the docs give them. Anything else is refused. */
-export declare const GAME_SERVER_OPTIONS: readonly ["maximumPlayerCount", "maximumSpectatorCount", "ticksPerSec", "hostControlsEnabled", "idleCheck", "idleTimeoutSec", "awayMode", "seatHoldDurationSec", "stateSyncEnabled", "adultChatFilterEnabled", "reconnectTimeoutSec", "maximumRoomCountPerPlayer", "stateSaveIntervalSec", "setup", "onJoin", "canJoin", "onChat", "onMoved", "onLeave", "onSpectatorJoin", "onSpectatorLeave", "onAway", "onBack", "onMessage", "onBytes", "onPurchase", "onRefund", "onTick", "onEnding", "onRestored", "stateView", "onVersionUpdate", "onRequest", "schedules", "onSchedule", "onWebhook"];
+export declare const GAME_SERVER_OPTIONS: readonly ["maximumPlayerCount", "maximumSpectatorCount", "ticksPerSec", "hostControlsEnabled", "idleCheck", "idleTimeoutSec", "awayMode", "seatHoldDurationSec", "stateSyncEnabled", "adultChatFilterEnabled", "reconnectTimeoutSec", "maximumRoomCountPerPlayer", "stateSaveIntervalSec", "setup", "onJoin", "canJoin", "onChat", "onMoved", "onLeave", "onSpectatorJoin", "onSpectatorLeave", "onAway", "onBack", "onMessage", "onBytes", "onPurchase", "onRefund", "onTick", "onEnding", "onEndingCancelled", "onRestored", "stateView", "onVersionUpdate", "onRequest", "schedules", "onSchedule", "onWebhook"];
 export declare const ROOM_LIMITS: {
     /** Players in one room: what one room carries at 60 ticks a second (test/load/room-load.test.ts). */
     readonly maximumPlayerCount: 100;
@@ -843,6 +850,8 @@ export type ServerMessage = {
 } | {
     type: "ending";
     endsAt: string;
+} | {
+    type: "ending_cancelled";
 } | {
     type: "version_update";
     step: "coming" | "now";
@@ -883,6 +892,8 @@ export type ServerMessage = {
 } | {
     type: "blocks";
     playerIds: string[];
+} | {
+    type: "friend_request";
 } | {
     type: "chat";
     fromPlayerId: string;
@@ -950,6 +961,9 @@ export type ClientMessage = {
 } | {
     type: "unblock";
     playerId: string;
+} | {
+    type: "friend_request";
+    playerId: string;
 } | {
     type: "probe_answer";
     probeNumber: number;
@@ -1418,6 +1432,12 @@ export declare class RoomCore<S = any> {
     private tellBlocks;
     /** A player's game blocked a player in the room (a guest's block, or one just made), or took one back. */
     private sessionBlock;
+    /**
+     * A player's game page just sent another player here a friend request, or accepted theirs (docs/DECISIONS.md,
+     * "Friend requests in games"): the room tells that player's game to have their page look now, rather than at its next check-in.
+     * Zaisma's record is the request; this says only "look", never who it's from, so a lying client gains nothing.
+     */
+    private friendRequestTold;
     /** Players in the match who haven't walked away: what room lists and "playing now" count. */
     get playingCount(): number;
     /**
@@ -1664,6 +1684,11 @@ export declare class RoomCore<S = any> {
      * Only Zaisma rooms call it, when the game's hosting pauses.
      */
     startEnding(endsAt: string): void;
+    /**
+     * Zaisma calls off the end startEnding announced, since the game's hosting started again: endsAt is null, every
+     * player hears it and onEndingCancelled runs, once. Only Zaisma rooms call it.
+     */
+    cancelEnding(): void;
     /** End the match: everyone hears message and why (endReason), and their connections close. */
     end(message: string, endReason: EndReason): void;
     /** The players as every player's game lists them, with why each isn't playing. */

package/src/room.js

@@ -94,6 +94,7 @@ export const GAME_SERVER_OPTIONS = [
     "onRefund",
     "onTick",
     "onEnding",
+    "onEndingCancelled",
     "onRestored",
     "stateView",
     "onVersionUpdate",
@@ -1070,6 +1071,20 @@ export class RoomCore {
         this.tellBlocks();
         return null;
     }
+    /**
+     * A player's game page just sent another player here a friend request, or accepted theirs (docs/DECISIONS.md,
+     * "Friend requests in games"): the room tells that player's game to have their page look now, rather than at its next check-in.
+     * Zaisma's record is the request; this says only "look", never who it's from, so a lying client gains nothing.
+     */
+    friendRequestTold(playerId, message) {
+        const otherPlayerId = message.playerId;
+        if (typeof otherPlayerId !== "string" || otherPlayerId === playerId || !this.players.has(otherPlayerId))
+            return "bad_message";
+        if (this.hasBlockBetween(playerId, otherPlayerId))
+            return null;
+        this.sendText(otherPlayerId, JSON.stringify({ type: "friend_request" }));
+        return null;
+    }
     /** Players in the match who haven't walked away: what room lists and "playing now" count. */
     get playingCount() {
         return this.players.size - this.kept.size;
@@ -1690,6 +1705,8 @@ export class RoomCore {
                 return this.sessionBlock(playerId, message, true);
             case "unblock":
                 return this.sessionBlock(playerId, message, false);
+            case "friend_request":
+                return this.friendRequestTold(playerId, message);
             default:
                 // A type this room doesn't know, maybe from a newer SDK: counted and limited above, then ignored.
                 return typeof message.type === "string" ? null : "bad_message";
@@ -2210,6 +2227,19 @@ export class RoomCore {
         if (this.server.onEnding)
             this.run(() => this.server.onEnding(this.state, this.api), "onEnding");
     }
+    /**
+     * Zaisma calls off the end startEnding announced, since the game's hosting started again: endsAt is null, every
+     * player hears it and onEndingCancelled runs, once. Only Zaisma rooms call it.
+     */
+    cancelEnding() {
+        if (this.ended || this.endsAt === null)
+            return;
+        this.endsAt = null;
+        this.dirty = true;
+        this.sendEach(this.everyone(), JSON.stringify({ type: "ending_cancelled" }));
+        if (this.server.onEndingCancelled)
+            this.run(() => this.server.onEndingCancelled(this.state, this.api), "onEndingCancelled");
+    }
     /** End the match: everyone hears message and why (endReason), and their connections close. */
     end(message, endReason) {
         if (this.ended)