@zaisma/game-server 1.10.0 → 1.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zaisma/game-server",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Run your Zaisma game server: the same rooms on Zaisma or on your own server.",
   "license": "MIT",
   "homepage": "https://zaisma.com",

package/sdk/zaisma.d.ts

@@ -566,6 +566,32 @@ declare namespace Zaisma {
    */
   const versions: Versions;
 
+  /**
+   * Whether Zaisma's page covers the game right now, so a game can pause or hold the player's input while it does.
+   * coveredBy is "sheet" while one of Zaisma's sheets is open over the game (buying, Players, Report: the player is
+   * busy with it), "card" while one of its cards is over the game's corner (Still there?, Keep your progress; the
+   * game stays in view and playable), and null otherwise. Always null outside Zaisma's page (your own site, a
+   * local test). Listen for "coveredBy" to hear each change.
+   * @example
+   * Zaisma.page.on("coveredBy", (coveredBy) => {
+   *   if (coveredBy === "sheet") pauseGame();
+   *   else resumeGame();
+   * });
+   */
+  const page: Page;
+
+  /** Whether Zaisma's page covers the game ({@link page}). */
+  interface Page {
+    /** "sheet", "card" or null: what of Zaisma's is over the game now. Read-only. */
+    readonly coveredBy: CoveredBy;
+    /** Listen for "coveredBy": called with the new value each time it changes. A wrong name fails with error.code "unknown_event". */
+    on(event: "coveredBy", listener: (coveredBy: CoveredBy) => void): Page;
+    off(event: "coveredBy", listener: (coveredBy: CoveredBy) => void): Page;
+  }
+
+  /** What of Zaisma's covers the game ({@link page}): one of its sheets, one of its cards, or nothing. */
+  type CoveredBy = "sheet" | "card" | null;
+
   /** A version published "now" ({@link versions}). */
   interface Versions {
     /** Listen for "update". A wrong name fails with error.code "unknown_event". */

package/sdk/zaisma.js

@@ -37,6 +37,7 @@
   var SAVES_EVENTS = ["conflict", "developerChange"];
   var ITEMS_EVENTS = ["purchase", "refund", "sheetOpen", "sheetClose"];
   var VERSIONS_EVENTS = ["update"];
+  var PAGE_EVENTS = ["coveredBy"];
   var BUY_OPTIONS = ["itemCount", "gameAccountId"];
   /** The room messages this SDK speaks (zaisma.d.ts: the wire protocol), sent in the hello. */
   var PROTOCOL_VERSION_NUMBER = 1;
@@ -2023,6 +2024,34 @@
     });
   }
 
+  /*
+   * Whether Zaisma's page covers the game: "sheet" while one of its sheets is open over it (buying, Players, Report), "card" while one of
+   * its cards is over the game's corner, null otherwise, and always null outside Zaisma's page. The page says so whenever it changes
+   * (zaisma:covered), and only the page is heard. A game can pause while a sheet covers it.
+   */
+  var pageEvents = new Emitter(PAGE_EVENTS, "Zaisma.page has");
+  var coveredBy = null;
+  var zaismaPage = {
+    on: function (event, listener) {
+      pageEvents.on(event, listener);
+      return zaismaPage;
+    },
+    off: function (event, listener) {
+      pageEvents.off(event, listener);
+      return zaismaPage;
+    },
+  };
+  Object.defineProperty(zaismaPage, "coveredBy", { enumerable: true, get: function () { return coveredBy; } });
+  if (config.site && window.parent !== window) {
+    window.addEventListener("message", function (event) {
+      if (event.origin !== config.site || event.source !== window.parent || !event.data || event.data.type !== "zaisma:covered") return;
+      var now = event.data.coveredBy === "sheet" || event.data.coveredBy === "card" ? event.data.coveredBy : null;
+      if (now === coveredBy) return;
+      coveredBy = now;
+      pageEvents._emit("coveredBy", now);
+    });
+  }
+
   /*
    * The player's cloud saves, for games that draw their own save screens. The game page on Zaisma holds
    * the player's session and answers (apps/site/src/saves-client.ts); the game never talks to a server.
@@ -2506,5 +2535,5 @@
   });
 
   var friends = { list: listFriends, setRoom: setOwnRoom, sendRequest: sendFriendRequest };
-  window.Zaisma = { sdkVersionNumber: 1, gameSlug: config.game || null, player: player, joinRoom: joinRoom, rooms: rooms, server: server, invite: invite, checkChat: checkChat, openPlayersPanel: openPlayersPanel, links: links, items: items, friends: friends, saves: saves, versions: versions };
+  window.Zaisma = { sdkVersionNumber: 1, gameSlug: config.game || null, player: player, joinRoom: joinRoom, rooms: rooms, server: server, invite: invite, checkChat: checkChat, openPlayersPanel: openPlayersPanel, links: links, items: items, friends: friends, saves: saves, versions: versions, page: zaismaPage };
 })();

package/src/qr-code.d.ts

@@ -1,13 +1,14 @@
 /**
  * QR codes for game and room links (docs/DECISIONS.md, "QR codes"): players get one behind Share,
- * developers on the dashboard and through the API and MCP. Byte mode, error correction level M,
- * versions 1 to 10 (up to 213 bytes, far more than a link needs). Written here rather than taken from a
+ * developers on the dashboard and through the API and MCP. Byte mode, error correction level H, so a
+ * small picture over its middle (a game's icon) still leaves it readable, versions 1 to 10 (up to 119
+ * bytes, far more than a link needs). Written here rather than taken from a
  * package so the site's page and the API draw the same code with no dependency; it follows ISO/IEC
  * 18004 the way Project Nayuki's reference encoder does.
  */
 export declare const QR_CODE_LIMITS: {
-    /** Version 10 at level M holds 213 bytes. */
-    readonly maximumTextBytes: 213;
+    /** Version 10 at level H holds 119 bytes. */
+    readonly maximumTextBytes: 119;
     /** Light modules around the code, as the standard asks. */
     readonly quietZoneModuleCount: 4;
 };

package/src/qr-code.js

@@ -1,21 +1,22 @@
 /**
  * QR codes for game and room links (docs/DECISIONS.md, "QR codes"): players get one behind Share,
- * developers on the dashboard and through the API and MCP. Byte mode, error correction level M,
- * versions 1 to 10 (up to 213 bytes, far more than a link needs). Written here rather than taken from a
+ * developers on the dashboard and through the API and MCP. Byte mode, error correction level H, so a
+ * small picture over its middle (a game's icon) still leaves it readable, versions 1 to 10 (up to 119
+ * bytes, far more than a link needs). Written here rather than taken from a
  * package so the site's page and the API draw the same code with no dependency; it follows ISO/IEC
  * 18004 the way Project Nayuki's reference encoder does.
  */
 export const QR_CODE_LIMITS = {
-    /** Version 10 at level M holds 213 bytes. */
-    maximumTextBytes: 213,
+    /** Version 10 at level H holds 119 bytes. */
+    maximumTextBytes: 119,
     /** Light modules around the code, as the standard asks. */
     quietZoneModuleCount: 4,
 };
-// Level M: error correction codewords per block and blocks, by version (index 0 unused).
-const ERROR_CORRECTION_CODEWORD_COUNTS_PER_BLOCK = [0, 10, 16, 26, 18, 24, 16, 18, 22, 22, 26];
-const ERROR_CORRECTION_BLOCK_COUNTS = [0, 1, 1, 1, 2, 2, 4, 4, 4, 5, 5];
-/** Error correction level M (medium)'s two bits in the format information. */
-const MEDIUM_CORRECTION_FORMAT_NUMBER = 0;
+// Level H: error correction codewords per block and blocks, by version (index 0 unused).
+const ERROR_CORRECTION_CODEWORD_COUNTS_PER_BLOCK = [0, 17, 28, 22, 16, 22, 28, 26, 26, 24, 28];
+const ERROR_CORRECTION_BLOCK_COUNTS = [0, 1, 1, 2, 4, 4, 4, 5, 6, 8, 8];
+/** Error correction level H (high)'s two bits in the format information. */
+const HIGH_CORRECTION_FORMAT_NUMBER = 2;
 const HIGHEST_VERSION_NUMBER = 10;
 const isBitSet = (bitsNumber, bitIndex) => ((bitsNumber >>> bitIndex) & 1) !== 0;
 function rawDataModuleCount(versionNumber) {
@@ -226,7 +227,7 @@ export function qrCodeModules(text) {
         }
     }));
     const drawFormat = (maskIndex) => {
-        const formatNumber = (MEDIUM_CORRECTION_FORMAT_NUMBER << 3) | maskIndex;
+        const formatNumber = (HIGH_CORRECTION_FORMAT_NUMBER << 3) | maskIndex;
         let remainderNumber = formatNumber;
         for (let stepIndex = 0; stepIndex < 10; stepIndex++)
             remainderNumber = (remainderNumber << 1) ^ ((remainderNumber >>> 9) * 0x537);