@cparra/apexdocs 3.12.2 → 3.14.0

package/README.md

@@ -12,6 +12,26 @@ ApexDocs is a non-opinionated documentation generator for Salesforce Apex classe
 It can output documentation in Markdown format, which allows you to use the Static Site Generator of your choice to
 create a documentation site that fits your needs, hosted in any static web hosting service.
 
+## Table of Contents
+
+- [👀 Examples](#-examples)
+- [🚀 Features](#-features)
+- [💿 Installation](#-installation)
+- [⚡ Quick Start](#-quick-start)
+  - [CLI](#cli)
+    - [Markdown](#markdown)
+    - [OpenApi](#openapi)
+    - [Changelog](#changelog)
+- [▶️ Available Commands](#️-available-commands)
+  - [Markdown](#markdown-1)
+  - [OpenApi](#openapi-1)
+  - [Changelog](#changelog-1)
+- [🔬 Defining a configuration file](#-defining-a-configuration-file)
+- [🌐 Translation](#-translation)
+- [⤵︎ Importing to your project](#︎-importing-to-your-project)
+- [📖 Documentation Guide](#-documentation-guide)
+- [📄 Generating OpenApi REST Definitions](#-generating-openapi-rest-definitions)
+
 ## 👀 Examples
 
 ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine,
@@ -64,6 +84,7 @@ Here are some live projects using ApexDocs:
 * Support for ignoring files and members from being documented
 * Namespace support
 * Configuration file support
+* Translation support for different languages and custom terminology
 * Single line ApexDoc Blocks
 * Custom tag support
 * And much, much more!
@@ -84,6 +105,12 @@ Run the following command to generate markdown files for your global Salesforce
 
 ```bash
 apexdocs markdown -s force-app
+
+# Use sfdx-project.json as the source of directories
+apexdocs markdown --useSfdxProjectJson
+
+# Specify multiple source directories
+apexdocs markdown --sourceDirs force-app force-lwc force-utils
 ```
 
 #### OpenApi
@@ -111,21 +138,31 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 
 #### Flags
 
-| Flag                       | Alias | Description                                                                                                                                                                                              | Default          | Required |
-|----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
-| `--sourceDir`              | `-s`  | The directory where the source files are located.                                                                                                                                                        | N/A              | Yes      |
-| `--targetDir`              | `-t`  | The directory where the generated files will be placed.                                                                                                                                                  | `docs`           | No       |
-| `--scope`                  | `-p`  | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible.                                                                                      | `[global]`       | No       |
-| `--customObjectVisibility` | `-v`  | Controls which custom objects are documented. Values should be separated by a space.                                                                                                                     | `[public]`       | No       |
-| `--defaultGroupName`       | N/A   | The default group name to use when a group is not specified.                                                                                                                                             | `Miscellaneous`  | No       |
-| `--namespace`              | N/A   | The package namespace, if any. If provided, it will be added to the generated files.                                                                                                                     | N/A              | No       |
-| `--sortAlphabetically`     | N/A   | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false`          | No       |
-| `--includeMetadata `       | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                         | `false`          | No       |
-| `--linkingStrategy`        | N/A   | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none`                                                                                                 | `relative`       | No       |
-| `--customObjectsGroupName` | N/A   | The name under which custom objects will be grouped in the Reference Guide                                                                                                                               | `Custom Objects` | No       |
-| `--triggersGroupName`      | N/A   | The name under which triggers will be grouped in the Reference Guide                                                                                                                                     | `Triggers`       | No       |
-| `--includeFieldSecurityMetadata`      | N/A   | Whether to include the compliance category and security classification for fields in the generated files.                                                                                                                                     | `false`       | No       |
-| `--includeInlineHelpTextMetadata`      | N/A   | Whether to include the inline help text for fields in the generated files.                                                                                                                                     | `false`       | No       |
+| Flag                              | Alias | Description                                                                                                                                                                                              | Default          | Required |
+|-----------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
+| `--sourceDir`                     | `-s`  | The directory where the source files are located.                                                                                                                                                        | N/A              | *        |
+| `--sourceDirs`                    | N/A   | Multiple source directories (space-separated). Cannot be used with `--sourceDir` or `--useSfdxProjectJson`.                                                                                              | N/A              | *        |
+| `--useSfdxProjectJson`            | N/A   | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir` or `--sourceDirs`.                                                                                | `false`          | *        |
+| `--sfdxProjectPath`               | N/A   | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`.                                                                                 | `process.cwd()`  | No       |
+| `--targetDir`                     | `-t`  | The directory where the generated files will be placed.                                                                                                                                                  | `docs`           | No       |
+| `--scope`                         | `-p`  | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible.                                                                                      | `[global]`       | No       |
+| `--customObjectVisibility`        | `-v`  | Controls which custom objects are documented. Values should be separated by a space.                                                                                                                     | `[public]`       | No       |
+| `--defaultGroupName`              | N/A   | The default group name to use when a group is not specified.                                                                                                                                             | `Miscellaneous`  | No       |
+| `--namespace`                     | N/A   | The package namespace, if any. If provided, it will be added to the generated files.                                                                                                                     | N/A              | No       |
+| `--sortAlphabetically`            | N/A   | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false`          | No       |
+| `--includeMetadata `              | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                         | `false`          | No       |
+| `--linkingStrategy`               | N/A   | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none`                                                                                                 | `relative`       | No       |
+| `--customObjectsGroupName`        | N/A   | The name under which custom objects will be grouped in the Reference Guide                                                                                                                               | `Custom Objects` | No       |
+| `--triggersGroupName`             | N/A   | The name under which triggers will be grouped in the Reference Guide                                                                                                                                     | `Triggers`       | No       |
+| `--includeFieldSecurityMetadata`  | N/A   | Whether to include the compliance category and security classification for fields in the generated files.                                                                                                | `false`          | No       |
+| `--includeInlineHelpTextMetadata` | N/A   | Whether to include the inline help text for fields in the generated files.                                                                                                                               | `false`          | No       |
+
+> **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
+> - `--sourceDir` (single directory)
+> - `--sourceDirs` (multiple directories)
+> - `--useSfdxProjectJson` (read from sfdx-project.json)
+>
+> These options are mutually exclusive - you cannot use more than one at the same time.
 
 ##### Linking Strategy
 
@@ -258,6 +295,12 @@ export default defineMarkdownConfig({
   sourceDir: 'force-app',
   targetDir: 'docs',
   scope: ['global', 'public'],
+  translations: {
+    sections: {
+      methods: 'Methods',
+      properties: 'Properties',
+    },
+  },
   ...
 });
 ```
@@ -365,7 +408,8 @@ having to copy-paste the same text across multiple classes, polluting your
 source code.
 
 A macro can be defined in your documentation using the `{{macro_name}}` syntax.
-In the configuration file, you can then define the macro behavior as a key-value pair, where the key is the name of the macro, and the value is a function that returns the text to inject in place of the macro.
+In the configuration file, you can then define the macro behavior as a key-value pair, where the key is the name of the
+macro, and the value is a function that returns the text to inject in place of the macro.
 
 **Type**
 
@@ -379,7 +423,8 @@ type MacroSourceMetadata = {
 type MacroFunction = (metadata: MacroSourceMetadata) => string;
 ```
 
-Notice that the `metadata` object contains information about the source of the file for which the macro is being injected. This allows you to optionally
+Notice that the `metadata` object contains information about the source of the file for which the macro is being
+injected. This allows you to optionally
 return different text based on the source of the file.
 
 Example: Injecting a copyright notice
@@ -402,13 +447,14 @@ And then in your source code, you can use the macro like this:
  * @description This is a class
  */
 public class MyClass {
-  //...
+    //...
 }
 ```
 
 ##### **transformReferenceGuide**
 
-Allows changing the frontmatter and content of the reference guide, or if creating a reference guide page altogether should be skipped.
+Allows changing the frontmatter and content of the reference guide, or if creating a reference guide page altogether
+should be skipped.
 
 **Type**
 
@@ -576,6 +622,74 @@ export default {
 };
 ```
 
+## 🌐 Translation
+
+ApexDocs supports translations to customize the language and terminology used in the generated documentation.
+This feature allows you to:
+
+- **Translate documentation to different languages** (Spanish, French, etc.)
+- **Use custom business terminology** (e.g., "Business Operations" instead of "Methods")
+- **Partially override specific terms** while keeping the rest in English
+
+### How It Works
+
+The translation system uses:
+
+- **Default English translations** built into the system
+- **User-provided overrides** that can be partial or complete
+
+### Configuration
+
+Add a `translations` property to your ApexDocs configuration (JS or TS file) and pass
+the appropriate translation object, depending on the generator you're using:
+
+```javascript
+import { defineMarkdownConfig } from '@cparra/apexdocs';
+
+export default defineMarkdownConfig({
+  sourceDir: 'src',
+  targetDir: 'docs',
+  scope: ['public', 'global'],
+  translations: {
+    sections: {
+      methods: 'Métodos',
+      properties: 'Propiedades',
+      fields: 'Campos',
+    },
+  },
+});
+```
+
+### TypeScript Support
+
+For TypeScript projects, import the translation types for better autocomplete and type safety:
+
+```typescript
+import { defineMarkdownConfig } from '@cparra/apexdocs';
+import type { UserTranslations } from '@cparra/apexdocs';
+
+const markdownTranslations: UserTranslations['markdown'] = {
+  sections: {
+    methods: 'Functions',
+  },
+  // ...other translation keys as needed
+};
+
+export default defineMarkdownConfig({
+  sourceDir: 'src',
+  targetDir: 'docs',
+  scope: ['public', 'global'],
+  translations: markdownTranslations,
+});
+```
+
+### Notes
+
+- Only the **markdown** and **changelog** generators support translations
+- All translations are optional - anything not specified uses the English default
+
+For a complete example, see the [translation example](examples/translation/) in this repository.
+
 ## ⤵︎ 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-B8yR_O0h.js');
+var logger$1 = require('../logger-D4Q3KA6D.js');
 var require$$0 = require('yargs');
 var cosmiconfig = require('cosmiconfig');
 var E = require('fp-ts/Either');
@@ -43,12 +43,34 @@ function _interopNamespaceDefault(e) {
 
 var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 
+function validateMarkdownArgs(argv) {
+  const hasSourceDir = argv.sourceDir && (typeof argv.sourceDir === "string" || Array.isArray(argv.sourceDir) && argv.sourceDir.length > 0);
+  const hasUseSfdxProjectJson = argv.useSfdxProjectJson;
+  if (!hasSourceDir && !hasUseSfdxProjectJson) {
+    throw new Error("Must specify one of: --sourceDir or --useSfdxProjectJson");
+  }
+  return true;
+}
 const markdownOptions = {
   sourceDir: {
     type: "string",
+    array: true,
     alias: "s",
-    demandOption: true,
-    describe: "The directory location which contains your apex .cls classes."
+    demandOption: false,
+    describe: "The directory location(s) which contain your apex .cls classes. Can specify a single directory or multiple directories. Cannot be used with useSfdxProjectJson.",
+    conflicts: ["useSfdxProjectJson"]
+  },
+  useSfdxProjectJson: {
+    type: "boolean",
+    demandOption: false,
+    describe: "Read source directories from sfdx-project.json packageDirectories. Cannot be used with sourceDir.",
+    conflicts: ["sourceDir"]
+  },
+  sfdxProjectPath: {
+    type: "string",
+    demandOption: false,
+    describe: "Path to the directory containing sfdx-project.json (defaults to current working directory). Only used with useSfdxProjectJson.",
+    implies: "useSfdxProjectJson"
   },
   targetDir: {
     type: "string",
@@ -122,12 +144,34 @@ const markdownOptions = {
   }
 };
 
+function validateOpenApiArgs(argv) {
+  const hasSourceDir = argv.sourceDir && (typeof argv.sourceDir === "string" || Array.isArray(argv.sourceDir) && argv.sourceDir.length > 0);
+  const hasUseSfdxProjectJson = argv.useSfdxProjectJson;
+  if (!hasSourceDir && !hasUseSfdxProjectJson) {
+    throw new Error("Must specify one of: --sourceDir or --useSfdxProjectJson");
+  }
+  return true;
+}
 const openApiOptions = {
   sourceDir: {
     type: "string",
+    array: true,
     alias: "s",
-    demandOption: true,
-    describe: "The directory location which contains your apex .cls classes."
+    demandOption: false,
+    describe: "The directory location(s) which contain your apex .cls classes. Can specify a single directory or multiple directories. Cannot be used with useSfdxProjectJson.",
+    conflicts: ["useSfdxProjectJson"]
+  },
+  useSfdxProjectJson: {
+    type: "boolean",
+    demandOption: false,
+    describe: "Read source directories from sfdx-project.json packageDirectories. Cannot be used with sourceDir.",
+    conflicts: ["sourceDir"]
+  },
+  sfdxProjectPath: {
+    type: "string",
+    demandOption: false,
+    describe: "Path to the directory containing sfdx-project.json (defaults to current working directory). Only used with useSfdxProjectJson.",
+    implies: "useSfdxProjectJson"
   },
   targetDir: {
     type: "string",
@@ -156,18 +200,31 @@ const openApiOptions = {
   }
 };
 
+function validateChangelogArgs(argv) {
+  const hasPreviousVersionDir = argv.previousVersionDir && (typeof argv.previousVersionDir === "string" || Array.isArray(argv.previousVersionDir) && argv.previousVersionDir.length > 0);
+  const hasCurrentVersionDir = argv.currentVersionDir && (typeof argv.currentVersionDir === "string" || Array.isArray(argv.currentVersionDir) && argv.currentVersionDir.length > 0);
+  if (!hasPreviousVersionDir) {
+    throw new Error("Must specify --previousVersionDir");
+  }
+  if (!hasCurrentVersionDir) {
+    throw new Error("Must specify --currentVersionDir");
+  }
+  return true;
+}
 const changeLogOptions = {
   previousVersionDir: {
     type: "string",
+    array: true,
     alias: "p",
-    demandOption: true,
-    describe: "The directory location of the previous version of the source code."
+    demandOption: false,
+    describe: "The directory location(s) of the previous version of the source code. Can specify a single directory or multiple directories."
   },
   currentVersionDir: {
     type: "string",
+    array: true,
     alias: "c",
-    demandOption: true,
-    describe: "The directory location of the current version of the source code."
+    demandOption: false,
+    describe: "The directory location(s) of the current version of the source code. Can specify a single directory or multiple directories."
   },
   targetDir: {
     type: "string",
@@ -297,11 +354,23 @@ function extractArgsForCommandProvidedThroughCli(extractFromProcessFn, config) {
   const mergedConfig = __spreadProps(__spreadValues(__spreadValues({}, config.config), cliArgs), { targetGenerator: commandName });
   switch (mergedConfig.targetGenerator) {
     case "markdown":
-      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), mergedConfig));
+      return _function.pipe(
+        logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+        E__namespace.mapLeft((error) => new Error(`Invalid markdown configuration: ${error.message}`)),
+        E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), mergedConfig))
+      );
     case "openapi":
-      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), mergedConfig));
+      return _function.pipe(
+        logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+        E__namespace.mapLeft((error) => new Error(`Invalid openapi configuration: ${error.message}`)),
+        E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), mergedConfig))
+      );
     case "changelog":
-      return E__namespace.right(__spreadValues(__spreadValues({}, configOnlyChangelogDefaults), mergedConfig));
+      return _function.pipe(
+        validateChangelogConfig(mergedConfig),
+        E__namespace.mapLeft((error) => new Error(`Invalid changelog configuration: ${error.message}`)),
+        E__namespace.map(() => __spreadValues(__spreadValues({}, configOnlyChangelogDefaults), mergedConfig))
+      );
     default:
       return E__namespace.left(new Error(`Invalid command provided: ${mergedConfig.targetGenerator}`));
   }
@@ -317,12 +386,26 @@ function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
           E__namespace.map((cliArgs) => {
             return cliArgs;
           }),
-          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig), cliArgs))
+          E__namespace.flatMap((cliArgs) => {
+            const mergedConfig = __spreadValues(__spreadValues(__spreadValues({}, configOnlyMarkdownDefaults), generatorConfig), cliArgs);
+            return _function.pipe(
+              logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+              E__namespace.mapLeft((error) => new Error(`Invalid markdown configuration: ${error.message}`)),
+              E__namespace.map(() => mergedConfig)
+            );
+          })
         );
       case "openapi":
         return _function.pipe(
           extractMultiCommandConfig(extractFromProcessFn, "openapi", generatorConfig),
-          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig), cliArgs))
+          E__namespace.flatMap((cliArgs) => {
+            const mergedConfig = __spreadValues(__spreadValues(__spreadValues({}, configOnlyOpenApiDefaults), generatorConfig), cliArgs);
+            return _function.pipe(
+              logger$1.validateSourceDirectoryConfig(extractSourceDirectoryConfig(mergedConfig)),
+              E__namespace.mapLeft((error) => new Error(`Invalid openapi configuration: ${error.message}`)),
+              E__namespace.map(() => mergedConfig)
+            );
+          })
         );
       case "changelog":
         return _function.pipe(
@@ -330,7 +413,14 @@ function extractArgsForCommandsProvidedInConfig(extractFromProcessFn, config) {
           E__namespace.map((cliArgs) => {
             return cliArgs;
           }),
-          E__namespace.map((cliArgs) => __spreadValues(__spreadValues(__spreadValues({}, configOnlyChangelogDefaults), generatorConfig), cliArgs))
+          E__namespace.flatMap((cliArgs) => {
+            const mergedConfig = __spreadValues(__spreadValues(__spreadValues({}, configOnlyChangelogDefaults), generatorConfig), cliArgs);
+            return _function.pipe(
+              validateChangelogConfig(mergedConfig),
+              E__namespace.mapLeft((error) => new Error(`Invalid changelog configuration: ${error.message}`)),
+              E__namespace.map(() => mergedConfig)
+            );
+          })
         );
     }
   });
@@ -360,15 +450,15 @@ function extractYargsDemandingCommand(extractFromProcessFn, config) {
   return yargs.config(config.config).command(
     "markdown",
     "Generate documentation from Apex classes as a Markdown site.",
-    (yargs2) => yargs2.options(markdownOptions)
+    (yargs2) => yargs2.options(markdownOptions).check(validateMarkdownArgs)
   ).command(
     "openapi",
     "Generate an OpenApi REST specification from Apex classes.",
-    () => yargs.options(openApiOptions)
+    (yargs2) => yargs2.options(openApiOptions).check(validateOpenApiArgs)
   ).command(
     "changelog",
     "Generate a changelog from 2 versions of the source code.",
-    () => yargs.options(changeLogOptions)
+    (yargs2) => yargs2.options(changeLogOptions).check(validateChangelogArgs)
   ).demandCommand().parseSync(extractFromProcessFn());
 }
 function extractMultiCommandConfig(extractFromProcessFn, command, config) {
@@ -382,13 +472,45 @@ function extractMultiCommandConfig(extractFromProcessFn, command, config) {
         return changeLogOptions;
     }
   }
+  function getValidationFunction(generator) {
+    switch (generator) {
+      case "markdown":
+        return validateMarkdownArgs;
+      case "openapi":
+        return validateOpenApiArgs;
+      case "changelog":
+        return validateChangelogArgs;
+    }
+  }
   const options = getOptions(command);
+  const validator = getValidationFunction(command);
   return E__namespace.tryCatch(() => {
-    return yargs(extractFromProcessFn()).config(config).options(options).fail((msg) => {
+    return yargs(extractFromProcessFn()).config(config).options(options).check(validator).fail((msg) => {
       throw new Error(`Invalid configuration for command "${command}": ${msg}`);
     }).parseSync();
   }, E__namespace.toError);
 }
+function extractSourceDirectoryConfig(config) {
+  return {
+    sourceDir: config.sourceDir,
+    useSfdxProjectJson: config.useSfdxProjectJson,
+    sfdxProjectPath: config.sfdxProjectPath
+  };
+}
+function validateChangelogConfig(config) {
+  const previousVersionConfig = {
+    sourceDir: config.previousVersionDir
+  };
+  const currentVersionConfig = {
+    sourceDir: config.currentVersionDir
+  };
+  return _function.pipe(
+    E__namespace.Do,
+    E__namespace.bind("previousValid", () => logger$1.validateSourceDirectoryConfig(previousVersionConfig)),
+    E__namespace.bind("currentValid", () => logger$1.validateSourceDirectoryConfig(currentVersionConfig)),
+    E__namespace.map(() => config)
+  );
+}
 
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {

package/dist/index.d.ts

@@ -1,3 +1,140 @@
+/**
+ * Default English translations for ApexDocs.
+ * These can be overridden by users in their configuration.
+ */
+type Translations = {
+    changelog: {
+        title: string;
+        newClasses: {
+            heading: string;
+            description: string;
+        };
+        newInterfaces: {
+            heading: string;
+            description: string;
+        };
+        newEnums: {
+            heading: string;
+            description: string;
+        };
+        newCustomObjects: {
+            heading: string;
+            description: string;
+        };
+        newTriggers: {
+            heading: string;
+            description: string;
+        };
+        removedTypes: {
+            heading: string;
+            description: string;
+        };
+        removedCustomObjects: {
+            heading: string;
+            description: string;
+        };
+        removedTriggers: {
+            heading: string;
+            description: string;
+        };
+        newOrModifiedMembers: {
+            heading: string;
+            description: string;
+        };
+        newOrRemovedCustomFields: {
+            heading: string;
+            description: string;
+        };
+        newOrRemovedCustomMetadataTypeRecords: {
+            heading: string;
+            description: string;
+        };
+        memberModifications: {
+            newEnumValue: string;
+            removedEnumValue: string;
+            newMethod: string;
+            removedMethod: string;
+            newProperty: string;
+            removedProperty: string;
+            newField: string;
+            removedField: string;
+            newType: string;
+            removedType: string;
+            newCustomMetadataRecord: string;
+            removedCustomMetadataRecord: string;
+            newTrigger: string;
+            removedTrigger: string;
+        };
+    };
+    markdown: {
+        sections: {
+            methods: string;
+            properties: string;
+            fields: string;
+            constructors: string;
+            values: string;
+            classes: string;
+            enums: string;
+            interfaces: string;
+            namespace: string;
+            records: string;
+            publishBehavior: string;
+        };
+        details: {
+            type: string;
+            signature: string;
+            group: string;
+            author: string;
+            date: string;
+            see: string;
+            possibleValues: string;
+            parameters: string;
+            throws: string;
+            returnType: string;
+            apiName: string;
+            required: string;
+            inlineHelpText: string;
+            complianceGroup: string;
+            securityClassification: string;
+            protected: string;
+        };
+        typeSuffixes: {
+            class: string;
+            interface: string;
+            enum: string;
+            trigger: string;
+        };
+        triggerEvents: {
+            beforeInsert: string;
+            beforeUpdate: string;
+            beforeDelete: string;
+            afterInsert: string;
+            afterUpdate: string;
+            afterDelete: string;
+            afterUndelete: string;
+        };
+        publishBehaviors: {
+            publishImmediately: string;
+            publishAfterCommit: string;
+        };
+        inheritance: {
+            inheritance: string;
+            implements: string;
+        };
+    };
+};
+
+/**
+ * User-provided partial translations that can override the defaults.
+ */
+type UserTranslations = DeepPartial<Translations>;
+/**
+ * Utility type to make all properties in T optional recursively.
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
 type Generators = 'markdown' | 'openapi' | 'changelog';
 
 type LinkingStrategy =
@@ -20,7 +157,9 @@ type MacroSourceMetadata = {
 type MacroFunction = (metadata: MacroSourceMetadata) => string;
 
 type CliConfigurableMarkdownConfig = {
-  sourceDir: string;
+  sourceDir?: string | string[];
+  useSfdxProjectJson?: boolean;
+  sfdxProjectPath?: string;
   targetDir: string;
   scope: string[];
   customObjectVisibility: string[];
@@ -40,12 +179,15 @@ type UserDefinedMarkdownConfig = {
   targetGenerator: 'markdown';
   excludeTags: string[];
   exclude: string[];
+  translations?: UserTranslations['markdown'];
 } & CliConfigurableMarkdownConfig &
   Partial<MarkdownConfigurableHooks>;
 
 type UserDefinedOpenApiConfig = {
   targetGenerator: 'openapi';
-  sourceDir: string;
+  sourceDir?: string | string[];
+  useSfdxProjectJson?: boolean;
+  sfdxProjectPath?: string;
   targetDir: string;
   fileName: string;
   namespace?: string;
@@ -56,14 +198,15 @@ type UserDefinedOpenApiConfig = {
 
 type UserDefinedChangelogConfig = {
   targetGenerator: 'changelog';
-  previousVersionDir: string;
-  currentVersionDir: string;
+  previousVersionDir?: string | string[];
+  currentVersionDir?: string | string[];
   targetDir: string;
   fileName: string;
   scope: string[];
   customObjectVisibility: string[];
   exclude: string[];
   skipIfNoChanges: boolean;
+  translations?: UserTranslations['changelog'];
 } & Partial<ChangelogConfigurableHooks>;
 
 type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
@@ -243,4 +386,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 MacroFunction, type MacroSourceMetadata, type MarkdownConfigurableHooks, type ReferenceGuidePageData, type Skip, type SourceChangelog, 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 MacroFunction, type MacroSourceMetadata, type MarkdownConfigurableHooks, type ReferenceGuidePageData, type Skip, type SourceChangelog, type TransformChangelogPage, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, type Translations, type UserTranslations, defineChangelogConfig, defineMarkdownConfig, defineOpenApiConfig, process, skip };