@contentstack/cli-config 1.20.4 → 1.21.0

package/README.md

@@ -2,7 +2,7 @@
 
 The config namespace contains all the commands that you will need to configure the CLI as per your requirements. Contentstack currently supports four regions: North America, Europe, Azure North America and Azure Europe. [Configure the CLI documentation](https://www.contentstack.com/docs/developers/cli/configure-the-cli)
 
-[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
+[![License](https://img.shields.io/npm/l/@contentstack/cli-config)](https://github.com/contentstack/cli/blob/main/LICENSE)
 
 <!-- toc -->
 * [@contentstack/cli-config](#contentstackcli-config)
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.20.4 linux-x64 node-v22.22.3
+@contentstack/cli-config/1.21.0 linux-x64 node-v22.23.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -457,7 +457,7 @@ Set region for CLI
 ```
 USAGE
   $ csdx config:set:region [REGION] [-d <value> -m <value> --ui-host <value> -n <value>] [--developer-hub <value>]
-    [--personalize <value>] [--launch <value>] [--studio <value>]
+    [--personalize <value>] [--launch <value>] [--studio <value>] [--auth-api <value>]
 
 ARGUMENTS
   [REGION]  Name for the region
@@ -468,6 +468,7 @@ FLAGS
   -m, --cma=<value>            Custom host to set for content management API, , if this flag is added then cda, ui-host
                                and name flags are required
   -n, --name=<value>           Name for the region, if this flag is added then cda, cma and ui-host flags are required
+      --auth-api=<value>       Custom host to set for Auth API
       --developer-hub=<value>  Custom host to set for Developer hub API
       --launch=<value>         Custom host to set for Launch API
       --personalize=<value>    Custom host to set for Personalize API

package/lib/commands/config/set/region.js

@@ -5,6 +5,7 @@ const utils_1 = require("../../../utils");
 const base_command_1 = require("../../../base-command");
 class RegionSetCommand extends base_command_1.BaseCommand {
     async run() {
+        var _a;
         const { args, flags: regionSetFlags } = await this.parse(RegionSetCommand);
         let cda = regionSetFlags.cda;
         let cma = regionSetFlags.cma;
@@ -14,6 +15,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
         let personalizeUrl = regionSetFlags['personalize'];
         let launchHubUrl = regionSetFlags['launch'];
         let composableStudioUrl = regionSetFlags['studio'];
+        let authUrl = regionSetFlags['auth-api'];
         let selectedRegion = args.region;
         if (!(cda && cma && uiHost && name) && !selectedRegion) {
             selectedRegion = await utils_1.interactive.askRegions();
@@ -43,6 +45,9 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                 if (!composableStudioUrl) {
                     composableStudioUrl = this.transformUrl(cma, 'composable-studio-api');
                 }
+                if (!authUrl) {
+                    authUrl = this.transformUrl(cma, 'auth-api');
+                }
                 let customRegion = {
                     cda,
                     cma,
@@ -52,6 +57,16 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                     personalizeUrl,
                     launchHubUrl,
                     composableStudioUrl,
+                    endpoints: {
+                        contentManagement: cma,
+                        contentDelivery: cda,
+                        application: uiHost,
+                        developerHub: developerHubUrl,
+                        launch: launchHubUrl,
+                        personalizeManagement: personalizeUrl,
+                        composableStudio: composableStudioUrl,
+                        auth: authUrl,
+                    },
                 };
                 customRegion = utils_1.regionHandler.setCustomRegion(customRegion);
                 await cli_utilities_1.authHandler.setConfigData('logout'); //Todo: Handle this logout flow well through logout command call
@@ -63,6 +78,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                 cli_utilities_1.cliux.success(`Personalize URL: ${customRegion.personalizeUrl}`);
                 cli_utilities_1.cliux.success(`Launch URL: ${customRegion.launchHubUrl}`);
                 cli_utilities_1.cliux.success(`Studio URL: ${customRegion.composableStudioUrl}`);
+                cli_utilities_1.cliux.success(`Auth API URL: ${(_a = customRegion.endpoints) === null || _a === void 0 ? void 0 : _a.auth}`);
             }
             catch (error) {
                 (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.contextDetails), { module: 'config-set-region' }));
@@ -130,6 +146,9 @@ RegionSetCommand.flags = {
     studio: cli_utilities_1.flags.string({
         description: 'Custom host to set for Studio API',
     }),
+    'auth-api': cli_utilities_1.flags.string({
+        description: 'Custom host to set for Auth API',
+    }),
 };
 RegionSetCommand.examples = [
     '$ csdx config:set:region',

package/lib/interfaces/index.d.ts

@@ -17,6 +17,7 @@ export interface Region {
     personalizeUrl: string;
     launchHubUrl: string;
     composableStudioUrl: string;
+    endpoints?: Record<string, string>;
 }
 export interface Limit {
     value: number;

package/lib/utils/region-handler.d.ts

@@ -38,16 +38,7 @@ declare class UserConfig {
      * @param { object } regionObject JSON object needs to be sanitized
      * @returns { object } JSON object with only valid keys for region
      */
-    sanitizeRegionObject(regionObject: any): {
-        cma: any;
-        cda: any;
-        uiHost: any;
-        name: any;
-        developerHubUrl: any;
-        personalizeUrl: any;
-        launchHubUrl: any;
-        composableStudioUrl: any;
-    };
+    sanitizeRegionObject(regionObject: any): import("@contentstack/cli-utilities").CanonicalRegion;
 }
 export { regions };
 declare const _default: UserConfig;

package/lib/utils/region-handler.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.regions = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const utils_1 = require("@contentstack/utils");
 function validURL(str) {
     const pattern = new RegExp('^(https?:\\/\\/)?' + // protocol (http or https)
         '([a-zA-Z0-9.-]+|' + // domain name
@@ -20,44 +19,18 @@ function validURL(str) {
  * @returns {object} Region object with all necessary URLs
  */
 function getRegionObject(regionKey) {
-    try {
-        // getContentstackEndpoint handles all aliases defined in regions.json
-        const endpoints = (0, utils_1.getContentstackEndpoint)(regionKey);
-        if (typeof endpoints === 'string') {
-            throw new Error('Invalid endpoint response');
-        }
-        return {
-            name: regionKey,
-            cma: endpoints.contentManagement,
-            cda: endpoints.contentDelivery,
-            uiHost: endpoints.application,
-            developerHubUrl: endpoints.developerHub,
-            launchHubUrl: endpoints.launch,
-            personalizeUrl: endpoints.personalizeManagement,
-            composableStudioUrl: endpoints.composableStudio,
-        };
-    }
-    catch (_a) {
+    // resolveCanonicalEndpoints handles all aliases defined in regions.json
+    const endpoints = (0, cli_utilities_1.resolveCanonicalEndpoints)(regionKey);
+    if (!endpoints)
         return null;
-    }
+    return (0, cli_utilities_1.buildRegionFromEndpoints)(regionKey, endpoints);
 }
 /**
  * Get all available regions dynamically
  * This creates a regions object similar to the old hardcoded one but using @contentstack/utils
  */
 function getAvailableRegions() {
-    const regionKeys = [
-        'NA',
-        'AWS-NA',
-        'EU',
-        'AWS-EU',
-        'AU',
-        'AWS-AU',
-        'AZURE-NA',
-        'AZURE-EU',
-        'GCP-NA',
-        'GCP-EU',
-    ];
+    const regionKeys = ['NA', 'AWS-NA', 'EU', 'AWS-EU', 'AU', 'AWS-AU', 'AZURE-NA', 'AZURE-EU', 'GCP-NA', 'GCP-EU'];
     const regions = {};
     for (const key of regionKeys) {
         const regionObj = getRegionObject(key);
@@ -142,17 +115,22 @@ class UserConfig {
      * @returns { object } JSON object with only valid keys for region
      */
     sanitizeRegionObject(regionObject) {
-        const sanitizedRegion = {
-            cma: regionObject.cma,
-            cda: regionObject.cda,
-            uiHost: regionObject.uiHost,
-            name: regionObject.name,
-            developerHubUrl: regionObject['developerHubUrl'],
-            personalizeUrl: regionObject['personalizeUrl'],
-            launchHubUrl: regionObject['launchHubUrl'],
-            composableStudioUrl: regionObject['composableStudioUrl'],
+        var _a;
+        // endpoints is the single source of truth — every friendly field (cma, cda, ...,
+        // authUrl) is derived from it below via buildRegionFromEndpoints, same as named
+        // regions. Falls back to synthesizing endpoints from the individual raw fields
+        // when the caller didn't supply one directly.
+        const endpoints = (_a = regionObject['endpoints']) !== null && _a !== void 0 ? _a : {
+            contentManagement: regionObject.cma,
+            contentDelivery: regionObject.cda,
+            application: regionObject.uiHost,
+            developerHub: regionObject['developerHubUrl'],
+            launch: regionObject['launchHubUrl'],
+            personalizeManagement: regionObject['personalizeUrl'],
+            composableStudio: regionObject['composableStudioUrl'],
+            auth: regionObject['authUrl'],
         };
-        return sanitizedRegion;
+        return (0, cli_utilities_1.buildRegionFromEndpoints)(regionObject.name, endpoints);
     }
 }
 exports.default = new UserConfig();

package/oclif.manifest.json

@@ -1,16 +1,33 @@
 {
   "commands": {
-    "config:get:base-branch": {
+    "config:remove:base-branch": {
       "aliases": [],
       "args": {},
-      "description": "Get current branch set for CLI",
+      "description": "Remove branch config for CLI",
       "examples": [
-        "$ csdx config:get:base-branch"
+        "$ csdx config:remove:base-branch",
+        "$ csdx config:remove:base-branch --stack-api-key <value>"
       ],
-      "flags": {},
+      "flags": {
+        "stack-api-key": {
+          "char": "k",
+          "description": "Stack API key.",
+          "name": "stack-api-key",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "yes": {
+          "char": "y",
+          "description": "Force remove.",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:base-branch",
+      "id": "config:remove:base-branch",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -20,23 +37,39 @@
         "lib",
         "commands",
         "config",
-        "get",
+        "remove",
         "base-branch.js"
       ]
     },
-    "config:get:early-access-header": {
+    "config:remove:early-access-header": {
       "aliases": [
-        "config:get:ea-header"
+        "config:remove:ea-header"
       ],
       "args": {},
-      "description": "Display Early Access headers",
+      "description": "Remove Early Access header",
       "examples": [
-        "$ <%= config.bin %> <%= command.id %>"
+        "$ <%= config.bin %> <%= command.id %>",
+        "$ <%= config.bin %> <%= command.id %> --header-alias <value>"
       ],
-      "flags": {},
+      "flags": {
+        "header-alias": {
+          "description": "(optional) Provide the Early Access header alias name.",
+          "name": "header-alias",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "yes": {
+          "char": "y",
+          "description": "(optional) Force the removal of Early Access header configuration by skipping the confirmation.",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:early-access-header",
+      "id": "config:remove:early-access-header",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -46,21 +79,21 @@
         "lib",
         "commands",
         "config",
-        "get",
+        "remove",
         "early-access-header.js"
       ]
     },
-    "config:get:log": {
+    "config:remove:proxy": {
       "aliases": [],
       "args": {},
-      "description": "Get logging configuration for CLI",
+      "description": "Remove proxy configuration from global config",
       "examples": [
-        "csdx config:get:log"
+        "csdx config:remove:proxy"
       ],
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:log",
+      "id": "config:remove:proxy",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -70,21 +103,29 @@
         "lib",
         "commands",
         "config",
-        "get",
-        "log.js"
+        "remove",
+        "proxy.js"
       ]
     },
-    "config:get:proxy": {
+    "config:remove:rate-limit": {
       "aliases": [],
       "args": {},
-      "description": "Get proxy configuration for CLI",
+      "description": "Remove rate-limit of the organization",
       "examples": [
-        "csdx config:get:proxy"
+        "$ csdx config:remove:rate-limit --org <<org_uid>>"
       ],
-      "flags": {},
+      "flags": {
+        "org": {
+          "description": "Provide the organization UID",
+          "name": "org",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:proxy",
+      "id": "config:remove:rate-limit",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -94,21 +135,21 @@
         "lib",
         "commands",
         "config",
-        "get",
-        "proxy.js"
+        "remove",
+        "rate-limit.js"
       ]
     },
-    "config:get:rate-limit": {
+    "config:get:base-branch": {
       "aliases": [],
       "args": {},
-      "description": "Get rate-limit of organizations",
+      "description": "Get current branch set for CLI",
       "examples": [
-        "$ csdx config:get:rate-limit"
+        "$ csdx config:get:base-branch"
       ],
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:rate-limit",
+      "id": "config:get:base-branch",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -119,20 +160,22 @@
         "commands",
         "config",
         "get",
-        "rate-limit.js"
+        "base-branch.js"
       ]
     },
-    "config:get:region": {
-      "aliases": [],
+    "config:get:early-access-header": {
+      "aliases": [
+        "config:get:ea-header"
+      ],
       "args": {},
-      "description": "Get current region set for CLI",
+      "description": "Display Early Access headers",
       "examples": [
-        "$ csdx config:get:region"
+        "$ <%= config.bin %> <%= command.id %>"
       ],
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:get:region",
+      "id": "config:get:early-access-header",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -143,37 +186,20 @@
         "commands",
         "config",
         "get",
-        "region.js"
+        "early-access-header.js"
       ]
     },
-    "config:remove:base-branch": {
+    "config:get:log": {
       "aliases": [],
       "args": {},
-      "description": "Remove branch config for CLI",
+      "description": "Get logging configuration for CLI",
       "examples": [
-        "$ csdx config:remove:base-branch",
-        "$ csdx config:remove:base-branch --stack-api-key <value>"
+        "csdx config:get:log"
       ],
-      "flags": {
-        "stack-api-key": {
-          "char": "k",
-          "description": "Stack API key.",
-          "name": "stack-api-key",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "yes": {
-          "char": "y",
-          "description": "Force remove.",
-          "name": "yes",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
+      "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:remove:base-branch",
+      "id": "config:get:log",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -183,39 +209,21 @@
         "lib",
         "commands",
         "config",
-        "remove",
-        "base-branch.js"
+        "get",
+        "log.js"
       ]
     },
-    "config:remove:early-access-header": {
-      "aliases": [
-        "config:remove:ea-header"
-      ],
+    "config:get:proxy": {
+      "aliases": [],
       "args": {},
-      "description": "Remove Early Access header",
+      "description": "Get proxy configuration for CLI",
       "examples": [
-        "$ <%= config.bin %> <%= command.id %>",
-        "$ <%= config.bin %> <%= command.id %> --header-alias <value>"
+        "csdx config:get:proxy"
       ],
-      "flags": {
-        "header-alias": {
-          "description": "(optional) Provide the Early Access header alias name.",
-          "name": "header-alias",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "yes": {
-          "char": "y",
-          "description": "(optional) Force the removal of Early Access header configuration by skipping the confirmation.",
-          "name": "yes",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
+      "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:remove:early-access-header",
+      "id": "config:get:proxy",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -225,21 +233,21 @@
         "lib",
         "commands",
         "config",
-        "remove",
-        "early-access-header.js"
+        "get",
+        "proxy.js"
       ]
     },
-    "config:remove:proxy": {
+    "config:get:rate-limit": {
       "aliases": [],
       "args": {},
-      "description": "Remove proxy configuration from global config",
+      "description": "Get rate-limit of organizations",
       "examples": [
-        "csdx config:remove:proxy"
+        "$ csdx config:get:rate-limit"
       ],
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:remove:proxy",
+      "id": "config:get:rate-limit",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -249,29 +257,21 @@
         "lib",
         "commands",
         "config",
-        "remove",
-        "proxy.js"
+        "get",
+        "rate-limit.js"
       ]
     },
-    "config:remove:rate-limit": {
+    "config:get:region": {
       "aliases": [],
       "args": {},
-      "description": "Remove rate-limit of the organization",
+      "description": "Get current region set for CLI",
       "examples": [
-        "$ csdx config:remove:rate-limit --org <<org_uid>>"
+        "$ csdx config:get:region"
       ],
-      "flags": {
-        "org": {
-          "description": "Provide the organization UID",
-          "name": "org",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
+      "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:remove:rate-limit",
+      "id": "config:get:region",
       "pluginAlias": "@contentstack/cli-config",
       "pluginName": "@contentstack/cli-config",
       "pluginType": "core",
@@ -281,8 +281,8 @@
         "lib",
         "commands",
         "config",
-        "remove",
-        "rate-limit.js"
+        "get",
+        "region.js"
       ]
     },
     "config:set:base-branch": {
@@ -648,6 +648,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "auth-api": {
+          "description": "Custom host to set for Auth API",
+          "name": "auth-api",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -667,5 +674,5 @@
       ]
     }
   },
-  "version": "1.20.4"
+  "version": "1.21.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.20.4",
+  "version": "1.21.0",
   "author": "Contentstack",
   "scripts": {
     "build": "pnpm compile && oclif manifest && oclif readme",
@@ -14,8 +14,8 @@
     "lint": "eslint src/**/*.ts"
   },
   "dependencies": {
-    "@contentstack/cli-command": "~1.8.3",
-    "@contentstack/cli-utilities": "~1.18.4",
+    "@contentstack/cli-command": "~1.8.5",
+    "@contentstack/cli-utilities": "~1.19.0",
     "@contentstack/utils": "~1.9.1",
     "@oclif/core": "^4.11.4"
   },
@@ -31,7 +31,7 @@
     "@types/node": "^14.18.63",
     "@types/sinon": "^21.0.0",
     "chai": "^4.5.0",
-    "eslint": "^9.26.0",
+    "eslint": "^10.5.0",
     "eslint-config-oclif": "^6.0.62",
     "eslint-config-oclif-typescript": "^3.1.14",
     "mocha": "10.8.2",
@@ -42,7 +42,7 @@
     "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=22.0.0"
   },
   "files": [
     "/lib",
@@ -91,4 +91,4 @@
     }
   },
   "repository": "contentstack/cli"
-}
+}