@seekprotocol/game 0.1.0 → 0.1.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seekprotocol/game",
-  "version": "0.1.0",
-  "description": "GameKit: the browser bridge a Seek minigame imports to talk to the Seek app.",
+  "version": "0.1.1",
+  "description": "GameKit: the bridge between a minigame and the Seek app.",
   "author": {
     "name": "Seek Protocol",
     "url": "https://www.seekprotocol.ai/en"
@@ -11,7 +11,6 @@
     "seek",
     "seekprotocol",
     "quests",
-    "location-based",
     "games"
   ],
   "license": "MIT",

package/perf.d.ts

@@ -1,15 +1,3 @@
-/**
- * Seekprotocol Vitals: how smooth a game runs, measured in the game itself.
- *
- * Each heartbeat carries what happened since the one before: frames per
- * second, frames that took longer than 50 ms (jank: the player feels them),
- * and the JavaScript heap where the browser tells it (Chrome and Android's
- * WebView do, Safari does not). The start entry carries how long the page
- * took from navigation to ready(). The frame loop is the browser's own
- * (`requestAnimationFrame`), so it slows down when the game blocks the main
- * thread, whether the game draws on a canvas or not. Nothing is measured
- * while the page is hidden: a phone in a pocket draws no frames.
- */
 export interface PerfWindow {
     requestAnimationFrame?: (fn: (t: number) => void) => number;
     cancelAnimationFrame?: (id: number) => void;
@@ -24,20 +12,14 @@ export interface PerfWindow {
     };
 }
 export interface PerfSample {
-    /** Frames per second since the last sample, while visible. */
     fps?: number;
-    /** Frames that took longer than 50 ms since the last sample. */
     jank?: number;
-    /** The JavaScript heap in MB, where the browser reports it. */
     heap_mb?: number;
 }
 export interface PerfSampler {
-    /** What happened since the last call; empty when nothing could be measured. */
     sample(): PerfSample;
-    /** ms from navigation to now, or undefined without a performance clock. */
     sinceLoad(): number | undefined;
     stop(): void;
 }
-/** A frame longer than this is one the player notices. */
 export declare const JANK_FRAME_MS = 50;
 export declare function createPerfSampler(win: PerfWindow): PerfSampler;

package/protocol.d.ts

@@ -1,35 +1,18 @@
-/**
- * The GameKit protocol between a minigame and its host.
- *
- * The host is the Seek app's WebView (or Store Connect's simulator in an
- * iframe). Every message is a small JSON object tagged `seek: 'seek-game'`
- * with the protocol version `v`. The game sends requests with an `id`; the
- * host answers each with `re: <id>` and `ok`. The host may also send events
- * (`pause`, `resume`, `exit`). Shapes and sizes are checked on both sides, and
- * the proxy (`seek-gameproxy`) runs the very same checks on storage and track.
- *
- * No dependencies and no DOM, so the Workers import this file too.
- */
 export declare const PROTOCOL: "seek-game";
 export declare const PROTOCOL_VERSION: 1;
 export declare const BRIDGE_VERSION = "0.1.0";
-/** The largest message either side sends or accepts, as UTF-8 JSON. */
 export declare const MAX_MESSAGE_BYTES: number;
-/** What one player may keep per game, all keys together, as UTF-8 JSON of the whole object. */
 export declare const STORAGE_MAX_BYTES: number;
 export declare const STORAGE_KEY: RegExp;
 export declare const TRACK_EVENT: RegExp;
 export declare const TRACK_PROP_KEY: RegExp;
 export declare const TRACK_MAX_PROPS = 8;
 export declare const TRACK_MAX_STRING = 64;
-/** The longest launch token the bridge accepts from a host. */
 export declare const MAX_TOKEN_LENGTH = 4096;
-/** Where storage and track go when the host does not relay them. Fixed: a host cannot point the token elsewhere. */
 export declare const PROXY_ORIGIN = "https://api.play.seekprotocol.ai";
-/** Frame hosts the bridge talks to by default: Store Connect's simulator. The app talks through its native channel. */
 export declare const DEFAULT_HOST_ORIGINS: readonly string[];
-export type GameRequestType = 'ready' | 'finish' | 'storage.get' | 'storage.set' | 'storage.remove' | 'track' | 'heartbeat' | 'diagnostics';
-export type HostEventType = 'pause' | 'resume' | 'exit';
+export type GameRequestType = "ready" | "finish" | "storage.get" | "storage.set" | "storage.remove" | "track" | "heartbeat" | "diagnostics";
+export type HostEventType = "pause" | "resume" | "exit";
 export interface GameRequest {
     seek: typeof PROTOCOL;
     v: typeof PROTOCOL_VERSION;
@@ -53,47 +36,26 @@ export interface HostEvent {
     v: typeof PROTOCOL_VERSION;
     event: HostEventType;
 }
-/** What the host answers to `ready`. */
 export interface ReadyPayload {
-    /** The launch token from platform-quest `run_start`. */
     token: string;
-    /** `proxy` (default): storage, track and Vitals go to the proxy with the token. `host`: the host relays them. */
-    transport?: 'proxy' | 'host';
+    transport?: "proxy" | "host";
 }
-/** What a game knows about its run, from the launch token's claims. */
 export interface LaunchInfo {
     runId: string;
-    /** Use it for anything random, so a run can be checked. */
     seed: number;
-    /** The player's language, BCP 47 (`en`, `nl`, `pt-BR`). */
     lang: string;
-    /** The player, pseudonymous: the same for this game across runs, different in every other game. */
     sub: string;
-    /** The game's app id: `<gameId>-<16 hex>`. */
     game: string;
-    /** The game hash that is running. */
     version: string;
-    /** When the token stops working, in ms since 1970. */
     expiresAt: number;
 }
 export declare const utf8Bytes: (s: string) => number;
-/** UTF-8 size of a value as JSON, or Infinity when it is not JSON. */
 export declare function jsonBytes(value: unknown): number;
-/** Plain JSON only: no functions, no cycles, no NaN. */
 export declare function isJsonValue(v: unknown, depth?: number): boolean;
 export declare const storageKeyProblem: (key: unknown) => string | null;
 export type TrackProps = Record<string, string | number | boolean>;
-/** Why an analytics event cannot be sent, or null. Events are counted, not stored per player. */
 export declare function trackProblem(event: unknown, props: unknown): string | null;
-/** A score report the host will pass on to platform-quest. */
 export declare function finishProblem(r: unknown): string | null;
-/** A message from the host, checked, or null to ignore it. Strings (the native channel) are parsed. */
 export declare function parseHostMessage(data: unknown): HostReply | HostEvent | null;
-/** A request from a game, checked: what a host runs before acting on one. */
 export declare function parseGameRequest(data: unknown): GameRequest | null;
-/**
- * The claims of a launch token, read without checking the signature: a game
- * cannot check it and does not need to; the proxy does. Null when the token
- * is not one.
- */
 export declare function decodeLaunchToken(token: unknown): LaunchInfo | null;