@scrabble-solver/configs 2.13.2 → 2.13.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/configs",
-  "version": "2.13.2",
+  "version": "2.13.4",
   "description": "Scrabble Solver 2 - Configs",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -20,12 +20,11 @@
   "homepage": "https://scrabble-solver.org",
   "scripts": {
     "build": "tsc --project .",
-    "clean": "rimraf build/ node_modules/",
-    "clean:force": "npm run clean && rimraf package-lock.json"
+    "clean": "rimraf build/"
   },
   "dependencies": {
-    "@scrabble-solver/constants": "^2.13.2",
-    "@scrabble-solver/types": "^2.13.2"
+    "@scrabble-solver/constants": "^2.13.4",
+    "@scrabble-solver/types": "^2.13.4"
   },
-  "gitHead": "416ff4259dd617dd5a65212baf75aedfff2686af"
+  "gitHead": "852ecdf9eb6aaefb9befb0cb1ea671868da7d0de"
 }

package/dictionaries/build/Dictionaries.d.ts

@@ -1,13 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-declare class Dictionaries {
-    private readonly cache;
-    private readonly downloadDictionaryProxies;
-    constructor();
-    get(locale: Locale): Promise<Trie>;
-    remove(): void;
-    update(force?: boolean): Promise<void>;
-    private getLocalesToUpdate;
-    private updateDictionary;
-}
-export default Dictionaries;

package/dictionaries/build/Dictionaries.js

@@ -1,46 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("@scrabble-solver/logger"));
-const types_1 = require("@scrabble-solver/types");
-const fs_1 = __importDefault(require("fs"));
-const constants_1 = require("./constants");
-const lib_1 = require("./lib");
-class Dictionaries {
-    constructor() {
-        this.cache = new lib_1.LayeredCache();
-        this.downloadDictionaryProxies = Object.fromEntries(Object.values(types_1.Locale).map((locale) => [locale, (0, lib_1.createAsyncProxy)(() => (0, lib_1.downloadDictionary)(locale))]));
-    }
-    async get(locale) {
-        if (this.cache.has(locale)) {
-            const trie = await this.cache.get(locale);
-            if (trie) {
-                return trie;
-            }
-        }
-        logger_1.default.info('Dictionaries - cache miss', { locale });
-        return this.updateDictionary(locale);
-    }
-    remove() {
-        fs_1.default.rmdirSync(constants_1.OUTPUT_DIRECTORY, { recursive: true });
-    }
-    async update(force) {
-        const locales = force ? Object.values(types_1.Locale) : this.getLocalesToUpdate();
-        logger_1.default.info('Dictionaries - update', { force, locales });
-        await Promise.all(locales.map((locale) => this.updateDictionary(locale)));
-    }
-    getLocalesToUpdate() {
-        return Object.values(types_1.Locale).filter((locale) => this.cache.isStale(locale) !== false);
-    }
-    async updateDictionary(locale) {
-        logger_1.default.info('Dictionaries - updateDictionary', { locale });
-        fs_1.default.mkdirSync(constants_1.OUTPUT_DIRECTORY, { recursive: true });
-        const downloadDictionaryProxy = this.downloadDictionaryProxies[locale];
-        const trie = await downloadDictionaryProxy();
-        await this.cache.set(locale, trie);
-        return trie;
-    }
-}
-exports.default = Dictionaries;

package/dictionaries/build/constants/index.d.ts

@@ -1,3 +0,0 @@
-export declare const DAY: number;
-export declare const CACHE_STALE_THRESHOLD: number;
-export declare const OUTPUT_DIRECTORY: string;

package/dictionaries/build/constants/index.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OUTPUT_DIRECTORY = exports.CACHE_STALE_THRESHOLD = exports.DAY = void 0;
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-exports.DAY = 24 * 60 * 60 * 1000;
-exports.CACHE_STALE_THRESHOLD = 1 * exports.DAY; // eslint-disable-line no-implicit-coercion
-exports.OUTPUT_DIRECTORY = path_1.default.resolve(os_1.default.homedir(), '.scrabble-solver', 'dictionaries');

package/dictionaries/build/index.d.ts

@@ -1,3 +0,0 @@
-import Dictionaries from './Dictionaries';
-export * from './lib';
-export declare const dictionaries: Dictionaries;

package/dictionaries/build/index.js

@@ -1,23 +0,0 @@
-"use strict";
-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 __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);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dictionaries = void 0;
-const Dictionaries_1 = __importDefault(require("./Dictionaries"));
-__exportStar(require("./lib"), exports);
-exports.dictionaries = new Dictionaries_1.default();

package/dictionaries/build/lib/DiskCache.d.ts

@@ -1,11 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-import { Cache } from '../types';
-declare class DiskCache implements Cache<Locale, Trie> {
-    get(locale: Locale): Promise<Trie | undefined>;
-    getLastModifiedTimestamp(locale: Locale): number | undefined;
-    has(locale: Locale): boolean;
-    isStale(locale: Locale): boolean | undefined;
-    set(locale: Locale, trie: Trie): Promise<void>;
-}
-export default DiskCache;

package/dictionaries/build/lib/DiskCache.js

@@ -1,48 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const trie_1 = require("@kamilmielnik/trie");
-const fs_1 = __importDefault(require("fs"));
-const constants_1 = require("../constants");
-const getDictionaryFilepath_1 = __importDefault(require("./getDictionaryFilepath"));
-class DiskCache {
-    async get(locale) {
-        if (!this.has(locale)) {
-            return undefined;
-        }
-        const filepath = (0, getDictionaryFilepath_1.default)(locale);
-        const serialized = await fs_1.default.promises.readFile(filepath, 'utf-8');
-        const trie = trie_1.Trie.deserialize(serialized);
-        return trie;
-    }
-    getLastModifiedTimestamp(locale) {
-        const filepath = (0, getDictionaryFilepath_1.default)(locale);
-        if (!fs_1.default.existsSync(filepath)) {
-            return undefined;
-        }
-        const stats = fs_1.default.statSync(filepath);
-        return stats.mtimeMs;
-    }
-    has(locale) {
-        const filepath = (0, getDictionaryFilepath_1.default)(locale);
-        return fs_1.default.existsSync(filepath);
-    }
-    isStale(locale) {
-        if (!this.has(locale)) {
-            return undefined;
-        }
-        const lastModifiedTimestamp = this.getLastModifiedTimestamp(locale);
-        if (typeof lastModifiedTimestamp === 'undefined') {
-            return undefined;
-        }
-        const timeSinceModification = Math.abs(lastModifiedTimestamp - Date.now());
-        return timeSinceModification > constants_1.CACHE_STALE_THRESHOLD;
-    }
-    async set(locale, trie) {
-        const filepath = (0, getDictionaryFilepath_1.default)(locale);
-        await fs_1.default.promises.writeFile(filepath, trie.serialize());
-    }
-}
-exports.default = DiskCache;

package/dictionaries/build/lib/LayeredCache.d.ts

@@ -1,13 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-import { Cache } from '../types';
-declare class LayeredCache implements Cache<Locale, Trie> {
-    private readonly layers;
-    get(locale: Locale): Promise<Trie | undefined>;
-    getLastModifiedTimestamp(locale: Locale): number | undefined;
-    has(locale: Locale): boolean;
-    isStale(locale: Locale): boolean | undefined;
-    set(locale: Locale, trie: Trie): Promise<void>;
-    private getLastModifiedLayer;
-}
-export default LayeredCache;

package/dictionaries/build/lib/LayeredCache.js

@@ -1,55 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const createCacheTimestampComparator_1 = __importDefault(require("./createCacheTimestampComparator"));
-const DiskCache_1 = __importDefault(require("./DiskCache"));
-const MemoryCache_1 = __importDefault(require("./MemoryCache"));
-class LayeredCache {
-    constructor() {
-        this.layers = [new MemoryCache_1.default(), new DiskCache_1.default()];
-    }
-    async get(locale) {
-        const cache = this.getLastModifiedLayer(locale);
-        if (!cache) {
-            return Promise.resolve(undefined);
-        }
-        const [memoryCache, diskCache] = this.layers;
-        const value = await cache.get(locale);
-        if (cache === diskCache && typeof value !== 'undefined') {
-            await memoryCache.set(locale, value);
-        }
-        return value;
-    }
-    getLastModifiedTimestamp(locale) {
-        const cache = this.getLastModifiedLayer(locale);
-        if (!cache) {
-            return undefined;
-        }
-        return cache.getLastModifiedTimestamp(locale);
-    }
-    has(locale) {
-        return this.layers.some((cache) => cache.has(locale));
-    }
-    isStale(locale) {
-        if (this.layers.some((cache) => cache.isStale(locale))) {
-            return true;
-        }
-        if (this.layers.every((cache) => typeof cache.isStale(locale) === 'undefined')) {
-            return undefined;
-        }
-        return false;
-    }
-    async set(locale, trie) {
-        const [memoryCache, diskCache] = this.layers;
-        await diskCache.set(locale, trie);
-        await memoryCache.set(locale, trie);
-    }
-    getLastModifiedLayer(locale) {
-        const layers = this.layers.filter((cache) => cache.has(locale));
-        const [cached] = [...layers].sort((0, createCacheTimestampComparator_1.default)(locale));
-        return cached;
-    }
-}
-exports.default = LayeredCache;

package/dictionaries/build/lib/MemoryCache.d.ts

@@ -1,13 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-import { Cache } from '../types';
-declare class MemoryCache implements Cache<Locale, Trie> {
-    private readonly cache;
-    private readonly cacheTimestamps;
-    get(locale: Locale): Promise<Trie | undefined>;
-    getLastModifiedTimestamp(locale: Locale): number | undefined;
-    has(locale: Locale): boolean;
-    isStale(locale: Locale): boolean | undefined;
-    set(locale: Locale, trie: Trie): Promise<void>;
-}
-export default MemoryCache;

package/dictionaries/build/lib/MemoryCache.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../constants");
-class MemoryCache {
-    constructor() {
-        this.cache = {};
-        this.cacheTimestamps = {};
-    }
-    get(locale) {
-        return Promise.resolve(this.cache[locale]);
-    }
-    getLastModifiedTimestamp(locale) {
-        return this.cacheTimestamps[locale];
-    }
-    has(locale) {
-        return typeof this.cache[locale] !== 'undefined';
-    }
-    isStale(locale) {
-        const timestamp = this.getLastModifiedTimestamp(locale);
-        if (!this.has(locale) || typeof timestamp === 'undefined') {
-            return undefined;
-        }
-        const timeSinceModification = Math.abs(timestamp - Date.now());
-        return timeSinceModification > constants_1.CACHE_STALE_THRESHOLD;
-    }
-    set(locale, trie) {
-        this.cacheTimestamps[locale] = Date.now();
-        this.cache[locale] = trie;
-        return Promise.resolve();
-    }
-}
-exports.default = MemoryCache;

package/dictionaries/build/lib/createAsyncProxy.d.ts

@@ -1,3 +0,0 @@
-type AsyncCallback<T> = () => Promise<T>;
-declare const createAsyncProxy: <T>(asyncCallback: AsyncCallback<T>) => AsyncCallback<T>;
-export default createAsyncProxy;

package/dictionaries/build/lib/createAsyncProxy.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const createAsyncProxy = (asyncCallback) => {
-    let promise = null;
-    return async () => {
-        if (promise) {
-            return promise;
-        }
-        try {
-            promise = asyncCallback();
-            return await promise;
-        }
-        finally {
-            promise = null;
-        }
-    };
-};
-exports.default = createAsyncProxy;

package/dictionaries/build/lib/createCacheTimestampComparator.d.ts

@@ -1,5 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-import { Cache } from '../types';
-declare const createCacheTimestampComparator: (locale: Locale) => (a: Cache<Locale, Trie>, b: Cache<Locale, Trie>) => number;
-export default createCacheTimestampComparator;

package/dictionaries/build/lib/createCacheTimestampComparator.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const createCacheTimestampComparator = (locale) => {
-    return (a, b) => {
-        const aTimestamp = a.getLastModifiedTimestamp(locale);
-        const bTimestamp = b.getLastModifiedTimestamp(locale);
-        if (aTimestamp === bTimestamp) {
-            return 0;
-        }
-        if (typeof aTimestamp === 'undefined') {
-            return 1;
-        }
-        if (typeof bTimestamp === 'undefined') {
-            return -1;
-        }
-        return bTimestamp - aTimestamp;
-    };
-};
-exports.default = createCacheTimestampComparator;

package/dictionaries/build/lib/downloadDictionary.d.ts

@@ -1,4 +0,0 @@
-import { Trie } from '@kamilmielnik/trie';
-import { Locale } from '@scrabble-solver/types';
-declare const downloadDictionary: (locale: Locale) => Promise<Trie>;
-export default downloadDictionary;

package/dictionaries/build/lib/downloadDictionary.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const trie_1 = require("@kamilmielnik/trie");
-const logger_1 = __importDefault(require("@scrabble-solver/logger"));
-const word_lists_1 = require("@scrabble-solver/word-lists");
-const downloadDictionary = async (locale) => {
-    logger_1.default.info('downloadDictionary', { locale });
-    const words = await (0, word_lists_1.getWordList)(locale);
-    logger_1.default.info('downloadDictionary - success', { locale });
-    const trie = trie_1.Trie.fromArray(words);
-    return trie;
-};
-exports.default = downloadDictionary;

package/dictionaries/build/lib/getDictionaryFilepath.d.ts

@@ -1,3 +0,0 @@
-import { Locale } from '@scrabble-solver/types';
-declare const getDictionaryFilepath: (locale: Locale) => string;
-export default getDictionaryFilepath;

package/dictionaries/build/lib/getDictionaryFilepath.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const constants_1 = require("../constants");
-const getDictionaryFilepath = (locale) => {
-    return path_1.default.resolve(constants_1.OUTPUT_DIRECTORY, `${locale}.txt`);
-};
-exports.default = getDictionaryFilepath;

package/dictionaries/build/lib/index.d.ts

@@ -1,7 +0,0 @@
-export { default as createAsyncProxy } from './createAsyncProxy';
-export { default as createCacheTimestampComparator } from './createCacheTimestampComparator';
-export { default as DiskCache } from './DiskCache';
-export { default as downloadDictionary } from './downloadDictionary';
-export { default as getDictionaryFilepath } from './getDictionaryFilepath';
-export { default as LayeredCache } from './LayeredCache';
-export { default as MemoryCache } from './MemoryCache';

package/dictionaries/build/lib/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MemoryCache = exports.LayeredCache = exports.getDictionaryFilepath = exports.downloadDictionary = exports.DiskCache = exports.createCacheTimestampComparator = exports.createAsyncProxy = void 0;
-var createAsyncProxy_1 = require("./createAsyncProxy");
-Object.defineProperty(exports, "createAsyncProxy", { enumerable: true, get: function () { return __importDefault(createAsyncProxy_1).default; } });
-var createCacheTimestampComparator_1 = require("./createCacheTimestampComparator");
-Object.defineProperty(exports, "createCacheTimestampComparator", { enumerable: true, get: function () { return __importDefault(createCacheTimestampComparator_1).default; } });
-var DiskCache_1 = require("./DiskCache");
-Object.defineProperty(exports, "DiskCache", { enumerable: true, get: function () { return __importDefault(DiskCache_1).default; } });
-var downloadDictionary_1 = require("./downloadDictionary");
-Object.defineProperty(exports, "downloadDictionary", { enumerable: true, get: function () { return __importDefault(downloadDictionary_1).default; } });
-var getDictionaryFilepath_1 = require("./getDictionaryFilepath");
-Object.defineProperty(exports, "getDictionaryFilepath", { enumerable: true, get: function () { return __importDefault(getDictionaryFilepath_1).default; } });
-var LayeredCache_1 = require("./LayeredCache");
-Object.defineProperty(exports, "LayeredCache", { enumerable: true, get: function () { return __importDefault(LayeredCache_1).default; } });
-var MemoryCache_1 = require("./MemoryCache");
-Object.defineProperty(exports, "MemoryCache", { enumerable: true, get: function () { return __importDefault(MemoryCache_1).default; } });

package/dictionaries/build/types/Cache.d.ts

@@ -1,8 +0,0 @@
-interface Cache<Key extends string, Value> {
-    get(key: Key): Promise<Value | undefined>;
-    getLastModifiedTimestamp(key: Key): number | undefined;
-    has(key: Key): boolean;
-    isStale(key: Key): boolean | undefined;
-    set(key: Key, value: Value): Promise<void>;
-}
-export default Cache;

package/dictionaries/build/types/Cache.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dictionaries/build/types/index.d.ts

@@ -1 +0,0 @@
-export { default as Cache } from './Cache';

package/dictionaries/build/types/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dictionaries/node_modules/.package-lock.json

@@ -1,16 +0,0 @@
-{
-  "name": "@scrabble-solver/dictionaries",
-  "version": "2.12.5",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "node_modules/@kamilmielnik/trie": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@kamilmielnik/trie/-/trie-2.0.1.tgz",
-      "integrity": "sha512-6Ulw5/xgFRadHsx0uVnpOxB2E2ZO2osnaakI26yS3RMlww580JiaQEfXUmQjXZcmOjcO+HrZ0CWjRDhoDYKHbg==",
-      "engines": {
-        "node": ">=16"
-      }
-    }
-  }
-}

package/dictionaries/node_modules/@kamilmielnik/trie/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Kamil Mielnik
-
-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.