@contentstack/cli-utilities 1.0.2 → 1.0.4

package/src/encrypter.ts

@@ -1,70 +0,0 @@
-import crypto from "crypto";
-
-type CryptoConfig = {
-  algorithm?: string;
-  encryptionKey?: string;
-  typeIdentifier?: string;
-};
-
-const defaultValues: CryptoConfig = {
-  typeIdentifier: "◈",
-  algorithm: "aes-192-cbc",
-  encryptionKey: "nF2ejRQcTv",
-};
-
-export default class NodeCrypto {
-  private readonly key: Buffer;
-  private readonly algorithm: string;
-  private readonly typeIdentifier: string;
-
-  constructor(config: CryptoConfig = defaultValues) {
-    const { algorithm, encryptionKey, typeIdentifier } = config;
-    this.algorithm = algorithm;
-    this.typeIdentifier = typeIdentifier;
-    this.key = crypto.scryptSync(encryptionKey, "salt", 24);
-  }
-
-  encrypt(plainData) {
-    const iv = crypto.randomBytes(16);
-    const cipher = crypto.createCipheriv(this.algorithm, this.key, iv);
-    let data = plainData;
-
-    switch (typeof plainData) {
-      case "number":
-        data = `${String(plainData)}${this.typeIdentifier}number`;
-        break;
-      case "object":
-        data = `${JSON.stringify(plainData)}${this.typeIdentifier}object`;
-        break;
-    }
-
-    const encrypted = cipher.update(data, "utf8", "hex");
-
-    return [
-      encrypted + cipher.final("hex"),
-      Buffer.from(iv).toString("hex"),
-    ].join("|");
-  }
-
-  decrypt(encryptedData) {
-    const [encrypted, iv] = encryptedData.split("|");
-    if (!iv) throw new Error("IV not found");
-    const decipher = crypto.createDecipheriv(
-      this.algorithm,
-      this.key,
-      Buffer.from(iv, "hex")
-    );
-    const result =
-      decipher.update(encrypted, "hex", "utf8") + decipher.final("utf8");
-    const [data, type] = result.split(this.typeIdentifier);
-
-    switch (type) {
-      case "number":
-        return Number(data);
-      case "object":
-        return JSON.parse(data);
-    }
-
-    return data;
-  }
-}

package/src/flag-deprecation-check.ts

@@ -1,41 +0,0 @@
-import cliux from './cli-ux';
-
-/**
- * checks the deprecation and prints it
- * @param {Array} deprecatedFlags flags to be deprecated
- * @param {String} customMessage [optional] a custom message
- * @returns flag parser
- */
-export default function (deprecatedFlags = [], suggestions = [], customMessage?: string) {
-  return (input, command) => {
-    const { context: { flagWarningPrintState = {} } = {} } = command
-    let isCommandHasDeprecationFlag = false;
-    deprecatedFlags.forEach((item) => {
-      if (command.argv.indexOf(item) !== -1) {
-        if (flagWarningPrintState[command.id + item]) {
-          return input
-        }
-        flagWarningPrintState[command.id + item] = true
-        isCommandHasDeprecationFlag = true;
-      }
-    });
-
-    if (isCommandHasDeprecationFlag) {
-      let depreactionMessage = '';
-      if (customMessage) {
-        depreactionMessage = customMessage;
-      } else {
-        depreactionMessage = `WARNING!!! You're using the old (soon to be deprecated) Contentstack CLI flags (${deprecatedFlags.join(
-          ', ',
-        )}).`;
-
-        if (suggestions.length > 0) {
-          depreactionMessage += ` We recommend you to use the updated flags (${suggestions.join(', ')}).`;
-        }
-      }
-      cliux.print(depreactionMessage, { color: 'yellow' });
-    }
-
-    return input;
-  };
-}

package/src/http-client/client.ts

@@ -1,369 +0,0 @@
-import Axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { HttpResponse } from './http-response';
-
-export class HttpClient {
-  /**
-   * The request configuration.
-   */
-  private request: AxiosRequestConfig;
-
-  /**
-   * The request configuration.
-   */
-  private readonly axiosInstance: AxiosInstance;
-
-  /**
-   * The payload format for a JSON or form-url-encoded request.
-   */
-  private bodyFormat: BodyFormat = 'json';
-
-  /**
-   * Createa new pending HTTP request instance.
-   */
-  constructor() {
-    this.request = {};
-    this.axiosInstance = Axios.create();
-
-    // Sets payload format as json by default
-    this.asJson();
-  }
-
-  /**
-   * Create a reusable HttpClient instance.
-   *
-   * @returns {HttpClient}
-   */
-  static create(): HttpClient {
-    return new this();
-  }
-
-  /**
-   * Returns the Axios request config.
-   *
-   * @returns {AxiosRequestConfig}
-   */
-  requestConfig(): AxiosRequestConfig {
-    return this.request;
-  }
-
-  /**
-   * Resets the request config.
-   *
-   * @returns {AxiosRequestConfig}
-   */
-  resetConfig(): HttpClient {
-    this.request = {};
-    return this;
-  }
-
-  /**
-   * Use the given `baseUrl` for all requests.
-   *
-   * @param {String} baseUrl
-   *
-   * @returns {HttpClient}
-   */
-  baseUrl(baseUrl: string): HttpClient {
-    if (typeof baseUrl !== 'string') {
-      throw new Error(`The base URL must be a string. Received "${typeof baseUrl}"`);
-    }
-
-    this.request.baseURL = baseUrl;
-
-    return this;
-  }
-
-  /**
-   * Add request headers.
-   * @returns {HttpClient}
-   */
-  headers(headers: any): HttpClient {
-    this.request.headers = { ...this.request.headers, ...headers };
-
-    return this;
-  }
-
-  /**
-   * Add query parameters to the request.
-   *
-   * @param {Object} queryParams
-   *
-   * @returns {HttpClient}
-   */
-  queryParams(queryParams: object): HttpClient {
-    this.request.params = { ...this.request.params, ...queryParams };
-
-    return this;
-  }
-
-  /**
-   * Add basic authentication via `username` and `password` to the request.
-   *
-   * @param {String} username
-   * @param {String} password
-   *
-   * @returns {HttpClient}
-   */
-  basicAuth(username: string, password: string): HttpClient {
-    this.request.auth = { username, password };
-
-    return this;
-  }
-
-  /**
-   * Add an authorization `token` to the request.
-   *
-   * @param {String} token
-   * @param {String} type
-   *
-   * @returns {HttpClient}
-   */
-  token(token: string, type: string = 'Bearer'): HttpClient {
-    return this.headers({
-      Authorization: `${type} ${token}`.trim(),
-    });
-  }
-
-  /**
-   * Merge your own custom Axios options into the request.
-   *
-   * @param {Object} options
-   *
-   * @returns {HttpClient}
-   */
-  options(options: AxiosRequestConfig = {}): HttpClient {
-    Object.assign(this.request, options);
-
-    return this;
-  }
-
-  /**
-   * Add a request payload.
-   *
-   * @param {*} data
-   *
-   * @returns {HttpClient}
-   */
-  payload(data: any): HttpClient {
-    this.request.data = data;
-
-    return this;
-  }
-
-  /**
-   * Define the request `timeout` in milliseconds.
-   *
-   * @param {Number} timeout
-   *
-   * @returns {HttpClient}
-   */
-  timeout(timeout: number): HttpClient {
-    this.request.timeout = timeout;
-
-    return this;
-  }
-
-  /**
-   * Tell HttpClient to send the request as JSON payload.
-   *
-   * @returns {HttpClient}
-   */
-  asJson(): HttpClient {
-    return this.payloadFormat('json').contentType('application/json');
-  }
-
-  /**
-   * Tell HttpClient to send the request as form parameters,
-   * encoded as URL query parameters.
-   *
-   * @returns {HttpClient}
-   */
-  asFormParams(): HttpClient {
-    return this.payloadFormat('formParams').contentType('application/x-www-form-urlencoded');
-  }
-
-  /**
-   * Set the request payload format.
-   *
-   * @param {String} format
-   *
-   * @returns {HttpClient}
-   */
-  payloadFormat(format: BodyFormat): HttpClient {
-    this.bodyFormat = format;
-
-    return this;
-  }
-
-  /**
-   * Set the `Accept` request header. This indicates what
-   * content type the server should return.
-   *
-   * @param {String} accept
-   *
-   * @returns {HttpClient}
-   */
-  accept(accept: string): HttpClient {
-    return this.headers({ Accept: accept });
-  }
-
-  /**
-   * Set the `Accept` request header to JSON. This indicates
-   * that the server should return JSON data.
-   *
-   * @param {String} accept
-   *
-   * @returns {HttpClient}
-   */
-  acceptJson(): HttpClient {
-    return this.accept('application/json');
-  }
-
-  /**
-   * Set the `Content-Type` request header.
-   *
-   * @param {String} contentType
-   *
-   * @returns {HttpClient}
-   */
-  contentType(contentType: string): HttpClient {
-    return this.headers({ 'Content-Type': contentType });
-  }
-
-  /**
-   * Send an HTTP GET request, optionally with the given `queryParams`.
-   *
-   * @param {String} url
-   * @param {Object} queryParams
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async get<R>(url: string, queryParams: object = {}): Promise<HttpResponse<R>> {
-    this.queryParams(queryParams);
-
-    return this.send<R>('GET', url);
-  }
-
-  /**
-   * Send an HTTP POST request, optionally with the given `payload`.
-   *
-   * @param {String} url
-   * @param {Object} payload
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async post<R>(url: string, payload?: any): Promise<HttpResponse<R>> {
-    if (payload) {
-      this.payload(payload);
-    }
-
-    return this.send<R>('POST', url);
-  }
-
-  /**
-   * Send an HTTP PUT request, optionally with the given `payload`.
-   *
-   * @param {String} url
-   * @param {Object} payload
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async put<R>(url: string, payload?: any): Promise<HttpResponse<R>> {
-    if (payload) {
-      this.payload(payload);
-    }
-
-    return this.send<R>('PUT', url);
-  }
-
-  /**
-   * Send an HTTP PATCH request, optionally with the given `payload`.
-   *
-   * @param {String} url
-   * @param {Object} payload
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async patch<R>(url: string, payload?: any): Promise<HttpResponse<R>> {
-    if (payload) {
-      this.payload(payload);
-    }
-
-    return this.send<R>('PATCH', url);
-  }
-
-  /**
-   * Send an HTTP DELETE request, optionally with the given `queryParams`.
-   *
-   * @param {String} url
-   * @param {Object} queryParams
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async delete<R>(url: string, queryParams: object = {}): Promise<HttpResponse<R>> {
-    this.queryParams(queryParams);
-
-    return this.send<R>('DELETE', url);
-  }
-
-  /**
-   * Send the HTTP request.
-   *
-   * @param {String} method
-   * @param {String} url
-   *
-   * @returns {HttpResponse}
-   *
-   * @throws
-   */
-  async send<R>(method: HttpMethod, url: string): Promise<HttpResponse<R>> {
-    try {
-      return new HttpResponse<R>(await this.createAndSendRequest(method, url));
-    } catch (error: any) {
-      if (error.response) {
-        return new HttpResponse(error.response);
-      }
-
-      throw error;
-    }
-  }
-
-  /**
-   * Create and send the HTTP request.
-   *
-   * @param {String} method
-   * @param {String} url
-   *
-   * @returns {Request}
-   */
-  async createAndSendRequest(method: HttpMethod, url: string): Promise<AxiosResponse> {
-    return await this.axiosInstance({
-      url,
-      method,
-      withCredentials: true,
-      ...this.request,
-      data: this.prepareRequestPayload(),
-    });
-  }
-
-  /**
-   * Returns the request payload depending on the selected request payload format.
-   */
-  prepareRequestPayload(): any {
-    return this.bodyFormat === 'formParams' ? new URLSearchParams(this.request.data).toString() : this.request.data;
-  }
-}
-
-type BodyFormat = 'json' | 'formParams';
-
-type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS';

package/src/http-client/http-response.ts

@@ -1,55 +0,0 @@
-'use strict';
-
-import { AxiosResponse } from 'axios';
-
-export class HttpResponse<ResponseType = any> {
-  /**
-   * The Axios response object.
-   */
-  private readonly response: AxiosResponse;
-
-  /**
-   * Wrap the given Axios `response` into a new response instance.
-   *
-   * @param {AxiosResponse} response
-   */
-  constructor(response: AxiosResponse) {
-    this.response = response;
-  }
-
-  /**
-   * Returns the response status.
-   *
-   * @returns {Number}
-   */
-  get status() {
-    return this.response.status;
-  }
-
-  /**
-   * Returns the response payload. This method is an alias for `response.payload()`.
-   *
-   * @returns {*}
-   */
-  get data() {
-    return this.payload;
-  }
-
-  /**
-   * Returns the response payload.
-   *
-   * @returns {*}
-   */
-  get payload() {
-    return this.response.data;
-  }
-
-  /**
-   * Returns the response headers.
-   *
-   * @returns {Object}
-   */
-  get headers() {
-    return this.response.headers;
-  }
-}

package/src/http-client/index.ts

@@ -1,7 +0,0 @@
-'use strict';
-
-import { HttpClient } from './client';
-
-export default HttpClient;
-export * from './client';
-export * from './http-response';

package/src/index.ts

@@ -1,9 +0,0 @@
-export { default as logger } from './logger';
-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 printFlagDeprecation } from './flag-deprecation-check';
-export * from './http-client';
-export { default as NodeCrypto } from './encrypter'
-export { chooseLocale as chooseLocalePrompt } from './selectors';

package/src/interfaces/index.ts

@@ -1,61 +0,0 @@
-import { IPromptOptions } from "@oclif/core/lib/cli-ux";
-
-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 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;
-}
-
-export interface CliUXPromptOptions extends IPromptOptions {}

package/src/logger.ts

@@ -1,101 +0,0 @@
-import winston from 'winston';
-import messageHandler from './message-handler';
-
-class LoggerService {
-  name: string;
-  data: object | null;
-  logger: winston.Logger;
-
-  static dateFormat(): string {
-    return new Date(Date.now()).toUTCString();
-  }
-  constructor(name: string) {
-    this.data = null;
-    this.name = null;
-
-    const logger = winston.createLogger({
-      transports: [
-        // new winston.transports.Console(),
-        new winston.transports.File({
-          filename: `./logs/${name}.log`,
-        }),
-      ],
-      format: winston.format.combine(
-        winston.format.colorize(),
-        winston.format.printf((info) => {
-          let stringifiedParam;
-          try {
-            stringifiedParam = JSON.stringify(info.obj);
-          } catch (error) {
-            console.log('warning: failed to log the result');
-          }
-          // parse message
-          info.message = messageHandler.parse(info.message);
-          let message = `${LoggerService.dateFormat()}:${name}:${info.level}:${info.message}`;
-          message = info.obj ? message + `:${stringifiedParam}` : message;
-          message = this.data ? message + `:${JSON.stringify(this.data)}` : message;
-          return message;
-        }),
-      ),
-      // level: (config.get('logger.level') as string) || 'error',
-      level: 'error',
-      silent: true
-      // silent: config.get('logger.enabled') && process.env.CLI_ENV !== 'TEST' ? false : false,
-    });
-    this.logger = logger;
-  }
-
-  init(context) {
-    this.name = (context && context.plugin && context.plugin.name) || 'cli';
-  }
-
-  set loggerName(name: string) {
-    this.name = name;
-  }
-
-  setLogData(data: object): void {
-    this.data = data;
-  }
-
-  async info(message: string, param?: any): Promise<any> {
-    if (param) {
-      this.logger.log('info', message, {
-        obj: param,
-      });
-    } else {
-      this.logger.log('info', message);
-    }
-  }
-
-  async debug(message: string, param?: any): Promise<any> {
-    if (param) {
-      this.logger.log('debug', message, {
-        obj: param,
-      });
-    } else {
-      this.logger.log('debug', message);
-    }
-  }
-
-  async error(message: string, param?: any): Promise<any> {
-    if (param) {
-      this.logger.log('error', message, {
-        obj: param,
-      });
-    } else {
-      this.logger.log('error', message);
-    }
-  }
-
-  async warn(message: string, param?: any): Promise<any> {
-    if (param) {
-      this.logger.log('warn', message, {
-        obj: param,
-      });
-    } else {
-      this.logger.log('warn', message);
-    }
-  }
-}
-
-export default new LoggerService('cli');