@logic-pad/core 0.4.2 → 0.4.5

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

@@ -111,6 +111,7 @@ declare global {
   export declare enum Mode {
     Create = 'create',
     Solve = 'solve',
+    Perfection = 'perfection',
   }
   export declare class GridZones {
     readonly edges: readonly Edge[];
@@ -320,6 +321,10 @@ declare global {
     get validateWithSolution(): boolean;
     get necessaryForCompletion(): boolean;
     get visibleWhenSolving(): boolean;
+    /**
+     * Return a variant of this instruction that is suitable for the given mode.
+     */
+    abstract modeVariant(mode: Mode): Instruction | null;
     /**
      * Check if this instruction is equal to another instruction by comparing their IDs and configs.
      *
@@ -336,6 +341,7 @@ declare global {
     abstract validateGrid(grid: GridData): RuleState;
     abstract get searchVariants(): SearchVariant[];
     searchVariant(): SearchVariant;
+    modeVariant(_mode: Mode): Rule | null;
     /**
      * Whether only one instance of this rule is allowed in a grid.
      */
@@ -362,7 +368,8 @@ declare global {
     readonly x: number;
     readonly y: number;
     constructor(x: number, y: number);
-    abstract validateSymbol(grid: GridData): State;
+    abstract validateSymbol(grid: GridData, solution: GridData | null): State;
+    modeVariant(_mode: Mode): Symbol$1 | null;
     onGridResize(
       _grid: GridData,
       mode: 'insert' | 'remove',
@@ -426,6 +433,11 @@ declare global {
   export declare function handlesSetGrid<T extends Instruction>(
     val: T
   ): val is T & SetGridHandler;
+  export declare function invokeSetGrid(
+    oldGrid: GridData,
+    newGrid: GridData,
+    solution: GridData | null
+  ): GridData;
   export declare class Row extends Configurable {
     /**
      * The note to play at this row, or null to keep the current note from the previous control line.
@@ -509,6 +521,7 @@ declare global {
   {
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
+    readonly normalizeVelocity: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -516,8 +529,13 @@ declare global {
      * **Music Grid: Listen to the solution**
      * @param controlLines Denote changes in the playback settings. At least one control line at column 0 should be present to enable playback.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines: readonly ControlLine[], track: GridData | null);
+    constructor(
+      controlLines: readonly ControlLine[],
+      track: GridData | null,
+      normalizeVelocity?: boolean
+    );
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -546,9 +564,11 @@ declare global {
     copyWith({
       controlLines,
       track,
+      normalizeVelocity,
     }: {
       controlLines?: readonly ControlLine[];
       track?: GridData | null;
+      normalizeVelocity?: boolean;
     }): this;
     get validateWithSolution(): boolean;
     get isSingleton(): boolean;
@@ -980,14 +1000,6 @@ declare global {
      * @returns True if the grids are equal in size and tile colors, false otherwise.
      */
     colorEquals(grid: GridData): boolean;
-    /**
-     * Check if this grid conforms to the given solution, or an incomplete version of the solution.
-     * Symbols and rules are not validated.
-     *
-     * @param solution The solution to compare with.
-     * @returns True if the grid conforms to the solution, false otherwise.
-     */
-    solutionMatches(solution: GridData): boolean;
     /**
      * Check if this grid is equal to another grid in terms of size, tile colors, connections, symbols, and rules.
      *
@@ -1190,12 +1202,14 @@ declare global {
      * Controls whether a symbol should be visible in the grid.
      *
      * @param grid The grid that is being displayed.
+     * @param solution The solution grid, if it is available.
      * @param symbol The symbol that is being displayed.
      * @param editing Whether the grid is being edited.
      * @returns True if the symbol should be displayed, false otherwise. The symbol will not be displayed if any handler returns false.
      */
     onSymbolDisplay(
       grid: GridData,
+      solution: GridData | null,
       symbol: Symbol$1,
       editing: boolean
     ): boolean;
@@ -1368,7 +1382,7 @@ declare global {
     private static readonly EXAMPLE_GRID_GRAY;
     private static readonly SEARCH_VARIANTS;
     /**
-     * **Every zone has the same number of &lt;color&gt; cells.**
+     * **Zones of the same size have the same number of &lt;color&gt; cells.**
      *
      * @param color - The color of the cells to count.
      */
@@ -1483,6 +1497,7 @@ declare global {
     validateGrid(_grid: GridData): RuleState;
     get necessaryForCompletion(): boolean;
     get isSingleton(): boolean;
+    modeVariant(mode: Mode): Rule | null;
     copyWith({
       count,
       regenInterval,
@@ -1573,12 +1588,15 @@ declare global {
     extends Rule
     implements SetGridHandler, FinalValidationHandler
   {
+    readonly editor: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**
      * **Quest for Perfection: cell colors are final**
+     *
+     * @param editor - whether to enable editor mode. This field is automatically set by the editor.
      */
-    constructor();
+    constructor(editor?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -1586,6 +1604,7 @@ declare global {
     get searchVariants(): SearchVariant[];
     get necessaryForCompletion(): boolean;
     get isSingleton(): boolean;
+    modeVariant(mode: Mode): Rule | null;
     validateGrid(grid: GridData): RuleState;
     /**
      * If the grid passes validation but is different from the solution, indicate the error in the final state.
@@ -1596,6 +1615,8 @@ declare global {
       state: GridState
     ): GridState;
     private fixTiles;
+    private isValid;
+    private findSingleError;
     /**
      * Force all tiles to be fixed.
      *
@@ -1606,7 +1627,7 @@ declare global {
       newGrid: GridData,
       solution: GridData | null
     ): GridData;
-    copyWith(_: object): this;
+    copyWith({ editor }: { editor?: boolean }): this;
   }
   export declare class RegionAreaRule extends Rule {
     readonly color: Color;
@@ -6017,7 +6038,6 @@ declare global {
   {
     readonly x: number;
     readonly y: number;
-    readonly color: Color;
     readonly revealLocation: boolean;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
@@ -6026,10 +6046,9 @@ declare global {
      *
      * @param x - The x-coordinate of the symbol.
      * @param y - The y-coordinate of the symbol.
-     * @param color - The target color of the cell.
      * @param revealLocation - Whether to reveal the location of the symbol.
      */
-    constructor(x: number, y: number, color: Color, revealLocation?: boolean);
+    constructor(x: number, y: number, revealLocation?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -6037,24 +6056,22 @@ declare global {
     get necessaryForCompletion(): boolean;
     get visibleWhenSolving(): boolean;
     get sortOrder(): number;
-    validateSymbol(grid: GridData): State;
+    validateSymbol(grid: GridData, solution: GridData | null): State;
     onSymbolDisplay(
       grid: GridData,
+      solution: GridData | null,
       symbol: Symbol$1,
       editing: boolean
     ): boolean;
     copyWith({
       x,
       y,
-      color,
       revealLocation,
     }: {
       x?: number;
       y?: number;
-      color?: Color;
       revealLocation?: boolean;
     }): this;
-    withColor(color: Color): this;
     withRevealLocation(revealLocation: boolean): this;
   }
   export declare const allSymbols: Map<string, Symbol$1>;

package/dist/data/events/onSetGrid.d.ts

@@ -4,3 +4,4 @@ export interface SetGridHandler {
     onSetGrid(oldGrid: GridData, newGrid: GridData, solution: GridData | null): GridData;
 }
 export declare function handlesSetGrid<T extends Instruction>(val: T): val is T & SetGridHandler;
+export declare function invokeSetGrid(oldGrid: GridData, newGrid: GridData, solution: GridData | null): GridData;

package/dist/data/events/onSetGrid.js

@@ -2,3 +2,18 @@ import { isEventHandler } from './eventHelper.js';
 export function handlesSetGrid(val) {
     return isEventHandler(val, 'onSetGrid');
 }
+export function invokeSetGrid(oldGrid, newGrid, solution) {
+    newGrid.symbols.forEach(list => {
+        list.forEach(symbol => {
+            if (handlesSetGrid(symbol)) {
+                newGrid = symbol.onSetGrid(oldGrid, newGrid, solution);
+            }
+        });
+    });
+    newGrid.rules.forEach(rule => {
+        if (handlesSetGrid(rule)) {
+            newGrid = rule.onSetGrid(oldGrid, newGrid, solution);
+        }
+    });
+    return newGrid;
+}

package/dist/data/events/onSymbolDisplay.d.ts

@@ -6,10 +6,11 @@ export interface SymbolDisplayHandler {
      * Controls whether a symbol should be visible in the grid.
      *
      * @param grid The grid that is being displayed.
+     * @param solution The solution grid, if it is available.
      * @param symbol The symbol that is being displayed.
      * @param editing Whether the grid is being edited.
      * @returns True if the symbol should be displayed, false otherwise. The symbol will not be displayed if any handler returns false.
      */
-    onSymbolDisplay(grid: GridData, symbol: Symbol, editing: boolean): boolean;
+    onSymbolDisplay(grid: GridData, solution: GridData | null, symbol: Symbol, editing: boolean): boolean;
 }
 export declare function handlesSymbolDisplay<T extends Instruction>(val: T): val is T & SymbolDisplayHandler;

package/dist/data/grid.d.ts

@@ -332,14 +332,6 @@ export default class GridData {
      * @returns True if the grids are equal in size and tile colors, false otherwise.
      */
     colorEquals(grid: GridData): boolean;
-    /**
-     * Check if this grid conforms to the given solution, or an incomplete version of the solution.
-     * Symbols and rules are not validated.
-     *
-     * @param solution The solution to compare with.
-     * @returns True if the grid conforms to the solution, false otherwise.
-     */
-    solutionMatches(solution: GridData): boolean;
     /**
      * Check if this grid is equal to another grid in terms of size, tile colors, connections, symbols, and rules.
      *

package/dist/data/grid.js

@@ -855,29 +855,6 @@ export default class GridData {
             this.tiles.every((row, y) => row.every((tile, x) => (!tile.exists && !grid.getTile(x, y).exists) ||
                 tile.color === grid.getTile(x, y).color)));
     }
-    /**
-     * Check if this grid conforms to the given solution, or an incomplete version of the solution.
-     * Symbols and rules are not validated.
-     *
-     * @param solution The solution to compare with.
-     * @returns True if the grid conforms to the solution, false otherwise.
-     */
-    solutionMatches(solution) {
-        if (this.width !== solution.width)
-            return false;
-        if (this.height !== solution.height)
-            return false;
-        return this.tiles.every((row, y) => row.every((tile, x) => {
-            const solutionTile = solution.getTile(x, y);
-            if (!solutionTile.exists)
-                return true;
-            if (tile.color === Color.Gray)
-                return true;
-            if (solutionTile.color !== tile.color)
-                return false;
-            return true;
-        }));
-    }
     /**
      * Check if this grid is equal to another grid in terms of size, tile colors, connections, symbols, and rules.
      *

package/dist/data/instruction.d.ts

@@ -1,5 +1,6 @@
 import Configurable from './configurable.js';
 import GridData from './grid.js';
+import { Mode } from './primitives.js';
 export default abstract class Instruction extends Configurable {
     abstract get id(): string;
     abstract get explanation(): string;
@@ -10,6 +11,10 @@ export default abstract class Instruction extends Configurable {
     get validateWithSolution(): boolean;
     get necessaryForCompletion(): boolean;
     get visibleWhenSolving(): boolean;
+    /**
+     * Return a variant of this instruction that is suitable for the given mode.
+     */
+    abstract modeVariant(mode: Mode): Instruction | null;
     /**
      * Check if this instruction is equal to another instruction by comparing their IDs and configs.
      *

package/dist/data/primitives.d.ts

@@ -89,5 +89,6 @@ export declare function orientationToggle(...orientations: readonly Orientation[
 };
 export declare enum Mode {
     Create = "create",
-    Solve = "solve"
+    Solve = "solve",
+    Perfection = "perfection"
 }

package/dist/data/primitives.js

@@ -96,4 +96,5 @@ export var Mode;
 (function (Mode) {
     Mode["Create"] = "create";
     Mode["Solve"] = "solve";
+    Mode["Perfection"] = "perfection";
 })(Mode || (Mode = {}));

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

@@ -10,7 +10,7 @@ export default class CellCountPerZoneRule extends Rule {
     private static readonly EXAMPLE_GRID_GRAY;
     private static readonly SEARCH_VARIANTS;
     /**
-     * **Every zone has the same number of <color> cells.**
+     * **Zones of the same size have the same number of <color> cells.**
      *
      * @param color - The color of the cells to count.
      */

package/dist/data/rules/cellCountPerZoneRule.js

@@ -6,7 +6,7 @@ import { Color, State } from '../primitives.js';
 import Rule from './rule.js';
 class CellCountPerZoneRule extends Rule {
     /**
-     * **Every zone has the same number of <color> cells.**
+     * **Zones of the same size have the same number of <color> cells.**
      *
      * @param color - The color of the cells to count.
      */
@@ -24,7 +24,7 @@ class CellCountPerZoneRule extends Rule {
         return `zone_cell_count`;
     }
     get explanation() {
-        return `Every zone has the same number of ${this.color} cells`;
+        return `Zones of the same size have the same number of ${this.color} cells`;
     }
     get configs() {
         return CellCountPerZoneRule.CONFIGS;
@@ -91,6 +91,7 @@ class CellCountPerZoneRule extends Rule {
         }
         else {
             const errorZone = zones.find(z => zones.some(zz => zz !== z &&
+                zz.positions.length === z.positions.length &&
                 (zz.completed > z.completed + z.possible ||
                     zz.completed + zz.possible < z.completed)));
             if (errorZone) {
@@ -137,6 +138,10 @@ Object.defineProperty(CellCountPerZoneRule, "EXAMPLE_GRID_LIGHT", {
         { x1: 2, y1: 1, x2: 2, y2: 2 },
         { x1: 3, y1: 1, x2: 3, y2: 2 },
         { x1: 4, y1: 1, x2: 4, y2: 2 },
+        { x1: 1, y1: 0, x2: 2, y2: 0 },
+        { x1: 1, y1: 1, x2: 2, y2: 1 },
+        { x1: 2, y1: 2, x2: 3, y2: 2 },
+        { x1: 2, y1: 3, x2: 3, y2: 3 },
     ]))
         .addRule(new CellCountPerZoneRule(Color.Light)))
 });

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

@@ -1,6 +1,6 @@
 import { AnyConfig } from '../config.js';
 import GridData from '../grid.js';
-import { RuleState, Position } from '../primitives.js';
+import { RuleState, Position, Mode } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class ForesightRule extends Rule {
     readonly count: number;
@@ -23,6 +23,7 @@ export default class ForesightRule extends Rule {
     validateGrid(_grid: GridData): RuleState;
     get necessaryForCompletion(): boolean;
     get isSingleton(): boolean;
+    modeVariant(mode: Mode): Rule | null;
     copyWith({ count, regenInterval, startFull, solvePath, }: {
         count?: number;
         regenInterval?: number;

package/dist/data/rules/foresightRule.js

@@ -1,6 +1,6 @@
 import { ConfigType } from '../config.js';
 import GridData from '../grid.js';
-import { State } from '../primitives.js';
+import { State, Mode } from '../primitives.js';
 import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import Rule from './rule.js';
 class ForesightRule extends Rule {
@@ -65,6 +65,13 @@ class ForesightRule extends Rule {
     get isSingleton() {
         return true;
     }
+    modeVariant(mode) {
+        // foresight is disabled in perfection mode
+        if (mode === Mode.Perfection) {
+            return null;
+        }
+        return this;
+    }
     copyWith({ count, regenInterval, startFull, solvePath, }) {
         return new ForesightRule(count ?? this.count, regenInterval ?? this.regenInterval, startFull ?? this.startFull, solvePath ?? this.solvePath);
     }

package/dist/data/rules/musicControlLine.js

@@ -49,7 +49,7 @@ Object.defineProperty(Row, "CONFIGS", {
         },
         {
             type: ConfigType.NullableNumber,
-            default: 0.6,
+            default: 0.5,
             min: 0,
             max: 1,
             step: 0.2,

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

@@ -9,6 +9,7 @@ import Rule, { SearchVariant } from './rule.js';
 export default class MusicGridRule extends Rule implements GridChangeHandler, SetGridHandler, GridResizeHandler {
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
+    readonly normalizeVelocity: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -16,8 +17,9 @@ export default class MusicGridRule extends Rule implements GridChangeHandler, Se
      * **Music Grid: Listen to the solution**
      * @param controlLines Denote changes in the playback settings. At least one control line at column 0 should be present to enable playback.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines: readonly ControlLine[], track: GridData | null);
+    constructor(controlLines: readonly ControlLine[], track: GridData | null, normalizeVelocity?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -34,9 +36,10 @@ export default class MusicGridRule extends Rule implements GridChangeHandler, Se
      */
     setControlLine(controlLine: ControlLine): this;
     withTrack(track: GridData | null): this;
-    copyWith({ controlLines, track, }: {
+    copyWith({ controlLines, track, normalizeVelocity, }: {
         controlLines?: readonly ControlLine[];
         track?: GridData | null;
+        normalizeVelocity?: boolean;
     }): this;
     get validateWithSolution(): boolean;
     get isSingleton(): boolean;

package/dist/data/rules/musicGridRule.js

@@ -6,22 +6,23 @@ import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import { ControlLine, Row } from './musicControlLine.js';
 import Rule from './rule.js';
 const DEFAULT_SCALLE = [
-    new Row('C5', 0.6),
-    new Row('B4', 0.6),
-    new Row('A4', 0.6),
-    new Row('G4', 0.6),
-    new Row('F4', 0.6),
-    new Row('E4', 0.6),
-    new Row('D4', 0.6),
-    new Row('C4', 0.6),
+    new Row('C5', null),
+    new Row('B4', null),
+    new Row('A4', null),
+    new Row('G4', null),
+    new Row('F4', null),
+    new Row('E4', null),
+    new Row('D4', null),
+    new Row('C4', null),
 ];
 class MusicGridRule extends Rule {
     /**
      * **Music Grid: Listen to the solution**
      * @param controlLines Denote changes in the playback settings. At least one control line at column 0 should be present to enable playback.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines, track) {
+    constructor(controlLines, track, normalizeVelocity = true) {
         super();
         Object.defineProperty(this, "controlLines", {
             enumerable: true,
@@ -35,8 +36,15 @@ class MusicGridRule extends Rule {
             writable: true,
             value: track
         });
+        Object.defineProperty(this, "normalizeVelocity", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: normalizeVelocity
+        });
         this.controlLines = MusicGridRule.deduplicateControlLines(controlLines);
         this.track = track;
+        this.normalizeVelocity = normalizeVelocity;
     }
     get id() {
         return MajorRule.MusicGrid;
@@ -134,8 +142,8 @@ class MusicGridRule extends Rule {
     withTrack(track) {
         return this.copyWith({ track });
     }
-    copyWith({ controlLines, track, }) {
-        return new MusicGridRule(controlLines ?? this.controlLines, track !== undefined ? track : this.track);
+    copyWith({ controlLines, track, normalizeVelocity, }) {
+        return new MusicGridRule(controlLines ?? this.controlLines, track !== undefined ? track : this.track, normalizeVelocity ?? this.normalizeVelocity);
     }
     get validateWithSolution() {
         return true;
@@ -197,6 +205,13 @@ Object.defineProperty(MusicGridRule, "CONFIGS", {
             description: 'Track',
             configurable: true,
         },
+        {
+            type: ConfigType.Boolean,
+            default: true,
+            field: 'normalizeVelocity',
+            description: 'Normalize Velocity',
+            configurable: true,
+        },
     ])
 });
 Object.defineProperty(MusicGridRule, "SEARCH_VARIANTS", {

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

@@ -1,16 +1,19 @@
 import { AnyConfig } from '../config.js';
 import GridData from '../grid.js';
-import { GridState, RuleState } from '../primitives.js';
+import { GridState, RuleState, Mode } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 import { SetGridHandler } from '../events/onSetGrid.js';
 import { FinalValidationHandler } from '../events/onFinalValidation.js';
 export default class PerfectionRule extends Rule implements SetGridHandler, FinalValidationHandler {
+    readonly editor: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**
      * **Quest for Perfection: cell colors are final**
+     *
+     * @param editor - whether to enable editor mode. This field is automatically set by the editor.
      */
-    constructor();
+    constructor(editor?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -18,18 +21,23 @@ export default class PerfectionRule extends Rule implements SetGridHandler, Fina
     get searchVariants(): SearchVariant[];
     get necessaryForCompletion(): boolean;
     get isSingleton(): boolean;
+    modeVariant(mode: Mode): Rule | null;
     validateGrid(grid: GridData): RuleState;
     /**
      * If the grid passes validation but is different from the solution, indicate the error in the final state.
      */
     onFinalValidation(grid: GridData, solution: GridData | null, state: GridState): GridState;
     private fixTiles;
+    private isValid;
+    private findSingleError;
     /**
      * Force all tiles to be fixed.
      *
      * If the grid is already wrong, prevent the player from changing it further.
      */
     onSetGrid(oldGrid: GridData, newGrid: GridData, solution: GridData | null): GridData;
-    copyWith(_: object): this;
+    copyWith({ editor }: {
+        editor?: boolean;
+    }): this;
 }
 export declare const instance: PerfectionRule;