From 1be71cccc7da95536a6382c3d4184602c66d92b2 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 3 Oct 2023 16:25:55 -0700 Subject: [PATCH 01/21] introducing Tuple Signed-off-by: kpoorman --- .../default/classes/Data Structures/Tuple.cls | 86 +++++++++++++++++++ .../Data Structures/Tuple.cls-meta.xml | 5 ++ 2 files changed, 91 insertions(+) create mode 100644 force-app/main/default/classes/Data Structures/Tuple.cls create mode 100644 force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/Data Structures/Tuple.cls new file mode 100644 index 00000000..bcea2c07 --- /dev/null +++ b/force-app/main/default/classes/Data Structures/Tuple.cls @@ -0,0 +1,86 @@ +/** + * @description Tuple represents a key-value pair. Kinda. Don't come at me math nerds. + * + * You may be asking why this exists, given the existence of Map. Unfortuately Map isn't available everywhere. + * Notably, it's not available in Apex-defined Data Types used by Flow/Invocable actions. + * + * Additionally, `Object` is not a valid data type in Apex-defined Data Types, so we can't use a list of objects + * that have a string key, and Object value. This is the next best thing. A kind of polyfill for Map + * for use in Apex-defined Data Types. + * + * @see https ://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 + * Available primitive datatypes available for use in tupple: + * Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. + */ +public with sharing class Tuple { + /** + * @description This is an 'Apex Defined Type'. According to the documentation, the following types are supported: + * Boolean, Date, DateTime, Double, Decimal, Integer, Long, and String + * https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 + */ + + @AuraEnabled + @InvocableVariable + public Boolean[] booleans; + @AuraEnabled + @InvocableVariable + public Boolean booleanValue; + @AuraEnabled + @InvocableVariable + public Date dateValue; + @AuraEnabled + @InvocableVariable + public Date[] dates; + @AuraEnabled + @InvocableVariable + public Datetime[] datetimes; + @AuraEnabled + @InvocableVariable + public Datetime dateTimeValue; + @AuraEnabled + @InvocableVariable + public Double doubleValue; + @AuraEnabled + @InvocableVariable + public Double[] doubles; + @AuraEnabled + @InvocableVariable + public Decimal decimalValue; + @AuraEnabled + @InvocableVariable + public Decimal[] decimals; + @AuraEnabled + @InvocableVariable + public Integer integerValue; + @AuraEnabled + @InvocableVariable + public Integer[] integers; + @AuraEnabled + @InvocableVariable + public Long longValue; + @AuraEnabled + @InvocableVariable + public Long[] longs; + @AuraEnabled + @InvocableVariable + public String stringValue; + @AuraEnabled + @InvocableVariable + public String[] strings; + @AuraEnabled + @InvocableVariable + public SObject sobjectValue; + @AuraEnabled + @InvocableVariable + public SObject[] sobjects; + + /** + * @description In order to create a Tuple instance from within a flow, you need a no-arg constructor. + */ + @SuppressWarnings('PMD.EmptyStatementBlock') + public Tuple() { + } + + public Tuple(String key, Object value) { + } +} diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml b/force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml new file mode 100644 index 00000000..7a518297 --- /dev/null +++ b/force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml @@ -0,0 +1,5 @@ + + + 58.0 + Active + From c00518b2856e8c4ae4c54184954a569db6d4ab13 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 17 Oct 2023 17:57:27 -0700 Subject: [PATCH 02/21] Feat(Tuple): Introducing Tuple A generic Apex Defined Type for use in flows. Contains primitive @auraEnabled, @invocableVariable variables of every available type, as well as sObject and list and logic to auto cast the incoming Object value to the correct primitive type. Signed-off-by: kpoorman --- docs/Tuple.md | 138 ++++++++++++++++++ docs/home.md | 8 + .../default/classes/Data Structures/Tuple.cls | 84 ++++++++++- 3 files changed, 224 insertions(+), 6 deletions(-) create mode 100644 docs/Tuple.md diff --git a/docs/Tuple.md b/docs/Tuple.md new file mode 100644 index 00000000..c99d6633 --- /dev/null +++ b/docs/Tuple.md @@ -0,0 +1,138 @@ +`STATUS: ACTIVE` + +Tuple represents a key-value pair. Kinda. Don't come at me math nerds. +You may be asking why this exists, given the existence of Map. Unfortuately Map isn't available everywhere. +Notably, it's not available in Apex-defined Data Types used by Flow/Invocable actions. +Additionally, `Object` is not a valid data type in Apex-defined Data Types, so we can't use a list of objects +that have a string key, and Object value. This is the next best thing. A kind of polyfill for Map<String,Object> +for use in Apex-defined Data Types. +See also: https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 +Available primitive datatypes available for use in tupple: +Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. + +## Constructors + +### `public Tuple()` + +`SUPPRESSWARNINGS` + +In order to create a Tuple instance from within a flow, you need a no-arg constructor. + +### `public Tuple(String key, Object value)` + +--- + +## Fields + +### `public booleanValue` → `Boolean` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public booleans` → `Boolean` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public dateTimeValue` → `Datetime` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public dateValue` → `Date` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public dates` → `Date` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public datetimes` → `Datetime` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public decimalValue` → `Decimal` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public decimals` → `Decimal` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public doubleValue` → `Double` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public doubles` → `Double` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public integerValue` → `Integer` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public integers` → `Integer` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public key` → `String` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public longValue` → `Long` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public longs` → `Long` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public sobjectValue` → `SObject` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public sobjects` → `SObject` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public stringValue` → `String` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +### `public strings` → `String` + +`AURAENABLED` +`INVOCABLEVARIABLE` + +--- + +## Methods + +### `private void determineTypeAndSetCastedValue(Object value)` + +--- + +## Classes + +### TupleException + +**Inheritance** + +TupleException + +--- diff --git a/docs/home.md b/docs/home.md index 16f7c484..0a45fb65 100644 --- a/docs/home.md +++ b/docs/home.md @@ -349,6 +349,14 @@ inner class for managing the loop count per handler ### [TriggerFrameworkTests](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/TriggerFrameworkTests) +### [Tuple](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/Tuple) + +Tuple represents a key-value pair. Kinda. Don't come at me math nerds. +You may be asking why this exists, given the existence of Map. Unfortuately Map isn't available everywhere. +Notably, it's not available in Apex-defined Data Types used by Flow/Invocable actions. +Additionally, `Object` is not a v… + + ### [UFInvocable](https://github.com/codefriar/ApexKit/wiki/Miscellaneous/UFInvocable) This provides a common interface for classes & methods developers want to expose to flow. diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/Data Structures/Tuple.cls index bcea2c07..763459b2 100644 --- a/force-app/main/default/classes/Data Structures/Tuple.cls +++ b/force-app/main/default/classes/Data Structures/Tuple.cls @@ -8,16 +8,14 @@ * that have a string key, and Object value. This is the next best thing. A kind of polyfill for Map * for use in Apex-defined Data Types. * - * @see https ://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 + * See also: https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 * Available primitive datatypes available for use in tupple: * Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. */ public with sharing class Tuple { - /** - * @description This is an 'Apex Defined Type'. According to the documentation, the following types are supported: - * Boolean, Date, DateTime, Double, Decimal, Integer, Long, and String - * https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 - */ + @AuraEnabled + @InvocableVariable + public String key; @AuraEnabled @InvocableVariable @@ -82,5 +80,79 @@ public with sharing class Tuple { } public Tuple(String key, Object value) { + this.key = key; + determineTypeAndSetCastedValue(value); + } + + private void determineTypeAndSetCastedValue(Object value) { + String backingClassName = Polyfills.classNameFromInstance(value) + .toLowerCase(); + switch on backingClassName { + when 'boolean' { + this.booleanValue = (Boolean) value; + } + when 'list' { + this.booleans = (List) value; + } + when 'datetime' { + this.dateTimeValue = (Datetime) value; + } + when 'list' { + this.datetimes = (List) value; + } + when 'date' { + this.dateValue = (Date) value; + } + when 'list' { + this.dateValue = (Date) value; + } + when 'long' { + this.longValue = (Long) value; + } + when 'list' { + this.longs = (List) value; + } + when 'integer' { + this.integerValue = (Integer) value; + } + when 'list' { + this.integers = (List) value; + } + when 'decimal' { + this.decimalValue = (Decimal) value; + } + when 'list' { + this.decimals = (List) value; + } + when 'double' { + this.doubleValue = (Double) value; + } + when 'list' { + this.doubles = (List) value; + } + when 'string' { + this.stringValue = (String) value; + } + when 'list' { + this.strings = (List) value; + } + when else { + try { + this.sobjects = (value instanceof List) + ? (List) value + : null; + this.sobjectValue = (value instanceof SObject) + ? (SObject) value + : null; + } catch (TypeException e) { + throw new TupleException( + 'Unsupported data type: ' + backingClassName + ); + } + } + } + } + + public class TupleException extends Exception { } } From 96372afdbdfcb6bc05c833da71decdba64f31985 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 17 Oct 2023 20:01:00 -0700 Subject: [PATCH 03/21] fix(Tuple.cls): Adding doc blocks Signed-off-by: kpoorman --- docs/Tuple.md | 22 ++++++++++++- .../default/classes/Data Structures/Tuple.cls | 33 +++++++++++++------ 2 files changed, 44 insertions(+), 11 deletions(-) diff --git a/docs/Tuple.md b/docs/Tuple.md index c99d6633..22fa3902 100644 --- a/docs/Tuple.md +++ b/docs/Tuple.md @@ -7,7 +7,7 @@ Additionally, `Object` is not a valid data type in Apex-defined Data Types, so w that have a string key, and Object value. This is the next best thing. A kind of polyfill for Map<String,Object> for use in Apex-defined Data Types. See also: https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 -Available primitive datatypes available for use in tupple: +Available primitive datatypes available for use in tuple: Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. ## Constructors @@ -20,6 +20,15 @@ In order to create a Tuple instance from within a flow, you need a no-arg constr ### `public Tuple(String key, Object value)` +standard constructor accepting a key and value + +#### Parameters + +| Param | Description | +| ------- | ----------------------------------- | +| `key` | String the name of the Tuple's Key. | +| `value` | Object the Tuple's Value. | + --- ## Fields @@ -125,12 +134,23 @@ In order to create a Tuple instance from within a flow, you need a no-arg constr ### `private void determineTypeAndSetCastedValue(Object value)` +Method is responsible for determining the type of the value and setting the appropriate field. + +#### Parameters + +| Param | Description | +| ------- | ------------------------- | +| `value` | Object the Tuple's Value. | + --- ## Classes ### TupleException +A custom Exception type thrown when the incoming Object is not a recognized Apex-defined-type safe +type. + **Inheritance** TupleException diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/Data Structures/Tuple.cls index 763459b2..a8719c4e 100644 --- a/force-app/main/default/classes/Data Structures/Tuple.cls +++ b/force-app/main/default/classes/Data Structures/Tuple.cls @@ -9,7 +9,7 @@ * for use in Apex-defined Data Types. * * See also: https://help.salesforce.com/s/articleView?id=sf.flow_considerations_apex_data_type.htm&type=5 - * Available primitive datatypes available for use in tupple: + * Available primitive datatypes available for use in tuple: * Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. */ public with sharing class Tuple { @@ -79,11 +79,23 @@ public with sharing class Tuple { public Tuple() { } + /** + * @description standard constructor accepting a key and value + * @param key String the name of the Tuple's Key. + * @param value Object the Tuple's Value. + */ public Tuple(String key, Object value) { + if (key == null || value == null) { + throw new TupleException('Key and Value cannot be null'); + } this.key = key; determineTypeAndSetCastedValue(value); } + /** + * @description Method is responsible for determining the type of the value and setting the appropriate field. + * @param value Object the Tuple's Value. + */ private void determineTypeAndSetCastedValue(Object value) { String backingClassName = Polyfills.classNameFromInstance(value) .toLowerCase(); @@ -104,7 +116,7 @@ public with sharing class Tuple { this.dateValue = (Date) value; } when 'list' { - this.dateValue = (Date) value; + this.dates = (List) value; } when 'long' { this.longValue = (Long) value; @@ -137,14 +149,11 @@ public with sharing class Tuple { this.strings = (List) value; } when else { - try { - this.sobjects = (value instanceof List) - ? (List) value - : null; - this.sobjectValue = (value instanceof SObject) - ? (SObject) value - : null; - } catch (TypeException e) { + if (value instanceof List) { + this.sobjects = (List) value; + } else if (value instanceof SObject) { + this.sobjectValue = (SObject) value; + } else { throw new TupleException( 'Unsupported data type: ' + backingClassName ); @@ -153,6 +162,10 @@ public with sharing class Tuple { } } + /** + * @description A custom Exception type thrown when the incoming Object is not a recognized Apex-defined-type safe + * type. + */ public class TupleException extends Exception { } } From 03a26b75acf4419809dd2d243f16f1334572e4a7 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 17 Oct 2023 20:11:53 -0700 Subject: [PATCH 04/21] refactor(Tuple): accepting CodeRabit review suggestions Signed-off-by: kpoorman --- .../default/classes/Data Structures/Tuple.cls | 107 +++++++----------- 1 file changed, 43 insertions(+), 64 deletions(-) diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/Data Structures/Tuple.cls index a8719c4e..3c2a9d1e 100644 --- a/force-app/main/default/classes/Data Structures/Tuple.cls +++ b/force-app/main/default/classes/Data Structures/Tuple.cls @@ -85,8 +85,11 @@ public with sharing class Tuple { * @param value Object the Tuple's Value. */ public Tuple(String key, Object value) { - if (key == null || value == null) { - throw new TupleException('Key and Value cannot be null'); + if (key == null) { + throw new TupleException('Key cannot be null'); + } + if (value == null) { + throw new TupleException('Value cannot be null'); } this.key = key; determineTypeAndSetCastedValue(value); @@ -97,68 +100,44 @@ public with sharing class Tuple { * @param value Object the Tuple's Value. */ private void determineTypeAndSetCastedValue(Object value) { - String backingClassName = Polyfills.classNameFromInstance(value) - .toLowerCase(); - switch on backingClassName { - when 'boolean' { - this.booleanValue = (Boolean) value; - } - when 'list' { - this.booleans = (List) value; - } - when 'datetime' { - this.dateTimeValue = (Datetime) value; - } - when 'list' { - this.datetimes = (List) value; - } - when 'date' { - this.dateValue = (Date) value; - } - when 'list' { - this.dates = (List) value; - } - when 'long' { - this.longValue = (Long) value; - } - when 'list' { - this.longs = (List) value; - } - when 'integer' { - this.integerValue = (Integer) value; - } - when 'list' { - this.integers = (List) value; - } - when 'decimal' { - this.decimalValue = (Decimal) value; - } - when 'list' { - this.decimals = (List) value; - } - when 'double' { - this.doubleValue = (Double) value; - } - when 'list' { - this.doubles = (List) value; - } - when 'string' { - this.stringValue = (String) value; - } - when 'list' { - this.strings = (List) value; - } - when else { - if (value instanceof List) { - this.sobjects = (List) value; - } else if (value instanceof SObject) { - this.sobjectValue = (SObject) value; - } else { - throw new TupleException( - 'Unsupported data type: ' + backingClassName - ); - } - } + if (value instanceof Boolean) { + this.booleanValue = (Boolean) value; + } else if (value instanceof List) { + this.booleans = (List) value; + } else if (value instanceof Datetime) { + this.dateTimeValue = (Datetime) value; + } else if (value instanceof List) { + this.datetimes = (List) value; + } else if (value instanceof Date) { + this.dateValue = (Date) value; + } else if (value instanceof List) { + this.dates = (List) value; + } else if (value instanceof Long) { + this.longValue = (Long) value; + } else if (value instanceof List) { + this.longs = (List) value; + } else if (value instanceof Integer) { + this.integerValue = (Integer) value; + } else if (value instanceof List) { + this.integers = (List) value; + } else if (value instanceof Decimal) { + this.decimalValue = (Decimal) value; + } else if (value instanceof List) { + this.decimals = (List) value; + } else if (value instanceof Double) { + this.doubleValue = (Double) value; + } else if (value instanceof List) { + this.doubles = (List) value; + } else if (value instanceof String) { + this.stringValue = (String) value; + } else if (value instanceof List) { + this.strings = (List) value; + } else if (value instanceof List) { + this.sobjects = (List) value; + } else if (value instanceof SObject) { + this.sobjectValue = (SObject) value; + } else { + throw new TupleException('Unsupported data type: ' + value); } } From 83a3a29c1ff7c7e673e5e0eb10dda1c0718e6023 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 17 Oct 2023 20:13:47 -0700 Subject: [PATCH 05/21] refactor(Tuple): accepting CodeRabit review suggestions Signed-off-by: kpoorman --- docs/Tuple.md | 4 ++++ force-app/main/default/classes/Data Structures/Tuple.cls | 2 ++ 2 files changed, 6 insertions(+) diff --git a/docs/Tuple.md b/docs/Tuple.md index 22fa3902..a5869509 100644 --- a/docs/Tuple.md +++ b/docs/Tuple.md @@ -1,3 +1,5 @@ +`APIVERSION: 58` + `STATUS: ACTIVE` Tuple represents a key-value pair. Kinda. Don't come at me math nerds. @@ -134,6 +136,8 @@ standard constructor accepting a key and value ### `private void determineTypeAndSetCastedValue(Object value)` +`SUPPRESSWARNINGS` + Method is responsible for determining the type of the value and setting the appropriate field. #### Parameters diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/Data Structures/Tuple.cls index 3c2a9d1e..c3699264 100644 --- a/force-app/main/default/classes/Data Structures/Tuple.cls +++ b/force-app/main/default/classes/Data Structures/Tuple.cls @@ -12,6 +12,7 @@ * Available primitive datatypes available for use in tuple: * Boolean, Integer, Long, Decimal, Double, Date, DateTime, and String. Single values and lists are supported for each data type. */ +@SuppressWarnings('PMD.StdCyclomaticComplexity') public with sharing class Tuple { @AuraEnabled @InvocableVariable @@ -99,6 +100,7 @@ public with sharing class Tuple { * @description Method is responsible for determining the type of the value and setting the appropriate field. * @param value Object the Tuple's Value. */ + @SuppressWarnings('PMD.CyclomaticComplexity, PMD.StdCyclomaticComplexity') private void determineTypeAndSetCastedValue(Object value) { if (value instanceof Boolean) { this.booleanValue = (Boolean) value; From b62047d76998a4a077ffdb644c575deb29a361a2 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Tue, 17 Oct 2023 20:43:04 -0700 Subject: [PATCH 06/21] fix(ci-pr.yml): formatting Removed the pre-release option Signed-off-by: kpoorman --- .github/workflows/ci-pr.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index 90f0bf1f..3f6681c4 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -37,7 +37,7 @@ jobs: # openai_engine: "text-davinci-002" #optional openai_temperature: 0.5 #optional openai_max_tokens: 2048 #optional - mode: file # file or patch + mode: file # file or patch # Formatting only runs on human-submitted and Dependabot PRs format-and-linting: @@ -145,13 +145,13 @@ jobs: run: sf org login sfdx-url -f ./DEVHUB_SFDX_URL.txt -a devhub -d # Create prerelease scratch org - - name: 'Create prerelease scratch org' - if: ${{ env.IS_PRERELEASE }} - run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview + # - name: 'Create prerelease scratch org' + # if: ${{ env.IS_PRERELEASE }} + # run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview # Create scratch org - name: 'Create scratch org' - if: ${{ !env.IS_PRERELEASE }} + # if: ${{ !env.IS_PRERELEASE }} run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 # Deploy source to scratch org From 8207b77a133f56201b4b4364a3c0f85dc2487cb6 Mon Sep 17 00:00:00 2001 From: Kevin Poorman Date: Thu, 5 Oct 2023 23:30:07 -0700 Subject: [PATCH 07/21] Update ci-pr.yml --- .github/workflows/ci-pr.yml | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index 3f6681c4..69561d88 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -29,15 +29,11 @@ jobs: pull-requests: write steps: - name: ChatGTP code reviewer code - uses: cirolini/chatgpt-github-actions@v1.3 + uses: mattzcarey/code-review-gpt@v0.1.4-alpha with: - openai_api_key: ${{ secrets.OPENAI_API_KEY }} - github_token: ${{ secrets.GITHUB_TOKEN }} - github_pr_id: ${{ github.event.number }} - # openai_engine: "text-davinci-002" #optional - openai_temperature: 0.5 #optional - openai_max_tokens: 2048 #optional - mode: file # file or patch + OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} + MODEL: 'gpt-3.5-turbo' + GITHUB_TOKEN: ${{ github.token }} # Formatting only runs on human-submitted and Dependabot PRs format-and-linting: @@ -145,13 +141,13 @@ jobs: run: sf org login sfdx-url -f ./DEVHUB_SFDX_URL.txt -a devhub -d # Create prerelease scratch org - # - name: 'Create prerelease scratch org' - # if: ${{ env.IS_PRERELEASE }} - # run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview + - name: 'Create prerelease scratch org' + if: ${{ env.IS_PRERELEASE }} + run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview # Create scratch org - name: 'Create scratch org' - # if: ${{ !env.IS_PRERELEASE }} + if: ${{ !env.IS_PRERELEASE }} run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 # Deploy source to scratch org From 940717fb9a4008d416fce2f3ffed1bae0a289bbe Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 6 Oct 2023 09:40:08 +0000 Subject: [PATCH 08/21] build(npm): bump @cparra/apexdocs from 2.17.0 to 2.17.1 (#115) Bumps [@cparra/apexdocs](https://github.com/cesarParra/apexdocs) from 2.17.0 to 2.17.1. - [Release notes](https://github.com/cesarParra/apexdocs/releases) - [Commits](https://github.com/cesarParra/apexdocs/compare/v2.17.0...v2.17.1) --- updated-dependencies: - dependency-name: "@cparra/apexdocs" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7f2b1ba9..20389bf0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "hasInstallScript": true, "devDependencies": { - "@cparra/apexdocs": "^2.17.0", + "@cparra/apexdocs": "^2.17.1", "@lwc/eslint-plugin-lwc": "^1.6.3", "@prettier/plugin-xml": "^3.2.1", "@salesforce/eslint-config-lwc": "^3.5.2", @@ -964,18 +964,18 @@ "dev": true }, "node_modules/@cparra/apex-reflection": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/@cparra/apex-reflection/-/apex-reflection-2.4.0.tgz", - "integrity": "sha512-KsJzn86RMdwf97Dx3PNrSdA9EI+GZ/bgCrHqj4+knM0gnwgxJzazmNiKn0ZXyUk6Hpq4JftSMZKdvw/epdfFhg==", + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/@cparra/apex-reflection/-/apex-reflection-2.4.1.tgz", + "integrity": "sha512-ZuUfNgSukFecOM+h2K7u4qhk8HX0PzNlmxci+AQbDUAZISN/RfREJFjsqAewraS+4zIwqgDGNhAcAJmQymcnoA==", "dev": true }, "node_modules/@cparra/apexdocs": { - "version": "2.17.0", - "resolved": "https://registry.npmjs.org/@cparra/apexdocs/-/apexdocs-2.17.0.tgz", - "integrity": "sha512-iRruyKICN1OswNuVxleEaWJpTTQGZrBJbhFmZbKAKluNXXUNfglbvDFHHBVChxtAIsPib/psa2Mq+7/ZPror/w==", + "version": "2.17.1", + "resolved": "https://registry.npmjs.org/@cparra/apexdocs/-/apexdocs-2.17.1.tgz", + "integrity": "sha512-QjpNtUoClZEpfUHnV6eqtjoIvjPZ3AjrnZvmgGlnZXjFAICRsl0n9F/KeEujPZYeaG619+b8MOpTRiSXz5lsQg==", "dev": true, "dependencies": { - "@cparra/apex-reflection": "2.4.0", + "@cparra/apex-reflection": "2.4.1", "chalk": "^4.1.2", "fast-xml-parser": "^4.0.1", "js-yaml": "^4.1.0", diff --git a/package.json b/package.json index 5365d661..cb095f78 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "precommit": "npm run apexdocs && git add docs && lint-staged" }, "devDependencies": { - "@cparra/apexdocs": "^2.17.0", + "@cparra/apexdocs": "^2.17.1", "@lwc/eslint-plugin-lwc": "^1.6.3", "@prettier/plugin-xml": "^3.2.1", "@salesforce/eslint-config-lwc": "^3.5.2", From 93e20319ec30e3454f9d5bec3f2ee1b65bb437d4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:39:07 +0000 Subject: [PATCH 09/21] build(npm): bump eslint from 8.50.0 to 8.51.0 (#116) Bumps [eslint](https://github.com/eslint/eslint) from 8.50.0 to 8.51.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v8.50.0...v8.51.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 20389bf0..cf1eef71 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "@salesforce/eslint-plugin-aura": "^2.1.0", "@salesforce/eslint-plugin-lightning": "^1.0.0", "@salesforce/sfdx-lwc-jest": "^3.0.1", - "eslint": "^8.50.0", + "eslint": "^8.51.0", "eslint-plugin-import": "^2.28.1", "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", @@ -1320,9 +1320,9 @@ } }, "node_modules/@eslint/js": { - "version": "8.50.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.50.0.tgz", - "integrity": "sha512-NCC3zz2+nvYd+Ckfh87rA47zfu2QsQpvc6k1yzTk+b9KzRj0wkGa8LSoGOXN6Zv4lRf/EIoZ80biDh9HOI+RNQ==", + "version": "8.51.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.51.0.tgz", + "integrity": "sha512-HxjQ8Qn+4SI3/AFv6sOrDB+g6PpUTDwSJiQqOrnneEk8L71161srI9gjzzZvYVbzHiVg/BvcH95+cK/zfIt4pg==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -4553,15 +4553,15 @@ } }, "node_modules/eslint": { - "version": "8.50.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.50.0.tgz", - "integrity": "sha512-FOnOGSuFuFLv/Sa+FDVRZl4GGVAAFFi8LecRsI5a1tMO5HIE8nCm4ivAlzt4dT3ol/PaaGC0rJEEXQmHJBGoOg==", + "version": "8.51.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.51.0.tgz", + "integrity": "sha512-2WuxRZBrlwnXi+/vFSJyjMqrNjtJqiasMzehF0shoLaW7DzS3/9Yvrmq5JiT66+pNjiX4UBnLDiKHcWAr/OInA==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", "@eslint/eslintrc": "^2.1.2", - "@eslint/js": "8.50.0", + "@eslint/js": "8.51.0", "@humanwhocodes/config-array": "^0.11.11", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", diff --git a/package.json b/package.json index cb095f78..fa040971 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "@salesforce/eslint-plugin-aura": "^2.1.0", "@salesforce/eslint-plugin-lightning": "^1.0.0", "@salesforce/sfdx-lwc-jest": "^3.0.1", - "eslint": "^8.50.0", + "eslint": "^8.51.0", "eslint-plugin-import": "^2.28.1", "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", From 805c0bb9caee8784ce7463e7e668f839fe28e2e3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 11 Oct 2023 09:40:48 +0000 Subject: [PATCH 10/21] build(npm): bump @cparra/apexdocs from 2.17.1 to 2.17.2 (#117) Bumps [@cparra/apexdocs](https://github.com/cesarParra/apexdocs) from 2.17.1 to 2.17.2. - [Release notes](https://github.com/cesarParra/apexdocs/releases) - [Commits](https://github.com/cesarParra/apexdocs/compare/v2.17.1...v2.17.2) --- updated-dependencies: - dependency-name: "@cparra/apexdocs" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index cf1eef71..53d960a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "hasInstallScript": true, "devDependencies": { - "@cparra/apexdocs": "^2.17.1", + "@cparra/apexdocs": "^2.17.2", "@lwc/eslint-plugin-lwc": "^1.6.3", "@prettier/plugin-xml": "^3.2.1", "@salesforce/eslint-config-lwc": "^3.5.2", @@ -970,9 +970,9 @@ "dev": true }, "node_modules/@cparra/apexdocs": { - "version": "2.17.1", - "resolved": "https://registry.npmjs.org/@cparra/apexdocs/-/apexdocs-2.17.1.tgz", - "integrity": "sha512-QjpNtUoClZEpfUHnV6eqtjoIvjPZ3AjrnZvmgGlnZXjFAICRsl0n9F/KeEujPZYeaG619+b8MOpTRiSXz5lsQg==", + "version": "2.17.2", + "resolved": "https://registry.npmjs.org/@cparra/apexdocs/-/apexdocs-2.17.2.tgz", + "integrity": "sha512-mt3W+4c29U5xFuzZ0/DTFLpiJIDom0KjtCSnpOqNSSovd3OI2ak/Xl0gaL1FFVyskKZxkUMcRnDnOSEyphXkyw==", "dev": true, "dependencies": { "@cparra/apex-reflection": "2.4.1", diff --git a/package.json b/package.json index fa040971..893a720b 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "precommit": "npm run apexdocs && git add docs && lint-staged" }, "devDependencies": { - "@cparra/apexdocs": "^2.17.1", + "@cparra/apexdocs": "^2.17.2", "@lwc/eslint-plugin-lwc": "^1.6.3", "@prettier/plugin-xml": "^3.2.1", "@salesforce/eslint-config-lwc": "^3.5.2", From dfed13f36da88dad4b163fb35e93aec2612f9767 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 12 Oct 2023 09:11:38 +0000 Subject: [PATCH 11/21] build(npm): bump marked from 9.1.0 to 9.1.1 (#118) Bumps [marked](https://github.com/markedjs/marked) from 9.1.0 to 9.1.1. - [Release notes](https://github.com/markedjs/marked/releases) - [Changelog](https://github.com/markedjs/marked/blob/master/.releaserc.json) - [Commits](https://github.com/markedjs/marked/compare/v9.1.0...v9.1.1) --- updated-dependencies: - dependency-name: marked dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 53d960a1..b5c0b1f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", "lint-staged": "^14.0.1", - "marked": "^9.1.0", + "marked": "^9.1.1", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" } @@ -8139,9 +8139,9 @@ } }, "node_modules/marked": { - "version": "9.1.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-9.1.0.tgz", - "integrity": "sha512-VZjm0PM5DMv7WodqOUps3g6Q7dmxs9YGiFUZ7a2majzQTTCgX+6S6NAJHPvOhgFBzYz8s4QZKWWMfZKFmsfOgA==", + "version": "9.1.1", + "resolved": "https://registry.npmjs.org/marked/-/marked-9.1.1.tgz", + "integrity": "sha512-ZmXkUGH54U4rEy3GL9vYj8+S1PHJx/zz5pc4Frn7UdGiNREKT12fWBJ5a5ffjFtghx9C9912vEg9Zra1Nf7CnA==", "dev": true, "bin": { "marked": "bin/marked.js" diff --git a/package.json b/package.json index 893a720b..16f1b57a 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "eslint-plugin-import": "^2.28.1", "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", - "marked": "^9.1.0", + "marked": "^9.1.1", "lint-staged": "^14.0.1", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" From b4a5956da7e2fa8321bcb13076664b174fefa63e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 09:30:30 +0000 Subject: [PATCH 12/21] build(npm): bump marked from 9.1.1 to 9.1.2 (#120) Bumps [marked](https://github.com/markedjs/marked) from 9.1.1 to 9.1.2. - [Release notes](https://github.com/markedjs/marked/releases) - [Changelog](https://github.com/markedjs/marked/blob/master/.releaserc.json) - [Commits](https://github.com/markedjs/marked/compare/v9.1.1...v9.1.2) --- updated-dependencies: - dependency-name: marked dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index b5c0b1f7..704ec55e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", "lint-staged": "^14.0.1", - "marked": "^9.1.1", + "marked": "^9.1.2", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" } @@ -8139,9 +8139,9 @@ } }, "node_modules/marked": { - "version": "9.1.1", - "resolved": "https://registry.npmjs.org/marked/-/marked-9.1.1.tgz", - "integrity": "sha512-ZmXkUGH54U4rEy3GL9vYj8+S1PHJx/zz5pc4Frn7UdGiNREKT12fWBJ5a5ffjFtghx9C9912vEg9Zra1Nf7CnA==", + "version": "9.1.2", + "resolved": "https://registry.npmjs.org/marked/-/marked-9.1.2.tgz", + "integrity": "sha512-qoKMJqK0w6vkLk8+KnKZAH6neUZSNaQqVZ/h2yZ9S7CbLuFHyS2viB0jnqcWF9UKjwsAbMrQtnQhdmdvOVOw9w==", "dev": true, "bin": { "marked": "bin/marked.js" diff --git a/package.json b/package.json index 16f1b57a..bb98903d 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "eslint-plugin-import": "^2.28.1", "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", - "marked": "^9.1.1", + "marked": "^9.1.2", "lint-staged": "^14.0.1", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" From fecbea59c95f2803f9e2edff3e900cab4bedb25c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 13:26:13 -0700 Subject: [PATCH 13/21] build(npm): bump lint-staged from 14.0.1 to 15.0.1 (#119) Bumps [lint-staged](https://github.com/okonet/lint-staged) from 14.0.1 to 15.0.1. - [Release notes](https://github.com/okonet/lint-staged/releases) - [Changelog](https://github.com/lint-staged/lint-staged/blob/master/CHANGELOG.md) - [Commits](https://github.com/okonet/lint-staged/compare/v14.0.1...v15.0.1) --- updated-dependencies: - dependency-name: lint-staged dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 90 ++++++++++++++++++++++++++++------------------- package.json | 2 +- 2 files changed, 54 insertions(+), 38 deletions(-) diff --git a/package-lock.json b/package-lock.json index 704ec55e..f7aafa3c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,7 +20,7 @@ "eslint-plugin-import": "^2.28.1", "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", - "lint-staged": "^14.0.1", + "lint-staged": "^15.0.1", "marked": "^9.1.2", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" @@ -4054,9 +4054,9 @@ } }, "node_modules/commander": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-11.0.0.tgz", - "integrity": "sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==", + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", + "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", "dev": true, "engines": { "node": ">=16" @@ -5104,28 +5104,52 @@ "dev": true }, "node_modules/execa": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-7.2.0.tgz", - "integrity": "sha512-UduyVP7TLB5IcAQl+OzLyLcS/l32W/GLg+AhHJ+ow40FOk2U3SAllPwR44v4vmdFwIWqpdwxxpQbF1n5ta9seA==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", + "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==", "dev": true, "dependencies": { "cross-spawn": "^7.0.3", - "get-stream": "^6.0.1", - "human-signals": "^4.3.0", + "get-stream": "^8.0.1", + "human-signals": "^5.0.0", "is-stream": "^3.0.0", "merge-stream": "^2.0.0", "npm-run-path": "^5.1.0", "onetime": "^6.0.0", - "signal-exit": "^3.0.7", + "signal-exit": "^4.1.0", "strip-final-newline": "^3.0.0" }, "engines": { - "node": "^14.18.0 || ^16.14.0 || >=18.0.0" + "node": ">=16.17" }, "funding": { "url": "https://github.com/sindresorhus/execa?sponsor=1" } }, + "node_modules/execa/node_modules/get-stream": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz", + "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==", + "dev": true, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "dev": true, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/exit": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz", @@ -5715,12 +5739,12 @@ } }, "node_modules/human-signals": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-4.3.1.tgz", - "integrity": "sha512-nZXjEF2nbo7lIw3mgYjItAfgQXog3OjJogSbKa2CQIIvSGWcKgeJnQlNXip6NglNzYH45nSRiEVimMvYL8DDqQ==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", + "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", "dev": true, "engines": { - "node": ">=14.18.0" + "node": ">=16.17.0" } }, "node_modules/husky": { @@ -7958,36 +7982,36 @@ "dev": true }, "node_modules/lint-staged": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-14.0.1.tgz", - "integrity": "sha512-Mw0cL6HXnHN1ag0mN/Dg4g6sr8uf8sn98w2Oc1ECtFto9tvRF7nkXGJRbx8gPlHyoR0pLyBr2lQHbWwmUHe1Sw==", + "version": "15.0.1", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.0.1.tgz", + "integrity": "sha512-2IU5OWmCaxch0X0+IBF4/v7sutpB+F3qoXbro43pYjQTOo5wumckjxoxn47pQBqqBsCWrD5HnI2uG/zJA7isew==", "dev": true, "dependencies": { "chalk": "5.3.0", - "commander": "11.0.0", + "commander": "11.1.0", "debug": "4.3.4", - "execa": "7.2.0", + "execa": "8.0.1", "lilconfig": "2.1.0", - "listr2": "6.6.1", + "listr2": "7.0.1", "micromatch": "4.0.5", "pidtree": "0.6.0", "string-argv": "0.3.2", - "yaml": "2.3.1" + "yaml": "2.3.2" }, "bin": { "lint-staged": "bin/lint-staged.js" }, "engines": { - "node": "^16.14.0 || >=18.0.0" + "node": ">=18.12.0" }, "funding": { "url": "https://opencollective.com/lint-staged" } }, "node_modules/listr2": { - "version": "6.6.1", - "resolved": "https://registry.npmjs.org/listr2/-/listr2-6.6.1.tgz", - "integrity": "sha512-+rAXGHh0fkEWdXBmX+L6mmfmXmXvDGEKzkjxO+8mP3+nI/r/CWznVBvsibXdxda9Zz0OW2e2ikphN3OwCT/jSg==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-7.0.1.tgz", + "integrity": "sha512-nz+7hwgbDp8eWNoDgzdl4hA/xDSLrNRzPu1TLgOYs6l5Y+Ma6zVWWy9Oyt9TQFONwKoSPoka3H50D3vD5EuNwg==", "dev": true, "dependencies": { "cli-truncate": "^3.1.0", @@ -7999,14 +8023,6 @@ }, "engines": { "node": ">=16.0.0" - }, - "peerDependencies": { - "enquirer": ">= 2.3.0 < 3" - }, - "peerDependenciesMeta": { - "enquirer": { - "optional": true - } } }, "node_modules/locate-path": { @@ -10079,9 +10095,9 @@ "dev": true }, "node_modules/yaml": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.1.tgz", - "integrity": "sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.2.tgz", + "integrity": "sha512-N/lyzTPaJasoDmfV7YTrYCI0G/3ivm/9wdG0aHuheKowWQwGTsK0Eoiw6utmzAnI6pkJa0DUVygvp3spqqEKXg==", "dev": true, "engines": { "node": ">= 14" diff --git a/package.json b/package.json index bb98903d..2becc40d 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "eslint-plugin-jest": "^27.4.0", "husky": "^8.0.3", "marked": "^9.1.2", - "lint-staged": "^14.0.1", + "lint-staged": "^15.0.1", "prettier": "^3.0.3", "prettier-plugin-apex": "^2.0.1" }, From d19e20ef0f87b36e6e1f18571b44a99d97de7cbd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 20:27:47 +0000 Subject: [PATCH 14/21] build(npm): bump @babel/traverse from 7.23.0 to 7.23.2 (#121) Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.23.0 to 7.23.2. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse) --- updated-dependencies: - dependency-name: "@babel/traverse" dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index f7aafa3c..a0659bf6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -923,9 +923,9 @@ } }, "node_modules/@babel/traverse": { - "version": "7.23.0", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.23.0.tgz", - "integrity": "sha512-t/QaEvyIoIkwzpiZ7aoSKK8kObQYeF7T2v+dazAYCb8SXtp58zEVkWW7zAnju8FNKNdr4ScAOEDmMItbyOmEYw==", + "version": "7.23.2", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.23.2.tgz", + "integrity": "sha512-azpe59SQ48qG6nu2CzcMLbxUudtN+dOM9kDbUqGq3HXUJRlo7i8fvPoxQUzYgLZ4cMVmuZgm8vvBpNeRhd6XSw==", "dev": true, "dependencies": { "@babel/code-frame": "^7.22.13", From 4cce47c4fe4d65138b65382a9a046843cc599838 Mon Sep 17 00:00:00 2001 From: Kevin Poorman Date: Mon, 16 Oct 2023 13:28:38 -0700 Subject: [PATCH 15/21] Update ci-pr.yml --- .github/workflows/ci-pr.yml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index 69561d88..6e4aa685 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -22,18 +22,16 @@ env: # Jobs to be executed jobs: # GPT-4 code review - review_with_gpt: + review: runs-on: ubuntu-latest - name: ChatGPT code reviewer - permissions: - pull-requests: write steps: - - name: ChatGTP code reviewer code - uses: mattzcarey/code-review-gpt@v0.1.4-alpha - with: + - uses: fluxninja/openai-pr-reviewer@latest + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} - MODEL: 'gpt-3.5-turbo' - GITHUB_TOKEN: ${{ github.token }} + with: + debug: false + review_comment_lgtm: false # Formatting only runs on human-submitted and Dependabot PRs format-and-linting: From ee3f6df4eea075ca99511bfcbb0f5f825fab151c Mon Sep 17 00:00:00 2001 From: kpoorman Date: Wed, 18 Oct 2023 17:11:38 -0700 Subject: [PATCH 16/21] refactor(ci-pr.yml): fixing this branches' ci-pr yml Signed-off-by: kpoorman --- docs/BulkCallable.md | 8 +- docs/CanTheUser.md | 150 +++++++++++++-------------- docs/CanTheUserTests.md | 2 +- docs/CustomInvocable.md | 32 +++--- docs/ExampleQueueableProcessSteps.md | 6 +- docs/FF.md | 18 ++-- docs/FailsafeExceptionHandler.md | 6 +- docs/FeatureFlag.md | 36 +++---- docs/FeatureFlagCommonTests.md | 10 +- docs/FeatureFlagDataProvider.md | 32 +++--- docs/HttpCalloutMockFactory.md | 12 +-- docs/IdFactory.md | 16 +-- docs/Log.md | 6 +- docs/LogMessage.md | 2 +- docs/LogTriggerHandler.md | 18 ++-- docs/MetadataTriggerFramework.md | 18 ++-- docs/MetadataTriggerQueryService.md | 10 +- docs/MethodSignature.md | 68 ++++++------ docs/MockedMethod.md | 114 ++++++++++---------- docs/OrgShape.md | 48 ++++----- docs/Ouroboros.md | 12 +-- docs/OuroborosFinalizer.md | 6 +- docs/OuroborosTests.md | 6 +- docs/Polyfills.md | 80 +++++++------- docs/Query.md | 18 ++-- docs/QueueableProcess.md | 10 +- docs/QueueableProcessDataProvider.md | 6 +- docs/QueueableProcessTests.md | 20 ++-- docs/QuiddityGuard.md | 24 ++--- docs/RestClient.md | 6 +- docs/RestClientLib.md | 78 +++++++------- docs/RestLib.md | 6 +- docs/RestLibApiCall.md | 6 +- docs/SOQL.md | 2 +- docs/SOQLAgregate.md | 2 +- docs/SOSL.md | 2 +- docs/Safely.md | 98 ++++++++--------- docs/SampleHandler.md | 18 ++-- docs/Stub.md | 60 +++++------ docs/StubUtilities.md | 8 +- docs/TestFactory.md | 102 +++++++++--------- docs/TriggerContext.md | 6 +- docs/TriggerFramework.md | 18 ++-- docs/TriggerFrameworkLoopCount.md | 24 ++--- docs/UFInvocable.md | 50 ++++----- docs/ULID.md | 24 ++--- docs/UniversalBulkInvocable.md | 8 +- docs/UniversalFlowInputOutput.md | 14 +-- docs/UniversalInvocable.md | 8 +- 49 files changed, 667 insertions(+), 667 deletions(-) diff --git a/docs/BulkCallable.md b/docs/BulkCallable.md index a0aedaba..ee6c6f07 100644 --- a/docs/BulkCallable.md +++ b/docs/BulkCallable.md @@ -6,7 +6,7 @@ Provides a similar interface to Callable, but bulkified to handle multiple sets ## Methods -### `public List call(String methodName, List> parameters)` +### `public List call(String methodName, List> parameters)` Implementing classes must implement this method signature. @@ -19,8 +19,8 @@ Implementing classes must implement this method signature. #### Returns -| Type | Description | -| ------------ | --------------------------------------------------- | -| List | List The results of the called Apex methods | +| Type | Description | +| -------------- | --------------------------------------------------- | +| `List` | List The results of the called Apex methods | --- diff --git a/docs/CanTheUser.md b/docs/CanTheUser.md index 7907b9ab..07dfafa6 100644 --- a/docs/CanTheUser.md +++ b/docs/CanTheUser.md @@ -39,9 +39,9 @@ A method to determine if the running user can perform the specified CRUD operati #### Returns -| Type | Description | -| ------- | ----------------------------------------------------------------------------------------- | -| Boolean | Boolean true if the user can perform the specified CRUD operation on the specified object | +| Type | Description | +| --------- | ----------------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the specified object | #### Example @@ -64,9 +64,9 @@ a list accepting version of the crud method. It returns CRUD results for the fir #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------------------------- | -| Boolean | Boolean true if the user can perform the specified CRUD operation on the first object in the list | +| Type | Description | +| --------- | ------------------------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the first object in the list | ### `private static Boolean crud(String objectName, CrudType permission)` @@ -83,9 +83,9 @@ A method to determine if the running user can perform the specified CRUD operati #### Returns -| Type | Description | -| ------- | ----------------------------------------------------------------------------------------- | -| Boolean | Boolean true if the user can perform the specified CRUD operation on the specified object | +| Type | Description | +| --------- | ----------------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the specified object | ### `public static Boolean create(SObject obj)` @@ -99,9 +99,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can create the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can create the specified object | #### Example @@ -121,9 +121,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| ------- | ---------------------------------------------------------------- | -| Boolean | Boolean true if the user can create the first object in the list | +| Type | Description | +| --------- | ---------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can create the first object in the list | ### `public static Boolean create(String objName)` @@ -137,9 +137,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can create the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can create the specified object | #### Example @@ -159,9 +159,9 @@ convenience api for determining if the running user can read / access the specif #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can read the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can read the specified object | #### Example @@ -181,9 +181,9 @@ convenience api for determining if the running user can read / access the specif #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can read the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can read the specified object | ### `public static Boolean read(String objName)` @@ -197,9 +197,9 @@ convenience api for determining if the running user can read the specified objec #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can read the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can read the specified object | #### Example @@ -219,9 +219,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can edit the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can edit the specified object | #### Example @@ -241,9 +241,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can edit the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can edit the specified object | ### `public static Boolean edit(String objName)` @@ -257,9 +257,9 @@ convenience api for determining if the running user can edit the specified objec #### Returns -| Type | Description | -| ------- | ------------------------------------------------------ | -| Boolean | Boolean true if the user can edit the specified object | +| Type | Description | +| --------- | ------------------------------------------------------ | +| `Boolean` | Boolean true if the user can edit the specified object | #### Example @@ -279,9 +279,9 @@ convenience api for determining if the running user can upsert (insert and updat #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can upsert the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can upsert the specified object | #### Example @@ -301,9 +301,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can upsert the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can upsert the specified object | ### `public static Boolean ups(String objName)` @@ -317,9 +317,9 @@ convenience api for determining if the running user can upsert the specified obj #### Returns -| Type | Description | -| ------- | --------------------------------------------------------- | -| Boolean | Boolean true if the user can upsert the specified objects | +| Type | Description | +| --------- | --------------------------------------------------------- | +| `Boolean` | Boolean true if the user can upsert the specified objects | #### Example @@ -339,9 +339,9 @@ convenience api for determining if the running user can delete/destroy the speci #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can delete the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can delete the specified object | #### Example @@ -361,9 +361,9 @@ convenience api for determining if the running user can delete the specified obj #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can delete the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can delete the specified object | ### `public static Boolean destroy(String objName)` @@ -377,9 +377,9 @@ convenience api for determining if the running user can delete the specified obj #### Returns -| Type | Description | -| ------- | -------------------------------------------------------- | -| Boolean | Boolean true if the user can delete the specified object | +| Type | Description | +| --------- | -------------------------------------------------------- | +| `Boolean` | Boolean true if the user can delete the specified object | #### Example @@ -400,9 +400,9 @@ public static method to determine if a given field on a given object is Accessib #### Returns -| Type | Description | -| ------- | ----------------------------------------------------------------------------- | -| Boolean | Boolean true if the user can read the specified field on the specified object | +| Type | Description | +| --------- | ----------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can read the specified field on the specified object | #### Example @@ -410,7 +410,7 @@ public static method to determine if a given field on a given object is Accessib System.debug(CanTheUser.flsAccessible('Account', 'Name')); ``` -### `public static Map bulkFLSAccessible(String obj, Set fields)` +### `public static Map bulkFLSAccessible(String obj, Set fields)` bulk form of flsAccessible @@ -423,9 +423,9 @@ bulk form of flsAccessible #### Returns -| Type | Description | -| ------------------- | ----------------------------------------------------------------------------------------- | -| Map | `Map` where the key is the field name and the value is the accessibility | +| Type | Description | +| --------------------- | ----------------------------------------------------------------------------------------- | +| `Map` | `Map` where the key is the field name and the value is the accessibility | #### Example @@ -447,9 +447,9 @@ public static method to determine if a given field on a given object is Updatabl #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | Boolean true if the user can update the specified field on the specified object | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the user can update the specified field on the specified object | #### Example @@ -457,7 +457,7 @@ public static method to determine if a given field on a given object is Updatabl System.debug(CanTheUser.flsUpdatable('Account', 'Name')); ``` -### `public static Map bulkFLSUpdatable(String obj, Set fields)` +### `public static Map bulkFLSUpdatable(String obj, Set fields)` bulk form of flsUpdatable call @@ -470,9 +470,9 @@ bulk form of flsUpdatable call #### Returns -| Type | Description | -| ------------------- | ---------------------------------------------------------------------------------------- | -| Map | `Map` where the key is the field name and the value is the updatability | +| Type | Description | +| --------------------- | ---------------------------------------------------------------------------------------- | +| `Map` | `Map` where the key is the field name and the value is the updatability | #### Example @@ -495,11 +495,11 @@ Abstracted method for retrieving or calculating (memoization) of the FLS for a g #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | -### `private static Map calculateFLS(String objType)` +### `private static Map> calculateFLS(String objType)` Calculates the FLS for a given object type @@ -511,9 +511,9 @@ Calculates the FLS for a given object type #### Returns -| Type | Description | -| -------------------------------- | ------------------------------------ | -| Map> | `Map>` | +| Type | Description | +| ---------------------------------- | ------------------------------------ | +| `Map>` | `Map>` | --- diff --git a/docs/CanTheUserTests.md b/docs/CanTheUserTests.md index c5282683..78891da8 100644 --- a/docs/CanTheUserTests.md +++ b/docs/CanTheUserTests.md @@ -4,7 +4,7 @@ ## Methods -### `private static List generateAccounts()` +### `private static List generateAccounts()` ### `private static void canCrudAccountCreatePositive()` diff --git a/docs/CustomInvocable.md b/docs/CustomInvocable.md index a7eb32fd..0b71cd99 100644 --- a/docs/CustomInvocable.md +++ b/docs/CustomInvocable.md @@ -14,7 +14,7 @@ CustomInvocable ## Methods -### `public List daysTillChristmas(List startingDates)` +### `public List daysTillChristmas(List startingDates)` Method exposes the Apex Date method daysBetween to Flow. It accepts a single list of parameter for the start date, then calculates the days between the start date and Christmas. @@ -26,11 +26,11 @@ Method exposes the Apex Date method daysBetween to Flow. It accepts a single lis #### Returns -| Type | Description | -| ------------- | ------------------------------------------------------------------- | -| List | List List of days between the starting date and Christmas. | +| Type | Description | +| --------------- | ------------------------------------------------------------------- | +| `List` | List List of days between the starting date and Christmas. | -### `public List daysBetweenDates(List startingDates, List endingDates)` +### `public List daysBetweenDates(List startingDates, List endingDates)` This method exposes the Apex date method daysBetween to flow accepting two lists of date parameters, one for startDate and one for endDate. It calculates the days between the two dates. @@ -43,11 +43,11 @@ This method exposes the Apex date method daysBetween to flow accepting two lists #### Returns -| Type | Description | -| ------------- | --------------------------------------------------------------------- | -| List | List List of days between the starting date and ending date. | +| Type | Description | +| --------------- | --------------------------------------------------------------------- | +| `List` | List List of days between the starting date and ending date. | -### `public override List call(String methodName, List> param2)` +### `public override List call(String methodName, List> param2)` This is the method required by the BulkCallable interface. This is the method you'll need to implement in any classes you wish to expose to flow. @@ -60,11 +60,11 @@ This is the method required by the BulkCallable interface. This is the method yo #### Returns -| Type | Description | -| ------------ | --------------------------------------- | -| List | List of Objects to be returned to Flow. | +| Type | Description | +| -------------- | --------------------------------------- | +| `List` | List of Objects to be returned to Flow. | -### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` +### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` _Inherited_ @@ -80,8 +80,8 @@ Extracts values from a list of parameters. Used by implementations of the Invoca #### Returns -| Type | Description | -| ------------ | ------------------------------------------------------------------------------- | -| List | `List` The list of extracted values, in the same data type as requested | +| Type | Description | +| -------------- | ------------------------------------------------------------------------------- | +| `List` | `List` The list of extracted values, in the same data type as requested | --- diff --git a/docs/ExampleQueueableProcessSteps.md b/docs/ExampleQueueableProcessSteps.md index daa271ec..75756a22 100644 --- a/docs/ExampleQueueableProcessSteps.md +++ b/docs/ExampleQueueableProcessSteps.md @@ -28,9 +28,9 @@ A de-duplication effort to fetch the account by ID. Used only by this class' exa #### Returns -| Type | Description | -| ------- | ---------------------------------------------------- | -| Account | Account returns the account object referenced by id. | +| Type | Description | +| --------- | ---------------------------------------------------- | +| `Account` | Account returns the account object referenced by id. | --- diff --git a/docs/FF.md b/docs/FF.md index 940e3377..5f77a1e5 100644 --- a/docs/FF.md +++ b/docs/FF.md @@ -18,9 +18,9 @@ Convenience method for checking if a feature is enabled. #### Returns -| Type | Description | -| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Boolean | True if the feature is enabled by any of the following: Universally enabled, or enabled for the current user based on permission set, custom permission or time. | +| Type | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Boolean` | True if the feature is enabled by any of the following: Universally enabled, or enabled for the current user based on permission set, custom permission or time. | ### `public static Boolean isNotEnabled(String featureName)` @@ -34,9 +34,9 @@ logical inverse of the isEnabled method. #### Returns -| Type | Description | -| ------- | -------------------------------------- | -| Boolean | Boolean, returns inverse of isEnabled. | +| Type | Description | +| --------- | -------------------------------------- | +| `Boolean` | Boolean, returns inverse of isEnabled. | ### `public static String value(String featureName)` @@ -50,8 +50,8 @@ Law of diminishing returns here. This isn't tested, per-say. It's underlying Fea #### Returns -| Type | Description | -| ------ | ----------------------------------------------------------------- | -| String | String the value stored in custom metadata for this feature flag. | +| Type | Description | +| -------- | ----------------------------------------------------------------- | +| `String` | String the value stored in custom metadata for this feature flag. | --- diff --git a/docs/FailsafeExceptionHandler.md b/docs/FailsafeExceptionHandler.md index bf0fc728..11b276b6 100644 --- a/docs/FailsafeExceptionHandler.md +++ b/docs/FailsafeExceptionHandler.md @@ -92,8 +92,8 @@ Implements the Callable interface. This allows the class to be used outside of a #### Returns -| Type | Description | -| ------ | ------------------- | -| Object | Object returns null | +| Type | Description | +| -------- | ------------------- | +| `Object` | Object returns null | --- diff --git a/docs/FeatureFlag.md b/docs/FeatureFlag.md index 1ed42a2a..d08c816a 100644 --- a/docs/FeatureFlag.md +++ b/docs/FeatureFlag.md @@ -54,9 +54,9 @@ Returns the value of the specified feature flag This method is deterministic. It #### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | ### `public Boolean isEnabled(String featureFlagName)` @@ -70,9 +70,9 @@ Returns true if the specified feature flag is enabled This is the main method of #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `public Boolean isNotEnabled(String featureFlag)` @@ -86,9 +86,9 @@ Convenience method for determining if a feature flag is not enabled #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `private Boolean isUniversallyEnabled(String featureFlagName)` @@ -104,9 +104,9 @@ Logical test for global enablement of a feature #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `private Boolean isEnabledOnOrAfterToday(String featureFlagName)` @@ -126,9 +126,9 @@ Logical test for per-user enablement of a feature #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `private Boolean isEnabledByCustomPermissionForUser(String featureFlagName)` @@ -144,8 +144,8 @@ Logic gate for determining if a feature flag is enabled for this user based on a #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | --- diff --git a/docs/FeatureFlagCommonTests.md b/docs/FeatureFlagCommonTests.md index b133cf8c..9e511056 100644 --- a/docs/FeatureFlagCommonTests.md +++ b/docs/FeatureFlagCommonTests.md @@ -15,7 +15,7 @@ This is the id of the feature flag that's included with ApexKit. CMDT can be har ## Methods -### `public static Map getTestFlag(String flagName, Boolean enabled)` +### `public static Map getTestFlag(String flagName, Boolean enabled)` DRY method to create a test flag with valid-ish id. @@ -30,7 +30,7 @@ DRY method to create a test flag with valid-ish id. | Type | Description | | ------------------------------- | ------------------------------------------ | -| Map | Map test flag | +| `Map` | Map test flag | ### `public static Id getExistingPermSetId()` @@ -40,9 +40,9 @@ fetches a valid permission set id | Type | Description | | ---- | ----------------------------------------------------------- | -| Id | Id the id of the permissionset that's included with ApexKit | +| `Id` | Id the id of the permissionset that's included with ApexKit | -### `public static Map getOverriddenPerPermSet(String flagName, Id permSetId, Boolean enabled)` +### `public static Map getOverriddenPerPermSet(String flagName, Id permSetId, Boolean enabled)` returns a map of feature flags that are enabled just for a specified permission set @@ -58,6 +58,6 @@ returns a map of feature flags that are enabled just for a specified permission | Type | Description | | ------------------------------------------- | --------------------------------------------------------------------- | -| Map | Map the map of feature flags | +| `Map` | Map the map of feature flags | --- diff --git a/docs/FeatureFlagDataProvider.md b/docs/FeatureFlagDataProvider.md index 3724c64d..329ab41e 100644 --- a/docs/FeatureFlagDataProvider.md +++ b/docs/FeatureFlagDataProvider.md @@ -63,7 +63,7 @@ Used to correlate related metadata records for per-permission set enablement of ## Methods -### `public Set enablingPermissionSets(String featureFlagName)` +### `public Set enablingPermissionSets(String featureFlagName)` Returns set of ids corresponding to permission set ids that provide feature enablement for the indicated feature flag @@ -75,11 +75,11 @@ Returns set of ids corresponding to permission set ids that provide feature enab #### Returns -| Type | Description | -| ----------- | ------------------------------- | -| Set | `Set` of permission set ids | +| Type | Description | +| ------------- | ------------------------------- | +| `Set` | `Set` of permission set ids | -### `public Set enablingCustomPermissions(String featureFlagName)` +### `public Set enablingCustomPermissions(String featureFlagName)` Returns set of Strings representing custom permission names that provide feature enablement for the indicated feature flag @@ -91,19 +91,19 @@ Returns set of Strings representing custom permission names that provide feature #### Returns -| Type | Description | -| ----------- | ---------------------------------------- | -| Set | `Set` of custom permission names | +| Type | Description | +| ------------- | ---------------------------------------- | +| `Set` | `Set` of custom permission names | -### `public List fetchUsersAssignedPermissionSets()` +### `public List fetchUsersAssignedPermissionSets()` Used to find a users' assigned permission set ids. This is intentionally tied to the _executing users' userId_. #### Returns -| Type | Description | -| ------------ | --------------------------------------------------------------------- | -| List | `List` a list of permission set id's assigned to the current user | +| Type | Description | +| -------------- | --------------------------------------------------------------------- | +| `List` | `List` a list of permission set id's assigned to the current user | ### `private void overrideFlags(Map flags)` @@ -141,7 +141,7 @@ Allows testers to inject custom metadata records that are not present in the org | ------------------------------ | ---------------------------------------------------------------------------------------------------------------- | | `perCustomPermissionOverrides` | Map of flags to override this class' loading of custom metadata for per-custom-permission enablement of features | -### `private static Map rekeyMapByFeatureFlagName(Map incomingMap, Map> memoizedMap, Map correlatingMap, String keyField)` +### `private static Map> rekeyMapByFeatureFlagName(Map incomingMap, Map> memoizedMap, Map correlatingMap, String keyField)` `SUPPRESSWARNINGS` @@ -158,8 +158,8 @@ given an incoming map, create and return a new map where the keys are a from the #### Returns -| Type | Description | -| ------------------------- | ---------------------------- | -| Map> | `Map>` | +| Type | Description | +| --------------------------- | ---------------------------- | +| `Map>` | `Map>` | --- diff --git a/docs/HttpCalloutMockFactory.md b/docs/HttpCalloutMockFactory.md index 072768ee..82846d20 100644 --- a/docs/HttpCalloutMockFactory.md +++ b/docs/HttpCalloutMockFactory.md @@ -55,9 +55,9 @@ setMock can only be called once per test so to enable mocking multiple callouts, #### Returns -| Type | Description | -| ------------ | ------------ | -| HttpResponse | HttpResponse | +| Type | Description | +| -------------- | ------------ | +| `HttpResponse` | HttpResponse | ### `public static HttpResponse generateHttpResponse(Integer code, String status, String bodyAsString, Map headers)` @@ -76,8 +76,8 @@ Required method for the HttpCalloutMock interface #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HttpResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HttpResponse` | --- diff --git a/docs/IdFactory.md b/docs/IdFactory.md index 32ad2320..79a79599 100644 --- a/docs/IdFactory.md +++ b/docs/IdFactory.md @@ -38,7 +38,7 @@ this method accepts a String representation of the sObject type and defers to it | Type | Description | | ---- | ---------------------------- | -| Id | id a plausible, but bogus Id | +| `Id` | id a plausible, but bogus Id | #### Example @@ -60,7 +60,7 @@ This method accepts a Type object and defers to it's sister methods to generate | Type | Description | | ---- | ---------------------------- | -| Id | Id a plausible, but bogus Id | +| `Id` | Id a plausible, but bogus Id | #### Example @@ -82,7 +82,7 @@ This method accepts a generic SObject and defers to it's sister methods to gener | Type | Description | | ---- | ---------------------------- | -| Id | Id a plausible, but bogus Id | +| `Id` | Id a plausible, but bogus Id | ### `public static Id get(Schema incomingType)` @@ -98,7 +98,7 @@ All the other methods in this class defer to this method eventually to generate | Type | Description | | ---- | ---------------------------- | -| Id | Id a plausible, but bogus Id | +| `Id` | Id a plausible, but bogus Id | ### `private static Id getWithPrefixOverride(String prefix)` @@ -114,7 +114,7 @@ A method for getting a bogus Id for an object that may not return a prefix via s | Type | Description | | ---- | ---------------------------- | -| Id | Id a plausible, but bogus Id | +| `Id` | Id a plausible, but bogus Id | ### `private static String getUnstableObjectPrefix(String objectType)` @@ -128,9 +128,9 @@ Certain types of objects do not return a prefix via standard Schema methods. Thi #### Returns -| Type | Description | -| ------ | -------------------------------------------------- | -| String | String three character prefix for the object type. | +| Type | Description | +| -------- | -------------------------------------------------- | +| `String` | String three character prefix for the object type. | --- diff --git a/docs/Log.md b/docs/Log.md index 8be7547b..e79af034 100644 --- a/docs/Log.md +++ b/docs/Log.md @@ -38,9 +38,9 @@ Singleton pattern `get` method. #### Returns -| Type | Description | -| ---- | ----------- | -| Log | `Log` | +| Type | Description | +| ----- | ----------- | +| `Log` | `Log` | ### `public void add(String messageToLog)` diff --git a/docs/LogMessage.md b/docs/LogMessage.md index 29d34f8e..0077b6eb 100644 --- a/docs/LogMessage.md +++ b/docs/LogMessage.md @@ -80,6 +80,6 @@ converts this object to an event for publishing | Type | Description | | -------- | ----------- | -| Log\_\_e | `SObject` | +| `Log__e` | `SObject` | --- diff --git a/docs/LogTriggerHandler.md b/docs/LogTriggerHandler.md index f25046a7..6b35f2d7 100644 --- a/docs/LogTriggerHandler.md +++ b/docs/LogTriggerHandler.md @@ -90,9 +90,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -176,9 +176,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | #### Example @@ -216,9 +216,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| ------ | ---------------------------- | -| String | `String` Name of the Handler | +| Type | Description | +| -------- | ---------------------------- | +| `String` | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/MetadataTriggerFramework.md b/docs/MetadataTriggerFramework.md index 56be5f93..d995a96c 100644 --- a/docs/MetadataTriggerFramework.md +++ b/docs/MetadataTriggerFramework.md @@ -99,9 +99,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -185,9 +185,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | #### Example @@ -225,9 +225,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| ------ | ---------------------------- | -| String | `String` Name of the Handler | +| Type | Description | +| -------- | ---------------------------- | +| `String` | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/MetadataTriggerQueryService.md b/docs/MetadataTriggerQueryService.md index af14cebf..02f35628 100644 --- a/docs/MetadataTriggerQueryService.md +++ b/docs/MetadataTriggerQueryService.md @@ -27,7 +27,7 @@ Initialize objectTypeName as an empty string to avoid null errors ## Methods -### `public List getMetadataTriggers()` +### `public List getMetadataTriggers()` `SUPPRESSWARNINGS` @@ -37,7 +37,7 @@ This query finds an ordered list trigger handler classes to execute. It ignores | Type | Description | | ------------------------------------ | ------------------------------------ | -| List | `List` | +| `List` | `List` | ### `public static String getSObjectType(List triggerNew, List triggerOld)` @@ -52,9 +52,9 @@ This determines the active sObject type by describing the first record in the tr #### Returns -| Type | Description | -| ------ | ---------------------------- | -| String | `String` the ObjectType name | +| Type | Description | +| -------- | ---------------------------- | +| `String` | `String` the ObjectType name | #### Throws diff --git a/docs/MethodSignature.md b/docs/MethodSignature.md index 4c2734e8..9d798a3c 100644 --- a/docs/MethodSignature.md +++ b/docs/MethodSignature.md @@ -48,9 +48,9 @@ This is used to compare the signature of a MockedMethod, against another instanc #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------ | -| Boolean | `Boolean` true if the signatures match, false if they do not | +| Type | Description | +| --------- | ------------------------------------------------------------ | +| `Boolean` | `Boolean` true if the signatures match, false if they do not | ### `private static Boolean verifyMethodNamesMatch(String originalMethodName, String comparatorMethodName)` @@ -65,9 +65,9 @@ Returns true if the current MethodSignature's methodName is a case insensitive m #### Returns -| Type | Description | -| ------- | ----------------------------------------- | -| Boolean | `Boolean` true if the method names match, | +| Type | Description | +| --------- | ----------------------------------------- | +| `Boolean` | `Boolean` true if the method names match, | ### `public String getMethodName()` @@ -75,9 +75,9 @@ returns the method name for this signature #### Returns -| Type | Description | -| ------ | ------------------ | -| String | String method name | +| Type | Description | +| -------- | ------------------ | +| `String` | String method name | --- @@ -127,9 +127,9 @@ This variant handles the situation where a mocked method was called without para ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(List<System.Type> parameters)` @@ -143,9 +143,9 @@ Omnibus variant that handles a list(N) of parameters. ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter)` @@ -159,9 +159,9 @@ This variant handles a single parameter, brokers to omnibus method. ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2)` @@ -176,9 +176,9 @@ Two parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2, System parameter3)` @@ -194,9 +194,9 @@ Three parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2, System parameter3, System parameter4)` @@ -215,9 +215,9 @@ Four parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| ------------ | ---------------------- | -| MockedMethod | `MockedMethod.Builder` | +| Type | Description | +| -------------- | ---------------------- | +| `MockedMethod` | `MockedMethod.Builder` | ##### `public Stub finalizeSignature()` @@ -225,19 +225,19 @@ Called at the end of building a method signature. ###### Returns -| Type | Description | -| ---- | -------------- | -| Stub | `Stub.Builder` | +| Type | Description | +| ------ | -------------- | +| `Stub` | `Stub.Builder` | -##### `public List buildMockedMethod()` +##### `public List<MockedMethod> buildMockedMethod()` Creates the MockedMethod matching this method signature. ###### Returns -| Type | Description | -| ------------------------ | -------------------------- | -| List<MockedMethod> | `List<MockedMethod>` | +| Type | Description | +| -------------------------- | -------------------------- | +| `List<MockedMethod>` | `List<MockedMethod>` | --- diff --git a/docs/MockedMethod.md b/docs/MockedMethod.md index 32b33124..080b0d72 100644 --- a/docs/MockedMethod.md +++ b/docs/MockedMethod.md @@ -55,9 +55,9 @@ This method is invoked by it's parent stub object, and is responsible for return #### Returns -| Type | Description | -| ------ | ----------- | -| Object | `Object` | +| Type | Description | +| -------- | ----------- | +| `Object` | `Object` | ### `public void assertMockedMethodWasCalled()` @@ -77,9 +77,9 @@ Allows developers to define expected input parameters at execution time. This en #### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ### `public MockedMethod returning(Object returnValue)` @@ -93,9 +93,9 @@ Sets this MockedMethod's return value. This is the value that will be returned b #### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ### `public MockedMethod returning(List incomingIds)` @@ -109,9 +109,9 @@ Use this variant of returning when you want the mocked method to return a list o #### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ### `public MockedMethod throwingException()` @@ -119,9 +119,9 @@ Use this method when you need the mocked method to throw an exception. Incredibl #### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ### `public MockedMethod throwingException(Exception customException)` @@ -135,9 +135,9 @@ Use this variant to have this mocked method return a developer-specified excepti #### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ### `public Boolean doMethodSignaturesAndParametersMatch(MethodSignature methodSignature, List runtimeParameters)` @@ -152,9 +152,9 @@ determines if the current method call matches on both a method signature level a #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `private Boolean doRuntimeParametersMatch(List compareTo)` @@ -168,9 +168,9 @@ Determines if the method, as brokered by the stub object is being called with an #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | --- @@ -225,9 +225,9 @@ internal method used to set the parameter values of this MockedMethod instance. ###### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | ##### `public MockedMethod withParameterValues(Object parameter)` @@ -241,9 +241,9 @@ convenience methodfor setting a single parameter type ###### Returns -| Type | Description | -| ------------ | ----------- | -| MockedMethod | this | +| Type | Description | +| -------------- | ----------- | +| `MockedMethod` | this | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2)` @@ -258,9 +258,9 @@ convenience methodfor setting two params ###### Returns -| Type | Description | -| ------------ | ----------- | -| MockedMethod | this | +| Type | Description | +| -------------- | ----------- | +| `MockedMethod` | this | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2, Object parameter3)` @@ -276,9 +276,9 @@ convenience methodfor setting three params ###### Returns -| Type | Description | -| ------------ | ------------------ | -| MockedMethod | return description | +| Type | Description | +| -------------- | ------------------ | +| `MockedMethod` | return description | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2, Object parameter3, Object parameter4)` @@ -297,9 +297,9 @@ convenience methodfor setting four parameters ###### Returns -| Type | Description | -| ------------ | ----------- | -| MockedMethod | this | +| Type | Description | +| -------------- | ----------- | +| `MockedMethod` | this | ##### `public Stub returningObjectsWithIds(List<Id> ids)` @@ -313,9 +313,9 @@ This variant allows developers to specify a list of IDs to be assigned to the re ###### Returns -| Type | Description | -| ---- | ---------------------- | -| Stub | `MockedMethod.Builder` | +| Type | Description | +| ------ | ---------------------- | +| `Stub` | `MockedMethod.Builder` | ##### `public Stub returning(Object returnValue)` @@ -329,9 +329,9 @@ This variant allows developers to specify the object that will be returned when ###### Returns -| Type | Description | -| ---- | -------------- | -| Stub | `Stub.Builder` | +| Type | Description | +| ------ | -------------- | +| `Stub` | `Stub.Builder` | ##### `public Stub returning()` @@ -339,9 +339,9 @@ This variant allows developers to specify a void return. ###### Returns -| Type | Description | -| ---- | -------------- | -| Stub | `Stub.Builder` | +| Type | Description | +| ------ | -------------- | +| `Stub` | `Stub.Builder` | ##### `public Stub throwingException()` @@ -349,9 +349,9 @@ This variant allows developers to throw an internally generated Stub.StubExcepti ###### Returns -| Type | Description | -| ---- | -------------- | -| Stub | `Stub.Builder` | +| Type | Description | +| ------ | -------------- | +| `Stub` | `Stub.Builder` | ##### `public Stub throwingException(Exception customException)` @@ -365,9 +365,9 @@ Use this variant to have this mocked method return a developer-specified excepti ###### Returns -| Type | Description | -| ---- | -------------- | -| Stub | `MockedMethod` | +| Type | Description | +| ------ | -------------- | +| `Stub` | `MockedMethod` | ##### `public MockedMethod createMockedMethod(MethodSignature signature)` @@ -381,9 +381,9 @@ Responsible for returning a fully formed MockedMethod instance. ###### Returns -| Type | Description | -| ------------ | -------------- | -| MockedMethod | `MockedMethod` | +| Type | Description | +| -------------- | -------------- | +| `MockedMethod` | `MockedMethod` | --- diff --git a/docs/OrgShape.md b/docs/OrgShape.md index a236d7e6..b9361bb5 100644 --- a/docs/OrgShape.md +++ b/docs/OrgShape.md @@ -95,9 +95,9 @@ returns a Cache.Partition for a given name, and type #### Returns -| Type | Description | -| ----- | ----------------- | -| Cache | `Cache.Partition` | +| Type | Description | +| ------- | ----------------- | +| `Cache` | `Cache.Partition` | ### `public Boolean isPlatformCacheEnabled()` @@ -105,9 +105,9 @@ Method determines if platform cache is enabled for this org Note: fail-safes to #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `public Boolean isSeeAllDataTrue()` @@ -115,9 +115,9 @@ Certain features of the platform are incompatible with data-siloed tests. These #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | **Test** (seeAllData=true). Other platform features are incompatible with seeAllData=true. When used in a test context, this method determines if the currently running test is executing with, or without seeAllData=true. This method is therefore used to automatically disable platform features that require are incompatible with seeAllData=true. For example: platform cache is incompatible with seeAllData=true. However, our security library, CanTheUser utilizes platform cache to accelerate Crud and FLS checks. CanTheUser uses this method, in part, to determine, transparently if it should utilize platformCache during test execution Note: It is not a good idea, and against best practices to use seeAllData=true when not absolutely necessary. @@ -129,9 +129,9 @@ This method is responsible for discovering a cache partition that can be used fo #### Returns -| Type | Description | -| ----- | ----------- | -| Cache | `String` | +| Type | Description | +| ------- | ----------- | +| `Cache` | `String` | ### `public Boolean isAdvancedMultiCurrencyManagementEnabled()` @@ -139,9 +139,9 @@ Uses a dynamic soql query to determine if Advanced MultiCurrency Management is e #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | ### `private Organization getOrgShape()` @@ -153,9 +153,9 @@ Private method that memoizes the query result Suppressing the PMD warning to val #### Returns -| Type | Description | -| ------------ | -------------- | -| Organization | `Organization` | +| Type | Description | +| -------------- | -------------- | +| `Organization` | `Organization` | ### `private static Organization getOrgRecord()` @@ -165,9 +165,9 @@ Private method for pulling the Organization record Note: We're suppressing PMD w #### Returns -| Type | Description | -| ------------ | ---------------------------------- | -| Organization | `Organization` Organization Record | +| Type | Description | +| -------------- | ---------------------------------- | +| `Organization` | `Organization` Organization Record | --- @@ -197,9 +197,9 @@ We're suppressing PMD warning on Crud Checking because we want everyone to be ab ###### Returns -| Type | Description | -| ------------ | ---------------------------------------------------------- | -| Organization | `Organization` Organization Record - hopefully from cache. | +| Type | Description | +| -------------- | ---------------------------------------------------------- | +| `Organization` | `Organization` Organization Record - hopefully from cache. | --- diff --git a/docs/Ouroboros.md b/docs/Ouroboros.md index be08a639..b6e9fb20 100644 --- a/docs/Ouroboros.md +++ b/docs/Ouroboros.md @@ -27,9 +27,9 @@ This is the method that implementing classes must override. It's the method that #### Returns -| Type | Description | -| ------- | ----------------------------------------------- | -| Boolean | Boolean True if the exit criteria has been met. | +| Type | Description | +| --------- | ----------------------------------------------- | +| `Boolean` | Boolean True if the exit criteria has been met. | ### `public void execute()` @@ -41,9 +41,9 @@ This method is to be deprecated shortly, in favor of the lookup system built in #### Returns -| Type | Description | -| ------ | ----------------------------------------------------------------------------- | -| String | String class name. Currently only used in the finalizer for logging purposes. | +| Type | Description | +| -------- | ----------------------------------------------------------------------------- | +| `String` | String class name. Currently only used in the finalizer for logging purposes. | ### `public void execute(QueueableContext context)` diff --git a/docs/OuroborosFinalizer.md b/docs/OuroborosFinalizer.md index 7d27015d..48002b94 100644 --- a/docs/OuroborosFinalizer.md +++ b/docs/OuroborosFinalizer.md @@ -42,9 +42,9 @@ Method is responsible for determining if it's safe to enqueue the next iteration #### Returns -| Type | Description | -| ------- | -------------------------------------------------------------------------------------- | -| Boolean | Boolean True if enqueuing the next iteration will not violate any Apex governor limits | +| Type | Description | +| --------- | -------------------------------------------------------------------------------------- | +| `Boolean` | Boolean True if enqueuing the next iteration will not violate any Apex governor limits | ### `public void execute(FinalizerContext context)` diff --git a/docs/OuroborosTests.md b/docs/OuroborosTests.md index ca4efc2b..c3431535 100644 --- a/docs/OuroborosTests.md +++ b/docs/OuroborosTests.md @@ -48,9 +48,9 @@ Required method that returns true if the exit criteria has been met. ###### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------ | -| Boolean | Boolean - true if the exit criteria has been met, false otherwise. | +| Type | Description | +| --------- | ------------------------------------------------------------------ | +| `Boolean` | Boolean - true if the exit criteria has been met, false otherwise. | ##### `public override void execute()` diff --git a/docs/Polyfills.md b/docs/Polyfills.md index 95438714..febb477c 100644 --- a/docs/Polyfills.md +++ b/docs/Polyfills.md @@ -17,9 +17,9 @@ Used to determine what the Class name of the passed in Object is. There are many #### Returns -| Type | Description | -| ------ | ----------------------------------------------------- | -| String | String the name of the class of the passed in object. | +| Type | Description | +| -------- | ----------------------------------------------------- | +| `String` | String the name of the class of the passed in object. | ### `public static Type typeObjFromInstance(Object obj)` @@ -33,9 +33,9 @@ Method returns a Type object from an object instance. This is useful for reflect #### Returns -| Type | Description | -| ---- | ------------------------------------- | -| Type | Type the type of the passed in object | +| Type | Description | +| ------ | ------------------------------------- | +| `Type` | Type the type of the passed in object | ### `public static String getSObjectTypeFromListsFirstObject(List sObjects)` @@ -49,11 +49,11 @@ Method determines the type of a list from it's first element. This is potentiall #### Returns -| Type | Description | -| ------ | -------------------------------------------------------------------- | -| String | String the name of the SObject type of the first element in the list | +| Type | Description | +| -------- | -------------------------------------------------------------------- | +| `String` | String the name of the SObject type of the first element in the list | -### `public static Map idMapFromCollectionByKey(String key, List incomingList)` +### `public static Map idMapFromCollectionByKey(String key, List incomingList)` Method is responsible for building a map out of a list where you can specify the key. This is useful for drying up your code, as generating maps by a non-record-id key is ... common. Note: you'll need to cast this on the calling side. @@ -66,11 +66,11 @@ Method is responsible for building a map out of a list where you can specify the #### Returns -| Type | Description | -| --------------- | -------------------------------------------------------------------------- | -| Map | Map the map of the passed in list, keyed by the passed in key | +| Type | Description | +| ----------------- | -------------------------------------------------------------------------- | +| `Map` | Map the map of the passed in list, keyed by the passed in key | -### `public static Map stringMapFromCollectionByKey(String key, List incomingList)` +### `public static Map stringMapFromCollectionByKey(String key, List incomingList)` Method is responsible for building a map out of a list where you can specify the key. This is useful for drying up your code, as generating maps by a non-record-id key is ... common. Note: you'll need to cast this on the calling side. @@ -83,11 +83,11 @@ Method is responsible for building a map out of a list where you can specify the #### Returns -| Type | Description | -| ------------------- | -------------------------------------------------------------------------- | -| Map | Map the map of the passed in list, keyed by the passed in key | +| Type | Description | +| --------------------- | -------------------------------------------------------------------------- | +| `Map` | Map the map of the passed in list, keyed by the passed in key | -### `public static Map mapFromCollectionWithCollectionValues(String key, List incomingList)` +### `public static Map> mapFromCollectionWithCollectionValues(String key, List incomingList)` This method is responsible for building a map out of a list where you can specify the key. However this method is designed to help you group records by common keys. For instance, you can use this method to group a list of contacts by their accountIds by passing in 'AccountId' as the key. Note: you'll need to cast this on the calling side. The key used here must be an ID field. @@ -100,9 +100,9 @@ This method is responsible for building a map out of a list where you can specif #### Returns -| Type | Description | -| --------------------- | ---------------------------------------------------------------------------------- | -| Map> | Map> the map of the passed in list, grouped by the passed in key | +| Type | Description | +| ----------------------- | ---------------------------------------------------------------------------------- | +| `Map>` | Map> the map of the passed in list, grouped by the passed in key | ### `public static String generateStackTrace()` @@ -110,11 +110,11 @@ This method will give you a stack trace you can inspect. It's useful for debuggi #### Returns -| Type | Description | -| ------ | -------------------------------------------------------- | -| String | String The stack trace of the current execution context. | +| Type | Description | +| -------- | -------------------------------------------------------- | +| `String` | String The stack trace of the current execution context. | -### `public static List pluckFieldFromList(String fieldName, List incomingList)` +### `public static List pluckFieldFromList(String fieldName, List incomingList)` Similar to the pluck method in lodash, this method will return a list of strings from a list of SObjects, based on the field name you pass in. @@ -127,9 +127,9 @@ Similar to the pluck method in lodash, this method will return a list of strings #### Returns -| Type | Description | -| ------------ | --------------------------------------------------------------------------------------------------------------- | -| List | List list containing the string value of the field you passed in from every record in the incoming list | +| Type | Description | +| -------------- | --------------------------------------------------------------------------------------------------------------- | +| `List` | List list containing the string value of the field you passed in from every record in the incoming list | ### `public static Boolean setContainsAnyItemFromList(Set setToCheck, List listOfPossibleOptions)` @@ -144,9 +144,9 @@ Well, as much as I'd like to make this a generic method, I can't Apex doesn't pr #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------- | -| Boolean | Boolean True if any of the strings in the list are in the set | +| Type | Description | +| --------- | ------------------------------------------------------------- | +| `Boolean` | Boolean True if any of the strings in the list are in the set | ### `public static String generateUUID()` @@ -154,9 +154,9 @@ Generates a UUIDv4 string. This is useful for generating unique identifiers for #### Returns -| Type | Description | -| ------ | ---------------------- | -| String | String a UUIDv4 string | +| Type | Description | +| -------- | ---------------------- | +| `String` | String a UUIDv4 string | ### `public static Blob concatenateBlobAndString(Blob someFile, String supplementalText)` @@ -171,9 +171,9 @@ this method is useful for appending a string to a blob. Polyfill for the lack of #### Returns -| Type | Description | -| ---- | -------------------------------------------- | -| Blob | Blob the blob with the string appended to it | +| Type | Description | +| ------ | -------------------------------------------- | +| `Blob` | Blob the blob with the string appended to it | ### `public static String getStringifiedBlob(Blob someFile)` @@ -187,9 +187,9 @@ Returns the string value of a blob. Polyfill for the lack of String.valueOf(Blob #### Returns -| Type | Description | -| ------ | ----------------------------------- | -| String | A string representation of the blob | +| Type | Description | +| -------- | ----------------------------------- | +| `String` | A string representation of the blob | --- diff --git a/docs/Query.md b/docs/Query.md index 98a746f7..4bcdf894 100644 --- a/docs/Query.md +++ b/docs/Query.md @@ -264,23 +264,23 @@ Enum for null records sorting `TESTVISIBLE` -##### `private List convertToStringList(List<Date> values)` +##### `private List<String> convertToStringList(List<Date> values)` -##### `private List convertToStringList(List<Datetime> values)` +##### `private List<String> convertToStringList(List<Datetime> values)` -##### `private List convertToStringList(List<String> values)` +##### `private List<String> convertToStringList(List<String> values)` -##### `private List convertToStringList(List<Id> values)` +##### `private List<String> convertToStringList(List<Id> values)` -##### `private List convertToStringList(List<Integer> values)` +##### `private List<String> convertToStringList(List<Integer> values)` -##### `private List convertToStringList(List<Long> values)` +##### `private List<String> convertToStringList(List<Long> values)` -##### `private List convertToStringList(List<Decimal> values)` +##### `private List<String> convertToStringList(List<Decimal> values)` -##### `private List convertToStringList(List<Double> values)` +##### `private List<String> convertToStringList(List<Double> values)` -##### `private List convertToStringList(Set<Set<String>> values)` +##### `private List<String> convertToStringList(Set<Set<String>> values)` ##### `public override String toString()` diff --git a/docs/QueueableProcess.md b/docs/QueueableProcess.md index e543f6a7..37d741b3 100644 --- a/docs/QueueableProcess.md +++ b/docs/QueueableProcess.md @@ -57,9 +57,9 @@ This method provides a syntactic sugar for adding a new QueueableProcess to the #### Returns -| Type | Description | -| ---------------- | ----------------------------------------------------------------------------------------------------- | -| QueueableProcess | Returns a Queueable Process instance that can be used to chain additional QueueableProcess instances. | +| Type | Description | +| ------------------ | ----------------------------------------------------------------------------------------------------- | +| `QueueableProcess` | Returns a Queueable Process instance that can be used to chain additional QueueableProcess instances. | ### `public Id start()` @@ -69,7 +69,7 @@ This method starts the QueueableProcess chain. It's the entry point for the proc | Type | Description | | ---- | ---------------------------- | -| Id | Id - Id of the Enqueued job. | +| `Id` | Id - Id of the Enqueued job. | ### `public Id start(Object initialPassthrough)` @@ -85,7 +85,7 @@ This method starts the QueueableProcess chain. It's the entry point for the proc | Type | Description | | ---- | ---------------------------- | -| Id | Id - Id of the Enqueued job. | +| `Id` | Id - Id of the Enqueued job. | ### `public void execute()` diff --git a/docs/QueueableProcessDataProvider.md b/docs/QueueableProcessDataProvider.md index 2d4e6238..8d234655 100644 --- a/docs/QueueableProcessDataProvider.md +++ b/docs/QueueableProcessDataProvider.md @@ -27,8 +27,8 @@ This is the main method that will be called by the QueueableProcessManager. By e #### Returns -| Type | Description | -| ------ | --------------------------------------------------- | -| String | String The name of the Apex class that just failed. | +| Type | Description | +| -------- | --------------------------------------------------- | +| `String` | String The name of the Apex class that just failed. | --- diff --git a/docs/QueueableProcessTests.md b/docs/QueueableProcessTests.md index 109c4b1f..7aecdc0d 100644 --- a/docs/QueueableProcessTests.md +++ b/docs/QueueableProcessTests.md @@ -76,7 +76,7 @@ Returns the ID of the Queueable job for which this finalizer is defined. | Type | Description | | ---- | ----------- | -| Id | `Id` | +| `Id` | `Id` | ##### `public Exception getException()` @@ -84,9 +84,9 @@ Returns the exception with which the Queueable job failed when getResult is `UNH ###### Returns -| Type | Description | -| --------- | ----------- | -| Exception | `Exception` | +| Type | Description | +| ----------- | ----------- | +| `Exception` | `Exception` | ##### `public String getRequestId()` @@ -94,9 +94,9 @@ Returns the request ID, a string that uniquely identifies the request, and can b ###### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | ##### `public ParentJobResult getResult()` @@ -104,9 +104,9 @@ Returns the System.ParentJobResult enum, which represents the result of the pare ###### Returns -| Type | Description | -| --------------- | ----------------- | -| ParentJobResult | `ParentJobResult` | +| Type | Description | +| ----------------- | ----------------- | +| `ParentJobResult` | `ParentJobResult` | --- diff --git a/docs/QuiddityGuard.md b/docs/QuiddityGuard.md index 1f29f3ca..d2565c0f 100644 --- a/docs/QuiddityGuard.md +++ b/docs/QuiddityGuard.md @@ -39,9 +39,9 @@ A method to determine if the current Quiddity context is within a caller-supplie #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `boolean` | ### `public static Boolean isNotAcceptableQuiddity(List acceptableQuiddites)` @@ -55,9 +55,9 @@ Method to determine if the current Quiddity context is not acceptable #### Returns -| Type | Description | -| ------- | --------------------------------------------------------------------------------- | -| Boolean | Boolean true if the current quiddity is not in the list of acceptable quiddities. | +| Type | Description | +| --------- | --------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the current quiddity is not in the list of acceptable quiddities. | ### `public static Quiddity quiddity()` @@ -65,9 +65,9 @@ method grabs the current quiddity from the request object #### Returns -| Type | Description | -| -------- | ------------------------------ | -| Quiddity | Quiddity The current quiddity. | +| Type | Description | +| ---------- | ------------------------------ | +| `Quiddity` | Quiddity The current quiddity. | ### `public static Boolean quiddityIsATestContext()` @@ -75,8 +75,8 @@ Syntactic sugar method for determining if the current request quiddity is a know #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | Boolean true if the current quiddity is in the list of trusted test quiddities. | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | Boolean true if the current quiddity is in the list of trusted test quiddities. | --- diff --git a/docs/RestClient.md b/docs/RestClient.md index 389e35b1..e9175647 100644 --- a/docs/RestClient.md +++ b/docs/RestClient.md @@ -50,9 +50,9 @@ A static wrapper for the main makeApiCall method #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | #### Example diff --git a/docs/RestClientLib.md b/docs/RestClientLib.md index 6df5eee5..0b1c028d 100644 --- a/docs/RestClientLib.md +++ b/docs/RestClientLib.md @@ -60,9 +60,9 @@ Makes an HTTP Callout to an api resource. Convenience method that assumes the De #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HttpResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HttpResponse` | ### `protected HttpResponse makeApiCall(HttpVerb method, String path, String query)` @@ -80,9 +80,9 @@ convenience version of makeApiCall without body param. Invokes omnibus version a #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse makeApiCall(HttpVerb method, String path)` @@ -99,9 +99,9 @@ convenience version of makeApiCall without body or query params. Invokes omnibus #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse get(String path)` @@ -117,9 +117,9 @@ convenience method for a GET Call that only requires a path #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse get(String path, String query)` @@ -136,9 +136,9 @@ convenience method for a GET Call that only requires a path and query #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse del(String path)` @@ -154,9 +154,9 @@ convenience method for deleting a resource based only on path #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse del(String path, String query)` @@ -173,9 +173,9 @@ convenience method for a Delete Call that only requires a path and query #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse post(String path, String body)` @@ -192,9 +192,9 @@ convenience method for a POST Call that only requires a path and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse post(String path, String query, String body)` @@ -212,9 +212,9 @@ convenience method for a POST Call that only requires a path, query and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse put(String path, String body)` @@ -231,9 +231,9 @@ convenience method for a PUT Call that only requires a path and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse put(String path, String query, String body)` @@ -251,9 +251,9 @@ convenience method for a PUT Call that only requires a path, query and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse patch(String path, String body)` @@ -270,9 +270,9 @@ convenience method for a PATCH Call that only requires a path and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | ### `protected HttpResponse patch(String path, String query, String body)` @@ -290,8 +290,8 @@ convenience method for a PATCH Call that only requires a path, query and body #### Returns -| Type | Description | -| ------------ | -------------- | -| HttpResponse | `HTTPResponse` | +| Type | Description | +| -------------- | -------------- | +| `HttpResponse` | `HTTPResponse` | --- diff --git a/docs/RestLib.md b/docs/RestLib.md index 87aa7848..07f599b8 100644 --- a/docs/RestLib.md +++ b/docs/RestLib.md @@ -52,8 +52,8 @@ Omnibus callout method. This is the primary method for making a REST callout. Mo #### Returns -| Type | Description | -| ------------ | ----------------------------- | -| HttpResponse | HttpResponse HttpResponse Obj | +| Type | Description | +| -------------- | ----------------------------- | +| `HttpResponse` | HttpResponse HttpResponse Obj | --- diff --git a/docs/RestLibApiCall.md b/docs/RestLibApiCall.md index 80e3a4f0..140961d7 100644 --- a/docs/RestLibApiCall.md +++ b/docs/RestLibApiCall.md @@ -98,8 +98,8 @@ Ensures that the inputted string ends in a `/` makes callouts more robust. #### Returns -| Type | Description | -| ------ | --------------------------------------------------------- | -| String | inputted string with `/` if it didn't already end in one. | +| Type | Description | +| -------- | --------------------------------------------------------- | +| `String` | inputted string with `/` if it didn't already end in one. | --- diff --git a/docs/SOQL.md b/docs/SOQL.md index 5243f547..1a276ffa 100644 --- a/docs/SOQL.md +++ b/docs/SOQL.md @@ -40,7 +40,7 @@ SOFTWARE. ### `public sObject getRecord()` -### `public List getRecords()` +### `public List getRecords()` ### `public Database getQueryLocator()` diff --git a/docs/SOQLAgregate.md b/docs/SOQLAgregate.md index 872079d4..cebf5733 100644 --- a/docs/SOQLAgregate.md +++ b/docs/SOQLAgregate.md @@ -38,7 +38,7 @@ SOFTWARE. ### `public String getQueryString()` -### `public List getAggregateResults()` +### `public List getAggregateResults()` ### `public override String toString()` diff --git a/docs/SOSL.md b/docs/SOSL.md index c392d5d7..e6caf79f 100644 --- a/docs/SOSL.md +++ b/docs/SOSL.md @@ -38,7 +38,7 @@ SOFTWARE. ### `public String getQueryString()` -### `public List query()` +### `public List> query()` ### `public Search find()` diff --git a/docs/Safely.md b/docs/Safely.md index 227a359b..7cb3808f 100644 --- a/docs/Safely.md +++ b/docs/Safely.md @@ -22,9 +22,9 @@ Triggers the flag to throw an exception if fields are removed #### Returns -| Type | Description | -| ------ | ------------------------------------------------- | -| Safely | Safely - the current instance of the Safely class | +| Type | Description | +| -------- | ------------------------------------------------- | +| `Safely` | Safely - the current instance of the Safely class | ### `public Safely throwIfRemovedFields()` @@ -32,11 +32,11 @@ Sets the throwIfRemovedFields flag to true #### Returns -| Type | Description | -| ------ | ------------------------------------------------- | -| Safely | Safely - the current instance of the Safely class | +| Type | Description | +| -------- | ------------------------------------------------- | +| `Safely` | Safely - the current instance of the Safely class | -### `public List doInsert(List records)` +### `public List doInsert(List records)` A method for safely inserting a list of records @@ -48,11 +48,11 @@ A method for safely inserting a list of records #### Returns -| Type | Description | -| ------------------------- | ----------------------------------------------------- | -| List | List - the results of the insert | +| Type | Description | +| --------------------------- | ----------------------------------------------------- | +| `List` | List - the results of the insert | -### `public List doInsert(SObject record)` +### `public List doInsert(SObject record)` A method for safely inserting a single record @@ -64,11 +64,11 @@ A method for safely inserting a single record #### Returns -| Type | Description | -| ------------------------- | ----------------------------------------------------- | -| List | List - the results of the insert | +| Type | Description | +| --------------------------- | ----------------------------------------------------- | +| `List` | List - the results of the insert | -### `public List doUpdate(List records)` +### `public List doUpdate(List records)` A method for safely updating a list of records @@ -80,11 +80,11 @@ A method for safely updating a list of records #### Returns -| Type | Description | -| ------------------------- | ----------------------------------------------------- | -| List | List - the results of the update | +| Type | Description | +| --------------------------- | ----------------------------------------------------- | +| `List` | List - the results of the update | -### `public List doUpdate(SObject record)` +### `public List doUpdate(SObject record)` a method for safely updating a single record @@ -96,11 +96,11 @@ a method for safely updating a single record #### Returns -| Type | Description | -| ------------------------- | ----------------------------------------------------- | -| List | List - the results of the update | +| Type | Description | +| --------------------------- | ----------------------------------------------------- | +| `List` | List - the results of the update | -### `public List doUpsert(List records)` +### `public List doUpsert(List records)` A method for safely upserting a list of records @@ -112,11 +112,11 @@ A method for safely upserting a list of records #### Returns -| Type | Description | -| --------------------------- | ------------------------------------------------------- | -| List | List - the results of the upsert | +| Type | Description | +| ----------------------------- | ------------------------------------------------------- | +| `List` | List - the results of the upsert | -### `public List doUpsert(SObject record)` +### `public List doUpsert(SObject record)` a method for safely upserting a single record @@ -128,11 +128,11 @@ a method for safely upserting a single record #### Returns -| Type | Description | -| --------------------------- | ------------------------------------------------------- | -| List | List - the results of the upsert | +| Type | Description | +| ----------------------------- | ------------------------------------------------------- | +| `List` | List - the results of the upsert | -### `public List doDelete(List records)` +### `public List doDelete(List records)` a method for safely deleting a list of records @@ -144,11 +144,11 @@ a method for safely deleting a list of records #### Returns -| Type | Description | -| --------------------------- | ------------------------------------------------------- | -| List | List - the results of the delete | +| Type | Description | +| ----------------------------- | ------------------------------------------------------- | +| `List` | List - the results of the delete | -### `public List doDelete(SObject record)` +### `public List doDelete(SObject record)` a method for safely deleting a single record @@ -160,11 +160,11 @@ a method for safely deleting a single record #### Returns -| Type | Description | -| --------------------------- | ------------------------------------------------------------ | -| List | List - the results of the delete call | +| Type | Description | +| ----------------------------- | ------------------------------------------------------------ | +| `List` | List - the results of the delete call | -### `public List doQuery(String query)` +### `public List doQuery(String query)` A method for safely querying records @@ -176,11 +176,11 @@ A method for safely querying records #### Returns -| Type | Description | -| ------------- | ---------------------------------------- | -| List | List - the results of the query | +| Type | Description | +| --------------- | ---------------------------------------- | +| `List` | List - the results of the query | -### `private List doDML(System accessType, List records)` +### `private List doDML(System accessType, List records)` A method for safely performing DML @@ -193,9 +193,9 @@ A method for safely performing DML #### Returns -| Type | Description | -| ------------------------- | ------------------------------------------------------- | -| List | List - the results of the DML call | +| Type | Description | +| --------------------------- | ------------------------------------------------------- | +| `List` | List - the results of the DML call | ### `private SObjectAccessDecision guardAgainstRemovedFields(System accessType, List records)` @@ -210,9 +210,9 @@ method guards against removed fields by throwing an exception, if throwIfRemoved #### Returns -| Type | Description | -| --------------------- | ------------------------------------------------------------------- | -| SObjectAccessDecision | SObjectAccessDecision - the results of the Security Access Decision | +| Type | Description | +| ----------------------- | ------------------------------------------------------------------- | +| `SObjectAccessDecision` | SObjectAccessDecision - the results of the Security Access Decision | --- diff --git a/docs/SampleHandler.md b/docs/SampleHandler.md index 81ccccdb..211ecaf8 100644 --- a/docs/SampleHandler.md +++ b/docs/SampleHandler.md @@ -72,9 +72,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -158,9 +158,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | #### Example @@ -198,8 +198,8 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| ------ | ---------------------------- | -| String | `String` Name of the Handler | +| Type | Description | +| -------- | ---------------------------- | +| `String` | `String` Name of the Handler | --- diff --git a/docs/Stub.md b/docs/Stub.md index 6c71a3c9..a4e1a022 100644 --- a/docs/Stub.md +++ b/docs/Stub.md @@ -82,9 +82,9 @@ method required by the StubProvider interface. Handles the mock execution of the #### Returns -| Type | Description | -| ------ | ----------- | -| Object | `Object` | +| Type | Description | +| -------- | ----------- | +| `Object` | `Object` | ### `public void assertAllMockedMethodsWereCalled()` @@ -96,9 +96,9 @@ returns the this constructed class with it's mocked methods as a single stub obj #### Returns -| Type | Description | -| ------ | ---------------------------------------------------------- | -| Object | `Object` Needs to be cast back to the type of object used. | +| Type | Description | +| -------- | ---------------------------------------------------------- | +| `Object` | `Object` Needs to be cast back to the type of object used. | --- @@ -154,9 +154,9 @@ This method, and it's overloaded variants below, all work to add a new MockedMet ###### Returns -| Type | Description | -| --------------- | -------------------------------------------------------------------- | -| MethodSignature | `MethodSignature.Builder` - returns the builder object for chaining. | +| Type | Description | +| ----------------- | -------------------------------------------------------------------- | +| `MethodSignature` | `MethodSignature.Builder` - returns the builder object for chaining. | ##### `public MethodSignature mockingMethodCall(String methodName)` @@ -170,9 +170,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| --------------- | ------------------------- | -| MethodSignature | `MethodSignature.Builder` | +| Type | Description | +| ----------------- | ------------------------- | +| `MethodSignature` | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType)` @@ -187,9 +187,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| ------------ | ------------------------- | -| MockedMethod | `MethodSignature.Builder` | +| Type | Description | +| -------------- | ------------------------- | +| `MockedMethod` | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2)` @@ -205,9 +205,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| ------------ | ------------------------- | -| MockedMethod | `MethodSignature.Builder` | +| Type | Description | +| -------------- | ------------------------- | +| `MockedMethod` | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2, Type paramType3)` @@ -226,9 +226,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| ------------ | ------------------------- | -| MockedMethod | `MethodSignature.Builder` | +| Type | Description | +| -------------- | ------------------------- | +| `MockedMethod` | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2, Type paramType3, Type paramType4)` @@ -248,9 +248,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| ------------ | ------------------------- | -| MockedMethod | `MethodSignature.Builder` | +| Type | Description | +| -------------- | ------------------------- | +| `MockedMethod` | `MethodSignature.Builder` | ##### `public Object defineStub(Boolean generateInjectableStub)` @@ -264,9 +264,9 @@ Generates a Stub object from this builder object. ###### Returns -| Type | Description | -| ------ | ----------- | -| Object | `Stub` | +| Type | Description | +| -------- | ----------- | +| `Object` | `Stub` | ##### `public Stub defineStub()` @@ -274,9 +274,9 @@ Method generates a Stub object from this builder object. ###### Returns -| Type | Description | -| ---- | ----------------------------------------------- | -| Stub | Stub object to be used to mock the object type. | +| Type | Description | +| ------ | ----------------------------------------------- | +| `Stub` | Stub object to be used to mock the object type. | --- diff --git a/docs/StubUtilities.md b/docs/StubUtilities.md index 58663634..b4e769dc 100644 --- a/docs/StubUtilities.md +++ b/docs/StubUtilities.md @@ -12,7 +12,7 @@ a static incrementing counter tied to transaction a new comment ## Methods -### `public static List generateSObjectIds(String sObjectTypeString, Integer size)` +### `public static List generateSObjectIds(String sObjectTypeString, Integer size)` Used when you want a MockedMethod to return a set of IDs of a given sObject Type @@ -25,8 +25,8 @@ Used when you want a MockedMethod to return a set of IDs of a given sObject Type #### Returns -| Type | Description | -| -------- | ----------- | -| List | `List` | +| Type | Description | +| ---------- | ----------- | +| `List` | `List` | --- diff --git a/docs/TestFactory.md b/docs/TestFactory.md index c6a45556..eeced7cc 100644 --- a/docs/TestFactory.md +++ b/docs/TestFactory.md @@ -24,9 +24,9 @@ Creates a single sObject. #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject` | ### `public static SObject createSObject(SObject sObj, Boolean doInsert)` @@ -41,9 +41,9 @@ Creates a single sObject #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject` | ### `public static SObject createSObject(SObject sObj, String defaultClassName)` @@ -58,9 +58,9 @@ creates a single sObject #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject` | #### Throws @@ -82,11 +82,11 @@ Create a single sObject #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject` | -### `public static List createSObjectList(SObject sObj, Integer numberOfObjects)` +### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects)` Creates a list of sObjects @@ -99,11 +99,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject[]` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject[]` | -### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, Boolean doInsert)` +### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, Boolean doInsert)` Creates a list of sObjects @@ -117,11 +117,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject[]` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject[]` | -### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName, Boolean doInsert)` +### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName, Boolean doInsert)` `SUPPRESSWARNINGS` @@ -138,11 +138,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject[]` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject[]` | -### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName)` +### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName)` Creates a list of sObjects @@ -156,9 +156,9 @@ Creates a list of sObjects #### Returns -| Type | Description | -| ------- | ----------- | -| SObject | `SObject[]` | +| Type | Description | +| --------- | ----------- | +| `SObject` | `SObject[]` | ### `private static void addFieldDefaults(SObject sObj, Map defaults)` @@ -184,9 +184,9 @@ creates a test user. Useful for permissions testing #### Returns -| Type | Description | -| ---- | ----------- | -| User | `User` | +| Type | Description | +| ------ | ----------- | +| `User` | `User` | ### `public static User createTestUser(Boolean doInsert, String profileName)` @@ -201,9 +201,9 @@ Creates a test user with a given profile. #### Returns -| Type | Description | -| ---- | ----------- | -| User | `User` | +| Type | Description | +| ------ | ----------- | +| `User` | `User` | ### `public static User createMinAccessUser(Boolean doInsert)` @@ -217,9 +217,9 @@ Creates a user with the Minimum Access Profile Relies on the previous method for #### Returns -| Type | Description | -| ---- | ----------- | -| User | `User` | +| Type | Description | +| ------ | ----------- | +| `User` | `User` | ### `public static void assignPermSetToUser(User user, String permSetName)` @@ -232,7 +232,7 @@ Assigns a permission set to a given user. | `user` | User to assign the permission set to. | | `permSetName` | String name of the permission set. | -### `public static List invalidateSObjectList(List incoming)` +### `public static List invalidateSObjectList(List incoming)` Intentionally invalidates a list of sObjects. This is useful for intentionally causing DML errors during testing. @@ -244,9 +244,9 @@ Intentionally invalidates a list of sObjects. This is useful for intentionally c #### Returns -| Type | Description | -| ------------- | --------------- | -| List | `List` | +| Type | Description | +| --------------- | --------------- | +| `List` | `List` | ### `public static User createMarketingUser(Boolean doInsert)` @@ -260,9 +260,9 @@ Generates a marketing user - a user with the Marketing User profile. #### Returns -| Type | Description | -| ---- | --------------------- | -| User | User the created user | +| Type | Description | +| ------ | --------------------- | +| `User` | User the created user | ### `public static PermissionSet createPermissionSet(String permSetName, Boolean doInsert)` @@ -277,9 +277,9 @@ Generates a test permission set record - no permissions are added to it #### Returns -| Type | Description | -| ------------- | ----------------------------------------- | -| PermissionSet | PermissionSet the created permission set. | +| Type | Description | +| --------------- | ----------------------------------------- | +| `PermissionSet` | PermissionSet the created permission set. | ### `public static void enableCustomPermission(String permissionName, Id forUserId)` @@ -314,14 +314,14 @@ Use the FieldDefaults interface to set up values you want to default in for all #### Methods -##### `public Map getFieldDefaults()` +##### `public Map<Schema.SObjectField,Object> getFieldDefaults()` Interface used by implementing classes to define defaults. ###### Returns -| Type | Description | -| ------------------------------------- | ---------------------------------------- | -| Map<Schema.SObjectField,Object> | `Map<Schema.SObjectField, Object>` | +| Type | Description | +| --------------------------------------- | ---------------------------------------- | +| `Map<Schema.SObjectField,Object>` | `Map<Schema.SObjectField, Object>` | --- diff --git a/docs/TriggerContext.md b/docs/TriggerContext.md index 09b05895..d1ec0b83 100644 --- a/docs/TriggerContext.md +++ b/docs/TriggerContext.md @@ -30,9 +30,9 @@ make sure this trigger should continue to run #### Returns -| Type | Description | -| ------- | ---------------------------------------------------- | -| Boolean | `Boolean` true if the trigger should continue to run | +| Type | Description | +| --------- | ---------------------------------------------------- | +| `Boolean` | `Boolean` true if the trigger should continue to run | #### Throws diff --git a/docs/TriggerFramework.md b/docs/TriggerFramework.md index d0aa4c7f..0ca07d8b 100644 --- a/docs/TriggerFramework.md +++ b/docs/TriggerFramework.md @@ -38,9 +38,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------- | -| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| --------- | ------------------------------------------------------------------------------- | +| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | ### `private void dispatchHandlerMethod(TriggerOperation context)` @@ -124,9 +124,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| ------- | ----------- | -| Boolean | `Boolean` | +| Type | Description | +| --------- | ----------- | +| `Boolean` | `Boolean` | #### Example @@ -158,9 +158,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| ------ | ---------------------------- | -| String | `String` Name of the Handler | +| Type | Description | +| -------- | ---------------------------- | +| `String` | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/TriggerFrameworkLoopCount.md b/docs/TriggerFrameworkLoopCount.md index 8ad70214..d09cec22 100644 --- a/docs/TriggerFrameworkLoopCount.md +++ b/docs/TriggerFrameworkLoopCount.md @@ -36,9 +36,9 @@ Increment the internal counter returning the results of this.exceeded(). #### Returns -| Type | Description | -| ------- | ---------------------------------------------------------------- | -| Boolean | `Boolean` true if count will exceed max count or is less than 0. | +| Type | Description | +| --------- | ---------------------------------------------------------------- | +| `Boolean` | `Boolean` true if count will exceed max count or is less than 0. | ### `public Boolean exceeded()` @@ -46,9 +46,9 @@ Determines if this we're about to exceed the loop count. #### Returns -| Type | Description | -| ------- | ----------------------------------------------- | -| Boolean | `Boolean` true if less than 0 or more than max. | +| Type | Description | +| --------- | ----------------------------------------------- | +| `Boolean` | `Boolean` true if less than 0 or more than max. | ### `public Integer getMax()` @@ -56,9 +56,9 @@ Returns the max loop count. #### Returns -| Type | Description | -| ------- | ------------------------- | -| Integer | `Integer` max loop count. | +| Type | Description | +| --------- | ------------------------- | +| `Integer` | `Integer` max loop count. | ### `public Integer getCount()` @@ -66,9 +66,9 @@ Returns the current loop count. #### Returns -| Type | Description | -| ------- | ----------------------------- | -| Integer | `Integer` current loop count. | +| Type | Description | +| --------- | ----------------------------- | +| `Integer` | `Integer` current loop count. | ### `public void setMax(Integer max)` diff --git a/docs/UFInvocable.md b/docs/UFInvocable.md index a3920f9a..fdd00b3e 100644 --- a/docs/UFInvocable.md +++ b/docs/UFInvocable.md @@ -20,7 +20,7 @@ However, this class provides a few benefits: ## Methods -### `public List call(String methodName, List> passedParameters)` +### `public List call(String methodName, List> passedParameters)` This is a required method of the callable interface that this class implements. You'll need to extend the class you intend to expose to flow with this one, and implement this method. @@ -33,11 +33,11 @@ This is a required method of the callable interface that this class implements. #### Returns -| Type | Description | -| ------------ | -------------------------------------------------------------------------------------------- | -| List | Object This returns a generic Object. This is the return value of the method you're calling. | +| Type | Description | +| -------------- | -------------------------------------------------------------------------------------------- | +| `List` | Object This returns a generic Object. This is the return value of the method you're calling. | -### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` +### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` Extracts values from a list of parameters. Used by implementations of the Invocable framework. @@ -51,9 +51,9 @@ Extracts values from a list of parameters. Used by implementations of the Invoca #### Returns -| Type | Description | -| ------------ | ------------------------------------------------------------------------------- | -| List | `List` The list of extracted values, in the same data type as requested | +| Type | Description | +| -------------- | ------------------------------------------------------------------------------- | +| `List` | `List` The list of extracted values, in the same data type as requested | --- @@ -110,9 +110,9 @@ Used by Map/Set to identify unique values quickly ###### Returns -| Type | Description | -| ------- | ---------------------------------------------------------- | -| Integer | `Integer` returns a unique value based on x, y coordinates | +| Type | Description | +| --------- | ---------------------------------------------------------- | +| `Integer` | `Integer` returns a unique value based on x, y coordinates | ##### `public Boolean equals(Object other)` @@ -126,9 +126,9 @@ checks if the current instance is equal to another ###### Returns -| Type | Description | -| ------- | -------------------------------------------------------------------- | -| Boolean | `Boolean` returns `true` if the objects are equal, `false` otherwise | +| Type | Description | +| --------- | -------------------------------------------------------------------- | +| `Boolean` | `Boolean` returns `true` if the objects are equal, `false` otherwise | ##### `public Integer compareTo(Object other)` @@ -140,9 +140,9 @@ checks if the current instance is equal to another ###### Returns -| Type | Description | -| ------- | ------------------------------------------------------------------------------ | -| Integer | `Integer` negative when `this` is smaller, positive when greater, 0 when equal | +| Type | Description | +| --------- | ------------------------------------------------------------------------------ | +| `Integer` | `Integer` negative when `this` is smaller, positive when greater, 0 when equal | --- @@ -194,23 +194,23 @@ Constructor used for single bulkified flow processing #### Methods -##### `public List execute()` +##### `public List<UniversalFlowInputOutput> execute()` processes a single bulkified flow ###### Returns -| Type | Description | -| ------------------------------------ | ---------------------------------------------------------------------------------------- | -| List<UniversalFlowInputOutput> | `List<UniversalFlowInputOutput>` the flow inputs from a bulkified flow transaction | +| Type | Description | +| -------------------------------------- | ---------------------------------------------------------------------------------------- | +| `List<UniversalFlowInputOutput>` | `List<UniversalFlowInputOutput>` the flow inputs from a bulkified flow transaction | -##### `public List executeBulk()` +##### `public List<List<UniversalFlowInputOutput>> executeBulk()` ###### Returns -| Type | Description | -| ------------------------------------------------ | --------------------------------------------------------------------------------------------------- | -| List<List<UniversalFlowInputOutput>> | `List<List<UniversalFlowInputOutput>>` the flow inputs from a collection of flow inputs | +| Type | Description | +| -------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `List<List<UniversalFlowInputOutput>>` | `List<List<UniversalFlowInputOutput>>` the flow inputs from a collection of flow inputs | ##### `private void prepare()` diff --git a/docs/ULID.md b/docs/ULID.md index 927f070e..6b6bd2a7 100644 --- a/docs/ULID.md +++ b/docs/ULID.md @@ -31,9 +31,9 @@ Generates a ULID string according to spec. https://github.com/ulid/spec #### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | ### `private static String encodeTimestamp(Long dtSeed, Long timeLength)` @@ -48,9 +48,9 @@ Encodes a given timestamp into characters from the acceptable character set abov #### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | ### `private static String generateRandomString(Integer length)` @@ -64,9 +64,9 @@ generates a random string from the character set of a given length. #### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | ### `private static String fetchRandomCharacterFromCharacterSet()` @@ -74,8 +74,8 @@ pulls a random character from the character set. #### Returns -| Type | Description | -| ------ | ----------- | -| String | `String` | +| Type | Description | +| -------- | ----------- | +| `String` | `String` | --- diff --git a/docs/UniversalBulkInvocable.md b/docs/UniversalBulkInvocable.md index f2be89ea..b87ae150 100644 --- a/docs/UniversalBulkInvocable.md +++ b/docs/UniversalBulkInvocable.md @@ -4,7 +4,7 @@ This class contains the one and only invocable method that will be displayed in ## Methods -### `public static List invoke(List> inputs)` +### `public static List> invoke(List> inputs)` `INVOCABLEMETHOD` @@ -18,8 +18,8 @@ This method is what will be displayed in the flow builder. This method can corre #### Returns -| Type | Description | -| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | -| List> | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | +| Type | Description | +| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `List>` | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | --- diff --git a/docs/UniversalFlowInputOutput.md b/docs/UniversalFlowInputOutput.md index 6040c1a1..ab134cbf 100644 --- a/docs/UniversalFlowInputOutput.md +++ b/docs/UniversalFlowInputOutput.md @@ -62,15 +62,15 @@ While the parameters list is used for passing parameters to the method you're ca ## Methods -### `public Map toCallableParamMap()` +### `public Map toCallableParamMap()` Method is responsible for converting the list of UniversalFlowInputOutputParameter objects delivered by the Flow action framework, to a Map<String, Object> needed by the Callable interface. Note, this is a hard limitation of the Flow action framework and the Apex Defined Data Types. This is not a limitation of this pattern / framework. If you want to, say pass a list of records to a method, you'll need to pass a list of strings, and query for the objects in the Apex. #sorryNothingICanDo. #### Returns -| Type | Description | -| ------------------ | ----------------------------------------------------------------------------------- | -| Map | Map This returns a map of parameters you're passing to your method. | +| Type | Description | +| -------------------- | ----------------------------------------------------------------------------------- | +| `Map` | Map This returns a map of parameters you're passing to your method. | ### `public override String toString()` @@ -78,8 +78,8 @@ Used to provide a usable key for the Map that uses this method. #### Returns -| Type | Description | -| ------ | -------------------------------------------------- | -| String | `String` This value maps unique class/method names | +| Type | Description | +| -------- | -------------------------------------------------- | +| `String` | `String` This value maps unique class/method names | --- diff --git a/docs/UniversalInvocable.md b/docs/UniversalInvocable.md index 6390853d..c1bbcca3 100644 --- a/docs/UniversalInvocable.md +++ b/docs/UniversalInvocable.md @@ -6,7 +6,7 @@ invoked by this single invocable method. ## Methods -### `public static List invoke(List inputs)` +### `public static List invoke(List inputs)` `INVOCABLEMETHOD` @@ -20,8 +20,8 @@ This method is what will be displayed in the flow builder. This method can corre #### Returns -| Type | Description | -| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | -| List | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | +| Type | Description | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `List` | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | --- From 9ff506b9360efad23d67d31f5f69c936370b41a9 Mon Sep 17 00:00:00 2001 From: Kevin Poorman Date: Thu, 19 Oct 2023 16:47:48 -0700 Subject: [PATCH 17/21] Update project-scratch-def.json From 0efb55e19ccf1da11c26b7838fb396b0755cbf29 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Thu, 19 Oct 2023 16:53:09 -0700 Subject: [PATCH 18/21] fix(project-scratch-def): removing pre-release Signed-off-by: kpoorman --- config/project-scratch-def.json | 1 - 1 file changed, 1 deletion(-) diff --git a/config/project-scratch-def.json b/config/project-scratch-def.json index e20a86e3..5fd23329 100644 --- a/config/project-scratch-def.json +++ b/config/project-scratch-def.json @@ -2,7 +2,6 @@ "orgName": "ApexKit Company", "description": "ApexKitV2.5", "edition": "Developer", - "release": "preview", "hasSampleData": true, "features": [ "EinsteinGPTForDevelopers", From b8486d1a6a783eff38c46f7bb05fbedb8c48a3c7 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Thu, 19 Oct 2023 17:52:22 -0700 Subject: [PATCH 19/21] fix(project-scratch-def): removing pre-release Signed-off-by: kpoorman --- .github/workflows/ci-pr.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index 6e4aa685..f8364413 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -138,10 +138,10 @@ jobs: - name: 'Authenticate Dev Hub' run: sf org login sfdx-url -f ./DEVHUB_SFDX_URL.txt -a devhub -d - # Create prerelease scratch org - - name: 'Create prerelease scratch org' - if: ${{ env.IS_PRERELEASE }} - run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview + # # Create prerelease scratch org + # - name: 'Create prerelease scratch org' + # if: ${{ env.IS_PRERELEASE }} + # run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 --release=preview # Create scratch org - name: 'Create scratch org' From 56bec3ac4f9b65789d0a484f8421745d7d8e3dc4 Mon Sep 17 00:00:00 2001 From: kpoorman Date: Thu, 19 Oct 2023 19:16:18 -0700 Subject: [PATCH 20/21] fix(project-scratch-def): removing pre-release check from create scratch org Signed-off-by: kpoorman --- .github/workflows/ci-pr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index f8364413..1e5a8a27 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -145,7 +145,7 @@ jobs: # Create scratch org - name: 'Create scratch org' - if: ${{ !env.IS_PRERELEASE }} + # if: ${{ !env.IS_PRERELEASE }} run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 # Deploy source to scratch org From e0115b6201de0e4700a11fb00cc49870602f0caf Mon Sep 17 00:00:00 2001 From: David Schach Date: Fri, 27 Oct 2023 17:43:17 -0700 Subject: [PATCH 21/21] rename directory, update exclusions --- .gitignore | 1 - docs/BulkCallable.md | 8 +- docs/CanTheUser.md | 150 +++++++++--------- docs/CanTheUserTests.md | 2 +- docs/CustomInvocable.md | 32 ++-- docs/ExampleQueueableProcessSteps.md | 6 +- docs/FF.md | 18 +-- docs/FailsafeExceptionHandler.md | 6 +- docs/FeatureFlag.md | 36 ++--- docs/FeatureFlagCommonTests.md | 10 +- docs/FeatureFlagDataProvider.md | 32 ++-- docs/HttpCalloutMockFactory.md | 12 +- docs/IdFactory.md | 16 +- docs/Log.md | 6 +- docs/LogMessage.md | 2 +- docs/LogTriggerHandler.md | 18 +-- docs/MetadataTriggerFramework.md | 18 +-- docs/MetadataTriggerQueryService.md | 10 +- docs/MethodSignature.md | 68 ++++---- docs/MockedMethod.md | 114 ++++++------- docs/OrgShape.md | 48 +++--- docs/Ouroboros.md | 12 +- docs/OuroborosFinalizer.md | 6 +- docs/OuroborosTests.md | 6 +- docs/Polyfills.md | 80 +++++----- docs/Query.md | 18 +-- docs/QueueableProcess.md | 10 +- docs/QueueableProcessDataProvider.md | 6 +- docs/QueueableProcessTests.md | 20 +-- docs/QuiddityGuard.md | 24 +-- docs/RestClient.md | 6 +- docs/RestClientLib.md | 78 ++++----- docs/RestLib.md | 6 +- docs/RestLibApiCall.md | 6 +- docs/SOQL.md | 2 +- docs/SOQLAgregate.md | 2 +- docs/SOSL.md | 2 +- docs/Safely.md | 98 ++++++------ docs/SampleHandler.md | 18 +-- docs/Stub.md | 60 +++---- docs/StubUtilities.md | 8 +- docs/TestFactory.md | 102 ++++++------ docs/TriggerContext.md | 6 +- docs/TriggerFramework.md | 18 +-- docs/TriggerFrameworkLoopCount.md | 24 +-- docs/UFInvocable.md | 50 +++--- docs/ULID.md | 24 +-- docs/UniversalBulkInvocable.md | 8 +- docs/UniversalFlowInputOutput.md | 14 +- docs/UniversalInvocable.md | 8 +- .../Tuple.cls | 0 .../Tuple.cls-meta.xml | 0 pmd/ruleset.xml | 3 + 53 files changed, 670 insertions(+), 668 deletions(-) rename force-app/main/default/classes/{Data Structures => dataStructures}/Tuple.cls (100%) rename force-app/main/default/classes/{Data Structures => dataStructures}/Tuple.cls-meta.xml (100%) diff --git a/.gitignore b/.gitignore index 929f49b4..64c3342d 100644 --- a/.gitignore +++ b/.gitignore @@ -43,6 +43,5 @@ $RECYCLE.BIN/ .pmdCache /IlluminatedCloud/ApexKit_Company/OfflineSymbolTable.zip /force-app/main/default/profiles/*.profile-meta.xml -pmd/pmd.csv /.idea/sonarlint/ /pmd/*.csv diff --git a/docs/BulkCallable.md b/docs/BulkCallable.md index ee6c6f07..a0aedaba 100644 --- a/docs/BulkCallable.md +++ b/docs/BulkCallable.md @@ -6,7 +6,7 @@ Provides a similar interface to Callable, but bulkified to handle multiple sets ## Methods -### `public List call(String methodName, List> parameters)` +### `public List call(String methodName, List> parameters)` Implementing classes must implement this method signature. @@ -19,8 +19,8 @@ Implementing classes must implement this method signature. #### Returns -| Type | Description | -| -------------- | --------------------------------------------------- | -| `List` | List The results of the called Apex methods | +| Type | Description | +| ------------ | --------------------------------------------------- | +| List | List The results of the called Apex methods | --- diff --git a/docs/CanTheUser.md b/docs/CanTheUser.md index 07dfafa6..7907b9ab 100644 --- a/docs/CanTheUser.md +++ b/docs/CanTheUser.md @@ -39,9 +39,9 @@ A method to determine if the running user can perform the specified CRUD operati #### Returns -| Type | Description | -| --------- | ----------------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the specified object | +| Type | Description | +| ------- | ----------------------------------------------------------------------------------------- | +| Boolean | Boolean true if the user can perform the specified CRUD operation on the specified object | #### Example @@ -64,9 +64,9 @@ a list accepting version of the crud method. It returns CRUD results for the fir #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the first object in the list | +| Type | Description | +| ------- | ------------------------------------------------------------------------------------------------- | +| Boolean | Boolean true if the user can perform the specified CRUD operation on the first object in the list | ### `private static Boolean crud(String objectName, CrudType permission)` @@ -83,9 +83,9 @@ A method to determine if the running user can perform the specified CRUD operati #### Returns -| Type | Description | -| --------- | ----------------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can perform the specified CRUD operation on the specified object | +| Type | Description | +| ------- | ----------------------------------------------------------------------------------------- | +| Boolean | Boolean true if the user can perform the specified CRUD operation on the specified object | ### `public static Boolean create(SObject obj)` @@ -99,9 +99,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can create the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can create the specified object | #### Example @@ -121,9 +121,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| --------- | ---------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can create the first object in the list | +| Type | Description | +| ------- | ---------------------------------------------------------------- | +| Boolean | Boolean true if the user can create the first object in the list | ### `public static Boolean create(String objName)` @@ -137,9 +137,9 @@ convenience api for determining if the running user can create the specified obj #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can create the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can create the specified object | #### Example @@ -159,9 +159,9 @@ convenience api for determining if the running user can read / access the specif #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can read the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can read the specified object | #### Example @@ -181,9 +181,9 @@ convenience api for determining if the running user can read / access the specif #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can read the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can read the specified object | ### `public static Boolean read(String objName)` @@ -197,9 +197,9 @@ convenience api for determining if the running user can read the specified objec #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can read the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can read the specified object | #### Example @@ -219,9 +219,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can edit the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can edit the specified object | #### Example @@ -241,9 +241,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can edit the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can edit the specified object | ### `public static Boolean edit(String objName)` @@ -257,9 +257,9 @@ convenience api for determining if the running user can edit the specified objec #### Returns -| Type | Description | -| --------- | ------------------------------------------------------ | -| `Boolean` | Boolean true if the user can edit the specified object | +| Type | Description | +| ------- | ------------------------------------------------------ | +| Boolean | Boolean true if the user can edit the specified object | #### Example @@ -279,9 +279,9 @@ convenience api for determining if the running user can upsert (insert and updat #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can upsert the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can upsert the specified object | #### Example @@ -301,9 +301,9 @@ convenience api for determining if the running user can edit / update the specif #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can upsert the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can upsert the specified object | ### `public static Boolean ups(String objName)` @@ -317,9 +317,9 @@ convenience api for determining if the running user can upsert the specified obj #### Returns -| Type | Description | -| --------- | --------------------------------------------------------- | -| `Boolean` | Boolean true if the user can upsert the specified objects | +| Type | Description | +| ------- | --------------------------------------------------------- | +| Boolean | Boolean true if the user can upsert the specified objects | #### Example @@ -339,9 +339,9 @@ convenience api for determining if the running user can delete/destroy the speci #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can delete the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can delete the specified object | #### Example @@ -361,9 +361,9 @@ convenience api for determining if the running user can delete the specified obj #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can delete the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can delete the specified object | ### `public static Boolean destroy(String objName)` @@ -377,9 +377,9 @@ convenience api for determining if the running user can delete the specified obj #### Returns -| Type | Description | -| --------- | -------------------------------------------------------- | -| `Boolean` | Boolean true if the user can delete the specified object | +| Type | Description | +| ------- | -------------------------------------------------------- | +| Boolean | Boolean true if the user can delete the specified object | #### Example @@ -400,9 +400,9 @@ public static method to determine if a given field on a given object is Accessib #### Returns -| Type | Description | -| --------- | ----------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can read the specified field on the specified object | +| Type | Description | +| ------- | ----------------------------------------------------------------------------- | +| Boolean | Boolean true if the user can read the specified field on the specified object | #### Example @@ -410,7 +410,7 @@ public static method to determine if a given field on a given object is Accessib System.debug(CanTheUser.flsAccessible('Account', 'Name')); ``` -### `public static Map bulkFLSAccessible(String obj, Set fields)` +### `public static Map bulkFLSAccessible(String obj, Set fields)` bulk form of flsAccessible @@ -423,9 +423,9 @@ bulk form of flsAccessible #### Returns -| Type | Description | -| --------------------- | ----------------------------------------------------------------------------------------- | -| `Map` | `Map` where the key is the field name and the value is the accessibility | +| Type | Description | +| ------------------- | ----------------------------------------------------------------------------------------- | +| Map | `Map` where the key is the field name and the value is the accessibility | #### Example @@ -447,9 +447,9 @@ public static method to determine if a given field on a given object is Updatabl #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the user can update the specified field on the specified object | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | Boolean true if the user can update the specified field on the specified object | #### Example @@ -457,7 +457,7 @@ public static method to determine if a given field on a given object is Updatabl System.debug(CanTheUser.flsUpdatable('Account', 'Name')); ``` -### `public static Map bulkFLSUpdatable(String obj, Set fields)` +### `public static Map bulkFLSUpdatable(String obj, Set fields)` bulk form of flsUpdatable call @@ -470,9 +470,9 @@ bulk form of flsUpdatable call #### Returns -| Type | Description | -| --------------------- | ---------------------------------------------------------------------------------------- | -| `Map` | `Map` where the key is the field name and the value is the updatability | +| Type | Description | +| ------------------- | ---------------------------------------------------------------------------------------- | +| Map | `Map` where the key is the field name and the value is the updatability | #### Example @@ -495,11 +495,11 @@ Abstracted method for retrieving or calculating (memoization) of the FLS for a g #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | -### `private static Map> calculateFLS(String objType)` +### `private static Map calculateFLS(String objType)` Calculates the FLS for a given object type @@ -511,9 +511,9 @@ Calculates the FLS for a given object type #### Returns -| Type | Description | -| ---------------------------------- | ------------------------------------ | -| `Map>` | `Map>` | +| Type | Description | +| -------------------------------- | ------------------------------------ | +| Map> | `Map>` | --- diff --git a/docs/CanTheUserTests.md b/docs/CanTheUserTests.md index 78891da8..c5282683 100644 --- a/docs/CanTheUserTests.md +++ b/docs/CanTheUserTests.md @@ -4,7 +4,7 @@ ## Methods -### `private static List generateAccounts()` +### `private static List generateAccounts()` ### `private static void canCrudAccountCreatePositive()` diff --git a/docs/CustomInvocable.md b/docs/CustomInvocable.md index 0b71cd99..a7eb32fd 100644 --- a/docs/CustomInvocable.md +++ b/docs/CustomInvocable.md @@ -14,7 +14,7 @@ CustomInvocable ## Methods -### `public List daysTillChristmas(List startingDates)` +### `public List daysTillChristmas(List startingDates)` Method exposes the Apex Date method daysBetween to Flow. It accepts a single list of parameter for the start date, then calculates the days between the start date and Christmas. @@ -26,11 +26,11 @@ Method exposes the Apex Date method daysBetween to Flow. It accepts a single lis #### Returns -| Type | Description | -| --------------- | ------------------------------------------------------------------- | -| `List` | List List of days between the starting date and Christmas. | +| Type | Description | +| ------------- | ------------------------------------------------------------------- | +| List | List List of days between the starting date and Christmas. | -### `public List daysBetweenDates(List startingDates, List endingDates)` +### `public List daysBetweenDates(List startingDates, List endingDates)` This method exposes the Apex date method daysBetween to flow accepting two lists of date parameters, one for startDate and one for endDate. It calculates the days between the two dates. @@ -43,11 +43,11 @@ This method exposes the Apex date method daysBetween to flow accepting two lists #### Returns -| Type | Description | -| --------------- | --------------------------------------------------------------------- | -| `List` | List List of days between the starting date and ending date. | +| Type | Description | +| ------------- | --------------------------------------------------------------------- | +| List | List List of days between the starting date and ending date. | -### `public override List call(String methodName, List> param2)` +### `public override List call(String methodName, List> param2)` This is the method required by the BulkCallable interface. This is the method you'll need to implement in any classes you wish to expose to flow. @@ -60,11 +60,11 @@ This is the method required by the BulkCallable interface. This is the method yo #### Returns -| Type | Description | -| -------------- | --------------------------------------- | -| `List` | List of Objects to be returned to Flow. | +| Type | Description | +| ------------ | --------------------------------------- | +| List | List of Objects to be returned to Flow. | -### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` +### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` _Inherited_ @@ -80,8 +80,8 @@ Extracts values from a list of parameters. Used by implementations of the Invoca #### Returns -| Type | Description | -| -------------- | ------------------------------------------------------------------------------- | -| `List` | `List` The list of extracted values, in the same data type as requested | +| Type | Description | +| ------------ | ------------------------------------------------------------------------------- | +| List | `List` The list of extracted values, in the same data type as requested | --- diff --git a/docs/ExampleQueueableProcessSteps.md b/docs/ExampleQueueableProcessSteps.md index 75756a22..daa271ec 100644 --- a/docs/ExampleQueueableProcessSteps.md +++ b/docs/ExampleQueueableProcessSteps.md @@ -28,9 +28,9 @@ A de-duplication effort to fetch the account by ID. Used only by this class' exa #### Returns -| Type | Description | -| --------- | ---------------------------------------------------- | -| `Account` | Account returns the account object referenced by id. | +| Type | Description | +| ------- | ---------------------------------------------------- | +| Account | Account returns the account object referenced by id. | --- diff --git a/docs/FF.md b/docs/FF.md index 5f77a1e5..940e3377 100644 --- a/docs/FF.md +++ b/docs/FF.md @@ -18,9 +18,9 @@ Convenience method for checking if a feature is enabled. #### Returns -| Type | Description | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Boolean` | True if the feature is enabled by any of the following: Universally enabled, or enabled for the current user based on permission set, custom permission or time. | +| Type | Description | +| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Boolean | True if the feature is enabled by any of the following: Universally enabled, or enabled for the current user based on permission set, custom permission or time. | ### `public static Boolean isNotEnabled(String featureName)` @@ -34,9 +34,9 @@ logical inverse of the isEnabled method. #### Returns -| Type | Description | -| --------- | -------------------------------------- | -| `Boolean` | Boolean, returns inverse of isEnabled. | +| Type | Description | +| ------- | -------------------------------------- | +| Boolean | Boolean, returns inverse of isEnabled. | ### `public static String value(String featureName)` @@ -50,8 +50,8 @@ Law of diminishing returns here. This isn't tested, per-say. It's underlying Fea #### Returns -| Type | Description | -| -------- | ----------------------------------------------------------------- | -| `String` | String the value stored in custom metadata for this feature flag. | +| Type | Description | +| ------ | ----------------------------------------------------------------- | +| String | String the value stored in custom metadata for this feature flag. | --- diff --git a/docs/FailsafeExceptionHandler.md b/docs/FailsafeExceptionHandler.md index 11b276b6..bf0fc728 100644 --- a/docs/FailsafeExceptionHandler.md +++ b/docs/FailsafeExceptionHandler.md @@ -92,8 +92,8 @@ Implements the Callable interface. This allows the class to be used outside of a #### Returns -| Type | Description | -| -------- | ------------------- | -| `Object` | Object returns null | +| Type | Description | +| ------ | ------------------- | +| Object | Object returns null | --- diff --git a/docs/FeatureFlag.md b/docs/FeatureFlag.md index d08c816a..1ed42a2a 100644 --- a/docs/FeatureFlag.md +++ b/docs/FeatureFlag.md @@ -54,9 +54,9 @@ Returns the value of the specified feature flag This method is deterministic. It #### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | ### `public Boolean isEnabled(String featureFlagName)` @@ -70,9 +70,9 @@ Returns true if the specified feature flag is enabled This is the main method of #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `public Boolean isNotEnabled(String featureFlag)` @@ -86,9 +86,9 @@ Convenience method for determining if a feature flag is not enabled #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `private Boolean isUniversallyEnabled(String featureFlagName)` @@ -104,9 +104,9 @@ Logical test for global enablement of a feature #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `private Boolean isEnabledOnOrAfterToday(String featureFlagName)` @@ -126,9 +126,9 @@ Logical test for per-user enablement of a feature #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `private Boolean isEnabledByCustomPermissionForUser(String featureFlagName)` @@ -144,8 +144,8 @@ Logic gate for determining if a feature flag is enabled for this user based on a #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | --- diff --git a/docs/FeatureFlagCommonTests.md b/docs/FeatureFlagCommonTests.md index 9e511056..b133cf8c 100644 --- a/docs/FeatureFlagCommonTests.md +++ b/docs/FeatureFlagCommonTests.md @@ -15,7 +15,7 @@ This is the id of the feature flag that's included with ApexKit. CMDT can be har ## Methods -### `public static Map getTestFlag(String flagName, Boolean enabled)` +### `public static Map getTestFlag(String flagName, Boolean enabled)` DRY method to create a test flag with valid-ish id. @@ -30,7 +30,7 @@ DRY method to create a test flag with valid-ish id. | Type | Description | | ------------------------------- | ------------------------------------------ | -| `Map` | Map test flag | +| Map | Map test flag | ### `public static Id getExistingPermSetId()` @@ -40,9 +40,9 @@ fetches a valid permission set id | Type | Description | | ---- | ----------------------------------------------------------- | -| `Id` | Id the id of the permissionset that's included with ApexKit | +| Id | Id the id of the permissionset that's included with ApexKit | -### `public static Map getOverriddenPerPermSet(String flagName, Id permSetId, Boolean enabled)` +### `public static Map getOverriddenPerPermSet(String flagName, Id permSetId, Boolean enabled)` returns a map of feature flags that are enabled just for a specified permission set @@ -58,6 +58,6 @@ returns a map of feature flags that are enabled just for a specified permission | Type | Description | | ------------------------------------------- | --------------------------------------------------------------------- | -| `Map` | Map the map of feature flags | +| Map | Map the map of feature flags | --- diff --git a/docs/FeatureFlagDataProvider.md b/docs/FeatureFlagDataProvider.md index 329ab41e..3724c64d 100644 --- a/docs/FeatureFlagDataProvider.md +++ b/docs/FeatureFlagDataProvider.md @@ -63,7 +63,7 @@ Used to correlate related metadata records for per-permission set enablement of ## Methods -### `public Set enablingPermissionSets(String featureFlagName)` +### `public Set enablingPermissionSets(String featureFlagName)` Returns set of ids corresponding to permission set ids that provide feature enablement for the indicated feature flag @@ -75,11 +75,11 @@ Returns set of ids corresponding to permission set ids that provide feature enab #### Returns -| Type | Description | -| ------------- | ------------------------------- | -| `Set` | `Set` of permission set ids | +| Type | Description | +| ----------- | ------------------------------- | +| Set | `Set` of permission set ids | -### `public Set enablingCustomPermissions(String featureFlagName)` +### `public Set enablingCustomPermissions(String featureFlagName)` Returns set of Strings representing custom permission names that provide feature enablement for the indicated feature flag @@ -91,19 +91,19 @@ Returns set of Strings representing custom permission names that provide feature #### Returns -| Type | Description | -| ------------- | ---------------------------------------- | -| `Set` | `Set` of custom permission names | +| Type | Description | +| ----------- | ---------------------------------------- | +| Set | `Set` of custom permission names | -### `public List fetchUsersAssignedPermissionSets()` +### `public List fetchUsersAssignedPermissionSets()` Used to find a users' assigned permission set ids. This is intentionally tied to the _executing users' userId_. #### Returns -| Type | Description | -| -------------- | --------------------------------------------------------------------- | -| `List` | `List` a list of permission set id's assigned to the current user | +| Type | Description | +| ------------ | --------------------------------------------------------------------- | +| List | `List` a list of permission set id's assigned to the current user | ### `private void overrideFlags(Map flags)` @@ -141,7 +141,7 @@ Allows testers to inject custom metadata records that are not present in the org | ------------------------------ | ---------------------------------------------------------------------------------------------------------------- | | `perCustomPermissionOverrides` | Map of flags to override this class' loading of custom metadata for per-custom-permission enablement of features | -### `private static Map> rekeyMapByFeatureFlagName(Map incomingMap, Map> memoizedMap, Map correlatingMap, String keyField)` +### `private static Map rekeyMapByFeatureFlagName(Map incomingMap, Map> memoizedMap, Map correlatingMap, String keyField)` `SUPPRESSWARNINGS` @@ -158,8 +158,8 @@ given an incoming map, create and return a new map where the keys are a from the #### Returns -| Type | Description | -| --------------------------- | ---------------------------- | -| `Map>` | `Map>` | +| Type | Description | +| ------------------------- | ---------------------------- | +| Map> | `Map>` | --- diff --git a/docs/HttpCalloutMockFactory.md b/docs/HttpCalloutMockFactory.md index 82846d20..072768ee 100644 --- a/docs/HttpCalloutMockFactory.md +++ b/docs/HttpCalloutMockFactory.md @@ -55,9 +55,9 @@ setMock can only be called once per test so to enable mocking multiple callouts, #### Returns -| Type | Description | -| -------------- | ------------ | -| `HttpResponse` | HttpResponse | +| Type | Description | +| ------------ | ------------ | +| HttpResponse | HttpResponse | ### `public static HttpResponse generateHttpResponse(Integer code, String status, String bodyAsString, Map headers)` @@ -76,8 +76,8 @@ Required method for the HttpCalloutMock interface #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HttpResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HttpResponse` | --- diff --git a/docs/IdFactory.md b/docs/IdFactory.md index 79a79599..32ad2320 100644 --- a/docs/IdFactory.md +++ b/docs/IdFactory.md @@ -38,7 +38,7 @@ this method accepts a String representation of the sObject type and defers to it | Type | Description | | ---- | ---------------------------- | -| `Id` | id a plausible, but bogus Id | +| Id | id a plausible, but bogus Id | #### Example @@ -60,7 +60,7 @@ This method accepts a Type object and defers to it's sister methods to generate | Type | Description | | ---- | ---------------------------- | -| `Id` | Id a plausible, but bogus Id | +| Id | Id a plausible, but bogus Id | #### Example @@ -82,7 +82,7 @@ This method accepts a generic SObject and defers to it's sister methods to gener | Type | Description | | ---- | ---------------------------- | -| `Id` | Id a plausible, but bogus Id | +| Id | Id a plausible, but bogus Id | ### `public static Id get(Schema incomingType)` @@ -98,7 +98,7 @@ All the other methods in this class defer to this method eventually to generate | Type | Description | | ---- | ---------------------------- | -| `Id` | Id a plausible, but bogus Id | +| Id | Id a plausible, but bogus Id | ### `private static Id getWithPrefixOverride(String prefix)` @@ -114,7 +114,7 @@ A method for getting a bogus Id for an object that may not return a prefix via s | Type | Description | | ---- | ---------------------------- | -| `Id` | Id a plausible, but bogus Id | +| Id | Id a plausible, but bogus Id | ### `private static String getUnstableObjectPrefix(String objectType)` @@ -128,9 +128,9 @@ Certain types of objects do not return a prefix via standard Schema methods. Thi #### Returns -| Type | Description | -| -------- | -------------------------------------------------- | -| `String` | String three character prefix for the object type. | +| Type | Description | +| ------ | -------------------------------------------------- | +| String | String three character prefix for the object type. | --- diff --git a/docs/Log.md b/docs/Log.md index e79af034..8be7547b 100644 --- a/docs/Log.md +++ b/docs/Log.md @@ -38,9 +38,9 @@ Singleton pattern `get` method. #### Returns -| Type | Description | -| ----- | ----------- | -| `Log` | `Log` | +| Type | Description | +| ---- | ----------- | +| Log | `Log` | ### `public void add(String messageToLog)` diff --git a/docs/LogMessage.md b/docs/LogMessage.md index 0077b6eb..29d34f8e 100644 --- a/docs/LogMessage.md +++ b/docs/LogMessage.md @@ -80,6 +80,6 @@ converts this object to an event for publishing | Type | Description | | -------- | ----------- | -| `Log__e` | `SObject` | +| Log\_\_e | `SObject` | --- diff --git a/docs/LogTriggerHandler.md b/docs/LogTriggerHandler.md index 6b35f2d7..f25046a7 100644 --- a/docs/LogTriggerHandler.md +++ b/docs/LogTriggerHandler.md @@ -90,9 +90,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -176,9 +176,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | #### Example @@ -216,9 +216,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| -------- | ---------------------------- | -| `String` | `String` Name of the Handler | +| Type | Description | +| ------ | ---------------------------- | +| String | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/MetadataTriggerFramework.md b/docs/MetadataTriggerFramework.md index d995a96c..56be5f93 100644 --- a/docs/MetadataTriggerFramework.md +++ b/docs/MetadataTriggerFramework.md @@ -99,9 +99,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -185,9 +185,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | #### Example @@ -225,9 +225,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| -------- | ---------------------------- | -| `String` | `String` Name of the Handler | +| Type | Description | +| ------ | ---------------------------- | +| String | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/MetadataTriggerQueryService.md b/docs/MetadataTriggerQueryService.md index 02f35628..af14cebf 100644 --- a/docs/MetadataTriggerQueryService.md +++ b/docs/MetadataTriggerQueryService.md @@ -27,7 +27,7 @@ Initialize objectTypeName as an empty string to avoid null errors ## Methods -### `public List getMetadataTriggers()` +### `public List getMetadataTriggers()` `SUPPRESSWARNINGS` @@ -37,7 +37,7 @@ This query finds an ordered list trigger handler classes to execute. It ignores | Type | Description | | ------------------------------------ | ------------------------------------ | -| `List` | `List` | +| List | `List` | ### `public static String getSObjectType(List triggerNew, List triggerOld)` @@ -52,9 +52,9 @@ This determines the active sObject type by describing the first record in the tr #### Returns -| Type | Description | -| -------- | ---------------------------- | -| `String` | `String` the ObjectType name | +| Type | Description | +| ------ | ---------------------------- | +| String | `String` the ObjectType name | #### Throws diff --git a/docs/MethodSignature.md b/docs/MethodSignature.md index 9d798a3c..4c2734e8 100644 --- a/docs/MethodSignature.md +++ b/docs/MethodSignature.md @@ -48,9 +48,9 @@ This is used to compare the signature of a MockedMethod, against another instanc #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------ | -| `Boolean` | `Boolean` true if the signatures match, false if they do not | +| Type | Description | +| ------- | ------------------------------------------------------------ | +| Boolean | `Boolean` true if the signatures match, false if they do not | ### `private static Boolean verifyMethodNamesMatch(String originalMethodName, String comparatorMethodName)` @@ -65,9 +65,9 @@ Returns true if the current MethodSignature's methodName is a case insensitive m #### Returns -| Type | Description | -| --------- | ----------------------------------------- | -| `Boolean` | `Boolean` true if the method names match, | +| Type | Description | +| ------- | ----------------------------------------- | +| Boolean | `Boolean` true if the method names match, | ### `public String getMethodName()` @@ -75,9 +75,9 @@ returns the method name for this signature #### Returns -| Type | Description | -| -------- | ------------------ | -| `String` | String method name | +| Type | Description | +| ------ | ------------------ | +| String | String method name | --- @@ -127,9 +127,9 @@ This variant handles the situation where a mocked method was called without para ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(List<System.Type> parameters)` @@ -143,9 +143,9 @@ Omnibus variant that handles a list(N) of parameters. ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter)` @@ -159,9 +159,9 @@ This variant handles a single parameter, brokers to omnibus method. ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2)` @@ -176,9 +176,9 @@ Two parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2, System parameter3)` @@ -194,9 +194,9 @@ Three parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public MockedMethod withParameterTypes(System parameter, System parameter2, System parameter3, System parameter4)` @@ -215,9 +215,9 @@ Four parameter variant. Brokers to omnibus method. ###### Returns -| Type | Description | -| -------------- | ---------------------- | -| `MockedMethod` | `MockedMethod.Builder` | +| Type | Description | +| ------------ | ---------------------- | +| MockedMethod | `MockedMethod.Builder` | ##### `public Stub finalizeSignature()` @@ -225,19 +225,19 @@ Called at the end of building a method signature. ###### Returns -| Type | Description | -| ------ | -------------- | -| `Stub` | `Stub.Builder` | +| Type | Description | +| ---- | -------------- | +| Stub | `Stub.Builder` | -##### `public List<MockedMethod> buildMockedMethod()` +##### `public List buildMockedMethod()` Creates the MockedMethod matching this method signature. ###### Returns -| Type | Description | -| -------------------------- | -------------------------- | -| `List<MockedMethod>` | `List<MockedMethod>` | +| Type | Description | +| ------------------------ | -------------------------- | +| List<MockedMethod> | `List<MockedMethod>` | --- diff --git a/docs/MockedMethod.md b/docs/MockedMethod.md index 080b0d72..32b33124 100644 --- a/docs/MockedMethod.md +++ b/docs/MockedMethod.md @@ -55,9 +55,9 @@ This method is invoked by it's parent stub object, and is responsible for return #### Returns -| Type | Description | -| -------- | ----------- | -| `Object` | `Object` | +| Type | Description | +| ------ | ----------- | +| Object | `Object` | ### `public void assertMockedMethodWasCalled()` @@ -77,9 +77,9 @@ Allows developers to define expected input parameters at execution time. This en #### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ### `public MockedMethod returning(Object returnValue)` @@ -93,9 +93,9 @@ Sets this MockedMethod's return value. This is the value that will be returned b #### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ### `public MockedMethod returning(List incomingIds)` @@ -109,9 +109,9 @@ Use this variant of returning when you want the mocked method to return a list o #### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ### `public MockedMethod throwingException()` @@ -119,9 +119,9 @@ Use this method when you need the mocked method to throw an exception. Incredibl #### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ### `public MockedMethod throwingException(Exception customException)` @@ -135,9 +135,9 @@ Use this variant to have this mocked method return a developer-specified excepti #### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ### `public Boolean doMethodSignaturesAndParametersMatch(MethodSignature methodSignature, List runtimeParameters)` @@ -152,9 +152,9 @@ determines if the current method call matches on both a method signature level a #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `private Boolean doRuntimeParametersMatch(List compareTo)` @@ -168,9 +168,9 @@ Determines if the method, as brokered by the stub object is being called with an #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | --- @@ -225,9 +225,9 @@ internal method used to set the parameter values of this MockedMethod instance. ###### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | ##### `public MockedMethod withParameterValues(Object parameter)` @@ -241,9 +241,9 @@ convenience methodfor setting a single parameter type ###### Returns -| Type | Description | -| -------------- | ----------- | -| `MockedMethod` | this | +| Type | Description | +| ------------ | ----------- | +| MockedMethod | this | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2)` @@ -258,9 +258,9 @@ convenience methodfor setting two params ###### Returns -| Type | Description | -| -------------- | ----------- | -| `MockedMethod` | this | +| Type | Description | +| ------------ | ----------- | +| MockedMethod | this | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2, Object parameter3)` @@ -276,9 +276,9 @@ convenience methodfor setting three params ###### Returns -| Type | Description | -| -------------- | ------------------ | -| `MockedMethod` | return description | +| Type | Description | +| ------------ | ------------------ | +| MockedMethod | return description | ##### `public MockedMethod withParameterValues(Object parameter, Object parameter2, Object parameter3, Object parameter4)` @@ -297,9 +297,9 @@ convenience methodfor setting four parameters ###### Returns -| Type | Description | -| -------------- | ----------- | -| `MockedMethod` | this | +| Type | Description | +| ------------ | ----------- | +| MockedMethod | this | ##### `public Stub returningObjectsWithIds(List<Id> ids)` @@ -313,9 +313,9 @@ This variant allows developers to specify a list of IDs to be assigned to the re ###### Returns -| Type | Description | -| ------ | ---------------------- | -| `Stub` | `MockedMethod.Builder` | +| Type | Description | +| ---- | ---------------------- | +| Stub | `MockedMethod.Builder` | ##### `public Stub returning(Object returnValue)` @@ -329,9 +329,9 @@ This variant allows developers to specify the object that will be returned when ###### Returns -| Type | Description | -| ------ | -------------- | -| `Stub` | `Stub.Builder` | +| Type | Description | +| ---- | -------------- | +| Stub | `Stub.Builder` | ##### `public Stub returning()` @@ -339,9 +339,9 @@ This variant allows developers to specify a void return. ###### Returns -| Type | Description | -| ------ | -------------- | -| `Stub` | `Stub.Builder` | +| Type | Description | +| ---- | -------------- | +| Stub | `Stub.Builder` | ##### `public Stub throwingException()` @@ -349,9 +349,9 @@ This variant allows developers to throw an internally generated Stub.StubExcepti ###### Returns -| Type | Description | -| ------ | -------------- | -| `Stub` | `Stub.Builder` | +| Type | Description | +| ---- | -------------- | +| Stub | `Stub.Builder` | ##### `public Stub throwingException(Exception customException)` @@ -365,9 +365,9 @@ Use this variant to have this mocked method return a developer-specified excepti ###### Returns -| Type | Description | -| ------ | -------------- | -| `Stub` | `MockedMethod` | +| Type | Description | +| ---- | -------------- | +| Stub | `MockedMethod` | ##### `public MockedMethod createMockedMethod(MethodSignature signature)` @@ -381,9 +381,9 @@ Responsible for returning a fully formed MockedMethod instance. ###### Returns -| Type | Description | -| -------------- | -------------- | -| `MockedMethod` | `MockedMethod` | +| Type | Description | +| ------------ | -------------- | +| MockedMethod | `MockedMethod` | --- diff --git a/docs/OrgShape.md b/docs/OrgShape.md index b9361bb5..a236d7e6 100644 --- a/docs/OrgShape.md +++ b/docs/OrgShape.md @@ -95,9 +95,9 @@ returns a Cache.Partition for a given name, and type #### Returns -| Type | Description | -| ------- | ----------------- | -| `Cache` | `Cache.Partition` | +| Type | Description | +| ----- | ----------------- | +| Cache | `Cache.Partition` | ### `public Boolean isPlatformCacheEnabled()` @@ -105,9 +105,9 @@ Method determines if platform cache is enabled for this org Note: fail-safes to #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `public Boolean isSeeAllDataTrue()` @@ -115,9 +115,9 @@ Certain features of the platform are incompatible with data-siloed tests. These #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | **Test** (seeAllData=true). Other platform features are incompatible with seeAllData=true. When used in a test context, this method determines if the currently running test is executing with, or without seeAllData=true. This method is therefore used to automatically disable platform features that require are incompatible with seeAllData=true. For example: platform cache is incompatible with seeAllData=true. However, our security library, CanTheUser utilizes platform cache to accelerate Crud and FLS checks. CanTheUser uses this method, in part, to determine, transparently if it should utilize platformCache during test execution Note: It is not a good idea, and against best practices to use seeAllData=true when not absolutely necessary. @@ -129,9 +129,9 @@ This method is responsible for discovering a cache partition that can be used fo #### Returns -| Type | Description | -| ------- | ----------- | -| `Cache` | `String` | +| Type | Description | +| ----- | ----------- | +| Cache | `String` | ### `public Boolean isAdvancedMultiCurrencyManagementEnabled()` @@ -139,9 +139,9 @@ Uses a dynamic soql query to determine if Advanced MultiCurrency Management is e #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | ### `private Organization getOrgShape()` @@ -153,9 +153,9 @@ Private method that memoizes the query result Suppressing the PMD warning to val #### Returns -| Type | Description | -| -------------- | -------------- | -| `Organization` | `Organization` | +| Type | Description | +| ------------ | -------------- | +| Organization | `Organization` | ### `private static Organization getOrgRecord()` @@ -165,9 +165,9 @@ Private method for pulling the Organization record Note: We're suppressing PMD w #### Returns -| Type | Description | -| -------------- | ---------------------------------- | -| `Organization` | `Organization` Organization Record | +| Type | Description | +| ------------ | ---------------------------------- | +| Organization | `Organization` Organization Record | --- @@ -197,9 +197,9 @@ We're suppressing PMD warning on Crud Checking because we want everyone to be ab ###### Returns -| Type | Description | -| -------------- | ---------------------------------------------------------- | -| `Organization` | `Organization` Organization Record - hopefully from cache. | +| Type | Description | +| ------------ | ---------------------------------------------------------- | +| Organization | `Organization` Organization Record - hopefully from cache. | --- diff --git a/docs/Ouroboros.md b/docs/Ouroboros.md index b6e9fb20..be08a639 100644 --- a/docs/Ouroboros.md +++ b/docs/Ouroboros.md @@ -27,9 +27,9 @@ This is the method that implementing classes must override. It's the method that #### Returns -| Type | Description | -| --------- | ----------------------------------------------- | -| `Boolean` | Boolean True if the exit criteria has been met. | +| Type | Description | +| ------- | ----------------------------------------------- | +| Boolean | Boolean True if the exit criteria has been met. | ### `public void execute()` @@ -41,9 +41,9 @@ This method is to be deprecated shortly, in favor of the lookup system built in #### Returns -| Type | Description | -| -------- | ----------------------------------------------------------------------------- | -| `String` | String class name. Currently only used in the finalizer for logging purposes. | +| Type | Description | +| ------ | ----------------------------------------------------------------------------- | +| String | String class name. Currently only used in the finalizer for logging purposes. | ### `public void execute(QueueableContext context)` diff --git a/docs/OuroborosFinalizer.md b/docs/OuroborosFinalizer.md index 48002b94..7d27015d 100644 --- a/docs/OuroborosFinalizer.md +++ b/docs/OuroborosFinalizer.md @@ -42,9 +42,9 @@ Method is responsible for determining if it's safe to enqueue the next iteration #### Returns -| Type | Description | -| --------- | -------------------------------------------------------------------------------------- | -| `Boolean` | Boolean True if enqueuing the next iteration will not violate any Apex governor limits | +| Type | Description | +| ------- | -------------------------------------------------------------------------------------- | +| Boolean | Boolean True if enqueuing the next iteration will not violate any Apex governor limits | ### `public void execute(FinalizerContext context)` diff --git a/docs/OuroborosTests.md b/docs/OuroborosTests.md index c3431535..ca4efc2b 100644 --- a/docs/OuroborosTests.md +++ b/docs/OuroborosTests.md @@ -48,9 +48,9 @@ Required method that returns true if the exit criteria has been met. ###### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------ | -| `Boolean` | Boolean - true if the exit criteria has been met, false otherwise. | +| Type | Description | +| ------- | ------------------------------------------------------------------ | +| Boolean | Boolean - true if the exit criteria has been met, false otherwise. | ##### `public override void execute()` diff --git a/docs/Polyfills.md b/docs/Polyfills.md index febb477c..95438714 100644 --- a/docs/Polyfills.md +++ b/docs/Polyfills.md @@ -17,9 +17,9 @@ Used to determine what the Class name of the passed in Object is. There are many #### Returns -| Type | Description | -| -------- | ----------------------------------------------------- | -| `String` | String the name of the class of the passed in object. | +| Type | Description | +| ------ | ----------------------------------------------------- | +| String | String the name of the class of the passed in object. | ### `public static Type typeObjFromInstance(Object obj)` @@ -33,9 +33,9 @@ Method returns a Type object from an object instance. This is useful for reflect #### Returns -| Type | Description | -| ------ | ------------------------------------- | -| `Type` | Type the type of the passed in object | +| Type | Description | +| ---- | ------------------------------------- | +| Type | Type the type of the passed in object | ### `public static String getSObjectTypeFromListsFirstObject(List sObjects)` @@ -49,11 +49,11 @@ Method determines the type of a list from it's first element. This is potentiall #### Returns -| Type | Description | -| -------- | -------------------------------------------------------------------- | -| `String` | String the name of the SObject type of the first element in the list | +| Type | Description | +| ------ | -------------------------------------------------------------------- | +| String | String the name of the SObject type of the first element in the list | -### `public static Map idMapFromCollectionByKey(String key, List incomingList)` +### `public static Map idMapFromCollectionByKey(String key, List incomingList)` Method is responsible for building a map out of a list where you can specify the key. This is useful for drying up your code, as generating maps by a non-record-id key is ... common. Note: you'll need to cast this on the calling side. @@ -66,11 +66,11 @@ Method is responsible for building a map out of a list where you can specify the #### Returns -| Type | Description | -| ----------------- | -------------------------------------------------------------------------- | -| `Map` | Map the map of the passed in list, keyed by the passed in key | +| Type | Description | +| --------------- | -------------------------------------------------------------------------- | +| Map | Map the map of the passed in list, keyed by the passed in key | -### `public static Map stringMapFromCollectionByKey(String key, List incomingList)` +### `public static Map stringMapFromCollectionByKey(String key, List incomingList)` Method is responsible for building a map out of a list where you can specify the key. This is useful for drying up your code, as generating maps by a non-record-id key is ... common. Note: you'll need to cast this on the calling side. @@ -83,11 +83,11 @@ Method is responsible for building a map out of a list where you can specify the #### Returns -| Type | Description | -| --------------------- | -------------------------------------------------------------------------- | -| `Map` | Map the map of the passed in list, keyed by the passed in key | +| Type | Description | +| ------------------- | -------------------------------------------------------------------------- | +| Map | Map the map of the passed in list, keyed by the passed in key | -### `public static Map> mapFromCollectionWithCollectionValues(String key, List incomingList)` +### `public static Map mapFromCollectionWithCollectionValues(String key, List incomingList)` This method is responsible for building a map out of a list where you can specify the key. However this method is designed to help you group records by common keys. For instance, you can use this method to group a list of contacts by their accountIds by passing in 'AccountId' as the key. Note: you'll need to cast this on the calling side. The key used here must be an ID field. @@ -100,9 +100,9 @@ This method is responsible for building a map out of a list where you can specif #### Returns -| Type | Description | -| ----------------------- | ---------------------------------------------------------------------------------- | -| `Map>` | Map> the map of the passed in list, grouped by the passed in key | +| Type | Description | +| --------------------- | ---------------------------------------------------------------------------------- | +| Map> | Map> the map of the passed in list, grouped by the passed in key | ### `public static String generateStackTrace()` @@ -110,11 +110,11 @@ This method will give you a stack trace you can inspect. It's useful for debuggi #### Returns -| Type | Description | -| -------- | -------------------------------------------------------- | -| `String` | String The stack trace of the current execution context. | +| Type | Description | +| ------ | -------------------------------------------------------- | +| String | String The stack trace of the current execution context. | -### `public static List pluckFieldFromList(String fieldName, List incomingList)` +### `public static List pluckFieldFromList(String fieldName, List incomingList)` Similar to the pluck method in lodash, this method will return a list of strings from a list of SObjects, based on the field name you pass in. @@ -127,9 +127,9 @@ Similar to the pluck method in lodash, this method will return a list of strings #### Returns -| Type | Description | -| -------------- | --------------------------------------------------------------------------------------------------------------- | -| `List` | List list containing the string value of the field you passed in from every record in the incoming list | +| Type | Description | +| ------------ | --------------------------------------------------------------------------------------------------------------- | +| List | List list containing the string value of the field you passed in from every record in the incoming list | ### `public static Boolean setContainsAnyItemFromList(Set setToCheck, List listOfPossibleOptions)` @@ -144,9 +144,9 @@ Well, as much as I'd like to make this a generic method, I can't Apex doesn't pr #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------- | -| `Boolean` | Boolean True if any of the strings in the list are in the set | +| Type | Description | +| ------- | ------------------------------------------------------------- | +| Boolean | Boolean True if any of the strings in the list are in the set | ### `public static String generateUUID()` @@ -154,9 +154,9 @@ Generates a UUIDv4 string. This is useful for generating unique identifiers for #### Returns -| Type | Description | -| -------- | ---------------------- | -| `String` | String a UUIDv4 string | +| Type | Description | +| ------ | ---------------------- | +| String | String a UUIDv4 string | ### `public static Blob concatenateBlobAndString(Blob someFile, String supplementalText)` @@ -171,9 +171,9 @@ this method is useful for appending a string to a blob. Polyfill for the lack of #### Returns -| Type | Description | -| ------ | -------------------------------------------- | -| `Blob` | Blob the blob with the string appended to it | +| Type | Description | +| ---- | -------------------------------------------- | +| Blob | Blob the blob with the string appended to it | ### `public static String getStringifiedBlob(Blob someFile)` @@ -187,9 +187,9 @@ Returns the string value of a blob. Polyfill for the lack of String.valueOf(Blob #### Returns -| Type | Description | -| -------- | ----------------------------------- | -| `String` | A string representation of the blob | +| Type | Description | +| ------ | ----------------------------------- | +| String | A string representation of the blob | --- diff --git a/docs/Query.md b/docs/Query.md index 4bcdf894..98a746f7 100644 --- a/docs/Query.md +++ b/docs/Query.md @@ -264,23 +264,23 @@ Enum for null records sorting `TESTVISIBLE` -##### `private List<String> convertToStringList(List<Date> values)` +##### `private List convertToStringList(List<Date> values)` -##### `private List<String> convertToStringList(List<Datetime> values)` +##### `private List convertToStringList(List<Datetime> values)` -##### `private List<String> convertToStringList(List<String> values)` +##### `private List convertToStringList(List<String> values)` -##### `private List<String> convertToStringList(List<Id> values)` +##### `private List convertToStringList(List<Id> values)` -##### `private List<String> convertToStringList(List<Integer> values)` +##### `private List convertToStringList(List<Integer> values)` -##### `private List<String> convertToStringList(List<Long> values)` +##### `private List convertToStringList(List<Long> values)` -##### `private List<String> convertToStringList(List<Decimal> values)` +##### `private List convertToStringList(List<Decimal> values)` -##### `private List<String> convertToStringList(List<Double> values)` +##### `private List convertToStringList(List<Double> values)` -##### `private List<String> convertToStringList(Set<Set<String>> values)` +##### `private List convertToStringList(Set<Set<String>> values)` ##### `public override String toString()` diff --git a/docs/QueueableProcess.md b/docs/QueueableProcess.md index 37d741b3..e543f6a7 100644 --- a/docs/QueueableProcess.md +++ b/docs/QueueableProcess.md @@ -57,9 +57,9 @@ This method provides a syntactic sugar for adding a new QueueableProcess to the #### Returns -| Type | Description | -| ------------------ | ----------------------------------------------------------------------------------------------------- | -| `QueueableProcess` | Returns a Queueable Process instance that can be used to chain additional QueueableProcess instances. | +| Type | Description | +| ---------------- | ----------------------------------------------------------------------------------------------------- | +| QueueableProcess | Returns a Queueable Process instance that can be used to chain additional QueueableProcess instances. | ### `public Id start()` @@ -69,7 +69,7 @@ This method starts the QueueableProcess chain. It's the entry point for the proc | Type | Description | | ---- | ---------------------------- | -| `Id` | Id - Id of the Enqueued job. | +| Id | Id - Id of the Enqueued job. | ### `public Id start(Object initialPassthrough)` @@ -85,7 +85,7 @@ This method starts the QueueableProcess chain. It's the entry point for the proc | Type | Description | | ---- | ---------------------------- | -| `Id` | Id - Id of the Enqueued job. | +| Id | Id - Id of the Enqueued job. | ### `public void execute()` diff --git a/docs/QueueableProcessDataProvider.md b/docs/QueueableProcessDataProvider.md index 8d234655..2d4e6238 100644 --- a/docs/QueueableProcessDataProvider.md +++ b/docs/QueueableProcessDataProvider.md @@ -27,8 +27,8 @@ This is the main method that will be called by the QueueableProcessManager. By e #### Returns -| Type | Description | -| -------- | --------------------------------------------------- | -| `String` | String The name of the Apex class that just failed. | +| Type | Description | +| ------ | --------------------------------------------------- | +| String | String The name of the Apex class that just failed. | --- diff --git a/docs/QueueableProcessTests.md b/docs/QueueableProcessTests.md index 7aecdc0d..109c4b1f 100644 --- a/docs/QueueableProcessTests.md +++ b/docs/QueueableProcessTests.md @@ -76,7 +76,7 @@ Returns the ID of the Queueable job for which this finalizer is defined. | Type | Description | | ---- | ----------- | -| `Id` | `Id` | +| Id | `Id` | ##### `public Exception getException()` @@ -84,9 +84,9 @@ Returns the exception with which the Queueable job failed when getResult is `UNH ###### Returns -| Type | Description | -| ----------- | ----------- | -| `Exception` | `Exception` | +| Type | Description | +| --------- | ----------- | +| Exception | `Exception` | ##### `public String getRequestId()` @@ -94,9 +94,9 @@ Returns the request ID, a string that uniquely identifies the request, and can b ###### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | ##### `public ParentJobResult getResult()` @@ -104,9 +104,9 @@ Returns the System.ParentJobResult enum, which represents the result of the pare ###### Returns -| Type | Description | -| ----------------- | ----------------- | -| `ParentJobResult` | `ParentJobResult` | +| Type | Description | +| --------------- | ----------------- | +| ParentJobResult | `ParentJobResult` | --- diff --git a/docs/QuiddityGuard.md b/docs/QuiddityGuard.md index d2565c0f..1f29f3ca 100644 --- a/docs/QuiddityGuard.md +++ b/docs/QuiddityGuard.md @@ -39,9 +39,9 @@ A method to determine if the current Quiddity context is within a caller-supplie #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `boolean` | ### `public static Boolean isNotAcceptableQuiddity(List acceptableQuiddites)` @@ -55,9 +55,9 @@ Method to determine if the current Quiddity context is not acceptable #### Returns -| Type | Description | -| --------- | --------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the current quiddity is not in the list of acceptable quiddities. | +| Type | Description | +| ------- | --------------------------------------------------------------------------------- | +| Boolean | Boolean true if the current quiddity is not in the list of acceptable quiddities. | ### `public static Quiddity quiddity()` @@ -65,9 +65,9 @@ method grabs the current quiddity from the request object #### Returns -| Type | Description | -| ---------- | ------------------------------ | -| `Quiddity` | Quiddity The current quiddity. | +| Type | Description | +| -------- | ------------------------------ | +| Quiddity | Quiddity The current quiddity. | ### `public static Boolean quiddityIsATestContext()` @@ -75,8 +75,8 @@ Syntactic sugar method for determining if the current request quiddity is a know #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | Boolean true if the current quiddity is in the list of trusted test quiddities. | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | Boolean true if the current quiddity is in the list of trusted test quiddities. | --- diff --git a/docs/RestClient.md b/docs/RestClient.md index e9175647..389e35b1 100644 --- a/docs/RestClient.md +++ b/docs/RestClient.md @@ -50,9 +50,9 @@ A static wrapper for the main makeApiCall method #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | #### Example diff --git a/docs/RestClientLib.md b/docs/RestClientLib.md index 0b1c028d..6df5eee5 100644 --- a/docs/RestClientLib.md +++ b/docs/RestClientLib.md @@ -60,9 +60,9 @@ Makes an HTTP Callout to an api resource. Convenience method that assumes the De #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HttpResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HttpResponse` | ### `protected HttpResponse makeApiCall(HttpVerb method, String path, String query)` @@ -80,9 +80,9 @@ convenience version of makeApiCall without body param. Invokes omnibus version a #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse makeApiCall(HttpVerb method, String path)` @@ -99,9 +99,9 @@ convenience version of makeApiCall without body or query params. Invokes omnibus #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse get(String path)` @@ -117,9 +117,9 @@ convenience method for a GET Call that only requires a path #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse get(String path, String query)` @@ -136,9 +136,9 @@ convenience method for a GET Call that only requires a path and query #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse del(String path)` @@ -154,9 +154,9 @@ convenience method for deleting a resource based only on path #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse del(String path, String query)` @@ -173,9 +173,9 @@ convenience method for a Delete Call that only requires a path and query #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse post(String path, String body)` @@ -192,9 +192,9 @@ convenience method for a POST Call that only requires a path and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse post(String path, String query, String body)` @@ -212,9 +212,9 @@ convenience method for a POST Call that only requires a path, query and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse put(String path, String body)` @@ -231,9 +231,9 @@ convenience method for a PUT Call that only requires a path and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse put(String path, String query, String body)` @@ -251,9 +251,9 @@ convenience method for a PUT Call that only requires a path, query and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse patch(String path, String body)` @@ -270,9 +270,9 @@ convenience method for a PATCH Call that only requires a path and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | ### `protected HttpResponse patch(String path, String query, String body)` @@ -290,8 +290,8 @@ convenience method for a PATCH Call that only requires a path, query and body #### Returns -| Type | Description | -| -------------- | -------------- | -| `HttpResponse` | `HTTPResponse` | +| Type | Description | +| ------------ | -------------- | +| HttpResponse | `HTTPResponse` | --- diff --git a/docs/RestLib.md b/docs/RestLib.md index 07f599b8..87aa7848 100644 --- a/docs/RestLib.md +++ b/docs/RestLib.md @@ -52,8 +52,8 @@ Omnibus callout method. This is the primary method for making a REST callout. Mo #### Returns -| Type | Description | -| -------------- | ----------------------------- | -| `HttpResponse` | HttpResponse HttpResponse Obj | +| Type | Description | +| ------------ | ----------------------------- | +| HttpResponse | HttpResponse HttpResponse Obj | --- diff --git a/docs/RestLibApiCall.md b/docs/RestLibApiCall.md index 140961d7..80e3a4f0 100644 --- a/docs/RestLibApiCall.md +++ b/docs/RestLibApiCall.md @@ -98,8 +98,8 @@ Ensures that the inputted string ends in a `/` makes callouts more robust. #### Returns -| Type | Description | -| -------- | --------------------------------------------------------- | -| `String` | inputted string with `/` if it didn't already end in one. | +| Type | Description | +| ------ | --------------------------------------------------------- | +| String | inputted string with `/` if it didn't already end in one. | --- diff --git a/docs/SOQL.md b/docs/SOQL.md index 1a276ffa..5243f547 100644 --- a/docs/SOQL.md +++ b/docs/SOQL.md @@ -40,7 +40,7 @@ SOFTWARE. ### `public sObject getRecord()` -### `public List getRecords()` +### `public List getRecords()` ### `public Database getQueryLocator()` diff --git a/docs/SOQLAgregate.md b/docs/SOQLAgregate.md index cebf5733..872079d4 100644 --- a/docs/SOQLAgregate.md +++ b/docs/SOQLAgregate.md @@ -38,7 +38,7 @@ SOFTWARE. ### `public String getQueryString()` -### `public List getAggregateResults()` +### `public List getAggregateResults()` ### `public override String toString()` diff --git a/docs/SOSL.md b/docs/SOSL.md index e6caf79f..c392d5d7 100644 --- a/docs/SOSL.md +++ b/docs/SOSL.md @@ -38,7 +38,7 @@ SOFTWARE. ### `public String getQueryString()` -### `public List> query()` +### `public List query()` ### `public Search find()` diff --git a/docs/Safely.md b/docs/Safely.md index 7cb3808f..227a359b 100644 --- a/docs/Safely.md +++ b/docs/Safely.md @@ -22,9 +22,9 @@ Triggers the flag to throw an exception if fields are removed #### Returns -| Type | Description | -| -------- | ------------------------------------------------- | -| `Safely` | Safely - the current instance of the Safely class | +| Type | Description | +| ------ | ------------------------------------------------- | +| Safely | Safely - the current instance of the Safely class | ### `public Safely throwIfRemovedFields()` @@ -32,11 +32,11 @@ Sets the throwIfRemovedFields flag to true #### Returns -| Type | Description | -| -------- | ------------------------------------------------- | -| `Safely` | Safely - the current instance of the Safely class | +| Type | Description | +| ------ | ------------------------------------------------- | +| Safely | Safely - the current instance of the Safely class | -### `public List doInsert(List records)` +### `public List doInsert(List records)` A method for safely inserting a list of records @@ -48,11 +48,11 @@ A method for safely inserting a list of records #### Returns -| Type | Description | -| --------------------------- | ----------------------------------------------------- | -| `List` | List - the results of the insert | +| Type | Description | +| ------------------------- | ----------------------------------------------------- | +| List | List - the results of the insert | -### `public List doInsert(SObject record)` +### `public List doInsert(SObject record)` A method for safely inserting a single record @@ -64,11 +64,11 @@ A method for safely inserting a single record #### Returns -| Type | Description | -| --------------------------- | ----------------------------------------------------- | -| `List` | List - the results of the insert | +| Type | Description | +| ------------------------- | ----------------------------------------------------- | +| List | List - the results of the insert | -### `public List doUpdate(List records)` +### `public List doUpdate(List records)` A method for safely updating a list of records @@ -80,11 +80,11 @@ A method for safely updating a list of records #### Returns -| Type | Description | -| --------------------------- | ----------------------------------------------------- | -| `List` | List - the results of the update | +| Type | Description | +| ------------------------- | ----------------------------------------------------- | +| List | List - the results of the update | -### `public List doUpdate(SObject record)` +### `public List doUpdate(SObject record)` a method for safely updating a single record @@ -96,11 +96,11 @@ a method for safely updating a single record #### Returns -| Type | Description | -| --------------------------- | ----------------------------------------------------- | -| `List` | List - the results of the update | +| Type | Description | +| ------------------------- | ----------------------------------------------------- | +| List | List - the results of the update | -### `public List doUpsert(List records)` +### `public List doUpsert(List records)` A method for safely upserting a list of records @@ -112,11 +112,11 @@ A method for safely upserting a list of records #### Returns -| Type | Description | -| ----------------------------- | ------------------------------------------------------- | -| `List` | List - the results of the upsert | +| Type | Description | +| --------------------------- | ------------------------------------------------------- | +| List | List - the results of the upsert | -### `public List doUpsert(SObject record)` +### `public List doUpsert(SObject record)` a method for safely upserting a single record @@ -128,11 +128,11 @@ a method for safely upserting a single record #### Returns -| Type | Description | -| ----------------------------- | ------------------------------------------------------- | -| `List` | List - the results of the upsert | +| Type | Description | +| --------------------------- | ------------------------------------------------------- | +| List | List - the results of the upsert | -### `public List doDelete(List records)` +### `public List doDelete(List records)` a method for safely deleting a list of records @@ -144,11 +144,11 @@ a method for safely deleting a list of records #### Returns -| Type | Description | -| ----------------------------- | ------------------------------------------------------- | -| `List` | List - the results of the delete | +| Type | Description | +| --------------------------- | ------------------------------------------------------- | +| List | List - the results of the delete | -### `public List doDelete(SObject record)` +### `public List doDelete(SObject record)` a method for safely deleting a single record @@ -160,11 +160,11 @@ a method for safely deleting a single record #### Returns -| Type | Description | -| ----------------------------- | ------------------------------------------------------------ | -| `List` | List - the results of the delete call | +| Type | Description | +| --------------------------- | ------------------------------------------------------------ | +| List | List - the results of the delete call | -### `public List doQuery(String query)` +### `public List doQuery(String query)` A method for safely querying records @@ -176,11 +176,11 @@ A method for safely querying records #### Returns -| Type | Description | -| --------------- | ---------------------------------------- | -| `List` | List - the results of the query | +| Type | Description | +| ------------- | ---------------------------------------- | +| List | List - the results of the query | -### `private List doDML(System accessType, List records)` +### `private List doDML(System accessType, List records)` A method for safely performing DML @@ -193,9 +193,9 @@ A method for safely performing DML #### Returns -| Type | Description | -| --------------------------- | ------------------------------------------------------- | -| `List` | List - the results of the DML call | +| Type | Description | +| ------------------------- | ------------------------------------------------------- | +| List | List - the results of the DML call | ### `private SObjectAccessDecision guardAgainstRemovedFields(System accessType, List records)` @@ -210,9 +210,9 @@ method guards against removed fields by throwing an exception, if throwIfRemoved #### Returns -| Type | Description | -| ----------------------- | ------------------------------------------------------------------- | -| `SObjectAccessDecision` | SObjectAccessDecision - the results of the Security Access Decision | +| Type | Description | +| --------------------- | ------------------------------------------------------------------- | +| SObjectAccessDecision | SObjectAccessDecision - the results of the Security Access Decision | --- diff --git a/docs/SampleHandler.md b/docs/SampleHandler.md index 211ecaf8..81ccccdb 100644 --- a/docs/SampleHandler.md +++ b/docs/SampleHandler.md @@ -72,9 +72,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | ### `public void setMaxLoopCount(Integer max)` @@ -158,9 +158,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | #### Example @@ -198,8 +198,8 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| -------- | ---------------------------- | -| `String` | `String` Name of the Handler | +| Type | Description | +| ------ | ---------------------------- | +| String | `String` Name of the Handler | --- diff --git a/docs/Stub.md b/docs/Stub.md index a4e1a022..6c71a3c9 100644 --- a/docs/Stub.md +++ b/docs/Stub.md @@ -82,9 +82,9 @@ method required by the StubProvider interface. Handles the mock execution of the #### Returns -| Type | Description | -| -------- | ----------- | -| `Object` | `Object` | +| Type | Description | +| ------ | ----------- | +| Object | `Object` | ### `public void assertAllMockedMethodsWereCalled()` @@ -96,9 +96,9 @@ returns the this constructed class with it's mocked methods as a single stub obj #### Returns -| Type | Description | -| -------- | ---------------------------------------------------------- | -| `Object` | `Object` Needs to be cast back to the type of object used. | +| Type | Description | +| ------ | ---------------------------------------------------------- | +| Object | `Object` Needs to be cast back to the type of object used. | --- @@ -154,9 +154,9 @@ This method, and it's overloaded variants below, all work to add a new MockedMet ###### Returns -| Type | Description | -| ----------------- | -------------------------------------------------------------------- | -| `MethodSignature` | `MethodSignature.Builder` - returns the builder object for chaining. | +| Type | Description | +| --------------- | -------------------------------------------------------------------- | +| MethodSignature | `MethodSignature.Builder` - returns the builder object for chaining. | ##### `public MethodSignature mockingMethodCall(String methodName)` @@ -170,9 +170,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| ----------------- | ------------------------- | -| `MethodSignature` | `MethodSignature.Builder` | +| Type | Description | +| --------------- | ------------------------- | +| MethodSignature | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType)` @@ -187,9 +187,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| -------------- | ------------------------- | -| `MockedMethod` | `MethodSignature.Builder` | +| Type | Description | +| ------------ | ------------------------- | +| MockedMethod | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2)` @@ -205,9 +205,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| -------------- | ------------------------- | -| `MockedMethod` | `MethodSignature.Builder` | +| Type | Description | +| ------------ | ------------------------- | +| MockedMethod | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2, Type paramType3)` @@ -226,9 +226,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| -------------- | ------------------------- | -| `MockedMethod` | `MethodSignature.Builder` | +| Type | Description | +| ------------ | ------------------------- | +| MockedMethod | `MethodSignature.Builder` | ##### `public MockedMethod mockingMethodCall(String methodName, Type paramType, Type paramType2, Type paramType3, Type paramType4)` @@ -248,9 +248,9 @@ Overloaded variant of the main 'mockingMethodCall' method. See docs for the firs ###### Returns -| Type | Description | -| -------------- | ------------------------- | -| `MockedMethod` | `MethodSignature.Builder` | +| Type | Description | +| ------------ | ------------------------- | +| MockedMethod | `MethodSignature.Builder` | ##### `public Object defineStub(Boolean generateInjectableStub)` @@ -264,9 +264,9 @@ Generates a Stub object from this builder object. ###### Returns -| Type | Description | -| -------- | ----------- | -| `Object` | `Stub` | +| Type | Description | +| ------ | ----------- | +| Object | `Stub` | ##### `public Stub defineStub()` @@ -274,9 +274,9 @@ Method generates a Stub object from this builder object. ###### Returns -| Type | Description | -| ------ | ----------------------------------------------- | -| `Stub` | Stub object to be used to mock the object type. | +| Type | Description | +| ---- | ----------------------------------------------- | +| Stub | Stub object to be used to mock the object type. | --- diff --git a/docs/StubUtilities.md b/docs/StubUtilities.md index b4e769dc..58663634 100644 --- a/docs/StubUtilities.md +++ b/docs/StubUtilities.md @@ -12,7 +12,7 @@ a static incrementing counter tied to transaction a new comment ## Methods -### `public static List generateSObjectIds(String sObjectTypeString, Integer size)` +### `public static List generateSObjectIds(String sObjectTypeString, Integer size)` Used when you want a MockedMethod to return a set of IDs of a given sObject Type @@ -25,8 +25,8 @@ Used when you want a MockedMethod to return a set of IDs of a given sObject Type #### Returns -| Type | Description | -| ---------- | ----------- | -| `List` | `List` | +| Type | Description | +| -------- | ----------- | +| List | `List` | --- diff --git a/docs/TestFactory.md b/docs/TestFactory.md index eeced7cc..c6a45556 100644 --- a/docs/TestFactory.md +++ b/docs/TestFactory.md @@ -24,9 +24,9 @@ Creates a single sObject. #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject` | ### `public static SObject createSObject(SObject sObj, Boolean doInsert)` @@ -41,9 +41,9 @@ Creates a single sObject #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject` | ### `public static SObject createSObject(SObject sObj, String defaultClassName)` @@ -58,9 +58,9 @@ creates a single sObject #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject` | #### Throws @@ -82,11 +82,11 @@ Create a single sObject #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject` | -### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects)` +### `public static List createSObjectList(SObject sObj, Integer numberOfObjects)` Creates a list of sObjects @@ -99,11 +99,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject[]` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject[]` | -### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, Boolean doInsert)` +### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, Boolean doInsert)` Creates a list of sObjects @@ -117,11 +117,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject[]` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject[]` | -### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName, Boolean doInsert)` +### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName, Boolean doInsert)` `SUPPRESSWARNINGS` @@ -138,11 +138,11 @@ Creates a list of sObjects #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject[]` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject[]` | -### `public static SObject createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName)` +### `public static List createSObjectList(SObject sObj, Integer numberOfObjects, String defaultClassName)` Creates a list of sObjects @@ -156,9 +156,9 @@ Creates a list of sObjects #### Returns -| Type | Description | -| --------- | ----------- | -| `SObject` | `SObject[]` | +| Type | Description | +| ------- | ----------- | +| SObject | `SObject[]` | ### `private static void addFieldDefaults(SObject sObj, Map defaults)` @@ -184,9 +184,9 @@ creates a test user. Useful for permissions testing #### Returns -| Type | Description | -| ------ | ----------- | -| `User` | `User` | +| Type | Description | +| ---- | ----------- | +| User | `User` | ### `public static User createTestUser(Boolean doInsert, String profileName)` @@ -201,9 +201,9 @@ Creates a test user with a given profile. #### Returns -| Type | Description | -| ------ | ----------- | -| `User` | `User` | +| Type | Description | +| ---- | ----------- | +| User | `User` | ### `public static User createMinAccessUser(Boolean doInsert)` @@ -217,9 +217,9 @@ Creates a user with the Minimum Access Profile Relies on the previous method for #### Returns -| Type | Description | -| ------ | ----------- | -| `User` | `User` | +| Type | Description | +| ---- | ----------- | +| User | `User` | ### `public static void assignPermSetToUser(User user, String permSetName)` @@ -232,7 +232,7 @@ Assigns a permission set to a given user. | `user` | User to assign the permission set to. | | `permSetName` | String name of the permission set. | -### `public static List invalidateSObjectList(List incoming)` +### `public static List invalidateSObjectList(List incoming)` Intentionally invalidates a list of sObjects. This is useful for intentionally causing DML errors during testing. @@ -244,9 +244,9 @@ Intentionally invalidates a list of sObjects. This is useful for intentionally c #### Returns -| Type | Description | -| --------------- | --------------- | -| `List` | `List` | +| Type | Description | +| ------------- | --------------- | +| List | `List` | ### `public static User createMarketingUser(Boolean doInsert)` @@ -260,9 +260,9 @@ Generates a marketing user - a user with the Marketing User profile. #### Returns -| Type | Description | -| ------ | --------------------- | -| `User` | User the created user | +| Type | Description | +| ---- | --------------------- | +| User | User the created user | ### `public static PermissionSet createPermissionSet(String permSetName, Boolean doInsert)` @@ -277,9 +277,9 @@ Generates a test permission set record - no permissions are added to it #### Returns -| Type | Description | -| --------------- | ----------------------------------------- | -| `PermissionSet` | PermissionSet the created permission set. | +| Type | Description | +| ------------- | ----------------------------------------- | +| PermissionSet | PermissionSet the created permission set. | ### `public static void enableCustomPermission(String permissionName, Id forUserId)` @@ -314,14 +314,14 @@ Use the FieldDefaults interface to set up values you want to default in for all #### Methods -##### `public Map<Schema.SObjectField,Object> getFieldDefaults()` +##### `public Map getFieldDefaults()` Interface used by implementing classes to define defaults. ###### Returns -| Type | Description | -| --------------------------------------- | ---------------------------------------- | -| `Map<Schema.SObjectField,Object>` | `Map<Schema.SObjectField, Object>` | +| Type | Description | +| ------------------------------------- | ---------------------------------------- | +| Map<Schema.SObjectField,Object> | `Map<Schema.SObjectField, Object>` | --- diff --git a/docs/TriggerContext.md b/docs/TriggerContext.md index d1ec0b83..09b05895 100644 --- a/docs/TriggerContext.md +++ b/docs/TriggerContext.md @@ -30,9 +30,9 @@ make sure this trigger should continue to run #### Returns -| Type | Description | -| --------- | ---------------------------------------------------- | -| `Boolean` | `Boolean` true if the trigger should continue to run | +| Type | Description | +| ------- | ---------------------------------------------------- | +| Boolean | `Boolean` true if the trigger should continue to run | #### Throws diff --git a/docs/TriggerFramework.md b/docs/TriggerFramework.md index 0ca07d8b..d0aa4c7f 100644 --- a/docs/TriggerFramework.md +++ b/docs/TriggerFramework.md @@ -38,9 +38,9 @@ A method to guard against invalid execution contexts #### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------- | -| `Boolean` | true if the execution context is invalid or if this trigger handler is bypassed | +| Type | Description | +| ------- | ------------------------------------------------------------------------------- | +| Boolean | true if the execution context is invalid or if this trigger handler is bypassed | ### `private void dispatchHandlerMethod(TriggerOperation context)` @@ -124,9 +124,9 @@ Allows developers to check whether a given trigger handler class is currently by #### Returns -| Type | Description | -| --------- | ----------- | -| `Boolean` | `Boolean` | +| Type | Description | +| ------- | ----------- | +| Boolean | `Boolean` | #### Example @@ -158,9 +158,9 @@ Returns the string version of the handler class being invoked #### Returns -| Type | Description | -| -------- | ---------------------------- | -| `String` | `String` Name of the Handler | +| Type | Description | +| ------ | ---------------------------- | +| String | `String` Name of the Handler | ### `protected void beforeInsert()` diff --git a/docs/TriggerFrameworkLoopCount.md b/docs/TriggerFrameworkLoopCount.md index d09cec22..8ad70214 100644 --- a/docs/TriggerFrameworkLoopCount.md +++ b/docs/TriggerFrameworkLoopCount.md @@ -36,9 +36,9 @@ Increment the internal counter returning the results of this.exceeded(). #### Returns -| Type | Description | -| --------- | ---------------------------------------------------------------- | -| `Boolean` | `Boolean` true if count will exceed max count or is less than 0. | +| Type | Description | +| ------- | ---------------------------------------------------------------- | +| Boolean | `Boolean` true if count will exceed max count or is less than 0. | ### `public Boolean exceeded()` @@ -46,9 +46,9 @@ Determines if this we're about to exceed the loop count. #### Returns -| Type | Description | -| --------- | ----------------------------------------------- | -| `Boolean` | `Boolean` true if less than 0 or more than max. | +| Type | Description | +| ------- | ----------------------------------------------- | +| Boolean | `Boolean` true if less than 0 or more than max. | ### `public Integer getMax()` @@ -56,9 +56,9 @@ Returns the max loop count. #### Returns -| Type | Description | -| --------- | ------------------------- | -| `Integer` | `Integer` max loop count. | +| Type | Description | +| ------- | ------------------------- | +| Integer | `Integer` max loop count. | ### `public Integer getCount()` @@ -66,9 +66,9 @@ Returns the current loop count. #### Returns -| Type | Description | -| --------- | ----------------------------- | -| `Integer` | `Integer` current loop count. | +| Type | Description | +| ------- | ----------------------------- | +| Integer | `Integer` current loop count. | ### `public void setMax(Integer max)` diff --git a/docs/UFInvocable.md b/docs/UFInvocable.md index fdd00b3e..a3920f9a 100644 --- a/docs/UFInvocable.md +++ b/docs/UFInvocable.md @@ -20,7 +20,7 @@ However, this class provides a few benefits: ## Methods -### `public List call(String methodName, List> passedParameters)` +### `public List call(String methodName, List> passedParameters)` This is a required method of the callable interface that this class implements. You'll need to extend the class you intend to expose to flow with this one, and implement this method. @@ -33,11 +33,11 @@ This is a required method of the callable interface that this class implements. #### Returns -| Type | Description | -| -------------- | -------------------------------------------------------------------------------------------- | -| `List` | Object This returns a generic Object. This is the return value of the method you're calling. | +| Type | Description | +| ------------ | -------------------------------------------------------------------------------------------- | +| List | Object This returns a generic Object. This is the return value of the method you're calling. | -### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` +### `protected List extractParameter(String parameterName, List> parameters, Type parameterListType)` Extracts values from a list of parameters. Used by implementations of the Invocable framework. @@ -51,9 +51,9 @@ Extracts values from a list of parameters. Used by implementations of the Invoca #### Returns -| Type | Description | -| -------------- | ------------------------------------------------------------------------------- | -| `List` | `List` The list of extracted values, in the same data type as requested | +| Type | Description | +| ------------ | ------------------------------------------------------------------------------- | +| List | `List` The list of extracted values, in the same data type as requested | --- @@ -110,9 +110,9 @@ Used by Map/Set to identify unique values quickly ###### Returns -| Type | Description | -| --------- | ---------------------------------------------------------- | -| `Integer` | `Integer` returns a unique value based on x, y coordinates | +| Type | Description | +| ------- | ---------------------------------------------------------- | +| Integer | `Integer` returns a unique value based on x, y coordinates | ##### `public Boolean equals(Object other)` @@ -126,9 +126,9 @@ checks if the current instance is equal to another ###### Returns -| Type | Description | -| --------- | -------------------------------------------------------------------- | -| `Boolean` | `Boolean` returns `true` if the objects are equal, `false` otherwise | +| Type | Description | +| ------- | -------------------------------------------------------------------- | +| Boolean | `Boolean` returns `true` if the objects are equal, `false` otherwise | ##### `public Integer compareTo(Object other)` @@ -140,9 +140,9 @@ checks if the current instance is equal to another ###### Returns -| Type | Description | -| --------- | ------------------------------------------------------------------------------ | -| `Integer` | `Integer` negative when `this` is smaller, positive when greater, 0 when equal | +| Type | Description | +| ------- | ------------------------------------------------------------------------------ | +| Integer | `Integer` negative when `this` is smaller, positive when greater, 0 when equal | --- @@ -194,23 +194,23 @@ Constructor used for single bulkified flow processing #### Methods -##### `public List<UniversalFlowInputOutput> execute()` +##### `public List execute()` processes a single bulkified flow ###### Returns -| Type | Description | -| -------------------------------------- | ---------------------------------------------------------------------------------------- | -| `List<UniversalFlowInputOutput>` | `List<UniversalFlowInputOutput>` the flow inputs from a bulkified flow transaction | +| Type | Description | +| ------------------------------------ | ---------------------------------------------------------------------------------------- | +| List<UniversalFlowInputOutput> | `List<UniversalFlowInputOutput>` the flow inputs from a bulkified flow transaction | -##### `public List<List<UniversalFlowInputOutput>> executeBulk()` +##### `public List executeBulk()` ###### Returns -| Type | Description | -| -------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `List<List<UniversalFlowInputOutput>>` | `List<List<UniversalFlowInputOutput>>` the flow inputs from a collection of flow inputs | +| Type | Description | +| ------------------------------------------------ | --------------------------------------------------------------------------------------------------- | +| List<List<UniversalFlowInputOutput>> | `List<List<UniversalFlowInputOutput>>` the flow inputs from a collection of flow inputs | ##### `private void prepare()` diff --git a/docs/ULID.md b/docs/ULID.md index 6b6bd2a7..927f070e 100644 --- a/docs/ULID.md +++ b/docs/ULID.md @@ -31,9 +31,9 @@ Generates a ULID string according to spec. https://github.com/ulid/spec #### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | ### `private static String encodeTimestamp(Long dtSeed, Long timeLength)` @@ -48,9 +48,9 @@ Encodes a given timestamp into characters from the acceptable character set abov #### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | ### `private static String generateRandomString(Integer length)` @@ -64,9 +64,9 @@ generates a random string from the character set of a given length. #### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | ### `private static String fetchRandomCharacterFromCharacterSet()` @@ -74,8 +74,8 @@ pulls a random character from the character set. #### Returns -| Type | Description | -| -------- | ----------- | -| `String` | `String` | +| Type | Description | +| ------ | ----------- | +| String | `String` | --- diff --git a/docs/UniversalBulkInvocable.md b/docs/UniversalBulkInvocable.md index b87ae150..f2be89ea 100644 --- a/docs/UniversalBulkInvocable.md +++ b/docs/UniversalBulkInvocable.md @@ -4,7 +4,7 @@ This class contains the one and only invocable method that will be displayed in ## Methods -### `public static List> invoke(List> inputs)` +### `public static List invoke(List> inputs)` `INVOCABLEMETHOD` @@ -18,8 +18,8 @@ This method is what will be displayed in the flow builder. This method can corre #### Returns -| Type | Description | -| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `List>` | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | +| Type | Description | +| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| List> | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | --- diff --git a/docs/UniversalFlowInputOutput.md b/docs/UniversalFlowInputOutput.md index ab134cbf..6040c1a1 100644 --- a/docs/UniversalFlowInputOutput.md +++ b/docs/UniversalFlowInputOutput.md @@ -62,15 +62,15 @@ While the parameters list is used for passing parameters to the method you're ca ## Methods -### `public Map toCallableParamMap()` +### `public Map toCallableParamMap()` Method is responsible for converting the list of UniversalFlowInputOutputParameter objects delivered by the Flow action framework, to a Map<String, Object> needed by the Callable interface. Note, this is a hard limitation of the Flow action framework and the Apex Defined Data Types. This is not a limitation of this pattern / framework. If you want to, say pass a list of records to a method, you'll need to pass a list of strings, and query for the objects in the Apex. #sorryNothingICanDo. #### Returns -| Type | Description | -| -------------------- | ----------------------------------------------------------------------------------- | -| `Map` | Map This returns a map of parameters you're passing to your method. | +| Type | Description | +| ------------------ | ----------------------------------------------------------------------------------- | +| Map | Map This returns a map of parameters you're passing to your method. | ### `public override String toString()` @@ -78,8 +78,8 @@ Used to provide a usable key for the Map that uses this method. #### Returns -| Type | Description | -| -------- | -------------------------------------------------- | -| `String` | `String` This value maps unique class/method names | +| Type | Description | +| ------ | -------------------------------------------------- | +| String | `String` This value maps unique class/method names | --- diff --git a/docs/UniversalInvocable.md b/docs/UniversalInvocable.md index c1bbcca3..6390853d 100644 --- a/docs/UniversalInvocable.md +++ b/docs/UniversalInvocable.md @@ -6,7 +6,7 @@ invoked by this single invocable method. ## Methods -### `public static List invoke(List inputs)` +### `public static List invoke(List inputs)` `INVOCABLEMETHOD` @@ -20,8 +20,8 @@ This method is what will be displayed in the flow builder. This method can corre #### Returns -| Type | Description | -| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `List` | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | +| Type | Description | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| List | List output objects. Every input receives one output, even if non-fatal exceptions are encountered. | --- diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls b/force-app/main/default/classes/dataStructures/Tuple.cls similarity index 100% rename from force-app/main/default/classes/Data Structures/Tuple.cls rename to force-app/main/default/classes/dataStructures/Tuple.cls diff --git a/force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml b/force-app/main/default/classes/dataStructures/Tuple.cls-meta.xml similarity index 100% rename from force-app/main/default/classes/Data Structures/Tuple.cls-meta.xml rename to force-app/main/default/classes/dataStructures/Tuple.cls-meta.xml diff --git a/pmd/ruleset.xml b/pmd/ruleset.xml index 0ed5a9ab..53a2e24f 100644 --- a/pmd/ruleset.xml +++ b/pmd/ruleset.xml @@ -5,6 +5,9 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd"> Security Rules for Apex + .*/.sfdx/.* + .*/.sf/.* + node_modules