@contentstack/cli-config 1.17.0 → 1.18.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.17.0 linux-x64 node-v22.21.1
+@contentstack/cli-config/1.18.0 linux-x64 node-v22.22.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -33,16 +33,19 @@ USAGE
 * [`csdx config:get:ea-header`](#csdx-configgetea-header)
 * [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
 * [`csdx config:get:log`](#csdx-configgetlog)
+* [`csdx config:get:proxy`](#csdx-configgetproxy)
 * [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
 * [`csdx config:get:region`](#csdx-configgetregion)
 * [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
 * [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
 * [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
+* [`csdx config:remove:proxy`](#csdx-configremoveproxy)
 * [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
 * [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
 * [`csdx config:set:ea-header`](#csdx-configsetea-header)
 * [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
 * [`csdx config:set:log`](#csdx-configsetlog)
+* [`csdx config:set:proxy`](#csdx-configsetproxy)
 * [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
 * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
 
@@ -118,6 +121,23 @@ EXAMPLES
 
 _See code: [src/commands/config/get/log.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/log.ts)_
 
+## `csdx config:get:proxy`
+
+Get proxy configuration for CLI
+
+```
+USAGE
+  $ csdx config:get:proxy
+
+DESCRIPTION
+  Get proxy configuration for CLI
+
+EXAMPLES
+  $ csdx config:get:proxy
+```
+
+_See code: [src/commands/config/get/proxy.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/proxy.ts)_
+
 ## `csdx config:get:rate-limit`
 
 Get rate-limit of organizations
@@ -227,6 +247,23 @@ EXAMPLES
 
 _See code: [src/commands/config/remove/early-access-header.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/early-access-header.ts)_
 
+## `csdx config:remove:proxy`
+
+Remove proxy configuration from global config
+
+```
+USAGE
+  $ csdx config:remove:proxy
+
+DESCRIPTION
+  Remove proxy configuration from global config
+
+EXAMPLES
+  $ csdx config:remove:proxy
+```
+
+_See code: [src/commands/config/remove/proxy.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/proxy.ts)_
+
 ## `csdx config:remove:rate-limit`
 
 Remove rate-limit of the organization
@@ -358,6 +395,34 @@ EXAMPLES
 
 _See code: [src/commands/config/set/log.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_
 
+## `csdx config:set:proxy`
+
+Set proxy configuration for CLI
+
+```
+USAGE
+  $ csdx config:set:proxy --host <value> --port <value> --protocol http|https [--username <value>]
+
+FLAGS
+  --host=<value>       (required) Proxy host address
+  --port=<value>       (required) Proxy port number
+  --protocol=<option>  (required) [default: http] Proxy protocol (http or https)
+                       <options: http|https>
+  --username=<value>   Proxy username (optional)
+
+DESCRIPTION
+  Set proxy configuration for CLI
+
+EXAMPLES
+  $ csdx config:set:proxy --host 127.0.0.1 --port 3128
+
+  $ csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https
+
+  $ csdx config:set:proxy --host proxy.example.com --port 8080 --username user
+```
+
+_See code: [src/commands/config/set/proxy.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/proxy.ts)_
+
 ## `csdx config:set:rate-limit`
 
 Set rate-limit for CLI

package/lib/commands/config/get/proxy.d.ts

@@ -0,0 +1,6 @@
+import { BaseCommand } from '../../../base-command';
+export default class ProxyGetCommand extends BaseCommand<typeof ProxyGetCommand> {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const base_command_1 = require("../../../base-command");
+class ProxyGetCommand extends base_command_1.BaseCommand {
+    async run() {
+        var _a, _b;
+        try {
+            cli_utilities_1.log.debug('Starting proxy configuration retrieval', this.contextDetails);
+            const globalProxyConfig = cli_utilities_1.configHandler.get('proxy');
+            if (globalProxyConfig) {
+                cli_utilities_1.log.debug('Proxy configuration found in global config', this.contextDetails);
+                let usernameValue = 'Not set';
+                if ((_a = globalProxyConfig.auth) === null || _a === void 0 ? void 0 : _a.username) {
+                    usernameValue = globalProxyConfig.auth.username;
+                }
+                const proxyConfigList = [
+                    {
+                        Setting: 'Host',
+                        Value: globalProxyConfig.host || 'Not set',
+                    },
+                    {
+                        Setting: 'Port',
+                        Value: globalProxyConfig.port ? String(globalProxyConfig.port) : 'Not set',
+                    },
+                    {
+                        Setting: 'Protocol',
+                        Value: globalProxyConfig.protocol || 'Not set',
+                    },
+                    {
+                        Setting: 'Username',
+                        Value: usernameValue,
+                    },
+                    {
+                        Setting: 'Password',
+                        Value: ((_b = globalProxyConfig.auth) === null || _b === void 0 ? void 0 : _b.password) ? '***' : 'Not set',
+                    },
+                ];
+                const headers = [{ value: 'Setting' }, { value: 'Value' }];
+                cli_utilities_1.cliux.table(headers, proxyConfigList);
+                cli_utilities_1.log.info('Proxy configuration displayed successfully', this.contextDetails);
+            }
+            else {
+                cli_utilities_1.log.debug('No proxy configuration found in global config', this.contextDetails);
+            }
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.contextDetails), { module: 'config-get-proxy' }));
+        }
+    }
+}
+exports.default = ProxyGetCommand;
+ProxyGetCommand.description = 'Get proxy configuration for CLI';
+ProxyGetCommand.examples = ['csdx config:get:proxy'];

package/lib/commands/config/remove/proxy.d.ts

@@ -0,0 +1,6 @@
+import { BaseCommand } from '../../../base-command';
+export default class ProxyRemoveCommand extends BaseCommand<typeof ProxyRemoveCommand> {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/lib/commands/config/remove/proxy.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const base_command_1 = require("../../../base-command");
+class ProxyRemoveCommand extends base_command_1.BaseCommand {
+    async run() {
+        try {
+            cli_utilities_1.log.debug('Starting proxy configuration removal', this.contextDetails);
+            const currentProxy = cli_utilities_1.configHandler.get('proxy');
+            if (!currentProxy) {
+                cli_utilities_1.log.debug('No proxy configuration found in global config', this.contextDetails);
+                return;
+            }
+            cli_utilities_1.log.debug('Removing proxy configuration from global config', this.contextDetails);
+            cli_utilities_1.configHandler.delete('proxy');
+            cli_utilities_1.log.success('Proxy configuration removed from global config successfully', this.contextDetails);
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.contextDetails), { module: 'config-remove-proxy' }));
+        }
+    }
+}
+exports.default = ProxyRemoveCommand;
+ProxyRemoveCommand.description = 'Remove proxy configuration from global config';
+ProxyRemoveCommand.examples = ['csdx config:remove:proxy'];

package/lib/commands/config/set/proxy.d.ts

@@ -0,0 +1,8 @@
+import { FlagInput } from '@contentstack/cli-utilities';
+import { BaseCommand } from '../../../base-command';
+export default class ProxySetCommand extends BaseCommand<typeof ProxySetCommand> {
+    static description: string;
+    static flags: FlagInput;
+    static examples: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const interactive_1 = require("../../../utils/interactive");
+const base_command_1 = require("../../../base-command");
+class ProxySetCommand extends base_command_1.BaseCommand {
+    async run() {
+        try {
+            cli_utilities_1.log.debug('Starting proxy configuration setup', this.contextDetails);
+            const { flags } = await this.parse(ProxySetCommand);
+            cli_utilities_1.log.debug('Parsed proxy configuration flags', this.contextDetails);
+            // Validate host - must not be empty or whitespace-only
+            if (!flags.host || flags.host.trim() === '') {
+                cli_utilities_1.log.error('Invalid host provided - host cannot be empty or whitespace-only', this.contextDetails);
+                cli_utilities_1.cliux.error('Invalid host address. Host cannot be empty or contain only whitespace.');
+                return;
+            }
+            const port = Number.parseInt(flags.port, 10);
+            if (Number.isNaN(port) || port < 1 || port > 65535) {
+                cli_utilities_1.log.error('Invalid port number provided', this.contextDetails);
+                cli_utilities_1.cliux.error('Invalid port number. Port must be between 1 and 65535.');
+                return;
+            }
+            const proxyConfig = {
+                protocol: flags.protocol || 'http',
+                host: flags.host.trim(),
+                port: port,
+            };
+            if (flags.username) {
+                cli_utilities_1.log.debug('Username provided, prompting for password', this.contextDetails);
+                // Prompt for password when username is provided
+                const password = await (0, interactive_1.askProxyPassword)();
+                proxyConfig.auth = {
+                    username: flags.username,
+                    password: password || '',
+                };
+                cli_utilities_1.log.debug('Proxy authentication configured', this.contextDetails);
+            }
+            cli_utilities_1.log.debug('Saving proxy configuration to global config', this.contextDetails);
+            cli_utilities_1.configHandler.set('proxy', proxyConfig);
+            cli_utilities_1.log.success('Proxy configuration set successfully', this.contextDetails);
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.contextDetails), { module: 'config-set-proxy' }));
+        }
+    }
+}
+exports.default = ProxySetCommand;
+ProxySetCommand.description = 'Set proxy configuration for CLI';
+ProxySetCommand.flags = {
+    host: cli_utilities_1.flags.string({
+        description: 'Proxy host address',
+        required: true,
+    }),
+    port: cli_utilities_1.flags.string({
+        description: 'Proxy port number',
+        required: true,
+    }),
+    protocol: cli_utilities_1.flags.string({
+        description: 'Proxy protocol (http or https)',
+        options: ['http', 'https'],
+        default: 'http',
+        required: true,
+    }),
+    username: cli_utilities_1.flags.string({
+        description: 'Proxy username (optional)',
+    }),
+};
+ProxySetCommand.examples = [
+    'csdx config:set:proxy --host 127.0.0.1 --port 3128',
+    'csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https',
+    'csdx config:set:proxy --host proxy.example.com --port 8080 --username user',
+];

package/lib/utils/interactive.d.ts

@@ -9,3 +9,4 @@ export declare function askEarlyAccessHeaderAlias(): Promise<string>;
 export declare const askOrgID: () => Promise<string>;
 export declare function askLogLevel(): Promise<string>;
 export declare function askLogPath(): Promise<string>;
+export declare function askProxyPassword(): Promise<string>;

package/lib/utils/interactive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askLogPath = exports.askLogLevel = exports.askOrgID = exports.askEarlyAccessHeaderAlias = exports.askEarlyAccessHeaderValue = exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
+exports.askProxyPassword = exports.askLogPath = exports.askLogLevel = exports.askOrgID = exports.askEarlyAccessHeaderAlias = exports.askEarlyAccessHeaderValue = exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const askRegions = async () => {
     return cli_utilities_1.cliux.inquire({
@@ -127,3 +127,14 @@ async function askLogPath() {
     return logPath;
 }
 exports.askLogPath = askLogPath;
+async function askProxyPassword() {
+    return cli_utilities_1.cliux.inquire({
+        type: 'input',
+        message: 'Enter proxy password:',
+        name: 'password',
+        transformer: (password) => {
+            return '*'.repeat(password.length);
+        },
+    });
+}
+exports.askProxyPassword = askProxyPassword;

package/oclif.manifest.json

@@ -74,6 +74,30 @@
         "log.js"
       ]
     },
+    "config:get:proxy": {
+      "aliases": [],
+      "args": {},
+      "description": "Get proxy configuration for CLI",
+      "examples": [
+        "csdx config:get:proxy"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:get:proxy",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginName": "@contentstack/cli-config",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "get",
+        "proxy.js"
+      ]
+    },
     "config:get:rate-limit": {
       "aliases": [],
       "args": {},
@@ -205,6 +229,30 @@
         "early-access-header.js"
       ]
     },
+    "config:remove:proxy": {
+      "aliases": [],
+      "args": {},
+      "description": "Remove proxy configuration from global config",
+      "examples": [
+        "csdx config:remove:proxy"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:remove:proxy",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginName": "@contentstack/cli-config",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "remove",
+        "proxy.js"
+      ]
+    },
     "config:remove:rate-limit": {
       "aliases": [],
       "args": {},
@@ -378,6 +426,69 @@
         "log.js"
       ]
     },
+    "config:set:proxy": {
+      "aliases": [],
+      "args": {},
+      "description": "Set proxy configuration for CLI",
+      "examples": [
+        "csdx config:set:proxy --host 127.0.0.1 --port 3128",
+        "csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https",
+        "csdx config:set:proxy --host proxy.example.com --port 8080 --username user"
+      ],
+      "flags": {
+        "host": {
+          "description": "Proxy host address",
+          "name": "host",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "description": "Proxy port number",
+          "name": "port",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "protocol": {
+          "description": "Proxy protocol (http or https)",
+          "name": "protocol",
+          "required": true,
+          "default": "http",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "http",
+            "https"
+          ],
+          "type": "option"
+        },
+        "username": {
+          "description": "Proxy username (optional)",
+          "name": "username",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:set:proxy",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginName": "@contentstack/cli-config",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "set",
+        "proxy.js"
+      ]
+    },
     "config:set:rate-limit": {
       "aliases": [],
       "args": {},
@@ -556,5 +667,5 @@
       ]
     }
   },
-  "version": "1.17.0"
+  "version": "1.18.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",
@@ -21,8 +21,8 @@
     "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
   },
   "dependencies": {
-    "@contentstack/cli-command": "~1.7.1",
-    "@contentstack/cli-utilities": "~1.16.0",
+    "@contentstack/cli-command": "~1.7.2",
+    "@contentstack/cli-utilities": "~1.17.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "lodash": "^4.17.21"
@@ -32,7 +32,7 @@
     "@types/chai": "^4.3.20",
     "@types/mocha": "^8.2.3",
     "@types/node": "^14.18.63",
-    "@types/sinon": "^10.0.20",
+    "@types/sinon": "^21.0.0",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^6.0.62",
@@ -40,7 +40,7 @@
     "mocha": "10.8.2",
     "nyc": "^15.1.0",
     "oclif": "^4.17.46",
-    "sinon": "^19.0.5",
+    "sinon": "^21.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   },