[DXEC-763] Release v0.24.0 (#314)

* chore: build rules and bump ver

* fix: comment parsing return value

* fix: move description to the top of the comment

* feat: generate rules.json

Author: joshcanhelp

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "rules-templates",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Auth0 Rules Repository",
   "main": "./rules",
   "scripts": {

package.json

@@ -1,6 +1,6 @@
 /**
  * This rule is used to prevent access during weekends for a specific app.
- * 
+ *
  * @title Allow Access during weekdays for a specific App
  * @overview Prevent access to app during weekends.
  * @gallery true

rules.json

@@ -2,7 +2,7 @@
  * This rule checks if a user belongs to an AD group and if not, it will return Access Denied.
  *
  * > Note: you can mix this with `context.clientID` or `clientName` to do it only for specific application
- * 
+ *
  * @title Active Directory group membership
  * @overview Check Active Directory membership, else return Access Denied.
  * @gallery true

src/rules/access-on-weekdays-only-for-an-app.js

@@ -10,7 +10,7 @@
  * **Optional configuration:**
  *
  *    - `CAISSON_DEBUG` Set to "true" to log errors in the console
- * 
+ *
  * @title Caisson ID Check
  * @overview Validate US driver's licenses and international passports in real time.
  * @gallery false

src/rules/active-directory-groups.js

@@ -5,7 +5,7 @@
  * Use this rule to only allow users from specific email domains to login.
  *
  * For example, ExampleCo has setup exampleco.com as a managed domain. They add exampleco.com to the email domains list in their SAML connection. Now, only users with an email ending with @exampleco.com (and not @examplecocorp.com) can login via SAML.
- * 
+ *
  * @title Check if user email domain matches configured domain
  * @overview Check user email domain matches domains configured in connection.
  * @gallery true

src/rules/caisson-id-check.js

@@ -7,7 +7,7 @@
  * For more details about the Rules configuration settings, see here https://auth0.com/docs/rules/guides/configuration
  * For more information about Hubspot API keys see here https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key
  * Use 1 as the value for HUBSPOT_NEW_MEMBER_LIST_ID for the default list in Hubspot. Otherwise, you can see the ID of any list in HubSpot visiting it, and looking at the URL. It will have this format https://app.hubspot.com/contacts/:portalId/lists/:listId where :listId is the value you want.
- * 
+ *
  * @title Add New Contact to HubSpot for Marketing
  * @overview Add New Contact to HubSpot then add to a List for marketing
  * @gallery true

src/rules/check-domains-against-connection-aliases.js

@@ -3,7 +3,7 @@
  * This integration simplifies the process of making full use of integrated Cumul.io dashboards' multi tenant features
  * by using Auth0 as its authentication layer. The integration will allow you to set up and use user
  * information in Auth0 as Cumul.io parameters to filter and structure your Cumul.io dashboards.
- * 
+ *
  * @title User app_metadata for Cumul.io
  * @overview Add Cumul.io user app_metadata to tokens to be used for Cumul.io dashboard filtering
  * @gallery false

src/rules/create-new-contact-add-to-contact-list-hubspot.js

@@ -14,7 +14,7 @@
  *    - `AURAYA_COMMON_DIGITS_PROMPT` A digit string to prompt for common digits (e.g '987654321')
  *    - `AURAYA_PERSONAL_DIGITS_PROMPT` A string to prompt for personal digits (e.g 'your cell number')
  *    - `AURAYA_DEBUG` Set to "true" to log errors in the console
- * 
+ *
  * @title EVA Voice Biometric connector
  * @overview EVA Voice Biometric connector rule for Auth0 enables voice enrolment and verification as a second factor
  * @gallery false

src/rules/cumulio-add-metadata-to-tokens.js

@@ -9,7 +9,7 @@
  * **Required configuration** (this Rule will be skipped if any of the below are not defined):
  *
  *    - `FULLCONTACT_KEY` API key found at https://dashboard.fullcontact.com/
- * 
+ *
  * @title Enrich profile with FullContact
  * @overview Get the user profile from FullContact using the email then add a new property to user_metadata.
  * @gallery true

src/rules/eva-voice-biometric.js

@@ -1,7 +1,7 @@
 /**
  *
  * This rule is used to trigger multifactor authentication when the requesting IP is from outside the corporate IP range.
- * 
+ *
  * @title Multifactor when request comes from outside an IP range
  * @overview Trigger multifactor authentication when IP is outside the expected range.
  * @gallery true

src/rules/get-fullcontact-profile.js

@@ -6,7 +6,7 @@
  *
  *    - `INCOGNIA_CLIENT_ID`: The client ID obtained from Incognia's dashboard (My Apps > API Credentials)
  *    - `INCOGNIA_CLIENT_SECRET`: The client secret obtained from Incognia's dashboard (My Apps > API Credentials)
- * 
+ *
  * @title Incognia Authentication Rule
  * @overview Verify if the device logging in is at a trusted location.
  * @gallery false

src/rules/guardian-multifactor-ip-range.js

@@ -6,7 +6,7 @@
  *
  *    - `INCOGNIA_CLIENT_ID`: The client ID obtained from Incognia's dashboard (My Apps > API Credentials)
  *    - `INCOGNIA_CLIENT_SECRET`: The client secret obtained from Incognia's dashboard (My Apps > API Credentials)
- * 
+ *
  * @title Incognia Onboarding Rule
  * @overview Verify if the device location behavior matches the address declared during onboarding.
  * @gallery false

src/rules/incognia-authentication.js

@@ -1,7 +1,7 @@
 /**
  *
  * This rule will deny access to an app from a specific set of IP addresses.
- * 
+ *
  * @title IP Address Blocklist
  * @overview Do not allow access to an app from a specific set of IP addresses.
  * @gallery true

src/rules/incognia-onboarding.js

@@ -8,7 +8,7 @@
  * 1- The rule updates the profile root attribute with the mapped field from user_metadata.
  * 2- The mapped fields from user_metadata will be removed following the update.
  * 3- This rule will be executed on each login event. For signup scenarios, you should only consider using this rule if you currently use a custom signup form or Authentication Signup API, as these signup methods do not support setting the root attributes.
- * 
+ *
  * @title Move user metadata attributes to profile root attributes
  * @overview Moves select data from user_metadata to profile root attributes (family_name, given_name, name, nickname and picture).
  * @gallery true

src/rules/ip-address-blocklist.js

@@ -5,7 +5,7 @@
  *    - `DEFAULT_ROLE_NAME` - name of the default role to be given to a user
  *    - `DEFAULT_ROLE_ID` - id of the role to be given to a user
  *    - `CUSTOM_CLAIMS_NAMESPACE` - namespace for adding custom claims to ID Token
- * 
+ *
  * @title Netlify Role Management
  * @overview Adds a default role if the user doesn't have any yet and attaches roles to the ID Token.
  * @gallery true

src/rules/migrate-root-attributes.js

@@ -11,7 +11,7 @@
  * **Optional configuration:**
  *
  *    - `ONETRUST_SKIP_IF_NO_EMAIL` If set to "true" then the Rule will be skipped if there is no email address. Otherwise the Rule will fail with an error.
- * 
+ *
  * @title OneTrust Consent Management
  * @overview Enhance Auth0 user profiles with consent, opt-ins and communication preferences data.
  * @gallery false

src/rules/netlify-role-management.js

@@ -13,7 +13,7 @@
  * **Optional configuration:**
  *
  *    - `SCALED_ACCESS_CUSTOMCLAIM` A namespaced ID token claim (defaults to `https://scaledaccess.com/relationships`)
- * 
+ *
  * @title Scaled Access relationship-based claims
  * @overview Adds a claim based on the relationships the subject has in Scaled Access
  * @gallery false

src/rules/onetrust-consent-management.js

@@ -17,7 +17,7 @@
  * **Helpful Hints**
  *
  *    - The SecZetta API documentation is located here: `https://{{SECZETTA_BASE_URL}}/api/v1/`
- * 
+ *
  * @title SecZetta Get Risk Score
  * @overview Grab the risk score from SecZetta to use in the authentication flow
  * @gallery false

src/rules/scaled-access-relationships-claim.js

@@ -5,7 +5,7 @@
  * We use a persistent property `SignedUp` to track whether this is the first login or subsequent ones.
  *
  * In the same way you can use other services like [Amazon SES](http://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html), [Mandrill](https://auth0.com/mandrill) and few others.
- * 
+ *
  * @title Send emails through SendGrid
  * @overview Send an email to an administrator through SendGrind on the first login of a user.
  * @gallery true

src/rules/seczetta-get-risk-score.js

@@ -5,7 +5,7 @@
  * **Required configuration** (this Rule will be skipped if any of the below are not defined):
  *
  *    - `SLACK_HOOK_URL` URL to the Slack hook to notify.
- * 
+ *
  * @title Slack Notification on User Signup
  * @overview Slack notification on user signup.
  * @gallery true

src/rules/sendgrid.js

@@ -3,7 +3,7 @@
  * This rule will add one attribute to the user's metadata object on when they log in or sign up
  *
  * This is useful for cases where you want to add the username to an email using liquid syntax.
- * 
+ *
  * @title Add Username to AppMetadata
  * @overview Adds metadata on when an user first signs up or logs in.
  * @gallery true

src/rules/slack.js

@@ -12,7 +12,7 @@
  *    - `VOUCHED_API_URL` Your Vouched API URL; leave blank unless instructed by your Vouched rep
  *    - `VOUCHED_ID_TOKEN_CLAIM` Set a `https://vouchedid/is_verified` claim in the ID token with results
  *    - `VOUCHED_VERIFICATION_OPTIONAL` Set to "true" to succeed even if verification fails
- * 
+ *
  * @title Vouched Verification
  * @overview Verify a person's identity using Vouched.
  * @gallery true