@wasm-gaming/engine-specs 0.2.7 → 0.3.1

package/dist/manifest.d.ts

@@ -1,69 +0,0 @@
-/** A loose JSON Schema object (Draft 2020-12 subset). Kept dependency-free. */
-export type JSONSchema = Record<string, unknown>;
-/** A gamepad→keyboard key map, or the name of a built-in preset (e.g. "rsdkv4"). */
-export type KeyMap = Record<string, string>;
-export type InputPreset = string;
-/** How the host validates a user-provided asset before mounting it. */
-export interface AssetValidation {
-    /** Exact byte length, if the asset has a fixed size (e.g. a known ROM dump). */
-    bytes?: number;
-    /** Lowercase hex SHA-1 the asset must match. */
-    sha1?: string;
-}
-/** A file the host must supply at runtime, mounted into the engine's VFS. */
-export interface AssetSpec {
-    /** Stable key the host uses in `EngineConfig.assets` (e.g. "data", "rom", "bios"). */
-    key: string;
-    /** Absolute VFS path the engine reads from (e.g. "/Data.rsdk", "/roms/neogeo.zip"). */
-    mountPath: string;
-    /** If true, `load()` must reject when the asset is absent. */
-    required: boolean;
-    /** Suggested file extensions for a host file picker (e.g. [".rsdk"]). */
-    accept?: string[];
-    /** Integrity/shape constraints the host may enforce before mounting. */
-    validate?: AssetValidation;
-    /** Human-readable note shown in host UI. */
-    description?: string;
-}
-/** Where the CI-built artifacts live (relative paths or URLs; host resolves them). */
-export interface EngineArtifacts {
-    /** The `.wasm` binary. */
-    wasm: string;
-    /** The JS glue/loader (an ES module factory). */
-    js: string;
-    /** Optional preloaded Emscripten `.data` package (engines that bundle assets). */
-    data?: string;
-}
-/** Native render surface geometry. */
-export interface VideoSpec {
-    baseWidth: number;
-    baseHeight: number;
-    /** Display aspect ratio, e.g. "16:9" or "4:3". Defaults to baseWidth:baseHeight. */
-    aspect?: string;
-}
-/** Optional features an engine may or may not implement. Gate calls on these. */
-export interface EngineCapabilities {
-    saveStates?: boolean;
-    sram?: boolean;
-    /** Part of a swappable set of cores for one platform (e.g. Megadrive: JGenesis/BlastEm). */
-    coreSelectable?: boolean;
-}
-export interface EngineManifest {
-    /** Stable engine id, e.g. "rsdkv4" | "fbneo" | "blastem" | "jgenesis" | "smw". */
-    id: string;
-    /** SemVer of this engine build/contract implementation. */
-    version: string;
-    /** Human-readable name. */
-    name?: string;
-    description?: string;
-    artifacts: EngineArtifacts;
-    /** Files supplied at runtime. May be empty (e.g. engines with baked-in assets). */
-    assets: AssetSpec[];
-    /** Input preset name or an explicit key map. */
-    input: InputPreset | KeyMap;
-    video: VideoSpec;
-    /** JSON Schema for engine-specific `EngineConfig.options`. */
-    options?: JSONSchema;
-    capabilities: EngineCapabilities;
-}
-//# sourceMappingURL=manifest.d.ts.map

package/dist/manifest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAOA,+EAA+E;AAC/E,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEjD,oFAAoF;AACpF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6EAA6E;AAC7E,MAAM,WAAW,SAAS;IACxB,sFAAsF;IACtF,GAAG,EAAE,MAAM,CAAC;IACZ,uFAAuF;IACvF,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,QAAQ,EAAE,OAAO,CAAC;IAClB,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sFAAsF;AACtF,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,kFAAkF;IAClF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,oFAAoF;IACpF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,iFAAiF;AACjF,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,4FAA4F;IAC5F,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IACX,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,eAAe,CAAC;IAC3B,mFAAmF;IACnF,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,gDAAgD;IAChD,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC;IAC5B,KAAK,EAAE,SAAS,CAAC;IACjB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,EAAE,kBAAkB,CAAC;CAClC"}

package/dist/manifest.js

@@ -1,8 +0,0 @@
-// Layer A — the declarative contract.
-//
-// An EngineManifest describes what an engine subproject ships and needs. It drives
-// the host's launcher UI, asset pickers and validation. Everything that differs
-// between engines (Data.rsdk vs a ROM zip + BIOS vs baked-in assets) is expressed
-// as *data* here, so the imperative interface (Layer B) can stay identical.
-export {};
-//# sourceMappingURL=manifest.js.map

package/dist/manifest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,EAAE;AACF,mFAAmF;AACnF,gFAAgF;AAChF,kFAAkF;AAClF,4EAA4E"}

package/dist/validate.d.ts

@@ -1,10 +0,0 @@
-import type { EngineManifest } from './manifest.js';
-export interface ValidationResult {
-    valid: boolean;
-    errors: string[];
-}
-/** Validate an unknown value as an EngineManifest. Never throws. */
-export declare function validateManifest(input: unknown): ValidationResult;
-/** Validate and throw on failure. Returns the value narrowed to EngineManifest. */
-export declare function assertManifest(input: unknown): EngineManifest;
-//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAgED,oEAAoE;AACpE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAMjE;AAED,mFAAmF;AACnF,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAO7D"}

package/dist/validate.js

@@ -1,79 +0,0 @@
-// Runtime validation of an EngineManifest against the contract.
-// Engine CIs can run this to fail a build that drifts from the spec; hosts can run
-// it on manifests fetched from Releases before trusting them.
-import { z } from 'zod';
-const AssetValidationSchema = z.object({
-    bytes: z.int().nonnegative().optional(),
-    sha1: z.string().optional(),
-}).strict();
-const AssetSpecSchema = z.object({
-    key: z.string().min(1),
-    mountPath: z.string().regex(/^\//),
-    required: z.boolean(),
-    accept: z.array(z.string()).optional(),
-    validate: AssetValidationSchema.optional(),
-    description: z.string().optional(),
-}).strict();
-const InputSchema = z.union([
-    z.string(),
-    z.record(z.string(), z.string()),
-]);
-const VideoSpecSchema = z.object({
-    baseWidth: z.int().positive(),
-    baseHeight: z.int().positive(),
-    aspect: z.string().optional(),
-}).strict();
-const EngineArtifactsSchema = z.object({
-    wasm: z.string(),
-    js: z.string(),
-    data: z.string().optional(),
-}).strict();
-const EngineCapabilitiesSchema = z.object({
-    saveStates: z.boolean().optional(),
-    sram: z.boolean().optional(),
-    coreSelectable: z.boolean().optional(),
-}).strict();
-const EngineManifestSchema = z.object({
-    id: z.string().min(1),
-    version: z.string().min(1),
-    name: z.string().optional(),
-    description: z.string().optional(),
-    artifacts: EngineArtifactsSchema,
-    assets: z.array(AssetSpecSchema),
-    input: InputSchema,
-    video: VideoSpecSchema,
-    options: z.record(z.string(), z.unknown()).optional(),
-    capabilities: EngineCapabilitiesSchema,
-}).strict();
-function formatIssuePath(path) {
-    if (path.length === 0)
-        return 'manifest';
-    let out = 'manifest';
-    for (const part of path) {
-        if (typeof part === 'number')
-            out += `[${part}]`;
-        else if (typeof part === 'string')
-            out += `.${part}`;
-        else
-            out += '.[symbol]';
-    }
-    return out;
-}
-/** Validate an unknown value as an EngineManifest. Never throws. */
-export function validateManifest(input) {
-    const result = EngineManifestSchema.safeParse(input);
-    if (result.success)
-        return { valid: true, errors: [] };
-    const errors = result.error.issues.map((issue) => `${formatIssuePath(issue.path)}: ${issue.message}`);
-    return { valid: false, errors };
-}
-/** Validate and throw on failure. Returns the value narrowed to EngineManifest. */
-export function assertManifest(input) {
-    const result = EngineManifestSchema.safeParse(input);
-    if (!result.success) {
-        const errors = result.error.issues.map((issue) => `${formatIssuePath(issue.path)}: ${issue.message}`);
-        throw new Error(`Invalid EngineManifest:\n- ${errors.join('\n- ')}`);
-    }
-    return result.data;
-}
-//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,mFAAmF;AACnF,8DAA8D;AAE9D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IAC1C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC;IAC1B,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;CACjC,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,qBAAqB;IAChC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IAChC,KAAK,EAAE,WAAW;IAClB,KAAK,EAAE,eAAe;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACrD,YAAY,EAAE,wBAAwB;CACvC,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,SAAS,eAAe,CAAC,IAAmB;IAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAEzC,IAAI,GAAG,GAAG,UAAU,CAAC;IACrB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC;aAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;;YAChD,GAAG,IAAI,WAAW,CAAC;IAC1B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,MAAM,GAAG,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACrD,IAAI,MAAM,CAAC,OAAO;QAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAEvD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACtG,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAClC,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,MAAM,MAAM,GAAG,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtG,MAAM,IAAI,KAAK,CAAC,8BAA8B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,MAAM,CAAC,IAAsB,CAAC;AACvC,CAAC"}

package/schema/engine-manifest.schema.json

@@ -1,74 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://github.com/wasm-gaming/engine-specs/schema/engine-manifest.json",
-  "title": "EngineManifest",
-  "description": "The declarative contract an engine subproject ships (mirror of src/manifest.ts).",
-  "type": "object",
-  "required": ["id", "version", "artifacts", "assets", "input", "video", "capabilities"],
-  "additionalProperties": false,
-  "properties": {
-    "id": { "type": "string", "minLength": 1 },
-    "version": { "type": "string", "minLength": 1 },
-    "name": { "type": "string" },
-    "description": { "type": "string" },
-    "artifacts": {
-      "type": "object",
-      "required": ["wasm", "js"],
-      "additionalProperties": false,
-      "properties": {
-        "wasm": { "type": "string" },
-        "js": { "type": "string" },
-        "data": { "type": "string" }
-      }
-    },
-    "assets": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "required": ["key", "mountPath", "required"],
-        "additionalProperties": false,
-        "properties": {
-          "key": { "type": "string", "minLength": 1 },
-          "mountPath": { "type": "string", "pattern": "^/" },
-          "required": { "type": "boolean" },
-          "accept": { "type": "array", "items": { "type": "string" } },
-          "validate": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-              "bytes": { "type": "integer", "minimum": 0 },
-              "sha1": { "type": "string" }
-            }
-          },
-          "description": { "type": "string" }
-        }
-      }
-    },
-    "input": {
-      "oneOf": [
-        { "type": "string" },
-        { "type": "object", "additionalProperties": { "type": "string" } }
-      ]
-    },
-    "video": {
-      "type": "object",
-      "required": ["baseWidth", "baseHeight"],
-      "additionalProperties": false,
-      "properties": {
-        "baseWidth": { "type": "integer", "exclusiveMinimum": 0 },
-        "baseHeight": { "type": "integer", "exclusiveMinimum": 0 },
-        "aspect": { "type": "string" }
-      }
-    },
-    "options": { "type": "object" },
-    "capabilities": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "saveStates": { "type": "boolean" },
-        "sram": { "type": "boolean" },
-        "coreSelectable": { "type": "boolean" }
-      }
-    }
-  }
-}