@contentstack/cli 1.60.0-beta.3 → 1.60.0-beta.6

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli/1.60.0-beta.0 darwin-arm64 node-v22.13.1
+@contentstack/cli/1.60.0-beta.6 linux-x64 node-v22.22.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    logger: {
+        level: string;
+        silent: boolean;
+    };
+    commandRegexPattern: RegExp;
+};
+export default _default;

package/lib/config/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    logger: {
+        level: 'error',
+        silent: false,
+    },
+    commandRegexPattern: /^(config|auth)+:/,
+};

package/lib/help.d.ts

@@ -0,0 +1,7 @@
+import { Help } from '@contentstack/cli-utilities';
+export default class MyHelpClass extends Help {
+    constructor(config: any, opts: any);
+    showRootHelp(): any;
+    showCommandHelp(command: any): any;
+    formatCommands(commands: any): string;
+}

package/lib/help.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const figlet = tslib_1.__importStar(require("figlet"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class MyHelpClass extends cli_utilities_1.Help {
+    constructor(config, opts) {
+        super(config, opts);
+    }
+    showRootHelp() {
+        // Shows Contentstack graphics
+        cli_utilities_1.cliux.print(figlet.textSync('Contentstack', {
+            horizontalLayout: 'default',
+            verticalLayout: 'default',
+        }));
+        super.showRootHelp();
+    }
+    showCommandHelp(command) {
+        if (command.id === 'cm:bulk-publish') {
+            let { context: { plugin: { commands = [] } = {} } = {} } = this.config;
+            commands = commands.map((c) => {
+                return Object.assign(Object.assign({}, c), { name: c.id });
+            });
+            const title = command.description && this.render(command.description).split('\n')[0];
+            if (title)
+                console.log(title + '\n');
+            console.log(this.formatCommand(command));
+            console.log('');
+            if (commands.length > 0) {
+                console.log(this.formatCommands(commands));
+                console.log('');
+            }
+            return;
+        }
+        super.showCommandHelp(command);
+    }
+    formatCommands(commands) {
+        if (commands.length === 0)
+            return '';
+        const body = this.renderList(commands
+            // if aliases do not contain the current command's id it is the main command
+            .filter(c => !c.aliases.some(a => a === c.id))
+            .map(c => {
+            if (this.config.topicSeparator !== ':')
+                c.id = c.id.replace(/:/g, this.config.topicSeparator);
+            // Add aliases at the end of summary
+            const summary = c.aliases.length > 0 ? `${this.summary(c)} (ALIASES: ${c.aliases.join(', ')})` : this.summary(c);
+            return [c.id, summary];
+        }), {
+            spacer: '\n',
+            stripAnsi: this.opts.stripAnsi,
+            indentation: 2
+        });
+        return this.section('COMMANDS', body);
+    }
+}
+exports.default = MyHelpClass;

package/lib/hooks/init/context-init.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Set the cli context
+ */
+export default function (opts: any): void;

package/lib/hooks/init/context-init.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../utils");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+/**
+ * Set the cli context
+ */
+function default_1(opts) {
+    // Store command ID for session-based log organization
+    if (opts.id) {
+        cli_utilities_1.configHandler.set('currentCommandId', opts.id);
+    }
+    this.config.context = new utils_1.CsdxContext(opts, this.config);
+}
+exports.default = default_1;

package/lib/hooks/init/utils-init.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Initialize the utilities
+ */
+export default function (_opts: any): void;

package/lib/hooks/init/utils-init.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+/**
+ * Initialize the utilities
+ */
+function default_1(_opts) {
+    const { context } = this.config;
+    cli_utilities_1.messageHandler.init(context);
+    cli_utilities_1.cliux.init(context);
+    cli_utilities_1.managementSDKInitiator.init(context);
+    cli_utilities_1.marketplaceSDKInitiator.init(context);
+}
+exports.default = default_1;

package/lib/hooks/prerun/auth-guard.d.ts

@@ -0,0 +1 @@
+export default function (opts: any): Promise<void>;

package/lib/hooks/prerun/auth-guard.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+// TBD: run region command if region is not there
+async function default_1(opts) {
+    const { context: { plugin: { config: { protectedCommands = {} } = {} } = {}, region = null } = {} } = this.config;
+    if (opts.Command.id !== 'config:set:region') {
+        if (!region) {
+            cli_utilities_1.cliux.error('No region found, please set a region $config:set:region');
+            this.exit();
+            return;
+        }
+        cli_utilities_1.cliux.print(`Currently using region: ${region.name}`, { color: 'grey' });
+    }
+    // Auth guard
+    if (protectedCommands[opts.Command.id]) {
+        if (!(0, cli_utilities_1.isAuthenticated)()) {
+            (0, cli_utilities_1.handleAndLogError)(new Error('Authentication required for this command'), { module: 'auth-guard', commandId: opts.Command.id });
+            cli_utilities_1.cliux.error('Please log in to execute the command');
+            this.exit();
+        }
+        const client = await (0, cli_utilities_1.managementSDKClient)({ host: region.cma });
+        try {
+            const result = await client.getUser();
+            if (!result) {
+                (0, cli_utilities_1.handleAndLogError)(new Error('Error in auth validation'), { module: 'auth-guard' });
+                cli_utilities_1.cliux.error('Please log in to execute the command');
+                this.exit();
+            }
+            cli_utilities_1.log.debug('Logged-in user', { module: 'auth-guard', userData: result.data });
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, { module: 'auth-guard' }, 'Error in auth validation');
+            cli_utilities_1.cliux.error('Please log in to execute the command');
+            process.exit();
+        }
+    }
+}
+exports.default = default_1;

package/lib/hooks/prerun/command-deprecation-check.d.ts

@@ -0,0 +1 @@
+export default function (_opts: any): Promise<void>;

package/lib/hooks/prerun/command-deprecation-check.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+async function default_1(_opts) {
+    const { context: { plugin: { config: { expiredCommands = {} } = {} } = {}, info: { command = null } = {} } = {} } = this.config;
+    if (expiredCommands.hasOwnProperty(command)) {
+        cli_utilities_1.cliux.print(`WARNING!!! You're using the old (soon to be deprecated) Contentstack CLI command. We recommend you to use the latest ${expiredCommands[command]} command.`, { color: 'yellow' });
+    }
+}
+exports.default = default_1;

package/lib/hooks/prerun/default-rate-limit-check.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/lib/hooks/prerun/default-rate-limit-check.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+function default_1() {
+    const rateLimit = cli_utilities_1.configHandler.get('rateLimit');
+    if (!(rateLimit === null || rateLimit === void 0 ? void 0 : rateLimit.default)) {
+        const defaultPlan = {
+            getLimit: { value: 10, utilize: 50 },
+            limit: { value: 10, utilize: 50 },
+            bulkLimit: { value: 1, utilize: 50 },
+        };
+        cli_utilities_1.configHandler.set('rateLimit', { default: defaultPlan });
+        cli_utilities_1.cliux.print(`Default rate limit configuration is set to ${JSON.stringify(defaultPlan)}. Please use this command csdx config:set:rate-limit to set the custom rate limit config.`, { color: 'blue' });
+    }
+}
+exports.default = default_1;

package/lib/hooks/prerun/latest-version-warning.d.ts

@@ -0,0 +1 @@
+export default function (_opts: any): Promise<void>;

package/lib/hooks/prerun/latest-version-warning.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const semver = tslib_1.__importStar(require("semver"));
+const versionUpgradeWarningFrequency = {
+    versionSyncDuration: 3 * 24 * 60 * 60 * 1000, // 3 days
+};
+async function default_1(_opts) {
+    var _a, _b;
+    const now = Date.now();
+    const today = new Date().toISOString().split('T')[0];
+    let cache = { lastChecked: 0, lastWarnedDate: '', latestVersion: '' };
+    // if CLI_VERSION is not set or is not the same as the current version, set it
+    if (!cli_utilities_1.configHandler.get('CLI_VERSION') || cli_utilities_1.configHandler.get('CLI_VERSION') !== this.config.version) {
+        cli_utilities_1.configHandler.set('CLI_VERSION', this.config.version); // set current version in configHandler
+    }
+    if (!cli_utilities_1.configHandler.get('versionUpgradeWarningFrequency')) {
+        cli_utilities_1.configHandler.set('versionUpgradeWarningFrequency', versionUpgradeWarningFrequency);
+    }
+    const versionUpgradeWarningFrequencyConfig = cli_utilities_1.configHandler.get('versionUpgradeWarningFrequency');
+    // Load cache if it exists
+    if (cli_utilities_1.configHandler.get('versionUpgradeWarningCache')) {
+        cache = cli_utilities_1.configHandler.get('versionUpgradeWarningCache');
+    }
+    // Perform update check if needed
+    const httpClient = new cli_utilities_1.HttpClient();
+    if (now - cache.lastChecked > versionUpgradeWarningFrequencyConfig.versionSyncDuration) {
+        try {
+            const latestVersion = (_b = (_a = (await httpClient.get(`https://registry.npmjs.org/@contentstack/cli/latest`))) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.version;
+            if (!latestVersion) {
+                (0, cli_utilities_1.handleAndLogError)(new Error('Failed to retrieve the latest version from the registry.'), { module: 'latest-version-warning' });
+                return;
+            }
+            cache.latestVersion = latestVersion;
+            cache.lastChecked = now;
+            // Save updated cache
+            cli_utilities_1.configHandler.set('versionUpgradeWarningCache', cache);
+        }
+        catch (error) {
+            (0, cli_utilities_1.handleAndLogError)(error, { module: 'latest-version-warning' }, 'Failed to check the latest version');
+            return;
+        }
+    }
+    // Show warning if an update is available and last warning was yesterday
+    if (semver.gt(cache.latestVersion, this.config.version) && cache.lastWarnedDate !== today) {
+        cli_utilities_1.cliux.print(`You are not using the most recent CLI release. Please update to the latest version for an improved experience.`, { color: 'yellow' });
+        // Update the last warned timestamp
+        cache.lastWarnedDate = today;
+        cli_utilities_1.configHandler.set('versionUpgradeWarningCache', cache);
+    }
+}
+exports.default = default_1;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "@oclif/core";
+export default _default;

package/lib/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = '@oclif/core';

package/lib/interfaces/index.d.ts

@@ -0,0 +1,39 @@
+import { Config, Plugin } from '@contentstack/cli-utilities';
+export interface PrintOptions {
+    color?: string;
+}
+export interface InquirePayload {
+    type: string;
+    name: string;
+    message: string;
+    choices?: Array<any>;
+    transformer?: Function;
+}
+export interface Region {
+    name: string;
+    cma: string;
+    cda: string;
+}
+export interface Context {
+    id: string;
+    user: {
+        authtoken: string;
+        email: string;
+    };
+    region: any;
+    plugin: Plugin;
+    config: any;
+    info: any;
+    messageFilePath: any;
+}
+export interface CLIConfig extends Config {
+    context: Context;
+}
+export interface IVersionUpgradeCache {
+    lastChecked: number;
+    lastWarnedDate: string;
+    latestVersion: string;
+}
+export interface IVersionUpgradeWarningFrequency {
+    versionSyncDuration: number;
+}

package/lib/interfaces/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,17 @@
+export default class CsdxContext {
+    readonly sessionId: string;
+    readonly clientId: string;
+    readonly user?: object;
+    readonly region?: object;
+    readonly config: object;
+    readonly info: any;
+    readonly plugin: any;
+    readonly pluginConfig: any;
+    readonly messageFilePath: string;
+    readonly analyticsInfo: string;
+    flagWarningPrintState: any;
+    flags: any;
+    cliVersion: string;
+    constructor(cliOpts: any, cliConfig: any);
+    getToken(alias: string): any;
+}

package/lib/utils/context-handler.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const shortUUID = tslib_1.__importStar(require("short-uuid"));
+const path = tslib_1.__importStar(require("path"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const node_machine_id_1 = require("node-machine-id");
+class CsdxContext {
+    constructor(cliOpts, cliConfig) {
+        var _a, _b, _c;
+        const analyticsInfo = [];
+        const command = cliConfig.findCommand(cliOpts.id) || {};
+        const config = cli_utilities_1.configHandler;
+        const platform = cliConfig.platform && cliConfig.arch ? `${cliConfig.platform}-${cliConfig.arch}` : 'none';
+        analyticsInfo.push(platform);
+        const nodeVersion = process.versions.node ? `v${process.versions.node}` : process.version;
+        analyticsInfo.push(nodeVersion || 'none');
+        analyticsInfo.push(cliConfig.version || 'none');
+        this.clientId = cli_utilities_1.configHandler.get('clientId');
+        if (!this.clientId) {
+            this.clientId = (0, node_machine_id_1.machineIdSync)(true);
+            cli_utilities_1.configHandler.set('clientId', this.clientId);
+        }
+        analyticsInfo.push(this.clientId);
+        const sessionId = shortUUID.generate();
+        cli_utilities_1.configHandler.set('sessionId', sessionId);
+        this.sessionId = sessionId;
+        analyticsInfo.push(this.sessionId);
+        this.user = {
+            authtoken: cli_utilities_1.configHandler.get('authtoken'),
+            email: cli_utilities_1.configHandler.get('email'),
+        };
+        this.config = Object.assign({}, config);
+        this.cliVersion = cliConfig.version;
+        this.region = cli_utilities_1.configHandler.get('region');
+        this.info = { command: cliOpts.id };
+        if (command.pluginName) {
+            this.plugin = (cliConfig.plugins || new Map()).get(command.pluginName) || {};
+            this.plugin.name = command.pluginName;
+            this.plugin.config = Object.assign({}, ((this.plugin.pjson && this.plugin.pjson.csdxConfig) || {}));
+            this.messageFilePath = (0, cli_utilities_1.pathValidator)(path.resolve((0, cli_utilities_1.sanitizePath)(this.plugin.root), (0, cli_utilities_1.sanitizePath)(this.plugin.config.messageFilePath) || './messages/index.json'));
+            this.info.shortCommandName = (_c = (_b = (_a = this.plugin) === null || _a === void 0 ? void 0 : _a.config) === null || _b === void 0 ? void 0 : _b.shortCommandName) === null || _c === void 0 ? void 0 : _c[cliOpts.id];
+            analyticsInfo.push(this.info.shortCommandName || cliOpts.id);
+        }
+        this.flagWarningPrintState = {};
+        this.analyticsInfo = analyticsInfo.join(';');
+    }
+    getToken(alias) {
+        if (alias) {
+            const token = cli_utilities_1.configHandler.get(`tokens.${alias}`);
+            if (token)
+                return token;
+        }
+    }
+}
+exports.default = CsdxContext;

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export { default as CsdxContext } from './context-handler';

package/lib/utils/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CsdxContext = void 0;
+var context_handler_1 = require("./context-handler");
+Object.defineProperty(exports, "CsdxContext", { enumerable: true, get: function () { return __importDefault(context_handler_1).default; } });

package/oclif.manifest.json

@@ -0,0 +1,4 @@
+{
+  "commands": {},
+  "version": "1.60.0-beta.6"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli",
   "description": "Command-line tool (CLI) to interact with Contentstack v1-beta",
-  "version": "1.60.0-beta.3",
+  "version": "1.60.0-beta.6",
   "author": "Contentstack",
   "bin": {
     "csdx": "./bin/run.js"