@scrabble-solver/types 2.12.2 → 2.12.4

package/build/Config.d.ts

@@ -2,6 +2,7 @@ import Bonus from './Bonus';
 import BonusValue from './BonusValue';
 import Cell from './Cell';
 import ConfigJson from './ConfigJson';
+import Game from './Game';
 import Locale from './Locale';
 import Tile from './Tile';
 import TileConfig from './TileConfig';
@@ -17,6 +18,7 @@ declare class Config {
     get blanksCount(): number;
     get boardHeight(): number;
     get boardWidth(): number;
+    get game(): Game;
     get locale(): Locale;
     get twoCharacterTiles(): string[];
     getCellBonus(cell: Cell): Bonus | undefined;

package/build/Config.js

@@ -33,6 +33,9 @@ class Config {
     get boardWidth() {
         return this.config.boardWidth;
     }
+    get game() {
+        return this.config.game;
+    }
     get locale() {
         return this.config.locale;
     }

package/build/ConfigJson.d.ts

@@ -1,4 +1,5 @@
 import BonusJson from './BonusJson';
+import Game from './Game';
 import Locale from './Locale';
 import TileConfig from './TileConfig';
 interface ConfigJson {
@@ -8,7 +9,7 @@ interface ConfigJson {
     boardHeight: number;
     boardWidth: number;
     bonuses: BonusJson[];
-    id: string;
+    game: Game;
     locale: Locale;
     maximumCharactersCount: number;
     name: string;

package/build/Dictionary.d.ts

@@ -0,0 +1,7 @@
+import Locale from './Locale';
+interface Dictionary {
+    description: string;
+    locale: Locale;
+    name: string;
+}
+export default Dictionary;

package/build/Dictionary.js

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

package/build/Game.d.ts

@@ -0,0 +1,7 @@
+declare enum Game {
+    Literaki = "literaki",
+    Scrabble = "scrabble",
+    SuperScrabble = "super-scrabble"
+}
+export declare const isGame: (locale: unknown) => locale is Game;
+export default Game;

package/build/Game.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGame = void 0;
+var Game;
+(function (Game) {
+    Game["Literaki"] = "literaki";
+    Game["Scrabble"] = "scrabble";
+    Game["SuperScrabble"] = "super-scrabble";
+})(Game || (Game = {}));
+const games = Object.values(Game);
+const isGame = (locale) => games.includes(locale);
+exports.isGame = isGame;
+exports.default = Game;

package/build/Locale.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Locales are defined using IETF language tags
+ * @see https://en.wikipedia.org/wiki/IETF_language_tag
+ * @see https://en.wikipedia.org/wiki/ISO_3166-1
+ */
 declare enum Locale {
     DE_DE = "de-DE",
     EN_GB = "en-GB",

package/build/Locale.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLocale = void 0;
-// eslint-disable-next-line no-shadow
+/**
+ * Locales are defined using IETF language tags
+ * @see https://en.wikipedia.org/wiki/IETF_language_tag
+ * @see https://en.wikipedia.org/wiki/ISO_3166-1
+ */
 var Locale;
 (function (Locale) {
     Locale["DE_DE"] = "de-DE";

package/build/index.d.ts

@@ -10,10 +10,10 @@ export { default as Collision } from './Collision';
 export { default as CollisionJson } from './CollisionJson';
 export { default as Config } from './Config';
 export { default as ConfigJson } from './ConfigJson';
+export { default as Dictionary } from './Dictionary';
 export { default as FinalPattern } from './FinalPattern';
+export { default as Game, isGame } from './Game';
 export { default as HorizontalPattern } from './HorizontalPattern';
-export { default as isError } from './isError';
-export { default as isObject } from './isObject';
 export { default as Locale, isLocale } from './Locale';
 export { default as Pattern } from './Pattern';
 export { default as PatternJson } from './PatternJson';
@@ -26,3 +26,5 @@ export { default as VerticalPattern } from './VerticalPattern';
 export { default as WordBonus } from './WordBonus';
 export { default as WordDefinition } from './WordDefinition';
 export { default as WordDefinitionJson } from './WordDefinitionJson';
+export { default as isError } from './isError';
+export { default as isObject } from './isObject';

package/build/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WordDefinition = exports.WordBonus = exports.VerticalPattern = exports.isTileJson = exports.Tile = exports.Result = exports.Pattern = exports.isLocale = exports.Locale = exports.isObject = exports.isError = exports.HorizontalPattern = exports.FinalPattern = exports.Config = exports.CharacterBonus = exports.isCellJson = exports.Cell = exports.Bonus = exports.isBoardJson = exports.Board = void 0;
+exports.isObject = exports.isError = exports.WordDefinition = exports.WordBonus = exports.VerticalPattern = exports.isTileJson = exports.Tile = exports.Result = exports.Pattern = exports.isLocale = exports.Locale = exports.HorizontalPattern = exports.isGame = exports.Game = exports.FinalPattern = exports.Config = exports.CharacterBonus = exports.isCellJson = exports.Cell = exports.Bonus = exports.isBoardJson = exports.Board = void 0;
 var Board_1 = require("./Board");
 Object.defineProperty(exports, "Board", { enumerable: true, get: function () { return __importDefault(Board_1).default; } });
 var BoardJson_1 = require("./BoardJson");
@@ -20,12 +20,11 @@ var Config_1 = require("./Config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return __importDefault(Config_1).default; } });
 var FinalPattern_1 = require("./FinalPattern");
 Object.defineProperty(exports, "FinalPattern", { enumerable: true, get: function () { return __importDefault(FinalPattern_1).default; } });
+var Game_1 = require("./Game");
+Object.defineProperty(exports, "Game", { enumerable: true, get: function () { return __importDefault(Game_1).default; } });
+Object.defineProperty(exports, "isGame", { enumerable: true, get: function () { return Game_1.isGame; } });
 var HorizontalPattern_1 = require("./HorizontalPattern");
 Object.defineProperty(exports, "HorizontalPattern", { enumerable: true, get: function () { return __importDefault(HorizontalPattern_1).default; } });
-var isError_1 = require("./isError");
-Object.defineProperty(exports, "isError", { enumerable: true, get: function () { return __importDefault(isError_1).default; } });
-var isObject_1 = require("./isObject");
-Object.defineProperty(exports, "isObject", { enumerable: true, get: function () { return __importDefault(isObject_1).default; } });
 var Locale_1 = require("./Locale");
 Object.defineProperty(exports, "Locale", { enumerable: true, get: function () { return __importDefault(Locale_1).default; } });
 Object.defineProperty(exports, "isLocale", { enumerable: true, get: function () { return Locale_1.isLocale; } });
@@ -43,3 +42,7 @@ var WordBonus_1 = require("./WordBonus");
 Object.defineProperty(exports, "WordBonus", { enumerable: true, get: function () { return __importDefault(WordBonus_1).default; } });
 var WordDefinition_1 = require("./WordDefinition");
 Object.defineProperty(exports, "WordDefinition", { enumerable: true, get: function () { return __importDefault(WordDefinition_1).default; } });
+var isError_1 = require("./isError");
+Object.defineProperty(exports, "isError", { enumerable: true, get: function () { return __importDefault(isError_1).default; } });
+var isObject_1 = require("./isObject");
+Object.defineProperty(exports, "isObject", { enumerable: true, get: function () { return __importDefault(isObject_1).default; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/types",
-  "version": "2.12.2",
+  "version": "2.12.4",
   "description": "Scrabble Solver 2 - Types",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -24,7 +24,7 @@
     "clean:force": "npm run clean && rimraf package-lock.json"
   },
   "dependencies": {
-    "@scrabble-solver/constants": "^2.12.2"
+    "@scrabble-solver/constants": "^2.12.4"
   },
-  "gitHead": "22ec8b756bf1f50d94028c8e69ccc269c23e5759"
+  "gitHead": "b7af635998fc55dcfb05c009d856819550cb20d8"
 }

package/src/Config.ts

@@ -5,6 +5,7 @@ import BonusValue from './BonusValue';
 import Cell from './Cell';
 import CharacterBonus from './CharacterBonus';
 import ConfigJson from './ConfigJson';
+import Game from './Game';
 import Locale from './Locale';
 import Tile from './Tile';
 import TileConfig from './TileConfig';
@@ -51,6 +52,10 @@ class Config {
     return this.config.boardWidth;
   }
 
+  public get game(): Game {
+    return this.config.game;
+  }
+
   public get locale(): Locale {
     return this.config.locale;
   }

package/src/ConfigJson.ts

@@ -1,4 +1,5 @@
 import BonusJson from './BonusJson';
+import Game from './Game';
 import Locale from './Locale';
 import TileConfig from './TileConfig';
 
@@ -9,7 +10,7 @@ interface ConfigJson {
   boardHeight: number;
   boardWidth: number;
   bonuses: BonusJson[];
-  id: string;
+  game: Game;
   locale: Locale;
   maximumCharactersCount: number;
   name: string;

package/src/Dictionary.ts

@@ -0,0 +1,9 @@
+import Locale from './Locale';
+
+interface Dictionary {
+  description: string;
+  locale: Locale;
+  name: string;
+}
+
+export default Dictionary;

package/src/Game.ts

@@ -0,0 +1,11 @@
+enum Game {
+  Literaki = 'literaki',
+  Scrabble = 'scrabble',
+  SuperScrabble = 'super-scrabble',
+}
+
+const games = Object.values(Game);
+
+export const isGame = (locale: unknown): locale is Game => games.includes(locale as Game);
+
+export default Game;

package/src/Locale.ts

@@ -1,4 +1,8 @@
-// eslint-disable-next-line no-shadow
+/**
+ * Locales are defined using IETF language tags
+ * @see https://en.wikipedia.org/wiki/IETF_language_tag
+ * @see https://en.wikipedia.org/wiki/ISO_3166-1
+ */
 enum Locale {
   DE_DE = 'de-DE',
   EN_GB = 'en-GB',

package/src/index.ts

@@ -10,10 +10,10 @@ export { default as Collision } from './Collision';
 export { default as CollisionJson } from './CollisionJson';
 export { default as Config } from './Config';
 export { default as ConfigJson } from './ConfigJson';
+export { default as Dictionary } from './Dictionary';
 export { default as FinalPattern } from './FinalPattern';
+export { default as Game, isGame } from './Game';
 export { default as HorizontalPattern } from './HorizontalPattern';
-export { default as isError } from './isError';
-export { default as isObject } from './isObject';
 export { default as Locale, isLocale } from './Locale';
 export { default as Pattern } from './Pattern';
 export { default as PatternJson } from './PatternJson';
@@ -26,3 +26,5 @@ export { default as VerticalPattern } from './VerticalPattern';
 export { default as WordBonus } from './WordBonus';
 export { default as WordDefinition } from './WordDefinition';
 export { default as WordDefinitionJson } from './WordDefinitionJson';
+export { default as isError } from './isError';
+export { default as isObject } from './isObject';