@logic-pad/core 0.26.1 → 0.26.2

package/dist/src/data/rules/customRule.js

@@ -1,74 +0,0 @@
-import { ConfigType } from '../config.js';
-import GridData from '../grid.js';
-import { State } from '../primitives.js';
-import Rule from './rule.js';
-export default class CustomRule extends Rule {
-    description;
-    grid;
-    title = 'Custom Rule';
-    get configExplanation() {
-        return 'A customizable rule. Your provided solution may override auto-validation.';
-    }
-    static EXAMPLE_GRID = Object.freeze(GridData.create(5, 4));
-    static configs = Object.freeze([
-        {
-            type: ConfigType.String,
-            default: 'A *custom* rule',
-            field: 'description',
-            description: 'Description',
-            explanation: 'A short descriptive text. Use *asterisks* to highlight keywords.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.Grid,
-            default: CustomRule.EXAMPLE_GRID,
-            field: 'grid',
-            description: 'Thumbnail Grid',
-            explanation: 'An example grid showing the rule.',
-            configurable: true,
-        },
-    ]);
-    static SEARCH_VARIANTS = [
-        new CustomRule('A *custom* rule', CustomRule.EXAMPLE_GRID).searchVariant(),
-    ];
-    /**
-     * A custom rule with a description and thumbnail grid.
-     *
-     * This rule validates answers based on the provided solution.
-     *
-     * @param description - The description of the rule.
-     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
-     */
-    constructor(description, grid) {
-        super();
-        this.description = description;
-        this.grid = grid;
-        this.description = description;
-        this.grid = grid;
-    }
-    get id() {
-        return `custom`;
-    }
-    get explanation() {
-        return this.description;
-    }
-    get configs() {
-        return CustomRule.configs;
-    }
-    createExampleGrid() {
-        return this.grid;
-    }
-    get searchVariants() {
-        return CustomRule.SEARCH_VARIANTS;
-    }
-    validateGrid(_grid) {
-        return { state: State.Incomplete };
-    }
-    copyWith({ description, grid, }) {
-        return new CustomRule(description ?? this.description, grid ?? this.grid);
-    }
-    get validateWithSolution() {
-        return true;
-    }
-}
-export const instance = new CustomRule('', GridData.create([]));

package/dist/src/data/rules/differentCountPerZoneRule.d.ts

@@ -1,30 +0,0 @@
-import { AnyConfig } from '../config.js';
-import GridData from '../grid.js';
-import { Color, RuleState } from '../primitives.js';
-import CellCountPerZoneRule from './cellCountPerZoneRule.js';
-import { SearchVariant } from './rule.js';
-export default class DifferentCountPerZoneRule extends CellCountPerZoneRule {
-    readonly color: Color;
-    readonly title = "Different Count Per Zone";
-    private static readonly CONFIGS;
-    private static readonly EXAMPLE_GRID_LIGHT;
-    private static readonly EXAMPLE_GRID_DARK;
-    private static readonly EXAMPLE_GRID_GRAY;
-    private static readonly SEARCH_VARIANTS;
-    /**
-     * **Zones of the same size have different numbers of <color> cells.**
-     *
-     * @param color - The color of the cells to count.
-     */
-    constructor(color: Color);
-    get id(): string;
-    get explanation(): string;
-    get configs(): readonly AnyConfig[] | null;
-    createExampleGrid(): GridData;
-    get searchVariants(): SearchVariant[];
-    validateGrid(grid: GridData): RuleState;
-    copyWith({ color }: {
-        color?: Color;
-    }): this;
-}
-export declare const instance: DifferentCountPerZoneRule;

package/dist/src/data/rules/differentCountPerZoneRule.js

@@ -1,96 +0,0 @@
-import { ConfigType } from '../config.js';
-import GridData from '../grid.js';
-import GridZones from '../gridZones.js';
-import { Color, State } from '../primitives.js';
-import CellCountPerZoneRule from './cellCountPerZoneRule.js';
-export default class DifferentCountPerZoneRule extends CellCountPerZoneRule {
-    color;
-    title = 'Different Count Per Zone';
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.Color,
-            default: Color.Light,
-            allowGray: true,
-            field: 'color',
-            description: 'Color',
-            configurable: true,
-        },
-    ]);
-    static EXAMPLE_GRID_LIGHT = Object.freeze(GridData.create(['wwbbw', 'wbbwb', 'bbbwb', 'bwbwb'])
-        .withZones(new GridZones([
-        { x1: 0, y1: 1, x2: 0, y2: 2 },
-        { x1: 1, y1: 1, x2: 1, y2: 2 },
-        { 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 DifferentCountPerZoneRule(Color.Light)));
-    static EXAMPLE_GRID_DARK = Object.freeze(DifferentCountPerZoneRule.EXAMPLE_GRID_LIGHT.withTiles(tiles => tiles.map(row => row.map(tile => tile.withColor(tile.color === Color.Dark ? Color.Light : Color.Dark)))));
-    static EXAMPLE_GRID_GRAY = Object.freeze(DifferentCountPerZoneRule.EXAMPLE_GRID_LIGHT.withTiles(tiles => tiles.map(row => row.map(tile => tile.withColor(tile.color === Color.Light ? Color.Gray : tile.color)))));
-    static SEARCH_VARIANTS = [
-        new DifferentCountPerZoneRule(Color.Light).searchVariant(),
-        new DifferentCountPerZoneRule(Color.Dark).searchVariant(),
-    ];
-    /**
-     * **Zones of the same size have different numbers of <color> cells.**
-     *
-     * @param color - The color of the cells to count.
-     */
-    constructor(color) {
-        super(color);
-        this.color = color;
-    }
-    get id() {
-        return `zone_diff_count`;
-    }
-    get explanation() {
-        return `Zones of the same size have different numbers of ${this.color} cells`;
-    }
-    get configs() {
-        return DifferentCountPerZoneRule.CONFIGS;
-    }
-    createExampleGrid() {
-        if (this.color === Color.Light) {
-            return DifferentCountPerZoneRule.EXAMPLE_GRID_LIGHT;
-        }
-        else if (this.color === Color.Dark) {
-            return DifferentCountPerZoneRule.EXAMPLE_GRID_DARK;
-        }
-        else {
-            return DifferentCountPerZoneRule.EXAMPLE_GRID_GRAY;
-        }
-    }
-    get searchVariants() {
-        return DifferentCountPerZoneRule.SEARCH_VARIANTS;
-    }
-    validateGrid(grid) {
-        const { zones, complete } = this.getZoneCounts(grid);
-        if (zones.length <= 1) {
-            return { state: complete ? State.Satisfied : State.Incomplete };
-        }
-        else {
-            const errorZone = zones.find(z => zones.some(zz => zz !== z &&
-                zz.positions.length === z.positions.length &&
-                zz.possible === 0 &&
-                z.possible === 0 &&
-                zz.completed === z.completed));
-            if (errorZone) {
-                return {
-                    state: State.Error,
-                    positions: errorZone.positions,
-                };
-            }
-            else {
-                return { state: complete ? State.Satisfied : State.Incomplete };
-            }
-        }
-    }
-    copyWith({ color }) {
-        return new DifferentCountPerZoneRule(color ?? this.color);
-    }
-}
-export const instance = new DifferentCountPerZoneRule(Color.Light);

package/dist/src/data/rules/exactCountPerZoneRule.d.ts

@@ -1,33 +0,0 @@
-import { AnyConfig } from '../config.js';
-import GridData from '../grid.js';
-import { Color, RuleState } from '../primitives.js';
-import CellCountPerZoneRule from './cellCountPerZoneRule.js';
-import { SearchVariant } from './rule.js';
-export default class ExactCountPerZoneRule extends CellCountPerZoneRule {
-    readonly color: Color;
-    readonly count: number;
-    readonly title = "Exact Count Per Zone";
-    private static readonly CONFIGS;
-    private static readonly EXAMPLE_GRID_LIGHT;
-    private static readonly EXAMPLE_GRID_DARK;
-    private static readonly EXAMPLE_GRID_GRAY;
-    private static readonly SEARCH_VARIANTS;
-    /**
-     * **Each zone has <count> <color> cells.**
-     *
-     * @param color - The color of the cells to count.
-     * @param count - The exact count of the cells in each zone.
-     */
-    constructor(color: Color, count: number);
-    get id(): string;
-    get explanation(): string;
-    get configs(): readonly AnyConfig[] | null;
-    createExampleGrid(): GridData;
-    get searchVariants(): SearchVariant[];
-    validateGrid(grid: GridData): RuleState;
-    copyWith({ color, count }: {
-        color?: Color;
-        count?: number;
-    }): this;
-}
-export declare const instance: ExactCountPerZoneRule;

package/dist/src/data/rules/exactCountPerZoneRule.js

@@ -1,99 +0,0 @@
-import { ConfigType } from '../config.js';
-import GridData from '../grid.js';
-import GridZones from '../gridZones.js';
-import { Color, State } from '../primitives.js';
-import CellCountPerZoneRule from './cellCountPerZoneRule.js';
-export default class ExactCountPerZoneRule extends CellCountPerZoneRule {
-    color;
-    count;
-    title = 'Exact Count Per Zone';
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.Color,
-            default: Color.Light,
-            allowGray: true,
-            field: 'color',
-            description: 'Color',
-            configurable: true,
-        },
-        {
-            type: ConfigType.Number,
-            default: 1,
-            min: 0,
-            field: 'count',
-            description: 'Count',
-            configurable: true,
-        },
-    ]);
-    static EXAMPLE_GRID_LIGHT = Object.freeze(GridData.create(['wbbbb', 'bbbwb', 'bbbwb', 'bwbbb'])
-        .withZones(new GridZones([
-        { x1: 0, y1: 1, x2: 0, y2: 2 },
-        { x1: 1, y1: 1, x2: 1, y2: 2 },
-        { 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 ExactCountPerZoneRule(Color.Light, 1)));
-    static EXAMPLE_GRID_DARK = Object.freeze(ExactCountPerZoneRule.EXAMPLE_GRID_LIGHT.withTiles(tiles => tiles.map(row => row.map(tile => tile.withColor(tile.color === Color.Dark ? Color.Light : Color.Dark)))));
-    static EXAMPLE_GRID_GRAY = Object.freeze(ExactCountPerZoneRule.EXAMPLE_GRID_LIGHT.withTiles(tiles => tiles.map(row => row.map(tile => tile.withColor(tile.color === Color.Light ? Color.Gray : tile.color)))));
-    static SEARCH_VARIANTS = [
-        new ExactCountPerZoneRule(Color.Light, 1).searchVariant(),
-        new ExactCountPerZoneRule(Color.Dark, 1).searchVariant(),
-    ];
-    /**
-     * **Each zone has <count> <color> cells.**
-     *
-     * @param color - The color of the cells to count.
-     * @param count - The exact count of the cells in each zone.
-     */
-    constructor(color, count) {
-        super(color);
-        this.color = color;
-        this.count = count;
-        this.count = count;
-    }
-    get id() {
-        return `zone_exact_count`;
-    }
-    get explanation() {
-        return `Each zone has exactly ${this.count} ${this.color} cell${this.count === 1 ? '' : 's'}`;
-    }
-    get configs() {
-        return ExactCountPerZoneRule.CONFIGS;
-    }
-    createExampleGrid() {
-        if (this.color === Color.Light) {
-            return ExactCountPerZoneRule.EXAMPLE_GRID_LIGHT;
-        }
-        else if (this.color === Color.Dark) {
-            return ExactCountPerZoneRule.EXAMPLE_GRID_DARK;
-        }
-        else {
-            return ExactCountPerZoneRule.EXAMPLE_GRID_GRAY;
-        }
-    }
-    get searchVariants() {
-        return ExactCountPerZoneRule.SEARCH_VARIANTS;
-    }
-    validateGrid(grid) {
-        const { zones, complete } = this.getZoneCounts(grid);
-        const errorZone = zones.find(z => z.completed > this.count || z.completed + z.possible < this.count);
-        if (errorZone) {
-            return {
-                state: State.Error,
-                positions: errorZone.positions,
-            };
-        }
-        else {
-            return { state: complete ? State.Satisfied : State.Incomplete };
-        }
-    }
-    copyWith({ color, count }) {
-        return new ExactCountPerZoneRule(color ?? this.color, count ?? this.count);
-    }
-}
-export const instance = new ExactCountPerZoneRule(Color.Light, 1);

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

@@ -1,36 +0,0 @@
-import { AnyConfig } from '../config.js';
-import GridData from '../grid.js';
-import { RuleState, Position, Mode } from '../primitives.js';
-import Rule, { SearchVariant } from './rule.js';
-export default class ForesightRule extends Rule {
-    readonly count: number;
-    readonly regenInterval: number;
-    readonly startFull: boolean;
-    readonly solvePath: Position[];
-    readonly title = "Foresight";
-    get configExplanation(): string;
-    private static readonly EXAMPLE_GRID;
-    private static readonly CONFIGS;
-    private static readonly SEARCH_VARIANTS;
-    /**
-     * **Foresight: Show hints**
-     */
-    constructor(count: number, regenInterval: number, startFull: boolean, solvePath?: Position[]);
-    get id(): string;
-    get explanation(): string;
-    get visibleWhenSolving(): boolean;
-    get configs(): readonly AnyConfig[] | null;
-    createExampleGrid(): GridData;
-    get searchVariants(): SearchVariant[];
-    validateGrid(_grid: GridData): RuleState;
-    get necessaryForCompletion(): boolean;
-    get isSingleton(): boolean;
-    modeVariant(mode: Mode): Rule | null;
-    copyWith({ count, regenInterval, startFull, solvePath, }: {
-        count?: number;
-        regenInterval?: number;
-        startFull?: boolean;
-        solvePath?: Position[];
-    }): this;
-}
-export declare const instance: ForesightRule;

package/dist/src/data/rules/foresightRule.js

@@ -1,107 +0,0 @@
-import { ConfigType } from '../config.js';
-import GridData from '../grid.js';
-import { State, Mode } from '../primitives.js';
-import CustomIconSymbol from '../symbols/customIconSymbol.js';
-import Rule from './rule.js';
-export default class ForesightRule extends Rule {
-    count;
-    regenInterval;
-    startFull;
-    solvePath;
-    title = 'Foresight';
-    get configExplanation() {
-        return 'Provide automatic hints to the player.';
-    }
-    static EXAMPLE_GRID = Object.freeze(GridData.create(['.']).addSymbol(new CustomIconSymbol('', GridData.create([]), 0, 0, 'MdRemoveRedEye')));
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.Number,
-            default: 5,
-            min: 1,
-            field: 'count',
-            description: 'Foresight count',
-            explanation: 'Maximum number of foresight charges that can be stored.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.Number,
-            default: 30,
-            min: 1,
-            field: 'regenInterval',
-            description: 'Regen Interval (seconds)',
-            explanation: 'Time taken for one foresight charge to regenerate.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.Boolean,
-            default: false,
-            field: 'startFull',
-            description: 'Start with full foresight',
-            explanation: 'Whether to start with all foresight charges available.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.SolvePath,
-            default: [],
-            field: 'solvePath',
-            description: 'Intended solve path',
-            explanation: 'A logical solve path of the puzzle. Foresight will hint at the location of the next tile if this is available.',
-            configurable: true,
-        },
-    ]);
-    static SEARCH_VARIANTS = [
-        new ForesightRule(5, 30, false).searchVariant(),
-    ];
-    /**
-     * **Foresight: Show hints**
-     */
-    constructor(count, regenInterval, startFull, solvePath = []) {
-        super();
-        this.count = count;
-        this.regenInterval = regenInterval;
-        this.startFull = startFull;
-        this.solvePath = solvePath;
-        this.count = count;
-        this.regenInterval = regenInterval;
-        this.startFull = startFull;
-        this.solvePath = solvePath;
-    }
-    get id() {
-        return `foresight`;
-    }
-    get explanation() {
-        return `*Foresight:* Show hints`;
-    }
-    get visibleWhenSolving() {
-        return false;
-    }
-    get configs() {
-        return ForesightRule.CONFIGS;
-    }
-    createExampleGrid() {
-        return ForesightRule.EXAMPLE_GRID;
-    }
-    get searchVariants() {
-        return ForesightRule.SEARCH_VARIANTS;
-    }
-    validateGrid(_grid) {
-        return { state: State.Incomplete };
-    }
-    get necessaryForCompletion() {
-        return false;
-    }
-    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);
-    }
-}
-export const instance = new ForesightRule(5, 30, false);

package/dist/src/data/rules/index.d.ts

@@ -1,3 +0,0 @@
-import Rule from './rule.js';
-declare const allRules: Map<string, Rule>;
-export { allRules };

package/dist/src/data/rules/index.js

@@ -1,10 +0,0 @@
-import * as rules from './rules.gen.js';
-const allRules = new Map();
-function register(prototype) {
-    allRules.set(prototype.id, prototype);
-}
-Object.values(rules).forEach(rule => {
-    if (rule)
-        register(rule);
-});
-export { allRules };

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

@@ -1,31 +0,0 @@
-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;
-    readonly title = "Lying Symbols";
-    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;