@fgv/ts-sudoku-lib 5.0.1-9 → 5.0.2-0

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.53.3"
+      "packageVersion": "7.54.0"
     }
   ]
 }

package/lib/index.browser.d.ts

@@ -0,0 +1,7 @@
+import * as Files from './packlets/files/index.browser';
+import * as Hints from './packlets/hints';
+import * as Puzzles from './packlets/puzzles';
+export * from './packlets/collections';
+export * from './packlets/common';
+export { Files, Hints, Puzzles };
+//# sourceMappingURL=index.browser.d.ts.map

package/lib/index.browser.js

@@ -0,0 +1,78 @@
+"use strict";
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Puzzles = exports.Hints = exports.Files = void 0;
+// Browser entry point - excludes Node.js filesystem dependencies
+// eslint-disable-next-line @rushstack/packlets/mechanics -- browser-specific entry point excludes Node.js fs dependencies
+const Files = __importStar(require("./packlets/files/index.browser"));
+exports.Files = Files;
+const Hints = __importStar(require("./packlets/hints"));
+exports.Hints = Hints;
+const Puzzles = __importStar(require("./packlets/puzzles"));
+exports.Puzzles = Puzzles;
+__exportStar(require("./packlets/collections"), exports);
+__exportStar(require("./packlets/common"), exports);
+// Excluded from browser:
+// - Files.loadJsonPuzzlesFileSync (requires Node.js fs via JsonFile.convertJsonFileSync)
+//
+// Included in browser (via FileTree):
+// - Files.loadJsonPuzzlesFromTree (browser-compatible via FileTree)
+//# sourceMappingURL=index.browser.js.map

package/lib/packlets/files/fileTreeHelpers.d.ts

@@ -0,0 +1,13 @@
+import { Result } from '@fgv/ts-utils';
+import { IPuzzlesFile } from './model';
+import { FileTree } from '@fgv/ts-json-base';
+/**
+ * Loads a puzzles file from a {@link FileTree.FileTree | FileTree}.
+ * @param fileTree - FileTree containing the file
+ * @param filePath - Path within the FileTree to the puzzles file
+ * @returns `Success` with the resulting file, or `Failure` with details if an
+ * error occurs.
+ * @public
+ */
+export declare function loadJsonPuzzlesFromTree(fileTree: FileTree.FileTree, filePath: string): Result<IPuzzlesFile>;
+//# sourceMappingURL=fileTreeHelpers.d.ts.map

package/lib/packlets/files/fileTreeHelpers.js

@@ -0,0 +1,40 @@
+"use strict";
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadJsonPuzzlesFromTree = loadJsonPuzzlesFromTree;
+const converters_1 = require("./converters");
+const ts_json_base_1 = require("@fgv/ts-json-base");
+/**
+ * Loads a puzzles file from a {@link FileTree.FileTree | FileTree}.
+ * @param fileTree - FileTree containing the file
+ * @param filePath - Path within the FileTree to the puzzles file
+ * @returns `Success` with the resulting file, or `Failure` with details if an
+ * error occurs.
+ * @public
+ */
+function loadJsonPuzzlesFromTree(fileTree, filePath) {
+    return ts_json_base_1.JsonFile.DefaultJsonTreeHelper.convertJsonFromTree(fileTree, filePath, converters_1.puzzlesFile);
+}
+//# sourceMappingURL=fileTreeHelpers.js.map

package/lib/packlets/files/index.browser.d.ts

@@ -0,0 +1,5 @@
+import * as Converters from './converters';
+import * as Model from './model';
+export { Converters, Model };
+export { loadJsonPuzzlesFromTree } from './fileTreeHelpers';
+//# sourceMappingURL=index.browser.d.ts.map

package/lib/packlets/files/index.browser.js

@@ -0,0 +1,70 @@
+"use strict";
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadJsonPuzzlesFromTree = exports.Model = exports.Converters = void 0;
+// Browser-safe files exports - includes FileTree functions, excludes Node.js filesystem functions
+const Converters = __importStar(require("./converters"));
+exports.Converters = Converters;
+const Model = __importStar(require("./model"));
+exports.Model = Model;
+// Re-export browser-compatible FileTree helpers
+var fileTreeHelpers_1 = require("./fileTreeHelpers");
+Object.defineProperty(exports, "loadJsonPuzzlesFromTree", { enumerable: true, get: function () { return fileTreeHelpers_1.loadJsonPuzzlesFromTree; } });
+// Excluded from browser:
+// - loadJsonPuzzlesFileSync (requires Node.js fs via JsonFile.convertJsonFileSync)
+//# sourceMappingURL=index.browser.js.map

package/lib/packlets/files/index.d.ts

@@ -1,5 +1,6 @@
 import * as Converters from './converters';
 import * as Model from './model';
-import * as FileSystem from './filesystem';
-export { Converters, Model, FileSystem };
+export { Converters, Model };
+export { loadJsonPuzzlesFileSync } from './filesystem';
+export { loadJsonPuzzlesFromTree } from './fileTreeHelpers';
 //# sourceMappingURL=index.d.ts.map

package/lib/packlets/files/index.js

@@ -2,7 +2,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2023 Erik Fortune
+ * Copyright (c) 2025 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
@@ -56,11 +56,14 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileSystem = exports.Model = exports.Converters = void 0;
+exports.loadJsonPuzzlesFromTree = exports.loadJsonPuzzlesFileSync = exports.Model = exports.Converters = void 0;
 const Converters = __importStar(require("./converters"));
 exports.Converters = Converters;
 const Model = __importStar(require("./model"));
 exports.Model = Model;
-const FileSystem = __importStar(require("./filesystem"));
-exports.FileSystem = FileSystem;
+// Export both filesystem and FileTree helpers
+var filesystem_1 = require("./filesystem");
+Object.defineProperty(exports, "loadJsonPuzzlesFileSync", { enumerable: true, get: function () { return filesystem_1.loadJsonPuzzlesFileSync; } });
+var fileTreeHelpers_1 = require("./fileTreeHelpers");
+Object.defineProperty(exports, "loadJsonPuzzlesFromTree", { enumerable: true, get: function () { return fileTreeHelpers_1.loadJsonPuzzlesFromTree; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-sudoku-lib",
-  "version": "5.0.1-9",
+  "version": "5.0.2-0",
   "description": "Sudoku rules library",
   "main": "lib/index.js",
   "types": "dist/ts-sudoku-lib.d.ts",
@@ -43,12 +43,30 @@
     "@rushstack/eslint-config": "4.5.3",
     "@rushstack/heft-jest-plugin": "1.1.3",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils": "5.0.1-9",
-    "@fgv/ts-json-base": "5.0.1-9",
-    "@fgv/ts-utils-jest": "5.0.1-9"
+    "@fgv/heft-dual-rig": "0.1.0",
+    "@fgv/ts-utils-jest": "5.0.2-0",
+    "@fgv/ts-utils": "5.0.2-0",
+    "@fgv/ts-json-base": "5.0.2-0"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.1-9"
+    "@fgv/ts-utils": "5.0.2-0"
+  },
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./lib/index.js",
+        "require": "./lib/index.js"
+      },
+      "default": {
+        "import": "./lib/index.browser.js",
+        "require": "./lib/index.browser.js"
+      },
+      "types": "dist/ts-sudoku-lib.d.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ErikFortune/fgv.git"
   },
   "scripts": {
     "build": "heft build --clean",