cubing 0.35.18 → 0.36.0

package/dist/esm/alg/index.js

@@ -18,7 +18,7 @@ import {
   functionFromTraversal,
   keyToMove,
   setAlgDebug
-} from "../chunk-HVZKPYTG.js";
+} from "../chunk-CFNRQVBC.js";
 export {
   Alg,
   AlgBuilder,

package/dist/esm/bluetooth/index.js

@@ -1,23 +1,23 @@
 import {
   binaryComponentsToReid3x3x3,
   twizzleBinaryToBinaryComponents
-} from "../chunk-FVWUXED6.js";
+} from "../chunk-RCFH7AT2.js";
 import {
   cube3x3x3,
   puzzles
-} from "../chunk-6FGST3DR.js";
+} from "../chunk-TF2GO5ZC.js";
 import {
   experimental3x3x3KPuzzle
-} from "../chunk-YU62MHVH.js";
+} from "../chunk-7C5DKKWG.js";
 import {
   KState
-} from "../chunk-LZTD2XRZ.js";
+} from "../chunk-UOAT7IN5.js";
 import {
   Alg,
   Move,
   experimentalAppendMove,
   keyToMove
-} from "../chunk-HVZKPYTG.js";
+} from "../chunk-CFNRQVBC.js";
 
 // src/cubing/bluetooth/debug.ts
 var DEBUG_LOGGING_ENABLED = false;
@@ -64,6 +64,7 @@ var m = {
   "-x z": new Quaternion(0, 0, s2, s2)
 };
 var BasicRotationTransformer = class {
+  // private reorientQuat = new Quaternion();
   transformAlgLeaf(_algLeafEvent) {
   }
   transformOrientation(orientationEvent) {
@@ -89,8 +90,11 @@ var BluetoothPuzzle = class extends EventTarget {
     super(...arguments);
     this.transformers = [];
     this.listeners = [];
+    // TODO: type
     this.orientationListeners = [];
   }
+  // TODO: Can we make this reutrn (async) on success?
+  // TODO: require subclasses to implement this?
   async getState() {
     throw new Error("cannot get state");
   }
@@ -130,6 +134,7 @@ var BluetoothPuzzle = class extends EventTarget {
 
 // src/cubing/bluetooth/keyboard.ts
 var KeyboardPuzzle = class extends BluetoothPuzzle {
+  // TODO: Decide on the right arguments.
   constructor(target) {
     super();
     this.target = target;
@@ -376,12 +381,16 @@ var PhysicalState = class {
     }
     return quat.clone().multiply(homeQuatInverse.clone());
   }
+  // Loops from 255 to 0.
   moveCounter() {
     return this.arr[12];
   }
   numMovesSince(previousMoveCounter) {
     return this.moveCounter() - previousMoveCounter & 255;
   }
+  // Due to the design of the Gan356i protocol, it's common to query for the
+  // latest physical state and find 0 moves have been performed since the last
+  // query. Therefore, it's useful to allow 0 as an argument.
   latestMoves(n) {
     if (n < 0 || n > MAX_LATEST_MOVES) {
       throw new Error(`Must ask for 0 to 6 latest moves. (Asked for ${n})`);
@@ -514,6 +523,7 @@ var GanCube = class extends BluetoothPuzzle {
     this.state = kpuzzle.startState();
     this.startTrackingMoves();
   }
+  // We have to perform async operations before we call the constructor.
   static async connect(server) {
     const ganCubeService = await server.getPrimaryService(UUIDs.ganCubeService);
     debugLog("Service:", ganCubeService);
@@ -553,6 +563,7 @@ var GanCube = class extends BluetoothPuzzle {
     clearInterval(this.intervalHandle);
     this.intervalHandle = null;
   }
+  // TODO: Can we ever receive async responses out of order?
   async intervalHandler() {
     const physicalState = await PhysicalState.read(
       this.physicalStateCharacteristic,
@@ -572,6 +583,7 @@ var GanCube = class extends BluetoothPuzzle {
         timeStamp: physicalState.timeStamp,
         debug: physicalState.debugInfo(),
         state: this.state
+        // quaternion: physicalState.rotQuat(),
       });
     }
     this.dispatchOrientation({
@@ -652,6 +664,11 @@ var GanCube = class extends BluetoothPuzzle {
     const actualAngleAndBatteryCharacteristic = await this.actualAngleAndBatteryCharacteristic();
     return (await actualAngleAndBatteryCharacteristic.readValue()).buffer;
   }
+  // TODO
+  // private onphysicalStateCharacteristicChanged(event: any): void {
+  //   var val = event.target.value;
+  //   debugLog(val);
+  // }
 };
 var ganConfig = {
   connect: GanCube.connect.bind(GanCube),
@@ -882,14 +899,21 @@ var GiiKERCube = class extends BluetoothPuzzle {
 var giiKERConfig = {
   connect: GiiKERCube.connect.bind(GiiKERCube),
   prefixes: ["Gi", ""],
+  // Hack
   filters: [
+    // Known prefixes: GiC, GiS (3x3x3), Gi2 (2x2x2)
+    // Suspected prefixes GiY, Gi3
     { namePrefix: "Gi" },
     { services: ["0000aadb-0000-1000-8000-00805f9b34fb"] },
     { services: ["0000aaaa-0000-1000-8000-00805f9b34fb"] },
     { services: ["0000fe95-0000-1000-8000-00805f9b34fb"] }
   ],
   optionalServices: [
+    // "00001530-1212-efde-1523-785feabcd123",
+    // "0000aaaa-0000-1000-8000-00805f9b34fb",
     UUIDs2.cubeService
+    // "0000180f-0000-1000-8000-00805f9b34fb",
+    // "0000180a-0000-1000-8000-00805f9b34fb"
   ]
 };
 
@@ -932,6 +956,14 @@ var GoCube = class extends BluetoothPuzzle {
     super();
     this.server = server;
     this.goCubeStateCharacteristic = goCubeStateCharacteristic;
+    // public async getState(): Promise<PuzzleState> {
+    //   return new Promise((resolve, reject) => {
+    //     this.resolve = (value: any) => {
+    //       resolve(buf2hex(value.buffer) as any);
+    //     };
+    //     this.goCubeStateCharacteristic.startNotifications();
+    //   });
+    // }
     this.recorded = [];
     this.homeQuatInverse = null;
     this.lastRawQuat = new Quaternion3(0, 0, 0, 1);
@@ -939,6 +971,7 @@ var GoCube = class extends BluetoothPuzzle {
     this.lastTarget = new Quaternion3(0, 0, 0, 1);
     this.alg = new Alg();
   }
+  // We have to perform async operations before we call the constructor.
   static async connect(server) {
     const service = await server.getPrimaryService(UUIDs3.goCubeService);
     debugLog({ service });
@@ -1044,6 +1077,7 @@ var HeykubeCube = class extends BluetoothPuzzle {
     this.stateCharacteristic.startNotifications();
     this.startTrackingMoves();
   }
+  // We have to perform async operations before we call the constructor.
   static async connect(server, device) {
     const service = await server.getPrimaryService(UUIDs4.heykubeService);
     debugLog("Service:", service);
@@ -1075,6 +1109,12 @@ var HeykubeCube = class extends BluetoothPuzzle {
       (e) => this.onStateCharacteristic(e)
     );
   }
+  // public stopTrackingMoves(): void {}
+  // public async getBattery(): Promise<number> {
+  //   return new Uint8Array(
+  //     await this.readActualAngleAndBatteryCharacteristic(),
+  //   )[7];
+  // }srcElement: BluetoothRemoteGATTCharacteristic
   onStateCharacteristic(event) {
     const state = this.decodeState(event.target.value);
     this.dispatchAlgLeaf({
@@ -1099,6 +1139,8 @@ var HeykubeCube = class extends BluetoothPuzzle {
       new Move("D'"),
       new Move("R"),
       new Move("R'")
+      // null,
+      // null,
     ];
     const b2 = new Uint8Array(dv.byteLength);
     for (let i = 0; i < dv.byteLength; i++) {
@@ -1115,6 +1157,7 @@ var HeykubeCube = class extends BluetoothPuzzle {
       poIdxL: 0,
       poIdxU: 7,
       moSupport: 1,
+      // TODO
       moMask: 0
     };
     return {
@@ -1140,6 +1183,7 @@ var smartPuzzleConfigs = [
   goCubeConfig,
   heykubeConfig,
   giiKERConfig
+  // GiiKER must be last, due to Xiaomi naming. TODO: enforce this using tests.
 ];
 async function connectSmartPuzzle(options) {
   return bluetoothConnect(smartPuzzleConfigs, options);
@@ -1230,6 +1274,7 @@ var GanRobot = class extends EventTarget {
     this.experimentalDebugOnSend = null;
     this.experimentalDebugLog = () => {
     };
+    // Because our Bluetooth connection code is set up not to know what kind of device is connecting, we put these options directly on the class.
     this.experimentalOptions = {
       xAngle: false,
       singleMoveFixHack: false,
@@ -1243,6 +1288,7 @@ var GanRobot = class extends EventTarget {
       this.onDisconnect.bind(this)
     );
   }
+  // We have to perform async operations before we call the constructor.
   static async connect(server, device) {
     const ganTimerService = await server.getPrimaryService(
       UUIDs5.ganRobotService
@@ -1321,6 +1367,7 @@ var GanRobot = class extends EventTarget {
   }
   processQueue() {
   }
+  // TODO: Don't let this resolve until the move is done?
   async queueMoves(moves) {
     this.moveQueue = this.moveQueue.concat(moves).experimentalSimplify({
       puzzleSpecificSimplifyOptions: cube3x3x3.puzzleSpecificSimplifyOptions
@@ -1419,6 +1466,7 @@ var GanTimer = class extends EventTarget {
       this.onDisconnect.bind(this)
     );
   }
+  // We have to perform async operations before we call the constructor.
   static async connect(server, device) {
     const ganTimerService = await server.getPrimaryService(
       UUIDs6.ganTimerService