feat: add support to parse picklist values

Author: RaviVaranasi

src/core/reflection/sobject/__test__/reflect-custom-field-sources.spec.ts

@@ -100,6 +100,52 @@ describe('when parsing custom field metadata', () => {
     assertEither(result, (data) => expect(data[0].type.description).toBe('A Photo URL field'));
   });
 
+  test('can parse picklist values', async() => {
+    const unparsed: UnparsedCustomFieldBundle = {
+      type: 'customfield',
+      name: 'Status__c',
+      parentName: 'MyFirstObject__c',
+      filePath: 'src/field/Status__c.field-meta.xml',
+      content: `
+      <?xml version="1.0" encoding="UTF-8"?>
+      <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+          <fullName>Status__c</fullName>
+          <externalId>false</externalId>
+          <label>Status</label>
+          <required>true</required>
+          <trackFeedHistory>false</trackFeedHistory>
+          <description>Status</description>
+          <type>Picklist</type>
+          <valueSet>
+              <restricted>true</restricted>
+              <valueSetDefinition>
+                  <sorted>false</sorted>
+                  <value>
+                      <fullName>Staging</fullName>
+                      <default>false</default>
+                      <label>Staging</label>
+                  </value>
+                  <value>
+                      <fullName>Active</fullName>
+                      <default>false</default>
+                      <label>Active</label>
+                  </value>
+                  <value>
+                      <fullName>Inactive</fullName>
+                      <default>false</default>
+                      <label>Inactive</label>
+                  </value>
+              </valueSetDefinition>
+          </valueSet>
+      </CustomField>`,
+    };
+
+    const result = await reflectCustomFieldSources([unparsed])();
+
+    assertEither(result, (data) => expect(data[0].type.description).toBe('Status'));
+    assertEither(result, (data) => expect(data[0].type.pickListValues).toEqual(['Staging', 'Active', 'Inactive']));
+  });
+
   test('An error is returned when the XML is in an invalid format', async () => {
     const unparsed: UnparsedCustomFieldBundle = {
       type: 'customfield',

src/core/reflection/sobject/reflect-custom-field-source.ts

@@ -15,6 +15,7 @@ export type CustomFieldMetadata = {
   label?: string | null;
   type?: string | null;
   parentName: string;
+  pickListValues: string[];
 };
 
 export function reflectCustomFieldSources(
@@ -58,12 +59,34 @@ function validate(parsedResult: unknown): E.Either<Error, { CustomField: unknown
 }
 
 function toCustomFieldMetadata(parserResult: { CustomField: unknown }): CustomFieldMetadata {
-  const customField = typeof parserResult.CustomField === 'object' ? parserResult.CustomField : {};
+  const customField =
+    parserResult?.CustomField != null && typeof parserResult.CustomField === 'object' ? parserResult.CustomField : {};
   const defaultValues = {
     description: null,
   };
 
-  return { ...defaultValues, ...customField, type_name: 'customfield' } as CustomFieldMetadata;
+  const pickListValues =
+    isCustomField(customField) && customField.type === 'Picklist' ? toPickListValues(customField) : [];
+  return { ...defaultValues, ...customField, type_name: 'customfield', pickListValues } as CustomFieldMetadata;
+}
+
+function toPickListValues(customField: object): string[] {
+  if ('valueSet' in customField) {
+    const valueSet = customField.valueSet as object;
+    if ('valueSetDefinition' in valueSet) {
+      const valueSetDefinition = valueSet.valueSetDefinition as object;
+      if ('value' in valueSetDefinition) {
+        const pickListValues = valueSetDefinition.value as object[];
+        return pickListValues.filter((each) => 'fullName' in each).map((each) => each.fullName as string);
+      }
+    }
+  }
+
+  return [];
+}
+
+function isCustomField(customField: object): customField is CustomFieldMetadata {
+  return (customField as CustomFieldMetadata).type != undefined;
 }
 
 function addName(metadata: CustomFieldMetadata, name: string): CustomFieldMetadata {