@logic-pad/core 0.4.6 → 0.6.0

package/assets/logic-core.global.d.ts

@@ -31,9 +31,25 @@ declare global {
     Underclued = 'underclued',
   }
   export declare enum State {
+    /**
+     * Describes the violation of a rule.
+     */
     Error = 'error',
+    /**
+     * Describes that a rule is satisfied and complete in the current grid.
+     */
     Satisfied = 'satisfied',
+    /**
+     * Describes that a rule is not violated, but is not yet complete in the current grid.
+     */
     Incomplete = 'incomplete',
+    /**
+     * Describes that a rule is violated but ignored due to the effect of another rule.
+     */
+    Ignored = 'ignored',
+  }
+  export declare namespace State {
+    function isSatisfied(state: State): boolean;
   }
   export type RuleState =
     | {
@@ -45,6 +61,9 @@ declare global {
       }
     | {
         readonly state: State.Incomplete;
+      }
+    | {
+        readonly state: State.Ignored;
       };
   export interface GridState {
     final: State;
@@ -627,6 +646,7 @@ declare global {
     readonly underclued: CachedAccess<UndercluedRule | undefined>;
     /**
      * Create a new grid with tiles, connections, symbols and rules.
+     *
      * @param width The width of the grid.
      * @param height The height of the grid.
      * @param tiles The tiles of the grid.
@@ -644,6 +664,38 @@ declare global {
       symbols?: ReadonlyMap<string, readonly Symbol$1[]>,
       rules?: readonly Rule[]
     );
+    /**
+     * Create a new GridData object from a string array.
+     *
+     * - Use `b` for dark cells, `w` for light cells, and `n` for gray cells.
+     * - Capitalize the letter to make the tile fixed.
+     * - Use `.` to represent empty space.
+     *
+     * @param array - The string array to create the grid from.
+     * @returns The created grid.
+     */
+    static create(array: string[]): GridData;
+    /**
+     * Create a new grid with tiles, connections, symbols and rules. Sanitize the provided list of symbols and rules,
+     * and trigger grid change events.
+     *
+     * @param width The width of the grid.
+     * @param height The height of the grid.
+     * @param tiles The tiles of the grid.
+     * @param connections The connections of the grid, which determines which tiles are merged.
+     * @param zones The zones of the grid.
+     * @param symbols The symbols in the grid.
+     * @param rules The rules of the grid.
+     */
+    static create(
+      width: number,
+      height: number,
+      tiles?: readonly (readonly TileData[])[],
+      connections?: GridConnections,
+      zones?: GridZones,
+      symbols?: ReadonlyMap<string, readonly Symbol$1[]>,
+      rules?: readonly Rule[]
+    ): GridData;
     /**
      * Copy the current grid while modifying the provided properties.
      * @param param0 The properties to modify.
@@ -666,6 +718,30 @@ declare global {
       symbols?: ReadonlyMap<string, readonly Symbol$1[]>;
       rules?: readonly Rule[];
     }): GridData;
+    /**
+     * Copy the current grid while modifying the provided properties.
+     * Skip sanitization and event triggering for performance.
+     *
+     * @param param0 The properties to modify.
+     * @returns The new grid with the modified properties.
+     */
+    fastCopyWith({
+      width,
+      height,
+      tiles,
+      connections,
+      zones,
+      symbols,
+      rules,
+    }: {
+      width?: number;
+      height?: number;
+      tiles?: readonly (readonly TileData[])[];
+      connections?: GridConnections;
+      zones?: GridZones;
+      symbols?: ReadonlyMap<string, readonly Symbol$1[]>;
+      rules?: readonly Rule[];
+    }): GridData;
     isPositionValid(x: number, y: number): boolean;
     /**
      * Safely get the tile at the given position.
@@ -676,19 +752,19 @@ declare global {
     getTile(x: number, y: number): TileData;
     /**
      * Safely set the tile at the given position.
-     * If the position is invalid, the grid is returned unchanged.
+     * If the position is invalid, the tile array is returned unchanged.
      * If the tile is merged with other tiles, the colors of all connected tiles are changed.
      *
      * @param x The x-coordinate of the tile.
      * @param y The y-coordinate of the tile.
      * @param tile The new tile to set.
-     * @returns The new grid with the tile set at the given position.
+     * @returns The new tile array with updated tiles.
      */
     setTile(
       x: number,
       y: number,
       tile: TileData | ((tile: TileData) => TileData)
-    ): GridData;
+    ): readonly (readonly TileData[])[];
     /**
      * Replace or modify all tiles in the grid.
      *
@@ -841,17 +917,6 @@ declare global {
      * @returns The created tile array.
      */
     static createTiles(array: string[]): TileData[][];
-    /**
-     * Create a new GridData object from a string array.
-     *
-     * - Use `b` for dark cells, `w` for light cells, and `n` for gray cells.
-     * - Capitalize the letter to make the tile fixed.
-     * - Use `.` to represent empty space.
-     *
-     * @param array - The string array to create the grid from.
-     * @returns The created grid.
-     */
-    static create(array: string[]): GridData;
     /**
      * Find a tile in the grid that satisfies the predicate.
      *
@@ -1511,6 +1576,35 @@ declare global {
     }): this;
   }
   export declare const allRules: Map<string, Rule>;
+  export declare class LyingSymbolRule
+    extends Rule
+    implements FinalValidationHandler
+  {
+    readonly count: number;
+    private static readonly EXAMPLE_GRID;
+    private static readonly CONFIGS;
+    private static readonly SEARCH_VARIANTS;
+    /**
+     * **&lt;count&gt; symbols are lying and are incorrect**
+     *
+     * @param count Number of lying symbols
+     */
+    constructor(count: number);
+    get id(): string;
+    get explanation(): string;
+    get configs(): readonly AnyConfig[] | null;
+    createExampleGrid(): GridData;
+    get searchVariants(): SearchVariant[];
+    validateGrid(_: GridData): RuleState;
+    get isSingleton(): boolean;
+    onFinalValidation(
+      grid: GridData,
+      solution: GridData | null,
+      state: GridState
+    ): GridState;
+    copyWith({ count }: { count?: number }): this;
+    withCount(count: number): this;
+  }
   export declare class MysteryRule
     extends Rule
     implements FinalValidationHandler, GridChangeHandler, GridResizeHandler
@@ -1574,7 +1668,7 @@ declare global {
     get configs(): readonly AnyConfig[] | null;
     createExampleGrid(): GridData;
     get searchVariants(): SearchVariant[];
-    validateGrid(_grid: GridData): RuleState;
+    validateGrid(grid: GridData): RuleState;
     onSymbolValidation(
       grid: GridData,
       symbol: Symbol$1,
@@ -1863,6 +1957,9 @@ declare global {
     stringifyPuzzle(puzzle: Puzzle): string;
     parsePuzzle(input: string): Puzzle;
   }
+  export interface CancelRef {
+    cancel?: () => void;
+  }
   /**
    * Base class that all solvers must extend.
    */
@@ -1892,8 +1989,13 @@ declare global {
      *
      * @param grid The grid to solve. The provided grid is guaranteed to be supported by the solver. Some tiles in the
      * grid may already be filled by the user. It is up to the solver to decide whether to respect these tiles or not.
+     * @param cancelRef A reference to a function that can be called to cancel the solver. If cancellation is supported,
+     * the solver can assign a function to `cancelRef.cancel` that will stop the solver when called.
      */
-    abstract solve(grid: GridData): AsyncGenerator<GridData | null>;
+    abstract solve(
+      grid: GridData,
+      cancelRef: CancelRef
+    ): AsyncGenerator<GridData | null>;
     /**
      * Check if the solver supports the current browser environment. This method is called once when the user first clicks
      * the "Solve" button, and the result is cached for the duration of the editor session.
@@ -1924,12 +2026,19 @@ declare global {
     isGridSupported(grid: GridData): boolean;
   }
   export declare const allSolvers: Map<string, Solver>;
-  export declare class BacktrackSolver extends Solver {
+  export declare abstract class EventIteratingSolver extends Solver {
+    protected abstract createWorker(): Worker;
+    solve(
+      grid: GridData,
+      cancelRef: CancelRef
+    ): AsyncGenerator<GridData | null>;
+  }
+  export declare class BacktrackSolver extends EventIteratingSolver {
     private static readonly supportedInstrs;
     readonly id = 'backtrack';
     readonly description =
       'Solves puzzles using backtracking with optimizations (blazingly fast). Support most rules and symbols (including underclued).';
-    solve(grid: GridData): AsyncGenerator<GridData | null>;
+    protected createWorker(): Worker;
     isInstructionSupported(instructionId: string): boolean;
   }
   export declare enum BTTile {
@@ -2400,11 +2509,11 @@ declare global {
     constructor(instr: ViewpointSymbol);
     checkGlobal(grid: BTGridData): CheckResult | false;
   }
-  export declare class UndercluedSolver extends Solver {
-    readonly id = 'underclued';
+  export declare class UniversalSolver extends EventIteratingSolver {
+    readonly id = 'universal';
     readonly description =
-      'Solves every puzzle as if it were underclued. Supports all rules and symbols and is decently fast for small puzzles. Very slow for large puzzles.';
-    solve(grid: GridData): AsyncGenerator<GridData | null>;
+      'A backtracking solver that supports all rules and symbols (including underclued) but is less optimized.';
+    protected createWorker(): Worker;
     isInstructionSupported(instructionId: string): boolean;
   }
   export declare class Z3SolverContext<
@@ -2648,10 +2757,10 @@ declare global {
   }
   export declare const allSymbols: Map<string, Symbol$1>;
   export declare function aggregateState(
-    rules: RuleState[],
+    rules: readonly RuleState[],
     grid: GridData,
-    symbols: Map<string, State[]>
-  ): State;
+    symbols: ReadonlyMap<string, State[]>
+  ): State.Error | State.Satisfied | State.Incomplete;
   export declare function applyFinalOverrides(
     grid: GridData,
     solution: GridData | null,

package/dist/data/grid.d.ts

@@ -22,6 +22,7 @@ export default class GridData {
     readonly underclued: CachedAccess<UndercluedRule | undefined>;
     /**
      * Create a new grid with tiles, connections, symbols and rules.
+     *
      * @param width The width of the grid.
      * @param height The height of the grid.
      * @param tiles The tiles of the grid.
@@ -31,6 +32,30 @@ export default class GridData {
      * @param rules The rules of the grid.
      */
     constructor(width: number, height: number, tiles?: readonly (readonly TileData[])[], connections?: GridConnections, zones?: GridZones, symbols?: ReadonlyMap<string, readonly Symbol[]>, rules?: readonly Rule[]);
+    /**
+     * Create a new GridData object from a string array.
+     *
+     * - Use `b` for dark cells, `w` for light cells, and `n` for gray cells.
+     * - Capitalize the letter to make the tile fixed.
+     * - Use `.` to represent empty space.
+     *
+     * @param array - The string array to create the grid from.
+     * @returns The created grid.
+     */
+    static create(array: string[]): GridData;
+    /**
+     * Create a new grid with tiles, connections, symbols and rules. Sanitize the provided list of symbols and rules,
+     * and trigger grid change events.
+     *
+     * @param width The width of the grid.
+     * @param height The height of the grid.
+     * @param tiles The tiles of the grid.
+     * @param connections The connections of the grid, which determines which tiles are merged.
+     * @param zones The zones of the grid.
+     * @param symbols The symbols in the grid.
+     * @param rules The rules of the grid.
+     */
+    static create(width: number, height: number, tiles?: readonly (readonly TileData[])[], connections?: GridConnections, zones?: GridZones, symbols?: ReadonlyMap<string, readonly Symbol[]>, rules?: readonly Rule[]): GridData;
     /**
      * Copy the current grid while modifying the provided properties.
      * @param param0 The properties to modify.
@@ -45,6 +70,22 @@ export default class GridData {
         symbols?: ReadonlyMap<string, readonly Symbol[]>;
         rules?: readonly Rule[];
     }): GridData;
+    /**
+     * Copy the current grid while modifying the provided properties.
+     * Skip sanitization and event triggering for performance.
+     *
+     * @param param0 The properties to modify.
+     * @returns The new grid with the modified properties.
+     */
+    fastCopyWith({ width, height, tiles, connections, zones, symbols, rules, }: {
+        width?: number;
+        height?: number;
+        tiles?: readonly (readonly TileData[])[];
+        connections?: GridConnections;
+        zones?: GridZones;
+        symbols?: ReadonlyMap<string, readonly Symbol[]>;
+        rules?: readonly Rule[];
+    }): GridData;
     isPositionValid(x: number, y: number): boolean;
     /**
      * Safely get the tile at the given position.
@@ -55,15 +96,15 @@ export default class GridData {
     getTile(x: number, y: number): TileData;
     /**
      * Safely set the tile at the given position.
-     * If the position is invalid, the grid is returned unchanged.
+     * If the position is invalid, the tile array is returned unchanged.
      * If the tile is merged with other tiles, the colors of all connected tiles are changed.
      *
      * @param x The x-coordinate of the tile.
      * @param y The y-coordinate of the tile.
      * @param tile The new tile to set.
-     * @returns The new grid with the tile set at the given position.
+     * @returns The new tile array with updated tiles.
      */
-    setTile(x: number, y: number, tile: TileData | ((tile: TileData) => TileData)): GridData;
+    setTile(x: number, y: number, tile: TileData | ((tile: TileData) => TileData)): readonly (readonly TileData[])[];
     /**
      * Replace or modify all tiles in the grid.
      *
@@ -199,17 +240,6 @@ export default class GridData {
      * @returns The created tile array.
      */
     static createTiles(array: string[]): TileData[][];
-    /**
-     * Create a new GridData object from a string array.
-     *
-     * - Use `b` for dark cells, `w` for light cells, and `n` for gray cells.
-     * - Capitalize the letter to make the tile fixed.
-     * - Use `.` to represent empty space.
-     *
-     * @param array - The string array to create the grid from.
-     * @returns The created grid.
-     */
-    static create(array: string[]): GridData;
     /**
      * Find a tile in the grid that satisfies the predicate.
      *

package/dist/data/grid.js

@@ -16,6 +16,7 @@ export default class GridData {
     /* eslint-enable @typescript-eslint/no-unsafe-enum-comparison */
     /**
      * Create a new grid with tiles, connections, symbols and rules.
+     *
      * @param width The width of the grid.
      * @param height The height of the grid.
      * @param tiles The tiles of the grid.
@@ -92,25 +93,35 @@ export default class GridData {
         this.tiles = tiles ?? array(width, height, () => TileData.empty());
         this.connections = connections ?? new GridConnections();
         this.zones = zones ?? new GridZones();
-        const newSymbols = symbols
-            ? GridData.deduplicateSymbols(symbols)
-            : new Map();
-        // do not deduplicate all rules because it makes for bad editor experience
-        const newRules = rules ? GridData.deduplicateSingletonRules(rules) : [];
-        this.symbols = newSymbols;
-        this.rules = newRules;
-        newSymbols.forEach(list => {
-            list.forEach((sym, i) => {
-                if (handlesGridChange(sym)) {
-                    list[i] = sym.onGridChange(this);
+        this.symbols = symbols ?? new Map();
+        this.rules = rules ?? [];
+    }
+    static create(arrayOrWidth, height, tiles, connections, zones, symbols, rules) {
+        if (typeof arrayOrWidth === 'number') {
+            const newSymbols = symbols
+                ? GridData.deduplicateSymbols(symbols)
+                : new Map();
+            // do not deduplicate all rules because it makes for bad editor experience
+            const newRules = rules ? GridData.deduplicateSingletonRules(rules) : [];
+            const newGrid = new GridData(arrayOrWidth, height, tiles, connections, zones, newSymbols, newRules);
+            newSymbols.forEach(list => {
+                list.forEach((sym, i) => {
+                    if (handlesGridChange(sym)) {
+                        list[i] = sym.onGridChange(newGrid);
+                    }
+                });
+            });
+            newRules.forEach((rule, i) => {
+                if (handlesGridChange(rule)) {
+                    newRules[i] = rule.onGridChange(newGrid);
                 }
             });
-        });
-        newRules.forEach((rule, i) => {
-            if (handlesGridChange(rule)) {
-                newRules[i] = rule.onGridChange(this);
-            }
-        });
+            return newGrid;
+        }
+        else {
+            const tiles = GridData.createTiles(arrayOrWidth);
+            return GridData.create(tiles[0]?.length ?? 0, tiles.length, tiles);
+        }
     }
     /**
      * Copy the current grid while modifying the provided properties.
@@ -118,6 +129,16 @@ export default class GridData {
      * @returns The new grid with the modified properties.
      */
     copyWith({ width, height, tiles, connections, zones, symbols, rules, }) {
+        return GridData.create(width ?? this.width, height ?? this.height, tiles ?? this.tiles, connections ?? this.connections, zones ?? this.zones, symbols ?? this.symbols, rules ?? this.rules);
+    }
+    /**
+     * Copy the current grid while modifying the provided properties.
+     * Skip sanitization and event triggering for performance.
+     *
+     * @param param0 The properties to modify.
+     * @returns The new grid with the modified properties.
+     */
+    fastCopyWith({ width, height, tiles, connections, zones, symbols, rules, }) {
         return new GridData(width ?? this.width, height ?? this.height, tiles ?? this.tiles, connections ?? this.connections, zones ?? this.zones, symbols ?? this.symbols, rules ?? this.rules);
     }
     isPositionValid(x, y) {
@@ -136,17 +157,17 @@ export default class GridData {
     }
     /**
      * Safely set the tile at the given position.
-     * If the position is invalid, the grid is returned unchanged.
+     * If the position is invalid, the tile array is returned unchanged.
      * If the tile is merged with other tiles, the colors of all connected tiles are changed.
      *
      * @param x The x-coordinate of the tile.
      * @param y The y-coordinate of the tile.
      * @param tile The new tile to set.
-     * @returns The new grid with the tile set at the given position.
+     * @returns The new tile array with updated tiles.
      */
     setTile(x, y, tile) {
         if (x < 0 || x >= this.width || y < 0 || y >= this.height) {
-            return this;
+            return this.tiles;
         }
         const changing = this.connections.getConnectedTiles({ x, y });
         const tiles = this.tiles.map(row => [...row]);
@@ -155,7 +176,7 @@ export default class GridData {
             tiles[y][x] = tiles[y][x].withColor(newTile.color);
         });
         tiles[y][x] = newTile;
-        return this.copyWith({ tiles });
+        return tiles;
     }
     /**
      * Replace or modify all tiles in the grid.
@@ -542,20 +563,6 @@ export default class GridData {
             return TileData.create(row.charAt(x));
         }));
     }
-    /**
-     * Create a new GridData object from a string array.
-     *
-     * - Use `b` for dark cells, `w` for light cells, and `n` for gray cells.
-     * - Capitalize the letter to make the tile fixed.
-     * - Use `.` to represent empty space.
-     *
-     * @param array - The string array to create the grid from.
-     * @returns The created grid.
-     */
-    static create(array) {
-        const tiles = GridData.createTiles(array);
-        return new GridData(tiles[0]?.length ?? 0, tiles.length, tiles);
-    }
     /**
      * Find a tile in the grid that satisfies the predicate.
      *
@@ -795,7 +802,7 @@ export default class GridData {
             if (newSymbolList.length > 0)
                 symbols.set(id, newSymbolList);
         }
-        return new GridData(width, height, newTiles, connections, zones, symbols, this.rules);
+        return GridData.create(width, height, newTiles, connections, zones, symbols, this.rules);
     }
     pasteTiles(origin, grid) {
         if (!(grid instanceof GridData))

package/dist/data/primitives.d.ts

@@ -17,9 +17,25 @@ export declare enum MajorRule {
     Underclued = "underclued"
 }
 export declare enum State {
+    /**
+     * Describes the violation of a rule.
+     */
     Error = "error",
+    /**
+     * Describes that a rule is satisfied and complete in the current grid.
+     */
     Satisfied = "satisfied",
-    Incomplete = "incomplete"
+    /**
+     * Describes that a rule is not violated, but is not yet complete in the current grid.
+     */
+    Incomplete = "incomplete",
+    /**
+     * Describes that a rule is violated but ignored due to the effect of another rule.
+     */
+    Ignored = "ignored"
+}
+export declare namespace State {
+    function isSatisfied(state: State): boolean;
 }
 export type RuleState = {
     readonly state: State.Error;
@@ -28,6 +44,8 @@ export type RuleState = {
     readonly state: State.Satisfied;
 } | {
     readonly state: State.Incomplete;
+} | {
+    readonly state: State.Ignored;
 };
 export interface GridState {
     final: State;

package/dist/data/primitives.js

@@ -9,9 +9,29 @@ export var MajorRule;
 })(MajorRule || (MajorRule = {}));
 export var State;
 (function (State) {
+    /**
+     * Describes the violation of a rule.
+     */
     State["Error"] = "error";
+    /**
+     * Describes that a rule is satisfied and complete in the current grid.
+     */
     State["Satisfied"] = "satisfied";
+    /**
+     * Describes that a rule is not violated, but is not yet complete in the current grid.
+     */
     State["Incomplete"] = "incomplete";
+    /**
+     * Describes that a rule is violated but ignored due to the effect of another rule.
+     */
+    State["Ignored"] = "ignored";
+})(State || (State = {}));
+// eslint-disable-next-line @typescript-eslint/no-namespace
+(function (State) {
+    function isSatisfied(state) {
+        return state === State.Satisfied || state === State.Ignored;
+    }
+    State.isSatisfied = isSatisfied;
 })(State || (State = {}));
 export var Color;
 (function (Color) {

package/dist/data/rules/banPatternRule.js

@@ -64,7 +64,7 @@ class BanPatternRule extends Rule {
                 return tile;
             return tile.withExists(false);
         });
-        return new GridData(width, height, tiles);
+        return GridData.create(width, height, tiles);
     }
     get searchVariants() {
         return BanPatternRule.SEARCH_VARIANTS;

package/dist/data/rules/customRule.js

@@ -57,7 +57,7 @@ Object.defineProperty(CustomRule, "EXAMPLE_GRID", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: Object.freeze(new GridData(5, 4))
+    value: Object.freeze(GridData.create(5, 4))
 });
 Object.defineProperty(CustomRule, "configs", {
     enumerable: true,

package/dist/data/rules/lyingSymbolRule.d.ts

@@ -0,0 +1,30 @@
+import { AnyConfig } from '../config.js';
+import { FinalValidationHandler } from '../events/onFinalValidation.js';
+import GridData from '../grid.js';
+import { GridState, RuleState } from '../primitives.js';
+import Rule, { SearchVariant } from './rule.js';
+export default class LyingSymbolRule extends Rule implements FinalValidationHandler {
+    readonly count: number;
+    private static readonly EXAMPLE_GRID;
+    private static readonly CONFIGS;
+    private static readonly SEARCH_VARIANTS;
+    /**
+     * **<count> symbols are lying and are incorrect**
+     *
+     * @param count Number of lying symbols
+     */
+    constructor(count: number);
+    get id(): string;
+    get explanation(): string;
+    get configs(): readonly AnyConfig[] | null;
+    createExampleGrid(): GridData;
+    get searchVariants(): SearchVariant[];
+    validateGrid(_: GridData): RuleState;
+    get isSingleton(): boolean;
+    onFinalValidation(grid: GridData, solution: GridData | null, state: GridState): GridState;
+    copyWith({ count }: {
+        count?: number;
+    }): this;
+    withCount(count: number): this;
+}
+export declare const instance: LyingSymbolRule;