@cparra/apexdocs 3.6.0 → 3.7.1

package/README.md

@@ -463,6 +463,39 @@ Allows changing the frontmatter and content of the changelog page.
 type TransformChangeLogPage = (
   changelog: ChangeLogPageData,
 ) => Partial<ChangeLogPageData> | Promise<Partial<ChangeLogPageData>>
+
+// Supporting types
+
+type ChangeLogPageData = {
+  source: SourceChangelog;
+  frontmatter: string | Record<string, any>;
+  content: string;
+  outputDocPath: string;
+};
+
+type SourceChangelog = {
+  fileChanges: FileChange[];
+};
+
+type FileChange = {
+  name: string;
+  fileType: 'apex' | 'customobject';
+  changeType: 'added' | 'removed' | 'changed';
+  changes?: {
+    addedMethods?: string[];
+    removedMethods?: string[];
+    addedFields?: string[];
+    removedFields?: string[];
+    addedProperties?: string[];
+    removedProperties?: string[];
+    addedCustomFields?: string[];
+    removedCustomFields?: string[];
+    addedSubtypes?: string[];
+    removedSubtypes?: string[];
+    addedEnumValues?: string[];
+    removedEnumValues?: string[];
+  };
+};
 ```
 
 Example

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-0jxxZOAh.js');
+var logger$1 = require('../logger-Y4IyA77j.js');
 var module$1 = require('module');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');

package/dist/index.d.ts

@@ -105,7 +105,32 @@ type DocPageData = {
   type: 'class' | 'interface' | 'enum' | 'customobject';
 };
 
+type FileChange = {
+  name: string;
+  fileType: 'apex' | 'customobject';
+  changeType: 'added' | 'removed' | 'changed';
+  changes?: {
+    addedMethods?: string[];
+    removedMethods?: string[];
+    addedFields?: string[];
+    removedFields?: string[];
+    addedProperties?: string[];
+    removedProperties?: string[];
+    addedCustomFields?: string[];
+    removedCustomFields?: string[];
+    addedSubtypes?: string[];
+    removedSubtypes?: string[];
+    addedEnumValues?: string[];
+    removedEnumValues?: string[];
+  };
+};
+
+type SourceChangelog = {
+  fileChanges: FileChange[];
+};
+
 type ChangeLogPageData = {
+  source: SourceChangelog;
   frontmatter: Frontmatter;
   content: string;
   outputDocPath: string;
@@ -204,4 +229,4 @@ type ConfigurableChangelogConfig = Omit<Partial<UserDefinedChangelogConfig>, 'ta
  */
 declare function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<UserDefinedChangelogConfig>;
 
-export { type ChangeLogPageData, type ChangelogConfigurableHooks, type ConfigurableChangelogConfig, type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type MarkdownConfigurableHooks, type ReferenceGuidePageData, type Skip, type TransformChangelogPage, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };
+export { type ChangeLogPageData, type ChangelogConfigurableHooks, type ConfigurableChangelogConfig, type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type MarkdownConfigurableHooks, type ReferenceGuidePageData, type Skip, type SourceChangelog, type TransformChangelogPage, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };

package/dist/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var logger = require('./logger-0jxxZOAh.js');
+var logger = require('./logger-Y4IyA77j.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');

package/dist/{logger-0jxxZOAh.js → logger-Y4IyA77j.js}

@@ -1942,12 +1942,19 @@ function toPickListValues(customField) {
       const valueSetDefinition = valueSet.valueSetDefinition;
       if ("value" in valueSetDefinition) {
         const pickListValues = valueSetDefinition.value;
-        return pickListValues.filter((each) => "fullName" in each).map((each) => each.fullName);
+        if (isArrayOfValues(pickListValues)) {
+          return pickListValues.filter((each) => "fullName" in each).map((current) => current.fullName);
+        } else {
+          return [pickListValues.fullName];
+        }
       }
     }
   }
   return void 0;
 }
+function isArrayOfValues(value) {
+  return Array.isArray(value);
+}
 
 var __defProp$b = Object.defineProperty;
 var __defProps$b = Object.defineProperties;
@@ -3913,6 +3920,77 @@ const changelogTemplate = `
 {{/if}}
 `.trim();
 
+function changelogToSourceChangelog(changelog) {
+  const newApexTypes = changelog.newApexTypes.map((newType) => {
+    return {
+      name: newType,
+      fileType: "apex",
+      changeType: "added"
+    };
+  });
+  const removedApexTypes = changelog.removedApexTypes.map((removedType) => {
+    return {
+      name: removedType,
+      fileType: "apex",
+      changeType: "removed"
+    };
+  });
+  const newCustomObjects = changelog.newCustomObjects.map((newType) => {
+    return {
+      name: newType,
+      fileType: "customobject",
+      changeType: "added"
+    };
+  });
+  const removedCustomObjects = changelog.removedCustomObjects.map((removedType) => {
+    return {
+      name: removedType,
+      fileType: "customobject",
+      changeType: "removed"
+    };
+  });
+  const modifiedApexTypes = changelog.newOrModifiedApexMembers.map((modifiedType) => {
+    return {
+      name: modifiedType.typeName,
+      fileType: "apex",
+      changeType: "changed",
+      changes: {
+        addedMethods: modifiedType.modifications.filter((mod) => mod.__typename === "NewMethod").map((mod) => mod.name),
+        removedMethods: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedMethod").map((mod) => mod.name),
+        addedFields: modifiedType.modifications.filter((mod) => mod.__typename === "NewField").map((mod) => mod.name),
+        removedFields: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedField").map((mod) => mod.name),
+        addedProperties: modifiedType.modifications.filter((mod) => mod.__typename === "NewProperty").map((mod) => mod.name),
+        removedProperties: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedProperty").map((mod) => mod.name),
+        addedSubtypes: modifiedType.modifications.filter((mod) => mod.__typename === "NewType").map((mod) => mod.name),
+        removedSubtypes: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedType").map((mod) => mod.name),
+        addedEnumValues: modifiedType.modifications.filter((mod) => mod.__typename === "NewEnumValue").map((mod) => mod.name),
+        removedEnumValues: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedEnumValue").map((mod) => mod.name)
+      }
+    };
+  });
+  const modifiedCustomObjects = changelog.customObjectModifications.map((modifiedType) => {
+    return {
+      name: modifiedType.typeName,
+      fileType: "customobject",
+      changeType: "changed",
+      changes: {
+        addedCustomFields: modifiedType.modifications.filter((mod) => mod.__typename === "NewField").map((mod) => mod.name),
+        removedCustomFields: modifiedType.modifications.filter((mod) => mod.__typename === "RemovedField").map((mod) => mod.name)
+      }
+    };
+  });
+  return {
+    fileChanges: [
+      ...newApexTypes,
+      ...removedApexTypes,
+      ...newCustomObjects,
+      ...removedCustomObjects,
+      ...modifiedApexTypes,
+      ...modifiedCustomObjects
+    ]
+  };
+}
+
 var __defProp$1 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
@@ -3958,7 +4036,11 @@ function generateChangeLog(oldBundles, newBundles, config) {
     if (config.skipIfNoChanges && !hasChanges(changelog)) {
       return skip();
     }
-    return _function.pipe(convertToRenderableChangelog(changelog, newManifest.types), compile, convertToPageData);
+    return _function.pipe(
+      convertToRenderableChangelog(changelog, newManifest.types),
+      compile,
+      (content) => convertToPageData(content, changelog)
+    );
   }
   return _function.pipe(
     reflect(oldBundles, config),
@@ -4015,8 +4097,9 @@ function compile(renderable) {
   };
   return Template.getInstance().compile(compilationRequest);
 }
-function toPageData(fileName, content) {
+function toPageData(fileName, content, changelog) {
   return {
+    source: changelogToSourceChangelog(changelog),
     frontmatter: null,
     content,
     outputDocPath: `${fileName}.md`

package/package.json

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