Merge pull request #2 from mdingena/add-embedded-entity-component-versions

Add embeddedEntity component versions to version string

Author: mdingena

package.json

@@ -8,6 +8,7 @@
     "prebuild": "rimraf build/",
     "build": "tsc",
     "compile": "tsc --noEmit",
+    "pretest": "npm run build",
     "test": "jest"
   },
   "author": "Marc Dingena",

src/decoders/decodeEmbeddedEntities.ts

@@ -11,7 +11,7 @@ export type UnknownEmbeddedEntity = {
 
 export type KnownEmbeddedEntity = Fire;
 
-export type EmbeddedEntities = KnownEmbeddedEntity & {
+export type EmbeddedEntities = {
   Unknown?: UnknownEmbeddedEntity[];
   Fire?: Fire;
 };

src/getComponentVersions.ts

@@ -1,40 +1,68 @@
-import { Prefab } from './decoders';
-import { transcoders, ComponentName, UnknownComponent, ComponentVersion } from './components';
+import { Components, KnownEmbeddedEntity, Prefab, UnknownEmbeddedEntity } from './decoders';
+import { ComponentName, UnknownComponent, ComponentVersion } from './components';
+import { ComponentHash } from './ComponentHash';
 
 type VersionPair = [number, number];
 
-const getComponentVersionPairs = (prefab: Prefab): VersionPair[] => {
+const getComponentVersionPairs = (components: Components = {}) => {
+  const versionPairs: VersionPair[] = [];
+
+  for (const [key, value] of Object.entries(components)) {
+    const componentName = key as ComponentName | 'Unknown';
+
+    if (componentName === 'Unknown') {
+      const unknownComponents = value as UnknownComponent[];
+      versionPairs.push(
+        ...unknownComponents.map(
+          component => [component.hash, ComponentVersion.get(component.hash)] as [number, number]
+        )
+      );
+    } else {
+      const componentHash = ComponentHash[componentName];
+      const componentVersion = ComponentVersion.get(componentHash);
+      versionPairs.push([componentHash, componentVersion ?? 1]);
+    }
+  }
+
+  return versionPairs;
+};
+
+const getPrefabVersionPairs = (prefab: Prefab): VersionPair[] => {
   const versionPairs: VersionPair[] = [];
 
   if (prefab.components) {
-    for (const [key, value] of Object.entries(prefab.components)) {
-      const componentName = key as ComponentName | 'Unknown';
-
-      if (componentName === 'Unknown') {
-        const unknownComponents = value as UnknownComponent[];
-        versionPairs.push(
-          ...unknownComponents.map(
-            component => [component.hash, ComponentVersion.get(component.hash)] as [number, number]
-          )
-        );
+    versionPairs.push(...getComponentVersionPairs(prefab.components));
+  }
+
+  if (prefab.embeddedEntities) {
+    for (const [key, value] of Object.entries(prefab.embeddedEntities)) {
+      const embeddedEntityName = key as keyof KnownEmbeddedEntity | 'Unknown';
+
+      if (embeddedEntityName === 'Unknown') {
+        const unknownEmbeddedEntities = value as UnknownEmbeddedEntity[];
+
+        for (const embeddedEntity of unknownEmbeddedEntities) {
+          versionPairs.push(...getComponentVersionPairs(embeddedEntity.components));
+        }
       } else {
-        const componentInfo = transcoders[componentName];
-        versionPairs.push([componentInfo.HASH, componentInfo.VERSION]);
+        const knownEmbeddedEntity = value as KnownEmbeddedEntity;
+
+        versionPairs.push(...getComponentVersionPairs(knownEmbeddedEntity.components));
       }
     }
   }
 
   if (prefab.childPrefabs?.length) {
     for (const childPrefab of prefab.childPrefabs) {
-      versionPairs.push(...getComponentVersionPairs(childPrefab.prefab));
+      versionPairs.push(...getPrefabVersionPairs(childPrefab.prefab));
     }
   }
 
   return versionPairs;
 };
 
 export const getComponentVersions = (prefab: Prefab): string => {
-  const versionPairs = getComponentVersionPairs(prefab);
+  const versionPairs = getPrefabVersionPairs(prefab);
   const uniquePairs = versionPairs.filter(
     ([hash], index) => versionPairs.findIndex(pair => pair[0] === hash) === index
   );

tests/createString.test.ts

@@ -1,11 +1,17 @@
 import { createString } from '../build';
-import { handle } from './data/unencodedPrefabObjects';
-import { shortHandleWithLargeGuardAndLargeBlade } from './data/encodedPrefabObjects';
+import { handle, litGrassClump } from './data/unencodedPrefabObjects';
+import { grassClumpOnFire, shortHandleWithLargeGuardAndLargeBlade } from './data/encodedPrefabObjects';
 
 describe('createString', () => {
   it('should encode a prefab object', () => {
     const encodedPrefab = createString(handle);
 
     expect(encodedPrefab).toStrictEqual(shortHandleWithLargeGuardAndLargeBlade);
   });
+
+  it('should create a version string', () => {
+    const encodedPrefab = createString(litGrassClump);
+
+    expect(encodedPrefab).toStrictEqual(grassClumpOnFire);
+  });
 });

tests/data/encodedPrefabObjects.ts

@@ -1,2 +1,4 @@
 export const shortHandleWithLargeGuardAndLargeBlade =
   '42230,252,42230,3291430912,1124086579,1120403456,0,0,0,1065353216,1065353216,2290978823,418,3291430912,1124086579,1120403456,0,0,0,1065353216,0,0,0,0,0,0,0,0,536871679,1163,0,0,0,0,0,0,133169152,133169152,34023564,2684354564,2523,1307670851,3758096388,126122721,1073741824,0,268438699,2147487155,3221225472,0,0,0,0,0,66584576,66584576,17011782,1342177282,1968,3875060897,4026531842,63061360,2684354560,0,0,|3,2290978823,1,272188517,1,1871432223,1,';
+export const grassClumpOnFire =
+  '57872,80,57872,0,0,0,0,0,0,1065353216,1065353216,0,30100,194,4202164032,48,3221225472,343781376,1836894,0,0,0,|1,4109360768,2,';

tests/data/unencodedPrefabObjects.ts

@@ -57,3 +57,16 @@ export const handle: Prefab = {
     }
   ]
 };
+
+export const litGrassClump: Prefab = {
+  prefabObject: {
+    hash: PrefabHash.Grass_Clump
+  },
+  embeddedEntities: {
+    Fire: {
+      components: {
+        HeatSourceBase: {}
+      }
+    }
+  }
+};