Upgrading node-auth0 from v3 to v4

CONTRIBUTING.md

@@ -1,4 +1,5 @@
 ## Commits
+
 All commits should be signed to enhance security, authorship, trust and compliance.
 
 [About commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)

docs/configuring-the-deploy-cli.md

@@ -149,7 +149,7 @@ String. Separate value from audience value while retrieving an access token for
 
 ### `AUTH0_EXCLUDED_RULES`
 
-Array of strings. Excludes the management of specific rules by name. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
+Array of strings. Excludes the management of specific rules by ID. **Note:** This configuration may be subject to deprecation in the future. See: [excluding resources from management](excluding-from-management.md).
 
 ### `AUTH0_EXCLUDED_CLIENTS`
 

docs/excluding-from-management.md

@@ -85,7 +85,6 @@ For non-set-based resource configuration like tenant, email provider and brandin
 #### Example of emptiness
 
 ```yaml
-hooks: [] # Empty hooks
 connections: [] # Empty connections
 tenant: {} # Effectively a no-op, cannot delete tenant
 emailProvider: {} # Will delete email provider

docs/resource-specific-documentation.md

@@ -57,12 +57,12 @@ Folder structure when in YAML mode.
 
 ./databases/
     /Username-Password-Authentication
-        /change_password.js   
-        /create.js   
-        /delete.js   
-        /get_user.js   
-        /login.js   
-        /verify.js   
+        /change_password.js
+        /create.js
+        /delete.js
+        /get_user.js
+        /login.js
+        /verify.js
 ./tenant.yaml
 ```
 
@@ -98,8 +98,8 @@ Folder structure when in directory mode.
         ./verify.js
 ```
 
-
 Contents of `database.json`
+
 ```json
 {
   "options": {
@@ -169,8 +169,8 @@ Folder structure when in directory mode.
     ./password_reset.json
 ```
 
-
 Contents of `login.json`
+
 ```json
 {
   "name": "login",
@@ -180,6 +180,7 @@ Contents of `login.json`
 ```
 
 Contents of `error_page.json`
+
 ```json
 {
   "html": "./error_page.html",
@@ -190,6 +191,7 @@ Contents of `error_page.json`
 ```
 
 Contents of `guardian_multifactor.json`
+
 ```json
 {
   "enabled": true,
@@ -199,6 +201,7 @@ Contents of `guardian_multifactor.json`
 ```
 
 Contents of `password_reset.json`
+
 ```json
 {
   "enabled": true,

docs/v8_MIGRATION_GUIDE.md

@@ -0,0 +1,46 @@
+# V8 Migration Guide
+
+Guide to migrating from `7.x` to `8.x`
+
+- [General](#general)
+    - [Node 18 or newer is required](#node-18-or-newer-is-required)
+    - [Auth0 V4 Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md)
+- [Management Resources](#management-resources)
+    - [EmailProvider](#emailProvider)
+    - [Migrations](#migrations)
+
+## General
+
+### Node 18 or newer is required
+
+Node 18 LTS and newer LTS releases are supported.
+
+## Management Resources
+
+| Resource      | Change           | Description                                   |
+|---------------|------------------|-----------------------------------------------|
+| emailProvider | delete operation | Delete operation is deprecated on auth0 `4.x` |
+| migrations    | removed support  | Not supported on auth0 `4.x`                  |
+
+#### Note: Other resources from `7.x` are not affected and no changes are required.
+
+#### emailProvider
+
+The `delete` operation on the `emailProvider` resource will disable the email provider instead of deleting it.
+This is because the email provider deletion operation is deprecated on auth0 `4.x`. User can disable the email provider
+by email provider setting the `enabled` property to `false` from the configuration file.
+
+```yaml
+  emailProvider:
+    # other properties
+    enabled: false
+```
+
+Rest of the operations on emailProvider resource will work the same as `7.x`.
+
+#### migrations
+
+The `migrations` resource is not supported on auth0 `4.x`. It's recommended to remove the `migrations` resource from the
+configuration file. If it's not removed, the deploy CLI will ignore the `migrations` resource for operations.
+
+

examples/directory/README.md

@@ -40,13 +40,6 @@ repository =>
   resource-servers
     resource_server1.json
     resource_server2.json
-  rules
-    rule1.js
-    rule1.json
-    rule2.js
-  rules-configs
-    env_param1.json
-    some_secret1.json
   guardian
     factors
       sms.json

examples/directory/config.json.example

@@ -7,13 +7,13 @@
     "ENV": "DEV"
   },
   "AUTH0_ALLOW_DELETE": false,
+  "INCLUDED_PROPS": {
+    "clients": [ "client_secret" ]
+  },
   "AUTH0_EXCLUDED_RULES": [
     "rule-1-name",
     "rule-2-name"
   ],
-  "INCLUDED_PROPS": {
-    "clients": [ "client_secret" ]
-  },
   "EXCLUDED_PROPS": {
     "connections": [ "options.client_secret" ]
   }

examples/yaml/config.json.example

@@ -1,19 +1,19 @@
 {
-  "AUTH0_DOMAIN": "<YOUR_TENANT>.<YOUR_REGION>.auth0.com", 
+  "AUTH0_DOMAIN": "<YOUR_TENANT>.<YOUR_REGION>.auth0.com",
   "AUTH0_CLIENT_ID": "<client_id>",
   "AUTH0_CLIENT_SECRET": "<client_secret>",
   "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
     "AUTH0_TENANT_NAME": "<NAME>",
     "ENV": "DEV"
   },
   "AUTH0_ALLOW_DELETE": false,
+  "INCLUDED_PROPS": {
+    "clients": [ "client_secret" ]
+  },
   "AUTH0_EXCLUDED_RULES": [
     "rule-1-name",
     "rule-2-name"
   ],
-  "INCLUDED_PROPS": {
-    "clients": [ "client_secret" ]
-  },
   "EXCLUDED_PROPS": {
     "connections": [ "options.client_secret" ]
   }

examples/yaml/tenant.yaml

@@ -63,27 +63,6 @@ connections:
     # Add other connection settings (https://auth0.com/docs/api/management/v2#!/Connections/post_connections)
 
 
-rules:
-  - name: "Common-Functions"
-    order: 10
-    script: "rules/enrich_tokens.js"
-
-rulesConfigs:
-  # Key/Value pairs for Rule configuration settings
-  - key: "SOME_SECRET"
-    value: 'some_key'
-
-hooks:
-  - name: "Client Credentials Exchange"
-    triggerId: "credentials-exchange"
-    enabled: true
-    secrets:
-      api-key: "my custom api key"
-    dependencies:
-      bcrypt: "3.0.6"
-    script: "hooks/client-credentials-exchange.js"
-
-
 resourceServers:
   -
     name: "My API"