@logic-pad/core 0.13.4 → 0.15.0

package/dist/data/rules/customRule.js

@@ -3,6 +3,9 @@ import GridData from '../grid.js';
 import { State } from '../primitives.js';
 import Rule from './rule.js';
 class CustomRule extends Rule {
+    get configExplanation() {
+        return 'A customizable rule. Your provided solution may override auto-validation.';
+    }
     /**
      * A custom rule with a description and thumbnail grid.
      *
@@ -25,6 +28,12 @@ class CustomRule extends Rule {
             writable: true,
             value: grid
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Custom Rule'
+        });
         this.description = description;
         this.grid = grid;
     }
@@ -69,6 +78,7 @@ Object.defineProperty(CustomRule, "configs", {
             default: 'A *custom* rule',
             field: 'description',
             description: 'Description',
+            explanation: 'A short descriptive text. Use *asterisks* to highlight keywords.',
             configurable: true,
         },
         {
@@ -76,6 +86,7 @@ Object.defineProperty(CustomRule, "configs", {
             default: CustomRule.EXAMPLE_GRID,
             field: 'grid',
             description: 'Thumbnail Grid',
+            explanation: 'An example grid showing the rule.',
             configurable: true,
         },
     ])

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

@@ -7,6 +7,8 @@ export default class ForesightRule extends Rule {
     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;

package/dist/data/rules/foresightRule.js

@@ -4,6 +4,9 @@ import { State, Mode } from '../primitives.js';
 import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import Rule from './rule.js';
 class ForesightRule extends Rule {
+    get configExplanation() {
+        return 'Provide automatic hints to the player.';
+    }
     /**
      * **Foresight: Show hints**
      */
@@ -33,6 +36,12 @@ class ForesightRule extends Rule {
             writable: true,
             value: solvePath
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Foresight'
+        });
         this.count = count;
         this.regenInterval = regenInterval;
         this.startFull = startFull;
@@ -93,6 +102,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             min: 1,
             field: 'count',
             description: 'Foresight count',
+            explanation: 'Maximum number of foresight charges that can be stored.',
             configurable: true,
         },
         {
@@ -101,6 +111,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             min: 1,
             field: 'regenInterval',
             description: 'Regen Interval (seconds)',
+            explanation: 'Time taken for one foresight charge to regenerate.',
             configurable: true,
         },
         {
@@ -108,6 +119,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             default: false,
             field: 'startFull',
             description: 'Start with full foresight',
+            explanation: 'Whether to start with all foresight charges available.',
             configurable: true,
         },
         {
@@ -115,6 +127,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             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,
         },
     ])

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

@@ -5,6 +5,7 @@ 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;

package/dist/data/rules/lyingSymbolRule.js

@@ -23,6 +23,12 @@ class IgnoredSymbol extends Symbol {
             writable: true,
             value: state
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Ignored Symbol'
+        });
         this.symbol = symbol;
         this.state = state;
     }
@@ -75,6 +81,12 @@ class IgnoredRule extends Rule {
             writable: true,
             value: state
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Ignored Rule'
+        });
         this.rule = rule;
         this.state = state;
     }
@@ -129,6 +141,12 @@ class LyingSymbolRule extends Rule {
             writable: true,
             value: count
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Lying Symbols'
+        });
         this.count = count;
     }
     get id() {
@@ -223,6 +241,7 @@ Object.defineProperty(LyingSymbolRule, "CONFIGS", {
             step: 1,
             field: 'count',
             description: 'Number of liars',
+            explanation: 'Number of symbols that are not satisfied in the final solution.',
             configurable: true,
         },
     ])

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

@@ -11,6 +11,8 @@ export declare class Row extends Configurable {
      * Ranges from 0 to 1
      */
     readonly velocity: number | null;
+    readonly title = "Music Grid - Row";
+    readonly configExplanation = "Configure the playback settings from this tile onwards.";
     private static readonly CONFIGS;
     constructor(
     /**
@@ -35,6 +37,8 @@ export declare class ControlLine extends Configurable {
     readonly pedal: boolean | null;
     readonly checkpoint: boolean;
     readonly rows: readonly Row[];
+    readonly title = "Music Grid - Control Line";
+    readonly configExplanation = "Configure the playback settings from this point onwards.";
     private static readonly CONFIGS;
     /**
      * Configure playback settings, taking effect at the given column (inclusive)

package/dist/data/rules/musicControlLine.js

@@ -25,6 +25,18 @@ export class Row extends Configurable {
             writable: true,
             value: velocity
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Music Grid - Row'
+        });
+        Object.defineProperty(this, "configExplanation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Configure the playback settings from this tile onwards.'
+        });
         this.note = note;
         this.velocity = velocity;
     }
@@ -45,6 +57,7 @@ Object.defineProperty(Row, "CONFIGS", {
             default: 'C4',
             field: 'note',
             description: 'Note',
+            explanation: 'The musical note or sample to play.',
             configurable: true,
         },
         {
@@ -55,6 +68,7 @@ Object.defineProperty(Row, "CONFIGS", {
             step: 0.2,
             field: 'velocity',
             description: 'Velocity',
+            explanation: 'For piano notes, how hard the note is played.',
             configurable: true,
         },
     ])
@@ -100,6 +114,18 @@ export class ControlLine extends Configurable {
             writable: true,
             value: rows
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Music Grid - Control Line'
+        });
+        Object.defineProperty(this, "configExplanation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Configure the playback settings from this point onwards.'
+        });
         this.column = Math.floor(column);
         this.bpm = bpm;
         this.pedal = pedal;
@@ -157,6 +183,7 @@ Object.defineProperty(ControlLine, "CONFIGS", {
             max: 1000,
             field: 'bpm',
             description: 'BPM',
+            explanation: 'Beats per minute for the playback.',
             configurable: true,
         },
         {
@@ -164,6 +191,7 @@ Object.defineProperty(ControlLine, "CONFIGS", {
             default: false,
             field: 'pedal',
             description: 'Pedal',
+            explanation: 'For piano notes, whether the pedal is pressed to sustain the sound.',
             configurable: true,
         },
         {
@@ -171,6 +199,7 @@ Object.defineProperty(ControlLine, "CONFIGS", {
             default: false,
             field: 'checkpoint',
             description: 'Checkpoint',
+            explanation: 'Whether players can start playback from this position.',
             configurable: true,
         },
     ])

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

@@ -10,6 +10,8 @@ export default class MusicGridRule extends Rule implements GridChangeHandler, Se
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
     readonly normalizeVelocity: boolean;
+    readonly title = "Music Grid";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/musicGridRule.js

@@ -16,6 +16,9 @@ const DEFAULT_SCALLE = [
     new Row('C4', null),
 ];
 class MusicGridRule extends Rule {
+    get configExplanation() {
+        return 'Solve the grid by listening to the solution being played back.';
+    }
     /**
      * **Music Grid: Listen to the solution**
      * @param controlLines Denote changes in the playback settings. At least one control line at column 0 should be present to enable playback.
@@ -42,6 +45,12 @@ class MusicGridRule extends Rule {
             writable: true,
             value: normalizeVelocity
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Music Grid'
+        });
         this.controlLines = MusicGridRule.deduplicateControlLines(controlLines);
         this.track = track;
         this.normalizeVelocity = normalizeVelocity;
@@ -208,6 +217,7 @@ Object.defineProperty(MusicGridRule, "CONFIGS", {
             ]).addRule(new MusicGridRule([new ControlLine(0, 120, false, false, DEFAULT_SCALLE)], null)),
             field: 'track',
             description: 'Track',
+            explanation: 'If set, this grid will be played instead of the solution.',
             configurable: true,
         },
         {
@@ -215,6 +225,7 @@ Object.defineProperty(MusicGridRule, "CONFIGS", {
             default: true,
             field: 'normalizeVelocity',
             description: 'Normalize Velocity',
+            explanation: 'Whether to adjust note velocities by their pitch such that every note has the same perceived loudness.',
             configurable: true,
         },
     ])

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

@@ -8,6 +8,8 @@ import Rule, { SearchVariant } from './rule.js';
 export default class MysteryRule extends Rule implements FinalValidationHandler, GridChangeHandler, GridResizeHandler {
     readonly solution: GridData;
     readonly visible: boolean;
+    readonly title = "Alternate Solution";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/mysteryRule.js

@@ -5,6 +5,9 @@ import { Color, State } from '../primitives.js';
 import CustomTextSymbol from '../symbols/customTextSymbol.js';
 import Rule from './rule.js';
 class MysteryRule extends Rule {
+    get configExplanation() {
+        return 'You may use multiple instances of this rule to provide multiple alternate solutions.';
+    }
     /**
      * **Mystery: alternate solution**
      */
@@ -22,6 +25,12 @@ class MysteryRule extends Rule {
             writable: true,
             value: visible
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Alternate Solution'
+        });
         this.solution = MysteryRule.cleanSolution(solution);
         this.visible = visible;
     }
@@ -141,6 +150,7 @@ Object.defineProperty(MysteryRule, "CONFIGS", {
             resizable: false,
             field: 'solution',
             description: 'Solution',
+            explanation: 'The alternate solution to the puzzle. Does not need to satisfy puzzle rules / symbols.',
             configurable: true,
         },
         {
@@ -148,6 +158,7 @@ Object.defineProperty(MysteryRule, "CONFIGS", {
             default: true,
             field: 'visible',
             description: 'Visible',
+            explanation: 'Display this rule to the player.',
             configurable: true,
         },
     ])

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

@@ -6,6 +6,7 @@ import Symbol from '../symbols/symbol.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class OffByXRule extends Rule implements SymbolValidationHandler {
     readonly number: number;
+    readonly title = "Off By X";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/offByXRule.js

@@ -18,6 +18,12 @@ class OffByXRule extends Rule {
             writable: true,
             value: number
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Off By X'
+        });
         this.number = number;
     }
     get id() {

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

@@ -6,6 +6,8 @@ import { SetGridHandler } from '../events/onSetGrid.js';
 import { FinalValidationHandler } from '../events/onFinalValidation.js';
 export default class PerfectionRule extends Rule implements SetGridHandler, FinalValidationHandler {
     readonly editor: boolean;
+    readonly title = "Perfection";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**

package/dist/data/rules/perfectionRule.js

@@ -4,6 +4,9 @@ import Rule from './rule.js';
 import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import validateGrid from '../validate.js';
 class PerfectionRule extends Rule {
+    get configExplanation() {
+        return 'You should allow players to enable perfection mode themselves instead of enforcing this rule.';
+    }
     /**
      * **Quest for Perfection: cell colors are final**
      *
@@ -17,6 +20,12 @@ class PerfectionRule extends Rule {
             writable: true,
             value: editor
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Perfection'
+        });
         this.editor = editor;
     }
     get id() {

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

@@ -5,6 +5,7 @@ import Rule, { SearchVariant } from './rule.js';
 export default class RegionAreaRule extends Rule {
     readonly color: Color;
     readonly size: number;
+    readonly title = "Region Area Size";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_DARK;
     private static readonly EXAMPLE_GRID_LIGHT;

package/dist/data/rules/regionAreaRule.js

@@ -25,6 +25,12 @@ class RegionAreaRule extends Rule {
             writable: true,
             value: size
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Region Area Size'
+        });
         this.color = color;
         this.size = size;
     }

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

@@ -4,6 +4,7 @@ import { Color, RuleState } from '../primitives.js';
 import RegionShapeRule from './regionShapeRule.js';
 import { SearchVariant } from './rule.js';
 export default class SameShapeRule extends RegionShapeRule {
+    readonly title = "Same Shape Areas";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;

package/dist/data/rules/sameShapeRule.js

@@ -11,6 +11,12 @@ class SameShapeRule extends RegionShapeRule {
      */
     constructor(color) {
         super(color);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Same Shape Areas'
+        });
     }
     get id() {
         return `same_shape`;

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

@@ -6,6 +6,7 @@ export default class SymbolsPerRegionRule extends Rule {
     readonly color: Color;
     readonly count: number;
     readonly comparison: Comparison;
+    readonly title = "Symbols Per Area";
     private static readonly SYMBOL_POSITIONS;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRIDS;

package/dist/data/rules/symbolsPerRegionRule.js

@@ -33,6 +33,12 @@ class SymbolsPerRegionRule extends Rule {
             writable: true,
             value: comparison
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Symbols Per Area'
+        });
         this.color = color;
         this.count = count;
         this.comparison = comparison;

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

@@ -2,6 +2,8 @@ import GridData from '../grid.js';
 import { RuleState } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class UndercluedRule extends Rule {
+    readonly title = "Underclued";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**

package/dist/data/rules/undercluedRule.js

@@ -4,6 +4,9 @@ import AreaNumberSymbol from '../symbols/areaNumberSymbol.js';
 import CustomTextSymbol from '../symbols/customTextSymbol.js';
 import Rule from './rule.js';
 class UndercluedRule extends Rule {
+    get configExplanation() {
+        return 'A solution must be provided. The solvers may be used to generate one automatically.';
+    }
     /**
      * **Underclued Grid: Mark only what is definitely true**
      *
@@ -11,6 +14,12 @@ class UndercluedRule extends Rule {
      */
     constructor() {
         super();
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Underclued'
+        });
     }
     get id() {
         return MajorRule.Underclued;

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

@@ -4,6 +4,7 @@ import { Color, RuleState } from '../primitives.js';
 import RegionShapeRule from './regionShapeRule.js';
 import { SearchVariant } from './rule.js';
 export default class UniqueShapeRule extends RegionShapeRule {
+    readonly title = "Unique Shape Areas";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;

package/dist/data/rules/uniqueShapeRule.js

@@ -10,6 +10,12 @@ class UniqueShapeRule extends RegionShapeRule {
      */
     constructor(color) {
         super(color);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Unique Shape Areas'
+        });
     }
     get id() {
         return `unique_shape`;

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

@@ -6,6 +6,8 @@ import Rule, { SearchVariant } from './rule.js';
 export default class WrapAroundRule extends Rule implements GetTileHandler {
     readonly horizontal: Wrapping;
     readonly vertical: Wrapping;
+    readonly title = "Wrap Around";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID_NONE;
     private static readonly EXAMPLE_GRID_HORIZONTAL;
     private static readonly EXAMPLE_GRID_VERTICAL;

package/dist/data/rules/wrapAroundRule.js

@@ -6,6 +6,9 @@ import LetterSymbol from '../symbols/letterSymbol.js';
 import MyopiaSymbol from '../symbols/myopiaSymbol.js';
 import Rule from './rule.js';
 class WrapAroundRule extends Rule {
+    get configExplanation() {
+        return 'Allow edges to connect with each other and symbols / rules to take effect across edges.';
+    }
     /**
      * **The left and right edges are connected (in reverse)**
      *
@@ -26,6 +29,12 @@ class WrapAroundRule extends Rule {
             writable: true,
             value: vertical
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Wrap Around'
+        });
         this.horizontal = horizontal;
         this.vertical = vertical;
     }

package/dist/data/serializer/serializer_checksum.js

@@ -2,6 +2,7 @@ import { ConfigType, } from '../config.js';
 import SerializerV0, { orientationChars } from './serializer_v0.js';
 import { DIRECTIONS, ORIENTATIONS, } from '../primitives.js';
 import { escape } from '../dataHelper.js';
+import { normalizeShape, tilesToShape } from '../shapes.js';
 export default class SerializerChecksum extends SerializerV0 {
     constructor() {
         super(...arguments);
@@ -9,7 +10,7 @@ export default class SerializerChecksum extends SerializerV0 {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 2
+            value: 3
         });
     }
     parseTile(_str) {
@@ -91,6 +92,13 @@ export default class SerializerChecksum extends SerializerV0 {
                 return (config.field +
                     '=' +
                     escape(this.stringifyGrid(instruction[config.field])));
+            case ConfigType.Shape:
+                return (config.field +
+                    '=' +
+                    escape(normalizeShape(tilesToShape(instruction[config.field].tiles))
+                        .elements.map(elm => `${elm.x}-${elm.y}-${elm.color}`)
+                        .sort()
+                        .join('/')));
             case ConfigType.NullableGrid:
                 return (config.field +
                     '=' +
@@ -137,6 +145,7 @@ export default class SerializerChecksum extends SerializerV0 {
     }
     stringifyRules(rules) {
         return `R${rules
+            .filter(rule => rule.necessaryForCompletion)
             .map(rule => this.stringifyRule(rule))
             .sort()
             .join(':')}`;
@@ -147,6 +156,7 @@ export default class SerializerChecksum extends SerializerV0 {
     stringifySymbols(symbols) {
         return `S${Array.from(symbols.values())
             .flat()
+            .filter(symbol => symbol.necessaryForCompletion)
             .map(symbol => this.stringifySymbol(symbol))
             .sort()
             .join(':')}`;

package/dist/data/serializer/serializer_v0.js

@@ -147,6 +147,7 @@ export default class SerializerV0 extends SerializerBase {
                         ? ''
                         : escape(String(instruction[config.field]))));
             case ConfigType.Tile:
+            case ConfigType.Shape:
             case ConfigType.Grid:
                 return (config.field +
                     '=' +
@@ -215,6 +216,7 @@ export default class SerializerV0 extends SerializerBase {
             case ConfigType.Icon:
                 return [config.field, unescape(value)];
             case ConfigType.Tile:
+            case ConfigType.Shape:
             case ConfigType.Grid:
                 return [config.field, this.parseGrid(unescape(value))];
             case ConfigType.NullableGrid:

package/dist/data/shapes.js

@@ -1,3 +1,5 @@
+import GridConnections from './gridConnections.js';
+import GridZones from './gridZones.js';
 import { Color } from './primitives.js';
 const colorIndex = {
     [Color.Dark]: 2,
@@ -44,6 +46,12 @@ function recenterShape(shape) {
     }
     shape.width = maxX - minX + 1;
     shape.height = maxY - minY + 1;
+    if (!Number.isFinite(shape.width)) {
+        shape.width = 0;
+    }
+    if (!Number.isFinite(shape.height)) {
+        shape.height = 0;
+    }
     return shape;
 }
 export function tilesToShape(tiles) {
@@ -123,5 +131,7 @@ export function sanitizePatternGrid(pattern, tileMapper = t => t) {
         : t.copyWith({ exists: true, color: Color.Gray, fixed: false })))))
         // strip all symbols and rules
         .withRules([])
-        .withSymbols(new Map()));
+        .withSymbols(new Map())
+        .withConnections(new GridConnections())
+        .withZones(new GridZones()));
 }

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

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