@kradle/challenges-sdk 0.11.0 → 0.13.0

package/dist/runtime/reducer.d.ts

@@ -0,0 +1,205 @@
+import { type Duration, type Ticks } from "./time.js";
+import type { BlockSpec, BlockState, ChallengeConfig, Handlers, Outcome, PhaseSpec, StateDecl, World } from "./types.js";
+import type { Action, BlockId, Box, Capability, Effect, EndReason, Event, ItemId, ItemStack, Json, Marker, RuntimeManifest, Status, Vec3 } from "./wire.js";
+import { type Equipment, type WorldState } from "./world.js";
+/** Effects per batch the engine accepts. The setup is split under it. */
+export declare const MAX_BATCH_EFFECTS = 4096;
+/** Blocks one batch may fill in total. The setup is split under it. */
+export declare const MAX_FILL_VOLUME = 32768;
+/** Phase transitions one event may chain (enter requests included). */
+export declare const MAX_TRANSITIONS_PER_EVENT = 8;
+/** A handler set, as one `.on()` call registered it. */
+export type AnyHandlers = Handlers<ChallengeConfig, unknown, Record<string, object>, string, string, string, Record<string, never>>;
+type AnyFn = (...args: unknown[]) => unknown;
+export type AnyPhaseSpec = PhaseSpec<ChallengeConfig, unknown, Record<string, object>, string, string, string, Record<string, never>>;
+export type AnyOutcome = Outcome<ChallengeConfig, unknown, Record<string, object>, string, string, string, Record<string, never>>;
+type AnyVoteRule = {
+    options?: readonly string[] | undefined;
+    final?: boolean | undefined;
+    allowEliminated?: boolean | undefined;
+    allowSelf?: boolean | undefined;
+    accept?: unknown;
+};
+/** What the builder compiles and locks: the reducer reads only this. */
+export interface Definition {
+    config: ChallengeConfig;
+    state: StateDecl<ChallengeConfig, unknown, unknown, Record<string, unknown>>;
+    life: "single" | "respawn";
+    duration: Ticks | undefined;
+    world: (Required<Omit<World, "spawn">> & {
+        spawn?: Vec3 | undefined;
+    }) | null;
+    zones: Record<string, Box>;
+    timers: readonly string[] | undefined;
+    markers: {
+        tags: string[];
+        within?: Box | undefined;
+    } | undefined;
+    votes: Record<string, AnyVoteRule>;
+    phases: readonly string[];
+    initialPhase: string | undefined;
+    setup: AnyFn | undefined;
+    start: AnyFn | undefined;
+    phaseSpecs: Record<string, AnyPhaseSpec>;
+    at: Array<{
+        at: Duration;
+        run: AnyFn;
+    }>;
+    every: Array<{
+        interval: Duration;
+        run: AnyFn;
+    }>;
+    on: AnyHandlers[];
+    outcome: AnyOutcome;
+    onOver: AnyFn | undefined;
+    judgeContext: AnyFn | undefined;
+    manifest: RuntimeManifest;
+}
+interface StatePlayer {
+    name: string;
+    role: string;
+    seatNumber: number;
+    human: boolean;
+    connected: boolean;
+    alive: boolean;
+    eliminated: boolean;
+    deaths: number;
+    kills: number;
+    score: number;
+    pos: Vec3 | null;
+    yaw: number;
+    pitch: number;
+    headYaw: number;
+    entityId: number | null;
+    uuid: string | null;
+    equipment: Equipment;
+    invisible: boolean;
+    health: number;
+    food: number;
+    gamemode: "survival" | "creative" | "adventure" | "spectator";
+    held: ItemId | null;
+    slots: Record<number, ItemStack>;
+    inventory: Record<string, number>;
+    zones: string[];
+    state: Record<string, unknown>;
+    /** Set once the first sample of the current connection arrived. */
+    sampled: boolean;
+    /** Derived: not eliminated. A non-enumerable getter, re-attached after every JSON round trip. */
+    readonly isActive: boolean;
+}
+interface VoteState {
+    open: boolean;
+    round: number;
+    cast: Record<string, string>;
+}
+/** The reducer state: plain JSON, except the world mirror (shared by reference, updated by copy). */
+export interface State {
+    /** The run's seed, from `run_started`. */
+    seed: number;
+    /** The generator's state; every draw advances it. */
+    rng: number;
+    /** The resolved parameter values. */
+    params: Record<string, Json>;
+    /** What the engine supplies, from `run_started`. */
+    capabilities: Capability[];
+    /** The declared locations, by name. */
+    locations: Record<string, Vec3>;
+    /** The tagged entities the engine read before the game. */
+    markers: Marker[];
+    /** The stage: CONNECTING, SETUP, PLAYING, OVER. */
+    status: Status;
+    /** True once the state initializers ran. */
+    initialized: boolean;
+    /** The last server tick seen. */
+    tick: number;
+    /** Ticks between the last two ticks seen. */
+    dt: number;
+    /** The tick PLAYING started. */
+    startTick: number;
+    /** The setup batches still to confirm: the whole list is kept (JSON) until the last confirmation. */
+    setup: {
+        /** Every batch, in order; the engine gets them one at a time. */
+        batches: Effect[][];
+        /** How many batches the engine confirmed: the next one to send. */
+        confirmed: number;
+        /** The tick the pending batch went out. */
+        sentTick: number;
+    } | null;
+    /** The current phase; `null` before the first entry and without phases. */
+    phase: string | null;
+    /** The tick the current phase was entered. */
+    phaseStartTick: number;
+    /** How many times the current phase was entered. */
+    phaseEntries: number;
+    /** The resolved duration of the current phase, in ticks; `null` without one. */
+    phaseDuration: number | null;
+    /** The `at` steps that already ran, by key. */
+    fired: Record<string, true>;
+    /** The last tick each `every` step ran, by key. */
+    every: Record<string, number>;
+    /** The scheduled timers: when each is due, and a generation that guards a reschedule. */
+    timers: Record<string, {
+        /** The tick the timer fires at. */
+        due: number;
+        /** The generation of the schedule call that set it; an older reschedule is ignored. */
+        gen: number;
+    }>;
+    /** The last timer generation handed out. */
+    nextGen: number;
+    /** The participants, by name. */
+    players: Record<string, StatePlayer>;
+    /** The shared challenge data (`g.state`). */
+    game: Record<string, unknown>;
+    /** The votes, by id: whether a round is open, its number, the casts. */
+    votes: Record<string, VoteState>;
+    /** The walks in progress, by request id. */
+    walks: Record<string, {
+        /** The participant who walks. */
+        player: string;
+        /** What a failed walk does: a teleport to the destination, or nothing. */
+        fallback: "teleport" | "none";
+    } & Vec3>;
+    /** Pending named batches: transport id to public name. */
+    batches: Record<string, string>;
+    /** The containers the mirror holds, by "x,y,z": the block and its slots. */
+    containers: Record<string, {
+        /** The container's block id. */
+        block: BlockId;
+        /** The stacks, by slot index. */
+        slots: Record<number, ItemStack>;
+    }>;
+    /** The world mirror. */
+    world: WorldState;
+    /** The next request id (walks, batches). */
+    nextId: number;
+    /** The winners once the game ended. */
+    winners: string[];
+    /** The end state once the game ended; `""` before. */
+    endState: string;
+    /** Why the game ended; `null` while it runs. */
+    reason: EndReason | null;
+    /** The clock values at the end: `elapsed` and `phaseElapsed` stop there. */
+    frozen: {
+        /** Ticks from game start to the end. */
+        elapsed: number;
+        /** Ticks from the last phase entry to the end. */
+        phaseElapsed: number;
+    } | null;
+}
+/** JSON-only state: no functions, class instances, cycles, shared objects or non-finite numbers. */
+export declare function assertJson(value: unknown, what: string): void;
+/** `minecraft:oak_stairs[facing=east,half=bottom]` -> `{ id, props }`. */
+export declare function parseBlockState(state: BlockId): BlockState;
+/** `{ id, props }` -> `minecraft:oak_stairs[facing=east]`. */
+export declare function blockSpecString(spec: BlockSpec): BlockId;
+/** Splits the setup effects into batches under the engine's limits, in order. */
+export declare function splitBatches(effects: Effect[]): Effect[][];
+export declare function createReducer(def: Definition): {
+    init: () => State;
+    reduce: (input: State, event: Event) => {
+        state: State;
+        actions: Action[];
+    };
+};
+export {};
+//# sourceMappingURL=reducer.d.ts.map

package/dist/runtime/reducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../src/runtime/reducer.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,KAAK,EAAW,MAAM,WAAW,CAAC;AAC/D,OAAO,KAAK,EAEX,SAAS,EACT,UAAU,EACV,eAAe,EACf,QAAQ,EAIR,OAAO,EACP,SAAS,EAGT,SAAS,EAET,KAAK,EACL,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACX,MAAM,EACN,OAAO,EACP,GAAG,EACH,UAAU,EAEV,MAAM,EACN,SAAS,EACT,KAAK,EACL,MAAM,EACN,SAAS,EACT,IAAI,EACJ,MAAM,EAEN,eAAe,EAEf,MAAM,EACN,IAAI,EACJ,MAAM,WAAW,CAAC;AACnB,OAAO,EAWN,KAAK,SAAS,EAcd,KAAK,UAAU,EACf,MAAM,YAAY,CAAC;AAIpB,yEAAyE;AACzE,eAAO,MAAM,iBAAiB,OAAO,CAAC;AACtC,uEAAuE;AACvE,eAAO,MAAM,eAAe,QAAQ,CAAC;AACrC,uEAAuE;AACvE,eAAO,MAAM,yBAAyB,IAAI,CAAC;AAK3C,wDAAwD;AACxD,MAAM,MAAM,WAAW,GAAG,QAAQ,CACjC,eAAe,EACf,OAAO,EACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtB,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CACrB,CAAC;AAEF,KAAK,KAAK,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;AAC7C,MAAM,MAAM,YAAY,GAAG,SAAS,CACnC,eAAe,EACf,OAAO,EACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtB,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CACrB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,OAAO,CAC/B,eAAe,EACf,OAAO,EACP,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtB,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CACrB,CAAC;AACF,KAAK,WAAW,GAAG;IAClB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,wEAAwE;AACxE,MAAM,WAAW,UAAU;IAC1B,MAAM,EAAE,eAAe,CAAC;IACxB,KAAK,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7E,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG;QAAE,KAAK,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAC9E,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACtC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IAClE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACnC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACzC,EAAE,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,GAAG,EAAE,KAAK,CAAA;KAAE,CAAC,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,GAAG,EAAE,KAAK,CAAA;KAAE,CAAC,CAAC;IACjD,EAAE,EAAE,WAAW,EAAE,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC;IACpB,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,YAAY,EAAE,KAAK,GAAG,SAAS,CAAC;IAChC,QAAQ,EAAE,eAAe,CAAC;CAC1B;AAID,UAAU,WAAW;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,IAAI,GAAG,IAAI,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;IAC9D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,mEAAmE;IACnE,OAAO,EAAE,OAAO,CAAC;IACjB,iGAAiG;IACjG,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC3B;AAED,UAAU,SAAS;IAClB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,qGAAqG;AACrG,MAAM,WAAW,KAAK;IACrB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7B,oDAAoD;IACpD,YAAY,EAAE,UAAU,EAAE,CAAC;IAC3B,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,2DAA2D;IAC3D,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,WAAW,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,qGAAqG;IACrG,KAAK,EAAE;QACN,iEAAiE;QACjE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;QACpB,mEAAmE;QACnE,SAAS,EAAE,MAAM,CAAC;QAClB,2CAA2C;QAC3C,QAAQ,EAAE,MAAM,CAAC;KACjB,GAAG,IAAI,CAAC;IACT,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5B,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,yFAAyF;IACzF,MAAM,EAAE,MAAM,CACb,MAAM,EACN;QACC,mCAAmC;QACnC,GAAG,EAAE,MAAM,CAAC;QACZ,uFAAuF;QACvF,GAAG,EAAE,MAAM,CAAC;KACZ,CACD,CAAC;IACF,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CACZ,MAAM,EACN;QACC,iCAAiC;QACjC,MAAM,EAAE,MAAM,CAAC;QACf,0EAA0E;QAC1E,QAAQ,EAAE,UAAU,GAAG,MAAM,CAAC;KAC9B,GAAG,IAAI,CACR,CAAC;IACF,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CACjB,MAAM,EACN;QACC,gCAAgC;QAChC,KAAK,EAAE,OAAO,CAAC;QACf,iCAAiC;QACjC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;KACjC,CACD,CAAC;IACF,wBAAwB;IACxB,KAAK,EAAE,UAAU,CAAC;IAClB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,gDAAgD;IAChD,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,4EAA4E;IAC5E,MAAM,EAAE;QACP,wCAAwC;QACxC,OAAO,EAAE,MAAM,CAAC;QAChB,kDAAkD;QAClD,YAAY,EAAE,MAAM,CAAC;KACrB,GAAG,IAAI,CAAC;CACT;AAmBD,oGAAoG;AACpG,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAgC7D;AAeD,0EAA0E;AAC1E,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAS1D;AAED,8DAA8D;AAC9D,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAKxD;AA6ED,iFAAiF;AACjF,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAmB1D;AAqKD,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,GAAG;IAC/C,IAAI,EAAE,MAAM,KAAK,CAAC;IAClB,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,KAAK;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAC5E,CAmkDA"}