@cparra/apexdocs 2.23.0 → 2.24.0

package/lib/model/openapi/apex-doc-types.js

@@ -1,5 +1,5 @@
-"use strict";
-// These are types that represent how the data is expected to be created in the ApexDoc (as YAML), which
-// in some cases might be different from the official OpenApi spec for simplicity when writing the ApexDoc.
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+// These are types that represent how the data is expected to be created in the ApexDoc (as YAML), which
+// in some cases might be different from the official OpenApi spec for simplicity when writing the ApexDoc.
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=apex-doc-types.js.map

package/lib/model/openapi/open-api-types.d.ts

@@ -1,93 +1,93 @@
-export type InfoObject = {
-    title: string;
-    version: string;
-};
-export type ServerObject = {
-    url: string;
-};
-export type PathsObject = {
-    [index: string]: PathItemObject;
-};
-export type PathItemObject = {
-    description?: string;
-    get?: OperationObject;
-    put?: OperationObject;
-    post?: OperationObject;
-    delete?: OperationObject;
-    patch?: OperationObject;
-};
-export type OperationObject = {
-    tags?: string[];
-    description?: string;
-    summary?: string;
-    requestBody?: RequestBody;
-    parameters?: ParameterObject[];
-    responses?: ResponsesObject;
-};
-export type ParameterObject = {
-    name: string;
-    in: 'query' | 'header' | 'path' | 'cookie';
-    description?: string;
-    required?: boolean;
-    schema?: SchemaObject;
-};
-export type RequestBody = {
-    description?: string;
-    content: RequestBodyContent;
-    required?: boolean;
-};
-export type RequestBodyContent = {
-    [index: string]: MediaTypeObject;
-};
-export type MediaTypeObject = {
-    schema?: SchemaObject;
-    example?: any;
-    examples?: {
-        [index: string]: ExampleObject;
-    };
-};
-export type ExampleObject = {
-    summary?: string;
-    description?: string;
-    value?: any;
-};
-export type ResponsesObject = {
-    [index: string]: ResponseObject;
-};
-export type ResponseObject = {
-    description: string;
-    content?: ContentObject;
-};
-export type ContentObject = {
-    [index: string]: {
-        schema: SchemaObject;
-    };
-};
-export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
-export type SchemaObjectObject = {
-    type: string;
-    properties?: PropertiesObject;
-    format?: string;
-    description?: string;
-};
-export type PropertiesObject = {
-    [index: string]: SchemaObject;
-};
-export type SchemaObjectArray = {
-    type: 'array';
-    items: SchemaObject;
-    description?: string;
-};
-export type ReferenceObject = {
-    $ref: string;
-    description?: string;
-};
-export type ComponentsObject = {
-    schemas: {
-        [index: string]: SchemaObject;
-    };
-};
-export type TagObject = {
-    name: string;
-    description?: string;
-};
+export type InfoObject = {
+    title: string;
+    version: string;
+};
+export type ServerObject = {
+    url: string;
+};
+export type PathsObject = {
+    [index: string]: PathItemObject;
+};
+export type PathItemObject = {
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    patch?: OperationObject;
+};
+export type OperationObject = {
+    tags?: string[];
+    description?: string;
+    summary?: string;
+    requestBody?: RequestBody;
+    parameters?: ParameterObject[];
+    responses?: ResponsesObject;
+};
+export type ParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema?: SchemaObject;
+};
+export type RequestBody = {
+    description?: string;
+    content: RequestBodyContent;
+    required?: boolean;
+};
+export type RequestBodyContent = {
+    [index: string]: MediaTypeObject;
+};
+export type MediaTypeObject = {
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [index: string]: ExampleObject;
+    };
+};
+export type ExampleObject = {
+    summary?: string;
+    description?: string;
+    value?: any;
+};
+export type ResponsesObject = {
+    [index: string]: ResponseObject;
+};
+export type ResponseObject = {
+    description: string;
+    content?: ContentObject;
+};
+export type ContentObject = {
+    [index: string]: {
+        schema: SchemaObject;
+    };
+};
+export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
+export type SchemaObjectObject = {
+    type: string;
+    properties?: PropertiesObject;
+    format?: string;
+    description?: string;
+};
+export type PropertiesObject = {
+    [index: string]: SchemaObject;
+};
+export type SchemaObjectArray = {
+    type: 'array';
+    items: SchemaObject;
+    description?: string;
+};
+export type ReferenceObject = {
+    $ref: string;
+    description?: string;
+};
+export type ComponentsObject = {
+    schemas: {
+        [index: string]: SchemaObject;
+    };
+};
+export type TagObject = {
+    name: string;
+    description?: string;
+};

package/lib/model/openapi/open-api-types.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=open-api-types.js.map

package/lib/model/openapi/open-api.d.ts

@@ -1,16 +1,16 @@
-import { ComponentsObject, InfoObject, PathsObject, ServerObject, TagObject } from './open-api-types';
-/**
- * Represents the OpenApi 3.1.0 spec
- * https://spec.openapis.org/oas/v3.1.0
- */
-export declare class OpenApi {
-    private namespace?;
-    openapi: string;
-    info: InfoObject;
-    tags: TagObject[];
-    paths: PathsObject;
-    servers: ServerObject[];
-    components?: ComponentsObject;
-    constructor(title: string, version: string, namespace?: string | undefined);
-    private getServerUrl;
-}
+import { ComponentsObject, InfoObject, PathsObject, ServerObject, TagObject } from './open-api-types';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+export declare class OpenApi {
+    private namespace?;
+    openapi: string;
+    info: InfoObject;
+    tags: TagObject[];
+    paths: PathsObject;
+    servers: ServerObject[];
+    components?: ComponentsObject;
+    constructor(title: string, version: string, namespace?: string | undefined);
+    private getServerUrl;
+}

package/lib/model/openapi/open-api.js

@@ -1,34 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenApi = void 0;
-const OPEN_API_VERSION = '3.1.0';
-const SERVER_URL = '/services/apexrest/';
-/**
- * Represents the OpenApi 3.1.0 spec
- * https://spec.openapis.org/oas/v3.1.0
- */
-class OpenApi {
-    constructor(title, version, namespace) {
-        this.namespace = namespace;
-        this.openapi = OPEN_API_VERSION;
-        this.info = {
-            title: title,
-            version: version,
-        };
-        this.servers = [
-            {
-                url: this.getServerUrl(),
-            },
-        ];
-        this.paths = {};
-        this.tags = [];
-    }
-    getServerUrl() {
-        if (!this.namespace) {
-            return SERVER_URL;
-        }
-        return `${SERVER_URL}${this.namespace}/`;
-    }
-}
-exports.OpenApi = OpenApi;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApi = void 0;
+const OPEN_API_VERSION = '3.1.0';
+const SERVER_URL = '/services/apexrest/';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+class OpenApi {
+    constructor(title, version, namespace) {
+        this.namespace = namespace;
+        this.openapi = OPEN_API_VERSION;
+        this.info = {
+            title: title,
+            version: version,
+        };
+        this.servers = [
+            {
+                url: this.getServerUrl(),
+            },
+        ];
+        this.paths = {};
+        this.tags = [];
+    }
+    getServerUrl() {
+        if (!this.namespace) {
+            return SERVER_URL;
+        }
+        return `${SERVER_URL}${this.namespace}/`;
+    }
+}
+exports.OpenApi = OpenApi;
 //# sourceMappingURL=open-api.js.map

package/lib/model/openapi/openapi-type-file.d.ts

@@ -1,7 +1,7 @@
-import { OutputFile } from '../outputFile';
-import { OpenApi } from './open-api';
-export declare class OpenapiTypeFile extends OutputFile {
-    openApiModel: OpenApi;
-    constructor(openApiModel: OpenApi);
-    fileExtension(): string;
-}
+import { OutputFile } from '../outputFile';
+import { OpenApi } from './open-api';
+export declare class OpenapiTypeFile extends OutputFile {
+    openApiModel: OpenApi;
+    constructor(openApiModel: OpenApi);
+    fileExtension(): string;
+}

package/lib/model/openapi/openapi-type-file.js

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenapiTypeFile = void 0;
-const outputFile_1 = require("../outputFile");
-const settings_1 = require("../../settings");
-class OpenapiTypeFile extends outputFile_1.OutputFile {
-    constructor(openApiModel) {
-        super(settings_1.Settings.getInstance().openApiFileName(), '');
-        this.openApiModel = openApiModel;
-        this.addText(JSON.stringify(Object.assign(Object.assign({}, openApiModel), { namespace: undefined }), null, 2));
-    }
-    fileExtension() {
-        return '.json';
-    }
-}
-exports.OpenapiTypeFile = OpenapiTypeFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenapiTypeFile = void 0;
+const outputFile_1 = require("../outputFile");
+const settings_1 = require("../../settings");
+class OpenapiTypeFile extends outputFile_1.OutputFile {
+    constructor(openApiModel) {
+        super(settings_1.Settings.getInstance().openApiFileName(), '');
+        this.openApiModel = openApiModel;
+        this.addText(JSON.stringify(Object.assign(Object.assign({}, openApiModel), { namespace: undefined }), null, 2));
+    }
+    fileExtension() {
+        return '.json';
+    }
+}
+exports.OpenapiTypeFile = OpenapiTypeFile;
 //# sourceMappingURL=openapi-type-file.js.map

package/lib/model/outputFile.d.ts

@@ -1,10 +1,10 @@
-export declare abstract class OutputFile {
-    fileName: string;
-    dir: string;
-    _contents: string;
-    constructor(fileName: string, dir: string);
-    abstract fileExtension(): string;
-    get body(): string;
-    addText(text: string, encodeHtml?: boolean): void;
-    addBlankLine(): void;
-}
+export declare abstract class OutputFile {
+    fileName: string;
+    dir: string;
+    _contents: string;
+    constructor(fileName: string, dir: string);
+    abstract fileExtension(): string;
+    get body(): string;
+    addText(text: string, encodeHtml?: boolean): void;
+    addBlankLine(): void;
+}

package/lib/model/outputFile.js

@@ -1,29 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutputFile = void 0;
-const xss = require("xss");
-const settings_1 = require("../settings");
-const xssFilter = new xss.FilterXSS({
-    whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
-});
-class OutputFile {
-    constructor(fileName, dir) {
-        this.fileName = fileName;
-        this.dir = dir;
-        this._contents = '';
-    }
-    get body() {
-        return this._contents;
-    }
-    addText(text, encodeHtml = true) {
-        const shouldEncode = encodeHtml && settings_1.Settings.getInstance().sanitizeHtml;
-        const textToAdd = shouldEncode ? xssFilter.process(text) : text;
-        this._contents += textToAdd;
-        this.addBlankLine();
-    }
-    addBlankLine() {
-        this._contents += '\n';
-    }
-}
-exports.OutputFile = OutputFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutputFile = void 0;
+const xss = require("xss");
+const settings_1 = require("../settings");
+const xssFilter = new xss.FilterXSS({
+    whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
+});
+class OutputFile {
+    constructor(fileName, dir) {
+        this.fileName = fileName;
+        this.dir = dir;
+        this._contents = '';
+    }
+    get body() {
+        return this._contents;
+    }
+    addText(text, encodeHtml = true) {
+        const shouldEncode = encodeHtml && settings_1.Settings.getInstance().sanitizeHtml;
+        const textToAdd = shouldEncode ? xssFilter.process(text) : text;
+        this._contents += textToAdd;
+        this.addBlankLine();
+    }
+    addBlankLine() {
+        this._contents += '\n';
+    }
+}
+exports.OutputFile = OutputFile;
 //# sourceMappingURL=outputFile.js.map

package/lib/model/types-repository.d.ts

@@ -1,16 +1,16 @@
-import { Type } from '@cparra/apex-reflection';
-export type TypeBundle = {
-    type: Type;
-    isChild: boolean;
-    parentType?: Type;
-};
-export declare class TypesRepository {
-    private static instance;
-    private scopedTypes;
-    private allTypes;
-    static getInstance(): TypesRepository;
-    populateAll(types: Type[]): void;
-    getFromAllByName(typeName: string): TypeBundle | undefined;
-    populateScoped(types: Type[]): void;
-    getFromScopedByName(typeName: string): Type | undefined;
-}
+import { Type } from '@cparra/apex-reflection';
+export type TypeBundle = {
+    type: Type;
+    isChild: boolean;
+    parentType?: Type;
+};
+export declare class TypesRepository {
+    private static instance;
+    private scopedTypes;
+    private allTypes;
+    static getInstance(): TypesRepository;
+    populateAll(types: Type[]): void;
+    getFromAllByName(typeName: string): TypeBundle | undefined;
+    populateScoped(types: Type[]): void;
+    getFromScopedByName(typeName: string): Type | undefined;
+}

package/lib/model/types-repository.js

@@ -1,54 +1,54 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypesRepository = void 0;
-class TypesRepository {
-    constructor() {
-        this.scopedTypes = [];
-        this.allTypes = [];
-    }
-    static getInstance() {
-        if (!TypesRepository.instance) {
-            TypesRepository.instance = new TypesRepository();
-        }
-        return TypesRepository.instance;
-    }
-    populateAll(types) {
-        this.allTypes = types;
-    }
-    getFromAllByName(typeName) {
-        if (typeName.includes('.')) {
-            // If it includes a dot we are assuming we are dealing with an inner class.
-            const [parentTypeName, childTypeName] = typeName.split('.');
-            const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
-            if (!parentReference || parentReference.type_name !== 'class') {
-                // If the parent is not found, no reason to keep searching, instead we return undefined.
-                // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
-                return undefined;
-            }
-            const parentReferenceAsClass = parentReference;
-            const childTypes = [
-                ...parentReferenceAsClass.classes,
-                ...parentReferenceAsClass.interfaces,
-                ...parentReferenceAsClass.enums,
-            ];
-            const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
-            if (!foundType) {
-                return undefined;
-            }
-            return { type: foundType, isChild: true, parentType: parentReference };
-        }
-        const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
-        if (!foundType) {
-            return undefined;
-        }
-        return { type: foundType, isChild: false };
-    }
-    populateScoped(types) {
-        this.scopedTypes = types;
-    }
-    getFromScopedByName(typeName) {
-        return this.scopedTypes.find((currentType) => currentType.name === typeName);
-    }
-}
-exports.TypesRepository = TypesRepository;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesRepository = void 0;
+class TypesRepository {
+    constructor() {
+        this.scopedTypes = [];
+        this.allTypes = [];
+    }
+    static getInstance() {
+        if (!TypesRepository.instance) {
+            TypesRepository.instance = new TypesRepository();
+        }
+        return TypesRepository.instance;
+    }
+    populateAll(types) {
+        this.allTypes = types;
+    }
+    getFromAllByName(typeName) {
+        if (typeName.includes('.')) {
+            // If it includes a dot we are assuming we are dealing with an inner class.
+            const [parentTypeName, childTypeName] = typeName.split('.');
+            const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
+            if (!parentReference || parentReference.type_name !== 'class') {
+                // If the parent is not found, no reason to keep searching, instead we return undefined.
+                // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
+                return undefined;
+            }
+            const parentReferenceAsClass = parentReference;
+            const childTypes = [
+                ...parentReferenceAsClass.classes,
+                ...parentReferenceAsClass.interfaces,
+                ...parentReferenceAsClass.enums,
+            ];
+            const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
+            if (!foundType) {
+                return undefined;
+            }
+            return { type: foundType, isChild: true, parentType: parentReference };
+        }
+        const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
+        if (!foundType) {
+            return undefined;
+        }
+        return { type: foundType, isChild: false };
+    }
+    populateScoped(types) {
+        this.scopedTypes = types;
+    }
+    getFromScopedByName(typeName) {
+        return this.scopedTypes.find((currentType) => currentType.name === typeName);
+    }
+}
+exports.TypesRepository = TypesRepository;
 //# sourceMappingURL=types-repository.js.map

package/lib/service/apex-file-reader.d.ts

@@ -1,14 +1,14 @@
-import { FileSystem } from './file-system';
-import ApexBundle from '../model/apex-bundle';
-/**
- * Reads from .cls files and returns their raw body.
- */
-export declare class ApexFileReader {
-    /**
-     * Reads from .cls files and returns their raw body.
-     */
-    static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
-    private static isApexFile;
-    private static get sourceDirectory();
-    private static get readRecursively();
-}
+import { FileSystem } from './file-system';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Reads from .cls files and returns their raw body.
+ */
+export declare class ApexFileReader {
+    /**
+     * Reads from .cls files and returns their raw body.
+     */
+    static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
+    private static isApexFile;
+    private static get sourceDirectory();
+    private static get readRecursively();
+}