s2cfgtojson 4.4.0 → 5.0.0

package/Struct.mts

@@ -1,6 +1,44 @@
 export * from "./types.mts";
 export * from "./enums.mts";
-import { DefaultEntries, GetStructType, Internal } from "./types.mts";
+
+export type Internal =
+  | "__internal__"
+  | "fork"
+  | "removeNode"
+  | "addNode"
+  | "clone"
+  | "entries"
+  | "forEach"
+  | "filter"
+  | "map"
+  | "fromJson"
+  | "toJson"
+  | "toString"
+  | "fromString";
+
+export interface DefaultEntries {
+  bpatch?: boolean;
+  bskipref?: boolean;
+  isArray?: boolean;
+  isRoot?: boolean;
+  rawName?: string;
+  refkey?: string | number;
+  refurl?: string;
+  useAsterisk?: boolean;
+}
+
+export type GetStructType<In> =
+  In extends Array<any>
+    ? Struct & { [key: `${number}`]: GetStructType<In[typeof key]> }
+    : In extends Record<any, any>
+      ? Struct & { [key in keyof In]: GetStructType<In[key]> }
+      : In extends string
+        ? In
+        : In extends number
+          ? number
+          : In extends boolean
+            ? boolean
+            : In;
 
 const TAB = "   ";
 const WILDCARD = "_wildcard";
@@ -345,7 +383,8 @@ export function createDynamicClassInstance<T extends Struct = Struct>(
   rawName: string,
   index?: number,
 ): T {
-  const name = parseStructName(rawName) || `UnnamedStruct${index}`;
+  const parsedName = parseStructName(rawName) || `UnnamedStruct${index}`;
+  const name = makeSafeClassName(parsedName);
   return new (new Function(
     "parent",
     "Refs",
@@ -492,6 +531,62 @@ function parseStructName(name: string): string {
     .replace(/^_+/, "");
 }
 
+const RESERVED_IDENTIFIERS = new Set([
+  "break",
+  "case",
+  "catch",
+  "class",
+  "const",
+  "continue",
+  "debugger",
+  "default",
+  "delete",
+  "do",
+  "else",
+  "export",
+  "extends",
+  "finally",
+  "for",
+  "function",
+  "if",
+  "import",
+  "in",
+  "instanceof",
+  "new",
+  "return",
+  "super",
+  "switch",
+  "this",
+  "throw",
+  "try",
+  "typeof",
+  "var",
+  "void",
+  "while",
+  "with",
+  "yield",
+  "enum",
+  "await",
+  "implements",
+  "package",
+  "protected",
+  "static",
+  "interface",
+  "private",
+  "public",
+  "let",
+]);
+
+function makeSafeClassName(name: string): string {
+  if (
+    !/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name) ||
+    RESERVED_IDENTIFIERS.has(name)
+  ) {
+    return `_${name}`;
+  }
+  return name;
+}
+
 function maybeMinifyKey(key: string, minify: boolean) {
   return minify &&
     (INTERNAL_PROPS.has(key as any) || REF_INTERNAL_PROPS.has(key as any))

package/Struct.test.mts

@@ -91,6 +91,14 @@ struct.end`,
         `DynamicClass : struct.begin\n\nstruct.end`,
       );
     });
+
+    test("reserved keyword name", () => {
+      const instance = createDynamicClassInstance("default");
+      instance.__internal__.isRoot = true;
+
+      expect(instance).toBeInstanceOf(Struct);
+      expect(instance.toString()).toBe(`default : struct.begin\n\nstruct.end`);
+    });
   });
 
   describe("fromString()", () => {

package/enums.mts

@@ -1,5 +1,18 @@
 // noinspection JSUnusedGlobalSymbols
 
+import {
+  Caliber,
+  Experienced,
+  Master,
+  Newbie,
+  Permutations3,
+  Veteran,
+} from "./utility-types.mts";
+
+export type PanningRule = `PanningRule::${
+  | "PanningRule_Headphones"
+  | "PanningRule_Speakers"}`;
+
 export type EAIConstraintType = `EAIConstraintType::${"PrepareForEmission"}`;
 
 export type EAIMovementPose = `EAIMovementPose::${"Stand"}`;
@@ -76,23 +89,6 @@ export type EAimAssistWeightType = `EAimAssistWeightType::${
   | "Angle"
   | "DistanceFromApex"}`;
 
-export type Caliber =
-  | "A012"
-  | "A045"
-  | "A545"
-  | "A556"
-  | "A762"
-  | "A762NATO"
-  | "A762Sniper"
-  | "A918"
-  | "A919"
-  | "A939"
-  | "AGA"
-  | "AHEDP"
-  | "APG7V"
-  | "AVOG"
-  | "None";
-
 export type EAmmoCaliber = `EAmmoCaliber::${Caliber}`;
 
 export type EAmmoType = `EAmmoType::${
@@ -1610,25 +1606,6 @@ export type ERadiationPreset = `ERadiationPreset::${
   | "Strong"
   | "Topaz"}`;
 
-export type Rank = "Newbie" | "Experienced" | "Veteran" | "Master";
-type Newbie = "ERank::Newbie";
-type Experienced = "ERank::Experienced";
-type Veteran = "ERank::Veteran";
-type Master = "ERank::Master";
-type Permutations2<A, B> = A extends string
-  ? B extends string
-    ? A | B | `${A}, ${B}`
-    : A
-  : never;
-
-type Permutations3<A, B, C> = A extends string
-  ? B extends string
-    ? C extends string
-      ? Permutations2<A, B> | Permutations2<B, C> | `${A}, ${B}, ${C}`
-      : Permutations2<A, B>
-    : A
-  : never;
-
 export type ERank =
   | Permutations3<Newbie, Experienced, Veteran>
   | Permutations3<Experienced, Veteran, Master>
@@ -1969,10 +1946,6 @@ export type EZombificationType = `EZombificationType::${
   | "AliveHuman"
   | "CorpseHuman"}`;
 
-export type PanningRule = `PanningRule::${
-  | "PanningRule_Headphones"
-  | "PanningRule_Speakers"}`;
-
 export type ESoundEffectSubtype = `ESoundEffectSubtype::${
   | "PlaySoundAttached"
   | "SetParameter"
@@ -1995,106 +1968,6 @@ export type EActionType = `EActionType::${
   | "Vault"
   | "ThrowItem"}`;
 
-export type Reactions =
-  | "Enemy"
-  | "Disaffection"
-  | "Neutral"
-  | "Friend"
-  | "Self";
-
-export type Factions =
-  | ""
-  | "Humanoid"
-  | "Player"
-  | "Bandits"
-  | "Monolith"
-  | "FreeStalkers"
-  | "Army"
-  | "Duty"
-  | "Freedom"
-  | "Varta"
-  | "Neutrals"
-  | "Militaries"
-  | "Noon"
-  | "Scientists"
-  | "Mercenaries"
-  | "Flame"
-  | "Law"
-  | "Spark"
-  | "Corpus"
-  | "WildBandits"
-  | "GarmataMilitaries"
-  | "SphereMilitaries"
-  | "NeutralBandits"
-  | "VaranBandits"
-  | "RooseveltBandits"
-  | "ShahBandits"
-  | "LokotBandits"
-  | "DepoBandits"
-  | "DepoVictims"
-  | "DocentBandits"
-  | "VaranStashBandits"
-  | "Diggers"
-  | "KosakBandits"
-  | "AzimutVarta"
-  | "UdavMercenaries"
-  | "SafariHunters"
-  | "AzimuthMilitaries"
-  | "SultanBandits"
-  | "ShevchenkoStalkers"
-  | "VartaLesnichestvo"
-  | "SparkLesnichestvo"
-  | "IkarVarta"
-  | "KabanBandits"
-  | "CrazyGuardians"
-  | "ArenaEnemy"
-  | "ArenaFriend"
-  | "DrozdMilitaries"
-  | "EnemyVarta"
-  | "NeutralMSOP"
-  | "YanovCorpus"
-  | "MoleStalkers"
-  | "Mutant"
-  | "Controller"
-  | "Poltergeist"
-  | "Bloodsucker"
-  | "Zombie"
-  | "Chimera"
-  | "Burer"
-  | "Pseudogiant"
-  | "Anamorph"
-  | "Sinister"
-  | "Pseudobear"
-  | "Snork"
-  | "Pseudodog"
-  | "Boar"
-  | "Flesh"
-  | "Beaver"
-  | "Ratwolf"
-  | "Deer"
-  | "Rat"
-  | "Tushkan"
-  | "Stickman"
-  | "Blinddog"
-  | "Bayun"
-  | "CorpusStorm"
-  | "DocileLabMutants"
-  | "VartaSIRCAA"
-  | "YantarZombie"
-  | "FriendlyBlinddog"
-  | "Lessy"
-  | "AlliedMutants"
-  | "NoahLesya"
-  | "KlenMercenaries"
-  | "SIRCAA_Scientist"
-  | "MALACHITE_Scientist"
-  | "NoonFaustians"
-  | "SQ89_SidorMercs"
-  | "ScarBoss_Faction"
-  | "KorshunovBoss_Faction"
-  | "StrelokBoss_Faction"
-  | "FaustBoss_Faction";
-
 export type EObjBoolParams = `EObjBoolParams::${
   | "IsOffsetAimingEnabled"
   | "IsNightVisionEnabled"

package/package.json

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

package/readme.md

@@ -53,7 +53,7 @@ BasePhantomAttack : struct.begin {refkey=BaseAttackAbility}
 struct.end
 `;
 const parsed = Struct.fromString(configText)[0];
-console.log(parsed.entries.TriggeredCooldowns);
+console.log(parsed.TriggeredCooldowns);
 ```
 
 ---