Extended commands api

.prettierrc

@@ -0,0 +1 @@
+"@consy/configs/prettier/config.json"

core/src/interactive-object-builder.ts

@@ -11,7 +11,7 @@ export class InteractiveObjectBuilder {
 
   public addCommand(command: CommandDefinition): void {
     const collableCommand: CallableCommand = () => {
-      const commandResult: void | Promise<void> = command.callback();
+      const commandResult: void | Promise<void> = command.callback({} as any);
 
       const onDoneMessage: string = `Command ${command.name} is executed.`;
       commandResult instanceof Promise

declarations/src/command-definition-base.ts

@@ -0,0 +1,9 @@
+import { AnyFunction } from './any-function';
+import { SyncOrAsyncFunction } from './sync-or-async-function';
+
+export interface CommandDefinitionBase<C extends AnyFunction> {
+  readonly name: string;
+  readonly description: string;
+
+  readonly callback: SyncOrAsyncFunction<C>;
+}

declarations/src/command-definition.ts

@@ -1,11 +1,4 @@
-import { AnyFunction } from './any-function';
-import { SyncOrAsyncFunction } from './sync-or-async-function';
+import { NonParameterizableCommand } from './non-parameterizable-command';
+import { ParameterizableCommand } from './parameterizable-command';
 
-interface CommandDefinitionBase<C extends AnyFunction> {
-  name: string;
-  description: string;
-
-  callback: SyncOrAsyncFunction<C>;
-}
-
-export type CommandDefinition = CommandDefinitionBase<() => void>;
+export type CommandDefinition = NonParameterizableCommand | ParameterizableCommand;

declarations/src/command-param-definition-base.ts

@@ -0,0 +1,5 @@
+import { CommandParamType } from './command-param-type';
+
+export interface CommandParamDefinitionBase<T extends CommandParamType = CommandParamType> {
+  readonly type: T;
+}

declarations/src/command-param-definition-type.ts

@@ -0,0 +1,14 @@
+import { CommandParamDefinitionBase } from './command-param-definition-base';
+import { CommandParamType } from './command-param-type';
+import { CommandParamsDefinition } from './command-params-definition';
+
+type CommandParamDefinitionType<T extends CommandParamDefinitionBase> = T['type'];
+export type CommandParams<P extends CommandParamsDefinition = CommandParamsDefinition> = {
+  [K in keyof P]: CommandParamDefinitionType<P[K]> extends CommandParamType.String
+    ? string
+    : CommandParamDefinitionType<P[K]> extends CommandParamType.Toggle
+      ? boolean
+      : CommandParamDefinitionType<P[K]> extends CommandParamType.Select
+        ? string[]
+        : never;
+};

declarations/src/command-param-definition.ts

@@ -0,0 +1,21 @@
+import { CommandParamDefinitionBase } from './command-param-definition-base';
+import { CommandParamType } from './command-param-type';
+
+type StringParamDefinition = CommandParamDefinitionBase<CommandParamType.String>;
+
+interface ToggleParamDefinition extends CommandParamDefinitionBase<CommandParamType.Toggle> {
+  readonly isEnabledByDefault: boolean;
+}
+
+interface SelectParamDefinition extends CommandParamDefinitionBase<CommandParamType.Select> {
+  readonly isMultipleChoiceAllowed: boolean;
+  readonly options: ReadonlyArray<string>;
+}
+
+export type CommandParamDefinition<T extends CommandParamType = CommandParamType> = T extends CommandParamType.String
+  ? StringParamDefinition
+  : T extends CommandParamType.Toggle
+    ? ToggleParamDefinition
+    : T extends CommandParamType.Select
+      ? SelectParamDefinition
+      : never;

declarations/src/command-param-type.ts

@@ -0,0 +1,5 @@
+export enum CommandParamType {
+  String = 'string',
+  Toggle = 'toggle',
+  Select = 'select'
+}

declarations/src/command-params-definition.ts

@@ -0,0 +1,5 @@
+import { CommandParamDefinition } from './command-param-definition';
+
+export interface CommandParamsDefinition {
+  readonly [key: string]: CommandParamDefinition;
+}

declarations/src/non-parameterizable-command.ts

@@ -0,0 +1,3 @@
+import { CommandDefinitionBase } from './command-definition-base';
+
+export type NonParameterizableCommand = CommandDefinitionBase<() => void>;

declarations/src/parameterizable-command.ts

@@ -0,0 +1,8 @@
+import { CommandDefinitionBase } from './command-definition-base';
+import { CommandParams } from './command-param-definition-type';
+import { CommandParamsDefinition } from './command-params-definition';
+
+export interface ParameterizableCommand<P extends CommandParamsDefinition = CommandParamsDefinition>
+  extends CommandDefinitionBase<(params: CommandParams<P>) => void> {
+  readonly params: P;
+}