chess-moments 1.1.2 → 1.2.0

package/README.md

@@ -47,6 +47,24 @@ The first level splits between variants and subvariants played in the chess game
 Returns a two level deep array of chess moments.
 It is useful for hiding future moves in chess training.
 
+## Extras
+
+### .addMomentToTree()
+
+Adds a new move to the chess tree
+
+### .getNextMoments()
+
+Move forward in the chess tree
+
+### .getPrevMoment()
+
+Move back in the chess tree
+
+### .momentsToPgn()
+
+Transform the chess tree into PGN
+
 ## JSON output
 
 The basic PGN file `1. e4 e5 *` will generated the following chess moments in JSON format:

package/functions/extras/add-moment-to-tree.js

@@ -1,6 +1,12 @@
 const { flatten, cloneDeep } = require('lodash');
 const { insertMomentIntoTree } = require('../helpers');
 
+/**
+ * Adds a new chess moment to the tree structure.
+ * @param {*} tree - The current tree structure.
+ * @param {*} newMoment - The new moment to add.
+ * @returns {*} - The updated tree structure.
+ */
 const addMomentToTree = (tree, newMoment) => {
   if (!newMoment || !newMoment.san || !newMoment.before) {
     return tree;
@@ -52,6 +58,15 @@ const addMomentToTree = (tree, newMoment) => {
     }
   }
 
+  // Remove all new flags from existing moments
+  for (const line of clonedTree) {
+    for (const moment of line) {
+      if (moment.new) {
+        delete moment.new;
+      }
+    }
+  }
+
   // Insert the moment into the tree
   const newTree = insertMomentIntoTree(clonedTree, point, newMoment);
 

package/functions/extras/find-inserted-moment.js

@@ -0,0 +1,17 @@
+/**
+ * Finds the most recently inserted moment in the tree.
+ * @param {*} tree - The current tree structure.
+ * @returns {Object|null} - The inserted moment or null if none found.
+ */
+const findInsertedMoment = (tree) => {
+  for (const line of tree) {
+    for (const moment of line) {
+      if (moment.new) {
+        return moment;
+      }
+    }
+  }
+  return null;
+};
+
+module.exports = findInsertedMoment;

package/functions/extras/index.js

@@ -1,4 +1,5 @@
 const addMomentToTree = require('./add-moment-to-tree');
+const findInsertedMoment = require('./find-inserted-moment');
 const getNextMoments = require('./get-next-moments');
 const getPrevMoment = require('./get-prev-moment');
 const momentsToPgn = require('./moments-to-pgn');
@@ -6,6 +7,7 @@ const moveTrainer = require('./move-trainer');
 
 module.exports = {
   addMomentToTree,
+  findInsertedMoment,
   getNextMoments,
   getPrevMoment,
   momentsToPgn,

package/functions/helpers/insert-moment-into-tree.js

@@ -12,6 +12,9 @@ const insertMomentIntoTree = (tree, point, newMoment) => {
   // Prepare the moment to be inserted with only the properties that match normal moments
   const momentToInsert = prepareMoment(tree, point, newMoment);
 
+  // Add flag to indicate this is a new moment
+  momentToInsert.new = true;
+
   // If no matching position found, always create a new line
   if (!point) {
     tree.push([momentToInsert]);

package/index.js

@@ -1,6 +1,7 @@
 const { fen, pgn, flat, tree, mainline } = require('./functions');
 const {
   addMomentToTree,
+  findInsertedMoment,
   getNextMoments,
   getPrevMoment,
   momentsToPgn,
@@ -14,6 +15,7 @@ module.exports = {
   tree,
   mainline,
   addMomentToTree,
+  findInsertedMoment,
   getNextMoments,
   getPrevMoment,
   momentsToPgn,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chess-moments",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "PGN parser that transforms PGN files into chess \"moments\"",
   "main": "index.js",
   "files": [