Merge branch 'DXCDT-859-Extensibility-as-custom-provider-deploy-cli-support' of https://github.com/auth0/auth0-deploy-cli into DXCDT-859-Extensibility-as-custom-provider-deploy-cli-support

Author: ramya18101

README.md

@@ -70,7 +70,7 @@ This guide will help you to a working implementation of the Deploy CLI tool used
 
 ### Prerequisites
 
-- [Node](https://nodejs.dev/) version 18 or greater
+- [Node](https://nodejs.dev/) version 20(v20.18.3) or greater
 - [Auth0 Tenant](https://auth0.com/)
 
 ### Install the Deploy CLI

docs/v8_MIGRATION_GUIDE.md

@@ -3,17 +3,17 @@
 Guide to migrating from `7.x` to `8.x`
 
 - [General](#general)
-  - [Node 18 or newer is required](#node-18-or-newer-is-required)
+  - [Node 20(v20.18.3) or newer is required](#node-20(v20.18.3)-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 20(v20.18.3) or newer is required
 
-Node 18 LTS and newer LTS releases are supported.
+Node 20(v20.18.3) LTS and newer LTS releases are supported.
 
 ## Management Resources
 

package-lock.json

@@ -42,7 +42,7 @@
     "nconf": "^0.12.1",
     "promise-pool-executor": "^1.1.1",
     "sanitize-filename": "^1.6.3",
-    "undici": "^7.3.0",
+    "undici": "^7.4.0",
     "winston": "^3.17.0",
     "yargs": "^15.3.1"
   },
@@ -70,12 +70,12 @@
     "rmdir-sync": "^1.0.1",
     "sinon": "^13.0.2",
     "sinon-chai": "^3.7.0",
-    "ts-mocha": "^10.0.0",
-    "typescript": "^5.7.2",
+    "ts-mocha": "^10.1.0",
+    "typescript": "^5.8.2",
     "zlib": "^1.0.5"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">= 20.18.3"
   },
   "keywords": [
     "auth0",

package.json

@@ -68,17 +68,6 @@ export default async function exportCMD(params: ExportParams) {
   // Setup context and load
   const context = await setupContext(nconf.get(), 'export');
   await context.dump();
-  log.info('Export Successful');
-
-  log.info(`
-  ================================================
-  ======= Help us improve Auth0 Deploy CLI =======
-  ================================================
-  We're on a mission to make Auth0 Deploy CLI the best it can be, and we need YOUR help.
-  We've put together a brief survey to understand how you use Deploy CLI, what you love about it, and where you think we can do better.
 
-  ===> https://www.surveymonkey.com/r/LZKMPFN  <===
-
-  Thank you for helping us make Auth0 Deploy CLI better for everyone!
-  ================================================`);
+  log.info('Export Successful');
 }

src/commands/export.ts

@@ -61,16 +61,4 @@ export default async function importCMD(params: ImportParams) {
   await toolsDeploy(context.assets, context.mgmtClient, config);
 
   log.info('Import Successful');
-
-  log.info(`
-  ================================================
-  ======= Help us improve Auth0 Deploy CLI =======
-  ================================================
-  We're on a mission to make Auth0 Deploy CLI the best it can be, and we need YOUR help.
-  We've put together a brief survey to understand how you use Deploy CLI, what you love about it, and where you think we can do better.
-
-  ===> https://www.surveymonkey.com/r/LZKMPFN  <===
-
-  Thank you for helping us make Auth0 Deploy CLI better for everyone!
-  ================================================`);
 }

src/commands/import.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import fs from 'fs-extra';
 import { Client, ResourceServer } from 'auth0';
-import { constants } from '../../../tools';
+import { constants, keywordReplace } from '../../../tools';
 
 import {
   getFiles,
@@ -16,6 +16,7 @@ import DirectoryContext from '..';
 import { ParsedAsset } from '../../../types';
 import { ClientGrant } from '../../../tools/auth0/handlers/clientGrants';
 import { paginate } from '../../../tools/auth0/client';
+import { doesHaveKeywordMarker } from '../../../keywordPreservation';
 
 type ParsedClientGrants = ParsedAsset<'clientGrants', ClientGrant[]>;
 
@@ -71,28 +72,41 @@ async function dump(context: DirectoryContext): Promise<void> {
     }
 
     const clientName = (() => {
-      const associatedClient = allClients.find((client) => {
-        return client.client_id === grant.client_id;
-      });
+      const associatedClient = allClients.find((client) => client.client_id === grant.client_id);
 
       if (associatedClient === undefined) return grant.client_id;
 
       return associatedClient.name;
     })();
 
-    const apiName = (() => {
-      const associatedAPI = allResourceServers.find((resourceServer) => {
-        return resourceServer.identifier === grant.audience;
-      });
+    // Convert audience to the API name for readability
+    const apiName = (grantAudience: string) => {
+      const associatedAPI = allResourceServers.find(
+        (resourceServer) => resourceServer.identifier === grantAudience
+      );
 
-      if (associatedAPI === undefined) return grant.audience;
+      if (associatedAPI === undefined) return grantAudience; // Use the audience if the API is not found
 
-      return associatedAPI.name;
-    })();
+      return associatedAPI.name; // Use the name of the API
+    };
 
-    const name = sanitize(`${clientName}-${apiName}`);
-    const grantFile = path.join(grantsFolder, `${name}.json`);
+    // Replace keyword markers if necessary
+    const clientNameNonMarker = doesHaveKeywordMarker(clientName, context.mappings)
+      ? keywordReplace(clientName, context.mappings)
+      : clientName;
+    const apiAudienceNonMarker = doesHaveKeywordMarker(grant.audience, context.mappings)
+      ? keywordReplace(grant.audience, context.mappings)
+      : grant.audience;
+
+    // Construct the name using non-marker names
+    const name = sanitize(`${clientNameNonMarker}-${apiName(apiAudienceNonMarker)}`);
 
+    // Ensure the name is not empty or invalid
+    if (!name || name.trim().length === 0) {
+      throw new Error(`Invalid name generated for client grant: ${JSON.stringify(grant)}`);
+    }
+
+    const grantFile = path.join(grantsFolder, `${name}.json`);
     dumpJSON(grantFile, dumpGrant);
   });
 }

src/context/directory/handlers/clientGrants.ts

@@ -297,6 +297,17 @@ export const preserveKeywords = ({
       );
     }
 
+    // Update the clientGrants audience field if it exists
+    if (updatedRemoteAssets && (updatedRemoteAssets as any).clientGrants) {
+      for (let i = 0; i < (updatedRemoteAssets as any).clientGrants.length; i++) {
+        const clientGrant = (updatedRemoteAssets as any).clientGrants[i];
+        if (clientGrant.audience === remoteValue) {
+          clientGrant.audience = localValue;
+        }
+        (updatedRemoteAssets as any).clientGrants[i] = clientGrant;
+      }
+    }
+
     // Two address possibilities are provided to account for cases when there is a keyword
     // in the resources's identifier field. When the resource identifier's field is preserved
     // on the remote assets tree, it loses its identify, so we'll need to try two addresses:

src/keywordPreservation.ts

@@ -144,7 +144,7 @@ export default class ConnectionsHandler extends DefaultAPIHandler {
     if (this.existing) return this.existing;
 
     const connections = await paginate<Connection>(this.client.connections.getAll, {
-      paginate: true,
+      checkpoint: true,
       include_totals: true,
     });
 
@@ -177,7 +177,7 @@ export default class ConnectionsHandler extends DefaultAPIHandler {
     });
 
     const existingConnections = await paginate<Connection>(this.client.connections.getAll, {
-      paginate: true,
+      checkpoint: true,
       include_totals: true,
     });
 

src/tools/auth0/handlers/connections.ts

@@ -152,7 +152,7 @@ export default class DatabaseHandler extends DefaultAPIHandler {
 
     const connections = await paginate<Connection>(this.client.connections.getAll, {
       strategy: [GetConnectionsStrategyEnum.auth0],
-      paginate: true,
+      checkpoint: true,
       include_totals: true,
     });
     this.existing = connections;
@@ -183,7 +183,7 @@ export default class DatabaseHandler extends DefaultAPIHandler {
       this.client.connections.getAll,
       {
         strategy: [GetConnectionsStrategyEnum.auth0],
-        paginate: true,
+        checkpoint: true,
         include_totals: true,
       }
     );