@logic-pad/core 0.1.6 → 0.2.0

package/dist/data/dataHelper.d.ts

@@ -75,3 +75,11 @@ export declare function escape(text: string, escapeCharacters?: string): string;
  * @returns The unescaped text.
  */
 export declare function unescape(text: string, escapeCharacters?: string): string;
+export declare class CachedAccess<T> {
+    private readonly getter;
+    private static readonly UNCACHED;
+    private cache;
+    private constructor();
+    static of<T>(getter: () => T): CachedAccess<T>;
+    get value(): T;
+}

package/dist/data/dataHelper.js

@@ -188,3 +188,34 @@ export function unescape(text, escapeCharacters = '=,:|') {
     }
     return result + text.substring(index);
 }
+export class CachedAccess {
+    constructor(getter) {
+        Object.defineProperty(this, "getter", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: getter
+        });
+        Object.defineProperty(this, "cache", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: CachedAccess.UNCACHED
+        });
+    }
+    static of(getter) {
+        return new CachedAccess(getter);
+    }
+    get value() {
+        if (this.cache === CachedAccess.UNCACHED) {
+            this.cache = this.getter();
+        }
+        return this.cache;
+    }
+}
+Object.defineProperty(CachedAccess, "UNCACHED", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Symbol('uncached')
+});

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

@@ -0,0 +1,15 @@
+import GridData from '../grid.js';
+import Instruction from '../instruction.js';
+import Symbol from '../symbols/symbol.js';
+export interface SymbolDisplayHandler {
+    /**
+     * Controls whether a symbol should be visible in the grid.
+     *
+     * @param grid The grid that is being displayed.
+     * @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;
+}
+export declare function handlesSymbolDisplay<T extends Instruction>(val: T): val is T & SymbolDisplayHandler;

package/dist/data/events/onSymbolDisplay.js

@@ -0,0 +1,4 @@
+import { isEventHandler } from './eventHelper.js';
+export function handlesSymbolDisplay(val) {
+    return isEventHandler(val, 'onSymbolDisplay');
+}

package/dist/data/grid.d.ts

@@ -1,8 +1,12 @@
 import GridConnections from './gridConnections.js';
+import { CachedAccess } from './dataHelper.js';
 import { Color, Direction, Orientation, Position } from './primitives.js';
 import Rule from './rules/rule.js';
 import Symbol from './symbols/symbol.js';
 import TileData from './tile.js';
+import MusicGridRule from './rules/musicGridRule.js';
+import CompletePatternRule from './rules/completePatternRule.js';
+import UndercluedRule from './rules/undercluedRule.js';
 export default class GridData {
     readonly width: number;
     readonly height: number;
@@ -10,6 +14,9 @@ export default class GridData {
     readonly connections: GridConnections;
     readonly symbols: ReadonlyMap<string, readonly Symbol[]>;
     readonly rules: readonly Rule[];
+    readonly musicGrid: CachedAccess<MusicGridRule | undefined>;
+    readonly completePattern: CachedAccess<CompletePatternRule | undefined>;
+    readonly underclued: CachedAccess<UndercluedRule | undefined>;
     /**
      * Create a new grid with tiles, connections, symbols and rules.
      * @param width The width of the grid.

package/dist/data/grid.js

@@ -2,8 +2,8 @@ import { handlesGridChange } from './events/onGridChange.js';
 import { handlesGridResize } from './events/onGridResize.js';
 import { handlesSetGrid } from './events/onSetGrid.js';
 import GridConnections from './gridConnections.js';
-import { array, move } from './dataHelper.js';
-import { Color } from './primitives.js';
+import { CachedAccess, array, move } from './dataHelper.js';
+import { Color, MajorRule, } from './primitives.js';
 import TileData from './tile.js';
 const NEIGHBOR_OFFSETS = [
     { x: -1, y: 0 },
@@ -12,6 +12,7 @@ const NEIGHBOR_OFFSETS = [
     { x: 0, y: 1 },
 ];
 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.
@@ -58,6 +59,26 @@ export default class GridData {
             writable: true,
             value: void 0
         });
+        // Important rules are cached for quick access
+        /* eslint-disable @typescript-eslint/no-unsafe-enum-comparison */
+        Object.defineProperty(this, "musicGrid", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: CachedAccess.of(() => this.findRule(rule => rule.id === MajorRule.MusicGrid))
+        });
+        Object.defineProperty(this, "completePattern", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: CachedAccess.of(() => this.findRule(rule => rule.id === MajorRule.CompletePattern))
+        });
+        Object.defineProperty(this, "underclued", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: CachedAccess.of(() => this.findRule(rule => rule.id === MajorRule.Underclued))
+        });
         this.width = width;
         this.height = height;
         this.tiles = tiles ?? array(width, height, () => TileData.empty());

package/dist/data/instruction.d.ts

@@ -9,6 +9,7 @@ export default abstract class Instruction extends Configurable {
      */
     get validateWithSolution(): boolean;
     get necessaryForCompletion(): boolean;
+    get visibleWhenSolving(): boolean;
     /**
      * Check if this instruction is equal to another instruction by comparing their IDs and configs.
      *

package/dist/data/instruction.js

@@ -9,6 +9,9 @@ export default class Instruction extends Configurable {
     get necessaryForCompletion() {
         return true;
     }
+    get visibleWhenSolving() {
+        return true;
+    }
     /**
      * Check if this instruction is equal to another instruction by comparing their IDs and configs.
      *

package/dist/data/primitives.d.ts

@@ -8,6 +8,14 @@ export interface Edge {
     readonly x2: number;
     readonly y2: number;
 }
+/**
+ * Major rules are frequently referenced in grids to provide additional UI.
+ */
+export declare enum MajorRule {
+    MusicGrid = "music",
+    CompletePattern = "complete_pattern",
+    Underclued = "underclued"
+}
 export declare enum State {
     Error = "error",
     Satisfied = "satisfied",

package/dist/data/primitives.js

@@ -1,3 +1,12 @@
+/**
+ * Major rules are frequently referenced in grids to provide additional UI.
+ */
+export var MajorRule;
+(function (MajorRule) {
+    MajorRule["MusicGrid"] = "music";
+    MajorRule["CompletePattern"] = "complete_pattern";
+    MajorRule["Underclued"] = "underclued";
+})(MajorRule || (MajorRule = {}));
 export var State;
 (function (State) {
     State["Error"] = "error";

package/dist/data/rules/completePatternRule.js

@@ -1,5 +1,5 @@
 import GridData from '../grid.js';
-import { State } from '../primitives.js';
+import { MajorRule, State } from '../primitives.js';
 import Rule from './rule.js';
 class CompletePatternRule extends Rule {
     /**
@@ -11,7 +11,7 @@ class CompletePatternRule extends Rule {
         super();
     }
     get id() {
-        return `complete_pattern`;
+        return MajorRule.CompletePattern;
     }
     get explanation() {
         return `Complete the pattern`;

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

@@ -21,6 +21,7 @@ export default class ForesightRule extends Rule {
     get searchVariants(): SearchVariant[];
     validateGrid(_grid: GridData): RuleState;
     get necessaryForCompletion(): boolean;
+    get isSingleton(): boolean;
     copyWith({ count, regenInterval, startFull, }: {
         count?: number;
         regenInterval?: number;

package/dist/data/rules/foresightRule.js

@@ -55,6 +55,9 @@ class ForesightRule extends Rule {
     get necessaryForCompletion() {
         return false;
     }
+    get isSingleton() {
+        return true;
+    }
     copyWith({ count, regenInterval, startFull, }) {
         return new ForesightRule(count ?? this.count, regenInterval ?? this.regenInterval, startFull ?? this.startFull);
     }

package/dist/data/rules/musicGridRule.js

@@ -1,7 +1,7 @@
 import { ConfigType } from '../config.js';
 import GridData from '../grid.js';
 import { resize } from '../dataHelper.js';
-import { Color, State } from '../primitives.js';
+import { Color, MajorRule, State } from '../primitives.js';
 import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import { ControlLine, Row } from './musicControlLine.js';
 import Rule from './rule.js';
@@ -39,7 +39,7 @@ class MusicGridRule extends Rule {
         this.track = track;
     }
     get id() {
-        return `music`;
+        return MajorRule.MusicGrid;
     }
     get explanation() {
         return `*Music Grid:* Listen to the solution`;

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

@@ -22,6 +22,7 @@ export default class OffByXRule extends Rule implements SymbolValidationHandler
     get searchVariants(): SearchVariant[];
     validateGrid(_grid: GridData): RuleState;
     onSymbolValidation(grid: GridData, symbol: Symbol, _validator: (grid: GridData) => State): State | undefined;
+    get isSingleton(): boolean;
     copyWith({ number }: {
         number?: number;
     }): this;

package/dist/data/rules/offByXRule.js

@@ -63,6 +63,9 @@ class OffByXRule extends Rule {
             return undefined;
         }
     }
+    get isSingleton() {
+        return true;
+    }
     copyWith({ number }) {
         return new OffByXRule(number ?? this.number);
     }

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

@@ -9,7 +9,6 @@ export default abstract class Rule extends Instruction {
     abstract validateGrid(grid: GridData): RuleState;
     abstract get searchVariants(): SearchVariant[];
     searchVariant(): SearchVariant;
-    get visibleWhenSolving(): boolean;
     /**
      * Whether only one instance of this rule is allowed in a grid.
      */

package/dist/data/rules/rule.js

@@ -6,9 +6,6 @@ export default class Rule extends Instruction {
             rule: this,
         };
     }
-    get visibleWhenSolving() {
-        return true;
-    }
     /**
      * Whether only one instance of this rule is allowed in a grid.
      */

package/dist/data/rules/symbolsPerRegionRule.js

@@ -136,7 +136,9 @@ class SymbolsPerRegionRule extends Rule {
     static countAllSymbolsOfPosition(grid, x, y) {
         let count = 0;
         for (const symbolKind of grid.symbols.values()) {
-            if (symbolKind.some(symbol => Math.floor(symbol.x) === x && Math.floor(symbol.y) === y)) {
+            if (symbolKind.some(symbol => Math.floor(symbol.x) === x &&
+                Math.floor(symbol.y) === y &&
+                symbol.necessaryForCompletion)) {
                 count++;
             }
         }

package/dist/data/rules/undercluedRule.js

@@ -1,5 +1,5 @@
 import GridData from '../grid.js';
-import { State } from '../primitives.js';
+import { MajorRule, State } from '../primitives.js';
 import AreaNumberSymbol from '../symbols/areaNumberSymbol.js';
 import CustomTextSymbol from '../symbols/customTextSymbol.js';
 import Rule from './rule.js';
@@ -13,7 +13,7 @@ class UndercluedRule extends Rule {
         super();
     }
     get id() {
-        return `underclued`;
+        return MajorRule.Underclued;
     }
     get explanation() {
         return `*Underclued Grid:* Mark only what is definitely true`;

package/dist/data/symbols/hiddenSymbol.d.ts

@@ -0,0 +1,36 @@
+import { AnyConfig } from '../config.js';
+import { SymbolDisplayHandler } from '../events/onSymbolDisplay.js';
+import GridData from '../grid.js';
+import { Color, State } from '../primitives.js';
+import Symbol from './symbol.js';
+export default class HiddenSymbol extends Symbol implements SymbolDisplayHandler {
+    readonly x: number;
+    readonly y: number;
+    readonly color: Color;
+    private static readonly CONFIGS;
+    private static readonly EXAMPLE_GRID;
+    /**
+     * **Hidden Symbols: color cells correctly to reveal more clues**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param color - The target color of the cell.
+     */
+    constructor(x: number, y: number, color: Color);
+    get id(): string;
+    get explanation(): string;
+    get configs(): readonly AnyConfig[] | null;
+    createExampleGrid(): GridData;
+    get necessaryForCompletion(): boolean;
+    get visibleWhenSolving(): boolean;
+    get sortOrder(): number;
+    validateSymbol(grid: GridData): State;
+    onSymbolDisplay(grid: GridData, symbol: Symbol, editing: boolean): boolean;
+    copyWith({ x, y, color, }: {
+        x?: number;
+        y?: number;
+        color?: Color;
+    }): this;
+    withColor(color: Color): this;
+}
+export declare const instance: HiddenSymbol;

package/dist/data/symbols/hiddenSymbol.js

@@ -0,0 +1,119 @@
+import { ConfigType } from '../config.js';
+import GridData from '../grid.js';
+import { Color, State } from '../primitives.js';
+import CustomIconSymbol from './customIconSymbol.js';
+import Symbol from './symbol.js';
+class HiddenSymbol extends Symbol {
+    /**
+     * **Hidden Symbols: color cells correctly to reveal more clues**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param color - The target color of the cell.
+     */
+    constructor(x, y, color) {
+        super(x, y);
+        Object.defineProperty(this, "x", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: x
+        });
+        Object.defineProperty(this, "y", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: y
+        });
+        Object.defineProperty(this, "color", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: color
+        });
+        this.color = color;
+    }
+    get id() {
+        return `hidden`;
+    }
+    get explanation() {
+        return '*Hidden Symbols*: color cells correctly to reveal more clues';
+    }
+    get configs() {
+        return HiddenSymbol.CONFIGS;
+    }
+    createExampleGrid() {
+        return HiddenSymbol.EXAMPLE_GRID;
+    }
+    get necessaryForCompletion() {
+        return false;
+    }
+    get visibleWhenSolving() {
+        return false;
+    }
+    get sortOrder() {
+        return 0;
+    }
+    validateSymbol(grid) {
+        const thisX = Math.floor(this.x);
+        const thisY = Math.floor(this.y);
+        return grid.getTile(thisX, thisY).color === this.color
+            ? State.Satisfied
+            : State.Incomplete;
+    }
+    onSymbolDisplay(grid, symbol, editing) {
+        if (symbol.id === this.id || editing)
+            return true;
+        const thisX = Math.floor(this.x);
+        const thisY = Math.floor(this.y);
+        const symX = Math.floor(symbol.x);
+        const symY = Math.floor(symbol.y);
+        if (thisX !== symX || thisY !== symY)
+            return true;
+        return grid.getTile(thisX, thisY).color === this.color;
+    }
+    copyWith({ x, y, color, }) {
+        return new HiddenSymbol(x ?? this.x, y ?? this.y, color ?? this.color);
+    }
+    withColor(color) {
+        return this.copyWith({ color });
+    }
+}
+Object.defineProperty(HiddenSymbol, "CONFIGS", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze([
+        {
+            type: ConfigType.Number,
+            default: 0,
+            field: 'x',
+            description: 'X',
+            configurable: false,
+        },
+        {
+            type: ConfigType.Number,
+            default: 0,
+            field: 'y',
+            description: 'Y',
+            configurable: false,
+        },
+        {
+            type: ConfigType.Color,
+            default: Color.Light,
+            field: 'color',
+            allowGray: true,
+            description: 'Show on color',
+            configurable: true,
+        },
+    ])
+});
+Object.defineProperty(HiddenSymbol, "EXAMPLE_GRID", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze(GridData.create(['w']).addSymbol(new CustomIconSymbol('', GridData.create(['.']), 0, 0, 'MdHideSource') // Not using HiddenSymbol here because it is meant to be hidden in non-edit mode
+    ))
+});
+export default HiddenSymbol;
+export const instance = new HiddenSymbol(0, 0, Color.Light);

package/dist/data/symbols/symbol.d.ts

@@ -8,7 +8,14 @@ export default abstract class Symbol extends Instruction implements GridResizeHa
     constructor(x: number, y: number);
     abstract validateSymbol(grid: GridData): State;
     onGridResize(_grid: GridData, mode: 'insert' | 'remove', direction: 'row' | 'column', index: number): this | null;
+    /**
+     * The step size for the x and y coordinates of the symbol.
+     */
     get placementStep(): number;
+    /**
+     * The order in which symbols are displayed on the instruction list. Lower values are displayed first.
+     */
+    get sortOrder(): number;
     withX(x: number): this;
     withY(y: number): this;
     withPosition(x: number, y: number): this;

package/dist/data/symbols/symbol.js

@@ -35,9 +35,18 @@ export default class Symbol extends Instruction {
             });
         }
     }
+    /**
+     * The step size for the x and y coordinates of the symbol.
+     */
     get placementStep() {
         return 0.5;
     }
+    /**
+     * The order in which symbols are displayed on the instruction list. Lower values are displayed first.
+     */
+    get sortOrder() {
+        return this.id.charCodeAt(0);
+    }
     withX(x) {
         return this.copyWith({ x });
     }

package/dist/data/symbols/symbols.gen.d.ts

@@ -3,6 +3,7 @@ export { instance as CustomIconSymbol } from './customIconSymbol.js';
 export { instance as CustomTextSymbol } from './customTextSymbol.js';
 export { instance as DartSymbol } from './dartSymbol.js';
 export { instance as GalaxySymbol } from './galaxySymbol.js';
+export { instance as HiddenSymbol } from './hiddenSymbol.js';
 export { instance as LetterSymbol } from './letterSymbol.js';
 export { instance as LotusSymbol } from './lotusSymbol.js';
 export { instance as MinesweeperSymbol } from './minesweeperSymbol.js';

package/dist/data/symbols/symbols.gen.js

@@ -7,6 +7,7 @@ export { instance as CustomIconSymbol } from './customIconSymbol.js';
 export { instance as CustomTextSymbol } from './customTextSymbol.js';
 export { instance as DartSymbol } from './dartSymbol.js';
 export { instance as GalaxySymbol } from './galaxySymbol.js';
+export { instance as HiddenSymbol } from './hiddenSymbol.js';
 export { instance as LetterSymbol } from './letterSymbol.js';
 export { instance as LotusSymbol } from './lotusSymbol.js';
 export { instance as MinesweeperSymbol } from './minesweeperSymbol.js';

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 import { ConfigType, configEquals } from './data/config.js';
 import Configurable from './data/configurable.js';
-import { allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape } from './data/dataHelper.js';
+import { CachedAccess, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape } from './data/dataHelper.js';
 import { isEventHandler } from './data/events/eventHelper.js';
 import { handlesFinalValidation } from './data/events/onFinalValidation.js';
 import { handlesGridChange } from './data/events/onGridChange.js';
 import { handlesGridResize } from './data/events/onGridResize.js';
 import { handlesSetGrid } from './data/events/onSetGrid.js';
+import { handlesSymbolDisplay } from './data/events/onSymbolDisplay.js';
 import { handlesSymbolValidation } from './data/events/onSymbolValidation.js';
 import GridData from './data/grid.js';
 import GridConnections from './data/gridConnections.js';
 import Instruction from './data/instruction.js';
-import { COMPARISONS, Color, Comparison, DIRECTIONS, Direction, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle } from './data/primitives.js';
+import { COMPARISONS, Color, Comparison, DIRECTIONS, Direction, MajorRule, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle } from './data/primitives.js';
 import { MetadataSchema, PuzzleSchema } from './data/puzzle.js';
 import BanPatternRule from './data/rules/banPatternRule.js';
 import CellCountRule from './data/rules/cellCountRule.js';
@@ -81,6 +82,7 @@ import CustomTextSymbol from './data/symbols/customTextSymbol.js';
 import DartSymbol from './data/symbols/dartSymbol.js';
 import DirectionLinkerSymbol from './data/symbols/directionLinkerSymbol.js';
 import GalaxySymbol from './data/symbols/galaxySymbol.js';
+import HiddenSymbol from './data/symbols/hiddenSymbol.js';
 import { allSymbols } from './data/symbols/index.js';
 import LetterSymbol from './data/symbols/letterSymbol.js';
 import LotusSymbol from './data/symbols/lotusSymbol.js';
@@ -93,4 +95,4 @@ import ViewpointSymbol from './data/symbols/viewpointSymbol.js';
 import TileData from './data/tile.js';
 import TileConnections from './data/tileConnections.js';
 import validateGrid, { aggregateState, applyFinalOverrides } from './data/validate.js';
-export { ConfigType, configEquals, Configurable, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape, isEventHandler, handlesFinalValidation, handlesGridChange, handlesGridResize, handlesSetGrid, handlesSymbolValidation, GridData, GridConnections, Instruction, COMPARISONS, Color, Comparison, DIRECTIONS, Direction, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle, MetadataSchema, PuzzleSchema, BanPatternRule, CellCountRule, CompletePatternRule, ConnectAllRule, CustomRule, ForesightRule, allRules, ControlLine, Row, MusicGridRule, MysteryRule, OffByXRule, RegionAreaRule, RegionShapeRule, Rule, SameShapeRule, SymbolsPerRegionRule, UndercluedRule, UniqueShapeRule, Serializer, Compressor, CompressorBase, DeflateCompressor, GzipCompressor, StreamCompressor, SerializerBase, SerializerV0, getShapeVariants, normalizeShape, positionsToShape, shapeEquals, tilesToShape, allSolvers, BacktrackSolver, BTModule, BTGridData, BTTile, IntArray2D, colorToBTTile, createOneTileResult, getOppositeColor, BanPatternBTModule, CellCountBTModule, ConnectAllBTModule, RegionAreaBTModule, RegionShapeBTModule, SameShapeBTModule, SymbolsPerRegionBTModule, UniqueShapeBTModule, AreaNumberBTModule, DartBTModule, DirectionLinkerBTModule, GalaxyBTModule, LetterBTModule, LotusBTModule, MinesweeperBTModule, MyopiaBTModule, ViewpointBTModule, Solver, UndercluedSolver, AreaNumberModule, CellCountModule, ConnectAllModule, DartModule, allZ3Modules, LetterModule, MyopiaModule, RegionAreaModule, ViewpointModule, Z3Module, convertDirection, Z3Solver, Z3SolverContext, AreaNumberSymbol, CustomIconSymbol, CustomSymbol, CustomTextSymbol, DartSymbol, DirectionLinkerSymbol, GalaxySymbol, allSymbols, LetterSymbol, LotusSymbol, MinesweeperSymbol, MultiEntrySymbol, MyopiaSymbol, NumberSymbol, Symbol, ViewpointSymbol, TileData, TileConnections, validateGrid, aggregateState, applyFinalOverrides, };
+export { ConfigType, configEquals, Configurable, CachedAccess, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape, isEventHandler, handlesFinalValidation, handlesGridChange, handlesGridResize, handlesSetGrid, handlesSymbolDisplay, handlesSymbolValidation, GridData, GridConnections, Instruction, COMPARISONS, Color, Comparison, DIRECTIONS, Direction, MajorRule, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle, MetadataSchema, PuzzleSchema, BanPatternRule, CellCountRule, CompletePatternRule, ConnectAllRule, CustomRule, ForesightRule, allRules, ControlLine, Row, MusicGridRule, MysteryRule, OffByXRule, RegionAreaRule, RegionShapeRule, Rule, SameShapeRule, SymbolsPerRegionRule, UndercluedRule, UniqueShapeRule, Serializer, Compressor, CompressorBase, DeflateCompressor, GzipCompressor, StreamCompressor, SerializerBase, SerializerV0, getShapeVariants, normalizeShape, positionsToShape, shapeEquals, tilesToShape, allSolvers, BacktrackSolver, BTModule, BTGridData, BTTile, IntArray2D, colorToBTTile, createOneTileResult, getOppositeColor, BanPatternBTModule, CellCountBTModule, ConnectAllBTModule, RegionAreaBTModule, RegionShapeBTModule, SameShapeBTModule, SymbolsPerRegionBTModule, UniqueShapeBTModule, AreaNumberBTModule, DartBTModule, DirectionLinkerBTModule, GalaxyBTModule, LetterBTModule, LotusBTModule, MinesweeperBTModule, MyopiaBTModule, ViewpointBTModule, Solver, UndercluedSolver, AreaNumberModule, CellCountModule, ConnectAllModule, DartModule, allZ3Modules, LetterModule, MyopiaModule, RegionAreaModule, ViewpointModule, Z3Module, convertDirection, Z3Solver, Z3SolverContext, AreaNumberSymbol, CustomIconSymbol, CustomSymbol, CustomTextSymbol, DartSymbol, DirectionLinkerSymbol, GalaxySymbol, HiddenSymbol, allSymbols, LetterSymbol, LotusSymbol, MinesweeperSymbol, MultiEntrySymbol, MyopiaSymbol, NumberSymbol, Symbol, ViewpointSymbol, TileData, TileConnections, validateGrid, aggregateState, applyFinalOverrides, };

package/dist/index.js

@@ -3,17 +3,18 @@
 // noinspection JSUnusedGlobalSymbols
 import { ConfigType, configEquals } from './data/config.js';
 import Configurable from './data/configurable.js';
-import { allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape } from './data/dataHelper.js';
+import { CachedAccess, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape } from './data/dataHelper.js';
 import { isEventHandler } from './data/events/eventHelper.js';
 import { handlesFinalValidation } from './data/events/onFinalValidation.js';
 import { handlesGridChange } from './data/events/onGridChange.js';
 import { handlesGridResize } from './data/events/onGridResize.js';
 import { handlesSetGrid } from './data/events/onSetGrid.js';
+import { handlesSymbolDisplay } from './data/events/onSymbolDisplay.js';
 import { handlesSymbolValidation } from './data/events/onSymbolValidation.js';
 import GridData from './data/grid.js';
 import GridConnections from './data/gridConnections.js';
 import Instruction from './data/instruction.js';
-import { COMPARISONS, Color, Comparison, DIRECTIONS, Direction, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle } from './data/primitives.js';
+import { COMPARISONS, Color, Comparison, DIRECTIONS, Direction, MajorRule, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle } from './data/primitives.js';
 import { MetadataSchema, PuzzleSchema } from './data/puzzle.js';
 import BanPatternRule from './data/rules/banPatternRule.js';
 import CellCountRule from './data/rules/cellCountRule.js';
@@ -84,6 +85,7 @@ import CustomTextSymbol from './data/symbols/customTextSymbol.js';
 import DartSymbol from './data/symbols/dartSymbol.js';
 import DirectionLinkerSymbol from './data/symbols/directionLinkerSymbol.js';
 import GalaxySymbol from './data/symbols/galaxySymbol.js';
+import HiddenSymbol from './data/symbols/hiddenSymbol.js';
 import { allSymbols } from './data/symbols/index.js';
 import LetterSymbol from './data/symbols/letterSymbol.js';
 import LotusSymbol from './data/symbols/lotusSymbol.js';
@@ -96,4 +98,4 @@ import ViewpointSymbol from './data/symbols/viewpointSymbol.js';
 import TileData from './data/tile.js';
 import TileConnections from './data/tileConnections.js';
 import validateGrid, { aggregateState, applyFinalOverrides } from './data/validate.js';
-export { ConfigType, configEquals, Configurable, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape, isEventHandler, handlesFinalValidation, handlesGridChange, handlesGridResize, handlesSetGrid, handlesSymbolValidation, GridData, GridConnections, Instruction, COMPARISONS, Color, Comparison, DIRECTIONS, Direction, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle, MetadataSchema, PuzzleSchema, BanPatternRule, CellCountRule, CompletePatternRule, ConnectAllRule, CustomRule, ForesightRule, allRules, ControlLine, Row, MusicGridRule, MysteryRule, OffByXRule, RegionAreaRule, RegionShapeRule, Rule, SameShapeRule, SymbolsPerRegionRule, UndercluedRule, UniqueShapeRule, Serializer, Compressor, CompressorBase, DeflateCompressor, GzipCompressor, StreamCompressor, SerializerBase, SerializerV0, getShapeVariants, normalizeShape, positionsToShape, shapeEquals, tilesToShape, allSolvers, BacktrackSolver, BTModule, BTGridData, BTTile, IntArray2D, colorToBTTile, createOneTileResult, getOppositeColor, BanPatternBTModule, CellCountBTModule, ConnectAllBTModule, RegionAreaBTModule, RegionShapeBTModule, SameShapeBTModule, SymbolsPerRegionBTModule, UniqueShapeBTModule, AreaNumberBTModule, DartBTModule, DirectionLinkerBTModule, GalaxyBTModule, LetterBTModule, LotusBTModule, MinesweeperBTModule, MyopiaBTModule, ViewpointBTModule, Solver, UndercluedSolver, AreaNumberModule, CellCountModule, ConnectAllModule, DartModule, allZ3Modules, LetterModule, MyopiaModule, RegionAreaModule, ViewpointModule, Z3Module, convertDirection, Z3Solver, Z3SolverContext, AreaNumberSymbol, CustomIconSymbol, CustomSymbol, CustomTextSymbol, DartSymbol, DirectionLinkerSymbol, GalaxySymbol, allSymbols, LetterSymbol, LotusSymbol, MinesweeperSymbol, MultiEntrySymbol, MyopiaSymbol, NumberSymbol, Symbol, ViewpointSymbol, TileData, TileConnections, validateGrid, aggregateState, applyFinalOverrides, };
+export { ConfigType, configEquals, Configurable, CachedAccess, allEqual, array, directionToRotation, escape, maxBy, minBy, move, orientationToRotation, resize, unescape, isEventHandler, handlesFinalValidation, handlesGridChange, handlesGridResize, handlesSetGrid, handlesSymbolDisplay, handlesSymbolValidation, GridData, GridConnections, Instruction, COMPARISONS, Color, Comparison, DIRECTIONS, Direction, MajorRule, Mode, ORIENTATIONS, Orientation, State, directionToggle, orientationToggle, MetadataSchema, PuzzleSchema, BanPatternRule, CellCountRule, CompletePatternRule, ConnectAllRule, CustomRule, ForesightRule, allRules, ControlLine, Row, MusicGridRule, MysteryRule, OffByXRule, RegionAreaRule, RegionShapeRule, Rule, SameShapeRule, SymbolsPerRegionRule, UndercluedRule, UniqueShapeRule, Serializer, Compressor, CompressorBase, DeflateCompressor, GzipCompressor, StreamCompressor, SerializerBase, SerializerV0, getShapeVariants, normalizeShape, positionsToShape, shapeEquals, tilesToShape, allSolvers, BacktrackSolver, BTModule, BTGridData, BTTile, IntArray2D, colorToBTTile, createOneTileResult, getOppositeColor, BanPatternBTModule, CellCountBTModule, ConnectAllBTModule, RegionAreaBTModule, RegionShapeBTModule, SameShapeBTModule, SymbolsPerRegionBTModule, UniqueShapeBTModule, AreaNumberBTModule, DartBTModule, DirectionLinkerBTModule, GalaxyBTModule, LetterBTModule, LotusBTModule, MinesweeperBTModule, MyopiaBTModule, ViewpointBTModule, Solver, UndercluedSolver, AreaNumberModule, CellCountModule, ConnectAllModule, DartModule, allZ3Modules, LetterModule, MyopiaModule, RegionAreaModule, ViewpointModule, Z3Module, convertDirection, Z3Solver, Z3SolverContext, AreaNumberSymbol, CustomIconSymbol, CustomSymbol, CustomTextSymbol, DartSymbol, DirectionLinkerSymbol, GalaxySymbol, HiddenSymbol, allSymbols, LetterSymbol, LotusSymbol, MinesweeperSymbol, MultiEntrySymbol, MyopiaSymbol, NumberSymbol, Symbol, ViewpointSymbol, TileData, TileConnections, validateGrid, aggregateState, applyFinalOverrides, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logic-pad/core",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "type": "module",
   "files": [
     "dist",