@qodalis/cli-core 0.0.10 → 0.0.12

package/lib/interfaces/index.d.ts

@@ -1,130 +1,7 @@
-import { Terminal } from '@xterm/xterm';
-import { Observable, Subject } from 'rxjs';
-import { CliBackgroundColor, CliForegroundColor, CliLogLevel, 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
-     * @default false
-     * @remarks If true, the processor can handle unlisted commands. If false, the processor will only handle commands that are explicitly listed in the processors property
-     * @remarks Optional if valueRequired is true
-     */
-    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, Subscription } from 'rxjs';
+import { CliBackgroundColor, CliForegroundColor, CliLogLevel, CliProcessCommand, CliProvider, CliState } from '../models';
+import { ICliExecutionContext } from './execution-context';
+import { ICliCommandChildProcessor, ICliCommandProcessor } from './command-processor';
 export interface ICliTerminalWriter {
     /**
      * Write text to the terminal
@@ -211,58 +88,6 @@ export interface ICliTerminalWriter {
         char?: 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
-     * @returns void
-     */
-    complete: () => void;
-    /**
-     * Set the text of the spinner
-     * @param text The text to set
-     */
-    setText: (text: string) => void;
-}
 /**
  * Represents a clipboard for the CLI
  */
@@ -300,12 +125,29 @@ export interface ICliCommandExecutorService {
  * Represents a registry for command processors
  */
 export interface ICliCommandProcessorRegistry {
+    /**
+     * The processors registered with the registry
+     */
+    readonly processors: ICliCommandProcessor[];
     /**
      * Find a processor for a command
      * @param mainCommand
      * @param chainCommands
      */
     findProcessor(mainCommand: string, chainCommands: string[]): ICliCommandProcessor | undefined;
+    /**
+     * Recursively searches for a processor matching the given command.
+     * @param mainCommand The main command name.
+     * @param chainCommands The remaining chain commands (if any).
+     * @param processors The list of available processors.
+     * @returns The matching processor or undefined if not found.
+     */
+    findProcessorInCollection(mainCommand: string, chainCommands: string[], processors: ICliCommandProcessor[]): ICliCommandProcessor | undefined;
+    /**
+     * Get the root processor for a child processor
+     * @param child The child processor
+     */
+    getRootProcessor(child: ICliCommandChildProcessor): ICliCommandProcessor;
     /**
      * Register a processor
      * @param processor
@@ -360,128 +202,71 @@ export interface ICliExecutionProcess {
     output(data: any): void;
 }
 /**
- * Represents the context in which a command is executed
+ * Represents a key-value store for the CLI
  */
-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;
+export interface ICliKeyValueStore {
     /**
-     * The prompt to use for prompting the user for input
+     * Retrieves a value by key.
+     * @param key - The key to retrieve the value for.
+     * @returns A promise resolving to the value or undefined if not found.
      */
-    showPrompt: () => void;
+    get<T = any>(key: string): Promise<T | undefined>;
     /**
-     * Set the current main processor
-     * @param processor The processor to set
+     * Sets a key-value pair in the store.
+     * @param key - The key to set.
+     * @param value - The value to store.
+     * @returns A promise resolving when the value is stored.
      */
-    setMainProcessor(processor: ICliCommandProcessor): void;
+    set(key: string, value: any): Promise<void>;
     /**
-     * The process to use for exiting the CLI
+     * Removes a key-value pair by key.
+     * @param key - The key to remove.
+     * @returns A promise resolving when the key is removed.
      */
-    process: ICliExecutionProcess;
+    remove(key: string): Promise<void>;
     /**
-     * The logger to use for logging
+     * Clears all key-value pairs from the store.
+     * @returns A promise resolving when the store is cleared.
      */
-    logger: ICliLogger;
+    clear(): Promise<void>;
 }
 /**
- * Represents a data store for storing data associated with commands
+ * Represents a store for storing data associated with commands
  */
-export interface ICliCommandDataStore {
-    /**
-     * The data store
-     */
-    data: Record<string, Record<string, any>>;
+export interface ICliStateStore {
     /**
-     * Append data to the data store
-     * @param command
-     * @param key
-     * @param data
+     * Get the current state as an object.
      */
-    appendData(command: string, key: string, data: any): void;
+    getState(): CliState;
     /**
-     * Get data from the data store
-     * @param command
-     * @param key
+     * Update the state with new values. Supports partial updates.
+     * @param newState Partial state to merge with the current state.
      */
-    getData<T = any>(command: string, key: string): T;
-}
-/**
- * Represents a service that manages user sessions in the CLI
- */
-export interface ICliUserSessionService {
+    updateState(newState: Partial<CliState>): void;
     /**
-     * Gets the current user session
-     * @returns An observable that emits the current user session
+     * Select a specific property or computed value from the state.
+     * @param selector A function to project a slice of the state.
+     * @returns Observable of the selected value.
      */
-    getUserSession(): Observable<ICliUserSession | undefined>;
+    select<K>(selector: (state: CliState) => K): Observable<K>;
     /**
-     * Sets the current user session
-     * @param session The session to set
+     * Subscribe to state changes.
+     * @param callback Callback function to handle state changes.
+     * @returns Subscription object to manage the subscription.
      */
-    setUserSession(session: ICliUserSession): Promise<void>;
-}
-/**
- * Represents a service that manages users in the CLI
- */
-export interface ICliUsersStoreService {
+    subscribe(callback: (state: CliState) => void): Subscription;
     /**
-     * Gets the current users
-     * @returns An observable that emits the current users
+     * Reset the state to its initial value.
      */
-    getUsers(options?: {
-        query?: string;
-        skip?: number;
-        take?: number;
-    }): Observable<ICliUser[]>;
+    reset(): void;
     /**
-     * Creates a user
-     * @param user The user to create
+     * Persist the state to storage.
      */
-    createUser(user: Omit<ICliUser, 'id'>): Promise<ICliUser>;
+    persist(): Promise<void>;
     /**
-     * Gets a user by id
-     * @param id The id of the user to get
-     * @returns An observable that emits the user with the specified id
+     * Initialize the state from storage.
      */
-    getUser(id: string): Observable<ICliUser | undefined>;
+    initialize(): Promise<void>;
 }
 /**
  * Represents a service that pings the server
@@ -542,3 +327,23 @@ export interface ICliLogger {
      */
     debug(...args: any[]): void;
 }
+/**
+ * Represents a service provider for the CLI
+ */
+export interface ICliServiceProvider {
+    /**
+     * 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';
+export * from './command-hooks';
+export * from './users';

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

@@ -0,0 +1,72 @@
+export interface ICliProgressBar {
+    /**
+     * Indicates if the progress bar is running
+     */
+    isRunning: boolean;
+    /**
+     * Show the progress bar
+     */
+    show: (text?: string) => 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;
+}
+export type CliTextAnimatorOptions = {
+    /**
+     * The speed of the animation
+     * @default 100
+     */
+    speed?: number;
+    /**
+     * The text will be removed after typing
+     */
+    removeAfterTyping?: boolean;
+};
+export interface ICliTextAnimator extends ICliProgressBar {
+    /**
+     * Show animated text in a typing and erasing effect.
+     * @param text
+     * @param options
+     * @returns
+     */
+    showText: (text: string, options?: CliTextAnimatorOptions) => void;
+}

package/lib/interfaces/users.d.ts

@@ -0,0 +1,42 @@
+import { ICliUserSession, ICliUser, CliAddUser } from '../models';
+import { Observable } from 'rxjs';
+/**
+ * Represents a service that manages user sessions in the CLI
+ */
+export interface ICliUserSessionService {
+    /**
+     * Gets the current user session
+     * @returns An observable that emits the current user session
+     */
+    getUserSession(): Observable<ICliUserSession | undefined>;
+    /**
+     * Sets the current user session
+     * @param session The session to set
+     */
+    setUserSession(session: ICliUserSession): Promise<void>;
+}
+/**
+ * Represents a service that manages users in the CLI
+ */
+export interface ICliUsersStoreService {
+    /**
+     * Gets the current users
+     * @returns An observable that emits the current users
+     */
+    getUsers(options?: {
+        query?: string;
+        skip?: number;
+        take?: number;
+    }): Observable<ICliUser[]>;
+    /**
+     * Creates a user
+     * @param user The user to create
+     */
+    createUser(user: CliAddUser): Promise<ICliUser>;
+    /**
+     * Gets a user by id
+     * @param id The id of the user to get
+     * @returns An observable that emits the user with the specified id
+     */
+    getUser(id: string): Observable<ICliUser | undefined>;
+}

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
      */
@@ -162,35 +162,6 @@ export declare enum CliIcon {
     Balloon = "\uD83C\uDF88",
     Gift = "\uD83C\uDF81"
 }
-export type ICliUser = {
-    /**
-     * The id of the user
-     */
-    id: string;
-    /**
-     * The name of the user
-     */
-    name: string;
-    /**
-     * The email of the user
-     */
-    email: string;
-    /**
-     * The groups the user belongs to
-     * @default []
-     */
-    groups?: string[];
-};
-export interface ICliUserSession {
-    /**
-     * The user associated with the session
-     */
-    user: ICliUser;
-    /**
-     * The data associated with the user session
-     */
-    data?: Record<string, any>;
-}
 /**
  * Options for the CLI
  */
@@ -286,6 +257,20 @@ export type CliProcessorMetadata = Record<string, any> & {
      */
     icon?: CliIcon | string;
 };
+/**
+ * Represents a state configuration for the CLI processor
+ */
+export type CliStateConfiguration = {
+    /**
+     * The initial state for the processor
+     */
+    initialState: Record<string, any>;
+    /**
+     * The store identifier for the processor, if any
+     * @remarks If the store identifier is not set, the processor command name is used
+     */
+    storeName?: string;
+};
 /**
  * Represents a log level for the CLI
  */
@@ -297,9 +282,12 @@ export declare enum CliLogLevel {
     WARN = 4,
     ERROR = 5
 }
+export type CliState = Record<string, any>;
 export declare const enums: {
     CliForegroundColor: typeof CliForegroundColor;
     CliBackgroundColor: typeof CliBackgroundColor;
     CliIcon: typeof CliIcon;
     CliLogLevel: typeof CliLogLevel;
 };
+export * from './services';
+export * from './users';

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/models/users.d.ts

@@ -0,0 +1,30 @@
+export type ICliUser = {
+    /**
+     * The id of the user
+     */
+    id: string;
+    /**
+     * The name of the user
+     */
+    name: string;
+    /**
+     * The email of the user
+     */
+    email: string;
+    /**
+     * The groups the user belongs to
+     * @default []
+     */
+    groups?: string[];
+};
+export interface ICliUserSession {
+    /**
+     * The user associated with the session
+     */
+    user: ICliUser;
+    /**
+     * The data associated with the user session
+     */
+    data?: Record<string, any>;
+}
+export type CliAddUser = Omit<ICliUser, 'id'>;

package/lib/types/CancellablePromise.d.ts

@@ -3,6 +3,6 @@ export declare class CancellablePromise<T> {
     private hasCancelled;
     private abortController;
     constructor(executor: (resolve: (value: T) => void, reject: (reason?: any) => void) => void);
-    promise: Promise<T>;
+    execute(): Promise<T>;
     cancel(): void;
 }

package/package.json

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