cubing 0.41.0 → 0.42.0

package/dist/{types/KPattern-85fd8579.d.ts → cubing/KPattern-12e23b1f.d.ts}

@@ -18,7 +18,7 @@ interface KPatternOrbitData {
      *     - This indicates that the orientation of a piece is fully known, i.e.
      *        that its "orientation mod" is the default value (N). However, such a
      *        value is recorded as 0 instead of N, in order to make it simpler to
-     *        implement and debug state logic involving the default value.
+     *        implement and debug pattern logic involving the default value.
      * - If `.orientationMod[i]` is a proper divisor of N (i.e. not 0), then
      *   `.orientation[i]` must be less than `.orientationMod[i]`. That is, the
      *   orientation values must be individually "normalized" for each piece.
@@ -37,7 +37,7 @@ interface KPatternOrbitData {
      * imagine a 24-hour clock with 24 hour marks around the dial, but where the
      * hour hand is symmetric and points equally at the current hour as well as
      * its diametic opposite (like a compass needle but painted all in one color).
-     * This has the same set of "valid states" as a normal 12-hour clock. Such a
+     * This has the same set of "valid patterns" as a normal 12-hour clock. Such a
      * clock also has an "orientation mod" of 12, but where the multiples of the
      * modulus have been "unfolded" to show their full symmetry instead of being
      * implicit.
@@ -84,7 +84,7 @@ interface KPatternOrbitData {
      *
      * For those with a mathematical background, you may notice a relationship to
      * the concept of a coset (https://en.wikipedia.org/wiki/Coset). For example,
-     * consider the group of states of a `KPuzzle` (without indistinguishable
+     * consider the group of patterns of a `KPuzzle` (without indistinguishable
      * pieces) generated by a set of transformations. We can assign each set of
      * piece orbits an orientation mod value (which must be identical for all
      * constituent pieces of the same orbit). Each such choice generates a set of
@@ -145,7 +145,7 @@ interface KPuzzleDefinition {
     defaultPattern: KPatternData;
     moves: Record<string, KTransformationData>;
     derivedMoves?: Record<string, string>;
-    experimentalIsStateSolved?: (kpattern: KPattern, options: {
+    experimentalIsPatternSolved?: (kpattern: KPattern, options: {
         ignorePuzzleOrientation: boolean;
         ignoreCenterOrientation: boolean;
     }) => boolean;
@@ -522,14 +522,14 @@ declare class KPuzzle {
     algToTransformation(alg: Alg | string): KTransformation;
     /** @deprecated */
     toTransformation(source: KTransformationSource): KTransformation;
-    startState(): KPattern;
-    canConvertStateToUniqueTransformation(): boolean;
+    defaultPattern(): KPattern;
+    canConvertDefaultPatternToUniqueTransformation(): boolean;
 }
 
 declare class KPattern {
     readonly kpuzzle: KPuzzle;
-    readonly stateData: KPatternData;
-    constructor(kpuzzle: KPuzzle, stateData: KPatternData);
+    readonly patternData: KPatternData;
+    constructor(kpuzzle: KPuzzle, patternData: KPatternData);
     toJSON(): any;
     static fromTransformation(transformation: KTransformation): KPattern;
     /** @deprecated */

package/dist/{types/TwizzleLink-7d147be8.d.ts → cubing/TwizzleLink-8eaf164c.d.ts}

@@ -1,7 +1,7 @@
 import { Texture, Object3D, Raycaster, PerspectiveCamera, Scene, WebGLRenderer } from 'three';
 import { g as PuzzleSpecificSimplifyOptions, M as Move, a as Alg, P as Pause, h as AppendCancelOptions, d as AlgLeaf, b as AppendOptions, A as AlgNode, I as IterationDirection } from './Alg-c6770822.js';
 import { P as Parsed } from './parseAlg-d2c83795.js';
-import { a as KPuzzle, P as PuzzleGeometry, K as KPattern, g as KTransformation, h as PuzzleDescriptionString } from './KPattern-85fd8579.js';
+import { a as KPuzzle, P as PuzzleGeometry, K as KPattern, g as KTransformation, h as PuzzleDescriptionString } from './KPattern-12e23b1f.js';
 
 type FaceletMeshStickeringMask = "regular" | "dim" | "oriented" | "ignored" | "invisible";
 type FaceletStickeringMask = {
@@ -55,7 +55,7 @@ interface MoveInProgress {
     fraction: number;
 }
 type PuzzlePosition = {
-    state: KPattern;
+    pattern: KPattern;
     movesInProgress: MoveInProgress[];
 };
 declare enum BoundaryType {
@@ -192,7 +192,7 @@ interface CurrentMove {
     endTimestamp: MillisecondTimestamp;
 }
 interface CurrentMoveInfo {
-    stateIndex: number;
+    patternIndex: number;
     currentMoves: CurrentMove[];
     movesFinishing: CurrentMove[];
     movesFinished: CurrentMove[];
@@ -203,13 +203,13 @@ interface CurrentMoveInfo {
 interface AlgIndexer {
     getAnimLeaf(index: number): AnimatedLeafAlgNode | null;
     indexToMoveStartTimestamp(index: number): Timestamp;
-    stateAtIndex(index: number, startSTate?: KPattern): KPattern;
+    patternAtIndex(index: number, startPattern?: KPattern): KPattern;
     transformationAtIndex(index: number): KTransformation;
     numAnimatedLeaves(): number;
     timestampToIndex(timestamp: Timestamp): number;
     algDuration(): Duration;
     moveDuration(index: number): number;
-    timestampToPosition?: (timestamp: Timestamp, startState?: KPattern) => PuzzlePosition;
+    timestampToPosition?: (timestamp: Timestamp, startPattern?: KPattern) => PuzzlePosition;
     currentMoveInfo?: (timestamp: Timestamp) => CurrentMoveInfo;
 }
 
@@ -245,7 +245,7 @@ interface CurrentLeavesSimplifiedPropInputs {
     currentMoveInfo: CurrentMoveInfo;
 }
 interface CurrentLeavesSimplified {
-    stateIndex: number;
+    patternIndex: number;
     movesFinishing: Move[];
     movesFinished: Move[];
 }
@@ -300,7 +300,7 @@ interface CurrentTransformationPropInputs {
     currentLeavesSimplified: CurrentLeavesSimplified;
     indexer: AlgIndexer;
 }
-declare class CurrentStateProp extends TwistyPropDerived<CurrentTransformationPropInputs, KPattern> {
+declare class CurrentPatternProp extends TwistyPropDerived<CurrentTransformationPropInputs, KPattern> {
     derive(inputs: CurrentTransformationPropInputs): KPattern;
 }
 
@@ -384,7 +384,7 @@ declare class IndexerProp extends TwistyPropDerived<IndexerPropInputs, AlgIndexe
 
 interface LegacyPositionPropInputs {
     currentMoveInfo: CurrentMoveInfo;
-    state: KPattern;
+    currentPattern: KPattern;
 }
 declare class LegacyPositionProp extends TwistyPropDerived<LegacyPositionPropInputs, PuzzlePosition> {
     derive(inputs: LegacyPositionPropInputs): PuzzlePosition;
@@ -771,7 +771,7 @@ declare class TwistyPlayerModel {
     currentMoveInfo: CurrentMoveInfoProp;
     buttonAppearance: ButtonAppearanceProp;
     currentLeavesSimplified: CurrentLeavesSimplifiedProp;
-    currentState: CurrentStateProp;
+    currentPattern: CurrentPatternProp;
     legacyPosition: LegacyPositionProp;
     twistySceneModel: TwistySceneModel;
     twizzleLink(): Promise<string>;

package/dist/{types → cubing}/bluetooth/index.d.ts

@@ -1,6 +1,6 @@
-import { K as KPattern } from '../KPattern-85fd8579.js';
-import { B as BluetoothPuzzle } from '../bluetooth-puzzle-da601f13.js';
-export { B as BluetoothPuzzle, A as MoveEvent, O as OrientationEvent } from '../bluetooth-puzzle-da601f13.js';
+import { K as KPattern } from '../KPattern-12e23b1f.js';
+import { B as BluetoothPuzzle } from '../bluetooth-puzzle-91e73b7f.js';
+export { B as BluetoothPuzzle, A as MoveEvent, O as OrientationEvent } from '../bluetooth-puzzle-91e73b7f.js';
 import { a as Alg, M as Move } from '../Alg-c6770822.js';
 
 declare function enableDebugLogging(enable: boolean): void;
@@ -9,12 +9,12 @@ declare function enableDebugLogging(enable: boolean): void;
 declare class KeyboardPuzzle extends BluetoothPuzzle {
     private target;
     private puzzle;
-    private state;
+    private pattern;
     listener: (e: KeyboardEvent) => Promise<void>;
     constructor(target: Element);
     name(): string | undefined;
     disconnect(): void;
-    getState(): Promise<KPattern>;
+    getPattern(): Promise<KPattern>;
     private onKeyDown;
 }
 /** @category Keyboard Puzzles */
@@ -39,7 +39,7 @@ declare class GanCube extends BluetoothPuzzle {
     static connect(server: BluetoothRemoteGATTServer): Promise<GanCube>;
     INTERVAL_MS: number;
     private intervalHandle;
-    private state;
+    private pattern;
     private cachedFaceletStatus1Characteristic;
     private cachedFaceletStatus2Characteristic;
     private cachedActualAngleAndBatteryCharacteristic;
@@ -50,7 +50,7 @@ declare class GanCube extends BluetoothPuzzle {
     stopTrackingMoves(): void;
     intervalHandler(): Promise<void>;
     getBattery(): Promise<number>;
-    getState(): Promise<KPattern>;
+    getPattern(): Promise<KPattern>;
     faceletStatus1Characteristic(): Promise<BluetoothRemoteGATTCharacteristic>;
     faceletStatus2Characteristic(): Promise<BluetoothRemoteGATTCharacteristic>;
     actualAngleAndBatteryCharacteristic(): Promise<BluetoothRemoteGATTCharacteristic>;
@@ -69,7 +69,7 @@ declare class GiiKERCube extends BluetoothPuzzle {
     private constructor();
     name(): string | undefined;
     disconnect(): void;
-    getState(): Promise<KPattern>;
+    getPattern(): Promise<KPattern>;
     private getBit;
     private toReid333;
     private onCubeCharacteristicChanged;

package/dist/{esm → cubing}/bluetooth/index.js

@@ -1,17 +1,17 @@
 import {
   binaryComponentsToReid3x3x3,
   twizzleBinaryToBinaryComponents
-} from "../chunk-2MAPPPWG.js";
+} from "../chunk-3B5ND2Z3.js";
 import {
   cube3x3x3,
   puzzles
-} from "../chunk-BTVDGT5H.js";
+} from "../chunk-Q7UVEISQ.js";
 import {
   experimental3x3x3KPuzzle
-} from "../chunk-SNYTAYI2.js";
+} from "../chunk-H66X47MG.js";
 import {
   KPattern
-} from "../chunk-F72PPD54.js";
+} from "../chunk-V4YTFIKT.js";
 import {
   Alg,
   Move,
@@ -95,8 +95,8 @@ var BluetoothPuzzle = class extends EventTarget {
   }
   // TODO: Can we make this reutrn (async) on success?
   // TODO: require subclasses to implement this?
-  async getState() {
-    throw new Error("cannot get state");
+  async getPattern() {
+    throw new Error("cannot get pattern");
   }
   addAlgLeafListener(listener) {
     this.listeners.push(listener);
@@ -139,7 +139,7 @@ var KeyboardPuzzle = class extends BluetoothPuzzle {
     super();
     this.target = target;
     this.puzzle = puzzles["3x3x3"].kpuzzle();
-    this.state = (async () => (await this.puzzle).startState())();
+    this.pattern = (async () => (await this.puzzle).defaultPattern())();
     this.listener = this.onKeyDown.bind(this);
     target.addEventListener("keydown", this.listener);
   }
@@ -149,8 +149,8 @@ var KeyboardPuzzle = class extends BluetoothPuzzle {
   disconnect() {
     this.target.removeEventListener("keydown", this.listener);
   }
-  async getState() {
-    return this.state;
+  async getPattern() {
+    return this.pattern;
   }
   async onKeyDown(e) {
     if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
@@ -158,12 +158,12 @@ var KeyboardPuzzle = class extends BluetoothPuzzle {
     }
     const algLeaf = keyToMove(e);
     if (algLeaf) {
-      const newState = (await this.state).applyAlg(new Alg([algLeaf]));
-      this.state = Promise.resolve(newState);
+      const newPattern = (await this.pattern).applyAlg(new Alg([algLeaf]));
+      this.pattern = Promise.resolve(newPattern);
       this.dispatchAlgLeaf({
         latestAlgLeaf: algLeaf,
         timeStamp: e.timeStamp,
-        state: newState
+        pattern: newPattern
       });
       e.preventDefault();
     }
@@ -335,7 +335,7 @@ var key11 = new Uint8Array([
   1,
   241
 ]);
-async function decryptState(data, aesKey) {
+async function decryptPattern(data, aesKey) {
   if (aesKey === null) {
     return data;
   }
@@ -348,7 +348,7 @@ async function decryptState(data, aesKey) {
   if (probablyDecodedCorrectly(copy)) {
     return copy;
   }
-  throw new Error("Invalid Gan cube state");
+  throw new Error("Invalid Gan cube pattern");
 }
 var PhysicalState = class _PhysicalState {
   constructor(dataView, timeStamp) {
@@ -361,7 +361,7 @@ var PhysicalState = class _PhysicalState {
     }
   }
   static async read(characteristic, aesKey) {
-    const value = await decryptState(
+    const value = await decryptPattern(
       new Uint8Array((await characteristic.readValue()).buffer),
       aesKey
     );
@@ -520,7 +520,7 @@ var GanCube = class _GanCube extends BluetoothPuzzle {
     this.aesKey = aesKey;
     this.INTERVAL_MS = DEFAULT_INTERVAL_MS;
     this.intervalHandle = null;
-    this.state = kpuzzle.startState();
+    this.pattern = kpuzzle.defaultPattern();
     this.startTrackingMoves();
   }
   // We have to perform async operations before we call the constructor.
@@ -577,12 +577,12 @@ var GanCube = class _GanCube extends BluetoothPuzzle {
       numInterveningMoves = MAX_LATEST_MOVES;
     }
     for (const move of physicalState.latestMoves(numInterveningMoves)) {
-      this.state = this.state.applyMove(move);
+      this.pattern = this.pattern.applyMove(move);
       this.dispatchAlgLeaf({
         latestAlgLeaf: move,
         timeStamp: physicalState.timeStamp,
         debug: physicalState.debugInfo(),
-        state: this.state
+        pattern: this.pattern
         // quaternion: physicalState.rotQuat(),
       });
     }
@@ -597,8 +597,8 @@ var GanCube = class _GanCube extends BluetoothPuzzle {
       await this.readActualAngleAndBatteryCharacteristic()
     )[7];
   }
-  async getState() {
-    const arr = await decryptState(
+  async getPattern() {
+    const arr = await decryptPattern(
       new Uint8Array(await this.readFaceletStatus1Characteristic()),
       this.aesKey
     );
@@ -610,7 +610,7 @@ var GanCube = class _GanCube extends BluetoothPuzzle {
         v >>= 3;
       }
     }
-    const stateData = {
+    const patternData = {
       CORNERS: {
         pieces: [],
         orientation: []
@@ -628,15 +628,15 @@ var GanCube = class _GanCube extends BluetoothPuzzle {
     };
     for (const cornerMapping of gan356iCornerMappings) {
       const pieceInfo = pieceMap[cornerMapping.map((i) => faceOrder[stickers[i]]).join("")];
-      stateData.CORNERS.pieces.push(pieceInfo.piece);
-      stateData.CORNERS.orientation.push(pieceInfo.orientation);
+      patternData.CORNERS.pieces.push(pieceInfo.piece);
+      patternData.CORNERS.orientation.push(pieceInfo.orientation);
     }
     for (const edgeMapping of gan356iEdgeMappings) {
       const pieceInfo = pieceMap[edgeMapping.map((i) => faceOrder[stickers[i]]).join("")];
-      stateData.EDGES.pieces.push(pieceInfo.piece);
-      stateData.EDGES.orientation.push(pieceInfo.orientation);
+      patternData.EDGES.pieces.push(pieceInfo.piece);
+      patternData.EDGES.orientation.push(pieceInfo.orientation);
     }
-    return new KPattern(this.kpuzzle, stateData);
+    return new KPattern(this.kpuzzle, patternData);
   }
   async faceletStatus1Characteristic() {
     this.cachedFaceletStatus1Characteristic = this.cachedFaceletStatus1Characteristic || this.service.getCharacteristic(UUIDs.faceletStatus1Characteristic);
@@ -775,7 +775,7 @@ var lookup = [
   171,
   41
 ];
-function decryptState2(data) {
+function decryptState(data) {
   const offset1 = getNibble(data, 38);
   const offset2 = getNibble(data, 39);
   const output = new Uint8Array(MESSAGE_LENGTH);
@@ -788,7 +788,7 @@ async function decodeState(data) {
   if (!probablyEncrypted(data)) {
     return data;
   }
-  return decryptState2(data);
+  return decryptState(data);
 }
 var GiiKERCube = class _GiiKERCube extends BluetoothPuzzle {
   constructor(server, cubeCharacteristic, originalValue) {
@@ -822,7 +822,7 @@ var GiiKERCube = class _GiiKERCube extends BluetoothPuzzle {
   disconnect() {
     this.server.disconnect();
   }
-  async getState() {
+  async getPattern() {
     return this.toReid333(
       new Uint8Array((await this.cubeCharacteristic.readValue()).buffer)
     );
@@ -833,7 +833,7 @@ var GiiKERCube = class _GiiKERCube extends BluetoothPuzzle {
     return val[n] >> shift & 1;
   }
   toReid333(val) {
-    const state = {
+    const patternData = {
       EDGES: {
         pieces: new Array(12),
         orientation: new Array(12)
@@ -846,15 +846,15 @@ var GiiKERCube = class _GiiKERCube extends BluetoothPuzzle {
     };
     for (let i = 0; i < 12; i++) {
       const gi = epReid333toGiiKER[i];
-      state.EDGES.pieces[i] = epGiiKERtoReid333[getNibble(val, gi + 16) - 1];
-      state.EDGES.orientation[i] = this.getBit(val, gi + 112) ^ preEO[state.EDGES.pieces[i]] ^ postEO[i];
+      patternData.EDGES.pieces[i] = epGiiKERtoReid333[getNibble(val, gi + 16) - 1];
+      patternData.EDGES.orientation[i] = this.getBit(val, gi + 112) ^ preEO[patternData.EDGES.pieces[i]] ^ postEO[i];
     }
     for (let i = 0; i < 8; i++) {
       const gi = cpReid333toGiiKER[i];
-      state.CORNERS.pieces[i] = cpGiiKERtoReid333[getNibble(val, gi) - 1];
-      state.CORNERS.orientation[i] = (getNibble(val, gi + 8) * coFlip[gi] + preCO[state.CORNERS.pieces[i]] + postCO[i]) % 3;
+      patternData.CORNERS.pieces[i] = cpGiiKERtoReid333[getNibble(val, gi) - 1];
+      patternData.CORNERS.orientation[i] = (getNibble(val, gi + 8) * coFlip[gi] + preCO[patternData.CORNERS.pieces[i]] + postCO[i]) % 3;
     }
-    return new KPattern(experimental3x3x3KPuzzle, state);
+    return new KPattern(experimental3x3x3KPuzzle, patternData);
   }
   async onCubeCharacteristicChanged(event) {
     const val = await decodeState(new Uint8Array(event.target.value.buffer));
@@ -878,7 +878,7 @@ var GiiKERCube = class _GiiKERCube extends BluetoothPuzzle {
       debug: {
         stateStr: str
       },
-      state: this.toReid333(val)
+      pattern: this.toReid333(val)
     });
   }
   isRepeatedInitialValue(val) {
@@ -1124,7 +1124,7 @@ var HeykubeCube = class _HeykubeCube extends BluetoothPuzzle {
     this.dispatchAlgLeaf({
       latestAlgLeaf: state.latestMove,
       timeStamp: event.timeStamp,
-      state: state.state
+      pattern: state.pattern
     });
   }
   decodeState(dv) {
@@ -1165,13 +1165,13 @@ var HeykubeCube = class _HeykubeCube extends BluetoothPuzzle {
       moMask: 0
     };
     return {
-      state: binaryComponentsToReid3x3x3(components2),
+      pattern: binaryComponentsToReid3x3x3(components2),
       latestMove: moves[b2[20] & 15]
     };
   }
-  async getState() {
+  async getPattern() {
     const b1 = await this.stateCharacteristic.readValue();
-    return this.decodeState(b1).state;
+    return this.decodeState(b1).pattern;
   }
 };
 var heykubeConfig = {