@cparra/apexdocs 3.4.2 → 3.6.0

package/README.md

@@ -17,7 +17,7 @@ create a documentation site that fits your needs, hosted in any static web hosti
 ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine,
 (e.g. Jekyll, Vitepress, Hugo, Docosaurus, etc.) to create a documentation site that fits your needs.
 
-This gives you the flexibility to create beautiful leveraging your preferred SSG engine, which
+This gives you the flexibility to create beautiful sites by leveraging your preferred SSG engine, which
 usually provides a wide range of themes, dark mode support, and other features out of the box.
 
 <div align="center">
@@ -335,9 +335,11 @@ of different hooks that will be called at different stages of the documentation
 
 All hooks can be async functions, allowing you to make asynchronous operations, like calling an external API.
 
-📒 Note: The extension hook functions are only available when generating Markdown files (not OpenApi).
+There are hooks for both Markdown and Changelog operations (but not for OpenApi).
 
-#### **transformReferenceGuide**
+#### Markdown Hooks
+
+##### **transformReferenceGuide**
 
 Allows changing the Allows changing the frontmatter and content of the reference guide, or even if creating a reference
 guide page should be skipped.
@@ -374,7 +376,7 @@ export default defineMarkdownConfig({
 });
 ```
 
-#### **transformDocs**
+##### **transformDocs**
 
 The main purpose of this hook is to allow you to skip the generation of specific pages,
 by returning a filtered array of `DocPageData` objects.
@@ -397,7 +399,7 @@ export default {
 };
 ```
 
-#### **transformDocPage**
+##### **transformDocPage**
 
 Allows changing the frontmatter and content of the doc page.
 
@@ -421,7 +423,7 @@ export default {
 };
 ```
 
-#### **transformReference**
+##### **transformReference**
 
 Allows changing where the files are written to and how files are linked to each other.
 
@@ -449,6 +451,32 @@ export default {
 };
 ```
 
+#### Changelog Hooks
+
+##### **transformChangeLogPage**
+
+Allows changing the frontmatter and content of the changelog page.
+
+**Type**
+
+```typescript
+type TransformChangeLogPage = (
+  changelog: ChangeLogPageData,
+) => Partial<ChangeLogPageData> | Promise<Partial<ChangeLogPageData>>
+```
+
+Example
+
+```typescript
+export default {
+  transformChangeLogPage: (changelog) => {
+    return {
+      frontmatter: { example: 'example' }
+    };
+  }
+};
+```
+
 ## ⤵︎ Importing to your project
 
 ### Reflection

package/dist/cli/generate.js

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

package/dist/index.d.ts

@@ -29,7 +29,7 @@ type UserDefinedMarkdownConfig = {
   excludeTags: string[];
   exclude: string[];
 } & CliConfigurableMarkdownConfig &
-  Partial<ConfigurableHooks>;
+  Partial<MarkdownConfigurableHooks>;
 
 type UserDefinedOpenApiConfig = {
   targetGenerator: 'openapi';
@@ -51,18 +51,31 @@ type UserDefinedChangelogConfig = {
   scope: string[];
   exclude: string[];
   skipIfNoChanges: boolean;
-};
+} & Partial<ChangelogConfigurableHooks>;
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
 
+type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield';
+
 type SourceFileMetadata = {
   filePath: string;
   name: string;
-  type: 'interface' | 'class' | 'enum' | 'customobject' | 'customfield';
+  type: MetadataTypes;
+};
+
+// External metadata is metadata that does not live directly in the source code, and thus we don't
+// have a file path for it.
+// This is metadata derived from other information.
+// For example, for an "extension"
+// field that extends a Salesforce object or object in a different package, we want to capture the parent
+// object, even if the file for that object was not parsed.
+type ExternalMetadata = {
+  name: string;
+  type: MetadataTypes;
 };
 
 type DocPageReference = {
-  source: SourceFileMetadata;
+  source: SourceFileMetadata | ExternalMetadata;
   // The name under which the type should be displayed in the documentation.
   // By default, this will match the source.name, but it can be configured by the user.
   displayName: string;
@@ -84,7 +97,7 @@ type ReferenceGuidePageData = {
 };
 
 type DocPageData = {
-  source: SourceFileMetadata;
+  source: SourceFileMetadata | ExternalMetadata;
   group: string | null;
   outputDocPath: string;
   frontmatter: Frontmatter;
@@ -92,6 +105,12 @@ type DocPageData = {
   type: 'class' | 'interface' | 'enum' | 'customobject';
 };
 
+type ChangeLogPageData = {
+  frontmatter: Frontmatter;
+  content: string;
+  outputDocPath: string;
+};
+
 /**
  * Represents a file to be skipped.
  */
@@ -102,9 +121,9 @@ type Skip = {
 // CONFIGURABLE HOOKS
 
 /**
- * The configurable hooks that can be used to modify the output of the generator.
+ * The configurable hooks that can be used to modify the output of the Markdown generator.
  */
-type ConfigurableHooks = {
+type MarkdownConfigurableHooks = {
   transformReferenceGuide: TransformReferenceGuide;
   transformDocs: TransformDocs;
   transformDocPage: TransformDocPage;
@@ -143,6 +162,14 @@ type TransformDocPage = (
   doc: DocPageData,
 ) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
+type ChangelogConfigurableHooks = {
+  transformChangeLogPage: TransformChangelogPage;
+};
+
+type TransformChangelogPage = (
+  page: ChangeLogPageData,
+) => Partial<ChangeLogPageData> | Promise<Partial<ChangeLogPageData>>;
+
 /**
  * Represents a file to be skipped.
  */
@@ -177,4 +204,4 @@ type ConfigurableChangelogConfig = Omit<Partial<UserDefinedChangelogConfig>, 'ta
  */
 declare function defineChangelogConfig(config: ConfigurableChangelogConfig): Partial<UserDefinedChangelogConfig>;
 
-export { type ConfigurableChangelogConfig, type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableHooks, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type ReferenceGuidePageData, type Skip, 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 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-D84qiac7.js');
+var logger = require('./logger-0jxxZOAh.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');