@qodalis/cli-core 0.0.6 → 0.0.8

package/lib/interfaces/index.d.ts

@@ -1,6 +1,6 @@
 import { Terminal } from '@xterm/xterm';
 import { Observable, Subject } from 'rxjs';
-import { CliBackgroundColor, CliForegroundColor, CliOptions, CliProcessCommand, ICliUser, ICliUserSession } from '../models';
+import { CliBackgroundColor, CliForegroundColor, CliOptions, CliProcessCommand, CliProcessorMetadata, ICliUser, ICliUserSession } from '../models';
 export interface ICliCommandAuthor {
     /**
      * The name of the author
@@ -41,9 +41,9 @@ export interface ICliCommandProcessor {
      */
     version?: string;
     /**
-     * If true, the processor is sealed and cannot be extended
+     * The metadata for the command processor
      */
-    sealed?: boolean;
+    metadata?: CliProcessorMetadata;
     /**
      * Processors that are nested under this processor
      */
@@ -189,7 +189,7 @@ export interface ICliTerminalWriter {
      * @param objects The objects to write to the table
      * @returns void
      */
-    writeObjectArrayTable(objects: any[]): void;
+    writeObjectsAsTable(objects: any[]): void;
     /**
      * Write a table to the terminal
      * @param headers The headers of the table
@@ -216,7 +216,19 @@ export interface ICliProgressBar {
  * 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
  */
@@ -226,12 +238,17 @@ export interface ICliPercentageProgressBar extends ICliProgressBar {
      * @param progress The progress to update to
      * @returns void
      */
-    update: (progress: number) => 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
@@ -281,6 +298,45 @@ export interface ICliCommandExecutorService {
      */
     unregisterProcessor(processor: ICliCommandProcessor): void;
 }
+export interface ICliExecutionProcess {
+    /**
+     * Indicates if the process has exited
+     */
+    exited?: boolean;
+    /**
+     * The exit code of the process
+     */
+    exitCode?: number;
+    /**
+     * Indicates if the process is running
+     */
+    running: boolean;
+    /**
+     * The data of the process
+     */
+    data: string | undefined;
+    /**
+     * Exit the process
+     * @param code The exit code
+     * @returns void
+     */
+    exit: (code?: number) => void;
+    /**
+     * Output data from the process
+     * @param data The data to output
+     */
+    output(data: string): void;
+    /**
+     * Start the process
+     * @returns void
+     */
+    start: () => void;
+    /**
+     * End the process
+     * @returns void
+     */
+    end: () => void;
+}
 /**
  * Represents the context in which a command is executed
  */
@@ -329,6 +385,15 @@ export interface ICliExecutionContext {
      * 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;
+    /**
+     * The process to use for exiting the CLI
+     */
+    process: ICliExecutionProcess;
 }
 /**
  * Represents a data store for storing data associated with commands
@@ -375,12 +440,16 @@ export interface ICliUsersStoreService {
      * Gets the current users
      * @returns An observable that emits the current users
      */
-    getUsers(): Observable<ICliUser[]>;
+    getUsers(options?: {
+        query?: string;
+        skip?: number;
+        take?: number;
+    }): Observable<ICliUser[]>;
     /**
-     * Sets the current users
-     * @param users The users to set
+     * Creates a user
+     * @param user The user to create
      */
-    setUsers(users: ICliUser[]): Promise<void>;
+    createUser(user: Omit<ICliUser, 'id'>): Promise<ICliUser>;
     /**
      * Gets a user by id
      * @param id The id of the user to get

package/lib/models/index.d.ts

@@ -4,6 +4,10 @@ export type CliProcessCommand = {
      * The command that was entered
      */
     command: string;
+    /**
+     * The data that was entered
+     */
+    data?: string;
     /**
      * The chain of commands that were entered
      */
@@ -42,7 +46,123 @@ export declare enum CliBackgroundColor {
     Cyan = "\u001B[46m",
     White = "\u001B[47m"
 }
-export interface ICliUser extends Record<string, any> {
+export declare enum CliIcon {
+    CheckIcon = "\u2714",
+    CrossIcon = "\u2718",
+    InfoIcon = "\u2139",
+    WarningIcon = "\u26A0",
+    QuestionMark = "?",
+    Exclamation = "\u2757",
+    Ellipsis = "\u2026",
+    Dot = "\u2022",
+    Bullet = "\u2023",
+    ArrowRight = "\u2192",
+    ArrowLeft = "\u2190",
+    ArrowUp = "\u2191",
+    ArrowDown = "\u2193",
+    ArrowRightFilled = "\u25B6",
+    ArrowLeftFilled = "\u25C0",
+    ArrowUpFilled = "\u25B2",
+    ArrowDownFilled = "\u25BC",
+    DoubleArrowRight = "\u00BB",
+    DoubleArrowLeft = "\u00AB",
+    Star = "\u2605",
+    StarEmpty = "\u2606",
+    Plus = "+",
+    Minus = "-",
+    Progress = "\u23F3",
+    Success = "\u2705",
+    Failure = "\u274C",
+    Clock = "\u23F0",
+    Timer = "\u23F1",
+    Alarm = "\uD83D\uDD14",
+    Calendar = "\uD83D\uDCC5",
+    Folder = "\uD83D\uDCC1",
+    FolderOpen = "\uD83D\uDCC2",
+    File = "\uD83D\uDCC4",
+    Archive = "\uD83D\uDDC3",
+    Link = "\uD83D\uDD17",
+    Chain = "\u26D3",
+    Bookmark = "\uD83D\uDD16",
+    Edit = "\u270F",
+    Trash = "\uD83D\uDDD1",
+    Add = "\u2795",
+    Remove = "\u2796",
+    Reload = "\uD83D\uDD04",
+    Save = "\uD83D\uDCBE",
+    Undo = "\u21A9",
+    Redo = "\u21AA",
+    Play = "\u25B6",
+    Pause = "\u23F8",
+    Stop = "\u23F9",
+    Cancel = "\u274E",
+    User = "\uD83D\uDC64",
+    Group = "\uD83D\uDC65",
+    Lock = "\uD83D\uDD12",
+    Unlock = "\uD83D\uDD13",
+    Help = "\u2753",
+    Key = "\uD83D\uDD11",
+    Shield = "\uD83D\uDEE1",
+    Gear = "\u2699",
+    Settings = "\u2699\uFE0F",
+    Theme = "\uD83C\uDFA8",
+    Light = "\uD83D\uDCA1",
+    Bug = "\uD83D\uDC1E",
+    Wrench = "\uD83D\uDD27",
+    Hammer = "\uD83D\uDD28",
+    Terminal = "\uD83D\uDCBB",
+    Database = "\uD83D\uDDC4",
+    Server = "\uD83D\uDDA5",
+    Cloud = "\u2601",
+    Network = "\uD83C\uDF10",
+    Monitor = "\uD83D\uDDA5",
+    Printer = "\uD83D\uDDA8",
+    USB = "\uD83D\uDD0C",
+    Speaker = "\uD83D\uDD0A",
+    Microphone = "\uD83C\uDF99",
+    Camera = "\uD83D\uDCF7",
+    Video = "\uD83C\uDFA5",
+    Music = "\uD83C\uDFB5",
+    Phone = "\uD83D\uDCDE",
+    Package = "\uD83D\uDCE6",
+    Plugin = "\uD83D\uDD0C",
+    Extension = "\uD83E\uDDE9",
+    Module = "\uD83D\uDCE6",
+    Evaluate = "\uD83D\uDD0D",
+    Variable = "\uD83D\uDD27",
+    Script = "\uD83D\uDCDC",
+    Code = "\uD83D\uDCBE",
+    Logs = "\uD83D\uDCDC",
+    Power = "\u23FB",
+    Heart = "\u2764",
+    Flame = "\uD83D\uDD25",
+    Growth = "\uD83D\uDCC8",
+    Decline = "\uD83D\uDCC9",
+    WarningFilled = "\u26A0\uFE0F",
+    Sun = "\u2600",
+    Moon = "\uD83C\uDF19",
+    Rain = "\uD83C\uDF27",
+    Snow = "\u2744",
+    Lightning = "\u26A1",
+    Tree = "\uD83C\uDF32",
+    Smile = "\uD83D\uDE0A",
+    Sad = "\uD83D\uDE22",
+    Angry = "\uD83D\uDE21",
+    Clap = "\uD83D\uDC4F",
+    ThumbsUp = "\uD83D\uDC4D",
+    ThumbsDown = "\uD83D\uDC4E",
+    Rocket = "\uD83D\uDE80",
+    Globe = "\uD83C\uDF0D",
+    Medal = "\uD83C\uDFC5",
+    Trophy = "\uD83C\uDFC6",
+    Flag = "\uD83D\uDEA9",
+    StarFilled = "\u2B50",
+    StarOutline = "\u2729",
+    Fireworks = "\uD83C\uDF86",
+    Balloon = "\uD83C\uDF88",
+    Gift = "\uD83C\uDF81"
+}
+export type ICliUser = {
     /**
      * The id of the user
      */
@@ -55,7 +175,12 @@ export interface ICliUser extends Record<string, any> {
      * 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
@@ -69,15 +194,29 @@ export interface ICliUserSession {
 /**
  * Options for the CLI
  */
-export type CliOptions = {
+export type CliOptions = Record<string, any> & {
     /**
      * The welcome message to display when the CLI starts
      */
     welcomeMessage?: string;
     /**
-     * Hide the prompt to display when the CLI is ready to accept input
+     * If true, the welcome message is hidden
+     * @default false
+     */
+    hideWelcomeMessage?: boolean;
+    /**
+     * Users module options
      */
-    hideUserName?: boolean;
+    usersModule?: {
+        /**
+         * If true, the users module is enabled
+         */
+        enabled: boolean;
+        /**
+         * Hide the prompt to display when the CLI is ready to accept input
+         */
+        hideUserName?: boolean;
+    };
     /**
      * Custom terminal options
      */
@@ -108,3 +247,29 @@ export interface Package {
      */
     dependencies?: Package[];
 }
+/**
+ * Represents command processor metadata
+ */
+export type CliProcessorMetadata = Record<string, any> & {
+    /**
+     * If true, the processor is sealed and cannot be extended
+     */
+    sealed?: boolean;
+    /**
+     * If true, the processor requires the server to be running
+     */
+    requireServer?: boolean;
+    /**
+     * The module the processor belongs to
+     */
+    module?: string;
+    /**
+     * An icon to display for the processor
+     */
+    icon?: CliIcon | string;
+};
+export declare const enums: {
+    CliForegroundColor: typeof CliForegroundColor;
+    CliBackgroundColor: typeof CliBackgroundColor;
+    CliIcon: typeof CliIcon;
+};

package/lib/types/CancellablePromise.d.ts

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

package/lib/types/index.d.ts

@@ -0,0 +1 @@
+export * from './CancellablePromise';

package/lib/utils/index.d.ts

@@ -1,11 +1,13 @@
 import { ICliCommandParameterDescriptor } from '../interfaces';
 import { CliBackgroundColor } from '../models';
+import { ObjectDescriber } from './object-describer';
 export declare const getParameterValue: (p: ICliCommandParameterDescriptor, args: Record<string, any>) => any | undefined;
 export declare const formatJson: (json: any) => string;
 export declare const colorizeJson: (jsonString: any) => string;
 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 declare const utils: {
     getParameterValue: (p: ICliCommandParameterDescriptor, args: Record<string, any>) => any | undefined;
     formatJson: (json: any) => string;
@@ -13,4 +15,5 @@ export declare const utils: {
     toQueryString: (params: Record<string, any>) => string;
     highlightTextWithBg: (text: string, pattern: RegExp, bgColor?: CliBackgroundColor) => string;
     getRightOfWord: (command: string, word: string) => string | undefined;
+    ObjectDescriber: typeof ObjectDescriber;
 };

package/lib/utils/object-describer.d.ts

@@ -0,0 +1,12 @@
+import { ICliCommandProcessor } from '../interfaces';
+export declare class ObjectDescriber {
+    static describe(obj: any, options?: {
+        filter?: (o: {
+            funcName: string;
+            func: any;
+            args: string[];
+        }) => boolean;
+    }): ICliCommandProcessor[];
+    static supportsDynamicArgs(func: any): boolean;
+    static getFunctionArguments(func: any): string[];
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@qodalis/cli-core",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Core Angular CLI for @qodalis extensions.",
   "author": "Nicolae Lupei, Qodalis Solutions",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/qodalis-solutions/qodalis-angular-cli"
+    "url": "https://github.com/qodalis-solutions/angular-web-cli"
   },
   "homepage": "https://qodalis.com",
   "keywords": [

package/public-api.d.ts

@@ -3,3 +3,4 @@ export * from './lib/interfaces';
 export * from './lib/modules';
 export * from './lib/utils';
 export * from './lib/constants';
+export * from './lib/types';