# Twister changelog

## 2.1.0

- Add `data` property to `Cube` and `Dodecaminx` stickers, and adds options to set initial values
- Exposes more data types like `CubeSticker<T>` and `DodecaminxSticker<T>`

## 2.0.1

- Fix dodecaminx error where swapped pieces didn't always break super-solved position

## 2.0.0

- Re-written puzzle logic to support super-cubes
- New documentation website, [see here &rarr;](https://twister.speedcube.site/)
- Improved tooling and developer experience

## 1.0.0-beta.19

- Fix cube notation parsing. Multiple wide suffixes and overly deep turns now throw errors.

## 1.0.0-beta.18

- Set default `Puzzle` generics to `any`

## 1.0.0-beta.17

- Implement [`notation`](https://github.com/scottbedard/twister#notation) method to generate string representation of parsed turn objects.
- The [`turn`](https://github.com/scottbedard/twister#turn-1) CLI command now returns an `unturn` algorithm to reverse the applied of turns.
- [`unturn`](https://github.com/scottbedard/twister#unturn) now returns the reversed algorithm.

## 1.0.0-beta.16

- Implement [`unturn`](https://github.com/scottbedard/twister#unturn) method to execute algorithms in reverse. An unturn flag has also been added to [`parse`](https://github.com/scottbedard/twister#parse) and [`parseAlgorithm`](https://github.com/scottbedard/twister#parsealgorithm).

## 1.0.0-beta.15

- Allow for falsey center values when applying state to an odd-layered Dodecaminx ([#36](https://github.com/scottbedard/twister/issues/36))

## 1.0.0-beta.14

- Added state argument to `test` command to assert puzzle matches a particular state. This includes adding a `--test` argument to the `turn` CLI command.

## 1.0.0-beta.13

- Added [`clone`](https://github.com/scottbedard/twister#clone) method to base puzzle class.

## 1.0.0-beta.12

- The base puzzle class is no longer abstract. It can be instantiated as used as a placeholder, but cannot be scrambled.

## 1.0.0-beta.11

- Fix cubes not erroring when parsing prime double turns ([#29](https://github.com/scottbedard/twister/issues/29))

## 1.0.0-beta.10

- If no argument is provided to `stickers`, all stickers will be returned

## 1.0.0-beta.9

- All turn objects now include a `whole` property
- Added `parseAlgorithm` method
- Added `parse` and `parseAlgorithm` cli commands

## 1.0.0-beta.8

- Adds previous turn argument to `scramble` and `generateScramble` to allow for continuous scrambling.

## 1.0.0-beta.7

- **BREAKING:** CLI no longer uses special puzzle names to define constructor options. An explicit `options` parameter must now be provided to use non-default values.

## 1.0.0-beta.1

#### Improvements

- A number of technical improvements, the largest of which being that cubes now use the "net" strategy for managing how faces are related to one another. This significantly reduces the size of the library, and makes things much more maintainable.
- Migrated the playground from vue-cli to vite.
- Added a light mode to the playground.
- Refactored tests to be more maintainable.

#### Breaking changes

- Simplified how state for Dodecaminx faces, we now use "block matrices". See the `src/utils/block-matrix.ts` for more information.
- Renamed `getStickersForTurn` to `stickers`.
- Renamed `isSolved` to `test`.
- `scramble` and `generateScramble` now return the resulting scramble.
- Typescript resources for specific puzzles are no longer exported.
- Dodecaminx no longer supports Pochmann-style scrambling notation.
- Dodecaminx now uses lowercase letters to denote whole-puzzle turns.

## 0.7.0

-  **BREAKING:** Replaced `test` CLI command with `apply`

## 0.6.6

- Fixed node environment issue that broke npx

## 0.6.5

- Export base `Puzzle` class

## 0.6.4

- Fix versioning and dependency issue that broke the command line interface

## 0.6.2

- Fix dodecaminx `getStickersForTurn` logic that wasn't including all slices of wide turns ([#12](https://github.com/scottbedard/twister/issues/12))

## 0.6.1

- Fix dodecaminx `getStickersForTurn` logic that extracted slices from incorrect angles ([#11](https://github.com/scottbedard/twister/issues/11))

## 0.6.0

- Dodecaminx puzzle added

## 0.5.1

- Fix regression of default type definitions added in v0.4.1

## 0.5.0

- Add support for generating cryptographically strong scrambles ([#4](https://github.com/scottbedard/twister/issues/4))
- Add `getStickersForTurn` method ([#5](https://github.com/scottbedard/twister/issues/5))

## 0.4.1

- For use with Typescript projects, a default sticker data type of [`Record<string, unknown>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeystype) will be used

## 0.4.0

- **BREAKING:** Various methods have been renamed, [check the readme for current API](https://github.com/scottbedard/twister#api)

## 0.3.0

- Added command line interface ([#3](https://github.com/scottbedard/twister/issues/3))
- Added `toState` method

## 0.2.0

- Added `applyState` method
- **BREAKING:** `Cube` state now uses lower case keys