@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/src/{core → transpiler}/openapi/parsers/RequestBodyBuilder.ts

@@ -1,6 +1,6 @@
-import { RequestBody } from '../../../core/openapi/open-api-types';
+import { RequestBody } from '../../../model/openapi/open-api-types';
 import { Reference } from './ReferenceBuilder';
-import { ApexDocHttpRequestBody } from '../../../core/openapi/apex-doc-types';
+import { ApexDocHttpRequestBody } from '../../../model/openapi/apex-doc-types';
 import { Builder } from './Builder';
 
 /**

package/src/{core → transpiler}/openapi/parsers/ResponsesBuilder.ts

@@ -1,6 +1,6 @@
-import { ResponseObject } from '../../../core/openapi/open-api-types';
+import { ResponseObject } from '../../../model/openapi/open-api-types';
 import { Reference } from './ReferenceBuilder';
-import { ApexDocHttpResponse } from '../../../core/openapi/apex-doc-types';
+import { ApexDocHttpResponse } from '../../../model/openapi/apex-doc-types';
 import { Builder } from './Builder';
 
 export class ResponsesBuilder extends Builder<ResponseObject, ApexDocHttpResponse> {

package/src/{core → transpiler}/openapi/parsers/__tests__/MethodParser.spec.ts

@@ -1,7 +1,7 @@
 import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
 import { MethodMirrorBuilder } from '../../../../test-helpers/MethodMirrorBuilder';
 import { AnnotationBuilder } from '../../../../test-helpers/AnnotationBuilder';
-import { OpenApi } from '../../../../core/openapi/open-api';
+import { OpenApi } from '../../../../model/openapi/open-api';
 import { MethodParser } from '../MethodParser';
 import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
 

package/src/{core → transpiler}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts

@@ -1,7 +1,7 @@
 import { ParameterObjectBuilder } from '../ParameterObjectBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ReferenceObject } from '../../../../core/openapi/open-api-types';
-import { ApexDocParameterObject } from '../../../../core/openapi/apex-doc-types';
+import { ReferenceObject } from '../../../../model/openapi/open-api-types';
+import { ApexDocParameterObject } from '../../../../model/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/{core → transpiler}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts

@@ -1,8 +1,8 @@
-import { TypesRepository } from '../../../../core/openapi/types-repository';
+import { TypesRepository } from '../../../../model/types-repository';
 import { ReferenceBuilder } from '../ReferenceBuilder';
 import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
 import { FieldMirrorBuilder } from '../../../../test-helpers/FieldMirrorBuilder';
-import { SchemaObjectArray, SchemaObjectObject } from '../../../../core/openapi/open-api-types';
+import { SchemaObjectArray, SchemaObjectObject } from '../../../../model/openapi/open-api-types';
 import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
 import { DocCommentAnnotationBuilder } from '../../../../test-helpers/DocCommentAnnotationBuilder';
 

package/src/{core → transpiler}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts

@@ -1,7 +1,7 @@
 import { RequestBodyBuilder } from '../RequestBodyBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ReferenceObject } from '../../../../core/openapi/open-api-types';
-import { ApexDocHttpRequestBody } from '../../../../core/openapi/apex-doc-types';
+import { ReferenceObject } from '../../../../model/openapi/open-api-types';
+import { ApexDocHttpRequestBody } from '../../../../model/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/{core → transpiler}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts

@@ -1,6 +1,6 @@
 import { ResponsesBuilder } from '../ResponsesBuilder';
 import { Reference } from '../ReferenceBuilder';
-import { ApexDocHttpResponse } from '../../../../core/openapi/apex-doc-types';
+import { ApexDocHttpResponse } from '../../../../model/openapi/apex-doc-types';
 
 jest.mock('../ReferenceBuilder', () => {
   return {

package/src/transpiler/processor-type-transpiler.ts

@@ -0,0 +1,18 @@
+import { Type } from '@cparra/apex-reflection';
+import { FileContainer } from './file-container';
+
+export type LinkingStrategy = 'root-relative' | 'path-relative';
+
+export default abstract class ProcessorTypeTranspiler {
+  onBeforeProcess: ((types: Type[]) => void) | undefined;
+
+  abstract onProcess(type: Type): void;
+
+  onAfterProcess: ((types: Type[]) => void) | undefined;
+
+  abstract fileBuilder(): FileContainer;
+
+  getLinkingStrategy(): LinkingStrategy {
+    return 'root-relative';
+  }
+}

package/src/{core/openapi → transpiler}/transpiler.ts

@@ -1,20 +1,24 @@
 import { Type } from '@cparra/apex-reflection';
+import ProcessorTypeTranspiler from './processor-type-transpiler';
 import { Settings } from '../settings';
-import { OpenApiDocsProcessor } from './open-api-docs-processor';
+import State from '../service/state';
 
 export default class Transpiler {
-  static generate(types: Type[], processor: OpenApiDocsProcessor): void {
+  static generate(types: Type[], processor: ProcessorTypeTranspiler): void {
     const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
       if (apexTypeA.name < apexTypeB.name) return -1;
       if (apexTypeA.name > apexTypeB.name) return 1;
       return 0;
     });
 
+    processor.onBeforeProcess?.(sortedTypes);
+
     if (Settings.getInstance().indexOnly) {
       return;
     }
 
     sortedTypes.forEach((currentType) => {
+      State.getInstance().setTypeBeingProcessed(currentType);
       processor.onProcess(currentType);
     });
     processor.onAfterProcess?.(sortedTypes);

package/src/util/error-logger.ts

@@ -8,7 +8,7 @@ export default class ErrorLogger {
     });
   }
 
-  private static logErrorsForSingleType(currentType: Type): void {
+  private static logErrorsForSingleType(currentType: Type, parentType?: Type): void {
     this.logTypeErrors(currentType);
 
     if (currentType.type_name === 'class') {
@@ -67,15 +67,15 @@ export default class ErrorLogger {
     });
 
     classMirror.enums.forEach((currentEnum) => {
-      this.logErrorsForSingleType(currentEnum);
+      this.logErrorsForSingleType(currentEnum, classMirror);
     });
 
     classMirror.interfaces.forEach((currentInterface) => {
-      this.logErrorsForSingleType(currentInterface);
+      this.logErrorsForSingleType(currentInterface, classMirror);
     });
 
     classMirror.classes.forEach((currentClass) => {
-      this.logErrorsForSingleType(currentClass);
+      this.logErrorsForSingleType(currentClass, classMirror);
     });
   }
 

package/src/util/logger.ts

@@ -1,11 +1,11 @@
-import chalk from 'chalk';
-import logUpdate from 'log-update';
+import * as chalk from 'chalk';
+import * as logUpdate from 'log-update';
 
 /**
  * Logs messages to the console.
  */
 export class Logger {
-  static currentFrame = 0;
+  static currentFrame = -1;
 
   static frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
 
@@ -26,14 +26,14 @@ export class Logger {
    * @param message The error message to log.
    * @param args Optional arguments.
    */
-  public static error(message: unknown, ...args: string[]) {
+  public static error(message: string, ...args: string[]) {
     this.logSingle(message, false, 'red', false);
-    args.forEach(() => {
+    args.forEach((arg) => {
       this.logSingle(message, false, 'red', false);
     });
   }
 
-  public static logSingle(text: unknown, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
+  public static logSingle(text: string, showSpinner = true, color: 'green' | 'red' = 'green', overrideConsole = true) {
     if (this.currentFrame > 9) {
       this.currentFrame = 0;
     }

package/src/util/string-utils.ts

@@ -1,3 +1,7 @@
+export function truncate(str: string, n: number) {
+  return str.length > n ? str.substr(0, n - 1) + '…' : str;
+}
+
 export const camel2title = (camelCase: string) =>
   camelCase
     .replace(/\//g, ' ')

package/tsconfig.json

@@ -3,20 +3,15 @@
     "target": "es6",
     "module": "commonjs",
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "./lib",
     "strict": true,
     "sourceMap": true,
-    "esModuleInterop": true,
     "lib": [
       "ES2021"
-    ],
-    "baseUrl": "./",
-    "paths": {
-      "#utils/*": ["src/util/*"],
-    }
+    ]
   },
   "include": [
-    "src", "jest.d.ts"
+    "src"
   ],
   "exclude": [
     "node_modules",

package/.github/workflows/ci.yaml

@@ -1,22 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["master", "develop"]
-  pull_request:
-    branches: ["main", "develop"]
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-          cache: "npm"
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm test

package/__mocks__/chalk.js

@@ -1,12 +0,0 @@
-// __mocks__/chalk.js
-module.exports = new Proxy(
-  {},
-  {
-    get: function (target, property) {
-      return property === 'default' ? this : (text) => text;
-    },
-    green: function (text) {
-      return text;
-    },
-  },
-);

package/__mocks__/log-update.js

@@ -1,6 +0,0 @@
-// This is a basic mock that can be expanded based on your needs.
-// It mocks the main function of log-update to just log to console or do nothing.
-module.exports = {
-  // Mock the main function to just log the text or do nothing
-  default: function () {},
-};