@contentstack/cli-utilities 1.2.0 → 1.3.0

package/lib/cli-ux.js

@@ -20,9 +20,18 @@ class CLIInterface {
         return core_1.ux.table;
     }
     init(context) { }
+    registerSearchPlugin() {
+        inquirer_1.default.registerPrompt('search-list', require('inquirer-search-list'));
+        inquirer_1.default.registerPrompt('search-checkbox', require('inquirer-search-checkbox'));
+    }
     print(message, opts) {
-        if (opts && opts.color) {
-            core_1.ux.log(chalk_1.default[opts.color](message_handler_1.default.parse(message)));
+        if (opts) {
+            let chalkFn = chalk_1.default;
+            if (opts.color)
+                chalkFn = chalkFn[opts.color];
+            if (opts.bold)
+                chalkFn = chalkFn.bold;
+            core_1.ux.log(chalkFn(message_handler_1.default.parse(message)));
             return;
         }
         core_1.ux.log(message_handler_1.default.parse(message));
@@ -46,9 +55,14 @@ class CLIInterface {
         core_1.ux.table(data, columns, options);
     }
     async inquire(inquirePayload) {
-        inquirePayload.message = message_handler_1.default.parse(inquirePayload.message);
-        const result = await inquirer_1.default.prompt(inquirePayload);
-        return result[inquirePayload.name];
+        if (Array.isArray(inquirePayload)) {
+            return inquirer_1.default.prompt(inquirePayload);
+        }
+        else {
+            inquirePayload.message = message_handler_1.default.parse(inquirePayload.message);
+            const result = await inquirer_1.default.prompt(inquirePayload);
+            return result[inquirePayload.name];
+        }
     }
     prompt(name, options) {
         return core_1.ux.prompt(name, options);

package/lib/contentstack-management-sdk.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.managementSDKInitiator = void 0;
 const tslib_1 = require("tslib");
-const https_1 = require("https");
 const management_1 = require("@contentstack/management");
+const node_https_1 = require("node:https");
 const config_handler_1 = tslib_1.__importDefault(require("./config-handler"));
-exports.default = async (config) => {
-    try {
+class ManagementSDKInitiator {
+    constructor() { }
+    init(context) {
+        this.analyticsInfo = context === null || context === void 0 ? void 0 : context.analyticsInfo;
+    }
+    async createAPIClient(config) {
         const option = {
             host: config.host,
             maxContentLength: 100000000,
@@ -13,7 +18,7 @@ exports.default = async (config) => {
             maxRequests: 10,
             retryLimit: 3,
             timeout: 60000,
-            httpsAgent: new https_1.Agent({
+            httpsAgent: new node_https_1.Agent({
                 maxSockets: 100,
                 maxFreeSockets: 10,
                 keepAlive: true,
@@ -47,12 +52,19 @@ exports.default = async (config) => {
             },
         };
         if (typeof config.branchName === 'string') {
-            option.headers = { branch: config.branchName };
+            if (!option.headers)
+                option.headers = {};
+            option.headers.branch = config.branchName;
+        }
+        if (this.analyticsInfo) {
+            if (!option.headers)
+                option.headers = {};
+            option.headers['X-CS-CLI'] = this.analyticsInfo;
         }
         if (!config.management_token) {
             const authtoken = config_handler_1.default.get('authtoken');
             if (authtoken) {
-                option.authtoken = config_handler_1.default.get('authtoken');
+                option.authtoken = authtoken;
                 option.authorization = '';
             }
             else {
@@ -62,8 +74,6 @@ exports.default = async (config) => {
         }
         return (0, management_1.client)(option);
     }
-    catch (error) {
-        console.error(error);
-        throw new Error(error);
-    }
-};
+}
+exports.managementSDKInitiator = new ManagementSDKInitiator();
+exports.default = exports.managementSDKInitiator.createAPIClient.bind(exports.managementSDKInitiator);

package/lib/helpers.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAuthenticated = void 0;
+const tslib_1 = require("tslib");
+const config_handler_1 = tslib_1.__importDefault(require("./config-handler"));
+function isAuthenticated() {
+    const authtoken = config_handler_1.default.get('authtoken');
+    if (authtoken) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+exports.isAuthenticated = isAuthenticated;

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKClient = exports.configHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.logger = void 0;
+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.messageHandler = exports.CLIError = exports.cliux = exports.logger = void 0;
 const tslib_1 = require("tslib");
 var logger_1 = require("./logger");
 Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return tslib_1.__importDefault(logger_1).default; } });
@@ -14,6 +14,7 @@ var config_handler_1 = require("./config-handler");
 Object.defineProperty(exports, "configHandler", { enumerable: true, get: function () { return tslib_1.__importDefault(config_handler_1).default; } });
 var contentstack_management_sdk_1 = require("./contentstack-management-sdk");
 Object.defineProperty(exports, "managementSDKClient", { enumerable: true, get: function () { return tslib_1.__importDefault(contentstack_management_sdk_1).default; } });
+Object.defineProperty(exports, "managementSDKInitiator", { enumerable: true, get: function () { return contentstack_management_sdk_1.managementSDKInitiator; } });
 var flag_deprecation_check_1 = require("./flag-deprecation-check");
 Object.defineProperty(exports, "printFlagDeprecation", { enumerable: true, get: function () { return tslib_1.__importDefault(flag_deprecation_check_1).default; } });
 tslib_1.__exportStar(require("./http-client"), exports);
@@ -23,3 +24,28 @@ var cli_ux_2 = require("./cli-ux");
 Object.defineProperty(exports, "args", { enumerable: true, get: function () { return cli_ux_2.Args; } });
 Object.defineProperty(exports, "flags", { enumerable: true, get: function () { return cli_ux_2.Flags; } });
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return cli_ux_2.Command; } });
+tslib_1.__exportStar(require("./helpers"), exports);
+// NOTE Exporting all @oclif/core modules: So that all the module can be acessed through cli-utility
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "Args", { enumerable: true, get: function () { return core_1.Args; } });
+Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return core_1.CommandHelp; } });
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return core_1.Config; } });
+Object.defineProperty(exports, "Errors", { enumerable: true, get: function () { return core_1.Errors; } });
+Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return core_1.Flags; } });
+Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return core_1.loadHelpClass; } });
+Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return core_1.Help; } });
+Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return core_1.HelpBase; } });
+Object.defineProperty(exports, "Interfaces", { enumerable: true, get: function () { return core_1.Interfaces; } });
+Object.defineProperty(exports, "Parser", { enumerable: true, get: function () { return core_1.Parser; } });
+Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return core_1.Plugin; } });
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
+Object.defineProperty(exports, "toCached", { enumerable: true, get: function () { return core_1.toCached; } });
+Object.defineProperty(exports, "tsPath", { enumerable: true, get: function () { return core_1.tsPath; } });
+Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return core_1.toStandardizedId; } });
+Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return core_1.toConfiguredId; } });
+Object.defineProperty(exports, "settings", { enumerable: true, get: function () { return core_1.settings; } });
+Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return core_1.flush; } });
+Object.defineProperty(exports, "ux", { enumerable: true, get: function () { return core_1.ux; } });
+Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return core_1.execute; } });
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return core_1.stderr; } });
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return core_1.stdout; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "./types/index.d.ts",
@@ -71,4 +71,4 @@
     "typescript": "^4.9.3",
     "tslib": "^1.13.0"
   }
-}
+}

package/types/cli-ux.d.ts

@@ -9,12 +9,13 @@ declare class CLIInterface {
     constructor();
     get uxTable(): typeof Table.table;
     init(context: any): void;
+    registerSearchPlugin(): void;
     print(message: string, opts?: PrintOptions): void;
     success(message: string): void;
     error(message: string, ...params: any): void;
     loader(message?: string): void;
     table(data: Record<string, unknown>[], columns: Table.table.Columns<Record<string, unknown>>, options?: Table.table.Options): void;
-    inquire<T>(inquirePayload: InquirePayload): Promise<T>;
+    inquire<T>(inquirePayload: InquirePayload | Array<InquirePayload>): Promise<T>;
     prompt(name: string, options?: CliUXPromptOptions): Promise<any>;
     confirm(message?: string): Promise<boolean>;
     progress(options?: any): any;

package/types/contentstack-management-sdk.d.ts

@@ -1,3 +1,11 @@
-import { ContentstackClient } from '@contentstack/management';
-declare const _default: (config: any) => Promise<ContentstackClient>;
+import { ContentstackClient, ContentstackConfig } from '@contentstack/management';
+declare class ManagementSDKInitiator {
+    private analyticsInfo;
+    constructor();
+    init(context: any): void;
+    createAPIClient(config: any): Promise<ContentstackClient>;
+}
+export declare const managementSDKInitiator: ManagementSDKInitiator;
+declare const _default: any;
 export default _default;
+export { ContentstackConfig, ContentstackClient };

package/types/encrypter.d.ts

@@ -1,4 +1,4 @@
-declare type CryptoConfig = {
+type CryptoConfig = {
     algorithm?: string;
     encryptionKey?: string;
     typeIdentifier?: string;

package/types/helpers.d.ts

@@ -0,0 +1 @@
+export declare function isAuthenticated(): boolean;

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

@@ -225,6 +225,8 @@ export declare class HttpClient {
      */
     prepareRequestPayload(): any;
 }
+export interface HttpRequestConfig extends AxiosRequestConfig {
+}
 type BodyFormat = 'json' | 'formParams';
 type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS';
 export {};

package/types/index.d.ts

@@ -3,8 +3,11 @@ export { default as cliux } from './cli-ux';
 export { default as CLIError } from './cli-error';
 export { default as messageHandler } from './message-handler';
 export { default as configHandler } from './config-handler';
-export { default as managementSDKClient } from './contentstack-management-sdk';
+export { default as managementSDKClient, managementSDKInitiator, ContentstackClient, ContentstackConfig, } from './contentstack-management-sdk';
 export { default as printFlagDeprecation } from './flag-deprecation-check';
 export * from './http-client';
 export { default as NodeCrypto } from './encrypter';
 export { Args as args, Flags as flags, Command } from './cli-ux';
+export * from './helpers';
+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 } from '@oclif/core/lib/interfaces/parser';

package/types/interfaces/index.d.ts

@@ -1,13 +1,16 @@
 import { IPromptOptions } from "@oclif/core/lib/cli-ux";
 export interface PrintOptions {
+    bold?: boolean;
     color?: string;
 }
 export interface InquirePayload {
     type: string;
     name: string;
+    default?: any;
     message: string;
     choices?: Array<any>;
     transformer?: Function;
+    validate?(input: any, answers?: any): boolean | string | Promise<boolean | string>;
 }
 export interface Region {
     name: string;

package/types/http-client.d.ts

@@ -1,54 +0,0 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { HttpResponse } from '../src/http-client';
-
-type BodyFormat = 'json' | 'formParams';
-
-type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS';
-
-/**
- * CLI HttpClient
- */
-export declare class HttpClient {
-  private request: AxiosRequestConfig;
-  private readonly axiosInstance: AxiosInstance;
-  constructor();
-  static create(): HttpClient;
-  requestConfig(): AxiosRequestConfig;
-  resetConfig(): HttpClient;
-  baseUrl(baseUrl: string): HttpClient;
-  headers(headers: any): HttpClient;
-  queryParams(queryParams: object): HttpClient;
-  basicAuth(username: string, password: string): HttpClient;
-  token(token: string, type: string): HttpClient;
-  options(options: AxiosRequestConfig): HttpClient;
-  payload(data: any): HttpClient;
-  timeout(timeout: number): this;
-  asJson(): HttpClient;
-  asFormParams(): HttpClient;
-  payloadFormat(format: BodyFormat): HttpClient;
-  accept(accept: string): HttpClient;
-  acceptJson(): HttpClient;
-  contentType(contentType: string): HttpClient;
-  get<R>(url: string, queryParams?: object): Promise<HttpResponse<R>>;
-  post<R>(url: string, payload?: any): Promise<HttpResponse<R>>;
-  put<R>(url: string, payload?: any): Promise<HttpResponse<R>>;
-  patch<R>(url: string, payload?: any): Promise<HttpResponse<R>>;
-  delete<R>(url: string, queryParams?: object): Promise<HttpResponse<R>>;
-  send<R>(method: HttpMethod, url: string): Promise<HttpResponse<R>>;
-  createAndSendRequest(method: HttpMethod, url: string): Promise<AxiosResponse>;
-  prepareRequestPayload(): any;
-}
-
-/**
- * CLI HttpClient
- */
-export declare class HttpResponse {
-  private readonly response: AxiosResponse;
-  constructor();
-  get status(): number;
-  get data();
-  get payload();
-  get headers();
-}
-
-export interface HttpRequestConfig extends AxiosRequestConfig {}

package/types/selectors/index.d.ts

@@ -1,12 +0,0 @@
-import { Token, selectedOrganization, Stack, ContentType, Environment, Entry, Locale } from './interfaces';
-export declare function chooseOrganization(client: any, displayMessage?: string, region?: string, orgUid?: string): Promise<selectedOrganization>;
-export declare function chooseStack(client: any, organizationId: string, displayMessage?: string, region?: string): Promise<Stack>;
-export declare function chooseContentType(stackApiKey: string, displayMessage?: string, region?: string): Promise<ContentType>;
-export declare function chooseEntry(contentTypeUid: string, stackApiKey: string, displayMessage?: string, region?: string): Promise<Entry>;
-export declare function chooseContentTypes(stack: any, displayMessage?: string): Promise<ContentType[]>;
-export declare function chooseEnvironments(stack: any, displayMessage?: string): Promise<Environment[]>;
-export declare function chooseEnvironment(stack: any, displayMessage?: string): Promise<Environment>;
-export declare function chooseLocales(stack: any, displayMessage?: string): Promise<Locale[]>;
-export declare function chooseLocale(stack: any, displayMessage?: string, defaultLocale?: Locale): Promise<Locale>;
-export declare function chooseTokenAlias(): Promise<Token>;
-export declare function chooseDeliveryTokenAlias(): Promise<Token>;

package/types/selectors/interfaces.d.ts

@@ -1,32 +0,0 @@
-export interface Token {
-    token: string;
-    apiKey: string;
-}
-export interface Organization {
-    uid: string;
-    name: string;
-}
-export interface selectedOrganization {
-    orgUid: string;
-    orgName: string;
-}
-export interface Stack {
-    name: string;
-    api_key: string;
-}
-export interface ContentType {
-    uid: string;
-    title: string;
-}
-export interface Environment {
-    name: string;
-    uid: string;
-}
-export interface Entry {
-    uid: string;
-    title: string;
-}
-export interface Locale {
-    name: string;
-    code: string;
-}

package/types/selectors/validations.d.ts

@@ -1 +0,0 @@
-export declare function shouldNotBeEmpty(input: any): boolean;