@slugbugblue/trax 0.20.0 → 0.22.0

package/src/cmds/select.js

@@ -1,47 +0,0 @@
-/* Copyright 2022 Chad Transtrum
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// CLI select command
-
-export const selectCmd = {
-  name: 'select',
-  alt: ['choose', '#'],
-  args: '#id [command]',
-  comp: '<id> <cmd>',
-  desc: 'select a different game',
-  rx: /^#\d+$/,
-  help: [
-    'Make another game the default game of future commands. If another',
-    'command is included, that command will be run immediately.',
-  ],
-}
-
-selectCmd.fn = (CLI, id, ...cmds) => {
-  if (!id) {
-    CLI.error('Missing id.')
-    return CLI.do('help', 'select')
-  }
-
-  if (id.startsWith('#')) id = id.slice(1)
-  CLI.load(id)
-  if (String(CLI.GAME?.id) === id) {
-    CLI.out(CLI.color(`Game #${id} selected.`))
-    if (cmds.length > 0) {
-      CLI.doNext(cmds.join(' '))
-    }
-  } else {
-    CLI.error('Invalid id. Type "list" to see available games.')
-  }
-}

package/src/cmds/suggest.js

@@ -1,55 +0,0 @@
-/* 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.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// CLI suggest command
-
-import { suggest } from '@slugbugblue/trax/analyst'
-import { timeString } from '@slugbugblue/trax/utils'
-
-export const suggestCmd = {
-  name: 'suggest',
-  alt: ['bot'],
-  desc: 'suggest a move',
-  help: ['Suggest a move in the current game.'],
-}
-
-suggestCmd.fn = (CLI, debug) => {
-  if (!String(CLI.GAME?.id)) {
-    return CLI.error('No active game. Type "new" to start a game.')
-  }
-
-  const game = CLI.TRAX
-  const suggestion = suggest(game)
-
-  if (!suggestion.best) return
-
-  CLI.out(
-    CLI.bubble(
-      game.turn === 1 ? 'w' : 'b',
-      String(game.move + 1) + '. ' + suggestion.pick.move,
-    ),
-  )
-
-  if ('debug'.startsWith(debug)) {
-    const m = []
-    for (const move of suggestion.options) {
-      m.push(move.move + ' ' + move.score)
-    }
-
-    CLI.out(
-      '[' + m.join(', ') + '] ' + CLI.color.black(timeString(suggestion.ms)),
-    )
-  }
-}

package/src/cmds/undo.js

@@ -1,40 +0,0 @@
-/* Copyright 2022 Chad Transtrum
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// CLI undo command
-
-export const undoCmd = {
-  name: 'undo',
-  args: '[n]',
-  comp: '<move>',
-  desc: 'undo the last move in a game',
-  help: [
-    'Backtrack one or more moves in a game. Type "undo" to take back the last',
-    'move, or "undo 2" to undo the last two moves.',
-  ],
-}
-
-undoCmd.fn = (CLI, n) => {
-  n = Math.max(1, Math.floor(Number(n) || 1)) // Get an integer 1 or higher
-
-  const { moves } = CLI.TRAX
-  const undo = moves.slice(0, 0 - n)
-  if (moves.length === undo.length) {
-    CLI.error('Unable to undo.')
-  } else {
-    CLI.setGame(undo)
-    CLI.do('view')
-  }
-}

package/src/cmds/view.js

@@ -1,61 +0,0 @@
-/* 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.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// CLI view command
-
-export const viewCmd = {
-  name: 'view',
-  alt: ['show', 'display'],
-  args: '[move number]',
-  comp: '<move>',
-  desc: 'show the game board',
-  help: [
-    'Show the current game. Include a move number to see the board as it was at',
-    'that move.',
-  ],
-}
-
-viewCmd.fn = (CLI, move) => {
-  if (!CLI.GAME?.id) {
-    return CLI.error('No active game. Type "new" to start a game.')
-  }
-
-  const trax = CLI.TRAX
-
-  let show = Number.POSITIVE_INFINITY
-  if (move && Number(move) >= 0 && Number(move) <= trax.moves.length) {
-    show = Number(move)
-  }
-
-  const game = CLI.GAME
-  const players = game.players || ['white', 'black']
-  const puzzle = game.puzzle || ''
-  const { note } = [...(game.notes || [{}])].pop()
-
-  CLI.out(
-    CLI.color('#' + CLI.ID + ' ') +
-      CLI.name(trax.rules) +
-      ' ' +
-      CLI.bubble('w' + (trax.turn === 1 ? 'h' : ''), players[0]) +
-      CLI.color(' vs ') +
-      CLI.bubble('b' + (trax.turn === 2 ? 'h' : ''), players[1]),
-  )
-  CLI.display(trax, players, undefined, show)
-  if (puzzle && (!note || !note.includes(puzzle))) {
-    CLI.out(CLI.color('Puzzle ' + puzzle))
-  }
-
-  if (note) CLI.out(CLI.color.help(note))
-}

package/src/lru.js

@@ -1,153 +0,0 @@
-/** Least Recently Used cache
- * @copyright 2023
- * @author Chad Transtrum <chad@transtrum.net>
- * @license Apache-2.0
- */
-
-/** LRU cache: a class for remembering things. It uses a Map internally and
- * exposes most of the same interface.
- */
-export class LRU {
-  /** @type Map */
-  #cache
-  #capacity = 0
-  #hits = 0
-  #misses = 0
-  #expired = 0
-
-  /** Instantiate this class with the max number of cached items
-   * @arg {number} capacity - the maximum number of items to cache
-   */
-  constructor(capacity = 1000) {
-    this.#cache = new Map()
-    if (typeof capacity === 'number' && capacity >= 1) {
-      this.#capacity = Math.floor(capacity)
-    } else {
-      throw new SyntaxError('capacity must be a positive integer')
-    }
-  }
-
-  /** The maximum capacity. */
-  get capacity() {
-    return this.#capacity
-  }
-
-  /** The current size. */
-  get size() {
-    return this.#cache.size
-  }
-
-  /** Number of times we have had a cache hit. */
-  get hits() {
-    return this.#hits
-  }
-
-  /** Number of times we have had a cache miss. */
-  get misses() {
-    return this.#misses
-  }
-
-  /** Number of times we have expired a cache entry. */
-  get expired() {
-    return this.#expired
-  }
-
-  /** Retrieve an item from the cache.
-   * @arg {any} key - the key of the cached item
-   * @returns {any} - the cached item or undefined
-   */
-  get(key) {
-    if (this.#cache.has(key)) {
-      // Update the least recently used order
-      const value = this.#cache.get(key)
-      this.#cache.delete(key)
-      this.#cache.set(key, value)
-      this.#hits++
-    } else {
-      this.#misses++
-    }
-
-    return this.#cache.get(key)
-  }
-
-  /** Retrieve an item from the cache without triggering any LRU handling.
-   * @arg {any} key - the key of the cached item to retrieve
-   * @returns {any} - the cached item or undefined
-   */
-  peek(key) {
-    return this.#cache.get(key)
-  }
-
-  /** Store an item in the cache.
-   * @arg {any} key - the key of the cached item
-   * @arg {any} value - the value to store
-   */
-  set(key, value) {
-    // To update an item, remove and re-add it to track LRU status
-    this.#cache.delete(key)
-
-    // If there are too many items, expire one before adding more
-    if (this.#cache.size >= this.#capacity) {
-      this.#expired++
-      const [expire] = this.#cache[Symbol.iterator]().next().value
-      this.#cache.delete(expire)
-    }
-
-    this.#cache.set(key, value)
-  }
-
-  /** Delete an item from the cache.
-   * @arg {any} key - the key of the cached item
-   * @returns {boolean} true if the item was in the cache
-   */
-  delete(key) {
-    return this.#cache.delete(key)
-  }
-
-  /** Clear the cache and all its statistics. */
-  clear() {
-    this.#cache.clear()
-    this.#hits = 0
-    this.#misses = 0
-    this.#expired = 0
-  }
-
-  /** Get an iterator to return [key, value] pairs from the cache. Does not
-   * update any LRU information. */
-  entries() {
-    return this.#cache.entries()
-  }
-
-  /** Determine if a key is already in the cache. Does not trigger hit/miss.
-   * @arg {any} key - the key to check
-   * @returns {boolean} true if the key is in the cache
-   */
-  has(key) {
-    return this.#cache.has(key)
-  }
-
-  /** Get an iterator for the keys stored in cache, in order from least to most
-   * recent. Does not update any LRU information. */
-  keys() {
-    return this.#cache.keys()
-  }
-
-  /** Get an iterator for the values stored in cache, in order from least to
-   * most recent. Does not update any LRU information. */
-  values() {
-    return this.#cache.values()
-  }
-
-  // Play nicely with the rest of the world
-  toString() {
-    return `LRU(${this.#cache.size} of ${this.#capacity})`
-  }
-
-  [Symbol.for('nodejs.util.inspect.custom')](_, options) {
-    const [y, s, n] = [options.stylize, 'special', 'number']
-    return `${y('LRU', s)}(${y(this.#cache.size, n)} of ${y(
-      this.#capacity,
-      n,
-    )})`
-  }
-}

package/src/point.js

@@ -1,173 +0,0 @@
-/* Copyright 2022 Chad Transtrum
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/** Because javascript doesn't have a "0 < 3 < 7" syntax.
- * @arg {number} end1 - A number on one end or the other
- * @arg {number} mid - The middle number
- * @arg {number} end2 - The other end
- * @returns {boolean} - If the number is in the middle
- */
-const between = (end1, mid, end2) => {
-  const low = Math.min(end1, end2)
-  const high = Math.max(end1, end2)
-  return low <= mid && mid <= high
-}
-
-/** Are you tired of doing x,y movements in multiple statements?
- *
- * I know I am.
- *
- * Point: an immutable two-dimensional location (x,y) with
- * functions for moving around quickly to neighboring points.
- */
-export class Point {
-  #x = 0
-  #y = 0
-
-  static dirs = ['up', 'down', 'left', 'right']
-
-  /** You can call this with new Point(point) or new Point({x, y}) or new Point(x, y)
-   * @arg {number | PointLike} x - the x value or a point
-   * @arg {number} [y] - the y value
-   */
-  constructor(x, y) {
-    if (
-      typeof x === 'object' &&
-      typeof x.x === 'number' &&
-      typeof x.y === 'number'
-    ) {
-      this.#x = x.x
-      this.#y = x.y
-    } else {
-      if (typeof x !== 'number' || Number.isNaN(x)) {
-        throw new SyntaxError('x must be a number or a point-like object')
-      }
-
-      if (typeof y !== 'number' || Number.isNaN(x)) {
-        throw new SyntaxError('y must be a number')
-      }
-
-      this.#x = x
-      this.#y = y
-    }
-  }
-
-  /** The horizontal value of the point. */
-  get x() {
-    return this.#x
-  }
-
-  /** Throws an error. Points are immutable. */
-  set x(_) {
-    throw new ReferenceError('Point is immutable')
-  }
-
-  /** The vertical value of the point. */
-  get y() {
-    return this.#y
-  }
-
-  /** Throws an error. Points are immutable. */
-  set y(_) {
-    throw new ReferenceError('Point is immutable')
-  }
-
-  /** The point immediately above this point. */
-  get up() {
-    return new Point(this.#x, this.#y - 1)
-  }
-
-  /** The point immediately below this point. */
-  get down() {
-    return new Point(this.#x, this.#y + 1)
-  }
-
-  /** The point to the immediate left of this point. */
-  get left() {
-    return new Point(this.#x - 1, this.#y)
-  }
-
-  /** The point to the immediate right of this point. */
-  get right() {
-    return new Point(this.#x + 1, this.#y)
-  }
-
-  /** A list of the four points that surround this point: up, down, left, and right. */
-  get around() {
-    return [this.up, this.down, this.left, this.right]
-  }
-
-  /** Move in a specific direction by passing in a direction string.
-   * @arg {string} direction - any string that begins with u, d, l, or r
-   * @returns {Point}
-   */
-  dir(direction) {
-    const error = 'direction must be one of: up, down, left, right, u, d, l, r'
-    if (typeof direction !== 'string') throw new SyntaxError(error)
-    direction = direction.toLowerCase()
-    if (direction[0] === 'u') return this.up
-    if (direction[0] === 'd') return this.down
-    if (direction[0] === 'l') return this.left
-    if (direction[0] === 'r') return this.right
-    throw new SyntaxError(error)
-  }
-
-  /** @arg {PointLike} from - the point to measure x against. */
-  distX(from) {
-    return Math.abs(this.#x - from.x)
-  }
-
-  /** @arg {PointLike} from - the point to measure y against. */
-  distY(from) {
-    return Math.abs(this.#y - from.y)
-  }
-
-  /** @arg {PointLike} from - the point to measure against. */
-  distance(from) {
-    return Math.hypot(this.distX(from), this.distY(from))
-  }
-
-  /** @arg {PointLike} that - the point to test equality against. */
-  eq(that) {
-    return this.#x === that.x && this.#y === that.y
-  }
-
-  /** Bounding box corners can be passed in any order.
-   * @arg {PointLike} a - one corner of the bounding box
-   * @arg {PointLike} b - the opposite corner
-   * @returns {boolean} - true if the point is on or in the box
-   */
-  in(a, b) {
-    // Allow for the bounding points to be passed in any order
-    // as long as they are opposite corners:
-    return between(a.x, this.x, b.x) && between(a.y, this.y, b.y)
-  }
-
-  // Play nicely with the rest of the world
-
-  toString() {
-    return 'Point(' + this.#x + ',' + this.#y + ')'
-  }
-
-  /** @returns {PointLike} */
-  toJSON() {
-    return { x: this.#x, y: this.#y }
-  }
-
-  [Symbol.for('nodejs.util.inspect.custom')](_, options) {
-    const [y, s, n] = [options.stylize, 'special', 'number']
-    return `${y('Point', s)}(${y(this.#x, n)},${y(this.#y, n)})`
-  }
-}