@fgv/ts-sudoku-lib - npm Package Compare versions

Comparing version 3.0.1-alpha.6 to 4.0.0

CHANGELOG.json

@@ -5,2 +5,17 @@ {
     {
+      "version": "4.0.0",
+      "tag": "@fgv/ts-sudoku-lib_v4.0.0",
+      "date": "Tue, 14 May 2024 03:09:27 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "update dependencies"
+          },
+          {
+            "comment": "update generated api docs"
+          }
+        ]
+      }
+    },
+    {
       "version": "3.0.0",
@@ -7,0 +22,0 @@ "tag": "@fgv/ts-sudoku-lib_v3.0.0",

CHANGELOG.md

 # Change Log - @fgv/ts-sudoku-lib
 
-This log was last generated on Mon, 22 Jan 2024 07:00:18 GMT and should not be manually modified.
+This log was last generated on Tue, 14 May 2024 03:09:27 GMT and should not be manually modified.
 
+## 4.0.0
+Tue, 14 May 2024 03:09:27 GMT
+
+### Updates
+
+- update dependencies
+- update generated api docs
+
 ## 3.0.0
@@ -6,0 +14,0 @@ Mon, 22 Jan 2024 07:00:18 GMT

dist/ts-sudoku-lib.d.ts

@@ -12,3 +12,3 @@ import { Brand } from '@fgv/ts-utils';
 /**
- * Static class to instantiate any puzzle from a {@link Data.Model.PuzzleDescription | puzzle description}.
+ * Static class to instantiate any puzzle from a {@link PuzzleDescription | puzzle description}.
  * @internal
@@ -291,3 +291,3 @@ */
  * Loads an arbitrary JSON file and parses it to return a validated
- * {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @param path - String path to the file
@@ -348,3 +348,3 @@ * @returns `Success` with the resulting file, or `Failure` with details if an
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link Data.Model.PuzzleDescription | Puzzle description} from which this puzzle state
+     * @param puzzle - {@Link IPuzzleDescription | Puzzle description} from which this puzzle state
      * is to be initialized.
@@ -409,4 +409,4 @@ */
     /**
-     * Creates a new puzzle from a loaded {@link FileData.Model.IPuzzlesFile | PuzzlesFile}
-     * @param from - The {@link FileData.Model.IPuzzlesFile | puzzles file} to be loaded.
+     * 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}
@@ -452,3 +452,3 @@ * or `Failure` with details if an error occurs.
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzleDescription | PuzzleDescription}.
+ * Converts an arbitrary object to a {@link IPuzzleDescription | IPuzzleDescription}.
  * @public
@@ -674,3 +674,3 @@ */
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * Converts an arbitrary object to a {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @public
@@ -677,0 +677,0 @@ */

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.1"
+      "packageVersion": "7.43.4"
     }
   ]
 }

lib/packlets/collections/collections.d.ts

@@ -16,4 +16,4 @@ import * as FileData from '../file';
     /**
-     * Creates a new puzzle from a loaded {@link FileData.Model.IPuzzlesFile | PuzzlesFile}
-     * @param from - The {@link FileData.Model.IPuzzlesFile | puzzles file} to be loaded.
+     * 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}
@@ -20,0 +20,0 @@ * or `Failure` with details if an error occurs.

lib/packlets/collections/collections.js

@@ -70,4 +70,4 @@ "use strict";
     /**
-     * Creates a new puzzle from a loaded {@link FileData.Model.IPuzzlesFile | PuzzlesFile}
-     * @param from - The {@link FileData.Model.IPuzzlesFile | puzzles file} to be loaded.
+     * 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}
@@ -74,0 +74,0 @@ * or `Failure` with details if an error occurs.

lib/packlets/common/converters.d.ts

@@ -20,3 +20,3 @@ import { Converter } from '@fgv/ts-utils';
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzleDescription | PuzzleDescription}.
+ * Converts an arbitrary object to a {@link IPuzzleDescription | IPuzzleDescription}.
  * @public
@@ -23,0 +23,0 @@ */

lib/packlets/common/converters.js

@@ -59,3 +59,3 @@ "use strict";
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzleDescription | PuzzleDescription}.
+ * Converts an arbitrary object to a {@link IPuzzleDescription | IPuzzleDescription}.
  * @public
@@ -62,0 +62,0 @@ */

lib/packlets/common/puzzle.d.ts

@@ -52,3 +52,3 @@ import { Result } from '@fgv/ts-utils';
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link Data.Model.PuzzleDescription | Puzzle description} from which this puzzle state
+     * @param puzzle - {@Link IPuzzleDescription | Puzzle description} from which this puzzle state
      * is to be initialized.
@@ -55,0 +55,0 @@ */

lib/packlets/common/puzzle.js

@@ -39,3 +39,3 @@ "use strict";
      * Constructs a new puzzle state.
-     * @param puzzle - {@Link Data.Model.PuzzleDescription | Puzzle description} from which this puzzle state
+     * @param puzzle - {@Link IPuzzleDescription | Puzzle description} from which this puzzle state
      * is to be initialized.
@@ -42,0 +42,0 @@ */

lib/packlets/file/converters.d.ts

 import { Converter, Result } from '@fgv/ts-utils';
 import { IPuzzlesFile } from './model';
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * Converts an arbitrary object to a {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @public
@@ -10,3 +10,3 @@ */
  * Loads an arbitrary JSON file and parses it to return a validated
- * {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @param path - String path to the file
@@ -13,0 +13,0 @@ * @returns `Success` with the resulting file, or `Failure` with details if an

lib/packlets/file/converters.js

@@ -31,3 +31,3 @@ "use strict";
 /**
- * Converts an arbitrary object to a {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * Converts an arbitrary object to a {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @public
@@ -40,3 +40,3 @@ */
  * Loads an arbitrary JSON file and parses it to return a validated
- * {@link Data.Model.PuzzlesFile | PuzzlesFile}.
+ * {@link File.Model.IPuzzlesFile | IPuzzlesFile}.
  * @param path - String path to the file
@@ -43,0 +43,0 @@ * @returns `Success` with the resulting file, or `Failure` with details if an

lib/packlets/puzzles/anyPuzzle.d.ts

 import { Result } from '@fgv/ts-utils';
 import { IPuzzleDescription, Puzzle } from '../common';
 /**
- * Static class to instantiate any puzzle from a {@link Data.Model.PuzzleDescription | puzzle description}.
+ * Static class to instantiate any puzzle from a {@link PuzzleDescription | puzzle description}.
  * @internal
@@ -6,0 +6,0 @@ */

lib/packlets/puzzles/anyPuzzle.js

@@ -32,3 +32,3 @@ "use strict";
 /**
- * Static class to instantiate any puzzle from a {@link Data.Model.PuzzleDescription | puzzle description}.
+ * Static class to instantiate any puzzle from a {@link PuzzleDescription | puzzle description}.
  * @internal
@@ -35,0 +35,0 @@ */

package.json

 {
 	"name": "@fgv/ts-sudoku-lib",
-	"version": "3.0.1-alpha.6",
+	"version": "4.0.0",
 	"description": "Sudoku rules library",
@@ -19,10 +19,10 @@ "main": "lib/index.js",
 	"devDependencies": {
-		"@fgv/ts-utils": "3.0.1-alpha.6",
-		"@fgv/ts-utils-jest": "3.0.1-alpha.6",
-		"@microsoft/api-documenter": "^7.23.34",
-		"@microsoft/api-extractor": "^7.42.1",
+		"@fgv/ts-utils": "4.0.0",
+		"@fgv/ts-utils-jest": "4.0.0",
+		"@microsoft/api-documenter": "^7.24.5",
+		"@microsoft/api-extractor": "^7.43.4",
 		"@types/jest": "^29.5.12",
-		"@types/node": "^20.11.24",
-		"@typescript-eslint/eslint-plugin": "^7.1.0",
-		"@typescript-eslint/parser": "^7.1.0",
+		"@types/node": "^20.12.11",
+		"@typescript-eslint/eslint-plugin": "^7.9.0",
+		"@typescript-eslint/parser": "^7.9.0",
 		"cspell": "^8.3.2",
@@ -39,17 +39,17 @@ "eslint": "^8.57.0",
 		"prettier": "^3.2.5",
-		"rimraf": "^5.0.5",
+		"rimraf": "^5.0.7",
 		"ts-jest": "^29.1.2",
 		"ts-node": "^10.9.2",
-		"typescript": "^5.3.3",
+		"typescript": "^5.4.5",
 		"eslint-plugin-n": "^16.6.2",
-		"@rushstack/heft": "~0.65.8",
-		"@rushstack/heft-node-rig": "~2.4.21",
+		"@rushstack/heft": "~0.66.6",
+		"@rushstack/heft-node-rig": "~2.6.3",
 		"@types/heft-jest": "1.0.6",
-		"@rushstack/eslint-config": "~3.6.4",
-		"@rushstack/heft-jest-plugin": "~0.11.18",
+		"@rushstack/eslint-config": "~3.6.9",
+		"@rushstack/heft-jest-plugin": "~0.11.27",
 		"eslint-plugin-tsdoc": "~0.2.17",
-		"@fgv/ts-json-base": "3.0.1-alpha.6"
+		"@fgv/ts-json-base": "4.0.0"
 	},
 	"peerDependencies": {
-		"@fgv/ts-utils": "3.0.1-alpha.6"
+		"@fgv/ts-utils": "4.0.0"
 	},
@@ -56,0 +56,0 @@ "scripts": {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

290546

increased by0.09%

Lines of code

3678

increased by0.41%

Number of low quality alerts

1

decreased by-50%

No dependency changes