cubing 0.21.3 → 0.22.0

package/docs/cubing/api/index.html

@@ -17,8 +17,9 @@
     </div>
 
     <section class="no-header">
-      Note: These documents are still in early draft stage. Each method and should have enough examples to demonstrate all possible arguments.
-        </section>
+      Note: These documents are still in early draft stage. Each method and should have enough examples to demonstrate
+      all possible arguments.
+    </section>
 
     <section id="alg">
       <h1><a href="#alg"><code>cubing/alg</code></a></h1>
@@ -58,7 +59,7 @@
 &nbsp;&nbsp;experimentalNumUnits(): number;<br>
 }</code>
 
-<p>Example:</p>
+      <p>Example:</p>
       <div class="code-demo">
         <div>
           <code class="sample">
@@ -72,16 +73,17 @@ antiSune.<b><u>expand()</u></b>.log();<br>
 antiSune.expand().<b><u>simplify()</u></b>.log();</span>
           </code>
         </div>
-          <code class="sample output">
+        <code class="sample output">
             <span>Alg{}&nbsp;&quot;[[R: U], R U R2']&quot;</span>
             <span>Alg{}&nbsp;&quot;R U R' R U R2' R U' R' R2 U' R'&quot;</span>
             <span>Alg{}&nbsp;&quot;R U2 R' U' R U' R'&quot;</span>
           </code>
       </div>
 
-<p>A <code>Move</code> is a <code>QuantumMove</code> (like <code>R</code> or <code>UL</code>) with an amount (any integer).</p>
+      <p>A <code>Move</code> is a <code>QuantumMove</code> (like <code>R</code> or <code>UL</code>) with an amount (any
+        integer).</p>
 
-<code class="sample">class Move {<br>
+      <code class="sample">class Move {<br>
 &nbsp;&nbsp;// Constructors<br>
 &nbsp;&nbsp;constructor(s: string);<br>
 &nbsp;&nbsp;constructor(quantumMove: string, amount: number);<br>
@@ -108,7 +110,7 @@ antiSune.expand().<b><u>simplify()</u></b>.log();</span>
 &nbsp;&nbsp;get amount(): number;<br>
 &nbsp;&nbsp;log(message?: string): Alg;<br>
 }</code>
-<code class="sample">class QuantumMove {<br>
+      <code class="sample">class QuantumMove {<br>
 &nbsp;&nbsp;// Constructors<br>
 &nbsp;&nbsp;constructor(family: string, innerLayer?: number | null, outerLayer?: number | null);<br>
 <br>
@@ -141,53 +143,10 @@ antiSune.expand().<b><u>simplify()</u></b>.log();</span>
       </p>
 
       <code class="sample">class TwistyPlayer {<br>
-&nbsp;&nbsp;// Constructor<br>
-&nbsp;&nbsp;constructor(initialConfig?: {<br>
-&nbsp;&nbsp;&nbsp;&nbsp;// Note that any of the config options can be accessed<br>
-&nbsp;&nbsp;&nbsp;&nbsp;// or updated as properties on a TwistyPlayer instance directly.<br>
-<br>
-&nbsp;&nbsp;&nbsp;&nbsp;alg?: Alg | string;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalSetupAlg?: Alg | string;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalSetupAnchor?: "start" | "end";<br>
-<br>
-&nbsp;&nbsp;&nbsp;&nbsp;puzzle?: PuzzleID;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;visualization?: "3D" | "2D" | "experimental-2D-LL" | "PG3D";<br>
-&nbsp;&nbsp;&nbsp;&nbsp;hintFacelets?: "floating" | "none";<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalStickering?: ExperimentalStickering;<br>
-<br>
-&nbsp;&nbsp;&nbsp;&nbsp;background?: BackgroundTheme;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;controlPanel?: "bottom-row" | "none";<br>
-<br>
-&nbsp;&nbsp;&nbsp;&nbsp;backView?: BackViewLayout;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalCameraLatitude?: Vector3;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalCameraLongitude?: Vector3;<br>
-&nbsp;&nbsp;&nbsp;&nbsp;experimentalCameraLatitudeLimits?: "auto" | "none";<br>
-<br>
-&nbsp;&nbsp;&nbsp;&nbsp;viewerLink?: "twizzle" | "none";<br>
-&nbsp;&nbsp;})<br>
-<br>
-&nbsp;&nbsp;// Structure<br>
-&nbsp;&nbsp;timeline: Timeline;<br>
-&nbsp;&nbsp;cursor: AlgCursor | null;<br>
-&nbsp;&nbsp;viewerElems: TwistyViewerElement[];<br>
-&nbsp;&nbsp;controlElems: TwistyControlElement[];<br>
-&nbsp;&nbsp;fullscreen(): void;<br>
-<br>
-&nbsp;&nbsp;// Twizzle<br>
-&nbsp;&nbsp;twizzleLink(): string;<br>
-&nbsp;&nbsp;visitTwizzleLink(): void;<br>
-<br>
-&nbsp;&nbsp;// 3D code<br>
-&nbsp;&nbsp;scene: Twisty3DScene | null;<br>
-&nbsp;&nbsp;twisty3D: Twisty3DPuzzle | null;<br>
-<br>
-&nbsp;&nbsp;// Experimental methods<br>
-&nbsp;&nbsp;experimentalSetStartStateOverride(state: Transformation | null): void;<br>
-&nbsp;&nbsp;experimentalSetCursorIndexer(cursorName: "simple" | "tree" | "simultaneous"): void;<br>
-&nbsp;&nbsp;experimentalAddMove(move: Move, coalesce?: boolean, coalesceDelayed?: boolean): void;<br>
+&nbsp;&nbsp;// TODO<br>
 }
 </code>
-</section>
+    </section>
 
     <section id="methods">
       <h1><a href="#methods">Examples</a></h1>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cubing",
-  "version": "0.21.3",
+  "version": "0.22.0",
   "description": "A collection of Javascript cubing libraries.",
   "author": "The js.cubing.net team",
   "type": "module",

package/src/cubing/alg/index.ts

@@ -4,6 +4,7 @@ export { TraversalDownUp, TraversalUp } from "./traversal";
 export { Example } from "./example";
 export { keyToMove } from "./keyboard";
 export * from "./units";
+export { MoveModifications } from "./units/leaves/Move";
 
 export { algCubingNetLink } from "./url";
 export type { AlgCubingNetOptions } from "./url";

package/src/cubing/alg/units/leaves/Move.ts

@@ -126,7 +126,7 @@ export class QuantumMove extends Comparable {
   }
 }
 
-interface MoveModifications {
+export interface MoveModifications {
   outerLayer?: number;
   innerLayer?: number;
   family?: string;

package/src/cubing/bluetooth/smart-timer/GanTimer.ts

@@ -1,4 +1,4 @@
-import type { MillisecondTimestamp } from "../../twisty/old/animation/cursor/CursorTypes";
+import type { MillisecondTimestamp } from "../../twisty/controllers/AnimationTypes";
 import type { BluetoothConfig } from "../smart-puzzle/bluetooth-puzzle";
 
 // TODO: Short IDs

package/src/cubing/puzzle-geometry/PGPuzzles.spec.ts

@@ -1,3 +1,7 @@
+/**
+ * @jest-environment jsdom
+ */
+
 import { getPuzzleGeometryByDesc } from ".";
 import { PGPuzzles } from "./PGPuzzles";
 import { transformationOrder, Transformation } from "../kpuzzle";

package/src/cubing/puzzle-geometry/PuzzleGeometry.ts

@@ -66,7 +66,11 @@ export interface StickerDatFace {
   name: string;
 }
 
-export type StickerDatAxis = [number[], string, number];
+export type StickerDatAxis = {
+  coordinates: number[];
+  quantumMove: Move;
+  order: number;
+};
 
 export interface StickerDat {
   stickers: StickerDatSticker[];
@@ -2851,12 +2855,16 @@ export class PuzzleGeometry {
       const order = this.movesetorders[i];
       for (const gn of this.geonormals) {
         if (msg[0] === gn[1] && msg[1] === gn[2]) {
-          grips.push([toCoords(gn[0].rotatepoint(rot), 1), msg[0], order]);
-          grips.push([
-            toCoords(gn[0].rotatepoint(rot).smul(-1), 1),
-            msg[2],
+          grips.push({
+            coordinates: toCoords(gn[0].rotatepoint(rot), 1),
+            quantumMove: new Move(msg[0]),
+            order,
+          });
+          grips.push({
+            coordinates: toCoords(gn[0].rotatepoint(rot).smul(-1), 1),
+            quantumMove: new Move(msg[2]),
             order,
-          ]);
+          });
         }
       }
     }

package/src/cubing/puzzles/index.ts

@@ -3,7 +3,7 @@ export { experimentalCube3x3x3KPuzzle as experimentalCube3x3x3KPuzzle } from "..
 
 export { cubeAppearance as experimentalCubeAppearance } from "./stickerings/cube-stickerings";
 
-import type { PuzzleID } from "../twisty/old/dom/TwistyPlayerConfig";
+import type { PuzzleID } from "../twisty";
 import { cubePGPuzzleLoader, genericPGPuzzleLoader } from "./async/async-pg3d";
 import { cube2x2x2 } from "./implementations/2x2x2";
 import { cube3x3x3 } from "./implementations/3x3x3";