@slugbugblue/trax 0.19.0 → 0.20.0

package/src/cmds/play-try.js

@@ -1,4 +1,4 @@
-/* Copyright 2022 Chad Transtrum
+/* Copyright 2022-2023 Chad Transtrum
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 // CLI play/try commands
 
 import { suggest } from '@slugbugblue/trax/analyst'
+import { timeString } from '@slugbugblue/trax/utils'
 
 const moveRx = /^\d+\.?$/
 const notationRx = /^[@a-z]+\d+[bps/\\+]$/i
@@ -70,9 +71,14 @@ const bot = (CLI) => {
 
     CLI.do('view')
     CLI.out(CLI.bubble(trax.color + 'd', `${name} thinking...`))
+    const start = Date.now()
     const move = suggest(trax)?.pick?.move
+    const ms = Date.now() - start
     if (move) {
-      CLI.out(CLI.bubble(trax.color + 'd', `${name} chooses ${move}`))
+      CLI.out(
+        CLI.bubble(trax.color + 'd', `${name} chooses ${move}`) +
+          CLI.color.black(' in ' + timeString(ms)),
+      )
       trax.play(move)
     }
 

package/src/cmds/puzzles.js

@@ -1,5 +1,5 @@
 /** @file Puzzles CLI
- * @copyright 2022
+ * @copyright 2022-2023
  * @author Chad Transtrum <chad@transtrum.net>
  * @license Apache-2.0
  */
@@ -34,8 +34,14 @@ const an = (word = '') => {
 }
 
 const showPuzzle = (CLI, id) => {
-  const puzzle = puzzles.find((p) => p.id === id)
+  let puzzle = puzzles.find((p) => p.id === id)
+  if (!puzzle) {
+    const possibles = puzzles.filter((p) => p.id.includes(id))
+    if (possibles.length === 1) puzzle = possibles[0]
+  }
+
   if (!puzzle) return CLI.error(`Puzzle ${id} not found`)
+
   const trax = new Trax(puzzle.game, puzzle.notation, 'cli')
   const players = ['white', 'black']
   CLI.display(trax, players)
@@ -45,14 +51,19 @@ const showPuzzle = (CLI, id) => {
   if (puzzle.desc) out += CLI.color.help(puzzle.desc) + '\n'
   out += CLI.color(players[puzzle.player - 1] + ' to win by move ' + puzzle.max)
   const src = sources[puzzle.src]
+
   if (src) {
     let source = '\nPuzzle '
     source += src.copyright
       ? 'copyright ' + src.copyright + ' by'
       : 'courtesy of'
     source += ' ' + src.name
-    const url = src.url ? ' ' + CLI.color.white(src.url) : ''
-    out += CLI.color.black(source) + url
+    const url = src.url ? ' ' + CLI.color.help(src.url) : ''
+    out += CLI.color.white(source) + url
+    if (src.license) {
+      out += '\n' + CLI.color.optional('License: ' + src.license)
+      if (src.licenseUrl) out += CLI.color.black(' ' + src.licenseUrl)
+    }
   }
 
   CLI.out(out)
@@ -144,14 +155,22 @@ puzzlesCmd.fn = (CLI, action, id) => {
       return startNextPuzzle(CLI, levels.indexOf(id))
     }
 
-    return CLI.error('Could not start puzzle ' + id)
+    const possibles = puzzles.filter((p) => p.id.includes(id))
+    if (possibles.length === 1) {
+      return startPuzzle(CLI, possibles[0])
+    }
+
+    return CLI.error('Could not find puzzle ' + id)
   }
 
   if (action) {
     const x = id || action
     if (validLevels.includes(x)) return listLevel(CLI, x)
-    if (puzzleIds.includes(x)) return showPuzzle(CLI, x)
-    if (id) return CLI.error('Could not find puzzle ' + id)
+    if ('list'.startsWith(x) || 'ls'.startsWith(x)) {
+      return listPuzzles(CLI)
+    }
+
+    return showPuzzle(CLI, x)
   }
 
   listPuzzles(CLI)

package/src/cmds/suggest.js

@@ -1,4 +1,4 @@
-/* Copyright 2022 Chad Transtrum
+/* Copyright 2022-2023 Chad Transtrum
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 // CLI suggest command
 
 import { suggest } from '@slugbugblue/trax/analyst'
+import { timeString } from '@slugbugblue/trax/utils'
 
 export const suggestCmd = {
   name: 'suggest',
@@ -47,6 +48,8 @@ suggestCmd.fn = (CLI, debug) => {
       m.push(move.move + ' ' + move.score)
     }
 
-    CLI.out('[' + m.join(', ') + '] ' + suggestion.ms + 'ms')
+    CLI.out(
+      '[' + m.join(', ') + '] ' + CLI.color.black(timeString(suggestion.ms)),
+    )
   }
 }

package/src/puzzles.js

@@ -26,6 +26,9 @@ export const sources = {
   book1: {
     name: 'Martin M. S. Pedersen',
     url: 'https://gnutrax.com/book',
+    copyright: '2011',
+    license: 'CC BY 4.0',
+    licenseUrl: 'https://creativecommons.org/licenses/by/4.0/',
   },
 }
 
@@ -764,7 +767,7 @@ export const puzzles = [
     level: 3,
     player: 2,
     max: 16,
-    hints: ['A0+', 'C2\\'],
+    hint: 'A0+',
   },
   {
     id: 'hb4.trx',
@@ -811,7 +814,7 @@ export const puzzles = [
     hint: 'B1+',
   },
   {
-    id: 'book_01.trx',
+    id: 'book.01',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ @1+ B0/ C1+ D2/ C3/',
@@ -822,18 +825,18 @@ export const puzzles = [
     hint: '@2/',
   },
   {
-    id: 'book_02.trx',
+    id: 'book.02',
     src: 'book1',
     game: 'traxloop',
     notation: '@0+ B1+ C1/ B0/ B0/ B0/ B0/ D5/ E5/ E6+ C4/ C3+ B6+',
-    icon: '0df:0ca:0df:cd:eecdc:0efae',
+    icon: '0df:0ca:0de:0cd:eecdc:0efae',
     level: 2,
     player: 2,
     max: 18,
     hints: ['D2\\', 'D3/'],
   },
   {
-    id: 'book_03.trx',
+    id: 'book.03',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ @1/ @1+ @1/ @1+ C0/ D1/ E1+ D0+ E1+ F1\\ E0+',
@@ -844,18 +847,18 @@ export const puzzles = [
     hint: 'C1\\',
   },
   {
-    id: 'book_04.trx',
+    id: 'book.04',
     src: 'book1',
     game: 'traxloop',
-    notation: '@0+ B1/ @1/ A0/ C3/ A4+ @4+ @3/ a5\\',
+    notation: '@0+ B1/ @1/ A0/ C3/ A4+ @4+ @3/ A5\\',
     icon: '1caf:1dec:dcafd:aeec:fd',
     level: 3,
     player: 2,
     max: 16,
-    hint: 'C0/',
+    hints: ['C0/', 'D0\\'],
   },
   {
-    id: 'book_05.trx',
+    id: 'book.05',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ @1/ B0+ @2+ A0/ @2+',
@@ -866,7 +869,7 @@ export const puzzles = [
     hints: ['B4\\', 'C4/'],
   },
   {
-    id: 'book_07.trx',
+    id: 'book.07',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ A2+ A0+ @2\\ B0+ C1+ B0/ B0/ A2+',
@@ -877,7 +880,7 @@ export const puzzles = [
     hint: 'C6+',
   },
   {
-    id: 'book_08.trx',
+    id: 'book.08',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ @1/ A2/ A0/ B1/ @1+ @1/ A0/ @1/',
@@ -888,7 +891,7 @@ export const puzzles = [
     hint: 'A0\\',
   },
   {
-    id: 'book_09.trx',
+    id: 'book.09',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ @1/ B0/ B0/ A0/ A5/ @3\\ @4/',
@@ -899,7 +902,7 @@ export const puzzles = [
     hint: 'A2\\',
   },
   {
-    id: 'book_10.trx',
+    id: 'book.10',
     src: 'book1',
     game: 'traxloop',
     notation: '@0/ A0+ A0/ A4+ A0/ A0/ B4+ C4/ @4+ @4/ @4/',
@@ -907,10 +910,10 @@ export const puzzles = [
     level: 2,
     player: 2,
     max: 18,
-    hint: 'E6+',
+    hints: ['D7\\', 'E6+'],
   },
   {
-    id: 'book_11.trx',
+    id: 'book.11',
     src: 'book1',
     game: 'traxloop',
     notation: '@0+ B1+ C1/ C0/ B0/ @3+',
@@ -921,7 +924,7 @@ export const puzzles = [
     hint: 'B1\\',
   },
   {
-    id: 'book_12.trx',
+    id: 'book.12',
     src: 'book1',
     game: 'traxloop',
     notation: '@0+ B1+ C1/ C0/ B0/ D2+',
@@ -929,8 +932,274 @@ export const puzzles = [
     level: 3,
     player: 1,
     max: 15,
+    hints: ['B4\\', 'C4/'],
+  },
+  {
+    id: 'book.13',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ B2+ A0\\ @1+ @1\\ C4/ B4/',
+    icon: 'aefa:1cd:1fb:0dc',
+    level: 3,
+    player: 1,
+    max: 15,
+    hint: 'C5\\',
+  },
+  {
+    id: 'book.15',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ A0/ @1+ A0\\ C1+ D1+ B0+ A0/ @5+ A2/ A0+ @1\\ A4+ @4+',
+    icon: 'caef:dfdca:cacdef:eefafbb:0faec:0aefd',
+    level: 3,
+    player: 1,
+    max: 21,
+    hints: ['B7\\', 'C7/'],
+  },
+  {
+    id: 'book.17',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ B0+ C1/ @1\\ B0/  C0/ D0+ A2+ @2+',
+    icon: '2de:eecaf:0fdec:0acd',
+    level: 3,
+    player: 1,
+    max: 19,
+    hints: ['A1/', 'B1\\'],
+  },
+  {
+    id: 'book.18',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0+ B1+ C1/ B2\\ B3\\ B4\\ B5\\',
+    icon: 'eec:0fd:0ac:0fd:0ac',
+    level: 2,
+    player: 2,
+    max: 14,
+    hint: 'D3+',
+  },
+  {
+    id: 'book.19',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0+ B1+ @1/ @1/ B2\\',
+    icon: 'cdee:fa',
+    level: 2,
+    player: 2,
+    max: 12,
+    hint: 'E1\\',
+  },
+  {
+    id: 'book.20',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ B0+ B0/ C3+ D3+ E3\\',
+    icon: '0c:de:cdeef',
+    level: 2,
+    player: 2,
+    max: 14,
+    hints: ['C4+', 'B4\\'],
+  },
+  {
+    id: 'book.23',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0+ @1\\  @1\\ @1\\ @1+ A0+ @1/ B3\\ E3/',
+    icon: 'cb:fbafae:0a1d',
+    level: 2,
+    player: 2,
+    max: 12,
+    hint: 'F1+',
+  },
+  {
+    id: 'book.25',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ B0/ B0+ C1/ C0+ B0/ A2+ @1/ @3\\',
+    icon: '0cdca:0fbde:facbd:afdc:facd',
+    level: 3,
+    player: 1,
+    max: 17,
+    hint: 'B0+',
+  },
+  {
+    id: 'book.26',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ @1/ @1+ A0\\ B0+ @3/ @3/',
+    icon: '1cbaf:cdfafa:dcbdcd',
+    level: 4,
+    player: 1,
+    max: 21,
     hint: 'B4\\',
   },
+  {
+    id: 'book.28',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ B0/ C1/ C0/ @2+ A0+ D0+ @2\\ @3+ A4/ @4\\ A2/',
+    icon: '3cde:dcaefaf:aefdcdc:fdcbdcd:0afacdc',
+    level: 2,
+    player: 2,
+    max: 20,
+    hint: 'G6+',
+  },
+  {
+    id: 'book.29',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ B1+ B2\\ B3/',
+    icon: 'de:af:0c',
+    level: 3,
+    player: 1,
+    max: 13,
+    hint: '@2/',
+  },
+  {
+    id: 'book.30',
+    src: 'book1',
+    game: 'traxloop',
+    notation:
+      '@0/ @1/ @1/ D1+ A2+ E1+ E2+ E0+ F1\\ G1+ G2\\ F3+ E4\\ G3+ H2\\ C5\\ D5+ D6\\ D7\\',
+    icon: '3efba:dcdeecaf:bdcdeeec:0afafd:0faec:2fd:2ac',
+    level: 4,
+    player: 2,
+    max: 30,
+    hints: ['H4/', 'G4\\'],
+  },
+  {
+    id: 'book.31',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ C1/ A2+ B3+ A3/ D3\\ B4\\ D4+ C5+ E2\\ E3+',
+    icon: 'cdcaf:ecdfa:decae:afde:1bd',
+    level: 3,
+    player: 1,
+    max: 23,
+    hints: ['E0/', '@4/'],
+  },
+  {
+    id: 'book.32',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1+ C1/ B2+ A2/ B3+ D2/ E2\\ D3+ F2+ G2\\ G3\\ C4\\ C5+ A4+',
+    icon: 'bdc:cbdcaef:fbaeefa:bafd:afb',
+    level: 3,
+    player: 2,
+    max: 24,
+    hint: 'G4+',
+  },
+  {
+    id: 'book.35',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0+ B1+ A0+  @2+ @2+ @2+ A1+ @1/ E3/',
+    icon: 'de1e:aeeeee:2fd',
+    level: 4,
+    player: 2,
+    max: 20,
+    hint: 'E4\\',
+  },
+  {
+    id: 'book.38',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ B1/ C1/ D1/  A2+ E1+  D3\\ E3+ F3+ F4\\ G4\\ F5\\ G5\\',
+    icon: 'dcdcb:bdcdca:0afaeef:4fa:4af',
+    level: 3,
+    player: 2,
+    max: 22,
+    hint: 'B4+',
+  },
+  {
+    id: 'book.40',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ A2+ @2/ @2/ B1+ B3\\',
+    icon: 'decd:cdec:fa',
+    level: 3,
+    player: 2,
+    max: 14,
+    hint: 'E2+',
+  },
+  {
+    id: 'book.42',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ B1+  @1+ A2/ A3+ B0+ D2+ E2\\ D1/',
+    icon: 'deeca:bdeef:c:d',
+    level: 2,
+    player: 2,
+    max: 16,
+    hint: 'F1/',
+  },
+  {
+    id: 'book.43',
+    src: 'book1',
+    game: 'traxloop',
+    notation:
+      '@0/ A0/ A0/ A0+ @1\\ C1+ D1/ E1+ F1/ D0+ B1+ A0/ @1+ @1/ D0+ D0\\',
+    icon: '2f:2ba:decaf:afdecb:1aeecbd:1fd:1ac:1fd',
+    level: 3,
+    player: 1,
+    max: 27,
+    hints: ['E6\\', 'F6/'],
+  },
+  {
+    id: 'book.44',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ C1/ D1+ B2/ D3\\ E1\\ D0/ F2+ E4+ F3\\ F4\\',
+    icon: '2dfa:cdcbae:0cdcdf:0fafba',
+    level: 3,
+    player: 1,
+    max: 19,
+    hint: 'D5+',
+  },
+  {
+    id: 'book.45',
+    src: 'book1',
+    game: 'traxloop',
+    notation: 'A0+ B1+ C1/ C0/ B0/ D2\\ A4\\ A5\\ C4+ @3+',
+    icon: '1d:1cdf:eeec:0fde:0acd',
+    level: 3,
+    player: 1,
+    max: 17,
+    hint: 'E1/',
+  },
+  {
+    id: 'book.47',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ A0/ @2+ B0+ B0+ @3\\ @3\\ @3\\ A2/',
+    icon: '3b:c1cb:fafdc:2bd',
+    level: 2,
+    player: 2,
+    max: 14,
+    hint: 'A1\\',
+  },
+  {
+    id: 'book.49',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ @1/ @1/ D0+ @2+ @2/ @2/ @2/ F3\\ G3\\',
+    icon: '2cdcde:dcdecdcd:3faf',
+    level: 3,
+    player: 2,
+    max: 16,
+    hints: ['A1+', 'A3+'],
+  },
+  {
+    id: 'book.50',
+    src: 'book1',
+    game: 'traxloop',
+    notation: '@0/ @1/ @1/ @1+ @1/ @1/ A0/ A3/ D3+',
+    icon: 'c:dcbdcd:cdcbdc',
+    level: 3,
+    player: 2,
+    max: 16,
+    hint: 'D1+',
+  },
 ]
 
 puzzles.sort(

package/src/threats.js

@@ -83,7 +83,7 @@ export class ThreatsDB {
   }
 
   compose(depth, pattern) {
-    pattern = pattern.replaceAll(/(?<=.)A/g, 'a').replaceAll(/W(?=.)/g, 'w')
+    pattern = pattern.replace(/(?<=.)A/g, 'a').replace(/W(?=.)/g, 'w')
     return this.add(depth, pattern)
   }
 

package/src/types.d.ts

@@ -71,7 +71,7 @@ type FaultyThreats = {
 
 /** An object with keys representing each level, with arrays for each threat of
  * that level. */
-type FoundThreats = Record<string, FoundThreat[]>
+type ColorThreats = Record<string, FoundThreat[]>
 
 /** All the threats found for both the white and black player. */
 type FoundThreatsCollection = { b: ColorThreats; w: ColorThreats }
@@ -116,8 +116,10 @@ type Puzzle = {
 
 type PuzzleSource = {
   name: string
-  copyright?: string
   url?: string
+  copyright?: string
+  license?: string
+  licenseUrl?: string
 }
 
 /** Array of objects representing the spaces surrounding the perimeter of a

package/src/utils.js

@@ -0,0 +1,22 @@
+/** Shared utilities
+ * @copyright 2023
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+/** Convert milliseconds to a human readable string in ms, sec, or min units.
+ * @arg {number} ms - the number of milliseconds
+ * @returns {string} a short human-readable representation of the time
+ */
+export const timeString = (ms) => {
+  if (ms < 1000) {
+    return (ms === Math.floor(ms) ? String(ms) : ms.toFixed(2)) + ' ms'
+  }
+
+  ms /= 1000
+  if (ms < 60) return ms.toFixed(3) + ' sec'
+
+  const min = Math.floor(ms / 60)
+  ms -= min * 60
+  return String(min) + ' min ' + ms.toFixed(3) + ' sec'
+}

package/src/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '0.19.0'
+export const version = '0.20.0'

package/benchmark/benchmarks.json

@@ -1,60 +0,0 @@
-{
-  "0.17.0": {
-    "puzzles.firstmove.tutorial": {
-      "count": 16,
-      "ms": 2007
-    },
-    "puzzles.firstmove.beginner": {
-      "count": 16,
-      "ms": 2664
-    },
-    "puzzles.firstmove.tough": {
-      "count": 1,
-      "ms": 76
-    },
-    "puzzles.firstmove.total": {
-      "count": 33,
-      "ms": 4838
-    }
-  },
-  "0.18.0": {
-    "puzzles.firstmove.tutorial": {
-      "count": 16,
-      "ms": 10164
-    },
-    "puzzles.firstmove.beginner": {
-      "count": 15,
-      "ms": 17864
-    },
-    "puzzles.firstmove.tough": {
-      "count": 26,
-      "ms": 30349
-    },
-    "puzzles.firstmove.advanced": {
-      "count": 1,
-      "ms": 427
-    },
-    "puzzles.firstmove.total": {
-      "count": 58,
-      "ms": 59031
-    }
-  },
-  "0.19.0": {
-    "puzzles.firstmove.tutorial": {
-      "count": 16,
-      "ms": 9753
-    },
-    "puzzles.firstmove.beginner": {
-      "count": 15,
-      "ms": 17376
-    },
-    "puzzles.firstmove.tough": {
-      "count": 25,
-      "ms": 26380
-    },
-    "puzzles.firstmove.total": {
-      "count": 56,
-      "ms": 55167
-    }
-  }
-}