@contentstack/cli-config 1.7.2 → 1.8.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.7.2 linux-x64 node-v18.20.4
+@contentstack/cli-config/1.8.0 linux-x64 node-v18.20.4
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -32,13 +32,16 @@ USAGE
 * [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
 * [`csdx config:get:ea-header`](#csdx-configgetea-header)
 * [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
+* [`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: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:rate-limit`](#csdx-configsetrate-limit)
 * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
 
 ## `csdx config:get:base-branch`
@@ -96,6 +99,23 @@ EXAMPLES
 
 _See code: [src/commands/config/get/early-access-header.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/early-access-header.ts)_
 
+## `csdx config:get:rate-limit`
+
+Get rate-limit of organizations
+
+```
+USAGE
+  $ csdx config:get:rate-limit
+
+DESCRIPTION
+  Get rate-limit of organizations
+
+EXAMPLES
+  $ csdx config:get:rate-limit
+```
+
+_See code: [src/commands/config/get/rate-limit.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/rate-limit.ts)_
+
 ## `csdx config:get:region`
 
 Get current region set for CLI
@@ -186,6 +206,26 @@ 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:rate-limit`
+
+Remove rate-limit of the organization
+
+```
+USAGE
+  $ csdx config:remove:rate-limit [--org <value>]
+
+FLAGS
+  --org=<value>  Provide the organization UID
+
+DESCRIPTION
+  Remove rate-limit of the organization
+
+EXAMPLES
+  $ csdx config:remove:rate-limit --org <<org_uid>>
+```
+
+_See code: [src/commands/config/remove/rate-limit.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/rate-limit.ts)_
+
 ## `csdx config:set:base-branch`
 
 Set branch for CLI
@@ -259,6 +299,33 @@ EXAMPLES
 
 _See code: [src/commands/config/set/early-access-header.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/early-access-header.ts)_
 
+## `csdx config:set:rate-limit`
+
+Set rate-limit for CLI
+
+```
+USAGE
+  $ csdx config:set:rate-limit [--org <value>] [--utilize <value>] [--limit-name <value>] [--default]
+
+FLAGS
+  --default                Reset to default rate limit
+  --limit-name=<value>...  [Optional] Provide the limit names separated by commas ['limit', 'getLimit', 'bulkLimit']
+  --org=<value>            Provide the organization UID
+  --utilize=<value>        [default: 50] Provide the utilization percentages for rate limit, separated by commas
+
+DESCRIPTION
+  Set rate-limit for CLI
+
+EXAMPLES
+  $ csdx config:set:rate-limit --org <<org_uid>>
+
+  $ csdx config:set:rate-limit --org <<org_uid>> --utilize 70,80 --limit-name getLimit,limit
+
+  $ csdx config:set:rate-limit --org <<org_uid>> --default
+```
+
+_See code: [src/commands/config/set/rate-limit.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/rate-limit.ts)_
+
 ## `csdx config:set:region [REGION]`
 
 Set region for CLI

package/lib/commands/config/get/rate-limit.d.ts

@@ -0,0 +1,6 @@
+import { Command } from '@contentstack/cli-command';
+export default class RateLimitGetCommand extends Command {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/lib/commands/config/get/rate-limit.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const cli_command_1 = require("@contentstack/cli-command");
+class RateLimitGetCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            const rateLimit = cli_utilities_1.configHandler.get('rateLimit') || {};
+            const formatLimit = (limit) => (limit ? `${limit.value}(${limit.utilize}%)` : '0');
+            const tableData = Object.entries(rateLimit).map(([org, limits]) => ({
+                Org: org === 'default' ? 'default' : org,
+                'Get Limit': formatLimit(limits.getLimit),
+                Limit: formatLimit(limits.limit),
+                'Bulk Limit': formatLimit(limits.bulkLimit),
+            }));
+            const columns = {
+                Org: {
+                    minWidth: 10,
+                },
+                'Get Limit': {
+                    minWidth: 20,
+                },
+                Limit: {
+                    minWidth: 20,
+                },
+                'Bulk Limit': {
+                    minWidth: 20,
+                },
+            };
+            cli_utilities_1.cliux.table(tableData, columns, { printLine: cli_utilities_1.cliux.print });
+        }
+        catch (error) {
+            this.log('Unable to retrieve the rate limits configuration', error instanceof Error ? error.message : error);
+        }
+    }
+}
+exports.default = RateLimitGetCommand;
+RateLimitGetCommand.description = 'Get rate-limit of organizations';
+RateLimitGetCommand.examples = ['$ csdx config:get:rate-limit'];

package/lib/commands/config/remove/rate-limit.d.ts

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

package/lib/commands/config/remove/rate-limit.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const cli_command_1 = require("@contentstack/cli-command");
+const interactive_1 = require("../../../utils/interactive");
+class RateLimitRemoveCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            const { flags } = await this.parse(RateLimitRemoveCommand);
+            let { org } = flags;
+            if (!org) {
+                org = await (0, interactive_1.askOrgID)();
+            }
+            const rateLimit = cli_utilities_1.configHandler.get('rateLimit') || {};
+            if (!rateLimit[org]) {
+                cli_utilities_1.cliux.print(`No rate limit found for the organization UID: ${org}`, { color: 'red' });
+                return;
+            }
+            cli_utilities_1.configHandler.delete(`rateLimit.${org}`);
+            cli_utilities_1.cliux.print(`Rate limit entry for organization UID ${org} has been removed.`, { color: 'green' });
+        }
+        catch (error) {
+            this.log('Unable to remove the rate limit entry', error instanceof Error ? error.message : error);
+        }
+    }
+}
+exports.default = RateLimitRemoveCommand;
+RateLimitRemoveCommand.description = 'Remove rate-limit of the organization';
+RateLimitRemoveCommand.flags = {
+    org: cli_utilities_1.flags.string({
+        description: 'Provide the organization UID',
+    }),
+};
+RateLimitRemoveCommand.examples = ['$ csdx config:remove:rate-limit --org <<org_uid>>'];

package/lib/commands/config/set/rate-limit.d.ts

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

package/lib/commands/config/set/rate-limit.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const rate_limit_handler_1 = require("../../../utils/rate-limit-handler");
+const base_command_1 = require("../../../base-command");
+const interactive_1 = require("../../../utils/interactive");
+const common_utilities_1 = require("../../../utils/common-utilities");
+class SetRateLimitCommand extends base_command_1.BaseCommand {
+    async run() {
+        var _a, _b, _c;
+        if (!(0, cli_utilities_1.isAuthenticated)()) {
+            const err = { errorMessage: 'You are not logged in. Please login with command $ csdx auth:login' };
+            cli_utilities_1.cliux.print(err.errorMessage, { color: 'red' });
+            this.exit(1);
+        }
+        const { flags } = await this.parse(SetRateLimitCommand);
+        let { org, utilize, 'limit-name': limitName } = flags;
+        const config = { org: '', limitName: common_utilities_1.limitNamesConfig, host: this.cmaHost };
+        if (!org) {
+            org = await (0, interactive_1.askOrgID)();
+        }
+        config.org = org;
+        config.default = flags.default;
+        if (utilize) {
+            const utilizeValues = (_a = utilize === null || utilize === void 0 ? void 0 : utilize.split(',')) === null || _a === void 0 ? void 0 : _a.map((u) => Number(u.trim()));
+            if (utilizeValues.some((u) => isNaN(u) || u < 0 || u > 100)) {
+                cli_utilities_1.cliux.error('Utilize percentages must be numbers between 0 and 100.');
+                return;
+            }
+            if ((limitName === null || limitName === void 0 ? void 0 : limitName.length) > 0 && ((_c = (_b = limitName[0]) === null || _b === void 0 ? void 0 : _b.split(',')) === null || _c === void 0 ? void 0 : _c.length) !== utilizeValues.length) {
+                cli_utilities_1.cliux.error('The number of utilization percentages must match the number of limit names provided.');
+                return;
+            }
+            else {
+                config.utilize = utilize.split(',').map((v) => v.trim());
+            }
+        }
+        if (limitName) {
+            const invalidLimitNames = limitName[0].split(',').map((name) => name.trim());
+            if (invalidLimitNames.some((name) => !common_utilities_1.limitNamesConfig.includes(name))) {
+                cli_utilities_1.cliux.error(`Invalid limit names provided: ${invalidLimitNames.join(', ')}`);
+                return;
+            }
+            else {
+                config['limit-name'] = limitName[0].split(',').map((n) => n.trim());
+            }
+        }
+        const limitHandler = new rate_limit_handler_1.RateLimitHandler();
+        const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(config);
+        limitHandler.setClient(managementAPIClient);
+        try {
+            await limitHandler.setRateLimit(config);
+        }
+        catch (error) {
+            cli_utilities_1.cliux.error(`Error: Something went wrong while setting rate limit for org: ${org}`);
+            cli_utilities_1.cliux.error(error);
+        }
+    }
+}
+exports.default = SetRateLimitCommand;
+SetRateLimitCommand.description = 'Set rate-limit for CLI';
+SetRateLimitCommand.flags = {
+    org: cli_utilities_1.flags.string({
+        description: 'Provide the organization UID',
+    }),
+    utilize: cli_utilities_1.flags.string({
+        description: 'Provide the utilization percentages for rate limit, separated by commas',
+        default: '50',
+    }),
+    'limit-name': cli_utilities_1.flags.string({
+        description: "[Optional] Provide the limit names separated by commas ['limit', 'getLimit', 'bulkLimit']",
+        multiple: true,
+    }),
+    default: cli_utilities_1.flags.boolean({
+        default: false,
+        description: 'Reset to default rate limit',
+    }),
+};
+SetRateLimitCommand.examples = [
+    '$ csdx config:set:rate-limit --org <<org_uid>>',
+    '$ csdx config:set:rate-limit --org <<org_uid>> --utilize 70,80 --limit-name getLimit,limit',
+    '$ csdx config:set:rate-limit --org <<org_uid>> --default',
+];

package/lib/interfaces/index.d.ts

@@ -17,3 +17,19 @@ export interface Region {
     personalizeUrl: string;
     launchHubUrl: string;
 }
+export interface Limit {
+    value: number;
+    utilize: number;
+}
+export interface RateLimitConfig {
+    getLimit?: Limit;
+    limit?: Limit;
+    bulkLimit?: Limit;
+}
+export interface SetRateLimitConfig {
+    org: string;
+    utilize?: number;
+    limitName?: string[];
+    default?: boolean;
+    host?: string;
+}

package/lib/utils/common-utilities.d.ts

@@ -0,0 +1,15 @@
+export declare const limitNamesConfig: string[];
+export declare const defaultRalteLimitConfig: {
+    getLimit: {
+        value: number;
+        utilize: number;
+    };
+    limit: {
+        value: number;
+        utilize: number;
+    };
+    bulkLimit: {
+        value: number;
+        utilize: number;
+    };
+};

package/lib/utils/common-utilities.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRalteLimitConfig = exports.limitNamesConfig = void 0;
+exports.limitNamesConfig = ['getLimit', 'limit', 'bulkLimit'];
+exports.defaultRalteLimitConfig = {
+    getLimit: { value: 10, utilize: 50 },
+    limit: { value: 10, utilize: 50 },
+    bulkLimit: { value: 1, utilize: 50 },
+};

package/lib/utils/interactive.d.ts

@@ -6,3 +6,4 @@ export declare function askConfirmation(): Promise<boolean>;
 export declare function inquireRequireFieldValidation(input: string): string | boolean;
 export declare function askEarlyAccessHeaderValue(): Promise<string>;
 export declare function askEarlyAccessHeaderAlias(): Promise<string>;
+export declare const askOrgID: () => Promise<string>;

package/lib/utils/interactive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askEarlyAccessHeaderAlias = exports.askEarlyAccessHeaderValue = exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
+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({
@@ -94,3 +94,11 @@ async function askEarlyAccessHeaderAlias() {
     });
 }
 exports.askEarlyAccessHeaderAlias = askEarlyAccessHeaderAlias;
+const askOrgID = async () => {
+    return cli_utilities_1.cliux.inquire({
+        type: 'input',
+        message: 'Provide the organization UID',
+        name: 'org',
+    });
+};
+exports.askOrgID = askOrgID;

package/lib/utils/rate-limit-handler.d.ts

@@ -0,0 +1,4 @@
+export declare class RateLimitHandler {
+    setClient(managementSDKClient: any): void;
+    setRateLimit(config: any): Promise<void>;
+}

package/lib/utils/rate-limit-handler.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitHandler = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const common_utilities_1 = require("../utils/common-utilities");
+let client;
+class RateLimitHandler {
+    setClient(managementSDKClient) {
+        client = managementSDKClient;
+    }
+    async setRateLimit(config) {
+        var _a;
+        const rateLimit = cli_utilities_1.configHandler.get('rateLimit');
+        rateLimit.default = Object.assign({}, common_utilities_1.defaultRalteLimitConfig);
+        if (config.default) {
+            rateLimit[config.org] = Object.assign({}, rateLimit.default);
+            cli_utilities_1.configHandler.set('rateLimit', rateLimit);
+            cli_utilities_1.cliux.success(`Rate limit reset to default for org: ${config.org}`);
+            return;
+        }
+        if (!rateLimit[config.org]) {
+            rateLimit[config.org] = Object.assign({}, rateLimit.default);
+        }
+        const limitNames = Array.isArray(config['limit-name']) ? config['limit-name'] : [];
+        const utilizeValues = Array.isArray(config.utilize) ? config.utilize.map((v) => Number(v)) : [];
+        const unavailableLimits = [];
+        try {
+            const organizations = await client.organization(config.org).fetch({ include_plan: true });
+            const features = ((_a = organizations.plan) === null || _a === void 0 ? void 0 : _a.features) || [];
+            const limitsToUpdate = Object.assign({}, rateLimit[config.org]);
+            let utilizationMap = {};
+            limitNames.forEach((name, index) => {
+                if (utilizeValues[index] !== undefined) {
+                    utilizationMap[name] = utilizeValues[index];
+                }
+            });
+            common_utilities_1.limitNamesConfig.forEach((limitName) => {
+                var _a, _b, _c;
+                const feature = features.find((f) => f.uid === limitName);
+                if (feature) {
+                    limitsToUpdate[limitName] = {
+                        value: feature.limit || ((_a = rateLimit[config.org][limitName]) === null || _a === void 0 ? void 0 : _a.value) || ((_b = rateLimit.default[limitName]) === null || _b === void 0 ? void 0 : _b.value),
+                        utilize: utilizationMap[limitName] || ((_c = common_utilities_1.defaultRalteLimitConfig[limitName]) === null || _c === void 0 ? void 0 : _c.utilize),
+                    };
+                }
+                else {
+                    unavailableLimits.push(limitName);
+                }
+            });
+            if (unavailableLimits.length > 0) {
+                cli_utilities_1.cliux.print(`You have not subscribed to these limits: ${unavailableLimits.join(', ')}`, {
+                    color: 'yellow',
+                });
+            }
+            rateLimit[config.org] = limitsToUpdate;
+            cli_utilities_1.configHandler.set('rateLimit', rateLimit);
+            cli_utilities_1.cliux.success(`Rate limit has been set successfully for org: ${config.org}`);
+            Object.entries(limitsToUpdate).forEach(([limit, { value, utilize }]) => {
+                if (!unavailableLimits.includes(limit)) {
+                    cli_utilities_1.cliux.success(`${limit}: ${value}(${utilize}%)`);
+                }
+            });
+        }
+        catch (error) {
+            throw new Error(error);
+        }
+    }
+}
+exports.RateLimitHandler = RateLimitHandler;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.7.2",
+  "version": "1.8.0",
   "commands": {
     "config:get:base-branch": {
       "id": "config:get:base-branch",
@@ -33,6 +33,21 @@
       "flags": {},
       "args": {}
     },
+    "config:get:rate-limit": {
+      "id": "config:get:rate-limit",
+      "description": "Get rate-limit of organizations",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        "$ csdx config:get:rate-limit"
+      ],
+      "flags": {},
+      "args": {}
+    },
     "config:get:region": {
       "id": "config:get:region",
       "description": "Get current region set for CLI",
@@ -111,6 +126,28 @@
       },
       "args": {}
     },
+    "config:remove:rate-limit": {
+      "id": "config:remove:rate-limit",
+      "description": "Remove rate-limit of the organization",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        "$ csdx config:remove:rate-limit --org <<org_uid>>"
+      ],
+      "flags": {
+        "org": {
+          "name": "org",
+          "type": "option",
+          "description": "Provide the organization UID",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
     "config:set:base-branch": {
       "id": "config:set:base-branch",
       "description": "Set branch for CLI",
@@ -172,6 +209,49 @@
       },
       "args": {}
     },
+    "config:set:rate-limit": {
+      "id": "config:set:rate-limit",
+      "description": "Set rate-limit for CLI",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        "$ csdx config:set:rate-limit --org <<org_uid>>",
+        "$ csdx config:set:rate-limit --org <<org_uid>> --utilize 70,80 --limit-name getLimit,limit",
+        "$ csdx config:set:rate-limit --org <<org_uid>> --default"
+      ],
+      "flags": {
+        "org": {
+          "name": "org",
+          "type": "option",
+          "description": "Provide the organization UID",
+          "multiple": false
+        },
+        "utilize": {
+          "name": "utilize",
+          "type": "option",
+          "description": "Provide the utilization percentages for rate limit, separated by commas",
+          "multiple": false,
+          "default": "50"
+        },
+        "limit-name": {
+          "name": "limit-name",
+          "type": "option",
+          "description": "[Optional] Provide the limit names separated by commas ['limit', 'getLimit', 'bulkLimit']",
+          "multiple": true
+        },
+        "default": {
+          "name": "default",
+          "type": "boolean",
+          "description": "Reset to default rate limit",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "config:set:region": {
       "id": "config:set:region",
       "description": "Set region for CLI",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.7.2",
+  "version": "1.8.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.3.0",
-    "@contentstack/cli-utilities": "~1.7.2",
+    "@contentstack/cli-command": "~1.3.2",
+    "@contentstack/cli-utilities": "~1.8.0",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "inquirer": "8.2.4",
@@ -81,7 +81,10 @@
       "config:get:region": "RGT",
       "config:set:region": "RST",
       "config:get:base-branch": "BRGT",
-      "config:set:base-branch": "BRST"
+      "config:set:base-branch": "BRST",
+      "config:set:rate-limit": "RLST",
+      "config:get:rate-limit": "RLGT",
+      "config:remove:rate-limit": "RLRM"
     }
   },
   "repository": "contentstack/cli"