@wodzik/cubecore 0.1.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,118 @@
+# cubecore
+
+A 3×3×3 cube library for the web, built around smart (Bluetooth) cubes: a
+headless core for state, notation and colour-neutral method analysis;
+solvers and random-state / trainer scrambles; timed recordings and share
+codecs; a three.js renderer with skins down to per-model piece geometry;
+SVG / PNG pictures; web components with themable controls; React bindings.
+
+TypeScript, ESM; one npm package (`@wodzik/cubecore`), developed as Bun workspaces. Everything runs in the browser; the
+headless packages also run in Node / Bun / workers.
+
+## Packages
+
+| package | what |
+|---|---|
+| `@wodzik/cubecore/core` | state (sticker permutation + centre spins), notation (parse / format / invert / simplify / mirror, `(…)3`, `[A, B]`, `.` pauses, comments, source ranges), metrics, 24 frames and colour neutrality, check primitives, method engine (`Method`, `MethodTracker`), masks, pieces view (Kociemba), 15-char state codec, facelet strings, face turns as a smart cube reports them (`toFaceTurns`, `OrientationTracker`), live move log (`MoveCollapser`: R R → R2, R L' → M), following a scramble / algorithm (`SequenceTracker`) |
+| `@wodzik/cubecore/cfop`, `roux`, `zz`, `petrus`, `lbl` | methods: stages, their checks, masks, trainer stages; CFOP: OLL / PLL recognition (colour neutral, speedcubedb numbering and names; which case came up after F2L / OLL in a solve) |
+| `@wodzik/cubecore/methods` | all methods together, masks by name |
+| `@wodzik/cubecore/solve` | two-phase solver (≤ 21 moves, ms), optimal stage solvers (cross, EOCross, xcross, xxcross, slot, Roux blocks), random-state scrambles with presets, trainer scrambles (a stage in exactly N moves), from the cube's current state, any face; Web Worker with a Promise API; tables kept in IndexedDB |
+| `@wodzik/cubecore/timeline` | recordings, replay clock (moves end at their recorded time), stage timings, sections for progress bars, pause compression, recording and share codecs |
+| `@wodzik/cubecore/skin` | skins as data: tile shapes, stickerless tiles, piece shapes, decals (PNG / SVG), features (`defineFeature`), glTF piece models, light / dark themes; presets `default`, `gan`, `qiyiSC`, `moyu` and their stickered versions (`withStickers`), matte / UV (`withFinish`) |
+| `@wodzik/cubecore/render` | three.js `CubeRenderer`: skins, masks, back stickers, back view, gyro orientation, partial layers, glTF pieces (+ templates exporter) |
+| `@wodzik/cubecore/image` | SVG pictures (iso / top / net) from the same skin; PNG in the browser or via resvg on a server; cache keys |
+| `@wodzik/cubecore/bld` | Blindfolded (Old Pochmann): letter schemes (ruwix, Speffz), memo, execution followed letter by letter, a skin with letters |
+| `@wodzik/cubecore/analyze` | scramble analysis — CFOP: per cross colour the optimal cross / Cross+1…3, the best pair order (fewest moves or by F2L algorithms), OLL / PLL cases, coverage of known algorithms; Roux: per block side FB, second square + block, CMLL case, optimal LSE; ZZ: EOCross, R U L pairs, OCLL + PLL; worker |
+| `@wodzik/cubecore/element` | `<cube-player>` (algorithms at a tempo or timed solves; controls, progress bar with stage sections, 2D views, live mode), `<cube-scramble>` (follows a scramble on a smart cube; paste your own), `<cube-alg-practice>` (algorithm practice: hidden moves, hints, mistakes, TPS), `<cube-bld>` (blindfolded memo and execution), `<cube-alg>` (the text in sync) |
+| `@wodzik/cubecore/bluetooth` | `SmartCubeSession` over smartcube-web-bluetooth (GAN, MoYu, QiYi, GoCube, Giiker): moves timed by the cube's clock, resync, gyro, battery; skin per cube; `SimulatedCube` |
+| `@wodzik/cubecore/react` | `<CubePlayer>`, `<CubeScramble>`, `<CubeAlgPractice>`, `<CubeAlg>`, `useSmartCube()`, `useSolverWorker()` |
+
+## Quick start
+
+```html
+<script type="module">import "@wodzik/cubecore/element";</script>
+<cube-player alg="R U R' U R U2 R'" anchor="end" skin="gan" progress></cube-player>
+```
+
+```ts
+import { SmartCubeSession } from "@wodzik/cubecore/bluetooth";
+import { MoveCollapser } from "@wodzik/cubecore/core";
+import { createSolverWorker, STAGES } from "@wodzik/cubecore/solve";
+
+const cube = await SmartCubeSession.connect();          // from a click
+const log = new MoveCollapser();
+cube.on("move", ({ move, time }) => log.push(move, time));
+document.querySelector("cube-player").attach(cube, { autoSkin: true });
+
+const solver = createSolverWorker();
+const { moves } = await solver.stageScramble({ stage: STAGES.cross(), length: 6, from: cube.state });
+document.querySelector("cube-scramble").scramble = moves;
+```
+
+## Guides
+
+- [docs/core.md](https://github.com/wodzik/cubecore/blob/main/docs/core.md) — state, notation, frames and colour neutrality, methods, masks, smart-cube moves
+- [docs/cases.md](https://github.com/wodzik/cubecore/blob/main/docs/cases.md) — OLL / PLL / CMLL recognition
+- [docs/scrambles.md](https://github.com/wodzik/cubecore/blob/main/docs/scrambles.md) — solvers, scrambles, trainer stages, following a scramble, `<cube-scramble>`, `<cube-alg-practice>`, arrows
+- [docs/player.md](https://github.com/wodzik/cubecore/blob/main/docs/player.md) — `<cube-player>`, algorithm vs recording, sections, `<cube-alg>`, customising controls
+- [docs/render.md](https://github.com/wodzik/cubecore/blob/main/docs/render.md) — the three.js renderer, still pictures, turn arrows, SVG / PNG
+- [docs/skins.md](https://github.com/wodzik/cubecore/blob/main/docs/skins.md) — making skins: shapes, decals, features, glTF pieces, themes
+- [docs/timeline.md](https://github.com/wodzik/cubecore/blob/main/docs/timeline.md) — recordings, stage timings, replay, codecs, statistics
+- [docs/analyze.md](https://github.com/wodzik/cubecore/blob/main/docs/analyze.md) — scramble analysis for CFOP, Roux and ZZ
+- [docs/bld.md](https://github.com/wodzik/cubecore/blob/main/docs/bld.md) — blindfolded: letters, memo, execution, `<cube-bld>`
+- [docs/bluetooth.md](https://github.com/wodzik/cubecore/blob/main/docs/bluetooth.md) — smart cubes
+- [docs/react.md](https://github.com/wodzik/cubecore/blob/main/docs/react.md) — React
+
+## Development
+
+```sh
+bun install
+bun test            # ~220 tests (core parity with cubing.js included)
+bun run typecheck
+bun run demo        # http://localhost:3000 — core, 3D, skins, player, sequences, BLD, analysis, React, smart cubes
+bun scripts/export-models.ts ganI4 ./out   # a skin's pieces as glTF templates
+bun run build:npm 0.1.0                    # the npm package in dist/package
+```
+
+In the repository every part is a workspace package (`packages/core` is
+`@cubecore/core`…); `bun run build:npm` compiles them into the single
+`@wodzik/cubecore` package, one subpath each.
+
+The demo shows brand logos on the cubes only if you supply them: PNGs in
+`../cubecore-assets` next to the repo (or `CUBECORE_ASSETS=/path`). Brand
+logos are trademarks and are never part of this repository.
+
+## Install
+
+```sh
+npm install @wodzik/cubecore            # plus three for 3D / elements, react for @wodzik/cubecore/react
+```
+
+One package, a subpath per part — import only what you use:
+`@wodzik/cubecore/` + `core`, `cfop`, `roux`, `zz`, `petrus`, `lbl`, `methods`,
+`solve`, `timeline`, `skin`, `render`, `image` (+ `image/png-node`), `bld`,
+`analyze`, `element`, `bluetooth`, `react`. `three`, `react` and `@resvg/resvg-js` are optional peer
+dependencies: install them if you use the parts that need them.
+
+The solver and analyser run in Web Workers created with
+`new Worker(new URL("./worker.js", import.meta.url), { type: "module" })`,
+which Vite, webpack 5 and other bundlers pick up by themselves.
+
+## Licence
+
+[Mozilla Public License 2.0](LICENSE). You can use cubecore in any project,
+open or closed; changes to cubecore's own files must be shared under the
+same licence.
+
+## Credits
+
+- The `gan` skin's piece shapes were measured from
+  ["GAN CUBE 356s M air"](https://sketchfab.com/3d-models/gan-cube-356s-m-air-dd4768b8fe2841c78e418230e5d9e192)
+  by Amyyu (Sketchfab, [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)).
+- Smart-cube protocols: [smartcube-web-bluetooth](https://github.com/poliva/smartcube-web-bluetooth)
+  by Pau Oliva and Andy Fedotov (MIT).
+- Case numbering, names and groups (OLL, PLL, F2L, CMLL) follow
+  [speedcubedb.com](https://speedcubedb.com).
+- Notation and state tests compare against [cubing.js](https://github.com/cubing/cubing.js).
+- Cube names such as GAN, MoYu and QiYi are trademarks of their owners;
+  cubecore is not affiliated with them.

package/analyze/client.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Promise API for the analyser worker:
+ *
+ *   const analyzer = createAnalyzerWorker();
+ *   const a = await analyzer.analyze(scramble, { f2l: "algorithms", known: myCases });
+ */
+import type { State } from "../core/index.js";
+import type { Analysis, AnalyzeOptions, RouxAnalysisResult, RouxAnalyzeOptions, ZZAnalysisResult, ZZAnalyzeOptions } from "./index.js";
+export interface AnalyzerClient {
+    /** CFOP. */
+    analyze(scramble: string | State, options?: AnalyzeOptions): Promise<Analysis>;
+    analyzeRoux(scramble: string | State, options?: RouxAnalyzeOptions): Promise<RouxAnalysisResult>;
+    analyzeZZ(scramble: string | State, options?: ZZAnalyzeOptions): Promise<ZZAnalysisResult>;
+    terminate(): void;
+}
+export declare function analyzerClient(worker: Worker): AnalyzerClient;
+/** Start the analyser worker (bundlers pick up `./worker.ts`; or pass the URL of one you built). */
+export declare function createAnalyzerWorker(url?: string | URL): AnalyzerClient;

package/analyze/client.js

@@ -0,0 +1,42 @@
+/**
+ * Promise API for the analyser worker:
+ *
+ *   const analyzer = createAnalyzerWorker();
+ *   const a = await analyzer.analyze(scramble, { f2l: "algorithms", known: myCases });
+ */
+export function analyzerClient(worker) {
+    let nextId = 1;
+    const pending = new Map();
+    worker.onmessage = (e) => {
+        const p = pending.get(e.data.id);
+        if (!p)
+            return;
+        pending.delete(e.data.id);
+        if (e.data.ok)
+            p.resolve(e.data.value);
+        else
+            p.reject(new Error(e.data.error));
+    };
+    const call = (method, scramble, options) => new Promise((resolve, reject) => {
+        const id = nextId++;
+        pending.set(id, { resolve: resolve, reject });
+        const { known, ...rest } = options;
+        worker.postMessage({ id, method, scramble: typeof scramble === "string" ? scramble : [...scramble], options: { ...rest, ...(known ? { known: [...known] } : {}) } });
+    });
+    return {
+        analyze: (scramble, options = {}) => call("cfop", scramble, options),
+        analyzeRoux: (scramble, options = {}) => call("roux", scramble, options),
+        analyzeZZ: (scramble, options = {}) => call("zz", scramble, options),
+        terminate: () => {
+            worker.terminate();
+            for (const p of pending.values())
+                p.reject(new Error("Analyzer worker terminated"));
+            pending.clear();
+        },
+    };
+}
+/** Start the analyser worker (bundlers pick up `./worker.ts`; or pass the URL of one you built). */
+export function createAnalyzerWorker(url) {
+    // Written out in full: bundlers only recognise the literal `new Worker(new URL(…), { type: "module" })`.
+    return analyzerClient(url ? new Worker(url, { type: "module" }) : new Worker(new URL("./worker.js", import.meta.url), { type: "module" }));
+}

package/analyze/index.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Scramble analysis for CFOP (in the spirit of speedcubedb.com/analyze):
+ * for each cross colour, a good way through — the cross (or XCross…), the
+ * F2L pairs in the best order, the last layer with its cases — so an app
+ * can show the optimal cross, the recommended first pair, the pair order,
+ * which cases come up, and how much of it the solver's own algorithms
+ * cover.
+ *
+ *   const a = analyzeScramble("R U2 F' …", { f2l: "optimal", start: "cross" });
+ *   a.best                 // the shortest analysis over the six cross colours
+ *   a.byCross[0].steps     // [{ step: "cross", moves }, { step: "pair", slot: "FL", moves, case? }, … { step: "oll", case } …]
+ *   a.byCross[0].rotation  // "x2" — hold like this (cross on the bottom), then do the moves as written
+ *
+ * F2L modes:
+ *   "optimal"     each pair the fewest moves that keep the cross and the pairs
+ *                 already in (StageSolver), over all 24 pair orders;
+ *   "algorithms"  each pair its F2L case's algorithm (pre-AUF + alg), over all
+ *                 orders; a pair not in one of the 41 cases (a piece stuck in
+ *                 another slot) falls back to the fewest-moves insertion.
+ * The last layer always goes by OLL + PLL algorithms (+ AUF).
+ */
+import { type Face, type Frame, type Move, type StageDef, type State } from "../core/index.js";
+import { type F2LSlot } from "../cfop/index.js";
+export * from "./roux.js";
+export * from "./zz.js";
+export { rotationFor } from "./rotations.js";
+export type AnalysisStart = "cross" | "xcross" | "xxcross" | "xxxcross";
+export interface AnalyzeOptions {
+    /** Physical faces to put the cross on (default: all six — colour neutral). */
+    crosses?: readonly Face[];
+    /** Begin with the cross, or cross + 1 / 2 / 3 pairs solved optimally together ("Cross+1…3"). Default "cross". */
+    start?: AnalysisStart;
+    /** How the pairs are solved. Default "optimal". */
+    f2l?: "optimal" | "algorithms";
+    /** Case ids the solver knows ("F2L 7", "OLL 27", "T"…) — steps are marked `known`. */
+    known?: Iterable<string>;
+}
+export type AnalysisStep = {
+    step: "cross";
+    moves: Move[];
+    slots?: F2LSlot[];
+} | {
+    step: "pair";
+    slot: F2LSlot;
+    moves: Move[];
+    /** F2L case the pair was in ("solved" when it came in by itself). */
+    case?: string;
+    alg?: string;
+    /** "algorithm": the case's algorithm; "optimal": fewest moves (optimal mode, or a pair outside the 41 cases). */
+    how: "algorithm" | "optimal";
+    known?: boolean;
+} | {
+    step: "oll";
+    moves: Move[];
+    case: string;
+    alg?: string;
+    known?: boolean;
+} | {
+    step: "pll";
+    moves: Move[];
+    case: string;
+    alg?: string;
+    known?: boolean;
+} | {
+    step: "auf";
+    moves: Move[];
+}
+/** ZZ: the EOLine (every edge oriented, DF + DB), and a block built with R U L after it. */
+ | {
+    step: "eoline";
+    moves: Move[];
+} | {
+    step: "block";
+    side: "left" | "right";
+    moves: Move[];
+};
+export interface CrossAnalysis {
+    /** Physical face the cross goes on. */
+    face: Face;
+    /** The rotation to hold the cube with the cross on the bottom; the steps' moves are written for that grip. */
+    rotation: string;
+    frame: Frame;
+    steps: AnalysisStep[];
+    /** Face turns in all (HTM). */
+    length: number;
+    /** Order the pairs go in (after any solved with the cross). */
+    pairOrder: F2LSlot[];
+}
+export interface Analysis {
+    byCross: CrossAnalysis[];
+    /** The shortest. */
+    best: CrossAnalysis;
+}
+/** Cross plus the given pairs solved — one stage (tables: cross + each piece); `moves` limits the faces turned (ZZ: R U L). */
+export declare function f2lStage(slots: readonly F2LSlot[], moves?: StageDef["moves"]): StageDef;
+export interface F2LPlan {
+    steps: AnalysisStep[];
+    length: number;
+    order: F2LSlot[];
+    state: State;
+}
+/** The best way through the remaining pairs (all orders). */
+export declare function planPairs(state: State, done: F2LSlot[], mode: "optimal" | "algorithms", known: Set<string> | null, moves?: StageDef["moves"]): F2LPlan;
+export declare function lastLayer(state: State, known: Set<string> | null): {
+    steps: AnalysisStep[];
+    state: State;
+};
+/** One cross colour: the whole way through, as held with the cross on the bottom. */
+export declare function analyzeCross(scrambled: State, face: Face, options?: AnalyzeOptions): CrossAnalysis;
+/** Analyse a scramble (moves from solved, or a state) for each cross colour. */
+export declare function analyzeScramble(scramble: string | readonly Move[] | State, options?: AnalyzeOptions): Analysis;
+/** Does following the analysis (rotation, then every step) solve the cube? — for tests / sanity checks. */
+export declare function followsThrough(scramble: State, a: CrossAnalysis): boolean;
+export * from "./client.js";