@anweather/game-plugin-ssdk 1.26.0 → 1.28.0

package/dist-cjs/runtime/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_MEMBERSHIP_AGE_MS = exports.FakeSpaceClient = exports.NotASpaceMemberError = exports.SpaceApiError = exports.isAlreadyASpace = exports.createMembershipGuard = exports.createSpaceClient = exports.MAX_LINK_FRAME_BYTES = exports.LinkCloseCode = exports.LIVE_PATH = exports.LIVE_PROTOCOL_VERSION = exports.assertLiveConformance = exports.runLiveConformance = exports.loadRoomCheckpoint = exports.createLiveHarness = exports.attachLive = exports.isVersionConflict = exports.BlobStoreError = exports.allBlobOwners = exports.blobOwner = exports.casUpdate = exports.createBlobClient = exports.runtimeVersion = exports.PLUGIN_PROTOCOL_VERSION = exports.MAX_PRESENTATION_BYTES = exports.PRESENTATION_CATEGORIES = exports.assertPresentation = exports.validatePresentation = exports.assertConformance = exports.runConformance = exports.createRegistrationLoop = exports.createPluginApp = exports.servePlugin = exports.createGamePluginService = exports.mountSsdkHandler = void 0;
+exports.MAX_MEMBERSHIP_AGE_MS = exports.FakeSpaceClient = exports.NotASpaceMemberError = exports.SpaceApiError = exports.isAlreadyASpace = exports.createMembershipGuard = exports.createSpaceClient = exports.MAX_LINK_FRAME_BYTES = exports.LinkCloseCode = exports.LIVE_PATH = exports.LIVE_PROTOCOL_VERSION = exports.assertLiveConformance = exports.runLiveConformance = exports.loadRoomCheckpoint = exports.createLiveHarness = exports.attachLive = exports.isVersionConflict = exports.BlobStoreError = exports.allBlobOwners = exports.blobOwner = exports.casUpdate = exports.createBlobClient = exports.runtimeVersion = exports.PLUGIN_PROTOCOL_VERSION = exports.MAX_TUTORIAL_PLAYERS = exports.TUTORIAL_SLUG_PATTERN = exports.RESERVED_TUTORIAL_SLUGS = exports.MAX_PRESENTATION_BYTES = exports.PRESENTATION_CATEGORIES = exports.assertPresentation = exports.validatePresentation = exports.assertConformance = exports.runConformance = exports.createRegistrationLoop = exports.createPluginApp = exports.servePlugin = exports.createGamePluginService = exports.mountSsdkHandler = void 0;
 var express_1 = require("./express");
 Object.defineProperty(exports, "mountSsdkHandler", { enumerable: true, get: function () { return express_1.mountSsdkHandler; } });
 var defaultService_1 = require("./defaultService");
@@ -18,6 +18,9 @@ Object.defineProperty(exports, "validatePresentation", { enumerable: true, get:
 Object.defineProperty(exports, "assertPresentation", { enumerable: true, get: function () { return presentation_1.assertPresentation; } });
 Object.defineProperty(exports, "PRESENTATION_CATEGORIES", { enumerable: true, get: function () { return presentation_1.PRESENTATION_CATEGORIES; } });
 Object.defineProperty(exports, "MAX_PRESENTATION_BYTES", { enumerable: true, get: function () { return presentation_1.MAX_PRESENTATION_BYTES; } });
+Object.defineProperty(exports, "RESERVED_TUTORIAL_SLUGS", { enumerable: true, get: function () { return presentation_1.RESERVED_TUTORIAL_SLUGS; } });
+Object.defineProperty(exports, "TUTORIAL_SLUG_PATTERN", { enumerable: true, get: function () { return presentation_1.TUTORIAL_SLUG_PATTERN; } });
+Object.defineProperty(exports, "MAX_TUTORIAL_PLAYERS", { enumerable: true, get: function () { return presentation_1.MAX_TUTORIAL_PLAYERS; } });
 var version_1 = require("./version");
 Object.defineProperty(exports, "PLUGIN_PROTOCOL_VERSION", { enumerable: true, get: function () { return version_1.PLUGIN_PROTOCOL_VERSION; } });
 Object.defineProperty(exports, "runtimeVersion", { enumerable: true, get: function () { return version_1.runtimeVersion; } });

package/dist-cjs/runtime/presentation.js

@@ -1,14 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_PRESENTATION_BYTES = exports.PRESENTATION_CATEGORIES = void 0;
+exports.MAX_PRESENTATION_BYTES = exports.MAX_TUTORIAL_PLAYERS = exports.TUTORIAL_SLUG_PATTERN = exports.RESERVED_TUTORIAL_SLUGS = exports.PRESENTATION_CATEGORIES = void 0;
 exports.validatePresentation = validatePresentation;
 exports.assertPresentation = assertPresentation;
 exports.PRESENTATION_CATEGORIES = ["classic", "strategy", "cards", "word", "wip"];
+exports.RESERVED_TUTORIAL_SLUGS = [
+    "api", "assets", "chats", "games", "health", "icons", "leaderboard", "nerdle",
+    "players", "plugins", "save-files", "saved-data", "spaces", "style-guide",
+    "tutorial", "tutorials", "wordle",
+];
+exports.TUTORIAL_SLUG_PATTERN = /^[a-z0-9]+(-[a-z0-9]+)*$/;
+exports.MAX_TUTORIAL_PLAYERS = 16;
 exports.MAX_PRESENTATION_BYTES = 32 * 1024;
 const str = { kind: "string" };
 const bool = { kind: "boolean" };
 const oneOf = (...values) => ({ kind: "oneOf", values });
-const obj = (fields) => ({ kind: "object", fields });
+const obj = (fields, required) => ({ kind: "object", fields, required });
 const SCHEMA = obj({
     catalogue: obj({
         title: str,
@@ -26,6 +33,12 @@ const SCHEMA = obj({
         host: obj({ overflowX: oneOf("auto", "hidden", "clip"), width: oneOf("fit", "full") }),
     }),
     rematch: obj({ seatNames: { kind: "strings", size: 2 } }),
+    tutorial: obj({
+        slug: { kind: "slug" },
+        config: { kind: "nonEmptyObject" },
+        players: { kind: "int", min: 1, max: exports.MAX_TUTORIAL_PLAYERS },
+        title: str,
+    }, ["slug", "config"]),
 });
 const POSTER_TOKEN = /^([a-z]+-(50|[1-9]00|950)|white|black)$/;
 function validatePresentation(value) {
@@ -60,6 +73,18 @@ function validatePresentation(value) {
                 if (typeof v !== "string" || !POSTER_TOKEN.test(v))
                     problems.push(`${path} is not a palette token like "amber-700"`);
                 return;
+            case "slug":
+                if (typeof v !== "string" || !exports.TUTORIAL_SLUG_PATTERN.test(v)) {
+                    problems.push(`${path} is not lowercase words joined by hyphens, like "spirit-island"`);
+                }
+                else if (exports.RESERVED_TUTORIAL_SLUGS.includes(v)) {
+                    problems.push(`${path} "${v}" is reserved for one of the site's own pages`);
+                }
+                return;
+            case "nonEmptyObject":
+                if (!isObject(v) || Object.keys(v).length === 0)
+                    problems.push(`${path} is not an object with at least one field`);
+                return;
             case "falseOr":
                 if (v === false)
                     return;
@@ -80,6 +105,10 @@ function validatePresentation(value) {
                     else if (child !== undefined)
                         visit(child, childRule, `${path}.${key}`);
                 }
+                for (const key of rule.required ?? []) {
+                    if (v[key] === undefined)
+                        problems.push(`${path}.${key} is required`);
+                }
                 return;
         }
     };