npm - @puzzmo/sdk - Versions diffs - 0.0.7 → 1.0.1 - Mend

@puzzmo/sdk 0.0.7 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (75) hide show

package/README.md +80 -260
package/dist/createSimulator-9IxV0l3_.js +2749 -0
package/dist/createSimulator-9IxV0l3_.js.map +1 -0
package/dist/createSimulator-DxhvbnJB.cjs +1428 -0
package/dist/createSimulator-DxhvbnJB.cjs.map +1 -0
package/dist/index.cjs +2 -2
package/dist/index.cjs.map +1 -1
package/dist/index.d.ts +3 -13
package/dist/index.d.ts.map +1 -1
package/dist/index.js +267 -14
package/dist/index.js.map +1 -1
package/dist/objectSpread2-C4RR_HMd.cjs +1 -0
package/dist/objectSpread2-CJo2CZQ6.js +76 -0
package/dist/sdk.d.ts +61 -0
package/dist/sdk.d.ts.map +1 -0
package/dist/simulator/createSimulator.d.ts +41 -0
package/dist/simulator/createSimulator.d.ts.map +1 -0
package/dist/simulator/fixtures.d.ts +18 -0
package/dist/simulator/fixtures.d.ts.map +1 -0
package/dist/simulator/index.cjs +1 -0
package/dist/simulator/index.d.ts +3 -0
package/dist/simulator/index.d.ts.map +1 -0
package/dist/simulator/index.js +2 -0
package/dist/simulator/messaging.d.ts +12 -0
package/dist/simulator/messaging.d.ts.map +1 -0
package/dist/simulator/standalone.cjs +2 -0
package/dist/simulator/standalone.cjs.map +1 -0
package/dist/simulator/standalone.d.ts +7 -0
package/dist/simulator/standalone.d.ts.map +1 -0
package/dist/simulator/standalone.js +19 -0
package/dist/simulator/standalone.js.map +1 -0
package/dist/simulator/state.d.ts +12 -0
package/dist/simulator/state.d.ts.map +1 -0
package/dist/simulator/styles.d.ts +2 -0
package/dist/simulator/styles.d.ts.map +1 -0
package/dist/simulator/types.d.ts +72 -0
package/dist/simulator/types.d.ts.map +1 -0
package/dist/simulator/views/AuthView.d.ts +3 -0
package/dist/simulator/views/AuthView.d.ts.map +1 -0
package/dist/simulator/views/CheckpointsView.d.ts +3 -0
package/dist/simulator/views/CheckpointsView.d.ts.map +1 -0
package/dist/simulator/views/CtrlView.d.ts +3 -0
package/dist/simulator/views/CtrlView.d.ts.map +1 -0
package/dist/simulator/views/DataView.d.ts +3 -0
package/dist/simulator/views/DataView.d.ts.map +1 -0
package/dist/simulator/views/DoneView.d.ts +3 -0
package/dist/simulator/views/DoneView.d.ts.map +1 -0
package/dist/simulator/views/FeaturesView.d.ts +4 -0
package/dist/simulator/views/FeaturesView.d.ts.map +1 -0
package/dist/simulator/views/MsgsView.d.ts +6 -0
package/dist/simulator/views/MsgsView.d.ts.map +1 -0
package/dist/simulator/views/ThemeView.d.ts +3 -0
package/dist/simulator/views/ThemeView.d.ts.map +1 -0
package/dist/simulator/views/ThumbView.d.ts +6 -0
package/dist/simulator/views/ThumbView.d.ts.map +1 -0
package/dist/simulator/views/index.d.ts +10 -0
package/dist/simulator/views/index.d.ts.map +1 -0
package/dist/themes.d.ts +46 -0
package/dist/themes.d.ts.map +1 -0
package/dist/types.d.ts +232 -0
package/dist/types.d.ts.map +1 -0
package/dist/vite.cjs +11 -0
package/dist/vite.cjs.map +1 -0
package/dist/vite.d.ts +16 -0
package/dist/vite.d.ts.map +1 -0
package/dist/vite.js +45 -0
package/dist/vite.js.map +1 -0
package/dist/workshop.d.ts +7 -175
package/dist/workshop.d.ts.map +1 -1
package/package.json +21 -19
package/dist/index.iife.js +0 -2
package/dist/index.iife.js.map +0 -1
package/dist/index.umd.js +0 -2
package/dist/index.umd.js.map +0 -1
package/dist/puzzmoSDK.d.ts +0 -237

package/dist/vite.js ADDED Viewed

@@ -0,0 +1,45 @@
+function e(e, t) {
+	if (e == null) return {};
+	var n = {};
+	for (var r in e) if ({}.hasOwnProperty.call(e, r)) {
+		if (t.includes(r)) continue;
+		n[r] = e[r];
+	}
+	return n;
+}
+function t(t, n) {
+	if (t == null) return {};
+	var r, i, a = e(t, n);
+	if (Object.getOwnPropertySymbols) {
+		var o = Object.getOwnPropertySymbols(t);
+		for (i = 0; i < o.length; i++) r = o[i], n.includes(r) || {}.propertyIsEnumerable.call(t, r) && (a[r] = t[r]);
+	}
+	return a;
+}
+var n = ["fixturesGlob"];
+/** Vite plugin that injects the Puzzmo simulator in dev mode and handles OAuth callbacks. */
+function r(e = {}) {
+	return {
+		name: "puzzmo-simulator",
+		apply: "serve",
+		configureServer(e) {
+			e.middlewares.use("/oauth/callback", (e, t) => {
+				t.setHeader("Content-Type", "text/html"), t.end("<!DOCTYPE html>\n<html><head><title>Puzzmo OAuth</title></head>\n<body><script>\nvar params = new URLSearchParams(window.location.search);\nvar returnUrl = sessionStorage.getItem(\"oauth_return_url\") || \"/\";\nvar url = new URL(returnUrl);\nparams.forEach(function(v, k) { url.searchParams.set(k, v); });\nwindow.location.href = url.toString();\n<\/script></body></html>");
+			});
+		},
+		transformIndexHtml() {
+			let { fixturesGlob: r } = e, i = t(e, n), a = ["import { createSimulator } from \"@puzzmo/sdk/simulator\""];
+			r && a.push(`const fixtures = import.meta.glob(${JSON.stringify(r)}, { eager: true })`);
+			let o = Object.entries(i).filter(([, e]) => e !== void 0).map(([e, t]) => `${e}: ${JSON.stringify(t)}`);
+			return r && o.push("fixtures"), a.push(`createSimulator({ ${o.join(", ")} })`), [{
+				tag: "script",
+				attrs: { type: "module" },
+				children: a.join("\n"),
+				injectTo: "head"
+			}];
+		}
+	};
+}
+export { r as puzzmoSimulator };
+//# sourceMappingURL=vite.js.map

package/dist/vite.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"vite.js","names":[],"sources":["../src/vite.ts"],"sourcesContent":["import type { Plugin } from \"vite\"\n\nexport type PuzzmoSimulatorPluginOptions = {\n /** Path to the puzzle JSON file (default: \"./sample-puzzle.json\") */\n puzzlePath?: string\n /** Whether to auto-start the game after READY (default: true) */\n autoStart?: boolean\n /** Initial collapsed state (default: true) */\n collapsed?: boolean\n /** Game slug for API features (e.g. \"crossword\", \"my-game\") */\n slug?: string\n /** Glob pattern for fixture files, passed to import.meta.glob (e.g. \"./fixtures/puzzles/**\\/*.json\") */\n fixturesGlob?: string\n}\n\n/** Vite plugin that injects the Puzzmo simulator in dev mode and handles OAuth callbacks. */\nexport function puzzmoSimulator(options: PuzzmoSimulatorPluginOptions = {}): Plugin {\n return {\n name: \"puzzmo-simulator\",\n apply: \"serve\",\n\n configureServer(server) {\n server.middlewares.use(\"/oauth/callback\", (_req, res) => {\n res.setHeader(\"Content-Type\", \"text/html\")\n res.end(`<!DOCTYPE html>\n<html><head><title>Puzzmo OAuth</title></head>\n<body><script>\nvar params = new URLSearchParams(window.location.search);\nvar returnUrl = sessionStorage.getItem(\"oauth_return_url\") || \"/\";\nvar url = new URL(returnUrl);\nparams.forEach(function(v, k) { url.searchParams.set(k, v); });\nwindow.location.href = url.toString();\n</script></body></html>`)\n })\n },\n\n transformIndexHtml() {\n const { fixturesGlob, ...config } = options\n\n const lines = [\n `import { createSimulator } from \"@puzzmo/sdk/simulator\"`,\n ]\n\n if (fixturesGlob) {\n lines.push(`const fixtures = import.meta.glob(${JSON.stringify(fixturesGlob)}, { eager: true })`)\n }\n\n const configEntries = Object.entries(config).filter(([, v]) => v !== undefined)\n const configParts = configEntries.map(([k, v]) => `${k}: ${JSON.stringify(v)}`)\n if (fixturesGlob) configParts.push(\"fixtures\")\n\n lines.push(`createSimulator({ ${configParts.join(\", \")} })`)\n\n return [\n {\n tag: \"script\",\n attrs: { type: \"module\" },\n children: lines.join(\"\\n\"),\n injectTo: \"head\",\n },\n ]\n },\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;SAqCc,eAAA;;AArBd,SAAgB,EAAgB,IAAwC,EAAE,EAAU;AAClF,QAAO;EACL,MAAM;EACN,OAAO;EAEP,gBAAgB,GAAQ;AACtB,KAAO,YAAY,IAAI,oBAAoB,GAAM,MAAQ;AAEvD,IADA,EAAI,UAAU,gBAAgB,YAAY,EAC1C,EAAI,IAAI,uXAQS;KACjB;;EAGJ,qBAAqB;GACnB,IAAM,EAAE,oBAAA,GAAiB,IAAA,EAAW,GAAA,EAAA,EAE9B,IAAQ,CACZ,4DACD;AAED,GAAI,KACF,EAAM,KAAK,qCAAqC,KAAK,UAAU,EAAa,CAAC,oBAAoB;GAInG,IAAM,IADgB,OAAO,QAAQ,EAAO,CAAC,QAAQ,GAAG,OAAO,MAAM,KAAA,EAAU,CAC7C,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,IAAI,KAAK,UAAU,EAAE,GAAG;AAK/E,UAJI,KAAc,EAAY,KAAK,WAAW,EAE9C,EAAM,KAAK,qBAAqB,EAAY,KAAK,KAAK,CAAC,KAAK,EAErD,CACL;IACE,KAAK;IACL,OAAO,EAAE,MAAM,UAAU;IACzB,UAAU,EAAM,KAAK,KAAK;IAC1B,UAAU;IACX,CACF;;EAEJ"}

package/dist/workshop.d.ts CHANGED Viewed

@@ -1,208 +1,40 @@
-import type { GameSettingsUIComponents } from "@puzzmo-com/shared/hostAPI";
-/**
- * Severity level for validation issues.
- *
- * - `error`: Critical issue that prevents puzzle from being valid
- * - `warning`: Issue that should be addressed but doesn't prevent usage
- * - `info`: Informational message about the puzzle
- */
+/** Severity level for validation issues */
 export type ValidationLevel = "error" | "warning" | "info";
-/** Represents a single validation issue found during puzzle validation. */
+/** Represents a single validation issue found during puzzle validation */
 export interface ValidationIssue {
-    /** Severity level of this validation issue */
     level: ValidationLevel;
-    /** Human-readable description of the issue */
     message: string;
-    /** Line number in the puzzle data where the issue occurs (1-indexed, optional) */
     line?: number;
-    /**
-     * Column position in the puzzle data where the issue occurs (1-indexed,
-     * optional)
-     */
     col?: number;
-    /** Length of the problematic text segment for highlighting (optional) */
     length?: number;
 }
-/**
- * Complete validation report for a puzzle. Contains the overall validation
- * status and any issues found.
- */
+/** Complete validation report for a puzzle */
 export interface ValidationReport {
-    /** Whether the puzzle passed validation without errors */
     success: boolean;
-    /** Array of validation issues found (errors, warnings, and info messages) */
     issues: ValidationIssue[];
 }
-/**
- * Types of errors that can occur during puzzle import.
- *
- * - `invalid_format`: The file format is not supported or recognized
- * - `parsing_error`: The file format is valid but parsing failed
- * - `unknown`: An unexpected error occurred during import
- */
 export type ImportErrorType = "invalid_format" | "parsing_error" | "unknown";
-/**
- * Custom error class for workshop import failures. Thrown by the `onImport`
- * function when a puzzle cannot be imported.
- *
- * @example
- *
- * ```typescript
- * throw new WorkshopImportError(
- *   "invalid_format",
- *   "Unsupported file extension: .xyz",
- * );
- * ```
- */
+/** Custom error class for workshop import failures */
 export declare class WorkshopImportError extends Error {
-    /** The category of import error */
     type: ImportErrorType;
-    /** Optional underlying error that caused the import to fail */
     originalError?: unknown | undefined;
-    constructor(
-    /** The category of import error */
-    type: ImportErrorType,
-    /** Human-readable error message */
-    message: string,
-    /** Optional underlying error that caused the import to fail */
-    originalError?: unknown | undefined);
+    constructor(type: ImportErrorType, message: string, originalError?: unknown | undefined);
 }
-/**
- * Result of a successful puzzle import operation. Contains the converted puzzle
- * data and optional metadata.
- */
+/** Result of a successful puzzle import operation */
 export interface ImportResult {
-    /**
-     * The converted puzzle data in the target format (e.g., XD format for
-     * crosswords)
-     */
     data: string;
-    /** Optional validation warnings about the imported puzzle */
     warnings?: ValidationIssue[];
-    /** Optional puzzle title extracted from the import file */
     title?: string;
-    /** Optional list of puzzle authors */
     authors?: string[];
-    /** Optional list of puzzle editors */
     editors?: string[];
 }
-/**
- * Main interface for a Workshop bundle. Workshop bundles are dynamically loaded
- * modules that provide game-specific functionality for puzzle validation and
- * import.
- *
- * @example
- *
- * ```typescript
- * // In your workshop bundle (e.g., games/crossword/src/workshop/index.ts)
- * export const validator = {
- *   validate(data: string): ValidationReport {
- *     // Custom validation logic
- *     return { success: true, issues: [] };
- *   },
- * };
- *
- * export const importer = {
- *   async onImport(
- *     filename: string,
- *     contents: string | ArrayBuffer,
- *   ): Promise<ImportResult> {
- *     // Custom import logic
- *     return { data: convertedData };
- *   },
- * };
- * ```
- */
+/** Main interface for a Workshop bundle */
 export interface WorkshopBundle {
-    /** Required validator for puzzle data validation */
     validator: {
-        /**
-         * Validates puzzle data and returns a report of issues.
-         *
-         * @param   data - The raw puzzle data string to validate
-         *
-         * @returns      Validation report with success status and any issues found
-         */
         validate(data: string): Promise<ValidationReport> | ValidationReport;
     };
-    /** Optional importer for converting external puzzle file formats */
     importer?: {
-        /**
-         * Imports a puzzle file and converts it to the game's native format. Should
-         * throw `WorkshopImportError` for known failure cases.
-         *
-         * @param   filename                     - Name of the file being imported
-         * @param   contents                     - Raw file contents (string for
-         *   text files, ArrayBuffer for binary)
-         *
-         * @returns          Import result with converted data and optional metadata
-         *
-         * @throws  {WorkshopImportError}          For invalid or unsupported files
-         */
         onImport(filename: string, contents: string | ArrayBuffer): Promise<ImportResult> | ImportResult;
     };
-    /**
-     * Optional settings configuration for embed customization in Workshop. Allows
-     * Workshop to render a settings form for configuring embed overrides.
-     */
-    settings?: {
-        /** UI component definitions for rendering the settings form */
-        components: GameSettingsUIComponents[];
-        /** Default values for all settings */
-        defaults: Record<string, unknown>;
-    };
-    /**
-     * Optional per-queue editor settings declaration. Shown on the queue page and
-     * passed to editor.mount() as config.settings.
-     */
-    editorSettings?: {
-        /** UI component definitions for rendering the editor settings form */
-        components: GameSettingsUIComponents[];
-        /** Default values for all settings */
-        defaults: Record<string, unknown>;
-    };
-    editor?: {
-        /** Called when first visiting a puzzle page. */
-        mount: (element: HTMLElement, config: {
-            puzzleString: string;
-            onChange: (puzzleString: string) => void;
-            theme: "light" | "dark";
-            width: number;
-            height: number;
-            /**
-             * Optional function for making chat completions from the editor (e.g.,
-             * for AI-assisted puzzle editing). This needs to be enabled for a team
-             * explicitly.
-             */
-            chatCompletion?: (prompt: string) => Promise<string>;
-            /**
-             * Optional function for fetching URLs from the editor (e.g., for
-             * fetching article content). This needs to be enabled for a team
-             * explicitly.
-             */
-            fetchURL?: (url: string) => Promise<{
-                status: number;
-                body: string;
-            }>;
-            /**
-             * Pre-configured editor settings values from the queue's
-             * editorSettings.
-             */
-            settings?: Record<string, unknown>;
-        }) => Promise<{
-            unmount: () => void;
-            /**
-             * Called whenever the puzzle string is updated in the editor from the
-             * outside, or when the theme or dimensions update. Workshop will rely on
-             * validator to reject / accept updates.
-             */
-            update: (config: {
-                puzzleString?: string;
-                theme?: "light" | "dark";
-                width?: number;
-                height?: number;
-            }) => void;
-        }>;
-    };
 }
 //# sourceMappingURL=workshop.d.ts.map

package/dist/workshop.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"workshop.d.ts","sourceRoot":"","sources":["../src/workshop.ts"],"names":[],"mappings":"AAAA,~~OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC~~;~~AAE3E;;;;;;GAMG;AACH~~,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,~~CAAC~~;~~AAE3D~~,~~2EAA2E~~;~~AAC3E~~,MAAM,WAAW,eAAe;IAC9B,~~8CAA8C;IAC9C,~~KAAK,EAAE,eAAe,~~CAAC~~;~~IACvB~~,~~8CAA8C;IAC9C,~~OAAO,EAAE,MAAM,~~CAAC~~;~~IAChB~~,~~kFAAkF;IAClF,~~IAAI,CAAC,EAAE,MAAM,~~CAAC~~;~~IACd;;;OAGG;IACH~~,GAAG,CAAC,EAAE,MAAM,~~CAAC~~;~~IACb~~,~~yEAAyE;IACzE,~~MAAM,CAAC,EAAE,MAAM,~~CAAC~~;~~CACjB~~;AAED~~;;;GAGG~~;~~AACH~~,MAAM,WAAW,gBAAgB;IAC/B,~~0DAA0D;IAC1D,~~OAAO,EAAE,OAAO,~~CAAC~~;~~IACjB~~,~~6EAA6E;IAC7E,~~MAAM,EAAE,eAAe,EAAE,~~CAAC~~;~~CAC3B~~;AAED~~;;;;;;GAMG;AACH~~,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,eAAe,GAAG,SAAS,~~CAAC~~;~~AAE7E;;;;;;;;;;;;GAYG~~;~~AACH~~,qBAAa,mBAAoB,SAAQ,KAAK;~~IAE1C~~,~~mCAAmC;IAC5B,~~IAAI,EAAE,eAAe;~~IAG5B,+DAA+D;IACxD~~,aAAa,CAAC,EAAE,OAAO~~;;IAL9B,mCAAmC~~;~~IAC5B~~,IAAI,EAAE,eAAe~~;IAC5B~~,~~mCAAmC;IACnC~~,OAAO,EAAE,MAAM~~;IACf,+DAA+D;IACxD~~,aAAa,CAAC,EAAE,OAAO,YAAA;CAKjC;AAED~~;;;GAGG~~;~~AACH~~,MAAM,WAAW,YAAY;IAC3B~~;;;OAGG;IACH~~,IAAI,EAAE,MAAM,~~CAAC~~;~~IACb~~,~~6DAA6D;IAC7D,~~QAAQ,CAAC,EAAE,eAAe,EAAE,~~CAAC~~;~~IAC7B~~,~~2DAA2D;IAC3D,~~KAAK,CAAC,EAAE,MAAM,~~CAAC~~;~~IACf~~,~~sCAAsC;IACtC,~~OAAO,CAAC,EAAE,MAAM,EAAE,~~CAAC~~;~~IACnB~~,~~sCAAsC;IACtC,~~OAAO,CAAC,EAAE,MAAM,EAAE,~~CAAC~~;~~CACpB~~;AAED~~;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG~~;~~AACH~~,MAAM,WAAW,cAAc;IAC7B,~~oDAAoD;IACpD,~~SAAS,EAAE;QACT~~;;;;;;WAMG;QACH~~,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,~~CAAC~~;~~KACtE~~,~~CAAC~~;~~IACF~~,~~oEAAoE;IACpE,~~QAAQ,CAAC,EAAE;QACT~~;;;;;;;;;;;WAWG;QACH~~,QAAQ,~~CACN~~,QAAQ,EAAE,MAAM,~~EAChB~~,QAAQ,EAAE,MAAM,GAAG,WAAW,~~GAC7B~~,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,~~CAAC~~;~~KACzC~~,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE;QACT,+DAA+D;QAC/D,UAAU,EAAE,wBAAwB,EAAE,CAAC;QACvC,sCAAsC;QACtC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,CAAC;IACF;;;OAGG;IACH,cAAc,CAAC,EAAE;QACf,sEAAsE;QACtE,UAAU,EAAE,wBAAwB,EAAE,CAAC;QACvC,sCAAsC;QACtC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,CAAC;IAEF,MAAM,CAAC,EAAE;QACP,gDAAgD;QAChD,KAAK,EAAE,CACL,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE;YACN,YAAY,EAAE,MAAM,CAAC;YACrB,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;YACzC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;YACf;;;;eAIG;YACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD;;;;eAIG;YACH,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,IAAI,EAAE,MAAM,CAAA;aAAE,CAAC,CAAC;YACtE;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC,KACE,OAAO,CAAC;YACX,OAAO,EAAE,MAAM,IAAI,CAAC;YACpB;;;;eAIG;YACH,MAAM,EAAE,CAAC,MAAM,EAAE;gBACf,YAAY,CAAC,EAAE,MAAM,CAAC;gBACtB,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;gBACzB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,MAAM,CAAC,EAAE,MAAM,CAAC;aACjB,KAAK,IAAI,CAAC;SACZ,CAAC,CAAC;KACJ,CAAC;CACH"}
1	+ {"version":3,"file":"workshop.d.ts","sourceRoot":"","sources":["../src/workshop.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;AAE1D,0EAA0E;AAC1E,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,eAAe,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,8CAA8C;AAC9C,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B;AAED,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAAA;AAE5E,sDAAsD;AACtD,qBAAa,mBAAoB,SAAQ,KAAK;IAEnC,IAAI,EAAE,eAAe;IAErB,aAAa,CAAC,EAAE,OAAO;gBAFvB,IAAI,EAAE,eAAe,EAC5B,OAAO,EAAE,MAAM,EACR,aAAa,CAAC,EAAE,OAAO,YAAA;CAKjC;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,2CAA2C;AAC3C,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE;QACT,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,CAAA;KACrE,CAAA;IACD,QAAQ,CAAC,EAAE;QACT,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAA;KACjG,CAAA;CACF"}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@puzzmo/sdk",
-  "version": "0.0.7",
-  "description": "Puzzmo runtime and API access for games",
+  "version": "1.0.1",
+  "description": "Puzzmo runtime SDK for game developers",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -11,19 +11,29 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./simulator": {
+      "types": "./dist/simulator/index.d.ts",
+      "import": "./dist/simulator/index.js",
+      "require": "./dist/simulator/index.cjs"
+    },
+    "./simulator/standalone": {
+      "types": "./dist/simulator/standalone.d.ts",
+      "import": "./dist/simulator/standalone.js",
+      "require": "./dist/simulator/standalone.cjs"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "import": "./dist/vite.js",
+      "require": "./dist/vite.cjs"
     }
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "generate-sdk": "tsx scripts/generateSDK.ts",
-    "generate-sdk:watch": "tsx scripts/generateSDK.ts --watch",
-    "copy-sdk-types": "cp src/puzzmoSDK.d.ts dist/puzzmoSDK.d.ts",
-    "build": "yarn generate-sdk && vite build && tsc --project tsconfig.build.json && yarn copy-sdk-types",
-    "type-check": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
+    "build": "vite build && tsc --project tsconfig.build.json",
+    "type-check": "tsc --noEmit"
   },
   "keywords": [
     "puzzmo",
@@ -34,20 +44,12 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/puzzmo-com/games.git",
+    "url": "git+https://github.com/puzzmo-com/oss.git",
     "directory": "packages/sdk"
   },
   "publishConfig": {
     "access": "public",
+    "provenance": true,
     "registry": "https://registry.npmjs.org/"
-  },
-  "devDependencies": {
-    "@puzzmo-com/shared": "^0.0.14781",
-    "prettier": "^3.6.2",
-    "prettier-plugin-jsdoc": "^1.5.0",
-    "tsx": "catalog:",
-    "typescript": "catalog:",
-    "vite": "catalog:",
-    "vitest": "catalog:"
   }
 }

package/dist/index.iife.js DELETED Viewed

	@@ -1,2 +0,0 @@
1	- var PuzzmoSDK=function(r){"use strict";class t extends Error{constructor(n,u,l){super(u),this.type=n,this.originalError=l,this.name="WorkshopImportError"}}function e(o){return{hello:()=>{console.log("Hello from Puzzmo SDK!",o)}}}return r.WorkshopImportError=t,r.createPuzzmoSDK=e,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"}),r}({});
2	- //# sourceMappingURL=index.iife.js.map

package/dist/index.iife.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"index.iife.js","sources":["../src/workshop.ts","../src/index.ts"],"sourcesContent":["import type { GameSettingsUIComponents } from \"@puzzmo-com/shared/hostAPI\";\n\n/**\n * Severity level for validation issues.\n *\n * - `error`: Critical issue that prevents puzzle from being valid\n * - `warning`: Issue that should be addressed but doesn't prevent usage\n * - `info`: Informational message about the puzzle\n */\nexport type ValidationLevel = \"error\" | \"warning\" | \"info\";\n\n/** Represents a single validation issue found during puzzle validation. */\nexport interface ValidationIssue {\n /** Severity level of this validation issue */\n level: ValidationLevel;\n /** Human-readable description of the issue */\n message: string;\n /** Line number in the puzzle data where the issue occurs (1-indexed, optional) */\n line?: number;\n /**\n * Column position in the puzzle data where the issue occurs (1-indexed,\n * optional)\n */\n col?: number;\n /** Length of the problematic text segment for highlighting (optional) */\n length?: number;\n}\n\n/**\n * Complete validation report for a puzzle. Contains the overall validation\n * status and any issues found.\n */\nexport interface ValidationReport {\n /** Whether the puzzle passed validation without errors */\n success: boolean;\n /** Array of validation issues found (errors, warnings, and info messages) */\n issues: ValidationIssue[];\n}\n\n/**\n * Types of errors that can occur during puzzle import.\n *\n * - `invalid_format`: The file format is not supported or recognized\n * - `parsing_error`: The file format is valid but parsing failed\n * - `unknown`: An unexpected error occurred during import\n */\nexport type ImportErrorType = \"invalid_format\" | \"parsing_error\" | \"unknown\";\n\n/**\n * Custom error class for workshop import failures. Thrown by the `onImport`\n * function when a puzzle cannot be imported.\n *\n * @example\n *\n * ```typescript\n * throw new WorkshopImportError(\n * \"invalid_format\",\n * \"Unsupported file extension: .xyz\",\n * );\n * ```\n */\nexport class WorkshopImportError extends Error {\n constructor(\n /** The category of import error */\n public type: ImportErrorType,\n /** Human-readable error message */\n message: string,\n /** Optional underlying error that caused the import to fail */\n public originalError?: unknown,\n ) {\n super(message);\n this.name = \"WorkshopImportError\";\n }\n}\n\n/**\n * Result of a successful puzzle import operation. Contains the converted puzzle\n * data and optional metadata.\n */\nexport interface ImportResult {\n /**\n * The converted puzzle data in the target format (e.g., XD format for\n * crosswords)\n */\n data: string;\n /** Optional validation warnings about the imported puzzle */\n warnings?: ValidationIssue[];\n /** Optional puzzle title extracted from the import file */\n title?: string;\n /** Optional list of puzzle authors */\n authors?: string[];\n /** Optional list of puzzle editors */\n editors?: string[];\n}\n\n/**\n * Main interface for a Workshop bundle. Workshop bundles are dynamically loaded\n * modules that provide game-specific functionality for puzzle validation and\n * import.\n *\n * @example\n *\n * ```typescript\n * // In your workshop bundle (e.g., games/crossword/src/workshop/index.ts)\n * export const validator = {\n * validate(data: string): ValidationReport {\n * // Custom validation logic\n * return { success: true, issues: [] };\n * },\n * };\n *\n * export const importer = {\n * async onImport(\n * filename: string,\n * contents: string | ArrayBuffer,\n * ): Promise<ImportResult> {\n * // Custom import logic\n * return { data: convertedData };\n * },\n * };\n * ```\n */\nexport interface WorkshopBundle {\n /** Required validator for puzzle data validation */\n validator: {\n /**\n * Validates puzzle data and returns a report of issues.\n *\n * @param data - The raw puzzle data string to validate\n *\n * @returns Validation report with success status and any issues found\n */\n validate(data: string): Promise<ValidationReport> | ValidationReport;\n };\n /** Optional importer for converting external puzzle file formats */\n importer?: {\n /**\n * Imports a puzzle file and converts it to the game's native format. Should\n * throw `WorkshopImportError` for known failure cases.\n *\n * @param filename - Name of the file being imported\n * @param contents - Raw file contents (string for\n * text files, ArrayBuffer for binary)\n *\n * @returns Import result with converted data and optional metadata\n *\n * @throws {WorkshopImportError} For invalid or unsupported files\n */\n onImport(\n filename: string,\n contents: string | ArrayBuffer,\n ): Promise<ImportResult> | ImportResult;\n };\n /**\n * Optional settings configuration for embed customization in Workshop. Allows\n * Workshop to render a settings form for configuring embed overrides.\n */\n settings?: {\n /** UI component definitions for rendering the settings form */\n components: GameSettingsUIComponents[];\n /** Default values for all settings */\n defaults: Record<string, unknown>;\n };\n /**\n * Optional per-queue editor settings declaration. Shown on the queue page and\n * passed to editor.mount() as config.settings.\n */\n editorSettings?: {\n /** UI component definitions for rendering the editor settings form */\n components: GameSettingsUIComponents[];\n /** Default values for all settings */\n defaults: Record<string, unknown>;\n };\n\n editor?: {\n /** Called when first visiting a puzzle page. */\n mount: (\n element: HTMLElement,\n config: {\n puzzleString: string;\n onChange: (puzzleString: string) => void;\n theme: \"light\" | \"dark\";\n width: number;\n height: number;\n /**\n * Optional function for making chat completions from the editor (e.g.,\n * for AI-assisted puzzle editing). This needs to be enabled for a team\n * explicitly.\n */\n chatCompletion?: (prompt: string) => Promise<string>;\n /**\n * Optional function for fetching URLs from the editor (e.g., for\n * fetching article content). This needs to be enabled for a team\n * explicitly.\n */\n fetchURL?: (url: string) => Promise<{ status: number; body: string }>;\n /**\n * Pre-configured editor settings values from the queue's\n * editorSettings.\n */\n settings?: Record<string, unknown>;\n },\n ) => Promise<{\n unmount: () => void;\n /**\n * Called whenever the puzzle string is updated in the editor from the\n * outside, or when the theme or dimensions update. Workshop will rely on\n * validator to reject / accept updates.\n */\n update: (config: {\n puzzleString?: string;\n theme?: \"light\" | \"dark\";\n width?: number;\n height?: number;\n }) => void;\n }>;\n };\n}\n","import { GameConfig } from \"./puzzmoSDK\";\n\n// Export the auto-generated public SDK types\nexport type * from \"./puzzmoSDK\";\n\n// Export workshop types\nexport * from \"./workshop\";\n\n/**\n * Creates a Puzzmo SDK instance\n *\n * @param config - Configuration options\n *\n * @returns A Puzzmo SDK instance\n */\nexport function createPuzzmoSDK(config: GameConfig) {\n return {\n hello: () => {\n console.log(\"Hello from Puzzmo SDK!\", config);\n },\n };\n}\n\nexport type PuzzmoSDK = ReturnType<typeof createPuzzmoSDK>;\n"],"names":["WorkshopImportError","type","message","originalError","createPuzzmoSDK","config"],"mappings":"uCA6DO,MAAMA,UAA4B,KAAM,CAC7C,YAESC,EAEPC,EAEOC,EACP,CACA,MAAMD,CAAO,EANN,KAAA,KAAAD,EAIA,KAAA,cAAAE,EAGP,KAAK,KAAO,qBACd,CACF,CC1DO,SAASC,EAAgBC,EAAoB,CAClD,MAAO,CACL,MAAO,IAAM,CACX,QAAQ,IAAI,yBAA0BA,CAAM,CAC9C,CAAA,CAEJ"}

package/dist/index.umd.js DELETED Viewed

	@@ -1,2 +0,0 @@
1	- (function(o,e){typeof exports=="object"&&typeof module!="undefined"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(o=typeof globalThis!="undefined"?globalThis:o\|\|self,e(o.PuzzmoSDK={}))})(this,function(o){"use strict";class e extends Error{constructor(n,i,s){super(i),this.type=n,this.originalError=s,this.name="WorkshopImportError"}}function t(r){return{hello:()=>{console.log("Hello from Puzzmo SDK!",r)}}}o.WorkshopImportError=e,o.createPuzzmoSDK=t,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});
2	- //# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"index.umd.js","sources":["../src/workshop.ts","../src/index.ts"],"sourcesContent":["import type { GameSettingsUIComponents } from \"@puzzmo-com/shared/hostAPI\";\n\n/**\n * Severity level for validation issues.\n *\n * - `error`: Critical issue that prevents puzzle from being valid\n * - `warning`: Issue that should be addressed but doesn't prevent usage\n * - `info`: Informational message about the puzzle\n */\nexport type ValidationLevel = \"error\" | \"warning\" | \"info\";\n\n/** Represents a single validation issue found during puzzle validation. */\nexport interface ValidationIssue {\n /** Severity level of this validation issue */\n level: ValidationLevel;\n /** Human-readable description of the issue */\n message: string;\n /** Line number in the puzzle data where the issue occurs (1-indexed, optional) */\n line?: number;\n /**\n * Column position in the puzzle data where the issue occurs (1-indexed,\n * optional)\n */\n col?: number;\n /** Length of the problematic text segment for highlighting (optional) */\n length?: number;\n}\n\n/**\n * Complete validation report for a puzzle. Contains the overall validation\n * status and any issues found.\n */\nexport interface ValidationReport {\n /** Whether the puzzle passed validation without errors */\n success: boolean;\n /** Array of validation issues found (errors, warnings, and info messages) */\n issues: ValidationIssue[];\n}\n\n/**\n * Types of errors that can occur during puzzle import.\n *\n * - `invalid_format`: The file format is not supported or recognized\n * - `parsing_error`: The file format is valid but parsing failed\n * - `unknown`: An unexpected error occurred during import\n */\nexport type ImportErrorType = \"invalid_format\" | \"parsing_error\" | \"unknown\";\n\n/**\n * Custom error class for workshop import failures. Thrown by the `onImport`\n * function when a puzzle cannot be imported.\n *\n * @example\n *\n * ```typescript\n * throw new WorkshopImportError(\n * \"invalid_format\",\n * \"Unsupported file extension: .xyz\",\n * );\n * ```\n */\nexport class WorkshopImportError extends Error {\n constructor(\n /** The category of import error */\n public type: ImportErrorType,\n /** Human-readable error message */\n message: string,\n /** Optional underlying error that caused the import to fail */\n public originalError?: unknown,\n ) {\n super(message);\n this.name = \"WorkshopImportError\";\n }\n}\n\n/**\n * Result of a successful puzzle import operation. Contains the converted puzzle\n * data and optional metadata.\n */\nexport interface ImportResult {\n /**\n * The converted puzzle data in the target format (e.g., XD format for\n * crosswords)\n */\n data: string;\n /** Optional validation warnings about the imported puzzle */\n warnings?: ValidationIssue[];\n /** Optional puzzle title extracted from the import file */\n title?: string;\n /** Optional list of puzzle authors */\n authors?: string[];\n /** Optional list of puzzle editors */\n editors?: string[];\n}\n\n/**\n * Main interface for a Workshop bundle. Workshop bundles are dynamically loaded\n * modules that provide game-specific functionality for puzzle validation and\n * import.\n *\n * @example\n *\n * ```typescript\n * // In your workshop bundle (e.g., games/crossword/src/workshop/index.ts)\n * export const validator = {\n * validate(data: string): ValidationReport {\n * // Custom validation logic\n * return { success: true, issues: [] };\n * },\n * };\n *\n * export const importer = {\n * async onImport(\n * filename: string,\n * contents: string | ArrayBuffer,\n * ): Promise<ImportResult> {\n * // Custom import logic\n * return { data: convertedData };\n * },\n * };\n * ```\n */\nexport interface WorkshopBundle {\n /** Required validator for puzzle data validation */\n validator: {\n /**\n * Validates puzzle data and returns a report of issues.\n *\n * @param data - The raw puzzle data string to validate\n *\n * @returns Validation report with success status and any issues found\n */\n validate(data: string): Promise<ValidationReport> | ValidationReport;\n };\n /** Optional importer for converting external puzzle file formats */\n importer?: {\n /**\n * Imports a puzzle file and converts it to the game's native format. Should\n * throw `WorkshopImportError` for known failure cases.\n *\n * @param filename - Name of the file being imported\n * @param contents - Raw file contents (string for\n * text files, ArrayBuffer for binary)\n *\n * @returns Import result with converted data and optional metadata\n *\n * @throws {WorkshopImportError} For invalid or unsupported files\n */\n onImport(\n filename: string,\n contents: string | ArrayBuffer,\n ): Promise<ImportResult> | ImportResult;\n };\n /**\n * Optional settings configuration for embed customization in Workshop. Allows\n * Workshop to render a settings form for configuring embed overrides.\n */\n settings?: {\n /** UI component definitions for rendering the settings form */\n components: GameSettingsUIComponents[];\n /** Default values for all settings */\n defaults: Record<string, unknown>;\n };\n /**\n * Optional per-queue editor settings declaration. Shown on the queue page and\n * passed to editor.mount() as config.settings.\n */\n editorSettings?: {\n /** UI component definitions for rendering the editor settings form */\n components: GameSettingsUIComponents[];\n /** Default values for all settings */\n defaults: Record<string, unknown>;\n };\n\n editor?: {\n /** Called when first visiting a puzzle page. */\n mount: (\n element: HTMLElement,\n config: {\n puzzleString: string;\n onChange: (puzzleString: string) => void;\n theme: \"light\" | \"dark\";\n width: number;\n height: number;\n /**\n * Optional function for making chat completions from the editor (e.g.,\n * for AI-assisted puzzle editing). This needs to be enabled for a team\n * explicitly.\n */\n chatCompletion?: (prompt: string) => Promise<string>;\n /**\n * Optional function for fetching URLs from the editor (e.g., for\n * fetching article content). This needs to be enabled for a team\n * explicitly.\n */\n fetchURL?: (url: string) => Promise<{ status: number; body: string }>;\n /**\n * Pre-configured editor settings values from the queue's\n * editorSettings.\n */\n settings?: Record<string, unknown>;\n },\n ) => Promise<{\n unmount: () => void;\n /**\n * Called whenever the puzzle string is updated in the editor from the\n * outside, or when the theme or dimensions update. Workshop will rely on\n * validator to reject / accept updates.\n */\n update: (config: {\n puzzleString?: string;\n theme?: \"light\" | \"dark\";\n width?: number;\n height?: number;\n }) => void;\n }>;\n };\n}\n","import { GameConfig } from \"./puzzmoSDK\";\n\n// Export the auto-generated public SDK types\nexport type * from \"./puzzmoSDK\";\n\n// Export workshop types\nexport * from \"./workshop\";\n\n/**\n * Creates a Puzzmo SDK instance\n *\n * @param config - Configuration options\n *\n * @returns A Puzzmo SDK instance\n */\nexport function createPuzzmoSDK(config: GameConfig) {\n return {\n hello: () => {\n console.log(\"Hello from Puzzmo SDK!\", config);\n },\n };\n}\n\nexport type PuzzmoSDK = ReturnType<typeof createPuzzmoSDK>;\n"],"names":["WorkshopImportError","type","message","originalError","createPuzzmoSDK","config"],"mappings":"mPA6DO,MAAMA,UAA4B,KAAM,CAC7C,YAESC,EAEPC,EAEOC,EACP,CACA,MAAMD,CAAO,EANN,KAAA,KAAAD,EAIA,KAAA,cAAAE,EAGP,KAAK,KAAO,qBACd,CACF,CC1DO,SAASC,EAAgBC,EAAoB,CAClD,MAAO,CACL,MAAO,IAAM,CACX,QAAQ,IAAI,yBAA0BA,CAAM,CAC9C,CAAA,CAEJ"}

package/dist/puzzmoSDK.d.ts DELETED Viewed

@@ -1,237 +0,0 @@
-/** Puzzmo SDK Type Definitions. */
-/**
- * The API contract between the Puzzmo game runtime, and the game. Contains a
- * space for different objects to handle responsibilities (via the
- * delegates/loaders)
- */
-export type GameConfig = {
-  /**
-   * An agreement between the game runner, and the games implementation
-   * details about the fns in this type any breaking changes to how the run
-   * time works will need to be handled by looking at this string version.
-   */
-  runtimeContract?: "1.0";
-  /** The functions for setting up the game state */
-  loader: GameDataLoader;
-  /**
-   * Get updates from the user-oriented changes to the puzzle board: either
-   * everything or one when it's useful
-   */
-  stateSubscriber?: GameStateSubscriber;
-  /** Lets the game DI in the color scheme for a game */
-  theme: Theme;
-  /** Lets a game handle lifecycle events which come from the host downwards */
-  setLifecycleSubscriber: (sub: () => GameLifecycleSubscriber) => void;
-};
-/**
- * The way to think about is is the lifecycle subscriber is that it provides
- * hooks which the game will listen to
- */
-export type GameLifecycleSubscriber = {
-  /**
-   * When the theme changes in the Puzzmo app, also update the theme in the
-   * embed/game.
-   */
-  updateTheme: (theme: Theme) => void;
-  /** App starts the timer when it is ready */
-  startGame: () => void;
-};
-/** A dumb 'json object' settings thing */
-export type GameSettingsUIComponents =
-  | {
-      id: string;
-      type: "title";
-      value: string;
-    }
-  | {
-      id: string;
-      type: "subtitle";
-      value: string;
-    }
-  | {
-      id: string;
-      type: "paragraph";
-      value: string;
-    }
-  | {
-      id: string;
-      type: "text";
-      name: string;
-      defaultValue: string;
-      title: string;
-      subtitle?: string | (() => any);
-      textarea?: true;
-    }
-  | {
-      id: string;
-      type: "number";
-      name: string;
-      defaultValue: number;
-      values: number[];
-      title: string;
-      subtitle?: string;
-    }
-  | {
-      id: string;
-      type: "boolean";
-      name: string;
-      defaultValue: boolean;
-      title: string;
-      subtitle?: string;
-    }
-  | {
-      id: string;
-      type: "enum";
-      name: string;
-      defaultValue: string;
-      values: string[];
-      displays: string[];
-      title: string;
-      subtitle?: string;
-    }
-  | {
-      id: string;
-      type: "setOptions";
-      label: string;
-      title: string;
-      subtitle?: string;
-      values: any;
-      bgKey: keyof Theme;
-      colorKey: keyof Theme;
-    }
-  | {
-      id: string;
-      type: "separator";
-      key: string;
-    }
-  | {
-      id: string;
-      type: "split";
-      content: GameSettingsUIComponents[];
-    };
-/**
- * An object which if set will receive internal state updates and callbacks from
- * the inside the game.
- */
-export type GameStateSubscriber = {
-  /** The callback when a game is completed */
-  gameCompleted: (
-    /** The internal state string of the completed game */
-    state: string,
-    /**
-     * The essentials, though metrics* fields are replaced by deeds which can be
-     * accessed via `config`
-     */
-    play: Partial<GamePlay>,
-    /** These are legacy options, newer games will send an empty [] */
-    pipelineStats: any[] | null,
-    // For a small period of time, we sent leaderboards and deeds in this and the next arg positions, so you
-    // should take into account that a game may send these from the past
-    // Older game builds would not send this object
-    config?: AugmentationConfig,
-  ) => void;
-  /** This function will get called whenever the user's state has changed */
-  userInputStringChanged: (state: string, play?: Partial<GamePlay>) => void;
-  /** The callback when a game has started booting up */
-  gameLaunched?: (state: any, gameRuntimeContractVersion: string) => void;
-  /** The callback when game victory animation has finished */
-  showGameCompleteScreen: (
-    context: MessagesSentFromEmbed["SHOW_GAME_COMPLETE_SCREEN"],
-  ) => void;
-};
-export interface KeyboardConfig {
-  /**
-   * Whether the keyboard should be shown. Optional legacy property.
-   *
-   * @deprecated Use the showKeyboard prop on PlayGameKeyboard instead
-   */
-  show?: boolean;
-  /**
-   * Custom CSS styles to apply to individual keys, keyed by the character.
-   * These styles are merged with the general keyStyles for each key.
-   */
-  individualKeyStyles?: {
-    [key: string]: {
-      text: CSSProperties;
-      background: CSSProperties;
-    };
-  };
-  /**
-   * Custom CSS styles to apply to individual keys. Can be either React
-   * CSSProperties or a string-based style object for compatibility with
-   * different styling systems.
-   */
-  keyStyles?:
-    | CSSProperties
-    | {
-        [prop: string]: string;
-      };
-  /**
-   * Custom CSS styles to apply to the entire keyboard container. Uses
-   * string-based properties for maximum compatibility.
-   */
-  kbdStyles?: {
-    [prop: string]: string;
-  };
-  /**
-   * Enables drag cursor functionality, allowing users to drag across the
-   * keyboard to position a cursor before releasing to select a key. Useful
-   * for precise input.
-   */
-  supportsDragCursor: boolean;
-  /**
-   * Defines the keyboard layout as rows of characters. Can be either:
-   *
-   * - A 4-tuple for standard QWERTY-style layouts [row1, row2, row3, row4?]
-   * - An array of strings/nulls for custom layouts (null = empty row) Each
-   *   string represents one row, with each character being one key.
-   */
-  layout: [string, string, string, string | undefined] | (string | null)[];
-  /**
-   * Maps character keys to display symbols or special commands. Key =
-   * character in layout, Value = what to display/send to game Example: { "≥":
-   * ">" } displays ">" but sends "≥" to the game
-   */
-  symbols: Record<string, string>;
-  /**
-   * Set of keys that should be visually highlighted (different background
-   * color). Commonly used to indicate special keys or current selection
-   * state.
-   */
-  highlight: Set<string>;
-  /**
-   * Set of keys that should be disabled (non-interactive, grayed out). Used
-   * to prevent input of invalid characters in current game state.
-   */
-  disabled: Set<string>;
-  /**
-   * Set of keys that should be extra-large (17.85% width vs normal 9.75%).
-   * Typically used for important keys like space or enter.
-   */
-  xl: Set<string>;
-  /**
-   * Set of keys that should be large (14.7% width vs normal 9.75%). Used for
-   * moderately important keys that need more space.
-   */
-  l: Set<string>;
-  /**
-   * Controls horizontal alignment of each keyboard row. Array index
-   * corresponds to layout row index.
-   *
-   * - "start" = left-aligned
-   * - "center" = center-aligned (default)
-   * - "end" = right-aligned
-   * - Undefined = use default (center)
-   */
-  rowPositioning?: ("end" | "start" | "center" | undefined)[];
-  /**
-   * Set of keys that should grow to fill available horizontal space. Useful
-   * for spacebar-like keys that should expand to fill the row.
-   */
-  flexGrowSymbols?: Set<string>;
-}