@anweather/game-plugin-ssdk 1.26.0 → 1.28.0

package/dist-es/runtime/index.js

@@ -3,7 +3,7 @@ export { createGamePluginService } from "./defaultService";
 export { servePlugin, createPluginApp } from "./servePlugin";
 export { createRegistrationLoop } from "./registration";
 export { runConformance, assertConformance } from "./conformance";
-export { validatePresentation, assertPresentation, PRESENTATION_CATEGORIES, MAX_PRESENTATION_BYTES } from "./presentation";
+export { validatePresentation, assertPresentation, PRESENTATION_CATEGORIES, MAX_PRESENTATION_BYTES, RESERVED_TUTORIAL_SLUGS, TUTORIAL_SLUG_PATTERN, MAX_TUTORIAL_PLAYERS, } from "./presentation";
 export { PLUGIN_PROTOCOL_VERSION, runtimeVersion } from "./version";
 export { createBlobClient, casUpdate, blobOwner, allBlobOwners, BlobStoreError, isVersionConflict } from "./blobClient";
 export { attachLive } from "./live/server";

package/dist-es/runtime/presentation.js

@@ -1,9 +1,16 @@
 export const PRESENTATION_CATEGORIES = ["classic", "strategy", "cards", "word", "wip"];
+export const RESERVED_TUTORIAL_SLUGS = [
+    "api", "assets", "chats", "games", "health", "icons", "leaderboard", "nerdle",
+    "players", "plugins", "save-files", "saved-data", "spaces", "style-guide",
+    "tutorial", "tutorials", "wordle",
+];
+export const TUTORIAL_SLUG_PATTERN = /^[a-z0-9]+(-[a-z0-9]+)*$/;
+export const MAX_TUTORIAL_PLAYERS = 16;
 export const 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,
@@ -21,6 +28,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: MAX_TUTORIAL_PLAYERS },
+        title: str,
+    }, ["slug", "config"]),
 });
 const POSTER_TOKEN = /^([a-z]+-(50|[1-9]00|950)|white|black)$/;
 export function validatePresentation(value) {
@@ -55,6 +68,18 @@ export 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" || !TUTORIAL_SLUG_PATTERN.test(v)) {
+                    problems.push(`${path} is not lowercase words joined by hyphens, like "spirit-island"`);
+                }
+                else if (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;
@@ -75,6 +100,10 @@ export 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;
         }
     };