vue-pgn-viewer 0.2.1 → 0.3.1

package/dist/vue-pgn-viewer.d.ts

@@ -1,22 +1,110 @@
 import { Api } from 'chessground/api';
 import { Color } from 'chessops';
+import { CommentShape } from 'chessops/pgn';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { Config } from 'chessground/config';
 import { DefineComponent } from 'vue';
+import { FEN } from 'chessground/types';
+import { Move } from 'chessops';
+import { Node as Node_2 } from 'chessops/pgn';
+import { Position } from 'chessops';
 import { PublicProps } from 'vue';
 
+declare type AnyNode = Node_2<MoveData>;
+
+declare type Clocks = {
+    white?: number;
+    black?: number;
+};
+
 declare type ComponentProps = {
     config?: PgnViewerConfig;
 };
 
+declare type Game = {
+    mainline: MoveData[];
+    initial: Initial;
+    moves: AnyNode;
+    players: Players;
+    metadata: Metadata;
+    title(): string;
+    hasPlayerName(): boolean;
+    nodeAt(path: Path): AnyNode | undefined;
+    dataAt(path: Path): MoveData | Initial | undefined;
+    pathAtMainlinePly(ply: Ply | "last"): Path;
+};
+
 declare type GoTo = "first" | "prev" | "next" | "last";
 
 declare type Id = string;
 
+declare type Initial = InitialOrMove & {
+    pos: Position;
+};
+
+declare type InitialOrMove = {
+    fen: FEN;
+    turn: Color;
+    check: boolean;
+    comments: string[];
+    shapes: CommentShape[];
+    clocks: Clocks;
+};
+
 declare type Lichess = string | false;
 
-declare type Pane = "board" | "menu" | "pgn";
+declare type Metadata = {
+    externalLink?: string;
+    isLichess: boolean;
+    timeControl?: {
+        initial: number;
+        increment: number;
+    };
+    orientation?: Color;
+    result?: string;
+};
+
+declare type MoveData = InitialOrMove & {
+    path: Path;
+    ply: number;
+    move: Move;
+    san: San;
+    uci: Uci;
+    startingComments: string[];
+    nags: number[];
+    emt?: number;
+};
+
+declare type Options = {
+    pgn: string;
+    fen?: string;
+    chessground: Config;
+    orientation?: Color;
+    showPlayers: ShowPlayers;
+    showMoves: ShowMoves;
+    showClocks: boolean;
+    showControls: boolean;
+    initialPly: Ply | "last";
+    scrollToMove: boolean;
+    keyboardToMove: boolean;
+    drawArrows: boolean;
+    menu: {
+        getPgn: {
+            enabled?: boolean;
+            fileName?: string;
+        };
+        practiceWithComputer?: {
+            enabled?: boolean;
+        };
+        analysisBoard?: {
+            enabled?: boolean;
+        };
+    };
+    lichess: Lichess;
+    classes?: string;
+    translate?: Translate;
+};
 
 declare type Path = {
     path: string;
@@ -37,16 +125,17 @@ ready: (api: PgnViewerApi) => any;
 }, string, PublicProps, Readonly<ComponentProps> & Readonly<{
 onReady?: ((api: PgnViewerApi) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
-board: HTMLDivElement;
+div: HTMLDivElement;
 }, HTMLDivElement>;
 
 export declare type PgnViewerApi = {
+    game: Game;
     path: Path;
     translate: Translate;
-    ground: Api;
+    ground?: Api;
     div?: HTMLElement;
     flipped: boolean;
-    pane: Pane;
+    pane: string;
     autoScrollRequested: boolean;
     focus(): void;
     orientation(): string;
@@ -61,44 +150,30 @@ export declare type PgnViewerApi = {
     setGround(api: Api): void;
 };
 
-export declare type PgnViewerConfig = Partial<PgnViewerOptions>;
+export declare type PgnViewerConfig = Partial<Options>;
 
-declare type PgnViewerOptions = {
-    pgn: string;
-    fen?: string;
-    chessground: Config;
-    orientation?: Color;
-    showPlayers: ShowPlayers;
-    showMoves: ShowMoves;
-    showClocks: boolean;
-    showControls: boolean;
-    initialPly: Ply | "last";
-    scrollToMove: boolean;
-    keyboardToMove: boolean;
-    drawArrows: boolean;
-    menu: {
-        getPgn: {
-            enabled?: boolean;
-            fileName?: string;
-        };
-        practiceWithComputer?: {
-            enabled?: boolean;
-        };
-        analysisBoard?: {
-            enabled?: boolean;
-        };
-    };
-    lichess: Lichess;
-    classes?: string;
-    translate?: Translate;
+declare type Player = {
+    name?: string;
+    title?: string;
+    rating?: number;
+    isLichessUser: boolean;
+};
+
+declare type Players = {
+    white: Player;
+    black: Player;
 };
 
 declare type Ply = number;
 
+declare type San = string;
+
 declare type ShowMoves = false | "right" | "bottom" | "auto";
 
 declare type ShowPlayers = true | false | "auto";
 
 declare type Translate = (key: string) => string | undefined;
 
+declare type Uci = string;
+
 export { }