@contentstack/cli-utilities 0.1.1-beta.1

package/test/helpers/init.js

@@ -0,0 +1,4 @@
+const path = require('path');
+
+process.env.TS_NODE_PROJECT = path.resolve('test/tsconfig.json');
+process.env.CLI_ENV = 'TEST';

package/test/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "noEmit": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "declaration": false,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "lib",
+    "rootDir": "src",
+    "strict": false,
+    "target": "es2017",
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "src/**/*.d.ts"
+  ]
+}

package/types/cli-error.d.ts

@@ -0,0 +1,4 @@
+export default class CLIError extends Error {
+    suggestions?: string[];
+    constructor(message: any, suggestions?: string[]);
+}

package/types/cli-ux.d.ts

@@ -0,0 +1,22 @@
+import { Table } from '@oclif/core/lib/cli-ux';
+import { PrintOptions, InquirePayload, CliUXPromptOptions } from './interfaces';
+/**
+ * CLI Interface
+ */
+declare class CLIInterface {
+    private loading;
+    constructor();
+    get uxTable(): typeof Table.table;
+    init(context: any): 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>;
+    prompt(name: string, options?: CliUXPromptOptions): Promise<any>;
+    confirm(message?: string): Promise<boolean>;
+    progress(options?: any): any;
+}
+declare const _default: CLIInterface;
+export default _default;

package/types/config-handler.d.ts

@@ -0,0 +1,17 @@
+import Conf from 'conf';
+declare class Config {
+    private config;
+    constructor();
+    init(): Conf<Record<string, unknown>>;
+    private fallbackInit;
+    private getObfuscationKey;
+    private getConfigDataAndUnlinkConfigFile;
+    private getEncryptedConfig;
+    private getDecryptedConfig;
+    get(key: any): string | any;
+    set(key: any, value: any): Promise<Conf<Record<string, unknown>>>;
+    delete(key: any): Conf<Record<string, unknown>>;
+    clear(): void;
+}
+declare const _default: Config;
+export default _default;

package/types/flag-deprecation-check.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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?: any[], suggestions?: any[], customMessage?: string): (input: any, command: any) => any;

package/types/http-client.d.ts

@@ -0,0 +1,54 @@
+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/index.d.ts

@@ -0,0 +1,7 @@
+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';

package/types/interfaces/index.d.ts

@@ -0,0 +1,50 @@
+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/types/logger.d.ts

@@ -0,0 +1,17 @@
+import winston from 'winston';
+declare class LoggerService {
+    name: string;
+    data: object | null;
+    logger: winston.Logger;
+    static dateFormat(): string;
+    constructor(name: string);
+    init(context: any): void;
+    set loggerName(name: string);
+    setLogData(data: object): void;
+    info(message: string, param?: any): Promise<any>;
+    debug(message: string, param?: any): Promise<any>;
+    error(message: string, param?: any): Promise<any>;
+    warn(message: string, param?: any): Promise<any>;
+}
+declare const _default: LoggerService;
+export default _default;

package/types/message-handler.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Message handler
+ */
+declare class Messages {
+    private messages;
+    messageFilePath: any;
+    constructor();
+    init(context: any): void;
+    parse(messageKey: string, ...substitutions: Array<any>): string;
+}
+declare const _default: Messages;
+export default _default;

package/types/selectors/index.d.ts

@@ -0,0 +1,12 @@
+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): Promise<Locale>;
+export declare function chooseTokenAlias(): Promise<Token>;
+export declare function chooseDeliveryTokenAlias(): Promise<Token>;

package/types/selectors/interfaces.d.ts

@@ -0,0 +1,32 @@
+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

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