@dchighs/dc-config 0.0.10 → 0.1.1

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/dist/dtos/game-config.d.ts

@@ -2169,26 +2169,28 @@ export interface MazeIslandReward {
 export interface News {
     "0": The0;
     "1": The1;
-    "2": The11;
-    "3": The3;
-    "4": The1;
-    "5": The3;
-    "6": The1;
-    "7": The3;
-    "8": The3;
-    "9": The1;
+    "2": The10;
+    "3": The12;
+    "4": The12;
+    "5": The10;
+    "6": The12;
+    "7": The10;
+    "8": The12;
+    "9": The12;
     "10": The10;
     "11": The11;
-    "12": The1;
-    "13": The1;
-    "14": The14;
+    "12": The12;
+    "13": The10;
+    "14": The10;
     "15": The15;
+    "16": The16;
     canvas: Canva[];
 }
 export interface The0 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
+    direct_to_shop: number;
     end_ts: string;
     hud_button: The0_HudButton;
     id: number;
@@ -2201,6 +2203,7 @@ export interface The0 {
 export interface The0_HudButton {
     file: string;
     title: string;
+    viral_icon_tier: number;
 }
 export interface The0_Slide {
     content_localized_key: string;
@@ -2215,6 +2218,23 @@ export interface The0_Slide {
     times_to_show?: number;
 }
 export interface The1 {
+    active_platforms: ValueClass;
+    allow_island_tutorial: number;
+    assets_name: string;
+    end_ts: string;
+    hud_button: The1_HudButton;
+    id: number;
+    min_level: number;
+    popup_type: string;
+    show_on_startup: number;
+    slides: The0_Slide[];
+    start_ts: string;
+}
+export interface The1_HudButton {
+    file: string;
+    title: string;
+}
+export interface The10 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
@@ -2228,10 +2248,10 @@ export interface The1 {
     popup_type: string;
     priority: number | null;
     show_on_startup: number;
-    slides: The1_Slide[];
+    slides: The10_Slide[];
     start_ts: string;
 }
-export interface The1_Slide {
+export interface The10_Slide {
     content_localized_key: string;
     custom_title_localized_key: string;
     header_localized_key: string;
@@ -2279,14 +2299,14 @@ export declare enum Style {
 export declare enum SlideType {
     FullImage = "FullImage"
 }
-export interface The10 {
+export interface The11 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
     direct_to_shop: number;
     end_ts: string;
     filter_category: null;
-    hud_button: The10_HudButton;
+    hud_button: The0_HudButton;
     id: number;
     label_text_tid: null;
     label_title_tid: null;
@@ -2295,15 +2315,10 @@ export interface The10 {
     popup_type: string;
     priority: null;
     show_on_startup: number;
-    slides: The10_Slide[];
+    slides: The11_Slide[];
     start_ts: string;
 }
-export interface The10_HudButton {
-    file: string;
-    title: string;
-    viral_icon_tier: number;
-}
-export interface The10_Slide {
+export interface The11_Slide {
     content_localized_key: string;
     custom_title_localized_key: string;
     forceClose?: boolean;
@@ -2313,7 +2328,7 @@ export interface The10_Slide {
     times_to_show: number;
     type: SlideType;
 }
-export interface The11 {
+export interface The12 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
@@ -2324,10 +2339,10 @@ export interface The11 {
     popup_frequency: string;
     popup_type: string;
     show_on_startup: number;
-    slides: The1_Slide[];
+    slides: The11_Slide[];
     start_ts: string;
 }
-export interface The14 {
+export interface The15 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
@@ -2342,7 +2357,7 @@ export interface The14 {
     slides: The0_Slide[];
     start_ts: string;
 }
-export interface The15 {
+export interface The16 {
     active_platforms: ValueClass;
     allow_island_tutorial: number;
     assets_name: string;
@@ -2356,21 +2371,7 @@ export interface The15 {
     popup_type: string;
     priority: null;
     show_on_startup: number;
-    slides: The10_Slide[];
-    start_ts: string;
-}
-export interface The3 {
-    active_platforms: ValueClass;
-    allow_island_tutorial: number;
-    assets_name: string;
-    direct_to_shop: number;
-    end_ts: string;
-    id: number;
-    min_level: number;
-    popup_frequency: string;
-    popup_type: string;
-    show_on_startup: number;
-    slides: The10_Slide[];
+    slides: The11_Slide[];
     start_ts: string;
 }
 export interface Canva {
@@ -3323,8 +3324,8 @@ export interface MultiplierTime {
     multiplier_time: number;
 }
 export interface TreeOfLifePowerupRaritySeed {
-    rarity: Rarity;
     max_rarity_seeds_per_grade: number[];
+    rarity: Rarity;
 }
 export interface Visual {
     id: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dchighs/dc-config",
-  "version": "0.0.10",
+  "version": "0.1.1",
   "description": "A library to handle configuration for Dragon City.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",