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

package/src/packlets/common/ids.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, fail, succeed } from '@fgv/ts-utils';
-import { CageId, CellId, IRowColumn } from './common';
-import * as Converters from './converters';
-import { ICage, ICell } from './public';
-
-const firstRowIdChar: number = 'A'.charCodeAt(0);
-const firstColIdChar: number = '1'.charCodeAt(0);
-
-function isRowColumn(from: unknown): from is IRowColumn {
-  return typeof from === 'object' && from !== null && 'row' in from && `col` in from;
-}
-
-/**
- * @public
- */
-export class Ids {
-  public static cageId(from: string | ICage): Result<CageId> {
-    if (typeof from === 'string') {
-      return Converters.cageId.convert(from);
-    }
-    return succeed(from.id);
-  }
-
-  public static cellId(spec: string | IRowColumn | ICell): Result<CellId> {
-    if (isRowColumn(spec)) {
-      if ('id' in spec) {
-        return succeed(spec.id);
-      }
-      const row = String.fromCharCode(firstRowIdChar + spec.row);
-      const col = String.fromCharCode(firstColIdChar + spec.col);
-      return succeed(`${row}${col}` as CellId);
-    }
-    return Converters.cellId.convert(spec);
-  }
-
-  public static rowCageId(row: number): CageId {
-    return `R${String.fromCharCode(firstRowIdChar + row)}` as CageId;
-  }
-
-  public static columnCageId(col: number): CageId {
-    return `C${String.fromCharCode(firstColIdChar + col)}` as CageId;
-  }
-
-  public static sectionCageId(row: number, col: number): CageId {
-    row = Math.floor(row / 3) * 3;
-    col = Math.floor(col / 3) * 3;
-    return `S${String.fromCharCode(firstRowIdChar + row)}${String.fromCharCode(
-      firstColIdChar + col
-    )}` as CageId;
-  }
-
-  public static cellIds(
-    firstRow: number,
-    numRows: number,
-    firstCol: number,
-    numCols: number
-  ): Result<CellId[]> {
-    const cellIds: CellId[] = [];
-    for (let row = firstRow; row < firstRow + numRows; row++) {
-      for (let col = firstCol; col < firstCol + numCols; col++) {
-        const result = this.cellId({ row, col }).onSuccess((id) => {
-          cellIds.push(id);
-          return succeed(id);
-        });
-
-        /* c8 ignore next 3 - defense in depth should not happen */
-        if (result.isFailure()) {
-          return fail(result.message);
-        }
-      }
-    }
-    return succeed(cellIds);
-  }
-}

package/src/packlets/common/index.ts

@@ -1,37 +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 Converters from './converters';
-
-export * from './cage';
-export * from './cell';
-export * from './common';
-export { Ids } from './ids';
-export * from './model';
-export * from './public';
-export * from './puzzle';
-export * from './puzzleSession';
-export * from './puzzleState';
-
-export { Converters };

package/src/packlets/common/model.ts

@@ -1,39 +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 { PuzzleType } from './common';
-
-/**
- * Description of a single puzzle.
- * @public
- */
-export interface IPuzzleDescription {
-  id?: string;
-  description: string;
-  type: PuzzleType;
-  level: number;
-  rows: number;
-  cols: number;
-  cells: string;
-}

package/src/packlets/common/public.ts

@@ -1,100 +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 { CageId, CageType, CellId } from './common';
-
-/**
- * Describes the structure of a single cage in a {@link PuzzleSession | puzzle}.
- * Does not describe state.
- * @public
- */
-export interface ICage {
-  /**
-   * Unique identifier for the cage.
-   */
-  readonly id: CageId;
-
-  /**
-   * The {@link CageType | type} of the cage.
-   */
-  readonly cageType: CageType;
-
-  /**
-   * The expected sum of all cells in the cage.
-   */
-  readonly total: number;
-
-  /**
-   * The number of cells in the cage.
-   */
-  readonly numCells: number;
-
-  /**
-   * The identity of each cell in the cage.
-   */
-  readonly cellIds: CellId[];
-
-  /**
-   * Determines if a supplied cell is present in the cage.
-   * @param id - the identifier to be searched.
-   */
-  containsCell(id: CellId): boolean;
-}
-
-/**
- * Describes the structure of a single cell in a {@link PuzzleSession | puzzle}.
- * Does not describe state.
- * @public
- */
-export interface ICell {
-  /**
-   * Unique identifier for the cell.
-   */
-  readonly id: CellId;
-
-  /**
-   * Row number of the cell.
-   */
-  readonly row: number;
-
-  /**
-   * Column number of the cell.
-   */
-  readonly col: number;
-
-  /**
-   * All of the {@Link ICage | cages} to which this cell belongs.
-   */
-  readonly cages: readonly ICage[];
-
-  /**
-   * Indicates whether this cell is a given value (immutable).
-   */
-  readonly immutable: boolean;
-
-  /**
-   * Given value of this cell, or `undefined` if the cell is not immutable.
-   */
-  readonly immutableValue?: number;
-}