@masonf539/game-sdk 1.0.0 → 1.0.1

package/README.md

@@ -17,6 +17,11 @@ routing through `GameClientContext.input`. GameHub treats installed packages
 as trusted code and does not expose its private room implementation through
 these contracts.
 
+Keybind defaults are validated `KeyboardEvent.code` values. Letters, numbers,
+arrows, Space, Enter, Escape, punctuation, and ordinary numpad keys are
+assignable; Tab, function keys, and standalone modifiers are reserved by the
+platform. Games must subscribe only to action IDs declared in their manifest.
+
 ## Releasing
 
 The package is configured for public npm publication. From the repository

package/dist/gameDefinition.d.ts

@@ -39,7 +39,10 @@ export type GameKeybind = {
     id: string;
     label: string;
     description?: string;
-    /** KeyboardEvent.code value, so defaults follow physical key positions. */
+    /**
+     * Assignable KeyboardEvent.code value. Tab, function keys, and standalone
+     * modifier keys are reserved by GameHub.
+     */
     defaultKey: string;
 };
 export type GameDefinition = {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export type { BooleanGameSetting, GameDefinition, GameKeybind, GamePreview, GameSetting, GameSettingValue, NumberGameSetting, RangeNumberGameSetting, SelectNumberGameSetting } from "./gameDefinition.js";
 export { gameHubGameApiVersion, type EmbeddedGameClient, type GameClientDelivery, type GamePluginManifest, type GamePluginPackage, type ModuleGameClient } from "./manifest.js";
 export type { GameActionEnvelope, GameActionResult, GameAudioApi, GameClientContext, GameClientInstance, GameClientModule, GameCompletion, GameEvent, GameEventEnvelope, GameLifecycleState, GameMember, GameMemberRole, GameInputApi, GamePlatformEvent, GameServerPlugin, GameSession, GameSessionContext, GameStateEnvelope, GameViewer } from "./plugin.js";
-export { GamePluginRegistry, GamePluginValidationError, validateGamePluginManifest } from "./registry.js";
+export { GamePluginRegistry, GamePluginValidationError, isAssignableKeyCode, validateGamePluginManifest } from "./registry.js";

package/dist/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateGamePluginManifest = exports.GamePluginValidationError = exports.GamePluginRegistry = exports.gameHubGameApiVersion = void 0;
+exports.validateGamePluginManifest = exports.isAssignableKeyCode = exports.GamePluginValidationError = exports.GamePluginRegistry = exports.gameHubGameApiVersion = void 0;
 var manifest_js_1 = require("./manifest.js");
 Object.defineProperty(exports, "gameHubGameApiVersion", { enumerable: true, get: function () { return manifest_js_1.gameHubGameApiVersion; } });
 var registry_js_1 = require("./registry.js");
 Object.defineProperty(exports, "GamePluginRegistry", { enumerable: true, get: function () { return registry_js_1.GamePluginRegistry; } });
 Object.defineProperty(exports, "GamePluginValidationError", { enumerable: true, get: function () { return registry_js_1.GamePluginValidationError; } });
+Object.defineProperty(exports, "isAssignableKeyCode", { enumerable: true, get: function () { return registry_js_1.isAssignableKeyCode; } });
 Object.defineProperty(exports, "validateGamePluginManifest", { enumerable: true, get: function () { return registry_js_1.validateGamePluginManifest; } });

package/dist/registry.d.ts

@@ -1,5 +1,6 @@
 import type { GameDefinition } from "./gameDefinition.js";
 import { type GamePluginManifest } from "./manifest.js";
+export declare function isAssignableKeyCode(code: string): boolean;
 export declare class GamePluginValidationError extends Error {
     constructor(message: string);
 }

package/dist/registry.js

@@ -1,12 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GamePluginRegistry = exports.GamePluginValidationError = void 0;
+exports.isAssignableKeyCode = isAssignableKeyCode;
 exports.validateGamePluginManifest = validateGamePluginManifest;
 const manifest_js_1 = require("./manifest.js");
 const identifierPattern = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const settingKeyPattern = /^[A-Za-z][A-Za-z0-9]*$/;
 const actionIdPattern = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
 const semanticVersionPattern = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/;
+const assignableKeyCodes = new Set([
+    "Escape", "Space", "Enter",
+    "ArrowUp", "ArrowDown", "ArrowLeft", "ArrowRight",
+    "Backquote", "Minus", "Equal", "BracketLeft", "BracketRight",
+    "Backslash", "Semicolon", "Quote", "Comma", "Period", "Slash",
+    "NumpadAdd", "NumpadSubtract", "NumpadMultiply", "NumpadDivide",
+    "NumpadDecimal", "NumpadEnter", "NumpadEqual", "NumpadComma"
+]);
+function isAssignableKeyCode(code) {
+    return /^(Key[A-Z]|Digit[0-9]|Numpad[0-9])$/.test(code) ||
+        assignableKeyCodes.has(code);
+}
 class GamePluginValidationError extends Error {
     constructor(message) {
         super(message);
@@ -118,6 +131,9 @@ function validateGamePluginManifest(manifest) {
         }
         requireNonEmpty(keybind.label, `${game.id}.${keybind.id} keybind label`);
         requireNonEmpty(keybind.defaultKey, `${game.id}.${keybind.id} default keybind`);
+        if (!isAssignableKeyCode(keybind.defaultKey)) {
+            throw new GamePluginValidationError(`${game.id}.${keybind.id} has an invalid default keybind: ${keybind.defaultKey}.`);
+        }
         if (defaultKeys.has(keybind.defaultKey)) {
             throw new GamePluginValidationError(`${game.id} assigns ${keybind.defaultKey} to multiple actions.`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masonf539/game-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Versioned contracts for GameHub game plugins.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",