s2cfgtojson 3.1.0 → 3.2.0

package/Struct.mts

@@ -1,6 +1,6 @@
 export * from "./types.mts";
 export * from "./enums.mts";
-import { DefaultEntries } from "./types.mts";
+import { DefaultEntries, Internal } from "./types.mts";
 
 const TAB = "   ";
 const WILDCARD = "_wildcard";
@@ -11,6 +11,17 @@ const KEYWORDS = [
   "bpatch", // allows patching only specific keys
 ];
 const REMOVE_NODE = "removenode";
+const INTERNAL_PROPS = new Set([
+  "__internal__",
+  "fork",
+  "removeNode",
+  "addNode",
+  "clone",
+  "forEach",
+  "filter",
+  "map",
+  "toString",
+]);
 
 /**
  * This file is part of the Stalker 2 Modding Tools project.
@@ -83,25 +94,32 @@ export class Struct {
     return Struct.fromString(this.toString())[0] as this;
   }
 
-  forEach(callback: ([key, value]) => void): void {
-    Object.entries(this)
-      .filter(([key]) => key !== "__internal__")
-      .forEach(callback);
+  entries(): [keyof this, (typeof this)[keyof this]][] {
+    return Object.entries(this).filter(([key]) => !INTERNAL_PROPS.has(key)) as [
+      keyof this,
+      (typeof this)[keyof this],
+    ][];
+  }
+
+  forEach<K extends Exclude<keyof this, Internal>, V extends (typeof this)[K]>(
+    callback: ([key, value]: [K, V]) => void,
+  ): void {
+    this.entries().forEach(([key, value]) => callback([key as K, value as V]));
   }
 
   /**
    * Filters the struct entries based on a callback function. Returns a copy.
    * @param callback
    */
-  filter(callback: ([key, value]) => boolean): Partial<this> & Struct {
+  filter<K extends Exclude<keyof this, Internal>, V extends (typeof this)[K]>(
+    callback: ([key, value]: [K, V]) => boolean,
+  ): Partial<this> & Struct {
     const clone = this.clone();
-    Object.entries(clone)
-      .filter(([key]) => key !== "__internal__")
-      .forEach(([key, value]) => {
-        if (!callback([key, value])) {
-          delete clone[key];
-        }
-      });
+    clone.entries().forEach(([key, value]) => {
+      if (!callback([key as K, value as V])) {
+        delete clone[key];
+      }
+    });
     return clone;
   }
 
@@ -109,13 +127,13 @@ export class Struct {
    * Maps the struct entries based on a callback function. Returns a copy.
    * @param callback
    */
-  map(callback: ([key, value]) => typeof value): this {
+  map<K extends Exclude<keyof this, Internal>, V extends (typeof this)[K]>(
+    callback: ([key, value]: [K, V]) => V,
+  ): this {
     const clone = this.clone();
-    Object.entries(clone)
-      .filter(([key]) => key !== "__internal__")
-      .forEach(([key, value]) => {
-        clone[key] = callback([key, value]);
-      });
+    clone.entries().forEach(([key, value]) => {
+      clone[key] = callback([key as K, value as V]);
+    });
     return clone;
   }
 
@@ -123,23 +141,26 @@ export class Struct {
     if (!(this.__internal__ instanceof Refs)) {
       this.__internal__ = new Refs(this.__internal__);
     }
-    const { __internal__: internal, ...entries } = this;
 
-    let text: string = internal.rawName ? `${internal.rawName} : ` : "";
+    let text: string = this.__internal__.rawName
+      ? `${this.__internal__.rawName} : `
+      : "";
     text += "struct.begin";
 
-    const refs = internal.toString();
+    const refs = this.__internal__.toString();
     if (refs) {
       text += ` {${refs}}`;
     }
 
     text += "\n";
     // Add all keys
-    text += Object.entries(entries || {})
+    text += Object.entries(this)
+      .filter(([key]) => !INTERNAL_PROPS.has(key))
       .map(([key, value]) => {
         const nameAlreadyRendered =
           value instanceof Struct && value.__internal__.rawName;
-        const useAsterisk = internal.isArray && internal.useAsterisk;
+        const useAsterisk =
+          this.__internal__.isArray && this.__internal__.useAsterisk;
         let keyOrIndex = "";
         let equalsOrColon = "";
         let spaceOrNoSpace = "";

package/Struct.test.mts

@@ -42,8 +42,8 @@ class BuyLimitations extends Struct {
     rawName: "BuyLimitations",
     isArray: true,
   });
-  [0] = "EItemType::Weapon";
-  [1] = "EItemType::Armor";
+  "0" = "EItemType::Weapon";
+  "1" = "EItemType::Armor";
 }
 
 describe("Struct", () => {
@@ -309,7 +309,7 @@ struct.end`;
       const a = new TradePrototype().fork(true);
       expect(a.TradeGenerators[0].BuyLimitations[0]).toBe("EItemType::Weapon");
       expect(a.TradeGenerators[0].BuyLimitations[1]).toBe("EItemType::Armor");
-      a.TradeGenerators[0].BuyLimitations.removeNode(0);
+      a.TradeGenerators[0].BuyLimitations.removeNode("0");
       expect(a.TradeGenerators[0].BuyLimitations[0]).toBe("removenode");
     });
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "s2cfgtojson",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Converts Stalker 2 Cfg file into POJOs",
   "keywords": [
     "stalker",

package/types.mts

@@ -68,7 +68,17 @@ import {
 } from "./enums.mjs";
 import { Struct } from "./Struct.mjs";
 
-export type Internal = "__internal__";
+export type Internal =
+  | "__internal__"
+  | "fork"
+  | "removeNode"
+  | "addNode"
+  | "clone"
+  | "forEach"
+  | "filter"
+  | "map"
+  | "entries"
+  | "toString";
 
 export type DeeplyPartial<T> = {
   [P in keyof T]?: T[P] extends Array<infer U>
@@ -81,7 +91,7 @@ export type DeeplyPartial<T> = {
 };
 
 export type DeeplyPartialStruct<T> = DeeplyPartial<
-  T extends Struct ? Omit<T, Internal> : T
+  T extends Struct ? Exclude<T, Internal> : T
 >;
 
 export interface DefaultEntries {