bob-core 1.3.13 → 2.0.0-beta.1

package/dist/cjs/src/Logger.d.ts

@@ -0,0 +1,17 @@
+export type LogLevel = 'debug' | 'verbose' | 'info' | 'warn' | 'error' | 'silent';
+export type LoggerOptions = {
+    level?: LogLevel;
+};
+export declare class Logger {
+    private level;
+    constructor(opts?: LoggerOptions);
+    private shouldLog;
+    setLevel(level: LogLevel): void;
+    getLevel(): LogLevel;
+    log(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    debug(...args: any[]): void;
+    verbose(...args: any[]): void;
+}

package/dist/cjs/src/commands/HelpCommand.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '../Command.js';
 import { CommandRegistry } from '../CommandRegistry.js';
+import { Command } from '../Command.js';
 export type HelpCommandOptions = {
     commandRegistry: CommandRegistry;
     cliName?: string;
@@ -7,8 +7,6 @@ export type HelpCommandOptions = {
 };
 export default class HelpCommand extends Command {
     private opts;
-    signature: string;
-    description: string;
     constructor(opts: HelpCommandOptions);
-    protected handle(): Promise<void>;
+    handle(): Promise<void>;
 }

package/dist/cjs/src/contracts/CommandOption.d.ts

@@ -1,7 +1,6 @@
-export interface CommandOption<C> {
+import { OptionDefinition } from '../lib/types.js';
+import { Command } from '../Command.js';
+export interface CommandOption<C extends Command> extends OptionDefinition {
     option: string;
-    alias?: string[];
-    defaultValue: string | boolean | Array<string> | null;
-    description?: string;
     handler(this: C): Promise<number | void>;
 }

package/dist/cjs/src/contracts/LoggerContract.d.ts

@@ -0,0 +1,14 @@
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'verbose';
+/**
+ * Logger interface defining standard logging methods and level management
+ */
+export interface LoggerContract {
+    log(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
+    verbose(message: string, ...args: any[]): void;
+    setLevel(level: LogLevel): void;
+    getLevel(): LogLevel;
+}

package/dist/cjs/src/contracts/index.d.ts

@@ -1 +1,2 @@
 export * from './CommandOption.js';
+export * from './LoggerContract.js';

package/dist/cjs/src/errors/BadCommandOption.d.ts

@@ -7,5 +7,5 @@ export type OptionProps = {
 export declare class BadCommandOption extends BobError {
     readonly param: OptionProps;
     constructor(param: OptionProps);
-    pretty(): void;
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/BadCommandParameter.d.ts

@@ -7,5 +7,5 @@ export type ParameterProps = {
 export declare class BadCommandParameter extends BobError {
     readonly param: ParameterProps;
     constructor(param: ParameterProps);
-    pretty(): void;
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/BobError.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from '../Logger.js';
 export declare abstract class BobError extends Error {
-    abstract pretty(): void;
+    abstract pretty(logger: Logger): void;
 }

package/dist/cjs/src/errors/CommandNotFoundError.d.ts

@@ -2,5 +2,5 @@ import { BobError } from './BobError.js';
 export declare class CommandNotFoundError extends BobError {
     readonly command: string;
     constructor(command: string);
-    pretty(): void;
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/InvalidOption.d.ts

@@ -1,8 +1,8 @@
 import { BobError } from './BobError.js';
-import { ArgSignature } from '../CommandParser.js';
+import { OptionsSchema } from '../lib/types.js';
 export declare class InvalidOption extends BobError {
     private option;
-    private optionsSignature;
-    constructor(option: string, optionsSignature: ArgSignature[]);
-    pretty(): void;
+    private optionsSchema;
+    constructor(option: string, optionsSchema?: OptionsSchema);
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/MissingRequiredArgumentValue.d.ts

@@ -1,7 +1,6 @@
 import { BobError } from './BobError.js';
-import { ArgSignature } from '../CommandParser.js';
 export declare class MissingRequiredArgumentValue extends BobError {
-    readonly paramSignature: ArgSignature;
-    constructor(paramSignature: ArgSignature);
-    pretty(): void;
+    readonly argument: string;
+    constructor(argument: string);
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/MissingRequiredOptionValue.d.ts

@@ -0,0 +1,6 @@
+import { BobError } from './BobError.js';
+export declare class MissingRequiredOptionValue extends BobError {
+    readonly option: string;
+    constructor(option: string);
+    pretty(io: any): void;
+}

package/dist/cjs/src/errors/MissingSignatureArgument.d.ts

@@ -1,8 +1,8 @@
 import { BobError } from './BobError.js';
-import { ArgSignature } from '../CommandParser.js';
+import { OptionsSchema } from '../lib/types.js';
 export declare class MissingSignatureArgument extends BobError {
     private argument;
-    private argumentSignatures;
-    constructor(argument: string, argumentSignatures: ArgSignature[]);
-    pretty(): void;
+    private argumentsSchema;
+    constructor(argument: string, argumentsSchema: OptionsSchema);
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/MissingSignatureOption.d.ts

@@ -1,8 +1,8 @@
 import { BobError } from './BobError.js';
-import { ArgSignature } from '../CommandParser.js';
+import { OptionsSchema } from '../lib/types.js';
 export declare class MissingSignatureOption extends BobError {
     private option;
-    private optionsSignature;
-    constructor(option: string, optionsSignature: ArgSignature[]);
-    pretty(): void;
+    private optionsSchema;
+    constructor(option: string, optionsSchema: OptionsSchema);
+    pretty(io: any): void;
 }

package/dist/cjs/src/errors/index.d.ts

@@ -1,3 +1,9 @@
 export * from './BobError.js';
 export * from './BadCommandParameter.js';
 export * from './BadCommandOption.js';
+export * from './InvalidOption.js';
+export * from './CommandNotFoundError.js';
+export * from './MissingSignatureArgument.js';
+export * from './MissingSignatureOption.js';
+export * from './MissingRequiredArgumentValue.js';
+export * from './MissingRequiredOptionValue.js';

package/dist/cjs/src/index.d.ts

@@ -1,6 +1,12 @@
 export * from './Command.js';
+export * from './CommandWithSignature.js';
 export * from './CommandIO.js';
+export * from './CommandParser.js';
+export * from './CommandSignatureParser.js';
+export * from './CommandRegistry.js';
 export * from './Cli.js';
+export * from './Logger.js';
+export * from './ExceptionHandler.js';
+export * from './lib/types.js';
 export * from './errors/index.js';
-export * from './contracts/index.js';
 export * from './options/index.js';

package/dist/cjs/src/lib/optionHelpers.d.ts

@@ -0,0 +1,5 @@
+import { Option, OptionDefinition, OptionReturnType } from './types.js';
+export declare function getOptionPrimitiveDefaultValue<Opts extends Option>(type: Opts): OptionReturnType<Opts>;
+export declare function getOptionDefaultValue<Opts extends Option>(option: Opts): OptionReturnType<Opts>;
+export type OptionDetails = Required<OptionDefinition>;
+export declare function getOptionDetails(option: Option): OptionDetails;

package/dist/cjs/src/lib/types.d.ts

@@ -0,0 +1,29 @@
+export type OptionPrimitive = 'string' | 'number' | 'boolean' | ['string'] | ['number'];
+export type OptionDefinition = {
+    type: OptionPrimitive;
+    description?: string;
+    alias?: string | Array<string>;
+    required?: boolean;
+    default?: any;
+    variadic?: boolean;
+};
+export type Option = OptionPrimitive | OptionDefinition;
+export type OptionType<O extends Option> = O extends 'string' ? string : O extends 'number' ? number : O extends 'boolean' ? boolean : O extends Array<'string'> ? Array<string> : O extends Array<'number'> ? Array<number> : O extends {
+    type: infer T extends Option;
+} ? OptionType<T> : never;
+export type IsRequired<O extends Option> = O extends {
+    required: true;
+} ? true : false;
+export type OptionReturnType<O extends Option> = IsRequired<O> extends true ? OptionType<O> : OptionType<O> | null;
+export type OptionsSchema = {
+    [key: string]: Option;
+};
+export type OptionsObject<Options extends OptionsSchema> = {
+    [Key in keyof Options]: OptionReturnType<Options[Key]>;
+};
+export type ArgumentsSchema = {
+    [key: string]: Option;
+};
+export type ArgumentsObject<Arguments extends ArgumentsSchema> = {
+    [Key in keyof Arguments]: OptionReturnType<Arguments[Key]>;
+};

package/dist/cjs/src/lib/valueConverter.d.ts

@@ -0,0 +1,10 @@
+import { OptionPrimitive } from './types.js';
+/**
+ * Converts a value to the specified type with validation
+ * @param value - The value to convert
+ * @param type - The target type
+ * @param name - The parameter name (for error messages)
+ * @param defaultValue - Optional default value if value is null/undefined
+ * @returns The converted value
+ */
+export declare function convertValue(value: any, type: OptionPrimitive, name: string, defaultValue?: any): any;

package/dist/cjs/src/options/HelpOption.d.ts

@@ -1,9 +1,11 @@
-import { Command } from '../Command.js';
 import { CommandOption } from '../contracts/index.js';
+import { Command } from '../Command.js';
+import { OptionPrimitive } from '../lib/types.js';
 export declare class HelpOption implements CommandOption<Command> {
+    type: OptionPrimitive;
     option: string;
     alias: string[];
-    defaultValue: boolean;
+    default: boolean;
     description: string;
     handler(this: Command): Promise<number | void>;
 }

package/dist/cjs/src/testFixtures.d.ts

@@ -0,0 +1,11 @@
+import { Mocked } from 'vitest';
+import { Logger } from './Logger.js';
+export type TestLogger = Mocked<Logger>;
+export declare function newTestLogger(): TestLogger;
+/**
+ * Creates test fixtures with a mocked logger
+ * @returns Object containing mocked logger instance
+ */
+export declare function newFixtures(): {
+    logger: TestLogger;
+};