auth0-deploy-cli 8.30.0 → 8.32.0

package/lib/types.d.ts

@@ -71,7 +71,11 @@ export type Config = {
     AUTH0_RETRY_MAX_DELAY_MS?: number;
     AUTH0_KEYWORD_REPLACE_MAPPINGS?: KeywordMappings;
     AUTH0_EXPORT_IDENTIFIERS?: boolean;
+    AUTH0_EXPORT_ORDERED?: boolean;
     AUTH0_CONNECTIONS_DIRECTORY?: string;
+    AUTH0_DRY_RUN?: boolean | 'preview';
+    AUTH0_DRY_RUN_INTERACTIVE?: boolean;
+    AUTH0_DRY_RUN_APPLY?: boolean;
     EXCLUDED_PROPS?: {
         [key: string]: string[];
     };
@@ -157,6 +161,19 @@ export type CalculatedChanges = {
     conflicts: Asset[];
     create: Asset[];
 };
+export type DetailedDryRunChange = {
+    action: 'CREATE' | 'UPDATE' | 'DELETE';
+    identifier: string;
+    details?: any;
+};
+export type DetailedDryRunChanges = {
+    [key: string]: {
+        created: number;
+        updated: number;
+        deleted: number;
+        changes: DetailedDryRunChange[];
+    };
+};
 export type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' | 'databases' | 'clientGrants' | 'resourceServers' | 'clients' | 'connections' | 'tenant' | 'emailProvider' | 'emailTemplates' | 'guardianFactors' | 'guardianFactorProviders' | 'guardianFactorTemplates' | 'guardianPhoneFactorMessageTypes' | 'guardianPhoneFactorSelectedProvider' | 'guardianPolicies' | 'roles' | 'actions' | 'actionModules' | 'organizations' | 'triggers' | 'attackProtection' | 'riskAssessment' | 'branding' | 'phoneProviders' | 'phoneTemplates' | 'logStreams' | 'prompts' | 'customDomains' | 'themes' | 'forms' | 'flows' | 'flowVaultConnections' | 'selfServiceProfiles' | 'networkACLs' | 'userAttributeProfiles' | 'connectionProfiles' | 'tokenExchangeProfiles' | 'supplementalSignals';
 export type KeywordMappings = {
     [key: string]: (string | number)[] | string | number;

package/lib/utils.d.ts

@@ -1,5 +1,6 @@
 import { Auth0 } from './tools';
 import { Asset, Assets, Config, KeywordMappings } from './types';
+export declare function isTruthy(value: unknown): boolean;
 export declare function isDirectory(filePath: string): boolean;
 export declare function isFile(filePath: string): boolean;
 export declare function getFiles(folder: string, exts: string[]): string[];
@@ -45,4 +46,10 @@ export declare const findKeyPathWithValue: (obj: any, findKey: string, parentPat
  * @returns The Base64 encoded certificate string if the input starts with '-----BEGIN CERTIFICATE-----', otherwise returns the original string.
  */
 export declare const encodeCertStringToBase64: (cert: string) => string;
+export declare const decodeBase64ToCertString: (base64Cert: string) => string;
+export declare const getFormattedOptions: (connection: any, clients: any) => {
+    options: any;
+} | {
+    options?: undefined;
+};
 export {};

package/lib/utils.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeCertStringToBase64 = exports.findKeyPathWithValue = void 0;
+exports.getFormattedOptions = exports.decodeBase64ToCertString = exports.encodeCertStringToBase64 = exports.findKeyPathWithValue = void 0;
+exports.isTruthy = isTruthy;
 exports.isDirectory = isDirectory;
 exports.isFile = isFile;
 exports.getFiles = getFiles;
@@ -24,11 +25,15 @@ exports.mapClientID2NameSorted = mapClientID2NameSorted;
 exports.nomalizedYAMLPath = nomalizedYAMLPath;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const nconf_1 = __importDefault(require("nconf"));
 const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
 const dot_prop_1 = __importDefault(require("dot-prop"));
 const lodash_1 = require("lodash");
 const tools_1 = require("./tools");
 const logger_1 = __importDefault(require("./logger"));
+function isTruthy(value) {
+    return value === true || value === 'true';
+}
 function isDirectory(filePath) {
     try {
         return fs_extra_1.default.statSync(path_1.default.resolve(filePath)).isDirectory();
@@ -69,10 +74,21 @@ function loadJSON(file, opts = {
         throw new Error(`Error parsing JSON from metadata file: ${file}, because: ${e.message}`);
     }
 }
+function orderedKeysReplacer(_key, value) {
+    if (value && typeof value === 'object' && !Array.isArray(value)) {
+        const obj = value;
+        return Object.fromEntries(Object.keys(obj)
+            .sort()
+            .map((k) => [k, obj[k]]));
+    }
+    return value;
+}
 function dumpJSON(file, mappings) {
     try {
         logger_1.default.info(`Writing ${file}`);
-        const jsonBody = JSON.stringify(mappings, null, 2);
+        const exportOrdered = Boolean(nconf_1.default.get('AUTH0_EXPORT_ORDERED'));
+        const replacer = exportOrdered ? orderedKeysReplacer : undefined;
+        const jsonBody = JSON.stringify(mappings, replacer, 2);
         fs_extra_1.default.writeFileSync(file, jsonBody.endsWith('\n') ? jsonBody : `${jsonBody}\n`);
     }
     catch (e) {
@@ -272,3 +288,31 @@ const encodeCertStringToBase64 = (cert) => {
     return cert;
 };
 exports.encodeCertStringToBase64 = encodeCertStringToBase64;
+// Decode a Base64 encoded certificate string back to its original format.
+const decodeBase64ToCertString = (base64Cert) => {
+    try {
+        return Buffer.from(base64Cert, 'base64').toString('utf-8');
+    }
+    catch (e) {
+        return base64Cert;
+    }
+};
+exports.decodeBase64ToCertString = decodeBase64ToCertString;
+// Format connection options by converting client IDs to client names for SAML connections
+const getFormattedOptions = (connection, clients) => {
+    try {
+        return {
+            options: {
+                ...connection.options,
+                idpinitiated: {
+                    ...connection.options.idpinitiated,
+                    client_id: convertClientIdToName(connection.options.idpinitiated.client_id, clients),
+                },
+            },
+        };
+    }
+    catch (e) {
+        return {};
+    }
+};
+exports.getFormattedOptions = getFormattedOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "8.30.0",
+  "version": "8.32.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -9,6 +9,7 @@
   "scripts": {
     "lint:fix": "eslint --fix . && kacl lint",
     "lint": "eslint . && kacl lint",
+    "format:check": "npx prettier --check .",
     "format": "npx prettier --write .",
     "test": "ts-mocha -p tsconfig.json --recursive 'test/**/*.test*' --exclude 'test/e2e/*' --timeout 20000",
     "test:e2e:node-module": "ts-mocha -p tsconfig.json --recursive 'test/e2e/*.test*' --timeout 150000",
@@ -32,28 +33,31 @@
   "readme": "README.md",
   "homepage": "https://github.com/auth0/auth0-deploy-cli#readme",
   "dependencies": {
+    "@clack/prompts": "1.2.0",
     "ajv": "^6.12.6",
-    "auth0": "^5.5.0",
+    "chalk": "5.6.2",
+    "auth0": "^5.8.0",
     "dot-prop": "^5.3.0",
     "fs-extra": "^10.1.0",
     "js-yaml": "^4.1.1",
-    "lodash": "^4.17.23",
+    "lodash": "^4.18.1",
     "mkdirp": "^1.0.4",
     "nconf": "^0.13.0",
     "promise-pool-executor": "^1.1.1",
-    "sanitize-filename": "^1.6.3",
+    "sanitize-filename": "^1.6.4",
     "undici": "^7.24.3",
     "winston": "^3.19.0",
     "yargs": "^15.4.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
+    "@types/chai": "^5.2.3",
     "@types/fs-extra": "^9.0.13",
     "@types/lodash": "^4.17.24",
     "@types/mocha": "^10.0.10",
     "@types/nconf": "^0.10.7",
-    "@typescript-eslint/eslint-plugin": "^8.57.0",
-    "@typescript-eslint/parser": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^8.58.1",
+    "@typescript-eslint/parser": "^8.58.1",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
     "eslint": "^9.39.2",