@pompidup/kingdomino-engine 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+declare const ground: readonly ["castle", "wheat", "forest", "sea", "plain", "swamp", "mine"];
+type Ground = (typeof ground)[number];
+type Tile = {
+    type: Ground;
+    crowns: number;
+};
+type EmptyTile = {
+    type: "empty";
+    crowns: 0;
+};
+type Domino = {
+    left: Tile;
+    right: Tile;
+    number: number;
+};
+type RevealsDomino = {
+    domino: Domino;
+    picked: boolean;
+    kingId: string | null;
+    position: number;
+};
+
+type Position = {
+    x: number;
+    y: number;
+};
+type Orientation = "vertical" | "horizontal";
+type Rotation = 0 | 180;
+type Kingdom = (Tile | EmptyTile)[][];
+
+type King = {
+    id: string;
+    playerId: string;
+    order: number;
+    turnEnded: boolean;
+    hasPick: boolean;
+    hasPlace: boolean;
+    dominoPicked?: Domino;
+};
+type Player = {
+    id?: string;
+    name: string;
+    kingdom: Kingdom;
+};
+declare const availableMode: readonly ["Classic"];
+type AvailableMode = (typeof availableMode)[number];
+type Rule = {
+    name: string;
+    description: string;
+    mode: AvailableMode[];
+    playersLimit?: number;
+};
+type Game = {
+    id: string;
+    dominoes: Domino[];
+    currentDominoes: RevealsDomino[];
+    players: Player[];
+    kings: King[];
+    turn: number;
+    maxTurns: number;
+    maxDominoes: number;
+    dominoesPerTurn: number;
+    order: Record<number, string>;
+    rules?: Rule[];
+};
+
+type Score = {
+    score: number;
+    maxPropertiesSize: number;
+    totalCrowns: number;
+};
+
+type ScoreResult = {
+    playerId: string;
+    playerName: string;
+    details: Score;
+};
+type FinalResult = ScoreResult & {
+    position: number;
+};
+
+type Resp = {
+    nextKing: string;
+    nextAction: "pick" | "place" | "end";
+    game: Game;
+};
+type GameResult = {
+    result: FinalResult[];
+    game: Game;
+};
+/** Todo
+ * Add rules step
+ *
+ **/
+declare const gameEngine: () => {
+    init: () => Game;
+    getMode: () => readonly ["Classic"];
+    setMode: (mode: string, game: Game) => Game;
+    getRules: (mode: string) => never[];
+    setRules: (rules: string[], game: Game) => Game;
+    start: (game: Game, players: {
+        name: string;
+    }[]) => Resp;
+    pass: (game: Game, kingId: string) => Resp;
+    placeDomino: (game: Game, kingId: string, position: Position, orientation: Orientation, rotation: Rotation) => Resp;
+    pickDomino: (game: Game, kingId: string, dominoPick: number) => Resp;
+    endGame: (game: Game) => GameResult;
+};
+
+export { gameEngine as default };