@cparra/apexdocs 3.0.0-alpha.9 → 3.0.0-rc.0

package/src/core/shared/types.d.ts

@@ -1,17 +1,5 @@
 import { Type } from '@cparra/apex-reflection';
 
-export type Generator = 'markdown' | 'openapi';
-
-/**
- * The configurable hooks that can be used to modify the output of the generator.
- */
-export type ConfigurableHooks = {
-  transformReferenceGuide: TransformReferenceGuide;
-  transformDocs: TransformDocs;
-  transformDocPage: TransformDocPage;
-  transformReference: TransformReference;
-};
-
 type LinkingStrategy =
   // Links will be generated using relative paths.
   | 'relative'
@@ -24,8 +12,8 @@ type LinkingStrategy =
   | 'none';
 
 export type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown';
   sourceDir: string;
+  targetGenerator: 'markdown';
   targetDir: string;
   scope: string[];
   defaultGroupName: string;
@@ -39,7 +27,10 @@ export type UserDefinedOpenApiConfig = {
   targetGenerator: 'openapi';
   sourceDir: string;
   targetDir: string;
-  includeMetadata: boolean;
+  fileName: string;
+  namespace?: string;
+  title: string;
+  apiVersion: string;
 };
 
 export type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig;
@@ -112,11 +103,21 @@ export type PostHookDocumentationBundle = {
   docs: DocPageData[];
 };
 
-// Configurable Hooks
+// CONFIGURABLE HOOKS
+
+/**
+ * The configurable hooks that can be used to modify the output of the generator.
+ */
+export type ConfigurableHooks = {
+  transformReferenceGuide: TransformReferenceGuide;
+  transformDocs: TransformDocs;
+  transformDocPage: TransformDocPage;
+  transformReference: TransformReference;
+};
 
-type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
+export type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
 
-type ConfigurableDocPageData = Omit<DocPageData, 'source' | 'outputDocPath'>;
+export type ConfigurableDocPageData = Omit<DocPageData, 'source' | 'outputDocPath'>;
 
 /**
  * Allows changing where the files are written to.

package/src/index.ts

@@ -1,4 +1,3 @@
-import { SetOptional } from 'type-fest';
 import type {
   ConfigurableHooks,
   Skip,
@@ -6,18 +5,18 @@ import type {
   ReferenceGuidePageData,
   DocPageData,
   DocPageReference,
+  ConfigurableDocPageData,
+  TransformReferenceGuide,
+  TransformDocs,
+  TransformDocPage,
+  TransformReference,
+  ConfigurableDocPageReference,
 } from './core/shared/types';
 import { defaults } from './defaults';
 
-type ConfigurableMarkdownConfig = Omit<
-  SetOptional<
-    UserDefinedMarkdownConfig,
-    'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically' | 'linkingStrategy'
-  >,
-  'targetGenerator'
->;
+type ConfigurableMarkdownConfig = Omit<Partial<UserDefinedMarkdownConfig>, 'targetGenerator'>;
 
-function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig {
+function defineMarkdownConfig(config: ConfigurableMarkdownConfig): Partial<UserDefinedMarkdownConfig> {
   return {
     ...defaults,
     ...config,
@@ -33,4 +32,18 @@ function skip(): Skip {
 
 // Exports
 
-export { defineMarkdownConfig, skip, ConfigurableHooks, ReferenceGuidePageData, DocPageData, DocPageReference };
+export {
+  defineMarkdownConfig,
+  skip,
+  TransformReferenceGuide,
+  TransformDocs,
+  TransformDocPage,
+  TransformReference,
+  ConfigurableHooks,
+  ReferenceGuidePageData,
+  DocPageData,
+  DocPageReference,
+  Skip,
+  ConfigurableDocPageData,
+  ConfigurableDocPageReference,
+};

package/src/test-helpers/SettingsBuilder.ts

@@ -1,4 +1,4 @@
-import { SettingsConfig } from '../core/settings';
+import { SettingsConfig } from '../core/openApiSettings';
 
 /**
  * Builder class to create SettingsConfig objects.
@@ -8,14 +8,10 @@ export class SettingsBuilder {
   build(): SettingsConfig {
     return {
       sourceDirectory: './',
-      scope: [],
       outputDir: './',
-      targetGenerator: 'openapi',
-      indexOnly: false,
-      defaultGroupName: 'Misc',
       openApiTitle: 'Apex API',
       openApiFileName: 'openapi',
-      includeMetadata: false,
+      version: '1.0.0',
     };
   }
 }

package/examples/force-app/main/default/classes/AnotherInterface.cls

@@ -1,16 +0,0 @@
-/**
- * @description Some desc
- * @group Classes
- * @mermaid
-  * sequenceDiagram
-  *     participant dotcom
-  *     participant iframe
-  *     participant viewscreen
-  *     dotcom->>iframe: loads html w/ iframe url
-  *     iframe->>viewscreen: request template
-  *     viewscreen->>iframe: html & javascript
-  *     iframe->>dotcom: iframe ready
-  *     dotcom->>iframe: set mermaid data on iframe
-  *     iframe->>iframe: render mermaid
- */
-public interface AnotherInterface{}

package/examples/force-app/main/default/classes/EscapedAnnotations.cls

@@ -1,5 +0,0 @@
-/**
- * @description This sentence has an `@embedded` annotation.
- */
-public with sharing class EscapedAnnotations {
-}

package/examples/force-app/main/default/classes/GrandparentClass.cls

@@ -1,5 +0,0 @@
-public virtual class GrandparentClass {
-    protected String protectedGrandParentField;
-
-    protected String AProp { get; set; }
-}

package/examples/force-app/main/default/classes/GroupedClass.cls

@@ -1,8 +0,0 @@
-/**********************************************************
-Uses a block style apex doc
-@group           Main
-@test-class      {@link SampleClass}
-***********************************************************/
-public class GroupedClass {
-
-}

package/examples/force-app/main/default/classes/InterfaceWithInheritance.cls

@@ -1 +0,0 @@
-public interface InterfaceWithInheritance extends SampleInterface, AnotherInterface {}

package/examples/force-app/main/default/classes/MemberGrouping.cls

@@ -1,17 +0,0 @@
-public class MemberGrouping {
-    // @start-group Group old syntax
-    public static final String inGroup1;
-    public static final String anotherInGroup1;
-    // @end-group
-
-    /**
-     * @start-group Group new syntax
-     * @description Group's description
-     */
-
-    /** @description Description for constant in group 2 */
-    public static final String inGroup2;
-    /** @description Description for another constant in group 2 @future annotation */
-    public static final String anotherInGroup2;
-    /** @end-group */
-}

package/examples/force-app/main/default/classes/ParentClass.cls

@@ -1,16 +0,0 @@
-public abstract class ParentClass extends GrandparentClass{
-    private String privateStringFromParent;
-    /**
-     * @description This is a protected string, use carefully.
-     */
-    protected String protectedStringFromParent;
-    public String publicStringFromParent;
-
-    public virtual String overridableMethod() {
-        return '';
-    }
-
-    public virtual String overridableMethodOverridden() {
-        return '';
-    }
-}

package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>54.0</apiVersion>
-    <status>Active</status>
-</ApexClass>

package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls

@@ -1,9 +0,0 @@
-@IsTest
-class SampleClassWithoutModifier {
-    /**
-     * @description This is a test method
-     */
-    @IsTest
-    private static void thisIsAClassWithoutAModifier() {
-    }
-}

package/examples/force-app/main/default/classes/SampleInterface.cls

@@ -1,16 +0,0 @@
-/**
- * @description This is an interface description.
- * @group Sample Interfaces
- */
-global interface SampleInterface {
-    /**
-     * @description Executes the command.
-     */
-    void execute();
-
-    /**
-     * @description Returns a value based on the executed command.
-     * @return The value
-     */
-    String getValue();
-}

package/src/core/settings.ts

@@ -1,56 +0,0 @@
-import { Generator } from './shared/types';
-
-export interface SettingsConfig {
-  sourceDirectory: string;
-  scope: string[];
-  outputDir: string;
-  targetGenerator: Generator;
-  indexOnly: boolean;
-  defaultGroupName: string;
-  openApiTitle?: string;
-  namespace?: string;
-  openApiFileName: string;
-  includeMetadata: boolean;
-  sortMembersAlphabetically?: boolean;
-}
-
-export class Settings {
-  private static instance: Settings;
-
-  private constructor(public config: SettingsConfig) {}
-
-  public static build(config: SettingsConfig) {
-    Settings.instance = new Settings(config);
-  }
-
-  public static getInstance(): Settings {
-    if (!Settings.instance) {
-      throw new Error('Settings has not been initialized');
-    }
-    return Settings.instance;
-  }
-
-  get scope(): string[] {
-    return this.config.scope;
-  }
-
-  get targetGenerator(): Generator {
-    return this.config.targetGenerator;
-  }
-
-  get indexOnly(): boolean {
-    return this.config.indexOnly;
-  }
-
-  public getOpenApiTitle(): string | undefined {
-    return this.config.openApiTitle;
-  }
-
-  public getNamespace(): string | undefined {
-    return this.config.namespace;
-  }
-
-  public openApiFileName(): string {
-    return this.config.openApiFileName;
-  }
-}