schachnovelle 1.0.1 → 1.0.3

package/README.md

@@ -4,8 +4,8 @@ _»Um Gottes Willen! Nicht!«_
 [![Find the code on GitLab](https://upload.wikimedia.org/wikipedia/commons/d/d9/Chess_clt45.svg)](https://gitlab.com/manegame/schachnovelle)
 
 
+_[manusnijhoff.nl](https://manusnijhoff.nl)_,
 _[Read the book](https://en.wikipedia.org/wiki/The_Royal_Game)_, _[Play me on lichess](https://lichess.org/@/manegame)_,
-_[Check out my website](https://manusnijhoff.nl)_
 
 
 ## Installation
@@ -23,13 +23,11 @@ or npm
 ...And play!
 
 ## Features
-There is no check detection yet. Play with your head! For now...
-
 You can play against yourself or a friend on the same keyboard.
 
 ## Roadmap
 
-I'm slowly working on connecting this to the [lichess](https://lichess.org/) API, so you can play others from the comfort of the command line!
+I'd love to connect this to the [lichess](https://lichess.org/) API, so you can play others from the comfort of the command line!
 
 ## Changelog
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schachnovelle",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Chess to play on the command line",
   "main": "index.js",
   "scripts": {
@@ -25,8 +25,10 @@
     "express": "^4.17.1",
     "express-session": "^1.17.1",
     "memorystore": "^1.6.4",
+    "ndjson": "^2.0.0",
     "node-fetch": "^2.6.0",
     "open": "^7.3.0",
+    "pug": "^3.0.0",
     "simple-oauth2": "^4.1.0"
   }
 }

package/server/api.js

@@ -1,24 +1,132 @@
 const axios = require('axios')
+const https = require('https')
+const ndjson = require('ndjson')
 
 module.exports = {
+
+  /**
+   * get the user's information
+   * @param {*} token 
+   */
   getUserInfo (token) {
-    return axios.get('/api/account', {
-      baseURL: 'https://lichess.org/',
-      headers: { 'Authorization': 'Bearer ' + token.access_token }
+    return new Promise((resolve, reject) => {
+      axios.get('/api/account', {
+        baseURL: 'https://lichess.org/',
+        headers: { 'Authorization': 'Bearer ' + token.access_token }
+      })
+      .then((response) => {
+        resolve(response)
+      })
+      .catch((error) => {
+        reject(error)
+      })
     })
   },
 
-  streamEvents (token) {
-    return axios.get('/api/stream/event', {
-      baseURL: 'https://lichess.org/',
-      headers: { 'Authorization': 'Bearer ' + token.access_token }
+  /**
+   * Create an event stream
+   * @param {*} token 
+   */
+  createEventStream (token) {
+    const options = {
+      headers: {
+        'Authorization': 'Bearer ' + token.access_token
+      }
+    }
+
+    return new Promise((resolve, reject) => { 
+      const req = https.get('https://lichess.org/api/stream/event', options)
+
+      req
+        .on('response', (stream) => {
+          const { statusCode } = stream
+          
+          if (statusCode >= 200 && statusCode < 300) {
+            resolve(stream)
+          }
+        })
+        .on('error', (error) => {
+          reject(error)
+        })
     })
   },
+
+  createGameStream (token, gameId) {
+    const options = {
+      headers: {
+        'Authorization': 'Bearer ' + token.access_token
+      }
+    }
+
+    return new Promise((resolve, reject) => {
+      const req = https.get(`https://lichess.org/api/board/game/stream/${gameId}`, options)
   
-  createSeek (token) {
-    return axios.post('/api/board/seek', {
-        baseURL: 'https://lichess.org',
-        headers: { 'Authorization': 'Bearer ' + token.access_token }
+      req
+        .on('response', (stream) => {
+          const { statusCode } = stream
+  
+          if (statusCode >= 200 && statusCode < 300) {
+            resolve(stream)
+          }
+        })
+        .on('error', (error) => {
+          reject(error)
+        })
+    })
+  },
+
+  // Commence play after the user has been identified
+  startPlay (req, res) {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const stream = await this.createEventStream(req.session.accessToken)
+        stream
+          .pipe(ndjson.parse())
+          .on('data', (data) => {
+            // Always write the data type to the stream
+            process.stdout.write(data.type)
+
+            // Hook into events from event stream!
+            if (data.type === 'gameStart') {
+              req.session.currentGame = data.game
+              this.openGameStream(req)
+            } else {
+              console.log('!!!   unhandled data type   !!!')
+              console.log(data)
+              console.log('!!! end unhandled data type !!!')
+            }
+          })
+      } catch (error) {
+        reject(error)
+      } finally {
+        resolve({ status: 200 })
+      }
     })
+  },
+
+  // Tryout to follow a game
+  async openGameStream (req) {
+    try {
+      const stream = await this.createGameStream(req.session.accessToken, req.session.currentGame.id)
+
+      stream
+        .pipe(ndjson.parse())
+        .on('data', (data) => {
+          // Write data type to stdout
+          process.stdout.write(data.type)
+
+          if (data.type === 'gameFull') {
+            req.session.currentGame.data = data
+          } else if (data.type === 'gameState') {
+            req.session.currentGame.data.gameState = data
+          } else {
+            console.log('UNUSED DATA TYPE', data.type)
+          }
+        })
+    } catch (error) {
+      console.error(error)
+    }
   }
+
+
 }

package/server/index.js

@@ -1,30 +1,41 @@
 require('dotenv').config()
 
+// 
+// 
+// Imports
 const express = require('express')
-const session = require('express-session')
+// Storage
 const open = require('open')
+const session = require('express-session')
 const MemoryStore = require('memorystore')(session)
-const simpleOauth = require('simple-oauth2')
-const api = require('./api')
+// Lichess
+const lichess = require('./api')
 
 /* Create your lichess OAuth app on https://lichess.org/account/oauth/app/create
  * Homepage URL: http://localhost:3000
  * Callback URL: http://localhost:3000/callback
  */
 
+
+
 //
 //
 // Server + Auth config
 const port = 3000
+const host = process.env.NODE_ENV === 'production' ? 'https://schachnovelle.online' : 'http://localhost'
 const clientId = process.env.LICHESS_ID
 const clientSecret = process.env.LICHESS_SECRET
 const redirectUri = `http://localhost:${port}/callback`
 
+// Scopes
 const scopes = [
   'preference:read',
   'challenge:read',
-  'board:play'
-  ];
+  'board:play',
+  'bot:play'
+];
+
+
 
 //
 //
@@ -45,13 +56,25 @@ const oAuthConfig = {
   }
 }
 
-const { ClientCredentials, ResourceOwnerPassword, AuthorizationCode } = require('simple-oauth2')
+const { AuthorizationCode } = require('simple-oauth2')
 const client = new AuthorizationCode(oAuthConfig)
 
+
+
 //
 //
 // Initialize the server
 const app = express();
+
+
+
+// 
+// 
+// Set things
+app.set('view engine', 'pug')
+
+
+
 //
 //
 // Session
@@ -70,7 +93,15 @@ app.use(session({
 //
 //
 // Show the "log in with lichess" button
-app.get('/', (req, res) => res.send('Hello<br><a href="/auth">Log in with lichess</a>'));
+app.get('/', (req, res) => {
+  if (req.session.userInfo) {
+    res.redirect('/welcome')
+  } else {
+    res.render('../views/index')
+  }
+})
+
+
 
 //
 //
@@ -85,7 +116,8 @@ app.get('/auth', (req, res) => {
   })
 
   res.redirect(authorizationUri)
-});
+})
+
 
 //
 //
@@ -98,10 +130,10 @@ app.get('/callback', async (req, res) => {
   }
 
   try {
-    console.log('creating token')
     const result = await client.getToken(tokenParams)
     const accessToken = client.createToken(result)
-    
+
+    // Save token to the session
     req.session.accessToken = accessToken.token.token
 
     res.redirect('/welcome')
@@ -110,35 +142,303 @@ app.get('/callback', async (req, res) => {
   }
 })
 
+
+
 //
 //
 // Welcome page
 app.get('/welcome', async (req, res) => {
-    if (req.session.accessToken) {
-      console.log('Getting user information')
-      const userInfo = await api.getUserInfo(req.session.accessToken);
-      
-      // open a stream for events
-      // const stream = await api.streamEvents(accessToken.token.token)
-    
-      // console.log(stream)
-      // stream.on('data', (data) => {
-      //   console.log(data)
-      // })
-      
-      // seek a game
-      // const seek = api.createSeek(accessToken.token.token)
-      // console.log(seek)
-  
-      // send the webpage response
-      res.send(`<h1>Success!</h1>Your lichess user info: <pre>${JSON.stringify(userInfo.data)}</pre>`)
-    } else {
-      res.redirect('/')
+  if (req.session.accessToken) {    
+    try {
+      const userInfo = await lichess.getUserInfo(req.session.accessToken)
+      req.session.userInfo = userInfo.data
+    } catch (error) {
+      console.error(error)
+    } finally {
+      if (req.session.userInfo) {
+        lichess.startPlay(req, res)
+          .then((response) => {
+            if (response.status === 200) {
+              // This goes to the UI
+              process.stdout.write('streamReady')
+              // This to the browser
+              res.render('../views/welcome', { user: req.session.userInfo })
+            } else {
+              res.render('../views/error', response)
+            }
+          })
+          .catch((error) => {
+            console.error(error)
+            res.render('../views/error', error)
+          })
+        } else {
+        res.render('../views/error')
+      }
     }
+    
+  } else {
+    res.redirect('/')
+  }
 })
 
 app.listen(port, async () => {
-  await open(`http://localhost:${port}`)
+  await open(`${host}:${port}`)
 });
 
 
+
+// SAMPLE DATA
+
+// { type: 'gameStart', game: { id: 'Wmv3QOtD' } }
+// {
+//   id: 'Wmv3QOtD',
+//   variant: { key: 'standard', name: 'Standard', short: 'Std' },
+//   clock: { initial: 600000, increment: 3000 },
+//   speed: 'rapid',
+//   perf: { name: 'Rapid' },
+//   rated: false,
+//   createdAt: 1612916752568,
+//   white: { id: 'manegame', name: 'manegame', title: null, rating: 1155 },
+//   black: {
+//     id: 'schachnovelle-online',
+//     name: 'schachnovelle-online',
+//     title: null,
+//     rating: 1500,
+//     provisional: true
+//   },
+//   initialFen: 'startpos',
+//   type: 'gameFull',
+//   state: {
+//     type: 'gameState',
+//     moves: '',
+//     wtime: 600000,
+//     btime: 600000,
+//     winc: 3000,
+//     binc: 3000,
+//     wdraw: false,
+//     bdraw: false,
+//     status: 'started'
+//   }
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4',
+//   wtime: 600000,
+//   btime: 600000,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5',
+//   wtime: 600000,
+//   btime: 600000,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3',
+//   wtime: 599590,
+//   btime: 600000,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6',
+//   wtime: 599590,
+//   btime: 597200,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4',
+//   wtime: 598580,
+//   btime: 597200,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5',
+//   wtime: 598580,
+//   btime: 595560,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5',
+//   wtime: 592540,
+//   btime: 595560,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5',
+//   wtime: 592540,
+//   btime: 595370,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5',
+//   wtime: 591460,
+//   btime: 595370,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4',
+//   wtime: 591460,
+//   btime: 594720,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3',
+//   wtime: 578720,
+//   btime: 594720,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2',
+//   wtime: 578720,
+//   btime: 597720,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1',
+//   wtime: 565650,
+//   btime: 597720,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3',
+//   wtime: 565650,
+//   btime: 595360,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3',
+//   wtime: 556810,
+//   btime: 595360,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3 c8h3',
+//   wtime: 556810,
+//   btime: 587450,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3 c8h3 f1g1',
+//   wtime: 547270,
+//   btime: 587450,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3 c8h3 f1g1 h3g2',
+//   wtime: 547270,
+//   btime: 581970,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3 c8h3 f1g1 h3g2 b2b3',
+//   wtime: 543850,
+//   btime: 581970,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'started'
+// }
+// { type: 'gameFinish', game: { id: 'Wmv3QOtD' } }
+// {
+//   type: 'gameState',
+//   moves: 'e2e4 e7e5 g1f3 c7c6 f1c4 d7d5 c4d5 c6d5 f3e5 d5e4 g2g3 d8d2 e1f1 e4e3 c2c3 c8h3 f1g1 h3g2 b2b3 d2f2',
+//   wtime: 543850,
+//   btime: 574250,
+//   winc: 3000,
+//   binc: 3000,
+//   wdraw: false,
+//   bdraw: false,
+//   status: 'mate',
+//   winner: 'black'
+// }

package/ui/Board.js

@@ -29,9 +29,11 @@ class Board {
   }
 
   render () {
+    // this.topCheck()
     this.topRank()
     this.board()
     this.bottomRank()
+    // this.bottomCheck()
   }
 
   getPiece (file, rank) {
@@ -53,13 +55,13 @@ class Board {
        * Pieces
        */
       if (activeWhitePiece) {
-        if (activeWhitePiece.inCheck === true) {
+        if (activeWhitePiece.type === 'King' && this.white.inCheck) {
           return chalk`{red ${activeWhitePiece.piece}}  `
         } else {
           return chalk`{black ${activeWhitePiece.piece}}  `
         }
       } else if (activeBlackPiece) {
-        if (activeBlackPiece.inCheck === true) {
+        if (activeBlackPiece.type === 'King' && this.black.inCheck) {
           return chalk`{red ${activeBlackPiece.piece}}  `
         } else {
           return chalk`{black ${activeBlackPiece.piece}}  `
@@ -92,7 +94,7 @@ class Board {
   scoreBoard (side) {
     let scoreBoard = ''
     let score = 0
-    const opponent = this.utils.opponentColor(side)
+    const opponent = this.utils.opposingColor(side)
     const pieces = this.capturedPieces(opponent)
     
     if (pieces.length > 0) {
@@ -110,11 +112,30 @@ class Board {
     this.printer.addSpace('y')
   }
 
+  /**
+   * For development only. Display if the king is in check
+   */
+  topCheck () {
+    const side = this.utils.opposingColor(this.options.orientation)
+    this.printer.print(side + ' king in check: ' + this[side].inCheck)
+    this.printer.addSpace('y')
+  }
+
+  /**
+   * For development only. Display if the king is in check
+   */
+  bottomCheck () {
+    const side = this.options.orientation
+    this.printer.print(side + ' king in check: ' + this[side].inCheck)
+    this.printer.addSpace('y')
+  }
+
   /**
    * Top signage
    */
   topRank () {
-    this.scoreBoard(this.utils.opponentColor(this.options.orientation))
+    const side = this.utils.opposingColor(this.options.orientation)
+    this.scoreBoard(side)
     let renderTopRank = this.printer.tab
     renderTopRank = this.printer.addSpace('x', renderTopRank)
     for (let file in this.files) {

package/ui/Fen.js

@@ -0,0 +1,5 @@
+export default {
+  currentPosition: null,
+  startPos: 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1',
+  moves: []
+}