@dchighs/dc-config 0.0.10 → 0.1.0

package/LICENSE

@@ -1,21 +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
+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

@@ -10,13 +10,12 @@ Installation is straightforward—simply use your preferred package manager. Her
 
 ```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">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="200">
 </a>
 
 ### Fetching configuration for specific parameters
@@ -27,24 +26,23 @@ To create a `Config` instance, you need to provide credentials or use the static
 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)
+    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)
 })();
-
 ```
 
 ---
@@ -58,17 +56,43 @@ import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/
 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
-	})
+    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
+    })
 })();
+```
+
+---
+
+### Fetching a raw configuration from a URL
 
+If you have a full raw JSON file and want to fetch it and filter specific keys:
+
+```ts
+import { Config, ConfigFilter, ConfigLanguage } from "@dchighs/dc-config"
+
+;(async () => {
+    const rawUrl = "https://example.com/config.json"
+    
+    // Using createRaw to get a Config instance
+    const config = await Config.createRaw({
+        url: rawUrl,
+        filter: [ConfigFilter.Items],
+        language: ConfigLanguage.English
+    })
+
+    // Or using fetchRaw to get just the data (GameConfigDto)
+    const data = await Config.fetchRaw({
+        url: rawUrl,
+        filter: [ConfigFilter.Items]
+    })
+})();
 ```
 
 ---

package/dist/dc-config.d.ts

@@ -13,13 +13,34 @@ export type CreateOptions = Omit<Omit<ConfigOptions, "platform" | "language"> &
     language?: ConfigLanguage | `${ConfigLanguage}`;
     platform?: ConfigPlatform | `${ConfigPlatform}`;
 }, "data">;
+export type CreateRawOptions = {
+    url: string;
+    filter?: Array<ConfigFilter | `${ConfigFilter}`>;
+    language?: ConfigLanguage | `${ConfigLanguage}`;
+    platform?: ConfigPlatform | `${ConfigPlatform}`;
+};
 export type FetchOptions = CreateOptions;
+export type FetchRawOptions = Pick<CreateRawOptions, "url" | "filter">;
 export declare class Config {
     readonly platform: ConfigPlatform;
     readonly langauge: ConfigLanguage;
     readonly filter?: ConfigFilter[];
     readonly data: GameConfigDto;
     constructor({ data, language, platform, filter }: ConfigOptions);
+    /**
+     * Creates a new Config instance by fetching data from the API with authentication.
+    */
     static create({ authToken, userId, filter, language, platform, url }: CreateOptions): Promise<Config>;
+    /**
+     * Creates a new Config instance by fetching a raw JSON file from a URL.
+    */
+    static createRaw({ url, filter, language, platform }: CreateRawOptions): Promise<Config>;
+    /**
+     * Fetches configuration from the API with authentication.
+    */
     static fetch({ authToken, userId, filter, language, platform, url }: FetchOptions): Promise<GameConfigDto>;
+    /**
+     * Fetches a raw config file from a URL and filters its contents.
+    */
+    static fetchRaw({ url, filter }: FetchRawOptions): Promise<GameConfigDto>;
 }

package/dist/dc-config.js

@@ -13,6 +13,9 @@ class Config {
         this.platform = platform;
         this.filter = filter ? filter : undefined;
     }
+    /**
+     * Creates a new Config instance by fetching data from the API with authentication.
+    */
     static async create({ authToken, userId, filter, language, platform, url }) {
         const data = await Config.fetch({
             authToken: authToken,
@@ -29,6 +32,21 @@ class Config {
             platform: platform !== null && platform !== void 0 ? platform : enums_1.ConfigPlatform.Default
         });
     }
+    /**
+     * Creates a new Config instance by fetching a raw JSON file from a URL.
+    */
+    static async createRaw({ url, filter, language, platform }) {
+        const data = await Config.fetchRaw({ url, filter });
+        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
+        });
+    }
+    /**
+     * Fetches configuration from the API with authentication.
+    */
     static async fetch({ authToken, userId, filter, language, platform, url }) {
         const response = await axios_1.default.post(url, null, {
             params: {
@@ -42,5 +60,32 @@ class Config {
         const data = response.data;
         return data;
     }
+    /**
+     * Fetches a raw config file from a URL and filters its contents.
+    */
+    static async fetchRaw({ url, filter }) {
+        const response = await axios_1.default.get(url);
+        const fullData = response.data;
+        if (!filter || filter.length === 0) {
+            return {
+                game_data: {
+                    config: fullData.game_data.config
+                }
+            };
+        }
+        const filteredData = {};
+        filter.forEach((key) => {
+            var _a, _b;
+            const value = (_b = (_a = fullData.game_data) === null || _a === void 0 ? void 0 : _a.config) === null || _b === void 0 ? void 0 : _b[key];
+            if (value !== undefined) {
+                filteredData[key] = value;
+            }
+        });
+        return {
+            game_data: {
+                config: filteredData
+            }
+        };
+    }
 }
 exports.Config = Config;

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "@dchighs/dc-config",
-  "version": "0.0.10",
-  "description": "A library to handle configuration for Dragon City.",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist/*",
-    "!/**/__tests__"
-  ],
-  "keywords": [
-    "dragon city",
-    "dc",
-    "configuration",
-    "dc highs"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "update-dto": "ts-node scripts/update-dto.ts"
-  },
-  "author": "Marcuth",
-  "license": "MIT",
-  "type": "commonjs",
-  "devDependencies": {
-    "@marcuth/env": "^0.0.1",
-    "@types/node": "^25.0.3",
-    "quicktype-core": "^23.2.6",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "axios": "^1.13.2"
-  },
-  "peerDependencies": {
-    "@dchighs/dc-core": "^0.3.0"
-  }
-}
+{
+  "name": "@dchighs/dc-config",
+  "version": "0.1.0",
+  "description": "A library to handle configuration for Dragon City.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/*",
+    "!/**/__tests__"
+  ],
+  "keywords": [
+    "dragon city",
+    "dc",
+    "configuration",
+    "dc highs"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "update-dto": "ts-node scripts/update-dto.ts"
+  },
+  "author": "Marcuth",
+  "license": "MIT",
+  "type": "commonjs",
+  "devDependencies": {
+    "@marcuth/env": "^0.0.1",
+    "@types/node": "^25.0.3",
+    "quicktype-core": "^23.2.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "axios": "^1.13.2"
+  },
+  "peerDependencies": {
+    "@dchighs/dc-core": "^0.3.0"
+  }
+}