@contentstack/cli-config 1.4.15 → 1.5.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.4.15 linux-x64 node-v18.18.2
+@contentstack/cli-config/1.5.0 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -30,9 +30,15 @@ USAGE
 
 <!-- commands -->
 * [`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: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: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:region [REGION]`](#csdx-configsetregion-region)
 
 ## `csdx config:get:base-branch`
@@ -52,6 +58,44 @@ EXAMPLES
 
 _See code: [src/commands/config/get/base-branch.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/base-branch.ts)_
 
+## `csdx config:get:ea-header`
+
+Display Early Access Program headers
+
+```
+USAGE
+  $ csdx config:get:ea-header
+
+DESCRIPTION
+  Display Early Access Program headers
+
+ALIASES
+  $ csdx config:get:ea-header
+
+EXAMPLES
+  $ csdx config:get:ea-header
+```
+
+## `csdx config:get:early-access-header`
+
+Display Early Access Program headers
+
+```
+USAGE
+  $ csdx config:get:early-access-header
+
+DESCRIPTION
+  Display Early Access Program headers
+
+ALIASES
+  $ csdx config:get:ea-header
+
+EXAMPLES
+  $ csdx config:get:early-access-header
+```
+
+_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:region`
 
 Get current region set for CLI
@@ -92,6 +136,56 @@ EXAMPLES
 
 _See code: [src/commands/config/remove/base-branch.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/base-branch.ts)_
 
+## `csdx config:remove:ea-header`
+
+Remove Early Access Program header
+
+```
+USAGE
+  $ csdx config:remove:ea-header [--header-alias <value>] [-y]
+
+FLAGS
+  -y, --yes               Force Remove
+  --header-alias=<value>  Early access header alias
+
+DESCRIPTION
+  Remove Early Access Program header
+
+ALIASES
+  $ csdx config:remove:ea-header
+
+EXAMPLES
+  $ csdx config:remove:ea-header
+
+  $ csdx config:remove:ea-header --header-alias <value>
+```
+
+## `csdx config:remove:early-access-header`
+
+Remove Early Access Program header
+
+```
+USAGE
+  $ csdx config:remove:early-access-header [--header-alias <value>] [-y]
+
+FLAGS
+  -y, --yes               Force Remove
+  --header-alias=<value>  Early access header alias
+
+DESCRIPTION
+  Remove Early Access Program header
+
+ALIASES
+  $ csdx config:remove:ea-header
+
+EXAMPLES
+  $ csdx config:remove:early-access-header
+
+  $ csdx config:remove:early-access-header --header-alias <value>
+```
+
+_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:set:base-branch`
 
 Set branch for CLI
@@ -115,6 +209,56 @@ EXAMPLES
 
 _See code: [src/commands/config/set/base-branch.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/base-branch.ts)_
 
+## `csdx config:set:ea-header`
+
+Set Early Access Program header
+
+```
+USAGE
+  $ csdx config:set:ea-header [--header-alias <value>] [--header <value>]
+
+FLAGS
+  --header=<value>        Early access header value
+  --header-alias=<value>  Early access header alias
+
+DESCRIPTION
+  Set Early Access Program header
+
+ALIASES
+  $ csdx config:set:ea-header
+
+EXAMPLES
+  $ csdx config:set:ea-header
+
+  $ csdx config:set:ea-header --header <value> --header-alias <value>
+```
+
+## `csdx config:set:early-access-header`
+
+Set Early Access Program header
+
+```
+USAGE
+  $ csdx config:set:early-access-header [--header-alias <value>] [--header <value>]
+
+FLAGS
+  --header=<value>        Early access header value
+  --header-alias=<value>  Early access header alias
+
+DESCRIPTION
+  Set Early Access Program header
+
+ALIASES
+  $ csdx config:set:ea-header
+
+EXAMPLES
+  $ csdx config:set:early-access-header
+
+  $ csdx config:set:early-access-header --header <value> --header-alias <value>
+```
+
+_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:region [REGION]`
 
 Set region for CLI

package/lib/commands/config/get/early-access-header.d.ts

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

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

@@ -0,0 +1,37 @@
+"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 GetEarlyAccessHeaderCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            let config = cli_utilities_1.configHandler.get(`earlyAccessHeaders`);
+            if (config && Object.keys(config).length > 0) {
+                let tableHeaders = Object.keys(config).map((key) => ({
+                    ['Alias']: key,
+                    ['Early access header']: config[key],
+                }));
+                cli_utilities_1.cliux.table(tableHeaders, {
+                    Alias: {
+                        minWidth: 8,
+                    },
+                    'Early access header': {
+                        minWidth: 8,
+                    },
+                }, {
+                    printLine: cli_utilities_1.cliux.print,
+                });
+            }
+            else {
+                cli_utilities_1.cliux.print(`No Early Access Program header found!`, { color: 'red' });
+            }
+        }
+        catch (error) {
+            this.log('Unable to retrieve the Early Access Program header config', error instanceof Error ? error.message : error);
+        }
+    }
+}
+exports.default = GetEarlyAccessHeaderCommand;
+GetEarlyAccessHeaderCommand.description = 'Display Early Access Program headers';
+GetEarlyAccessHeaderCommand.aliases = ['config:get:ea-header'];
+GetEarlyAccessHeaderCommand.examples = ['$ <%= config.bin %> <%= command.id %>'];

package/lib/commands/config/remove/early-access-header.d.ts

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

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_1 = require("../../../utils");
+const cli_command_1 = require("@contentstack/cli-command");
+class RemoveEarlyAccessHeader extends cli_command_1.Command {
+    async run() {
+        try {
+            let { flags: { 'header-alias': earlyAccessHeaderAlias, yes: skipConfirmation }, } = await this.parse(RemoveEarlyAccessHeader);
+            if (!earlyAccessHeaderAlias) {
+                earlyAccessHeaderAlias = await utils_1.interactive.askEarlyAccessHeaderAlias();
+            }
+            if (cli_utilities_1.configHandler.get(`earlyAccessHeaders.${earlyAccessHeaderAlias}`) === undefined) {
+                cli_utilities_1.cliux.error(`Early Access Program header not configured for alias: ${earlyAccessHeaderAlias}`);
+                return;
+            }
+            if (!skipConfirmation) {
+                const confirmation = await utils_1.interactive.askConfirmation();
+                if (!confirmation) {
+                    return;
+                }
+            }
+            cli_utilities_1.configHandler.delete(`earlyAccessHeaders.${earlyAccessHeaderAlias}`);
+            cli_utilities_1.cliux.success(`Early Access Program header '${earlyAccessHeaderAlias}' has been successfully removed`);
+        }
+        catch (error) {
+            this.log('Unable to remove the Early Access Program header config', error instanceof Error ? error.message : error);
+        }
+    }
+}
+exports.default = RemoveEarlyAccessHeader;
+RemoveEarlyAccessHeader.description = 'Remove Early Access Program header';
+RemoveEarlyAccessHeader.aliases = ['config:remove:ea-header'];
+RemoveEarlyAccessHeader.flags = {
+    'header-alias': cli_utilities_1.flags.string({ description: 'Early access header alias' }),
+    yes: cli_utilities_1.flags.boolean({ char: 'y', description: 'Force Remove' }),
+};
+RemoveEarlyAccessHeader.examples = [
+    '$ <%= config.bin %> <%= command.id %>',
+    '$ <%= config.bin %> <%= command.id %> --header-alias <value>',
+];

package/lib/commands/config/set/early-access-header.d.ts

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

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_1 = require("../../../utils");
+const cli_command_1 = require("@contentstack/cli-command");
+class SetEarlyAccessHeaderCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            let { flags: { header: earlyAccessHeader, 'header-alias': earlyAccessHeaderAlias }, } = await this.parse(SetEarlyAccessHeaderCommand);
+            if (!earlyAccessHeaderAlias) {
+                earlyAccessHeaderAlias = await utils_1.interactive.askEarlyAccessHeaderAlias();
+            }
+            if (!earlyAccessHeader) {
+                earlyAccessHeader = await utils_1.interactive.askEarlyAccessHeaderValue();
+            }
+            cli_utilities_1.configHandler.set(`earlyAccessHeaders.${earlyAccessHeaderAlias}`, earlyAccessHeader);
+            cli_utilities_1.cliux.success(`Early access header '${earlyAccessHeader}' with alias '${earlyAccessHeaderAlias}' has been successfully set `);
+        }
+        catch (error) {
+            this.log('Unable to set the Early Access Program header config', error instanceof Error ? error.message : error);
+        }
+    }
+}
+exports.default = SetEarlyAccessHeaderCommand;
+SetEarlyAccessHeaderCommand.description = 'Set Early Access Program header';
+SetEarlyAccessHeaderCommand.aliases = ['config:set:ea-header'];
+SetEarlyAccessHeaderCommand.flags = {
+    'header-alias': cli_utilities_1.flags.string({ description: 'Early access header alias' }),
+    header: cli_utilities_1.flags.string({ description: 'Early access header value' }),
+};
+SetEarlyAccessHeaderCommand.examples = [
+    '$ <%= config.bin %> <%= command.id %>',
+    '$ <%= config.bin %> <%= command.id %> --header <value> --header-alias <value>',
+];

package/lib/utils/interactive.d.ts

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

package/lib/utils/interactive.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
-const lodash_1 = require("lodash");
+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({
@@ -70,9 +69,27 @@ async function askConfirmation() {
 }
 exports.askConfirmation = askConfirmation;
 function inquireRequireFieldValidation(input) {
-    if ((0, lodash_1.isEmpty)(input)) {
+    if (!input || input.trim() === '') {
         return cli_utilities_1.messageHandler.parse('CLI_BRANCH_REQUIRED_FIELD');
     }
     return true;
 }
 exports.inquireRequireFieldValidation = inquireRequireFieldValidation;
+async function askEarlyAccessHeaderValue() {
+    return await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        message: 'CLI_CONFIG_INQUIRE_EARLY_ACCESS_HEADER_VALUE',
+        name: 'header-value',
+        validate: inquireRequireFieldValidation,
+    });
+}
+exports.askEarlyAccessHeaderValue = askEarlyAccessHeaderValue;
+async function askEarlyAccessHeaderAlias() {
+    return await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        message: 'CLI_CONFIG_INQUIRE_EARLY_ACCESS_HEADER_ALIAS',
+        name: 'header-alias',
+        validate: inquireRequireFieldValidation,
+    });
+}
+exports.askEarlyAccessHeaderAlias = askEarlyAccessHeaderAlias;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.15",
+  "version": "1.5.0",
   "commands": {
     "config:get:base-branch": {
       "id": "config:get:base-branch",
@@ -15,6 +15,22 @@
       "flags": {},
       "args": {}
     },
+    "config:get:early-access-header": {
+      "id": "config:get:early-access-header",
+      "description": "Display Early Access Program headers",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:get:ea-header"
+      ],
+      "examples": [
+        "$ <%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {},
+      "args": {}
+    },
     "config:get:region": {
       "id": "config:get:region",
       "description": "Get current region set for CLI",
@@ -59,6 +75,37 @@
       },
       "args": {}
     },
+    "config:remove:early-access-header": {
+      "id": "config:remove:early-access-header",
+      "description": "Remove Early Access Program header",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:remove:ea-header"
+      ],
+      "examples": [
+        "$ <%= config.bin %> <%= command.id %>",
+        "$ <%= config.bin %> <%= command.id %> --header-alias <value>"
+      ],
+      "flags": {
+        "header-alias": {
+          "name": "header-alias",
+          "type": "option",
+          "description": "Early access header alias",
+          "multiple": false
+        },
+        "yes": {
+          "name": "yes",
+          "type": "boolean",
+          "char": "y",
+          "description": "Force Remove",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "config:set:base-branch": {
       "id": "config:set:base-branch",
       "description": "Set branch for CLI",
@@ -88,6 +135,36 @@
       },
       "args": {}
     },
+    "config:set:early-access-header": {
+      "id": "config:set:early-access-header",
+      "description": "Set Early Access Program header",
+      "strict": true,
+      "pluginName": "@contentstack/cli-config",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginType": "core",
+      "aliases": [
+        "config:set:ea-header"
+      ],
+      "examples": [
+        "$ <%= config.bin %> <%= command.id %>",
+        "$ <%= config.bin %> <%= command.id %> --header <value> --header-alias <value>"
+      ],
+      "flags": {
+        "header-alias": {
+          "name": "header-alias",
+          "type": "option",
+          "description": "Early access header alias",
+          "multiple": false
+        },
+        "header": {
+          "name": "header",
+          "type": "option",
+          "description": "Early access header value",
+          "multiple": 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.4.15",
+  "version": "1.5.0",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.7",
+    "@contentstack/cli-utilities": "~1.5.9",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "inquirer": "8.2.4",
@@ -41,7 +41,7 @@
     "chai": "^4.3.4",
     "eslint": "^8.18.0",
     "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^0.1.0",
+    "eslint-config-oclif-typescript": "^3.0.8",
     "globby": "^10.0.2",
     "mocha": "10.1.0",
     "nyc": "^15.1.0",
@@ -84,4 +84,4 @@
     }
   },
   "repository": "contentstack/cli"
-}
+}