@houstonp/rubiks-cube 2.1.0 → 3.0.0

package/types/cube/animationSlice.d.ts

@@ -1,26 +0,0 @@
-/** @typedef {{axis: Axis, layers: number[], direction: number}} Slice */
-/**
- * @param {import('../core').Movement } outerBlockMovement
- * @param {import('../core').CubeType} cubeType
- * @param {boolean} prioritiseStandardMovement
- * @returns {Slice | undefined}
- */
-export function GetLayerSlice(outerBlockMovement: import("../core").Movement, cubeType: import("../core").CubeType, prioritiseStandardMovement?: boolean): Slice | undefined;
-/**
- * @param {import("../core").Rotation} rotation
- * @param {import('../core').CubeType} cubeType
- * @returns {Slice | undefined}
- */
-export function GetRotationSlice(rotation: import("../core").Rotation, cubeType: import("../core").CubeType): Slice | undefined;
-/** @typedef {typeof Axi[keyof typeof Axi]} Axis */
-export const Axi: Readonly<{
-    x: "x";
-    y: "y";
-    z: "z";
-}>;
-export type Slice = {
-    axis: Axis;
-    layers: number[];
-    direction: number;
-};
-export type Axis = (typeof Axi)[keyof typeof Axi];

package/types/cube/animationState.d.ts

@@ -1,41 +0,0 @@
-/** @typedef {AnimationStatus[keyof AnimationStatus]} AnimationStatusType */
-export const AnimationStatus: Readonly<{
-    Pending: "pending";
-    Initialised: "initialised";
-    InProgress: "inProgress";
-    Complete: "complete";
-    Disposed: "disposed";
-}>;
-export class AnimationState {
-    /**
-     * @param {import('./animationSlice').Slice} slice
-     * @param {((state: string) => void )} completedCallback
-     * @param {((reason: string) => void )} failedCallback
-     */
-    constructor(slice: import("./animationSlice").Slice, completedCallback: ((state: string) => void), failedCallback: ((reason: string) => void));
-    /** @type {((state: string) => void )} */
-    completedCallback: ((state: string) => void);
-    /** @type {((reason: string) => void )} */
-    failedCallback: ((reason: string) => void);
-    /** @type {import('./animationSlice').Slice} */
-    slice: import("./animationSlice").Slice;
-    /** @type {AnimationStatusType} */
-    status: AnimationStatusType;
-    /** @type {number} */
-    timestampMs: number;
-    /** @type {number | undefined} */
-    _lastUpdatedTimeMs: number | undefined;
-    /** @type {number} */
-    _rotationPercentage: number;
-    initialise(): void;
-    /** @param {string} state */
-    complete(state: string): void;
-    /** @param {string} reason */
-    abort(reason: string): void;
-    /**
-     * @param {number} speedMs
-     * @returns {number} rotationIncrement
-     */
-    update(speedMs: number): number;
-}
-export type AnimationStatusType = "pending" | "initialised" | "inProgress" | "complete" | "disposed";

package/types/cube/cubeSettings.d.ts

@@ -1,17 +0,0 @@
-export default class CubeSettings {
-    /**
-     * @param {import('../core').CubeType} cubeType
-     * @param {number} pieceGap
-     * @param {number} animationSpeed
-     * @param {import('../core').AnimationStyle} animationStyle
-     */
-    constructor(pieceGap: number, animationSpeed: number, animationStyle: import("../core").AnimationStyle, cubeType: import("../core").CubeType);
-    /** @type {number} pieceGap */
-    pieceGap: number;
-    /** @type {import("../core").CubeType} */
-    cubeType: import("../core").CubeType;
-    /** @type {number} pieceGap */
-    animationSpeedMs: number;
-    /** @type {import('../core').AnimationStyle} pieceGap */
-    animationStyle: import("../core").AnimationStyle;
-}

package/types/cube/cubeState.d.ts

@@ -1,47 +0,0 @@
-/** @typedef {{cubeType: import('../core').CubeType, layers: number[], pieceSize: number, coreSize: number,initialStickerState: import('./stickerState').StickerState, outerLayerMultiplier: number, corners: state[], edges: state[], centers: state[]}} CubeInfo */
-/**
- * @param {import("../core").CubeType} cubeType
- * @return {CubeInfo}
- */
-export function getCubeInfo(cubeType: import("../core").CubeType): CubeInfo;
-export namespace FaceColors {
-    let B: string;
-    let D: string;
-    let F: string;
-    let L: string;
-    let R: string;
-    let U: string;
-}
-export function ColorToFace(color: import("three").ColorRepresentation): import("../core").Face;
-export function outlerLayerMultiplier(cubeType: import("../core").CubeType): number;
-export function coreSize(cubeType: import("../core").CubeType): number;
-export function getMiddleLayers(cubeType: import("../core").CubeType): number[];
-export function getAllLayers(cubeType: import("../core").CubeType): number[];
-export function pieceSize(cubeType: import("../core").CubeType): number;
-/**
- * @typedef {{position: vector, rotation: vector}} state
- */
-/** @type {state[]} */
-export const corners: state[];
-export function centers(layers: number[]): state[];
-export function edges(layers: number[]): state[];
-export type CubeInfo = {
-    cubeType: import("../core").CubeType;
-    layers: number[];
-    pieceSize: number;
-    coreSize: number;
-    initialStickerState: import("./stickerState").StickerState;
-    outerLayerMultiplier: number;
-    corners: state[];
-    edges: state[];
-    centers: state[];
-};
-export type vector = {
-    x: number;
-    y: number;
-    z: number;
-};
-export type state = {
-    position: vector;
-    rotation: vector;
-};

package/types/cube/stickerState.d.ts

@@ -1,21 +0,0 @@
-/**
- * @param {StickerState} stickerState
- * @returns {string}
- */
-export function toKociemba(stickerState: StickerState): string;
-/**
- * @param {string} kociembaString
- * @param {import('../core').CubeType} cubeType
- * @returns {StickerState | undefined} stickerState
- */
-export function fromKociemba(kociembaString: string, cubeType: import("../core").CubeType): StickerState | undefined;
-export function defaultStickerState(cubeType: import("../core").CubeType): StickerState;
-export function getEmptyStickerState(cubeType: import("../core").CubeType): StickerState;
-export type StickerState = {
-    up: import("../core").Face[][];
-    down: import("../core").Face[][];
-    front: import("../core").Face[][];
-    back: import("../core").Face[][];
-    left: import("../core").Face[][];
-    right: import("../core").Face[][];
-};

package/types/index.d.ts

@@ -1,87 +0,0 @@
-/// <reference path="globals.d.ts" preserve="true" />
-export namespace AttributeNames {
-    let cubeType: "cube-type";
-    let pieceGap: "piece-gap";
-    let animationSpeed: "animation-speed-ms";
-    let animationStyle: "animation-style";
-    let cameraSpeed: "camera-speed-ms";
-    let cameraRadius: "camera-radius";
-    let cameraFieldOfView: "camera-field-of-view";
-    let cameraPeekAngleHorizontal: "camera-peek-angle-horizontal";
-    let cameraPeekAngleVertical: "camera-peek-angle-vertical";
-}
-export class RubiksCubeElement extends HTMLElement {
-    /**
-     * @param {string} tagName the name of the tag to register the web component under
-     */
-    static register(tagName?: string): void;
-    static get observedAttributes(): ("cube-type" | "piece-gap" | "animation-speed-ms" | "animation-style" | "camera-speed-ms" | "camera-radius" | "camera-field-of-view" | "camera-peek-angle-horizontal" | "camera-peek-angle-vertical")[];
-    /** @private @type {HTMLCanvasElement} */
-    private canvas;
-    /** @private @type {Settings} */
-    private settings;
-    /** @private @type {CubeSettings} */
-    private cubeSettings;
-    /**
-     * @param {string} name
-     * @param {string} oldVal
-     * @param {string} newVal
-     *  */
-    attributeChangedCallback(name: string, oldVal: string, newVal: string): void;
-    connectedCallback(): void;
-    /** @private */
-    private animateCameraSetting;
-    /** @private */
-    private animateCameraRadius;
-    /** @private */
-    private updateCameraFOV;
-    /** @import {Movement} from './core' */
-    /** @internal @typedef {{eventId: string, move: Movement}} MovementEvent */
-    /** @internal @typedef {{eventId: string, move: Movement, state: string}} MovementCompleteEventData */
-    /** @internal @typedef {{eventId: string, move: Movement, reason: string}} MovementFailedEventData */
-    /**
-     * @param {Movement} move
-     * @returns {Promise<string>}
-     */
-    move(move: Movement): Promise<string>;
-    /** @import {Rotation} from './core' */
-    /** @internal @typedef {{eventId: string, rotation: Rotation}} RotationEventData */
-    /** @internal @typedef {{eventId: string, rotation: Rotation, state: string, }} RotationCompleteEventData*/
-    /** @internal @typedef {{eventId: string, rotation: Rotation, reason: string, }} RotationFailedEventData*/
-    /**
-     * @param {Rotation} rotation
-     * @returns {Promise<string>}
-     */
-    rotate(rotation: Rotation): Promise<string>;
-    /** @internal @typedef {{state: string }} ResetCompleteEventData */
-    /**
-     * @returns {Promise<string>}
-     */
-    reset(): Promise<string>;
-    /** @import {PeekType} from './core' */
-    /** @internal @typedef {{eventId: string, peekType: PeekType}} CameraPeekEventData */
-    /** @import {PeekState} from './core' */
-    /** @internal @typedef {{eventId: string, peekState: PeekState }} CameraPeekCompleteEventData */
-    /**
-     * This function changes the camera position to one of four states depending on the arguments passed.
-     *
-     * @param {PeekType} peekType
-     * @returns {Promise<PeekState>}
-     */
-    peek(peekType: PeekType): Promise<PeekState>;
-    /** @internal @typedef {{state: string }} SetStateEventData */
-    /** @internal @typedef {{state: string }} SetStateCompleteEventData */
-    /** @internal @typedef {{reason: string }} SetStateFailedEventData */
-    /**
-     * @param {string} kociembaState
-     * @returns {Promise<string>}
-     */
-    setState(kociembaState: string): Promise<string>;
-    /** @private */
-    private init;
-}
-export type AttributeName = (typeof AttributeNames)[keyof typeof AttributeNames];
-import type { Movement } from './core';
-import type { Rotation } from './core';
-import type { PeekType } from './core';
-import type { PeekState } from './core';

package/types/three/centerPiece.d.ts

@@ -1,15 +0,0 @@
-/** @typedef {{ positon: import('three').Vector3Like, rotation: import('three').Vector3Like }} CenterPieceUserData */
-export class CenterPiece extends Object3D<import("three").Object3DEventMap> {
-    constructor();
-    frontSticker: CenterSticker;
-    get stickers(): CenterSticker[];
-}
-export class CenterSticker extends Sticker {
-    constructor();
-}
-export type CenterPieceUserData = {
-    positon: import("three").Vector3Like;
-    rotation: import("three").Vector3Like;
-};
-import { Object3D } from 'three';
-import { Sticker } from './sticker';

package/types/three/cornerPiece.d.ts

@@ -1,24 +0,0 @@
-/** @typedef {{ positon: import('three').Vector3Like, rotation: import('three').Vector3Like }} CornerPieceUserData */
-/**
- * @param {Material} frontMaterial
- * @param {Material} rightMaterial
- * @param {Material} topMaterial
- * @param {Material} coreMaterial
- * @returns {Group}
- */
-export class CornerPiece extends Object3D<import("three").Object3DEventMap> {
-    constructor();
-    frontSticker: CornerSticker;
-    rightSticker: CornerSticker;
-    topSticker: CornerSticker;
-    get stickers(): CornerSticker[];
-}
-export class CornerSticker extends Sticker {
-    constructor();
-}
-export type CornerPieceUserData = {
-    positon: import("three").Vector3Like;
-    rotation: import("three").Vector3Like;
-};
-import { Object3D } from 'three';
-import { Sticker } from './sticker';

package/types/three/cube.d.ts

@@ -1,130 +0,0 @@
-export default class RubiksCube3D extends Object3D<import("three").Object3DEventMap> {
-    /**
-     * @public
-     * @param {CubeSettings} cubeSettings
-     */
-    constructor(cubeSettings: CubeSettings);
-    /** @type {CubeSettings} */
-    _cubeSettings: CubeSettings;
-    /** @type {number} */
-    _pieceGap: number;
-    /** @type {import('../core').CubeType} */
-    _cubeType: import("../core").CubeType;
-    /** @type {import('../cube/cubeState').CubeInfo} */
-    _cubeInfo: import("../cube/cubeState").CubeInfo;
-    /** @type {Group} */
-    _mainGroup: Group;
-    /** @type {Group} */
-    _rotationGroup: Group;
-    /** @type {AnimationState[]} */
-    _rotationQueue: AnimationState[];
-    /** @type {AnimationState | undefined} */
-    _currentRotation: AnimationState | undefined;
-    /** @type {number | undefined} */
-    _matchSpeed: number | undefined;
-    /**
-     * Creates the main group containing all the pieces of the cube in their default position and rotation. Should only be called once during initialization.
-     * @private
-     **/
-    private createCubeGroup;
-    /**
-     * Returns the sticker state of the cube. Can only be called when an Animation is not in progress as not all pieces would be in the main group.
-     * @private
-     * @returns {import('../cube/stickerState').StickerState}
-     */
-    private getStickerState;
-    /**
-     * Sets the sticker state of the cube. Can only be called when an Animation is not in progress as not all pieces would be in the main group.
-     * @private
-     * @param {import('../cube/stickerState').StickerState} stickerState
-     */
-    private setStickerState;
-    /**
-     * Returns the pieces that should be rotated for a given slice. If the slice has no layers, all pieces will be returned. Should only be called before an Animation is started.
-     * @private
-     * @param {import('../cube/animationSlice').Slice} slice
-     * @returns {Object3D[]}
-     */
-    private getRotationLayer;
-    /**
-     * Updates the gap of the pieces. To be used when the cube is not rotating
-     * @private
-     * @param {number} pieceGap
-     * @returns {void}
-     */
-    private updateGap;
-    /**
-     * @private
-     * @param {import('../core').CubeType} cubeType
-     */
-    private updateCubeType;
-    /**
-     * finish current rotation and clear rotation queue
-     * @private
-     */
-    private stop;
-    /**
-     * Adds pieces in the rotationGroup back into the main group.
-     * Updates the position and rotation of the pieces according to their world position and rotation, then resets the rotation of the rotation group.
-     * Should only be called when a rotation is in progress.
-     * @private
-     * @returns {void}
-     */
-    private clearRotationGroup;
-    /**
-     * Rotates the pieces in the rotation group according to the percentage of completion of the current animation. Should only be called when a rotation is in progress.
-     * @private
-     * @param {number} percentage
-     * @param {AnimationState} animationState
-     */
-    private rotateGroupByPercent;
-    /**
-     *
-     * calculates the current speed of the current rotation in ms.
-     * calculation is dependent on animation style and animation speed settings
-     * - exponential: speeds up rotations depending on the queue length
-     * - next: an animation speed of 0 when there is another animation in the queue
-     * - match: will match the speed of rotations to the frequency of key presses.
-     * - fixed: will return a constant value
-     * @private
-     * @returns {number}
-     */
-    private getRotationSpeed;
-    /**
-     * Update the cube and continue any rotations. If a rotation is in progress, it will be updated. If no rotation is in progress, the next rotation in the queue will be started.
-     * @public
-     */
-    public update(): void;
-    /**
-     * resets the cube to the default state and clears any queued rotations. If a rotation is in progress, it will be completed instantly before the reset.
-     * @public
-     * @param {(state: string) => boolean} completedCallback
-     */
-    public reset(completedCallback: (state: string) => boolean): void;
-    /**
-     * sets the state of the cube
-     * @public
-     * @param {string} state
-     * @param {(state: string) => boolean} completedCallback
-     * @param {(reason: string) => boolean} failedCallback
-     */
-    public setState(state: string, completedCallback: (state: string) => boolean, failedCallback: (reason: string) => boolean): void;
-    /**
-     *  @public
-     *  @param {import('../core').Rotation} rotation
-     *  @param {((state: string) => void )} completedCallback
-     *  @param {((reason: string) => void )} failedCallback
-     */
-    public rotate(rotation: import("../core").Rotation, completedCallback: ((state: string) => void), failedCallback: ((reason: string) => void)): void;
-    /**
-     *  @public
-     *  @param {import('../core').Movement} movement
-     *  @param {((state: string) => void )} completedCallback
-     *  @param {((reason: string) => void )} failedCallback
-     */
-    public movement(movement: import("../core").Movement, completedCallback: ((state: string) => void), failedCallback: ((reason: string) => void)): void;
-}
-import { Object3D } from 'three';
-import CubeSettings from '../cube/cubeSettings';
-import { Group } from 'three';
-import { AnimationState } from '../cube/animationState';

package/types/three/sticker.d.ts

@@ -1,15 +0,0 @@
-export class Sticker extends Mesh<import("three").BufferGeometry<import("three").NormalBufferAttributes, import("three").BufferGeometryEventMap>, import("three").Material | import("three").Material[], import("three").Object3DEventMap> {
-    /**
-     * @param {import("three").BufferGeometry} geometry
-     */
-    constructor(geometry: import("three").BufferGeometry);
-    /**
-     * @param {import('three').ColorRepresentation} color
-     */
-    set color(color: import("three").ColorRepresentation);
-    /**
-     * @returns {import('three').ColorRepresentation} color
-     */
-    get color(): import("three").ColorRepresentation;
-}
-import { Mesh } from 'three';