@fgv/ts-sudoku-lib 5.0.0-21 → 5.0.0-23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-sudoku-lib",
-  "version": "5.0.0-21",
+  "version": "5.0.0-23",
   "description": "Sudoku rules library",
   "main": "lib/index.js",
   "types": "dist/ts-sudoku-lib.d.ts",
@@ -43,12 +43,12 @@
     "@rushstack/eslint-config": "~4.4.0",
     "@rushstack/heft-jest-plugin": "~0.16.11",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils": "5.0.0-21",
-    "@fgv/ts-utils-jest": "5.0.0-21",
-    "@fgv/ts-json-base": "5.0.0-21"
+    "@fgv/ts-utils": "5.0.0-23",
+    "@fgv/ts-utils-jest": "5.0.0-23",
+    "@fgv/ts-json-base": "5.0.0-23"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.0-21"
+    "@fgv/ts-utils": "5.0.0-23"
   },
   "scripts": {
     "build": "heft build --clean",

package/src/index.ts

@@ -1,30 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as File from './packlets/file';
-import * as Puzzles from './packlets/puzzles';
-
-export * from './packlets/collections';
-export * from './packlets/common';
-export { File, Puzzles };

package/src/packlets/collections/collections.ts

@@ -1,124 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as FileData from '../file';
-import * as Puzzles from '../puzzles';
-
-import { Result, captureResult, fail, succeed } from '@fgv/ts-utils';
-
-import { IPuzzleDescription, PuzzleSession } from '../common';
-import DefaultPuzzles from './data/puzzles.json';
-
-/**
- * A collection of puzzles of various types.
- * @public
- */
-export class PuzzleCollection {
-  /**
-   * All puzzles in the collection.
-   */
-  public readonly puzzles: readonly IPuzzleDescription[];
-
-  private readonly _byId: Map<string, IPuzzleDescription>;
-
-  private constructor(puzzles: FileData.Model.IPuzzlesFile) {
-    this.puzzles = puzzles.puzzles;
-    this._byId = new Map(
-      this.puzzles
-        .map((p): [string | undefined, IPuzzleDescription] => [p.id, p])
-        .filter((p): p is [string, IPuzzleDescription] => p !== undefined)
-    );
-  }
-
-  /**
-   * Creates a new puzzle from a loaded {@link File.Model.IPuzzlesFile | PuzzlesFile}
-   * @param from - The {@link File.Model.IPuzzlesFile | puzzles file} to be loaded.
-   * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
-   * or `Failure` with details if an error occurs.
-   */
-  public static create(from: FileData.Model.IPuzzlesFile): Result<PuzzleCollection> {
-    return captureResult(() => new PuzzleCollection(from));
-  }
-
-  /**
-   * Creates a new puzzle from a JSON file.
-   * @param path - path to the JSON file to be loaded.
-   * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
-   * or `Failure` with details if an error occurs.
-   */
-  public static load(path: string): Result<PuzzleCollection> {
-    return FileData.Converters.loadJsonPuzzlesFileSync(path).onSuccess(PuzzleCollection.create);
-  }
-
-  /**
-   * Gets a puzzle by id from this collection.
-   * @param id - The string ID of the puzzle to be returned.
-   * @returns `Success` with the requested {@link PuzzleSession | puzzle}, or
-   * `Failure` with details if an error occurs.
-   */
-  public getPuzzle(id: string): Result<PuzzleSession> {
-    return this.getDescription(id)
-      .onSuccess((desc) => {
-        return Puzzles.Any.create(desc);
-      })
-      .onSuccess((puzzle) => {
-        return PuzzleSession.create(puzzle);
-      });
-  }
-
-  /**
-   * Gets a puzzle by id from this collection.
-   * @param id - The string ID of the puzzle to be returned.
-   * @returns `Success` with the requested {@link PuzzleSession | puzzle}, or
-   * `Failure` with details if an error occurs.
-   */
-  public getDescription(id: string): Result<IPuzzleDescription> {
-    const desc = this._byId.get(id);
-    if (!desc) {
-      return fail(`Puzzle "${id}" not found`);
-    }
-    return succeed(desc);
-  }
-}
-
-/**
- * Get well-known {@link PuzzleCollection | puzzle collections}.
- * @public
- */
-export class PuzzleCollections {
-  private static _default: PuzzleCollection | undefined = undefined;
-
-  /**
-   * The default {@link PuzzleCollection | puzzle collection}.
-   */
-  public static get default(): PuzzleCollection {
-    if (!PuzzleCollections._default) {
-      PuzzleCollections._default = FileData.Converters.puzzlesFile
-        .convert(DefaultPuzzles)
-        .onSuccess(PuzzleCollection.create)
-        .orThrow();
-    }
-    return PuzzleCollections._default;
-  }
-}

package/src/packlets/collections/data/puzzles.json

@@ -1,61 +0,0 @@
-{
-  "puzzles": [
-    {
-      "id": "hidden-pair",
-      "description": "hidden pair sample",
-      "type": "sudoku",
-      "level": 1,
-      "rows": 9,
-      "cols": 9,
-      "cells": [
-        ".........",
-        "9.46.7...",
-        ".768.41..",
-        "3.97.1.8.",
-        "7.8...3.1",
-        ".513.87.2",
-        "..75.261.",
-        "..54.32.8",
-        "........."
-      ]
-    },
-    {
-      "id": "almost-done",
-      "description": "nearly complete puzzle missing only 1 in cell A1",
-      "type": "sudoku",
-      "level": 1,
-      "rows": 9,
-      "cols": 9,
-      "cells": ".46728539837549126259316748685297413312684957794153862428965371571832694963471285"
-    },
-    {
-      "id": "sudoku-x-example",
-      "description": "sample x-sudoku puzzle",
-      "type": "sudoku-x",
-      "level": 1,
-      "rows": 9,
-      "cols": 9,
-      "cells": "4.....13....6.1.....7..29...76.....2....3..9.9.1....577...1.6..3...5.7...4......1"
-    },
-    {
-      "id": "killer-insane",
-      "description": "Insane (3208329) example from djape.net",
-      "type": "killer-sudoku",
-      "level": 100,
-      "rows": 9,
-      "cols": 9,
-      "cells": [
-        "ABCCCDDDE",
-        "ABFFGGGDE",
-        "HIJKGGLLL",
-        "HIJKMGLNN",
-        "HOPPMQQNR",
-        "OOSTMUVWR",
-        "SSSTTUVWR",
-        "XYTTTZZab",
-        "XYYYcccab",
-        "|A11,B09,C09,D20,E16,F17,G30,H17,I13,J09,K11,L16,M16,N11,O16,P07,Q11,R10,S14,T39,U08,V17,W16,X06,Y26,Z06,a09,b09,c11"
-      ]
-    }
-  ]
-}

package/src/packlets/collections/index.ts

@@ -1,25 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-export * from './collections';

package/src/packlets/common/cage.ts

@@ -1,98 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Result, captureResult } from '@fgv/ts-utils';
-import { CageId, CageType, CellId } from './common';
-import { ICage } from './public';
-import { PuzzleState } from './puzzleState';
-
-/**
- * @internal
- */
-export class Cage implements ICage {
-  public readonly id: CageId;
-  public readonly cageType: CageType;
-  public readonly total: number;
-
-  protected readonly _cellIds: CellId[];
-  private _values: Set<number>;
-
-  private constructor(id: CageId, type: CageType, total: number, cells: CellId[]) {
-    this.id = id;
-    this.cageType = type;
-    this.total = total;
-    this._cellIds = Array.from(cells);
-    this._values = new Set();
-  }
-
-  public get cellIds(): CellId[] {
-    return Array.from(this._cellIds);
-  }
-
-  public get numCells(): number {
-    return this._cellIds.length;
-  }
-
-  public static create(id: CageId, type: CageType, total: number, cells: CellId[]): Result<Cage> {
-    return captureResult(() => new Cage(id, type, total, cells));
-  }
-
-  public containsCell(id: CellId): boolean {
-    return this._cellIds.includes(id);
-  }
-
-  public containsValue(value: number, state: PuzzleState, ignore?: CellId[]): boolean {
-    for (const cellId of this._cellIds) {
-      if (!ignore?.includes(cellId)) {
-        /* c8 ignore next - defense in depth, ? should never happen */
-        if (state.getCellContents(cellId).orDefault()?.value === value) {
-          return true;
-        }
-      }
-    }
-    return false;
-  }
-
-  public containedValues(state: PuzzleState): Set<number> {
-    const values = new Set<number>();
-    for (const cellId of this._cellIds) {
-      /* c8 ignore next - defense in depth, ? should never happen */
-      const value = state.getCellContents(cellId).orDefault()?.value;
-      if (value !== undefined) {
-        values.add(value);
-      }
-    }
-    return values;
-  }
-
-  public toString(state?: PuzzleState): string {
-    return this._cellIds
-      .map((id) => {
-        /* c8 ignore next - defense in depth, ? should never happen */
-        const value = state?.getCellContents(id).orDefault()?.value;
-        return value ? String(value) : '.';
-      })
-      .join('');
-  }
-}

package/src/packlets/common/cell.ts

@@ -1,116 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Result, fail, succeed } from '@fgv/ts-utils';
-import { Cage } from './cage';
-import { CellId, ICellContents, ICellState } from './common';
-import { ICell } from './public';
-import { PuzzleState } from './puzzleState';
-
-/**
- * @internal
- */
-export interface ICellInit {
-  readonly id: CellId;
-  readonly row: number;
-  readonly col: number;
-  readonly immutableValue?: number;
-}
-
-/**
- * @internal
- */
-export class Cell implements ICellInit, ICell {
-  public readonly id: CellId;
-  public readonly row: number;
-  public readonly col: number;
-  public readonly cages: readonly Cage[];
-
-  public readonly immutable: boolean;
-  public readonly immutableValue?: number;
-
-  public constructor(init: ICellInit, cages: readonly Cage[]) {
-    this.id = init.id;
-    this.row = init.row;
-    this.col = init.col;
-    this.cages = [...cages];
-    this.immutableValue = init.immutableValue;
-    this.immutable = init.immutableValue !== undefined;
-  }
-
-  public isValid(state: PuzzleState): boolean {
-    if (this.immutable) {
-      return true;
-    }
-    const cell = state.getCellContents(this.id).orDefault();
-    return cell !== undefined && this.isValidValue(cell.value, state);
-  }
-
-  public hasValue(state: PuzzleState): boolean {
-    if (this.immutable) {
-      return true;
-    }
-    const cell = state.getCellContents(this.id).orDefault();
-    /* c8 ignore next - defense in depth ? should never happen */
-    return cell?.value !== undefined;
-  }
-
-  public isValidValue(value: number | undefined, state: PuzzleState): boolean {
-    if (this.immutable) {
-      return false;
-    } else if (value === undefined) {
-      return true;
-    }
-    return !this.cages.find((cage) => cage.containsValue(value, state, [this.id]));
-  }
-
-  public update(value: number | undefined, notes: number[]): Result<ICellState> {
-    if (this.immutable) {
-      return fail(`cannot set value "${value}" in immutable cell ${this.id}`);
-    }
-    return succeed({
-      id: this.id,
-      value,
-      notes
-    });
-  }
-
-  public updateValue(value: number | undefined, state: PuzzleState): Result<ICellState> {
-    return state.getCellContents(this.id).onSuccess((contents: ICellContents) => {
-      return this.update(value, contents.notes);
-    });
-  }
-
-  public updateNotes(notes: number[], state: PuzzleState): Result<ICellState> {
-    return state.getCellContents(this.id).onSuccess((contents: ICellContents) => {
-      return this.update(contents.value, notes);
-    });
-  }
-
-  public toString(state?: PuzzleState): string {
-    const contents = state?.getCellContents(this.id).orDefault();
-    const value = this.immutableValue ?? contents?.value;
-    return value && value >= 1 && value <= 9 ? String(value) : '.';
-  }
-}

package/src/packlets/common/common.ts

@@ -1,120 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Brand } from '@fgv/ts-utils';
-
-/**
- * Nominal identifier for a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
- * @public
- */
-export type CellId = Brand<string, 'CellId'>;
-
-/**
- * Nominal identifier for a single {@Link ICage | cage} in a {@link PuzzleSession | puzzle}.
- * @public
- */
-export type CageId = Brand<string, 'CageId'>;
-
-/**
- * Identifies the type of a {@Link ICage | cage}.
- * @public
- */
-export type CageType = 'row' | 'column' | 'section' | 'x' | 'killer';
-
-/**
- * The row/column coordinate of a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
- * @public
- */
-export interface IRowColumn {
-  row: number;
-  col: number;
-}
-
-/**
- * The contents of a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
- * @public
- */
-export interface ICellContents {
-  /**
-   * The value of the {@link ICell | cell}, or `undefined` if no value has been assigned.
-   */
-  readonly value?: number;
-  /**
-   * Any notes associated with the {@link ICell | cell}.
-   */
-  readonly notes: number[];
-}
-
-/**
- * Describes the state of or a state update for a single {@link ICell |cell} in a
- * {@link PuzzleSession | puzzle}.
- * @public
- */
-
-export interface ICellState extends ICellContents {
-  readonly id: CellId;
-}
-
-/**
- * Describes the rules that apply to the puzzle.
- * @public
- */
-export type PuzzleType = 'killer-sudoku' | 'sudoku' | 'sudoku-x';
-
-/**
- * All supported public types.
- * @public
- */
-export const allPuzzleTypes: PuzzleType[] = ['killer-sudoku', 'sudoku', 'sudoku-x'];
-
-/**
- * The minimum and maximum possible values for a {@link ICage | cage}, by cage size in
- * {@link ICell | cells}.
- * @public
- */
-export const totalsByCageSize: readonly { min: number; max: number }[] = [
-  { min: 0, max: 0 },
-  { min: 1, max: 9 },
-  { min: 3, max: 17 },
-  { min: 6, max: 24 },
-  { min: 10, max: 30 },
-  { min: 15, max: 35 },
-  { min: 21, max: 39 },
-  { min: 28, max: 42 },
-  { min: 36, max: 44 },
-  { min: 45, max: 45 }
-];
-
-/**
- * Navigation direction within a puzzle.
- * @public
- *
- */
-export type NavigationDirection = 'down' | 'left' | 'right' | 'up';
-
-/**
- * Wrapping rules when navigating within a puzzle.
- * @public
- */
-export type NavigationWrap = 'none' | 'wrap-around' | 'wrap-next';

package/src/packlets/common/converters.ts

@@ -1,84 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2023 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Converter, Converters, Result, fail, succeed } from '@fgv/ts-utils';
-import { CageId, CellId, PuzzleType, allPuzzleTypes } from './common';
-import { IPuzzleDescription } from './model';
-
-const cageIdRegExp: RegExp = /^(R[A-Z]$)|(C[0-9]$)|(S[A-Z][0-9]$)|(X[1-2]$)|(K[A-Za-z]$)/;
-
-function validateCageId(from: string): Result<CageId> {
-  if (cageIdRegExp.test(from)) {
-    return succeed(from as CageId);
-  }
-  return fail(`malformed cage ID "${from}" (expected "R[A-Z]", "C[0-9]" or "S[A-Z][0-9]")`);
-}
-
-const cellIdRegExp: RegExp = /^[A-Z][0-9]$/;
-function validateCellId(from: string): Result<CellId> {
-  if (cellIdRegExp.test(from)) {
-    return succeed(from as CellId);
-  }
-  return fail(`malformed cell ID "${from}" (expected "[A-Z][0-9]")`);
-}
-
-/**
- * Converts an arbitrary value to a {@link CageId | CageId}.
- * @public
- */
-export const cageId: Converter<CageId> = Converters.string.map(validateCageId);
-
-/**
- * Converts an arbitrary value to a {@link CellId | CellId}.
- * @public
- */
-export const cellId: Converter<CellId> = Converters.string.map(validateCellId);
-
-/**
- * Converts an arbitrary value to a {@link PuzzleType | PuzzleType}.
- * @public
- */
-export const puzzleType: Converter<
-  PuzzleType,
-  ReadonlyArray<PuzzleType>
-> = Converters.enumeratedValue<PuzzleType>(allPuzzleTypes);
-
-/**
- * Converts an arbitrary object to a {@link IPuzzleDescription | IPuzzleDescription}.
- * @public
- */
-export const puzzleDescription: Converter<IPuzzleDescription> = Converters.strictObject<IPuzzleDescription>(
-  {
-    id: Converters.string,
-    description: Converters.string,
-    type: puzzleType,
-    level: Converters.number,
-    rows: Converters.number,
-    cols: Converters.number,
-    cells: Converters.oneOf([Converters.string, Converters.stringArray.map((s) => succeed(s.join('')))])
-  },
-  {
-    optionalFields: ['id']
-  }
-);