@moostjs/event-cli 0.3.22 → 0.3.24

package/README.md

@@ -54,4 +54,4 @@ Here are some basic steps to get you started:
 
 Don't hesitate to ask for help if you need it. We believe in fostering a friendly and respectful environment for all contributors.
 
-Thank you for your interest in Moostjs. We look forward to building something amazing together!
+Thank you for your interest in Moostjs. We look forward to building something amazing together!

package/dist/index.cjs

@@ -7,6 +7,30 @@ function getCliMate() {
     return moost.getMoostMate();
 }
 
+function Cli(path) {
+    return getCliMate().decorate('handlers', { path: path?.replace(/\s+/g, '/'), type: 'CLI' }, true);
+}
+function CliAlias(alias) {
+    return getCliMate().decorate('cliAliases', alias, true);
+}
+function CliExample(cmd, description) {
+    return getCliMate().decorate('cliExamples', { cmd, description }, true);
+}
+
+function formatParams(keys) {
+    const names = [keys].flat();
+    return names.map(n => (n.length === 1 ? `-${n}` : `--${n}`));
+}
+
+function CliOption(...keys) {
+    const mate = getCliMate();
+    return mate.apply(mate.decorate('cliOptionsKeys', keys, false), moost.Resolve(() => eventCli.useCliOption(keys[0]), formatParams(keys).join(', ')));
+}
+function CliGlobalOption(option) {
+    const mate = getCliMate();
+    return mate.decorate('cliOptions', option, true);
+}
+
 const LOGGER_TITLE = 'moost-cli';
 const CONTEXT_TYPE = 'CLI';
 class MoostCli {
@@ -33,7 +57,7 @@ class MoostCli {
         }
     }
     async onNotFound() {
-        const pathParams = eventCli.useCliContext().store('event').get('pathParams');
+        const pathParams = eventCli.useCliContext().store('event').get('pathParams') || [];
         const response = await moost.defineMoostEventHandler({
             loggerTitle: LOGGER_TITLE,
             getIterceptorHandler: () => this.moost?.getGlobalInterceptorHandler(),
@@ -41,15 +65,14 @@ class MoostCli {
             callControllerMethod: () => undefined,
             logErrors: this.opts?.debug,
         })();
-        if (typeof response === 'undefined') {
+        if (response === undefined) {
             this.cliApp.onUnknownCommand(pathParams);
         }
         return response;
     }
     onInit(moost) {
         this.moost = moost;
-        const boolean = Object
-            .entries(this.optionTypes)
+        const boolean = Object.entries(this.optionTypes)
             .filter(([_key, val]) => val.length === 1 && val[0] === Boolean)
             .map(([key, _val]) => key);
         void this.cliApp.run(undefined, {
@@ -59,8 +82,9 @@ class MoostCli {
     bindHandler(opts) {
         let fn;
         for (const handler of opts.handlers) {
-            if (handler.type !== 'CLI')
+            if (handler.type !== 'CLI') {
                 continue;
+            }
             const path = typeof handler.path === 'string'
                 ? handler.path
                 : typeof opts.method === 'string'
@@ -89,12 +113,16 @@ class MoostCli {
             [
                 ...(this.opts?.globalCliOptions?.length ? this.opts.globalCliOptions : []),
                 ...(classMeta?.cliOptions || []),
-                ...(meta?.params ? meta.params.filter((param) => param.cliOptionsKeys?.length > 0).map((param) => ({
-                    keys: param.cliOptionsKeys,
-                    value: typeof param.value === 'string' ? param.value : '',
-                    description: param.description || '',
-                    type: param.type,
-                })) : []),
+                ...(meta?.params
+                    ? meta.params
+                        .filter((param) => param.cliOptionsKeys.length > 0)
+                        .map((param) => ({
+                        keys: param.cliOptionsKeys,
+                        value: typeof param.value === 'string' ? param.value : '',
+                        description: param.description || '',
+                        type: param.type,
+                    }))
+                    : []),
             ].forEach(o => cliOptions.set(o.keys[0], o));
             const aliases = [];
             if (meta?.cliAliases) {
@@ -109,14 +137,15 @@ class MoostCli {
                     if (!this.optionTypes[key]) {
                         this.optionTypes[key] = [];
                     }
-                    if (!(this.optionTypes[key].includes(o.type))) {
+                    if (!this.optionTypes[key].includes(o.type)) {
                         this.optionTypes[key].push(o.type);
                     }
                 }
             });
             const args = {};
-            meta?.params?.filter(p => p.paramSource === 'ROUTE' && p.description)
-                .forEach(p => args[p.paramName] = p.description);
+            meta?.params
+                .filter(p => p.paramSource === 'ROUTE' && p.description)
+                .forEach(p => (args[p.paramName] = p.description));
             const routerBinding = this.cliApp.cli(targetPath, {
                 description: meta?.description || '',
                 options: cliOptionsArray,
@@ -137,52 +166,26 @@ class MoostCli {
 }
 const aliasTypes = ['CLI', 'CLI-alias', 'CLI-alias*', 'CLI-alias*'];
 
-function formatParams(keys) {
-    const names = [keys].flat();
-    return names.map((n) => (n.length === 1 ? '-' + n : '--' + n));
-}
-
-function CliOption(...keys) {
-    const mate = getCliMate();
-    return mate.apply(mate.decorate('cliOptionsKeys', keys, false), moost.Resolve(() => eventCli.useCliOption(keys[0]), formatParams(keys).join(', ')));
-}
-function CliGlobalOption(option) {
-    const mate = getCliMate();
-    return mate.decorate('cliOptions', option, true);
-}
-
-function Cli(path) {
-    return getCliMate().decorate('handlers', { path: path?.replace(/\s+/g, '/'), type: 'CLI' }, true);
-}
-function CliAlias(alias) {
-    return getCliMate().decorate('cliAliases', alias, true);
-}
-function CliExample(cmd, description) {
-    return getCliMate().decorate('cliExamples', { cmd, description }, true);
-}
-
-const cliHelpInterceptor = (opts) => {
-    return moost.defineInterceptorFn(() => {
-        try {
-            if (eventCli.useAutoHelp(opts?.helpOptions, opts?.colors)) {
-                return '';
-            }
-        }
-        catch (e) {
+const cliHelpInterceptor = (opts) => moost.defineInterceptorFn(() => {
+    try {
+        if (eventCli.useAutoHelp(opts?.helpOptions, opts?.colors)) {
+            return '';
         }
-        if (opts?.lookupLevel) {
-            const { getMethod } = moost.useControllerContext();
-            if (!getMethod()) {
-                eventCli.useCommandLookupHelp(opts.lookupLevel);
-            }
+    }
+    catch (error) {
+    }
+    if (opts?.lookupLevel) {
+        const { getMethod } = moost.useControllerContext();
+        if (!getMethod()) {
+            eventCli.useCommandLookupHelp(opts.lookupLevel);
         }
-    }, moost.TInterceptorPriority.BEFORE_ALL);
-};
+    }
+}, moost.TInterceptorPriority.BEFORE_ALL);
 const CliHelpInterceptor = (...opts) => moost.Intercept(cliHelpInterceptor(...opts));
 
 Object.defineProperty(exports, "useCliContext", {
-    enumerable: true,
-    get: function () { return eventCli.useCliContext; }
+  enumerable: true,
+  get: function () { return eventCli.useCliContext; }
 });
 exports.Cli = Cli;
 exports.CliAlias = CliAlias;

package/dist/index.d.ts

@@ -1,7 +1,77 @@
-import * as moost from 'moost';
-import { TMoostAdapter, Moost, TMoostAdapterOptions } from 'moost';
 import { WooksCli, TWooksCliOptions } from '@wooksjs/event-cli';
 export { useCliContext } from '@wooksjs/event-cli';
+import * as moost from 'moost';
+import { TMoostAdapter, Moost, TMoostAdapterOptions } from 'moost';
+
+/**
+ * ## 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;
+
+/**
+ * ## 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;
 
 type TFunction = Function;
 
@@ -20,11 +90,11 @@ interface TMoostCliOpts {
     /**
      * Array of cli options applicable to every cli command
      */
-    globalCliOptions?: {
+    globalCliOptions?: Array<{
         keys: string[];
         description?: string;
         type?: TFunction;
-    }[];
+    }>;
 }
 /**
  * ## Moost Cli Adapter
@@ -67,76 +137,6 @@ declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
     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
  *

package/dist/index.mjs

@@ -1,11 +1,35 @@
-import { getMoostMate, getMoostInfact, defineMoostEventHandler, Resolve, defineInterceptorFn, useControllerContext, TInterceptorPriority, Intercept } from 'moost';
-import { WooksCli, createCliApp, useCliContext, useCliOption, useAutoHelp, useCommandLookupHelp } from '@wooksjs/event-cli';
+import { getMoostMate, Resolve, getMoostInfact, defineMoostEventHandler, defineInterceptorFn, useControllerContext, TInterceptorPriority, Intercept } from 'moost';
+import { useCliOption, WooksCli, createCliApp, useCliContext, useAutoHelp, useCommandLookupHelp } from '@wooksjs/event-cli';
 export { useCliContext } from '@wooksjs/event-cli';
 
 function getCliMate() {
     return getMoostMate();
 }
 
+function Cli(path) {
+    return getCliMate().decorate('handlers', { path: path?.replace(/\s+/g, '/'), type: 'CLI' }, true);
+}
+function CliAlias(alias) {
+    return getCliMate().decorate('cliAliases', alias, true);
+}
+function CliExample(cmd, description) {
+    return getCliMate().decorate('cliExamples', { cmd, description }, true);
+}
+
+function formatParams(keys) {
+    const names = [keys].flat();
+    return names.map(n => (n.length === 1 ? `-${n}` : `--${n}`));
+}
+
+function CliOption(...keys) {
+    const mate = getCliMate();
+    return mate.apply(mate.decorate('cliOptionsKeys', keys, false), Resolve(() => useCliOption(keys[0]), formatParams(keys).join(', ')));
+}
+function CliGlobalOption(option) {
+    const mate = getCliMate();
+    return mate.decorate('cliOptions', option, true);
+}
+
 const LOGGER_TITLE = 'moost-cli';
 const CONTEXT_TYPE = 'CLI';
 class MoostCli {
@@ -32,7 +56,7 @@ class MoostCli {
         }
     }
     async onNotFound() {
-        const pathParams = useCliContext().store('event').get('pathParams');
+        const pathParams = useCliContext().store('event').get('pathParams') || [];
         const response = await defineMoostEventHandler({
             loggerTitle: LOGGER_TITLE,
             getIterceptorHandler: () => this.moost?.getGlobalInterceptorHandler(),
@@ -40,15 +64,14 @@ class MoostCli {
             callControllerMethod: () => undefined,
             logErrors: this.opts?.debug,
         })();
-        if (typeof response === 'undefined') {
+        if (response === undefined) {
             this.cliApp.onUnknownCommand(pathParams);
         }
         return response;
     }
     onInit(moost) {
         this.moost = moost;
-        const boolean = Object
-            .entries(this.optionTypes)
+        const boolean = Object.entries(this.optionTypes)
             .filter(([_key, val]) => val.length === 1 && val[0] === Boolean)
             .map(([key, _val]) => key);
         void this.cliApp.run(undefined, {
@@ -58,8 +81,9 @@ class MoostCli {
     bindHandler(opts) {
         let fn;
         for (const handler of opts.handlers) {
-            if (handler.type !== 'CLI')
+            if (handler.type !== 'CLI') {
                 continue;
+            }
             const path = typeof handler.path === 'string'
                 ? handler.path
                 : typeof opts.method === 'string'
@@ -88,12 +112,16 @@ class MoostCli {
             [
                 ...(this.opts?.globalCliOptions?.length ? this.opts.globalCliOptions : []),
                 ...(classMeta?.cliOptions || []),
-                ...(meta?.params ? meta.params.filter((param) => param.cliOptionsKeys?.length > 0).map((param) => ({
-                    keys: param.cliOptionsKeys,
-                    value: typeof param.value === 'string' ? param.value : '',
-                    description: param.description || '',
-                    type: param.type,
-                })) : []),
+                ...(meta?.params
+                    ? meta.params
+                        .filter((param) => param.cliOptionsKeys.length > 0)
+                        .map((param) => ({
+                        keys: param.cliOptionsKeys,
+                        value: typeof param.value === 'string' ? param.value : '',
+                        description: param.description || '',
+                        type: param.type,
+                    }))
+                    : []),
             ].forEach(o => cliOptions.set(o.keys[0], o));
             const aliases = [];
             if (meta?.cliAliases) {
@@ -108,14 +136,15 @@ class MoostCli {
                     if (!this.optionTypes[key]) {
                         this.optionTypes[key] = [];
                     }
-                    if (!(this.optionTypes[key].includes(o.type))) {
+                    if (!this.optionTypes[key].includes(o.type)) {
                         this.optionTypes[key].push(o.type);
                     }
                 }
             });
             const args = {};
-            meta?.params?.filter(p => p.paramSource === 'ROUTE' && p.description)
-                .forEach(p => args[p.paramName] = p.description);
+            meta?.params
+                .filter(p => p.paramSource === 'ROUTE' && p.description)
+                .forEach(p => (args[p.paramName] = p.description));
             const routerBinding = this.cliApp.cli(targetPath, {
                 description: meta?.description || '',
                 options: cliOptionsArray,
@@ -136,47 +165,21 @@ class MoostCli {
 }
 const aliasTypes = ['CLI', 'CLI-alias', 'CLI-alias*', 'CLI-alias*'];
 
-function formatParams(keys) {
-    const names = [keys].flat();
-    return names.map((n) => (n.length === 1 ? '-' + n : '--' + n));
-}
-
-function CliOption(...keys) {
-    const mate = getCliMate();
-    return mate.apply(mate.decorate('cliOptionsKeys', keys, false), Resolve(() => useCliOption(keys[0]), formatParams(keys).join(', ')));
-}
-function CliGlobalOption(option) {
-    const mate = getCliMate();
-    return mate.decorate('cliOptions', option, true);
-}
-
-function Cli(path) {
-    return getCliMate().decorate('handlers', { path: path?.replace(/\s+/g, '/'), type: 'CLI' }, true);
-}
-function CliAlias(alias) {
-    return getCliMate().decorate('cliAliases', alias, true);
-}
-function CliExample(cmd, description) {
-    return getCliMate().decorate('cliExamples', { cmd, description }, true);
-}
-
-const cliHelpInterceptor = (opts) => {
-    return defineInterceptorFn(() => {
-        try {
-            if (useAutoHelp(opts?.helpOptions, opts?.colors)) {
-                return '';
-            }
-        }
-        catch (e) {
+const cliHelpInterceptor = (opts) => defineInterceptorFn(() => {
+    try {
+        if (useAutoHelp(opts?.helpOptions, opts?.colors)) {
+            return '';
         }
-        if (opts?.lookupLevel) {
-            const { getMethod } = useControllerContext();
-            if (!getMethod()) {
-                useCommandLookupHelp(opts.lookupLevel);
-            }
+    }
+    catch (error) {
+    }
+    if (opts?.lookupLevel) {
+        const { getMethod } = useControllerContext();
+        if (!getMethod()) {
+            useCommandLookupHelp(opts.lookupLevel);
         }
-    }, TInterceptorPriority.BEFORE_ALL);
-};
+    }
+}, TInterceptorPriority.BEFORE_ALL);
 const CliHelpInterceptor = (...opts) => Intercept(cliHelpInterceptor(...opts));
 
 export { Cli, CliAlias, CliExample, CliGlobalOption, CliHelpInterceptor, CliOption, MoostCli, cliHelpInterceptor };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/event-cli",
-  "version": "0.3.22",
+  "version": "0.3.24",
   "description": "@moostjs/event-cli",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -38,9 +38,9 @@
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-cli#readme",
   "peerDependencies": {},
   "dependencies": {
-    "moost": "0.3.22",
-    "wooks": "^0.4.24",
-    "@wooksjs/event-core": "^0.4.24",
-    "@wooksjs/event-cli": "^0.4.24"
+    "moost": "0.3.24",
+    "wooks": "^0.4.29",
+    "@wooksjs/event-core": "^0.4.29",
+    "@wooksjs/event-cli": "^0.4.29"
   }
 }