@anweather/game-plugin-ssdk 1.26.0 → 1.28.0

package/dist-types/runtime/index.d.ts

@@ -6,7 +6,7 @@ export type { ServePluginOptions, PluginServiceDefinition, PluginApp, RunningPlu
 export { createRegistrationLoop } from "./registration";
 export type { RegistrationOptions, RegistrationLoop } 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 type { PluginPresentation, PresentationCategory } from "./presentation";
 export type { ConformanceOptions, ConformanceReport } from "./conformance";
 export { PLUGIN_PROTOCOL_VERSION, runtimeVersion } from "./version";

package/dist-types/runtime/presentation.d.ts

@@ -1,5 +1,15 @@
 export declare const PRESENTATION_CATEGORIES: readonly ["classic", "strategy", "cards", "word", "wip"];
 export type PresentationCategory = (typeof PRESENTATION_CATEGORIES)[number];
+/** First path segments the platform's site already uses, which a tutorial
+ * slug may not take, so `{site}/{slug}/tutorial` can never shadow a page
+ * (`/spaces/tutorial` stays a Space). The platform's
+ * TutorialDeclaration.RESERVED_SLUGS and presentation.schema.json carry the
+ * same list. */
+export declare const RESERVED_TUTORIAL_SLUGS: readonly ["api", "assets", "chats", "games", "health", "icons", "leaderboard", "nerdle", "players", "plugins", "save-files", "saved-data", "spaces", "style-guide", "tutorial", "tutorials", "wordle"];
+/** A tutorial slug: lowercase words joined by single hyphens. */
+export declare const TUTORIAL_SLUG_PATTERN: RegExp;
+/** The most seats a tutorial may declare. */
+export declare const MAX_TUTORIAL_PLAYERS = 16;
 /** The platform refuses a registration whose presentation serialises
  * larger than this. */
 export declare const MAX_PRESENTATION_BYTES: number;
@@ -59,6 +69,23 @@ export interface PluginPresentation {
     rematch?: {
         seatNames: [string, string];
     };
+    /** A tutorial deep link, `{site}/{slug}/tutorial`: opening it resumes the
+     * player's unfinished tutorial Game of this type, or creates one with
+     * `config` and starts it. */
+    tutorial?: {
+        /** The URL's friendly name, e.g. "spirit-island": lowercase words
+         * joined by hyphens, and none of RESERVED_TUTORIAL_SLUGS. */
+        slug: string;
+        /** Merged into the new Game's config, e.g. { "tutorial": true }. At
+         * least one field: a Game whose config holds every one of these keys
+         * and values is how the platform recognises a tutorial to resume. */
+        config: Record<string, unknown>;
+        /** Seats, the learner included; the rest are filled with bots at the
+         * default level. Default 1, and within GetMetadata's min..maxPlayers. */
+        players?: number;
+        /** E.g. "Learn Spirit Island": the link's label and the new Game's name. */
+        title?: string;
+    };
 }
 /** Every problem with `value` as a presentation, strictest reading: wrong
  * types, unknown enum values, and unknown fields. Empty means valid. */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@anweather/game-plugin-ssdk",
     "description": "Generated GamePlugin RPC types/server (plugin-protocol/model/game-plugin.smithy) plus a hand-written Express bridge and default-handler wrapper (./runtime) -- see plugin-protocol/CLAUDE.md's \"Publishing for cross-repo plugins\".",
-    "version": "1.26.0",
+    "version": "1.28.0",
     "scripts": {
         "build": "concurrently 'npm:build:cjs' 'npm:build:es' 'npm:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",