import type { ConfigSchema } from "./src/schema";

/**
 * Declares a global scope for the types defined in this file.
 */
declare global {
	var buildMode: boolean | undefined;
	var config: Config | undefined;
	var testMode: boolean | undefined;
}
/**
 * Represents the arguments for the build command.
 * @property {string} source - The source directory or file to build.
 * @property {string} destination - The destination directory to write the build output.
 * @property {boolean} silent - Indicates whether the build process should run silently, without producing any output.
 * @property {boolean} verbose - Indicates whether the build process should output detailed information about the process to the console.
 */
export type BuildCommandArgs = {
	destination: string;
	silent: boolean;
	source: string;
	test: boolean;
	verbose: boolean;
};

/**
 * Represents the options for the build command.
 * @property {boolean} [silent] - Indicates whether the build process should run silently, without producing any output.
 * @property {boolean} [verbose] - Indicates whether the build process should output detailed information about the process to the console.
 * @property {boolean} [test] - Indicates that the build process should only test the process, without writing any files.
 */
export type BuildCommandOptions = {
	silent?: boolean;
	verbose?: boolean;
	test?: boolean;
};

/**
 * Represents the configuration object for the application, derived from the configSchema type.
 */
export type Config = Prettify<ConfigSchema>;

/**
 * Represents the options for combining documentation.
 * @property {boolean} silent - Indicates whether the build process should run silently, without producing any output.
 * @property {boolean} verbose - Indicates whether the build process should output detailed information about the process to the console.
 * @property {boolean} test - Indicates that the build process should only test the process, without writing any files.
 */
export type CombineDocumentationOptions = {
	silent: boolean;
	verbose: boolean;
	test: boolean;
};

/**
 * Represents the arguments for a guided command, which has no additional arguments.
 */
export type GuidedCommandArgs = Record<string, never>;

/**
 * Represents the arguments for the init command.
 * @property {boolean} silent - Indicates whether the init process should run silently, without producing any output.
 * @property {boolean} verbose - Indicates whether the init process should output detailed information about the process to the console.
 */
export type InitCommandArgs = {
	configFile: string;
	force: boolean;
	silent: boolean;
	verbose: boolean;
};

/**
 * Represents the options for the init command.
 * @property {boolean} [silent] - Indicates whether the init process should run silently, without producing any output.
 * @property {boolean} [verbose] - Indicates whether the init process should output detailed information about the process to the console.
 * @property {boolean} [force] - Indicates whether the init process should force the operation, even if it would overwrite existing files.
 */
export type InitCommandOptions = {
	configFileName: string;
	force?: boolean;
	silent?: boolean;
	verbose?: boolean;
};

/**
 * Represents a logging function that can be used to log messages at different log levels.
 *
 * The `LogFunction` type has the following properties:
 * - `(level: keyof typeof logLevels, message: string): void` - A function that can be called to log a message at the specified log level.
 * - `options: LogOptions` - An object that contains options for controlling the logging behavior.
 * - `debug(message: string): void` - A convenience function for logging a debug-level message.
 * - `error(message: string): void` - A convenience function for logging an error-level message.
 * - `info(message: string): void` - A convenience function for logging an info-level message.
 * - `verbose(message: string): void` - A convenience function for logging a verbose-level message.
 * - `warn(message: string): void` - A convenience function for logging a warning-level message.
 */
type LogFunction = {
	(level: keyof typeof logLevels, message: string, options: LogOptions): void;
	options: LogOptions;
	debug: (message: string) => void;
	error: (message: string) => void;
	info: (message: string) => void;
	verbose: (message: string) => void;
	warn: (message: string) => void;
};

/**
 * Represents the different log levels that can be used for logging.
 * - `"error"`: Indicates an error condition that should be logged.
 * - `"warn"`: Indicates a warning condition that should be logged.
 * - `"info"`: Indicates an informational message that should be logged.
 * - `"verbose"`: Indicates a verbose message that should be logged.
 * - `"debug"`: Indicates a debug-level message that should be logged.
 */
export type LogLevel = "error" | "warn" | "info" | "verbose" | "debug";

/**
 * Represents the options for logging.
 * @property {boolean} silent - Indicates whether logging should be silent, without producing any output.
 * @property {boolean} verbose - Indicates whether logging should output detailed information.
 */
export type LogOptions = {
	silent: boolean;
	verbose: boolean;
};

/**
 * Prettifies a type `T` by creating a new type with the same properties as `T`, but with the `unknown` type added to the intersection.
 * This can be useful for creating a type that has the same shape as another type, but with additional properties or constraints.
 *
 * @template T The type to be prettified.
 * @returns A new type with the same properties as `T`, but with the `unknown` type added to the intersection.
 */
export type Prettify<T> = {
	[K in keyof T]: T[K];
} & unknown;