Standard object parsing error

examples/markdown/docs/custom-objects/Account.md

@@ -0,0 +1,4 @@
+# Account
+
+## API Name
+`ns__Account`

examples/markdown/docs/custom-objects/Contact.md

@@ -0,0 +1,15 @@
+# Contact
+
+## API Name
+`ns__Contact`
+
+## Fields
+### PhotoUrl
+
+**API Name**
+
+`ns__PhotoUrl__c`
+
+**Type**
+
+*Url*

examples/markdown/docs/index.md

@@ -2,6 +2,10 @@
 
 ## Custom Objects
 
+### [Account](custom-objects/Account.md)
+
+### [Contact](custom-objects/Contact.md)
+
 ### [Event__c](custom-objects/Event__c.md)
 
 Represents an event that people can register for.

examples/markdown/force-app/objects/Account/Account.object-meta.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+    <actionOverrides>
+        <actionName>CallHighlightAction</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>CancelEdit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Delete</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Edit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>EmailHighlightAction</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>EnableCustomerPortalUser</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>List</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>ListClean</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>New</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>RequestUpdate</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>SaveEdit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>SmsHighlightAction</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Tab</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>View</actionName>
+        <content>Account_Record_Page</content>
+        <formFactor>Large</formFactor>
+        <skipRecordTypeSelect>false</skipRecordTypeSelect>
+        <type>Flexipage</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>ViewCustomerPortalUser</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>WebsiteHighlightAction</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <compactLayoutAssignment>Account_Compact_Layout</compactLayoutAssignment>
+    <enableEnhancedLookup>true</enableEnhancedLookup>
+    <enableFeeds>true</enableFeeds>
+    <enableHistory>false</enableHistory>
+    <searchLayouts>
+        <customTabListAdditionalFields>ACCOUNT.NAME</customTabListAdditionalFields>
+        <customTabListAdditionalFields>ACCOUNT.ADDRESS1_CITY</customTabListAdditionalFields>
+        <customTabListAdditionalFields>ACCOUNT.PHONE1</customTabListAdditionalFields>
+        <lookupDialogsAdditionalFields>ACCOUNT.NAME</lookupDialogsAdditionalFields>
+        <lookupDialogsAdditionalFields>CORE.USERS.ALIAS</lookupDialogsAdditionalFields>
+        <lookupDialogsAdditionalFields>ACCOUNT.TYPE</lookupDialogsAdditionalFields>
+        <lookupPhoneDialogsAdditionalFields>ACCOUNT.NAME</lookupPhoneDialogsAdditionalFields>
+        <lookupPhoneDialogsAdditionalFields>CORE.USERS.ALIAS</lookupPhoneDialogsAdditionalFields>
+        <lookupPhoneDialogsAdditionalFields>ACCOUNT.TYPE</lookupPhoneDialogsAdditionalFields>
+        <lookupPhoneDialogsAdditionalFields>ACCOUNT.PHONE1</lookupPhoneDialogsAdditionalFields>
+        <searchResultsAdditionalFields>ACCOUNT.NAME</searchResultsAdditionalFields>
+        <searchResultsAdditionalFields>ACCOUNT.PHONE1</searchResultsAdditionalFields>
+        <searchResultsAdditionalFields>CORE.USERS.ALIAS</searchResultsAdditionalFields>
+    </searchLayouts>
+    <sharingModel>ReadWrite</sharingModel>
+</CustomObject>

examples/markdown/force-app/objects/Contact/Contact.object-meta.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+</CustomObject>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",

src/application/source-code-file-reader.ts

@@ -155,7 +155,16 @@ export function processFiles(fileSystem: FileSystem) {
     return (rootPath: string, exclude: string[]) => {
       return pipe(
         fileSystem.getComponents(rootPath),
-        (components) => components.filter((component) => !isExcluded(component.content!, exclude)),
+        (components) => {
+          return components.map((component) => {
+            const pathLocation = component.type.name === 'ApexClass' ? component.content : component.xml;
+            return {
+              ...component,
+              filePath: pathLocation!,
+            };
+          });
+        },
+        (components) => components.filter((component) => !isExcluded(component.filePath, exclude)),
         (components) => convertersToUse.map((converter) => converter(components)),
         (bundles) => bundles.flat(),
       );

src/core/markdown/adapters/type-to-renderable.ts

@@ -254,7 +254,7 @@ function objectMetadataToRenderable(
     type: 'customobject',
     headingLevel: 1,
     apiName: getApiName(objectMetadata.name, config),
-    heading: objectMetadata.label,
+    heading: objectMetadata.label ?? objectMetadata.name,
     name: objectMetadata.name,
     doc: {
       description: objectMetadata.description ? [objectMetadata.description] : [],
@@ -277,7 +277,7 @@ function fieldMetadataToRenderable(
   return {
     type: 'field',
     headingLevel: headingLevel,
-    heading: field.label,
+    heading: field.label ?? field.name,
     description: field.description ? [field.description] : [],
     apiName: getApiName(field.name, config),
     fieldType: field.type,

src/core/markdown/templates/custom-object-template.ts

@@ -19,9 +19,11 @@ export const customObjectTemplate = `
 
 \`{{{apiName}}}\`
 
+{{#if fieldType}}
 **Type**
 
 *{{fieldType}}*
+{{/if}}
 
 {{#unless @last}}---{{/unless}}
 {{/each}}

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

@@ -137,66 +137,4 @@ describe('when parsing custom field metadata', () => {
 
     expect(E.isLeft(result)).toBe(true);
   });
-
-  test('An error is returned when the CustomField key is not an object', async () => {
-    const unparsed: UnparsedCustomFieldBundle = {
-      type: 'customfield',
-      name: 'PhotoUrl__c',
-      parentName: 'MyFirstObject__c',
-      filePath: 'src/field/PhotoUrl__c.field-meta.xml',
-      content: `
-      <?xml version="1.0" encoding="UTF-8"?>
-      <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">invalid</CustomField>`,
-    };
-
-    const result = await reflectCustomFieldSources([unparsed])();
-
-    expect(E.isLeft(result)).toBe(true);
-  });
-
-  test('An error is returned when the CustomKey object does not contain the label key', async () => {
-    const unparsed: UnparsedCustomFieldBundle = {
-      type: 'customfield',
-      name: 'PhotoUrl__c',
-      parentName: 'MyFirstObject__c',
-      filePath: 'src/field/PhotoUrl__c.field-meta.xml',
-      content: `
-      <?xml version="1.0" encoding="UTF-8"?>
-      <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
-          <fullName>PhotoUrl__c</fullName>
-          <externalId>false</externalId>
-          <required>false</required>
-          <trackFeedHistory>false</trackFeedHistory>
-          <type>Url</type>
-          <description>A Photo URL field</description>
-      </CustomField>`,
-    };
-
-    const result = await reflectCustomFieldSources([unparsed])();
-
-    expect(E.isLeft(result)).toBe(true);
-  });
-
-  test('An error is returned when the CustomKey object does not contain the type key', async () => {
-    const unparsed: UnparsedCustomFieldBundle = {
-      type: 'customfield',
-      name: 'PhotoUrl__c',
-      parentName: 'MyFirstObject__c',
-      filePath: 'src/field/PhotoUrl__c.field-meta.xml',
-      content: `
-      <?xml version="1.0" encoding="UTF-8"?>
-      <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
-          <fullName>PhotoUrl__c</fullName>
-          <externalId>false</externalId>
-          <label>PhotoUrl</label>
-          <required>false</required>
-          <trackFeedHistory>false</trackFeedHistory>
-          <description>A Photo URL field</description>
-      </CustomField>`,
-    };
-
-    const result = await reflectCustomFieldSources([unparsed])();
-
-    expect(E.isLeft(result)).toBe(true);
-  });
 });

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

@@ -156,26 +156,4 @@ describe('when parsing SObject metadata', () => {
 
     expect(E.isLeft(result)).toBe(true);
   });
-
-  test('an error is thrown when the label is missing', async () => {
-    const sObjectContent = `
-    <?xml version="1.0" encoding="UTF-8"?>
-    <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
-        <deploymentStatus>Deployed</deploymentStatus>
-        <description>test object for testing</description>
-        <pluralLabel>MyFirstObjects</pluralLabel>
-        <visibility>Public</visibility>
-    </CustomObject>`;
-
-    const unparsed: UnparsedCustomObjectBundle = {
-      type: 'customobject',
-      name: 'MyFirstObject__c',
-      filePath: 'src/object/MyFirstObject__c.object-meta.xml',
-      content: sObjectContent,
-    };
-
-    const result = await reflectCustomObjectSources([unparsed])();
-
-    expect(E.isLeft(result)).toBe(true);
-  });
 });

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

@@ -12,8 +12,8 @@ export type CustomFieldMetadata = {
   type_name: 'customfield';
   description: string | null;
   name: string;
-  label: string;
-  type: string;
+  label?: string | null;
+  type?: string | null;
   parentName: string;
 };
 
@@ -43,7 +43,7 @@ function reflectCustomFieldSource(
   );
 }
 
-function validate(parsedResult: unknown): E.Either<Error, { CustomField: object }> {
+function validate(parsedResult: unknown): E.Either<Error, { CustomField: unknown }> {
   const err = E.left(new Error('Invalid custom field metadata'));
 
   function isObject(value: unknown) {
@@ -54,34 +54,16 @@ function validate(parsedResult: unknown): E.Either<Error, { CustomField: object
     return 'CustomField' in value ? E.right(value) : err;
   }
 
-  function theCustomFieldKeyIsAnObject(value: Record<'CustomField', unknown>) {
-    return typeof value.CustomField === 'object' ? E.right(value as Record<'CustomField', object>) : err;
-  }
-
-  function theCustomFieldObjectContainsTheLabelKey(value: Record<'CustomField', object>) {
-    return 'label' in value.CustomField ? E.right(value) : err;
-  }
-
-  function theCustomFieldObjectContainsTheTypeKey(value: Record<'CustomField', object>) {
-    return 'type' in value.CustomField ? E.right(value) : err;
-  }
-
-  return pipe(
-    parsedResult,
-    isObject,
-    E.chain(hasTheCustomFieldKey),
-    E.chain(theCustomFieldKeyIsAnObject),
-    E.chain(theCustomFieldObjectContainsTheLabelKey),
-    E.chain(theCustomFieldObjectContainsTheTypeKey),
-  );
+  return pipe(parsedResult, isObject, E.chain(hasTheCustomFieldKey));
 }
 
-function toCustomFieldMetadata(parserResult: { CustomField: object }): CustomFieldMetadata {
+function toCustomFieldMetadata(parserResult: { CustomField: unknown }): CustomFieldMetadata {
+  const customField = typeof parserResult.CustomField === 'object' ? parserResult.CustomField : {};
   const defaultValues = {
     description: null,
   };
 
-  return { ...defaultValues, ...parserResult.CustomField, type_name: 'customfield' } as CustomFieldMetadata;
+  return { ...defaultValues, ...customField, type_name: 'customfield' } as CustomFieldMetadata;
 }
 
 function addName(metadata: CustomFieldMetadata, name: string): CustomFieldMetadata {

src/core/reflection/sobject/reflect-custom-object-sources.ts

@@ -13,7 +13,7 @@ export type ObjectMetadata = {
   type_name: 'customobject';
   deploymentStatus: string;
   visibility: string;
-  label: string;
+  label?: string | null;
   name: string;
   description: string | null;
   fields: ParsedFile<CustomFieldMetadata>[];
@@ -45,7 +45,7 @@ function reflectCustomObjectSource(
   );
 }
 
-function validate(parseResult: unknown): E.Either<Error, { CustomObject: object }> {
+function validate(parseResult: unknown): E.Either<Error, { CustomObject: unknown }> {
   const err = E.left(new Error('Invalid SObject metadata'));
 
   function isObject(value: unknown) {
@@ -56,31 +56,19 @@ function validate(parseResult: unknown): E.Either<Error, { CustomObject: object
     return 'CustomObject' in value ? E.right(value) : err;
   }
 
-  function theCustomObjectKeyIsAnObject(value: Record<'CustomObject', unknown>) {
-    return typeof value.CustomObject === 'object' ? E.right(value as Record<'CustomObject', object>) : err;
-  }
-
-  function theCustomObjectContainsTheLabelKey(value: Record<'CustomObject', object>) {
-    return 'label' in value.CustomObject ? E.right(value) : err;
-  }
-
-  return pipe(
-    parseResult,
-    isObject,
-    E.chain(hasTheCustomObjectKey),
-    E.chain(theCustomObjectKeyIsAnObject),
-    E.chain(theCustomObjectContainsTheLabelKey),
-  );
+  return pipe(parseResult, isObject, E.chain(hasTheCustomObjectKey));
 }
 
-function toObjectMetadata(parserResult: { CustomObject: object }): ObjectMetadata {
+function toObjectMetadata(parserResult: { CustomObject: unknown }): ObjectMetadata {
+  const customObject = typeof parserResult.CustomObject === 'object' ? parserResult.CustomObject : {};
+
   const defaultValues = {
     deploymentStatus: 'Deployed',
     visibility: 'Public',
     description: null,
     fields: [] as ParsedFile<CustomFieldMetadata>[],
   };
-  return { ...defaultValues, ...parserResult.CustomObject } as ObjectMetadata;
+  return { ...defaultValues, ...customObject } as ObjectMetadata;
 }
 
 function addName(objectMetadata: ObjectMetadata, name: string): ObjectMetadata {