@logic-pad/core 0.13.4 → 0.15.0

package/dist/data/symbols/areaNumberSymbol.js

@@ -12,6 +12,12 @@ class AreaNumberSymbol extends NumberSymbol {
      */
     constructor(x, y, number) {
         super(x, y, number);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Area Number'
+        });
     }
     get id() {
         return `number`;

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

@@ -4,6 +4,8 @@ import CustomSymbol from './customSymbol.js';
 export default class CustomIconSymbol extends CustomSymbol {
     readonly icon: string;
     readonly rotation: number;
+    readonly title = "Custom Icon Symbol";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     /**

package/dist/data/symbols/customIconSymbol.js

@@ -2,6 +2,9 @@ import { ConfigType } from '../config.js';
 import GridData from '../grid.js';
 import CustomSymbol from './customSymbol.js';
 class CustomIconSymbol extends CustomSymbol {
+    get configExplanation() {
+        return 'A customizable symbol. Your provided solution may override auto-validation.';
+    }
     /**
      * **A custom icon symbol**
      *
@@ -26,6 +29,12 @@ class CustomIconSymbol extends CustomSymbol {
             writable: true,
             value: rotation
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Custom Icon Symbol'
+        });
         this.icon = icon;
         this.rotation = rotation;
     }
@@ -76,6 +85,7 @@ Object.defineProperty(CustomIconSymbol, "CONFIGS", {
             placeholder: 'Enter description. Emphasize with *asterisks*.',
             field: 'description',
             description: 'Description',
+            explanation: 'A short descriptive text. Use *asterisks* to highlight keywords. Leave empty to hide the description.',
             configurable: true,
         },
         {
@@ -83,6 +93,7 @@ Object.defineProperty(CustomIconSymbol, "CONFIGS", {
             default: CustomIconSymbol.EXAMPLE_GRID,
             field: 'grid',
             description: 'Thumbnail Grid',
+            explanation: 'An example grid showing the symbol.',
             configurable: true,
         },
         {
@@ -90,6 +101,7 @@ Object.defineProperty(CustomIconSymbol, "CONFIGS", {
             default: 'MdQuestionMark',
             field: 'icon',
             description: 'Icon',
+            explanation: 'The icon displayed on the grid. All available icons at https://react-icons.github.io/react-icons/icons/md/',
             configurable: true,
         },
         {
@@ -97,6 +109,7 @@ Object.defineProperty(CustomIconSymbol, "CONFIGS", {
             default: 0,
             field: 'rotation',
             description: 'Rotation',
+            explanation: 'Rotate the symbol by the given degrees.',
             configurable: true,
         },
     ])

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

@@ -4,6 +4,8 @@ import CustomSymbol from './customSymbol.js';
 export default class CustomTextSymbol extends CustomSymbol {
     readonly text: string;
     readonly rotation: number;
+    readonly title = "Custom Text Symbol";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     /**

package/dist/data/symbols/customTextSymbol.js

@@ -2,6 +2,9 @@ import { ConfigType } from '../config.js';
 import GridData from '../grid.js';
 import CustomSymbol from './customSymbol.js';
 class CustomTextSymbol extends CustomSymbol {
+    get configExplanation() {
+        return 'A customizable symbol. Your provided solution may override auto-validation.';
+    }
     /**
      * **A custom text symbol**
      *
@@ -26,6 +29,12 @@ class CustomTextSymbol extends CustomSymbol {
             writable: true,
             value: rotation
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Custom Text Symbol'
+        });
         this.text = text;
         this.rotation = rotation;
     }
@@ -76,6 +85,7 @@ Object.defineProperty(CustomTextSymbol, "CONFIGS", {
             placeholder: 'Enter description. Emphasize with *asterisks*.',
             field: 'description',
             description: 'Description',
+            explanation: 'A short descriptive text. Use *asterisks* to highlight keywords. Leave empty to hide the description.',
             configurable: true,
         },
         {
@@ -83,6 +93,7 @@ Object.defineProperty(CustomTextSymbol, "CONFIGS", {
             default: CustomTextSymbol.EXAMPLE_GRID,
             field: 'grid',
             description: 'Thumbnail Grid',
+            explanation: 'An example grid showing the symbol.',
             configurable: true,
         },
         {
@@ -91,6 +102,7 @@ Object.defineProperty(CustomTextSymbol, "CONFIGS", {
             placeholder: 'Short text to be displayed on the symbol',
             field: 'text',
             description: 'Text',
+            explanation: 'The text displayed on the grid. You should use no more than 2 lines of 4 characters each.',
             configurable: true,
         },
         {
@@ -98,6 +110,7 @@ Object.defineProperty(CustomTextSymbol, "CONFIGS", {
             default: 0,
             field: 'rotation',
             description: 'Rotation',
+            explanation: 'Rotate the symbol by the given degrees.',
             configurable: true,
         },
     ])

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

@@ -4,6 +4,7 @@ import { Orientation } from '../primitives.js';
 import NumberSymbol from './numberSymbol.js';
 export default class DartSymbol extends NumberSymbol {
     readonly orientation: Orientation;
+    readonly title = "Dart";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/dartSymbol.js

@@ -19,6 +19,12 @@ class DartSymbol extends NumberSymbol {
             writable: true,
             value: orientation
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Dart'
+        });
         this.orientation = orientation;
     }
     get id() {

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

@@ -3,7 +3,7 @@ import GridData from '../grid.js';
 import { Direction, State } from '../primitives.js';
 import Symbol from './symbol.js';
 export type DirectionLinkerMap = Record<Direction, Direction>;
-export default class DirectionLinkerSymbol extends Symbol {
+export default abstract class DirectionLinkerSymbol extends Symbol {
     readonly x: number;
     readonly y: number;
     private static readonly CONFIGS;
@@ -24,10 +24,6 @@ export default class DirectionLinkerSymbol extends Symbol {
     createExampleGrid(): GridData;
     private deltaCoordinate;
     validateSymbol(grid: GridData): State;
-    copyWith({ x, y }: {
-        x?: number;
-        y?: number;
-    }): this;
     private getInitialCheckedCouples;
 }
 export declare const instance: undefined;

package/dist/data/symbols/directionLinkerSymbol.js

@@ -151,9 +151,6 @@ class DirectionLinkerSymbol extends Symbol {
         }
         return grayFound ? State.Incomplete : State.Satisfied;
     }
-    copyWith({ x, y }) {
-        return new DirectionLinkerSymbol(x ?? this.x, y ?? this.y);
-    }
     getInitialCheckedCouples(x, y, grid) {
         // 1x1
         if (x % 1 === 0 && y % 1 === 0) {

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

@@ -2,6 +2,7 @@ import { AnyConfig } from '../config.js';
 import GridData from '../grid.js';
 import NumberSymbol from './numberSymbol.js';
 export default class FocusSymbol extends NumberSymbol {
+    readonly title = "Focus Number";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/focusSymbol.js

@@ -17,6 +17,12 @@ class FocusSymbol extends NumberSymbol {
      */
     constructor(x, y, number) {
         super(x, y, number);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Focus Number'
+        });
     }
     get id() {
         return `focus`;

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

@@ -5,6 +5,7 @@ import DirectionLinkerSymbol from './directionLinkerSymbol.js';
 export default class GalaxySymbol extends DirectionLinkerSymbol {
     readonly x: number;
     readonly y: number;
+    readonly title = "Galaxy";
     private static readonly linkedDirections;
     /**
      * **Galaxies are centers of rotational symmetry**

package/dist/data/symbols/galaxySymbol.js

@@ -23,6 +23,12 @@ class GalaxySymbol extends DirectionLinkerSymbol {
             writable: true,
             value: y
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Galaxy'
+        });
         super.changeDirections(GalaxySymbol.linkedDirections);
     }
     get id() {

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

@@ -7,6 +7,8 @@ export default class HiddenSymbol extends Symbol implements SymbolDisplayHandler
     readonly x: number;
     readonly y: number;
     readonly revealLocation: boolean;
+    readonly title = "Hidden Symbol Marker";
+    get configExplanation(): string;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/hiddenSymbol.js

@@ -4,6 +4,9 @@ import { Color, State } from '../primitives.js';
 import CustomIconSymbol from './customIconSymbol.js';
 import Symbol from './symbol.js';
 class HiddenSymbol extends Symbol {
+    get configExplanation() {
+        return 'Other symbols in the same location will be hidden until this tile is colored correctly.';
+    }
     /**
      * **Hidden Symbols: color cells correctly to reveal more clues**
      *
@@ -31,6 +34,12 @@ class HiddenSymbol extends Symbol {
             writable: true,
             value: revealLocation
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Hidden Symbol Marker'
+        });
         this.revealLocation = revealLocation;
     }
     get id() {
@@ -116,6 +125,7 @@ Object.defineProperty(HiddenSymbol, "CONFIGS", {
             default: false,
             field: 'revealLocation',
             description: 'Reveal symbol location',
+            explanation: 'Whether to show this symbol when the tile is not yet colored correctly.',
             configurable: true,
         },
     ])

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

@@ -6,6 +6,7 @@ export default class LetterSymbol extends Symbol {
     readonly x: number;
     readonly y: number;
     readonly letter: string;
+    readonly title = "Letter";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/letterSymbol.js

@@ -31,6 +31,12 @@ class LetterSymbol extends Symbol {
             writable: true,
             value: letter
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Letter'
+        });
         this.letter = letter;
     }
     get id() {
@@ -116,6 +122,7 @@ Object.defineProperty(LetterSymbol, "CONFIGS", {
             default: 'A',
             field: 'letter',
             description: 'Letter',
+            explanation: 'Use single uppercase letters by convention.',
             configurable: true,
         },
     ])

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

@@ -6,6 +6,7 @@ export default class LotusSymbol extends DirectionLinkerSymbol {
     readonly x: number;
     readonly y: number;
     readonly orientation: Orientation;
+    readonly title = "Lotus";
     private static readonly linkedDirectionsFromOrientation;
     /**
      * **Areas containing this symbol must be symmetrical**

package/dist/data/symbols/lotusSymbol.js

@@ -30,6 +30,12 @@ class LotusSymbol extends DirectionLinkerSymbol {
             writable: true,
             value: orientation
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Lotus'
+        });
         super.changeDirections(LotusSymbol.linkedDirectionsFromOrientation[orientation]);
     }
     get id() {

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

@@ -2,6 +2,7 @@ import { AnyConfig } from '../config.js';
 import GridData from '../grid.js';
 import NumberSymbol from './numberSymbol.js';
 export default class MinesweeperSymbol extends NumberSymbol {
+    readonly title = "Minesweeper Number";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/minesweeperSymbol.js

@@ -12,6 +12,12 @@ class MinesweeperSymbol extends NumberSymbol {
      */
     constructor(x, y, number) {
         super(x, y, number);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Minesweeper Number'
+        });
     }
     get id() {
         return `minesweeper`;

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

@@ -5,6 +5,7 @@ import MultiEntrySymbol from './multiEntrySymbol.js';
 export default class MyopiaSymbol extends MultiEntrySymbol {
     readonly diagonals: boolean;
     readonly directions: OrientationToggle;
+    get title(): "Framed Myopia Arrow" | "Myopia Arrow";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     private static readonly EXAMPLE_DIAGONAL_GRID;

package/dist/data/symbols/myopiaSymbol.js

@@ -4,6 +4,9 @@ import GridData from '../grid.js';
 import { Color, ORIENTATIONS, Orientation, State, orientationToggle, } from '../primitives.js';
 import MultiEntrySymbol from './multiEntrySymbol.js';
 class MyopiaSymbol extends MultiEntrySymbol {
+    get title() {
+        return this.diagonals ? 'Framed Myopia Arrow' : 'Myopia Arrow';
+    }
     /**
      * **Viewpoint Numbers count visible cells in the four directions**
      * @param x - The x-coordinate of the symbol.
@@ -165,6 +168,7 @@ Object.defineProperty(MyopiaSymbol, "CONFIGS", {
             default: false,
             field: 'diagonals',
             description: 'Include diagonal directions',
+            explanation: 'Whether to check diagonals as well. Must be enabled for diagonal arrows.',
             configurable: true,
         },
         {
@@ -172,6 +176,7 @@ Object.defineProperty(MyopiaSymbol, "CONFIGS", {
             default: orientationToggle(Orientation.Up, Orientation.Right),
             field: 'directions',
             description: 'Directions',
+            explanation: 'The directions in which an arrow is pointing. A dot will be displayed if no arrows are present.',
             configurable: true,
         },
     ])

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

@@ -2,6 +2,7 @@ import { AnyConfig } from '../config.js';
 import GridData from '../grid.js';
 import NumberSymbol from './numberSymbol.js';
 export default class ViewpointSymbol extends NumberSymbol {
+    readonly title = "Viewpoint Number";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/symbols/viewpointSymbol.js

@@ -12,6 +12,12 @@ class ViewpointSymbol extends NumberSymbol {
      */
     constructor(x, y, number) {
         super(x, y, number);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Viewpoint Number'
+        });
     }
     get id() {
         return `viewpoint`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logic-pad/core",
-  "version": "0.13.4",
+  "version": "0.15.0",
   "type": "module",
   "files": [
     "dist",
@@ -43,7 +43,7 @@
   "scripts": {
     "build": "rimraf dist/ && bun run codegen && bunx --bun tsc && bun run typegen",
     "lint": "cd ../../ && eslint ./packages/logic-core --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "codegen": "bun ./scripts/genEntry.ts && bun ./scripts/genImports.ts",
+    "codegen": "bun ./scripts/genImports.ts && bun ./scripts/genEntry.ts",
     "typegen": "bun ./scripts/genTypes.ts",
     "prepublishOnly": "bun run build"
   },