@anweather/game-plugin-ssdk 1.24.0 → 1.26.0

package/dist-cjs/runtime/conformance.js

@@ -4,6 +4,7 @@ exports.runConformance = runConformance;
 exports.assertConformance = assertConformance;
 const node_util_1 = require("node:util");
 const version_1 = require("./version");
+const presentation_1 = require("./presentation");
 const conformance_1 = require("./live/conformance");
 function participantIds(n) {
     return Array.from({ length: n }, (_, i) => `00000000-0000-4000-8000-${String(i + 1).padStart(12, "0")}`);
@@ -34,6 +35,12 @@ async function runConformance(service, context, options = {}) {
         expect(minPlayers >= 1, `minPlayers ${metadata.minPlayers} < 1`);
         expect(maxPlayers >= minPlayers, `maxPlayers ${metadata.maxPlayers} < minPlayers ${metadata.minPlayers}`);
     });
+    if (metadata.presentation !== undefined) {
+        await check("GetMetadata: presentation is valid", async () => {
+            const problems = (0, presentation_1.validatePresentation)(metadata.presentation);
+            expect(problems.length === 0, problems.join("; "));
+        });
+    }
     await check("Health: ok, same gameType as metadata, current protocol version", async () => {
         const health = await service.Health({}, context);
         expect(health.status === "ok", `status is "${health.status}"`);

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.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_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");
@@ -13,6 +13,11 @@ Object.defineProperty(exports, "createRegistrationLoop", { enumerable: true, get
 var conformance_1 = require("./conformance");
 Object.defineProperty(exports, "runConformance", { enumerable: true, get: function () { return conformance_1.runConformance; } });
 Object.defineProperty(exports, "assertConformance", { enumerable: true, get: function () { return conformance_1.assertConformance; } });
+var presentation_1 = require("./presentation");
+Object.defineProperty(exports, "validatePresentation", { enumerable: true, get: function () { return presentation_1.validatePresentation; } });
+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; } });
 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

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_PRESENTATION_BYTES = exports.PRESENTATION_CATEGORIES = void 0;
+exports.validatePresentation = validatePresentation;
+exports.assertPresentation = assertPresentation;
+exports.PRESENTATION_CATEGORIES = ["classic", "strategy", "cards", "word", "wip"];
+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 SCHEMA = obj({
+    catalogue: obj({
+        title: str,
+        category: oneOf(...exports.PRESENTATION_CATEGORIES),
+        featured: bool,
+        poster: obj({ from: { kind: "token" }, to: { kind: "token" }, text: { kind: "token" } }),
+    }),
+    rules: { kind: "strings" },
+    board: obj({
+        layout: oneOf("fullscreen", "page"),
+        page: obj({ nameplates: oneOf("split", "below", "none"), fullBleed: bool }),
+        moveErrors: oneOf("platform", "board"),
+        nativeGestures: oneOf("suppress", "allow"),
+        recap: { kind: "falseOr", object: obj({ stepMs: { kind: "int", min: 100, max: 10_000 } }) },
+        host: obj({ overflowX: oneOf("auto", "hidden", "clip"), width: oneOf("fit", "full") }),
+    }),
+    rematch: obj({ seatNames: { kind: "strings", size: 2 } }),
+});
+const POSTER_TOKEN = /^([a-z]+-(50|[1-9]00|950)|white|black)$/;
+function validatePresentation(value) {
+    const problems = [];
+    const isObject = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+    const visit = (v, rule, path) => {
+        switch (rule.kind) {
+            case "string":
+                if (typeof v !== "string")
+                    problems.push(`${path} is not a string`);
+                return;
+            case "boolean":
+                if (typeof v !== "boolean")
+                    problems.push(`${path} is not a boolean`);
+                return;
+            case "oneOf":
+                if (typeof v !== "string" || !rule.values.includes(v))
+                    problems.push(`${path} is not one of ${rule.values.join(", ")}`);
+                return;
+            case "int":
+                if (!Number.isInteger(v) || v < rule.min || v > rule.max) {
+                    problems.push(`${path} is not an integer in ${rule.min}..${rule.max}`);
+                }
+                return;
+            case "strings":
+                if (!Array.isArray(v) || !v.every((s) => typeof s === "string"))
+                    problems.push(`${path} is not a list of strings`);
+                else if (rule.size !== undefined && v.length !== rule.size)
+                    problems.push(`${path} does not have ${rule.size} entries`);
+                return;
+            case "token":
+                if (typeof v !== "string" || !POSTER_TOKEN.test(v))
+                    problems.push(`${path} is not a palette token like "amber-700"`);
+                return;
+            case "falseOr":
+                if (v === false)
+                    return;
+                if (!isObject(v))
+                    problems.push(`${path} is neither false nor an object`);
+                else
+                    visit(v, rule.object, path);
+                return;
+            case "object":
+                if (!isObject(v)) {
+                    problems.push(`${path} is not an object`);
+                    return;
+                }
+                for (const [key, child] of Object.entries(v)) {
+                    const childRule = rule.fields[key];
+                    if (!childRule)
+                        problems.push(`${path}.${key} is not a known field`);
+                    else if (child !== undefined)
+                        visit(child, childRule, `${path}.${key}`);
+                }
+                return;
+        }
+    };
+    visit(value, SCHEMA, "presentation");
+    if (problems.length === 0) {
+        const bytes = Buffer.byteLength(JSON.stringify(value), "utf8");
+        if (bytes > exports.MAX_PRESENTATION_BYTES)
+            problems.push(`presentation is ${bytes} bytes; the limit is ${exports.MAX_PRESENTATION_BYTES}`);
+    }
+    return problems;
+}
+function assertPresentation(value) {
+    const problems = validatePresentation(value);
+    if (problems.length > 0)
+        throw new Error(`invalid presentation:\n  ${problems.join("\n  ")}`);
+}

package/dist-cjs/runtime/servePlugin.js

@@ -10,8 +10,22 @@ const express_2 = require("./express");
 const registration_1 = require("./registration");
 const version_1 = require("./version");
 const server_1 = require("./live/server");
+const presentation_1 = require("./presentation");
 const auth_1 = require("./auth");
 const permissiveValidation = () => undefined;
+function withPresentation(service, presentation) {
+    if (presentation === undefined)
+        return service;
+    return {
+        ...service,
+        GetMetadata: async (input, context) => {
+            const metadata = await service.GetMetadata(input, context);
+            return metadata.presentation === undefined
+                ? { ...metadata, presentation: presentation }
+                : metadata;
+        },
+    };
+}
 function createPluginApp(options) {
     const env = options.env ?? process.env;
     const port = Number(env.PORT ?? options.defaultPort ?? 0);
@@ -19,6 +33,9 @@ function createPluginApp(options) {
     const platformUrl = env.PLATFORM_URL || undefined;
     const backendBaseUrl = env.PLUGIN_BACKEND_BASE_URL || `http://localhost:${port}`;
     const log = options.log ?? console;
+    if (options.presentation !== undefined)
+        (0, presentation_1.assertPresentation)(options.presentation);
+    const definition = withPresentation(options.service, options.presentation);
     const service = (0, defaultService_1.createGamePluginService)({
         Health: async () => ({
             status: "ok",
@@ -26,7 +43,7 @@ function createPluginApp(options) {
             protocolVersion: version_1.PLUGIN_PROTOCOL_VERSION,
             runtimeVersion: (0, version_1.runtimeVersion)(),
         }),
-        ...options.service,
+        ...definition,
     });
     const handler = (0, GamePluginService_1.getGamePluginServiceHandler)(service, options.validationCustomizer ?? permissiveValidation);
     const app = (0, express_1.default)();

package/dist-cjs/src/models/models_0.js

@@ -600,6 +600,10 @@ var GameTypeMetadata;
                         memberValidators["live"] = new server_common_1.CompositeStructureValidator(new server_common_1.NoOpValidator(), LiveCapability.validate);
                         break;
                     }
+                    case "presentation": {
+                        memberValidators["presentation"] = new server_common_1.NoOpValidator();
+                        break;
+                    }
                 }
             }
             return memberValidators[member];
@@ -622,6 +626,7 @@ var GameTypeMetadata;
             ...getMemberValidator("hasSaveFileEditor").validate(obj.hasSaveFileEditor, `${path}/hasSaveFileEditor`),
             ...getMemberValidator("spaces").validate(obj.spaces, `${path}/spaces`),
             ...getMemberValidator("live").validate(obj.live, `${path}/live`),
+            ...getMemberValidator("presentation").validate(obj.presentation, `${path}/presentation`),
         ];
     };
 })(GameTypeMetadata || (exports.GameTypeMetadata = GameTypeMetadata = {}));

package/dist-cjs/src/protocols/Aws_restJson1.js

@@ -643,6 +643,7 @@ const serializeGetMetadataResponse = async (input, ctx) => {
         'live': _ => se_LiveCapability(_, context),
         'maxPlayers': [],
         'minPlayers': [],
+        'presentation': _ => se_Document(_, context),
         'spaces': _ => se_SpaceCapability(_, context),
         'spectatorSafe': [],
         'teamPlay': [],