@logic-pad/core 0.4.4 → 0.4.5

package/assets/logic-core.global.d.ts

@@ -368,7 +368,7 @@ declare global {
     readonly x: number;
     readonly y: number;
     constructor(x: number, y: number);
-    abstract validateSymbol(grid: GridData): State;
+    abstract validateSymbol(grid: GridData, solution: GridData | null): State;
     modeVariant(_mode: Mode): Symbol$1 | null;
     onGridResize(
       _grid: GridData,
@@ -521,6 +521,7 @@ declare global {
   {
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
+    readonly normalizeVelocity: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -528,8 +529,13 @@ declare global {
      * **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.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines: readonly ControlLine[], track: GridData | null);
+    constructor(
+      controlLines: readonly ControlLine[],
+      track: GridData | null,
+      normalizeVelocity?: boolean
+    );
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -558,9 +564,11 @@ declare global {
     copyWith({
       controlLines,
       track,
+      normalizeVelocity,
     }: {
       controlLines?: readonly ControlLine[];
       track?: GridData | null;
+      normalizeVelocity?: boolean;
     }): this;
     get validateWithSolution(): boolean;
     get isSingleton(): boolean;
@@ -1194,12 +1202,14 @@ declare global {
      * Controls whether a symbol should be visible in the grid.
      *
      * @param grid The grid that is being displayed.
+     * @param solution The solution grid, if it is available.
      * @param symbol The symbol that is being displayed.
      * @param editing Whether the grid is being edited.
      * @returns True if the symbol should be displayed, false otherwise. The symbol will not be displayed if any handler returns false.
      */
     onSymbolDisplay(
       grid: GridData,
+      solution: GridData | null,
       symbol: Symbol$1,
       editing: boolean
     ): boolean;
@@ -6028,7 +6038,6 @@ declare global {
   {
     readonly x: number;
     readonly y: number;
-    readonly color: Color;
     readonly revealLocation: boolean;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
@@ -6037,10 +6046,9 @@ declare global {
      *
      * @param x - The x-coordinate of the symbol.
      * @param y - The y-coordinate of the symbol.
-     * @param color - The target color of the cell.
      * @param revealLocation - Whether to reveal the location of the symbol.
      */
-    constructor(x: number, y: number, color: Color, revealLocation?: boolean);
+    constructor(x: number, y: number, revealLocation?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -6048,24 +6056,22 @@ declare global {
     get necessaryForCompletion(): boolean;
     get visibleWhenSolving(): boolean;
     get sortOrder(): number;
-    validateSymbol(grid: GridData): State;
+    validateSymbol(grid: GridData, solution: GridData | null): State;
     onSymbolDisplay(
       grid: GridData,
+      solution: GridData | null,
       symbol: Symbol$1,
       editing: boolean
     ): boolean;
     copyWith({
       x,
       y,
-      color,
       revealLocation,
     }: {
       x?: number;
       y?: number;
-      color?: Color;
       revealLocation?: boolean;
     }): this;
-    withColor(color: Color): this;
     withRevealLocation(revealLocation: boolean): this;
   }
   export declare const allSymbols: Map<string, Symbol$1>;

package/dist/data/events/onSymbolDisplay.d.ts

@@ -6,10 +6,11 @@ export interface SymbolDisplayHandler {
      * Controls whether a symbol should be visible in the grid.
      *
      * @param grid The grid that is being displayed.
+     * @param solution The solution grid, if it is available.
      * @param symbol The symbol that is being displayed.
      * @param editing Whether the grid is being edited.
      * @returns True if the symbol should be displayed, false otherwise. The symbol will not be displayed if any handler returns false.
      */
-    onSymbolDisplay(grid: GridData, symbol: Symbol, editing: boolean): boolean;
+    onSymbolDisplay(grid: GridData, solution: GridData | null, symbol: Symbol, editing: boolean): boolean;
 }
 export declare function handlesSymbolDisplay<T extends Instruction>(val: T): val is T & SymbolDisplayHandler;

package/dist/data/rules/musicControlLine.js

@@ -49,7 +49,7 @@ Object.defineProperty(Row, "CONFIGS", {
         },
         {
             type: ConfigType.NullableNumber,
-            default: 0.6,
+            default: 0.5,
             min: 0,
             max: 1,
             step: 0.2,

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

@@ -9,6 +9,7 @@ import Rule, { SearchVariant } from './rule.js';
 export default class MusicGridRule extends Rule implements GridChangeHandler, SetGridHandler, GridResizeHandler {
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
+    readonly normalizeVelocity: boolean;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -16,8 +17,9 @@ export default class MusicGridRule extends Rule implements GridChangeHandler, Se
      * **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.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines: readonly ControlLine[], track: GridData | null);
+    constructor(controlLines: readonly ControlLine[], track: GridData | null, normalizeVelocity?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -34,9 +36,10 @@ export default class MusicGridRule extends Rule implements GridChangeHandler, Se
      */
     setControlLine(controlLine: ControlLine): this;
     withTrack(track: GridData | null): this;
-    copyWith({ controlLines, track, }: {
+    copyWith({ controlLines, track, normalizeVelocity, }: {
         controlLines?: readonly ControlLine[];
         track?: GridData | null;
+        normalizeVelocity?: boolean;
     }): this;
     get validateWithSolution(): boolean;
     get isSingleton(): boolean;

package/dist/data/rules/musicGridRule.js

@@ -6,22 +6,23 @@ import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import { ControlLine, Row } from './musicControlLine.js';
 import Rule from './rule.js';
 const DEFAULT_SCALLE = [
-    new Row('C5', 0.6),
-    new Row('B4', 0.6),
-    new Row('A4', 0.6),
-    new Row('G4', 0.6),
-    new Row('F4', 0.6),
-    new Row('E4', 0.6),
-    new Row('D4', 0.6),
-    new Row('C4', 0.6),
+    new Row('C5', null),
+    new Row('B4', null),
+    new Row('A4', null),
+    new Row('G4', null),
+    new Row('F4', null),
+    new Row('E4', null),
+    new Row('D4', null),
+    new Row('C4', null),
 ];
 class MusicGridRule extends Rule {
     /**
      * **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.
      * @param track The grid to be played when "listen" is clicked. Set as null to play the solution.
+     * @param normalizeVelocity Whether to normalize the velocity of the notes by their pitch such that lower notes are played softer.
      */
-    constructor(controlLines, track) {
+    constructor(controlLines, track, normalizeVelocity = true) {
         super();
         Object.defineProperty(this, "controlLines", {
             enumerable: true,
@@ -35,8 +36,15 @@ class MusicGridRule extends Rule {
             writable: true,
             value: track
         });
+        Object.defineProperty(this, "normalizeVelocity", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: normalizeVelocity
+        });
         this.controlLines = MusicGridRule.deduplicateControlLines(controlLines);
         this.track = track;
+        this.normalizeVelocity = normalizeVelocity;
     }
     get id() {
         return MajorRule.MusicGrid;
@@ -134,8 +142,8 @@ class MusicGridRule extends Rule {
     withTrack(track) {
         return this.copyWith({ track });
     }
-    copyWith({ controlLines, track, }) {
-        return new MusicGridRule(controlLines ?? this.controlLines, track !== undefined ? track : this.track);
+    copyWith({ controlLines, track, normalizeVelocity, }) {
+        return new MusicGridRule(controlLines ?? this.controlLines, track !== undefined ? track : this.track, normalizeVelocity ?? this.normalizeVelocity);
     }
     get validateWithSolution() {
         return true;
@@ -197,6 +205,13 @@ Object.defineProperty(MusicGridRule, "CONFIGS", {
             description: 'Track',
             configurable: true,
         },
+        {
+            type: ConfigType.Boolean,
+            default: true,
+            field: 'normalizeVelocity',
+            description: 'Normalize Velocity',
+            configurable: true,
+        },
     ])
 });
 Object.defineProperty(MusicGridRule, "SEARCH_VARIANTS", {

package/dist/data/serializer/serializer_v0.js

@@ -173,8 +173,10 @@ export default class SerializerV0 extends SerializerBase {
     parseConfig(configs, entry) {
         const [key, value] = entry.split('=');
         const config = configs.find(x => x.field === key);
-        if (!config)
-            throw new Error(`Unknown config: ${key}`);
+        if (!config) {
+            console.warn(`Unknown config: ${key} when parsing ${entry}`);
+            return [key, value];
+        }
         switch (config.type) {
             case ConfigType.Boolean:
                 return [config.field, value === '1'];

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

@@ -1,12 +1,11 @@
 import { AnyConfig } from '../config.js';
 import { SymbolDisplayHandler } from '../events/onSymbolDisplay.js';
 import GridData from '../grid.js';
-import { Color, State } from '../primitives.js';
+import { State } from '../primitives.js';
 import Symbol from './symbol.js';
 export default class HiddenSymbol extends Symbol implements SymbolDisplayHandler {
     readonly x: number;
     readonly y: number;
-    readonly color: Color;
     readonly revealLocation: boolean;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
@@ -15,10 +14,9 @@ export default class HiddenSymbol extends Symbol implements SymbolDisplayHandler
      *
      * @param x - The x-coordinate of the symbol.
      * @param y - The y-coordinate of the symbol.
-     * @param color - The target color of the cell.
      * @param revealLocation - Whether to reveal the location of the symbol.
      */
-    constructor(x: number, y: number, color: Color, revealLocation?: boolean);
+    constructor(x: number, y: number, revealLocation?: boolean);
     get id(): string;
     get explanation(): string;
     get configs(): readonly AnyConfig[] | null;
@@ -26,15 +24,13 @@ export default class HiddenSymbol extends Symbol implements SymbolDisplayHandler
     get necessaryForCompletion(): boolean;
     get visibleWhenSolving(): boolean;
     get sortOrder(): number;
-    validateSymbol(grid: GridData): State;
-    onSymbolDisplay(grid: GridData, symbol: Symbol, editing: boolean): boolean;
-    copyWith({ x, y, color, revealLocation, }: {
+    validateSymbol(grid: GridData, solution: GridData | null): State;
+    onSymbolDisplay(grid: GridData, solution: GridData | null, symbol: Symbol, editing: boolean): boolean;
+    copyWith({ x, y, revealLocation, }: {
         x?: number;
         y?: number;
-        color?: Color;
         revealLocation?: boolean;
     }): this;
-    withColor(color: Color): this;
     withRevealLocation(revealLocation: boolean): this;
 }
 export declare const instance: HiddenSymbol;

package/dist/data/symbols/hiddenSymbol.js

@@ -9,10 +9,9 @@ class HiddenSymbol extends Symbol {
      *
      * @param x - The x-coordinate of the symbol.
      * @param y - The y-coordinate of the symbol.
-     * @param color - The target color of the cell.
      * @param revealLocation - Whether to reveal the location of the symbol.
      */
-    constructor(x, y, color, revealLocation = false) {
+    constructor(x, y, revealLocation = false) {
         super(x, y);
         Object.defineProperty(this, "x", {
             enumerable: true,
@@ -26,19 +25,12 @@ class HiddenSymbol extends Symbol {
             writable: true,
             value: y
         });
-        Object.defineProperty(this, "color", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: color
-        });
         Object.defineProperty(this, "revealLocation", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: revealLocation
         });
-        this.color = color;
         this.revealLocation = revealLocation;
     }
     get id() {
@@ -62,14 +54,20 @@ class HiddenSymbol extends Symbol {
     get sortOrder() {
         return 0;
     }
-    validateSymbol(grid) {
+    validateSymbol(grid, solution) {
         const thisX = Math.floor(this.x);
         const thisY = Math.floor(this.y);
-        return grid.getTile(thisX, thisY).color === this.color
-            ? State.Satisfied
-            : State.Incomplete;
+        const thisColor = grid.getTile(thisX, thisY).color;
+        if (solution) {
+            return thisColor === solution.getTile(thisX, thisY).color
+                ? State.Satisfied
+                : State.Incomplete;
+        }
+        else {
+            return thisColor !== Color.Gray ? State.Satisfied : State.Incomplete;
+        }
     }
-    onSymbolDisplay(grid, symbol, editing) {
+    onSymbolDisplay(grid, solution, symbol, editing) {
         if (editing)
             return true;
         const thisX = Math.floor(this.x);
@@ -78,17 +76,17 @@ class HiddenSymbol extends Symbol {
         const symY = Math.floor(symbol.y);
         if (thisX !== symX || thisY !== symY)
             return true;
-        const colorMatch = grid.getTile(thisX, thisY).color === this.color;
+        const thisColor = grid.getTile(thisX, thisY).color;
+        const colorMatch = solution
+            ? thisColor === solution.getTile(thisX, thisY).color
+            : thisColor !== Color.Gray;
         if (symbol.id === this.id) {
             return !colorMatch;
         }
         return colorMatch;
     }
-    copyWith({ x, y, color, revealLocation, }) {
-        return new HiddenSymbol(x ?? this.x, y ?? this.y, color ?? this.color, revealLocation ?? this.revealLocation);
-    }
-    withColor(color) {
-        return this.copyWith({ color });
+    copyWith({ x, y, revealLocation, }) {
+        return new HiddenSymbol(x ?? this.x, y ?? this.y, revealLocation ?? this.revealLocation);
     }
     withRevealLocation(revealLocation) {
         return this.copyWith({ revealLocation });
@@ -113,14 +111,6 @@ Object.defineProperty(HiddenSymbol, "CONFIGS", {
             description: 'Y',
             configurable: false,
         },
-        {
-            type: ConfigType.Color,
-            default: Color.Light,
-            field: 'color',
-            allowGray: true,
-            description: 'Show on color',
-            configurable: true,
-        },
         {
             type: ConfigType.Boolean,
             default: false,
@@ -138,4 +128,4 @@ Object.defineProperty(HiddenSymbol, "EXAMPLE_GRID", {
     ))
 });
 export default HiddenSymbol;
-export const instance = new HiddenSymbol(0, 0, Color.Light);
+export const instance = new HiddenSymbol(0, 0);

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

@@ -6,7 +6,7 @@ export default abstract class Symbol extends Instruction implements GridResizeHa
     readonly x: number;
     readonly y: number;
     constructor(x: number, y: number);
-    abstract validateSymbol(grid: GridData): State;
+    abstract validateSymbol(grid: GridData, solution: GridData | null): State;
     modeVariant(_mode: Mode): Symbol | null;
     onGridResize(_grid: GridData, mode: 'insert' | 'remove', direction: 'row' | 'column', index: number): this | null;
     /**

package/dist/data/validate.js

@@ -64,7 +64,7 @@ export default function validateGrid(grid, solution) {
     grid.symbols.forEach((symbolList, id) => symbolStates.set(id, symbolList.map(s => {
         if (s.validateWithSolution)
             requireSolution = true;
-        return applySymbolOverrides(grid, grid.rules, s, g => s.validateSymbol(g));
+        return applySymbolOverrides(grid, grid.rules, s, g => s.validateSymbol(g, solution));
     })));
     // apply the result of symbol overrides to the rules that provided them
     symbolOverrideStates.forEach((states, i) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logic-pad/core",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "type": "module",
   "files": [
     "dist",