@fgv/ts-sudoku-lib 5.1.0-15 → 5.1.0-17

package/dist/packlets/collections/collections.js

@@ -48,7 +48,7 @@ export class PuzzleCollection {
     }
     /**
      * Creates a new puzzle from a JSON file.
-     * @param path - path to the JSON file to be loaded.
+     * @param file - file item to be loaded.
      * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
      * or `Failure` with details if an error occurs.
      */

package/dist/packlets/common/puzzle.js

@@ -33,7 +33,7 @@ import { PuzzleState } from './puzzleState';
 export class Puzzle {
     /**
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link IPuzzleDefinition | Puzzle definition} from which this puzzle state
+     * @param puzzle - {@link IPuzzleDefinition | Puzzle definition} from which this puzzle state
      * is to be initialized.
      */
     constructor(puzzle, extraCages) {

package/dist/ts-sudoku-lib.d.ts

@@ -126,7 +126,7 @@ export declare class Cage implements ICage {
 }
 
 /**
- * Nominal identifier for a single {@Link ICage | cage} in a {@link PuzzleSession | puzzle}.
+ * Nominal identifier for a single {@link ICage | cage} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export declare type CageId = Brand<string, 'CageId'>;
@@ -138,7 +138,7 @@ export declare type CageId = Brand<string, 'CageId'>;
 declare const cageId: Converter<CageId>;
 
 /**
- * Identifies the type of a {@Link ICage | cage}.
+ * Identifies the type of a {@link ICage | cage}.
  * @public
  */
 export declare type CageType = 'row' | 'column' | 'section' | 'x' | 'killer';
@@ -170,7 +170,7 @@ export declare class Cell implements ICellInit, ICell {
 declare type CellAction = 'set-value' | 'eliminate-candidate' | 'add-candidate' | 'highlight';
 
 /**
- * Nominal identifier for a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
+ * Nominal identifier for a single {@link ICell | cell} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export declare type CellId = Brand<string, 'CellId'>;
@@ -763,7 +763,7 @@ export declare interface ICell {
      */
     readonly col: number;
     /**
-     * All of the {@Link ICage | cages} to which this cell belongs.
+     * All of the {@link ICage | cages} to which this cell belongs.
      */
     readonly cages: readonly ICage[];
     /**
@@ -788,7 +788,7 @@ declare interface ICellAction {
 }
 
 /**
- * The contents of a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
+ * The contents of a single {@link ICell | cell} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export declare interface ICellContents {
@@ -1141,7 +1141,7 @@ declare interface IRelevantCells {
 }
 
 /**
- * The row/column coordinate of a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
+ * The row/column coordinate of a single {@link ICell | cell} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export declare interface IRowColumn {
@@ -1391,7 +1391,7 @@ export declare class Puzzle {
     protected readonly _cells: Map<CellId, Cell>;
     /**
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link IPuzzleDefinition | Puzzle definition} from which this puzzle state
+     * @param puzzle - {@link IPuzzleDefinition | Puzzle definition} from which this puzzle state
      * is to be initialized.
      */
     protected constructor(puzzle: IPuzzleDefinition, extraCages?: [CageId, Cage][]);
@@ -1464,7 +1464,7 @@ export declare class PuzzleCollection {
     static create(from: Files.Model.IPuzzlesFile): Result<PuzzleCollection>;
     /**
      * Creates a new puzzle from a JSON file.
-     * @param path - path to the JSON file to be loaded.
+     * @param file - file item to be loaded.
      * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
      * or `Failure` with details if an error occurs.
      */

package/lib/packlets/collections/collections.d.ts

@@ -22,7 +22,7 @@ export declare class PuzzleCollection {
     static create(from: Files.Model.IPuzzlesFile): Result<PuzzleCollection>;
     /**
      * Creates a new puzzle from a JSON file.
-     * @param path - path to the JSON file to be loaded.
+     * @param file - file item to be loaded.
      * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
      * or `Failure` with details if an error occurs.
      */

package/lib/packlets/collections/collections.js

@@ -87,7 +87,7 @@ class PuzzleCollection {
     }
     /**
      * Creates a new puzzle from a JSON file.
-     * @param path - path to the JSON file to be loaded.
+     * @param file - file item to be loaded.
      * @returns `Success` with the resulting {@link PuzzleCollection | PuzzleCollection}
      * or `Failure` with details if an error occurs.
      */

package/lib/packlets/common/common.d.ts

@@ -1,21 +1,21 @@
 import { Brand } from '@fgv/ts-utils';
 /**
- * Nominal identifier for a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
+ * 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}.
+ * 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}.
+ * 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}.
+ * The row/column coordinate of a single {@link ICell | cell} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export interface IRowColumn {
@@ -23,7 +23,7 @@ export interface IRowColumn {
     col: number;
 }
 /**
- * The contents of a single {@Link ICell | cell} in a {@link PuzzleSession | puzzle}.
+ * The contents of a single {@link ICell | cell} in a {@link PuzzleSession | puzzle}.
  * @public
  */
 export interface ICellContents {

package/lib/packlets/common/public.d.ts

@@ -50,7 +50,7 @@ export interface ICell {
      */
     readonly col: number;
     /**
-     * All of the {@Link ICage | cages} to which this cell belongs.
+     * All of the {@link ICage | cages} to which this cell belongs.
      */
     readonly cages: readonly ICage[];
     /**

package/lib/packlets/common/puzzle.d.ts

@@ -54,7 +54,7 @@ export declare class Puzzle {
     protected readonly _cells: Map<CellId, Cell>;
     /**
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link IPuzzleDefinition | Puzzle definition} from which this puzzle state
+     * @param puzzle - {@link IPuzzleDefinition | Puzzle definition} from which this puzzle state
      * is to be initialized.
      */
     protected constructor(puzzle: IPuzzleDefinition, extraCages?: [CageId, Cage][]);

package/lib/packlets/common/puzzle.js

@@ -36,7 +36,7 @@ const puzzleState_1 = require("./puzzleState");
 class Puzzle {
     /**
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link IPuzzleDefinition | Puzzle definition} from which this puzzle state
+     * @param puzzle - {@link IPuzzleDefinition | Puzzle definition} from which this puzzle state
      * is to be initialized.
      */
     constructor(puzzle, extraCages) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-sudoku-lib",
-  "version": "5.1.0-15",
+  "version": "5.1.0-17",
   "description": "Sudoku rules library",
   "main": "lib/index.js",
   "types": "dist/ts-sudoku-lib.d.ts",
@@ -44,14 +44,14 @@
     "@rushstack/heft-jest-plugin": "1.2.6",
     "eslint-plugin-tsdoc": "~0.5.2",
     "typedoc": "~0.28.16",
-    "@fgv/heft-dual-rig": "5.1.0-15",
-    "@fgv/typedoc-compact-theme": "5.1.0-15",
-    "@fgv/ts-utils": "5.1.0-15",
-    "@fgv/ts-utils-jest": "5.1.0-15",
-    "@fgv/ts-json-base": "5.1.0-15"
+    "@fgv/heft-dual-rig": "5.1.0-17",
+    "@fgv/ts-utils-jest": "5.1.0-17",
+    "@fgv/typedoc-compact-theme": "5.1.0-17",
+    "@fgv/ts-utils": "5.1.0-17",
+    "@fgv/ts-json-base": "5.1.0-17"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.1.0-15"
+    "@fgv/ts-utils": "5.1.0-17"
   },
   "exports": {
     ".": {