@logic-pad/core 0.26.1 → 0.26.2

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

@@ -1,207 +0,0 @@
-import { ConfigType } from '../config.js';
-import GridData from '../grid.js';
-import { Color, Orientation, State, } from '../primitives.js';
-import Rule from './rule.js';
-import validateGrid from '../validate.js';
-import Symbol from '../symbols/symbol.js';
-import LetterSymbol from '../symbols/letterSymbol.js';
-import GalaxySymbol from '../symbols/galaxySymbol.js';
-import LotusSymbol from '../symbols/lotusSymbol.js';
-import AreaNumberSymbol from '../symbols/areaNumberSymbol.js';
-class IgnoredSymbol extends Symbol {
-    symbol;
-    state;
-    title = 'Ignored Symbol';
-    constructor(symbol, state) {
-        super(symbol.x, symbol.y);
-        this.symbol = symbol;
-        this.state = state;
-        this.symbol = symbol;
-        this.state = state;
-    }
-    get id() {
-        return `ignored_${this.symbol.id}`;
-    }
-    get explanation() {
-        return this.symbol.explanation;
-    }
-    get configs() {
-        return [];
-    }
-    createExampleGrid() {
-        return this.symbol.createExampleGrid();
-    }
-    get necessaryForCompletion() {
-        return this.symbol.necessaryForCompletion;
-    }
-    get visibleWhenSolving() {
-        return this.symbol.visibleWhenSolving;
-    }
-    get sortOrder() {
-        return this.symbol.sortOrder;
-    }
-    validateSymbol(_grid, _solution) {
-        return this.state;
-    }
-    copyWith({ symbol, state }) {
-        return new IgnoredSymbol(symbol ?? this.symbol, state ?? this.state);
-    }
-    withSymbol(symbol) {
-        return this.copyWith({ symbol });
-    }
-    equals(other) {
-        return other === this;
-    }
-}
-class IgnoredRule extends Rule {
-    rule;
-    state;
-    title = 'Ignored Rule';
-    constructor(rule, state) {
-        super();
-        this.rule = rule;
-        this.state = state;
-        this.rule = rule;
-        this.state = state;
-    }
-    get searchVariants() {
-        return [];
-    }
-    get id() {
-        return `ignored_${this.rule.id}`;
-    }
-    get explanation() {
-        return this.rule.explanation;
-    }
-    get configs() {
-        return [];
-    }
-    createExampleGrid() {
-        return this.rule.createExampleGrid();
-    }
-    get necessaryForCompletion() {
-        return this.rule.necessaryForCompletion;
-    }
-    get visibleWhenSolving() {
-        return this.rule.visibleWhenSolving;
-    }
-    get isSingleton() {
-        return this.rule.isSingleton;
-    }
-    validateGrid(_grid) {
-        if (this.state === State.Error)
-            return { state: State.Error, positions: [] };
-        else
-            return { state: this.state };
-    }
-    copyWith({ rule, state }) {
-        return new IgnoredRule(rule ?? this.rule, state ?? this.state);
-    }
-    equals(other) {
-        return other === this;
-    }
-}
-export default class LyingSymbolRule extends Rule {
-    count;
-    title = 'Lying Symbols';
-    static EXAMPLE_GRID = Object.freeze(GridData.create(['bbbbw', 'wwbbb', 'bbbbw', 'wbbww']).withSymbols([
-        new LetterSymbol(4, 0, 'A'),
-        new GalaxySymbol(1, 1),
-        new LotusSymbol(2, 2, Orientation.Up),
-        new LetterSymbol(0, 3, 'A'),
-        new AreaNumberSymbol(4, 3, 1),
-    ]));
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.Number,
-            default: 1,
-            min: 1,
-            max: 100,
-            step: 1,
-            field: 'count',
-            description: 'Number of liars',
-            explanation: 'Number of symbols that are not satisfied in the final solution.',
-            configurable: true,
-        },
-    ]);
-    static SEARCH_VARIANTS = [
-        new LyingSymbolRule(1).searchVariant(),
-    ];
-    /**
-     * **<count> symbols are lying and are incorrect**
-     *
-     * @param count Number of lying symbols
-     */
-    constructor(count) {
-        super();
-        this.count = count;
-        this.count = count;
-    }
-    get id() {
-        return `lying_symbols`;
-    }
-    get explanation() {
-        return `${this.count} symbol${this.count <= 1 ? ' is' : 's are'} *lying* and ${this.count <= 1 ? 'is' : 'are'} incorrect`;
-    }
-    get configs() {
-        return LyingSymbolRule.CONFIGS;
-    }
-    createExampleGrid() {
-        return LyingSymbolRule.EXAMPLE_GRID;
-    }
-    get searchVariants() {
-        return LyingSymbolRule.SEARCH_VARIANTS;
-    }
-    validateGrid(_) {
-        return { state: State.Incomplete };
-    }
-    get isSingleton() {
-        return true;
-    }
-    onFinalValidation(grid, solution, state) {
-        const ignoredSymbols = [];
-        state.symbols.forEach((values, key) => {
-            values.forEach((state, idx) => {
-                if (state === State.Error)
-                    ignoredSymbols.push([key, idx]);
-            });
-        });
-        if (ignoredSymbols.length > this.count) {
-            const thisIdx = grid.rules.findIndex(rule => rule.id === this.id);
-            return {
-                final: State.Error,
-                rules: state.rules.map((rule, idx) => idx === thisIdx ? { state: State.Error, positions: [] } : rule),
-                symbols: state.symbols,
-            };
-        }
-        const newSymbols = new Map();
-        grid.symbols.forEach((values, key) => {
-            values.forEach((symbol, idx) => {
-                if (!newSymbols.has(key)) {
-                    newSymbols.set(key, []);
-                }
-                if (ignoredSymbols.some(([k, i]) => k === key && i === idx)) {
-                    newSymbols.get(key).push(new IgnoredSymbol(symbol, State.Ignored));
-                }
-                else {
-                    newSymbols.get(key).push(symbol);
-                }
-            });
-        });
-        const newRules = grid.rules.map(rule => rule.id === this.id
-            ? new IgnoredRule(this, ignoredSymbols.length === this.count
-                ? State.Satisfied
-                : grid.getTileCount(true, false, Color.Gray) === 0
-                    ? State.Error
-                    : State.Incomplete)
-            : rule);
-        return validateGrid(grid.copyWith({ rules: newRules, symbols: newSymbols }), solution);
-    }
-    copyWith({ count }) {
-        return new LyingSymbolRule(count ?? this.count);
-    }
-    withCount(count) {
-        return this.copyWith({ count });
-    }
-}
-export const instance = new LyingSymbolRule(1);

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

@@ -1,82 +0,0 @@
-import { AnyConfig } from '../config.js';
-import Configurable from '../configurable.js';
-import { Instrument } from '../primitives.js';
-export declare class Row extends Configurable {
-    /**
-     * The note to play at this row, or null to keep the current note from the previous control line.
-     * If this is null from the first control line, the note will be silent.
-     */
-    readonly note: string | null;
-    /**
-     * The instrument to play the note with, or null to keep the current instrument from the previous control line.
-     * If this is null from the first control line, the instrument will be "piano".
-     * This has no effect if the current note is a drum sample.
-     */
-    readonly instrument: Instrument | null;
-    /**
-     * The velocity to play the note at, or null to keep the current velocity from the previous control line.
-     * 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(
-    /**
-     * The note to play at this row, or null to keep the current note from the previous control line.
-     * If this is null from the first control line, the note will be silent.
-     */
-    note: string | null, 
-    /**
-     * The instrument to play the note with, or null to keep the current instrument from the previous control line.
-     * If this is null from the first control line, the instrument will be "piano".
-     * This has no effect if the current note is a drum sample.
-     */
-    instrument: Instrument | null, 
-    /**
-     * The velocity to play the note at, or null to keep the current velocity from the previous control line.
-     * Ranges from 0 to 1
-     */
-    velocity: number | null);
-    get configs(): readonly AnyConfig[] | null;
-    copyWith({ note, instrument, velocity, }: {
-        note?: string | null;
-        instrument?: Instrument | null;
-        velocity?: number | null;
-    }): this;
-}
-export declare class ControlLine extends Configurable {
-    readonly column: number;
-    readonly bpm: number | null;
-    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)
-     * @param column The column at which the settings take effect
-     * @param bpm The new beats per minute, or null to keep the current value from the previous control line
-     * @param pedal Whether the pedal is pressed, or null to keep the current value from the previous control line
-     * @param checkpoint Whether this control line is a checkpoint
-     * @param rows The notes to play at each row. This list is automatically resized to match the height of the grid. You may pass in an empty list if none of the rows need to be changed.
-     */
-    constructor(column: number, bpm: number | null, pedal: boolean | null, checkpoint: boolean, rows: readonly Row[]);
-    get configs(): readonly AnyConfig[] | null;
-    copyWith({ column, bpm, pedal, checkpoint, rows, }: {
-        column?: number;
-        bpm?: number | null;
-        pedal?: boolean | null;
-        checkpoint?: boolean;
-        rows?: readonly Row[];
-    }): this;
-    withColumn(column: number): this;
-    withBpm(bpm: number | null): this;
-    withPedal(pedal: boolean | null): this;
-    withCheckpoint(checkpoint: boolean): this;
-    withRows(rows: readonly Row[]): this;
-    equals(other: ControlLine): boolean;
-    get isEmpty(): boolean;
-}
-export declare const instance: undefined;

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

@@ -1,167 +0,0 @@
-import { ConfigType } from '../config.js';
-import Configurable from '../configurable.js';
-import { Instrument } from '../primitives.js';
-export class Row extends Configurable {
-    note;
-    instrument;
-    velocity;
-    title = 'Music Grid - Row';
-    configExplanation = 'Configure the playback settings from this tile onwards.';
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.NullableNote,
-            default: 'C4',
-            field: 'note',
-            description: 'Note',
-            explanation: 'The musical note or sample to play.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.NullableInstrument,
-            default: Instrument.Piano,
-            field: 'instrument',
-            description: 'Instrument',
-            explanation: 'The musical instrument to use. This has no effect if the current note is a drum sample.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.NullableNumber,
-            default: 0.5,
-            min: 0,
-            max: 1,
-            step: 0.2,
-            field: 'velocity',
-            description: 'Velocity',
-            explanation: 'The volume to play the note at.',
-            configurable: true,
-        },
-    ]);
-    constructor(
-    /**
-     * The note to play at this row, or null to keep the current note from the previous control line.
-     * If this is null from the first control line, the note will be silent.
-     */
-    note, 
-    /**
-     * The instrument to play the note with, or null to keep the current instrument from the previous control line.
-     * If this is null from the first control line, the instrument will be "piano".
-     * This has no effect if the current note is a drum sample.
-     */
-    instrument, 
-    /**
-     * The velocity to play the note at, or null to keep the current velocity from the previous control line.
-     * Ranges from 0 to 1
-     */
-    velocity) {
-        super();
-        this.note = note;
-        this.instrument = instrument;
-        this.velocity = velocity;
-        this.note = note;
-        this.instrument = instrument;
-        this.velocity = velocity;
-    }
-    get configs() {
-        return Row.CONFIGS;
-    }
-    copyWith({ note, instrument, velocity, }) {
-        return new Row(note !== undefined ? note : this.note, instrument !== undefined ? instrument : this.instrument, velocity !== undefined ? velocity : this.velocity);
-    }
-}
-export class ControlLine extends Configurable {
-    column;
-    bpm;
-    pedal;
-    checkpoint;
-    rows;
-    title = 'Music Grid - Control Line';
-    configExplanation = 'Configure the playback settings from this point onwards.';
-    static CONFIGS = Object.freeze([
-        {
-            type: ConfigType.NullableNumber,
-            default: 120,
-            min: 20,
-            max: 1000,
-            field: 'bpm',
-            description: 'BPM',
-            explanation: 'Beats per minute for the playback.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.NullableBoolean,
-            default: false,
-            field: 'pedal',
-            description: 'Pedal',
-            explanation: 'For piano notes, whether the pedal is pressed to sustain the sound.',
-            configurable: true,
-        },
-        {
-            type: ConfigType.Boolean,
-            default: false,
-            field: 'checkpoint',
-            description: 'Checkpoint',
-            explanation: 'Whether players can start playback from this position.',
-            configurable: true,
-        },
-    ]);
-    /**
-     * Configure playback settings, taking effect at the given column (inclusive)
-     * @param column The column at which the settings take effect
-     * @param bpm The new beats per minute, or null to keep the current value from the previous control line
-     * @param pedal Whether the pedal is pressed, or null to keep the current value from the previous control line
-     * @param checkpoint Whether this control line is a checkpoint
-     * @param rows The notes to play at each row. This list is automatically resized to match the height of the grid. You may pass in an empty list if none of the rows need to be changed.
-     */
-    constructor(column, bpm, pedal, checkpoint, rows) {
-        super();
-        this.column = column;
-        this.bpm = bpm;
-        this.pedal = pedal;
-        this.checkpoint = checkpoint;
-        this.rows = rows;
-        this.column = Math.floor(column);
-        this.bpm = bpm;
-        this.pedal = pedal;
-        this.checkpoint = checkpoint;
-        this.rows = rows;
-    }
-    get configs() {
-        return ControlLine.CONFIGS;
-    }
-    copyWith({ column, bpm, pedal, checkpoint, rows, }) {
-        return new ControlLine(column ?? this.column, bpm !== undefined ? bpm : this.bpm, pedal !== undefined ? pedal : this.pedal, checkpoint ?? this.checkpoint, rows ?? this.rows);
-    }
-    withColumn(column) {
-        return this.copyWith({ column });
-    }
-    withBpm(bpm) {
-        return this.copyWith({ bpm });
-    }
-    withPedal(pedal) {
-        return this.copyWith({ pedal });
-    }
-    withCheckpoint(checkpoint) {
-        return this.copyWith({ checkpoint });
-    }
-    withRows(rows) {
-        return this.copyWith({ rows });
-    }
-    equals(other) {
-        return (this.column === other.column &&
-            this.bpm === other.bpm &&
-            this.pedal === other.pedal &&
-            this.checkpoint === other.checkpoint &&
-            this.rows.length === other.rows.length &&
-            this.rows.every((row, i) => {
-                const otherRow = other.rows[i];
-                return row.note === otherRow.note && row.velocity === otherRow.velocity;
-            }));
-    }
-    get isEmpty() {
-        return (this.bpm === null &&
-            this.pedal === null &&
-            !this.checkpoint &&
-            !this.rows.some(row => row.note !== null || row.velocity !== null));
-    }
-}
-export const instance = undefined;

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

@@ -1,51 +0,0 @@
-import { AnyConfig } from '../config.js';
-import { GridChangeHandler } from '../events/onGridChange.js';
-import { GridResizeHandler } from '../events/onGridResize.js';
-import { SetGridHandler } from '../events/onSetGrid.js';
-import GridData from '../grid.js';
-import { RuleState } from '../primitives.js';
-import { ControlLine } from './musicControlLine.js';
-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;
-    readonly title = "Music Grid";
-    get configExplanation(): string;
-    private static readonly EXAMPLE_GRID;
-    private static readonly CONFIGS;
-    private static readonly SEARCH_VARIANTS;
-    /**
-     * **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, normalizeVelocity?: boolean);
-    get id(): string;
-    get explanation(): string;
-    get configs(): readonly AnyConfig[] | null;
-    createExampleGrid(): GridData;
-    get searchVariants(): SearchVariant[];
-    validateGrid(_grid: GridData): RuleState;
-    onSetGrid(_oldGrid: GridData, newGrid: GridData, _solution: GridData | null): GridData;
-    onGridChange(newGrid: GridData): this;
-    onGridResize(_grid: GridData, mode: 'insert' | 'remove', direction: 'row' | 'column', index: number): this | null;
-    /**
-     * Add or replace a control line.
-     * @param controlLine The control line to set.
-     * @returns A new rule with the control line set.
-     */
-    setControlLine(controlLine: ControlLine): this;
-    withTrack(track: GridData | null): this;
-    copyWith({ controlLines, track, normalizeVelocity, }: {
-        controlLines?: readonly ControlLine[];
-        track?: GridData | null;
-        normalizeVelocity?: boolean;
-    }): this;
-    get validateWithSolution(): boolean;
-    get isSingleton(): boolean;
-    static mergeControlLines(...lines: ControlLine[]): ControlLine;
-    static deduplicateControlLines(lines: readonly ControlLine[]): ControlLine[];
-}
-export declare const instance: MusicGridRule;