@logic-pad/core 0.1.4 → 0.2.0

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.4",
+  "version": "0.2.0",
   "type": "module",
   "files": [
     "dist",