cube-state-engine 1.4.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cube-state-engine",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "An efficient representation in memory for tracking the Rubik's cube state on each movement.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -21,7 +21,7 @@
   "homepage": "https://github.com/bryanlundberg/cube-state-engine#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bryanlundberg/cube-state-engine"
+    "url": "git+https://github.com/bryanlundberg/cube-state-engine.git"
   },
   "devDependencies": {
     "@babel/core": "7.26.0",

package/.idea/workspace.xml

@@ -1,304 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="SELECTIVE" />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="c7204f89-75f2-42e0-aed9-81b858994b5a" name="Changes" comment="refactor: CubeEngine initialization logic and comments.&#10;&#10;Removed redundant comments and streamlined the CubeEngine class code. This improves readability while keeping the logic intact, ensuring clarity and maintainability.">
-      <change beforePath="$PROJECT_DIR$/index.html" beforeDir="false" afterPath="$PROJECT_DIR$/index.html" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/main.js" beforeDir="false" afterPath="$PROJECT_DIR$/main.js" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_BRANCH_BY_REPOSITORY">
-      <map>
-        <entry key="$PROJECT_DIR$" value="main" />
-      </map>
-    </option>
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="GitHubPullRequestSearchHistory">{
-  &quot;lastFilter&quot;: {
-    &quot;state&quot;: &quot;OPEN&quot;,
-    &quot;assignee&quot;: &quot;bryanlundberg01&quot;
-  }
-}</component>
-  <component name="GithubPullRequestsUISettings">{
-  &quot;selectedUrlAndAccountId&quot;: {
-    &quot;url&quot;: &quot;https://github.com/bryanlundberg/cube-state-engine.git&quot;,
-    &quot;accountId&quot;: &quot;85b47674-9e23-4732-99d6-79570b26716d&quot;
-  }
-}</component>
-  <component name="ProjectColorInfo">{
-  &quot;associatedIndex&quot;: 3
-}</component>
-  <component name="ProjectId" id="2sl2I2ViYNbfTkFbsmtRZjsyMhx" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "JavaScript Debug.index.html.executor": "Run",
-    "Jest.2x2 Cube Tests.executor": "Run",
-    "Jest.Dw equals y' U.executor": "Run",
-    "Jest.Dw' equals y U'.executor": "Run",
-    "Jest.Dw2 equals Dw Dw.executor": "Run",
-    "Jest.M equals Lw L'.executor": "Run",
-    "Jest.M' equals Lw' L.executor": "Run",
-    "Jest.ROTATE M then M' returns to solved.executor": "Run",
-    "Jest.ROTATE Rw then Rw' returns to solved.executor": "Run",
-    "Jest.ROTATE z'.executor": "Run",
-    "Jest.ROTATE z.executor": "Run",
-    "Jest.Rw equals x L.executor": "Run",
-    "Jest.Rw' equals x' L'.executor": "Run",
-    "Jest.applyMoves supports B and records when requested.executor": "Run",
-    "Jest.applyMoves supports M and M' and records when requested.executor": "Run",
-    "Jest.applyMoves supports Rw and Rw' and records when requested.executor": "Run",
-    "Jest.applyMoves with record: false does not record history.executor": "Run",
-    "Jest.constructor scramble supports M and does not record history.executor": "Run",
-    "Jest.cube-engine-2x2.test.js.executor": "Run",
-    "Jest.cube-engine.test.js.executor": "Run",
-    "Jest.initialize with scramble R U' F R2 D.executor": "Run",
-    "Jest.initialize with scramble by string: R U' F R2 D.executor": "Run",
-    "Jest.spawn a cube.executor": "Run",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "RunOnceActivity.git.unshallow": "true",
-    "git-widget-placeholder": "virtual-egine-2x2",
-    "ignore.virus.scanning.warn.message": "true",
-    "junie.onboarding.icon.badge.shown": "true",
-    "last_opened_file_path": "C:/Users/bryan/OneDrive/Documentos/workspace/NexusTimer",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs.jest.jest_package": "C:/Users/bryan/OneDrive/Documentos/workspace/cube-state-engine/node_modules/jest",
-    "nodejs_package_manager_path": "npm",
-    "npm.build.executor": "Run",
-    "npm.test.executor": "Run",
-    "settings.editor.selected.configurable": "preferences.pluginManager",
-    "to.speed.mode.migration.done": "true",
-    "ts.external.directory.path": "C:\\Users\\bryan\\OneDrive\\Documentos\\workspace\\cube-state-engine\\node_modules\\typescript\\lib",
-    "vue.rearranger.settings.migration": "true"
-  }
-}]]></component>
-  <component name="RunManager" selected="Jest.cube-engine-2x2.test.js">
-    <configuration name="applyMoves supports B and records when requested" type="JavaScriptTestRunnerJest" temporary="true" nameIsGenerated="true">
-      <node-interpreter value="project" />
-      <jest-package value="$PROJECT_DIR$/node_modules/jest" />
-      <working-dir value="$PROJECT_DIR$" />
-      <envs />
-      <scope-kind value="TEST" />
-      <test-file value="$PROJECT_DIR$/test/cube-engine.test.js" />
-      <test-names>
-        <test-name value="applyMoves supports B and records when requested" />
-      </test-names>
-      <method v="2" />
-    </configuration>
-    <configuration name="cube-engine-2x2.test.js" type="JavaScriptTestRunnerJest" temporary="true" nameIsGenerated="true">
-      <node-interpreter value="project" />
-      <jest-package value="$PROJECT_DIR$/node_modules/jest" />
-      <working-dir value="$PROJECT_DIR$" />
-      <envs />
-      <scope-kind value="TEST_FILE" />
-      <test-file value="$PROJECT_DIR$/test/cube-engine-2x2.test.js" />
-      <method v="2" />
-    </configuration>
-    <configuration name="cube-engine.test.js" type="JavaScriptTestRunnerJest" temporary="true" nameIsGenerated="true">
-      <node-interpreter value="project" />
-      <jest-package value="$PROJECT_DIR$/node_modules/jest" />
-      <working-dir value="$PROJECT_DIR$" />
-      <envs />
-      <scope-kind value="TEST_FILE" />
-      <test-file value="$PROJECT_DIR$/test/cube-engine.test.js" />
-      <method v="2" />
-    </configuration>
-    <configuration name="spawn a cube" type="JavaScriptTestRunnerJest" temporary="true" nameIsGenerated="true">
-      <node-interpreter value="project" />
-      <jest-package value="$PROJECT_DIR$/node_modules/jest" />
-      <working-dir value="$PROJECT_DIR$" />
-      <envs />
-      <scope-kind value="TEST" />
-      <test-file value="$PROJECT_DIR$/test/cube-engine.test.js" />
-      <test-names>
-        <test-name value="spawn a cube" />
-      </test-names>
-      <method v="2" />
-    </configuration>
-    <configuration name="index.html" type="JavascriptDebugType" temporary="true" nameIsGenerated="true" uri="http://localhost:63342/cube-state-engine/index.html" useBuiltInWebServerPort="true">
-      <method v="2" />
-    </configuration>
-    <recent_temporary>
-      <list>
-        <item itemvalue="Jest.cube-engine-2x2.test.js" />
-        <item itemvalue="Jest.cube-engine.test.js" />
-        <item itemvalue="Jest.applyMoves supports B and records when requested" />
-        <item itemvalue="JavaScript Debug.index.html" />
-        <item itemvalue="Jest.spawn a cube" />
-      </list>
-    </recent_temporary>
-  </component>
-  <component name="SharedIndexes">
-    <attachedChunks>
-      <set>
-        <option value="bundled-js-predefined-d6986cc7102b-1632447f56bf-JavaScript-WS-243.26574.96" />
-      </set>
-    </attachedChunks>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="c7204f89-75f2-42e0-aed9-81b858994b5a" name="Changes" comment="" />
-      <created>1739015757661</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1739015757661</updated>
-      <workItem from="1739015758729" duration="179000" />
-      <workItem from="1741396985188" duration="669000" />
-      <workItem from="1741434773408" duration="14000" />
-      <workItem from="1757809578390" duration="6244000" />
-      <workItem from="1757816608819" duration="487000" />
-      <workItem from="1757817801762" duration="372000" />
-      <workItem from="1759836800222" duration="2277000" />
-      <workItem from="1759843281721" duration="2894000" />
-    </task>
-    <task id="LOCAL-00001" summary="feat: Add scramble initialization and move application support&#10;&#10;Introduce a constructor option to initialize the CubeEngine with a scramble string, resetting the move history. Implement `applyMoves` to apply sequences of moves with an option to skip move history recording. Accompany changes with relevant tests.">
-      <option name="closed" value="true" />
-      <created>1757813016634</created>
-      <option name="number" value="00001" />
-      <option name="presentableId" value="LOCAL-00001" />
-      <option name="project" value="LOCAL" />
-      <updated>1757813016634</updated>
-    </task>
-    <task id="LOCAL-00002" summary="feat: Add support for wide D (Dw) moves in CubeEngine  &#10;&#10;Introduced `rotateDw` and `#rotateDw` methods to handle wide D layer rotations. Updated `applyMoves` to process &quot;Dw&quot; and added corresponding tests to ensure correctness, including scramble handling and move recording behavior.">
-      <option name="closed" value="true" />
-      <created>1757814527881</created>
-      <option name="number" value="00002" />
-      <option name="presentableId" value="LOCAL-00002" />
-      <option name="project" value="LOCAL" />
-      <updated>1757814527881</updated>
-    </task>
-    <task id="LOCAL-00003" summary="Add support for wide U (Uw) layer rotations&#10;&#10;Implemented new methods to handle wide U layer rotations, `rotateUw` and `#rotateUw`, along with logic to differentiate between regular and wide U moves. Updated command parsing to recognize and process wide U moves appropriately.">
-      <option name="closed" value="true" />
-      <created>1757814670104</created>
-      <option name="number" value="00003" />
-      <option name="presentableId" value="LOCAL-00003" />
-      <option name="project" value="LOCAL" />
-      <updated>1757814670104</updated>
-    </task>
-    <task id="LOCAL-00004" summary="Add support for Rw wide moves and related tests&#10;&#10;Implemented functionality to handle Rw and Rw' (wide right-layer) rotations, including integration with move sequencing and history recording. Updated tests to validate correct behavior for new moves, ensure consistency with equivalent rotations, and verify state preservation.">
-      <option name="closed" value="true" />
-      <created>1757814961897</created>
-      <option name="number" value="00004" />
-      <option name="presentableId" value="LOCAL-00004" />
-      <option name="project" value="LOCAL" />
-      <updated>1757814961897</updated>
-    </task>
-    <task id="LOCAL-00005" summary="Add support for 'Lw' wide move rotation&#10;&#10;Implemented functionality for rotating the wide 'Lw' (LEFT two layers) move, both clockwise and counterclockwise. Updated the `applyMoves` method to recognize and execute 'Lw' commands along with proper history tracking.">
-      <option name="closed" value="true" />
-      <created>1757815147915</created>
-      <option name="number" value="00005" />
-      <option name="presentableId" value="LOCAL-00005" />
-      <option name="project" value="LOCAL" />
-      <updated>1757815147915</updated>
-    </task>
-    <task id="LOCAL-00006" summary="Add support for M slice moves and corresponding tests&#10;&#10;Introduce functionality to handle M and M' slice moves, including their recording in move history. Update documentation and logic in `applyMoves` to recognize M moves and handle scrambling. Add corresponding unit tests to ensure correctness and behavior consistency.">
-      <option name="closed" value="true" />
-      <created>1757815394671</created>
-      <option name="number" value="00006" />
-      <option name="presentableId" value="LOCAL-00006" />
-      <option name="project" value="LOCAL" />
-      <updated>1757815394671</updated>
-    </task>
-    <task id="LOCAL-00007" summary="Add rotateZ functionality and tests for the Z-axis rotation&#10;&#10;Introduce the `rotateZ` method to handle clockwise and counterclockwise rotations along the Z-axis. Updated the README for documentation, extended move handling, and added comprehensive unit tests to verify the functionality.">
-      <option name="closed" value="true" />
-      <created>1757815728756</created>
-      <option name="number" value="00007" />
-      <option name="presentableId" value="LOCAL-00007" />
-      <option name="project" value="LOCAL" />
-      <updated>1757815728756</updated>
-    </task>
-    <task id="LOCAL-00008" summary="Update README with new CubeEngine methods and examples&#10;&#10;Added details for new methods like `applyMoves`, wide layer rotations, and the constructor with optional scramble. Improved usage examples, including initializing with a scramble and retrieving movement history.">
-      <option name="closed" value="true" />
-      <created>1757815931435</created>
-      <option name="number" value="00008" />
-      <option name="presentableId" value="LOCAL-00008" />
-      <option name="project" value="LOCAL" />
-      <updated>1757815931435</updated>
-    </task>
-    <task id="LOCAL-00009" summary="feat: Add reset method to CubeEngine with corresponding test&#10;&#10;Implemented a reset method to revert the cube to its solved state and clear the move history. Added a unit test to ensure the method functions correctly by resetting both the cube's state and move history.">
-      <option name="closed" value="true" />
-      <created>1757816840133</created>
-      <option name="number" value="00009" />
-      <option name="presentableId" value="LOCAL-00009" />
-      <option name="project" value="LOCAL" />
-      <updated>1757816840133</updated>
-    </task>
-    <task id="LOCAL-00010" summary="feat: Add `reset` method and improve `CubeEngine` documentation&#10;&#10;The `reset` method allows resetting the cube to its solved state and clears the move history. Updated the `CubeEngine` constructor to accept an optional initial scramble, and revised the documentation for better clarity and completeness.">
-      <option name="closed" value="true" />
-      <created>1757817044103</created>
-      <option name="number" value="00010" />
-      <option name="presentableId" value="LOCAL-00010" />
-      <option name="project" value="LOCAL" />
-      <updated>1757817044103</updated>
-    </task>
-    <task id="LOCAL-00011" summary="feat: Add support for rotating the Back (B) layer of the cube&#10;&#10;Implemented `rotateB` function to handle Back layer rotations clockwise and counterclockwise. Updated related documentation, input bindings, and `applyMoves` method to include support for the B move. Added tests to ensure functionality and alignment with expected behavior.">
-      <option name="closed" value="true" />
-      <created>1757818136642</created>
-      <option name="number" value="00011" />
-      <option name="presentableId" value="LOCAL-00011" />
-      <option name="project" value="LOCAL" />
-      <updated>1757818136642</updated>
-    </task>
-    <task id="LOCAL-00012" summary="test: Add unit tests for 2x2 CubeEngine functionality&#10;&#10;Introduce tests for basic 2x2 cube operations, including initialization, move validations (M, wide moves), and algorithm execution. These tests ensure the expected behavior and edge case handling of the 2x2 cube simulation.">
-      <option name="closed" value="true" />
-      <created>1759844862946</created>
-      <option name="number" value="00012" />
-      <option name="presentableId" value="LOCAL-00012" />
-      <option name="project" value="LOCAL" />
-      <updated>1759844862946</updated>
-    </task>
-    <task id="LOCAL-00013" summary="feat: Add support for 2x2 cube size and refactor state initialization&#10;&#10;Introduced support for 2x2 cubes by updating methods to adapt to cube size. Refactored state initialization with dynamic matrix generation to reduce repetitive code. Updated cube rotation logic and validation to handle variable sizes more efficiently.">
-      <option name="closed" value="true" />
-      <created>1759845076135</created>
-      <option name="number" value="00013" />
-      <option name="presentableId" value="LOCAL-00013" />
-      <option name="project" value="LOCAL" />
-      <updated>1759845076135</updated>
-    </task>
-    <task id="LOCAL-00014" summary="refactor: CubeEngine initialization logic and comments.&#10;&#10;Removed redundant comments and streamlined the CubeEngine class code. This improves readability while keeping the logic intact, ensuring clarity and maintainability.">
-      <option name="closed" value="true" />
-      <created>1759845463330</created>
-      <option name="number" value="00014" />
-      <option name="presentableId" value="LOCAL-00014" />
-      <option name="project" value="LOCAL" />
-      <updated>1759845463330</updated>
-    </task>
-    <option name="localTasksCounter" value="15" />
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-  <component name="VcsManagerConfiguration">
-    <MESSAGE value="feat: Add scramble initialization and move application support&#10;&#10;Introduce a constructor option to initialize the CubeEngine with a scramble string, resetting the move history. Implement `applyMoves` to apply sequences of moves with an option to skip move history recording. Accompany changes with relevant tests." />
-    <MESSAGE value="feat: Add support for wide D (Dw) moves in CubeEngine  &#10;&#10;Introduced `rotateDw` and `#rotateDw` methods to handle wide D layer rotations. Updated `applyMoves` to process &quot;Dw&quot; and added corresponding tests to ensure correctness, including scramble handling and move recording behavior." />
-    <MESSAGE value="Add support for wide U (Uw) layer rotations&#10;&#10;Implemented new methods to handle wide U layer rotations, `rotateUw` and `#rotateUw`, along with logic to differentiate between regular and wide U moves. Updated command parsing to recognize and process wide U moves appropriately." />
-    <MESSAGE value="Add support for Rw wide moves and related tests&#10;&#10;Implemented functionality to handle Rw and Rw' (wide right-layer) rotations, including integration with move sequencing and history recording. Updated tests to validate correct behavior for new moves, ensure consistency with equivalent rotations, and verify state preservation." />
-    <MESSAGE value="Add support for 'Lw' wide move rotation&#10;&#10;Implemented functionality for rotating the wide 'Lw' (LEFT two layers) move, both clockwise and counterclockwise. Updated the `applyMoves` method to recognize and execute 'Lw' commands along with proper history tracking." />
-    <MESSAGE value="Add support for M slice moves and corresponding tests&#10;&#10;Introduce functionality to handle M and M' slice moves, including their recording in move history. Update documentation and logic in `applyMoves` to recognize M moves and handle scrambling. Add corresponding unit tests to ensure correctness and behavior consistency." />
-    <MESSAGE value="Add rotateZ functionality and tests for the Z-axis rotation&#10;&#10;Introduce the `rotateZ` method to handle clockwise and counterclockwise rotations along the Z-axis. Updated the README for documentation, extended move handling, and added comprehensive unit tests to verify the functionality." />
-    <MESSAGE value="Update README with new CubeEngine methods and examples&#10;&#10;Added details for new methods like `applyMoves`, wide layer rotations, and the constructor with optional scramble. Improved usage examples, including initializing with a scramble and retrieving movement history." />
-    <MESSAGE value="feat: Add reset method to CubeEngine with corresponding test&#10;&#10;Implemented a reset method to revert the cube to its solved state and clear the move history. Added a unit test to ensure the method functions correctly by resetting both the cube's state and move history." />
-    <MESSAGE value="feat: Add `reset` method and improve `CubeEngine` documentation&#10;&#10;The `reset` method allows resetting the cube to its solved state and clears the move history. Updated the `CubeEngine` constructor to accept an optional initial scramble, and revised the documentation for better clarity and completeness." />
-    <MESSAGE value="feat: Add support for rotating the Back (B) layer of the cube&#10;&#10;Implemented `rotateB` function to handle Back layer rotations clockwise and counterclockwise. Updated related documentation, input bindings, and `applyMoves` method to include support for the B move. Added tests to ensure functionality and alignment with expected behavior." />
-    <MESSAGE value="test: Add unit tests for 2x2 CubeEngine functionality&#10;&#10;Introduce tests for basic 2x2 cube operations, including initialization, move validations (M, wide moves), and algorithm execution. These tests ensure the expected behavior and edge case handling of the 2x2 cube simulation." />
-    <MESSAGE value="feat: Add support for 2x2 cube size and refactor state initialization&#10;&#10;Introduced support for 2x2 cubes by updating methods to adapt to cube size. Refactored state initialization with dynamic matrix generation to reduce repetitive code. Updated cube rotation logic and validation to handle variable sizes more efficiently." />
-    <MESSAGE value="refactor: CubeEngine initialization logic and comments.&#10;&#10;Removed redundant comments and streamlined the CubeEngine class code. This improves readability while keeping the logic intact, ensuring clarity and maintainability." />
-    <option name="LAST_COMMIT_MESSAGE" value="refactor: CubeEngine initialization logic and comments.&#10;&#10;Removed redundant comments and streamlined the CubeEngine class code. This improves readability while keeping the logic intact, ensuring clarity and maintainability." />
-  </component>
-</project>