@moostjs/event-cli 0.3.10 → 0.3.12

package/dist/index.d.ts

@@ -1,219 +1,208 @@
-import { Moost } from 'moost';
-import { TInterceptorFn } from 'moost';
-import { TMoostAdapter } from 'moost';
-import { TMoostAdapterOptions } from 'moost';
-import { TWooksCliOptions } from '@wooksjs/event-cli';
-import { useCliContext } from '@wooksjs/event-cli';
-import { WooksCli } from '@wooksjs/event-cli';
-
-/**
- * ## Define CLI Command
- * ### @MethodDecorator
- *
- * Command path segments may be separated by / or space.
- *
- * For example the folowing path are interpreted the same:
- * - "command test use:dev :name"
- * - "command/test/use:dev/:name"
- *
- * Where name will become an argument
- *
- * @param path - command path
- * @returns
- */
-export declare function Cli(path?: string): MethodDecorator;
-
-/**
- * ## Define CLI Command Alias
- * ### @MethodDecorator
- *
- * Use it to define alias for @Cli('...') command
- *
- * @param path - command alias path
- * @returns
- */
-export declare function CliAlias(alias: string): MethodDecorator;
-
-/**
- * ## Define CLI Example
- * ### @MethodDecorator
- *
- * Use it to define example for Cli Help display
- *
- * @param path - command alias path
- * @returns
- */
-export declare function CliExample(cmd: string, description?: string): MethodDecorator;
-
-/**
- * ## Define Global CLI Option
- * ### @ClassDecorator
- * The option described here will appear in every command instructions
- * @param option keys and description of CLI option
- * @returns
- */
-export declare function CliGlobalOption(option: {
-    keys: string[];
-    description?: string;
-    value?: string;
-}): ClassDecorator;
-
-/**
- * ## @Decorator
- * ### Interceptor Factory for CliHelpRenderer
- *
- * By default intercepts cli calls with flag --help
- * and prints help.
- *
- * ```ts
- * // default configuration
- * • @CliHelpInterceptor({ helpOptions: 'help', colors: true })
- *
- * // additional option -h to invoke help renderer
- * • @CliHelpInterceptor({ helpOptions: ['help', 'h'], colors: true })
- *
- * // redefine cli option to invoke help renderer
- * • @CliHelpInterceptor({ helpOptions: ['usage'] })
- * ```
- *
- * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
- * @returns Decorator
- */
-export declare const CliHelpInterceptor: (opts?: {
-    /**
-     * CLI Options that invoke help
-     * ```js
-     * helpOptions: ['help', 'h']
-     * ```
-     */
-    helpOptions?: string[] | undefined;
-    /**
-     * Enable colored help
-     */
-    colors?: boolean | undefined;
-    /**
-     * Enable lookup for a command
-     */
-    lookupLevel?: number | undefined;
-} | undefined) => ClassDecorator & MethodDecorator;
-
-/**
- * ### Interceptor Factory for CliHelpRenderer
- *
- * By default intercepts cli calls with flag --help
- * and prints help.
- *
- * ```js
- * new Moost().applyGlobalInterceptors(cliHelpInterceptor({ colors: true }))
- * ```
- * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
- * @returns TInterceptorFn
- */
-export declare const cliHelpInterceptor: (opts?: {
-    /**
-     * CLI Options that invoke help
-     * ```js
-     * helpOptions: ['help', 'h']
-     * ```
-     */
-    helpOptions?: string[];
-    /**
-     * Enable colored help
-     */
-    colors?: boolean;
-    /**
-     * Enable lookup for a command
-     */
-    lookupLevel?: number;
-}) => TInterceptorFn;
-
-/**
- * ## Define CLI Option
- * ### @ParameterDecorator
- * Use together with @Description('...') to document cli option
- *
- * ```ts
- * │   @Cli('command')
- * │   command(
- * │      @Description('Test option...')
- * │      @CliOption('test', 't')
- * │      test: boolean,
- * │   ) {
- * │       return `test=${ test }`
- * │   }
- * ```
- *
- * @param keys list of keys (short and long alternatives)
- * @returns
- */
-export declare function CliOption(...keys: string[]): ParameterDecorator;
-
-/**
- * ## Moost Cli Adapter
- *
- * Moost Adapter for CLI events
- *
- * ```ts
- * │  // Quick example
- * │  import { MoostCli, Cli, CliOption, cliHelpInterceptor } from '@moostjs/event-cli'
- * │  import { Moost, Param } from 'moost'
- * │
- * │  class MyApp extends Moost {
- * │      @Cli('command/:arg')
- * │      command(
- * │         @Param('arg')
- * │         arg: string,
- * │         @CliOption('test', 't')
- * │         test: boolean,
- * │      ) {
- * │          return `command run with flag arg=${ arg }, test=${ test }`
- * │      }
- * │  }
- * │
- * │  const app = new MyApp()
- * │  app.applyGlobalInterceptors(cliHelpInterceptor())
- * │
- * │  const cli = new MoostCli()
- * │  app.adapter(cli)
- * │  app.init()
- * ```
- */
-export declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
-    protected opts?: TMoostCliOpts | undefined;
-    protected cliApp: WooksCli;
-    protected optionTypes: Record<string, TFunction[]>;
-    constructor(opts?: TMoostCliOpts | undefined);
-    onNotFound(): Promise<unknown>;
-    protected moost?: Moost;
-    onInit(moost: Moost): void;
-    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TCliHandlerMeta, T>): void;
-}
-
-export declare interface TCliHandlerMeta {
-    path: string;
-}
-
-declare type TFunction = Function;
-
-export declare interface TMoostCliOpts {
-    /**
-     * WooksCli options or instance
-     */
-    wooksCli?: WooksCli | TWooksCliOptions;
-    /**
-     * more internal logs are printed when true
-     */
-    debug?: boolean;
-    /**
-     * Array of cli options applicable to every cli command
-     */
-    globalCliOptions?: {
-        keys: string[];
-        description?: string;
-        type?: TFunction;
-    }[];
-}
-
-export { useCliContext }
-
-export { }
+import * as moost from 'moost';
+import { TMoostAdapter, Moost, TMoostAdapterOptions } from 'moost';
+import { WooksCli, TWooksCliOptions } from '@wooksjs/event-cli';
+export { useCliContext } from '@wooksjs/event-cli';
+
+type TFunction = Function;
+
+interface TCliHandlerMeta {
+    path: string;
+}
+interface TMoostCliOpts {
+    /**
+     * WooksCli options or instance
+     */
+    wooksCli?: WooksCli | TWooksCliOptions;
+    /**
+     * more internal logs are printed when true
+     */
+    debug?: boolean;
+    /**
+     * Array of cli options applicable to every cli command
+     */
+    globalCliOptions?: {
+        keys: string[];
+        description?: string;
+        type?: TFunction;
+    }[];
+}
+/**
+ * ## Moost Cli Adapter
+ *
+ * Moost Adapter for CLI events
+ *
+ * ```ts
+ * │  // Quick example
+ * │  import { MoostCli, Cli, CliOption, cliHelpInterceptor } from '@moostjs/event-cli'
+ * │  import { Moost, Param } from 'moost'
+ * │
+ * │  class MyApp extends Moost {
+ * │      @Cli('command/:arg')
+ * │      command(
+ * │         @Param('arg')
+ * │         arg: string,
+ * │         @CliOption('test', 't')
+ * │         test: boolean,
+ * │      ) {
+ * │          return `command run with flag arg=${ arg }, test=${ test }`
+ * │      }
+ * │  }
+ * │
+ * │  const app = new MyApp()
+ * │  app.applyGlobalInterceptors(cliHelpInterceptor())
+ * │
+ * │  const cli = new MoostCli()
+ * │  app.adapter(cli)
+ * │  app.init()
+ * ```
+ */
+declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
+    protected opts?: TMoostCliOpts | undefined;
+    protected cliApp: WooksCli;
+    protected optionTypes: Record<string, TFunction[]>;
+    constructor(opts?: TMoostCliOpts | undefined);
+    onNotFound(): Promise<unknown>;
+    protected moost?: Moost;
+    onInit(moost: Moost): void;
+    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TCliHandlerMeta, T>): void;
+}
+
+/**
+ * ## Define CLI Option
+ * ### @ParameterDecorator
+ * Use together with @Description('...') to document cli option
+ *
+ * ```ts
+ * │   @Cli('command')
+ * │   command(
+ * │      @Description('Test option...')
+ * │      @CliOption('test', 't')
+ * │      test: boolean,
+ * │   ) {
+ * │       return `test=${ test }`
+ * │   }
+ * ```
+ *
+ * @param keys list of keys (short and long alternatives)
+ * @returns
+ */
+declare function CliOption(...keys: string[]): ParameterDecorator;
+/**
+ * ## Define Global CLI Option
+ * ### @ClassDecorator
+ * The option described here will appear in every command instructions
+ * @param option keys and description of CLI option
+ * @returns
+ */
+declare function CliGlobalOption(option: {
+    keys: string[];
+    description?: string;
+    value?: string;
+}): ClassDecorator;
+
+/**
+ * ## Define CLI Command
+ * ### @MethodDecorator
+ *
+ * Command path segments may be separated by / or space.
+ *
+ * For example the folowing path are interpreted the same:
+ * - "command test use:dev :name"
+ * - "command/test/use:dev/:name"
+ *
+ * Where name will become an argument
+ *
+ * @param path - command path
+ * @returns
+ */
+declare function Cli(path?: string): MethodDecorator;
+/**
+ * ## Define CLI Command Alias
+ * ### @MethodDecorator
+ *
+ * Use it to define alias for @Cli('...') command
+ *
+ * @param path - command alias path
+ * @returns
+ */
+declare function CliAlias(alias: string): MethodDecorator;
+/**
+ * ## Define CLI Example
+ * ### @MethodDecorator
+ *
+ * Use it to define example for Cli Help display
+ *
+ * @param path - command alias path
+ * @returns
+ */
+declare function CliExample(cmd: string, description?: string): MethodDecorator;
+
+/**
+ * ### Interceptor Factory for CliHelpRenderer
+ *
+ * By default intercepts cli calls with flag --help
+ * and prints help.
+ *
+ * ```js
+ * new Moost().applyGlobalInterceptors(cliHelpInterceptor({ colors: true }))
+ * ```
+ * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+ * @returns TInterceptorFn
+ */
+declare const cliHelpInterceptor: (opts?: {
+    /**
+     * CLI Options that invoke help
+     * ```js
+     * helpOptions: ['help', 'h']
+     * ```
+     */
+    helpOptions?: string[];
+    /**
+     * Enable colored help
+     */
+    colors?: boolean;
+    /**
+     * Enable lookup for a command
+     */
+    lookupLevel?: number;
+}) => moost.TInterceptorFn;
+/**
+ * ## @Decorator
+ * ### Interceptor Factory for CliHelpRenderer
+ *
+ * By default intercepts cli calls with flag --help
+ * and prints help.
+ *
+ * ```ts
+ * // default configuration
+ * • @CliHelpInterceptor({ helpOptions: 'help', colors: true })
+ *
+ * // additional option -h to invoke help renderer
+ * • @CliHelpInterceptor({ helpOptions: ['help', 'h'], colors: true })
+ *
+ * // redefine cli option to invoke help renderer
+ * • @CliHelpInterceptor({ helpOptions: ['usage'] })
+ * ```
+ *
+ * @param opts {} { helpOptions: ['help', 'h'], colors: true } cli options to invoke help renderer
+ * @returns Decorator
+ */
+declare const CliHelpInterceptor: (opts?: {
+    /**
+     * CLI Options that invoke help
+     * ```js
+     * helpOptions: ['help', 'h']
+     * ```
+     */
+    helpOptions?: string[] | undefined;
+    /**
+     * Enable colored help
+     */
+    colors?: boolean | undefined;
+    /**
+     * Enable lookup for a command
+     */
+    lookupLevel?: number | undefined;
+} | undefined) => ClassDecorator & MethodDecorator;
+
+export { Cli, CliAlias, CliExample, CliGlobalOption, CliHelpInterceptor, CliOption, MoostCli, type TCliHandlerMeta, type TMoostCliOpts, cliHelpInterceptor };