@qodalis/cli-core 0.0.9 → 0.0.11

package/lib/interfaces/index.d.ts

@@ -1,127 +1,7 @@
-import { Terminal } from '@xterm/xterm';
-import { Observable, Subject } from 'rxjs';
-import { CliBackgroundColor, CliForegroundColor, CliOptions, CliProcessCommand, CliProcessorMetadata, ICliUser, ICliUserSession } from '../models';
-export interface ICliCommandAuthor {
-    /**
-     * The name of the author
-     */
-    name: string;
-    /**
-     * The email of the author
-     */
-    email: string;
-}
-/**
- * Represents a command processor
- */
-export interface ICliCommandProcessor {
-    /**
-     * The command that this processor handles
-     */
-    command: string;
-    /**
-     * A description of the command
-     */
-    description?: string;
-    /**
-     * The author of the command
-     */
-    author?: ICliCommandAuthor;
-    /**
-     * If true, the processor can handle unlisted commands
-     */
-    allowUnlistedCommands?: boolean;
-    /**
-     * If true, the value is required
-     */
-    valueRequired?: boolean;
-    /**
-     * The version of the command processor
-     * @default '1.0.0'
-     */
-    version?: string;
-    /**
-     * The metadata for the command processor
-     */
-    metadata?: CliProcessorMetadata;
-    /**
-     * Processors that are nested under this processor
-     */
-    processors?: ICliCommandProcessor[];
-    /**
-     * Parameters that the command accepts
-     */
-    parameters?: ICliCommandParameterDescriptor[];
-    /**
-     * Process the command
-     * @param command The command to process
-     * @param context The context in which the command is executed
-     */
-    processCommand(command: CliProcessCommand, context: ICliExecutionContext): Promise<void>;
-    /**
-     * Write the description of the command
-     * @param context The context in which the command is executed
-     */
-    writeDescription?(context: ICliExecutionContext): void;
-    /**
-     * A function that validates the command before execution
-     * @param value The value to validate
-     * @returns An object with a valid property that indicates if the value is valid and an optional message property that contains a message to display if the value is not valid
-     */
-    validateBeforeExecution?: (command: CliProcessCommand, context: ICliExecutionContext) => {
-        valid: boolean;
-        message?: string;
-    };
-    /**
-     * Initialize the command processor
-     * @param context The context in which the command is executed
-     */
-    initialize?(context: ICliExecutionContext): Promise<void>;
-}
-/**
- * Represents a command parameter
- */
-export interface ICliCommandParameterDescriptor {
-    /**
-     * The name of the parameter
-     */
-    name: string;
-    /**
-     * Aliases for the parameter
-     */
-    aliases?: string[];
-    /**
-     * A description of the parameter
-     */
-    description: string;
-    /**
-     * If true, the parameter is required
-     */
-    required: boolean;
-    /**
-     * The type of the parameter
-     */
-    type: string;
-    /**
-     * The default value of the parameter
-     */
-    defaultValue?: any;
-    /**
-     * A validator function that validates the value of the parameter
-     * @param value The value to validate
-     * @returns An object with a valid property that indicates if the value is valid and an optional message property that contains a message to display if the value is not valid
-     */
-    validator?: (value: any) => {
-        /**
-         * Indicates if the value is valid
-         */
-        valid: boolean;
-        /**
-         * An optional message to display if the value is not valid
-         */
-        message?: string;
-    };
-}
+import { Observable } from 'rxjs';
+import { CliBackgroundColor, CliForegroundColor, CliLogLevel, CliProcessCommand, CliProvider, ICliUser, ICliUserSession } from '../models';
+import { ICliExecutionContext } from './execution-context';
+import { ICliCommandProcessor } from './command-processor';
 export interface ICliTerminalWriter {
     /**
      * Write text to the terminal
@@ -132,7 +12,7 @@ export interface ICliTerminalWriter {
      * Write text to the terminal followed by a newline
      * @param text The text to write
      */
-    writeln(text: string): void;
+    writeln(text?: string): void;
     /**
      * Write a success message to the terminal
      * @param messag The message to write
@@ -197,58 +77,16 @@ export interface ICliTerminalWriter {
      * @returns void
      */
     writeTable(headers: string[], rows: string[][]): void;
-}
-export interface ICliProgressBar {
-    /**
-     * Indicates if the progress bar is running
-     */
-    isRunning: boolean;
-    /**
-     * Show the progress bar
-     */
-    show: () => void;
-    /**
-     * Hide the progress bar
-     */
-    hide: () => void;
-}
-/**
- * Represents a spinner for the CLI
- */
-export interface ICliSpinner extends ICliProgressBar {
-    /**
-     * Set the text of the spinner
-     * @param text The text to set
-     */
-    setText: (text: string) => void;
-}
-export type CliPercentageProgressBarUpdateValueOptions = {
     /**
-     * The type of update to perform
-     * @default 'replace'
-     */
-    type?: 'replace' | 'increment';
-};
-/**
- * Represents a progress bar for the CLI
- */
-export interface ICliPercentageProgressBar extends ICliProgressBar {
-    /**
-     * Update the progress of the progress bar
-     * @param progress The progress to update to
-     * @returns void
-     */
-    update: (progress: number, options?: CliPercentageProgressBarUpdateValueOptions) => void;
-    /**
-     * Complete the progress bar
+     * Write a divider to the terminal
+     * @param options The options for the divider
      * @returns void
      */
-    complete: () => void;
-    /**
-     * Set the text of the spinner
-     * @param text The text to set
-     */
-    setText: (text: string) => void;
+    writeDivider(options?: {
+        color?: CliForegroundColor;
+        length?: number;
+        char?: string;
+    }): void;
 }
 /**
  * Represents a clipboard for the CLI
@@ -277,10 +115,16 @@ export interface ICliCommandExecutorService {
      */
     showHelp(command: CliProcessCommand, context: ICliExecutionContext): Promise<void>;
     /**
-     * List all commands
-     * @returns An array of all commands
+     * Execute a command
+     * @param command The command to execute
+     * @param context The context in which the command is executed
      */
-    listCommands(): string[];
+    executeCommand(command: string, context: ICliExecutionContext): Promise<void>;
+}
+/**
+ * Represents a registry for command processors
+ */
+export interface ICliCommandProcessorRegistry {
     /**
      * Find a processor for a command
      * @param mainCommand
@@ -314,86 +158,31 @@ export interface ICliExecutionProcess {
     /**
      * The data of the process
      */
-    data: string | undefined;
+    data: any | undefined;
     /**
      * Exit the process
      * @param code The exit code
      * @returns void
      */
-    exit: (code?: number) => void;
+    exit: (
     /**
-     * Output data from the process
-     * @param data The data to output
+     * The exit code
      */
-    output(data: string): void;
+    code?: number, 
     /**
-     * Start the process
-     * @returns void
-     */
-    start: () => void;
-    /**
-     * End the process
-     * @returns void
+     * Options for exiting the process
      */
-    end: () => void;
-}
-/**
- * Represents the context in which a command is executed
- */
-export interface ICliExecutionContext {
-    /**
-     * The current user session
-     */
-    userSession?: ICliUserSession;
-    /**
-     * The spinner to use for showing/hiding the loader
-     */
-    spinner?: ICliSpinner;
-    /**
-     * The progress bar to use for showing progress
-     */
-    progressBar: ICliPercentageProgressBar;
-    /**
-     * A subject that emits when the command is aborted
-     */
-    onAbort: Subject<void>;
-    /**
-     * The terminal to use for writing
-     */
-    terminal: Terminal;
-    /**
-     * The writer to use for writing to the terminal
-     */
-    writer: ICliTerminalWriter;
-    /**
-     * The command executor to use for executing commands
-     */
-    executor: ICliCommandExecutorService;
-    /**
-     * The clipboard to use for copying/pasting
-     */
-    clipboard: ICliClipboard;
-    /**
-     * The data store to use for storing data
-     */
-    dataStore: ICliCommandDataStore;
-    /**
-     * The options for the CLI
-     */
-    options?: CliOptions;
-    /**
-     * The prompt to use for prompting the user for input
-     */
-    showPrompt: () => void;
-    /**
-     * Set the current main processor
-     * @param processor The processor to set
-     */
-    setMainProcessor(processor: ICliCommandProcessor): void;
+    options?: {
+        /**
+         * Indicates if the exit should be silent, i.e. not throw an error
+         */
+        silent?: boolean;
+    }) => void;
     /**
-     * The process to use for exiting the CLI
+     * Output data from the process
+     * @param data The data to output
      */
-    process: ICliExecutionProcess;
+    output(data: any): void;
 }
 /**
  * Represents a data store for storing data associated with commands
@@ -479,3 +268,58 @@ export interface ICliUmdModule {
      */
     processors: ICliCommandProcessor[];
 }
+/**
+ * Represents a logger for the CLI
+ */
+export interface ICliLogger {
+    /**
+     * Set the log level of the logger
+     * @param level The log level to set
+     * @returns void
+     * @default CliLogLevel.ERROR
+     */
+    setCliLogLevel(level: CliLogLevel): void;
+    /**
+     * Log a message
+     * @param args The arguments to log
+     */
+    log(...args: any[]): void;
+    /**
+     * Log a message
+     * @param args The arguments to log
+     */
+    info(...args: any[]): void;
+    /**
+     * Log a message
+     * @param args The arguments to log
+     */
+    warn(...args: any[]): void;
+    /**
+     * Log a message
+     * @param args The arguments to log
+     */
+    error(...args: any[]): void;
+    /**
+     * Log a message
+     * @param args The arguments to log
+     */
+    debug(...args: any[]): void;
+}
+/**
+ * Represents a services for the CLI context
+ */
+export interface ICliContextServices {
+    /**
+     * Get a service
+     * @param service The service to get
+     */
+    get<T>(service: any): T;
+    /**
+     * Set a service
+     * @param definition The definition of the service
+     */
+    set(definition: CliProvider | CliProvider[]): void;
+}
+export * from './execution-context';
+export * from './command-processor';
+export * from './progress-bars';

package/lib/interfaces/progress-bars.d.ts

@@ -0,0 +1,52 @@
+export interface ICliProgressBar {
+    /**
+     * Indicates if the progress bar is running
+     */
+    isRunning: boolean;
+    /**
+     * Show the progress bar
+     */
+    show: () => void;
+    /**
+     * Hide the progress bar
+     */
+    hide: () => void;
+}
+/**
+ * Represents a spinner for the CLI
+ */
+export interface ICliSpinner extends ICliProgressBar {
+    /**
+     * Set the text of the spinner
+     * @param text The text to set
+     */
+    setText: (text: string) => void;
+}
+export type CliPercentageProgressBarUpdateValueOptions = {
+    /**
+     * The type of update to perform
+     * @default 'replace'
+     */
+    type?: 'replace' | 'increment';
+};
+/**
+ * Represents a progress bar for the CLI
+ */
+export interface ICliPercentageProgressBar extends ICliProgressBar {
+    /**
+     * Update the progress of the progress bar
+     * @param progress The progress to update to
+     * @returns void
+     */
+    update: (progress: number, options?: CliPercentageProgressBarUpdateValueOptions) => void;
+    /**
+     * Complete the progress bar
+     * @returns void
+     */
+    complete: () => void;
+    /**
+     * Set the text of the spinner
+     * @param text The text to set
+     */
+    setText: (text: string) => void;
+}

package/lib/models/index.d.ts

@@ -7,7 +7,7 @@ export type CliProcessCommand = {
     /**
      * The data that was entered
      */
-    data?: string;
+    data?: any;
     /**
      * The chain of commands that were entered
      */
@@ -196,9 +196,19 @@ export interface ICliUserSession {
  */
 export type CliOptions = Record<string, any> & {
     /**
-     * The welcome message to display when the CLI starts
+     * The welcome message options
      */
-    welcomeMessage?: string;
+    welcomeMessage?: {
+        /**
+         * The message to display
+         */
+        message?: string;
+        /**
+         * When to show the welcome message
+         * @default 'always'
+         */
+        show?: 'always' | 'once' | 'daily' | 'never';
+    };
     /**
      * If true, the welcome message is hidden
      * @default false
@@ -225,6 +235,10 @@ export type CliOptions = Record<string, any> & {
      * Custom terminal options
      */
     terminalOptions?: ITerminalOptions & ITerminalInitOnlyOptions;
+    /**
+     * The minimum log level to display
+     */
+    logLevel?: CliLogLevel;
 };
 /**
  * Represents a package that can be installed
@@ -272,8 +286,21 @@ export type CliProcessorMetadata = Record<string, any> & {
      */
     icon?: CliIcon | string;
 };
+/**
+ * Represents a log level for the CLI
+ */
+export declare enum CliLogLevel {
+    None = 0,
+    DEBUG = 1,
+    LOG = 2,
+    INFO = 3,
+    WARN = 4,
+    ERROR = 5
+}
 export declare const enums: {
     CliForegroundColor: typeof CliForegroundColor;
     CliBackgroundColor: typeof CliBackgroundColor;
     CliIcon: typeof CliIcon;
+    CliLogLevel: typeof CliLogLevel;
 };
+export * from './services';

package/lib/models/services.d.ts

@@ -0,0 +1,20 @@
+type MultiServices = {
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+};
+export type CliValueProvider = MultiServices & {
+    useValue: any;
+};
+export type CliTypeProvider = MultiServices & {
+    useClass: any;
+};
+export type CliFactoryProvider = MultiServices & {
+    useFactory: Function;
+};
+export type CliProvider = {
+    provide: any;
+} & (CliValueProvider | CliTypeProvider | CliFactoryProvider) & Record<string, any>;
+export {};

package/lib/modules/index.d.ts

@@ -1,5 +1,6 @@
-import { ICliUmdModule } from '../interfaces';
-export declare const initializeBrowserEnvironment: ({ handlers, }: {
+import { ICliExecutionContext, ICliUmdModule } from '../interfaces';
+export declare const initializeBrowserEnvironment: ({ context, handlers, }: {
+    context: ICliExecutionContext;
     handlers: ((module: ICliUmdModule) => Promise<void>)[];
 }) => void;
 export declare const bootUmdModule: (module: ICliUmdModule) => Promise<void>;

package/lib/utils/delay.d.ts

@@ -0,0 +1 @@
+export declare const delay: (ms: number) => Promise<void>;

package/lib/utils/index.d.ts

@@ -8,6 +8,7 @@ export declare const toQueryString: (params: Record<string, any>) => string;
 export declare const highlightTextWithBg: (text: string, pattern: RegExp, bgColor?: CliBackgroundColor) => string;
 export declare const getRightOfWord: (command: string, word: string) => string | undefined;
 export * from './object-describer';
+export * from './delay';
 export declare const utils: {
     getParameterValue: (p: ICliCommandParameterDescriptor, args: Record<string, any>) => any | undefined;
     formatJson: (json: any) => string;
@@ -16,4 +17,5 @@ export declare const utils: {
     highlightTextWithBg: (text: string, pattern: RegExp, bgColor?: CliBackgroundColor) => string;
     getRightOfWord: (command: string, word: string) => string | undefined;
     ObjectDescriber: typeof ObjectDescriber;
+    delay: (ms: number) => Promise<void>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli-core",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Core Angular CLI for @qodalis extensions.",
   "author": "Nicolae Lupei, Qodalis Solutions",
   "license": "MIT",