Extended commands api

.prettierrc

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

core/package.json

@@ -11,7 +11,8 @@
     "extract-api": "api-extractor run --local --typescript-compiler-folder node_modules/typescript"
   },
   "dependencies": {
-    "@consy/declarations": "workspace:*"
+    "@consy/declarations": "workspace:*",
+    "@consy/utilities": "workspace:*"
   },
   "devDependencies": {
     "@consy/configs": "workspace:*",

core/src/core.ts → core/src/consy.ts

@@ -2,7 +2,7 @@ import { CommandDefinition, InteractiveObject } from '@consy/declarations';
 import { Acessor } from './accessor';
 import { InteractiveObjectBuilder } from './interactive-object-builder';
 
-export class Core<K extends string> {
+export class Consy<K extends string = string> {
   readonly #interactor: InteractiveObjectBuilder = new InteractiveObjectBuilder();
 
   readonly #accessor: Acessor<InteractiveObject, K> = new Acessor<InteractiveObject, K>(window);
@@ -13,19 +13,23 @@ export class Core<K extends string> {
     this.#key = key;
   }
 
-  public mount(): void {
+  public mount(): this {
     this.#accessor.mount(this.#key, this.#interactor.payload);
+    return this;
   }
 
-  public unmount(): void {
+  public unmount(): this {
     this.#accessor.unmount(this.#key);
+    return this;
   }
 
-  public addCommand(command: CommandDefinition): void {
+  public addCommand(command: CommandDefinition): this {
     this.#interactor.addCommand(command);
+    return this;
   }
 
-  public removeCommand(name: string): void {
+  public removeCommand(name: string): this {
     this.#interactor.removeCommand(name);
+    return this;
   }
 }

core/src/index.ts

@@ -1 +1 @@
-export * from './core';
+export * from './consy';

core/src/interactive-object-builder.ts

@@ -1,25 +1,35 @@
 import { CallableCommand, CommandDefinition, InteractiveObject } from '@consy/declarations';
+import { getValidatedParameterizableCommandParams, isParameterizableCommand } from '@consy/utilities';
 import { Acessor } from './accessor';
 
 export class InteractiveObjectBuilder {
-  readonly #payload: InteractiveObject = {};
-  readonly #accessor: Acessor<CallableCommand> = new Acessor<CallableCommand>(this.#payload);
+  readonly #payload: InteractiveObject;
+  readonly #accessor: Acessor<CallableCommand>;
 
   public get payload(): InteractiveObject {
     return this.#payload;
   }
 
-  public addCommand(command: CommandDefinition): void {
-    const collableCommand: CallableCommand = () => {
-      const commandResult: void | Promise<void> = command.callback();
+  constructor() {
+    this.#payload = Object.setPrototypeOf({}, null);
+    this.#accessor = new Acessor<CallableCommand>(this.#payload);
+  }
+
+  public addCommand(commandDefinition: CommandDefinition): void {
+    const collableCommand: CallableCommand = (...callParams: unknown[]) => {
+      const commandResult: void | Promise<void> = commandDefinition.callback(
+        isParameterizableCommand(commandDefinition)
+          ? getValidatedParameterizableCommandParams({ commandDefinition, callParams })
+          : {}
+      );
 
-      const onDoneMessage: string = `Command ${command.name} is executed.`;
+      const onDoneMessage: string = `Command ${commandDefinition.name} is executed.`;
       commandResult instanceof Promise
         ? commandResult.finally(() => console.log(onDoneMessage))
         : console.log(onDoneMessage);
     };
 
-    this.#accessor.mount(command.name, collableCommand);
+    this.#accessor.mount(commandDefinition.name, collableCommand);
   }
 
   public removeCommand(name: string): void {

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.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/command-params.ts

@@ -0,0 +1,15 @@
+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<D extends CommandParamsDefinition = CommandParamsDefinition> = {
+  [K in keyof D]: CommandParamDefinitionType<D[K]> extends CommandParamType.String
+    ? string
+    : CommandParamDefinitionType<D[K]> extends CommandParamType.Toggle
+      ? boolean
+      : CommandParamDefinitionType<D[K]> extends CommandParamType.Select
+        ? string[]
+        : never;
+};

declarations/src/index.ts

@@ -1,3 +1,9 @@
 export * from './callable-command';
 export * from './command-definition';
 export * from './interactive-object';
+export * from './parameterizable-command';
+export * from './non-parameterizable-command';
+export * from './command-param-definition';
+export * from './command-param-type';
+export * from './command-params';
+export * from './command-params-definition';

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-params';
+import { CommandParamsDefinition } from './command-params-definition';
+
+export interface ParameterizableCommand<D extends CommandParamsDefinition = CommandParamsDefinition>
+  extends CommandDefinitionBase<(params: CommandParams<D>) => void> {
+  readonly params: D;
+}

dist/package.json

@@ -28,5 +28,6 @@
     "prettier": "catalog:codebase",
     "@microsoft/api-extractor": "catalog:build-tools"
   },
-  "typings": "src/index.ts"
+  "typings": "src/index.ts",
+  "main": "src/index.ts"
 }

dist/src/index.ts

@@ -1,2 +1,7 @@
-export { Core } from '@consy/core';
-export { CommandDefinition } from '@consy/declarations';
+export { Consy } from '@consy/core';
+export {
+  CommandDefinition,
+  CommandParamType,
+  NonParameterizableCommand,
+  ParameterizableCommand
+} from '@consy/declarations';

examples/.gitignore

@@ -0,0 +1 @@
+serve/

examples/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@consy/examples",
+  "private": true,
+  "scripts": {
+    "compiler__run": "pnpm run compiler__run:build && pnpm run compiler__run:scripts",
+    "compiler__check": "pnpm run compiler__check:build && pnpm run compiler__check:scripts",
+    "compiler__run:build": "tsc --project tsconfig.build.json",
+    "compiler__check:build": "tsc --project tsconfig.build.json --noEmit",
+    "compiler__run:scripts": "tsc --project tsconfig.scripts.json",
+    "compiler__check:scripts": "tsc --project tsconfig.scripts.json --noEmit",
+    "formatter__check": "prettier --config node_modules/@consy/configs/prettier/config.json --ignore-path node_modules/@consy/configs/prettier/ignore --cache --cache-location .prettiercache --cache-strategy content --check .",
+    "formatter__fix": "prettier --config node_modules/@consy/configs/prettier/config.json --ignore-path node_modules/@consy/configs/prettier/ignore --cache --cache-location .prettiercache --cache-strategy content --write .",
+    "start": "ts-node --project tsconfig.scripts.json ./start.script.ts"
+  },
+  "dependencies": {
+    "consy": "workspace:*",
+    "tailwindcss": "catalog:build-tools"
+  },
+  "devDependencies": {
+    "@consy/configs": "workspace:*",
+    "typescript": "catalog:codebase",
+    "ts-node": "catalog:build-tools",
+    "esbuild": "catalog:build-tools",
+    "@types/node": "catalog:build-tools",
+    "prettier": "catalog:codebase"
+  }
+}

examples/src/index.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

examples/src/index.html

@@ -0,0 +1,18 @@
+<!doctype html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width"
+    />
+
+    <link
+      rel="stylesheet"
+      href="./index.css"
+    />
+  </head>
+
+  <body class="bg-[#ff0103]"></body>
+</html>