@cparra/apexdocs 2.23.0 → 2.24.0

package/examples/force-app/main/default/restapi/SampleRestResource.cls

@@ -1,195 +1,195 @@
-/**
- * @description Account related operations
- */
-@RestResource(UrlMapping='/AccountService/*')
-global with sharing class SampleRestResource {
-    /**
-     * @description Sample HTTP Delete method with references to other types.
-     * @http-parameter
-     * name: limit
-     * in: header
-     * required: true
-     * description: My sample description.
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 200
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 500
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 304
-     * schema: ChildClass
-     * @http-response
-     * statusCode: 305
-     * schema: Reference1
-     * @http-response
-     * statusCode: 306
-     * schema: List<Reference1>
-     * @http-response
-     * statusCode: 307
-     * schema: Reference7[untypedObject:Reference2]
-     */
-    @HttpDelete
-    global static void doDelete() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
-        delete account;
-    }
-
-    /**
-     * @description This is a sample HTTP Get method
-     * @return An Account SObject.
-     * @http-parameter
-     * name: limit
-     * in: query
-     * required: true
-     * description: Limits the number of items on a page
-     * schema:
-     *   type: integer
-     * @http-parameter
-     * name: complex
-     * in: cookie
-     * description: A more complex schema
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 200
-     * schema:
-     *   type: object
-     *   properties:
-     *     id:
-     *       type: string
-     *       description: The super Id.
-     *     name:
-     *       type: string
-     *     phone:
-     *       type: string
-     *       format: byte
-     * @http-response
-     * statusCode: 500
-     * schema:
-     *   type: string
-     * @http-response
-     * statusCode: 304
-     * schema:
-     *   type: object
-     *   properties:
-     *     error:
-     *       type: string
-     * @http-response
-     * statusCode: 400
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 100
-     * schema:
-     *   type: object
-     *   properties:
-     *     anotherObject:
-     *       description: An object inside of an object
-     *       type: object
-     *       properties:
-     *         message:
-     *           type: string
-     *         somethingElse:
-     *           type: number
-     */
-    @HttpGet
-    global static Account doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
-        return result;
-    }
-
-    /**
-     * @summary Posts an Account 2
-     * @description This is a sample HTTP Post method
-     * @return A String SObject.
-     * @http-parameter
-     * name: limit
-     * in: query
-     * required: true
-     * description: Limits the number of items on a page
-     * schema:
-     *   type: integer
-     * @http-parameter
-     * name: complex
-     * in: cookie
-     * description: A more complex schema
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-request-body
-     * description: This is an example of a request body
-     * required: true
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 200
-     * schema:
-     *   type: object
-     *   properties:
-     *     id:
-     *       type: string
-     *       description: The super Id.
-     *     name:
-     *       type: string
-     *     phone:
-     *       type: string
-     *       format: byte
-     * @http-response
-     * statusCode: 500
-     * schema:
-     *   type: string
-     * @http-response
-     * statusCode: 304
-     * schema:
-     *   type: object
-     *   properties:
-     *     error:
-     *       type: string
-     * @http-response
-     * statusCode: 400
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     */
-    @HttpPost
-    global static String doPost(String name,
-        String phone, String website) {
-        Account account = new Account();
-        account.Name = name;
-        account.phone = phone;
-        account.website = website;
-        insert account;
-        return account.Id;
-    }
-}
+/**
+ * @description Account related operations
+ */
+@RestResource(UrlMapping='/AccountService/*')
+global with sharing class SampleRestResource {
+    /**
+     * @description Sample HTTP Delete method with references to other types.
+     * @http-parameter
+     * name: limit
+     * in: header
+     * required: true
+     * description: My sample description.
+     * schema: SampleClass
+     * @http-response
+     * statusCode: 200
+     * schema: SampleClass
+     * @http-response
+     * statusCode: 500
+     * schema: SampleClass
+     * @http-response
+     * statusCode: 304
+     * schema: ChildClass
+     * @http-response
+     * statusCode: 305
+     * schema: Reference1
+     * @http-response
+     * statusCode: 306
+     * schema: List<Reference1>
+     * @http-response
+     * statusCode: 307
+     * schema: Reference7[untypedObject:Reference2]
+     */
+    @HttpDelete
+    global static void doDelete() {
+        RestRequest req = RestContext.request;
+        RestResponse res = RestContext.response;
+        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
+        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
+        delete account;
+    }
+
+    /**
+     * @description This is a sample HTTP Get method
+     * @return An Account SObject.
+     * @http-parameter
+     * name: limit
+     * in: query
+     * required: true
+     * description: Limits the number of items on a page
+     * schema:
+     *   type: integer
+     * @http-parameter
+     * name: complex
+     * in: cookie
+     * description: A more complex schema
+     * schema:
+     *   type: array
+     *   items:
+     *     type: object
+     *     properties:
+     *       name:
+     *         type: string
+     * @http-response
+     * statusCode: 200
+     * schema:
+     *   type: object
+     *   properties:
+     *     id:
+     *       type: string
+     *       description: The super Id.
+     *     name:
+     *       type: string
+     *     phone:
+     *       type: string
+     *       format: byte
+     * @http-response
+     * statusCode: 500
+     * schema:
+     *   type: string
+     * @http-response
+     * statusCode: 304
+     * schema:
+     *   type: object
+     *   properties:
+     *     error:
+     *       type: string
+     * @http-response
+     * statusCode: 400
+     * schema:
+     *   type: array
+     *   items:
+     *     type: object
+     *     properties:
+     *       name:
+     *         type: string
+     * @http-response
+     * statusCode: 100
+     * schema:
+     *   type: object
+     *   properties:
+     *     anotherObject:
+     *       description: An object inside of an object
+     *       type: object
+     *       properties:
+     *         message:
+     *           type: string
+     *         somethingElse:
+     *           type: number
+     */
+    @HttpGet
+    global static Account doGet() {
+        RestRequest req = RestContext.request;
+        RestResponse res = RestContext.response;
+        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
+        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
+        return result;
+    }
+
+    /**
+     * @summary Posts an Account 2
+     * @description This is a sample HTTP Post method
+     * @return A String SObject.
+     * @http-parameter
+     * name: limit
+     * in: query
+     * required: true
+     * description: Limits the number of items on a page
+     * schema:
+     *   type: integer
+     * @http-parameter
+     * name: complex
+     * in: cookie
+     * description: A more complex schema
+     * schema:
+     *   type: array
+     *   items:
+     *     type: object
+     *     properties:
+     *       name:
+     *         type: string
+     * @http-request-body
+     * description: This is an example of a request body
+     * required: true
+     * schema:
+     *   type: array
+     *   items:
+     *     type: object
+     *     properties:
+     *       name:
+     *         type: string
+     * @http-response
+     * statusCode: 200
+     * schema:
+     *   type: object
+     *   properties:
+     *     id:
+     *       type: string
+     *       description: The super Id.
+     *     name:
+     *       type: string
+     *     phone:
+     *       type: string
+     *       format: byte
+     * @http-response
+     * statusCode: 500
+     * schema:
+     *   type: string
+     * @http-response
+     * statusCode: 304
+     * schema:
+     *   type: object
+     *   properties:
+     *     error:
+     *       type: string
+     * @http-response
+     * statusCode: 400
+     * schema:
+     *   type: array
+     *   items:
+     *     type: object
+     *     properties:
+     *       name:
+     *         type: string
+     */
+    @HttpPost
+    global static String doPost(String name,
+        String phone, String website) {
+        Account account = new Account();
+        account.Name = name;
+        account.phone = phone;
+        account.website = website;
+        insert account;
+        return account.Id;
+    }
+}

package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls

@@ -1,35 +1,35 @@
-/**
- * @description This rest resource should be skipped
- * @ignore
- */
-@RestResource(UrlMapping='/ResourceToSkip/*')
-global with sharing class SampleRestResourceToSkip {
-    @HttpDelete
-    global static void doDelete() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
-        delete account;
-    }
-
-    @HttpGet
-    global static Account doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
-        return result;
-    }
-
-    @HttpPost
-    global static String doPost(String name,
-        String phone, String website) {
-        Account account = new Account();
-        account.Name = name;
-        account.phone = phone;
-        account.website = website;
-        insert account;
-        return account.Id;
-    }
-}
+/**
+ * @description This rest resource should be skipped
+ * @ignore
+ */
+@RestResource(UrlMapping='/ResourceToSkip/*')
+global with sharing class SampleRestResourceToSkip {
+    @HttpDelete
+    global static void doDelete() {
+        RestRequest req = RestContext.request;
+        RestResponse res = RestContext.response;
+        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
+        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
+        delete account;
+    }
+
+    @HttpGet
+    global static Account doGet() {
+        RestRequest req = RestContext.request;
+        RestResponse res = RestContext.response;
+        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
+        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
+        return result;
+    }
+
+    @HttpPost
+    global static String doPost(String name,
+        String phone, String website) {
+        Account account = new Account();
+        account.Name = name;
+        account.phone = phone;
+        account.website = website;
+        insert account;
+        return account.Id;
+    }
+}

package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls

@@ -1,24 +1,24 @@
-/**
- * @description Contact related operations
- */
-@RestResource(urlMapping='/Contact/*')
-global with sharing class SampleRestResourceWithInnerClass {
-    /**
-     * @description This is a sample HTTP Get method
-     * @return A SampleRestResourceWithInnerClass.InnerClass Object.
-     * @http-response
-     * statusCode: 200
-     * schema: SampleRestResourceWithInnerClass.InnerClass
-     */
-    @HttpGet
-    global static InnerClass doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String contactId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        return new InnerClass();
-    }
-
-    global class InnerClass {
-        global String stringMember;
-    }
-}
+/**
+ * @description Contact related operations
+ */
+@RestResource(urlMapping='/Contact/*')
+global with sharing class SampleRestResourceWithInnerClass {
+    /**
+     * @description This is a sample HTTP Get method
+     * @return A SampleRestResourceWithInnerClass.InnerClass Object.
+     * @http-response
+     * statusCode: 200
+     * schema: SampleRestResourceWithInnerClass.InnerClass
+     */
+    @HttpGet
+    global static InnerClass doGet() {
+        RestRequest req = RestContext.request;
+        RestResponse res = RestContext.response;
+        String contactId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
+        return new InnerClass();
+    }
+
+    global class InnerClass {
+        global String stringMember;
+    }
+}

package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls

@@ -1,15 +1,15 @@
-/**
- * @description Order related operations
- */
-@RestResource(urlMapping='/Order/*')
-global with sharing class SampleRestResourceWithoutApexDocs {
-    @HttpGet
-    global static String doGet(String param1, Reference1 param2) {
-        return 'Hello World!';
-    }
-
-    @HttpPatch
-    global static String doPatch(String param1, Reference1 param2) {
-        return 'Hello World!';
-    }
-}
+/**
+ * @description Order related operations
+ */
+@RestResource(urlMapping='/Order/*')
+global with sharing class SampleRestResourceWithoutApexDocs {
+    @HttpGet
+    global static String doGet(String param1, Reference1 param2) {
+        return 'Hello World!';
+    }
+
+    @HttpPatch
+    global static String doPatch(String param1, Reference1 param2) {
+        return 'Hello World!';
+    }
+}

package/examples/force-app/main/default/restapi/references/Reference1.cls

@@ -1,9 +1,9 @@
-public class Reference1 {
-    /**
-     * @description This is a reference 2 member. Lorem.
-     */
-    public Reference2 reference2Member;
-    public Reference3 reference3Member;
-    public List<Reference4> reference4Collection;
-    public Reference5 reference5Member;
-}
+public class Reference1 {
+    /**
+     * @description This is a reference 2 member. Lorem.
+     */
+    public Reference2 reference2Member;
+    public Reference3 reference3Member;
+    public List<Reference4> reference4Collection;
+    public Reference5 reference5Member;
+}

package/examples/force-app/main/default/restapi/references/Reference2.cls

@@ -1,9 +1,9 @@
-public class Reference2 {
-    public String stringMember;
-
-    /**
-     * @description This is an object reference.
-     * @http-schema List<Reference3>
-     */
-    public Object objectReference;
-}
+public class Reference2 {
+    public String stringMember;
+
+    /**
+     * @description This is an object reference.
+     * @http-schema List<Reference3>
+     */
+    public Object objectReference;
+}

package/examples/force-app/main/default/restapi/references/Reference3.cls

@@ -1,3 +1,3 @@
-public class Reference3 {
-    public Boolean someBoolean;
-}
+public class Reference3 {
+    public Boolean someBoolean;
+}

package/examples/force-app/main/default/restapi/references/Reference4.cls

@@ -1,3 +1,3 @@
-public class Reference4 {
-    public String someString;
-}
+public class Reference4 {
+    public String someString;
+}

package/examples/force-app/main/default/restapi/references/Reference5.cls

@@ -1,3 +1,3 @@
-public class Reference5 {
-    public Reference6 reference6Member;
-}
+public class Reference5 {
+    public Reference6 reference6Member;
+}

package/examples/force-app/main/default/restapi/references/Reference6.cls

@@ -1,6 +1,6 @@
-public class Reference6 {
-    /**
-     * @description This is the grandchild description.
-     */
-    public String grandChildString;
-}
+public class Reference6 {
+    /**
+     * @description This is the grandchild description.
+     */
+    public String grandChildString;
+}

package/examples/force-app/main/default/restapi/references/Reference7.cls

@@ -1,3 +1,3 @@
-public class Reference7 {
-    public Object untypedObject;
-}
+public class Reference7 {
+    public Object untypedObject;
+}

package/examples/includes/header.md

@@ -1,3 +1,3 @@
-# Welcome to the Apex Docs documentation example.
-
-This content will be added to the top of the home page.
+# Welcome to the Apex Docs documentation example.
+
+This content will be added to the top of the home page.

package/jest.config.js

@@ -1,5 +1,5 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/lib/'],
-};
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['<rootDir>/lib/'],
+};

package/lib/application/Apexdocs.d.ts

@@ -1,13 +1,13 @@
-import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
-/**
- * Application entry-point to generate documentation out of Apex source files.
- */
-export declare class Apexdocs {
-    /**
-     * Generates documentation out of Apex source files.
-     */
-    static generate(): void;
-    private static filterByScopes;
-    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
-}
+import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+export declare class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate(): void;
+    private static filterByScopes;
+    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
+}