@contentstack/cli-utilities 1.5.8 → 1.5.10

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Contentstack
+Copyright (c) 2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/cli-ux.js

@@ -54,7 +54,9 @@ class CLIInterface {
         this.loading = !this.loading;
     }
     table(data, columns, options) {
+        core_1.ux.log('\n');
         core_1.ux.table(data, columns, options);
+        core_1.ux.log('\n');
     }
     async inquire(inquirePayload) {
         if (Array.isArray(inquirePayload)) {

package/lib/contentstack-management-sdk.js

@@ -32,7 +32,7 @@ class ManagementSDKInitiator {
             retryCondition: (error) => {
                 // LINK https://github.com/contentstack/contentstack-javascript/blob/72fee8ad75ba7d1d5bab8489ebbbbbbaefb1c880/src/core/stack.js#L49
                 if (error.response && error.response.status) {
-                    switch (error.status) {
+                    switch (error.response.status) {
                         case 401:
                         case 429:
                         case 408:
@@ -107,6 +107,10 @@ class ManagementSDKInitiator {
                 option.authorization = '';
             }
         }
+        const earlyAccessHeaders = config_handler_1.default.get(`earlyAccessHeaders`);
+        if (earlyAccessHeaders && Object.keys(earlyAccessHeaders).length > 0) {
+            option.early_access = Object.values(earlyAccessHeaders);
+        }
         return (0, management_1.client)(option);
     }
 }

package/lib/contentstack-marketplace-sdk.d.ts

@@ -0,0 +1,36 @@
+import { App, AppData } from '@contentstack/marketplace-sdk/types/marketplace/app';
+import { ContentstackConfig, ContentstackClient, ContentstackToken } from '@contentstack/marketplace-sdk';
+import { Installation } from '@contentstack/marketplace-sdk/types/marketplace/installation';
+type ConfigType = Pick<ContentstackConfig, 'host' | 'endpoint' | 'retryDelay' | 'retryLimit'> & {
+    skipTokenValidity?: string;
+};
+type ContentstackMarketplaceConfig = ContentstackConfig;
+type ContentstackMarketplaceClient = ContentstackClient;
+declare class MarketplaceSDKInitiator {
+    private analyticsInfo;
+    /**
+     * The function returns a default configuration object for Contentstack API requests in TypeScript.
+     * @returns a default configuration object of type `ContentstackConfig`.
+     */
+    get defaultOptions(): ContentstackConfig;
+    init(context: any): void;
+    /**
+     * The function `refreshTokenHandler` returns a promise that resolves with a `ContentstackToken`
+     * object based on the `authorizationType` parameter.
+     * @param {string} authorizationType - The `authorizationType` parameter is a string that specifies
+     * the type of authorization being used. It can have one of the following values:
+     * @returns The refreshTokenHandler function returns a function that returns a Promise of type
+     * ContentstackToken.
+     */
+    refreshTokenHandler(authorizationType: string): () => Promise<ContentstackToken>;
+    /**
+     * The function creates a Contentstack SDK client with the provided configuration.
+     * @param config - The `config` parameter is an object that contains the following properties:
+     * @returns a Promise that resolves to a ContentstackClient object.
+     */
+    createAppSDKClient(config?: ConfigType): Promise<ContentstackClient>;
+}
+export declare const marketplaceSDKInitiator: MarketplaceSDKInitiator;
+declare const marketplaceSDKClient: typeof marketplaceSDKInitiator.createAppSDKClient;
+export { App, AppData, Installation, MarketplaceSDKInitiator, ContentstackMarketplaceConfig, ContentstackMarketplaceClient, };
+export default marketplaceSDKClient;

package/lib/contentstack-marketplace-sdk.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketplaceSDKInitiator = exports.marketplaceSDKInitiator = void 0;
+const tslib_1 = require("tslib");
+const node_https_1 = require("node:https");
+const marketplace_sdk_1 = require("@contentstack/marketplace-sdk");
+const auth_handler_1 = tslib_1.__importDefault(require("./auth-handler"));
+const config_handler_1 = tslib_1.__importDefault(require("./config-handler"));
+class MarketplaceSDKInitiator {
+    /**
+     * The function returns a default configuration object for Contentstack API requests in TypeScript.
+     * @returns a default configuration object of type `ContentstackConfig`.
+     */
+    get defaultOptions() {
+        return {
+            headers: {},
+            retryLimit: 3,
+            timeout: 60000,
+            maxRequests: 10,
+            authtoken: '',
+            authorization: '',
+            // host: 'api.contentstack.io',
+            maxContentLength: 100000000,
+            maxBodyLength: 1000000000,
+            httpsAgent: new node_https_1.Agent({
+                timeout: 60000,
+                maxSockets: 100,
+                keepAlive: true,
+                maxFreeSockets: 10,
+            }),
+            retryDelay: Math.floor(Math.random() * (8000 - 3000 + 1) + 3000),
+            retryCondition: (error) => {
+                var _a;
+                if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.status) {
+                    if ([408].includes(error.response.status)) {
+                        return true;
+                    }
+                    else {
+                        return false;
+                    }
+                }
+            },
+            retryDelayOptions: {
+                base: 1000,
+                customBackoff: () => 1,
+            },
+        };
+    }
+    init(context) {
+        this.analyticsInfo = context === null || context === void 0 ? void 0 : context.analyticsInfo;
+    }
+    /**
+     * The function `refreshTokenHandler` returns a promise that resolves with a `ContentstackToken`
+     * object based on the `authorizationType` parameter.
+     * @param {string} authorizationType - The `authorizationType` parameter is a string that specifies
+     * the type of authorization being used. It can have one of the following values:
+     * @returns The refreshTokenHandler function returns a function that returns a Promise of type
+     * ContentstackToken.
+     */
+    refreshTokenHandler(authorizationType) {
+        return () => {
+            return new Promise((resolve, reject) => {
+                if (authorizationType === 'BASIC') {
+                    // NOTE Handle basic auth 401 here
+                    reject(new Error('Session timed out, please login to proceed'));
+                }
+                else if (authorizationType === 'OAUTH') {
+                    auth_handler_1.default
+                        .compareOAuthExpiry(true)
+                        .then(() => resolve({ authorization: `Bearer ${config_handler_1.default.get('oauthAccessToken')}` }))
+                        .catch(reject);
+                }
+                else {
+                    reject(new Error('You do not have permissions to perform this action, please login to proceed'));
+                }
+            });
+        };
+    }
+    /**
+     * The function creates a Contentstack SDK client with the provided configuration.
+     * @param config - The `config` parameter is an object that contains the following properties:
+     * @returns a Promise that resolves to a ContentstackClient object.
+     */
+    async createAppSDKClient(config) {
+        const authorizationType = config_handler_1.default.get('authorisationType');
+        const option = this.defaultOptions;
+        option.refreshToken = this.refreshTokenHandler(authorizationType);
+        if (config.host) {
+            option.host = config.host;
+        }
+        if (config.endpoint) {
+            option.endpoint = config.endpoint;
+        }
+        if (config.retryLimit) {
+            option.retryLimit = config.retryLimit;
+        }
+        if (config.retryDelay) {
+            option.retryDelay = config.retryDelay;
+        }
+        if (this.analyticsInfo) {
+            option.headers['X-CS-CLI'] = this.analyticsInfo;
+        }
+        if (authorizationType === 'BASIC') {
+            option.authtoken = config_handler_1.default.get('authtoken');
+        }
+        else if (authorizationType === 'OAUTH') {
+            if (!config.skipTokenValidity) {
+                await auth_handler_1.default.compareOAuthExpiry();
+                option.authorization = `Bearer ${config_handler_1.default.get('oauthAccessToken')}`;
+            }
+        }
+        return (0, marketplace_sdk_1.client)(option);
+    }
+}
+exports.MarketplaceSDKInitiator = MarketplaceSDKInitiator;
+exports.marketplaceSDKInitiator = new MarketplaceSDKInitiator();
+const marketplaceSDKClient = exports.marketplaceSDKInitiator.createAppSDKClient.bind(exports.marketplaceSDKInitiator);
+exports.default = marketplaceSDKClient;

package/lib/helpers.d.ts

@@ -1,9 +1,12 @@
 export declare const isAuthenticated: () => boolean;
 export declare const doesBranchExist: (stack: any, branchName: any) => Promise<any>;
 export declare const isManagementTokenValid: (stackAPIKey: any, managementToken: any) => Promise<{
+    valid: boolean;
+    message?: undefined;
+} | {
     valid: boolean;
     message: any;
 } | {
+    valid: string;
     message: string;
-    valid?: undefined;
 }>;

package/lib/helpers.js

@@ -21,7 +21,7 @@ const isManagementTokenValid = async (stackAPIKey, managementToken) => {
     try {
         const response = (_a = (await httpClient.get(`${_1.configHandler.get('region').cma}/v3/environments?limit=1`))) === null || _a === void 0 ? void 0 : _a.data;
         if (response === null || response === void 0 ? void 0 : response.environments) {
-            return { valid: true, message: `valid token and stack api key` };
+            return { valid: true };
         }
         else if (response === null || response === void 0 ? void 0 : response.error_code) {
             return { valid: false, message: response.error_message };
@@ -31,7 +31,7 @@ const isManagementTokenValid = async (stackAPIKey, managementToken) => {
         }
     }
     catch (error) {
-        return { message: `Failed to check the validity of the Management token. ${error}` };
+        return { valid: 'failedToCheck', message: `Failed to check the validity of the Management token. ${error}` };
     }
 };
 exports.isManagementTokenValid = isManagementTokenValid;

package/lib/http-client/client.d.ts

@@ -1,6 +1,9 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { IHttpClient } from './client-interface';
 import { HttpResponse } from './http-response';
+type HttpClientOptions = {
+    disableEarlyAccessHeaders?: boolean;
+};
 export declare class HttpClient implements IHttpClient {
     /**
      * The request configuration.
@@ -10,6 +13,7 @@ export declare class HttpClient implements IHttpClient {
      * The request configuration.
      */
     private readonly axiosInstance;
+    private disableEarlyAccessHeaders;
     /**
      * The payload format for a JSON or form-url-encoded request.
      */
@@ -17,7 +21,7 @@ export declare class HttpClient implements IHttpClient {
     /**
      * Createa new pending HTTP request instance.
      */
-    constructor(request?: AxiosRequestConfig);
+    constructor(request?: AxiosRequestConfig, options?: HttpClientOptions);
     /**
      * Create a reusable HttpClient instance.
      *

package/lib/http-client/client.js

@@ -10,13 +10,14 @@ class HttpClient {
     /**
      * Createa new pending HTTP request instance.
      */
-    constructor(request = {}) {
+    constructor(request = {}, options = {}) {
         /**
          * The payload format for a JSON or form-url-encoded request.
          */
         this.bodyFormat = 'json';
         this.request = request;
         this.axiosInstance = axios_1.default.create();
+        this.disableEarlyAccessHeaders = options.disableEarlyAccessHeaders || false;
         // Sets payload format as json by default
         this.asJson();
     }
@@ -309,7 +310,8 @@ class HttpClient {
             if ((_b = (_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.error_message) === null || _b === void 0 ? void 0 : _b.includes('access token is invalid or expired')) {
                 const token = await this.refreshToken();
                 this.headers(Object.assign(Object.assign({}, this.request.headers), { authorization: token.authorization }));
-                return await this.axiosInstance(Object.assign(Object.assign({ url, method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
+                return await this.axiosInstance(Object.assign(Object.assign({ url,
+                    method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
             }
             // Retry while Network timeout or Network Error
             if (!(message.includes('timeout') || message.includes('Network Error') || message.includes('getaddrinfo ENOTFOUND'))) {
@@ -317,11 +319,20 @@ class HttpClient {
             }
             if (counter < 1) {
                 counter++;
-                return await this.axiosInstance(Object.assign(Object.assign({ url, method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
+                return await this.axiosInstance(Object.assign(Object.assign({ url,
+                    method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
             }
             return Promise.reject(error);
         });
-        return await this.axiosInstance(Object.assign(Object.assign({ url, method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
+        if (!this.disableEarlyAccessHeaders) {
+            // Add early access header by default
+            const earlyAccessHeaders = config_handler_1.default.get(`earlyAccessHeaders`);
+            if (earlyAccessHeaders && Object.keys(earlyAccessHeaders).length > 0) {
+                this.headers({ 'x-header-ea': Object.values(earlyAccessHeaders).join(',') });
+            }
+        }
+        return await this.axiosInstance(Object.assign(Object.assign({ url,
+            method, withCredentials: true }, this.request), { data: this.prepareRequestPayload() }));
     }
     /**
      * Returns the request payload depending on the selected request payload format.
@@ -335,8 +346,9 @@ class HttpClient {
             return Promise.reject('Your session is timed out, please login to proceed');
         }
         else if (authorisationType === 'OAUTH') {
-            return auth_handler_1.default.compareOAuthExpiry(true)
-                .then(() => Promise.resolve({ authorization: `Bearer ${config_handler_1.default.get('oauthAccessToken')}`, }))
+            return auth_handler_1.default
+                .compareOAuthExpiry(true)
+                .then(() => Promise.resolve({ authorization: `Bearer ${config_handler_1.default.get('oauthAccessToken')}` }))
                 .catch((error) => Promise.reject(error));
         }
         else {

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 import Logger from './logger';
+import marketplaceSDKClient, { App, AppData, Installation, MarketplaceSDKInitiator, marketplaceSDKInitiator, ContentstackMarketplaceClient, ContentstackMarketplaceConfig } from './contentstack-marketplace-sdk';
 export { LoggerService } from './logger';
 export { default as cliux } from './cli-ux';
 export { default as CLIError } from './cli-error';
@@ -15,7 +16,8 @@ export * from './helpers';
 export * from './interfaces';
 export * from './date-time';
 export * from './add-locale';
+export { App, AppData, Installation, marketplaceSDKClient, MarketplaceSDKInitiator, marketplaceSDKInitiator, ContentstackMarketplaceClient, ContentstackMarketplaceConfig, };
 export { Args, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toCached, tsPath, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, stderr, stdout, } from '@oclif/core';
-export { FlagInput, ArgInput } from '@oclif/core/lib/interfaces/parser';
+export { FlagInput, ArgInput, FlagDefinition } from '@oclif/core/lib/interfaces/parser';
 export { default as TablePrompt } from './inquirer-table-prompt';
 export { Logger };

package/lib/index.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
+exports.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("./logger"));
 exports.Logger = logger_1.default;
+const contentstack_marketplace_sdk_1 = tslib_1.__importStar(require("./contentstack-marketplace-sdk"));
+exports.marketplaceSDKClient = contentstack_marketplace_sdk_1.default;
+Object.defineProperty(exports, "MarketplaceSDKInitiator", { enumerable: true, get: function () { return contentstack_marketplace_sdk_1.MarketplaceSDKInitiator; } });
+Object.defineProperty(exports, "marketplaceSDKInitiator", { enumerable: true, get: function () { return contentstack_marketplace_sdk_1.marketplaceSDKInitiator; } });
 var logger_2 = require("./logger");
 Object.defineProperty(exports, "LoggerService", { enumerable: true, get: function () { return logger_2.LoggerService; } });
 var cli_ux_1 = require("./cli-ux");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.5.8",
+  "version": "1.5.10",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -32,9 +32,10 @@
   "author": "contentstack",
   "license": "MIT",
   "dependencies": {
-    "@contentstack/management": "~1.12.0",
+    "@contentstack/management": "~1.13.0",
+    "@contentstack/marketplace-sdk": "^1.0.1",
     "@oclif/core": "^2.9.3",
-    "axios": "^1.6.0",
+    "axios": "^1.6.4",
     "chalk": "^4.0.0",
     "cli-cursor": "^3.1.0",
     "cli-table": "^0.3.11",
@@ -57,6 +58,7 @@
     "xdg-basedir": "^4.0.0"
   },
   "devDependencies": {
+    "@contentstack/cli-dev-dependencies": "^1.2.4",
     "@oclif/test": "^2.2.10",
     "@types/chai": "^4.2.18",
     "@types/inquirer": "^9.0.3",
@@ -68,7 +70,7 @@
     "chai": "^4.3.4",
     "eslint": "^8.18.0",
     "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^0.2.0",
+    "eslint-config-oclif-typescript": "^3.0.8",
     "fancy-test": "^2.0.0",
     "globby": "^10.0.2",
     "mocha": "10.1.0",