@logic-pad/core 0.1.0

package/dist/data/solver/z3/z3SolverContext.js

@@ -0,0 +1,49 @@
+import { RegionConstrainer } from 'grilops';
+export default class Z3SolverContext {
+    constructor(grid) {
+        Object.defineProperty(this, "grid", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: grid
+        });
+        Object.defineProperty(this, "_regionConstrainer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.grid = grid;
+    }
+    get solver() {
+        return this.grid.solver;
+    }
+    get lattice() {
+        return this.grid.lattice;
+    }
+    get symbolSet() {
+        return this.grid.symbolSet;
+    }
+    get ctx() {
+        return this.grid.ctx.context;
+    }
+    get z3() {
+        return this.grid.ctx.z3;
+    }
+    get regionConstrainer() {
+        if (!this._regionConstrainer) {
+            this._regionConstrainer = new RegionConstrainer(this.grid.ctx, this.lattice, this.solver, true, false, 1);
+            for (const p of this.lattice.points) {
+                for (const np of this.lattice.edgeSharingNeighbors(this.grid.grid, p)) {
+                    this.solver.add(this.grid
+                        .cellAt(p)
+                        .eq(this.grid.cellAt(np.location))
+                        .eq(this._regionConstrainer.regionIdGrid
+                        .get(p)
+                        .eq(this._regionConstrainer.regionIdGrid.get(np.location))));
+                }
+            }
+        }
+        return this._regionConstrainer;
+    }
+}

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

@@ -0,0 +1,30 @@
+import { AnyConfig } from '../config';
+import GridData from '../grid';
+import NumberSymbol from './numberSymbol';
+export default class AreaNumberSymbol extends NumberSymbol {
+    private static readonly CONFIGS;
+    private static readonly EXAMPLE_GRID;
+    /**
+     * **Area Numbers must equal region sizes**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param number - The area number.
+     */
+    constructor(x: number, y: number, number: number);
+    get id(): string;
+    get explanation(): string;
+    get configs(): readonly AnyConfig[] | null;
+    createExampleGrid(): GridData;
+    countTiles(grid: GridData): {
+        completed: number;
+        possible: number;
+    };
+    copyWith({ x, y, number, }: {
+        x?: number;
+        y?: number;
+        number?: number;
+    }): this;
+    withNumber(number: number): this;
+}
+export declare const instance: AreaNumberSymbol;

package/dist/data/symbols/areaNumberSymbol.js

@@ -0,0 +1,88 @@
+import { ConfigType } from '../config';
+import GridData from '../grid';
+import { Color } from '../primitives';
+import NumberSymbol from './numberSymbol';
+class AreaNumberSymbol extends NumberSymbol {
+    /**
+     * **Area Numbers must equal region sizes**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param number - The area number.
+     */
+    constructor(x, y, number) {
+        super(x, y, number);
+    }
+    get id() {
+        return `number`;
+    }
+    get explanation() {
+        return `*Area Numbers* must equal region sizes`;
+    }
+    get configs() {
+        return AreaNumberSymbol.CONFIGS;
+    }
+    createExampleGrid() {
+        return AreaNumberSymbol.EXAMPLE_GRID;
+    }
+    countTiles(grid) {
+        const thisX = Math.floor(this.x);
+        const thisY = Math.floor(this.y);
+        const color = grid.getTile(thisX, thisY).color;
+        if (color === Color.Gray)
+            return { completed: 0, possible: Number.MAX_SAFE_INTEGER };
+        let completeCount = 0;
+        let grayCount = 0;
+        grid.iterateArea({ x: thisX, y: thisY }, tile => tile.color === Color.Gray || tile.color === color, () => {
+            grayCount++;
+        });
+        grid.iterateArea({ x: thisX, y: thisY }, tile => tile.color === color, () => {
+            completeCount++;
+        });
+        return { completed: completeCount, possible: grayCount };
+    }
+    copyWith({ x, y, number, }) {
+        return new AreaNumberSymbol(x ?? this.x, y ?? this.y, number ?? this.number);
+    }
+    withNumber(number) {
+        return this.copyWith({ number });
+    }
+}
+Object.defineProperty(AreaNumberSymbol, "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.Number,
+            default: 1,
+            field: 'number',
+            description: 'Number',
+            configurable: true,
+        },
+    ])
+});
+Object.defineProperty(AreaNumberSymbol, "EXAMPLE_GRID", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze(GridData.create(['wbbbb', 'wbbwb', 'bbwwb', 'bbbbb'])
+        .addSymbol(new AreaNumberSymbol(2, 2, 3))
+        .addSymbol(new AreaNumberSymbol(0, 1, 2)))
+});
+export default AreaNumberSymbol;
+export const instance = new AreaNumberSymbol(0, 0, 1);

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

@@ -0,0 +1,35 @@
+import { AnyConfig } from '../config';
+import GridData from '../grid';
+import CustomSymbol from './customSymbol';
+import type Md from 'react-icons/md';
+export type IconString = keyof typeof Md;
+export default class CustomIconSymbol extends CustomSymbol {
+    readonly icon: IconString;
+    readonly rotation: number;
+    private static readonly EXAMPLE_GRID;
+    private static readonly CONFIGS;
+    /**
+     * **A custom icon symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param icon - The icon to display. All available icons can be found at https://react-icons.github.io/react-icons/icons/md/
+     * @param rotation - The rotation of the icon in degrees.
+     */
+    constructor(description: string, grid: GridData, x: number, y: number, icon: IconString, rotation?: number);
+    get id(): string;
+    get configs(): readonly AnyConfig[] | null;
+    copyWith({ description, grid, x, y, icon, rotation, }: {
+        description?: string;
+        grid?: GridData;
+        x?: number;
+        y?: number;
+        icon?: IconString;
+        rotation?: number;
+    }): this;
+    withIcon(icon: IconString): this;
+    withRotation(rotation: number): this;
+}
+export declare const instance: CustomIconSymbol;

package/dist/data/symbols/customIconSymbol.js

@@ -0,0 +1,105 @@
+import { ConfigType } from '../config';
+import GridData from '../grid';
+import CustomSymbol from './customSymbol';
+class CustomIconSymbol extends CustomSymbol {
+    /**
+     * **A custom icon symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param icon - The icon to display. All available icons can be found at https://react-icons.github.io/react-icons/icons/md/
+     * @param rotation - The rotation of the icon in degrees.
+     */
+    constructor(description, grid, x, y, icon, rotation = 0) {
+        super(description, grid, x, y);
+        Object.defineProperty(this, "icon", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: icon
+        });
+        Object.defineProperty(this, "rotation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: rotation
+        });
+        this.icon = icon;
+        this.rotation = rotation;
+    }
+    get id() {
+        return `custom_icon`;
+    }
+    get configs() {
+        return CustomIconSymbol.CONFIGS;
+    }
+    copyWith({ description, grid, x, y, icon, rotation, }) {
+        return new CustomIconSymbol(description ?? this.description, grid ?? this.grid, x ?? this.x, y ?? this.y, icon ?? this.icon, rotation ?? this.rotation);
+    }
+    withIcon(icon) {
+        return this.copyWith({ icon });
+    }
+    withRotation(rotation) {
+        return this.copyWith({ rotation });
+    }
+}
+Object.defineProperty(CustomIconSymbol, "EXAMPLE_GRID", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze(new GridData(5, 4))
+});
+Object.defineProperty(CustomIconSymbol, "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.String,
+            default: 'A *custom* text symbol',
+            placeholder: 'Enter description. Emphasize with *asterisks*.',
+            field: 'description',
+            description: 'Description',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Grid,
+            default: CustomIconSymbol.EXAMPLE_GRID,
+            field: 'grid',
+            description: 'Thumbnail Grid',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Icon,
+            default: 'MdQuestionMark',
+            field: 'icon',
+            description: 'Icon',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Number,
+            default: 0,
+            field: 'rotation',
+            description: 'Rotation',
+            configurable: true,
+        },
+    ])
+});
+export default CustomIconSymbol;
+export const instance = new CustomIconSymbol('A *custom* icon symbol', new GridData(5, 4), 0, 0, 'MdQuestionMark');

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

@@ -0,0 +1,23 @@
+import GridData from '../grid';
+import { State } from '../primitives';
+import MultiEntrySymbol from './multiEntrySymbol';
+export default abstract class CustomSymbol extends MultiEntrySymbol {
+    readonly description: string;
+    readonly grid: GridData;
+    /**
+     * **A custom symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     */
+    constructor(description: string, grid: GridData, x: number, y: number);
+    get explanation(): string;
+    createExampleGrid(): GridData;
+    validateSymbol(_grid: GridData): State;
+    get validateWithSolution(): boolean;
+    withDescription(description: string): this;
+    withGrid(grid: GridData): this;
+}
+export declare const instance: undefined;

package/dist/data/symbols/customSymbol.js

@@ -0,0 +1,48 @@
+import { State } from '../primitives';
+import MultiEntrySymbol from './multiEntrySymbol';
+export default class CustomSymbol extends MultiEntrySymbol {
+    /**
+     * **A custom symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     */
+    constructor(description, grid, x, y) {
+        super(x, y);
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: description
+        });
+        Object.defineProperty(this, "grid", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: grid
+        });
+        this.description = description;
+        this.grid = grid;
+    }
+    get explanation() {
+        return this.description;
+    }
+    createExampleGrid() {
+        return this.grid;
+    }
+    validateSymbol(_grid) {
+        return State.Incomplete;
+    }
+    get validateWithSolution() {
+        return true;
+    }
+    withDescription(description) {
+        return this.copyWith({ description });
+    }
+    withGrid(grid) {
+        return this.copyWith({ grid });
+    }
+}
+export const instance = undefined;

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

@@ -0,0 +1,33 @@
+import { AnyConfig } from '../config';
+import GridData from '../grid';
+import CustomSymbol from './customSymbol';
+export default class CustomTextSymbol extends CustomSymbol {
+    readonly text: string;
+    readonly rotation: number;
+    private static readonly EXAMPLE_GRID;
+    private static readonly CONFIGS;
+    /**
+     * **A custom text symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param text - The text to display.
+     * @param rotation - The rotation of the text in degrees.
+     */
+    constructor(description: string, grid: GridData, x: number, y: number, text: string, rotation?: number);
+    get id(): string;
+    get configs(): readonly AnyConfig[] | null;
+    copyWith({ description, grid, x, y, text, rotation, }: {
+        description?: string;
+        grid?: GridData;
+        x?: number;
+        y?: number;
+        text?: string;
+        rotation?: number;
+    }): this;
+    withText(text: string): this;
+    withRotation(rotation: number): this;
+}
+export declare const instance: CustomTextSymbol;

package/dist/data/symbols/customTextSymbol.js

@@ -0,0 +1,106 @@
+import { ConfigType } from '../config';
+import GridData from '../grid';
+import CustomSymbol from './customSymbol';
+class CustomTextSymbol extends CustomSymbol {
+    /**
+     * **A custom text symbol**
+     *
+     * @param description - The description of the symbol. Leave this empty to hide the description.
+     * @param grid - The thumbnail grid of the rule, preferably 5x4 in size.
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param text - The text to display.
+     * @param rotation - The rotation of the text in degrees.
+     */
+    constructor(description, grid, x, y, text, rotation = 0) {
+        super(description, grid, x, y);
+        Object.defineProperty(this, "text", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: text
+        });
+        Object.defineProperty(this, "rotation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: rotation
+        });
+        this.text = text;
+        this.rotation = rotation;
+    }
+    get id() {
+        return `custom_text`;
+    }
+    get configs() {
+        return CustomTextSymbol.CONFIGS;
+    }
+    copyWith({ description, grid, x, y, text, rotation, }) {
+        return new CustomTextSymbol(description ?? this.description, grid ?? this.grid, x ?? this.x, y ?? this.y, text ?? this.text, rotation ?? this.rotation);
+    }
+    withText(text) {
+        return this.copyWith({ text });
+    }
+    withRotation(rotation) {
+        return this.copyWith({ rotation });
+    }
+}
+Object.defineProperty(CustomTextSymbol, "EXAMPLE_GRID", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze(new GridData(5, 4))
+});
+Object.defineProperty(CustomTextSymbol, "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.String,
+            default: 'A *custom* text symbol',
+            placeholder: 'Enter description. Emphasize with *asterisks*.',
+            field: 'description',
+            description: 'Description',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Grid,
+            default: CustomTextSymbol.EXAMPLE_GRID,
+            field: 'grid',
+            description: 'Thumbnail Grid',
+            configurable: true,
+        },
+        {
+            type: ConfigType.String,
+            default: 'X',
+            placeholder: 'Short text to be displayed on the symbol',
+            field: 'text',
+            description: 'Text',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Number,
+            default: 0,
+            field: 'rotation',
+            description: 'Rotation',
+            configurable: true,
+        },
+    ])
+});
+export default CustomTextSymbol;
+export const instance = new CustomTextSymbol('A *custom* text symbol', new GridData(5, 4), 0, 0, 'X');

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

@@ -0,0 +1,35 @@
+import { AnyConfig } from '../config';
+import GridData from '../grid';
+import { Orientation } from '../primitives';
+import NumberSymbol from './numberSymbol';
+export default class DartSymbol extends NumberSymbol {
+    readonly orientation: Orientation;
+    private static readonly CONFIGS;
+    private static readonly EXAMPLE_GRID;
+    /**
+     * **Darts count opposite color cells in that direction**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param number - The number of cells seen by the symbol.
+     * @param orientation - The orientation of the symbol.
+     */
+    constructor(x: number, y: number, number: number, orientation: Orientation);
+    get id(): string;
+    get placementStep(): number;
+    get explanation(): string;
+    get configs(): readonly AnyConfig[] | null;
+    createExampleGrid(): GridData;
+    countTiles(grid: GridData): {
+        completed: number;
+        possible: number;
+    };
+    copyWith({ x, y, number, orientation, }: {
+        x?: number;
+        y?: number;
+        number?: number;
+        orientation?: Orientation;
+    }): this;
+    withNumber(number: number): this;
+}
+export declare const instance: DartSymbol;

package/dist/data/symbols/dartSymbol.js

@@ -0,0 +1,110 @@
+import { ConfigType } from '../config';
+import GridData from '../grid';
+import { Color, Orientation } from '../primitives';
+import NumberSymbol from './numberSymbol';
+class DartSymbol extends NumberSymbol {
+    /**
+     * **Darts count opposite color cells in that direction**
+     *
+     * @param x - The x-coordinate of the symbol.
+     * @param y - The y-coordinate of the symbol.
+     * @param number - The number of cells seen by the symbol.
+     * @param orientation - The orientation of the symbol.
+     */
+    constructor(x, y, number, orientation) {
+        super(x, y, number);
+        Object.defineProperty(this, "orientation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: orientation
+        });
+        this.orientation = orientation;
+    }
+    get id() {
+        return `dart`;
+    }
+    get placementStep() {
+        return 1;
+    }
+    get explanation() {
+        return `*Darts* count opposite color cells in that direction`;
+    }
+    get configs() {
+        return DartSymbol.CONFIGS;
+    }
+    createExampleGrid() {
+        return DartSymbol.EXAMPLE_GRID;
+    }
+    countTiles(grid) {
+        if (Math.floor(this.x) !== this.x || Math.floor(this.y) !== this.y)
+            return { completed: 0, possible: Number.MAX_SAFE_INTEGER };
+        const color = grid.getTile(this.x, this.y).color;
+        if (color === Color.Gray)
+            return { completed: 0, possible: Number.MAX_SAFE_INTEGER };
+        let gray = 0;
+        let opposite = 0;
+        grid.iterateDirectionAll({ x: this.x, y: this.y }, this.orientation, () => true, tile => {
+            if (!tile.exists)
+                return;
+            if (tile.color === Color.Gray)
+                gray++;
+            else if (tile.color !== color)
+                opposite++;
+        });
+        return { completed: opposite, possible: opposite + gray };
+    }
+    copyWith({ x, y, number, orientation, }) {
+        return new DartSymbol(x ?? this.x, y ?? this.y, number ?? this.number, orientation ?? this.orientation);
+    }
+    withNumber(number) {
+        return this.copyWith({ number });
+    }
+}
+Object.defineProperty(DartSymbol, "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.Number,
+            default: 1,
+            field: 'number',
+            description: 'Number',
+            configurable: true,
+        },
+        {
+            type: ConfigType.Orientation,
+            default: Orientation.Right,
+            field: 'orientation',
+            description: 'Orientation',
+            configurable: true,
+        },
+    ])
+});
+Object.defineProperty(DartSymbol, "EXAMPLE_GRID", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Object.freeze(GridData.create(['wwbbw', 'wwwww', 'wbwbb', 'wwwww'])
+        .addSymbol(new DartSymbol(1, 0, 1, Orientation.Down))
+        .addSymbol(new DartSymbol(4, 0, 2, Orientation.Left))
+        .addSymbol(new DartSymbol(3, 1, 1, Orientation.Down))
+        .addSymbol(new DartSymbol(0, 2, 3, Orientation.Right)))
+});
+export default DartSymbol;
+export const instance = new DartSymbol(0, 0, 1, Orientation.Right);