Merge pull request #247 from williamsalexisSFDC/master

Add compliance category and security classification to Custom Field

Author: cesarParra

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

@@ -40,6 +40,25 @@ Represents an event that people can register for.
 
 *Location*
 
+---
+### Social Security Number
+
+Used to store the U.S. social security number in 9 digit format.
+
+**Compliance Category**
+PII
+
+**Security Classification**
+Internal
+
+**API Name**
+
+`ns__Social_Security_Number__c`
+
+**Type**
+
+*Text*
+
 ---
 ### Start Date
 **Required**

examples/markdown/force-app/objects/Event__c/fields/Social_Security_Number__c.field-meta.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fullName>Social_Security_Number__c</fullName>
+    <externalId>false</externalId>
+    <label>Social Security Number</label>
+    <description>Used to store the U.S. social security number in 9 digit format.</description>
+    <length>9</length>
+    <trackTrending>false</trackTrending>
+    <type>Text</type>
+    <complianceCategory>PII</complianceCategory>
+    <securityClassification>Internal</securityClassification>
+</CustomField>

src/cli/commands/markdown.ts

@@ -72,4 +72,9 @@ export const markdownOptions: Record<keyof CliConfigurableMarkdownConfig, Option
     describe: 'The title of the reference guide.',
     default: markdownDefaults.referenceGuideTitle,
   },
+  includeFieldSecurityMetadata: {
+    type: 'boolean',
+    describe: 'Whether to include the compliance category and security classification for fields in the generated files.',
+    default: markdownDefaults.includeFieldSecurityMetadata,
+  }
 };

src/core/changelog/__test__/helpers/custom-field-metadata-builder.ts

@@ -23,6 +23,8 @@ export default class CustomFieldMetadataBuilder {
       description: this.description,
       parentName: 'MyObject',
       required: false,
+      securityClassification: 'Internal',
+      complianceCategory: 'PII',
     };
   }
 }

src/core/markdown/__test__/test-helpers.ts

@@ -56,6 +56,7 @@ export function generateDocs(bundles: UnparsedSourceBundle[], config?: Partial<M
     linkingStrategy: 'relative',
     excludeTags: [],
     referenceGuideTitle: 'Apex Reference Guide',
+    includeFieldSecurityMetadata: true,
     exclude: [],
     ...config,
   });

src/core/markdown/adapters/__tests__/interface-adapter.spec.ts

@@ -20,6 +20,7 @@ const defaultMarkdownGeneratorConfig: MarkdownGeneratorConfig = {
   sortAlphabetically: false,
   linkingStrategy: 'relative',
   referenceGuideTitle: 'Apex Reference Guide',
+  includeFieldSecurityMetadata: true,
   exclude: [],
   excludeTags: [],
 };

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

@@ -357,6 +357,8 @@ function fieldMetadataToRenderable(
     apiName: getApiName(field.name, config),
     fieldType: field.type,
     required: field.required,
+    complianceCategory: renderComplianceCategory(field.complianceCategory, config),
+    securityClassification: renderComplianceCategory(field.securityClassification, config),
     pickListValues: field.pickListValues
       ? {
           headingLevel: headingLevel + 1,
@@ -391,3 +393,11 @@ function getApiName(currentName: string, config: MarkdownGeneratorConfig) {
   }
   return currentName;
 }
+
+function renderComplianceCategory(complianceCategory: string | null, config: MarkdownGeneratorConfig) {
+  if(config.includeFieldSecurityMetadata) {
+    return complianceCategory;
+  } else {
+    return null;
+  }
+}

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

@@ -24,6 +24,16 @@ export const customObjectTemplate = `
 {{{renderContent description}}}
 {{/if}}
 
+{{#if complianceCategory}}
+**Compliance Category**
+{{complianceCategory}}
+{{/if}}
+
+{{#if securityClassification}}
+**Security Classification**
+{{securityClassification}}
+{{/if}}
+
 **API Name**
 
 \`{{{apiName}}}\`

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

@@ -14,6 +14,8 @@ const customFieldContent = `
     <trackFeedHistory>false</trackFeedHistory>
     <type>Url</type>
     <description>A Photo URL field</description>
+    <securityClassification>Internal</securityClassification>
+    <complianceCategory>PII</complianceCategory>
 </CustomField>`;
 
 describe('when parsing custom field metadata', () => {
@@ -107,6 +109,34 @@ describe('when parsing custom field metadata', () => {
     assertEither(result, (data) => expect(data[0].type.description).toBe('A Photo URL field'));
   });
 
+  test('the resulting type contains the correct security classification', async () => {
+    const unparsed: UnparsedCustomFieldBundle = {
+      type: 'customfield',
+      name: 'PhotoUrl__c',
+      parentName: 'MyFirstObject__c',
+      filePath: 'src/field/PhotoUrl__c.field-meta.xml',
+      content: customFieldContent,
+    };
+
+    const result = await reflectCustomFieldSources([unparsed])();
+
+    assertEither(result, (data) => expect(data[0].type.securityClassification).toBe('Internal'));
+  });
+
+  test('the resulting type contains the correct compliance category', async () => {
+    const unparsed: UnparsedCustomFieldBundle = {
+      type: 'customfield',
+      name: 'PhotoUrl__c',
+      parentName: 'MyFirstObject__c',
+      filePath: 'src/field/PhotoUrl__c.field-meta.xml',
+      content: customFieldContent,
+    };
+
+    const result = await reflectCustomFieldSources([unparsed])();
+
+    assertEither(result, (data) => expect(data[0].type.complianceCategory).toBe('PII'));
+  });
+
   test('can parse picklist values when there are multiple picklist values available', async () => {
     const unparsed: UnparsedCustomFieldBundle = {
       type: 'customfield',

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

@@ -18,6 +18,8 @@ export type CustomFieldMetadata = {
   parentName: string;
   pickListValues?: string[];
   required: boolean;
+  securityClassification: string | null;
+  complianceCategory: string | null;
 };
 
 export function reflectCustomFieldSources(
@@ -66,6 +68,8 @@ function toCustomFieldMetadata(parserResult: { CustomField: unknown }): CustomFi
   const defaultValues = {
     description: null,
     required: false,
+    securityClassification: null,
+    complianceCategory: null,
   };
 
   return {