schachnovelle 1.0.0-beta-6 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project (tries to) adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+<!-- ### Added
+### Changed
+### Removed -->
+
+## [1.0.1] - 2020-12-16
+### Added
+- Changelog
+
+## [1.0.0] - 2020-12-16
+### Added
+- Promotion to different pieces
+
+### Changed
+- Clear the console instead of adding to the end of the line
+
+### Removed

package/README.md

@@ -23,10 +23,14 @@ or npm
 ...And play!
 
 ## Features
-Currently only supports basic moves and captures. There is no check detection yet. Play with your head! For now...
+There is no check detection yet. Play with your head! For now...
 
-You can play against yourself or a friend on the same keyboard. I'm working on more functionality and learning as I go along.
+You can play against yourself or a friend on the same keyboard.
 
-Long term, I want to connect this to the [lichess](https://lichess.org/) API, so you can play others from the comfort of the command line!
+## Roadmap
 
-_[Touch you later](http://touchystudios.com/)_
+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!
+
+## Changelog
+
+_[Changelog](CHANGELOG.md)_

package/index.js

@@ -1,42 +1,4 @@
 #!/usr/bin/env node
-const { spawn, exec } = require('child_process');
-
 const ui = require('./ui')
 
-ui.init()
-// const server = spawn('node', ['server'])
-// const ui = spawn('node', ['ui'])
-
-// server.stdout.on('data', (data) => {
-//   console.log(`server: ${data}`);
-// });
-
-// server.stderr.on('data', (data) => {
-//   console.error(`server error: ${data}`);
-// });
-
-// server.on('exit', (code, signal) => {
-//   console.log(`child process exited with code ${code} and signal ${signal}`);
-// })
-
-// server.on('close', (code) => {
-//   console.log(`child process exited with code ${code}`);
-// });
-
-// ui.stdout.on('data', (data) => {
-//   console.log(data);
-// });
-
-// ui.stderr.on('data', (data) => {
-//   console.error(`ui error: ${data}`);
-// });
-
-// ui.on('exit', (code, signal) => {
-//   console.log(`ui process exited with code ${code} and signal ${signal}`);
-// })
-
-// ui.on('close', (code) => {
-//   console.log(`ui exited with code ${code}`);
-// });
-
-
+ui.init()

package/package.json

@@ -1,18 +1,34 @@
 {
   "name": "schachnovelle",
-  "version": "1.0.0-beta-6",
+  "version": "1.1.0",
   "description": "Chess to play on the command line",
   "main": "index.js",
+  "scripts": {
+    "play": "node index.js",
+    "serve": "node server/index.js"
+  },
   "bin": {
-    "schachnovelle": "index.js"
+    "schachnovelle": "index.js",
+    "schachnovelle.server": "server/index.js"
+  },
+  "engines": {
+    "node": ">=14.15.0"
   },
+  "engineStrict": true,
   "author": "Manus <manusnijhoff@gmail.com>",
   "license": "MIT",
   "dependencies": {
+    "axios": "^0.20.0",
     "chalk": "^4.0.0",
     "dotenv": "^8.2.0",
     "enquirer": "^2.3.5",
     "express": "^4.17.1",
-    "node-fetch": "^2.6.0"
+    "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

@@ -0,0 +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 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)
+      })
+    })
+  },
+
+  /**
+   * 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)
+  
+      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,19 +1,444 @@
 require('dotenv').config()
 
+// 
+// 
+// Imports
 const express = require('express')
-const app = express()
-const port = process.env.SN_PORT
+// Storage
+const open = require('open')
+const session = require('express-session')
+const MemoryStore = require('memorystore')(session)
+// Lichess
+const lichess = require('./api')
 
-app.use(express.json())
+/* Create your lichess OAuth app on https://lichess.org/account/oauth/app/create
+ * Homepage URL: http://localhost:3000
+ * Callback URL: http://localhost:3000/callback
+ */
 
-app.post('/move', (req, res) => {
-  const response = 'move is ' + req.body.move
-  console.log(response)
-  res.json({
-    message: response
+
+
+//
+//
+// 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',
+  'bot:play'
+];
+
+
+
+//
+//
+// Lichess
+const tokenHost = 'https://oauth.lichess.org/';
+const tokenPath = '/oauth';
+const authorizePath = '/oauth/authorize';
+
+const oAuthConfig = {
+  client: {
+    id: clientId,
+    secret: clientSecret
+  },
+  auth: {
+    tokenHost,
+    tokenPath,
+    authorizePath
+  }
+}
+
+const { AuthorizationCode } = require('simple-oauth2')
+const client = new AuthorizationCode(oAuthConfig)
+
+
+
+//
+//
+// Initialize the server
+const app = express();
+
+
+
+// 
+// 
+// Set things
+app.set('view engine', 'pug')
+
+
+
+//
+//
+// Session
+app.use(session({
+  cookie: { maxAge: 86400000 },
+  store: new MemoryStore({
+    checkPeriod: 86400000 // prune expired entries every 24h
+  }),
+  resave: false,
+  secret: 'keyboard cat',
+  saveUninitialized: true
+}))
+
+
+
+//
+//
+// Show the "log in with lichess" button
+app.get('/', (req, res) => {
+  if (req.session.userInfo) {
+    res.redirect('/welcome')
+  } else {
+    res.render('../views/index')
+  }
+})
+
+
+
+//
+//
+// Initial page redirecting to Lichess
+app.get('/auth', (req, res) => {
+  const state = Math.random().toString(36).substring(2)
+
+  const authorizationUri = client.authorizeURL({
+    redirect_uri: redirectUri,
+    scope: scopes.join(' '),
+    state
   })
+
+  res.redirect(authorizationUri)
+})
+
+
+//
+//
+// callback page
+app.get('/callback', async (req, res) => {
+  const tokenParams = {
+    code: req.query.code,
+    redirect_uri: redirectUri,
+    scope: scopes.join(' ')
+  }
+
+  try {
+    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')
+  } catch (error) {
+    console.log('Access Token Error', error.message)
+  }
+})
+
+
+
+//
+//
+// Welcome page
+app.get('/welcome', async (req, res) => {
+  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, () => {
-  console.log('listening at http://localhost:', port)
-})
+app.listen(port, async () => {
+  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'
+// }