@cparra/apexdocs 2.25.0-alpha.2 → 2.25.0-alpha.4

package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md

@@ -0,0 +1,320 @@
+# Url Class
+
+Represents a uniform resource locator (URL) and provides access to parts of the URL. 
+
+Enables access to the base URL used to access your Salesforce org. 
+
+## Usage 
+
+Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, 
+
+logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create 
+
+a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: 
+
+```apex
+// Get a file uploaded through Chatter.
+ContentDocument doc = [SELECT Id FROM ContentDocument
+        WHERE Title = 'myfile'];
+// Create a link to the file.
+String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
+'/' + doc.id;
+system.debug(fullFileURL);
+```
+
+The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base 
+
+URL with the record ID. 
+
+```ape
+Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1];
+String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id;
+```
+
+## Example 
+
+In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL 
+
+pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example 
+
+prints out all the results to the debug log output. 
+
+```apex
+// Create a new account called Acme that we will create a link for later.
+Account myAccount = new Account(Name='Acme');
+insert myAccount;
+// Get the base URL.
+String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm();
+System.debug('Base URL: ' + sfdcBaseURL );
+// Get the URL for the current request.
+String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm();
+System.debug('Current request URL: ' + currentRequestURL);
+// Create the account URL from the base URL.
+String accountURL = URL.getOrgDomainURL().toExternalForm() +
+                       '/' + myAccount.Id;
+System.debug('URL of a particular account: ' + accountURL);
+// Get some parts of the base URL.
+System.debug('Host: ' + URL.getOrgDomainURL().getHost());
+System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol());
+// Get the query string of the current request.
+System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery());
+```
+
+## Version Behavior Changes 
+
+In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. 
+
+The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the 
+
+specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL 
+
+parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce 
+
+that inputs are valid, RFC-compliant URL or URI strings. 
+
+* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) 
+
+* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) 
+
+**See Also** 
+
+* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm)
+
+## Namespace
+ns
+
+## Constructors
+### `Url(spec)`
+
+Creates a new instance of the URL class using the specified string representation of the URL.
+
+#### Signature
+```apex
+global Url(String spec)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| spec | String | The string to parse as a URL. |
+
+---
+
+### `Url(context, spec)`
+
+Creates a new instance of the URL class by parsing the specified spec within the specified context.
+
+**Usage** 
+
+The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" : 
+
+```xml
+<scheme>://<authority><path>?<query>#<fragment>
+```
+
+For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java.
+
+#### Signature
+```apex
+global Url(Url context, String spec)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| context | [ns.Url](./ns.Url.md) | The context in which to parse the specification. |
+| spec | String | The string to parse as a URL. |
+
+---
+
+### `Url(protocol, host, file)`
+
+Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used.
+
+#### Signature
+```apex
+global Url(String protocol, String host, String file)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| protocol | String | The protocol name for this URL. |
+| host | String | The host name for this URL. |
+| file | String | The file name for this URL. |
+
+---
+
+### `Url(protocol, host, port, file)`
+
+Creates a new instance of the URL class using the specified protocol, host, port number, and file on the host.
+
+#### Signature
+```apex
+global Url(String protocol, String host, Integer port, String file)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| protocol | String | The protocol name for this URL. |
+| host | String | The host name for this URL. |
+| port | Integer | The port number for this URL. |
+| file | String | The file name for this URL. |
+
+## Methods
+### `getAuthority()`
+
+Returns the authority portion of the current URL.
+
+#### Signature
+```apex
+global String getAuthority()
+```
+
+#### Return Type
+**String**
+
+The authority portion of the current URL.
+
+---
+
+### `getCurrentRequestUrl()`
+
+Returns the URL of an entire request on a Salesforce instance.
+
+**Usage** 
+
+An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp.
+
+#### Signature
+```apex
+global static Url getCurrentRequestUrl()
+```
+
+#### Return Type
+**[ns.Url](./ns.Url.md)**
+
+The URL of the entire request.
+
+---
+
+### `getDefPort()`
+
+Returns the default port number of the protocol associated with the current URL.
+
+**Usage** 
+
+Returns -1 if the URL scheme or the stream protocol handler for the URL doesn&#x27;t define a default port number.
+
+#### Signature
+```apex
+global Integer getDefPort()
+```
+
+#### Return Type
+**Integer**
+
+The default port number of the protocol associated with the current URL.
+
+---
+
+### `getFile()`
+
+Returns the file name of the current URL.
+
+#### Signature
+```apex
+global String getFile()
+```
+
+#### Return Type
+**String**
+
+The file name of the current URL.
+
+---
+
+### `getFileFieldURL(entityId, fieldName)`
+
+Returns the download URL for a file attachment.
+
+#### Signature
+```apex
+global static String getFileFieldURL(String entityId, String fieldName)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| entityId | String | Specifies the ID of the entity that holds the file data. |
+| fieldName | String | Specifies the API name of a file field component, such as `AttachmentBody` . |
+
+#### Return Type
+**String**
+
+The download URL for the file attachment.
+
+#### Example
+```apex
+String fileURL =
+URL.getFileFieldURL(
+  '087000000000123' ,
+  'AttachmentBody');
+```
+
+---
+
+### `getHost()`
+
+Returns the host name of the current URL.
+
+#### Signature
+```apex
+global String getHost()
+```
+
+#### Return Type
+**String**
+
+The host name of the current URL.
+
+---
+
+### `getOrgDomainUrl()`
+
+Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com.
+
+**Usage** 
+
+Use getOrgDomainUrl() to interact with Salesforce REST and SOAP APIs in Apex code. Get endpoints for User Interface API calls, for creating and customizing picklist value sets and custom fields, and more. 
+
+ `getOrgDomainUrl()` can access the domain URL only for the org in which the Apex code is running. 
+
+You don&#x27;t need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method.
+
+**See Also** 
+
+* [Lightning Aura Components Developer Guide: Making API Calls from Apex](https://developer.salesforce.com/docs/atlas.en-us.250.0.lightning.meta/lightning/apex_api_calls.htm)
+
+#### Signature
+```apex
+global static Url getOrgDomainUrl()
+```
+
+#### Return Type
+**[ns.Url](./ns.Url.md)**
+
+getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org.
+
+#### Example
+```apex
+// This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide.
+Http h = new Http();
+HttpRequest req = new HttpRequest();
+req.setEndpoint(Url.getOrgDomainUrl().toExternalForm()
+   + '/services/data/v44.0/limits');
+req.setMethod('GET');
+req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId());
+HttpResponse res = h.send(req);
+```

package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md

@@ -6,7 +6,9 @@ This is a sample enum. This references [ns.ReferencedEnum](../Miscellaneous/ns.R
 
 This description has several lines
 
-**Some Custom** Test. I can also have a [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) here. 
+**Some Custom** 
+
+Test. I can also have a [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) here. 
 
 And it can be multiline.
 

package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md

@@ -31,7 +31,7 @@ This is a sample field.
 
 ##### Signature
 ```apex
-private name
+private final name
 ```
 
 ##### Type

package/examples/plain-markdown/docs/index.md

@@ -12,10 +12,94 @@
 
 ### [ns.SampleException](./Miscellaneous/ns.SampleException.md)
 
+This is a sample exception.
+
 ### [ns.SampleInterface](./Miscellaneous/ns.SampleInterface.md)
 
 This is a sample interface
 
+### [ns.Url](./Miscellaneous/ns.Url.md)
+
+Represents a uniform resource locator (URL) and provides access to parts of the URL. 
+
+Enables access to the base URL used to access your Salesforce org. 
+
+## Usage 
+
+Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, 
+
+logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create 
+
+a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: 
+
+```apex
+// Get a file uploaded through Chatter.
+ContentDocument doc = [SELECT Id FROM ContentDocument
+        WHERE Title = 'myfile'];
+// Create a link to the file.
+String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
+'/' + doc.id;
+system.debug(fullFileURL);
+```
+
+The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base 
+
+URL with the record ID. 
+
+```ape
+Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1];
+String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id;
+```
+
+## Example 
+
+In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL 
+
+pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example 
+
+prints out all the results to the debug log output. 
+
+```apex
+// Create a new account called Acme that we will create a link for later.
+Account myAccount = new Account(Name='Acme');
+insert myAccount;
+// Get the base URL.
+String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm();
+System.debug('Base URL: ' + sfdcBaseURL );
+// Get the URL for the current request.
+String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm();
+System.debug('Current request URL: ' + currentRequestURL);
+// Create the account URL from the base URL.
+String accountURL = URL.getOrgDomainURL().toExternalForm() +
+                       '/' + myAccount.Id;
+System.debug('URL of a particular account: ' + accountURL);
+// Get some parts of the base URL.
+System.debug('Host: ' + URL.getOrgDomainURL().getHost());
+System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol());
+// Get the query string of the current request.
+System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery());
+```
+
+## Version Behavior Changes 
+
+In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. 
+
+The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the 
+
+specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL 
+
+parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce 
+
+that inputs are valid, RFC-compliant URL or URI strings. 
+
+* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) 
+
+* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) 
+
+**See Also** 
+
+* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm)
+
 ## Sample Enums
 
 ### [ns.SampleEnum](./Sample-Enums/ns.SampleEnum.md)

package/examples/plain-markdown/force-app/classes/SampleException.cls

@@ -1 +1,17 @@
+/**
+ * @description This is a sample exception.
+ * @usage
+ *
+ * You can use the exception the following way.
+ * You can also take a look at {@link SampleClass} to see how it is used.
+ * This is a dangerous HTML tag: <script>alert('Hello');</script>
+ *
+ * ```
+ * try {
+ *    throw new SampleException();
+ * } catch (SampleException e) {
+ *   System.debug('Caught exception');
+ * }
+ * ```
+ */
 public class SampleException extends Exception {}

package/examples/plain-markdown/force-app/classes/Url.cls

@@ -0,0 +1,194 @@
+/**
+ * @description Represents a uniform resource locator (URL) and provides access to parts of the URL.
+ * Enables access to the base URL used to access your Salesforce org.
+ *
+ * ## Usage
+ * Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images,
+ * logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create
+ * a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID:
+ *
+ * ```apex
+ * // Get a file uploaded through Chatter.
+ * ContentDocument doc = [SELECT Id FROM ContentDocument
+ *         WHERE Title = 'myfile'];
+ * // Create a link to the file.
+ * String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
+ * '/' + doc.id;
+ * system.debug(fullFileURL);
+ * ```
+ *
+ * The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base
+ * URL with the record ID.
+ *
+ * ```ape
+ * Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1];
+ * String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id;
+ * ```
+ *
+ * ## Example
+ * In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL
+ * pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example
+ * prints out all the results to the debug log output.
+ *
+ * ```apex
+ * // Create a new account called Acme that we will create a link for later.
+ * Account myAccount = new Account(Name='Acme');
+ * insert myAccount;
+ *
+ * // Get the base URL.
+ * String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm();
+ * System.debug('Base URL: ' + sfdcBaseURL );
+ *
+ * // Get the URL for the current request.
+ * String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm();
+ * System.debug('Current request URL: ' + currentRequestURL);
+ *
+ * // Create the account URL from the base URL.
+ * String accountURL = URL.getOrgDomainURL().toExternalForm() +
+ *                        '/' + myAccount.Id;
+ * System.debug('URL of a particular account: ' + accountURL);
+ *
+ * // Get some parts of the base URL.
+ * System.debug('Host: ' + URL.getOrgDomainURL().getHost());
+ * System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol());
+ *
+ * // Get the query string of the current request.
+ * System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery());
+ * ```
+ *
+ * ## Version Behavior Changes
+ * In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type.
+ * The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the
+ * specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL
+ * parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce
+ * that inputs are valid, RFC-compliant URL or URI strings.
+ *
+ * * [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors)
+ * * [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods)
+ *
+ * **See Also**
+ * * [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm)
+ */
+global class Url {
+    /**
+     * @description Creates a new instance of the URL class using the specified string representation of the URL.
+     * @param spec The string to parse as a URL.
+     */
+    global Url(String spec) { }
+
+    /**
+     * @description Creates a new instance of the URL class by parsing the specified spec within the specified context.
+     * @param context The context in which to parse the specification.
+     * @param spec The string to parse as a URL.
+     *
+     * @usage
+     * The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :
+     * ```xml
+     * <scheme>://<authority><path>?<query>#<fragment>
+     * ```
+     *
+     * For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java.
+     */
+    global Url(Url context, String spec) { }
+
+    /**
+     * @description Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used.
+     * @param protocol The protocol name for this URL.
+     * @param host The host name for this URL.
+     * @param file The file name for this URL.
+     */
+    global Url(String protocol, String host, String file) {}
+
+    /**
+     * @description Creates a new instance of the URL class using the specified protocol, host, port number, and file on the host.
+     * @param protocol The protocol name for this URL.
+     * @param host The host name for this URL.
+     * @param port The port number for this URL.
+     * @param file The file name for this URL.
+     */
+    global Url(String protocol, String host, Integer port, String file) {}
+
+    /**
+     * @description Returns the authority portion of the current URL.
+     * @return The authority portion of the current URL.
+     */
+    global String getAuthority() {
+        return null;
+    }
+
+    /**
+     * @description Returns the URL of an entire request on a Salesforce instance.
+     * @return The URL of the entire request.
+     * @usage An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp.
+     */
+    global static Url getCurrentRequestUrl() {
+        return null;
+    }
+
+    /**
+     * @description Returns the default port number of the protocol associated with the current URL.
+     * @return The default port number of the protocol associated with the current URL.
+     * @usage Returns -1 if the URL scheme or the stream protocol handler for the URL doesn't define a default port number.
+     */
+    global Integer getDefPort() {
+        return null;
+    }
+
+    /**
+     * @description Returns the file name of the current URL.
+     * @return The file name of the current URL.
+     */
+    global String getFile() {
+        return null;
+    }
+
+    /**
+     * @description Returns the download URL for a file attachment.
+     * @param entityId Specifies the ID of the entity that holds the file data.
+     * @param fieldName Specifies the API name of a file field component, such as `AttachmentBody`.
+     * @return The download URL for the file attachment.
+     * @example
+     * String fileURL =
+     * URL.getFileFieldURL(
+     *   '087000000000123' ,
+     *   'AttachmentBody');
+     */
+    global static String getFileFieldURL(String entityId, String fieldName) {
+        return null;
+    }
+
+    /**
+     * @description Returns the host name of the current URL.
+     * @return The host name of the current URL.
+     */
+    global String getHost() {
+        return null;
+    }
+
+    /**
+     * @description Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com.
+     * @return getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org.
+     * @usage
+     * Use getOrgDomainUrl() to interact with Salesforce REST and SOAP APIs in Apex code. Get endpoints for User Interface API calls, for creating and customizing picklist value sets and custom fields, and more.
+     *
+     * `getOrgDomainUrl()` can access the domain URL only for the org in which the Apex code is running.
+     *
+     * You don't need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method.
+     *
+     * @example
+     * // This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide.
+     * Http h = new Http();
+     * HttpRequest req = new HttpRequest();
+     * req.setEndpoint(Url.getOrgDomainUrl().toExternalForm()
+     *    + '/services/data/v44.0/limits');
+     * req.setMethod('GET');
+     * req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId());
+     * HttpResponse res = h.send(req);
+     *
+     * @see-also
+     * * [Lightning Aura Components Developer Guide: Making API Calls from Apex](https://developer.salesforce.com/docs/atlas.en-us.250.0.lightning.meta/lightning/apex_api_calls.htm)
+     */
+    global static Url getOrgDomainUrl() {
+        return null;
+    }
+}

package/examples/plain-markdown/package.json

@@ -15,6 +15,7 @@
     "sourceDir": "force-app",
     "targetGenerator": "plain-markdown",
     "scope": ["global", "public", "protected", "private", "namespaceaccessible"],
-    "namespace": "ns"
+    "namespace": "ns",
+    "sanitizeHtml": true
   }
 }

package/jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/lib/'],
+  modulePathIgnorePatterns: ['<rootDir>/dist/'],
   moduleNameMapper: {
     '^chalk$': '<rootDir>/__mocks__/chalk.js',
     '^log-update$': '<rootDir>/__mocks__/log-update.js',