@dchighs/dc-config 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,87 @@
+# @dchighs/dc-config
+
+**@dchighs/dc-config** is a package for accessing game configuration data from [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
+
+```
+
+## 🚀 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>
+
+### Fetching configuration for specific parameters
+
+To create a `Config` instance, you need to provide credentials or use the static `.create()` method by providing the necessary parameters:
+
+```ts
+import { Config, ConfigLanguage, ConfigPlatform, ConfigFilter } from "@dchighs/dc-config"
+
+;(async () => {
+	const userId = process.env.USER_ID
+	const authToken = process.env.AUTH_TOKEN
+	const url = process.env.URL
+
+	const config = await Config.create({
+		url: url,
+		userId: userId,
+		authToken: authToken,
+		language: ConfigLanguage.Turkish, // optional - "en" is default
+		platform: ConfigPlatform.Android, // optional - "ios" is default
+		filter: [ConfigFilter.Items] // optional - undefined is default
+	})
+	
+	const data = config.data
+	
+	console.log(data)
+})();
+
+```
+
+---
+
+### Loading a saved configuration from a file
+
+If you have a saved JSON file containing configuration data and want to load it to perform operations using the class, you can do it as follows:
+
+```ts
+import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/dc-config"
+import fs from "node:fs"
+
+;(async () => {
+	const filePath = "config.json"
+	const contentString = await fs.promises.readFile(filePath, { encoding: "utf-8" })
+	const data = JSON.parse(contentString) as GameConfigDto
+
+	const config = new Config({
+		language: ConfigLanguage.Turkish,
+		platform: ConfigPlatform.Android,
+		data: data
+	})
+})();
+
+```
+
+---
+
+## 🤝 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/dc-config.d.ts

@@ -0,0 +1,25 @@
+import { ConfigFilter, ConfigLanguage, ConfigPlatform } from "./enums";
+import { GameConfigDto } from "./dtos/game-config";
+export type ConfigOptions = {
+    language: ConfigLanguage | `${ConfigLanguage}`;
+    filter?: Array<ConfigFilter | `${ConfigFilter}`>;
+    platform: ConfigPlatform | `${ConfigPlatform}`;
+    data: GameConfigDto;
+};
+export type CreateOptions = Omit<Omit<ConfigOptions, "platform" | "language"> & {
+    authToken: string;
+    userId: string;
+    url: string;
+    language?: ConfigLanguage | `${ConfigLanguage}`;
+    platform?: ConfigPlatform | `${ConfigPlatform}`;
+}, "data">;
+export type FetchOptions = CreateOptions;
+export declare class Config {
+    readonly platform: ConfigPlatform;
+    readonly langauge: ConfigLanguage;
+    readonly filter?: ConfigFilter[];
+    readonly data: GameConfigDto;
+    constructor({ data, language, platform, filter }: ConfigOptions);
+    static create({ authToken, userId, filter, language, platform, url }: CreateOptions): Promise<Config>;
+    static fetch({ authToken, userId, filter, language, platform, url }: FetchOptions): Promise<GameConfigDto>;
+}

package/dist/dc-config.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const axios_1 = __importDefault(require("axios"));
+const enums_1 = require("./enums");
+class Config {
+    constructor({ data, language, platform, filter }) {
+        this.data = data;
+        this.langauge = language;
+        this.platform = platform;
+        this.filter = filter ? filter : undefined;
+    }
+    static async create({ authToken, userId, filter, language, platform, url }) {
+        const data = await Config.fetch({
+            authToken: authToken,
+            userId: userId,
+            filter: filter,
+            language: language,
+            platform: platform,
+            url: url
+        });
+        return new Config({
+            data: data,
+            filter: filter,
+            language: language !== null && language !== void 0 ? language : enums_1.ConfigLanguage.Default,
+            platform: platform !== null && platform !== void 0 ? platform : enums_1.ConfigPlatform.Default
+        });
+    }
+    static async fetch({ authToken, userId, filter, language, platform, url }) {
+        const response = await axios_1.default.post(url, null, {
+            params: {
+                authToken: authToken,
+                userId: userId,
+                filter: filter === null || filter === void 0 ? void 0 : filter.join(","),
+                platform: platform,
+                language: language
+            }
+        });
+        const data = response.data;
+        return data;
+    }
+}
+exports.Config = Config;