@manabrew/protocol 0.0.1 → 1.0.1

package/README.md

@@ -0,0 +1,27 @@
+# @manabrew/protocol
+
+TypeScript types for the [Manabrew](https://manabrew.app) wire protocol — the
+engine↔client message contract used by the Manabrew Magic: The Gathering client.
+
+The types are generated from the Rust source of truth
+([`manabrew-protocol`](https://crates.io/crates/manabrew-protocol)) and published
+in lockstep with it, so both sides of the wire always agree.
+
+- Protocol reference: <https://docs.manabrew.app/protocol/>
+- Repository: <https://github.com/witchesofthehill/manabrew>
+
+## Install
+
+```sh
+npm install @manabrew/protocol
+```
+
+## Usage
+
+```ts
+import type { Prompt, PromptInput, PromptOutput } from "@manabrew/protocol";
+import { VERSION, PROTOCOL_VERSION } from "@manabrew/protocol";
+```
+
+`VERSION` is the package version; `PROTOCOL_VERSION` is the integer wire version
+a client must match to interoperate.

package/dist/deck/index.d.ts

@@ -0,0 +1,84 @@
+import type { PlaymatSettings } from "../game/index";
+export type CardBackFaceSummary = {
+    name: string;
+    manaCost: string;
+    typeLine: string;
+    oracleText: string;
+    uris: CardImageUris;
+};
+export type CardImageUris = {
+    small: string;
+    normal: string;
+    large: string;
+    png: string;
+    art_crop: string;
+    border_crop: string;
+};
+export type CardPart = {
+    name: string;
+    component: CardPartComponent;
+};
+export type CardPartComponent = "token" | "combo_piece" | "meld_part" | "meld_result";
+export type Deck = {
+    version?: string;
+    id?: string;
+    name: string;
+    description?: string;
+    color?: string;
+    format?: DeckFormat;
+    cards: Array<DeckCard>;
+    sideboard: Array<DeckCard>;
+    attractions?: Array<DeckCard>;
+    contraptions?: Array<DeckCard>;
+    schemes?: Array<DeckCard>;
+    planes?: Array<DeckCard>;
+    commanders?: Array<DeckCard>;
+    companion?: DeckCard;
+    maybeboard?: Array<DeckCard>;
+    draft?: boolean;
+    labels?: Array<DeckLabel>;
+    coverCardName?: string;
+    coverCardFace?: number;
+    playmat?: string;
+    playmatSettings?: PlaymatSettings;
+    stackPositions?: Record<string, {
+        x: number;
+        y: number;
+    }>;
+    tokens?: Array<DeckCard>;
+};
+export type DeckCard = {
+    identity: DeckCardIdentity;
+    uris: CardImageUris;
+    allParts?: Array<CardPart>;
+    color: string;
+    colorIdentity: Array<string>;
+    manaCost: string;
+    cmc: number;
+    types: Array<string>;
+    subtypes: Array<string>;
+    supertypes: Array<string>;
+    keywords?: Array<string>;
+    power?: string;
+    toughness?: string;
+    text: string;
+    layout?: string;
+    isDoubleFaced?: boolean;
+    /**
+     * Back face of a transform / modal_dfc card, captured at deck import.
+     * Absent on single-faced cards and on decks saved before it existed.
+     */
+    backFace?: CardBackFaceSummary;
+};
+export type DeckCardIdentity = {
+    id: string;
+    name: string;
+    setCode: string;
+    cardNumber: string;
+    foil?: boolean;
+};
+export type DeckFormat = "standard" | "pioneer" | "modern" | "legacy" | "vintage" | "pauper" | "commander" | "brawl" | "oathbreaker" | "draft" | "sealed";
+export type DeckLabel = {
+    name: string;
+    color?: string;
+};

package/dist/deck/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/display/index.d.ts

@@ -0,0 +1,12 @@
+export type DisplayEvent = {
+    "kind": "cardPlayed";
+    cardId: string;
+    cardName: string;
+    setCode: string;
+    playerId: string;
+} | {
+    "kind": "turnChanged";
+    activePlayerId: string;
+    activePlayerName: string;
+    turnNumber: number;
+};

package/dist/display/index.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/game/index.d.ts

@@ -0,0 +1,136 @@
+import type { TargetRef } from "../prompts/common";
+export type CardDto = {
+    id: string;
+    identity: CardIdentity;
+    color: string;
+    manaCost: string;
+    cmc: number;
+    types: Array<string>;
+    subtypes: Array<string>;
+    supertypes: Array<string>;
+    power: string | null;
+    toughness: string | null;
+    basePower?: number;
+    baseToughness?: number;
+    text: string;
+    controllerId: string;
+    ownerId: string;
+    tapped: boolean;
+    isCrewed: boolean;
+    isAttacking: boolean;
+    attackingPlayerId?: string;
+    attackTargetId?: string;
+    keywords: Array<string>;
+    counters: Record<string, number>;
+    damage: number;
+    summoningSick: boolean;
+    isCopy: boolean;
+    isDoubleFaced: boolean;
+    isTransformed: boolean;
+    isFaceDown: boolean;
+    isBestowed: boolean;
+    phasedOut: boolean;
+    exerted: boolean;
+    isRingBearer: boolean;
+    attachedTo?: string;
+    attachmentIds: Array<string>;
+    mergedCardIds: Array<string>;
+    flashbackCost?: string;
+    kickerCost?: string;
+    effectiveManaCost?: string;
+    madnessCost?: string;
+    isMadnessExiled: boolean;
+    isPlotted: boolean;
+    isWarpExiled: boolean;
+    foil: boolean;
+    wouldDieInCombat: boolean;
+};
+export type CardIdentity = {
+    name: string;
+    setCode: string;
+    cardNumber: string;
+    isToken: boolean;
+};
+export type CardView = {
+    "visibility": "visible";
+} & CardDto | {
+    "visibility": "hidden";
+    id: string;
+};
+export type CombatAssignmentDto = {
+    blockerId: string;
+    attackerId: string;
+};
+export type DayTime = "neither" | "day" | "night";
+export type GameViewDto = {
+    gameId: string;
+    turn: number;
+    step: StepKind;
+    combatAssignments: Array<CombatAssignmentDto>;
+    activePlayerId: string;
+    priorityPlayerId: string;
+    players: Array<PlayerDto>;
+    zones: Array<ZoneDto>;
+    stack: Array<StackObjectDto>;
+    gameOver: boolean;
+    winnerId: string | null;
+    monarchId: string | null;
+    initiativeHolderId: string | null;
+    dayTime: DayTime;
+};
+export type Mana = {
+    color: ManaColor;
+    amount: number;
+};
+export type ManaColor = "W" | "U" | "B" | "R" | "G" | "C";
+export type PlayerCounterKind = "poison" | "energy" | "experience" | "radiation" | "ticket";
+export type PlayerDto = {
+    id: string;
+    name: string;
+    status: PlayerStatus;
+    isHuman: boolean;
+    life: number;
+    counters: {
+        [key in PlayerCounterKind]?: number;
+    };
+    manaPool: {
+        [key in ManaColor]?: number;
+    };
+    commanderDamage: Record<string, number>;
+    hasCityBlessing: boolean;
+    ringLevel: number;
+    speed: number;
+};
+export type PlayerStatus = "playing" | "lost" | "conceded";
+export type PlaymatSettings = {
+    opacity?: number;
+    texture?: number;
+    borderWidth?: number;
+    borderColor?: string;
+    fit?: string;
+    offsetX?: number;
+    offsetY?: number;
+    zoom?: number;
+    blur?: number;
+    brightness?: number;
+    color?: string;
+};
+export type StackObjectDto = {
+    id: string;
+    sourceId: string;
+    controllerId: string;
+    identity: CardIdentity;
+    text: string;
+    isPermanentSpell: boolean;
+    isCasting: boolean;
+    targets: Array<TargetRef>;
+};
+export type StepKind = "untap" | "upkeep" | "draw" | "main1" | "combatBegin" | "combatDeclareAttackers" | "combatDeclareBlockers" | "combatFirstStrikeDamage" | "combatDamage" | "combatEnd" | "main2" | "endOfTurn" | "cleanup";
+export type TargetingIntent = "damage" | "destroy" | "sacrifice" | "exile" | "bounce" | "mill" | "discard" | "counter" | "tap" | "untap" | "copy" | "buff" | "debuff" | "heal" | "loseLife" | "reveal" | "draw" | "fetch" | "gainControl" | "fight" | "attach" | "attack" | "block" | "hostile" | "friendly";
+export type ZoneDto = {
+    zone: ZoneKind;
+    ownerId: string;
+    cards: Array<CardView>;
+    count: number;
+};
+export type ZoneKind = "battlefield" | "hand" | "library" | "graveyard" | "exile" | "command";

package/dist/game/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./prompts";
+export * from "./transport";
+export type * from "./display";
+export type * from "./game";
+export type * from "./deck";
+export type * from "./lobby";
+export * from "./version";

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// AUTO-GENERATED by `cargo run -p manabrew-protocol --bin gen-protocol`. Do not edit.
+__exportStar(require("./prompts"), exports);
+__exportStar(require("./transport"), exports);
+__exportStar(require("./version"), exports);

package/dist/lobby/index.d.ts

@@ -0,0 +1,43 @@
+import type { Deck } from "../deck/index";
+export type DraftConfig = {
+    set_code?: string;
+    cube_id?: string;
+    cube_name?: string;
+    rounds: number;
+    picks_per_pass: number;
+    seed?: number;
+    fill_with_bots: boolean;
+};
+export type EngineKind = "Manabrew" | "Forge" | "Ironsmith";
+export type GameFormat = "Any" | "Standard" | "Pioneer" | "Modern" | "Legacy" | "Vintage" | "Pauper" | "Commander" | "Brawl" | "Oathbreaker" | "Draft" | "Sealed";
+export type PlayerDeckInfo = {
+    username: string;
+    deck_name: string;
+    deck: Deck;
+    commander_name?: string;
+    avatar?: string;
+};
+export type ResumeRoomRequest = {
+    room_id: string;
+    resume_token: string;
+    room_name: string;
+    max_players: number;
+    format: GameFormat;
+    hosted: boolean;
+    engine: EngineKind;
+    official_key?: string;
+    password?: string;
+    reconnect_timeout_s?: number;
+    draft_config?: DraftConfig;
+    sealed_config?: SealedConfig;
+    player_order: Array<string>;
+    player_decks: Array<PlayerDeckInfo>;
+    starting_life: number;
+    bot_players: Array<string>;
+    game_id: string;
+};
+export type SealedConfig = {
+    set_code: string;
+    num_boosters: number;
+    base_seed?: number;
+};

package/dist/lobby/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseAction.d.ts

@@ -0,0 +1,20 @@
+import type { AvailableAction } from "./common";
+import type { StepKind } from "../game/index";
+export type ChooseActionInput = {
+    actions: Array<AvailableAction>;
+};
+export type ChooseActionOutput = {
+    "type": "pass";
+    until?: PassUntil;
+    exhaustStack: boolean;
+} | {
+    "type": "restoreSnapshot";
+    checkpointId: number;
+} | {
+    "type": "act";
+    actionId: string;
+};
+export type PassUntil = {
+    playerId: string;
+    phase: StepKind;
+};

package/dist/prompts/chooseAction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseAttackers.d.ts

@@ -0,0 +1,15 @@
+import type { AttackAssignment } from "./common";
+import type { AttackTargetDto } from "./common";
+export type AttackerOptionDto = {
+    attackerId: string;
+    validTargetIds: Array<string>;
+    mustAttack: boolean;
+};
+export type ChooseAttackersInput = {
+    attackers: Array<AttackerOptionDto>;
+    attackTargets: Array<AttackTargetDto>;
+};
+export type ChooseAttackersOutput = {
+    "type": "declareAttackers";
+    assignments: Array<AttackAssignment>;
+};

package/dist/prompts/chooseAttackers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseBlockers.d.ts

@@ -0,0 +1,17 @@
+import type { BlockAssignment } from "./common";
+export type BlockableAttackerDto = {
+    attackerId: string;
+    validBlockerIds: Array<string>;
+    minBlockers: number;
+    maxBlockers?: number;
+    mustBeBlocked: boolean;
+};
+export type ChooseBlockersInput = {
+    attackers: Array<BlockableAttackerDto>;
+    availableBlockerIds: Array<string>;
+    error?: string;
+};
+export type ChooseBlockersOutput = {
+    "type": "declareBlockers";
+    assignments: Array<BlockAssignment>;
+};

package/dist/prompts/chooseBlockers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseBoardTargets.d.ts

@@ -0,0 +1,16 @@
+import type { PromptPresentation } from "./common";
+import type { TargetRef } from "./common";
+import type { TargetingIntent } from "../game/index";
+export type ChooseBoardTargetsInput = {
+    presentation: PromptPresentation;
+    candidates: Array<TargetRef>;
+    hostile: boolean;
+    intent: TargetingIntent;
+    minTargets: number;
+    maxTargets: number;
+    chosenTargets: number;
+};
+export type ChooseBoardTargetsOutput = {
+    "type": "boardTargets";
+    chosen: Array<TargetRef>;
+};

package/dist/prompts/chooseBoardTargets.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseBoolean.d.ts

@@ -0,0 +1,10 @@
+import type { PromptPresentation } from "./common";
+export type ChooseBooleanInput = {
+    presentation: PromptPresentation;
+    confirmLabel: string;
+    denyLabel: string;
+};
+export type ChooseBooleanOutput = {
+    "type": "decision";
+    value: boolean;
+};

package/dist/prompts/chooseBoolean.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseCards.d.ts

@@ -0,0 +1,12 @@
+import type { CardDto } from "../game/index";
+import type { PromptPresentation } from "./common";
+export type ChooseCardsInput = {
+    presentation: PromptPresentation;
+    cards: Array<CardDto>;
+    min: number;
+    max: number;
+};
+export type ChooseCardsOutput = {
+    "type": "chooseCardsDecision";
+    chosenCardIds: Array<string>;
+};

package/dist/prompts/chooseCards.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseColor.d.ts

@@ -0,0 +1,13 @@
+import type { PromptPresentation } from "./common";
+export type ChooseColorInput = {
+    presentation: PromptPresentation;
+    validColors: Array<string>;
+    amount: number;
+    repeatAllowed: boolean;
+};
+export type ChooseColorOutput = {
+    "type": "colorDecision";
+    chosenColors: {
+        [key in string]?: number;
+    };
+};

package/dist/prompts/chooseColor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseCombatDamageAssignment.d.ts

@@ -0,0 +1,12 @@
+import type { CombatDamageAssignmentEntry } from "./common";
+export type ChooseCombatDamageAssignmentInput = {
+    attackerId: string;
+    blockerIds: Array<string>;
+    defenderId?: string;
+    totalDamage: number;
+    attackerHasDeathtouch: boolean;
+};
+export type ChooseCombatDamageAssignmentOutput = {
+    "type": "combatDamageAssignmentDecision";
+    assignments: Array<CombatDamageAssignmentEntry>;
+};

package/dist/prompts/chooseCombatDamageAssignment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseDamageAssignmentOrder.d.ts

@@ -0,0 +1,10 @@
+import type { CardDto } from "../game/index";
+export type ChooseDamageAssignmentOrderInput = {
+    attackerId: string;
+    blockerIds: Array<string>;
+    blockerCards: Array<CardDto>;
+};
+export type ChooseDamageAssignmentOrderOutput = {
+    "type": "damageAssignmentOrderDecision";
+    orderedBlockerIds: Array<string>;
+};

package/dist/prompts/chooseDamageAssignmentOrder.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseFromSelection.d.ts

@@ -0,0 +1,16 @@
+import type { PromptPresentation } from "./common";
+export type ChooseFromSelectionInput = {
+    presentation: PromptPresentation;
+    options: Array<SelectionOption>;
+    minTotal: number;
+    maxTotal: number;
+};
+export type ChooseFromSelectionOutput = {
+    "type": "selectionDecision";
+    chosenIndices: Array<number>;
+};
+export type SelectionOption = {
+    label: string;
+    weight: number;
+    canRepeat: boolean;
+};

package/dist/prompts/chooseFromSelection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/chooseNumber.d.ts

@@ -0,0 +1,10 @@
+import type { PromptPresentation } from "./common";
+export type ChooseNumberInput = {
+    presentation: PromptPresentation;
+    min: number;
+    max: number;
+};
+export type ChooseNumberOutput = {
+    "type": "numberDecision";
+    chosenNumber: number | null;
+};

package/dist/prompts/chooseNumber.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/common.d.ts

@@ -0,0 +1,98 @@
+import type { Mana } from "../game/index";
+import type { TargetingIntent } from "../game/index";
+export type ActivatableAbilityInfo = {
+    cardId: string;
+    abilityIndex: number;
+    description: string;
+    isManaAbility: boolean;
+    cost?: string;
+    producedMana?: Array<Mana>;
+};
+/**
+ * Mirrors the engine's `AlternativeCost` (itself a mirror of Java's).
+ */
+export type AlternativeCostKind = "flashback" | "spectacle" | "evoke" | "dash" | "blitz" | "escape" | "overload" | "madness" | "foretell" | "emerge" | "suspend" | "morph" | "megamorph" | "bestow" | "warp" | "sacrificeAlt" | "plot" | "awaken" | "disturb" | "harmonize" | "freerunning" | "impending" | "mayhem" | "moreThanMeetsTheEye" | "mutate" | "prowl" | "sneak" | "surge" | "webSlinging" | "plotted";
+export type AttackAssignment = {
+    attackerId: string;
+    targetId: string;
+};
+export type AttackTargetDto = {
+    id: string;
+    label: string;
+    kind: AttackTargetKind;
+};
+export type AttackTargetKind = "player" | "planeswalker" | "battle";
+export type AvailableAction = {
+    id: string;
+} & ({
+    "type": "cast";
+    cardId: string;
+    mode: PlayCardMode;
+    label: string;
+} | {
+    "type": "activateAbility";
+} & ActivatableAbilityInfo | {
+    "type": "undoMana";
+    cardId: string;
+});
+export type BlockAssignment = {
+    blockerId: string;
+    attackerId: string;
+};
+export type CombatDamageAssignmentEntry = {
+    assigneeId: string;
+    damage: number;
+};
+export type PaymentAction = {
+    id: string;
+} & ({
+    "type": "activateManaAbility";
+} & ActivatableAbilityInfo | {
+    "type": "undoMana";
+    cardId: string;
+} | {
+    "type": "useResource";
+    cardId: string;
+    resource: PaymentResourceKind;
+} | {
+    "type": "releaseResource";
+    cardId: string;
+    resource: PaymentResourceKind;
+} | {
+    "type": "payLife";
+    amount: number;
+});
+export type PaymentResourceKind = "convoke" | "improvise" | "delve";
+/**
+ * Mirrors the engine's `PlayCardMode`.
+ */
+export type PlayCardMode = {
+    "type": "normal";
+} | {
+    "type": "backFaceLand";
+} | {
+    "type": "roomRightSplit";
+} | {
+    "type": "alternative";
+    cost: AlternativeCostKind;
+} | {
+    "type": "staticAlternative";
+} | {
+    "type": "foretellExile";
+} | {
+    "type": "unlockDoor";
+};
+export type PromptPresentation = {
+    title: string;
+    description?: string;
+    text?: string;
+    sourceCardId?: string;
+    targets: Array<TargetRef>;
+};
+export type TargetKind = "player" | "card" | "spell";
+export type TargetRef = {
+    kind: TargetKind;
+    id: string;
+    intent?: TargetingIntent;
+    oracle?: string;
+};

package/dist/prompts/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/diceRolled.d.ts

@@ -0,0 +1,18 @@
+import type { PromptPresentation } from "./common";
+export type DiceRollEntry = {
+    label?: string;
+    playerId?: string;
+    naturalResults: Array<number>;
+    finalResults: Array<number>;
+    ignoredRolls: Array<number>;
+    highlighted: boolean;
+};
+export type DiceRolledInput = {
+    presentation: PromptPresentation;
+    sides: number;
+    rolls: Array<DiceRollEntry>;
+    sourceCardName?: string;
+};
+export type DiceRolledOutput = {
+    "type": "diceRolledAcknowledged";
+};

package/dist/prompts/diceRolled.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/gameOver.d.ts

@@ -0,0 +1 @@
+export type GameOverInput = Record<string, never>;

package/dist/prompts/gameOver.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/index.d.ts

@@ -0,0 +1,24 @@
+export * from "./chooseAction";
+export * from "./chooseAttackers";
+export * from "./chooseBlockers";
+export * from "./chooseBoardTargets";
+export * from "./chooseBoolean";
+export * from "./chooseCards";
+export * from "./chooseColor";
+export * from "./chooseCombatDamageAssignment";
+export * from "./chooseDamageAssignmentOrder";
+export * from "./chooseFromSelection";
+export * from "./chooseNumber";
+export * from "./common";
+export * from "./diceRolled";
+export * from "./gameOver";
+export * from "./mulligan";
+export * from "./mulliganPutBack";
+export * from "./payManaCost";
+export * from "./promptInput";
+export * from "./promptOutput";
+export * from "./reorder";
+export * from "./reveal";
+export * from "./scry";
+import type { PromptInput } from "./promptInput";
+export type PromptType = PromptInput["type"];

package/dist/prompts/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// AUTO-GENERATED by `cargo run -p manabrew-protocol --bin gen-protocol`. Do not edit.
+__exportStar(require("./chooseAction"), exports);
+__exportStar(require("./chooseAttackers"), exports);
+__exportStar(require("./chooseBlockers"), exports);
+__exportStar(require("./chooseBoardTargets"), exports);
+__exportStar(require("./chooseBoolean"), exports);
+__exportStar(require("./chooseCards"), exports);
+__exportStar(require("./chooseColor"), exports);
+__exportStar(require("./chooseCombatDamageAssignment"), exports);
+__exportStar(require("./chooseDamageAssignmentOrder"), exports);
+__exportStar(require("./chooseFromSelection"), exports);
+__exportStar(require("./chooseNumber"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./diceRolled"), exports);
+__exportStar(require("./gameOver"), exports);
+__exportStar(require("./mulligan"), exports);
+__exportStar(require("./mulliganPutBack"), exports);
+__exportStar(require("./payManaCost"), exports);
+__exportStar(require("./promptInput"), exports);
+__exportStar(require("./promptOutput"), exports);
+__exportStar(require("./reorder"), exports);
+__exportStar(require("./reveal"), exports);
+__exportStar(require("./scry"), exports);

package/dist/prompts/mulligan.d.ts

@@ -0,0 +1,8 @@
+export type MulliganInput = {
+    handCardIds: Array<string>;
+    mulliganCount: number;
+};
+export type MulliganOutput = {
+    "type": "mulliganDecision";
+    keep: boolean;
+};

package/dist/prompts/mulligan.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/mulliganPutBack.d.ts

@@ -0,0 +1,10 @@
+import type { CardDto } from "../game/index";
+export type MulliganPutBackInput = {
+    handCardIds: Array<string>;
+    cards: Array<CardDto>;
+    count: number;
+};
+export type MulliganPutBackOutput = {
+    "type": "mulliganPutBackDecision";
+    cardIds: Array<string>;
+};

package/dist/prompts/mulliganPutBack.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/payManaCost.d.ts

@@ -0,0 +1,19 @@
+import type { PaymentAction } from "./common";
+import type { PromptPresentation } from "./common";
+export type PayManaCostInput = {
+    presentation: PromptPresentation;
+    cardId: string;
+    cardName: string;
+    manaCost: string;
+    canConfirmFromPool: boolean;
+    actions: Array<PaymentAction>;
+};
+export type PayManaCostOutput = {
+    "type": "act";
+    actionId: string;
+} | {
+    "type": "pay";
+    auto: boolean;
+} | {
+    "type": "cancel";
+};

package/dist/prompts/payManaCost.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/promptInput.d.ts

@@ -0,0 +1,58 @@
+import type { ChooseActionInput } from "./chooseAction";
+import type { ChooseAttackersInput } from "./chooseAttackers";
+import type { ChooseBlockersInput } from "./chooseBlockers";
+import type { ChooseBoardTargetsInput } from "./chooseBoardTargets";
+import type { ChooseBooleanInput } from "./chooseBoolean";
+import type { ChooseCardsInput } from "./chooseCards";
+import type { ChooseColorInput } from "./chooseColor";
+import type { ChooseCombatDamageAssignmentInput } from "./chooseCombatDamageAssignment";
+import type { ChooseDamageAssignmentOrderInput } from "./chooseDamageAssignmentOrder";
+import type { ChooseFromSelectionInput } from "./chooseFromSelection";
+import type { ChooseNumberInput } from "./chooseNumber";
+import type { DiceRolledInput } from "./diceRolled";
+import type { GameOverInput } from "./gameOver";
+import type { MulliganInput } from "./mulligan";
+import type { MulliganPutBackInput } from "./mulliganPutBack";
+import type { PayManaCostInput } from "./payManaCost";
+import type { ReorderInput } from "./reorder";
+import type { RevealCardsInput } from "./reveal";
+import type { ScryInput } from "./scry";
+export type PromptInput = {
+    "type": "mulligan";
+} & MulliganInput | {
+    "type": "mulliganPutBack";
+} & MulliganPutBackInput | {
+    "type": "chooseAction";
+} & ChooseActionInput | {
+    "type": "chooseAttackers";
+} & ChooseAttackersInput | {
+    "type": "chooseBlockers";
+} & ChooseBlockersInput | {
+    "type": "chooseBoardTargets";
+} & ChooseBoardTargetsInput | {
+    "type": "chooseBoolean";
+} & ChooseBooleanInput | {
+    "type": "chooseFromSelection";
+} & ChooseFromSelectionInput | {
+    "type": "gameOver";
+} & GameOverInput | {
+    "type": "revealCards";
+} & RevealCardsInput | {
+    "type": "scry";
+} & ScryInput | {
+    "type": "chooseColor";
+} & ChooseColorInput | {
+    "type": "chooseNumber";
+} & ChooseNumberInput | {
+    "type": "chooseDamageAssignmentOrder";
+} & ChooseDamageAssignmentOrderInput | {
+    "type": "chooseCombatDamageAssignment";
+} & ChooseCombatDamageAssignmentInput | {
+    "type": "payManaCost";
+} & PayManaCostInput | {
+    "type": "chooseCards";
+} & ChooseCardsInput | {
+    "type": "reorder";
+} & ReorderInput | {
+    "type": "diceRolled";
+} & DiceRolledInput;

package/dist/prompts/promptInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/promptOutput.d.ts

@@ -0,0 +1,73 @@
+import type { ChooseActionOutput } from "./chooseAction";
+import type { ChooseAttackersOutput } from "./chooseAttackers";
+import type { ChooseBlockersOutput } from "./chooseBlockers";
+import type { ChooseBoardTargetsOutput } from "./chooseBoardTargets";
+import type { ChooseBooleanOutput } from "./chooseBoolean";
+import type { ChooseCardsOutput } from "./chooseCards";
+import type { ChooseColorOutput } from "./chooseColor";
+import type { ChooseCombatDamageAssignmentOutput } from "./chooseCombatDamageAssignment";
+import type { ChooseDamageAssignmentOrderOutput } from "./chooseDamageAssignmentOrder";
+import type { ChooseFromSelectionOutput } from "./chooseFromSelection";
+import type { ChooseNumberOutput } from "./chooseNumber";
+import type { DiceRolledOutput } from "./diceRolled";
+import type { MulliganOutput } from "./mulligan";
+import type { MulliganPutBackOutput } from "./mulliganPutBack";
+import type { PayManaCostOutput } from "./payManaCost";
+import type { ReorderOutput } from "./reorder";
+import type { RevealCardsOutput } from "./reveal";
+import type { ScryOutput } from "./scry";
+export type PromptOutput = {
+    "type": "mulligan";
+    "output": MulliganOutput;
+} | {
+    "type": "mulliganPutBack";
+    "output": MulliganPutBackOutput;
+} | {
+    "type": "chooseAction";
+    "output": ChooseActionOutput;
+} | {
+    "type": "chooseAttackers";
+    "output": ChooseAttackersOutput;
+} | {
+    "type": "chooseBlockers";
+    "output": ChooseBlockersOutput;
+} | {
+    "type": "chooseBoardTargets";
+    "output": ChooseBoardTargetsOutput;
+} | {
+    "type": "chooseBoolean";
+    "output": ChooseBooleanOutput;
+} | {
+    "type": "chooseFromSelection";
+    "output": ChooseFromSelectionOutput;
+} | {
+    "type": "revealCards";
+    "output": RevealCardsOutput;
+} | {
+    "type": "scry";
+    "output": ScryOutput;
+} | {
+    "type": "chooseColor";
+    "output": ChooseColorOutput;
+} | {
+    "type": "chooseNumber";
+    "output": ChooseNumberOutput;
+} | {
+    "type": "chooseDamageAssignmentOrder";
+    "output": ChooseDamageAssignmentOrderOutput;
+} | {
+    "type": "chooseCombatDamageAssignment";
+    "output": ChooseCombatDamageAssignmentOutput;
+} | {
+    "type": "payManaCost";
+    "output": PayManaCostOutput;
+} | {
+    "type": "chooseCards";
+    "output": ChooseCardsOutput;
+} | {
+    "type": "reorder";
+    "output": ReorderOutput;
+} | {
+    "type": "diceRolled";
+    "output": DiceRolledOutput;
+};

package/dist/prompts/promptOutput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/reorder.d.ts

@@ -0,0 +1,15 @@
+import type { CardDto } from "../game/index";
+import type { PromptPresentation } from "./common";
+export type ReorderInput = {
+    presentation: PromptPresentation;
+    items: Array<ReorderItem>;
+};
+export type ReorderItem = {
+    id: string;
+    card: CardDto;
+    oracle?: string;
+};
+export type ReorderOutput = {
+    "type": "reorderDecision";
+    orderedIds: Array<string>;
+};

package/dist/prompts/reorder.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/reveal.d.ts

@@ -0,0 +1,12 @@
+import type { CardDto } from "../game/index";
+import type { PromptPresentation } from "./common";
+import type { ZoneKind } from "../game/index";
+export type RevealCardsInput = {
+    presentation: PromptPresentation;
+    cards: Array<CardDto>;
+    zone: ZoneKind;
+    ownerPlayerId: string;
+};
+export type RevealCardsOutput = {
+    "type": "revealCardsAcknowledged";
+};

package/dist/prompts/reveal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/prompts/scry.d.ts

@@ -0,0 +1,12 @@
+import type { CardDto } from "../game/index";
+import type { PromptPresentation } from "./common";
+export type ScryDestination = "libraryTop" | "libraryBottom" | "graveyard" | "exile" | "hand";
+export type ScryInput = {
+    presentation: PromptPresentation;
+    cards: Array<CardDto>;
+    zones: Array<ScryDestination>;
+};
+export type ScryOutput = {
+    "type": "scryDecision";
+    zoneCardIds: Array<Array<string>>;
+};

package/dist/prompts/scry.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/transport/envelope.d.ts

@@ -0,0 +1,16 @@
+import type { PromptInput } from "../prompts";
+export interface PromptRequestEnvelope {
+    promptId?: string;
+    decidingPlayerId?: string;
+    sourceCardId?: string;
+}
+export type PromptRequest<TInput extends {
+    type: string;
+}> = PromptRequestEnvelope & {
+    input: TInput;
+};
+type DistributeRequest<TInput extends {
+    type: string;
+}> = TInput extends unknown ? PromptRequest<TInput> : never;
+export type Prompt = DistributeRequest<PromptInput>;
+export {};

package/dist/transport/envelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/transport/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./messages";
+export * from "./envelope";

package/dist/transport/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// AUTO-GENERATED by `cargo run -p manabrew-protocol --bin gen-protocol`. Do not edit.
+__exportStar(require("./messages"), exports);
+__exportStar(require("./envelope"), exports);

package/dist/transport/messages.d.ts

@@ -0,0 +1,29 @@
+import type { GameViewDto } from "../game/index";
+import type { PromptInput } from "../prompts/promptInput";
+import type { PromptOutput } from "../prompts/promptOutput";
+export type AgentPrompt = {
+    promptId: number;
+    decidingPlayerId: string;
+    sourceCardId?: string;
+    input: PromptInput;
+};
+export type ClientToServerMessage = {
+    "kind": "response";
+    promptId: number;
+    action: PromptOutput;
+} | {
+    "kind": "directive";
+    directive: DirectiveInput;
+};
+export type DirectiveInput = {
+    "type": "concede";
+};
+export type ProtocolError = {
+    code: ProtocolErrorCode;
+    message: string;
+    promptId?: number;
+};
+export type ProtocolErrorCode = "stalePrompt" | "wrongPlayer" | "wrongPromptType" | "unknownActionId" | "invalidShape";
+export type StateUpdate = {
+    gameView: GameViewDto;
+};

package/dist/transport/messages.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.0.1";
+export declare const PROTOCOL_VERSION = 1;

package/dist/version.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROTOCOL_VERSION = exports.VERSION = void 0;
+// AUTO-GENERATED by `cargo run -p manabrew-protocol --bin gen-protocol`. Do not edit.
+exports.VERSION = "1.0.1";
+exports.PROTOCOL_VERSION = 1;

package/package.json

@@ -1,9 +1,38 @@
 {
   "name": "@manabrew/protocol",
-  "version": "0.0.1",
-  "description": "Reserved package name for ManaBrew, a Magic: The Gathering client. See https://github.com/witchesofthehill/manabrew",
-  "license": "GPL-3.0-or-later",
+  "version": "1.0.1",
+  "description": "TypeScript types for the Manabrew wire protocol — the engine↔client message contract for the Manabrew Magic: The Gathering client.",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/witchesofthehill/manabrew.git",
+    "directory": "packages/protocol"
+  },
+  "homepage": "https://docs.manabrew.app/protocol/",
+  "bugs": "https://github.com/witchesofthehill/manabrew/issues",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0"
   }
 }