@contentstack/cli-config 2.0.0-beta.9 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @contentstack/cli-config
 
-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)
+The config namespace contains all the commands that you will need to configure the CLI as per your requirements. Contentstack supports multiple regions. [Configure the CLI documentation](https://www.contentstack.com/docs/headless-cms/configure-the-cli)
 
 [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
 
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/2.0.0-beta.9 linux-x64 node-v22.22.2
+@contentstack/cli-config/2.0.0 linux-x64 node-v22.23.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -316,8 +316,8 @@ USAGE
   $ csdx config:set:ea-header [--header-alias <value>] [--header <value>]
 
 FLAGS
-  --header=<value>        (optional) Provide the Early Access header alias name.
-  --header-alias=<value>  (optional) Provide the Early Access header value.
+  --header=<value>        (optional) Provide the Early Access header value.
+  --header-alias=<value>  (optional) Provide a name (alias) for this Early Access header.
 
 DESCRIPTION
   Set Early Access header
@@ -340,8 +340,8 @@ USAGE
   $ csdx config:set:early-access-header [--header-alias <value>] [--header <value>]
 
 FLAGS
-  --header=<value>        (optional) Provide the Early Access header alias name.
-  --header-alias=<value>  (optional) Provide the Early Access header value.
+  --header=<value>        (optional) Provide the Early Access header value.
+  --header-alias=<value>  (optional) Provide a name (alias) for this Early Access header.
 
 DESCRIPTION
   Set Early Access header
@@ -456,25 +456,26 @@ Set region for CLI
 
 ```
 USAGE
-  $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
-    <value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--cs-assets <value>]
+  $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> --name <value>] [--developer-hub
+    <value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--cs-assets <value>] [--auth-api <value>]
 
 ARGUMENTS
   [REGION]  Name for the region
 
 FLAGS
-  -n, --name=<value>           Name for the region, if this flag is added then cda, cma and ui-host flags are required
-      --cda=<value>            Custom host to set for content delivery API, if this flag is added then cma, ui-host and
-                               name flags are required
-      --cma=<value>            Custom host to set for content management API, , if this flag is added then cda, ui-host
-                               and name flags are required
-      --cs-assets=<value>      Custom host to set for Contentstack Assets 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
-      --studio=<value>         Custom host to set for Studio API
-      --ui-host=<value>        Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
-                               required
+  --auth-api=<value>       Custom host to set for Auth API
+  --cda=<value>            Custom host to set for content delivery API, if this flag is added then cma, ui-host and name
+                           flags are required
+  --cma=<value>            Custom host to set for content management API, , if this flag is added then cda, ui-host and
+                           name flags are required
+  --cs-assets=<value>      Custom host to set for Contentstack Assets API
+  --developer-hub=<value>  Custom host to set for Developer hub API
+  --launch=<value>         Custom host to set for Launch API
+  --name=<value>           Name for the region, if this flag is added then cda, cma and ui-host flags are required
+  --personalize=<value>    Custom host to set for Personalize API
+  --studio=<value>         Custom host to set for Studio API
+  --ui-host=<value>        Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
+                           required
 
 DESCRIPTION
   Set region for CLI
@@ -508,7 +509,7 @@ EXAMPLES
 
   $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --cs-assets <cs_assets_url>
 
-  $ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>
+  $ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url> --cs-assets <cs_assets_url>
 ```
 
 _See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_

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

@@ -17,6 +17,7 @@ class RegionGetCommand extends base_command_1.BaseCommand {
         cli_utilities_1.cliux.print(`Developer Hub URL: ${currentRegion.developerHubUrl}`);
         cli_utilities_1.cliux.print(`Launch URL: ${currentRegion.launchHubUrl}`);
         cli_utilities_1.cliux.print(`Personalize URL: ${currentRegion.personalizeUrl}`);
+        cli_utilities_1.cliux.print(`Contentstack Assets URL: ${currentRegion.csAssetsUrl}`);
         cli_utilities_1.log.info(`Currently using ${currentRegion.name} region`, this.contextDetails);
     }
 }

package/lib/commands/config/set/early-access-header.js

@@ -26,8 +26,8 @@ exports.default = SetEarlyAccessHeaderCommand;
 SetEarlyAccessHeaderCommand.description = 'Set Early Access header';
 SetEarlyAccessHeaderCommand.aliases = ['config:set:ea-header'];
 SetEarlyAccessHeaderCommand.flags = {
-    'header-alias': cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header value.' }),
-    header: cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header alias name.' }),
+    'header-alias': cli_utilities_1.flags.string({ description: '(optional) Provide a name (alias) for this Early Access header.' }),
+    header: cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header value.' }),
 };
 SetEarlyAccessHeaderCommand.examples = [
     '$ <%= config.bin %> <%= command.id %>',

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;
@@ -15,6 +16,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
         let launchHubUrl = regionSetFlags['launch'];
         let composableStudioUrl = regionSetFlags['studio'];
         let csAssetsUrl = regionSetFlags['cs-assets'];
+        let authUrl = regionSetFlags['auth-api'];
         let selectedRegion = args.region;
         if (!(cda && cma && uiHost && name) && !selectedRegion) {
             selectedRegion = await utils_1.interactive.askRegions();
@@ -47,6 +49,9 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                 if (!csAssetsUrl) {
                     csAssetsUrl = this.transformUrl(cma, 'am-api');
                 }
+                if (!authUrl) {
+                    authUrl = this.transformUrl(cma, 'auth-api');
+                }
                 let customRegion = {
                     cda,
                     cma,
@@ -57,6 +62,17 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                     launchHubUrl,
                     composableStudioUrl,
                     csAssetsUrl,
+                    endpoints: {
+                        contentManagement: cma,
+                        contentDelivery: cda,
+                        application: uiHost,
+                        developerHub: developerHubUrl,
+                        launch: launchHubUrl,
+                        personalizeManagement: personalizeUrl,
+                        composableStudio: composableStudioUrl,
+                        assetManagement: csAssetsUrl,
+                        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
@@ -69,6 +85,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
                 cli_utilities_1.cliux.success(`Launch URL: ${customRegion.launchHubUrl}`);
                 cli_utilities_1.cliux.success(`Studio URL: ${customRegion.composableStudioUrl}`);
                 cli_utilities_1.cliux.success(`Contentstack Assets URL: ${customRegion.csAssetsUrl}`);
+                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' }));
@@ -117,7 +134,6 @@ RegionSetCommand.flags = {
         dependsOn: ['cda', 'cma', 'name'],
     }),
     name: cli_utilities_1.flags.string({
-        char: 'n',
         description: 'Name for the region, if this flag is added then cda, cma and ui-host flags are required',
         dependsOn: ['cda', 'cma', 'ui-host'],
     }),
@@ -136,6 +152,9 @@ RegionSetCommand.flags = {
     'cs-assets': cli_utilities_1.flags.string({
         description: 'Custom host to set for Contentstack Assets API',
     }),
+    'auth-api': cli_utilities_1.flags.string({
+        description: 'Custom host to set for Auth API',
+    }),
 };
 RegionSetCommand.examples = [
     '$ csdx config:set:region',
@@ -152,7 +171,7 @@ RegionSetCommand.examples = [
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>',
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>',
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --cs-assets <cs_assets_url>',
-    '$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>',
+    '$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url> --cs-assets <cs_assets_url>',
 ];
 RegionSetCommand.args = {
     region: cli_utilities_1.args.string({ description: 'Name for the region' }),

package/lib/interfaces/index.d.ts

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

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

@@ -38,17 +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;
-        csAssetsUrl: 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,27 +19,11 @@ 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,
-            csAssetsUrl: endpoints.assetManagement,
-        };
-    }
-    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
@@ -132,18 +115,23 @@ 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'],
-            csAssetsUrl: regionObject['csAssetsUrl'],
+        var _a;
+        // endpoints is the single source of truth — every friendly field (cma, cda, ...,
+        // auth, csAssetsUrl) 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'],
+            assetManagement: regionObject['csAssetsUrl'],
+            auth: regionObject['authUrl'],
         };
-        return sanitizedRegion;
+        return (0, cli_utilities_1.buildRegionFromEndpoints)(regionObject.name, endpoints);
     }
 }
 exports.default = new UserConfig();

package/oclif.manifest.json

@@ -338,14 +338,14 @@
       ],
       "flags": {
         "header-alias": {
-          "description": "(optional) Provide the Early Access header value.",
+          "description": "(optional) Provide a name (alias) for this Early Access header.",
           "name": "header-alias",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "header": {
-          "description": "(optional) Provide the Early Access header alias name.",
+          "description": "(optional) Provide the Early Access header value.",
           "name": "header",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -568,7 +568,7 @@
         "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --launch <custom_launch_url>",
         "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --studio <custom_studio_url>",
         "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --cs-assets <cs_assets_url>",
-        "$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name \"India\" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>"
+        "$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name \"India\" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url> --cs-assets <cs_assets_url>"
       ],
       "flags": {
         "cda": {
@@ -608,7 +608,6 @@
           "type": "option"
         },
         "name": {
-          "char": "n",
           "dependsOn": [
             "cda",
             "cma",
@@ -654,6 +653,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,
@@ -673,5 +679,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.9"
+  "version": "2.0.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "2.0.0-beta.9",
+  "version": "2.0.0",
   "author": "Contentstack",
   "scripts": {
     "build": "pnpm compile && oclif manifest && oclif readme",
@@ -14,10 +14,10 @@
     "lint": "eslint src/**/*.ts"
   },
   "dependencies": {
-    "@contentstack/cli-command": "~2.0.0-beta.7",
-    "@contentstack/cli-utilities": "~2.0.0-beta.8",
+    "@contentstack/cli-command": "~2.0.0",
+    "@contentstack/cli-utilities": "~2.0.0",
     "@contentstack/utils": "~1.9.1",
-    "@oclif/core": "^4.8.3"
+    "@oclif/core": "^4.11.14"
   },
   "overrides": {
     "@oclif/core": {
@@ -25,24 +25,24 @@
     }
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.18",
+    "@oclif/test": "^4.1.20",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^8.2.3",
     "@types/node": "^14.18.63",
     "@types/sinon": "^21.0.1",
     "chai": "^4.5.0",
-    "eslint": "^9.26.0",
-    "eslint-config-oclif": "^6.0.62",
+    "eslint": "^10.6.0",
+    "eslint-config-oclif": "^6.0.175",
     "eslint-config-oclif-typescript": "^3.1.14",
     "mocha": "10.8.2",
     "nyc": "^15.1.0",
-    "oclif": "^4.23.0",
+    "oclif": "^4.23.27",
     "sinon": "^21.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=22.0.0"
   },
   "files": [
     "/lib",
@@ -90,5 +90,9 @@
       "config:remove:rate-limit": "RLRM"
     }
   },
-  "repository": "contentstack/cli"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contentstack/cli.git",
+    "directory": "packages/contentstack-config"
+  }
 }