@elsikora/commitizen-plugin-commitlint-ai 1.2.0 → 2.0.0-dev.1

package/dist/cjs/application/interface/commit-validator.interface.d.ts

@@ -0,0 +1,30 @@
+import type { CommitMessage } from "../../domain/entity/commit-message.entity.js";
+import type { ILlmPromptContext } from "./llm-service.interface.js";
+/**
+ * Validation result for a commit message
+ */
+export interface ICommitValidationResult {
+    errors?: Array<string>;
+    isValid: boolean;
+    warnings?: Array<string>;
+}
+/**
+ * Interface for commit message validators
+ */
+export interface ICommitValidator {
+    /**
+     * Attempt to fix a commit message based on validation errors
+     * @param message - The commit message to fix
+     * @param validationResult - The validation result containing errors
+     * @param context - Optional original context (diff, files, etc.) for better fixing
+     * @returns Promise resolving to the fixed commit message or null if unfixable
+     */
+    fix(message: CommitMessage, validationResult: ICommitValidationResult, context?: ILlmPromptContext): Promise<CommitMessage | null>;
+    /**
+     * Validate a commit message
+     * @param message - The commit message to validate
+     * @returns Promise resolving to the validation result
+     */
+    validate(message: CommitMessage): Promise<ICommitValidationResult>;
+}
+//# sourceMappingURL=commit-validator.interface.d.ts.map

package/dist/cjs/application/interface/commit-validator.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit-validator.interface.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/commit-validator.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAElF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEnI;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACnE"}

package/dist/cjs/application/interface/config-service.interface.d.ts

@@ -0,0 +1,48 @@
+import type { IConfig } from "./config.interface.js";
+import type { IFileSystemService } from "./file-system-service.interface.js";
+/**
+ * Interface for managing application configuration.
+ * Defines contract for reading, writing, and manipulating configuration settings.
+ */
+export interface IConfigService {
+    /**
+     * Checks if the configuration exists.
+     * @returns Promise resolving to true if the configuration exists, false otherwise
+     */
+    exists(): Promise<boolean>;
+    /**
+     * File system service for file operations.
+     */
+    FILE_SYSTEM_SERVICE: IFileSystemService;
+    /**
+     * Retrieves the current configuration.
+     * @returns Promise resolving to the configuration object
+     */
+    get(): Promise<IConfig>;
+    /**
+     * Gets a specific property from the configuration.
+     * @param property - The property key to retrieve
+     * @returns Promise resolving to the value of the specified property
+     */
+    getProperty<K extends keyof IConfig>(property: K): Promise<IConfig[K]>;
+    /**
+     * Merges partial configuration with the existing configuration.
+     * @param partial - Partial configuration to merge
+     * @returns Promise that resolves when the merged configuration is saved
+     */
+    merge(partial: Partial<IConfig>): Promise<void>;
+    /**
+     * Saves the entire configuration.
+     * @param config - The complete configuration to save
+     * @returns Promise that resolves when the configuration is saved
+     */
+    set(config: IConfig): Promise<void>;
+    /**
+     * Sets a specific property in the configuration.
+     * @param property - The property key to set
+     * @param value - The value to assign to the property
+     * @returns Promise that resolves when the updated configuration is saved
+     */
+    setProperty<K extends keyof IConfig>(property: K, value: IConfig[K]): Promise<void>;
+}
+//# sourceMappingURL=config-service.interface.d.ts.map

package/dist/cjs/application/interface/config-service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-service.interface.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/config-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE3B;;OAEG;IACH,mBAAmB,EAAE,kBAAkB,CAAC;IAExC;;;OAGG;IACH,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpF"}

package/dist/cjs/application/interface/config.interface.d.ts

@@ -0,0 +1,28 @@
+import type { ECommitMode } from "../../domain/enum/commit-mode.enum.js";
+import type { ELLMProvider } from "../../domain/enum/llm-provider.enum.js";
+/**
+ * Main configuration interface
+ */
+export interface IConfig {
+    /**
+     * Number of retries for LLM generation
+     */
+    maxRetries?: number;
+    /**
+     * Commit mode (auto, manual)
+     */
+    mode: ECommitMode;
+    /**
+     * Model to use
+     */
+    model?: string;
+    /**
+     * LLM provider (openai, anthropic)
+     */
+    provider: ELLMProvider;
+    /**
+     * Number of retries for validation fixes
+     */
+    validationMaxRetries?: number;
+}
+//# sourceMappingURL=config.interface.d.ts.map

package/dist/cjs/application/interface/config.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.interface.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/config.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC9B"}

package/dist/cjs/application/interface/file-system-service.interface.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Interface for file system operations.
+ * Provides methods for reading, writing, and managing files and directories.
+ */
+export interface IFileSystemService {
+    /**
+     * Creates a directory at the specified path.
+     * @param path - The path to the directory to create
+     * @param options - Optional configuration for directory creation
+     * @param options.isRecursive - Whether to create parent directories if they don't exist
+     * @returns Promise that resolves when the directory is created
+     */
+    createDirectory(path: string, options?: {
+        isRecursive: boolean;
+    }): Promise<void>;
+    /**
+     * Deletes a file at the specified path.
+     * @param path - The path to the file to delete
+     * @returns Promise that resolves when the file is deleted
+     */
+    deleteFile(path: string): Promise<void>;
+    /**
+     * Gets the directory name from a file path.
+     * @param filePath
+     * @returns The directory name
+     */
+    getDirectoryNameFromFilePath(filePath: string): string;
+    /**
+     * Gets the extension from a file path.
+     * @param filePath
+     * @returns The file extension
+     */
+    getExtensionFromFilePath(filePath: string): string;
+    /**
+     * Checks if any of the provided paths exist and returns the first existing path.
+     * @param paths - Array of paths to check
+     * @returns Promise that resolves to the first existing path or undefined if none exist
+     */
+    isOneOfPathsExists(paths: Array<string>): Promise<string | undefined>;
+    /**
+     * Checks if a file or directory exists at the specified path.
+     * @param path - The path to check
+     * @returns Promise that resolves to true if the path exists, false otherwise
+     */
+    isPathExists(path: string): Promise<boolean>;
+    /**
+     * Reads the contents of a file.
+     * @param path - The path to the file to read
+     * @param encoding - The encoding to use when reading the file, defaults to "utf8"
+     * @returns Promise that resolves to the file contents as a string
+     */
+    readFile(path: string, encoding?: BufferEncoding): Promise<string>;
+    /**
+     * Writes content to a file, creating the file and parent directories if they don't exist.
+     * @param path - The path to the file to write
+     * @param content - The content to write to the file
+     * @param encoding - The encoding to use when writing the file, defaults to "utf8"
+     * @returns Promise that resolves when the file is written
+     */
+    writeFile(path: string, content: string, encoding?: BufferEncoding): Promise<void>;
+}
+//# sourceMappingURL=file-system-service.interface.d.ts.map

package/dist/cjs/application/interface/file-system-service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system-service.interface.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/file-system-service.interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,4BAA4B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvD;;;;OAIG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnD;;;;OAIG;IACH,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEtE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C;;;;;OAKG;IAEH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnE;;;;;;OAMG;IAEH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnF"}

package/dist/cjs/application/interface/index.d.ts

@@ -0,0 +1,10 @@
+export type * from "./cli-interface-service-select-options.interface.js";
+export type * from "./cli-interface-service.interface.js";
+export type * from "./command-service.interface.js";
+export type * from "./commit-repository.interface.js";
+export type * from "./commit-validator.interface.js";
+export type * from "./config-service.interface.js";
+export type * from "./config.interface.js";
+export type * from "./file-system-service.interface.js";
+export type * from "./llm-service.interface.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/application/interface/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,qDAAqD,CAAC;AACzE,mBAAmB,sCAAsC,CAAC;AAC1D,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,kCAAkC,CAAC;AACtD,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,uBAAuB,CAAC;AAC3C,mBAAmB,oCAAoC,CAAC;AACxD,mBAAmB,4BAA4B,CAAC"}

package/dist/cjs/application/interface/llm-service.interface.d.ts

@@ -0,0 +1,44 @@
+import type { CommitMessage } from "../../domain/entity/commit-message.entity.js";
+import type { LLMConfiguration } from "../../domain/entity/llm-configuration.entity.js";
+/**
+ * Context for generating commit messages
+ */
+export interface ILlmPromptContext {
+    body?: {
+        description?: string;
+    };
+    diff?: string;
+    files?: string;
+    rules?: Record<string, unknown>;
+    scopeDescription?: string;
+    subject: {
+        description?: string;
+        maxLength?: number;
+        minLength?: number;
+    };
+    typeDescription?: string;
+    typeDescriptions?: Record<string, {
+        description: string;
+        emoji?: string;
+    }>;
+    typeEnum?: Array<string>;
+}
+/**
+ * Interface for LLM services
+ */
+export interface ILlmService {
+    /**
+     * Generate a commit message using the LLM
+     * @param context - The context for generating the commit message
+     * @param configuration - The LLM configuration
+     * @returns Promise resolving to the generated commit message
+     */
+    generateCommitMessage(context: ILlmPromptContext, configuration: LLMConfiguration): Promise<CommitMessage>;
+    /**
+     * Check if the service supports the given configuration
+     * @param configuration - The LLM configuration to check
+     * @returns True if the service supports the configuration
+     */
+    supports(configuration: LLMConfiguration): boolean;
+}
+//# sourceMappingURL=llm-service.interface.d.ts.map

package/dist/cjs/application/interface/llm-service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"llm-service.interface.d.ts","sourceRoot":"","sources":["../../../../src/application/interface/llm-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B;;;;;OAKG;IACH,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE3G;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,gBAAgB,GAAG,OAAO,CAAC;CACnD"}

package/dist/cjs/application/use-case/configure-llm.use-case.d.ts

@@ -0,0 +1,39 @@
+import type { ECommitMode } from "../../domain/enum/commit-mode.enum.js";
+import type { ICliInterfaceService } from "../interface/cli-interface-service.interface.js";
+import type { IConfigService } from "../interface/config-service.interface.js";
+import { LLMConfiguration } from "../../domain/entity/llm-configuration.entity.js";
+/**
+ * Use case for configuring LLM settings
+ */
+export declare class ConfigureLLMUseCase {
+    private readonly CLI_INTERFACE;
+    private readonly CONFIG_SERVICE;
+    constructor(configService: IConfigService, cliInterface: ICliInterfaceService);
+    /**
+     * Configure LLM settings interactively
+     * @returns Promise resolving to the new configuration
+     */
+    configureInteractively(): Promise<LLMConfiguration>;
+    /**
+     * Get the current LLM configuration
+     * @returns Promise resolving to the current configuration or null if not configured
+     */
+    getCurrentConfiguration(): Promise<LLMConfiguration | null>;
+    /**
+     * Check if the current configuration needs LLM details
+     * @returns Promise resolving to true if LLM details are needed
+     */
+    needsLLMDetails(): Promise<boolean>;
+    /**
+     * Save LLM configuration
+     * @param configuration - The configuration to save
+     */
+    saveConfiguration(configuration: LLMConfiguration): Promise<void>;
+    /**
+     * Update the commit mode
+     * @param mode - The new commit mode
+     * @returns Promise resolving to the updated configuration
+     */
+    updateMode(mode: ECommitMode): Promise<LLMConfiguration | null>;
+}
+//# sourceMappingURL=configure-llm.use-case.d.ts.map

package/dist/cjs/application/use-case/configure-llm.use-case.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure-llm.use-case.d.ts","sourceRoot":"","sources":["../../../../src/application/use-case/configure-llm.use-case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAI/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAC;AAUnF;;GAEG;AACH,qBAAa,mBAAmB;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAuB;IAErD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;gBAEpC,aAAa,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB;IAK7E;;;OAGG;IACG,sBAAsB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IA6RzD;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAyFjE;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAwBzC;;;OAGG;IACG,iBAAiB,CAAC,aAAa,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvE;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;CAYrE"}