@cparra/apexdocs 3.0.0-alpha.8 → 3.0.0-beta.1

package/src/core/openapi/open-api-docs-processor.ts

@@ -2,7 +2,7 @@ import { FileContainer } from './file-container';
 import { ClassMirror, Type } from '@cparra/apex-reflection';
 import { Logger } from '#utils/logger';
 import { OpenApi } from './open-api';
-import { Settings } from '../settings';
+import { OpenApiSettings } from '../openApiSettings';
 import { MethodParser } from './parsers/MethodParser';
 import { camel2title } from '#utils/string-utils';
 import { createOpenApiFile } from './openapi-type-file';
@@ -13,11 +13,15 @@ export class OpenApiDocsProcessor {
 
   constructor() {
     this._fileContainer = new FileContainer();
-    const title = Settings.getInstance().getOpenApiTitle();
+    const title = OpenApiSettings.getInstance().getOpenApiTitle();
     if (!title) {
       throw Error('No OpenApi title was provided.');
     }
-    this.openApiModel = new OpenApi(title, '1.0.0', Settings.getInstance().getNamespace());
+    this.openApiModel = new OpenApi(
+      title,
+      OpenApiSettings.getInstance().getVersion(),
+      OpenApiSettings.getInstance().getNamespace(),
+    );
   }
 
   fileBuilder(): FileContainer {
@@ -66,7 +70,7 @@ export class OpenApiDocsProcessor {
   }
 
   onAfterProcess: ((types: Type[]) => void) | undefined = () => {
-    const page = createOpenApiFile(Settings.getInstance().openApiFileName(), this.openApiModel);
+    const page = createOpenApiFile(OpenApiSettings.getInstance().openApiFileName(), this.openApiModel);
     this._fileContainer.pushFile(page);
   };
 

package/src/core/openapi/open-api.ts

@@ -15,7 +15,11 @@ export class OpenApi {
   servers: ServerObject[];
   components?: ComponentsObject;
 
-  constructor(title: string, version: string, private namespace?: string) {
+  constructor(
+    title: string,
+    version: string,
+    private namespace?: string,
+  ) {
     this.info = {
       title: title,
       version: version,

package/src/core/openapi/openapi-type-file.ts

@@ -4,7 +4,7 @@ import { OpenApiPageData } from '../shared/types';
 export function createOpenApiFile(fileName: string, openApiModel: OpenApi): OpenApiPageData {
   const content = JSON.stringify({ ...openApiModel, namespace: undefined }, null, 2);
   return {
-    outputDocPath: '',
+    outputDocPath: `${fileName}.json`,
     content,
     frontmatter: null,
     group: null,

package/src/core/openapi/parser.ts

@@ -1,5 +1,4 @@
 import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
-import { parseApexMetadata } from '../parse-apex-metadata';
 import { Logger } from '#utils/logger';
 import { UnparsedSourceFile } from '../shared/types';
 
@@ -16,20 +15,7 @@ export class RawBodyParser implements TypeParser {
     const types = this.typeBundles
       .map((currentBundle) => {
         Logger.log(`Parsing file: ${currentBundle.filePath}`);
-        const result = reflect(currentBundle);
-        if (!!result.typeMirror && !!currentBundle.metadataContent) {
-          // If successful and there is a metadata file
-          const metadataParams = parseApexMetadata(currentBundle.metadataContent);
-          metadataParams.forEach((value, key) => {
-            const declaration = `${key}: ${value}`;
-            result.typeMirror?.annotations.push({
-              rawDeclaration: declaration,
-              name: declaration,
-              type: declaration,
-            });
-          });
-        }
-        return result;
+        return reflect(currentBundle);
       })
       .filter((reflectionResult) => {
         return reflectionResult.typeMirror;

package/src/core/openapi/transpiler.ts

@@ -1,5 +1,4 @@
 import { Type } from '@cparra/apex-reflection';
-import { Settings } from '../settings';
 import { OpenApiDocsProcessor } from './open-api-docs-processor';
 
 export default class Transpiler {
@@ -10,10 +9,6 @@ export default class Transpiler {
       return 0;
     });
 
-    if (Settings.getInstance().indexOnly) {
-      return;
-    }
-
     sortedTypes.forEach((currentType) => {
       processor.onProcess(currentType);
     });

package/src/core/parse-apex-metadata.ts

@@ -1,13 +1,29 @@
 import { XMLParser } from 'fast-xml-parser';
+import * as E from 'fp-ts/Either';
+import { pipe } from 'fp-ts/function';
+
+type ApexMetadata = {
+  ApexClass: ApexClassMetadata;
+};
+
+type ApexClassMetadata = {
+  apiVersion: string;
+  status?: string;
+};
 
 export function parseApexMetadata(input: string) {
-  const map = new Map<string, string>();
-  const xml = new XMLParser().parse(input);
+  return pipe(input, parse, E.map(toMap));
+}
 
-  map.set('apiVersion', xml.ApexClass.apiVersion ?? '');
+function parse(input: string): E.Either<Error, ApexMetadata> {
+  return E.tryCatch(() => new XMLParser().parse(input), E.toError);
+}
 
-  if (xml.ApexClass.status) {
-    map.set('status', xml.ApexClass.status);
+function toMap(metadata: ApexMetadata): Map<string, string> {
+  const map = new Map<string, string>();
+  map.set('apiVersion', String(metadata.ApexClass.apiVersion));
+  if (metadata.ApexClass.status) {
+    map.set('status', String(metadata.ApexClass.status));
   }
 
   return map;

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

@@ -39,7 +39,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;

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/dist/defaults-DUwru49Q.js

@@ -1,12 +0,0 @@
-'use strict';
-
-const defaults = {
-  targetGenerator: "markdown",
-  targetDir: "./docs/",
-  scope: ["global"],
-  defaultGroupName: "Miscellaneous",
-  includeMetadata: false,
-  sortMembersAlphabetically: false
-};
-
-exports.defaults = defaults;

package/dist/defaults-SH0Rsi5E.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const defaults = {
-  targetGenerator: "markdown",
-  targetDir: "./docs/",
-  scope: ["global"],
-  defaultGroupName: "Miscellaneous",
-  includeMetadata: false
-};
-
-exports.defaults = defaults;

package/dist/defaults-jLXD2y8-.js

@@ -1,13 +0,0 @@
-'use strict';
-
-const defaults = {
-  targetGenerator: "markdown",
-  targetDir: "./docs/",
-  scope: ["global"],
-  defaultGroupName: "Miscellaneous",
-  includeMetadata: false,
-  sortMembersAlphabetically: false,
-  documentationRootDir: ""
-};
-
-exports.defaults = defaults;

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/markdown/reflection/error-handling.ts

@@ -1,37 +0,0 @@
-import * as E from 'fp-ts/Either';
-import { ParsedFile } from '../../shared/types';
-import { pipe } from 'fp-ts/function';
-
-export class ReflectionErrors {
-  readonly _tag = 'ReflectionErrors';
-  constructor(public errors: ReflectionError[]) {}
-}
-
-export class ReflectionError {
-  constructor(
-    public file: string,
-    public message: string,
-  ) {}
-}
-
-export function checkForReflectionErrors(reflectionResult: E.Either<ReflectionError, ParsedFile>[]) {
-  function reduceReflectionResultIntoSingleEither(results: E.Either<ReflectionError, ParsedFile>[]): {
-    errors: ReflectionError[];
-    parsedFiles: ParsedFile[];
-  } {
-    return results.reduce<{ errors: ReflectionError[]; parsedFiles: ParsedFile[] }>(
-      (acc, result) => {
-        E.isLeft(result) ? acc.errors.push(result.left) : acc.parsedFiles.push(result.right);
-        return acc;
-      },
-      {
-        errors: [],
-        parsedFiles: [],
-      },
-    );
-  }
-
-  return pipe(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, parsedFiles }) =>
-    errors.length ? E.left(new ReflectionErrors(errors)) : E.right(parsedFiles),
-  );
-}

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;
-  }
-}