chesstery-analysis-api

Forked from chess-analysis-api and modified. Fix minification bug after webpack bundling (check this for further information: MDN: Function.name, change import/require statements on Worker (web-worker), Chess constructor)

> chess engine that consume lichess API and wasm of stockfish for purpose a chess engine with hight level interface.

$3

npm install chesstery-analysis-api

or with _yarn_

yarn add chesstery-analysis-api

$3

ES6 Syntax

``js
import { chessAnalysisApi } from 'chesstery-analysis-api';

chessAnalysisApi
.getAnalysis({
//
fen: 'r1bqkb1r/pppp1ppp/2n2n2/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 4 4',

// calcul depth default=7
depth: 12,

// number options move should calcul
multipv: 2,
})
.then((result) => {
console.log(result);
// ...
})
.catch((error) => {
console.error(error);
throw new Error(error.message);

// ...
});
`

$3

this package consume multiple providers:

- lichess API opening

- lichess API cloud eval

- WASM stockfish

And with a _manager_, the package calls for the best providers according to the FEN position,
for sample if the FEN position indicates less than 10 moves played, the _manager_ will call the provider of the _openings_.
But if the FEN position indicates more than 35 moves already played the _manager_ will not report the opening providers,
nor the cloud assessment providers _(because the cloud assessment providers only give results from their cache)_
and call directly the stockfish provider.

$3

chess-analysis-api use 3 providers for Lichess API opening and Lichess API cloud not use parameter depth that represent calcul power of
chess engine if you want full control of calcul power engine, you should exclude Lichess Provider and use only Stockfish provider.

Example:

`js
import { chessAnalysisApi, PROVIDERS } from 'chesstery-analysis-api';

chessAnalysisApi
.getAnalysis({
//
fen: 'r1bqkb1r/pppp1ppp/2n2n2/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 4 4',

// calcul depth default=7
depth: 12,

// number options move should calcul
multipv: 2,

// excludes provider.s
excludes: [PROVIDERS.LICHESS_BOOK, PROVIDERS.LICHESS_CLOUD_EVAL],
})
.then((result) => {
console.log(result);
// ...
})
.catch((error) => {
console.error(error);
throw new Error(error.message);

// ...
});
`

$3

See below result format as response of getAnalysis: (...arg) => Promise:

`ts
export type AnalysisOutputProviderType = 'lichess' | 'stockfish';

export type AnalysisOutputActionType = 'opening' | 'eval';

export type AnalysisOutputLineScoreType = 'cp' | 'mate';
export type AnalysisOutputLineScore = {
type: AnalysisOutputLineScoreType;
value: number;
};

export type AnalysisOutputLineType = {
// computer eval in centi-pawn view by white player
score?: AnalysisOutputLineScore;

// next moves (main line of computer)
uci: string | string[];
};

export type AnalysisOutputType = {
provider: AnalysisOutputProviderType;
type: AnalysisOutputActionType;

fen: string;

// power calcul only for stockfish provider
depth?: number;

// number of lines
multipv?: number;

// opening data only for lichess opening provider
opening?: {
eco: string; // opening FIDE code
name: string; // opening full name
} | null;

moves: AnalysisOutputLineType[];
};
``

for the reason node.js don't work with webworkers to pass all the test checkout to the 'all-test-passed' branch, which differ only in require/import statements for stockfish (and its data parsing) and Chess constructor