@crowdedkingdoms/crowdyjs 18.11.0-dev.1 → 18.13.0-dev.1

package/dist/kit/modules/encounters.js

@@ -0,0 +1,57 @@
+import { HubState } from '../mirror.js';
+/** Waves, towers and bosses (the `director` starter): {@link encounter} by key. */
+export class EncountersKit {
+    constructor(runtime, nodeType = 'director') {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.encounters = new Map();
+    }
+    encounter(key) {
+        let e = this.encounters.get(key);
+        if (!e) {
+            e = new Encounter(this.runtime, this.nodeType, key);
+            this.encounters.set(key, e);
+        }
+        return e;
+    }
+}
+/**
+ * One encounter: waves of enemies down a lane to the players' base, towers the players build (a
+ * tower may not cut the lane), strikes on a cooldown, kills that pay gold, and a boss that changes
+ * phase as it weakens. {@link view} mirrors the `encounter` topic: snapshots once a second while it
+ * runs, and `event` messages (`type`: `wave_started`, `wave_cleared`, `boss_phase`, `won`, `lost`)
+ * through `view.onEvent`.
+ */
+export class Encounter {
+    constructor(runtime, nodeType, key) {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.key = key;
+        this.view = new HubState(runtime, nodeType, key, 'encounter');
+    }
+    watch() {
+        return this.view.start();
+    }
+    unwatch() {
+        return this.view.stop();
+    }
+    /** @throws {KitError} `full`. */
+    join() {
+        return this.runtime.call(this.nodeType, this.key, 'join', null, { action: true });
+    }
+    /** The first to join, or a developer. @throws {KitError} `forbidden`, `started`, `bad_request` (no way to the base). */
+    start() {
+        return this.runtime.call(this.nodeType, this.key, 'start', null, { action: true });
+    }
+    /**
+     * Builds a tower at `(x, z)`; resolves with the gold left.
+     * @throws {KitError} `blocks_lane`, `insufficient` (gold), `conflict` (taken), `bad_request`, `not_member`.
+     */
+    build(x, z) {
+        return this.runtime.call(this.nodeType, this.key, 'build', { x, z }, { action: true });
+    }
+    /** Strikes enemy `enemy`; resolves with its hp left. @throws {KitError} `cooldown`, `not_found`, `not_member`. */
+    hit(enemy) {
+        return this.runtime.call(this.nodeType, this.key, 'hit', { enemy }, { action: true });
+    }
+}

package/dist/kit/modules/instances.d.ts

@@ -0,0 +1,78 @@
+import { HubState } from '../mirror.js';
+import type { KitRuntime } from '../runtime.js';
+export interface InstanceRoom {
+    kind: 'fight' | 'treasure' | 'rest' | 'boss';
+    /** What a fight here takes. */
+    power: number;
+    done: boolean;
+}
+export interface InstanceMember {
+    player: number;
+    hp: number;
+    max_hp: number;
+    power: number;
+}
+/** What the `run` topic carries. */
+export interface InstanceRunView {
+    phase: 'unopened' | 'running' | 'cleared' | 'wiped' | 'abandoned' | 'expired';
+    owner: number | null;
+    /** The run's seed: the same seed lays out the same floors. */
+    seed: number;
+    floor: number;
+    floors: number;
+    /** The room the party is at on this floor. */
+    room: number;
+    rooms: InstanceRoom[];
+    members: InstanceMember[];
+    invited: number[];
+    gold: number;
+    relics: string[];
+    /** The grid reserved for the run, when the hub's config has a volume. */
+    grid: number | null;
+    log: string[];
+}
+/** Private runs for one party (the `instance` starter): {@link run} by key. */
+export declare class InstancesKit {
+    private readonly runtime;
+    private readonly nodeType;
+    private readonly runs;
+    constructor(runtime: KitRuntime, nodeType?: string);
+    /** The run with key `key` (a key the game makes up, one per run). */
+    run(key: string): InstanceRun;
+}
+/**
+ * One run: a party plays down floors the hub generates from the run's seed, the hub resolves each
+ * room, a party with nobody standing is wiped (permadeath), and a run nobody touches expires. A
+ * cleared or wiped run posts each member's depth to a leaderboard when the hub's config names one.
+ */
+export declare class InstanceRun {
+    private readonly runtime;
+    readonly nodeType: string;
+    readonly key: string;
+    readonly view: HubState<InstanceRunView>;
+    constructor(runtime: KitRuntime, nodeType: string, key: string);
+    watch(): Promise<InstanceRunView>;
+    unwatch(): Promise<void>;
+    /**
+     * Opens the run as its owner (a developer kit opens one for `party`); resolves with its seed.
+     * @throws {KitError} `started`, `bad_request` (party size), `conflict` (its grid could not be reserved).
+     */
+    open(options?: {
+        seed?: number;
+        party?: ReadonlyArray<number | string>;
+    }): Promise<number>;
+    /** The owner invites a player. @throws {KitError} `forbidden`, `full`. */
+    invite(player: number | string): Promise<boolean>;
+    /** An invited player joins. @throws {KitError} `forbidden`. */
+    join(): Promise<boolean>;
+    /**
+     * Resolves the room the party is at; resolves with what happened, as the log has it.
+     * @throws {KitError} `not_member`, `forbidden` (the caller is down), `conflict` (descend first), `finished`.
+     */
+    enter(): Promise<string>;
+    /** The owner leads the party to the next floor; resolves with it. @throws {KitError} `not_ready` (rooms left), `forbidden`. */
+    descend(): Promise<number>;
+    /** The owner (or a developer) ends the run. */
+    abandon(): Promise<boolean>;
+}
+//# sourceMappingURL=instances.d.ts.map

package/dist/kit/modules/instances.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/kit/modules/instances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7C,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;IAC9E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,yEAAyE;IACzE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,EAAE,CAAC;CACf;AAED,+EAA+E;AAC/E,qBAAa,YAAY;IAIrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAkC;gBAGpC,OAAO,EAAE,UAAU,EACnB,QAAQ,SAAa;IAGxC,qEAAqE;IACrE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;CAQ9B;AAED;;;;GAIG;AACH,qBAAa,WAAW;IAIpB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM;IALtB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAGtB,OAAO,EAAE,UAAU,EAC3B,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM;IAKtB,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAIjC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB;;;OAGG;IACH,IAAI,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9F,0EAA0E;IAC1E,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjD,+DAA+D;IAC/D,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAIxB;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAIxB,+HAA+H;IAC/H,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAI1B,+CAA+C;IAC/C,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;CAG5B"}

package/dist/kit/modules/instances.js

@@ -0,0 +1,72 @@
+import { HubState } from '../mirror.js';
+/** Private runs for one party (the `instance` starter): {@link run} by key. */
+export class InstancesKit {
+    constructor(runtime, nodeType = 'instance') {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.runs = new Map();
+    }
+    /** The run with key `key` (a key the game makes up, one per run). */
+    run(key) {
+        let r = this.runs.get(key);
+        if (!r) {
+            r = new InstanceRun(this.runtime, this.nodeType, key);
+            this.runs.set(key, r);
+        }
+        return r;
+    }
+}
+/**
+ * One run: a party plays down floors the hub generates from the run's seed, the hub resolves each
+ * room, a party with nobody standing is wiped (permadeath), and a run nobody touches expires. A
+ * cleared or wiped run posts each member's depth to a leaderboard when the hub's config names one.
+ */
+export class InstanceRun {
+    constructor(runtime, nodeType, key) {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.key = key;
+        this.view = new HubState(runtime, nodeType, key, 'run');
+    }
+    watch() {
+        return this.view.start();
+    }
+    unwatch() {
+        return this.view.stop();
+    }
+    /**
+     * Opens the run as its owner (a developer kit opens one for `party`); resolves with its seed.
+     * @throws {KitError} `started`, `bad_request` (party size), `conflict` (its grid could not be reserved).
+     */
+    open(options = {}) {
+        const args = {};
+        if (options.seed !== undefined)
+            args.seed = options.seed;
+        if (options.party?.length)
+            args.party = options.party.map(Number);
+        return this.runtime.call(this.nodeType, this.key, 'open', args, { action: true });
+    }
+    /** The owner invites a player. @throws {KitError} `forbidden`, `full`. */
+    invite(player) {
+        return this.runtime.call(this.nodeType, this.key, 'invite', { player: Number(player) }, { action: true });
+    }
+    /** An invited player joins. @throws {KitError} `forbidden`. */
+    join() {
+        return this.runtime.call(this.nodeType, this.key, 'join', null, { action: true });
+    }
+    /**
+     * Resolves the room the party is at; resolves with what happened, as the log has it.
+     * @throws {KitError} `not_member`, `forbidden` (the caller is down), `conflict` (descend first), `finished`.
+     */
+    enter() {
+        return this.runtime.call(this.nodeType, this.key, 'enter', null, { action: true });
+    }
+    /** The owner leads the party to the next floor; resolves with it. @throws {KitError} `not_ready` (rooms left), `forbidden`. */
+    descend() {
+        return this.runtime.call(this.nodeType, this.key, 'descend', null, { action: true });
+    }
+    /** The owner (or a developer) ends the run. */
+    abandon() {
+        return this.runtime.call(this.nodeType, this.key, 'abandon', null, { action: true });
+    }
+}

package/dist/kit/modules/leaderboards.d.ts

@@ -0,0 +1,79 @@
+import { HubState } from '../mirror.js';
+import type { KitRuntime } from '../runtime.js';
+/** A player's place on a board. */
+export interface LeaderboardRank {
+    rank: number;
+    player: number;
+    score: number;
+}
+/** What the `board` topic carries: the top of the board and the season. */
+export interface LeaderboardView {
+    season: number;
+    /** When the season began (Unix ms). */
+    season_started: number;
+    /** Players with a score this season. */
+    entries: number;
+    top: LeaderboardRank[];
+}
+/** The season, and the last one's final standings. */
+export interface LeaderboardSeason {
+    season: number;
+    started: number;
+    entries: number;
+    last: LeaderboardRank[];
+}
+/** A board's settings (developers). */
+export interface LeaderboardConfig {
+    /** `best` (by `order`), `sum` or `latest` submission. */
+    keep?: 'best' | 'sum' | 'latest';
+    /** `high` scores rank first (points) or `low` (times). */
+    order?: 'high' | 'low';
+    top_size?: number;
+    /** A cron schedule that ends the season (`0 0 * * 1`: every Monday), or null for none. */
+    season_cron?: string | null;
+    max_entries?: number;
+}
+/** Leaderboards (the `leaderboard` starter): {@link board} by name. */
+export declare class LeaderboardsKit {
+    private readonly runtime;
+    private readonly nodeType;
+    private readonly boards;
+    constructor(runtime: KitRuntime, nodeType?: string);
+    /** The board named `name` (`weekly-score`, `fastest-lap`, ...). */
+    board(name: string): LeaderboardHandle;
+}
+/**
+ * One board. The hub ranks players itself, and only other hubs and developers submit: a client
+ * never sends its own score, the hub that decided the result does (a session, a race, a run).
+ * {@link view} mirrors the `board` topic (at most once a second).
+ */
+export declare class LeaderboardHandle {
+    private readonly runtime;
+    readonly nodeType: string;
+    readonly name: string;
+    /** The `board` topic: the top of the board and the season. */
+    readonly view: HubState<LeaderboardView>;
+    constructor(runtime: KitRuntime, nodeType: string, name: string);
+    watch(): Promise<LeaderboardView>;
+    unwatch(): Promise<void>;
+    /** A page of the board, best first. */
+    top(options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<LeaderboardRank[]>;
+    /** The places around a player (the caller's own, without `player`). */
+    around(options?: {
+        player?: number | string;
+        radius?: number;
+    }): Promise<LeaderboardRank[]>;
+    /** The caller's own place, or null without a score this season. */
+    me(): Promise<LeaderboardRank | null>;
+    season(): Promise<LeaderboardSeason>;
+    /** Submits a score for `player`. Developers only (a developer kit); players are refused. */
+    submit(player: number | string, score: number): Promise<number>;
+    /** Sets the board's config. Developers only. */
+    configure(config: LeaderboardConfig): Promise<boolean>;
+    /** Ends the season now; resolves with the new season. Developers only. */
+    roll(): Promise<number>;
+}
+//# sourceMappingURL=leaderboards.d.ts.map

package/dist/kit/modules/leaderboards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leaderboards.d.ts","sourceRoot":"","sources":["../../../src/kit/modules/leaderboards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,mCAAmC;AACnC,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,2EAA2E;AAC3E,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,eAAe,EAAE,CAAC;CACxB;AAED,sDAAsD;AACtD,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,EAAE,CAAC;CACzB;AAED,uCAAuC;AACvC,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IACjC,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0FAA0F;IAC1F,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,uEAAuE;AACvE,qBAAa,eAAe;IAIxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAJ3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwC;gBAG5C,OAAO,EAAE,UAAU,EACnB,QAAQ,SAAgB;IAG3C,mEAAmE;IACnE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB;CAQvC;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAK1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM;IANvB,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAGtB,OAAO,EAAE,UAAU,EAC3B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM;IAKvB,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAIjC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,uCAAuC;IACvC,GAAG,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIlF,uEAAuE;IACvE,MAAM,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAO/F,mEAAmE;IACnE,EAAE,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAIrC,MAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAIpC,4FAA4F;IAC5F,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D,gDAAgD;IAChD,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD,0EAA0E;IAC1E,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;CAGxB"}

package/dist/kit/modules/leaderboards.js

@@ -0,0 +1,69 @@
+import { HubState } from '../mirror.js';
+/** Leaderboards (the `leaderboard` starter): {@link board} by name. */
+export class LeaderboardsKit {
+    constructor(runtime, nodeType = 'leaderboard') {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.boards = new Map();
+    }
+    /** The board named `name` (`weekly-score`, `fastest-lap`, ...). */
+    board(name) {
+        let b = this.boards.get(name);
+        if (!b) {
+            b = new LeaderboardHandle(this.runtime, this.nodeType, name);
+            this.boards.set(name, b);
+        }
+        return b;
+    }
+}
+/**
+ * One board. The hub ranks players itself, and only other hubs and developers submit: a client
+ * never sends its own score, the hub that decided the result does (a session, a race, a run).
+ * {@link view} mirrors the `board` topic (at most once a second).
+ */
+export class LeaderboardHandle {
+    constructor(runtime, nodeType, name) {
+        this.runtime = runtime;
+        this.nodeType = nodeType;
+        this.name = name;
+        this.view = new HubState(runtime, nodeType, name, 'board');
+    }
+    watch() {
+        return this.view.start();
+    }
+    unwatch() {
+        return this.view.stop();
+    }
+    /** A page of the board, best first. */
+    top(options = {}) {
+        return this.runtime.call(this.nodeType, this.name, 'top', options);
+    }
+    /** The places around a player (the caller's own, without `player`). */
+    around(options = {}) {
+        const args = {};
+        if (options.player !== undefined)
+            args.player = Number(options.player);
+        if (options.radius !== undefined)
+            args.radius = options.radius;
+        return this.runtime.call(this.nodeType, this.name, 'around', args);
+    }
+    /** The caller's own place, or null without a score this season. */
+    me() {
+        return this.runtime.call(this.nodeType, this.name, 'me');
+    }
+    season() {
+        return this.runtime.call(this.nodeType, this.name, 'season');
+    }
+    /** Submits a score for `player`. Developers only (a developer kit); players are refused. */
+    submit(player, score) {
+        return this.runtime.call(this.nodeType, this.name, 'submit', { player: Number(player), score }, { action: true });
+    }
+    /** Sets the board's config. Developers only. */
+    configure(config) {
+        return this.runtime.call(this.nodeType, this.name, 'configure', config, { action: true });
+    }
+    /** Ends the season now; resolves with the new season. Developers only. */
+    roll() {
+        return this.runtime.call(this.nodeType, this.name, 'roll', null, { action: true });
+    }
+}

package/dist/kit/modules/market.d.ts

@@ -0,0 +1,159 @@
+import { HubState, PrivateState } from '../mirror.js';
+import type { KitRuntime } from '../runtime.js';
+import type { EconBundle } from './player.js';
+export interface VendorOfferView {
+    item: string;
+    price: EconBundle;
+    /** Left on the shelf; null for no limit. */
+    stock: number | null;
+    per_player: number | null;
+    /** What the vendor pays for one; null when it does not buy them. */
+    buys_for: EconBundle | null;
+}
+export interface VendorView {
+    id: string;
+    offers: VendorOfferView[];
+    restocked_at: number;
+}
+export interface MarketQuote {
+    bid: number | null;
+    ask: number | null;
+    last: number | null;
+}
+/** What the `market` topic carries. */
+export interface MarketView {
+    vendors: VendorView[];
+    currency: string;
+    quotes: Record<string, MarketQuote>;
+    open_trades: number;
+    pending_steps: number;
+}
+export interface MarketBook {
+    item: string;
+    currency: string;
+    /** `[price, count]` a level, best first. */
+    bids: Array<[number, number]>;
+    asks: Array<[number, number]>;
+    last: number | null;
+}
+export interface MarketOrder {
+    id: number;
+    player: number;
+    item: string;
+    side: 'buy' | 'sell';
+    price: number;
+    count: number;
+    /** What is still open. */
+    open: number;
+    /** The hold that backs it, in the player's hub. */
+    hold: string;
+}
+export interface MarketPlaced {
+    order: number;
+    /** `[price, count]` it traded at once. */
+    fills: Array<[number, number]>;
+    open: number;
+}
+export interface MarketTradeSide {
+    bundle: EconBundle;
+    hold: string | null;
+    accepted: boolean;
+}
+export interface MarketTrade {
+    id: number;
+    players: [number, number];
+    sides: [MarketTradeSide, MarketTradeSide];
+    state: 'open' | 'settling' | 'done' | 'cancelled';
+    expires_at: number;
+    offers: number;
+}
+/** One market hub's mirrors and calls, shared by its market, shop and trade handles. */
+export declare class MarketCore {
+    readonly runtime: KitRuntime;
+    readonly nodeType: string;
+    readonly key: string;
+    readonly view: HubState<MarketView>;
+    /** The caller's open orders, read again when the market says they moved. */
+    readonly orders: PrivateState<MarketOrder[]>;
+    /** The caller's open and settling trades. */
+    readonly trades: PrivateState<MarketTrade[]>;
+    constructor(runtime: KitRuntime, nodeType: string, key: string);
+    change<T>(method: string, args: unknown): Promise<T>;
+}
+/** Markets' order books (the `market` starter): {@link at} a market by its name. */
+export declare class MarketsKit {
+    private readonly core;
+    constructor(core: (key: string) => MarketCore);
+    at(key?: string): MarketHandle;
+}
+/**
+ * A market's order books: limit orders matched at price-time priority. An order holds what it
+ * offers in the player's own hub until it fills or is cancelled; the market moves each fill
+ * between the two players' hubs.
+ */
+export declare class MarketHandle {
+    private readonly core;
+    constructor(core: MarketCore);
+    get view(): HubState<MarketView>;
+    get orders(): PrivateState<MarketOrder[]>;
+    watch(): Promise<MarketView>;
+    unwatch(): Promise<void>;
+    book(item: string): Promise<MarketBook>;
+    /**
+     * Places a limit order; a buy holds `price * count` of the market's currency, a sell the items.
+     * @throws {KitError} `insufficient`, `limit` (open orders), `not_found` (no book), `unavailable`.
+     */
+    order(order: {
+        item: string;
+        side: 'buy' | 'sell';
+        price: number;
+        count: number;
+    }): Promise<MarketPlaced>;
+    /** Cancels an open order; what it still holds comes back. @throws {KitError} `not_found`. */
+    cancel(order: number): Promise<boolean>;
+}
+/** Markets' vendors (the `market` starter): {@link at} a market by its name. */
+export declare class ShopsKit {
+    private readonly core;
+    constructor(core: (key: string) => MarketCore);
+    at(key?: string): ShopHandle;
+}
+/** A market's vendors: fixed prices, stock that restocks, a limit per player. */
+export declare class ShopHandle {
+    private readonly core;
+    constructor(core: MarketCore);
+    get view(): HubState<MarketView>;
+    watch(): Promise<MarketView>;
+    unwatch(): Promise<void>;
+    vendors(): Promise<VendorView[]>;
+    /** Buys `count` (one by default). @throws {KitError} `insufficient` (gold or stock), `limit`, `full`, `not_found`, `unavailable`. */
+    buy(vendor: string, item: string, count?: number): Promise<EconBundle>;
+    /** Sells `count` (one by default). @throws {KitError} `forbidden` (it does not buy them), `insufficient`, `unavailable`. */
+    sell(vendor: string, item: string, count?: number): Promise<EconBundle>;
+}
+/** Trades between two players at a market: {@link at} a market by its name. */
+export declare class TradesKit {
+    private readonly core;
+    constructor(core: (key: string) => MarketCore);
+    at(key?: string): TradeDesk;
+}
+/**
+ * Trades between two players: each offers a bundle, held in their own hub; when both accept
+ * the last offers, the market moves each to the other. A changed offer clears both acceptances.
+ */
+export declare class TradeDesk {
+    private readonly core;
+    constructor(core: MarketCore);
+    get mine(): PrivateState<MarketTrade[]>;
+    watch(): Promise<MarketTrade[]>;
+    unwatch(): Promise<void>;
+    /** Opens a trade with `player`; resolves with its id. */
+    open(player: number | string): Promise<number>;
+    /** Offers `bundle` (held at once; an empty one withdraws). @throws {KitError} `insufficient`, `forbidden`, `finished`. */
+    offer(trade: number, bundle: Partial<EconBundle>): Promise<boolean>;
+    /** Accepts the offers as they stand; resolves with the trade's state. @throws {KitError} `not_ready`, `finished`. */
+    accept(trade: number): Promise<MarketTrade['state']>;
+    /** Calls it off; what each offered comes back. */
+    decline(trade: number): Promise<boolean>;
+}
+//# sourceMappingURL=market.d.ts.map

package/dist/kit/modules/market.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../../src/kit/modules/market.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,UAAU,CAAC;IAClB,4CAA4C;IAC5C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,UAAU,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,uCAAuC;AACvC,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9B,IAAI,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAC1C,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,WAAW,CAAC;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAID,wFAAwF;AACxF,qBAAa,UAAU;IAQnB,QAAQ,CAAC,OAAO,EAAE,UAAU;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM;IATtB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpC,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7C,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;gBAGlC,OAAO,EAAE,UAAU,EACnB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM;IAQtB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CAGrD;AAED,oFAAoF;AACpF,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU;IAE9D,EAAE,CAAC,GAAG,SAAS,GAAG,YAAY;CAG/B;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,IAAI,IAAI,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE/B;IAED,IAAI,MAAM,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC,CAExC;IAEK,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC;IAK5B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIvC;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzG,6FAA6F;IAC7F,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGxC;AAED,gFAAgF;AAChF,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU;IAE9D,EAAE,CAAC,GAAG,SAAS,GAAG,UAAU;CAG7B;AAED,iFAAiF;AACjF,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,IAAI,IAAI,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE/B;IAED,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC;IAI5B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,OAAO,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAIhC,qIAAqI;IACrI,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAItE,4HAA4H;IAC5H,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAGxE;AAED,+EAA+E;AAC/E,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU;IAE9D,EAAE,CAAC,GAAG,SAAS,GAAG,SAAS;CAG5B;AAED;;;GAGG;AACH,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,IAAI,IAAI,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC,CAEtC;IAEK,KAAK,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIrC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,yDAAyD;IACzD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9C,0HAA0H;IAC1H,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAInE,qHAAqH;IACrH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAIpD,kDAAkD;IAClD,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGzC"}