@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/src/core/markdown/templates/class-template.ts

@@ -1,75 +0,0 @@
-export const classMarkdownTemplate = `
-{{ heading headingLevel heading }}
-{{#if classModifier}}
-\`{{classModifier}}\`
-{{/if}}
-
-{{> typeDocumentation}}
-
-{{#if extends.length}}
-**Inheritance**
-
-{{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
-{{/if}}
-
-{{#if implements}}
-**Implements**
-
-{{#each implements}}
-{{link this}}{{#unless @last}}, {{/unless}}
-{{/each}}
-{{/if}}
-
-{{#if fields.value}}
-{{#if fields.isGrouped}}
-{{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
-{{else}}
-{{> fieldsPartialTemplate fields}}
-{{/if}}
-{{/if}}
-
-{{#if properties.value}}
-{{#if properties.isGrouped}}
-{{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
-{{else}}
-{{> fieldsPartialTemplate properties}}
-{{/if}}
-{{/if}}
-
-{{#if constructors.value}}
-{{#if constructors.isGrouped}}
-{{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
-{{else}}
-{{> constructorsPartialTemplate constructors}}
-{{/if}}
-{{/if}}
-
-{{#if methods.value}}
-{{#if methods.isGrouped}}
-{{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
-{{else}}
-{{> methodsPartialTemplate methods}}
-{{/if}}
-{{/if}}
-
-{{#if innerClasses.value}}
-{{ heading innerClasses.headingLevel innerClasses.heading }}
-{{#each innerClasses.value}}
-{{> classTemplate this}}
-{{/each}}
-{{/if}}
-
-{{#if innerEnums.value}}
-{{ heading innerEnums.headingLevel innerEnums.heading }}
-{{#each innerEnums.value}}
-{{> enumTemplate this}}
-{{/each}}
-{{/if}}
-
-{{#if innerInterfaces.value}}
-{{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
-{{#each innerInterfaces.value}}
-{{> interfaceTemplate this}}
-{{/each}}
-{{/if}}
-`.trim();

package/src/core/markdown/templates/constructors-partial-template.ts

@@ -1,32 +0,0 @@
-export const constructorsPartialTemplate = `
-{{ heading headingLevel heading }}
-{{#each value}}
-{{{ heading headingLevel (inlineCode heading) }}}
-
-{{#> documentablePartialTemplate}}
-
-{{ heading signature.headingLevel signature.heading }}
-{{ code signature.value }}
-
-{{#if parameters.value}}
-{{ heading parameters.headingLevel parameters.heading }}
-| Name | Type | Description |
-|------|------|-------------|
-{{#each parameters.value}}
-| {{name}} | {{link type}} | {{description}} |
-{{/each}}
-{{/if}}
-
-{{#if throws.value}}
-{{ heading throws.headingLevel throws.heading }}
-{{#each throws.value}}
-{{link this.type}}: {{this.description}}
-
-{{/each}}
-{{/if}}
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-
-{{/each}}
-`.trim();

package/src/core/markdown/templates/documentable-partial-template.ts

@@ -1,26 +0,0 @@
-export const documentablePartialTemplate = `
-{{#each doc.annotations}}
-\`{{this}}\`
-{{/each}}
-
-{{{renderContent doc.description}}}
-
-{{#each doc.customTags}}
-**{{splitAndCapitalize name}}** 
-
-{{{renderContent description}}}
-
-{{/each}}
-
-{{> @partial-block}}
-
-{{#if doc.mermaid.value}}
-{{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
-{{code doc.mermaid.value}}
-{{/if}}
-
-{{#if doc.example.value}}
-{{ heading doc.example.headingLevel doc.example.heading }}
-{{{renderContent doc.example.value}}}
-{{/if}}
-`.trim();

package/src/core/markdown/templates/enum-template.ts

@@ -1,12 +0,0 @@
-export const enumMarkdownTemplate = `
-{{ heading headingLevel heading }}
-
-{{> typeDocumentation }}
-
-{{ heading values.headingLevel values.heading }}
-| Value | Description |
-|-------|-------------|
-{{#each values.value}}
-| {{value}} | {{description}} |
-{{/each}}
-`.trim();

package/src/core/markdown/templates/fieldsPartialTemplate.ts

@@ -1,23 +0,0 @@
-export const fieldsPartialTemplate = `
-{{ heading headingLevel heading }}
-{{#each value}}
-{{{ heading headingLevel (inlineCode heading) }}}
-
-{{#if inherited}}
-*Inherited*
-{{/if}}
-
-{{#> documentablePartialTemplate }}
-
-{{ heading signature.headingLevel signature.heading }}
-{{ code signature.value }}
-
-{{ heading type.headingLevel type.heading }}
-{{link type.value}}
-
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-
-{{/each}}
-`.trim();

package/src/core/markdown/templates/grouped-members-partial-template.ts

@@ -1,6 +0,0 @@
-export const groupedMembersPartialTemplate = `
-{{ heading headingLevel heading }}
-{{#each value}}
-{{> (lookup .. "subTemplate") this}}
-{{/each}}
-`.trim();

package/src/core/markdown/templates/hookable.ts

@@ -1,7 +0,0 @@
-export const hookableTemplate = `
-{{#if frontmatter}}
-{{{frontmatter}}}
-{{/if}}
-
-{{{content}}}
-`.trim();

package/src/core/markdown/templates/interface-template.ts

@@ -1,16 +0,0 @@
-export const interfaceMarkdownTemplate = `
-{{ heading headingLevel heading }}
-
-{{> typeDocumentation }}
-
-{{#if extends}}
-**Extends**
-{{#each extends}}
-{{link this}}{{#unless @last}}, {{/unless}}
-{{/each}}
-{{/if}}
-
-{{#if methods}}
-{{> methodsPartialTemplate methods}}
-{{/if}}
-`.trim();

package/src/core/markdown/templates/methods-partial-template.ts

@@ -1,43 +0,0 @@
-export const methodsPartialTemplate = `
-{{ heading headingLevel heading }}
-{{#each value}}
-{{{ heading headingLevel (inlineCode heading) }}}
-
-{{#if inherited}}
-*Inherited*
-{{/if}}
-
-{{#> documentablePartialTemplate}}
-
-{{ heading signature.headingLevel signature.heading }}
-{{ code signature.value }}
-
-{{#if parameters.value}}
-{{ heading parameters.headingLevel parameters.heading }}
-| Name | Type | Description |
-|------|------|-------------|
-{{#each parameters.value}}
-| {{name}} | {{link type}} | {{{renderContent description}}} |
-{{/each}}
-{{/if}}
-
-{{ heading returnType.headingLevel returnType.heading }}
-**{{link returnType.value.type}}**
-
-{{#if returnType.value.description}}
-{{returnType.value.description}}
-{{/if}}
-
-{{#if throws.value}}
-{{ heading throws.headingLevel throws.heading }}
-{{#each throws.value}}
-{{link this.type}}: {{this.description}}
-
-{{/each}}
-{{/if}}
-{{/documentablePartialTemplate}}
-
-{{#unless @last}}---{{/unless}}
-
-{{/each}}
-`.trim();

package/src/core/markdown/templates/reference-guide.ts

@@ -1,14 +0,0 @@
-export const referenceGuideTemplate = `
-# Apex Reference Guide
-
-{{#each this}}
-## {{@key}}
-
-{{#each this}}
-### {{link title}}
-
-{{{renderContent description}}}
-
-{{/each}}
-{{/each}}
-`.trim();

package/src/core/markdown/templates/template.ts

@@ -1,114 +0,0 @@
-import Handlebars from 'handlebars';
-import { CodeBlock, RenderableContent, StringOrLink } from '../adapters/types';
-import { isCodeBlock, isEmptyLine, isInlineCode } from '../adapters/type-utils';
-import { typeDocPartial } from './type-doc-partial';
-import { documentablePartialTemplate } from './documentable-partial-template';
-import { methodsPartialTemplate } from './methods-partial-template';
-import { groupedMembersPartialTemplate } from './grouped-members-partial-template';
-import { constructorsPartialTemplate } from './constructors-partial-template';
-import { fieldsPartialTemplate } from './fieldsPartialTemplate';
-import { classMarkdownTemplate } from './class-template';
-import { enumMarkdownTemplate } from './enum-template';
-import { interfaceMarkdownTemplate } from './interface-template';
-
-export type CompilationRequest = {
-  template: string;
-  source: unknown;
-};
-
-export class Template {
-  private static instance: Template;
-
-  private constructor() {
-    Handlebars.registerPartial('typeDocumentation', typeDocPartial);
-    Handlebars.registerPartial('documentablePartialTemplate', documentablePartialTemplate);
-    Handlebars.registerPartial('methodsPartialTemplate', methodsPartialTemplate);
-    Handlebars.registerPartial('constructorsPartialTemplate', constructorsPartialTemplate);
-    Handlebars.registerPartial('groupedMembersPartialTemplate', groupedMembersPartialTemplate);
-    Handlebars.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate);
-    Handlebars.registerPartial('classTemplate', classMarkdownTemplate);
-    Handlebars.registerPartial('enumTemplate', enumMarkdownTemplate);
-    Handlebars.registerPartial('interfaceTemplate', interfaceMarkdownTemplate);
-
-    Handlebars.registerHelper('link', link);
-    Handlebars.registerHelper('code', convertCodeBlock);
-    Handlebars.registerHelper('renderContent', resolveRenderableContent);
-    Handlebars.registerHelper('heading', heading);
-    Handlebars.registerHelper('inlineCode', inlineCode);
-    Handlebars.registerHelper('splitAndCapitalize', splitAndCapitalize);
-  }
-
-  public static getInstance(): Template {
-    if (!Template.instance) {
-      Template.instance = new Template();
-    }
-    return Template.instance;
-  }
-
-  compile(request: CompilationRequest): string {
-    const compiled = Handlebars.compile(request.template);
-    return (
-      compiled(request.source)
-        .trim()
-        // clean up extra newlines
-        .replace(/\n{3,}/g, '\n\n')
-    );
-  }
-}
-
-const splitAndCapitalize = (text: string) => {
-  const words = text.split(/[-_]+/);
-  const capitalizedWords = [];
-  for (const word of words) {
-    capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
-  }
-  return capitalizedWords.join(' ');
-};
-
-const heading = (level: number, text: string) => {
-  return `${'#'.repeat(level)} ${text}`;
-};
-
-const inlineCode = (text: string) => {
-  return new Handlebars.SafeString(`\`${text}\``);
-};
-
-const convertCodeBlock = (codeBlock: CodeBlock): Handlebars.SafeString => {
-  return new Handlebars.SafeString(
-    `
-\`\`\`${codeBlock.language}
-${codeBlock.content.join('\n')}
-\`\`\`
-  `.trim(),
-  );
-};
-
-const resolveRenderableContent = (description?: RenderableContent[]): string => {
-  if (!description) {
-    return '';
-  }
-
-  function reduceDescription(acc: string, curr: RenderableContent) {
-    if (isEmptyLine(curr)) {
-      return acc + '\n';
-    }
-    if (isCodeBlock(curr)) {
-      return acc + convertCodeBlock(curr) + '\n';
-    }
-    if (isInlineCode(curr)) {
-      return acc + inlineCode(curr.content).toString() + ' ';
-    } else {
-      return acc + Handlebars.escapeExpression(link(curr)).trim() + ' ';
-    }
-  }
-
-  return description.reduce(reduceDescription, '').trim();
-};
-
-const link = (source: StringOrLink): string => {
-  if (typeof source === 'string') {
-    return source;
-  } else {
-    return `[${source.title}](${source.url})`;
-  }
-};

package/src/core/markdown/templates/type-doc-partial.ts

@@ -1,27 +0,0 @@
-export const typeDocPartial = `
-{{#> documentablePartialTemplate}}
-
-{{#if doc.group}}
-**Group** {{doc.group}}
-{{/if}}
-
-{{#if doc.author}}
-**Author** {{doc.author}}
-{{/if}}
-
-{{#if doc.date}}
-**Date** {{doc.date}}
-{{/if}}
-
-{{#each doc.sees}}
-**See** {{link this}}
-
-{{/each}}
-
-{{#if namespace}}
-## Namespace
-{{namespace}}
-{{/if}}
-
-{{/documentablePartialTemplate}}
-`.trim();

package/src/core/markdown/utils.ts

@@ -1,3 +0,0 @@
-import { ParsedFile } from '../shared/types';
-
-export const parsedFilesToTypes = (parsedFiles: ParsedFile[]) => parsedFiles.map((parsedFile) => parsedFile.type);

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

@@ -1,13 +0,0 @@
-import { PageData } from '../shared/types';
-
-export class FileContainer {
-  _files: PageData[] = [];
-
-  files(): PageData[] {
-    return this._files;
-  }
-
-  pushFile(file: PageData): void {
-    this._files.push(file);
-  }
-}

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

@@ -1,14 +0,0 @@
-import { OpenApi } from './open-api';
-import { OpenApiPageData } from '../shared/types';
-
-export function createOpenApiFile(fileName: string, openApiModel: OpenApi): OpenApiPageData {
-  const content = JSON.stringify({ ...openApiModel, namespace: undefined }, null, 2);
-  return {
-    fileExtension: 'json',
-    fileName,
-    directory: '',
-    content,
-    frontmatter: null,
-    group: null,
-  };
-}

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

@@ -1,14 +0,0 @@
-import { XMLParser } from 'fast-xml-parser';
-
-export function parseApexMetadata(input: string) {
-  const map = new Map<string, string>();
-  const xml = new XMLParser().parse(input);
-
-  map.set('apiVersion', xml.ApexClass.apiVersion ?? '');
-
-  if (xml.ApexClass.status) {
-    map.set('status', xml.ApexClass.status);
-  }
-
-  return map;
-}

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

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

@@ -1,92 +0,0 @@
-import { Type } from '@cparra/apex-reflection';
-
-export type Generator = 'markdown' | 'openapi';
-
-export type ConfigurableHooks = {
-  transformReferenceGuide: TransformReferenceGuide;
-  transformDocs: TransformDocs;
-  transformDocPage: TransformDocPage;
-};
-
-export type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown';
-  sourceDir: string;
-  targetDir: string;
-  scope: string[];
-  defaultGroupName: string;
-  namespace?: string;
-  sortMembersAlphabetically: boolean;
-  includeMetadata: boolean;
-} & Partial<ConfigurableHooks>;
-
-export type UserDefinedOpenApiConfig = {
-  targetGenerator: 'openapi';
-  sourceDir: string;
-  targetDir: string;
-  includeMetadata: boolean;
-};
-
-export type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig;
-
-export type SourceFile = {
-  filePath: string;
-  content: string;
-  metadataContent: string | null;
-};
-
-export type ParsedFile = {
-  filePath: string;
-  type: Type;
-};
-
-type Frontmatter = string | Record<string, unknown> | null;
-
-export type ReferenceGuidePageData = {
-  directory: string;
-  frontmatter: Frontmatter;
-  content: string;
-  fileExtension: string;
-  fileName: string;
-};
-
-export type DocPageData = {
-  source: {
-    filePath: string;
-    name: string;
-    type: 'interface' | 'class' | 'enum';
-  };
-  group: string | null;
-  fileName: string;
-  fileExtension: string;
-  directory: string;
-  frontmatter: Frontmatter;
-  content: string;
-};
-
-export type OpenApiPageData = Omit<DocPageData, 'source'>;
-
-export type PageData = DocPageData | OpenApiPageData | ReferenceGuidePageData;
-
-export type DocumentationBundle = {
-  referenceGuide: ReferenceGuidePageData;
-  docs: DocPageData[];
-};
-
-export type Skip = {
-  readonly _tag: 'Skip';
-};
-
-export type PostHookDocumentationBundle = {
-  referenceGuide: ReferenceGuidePageData | Skip;
-  docs: DocPageData[];
-};
-
-// Configurable Hooks
-
-export type TransformReferenceGuide = (
-  referenceGuide: ReferenceGuidePageData,
-) => Partial<ReferenceGuidePageData> | Skip | Promise<Partial<ReferenceGuidePageData> | Skip>;
-
-export type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
-
-export type TransformDocPage = (doc: DocPageData) => Partial<DocPageData> | Promise<Partial<DocPageData>>;

package/src/core/shared/utils.ts

@@ -1,5 +0,0 @@
-import { Skip } from './types';
-
-export function isSkip(value: unknown): value is Skip {
-  return Object.prototype.hasOwnProperty.call(value, '_tag') && (value as Skip)._tag === 'Skip';
-}

package/src/defaults.ts

@@ -1,8 +0,0 @@
-export const defaults = {
-  targetGenerator: 'markdown' as const,
-  targetDir: './docs/',
-  scope: ['global'],
-  defaultGroupName: 'Miscellaneous',
-  includeMetadata: false,
-  sortMembersAlphabetically: false,
-};

package/src/test-helpers/InterfaceMirrorBuilder.ts

@@ -1,39 +0,0 @@
-import { Annotation, DocComment, InterfaceMirror, MethodMirror } from '@cparra/apex-reflection';
-
-/**
- * Builder class to create Interface objects.
- * For testing purposes only.
- */
-export class InterfaceMirrorBuilder {
-  private name = 'SampleClass';
-  private annotations: Annotation[] = [];
-  private docComment?: DocComment;
-  private methods: MethodMirror[] = [];
-
-  withName(name: string): InterfaceMirrorBuilder {
-    this.name = name;
-    return this;
-  }
-
-  addAnnotation(annotation: Annotation): InterfaceMirrorBuilder {
-    this.annotations.push(annotation);
-    return this;
-  }
-
-  addMethod(method: MethodMirror): InterfaceMirrorBuilder {
-    this.methods.push(method);
-    return this;
-  }
-
-  build(): InterfaceMirror {
-    return {
-      annotations: this.annotations,
-      name: this.name,
-      type_name: 'interface',
-      methods: this.methods,
-      access_modifier: 'public',
-      docComment: this.docComment,
-      extended_interfaces: [],
-    };
-  }
-}

package/src/util/fp.ts

@@ -1,3 +0,0 @@
-export function apply<T extends unknown[], U extends unknown[], R>(fn: (...args: [...T, ...U]) => R, ...front: T) {
-  return (...tailArgs: U) => fn(...front, ...tailArgs);
-}