@dchighs/dc-config-mapper 0.0.1

package/LICENSE

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

package/README.md

@@ -0,0 +1,187 @@
+# @dchighs/dc-config-mapper
+
+**@dchighs/dc-config-mapper** is a package for manipulating configuration data from the game [Dragon City](https://dragoncitygame.com/) (this is not an official SocialPoint library; it is fan-made).
+
+## 📦 Installation
+
+Installation is straightforward; simply use your preferred package manager. Here is an example using NPM:
+
+```cmd
+npm i @dchighs/dc-config-mapper @dchighs/dc-config @dchighs/dc-localization @dchighs/dc-core
+
+```
+
+> You also need to install `@dchighs/dc-config`, `@dchighs/dc-localization`, and `@dchighs/dc-core`. These are set as `peerDependencies`, meaning the package requires them to function but will use the specific versions you have installed in your project.
+
+---
+
+## 🚀 Usage
+
+<a href="https://www.buymeacoffee.com/marcuth">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="200">
+</a>
+
+### Mapping Chests
+
+```ts
+import { Config, ConfigLangauge } from "@dchighs/dc-config"
+import { ChestsMapper } from "@dchighs/dc-config-mapper"
+import { Localization } from "@dchighs/dc-localization"
+
+;(async () => {
+	const userId = process.env.USER_ID
+	const authToken = process.env.AUTH_TOKEN
+	const url = process.env.URL
+
+	const config = await Config.create({
+		userId: userId,
+		authToken: authToken,
+		url: url,
+	})
+	
+	const localization = await Localization.create(ConfigLangauge.Turkish)
+	const chestsMapper = new ChestsMapper(localization)
+	
+	const { chests, rewards } = chestsMapper.map(config.data.game_data.config.chests)
+	
+	console.log({ chests, rewards })
+})();
+
+```
+
+---
+
+### Mapping Items
+
+```ts
+import { ItemsMapper } from "@dchighs/dc-config-mapper"
+
+// ...
+	const itemsMapper = new ItemsMapper(localization)
+	
+	const items = itemsMapper.map(config.data.game_data.config.items)
+	
+	console.log(items)
+})();
+
+```
+
+---
+
+### Mapping Heroic Races
+
+```ts
+import { HeroicRacesMapper } from "@dchighs/dc-config-mapper"
+
+// ...
+	const heroicRacesMapper = new HeroicRacesMapper(localization)
+	
+	const heroicRaces = heroicRacesMapper.map(config.data.game_data.config.heroic_races)
+	
+	console.log(heroicRaces)
+})();
+
+```
+
+---
+
+### Mapping Maze Islands
+
+```ts
+import { MazeIslandsMapper } from "@dchighs/dc-config-mapper"
+
+// ...
+	const mazeIslandsMapper = new MazeIslandsMapper(localization)
+	
+	const mazeIslands = mazeIslandsMapper.map(config.data.game_data.config.maze_island)
+	
+	console.log(mazeIslands)
+})();
+
+```
+
+---
+
+### Mapping Skills
+
+```ts
+import { SkillsMapper } from "@dchighs/dc-config-mapper"
+
+// ...
+	const skillsMapper = new SkillsMapper(localization)
+	
+	const skills = skillsMapper.map(config.data.game_data.config.skills)
+	
+	console.log(skills)
+})();
+
+```
+
+---
+
+### Compiling Data
+
+If you need to populate data for end-use, it is ideal to use the `DataCompiler` and provide the necessary context for data compilation:
+
+```ts
+import { DataCompiler } from "@dchighs/dc-config-mapper"
+
+const dataCompiler = new DataCompiler({
+	acceptedPrefixes: [
+		"basic_",
+		"trainable_",
+		"top_",
+		"middle_",
+		"bottom_",
+		"1_",
+		"2_",
+		"3_",
+		"4_"
+	]
+})
+
+```
+
+Then, use it as follows:
+
+```ts
+const heroicRaces = heroicRacesMapper.map(config.data.game_data.config.heroic_races)
+const skills = skillsMapper.map(config.data.game_data.config.skills)
+const items = itemsMapper.map(config.data.game_data.config.items)
+
+const compileContext = {
+	laps: heroicRaces.laps,
+	nodes: heroicRaces.nodes,
+	missions: heroicRaces.missions,
+	rewards: heroicRaces.rewards,
+	attacks: skills.attacks,
+	dragons: items.dragons
+}
+
+const firstIsland = heroicRaces.islands[0]
+
+const finalData = dataCompiler.compile({
+	data: firstIsland,
+	context: compileContext,
+})
+
+console.log(finalData)
+
+```
+
+---
+
+## 🤝 Contributing
+
+* Want to contribute? Follow these steps:
+* Fork the repository.
+* Create a new branch (`git checkout -b feature-new`).
+* Commit your changes (`git commit -m 'Add new feature'`).
+* Push to the branch (`git push origin feature-new`).
+* Open a Pull Request.
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License.

package/dist/data-compiler.d.ts

@@ -0,0 +1,25 @@
+export type DataCompilerOptions = {
+    acceptedPrefixes?: string[];
+    idsSuffix?: string;
+    idSuffix?: string;
+};
+export type CompileOptions = {
+    data: Record<string, any>;
+    context: Record<string, any>;
+};
+export type CompileArrayOptions = {
+    data: Record<string, any>[];
+    context: Record<string, any>;
+};
+export declare class DataCompiler {
+    private readonly acceptedPrefixes;
+    private readonly idsSuffix;
+    private readonly idSuffix;
+    constructor({ acceptedPrefixes, idsSuffix, idSuffix }?: DataCompilerOptions);
+    private findMatchingPrefix;
+    private processIdsSuffix;
+    private processIdSuffix;
+    private isArrayOfObjects;
+    compileMany({ data, context }: CompileArrayOptions): Record<string, any>[];
+    compile({ data, context }: CompileOptions): Record<string, any>;
+}

package/dist/data-compiler.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataCompiler = void 0;
+const lodash_1 = require("lodash");
+const pluralize_1 = __importDefault(require("pluralize"));
+class DataCompiler {
+    constructor({ acceptedPrefixes, idsSuffix, idSuffix } = {}) {
+        this.acceptedPrefixes = acceptedPrefixes !== null && acceptedPrefixes !== void 0 ? acceptedPrefixes : [];
+        this.idsSuffix = idsSuffix !== null && idsSuffix !== void 0 ? idsSuffix : "_ids";
+        this.idSuffix = idSuffix !== null && idSuffix !== void 0 ? idSuffix : "_id";
+    }
+    findMatchingPrefix(key) {
+        for (const acceptedPrefix of this.acceptedPrefixes) {
+            if (key.startsWith(acceptedPrefix)) {
+                return acceptedPrefix;
+            }
+        }
+        return "";
+    }
+    processIdsSuffix({ context, data, key, prefix }) {
+        const baseKey = key.slice(prefix.length).slice(0, -this.idsSuffix.length);
+        const pluralizedKey = (0, pluralize_1.default)(baseKey);
+        if (context[pluralizedKey]) {
+            const relatedItems = context[pluralizedKey]
+                .filter((item) => data[key].includes(item.id))
+                .map((item) => (0, lodash_1.isObject)(item) ? this.compile({ data: item, context: context }) : item);
+            data[`${prefix}${pluralizedKey}`] = relatedItems;
+            delete data[key];
+        }
+    }
+    processIdSuffix({ context, data, key, prefix }) {
+        const baseKey = key.slice(prefix.length).slice(0, -this.idSuffix.length);
+        const pluralizedKey = (0, pluralize_1.default)(baseKey);
+        if (context[pluralizedKey]) {
+            const foundItem = context[pluralizedKey].find((item) => item.id === data[key]);
+            data[`${prefix}${baseKey}`] = foundItem ? this.compile({ data: foundItem, context: context }) : null;
+            delete data[key];
+        }
+    }
+    isArrayOfObjects(value) {
+        return Array.isArray(value) && value.every(item => (0, lodash_1.isObject)(item));
+    }
+    compileMany({ data, context }) {
+        return data.map(item => (0, lodash_1.isObject)(item) ? this.compile({ data: item, context: context }) : item);
+    }
+    compile({ data, context }) {
+        const dataCopy = { ...data };
+        try {
+            for (const [key, value] of Object.entries(dataCopy)) {
+                if (this.isArrayOfObjects(value)) {
+                    data[key] = this.compileMany({ data: value, context: context });
+                }
+                else if ((0, lodash_1.isObject)(value)) {
+                    data[key] = this.compile({ data: value, context: context });
+                }
+                const matchedPrefix = this.findMatchingPrefix(key);
+                if (key.endsWith(this.idsSuffix)) {
+                    this.processIdsSuffix({
+                        data: data,
+                        key: key,
+                        prefix: matchedPrefix,
+                        context: context
+                    });
+                }
+                else if (key.endsWith(this.idSuffix)) {
+                    this.processIdSuffix({
+                        data: data,
+                        key: key,
+                        prefix: matchedPrefix,
+                        context: context
+                    });
+                }
+            }
+            return data;
+        }
+        catch (error) {
+            console.error("Error while compiling data:", error);
+            console.log("Data:", data);
+            console.log("Data Copy:", dataCopy);
+            process.exit(1);
+        }
+    }
+}
+exports.DataCompiler = DataCompiler;

package/dist/dtos/items/dragon.d.ts

@@ -0,0 +1,74 @@
+export interface DragonDto {
+    id: number;
+    name: string;
+    group_type: string;
+    name_key?: string;
+    speed: number;
+    mobile_version: number;
+    android_version: number;
+    display_order: number;
+    hatching_time: number;
+    breeding_time: number;
+    xp: number;
+    lvl: number;
+    costs: {
+        g?: number;
+        c?: number;
+    };
+    sell_price: {
+        g: number;
+    };
+    starting_coins: number;
+    coins_added: number;
+    can_breed: number;
+    breedable: number;
+    deity_breeding: number;
+    difficulty: number;
+    category: number;
+    rarity: number;
+    dragon_rarity: string;
+    attacks: Array<number>;
+    attributes: Array<string>;
+    trainable_attacks: Array<number>;
+    upgrade_levels: Array<number>;
+    background_vfx: Array<number>;
+    foreground_vfx: Array<number>;
+    in_store: number;
+    in_store_min_level: number;
+    flying_level: number;
+    swim: number;
+    new_item: number;
+    img_name?: string;
+    img_name_mobile?: string;
+    img_name_android?: string;
+    giftable?: number;
+    gift_level: number;
+    description?: string;
+    seeds_to_summon: number;
+    hatching_time_10: number;
+    breeding_time_40: number;
+    breeding_time_10: number;
+    hatching_time_40: number;
+    base_attack: number;
+    base_life: number;
+    in_store_ch?: number;
+    costs_ch_1?: {
+        c?: number;
+        g?: number;
+    };
+    costs_ch_2?: {
+        c?: number;
+        g?: number;
+    };
+    hatching_time_reawaken: number;
+    breeding_time_reawaken: number;
+    hatching_time_ngu_aggressive: number;
+    breeding_time_ngu_aggressive: number;
+    hatching_time_ngu_soft: number;
+    breeding_time_ngu_soft: number;
+    dragon_ownership_id: number;
+    tags?: Array<string>;
+    speed_override?: number;
+    passive_skills?: Array<number>;
+    post_skills?: Array<number>;
+}

package/dist/dtos/items/dragon.js

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

package/dist/dtos/items/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dragon";
+export * from "./restructured-items";

package/dist/dtos/items/index.js

@@ -0,0 +1,18 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dragon"), exports);
+__exportStar(require("./restructured-items"), exports);