Add category/details converter (#167)

faros-ai · Oct 16, 2023 · 997a180 · 997a180
1 parent 4482c2a
commit 997a180
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 0 deletions.
diff --git a/src/utils.ts b/src/utils.ts
@@ -115,4 +115,27 @@ export class Utils {
       setTimeout(resolve, millis);
     });
   }
+
+static toCategoryDetail<EnumType extends {Custom: any}>(
+    enumObject: EnumType & Record<string, any>,
+    category: string,
+    categoryMapping: Record<string, string> = {}
+  ): {
+    category: EnumType[keyof EnumType];
+    detail: string;
+  } {
+    const enumSymbol =
+      enumObject[category] ?? enumObject[categoryMapping[category]];
+    if (enumSymbol) {
+      return {
+        category: enumSymbol,
+        detail: category,
+      };
+    }
+
+    return {
+      category: enumObject.Custom,
+      detail: category,
+    };
+  }
 }
diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -150,4 +150,64 @@ describe('parse primary keys', () => {
       true)
     ).toEqual(['lat', 'lon']);
   });
+
+  describe('to category detail converter', () => {
+    enum Example {
+      Option1 = 'Option1',
+      Option2 = 'Option2',
+      Custom = 'Custom',
+    }
+
+    test('category matches enum symbol', () => {
+      expect(
+        sut.Utils.toCategoryDetail(Example, 'Option1')
+      ).toEqual({
+        category: Example.Option1,
+        detail: 'Option1',
+      });
+    });
+
+    test('mapped category matches enum symbol', () => {
+      const sourceCategory = 'Option One';
+      const questionCategoryMapping = {
+        [sourceCategory]: 'Option1',
+      };
+
+      expect(
+        sut.Utils.toCategoryDetail(
+          Example,
+          sourceCategory,
+          questionCategoryMapping
+        )
+      ).toEqual({
+        category: Example.Option1,
+        detail: sourceCategory,
+      });
+    });
+
+    test('unmatched category', () => {
+      const sourceCategory = 'Option One';
+      const questionCategoryMapping = {
+        [sourceCategory]: 'NotARealCategory',
+      };
+
+      expect(
+        sut.Utils.toCategoryDetail(
+          Example,
+          sourceCategory,
+          questionCategoryMapping
+        )
+      ).toEqual({
+        category: Example.Custom,
+        detail: sourceCategory,
+      });
+
+      expect(
+        sut.Utils.toCategoryDetail(Example, sourceCategory)
+      ).toEqual({
+        category: Example.Custom,
+        detail: sourceCategory,
+      });
+    });
+  });
 });