driftdetect 0.7.1 → 0.8.1

package/dist/git/hooks.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Git Hooks - Pre-commit and pre-push hook setup
+ *
+ * Provides functionality to install and manage Git hooks for Drift integration.
+ * Supports both Husky-based and direct Git hooks installation.
+ *
+ * @requirements 37.1, 37.3
+ */
+/**
+ * Hook types supported by Drift
+ */
+export type HookType = 'pre-commit' | 'pre-push';
+/**
+ * Result of a hook installation operation
+ */
+export interface HookInstallResult {
+    success: boolean;
+    hookType: HookType;
+    method: 'husky' | 'git';
+    message: string;
+    path?: string;
+}
+/**
+ * Options for hook installation
+ */
+export interface HookInstallOptions {
+    /** Force overwrite existing hooks */
+    force?: boolean;
+    /** Use Husky if available */
+    preferHusky?: boolean;
+}
+/**
+ * Check if Husky is installed and configured in the project
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns True if Husky is available
+ */
+export declare function isHuskyInstalled(rootDir: string): Promise<boolean>;
+/**
+ * Get the Git hooks directory path
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Path to the Git hooks directory
+ */
+export declare function getGitHooksDir(rootDir: string): Promise<string>;
+/**
+ * Install a pre-commit hook for Drift
+ *
+ * The pre-commit hook runs `drift check --staged` to check only staged files
+ * before allowing a commit.
+ *
+ * @param rootDir - Root directory of the repository
+ * @param options - Installation options
+ * @returns Installation result
+ *
+ * @requirements 37.1
+ */
+export declare function installPreCommitHook(rootDir: string, options?: HookInstallOptions): Promise<HookInstallResult>;
+/**
+ * Install a pre-push hook for Drift
+ *
+ * The pre-push hook runs `drift check` to perform a full check
+ * before allowing a push.
+ *
+ * @param rootDir - Root directory of the repository
+ * @param options - Installation options
+ * @returns Installation result
+ *
+ * @requirements 37.3
+ */
+export declare function installPrePushHook(rootDir: string, options?: HookInstallOptions): Promise<HookInstallResult>;
+/**
+ * Install all Drift Git hooks (pre-commit and pre-push)
+ *
+ * @param rootDir - Root directory of the repository
+ * @param options - Installation options
+ * @returns Array of installation results
+ *
+ * @requirements 37.1, 37.3
+ */
+export declare function installAllHooks(rootDir: string, options?: HookInstallOptions): Promise<HookInstallResult[]>;
+/**
+ * Uninstall a Git hook
+ *
+ * @param rootDir - Root directory of the repository
+ * @param hookType - Type of hook to uninstall
+ * @returns True if hook was removed
+ */
+export declare function uninstallHook(rootDir: string, hookType: HookType): Promise<boolean>;
+/**
+ * Uninstall all Drift Git hooks
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Object with results for each hook type
+ */
+export declare function uninstallAllHooks(rootDir: string): Promise<Record<HookType, boolean>>;
+/**
+ * Get the status of installed hooks
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Object with status for each hook type
+ */
+export declare function getHooksStatus(rootDir: string): Promise<Record<HookType, {
+    installed: boolean;
+    method?: 'husky' | 'git';
+    path?: string;
+}>>;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/git/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Git module exports
+ */
+export { getStagedFiles, getChangedFiles, getUntrackedFiles, isGitRepository, getGitRoot, } from './staged-files.js';
+export { type HookType, type HookInstallResult, type HookInstallOptions, isHuskyInstalled, getGitHooksDir, installPreCommitHook, installPrePushHook, installAllHooks, uninstallHook, uninstallAllHooks, getHooksStatus, } from './hooks.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/git/staged-files.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Staged Files - Get list of staged files from Git
+ *
+ * @requirements 37.2
+ */
+/**
+ * Get list of staged files from Git
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Array of staged file paths (relative to rootDir)
+ */
+export declare function getStagedFiles(rootDir: string): Promise<string[]>;
+/**
+ * Get list of all changed files (staged and unstaged)
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Array of changed file paths (relative to rootDir)
+ */
+export declare function getChangedFiles(rootDir: string): Promise<string[]>;
+/**
+ * Get list of untracked files
+ *
+ * @param rootDir - Root directory of the repository
+ * @returns Array of untracked file paths (relative to rootDir)
+ */
+export declare function getUntrackedFiles(rootDir: string): Promise<string[]>;
+/**
+ * Check if a path is inside a Git repository
+ *
+ * @param dirPath - Directory path to check
+ * @returns True if inside a Git repository
+ */
+export declare function isGitRepository(dirPath: string): Promise<boolean>;
+/**
+ * Get the root directory of the Git repository
+ *
+ * @param dirPath - Directory path inside the repository
+ * @returns Root directory of the Git repository
+ */
+export declare function getGitRoot(dirPath: string): Promise<string>;
+//# sourceMappingURL=staged-files.d.ts.map

package/dist/reporters/github-reporter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * GitHub Reporter - GitHub Actions annotations
+ *
+ * @requirements 30.2
+ */
+import type { Reporter, ReportData } from './types.js';
+/**
+ * GitHub Actions reporter for CI annotations
+ */
+export declare class GitHubReporter implements Reporter {
+    generate(data: ReportData): string;
+}
+//# sourceMappingURL=github-reporter.d.ts.map

package/dist/reporters/gitlab-reporter.d.ts

@@ -0,0 +1,16 @@
+/**
+ * GitLab Reporter - GitLab CI code quality format
+ *
+ * @requirements 30.3
+ */
+import type { Reporter, ReportData } from './types.js';
+/**
+ * GitLab CI reporter for code quality reports
+ *
+ * Generates reports in GitLab Code Quality format:
+ * https://docs.gitlab.com/ee/ci/testing/code_quality.html
+ */
+export declare class GitLabReporter implements Reporter {
+    generate(data: ReportData): string;
+}
+//# sourceMappingURL=gitlab-reporter.d.ts.map

package/dist/reporters/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Reporters module exports
+ */
+export * from './types.js';
+export { TextReporter } from './text-reporter.js';
+export { JsonReporter } from './json-reporter.js';
+export { GitHubReporter } from './github-reporter.js';
+export { GitLabReporter } from './gitlab-reporter.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/reporters/json-reporter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * JSON Reporter - Machine-readable JSON output
+ *
+ * @requirements 30.1
+ */
+import type { Reporter, ReportData } from './types.js';
+/**
+ * JSON reporter for machine-readable output
+ */
+export declare class JsonReporter implements Reporter {
+    generate(data: ReportData): string;
+}
+//# sourceMappingURL=json-reporter.d.ts.map

package/dist/reporters/text-reporter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Text Reporter - Human-readable text output
+ *
+ * @requirements 29.7
+ */
+import type { Reporter, ReportData } from './types.js';
+/**
+ * Text reporter for human-readable output
+ */
+export declare class TextReporter implements Reporter {
+    generate(data: ReportData): string;
+}
+//# sourceMappingURL=text-reporter.d.ts.map

package/dist/reporters/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Reporter type definitions
+ */
+import type { Violation, Pattern } from 'driftdetect-core';
+/**
+ * Summary of violations
+ */
+export interface ViolationSummary {
+    /** Total number of violations */
+    total: number;
+    /** Number of errors */
+    errors: number;
+    /** Number of warnings */
+    warnings: number;
+    /** Number of info violations */
+    infos: number;
+    /** Number of hints */
+    hints: number;
+}
+/**
+ * Data passed to reporters
+ */
+export interface ReportData {
+    /** Violations found */
+    violations: Violation[];
+    /** Summary statistics */
+    summary: ViolationSummary;
+    /** Patterns checked */
+    patterns: Pattern[];
+    /** Timestamp of the report */
+    timestamp: string;
+    /** Root directory */
+    rootDir: string;
+}
+/**
+ * Reporter interface
+ */
+export interface Reporter {
+    /** Generate a report from the data */
+    generate(data: ReportData): string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/services/boundary-scanner.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Boundary Scanner Service
+ *
+ * Scans files to detect data access patterns and boundaries.
+ * Tracks which code accesses which database tables/fields.
+ */
+import { type BoundaryStore, type BoundaryScanResult } from 'driftdetect-core';
+export interface BoundaryScannerConfig {
+    rootDir: string;
+    verbose?: boolean;
+}
+export declare class BoundaryScanner {
+    private config;
+    private store;
+    constructor(config: BoundaryScannerConfig);
+    initialize(): Promise<void>;
+    scanFiles(files: string[]): Promise<BoundaryScanResult>;
+    getStore(): BoundaryStore;
+}
+export declare function createBoundaryScanner(config: BoundaryScannerConfig): BoundaryScanner;
+//# sourceMappingURL=boundary-scanner.d.ts.map

package/dist/services/contract-scanner.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Contract Scanner Service
+ *
+ * Scans backend and frontend files to detect API contracts
+ * and identify mismatches between what backend returns and
+ * what frontend expects.
+ */
+import { type ExtractedEndpoint, type ExtractedApiCall } from 'driftdetect-detectors';
+import { ContractStore, type Contract } from 'driftdetect-core';
+export interface ContractScannerConfig {
+    rootDir: string;
+    verbose?: boolean;
+}
+export interface ContractScanResult {
+    contracts: Contract[];
+    unmatchedBackend: ExtractedEndpoint[];
+    unmatchedFrontend: ExtractedApiCall[];
+    stats: {
+        backendEndpoints: number;
+        frontendCalls: number;
+        matchedContracts: number;
+        mismatches: number;
+    };
+    duration: number;
+}
+export declare class ContractScanner {
+    private config;
+    private store;
+    constructor(config: ContractScannerConfig);
+    initialize(): Promise<void>;
+    scanFiles(files: string[]): Promise<ContractScanResult>;
+    getStore(): ContractStore;
+}
+export declare function createContractScanner(config: ContractScannerConfig): ContractScanner;
+//# sourceMappingURL=contract-scanner.d.ts.map

package/dist/types/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * CLI type exports
+ */
+export interface CLIOptions {
+    /** Enable verbose output */
+    verbose?: boolean;
+    /** Output format */
+    format?: 'text' | 'json' | 'github' | 'gitlab';
+    /** CI mode */
+    ci?: boolean;
+    /** Check only staged files */
+    staged?: boolean;
+}
+export interface CheckResult {
+    /** Number of violations */
+    violationCount: number;
+    /** Number of errors */
+    errorCount: number;
+    /** Number of warnings */
+    warningCount: number;
+    /** Exit code */
+    exitCode: number;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/ui/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * UI module exports
+ *
+ * Provides CLI UI components for interactive prompts, spinners,
+ * tables, and progress bars.
+ */
+export { confirmPrompt, inputPrompt, selectPrompt, multiSelectPrompt, promptPatternAction, promptBatchPatternApproval, promptSeverity, promptVariantReason, promptVariantScope, promptInitOptions, promptIgnoreReason, promptReportFormat, promptCategorySelection, type PatternChoice, type PatternAction, type VariantScope, type InitPromptResult, type ReportFormat, } from './prompts.js';
+export { Spinner, createSpinner, withSpinner, spinners, status, type SpinnerOptions, } from './spinner.js';
+export { createTable, formatSeverity, formatConfidence, formatCount, formatPath, createPatternsTable, createViolationsTable, createSummaryTable, createStatusTable, createCategoryTable, type TableStyle, type TableOptions, type PatternRow, type ViolationRow, type SummaryRow, type StatusSummary, type CategoryBreakdown, } from './table.js';
+export { Progress, MultiProgress, createScanProgress, createAnalysisProgress, createDetectionProgress, withProgress, logProgress, type ProgressOptions, } from './progress.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/ui/progress.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Progress - Progress bars for scanning
+ *
+ * Provides progress bars for long-running operations like scanning.
+ *
+ * @requirements 29.1
+ */
+import { SingleBar } from 'cli-progress';
+/**
+ * Progress bar configuration options
+ */
+export interface ProgressOptions {
+    /** Total number of items */
+    total: number;
+    /** Format string for the progress bar */
+    format?: string;
+    /** Whether to show ETA */
+    showEta?: boolean;
+    /** Whether to show percentage */
+    showPercentage?: boolean;
+    /** Whether to show value/total */
+    showValue?: boolean;
+    /** Whether progress is enabled (false in CI mode) */
+    enabled?: boolean;
+    /** Clear the bar on complete */
+    clearOnComplete?: boolean;
+    /** Hide cursor during progress */
+    hideCursor?: boolean;
+}
+/**
+ * Progress bar wrapper for consistent CLI feedback
+ */
+export declare class Progress {
+    private bar;
+    private enabled;
+    private currentValue;
+    constructor(options: ProgressOptions);
+    /**
+     * Update progress with current value
+     */
+    update(value: number, payload?: Record<string, string | number>): this;
+    /**
+     * Increment progress by amount
+     */
+    increment(amount?: number, payload?: Record<string, string | number>): this;
+    /**
+     * Set the current task description
+     */
+    task(description: string): this;
+    /**
+     * Set the total value
+     */
+    setTotal(total: number): this;
+    /**
+     * Stop the progress bar
+     */
+    stop(): this;
+    /**
+     * Get current value
+     */
+    get value(): number;
+}
+/**
+ * Multi-progress bar for parallel operations
+ */
+export declare class MultiProgress {
+    private multiBar;
+    private bars;
+    private enabled;
+    constructor(enabled?: boolean);
+    /**
+     * Create a new progress bar
+     */
+    create(name: string, total: number): SingleBar | null;
+    /**
+     * Update a specific bar
+     */
+    update(name: string, value: number, payload?: Record<string, string | number>): this;
+    /**
+     * Increment a specific bar
+     */
+    increment(name: string, amount?: number, payload?: Record<string, string | number>): this;
+    /**
+     * Remove a specific bar
+     */
+    remove(name: string): this;
+    /**
+     * Stop all progress bars
+     */
+    stop(): this;
+}
+/**
+ * Create a progress bar for scanning operations
+ */
+export declare function createScanProgress(totalFiles: number): Progress;
+/**
+ * Create a progress bar for analysis operations
+ */
+export declare function createAnalysisProgress(totalItems: number): Progress;
+/**
+ * Create a progress bar for pattern detection
+ */
+export declare function createDetectionProgress(totalDetectors: number): Progress;
+/**
+ * Run an operation with progress tracking
+ */
+export declare function withProgress<T>(items: T[], operation: (item: T, index: number) => Promise<void>, options?: {
+    format?: string;
+    getTaskName?: (item: T) => string;
+}): Promise<void>;
+/**
+ * Simple percentage display for CI mode
+ */
+export declare function logProgress(current: number, total: number, message?: string): void;
+//# sourceMappingURL=progress.d.ts.map

package/dist/ui/prompts.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Prompts - Interactive prompts with Inquirer
+ *
+ * Provides interactive prompts for user input during CLI operations.
+ *
+ * @requirements 29.8
+ */
+import type { Severity } from 'driftdetect-core';
+/**
+ * Pattern approval choice
+ */
+export interface PatternChoice {
+    /** Pattern ID */
+    id: string;
+    /** Pattern name */
+    name: string;
+    /** Pattern category */
+    category: string;
+    /** Confidence score */
+    confidence: number;
+}
+/**
+ * Prompt for confirmation
+ */
+export declare function confirmPrompt(message: string, defaultValue?: boolean): Promise<boolean>;
+/**
+ * Prompt for text input
+ */
+export declare function inputPrompt(message: string, defaultValue?: string): Promise<string>;
+/**
+ * Prompt to select from a list of options
+ */
+export declare function selectPrompt<T extends string>(message: string, choices: Array<{
+    value: T;
+    name: string;
+    description?: string;
+}>): Promise<T>;
+/**
+ * Prompt to select multiple items from a list
+ */
+export declare function multiSelectPrompt<T extends string>(message: string, choices: Array<{
+    value: T;
+    name: string;
+    checked?: boolean;
+}>): Promise<T[]>;
+/**
+ * Prompt for pattern approval action
+ */
+export type PatternAction = 'approve' | 'ignore' | 'skip' | 'variant';
+export declare function promptPatternAction(pattern: PatternChoice): Promise<PatternAction>;
+/**
+ * Prompt for multiple pattern approvals
+ */
+export declare function promptBatchPatternApproval(patterns: PatternChoice[]): Promise<string[]>;
+/**
+ * Prompt for severity selection
+ */
+export declare function promptSeverity(message?: string): Promise<Severity>;
+/**
+ * Prompt for variant reason
+ */
+export declare function promptVariantReason(): Promise<string>;
+/**
+ * Prompt for variant scope
+ */
+export type VariantScope = 'global' | 'directory' | 'file';
+export declare function promptVariantScope(): Promise<VariantScope>;
+/**
+ * Prompt for initialization options
+ */
+export interface InitPromptResult {
+    /** Whether to scan immediately */
+    scanNow: boolean;
+    /** Whether to auto-approve high confidence patterns */
+    autoApprove: boolean;
+}
+export declare function promptInitOptions(): Promise<InitPromptResult>;
+/**
+ * Prompt for ignore reason
+ */
+export declare function promptIgnoreReason(): Promise<string>;
+/**
+ * Prompt for report format selection
+ */
+export type ReportFormat = 'text' | 'json' | 'github' | 'gitlab';
+export declare function promptReportFormat(): Promise<ReportFormat>;
+/**
+ * Prompt for category selection
+ */
+export declare function promptCategorySelection(categories: string[]): Promise<string[]>;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/ui/spinner.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Spinner - Progress spinners
+ *
+ * Provides animated spinners for long-running operations.
+ *
+ * @requirements 29.1
+ */
+/**
+ * Spinner configuration options
+ */
+export interface SpinnerOptions {
+    /** Spinner text */
+    text?: string;
+    /** Spinner color */
+    color?: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray';
+    /** Whether to show spinner (false in CI mode) */
+    enabled?: boolean;
+}
+/**
+ * Spinner wrapper for consistent CLI feedback
+ */
+export declare class Spinner {
+    private spinner;
+    private enabled;
+    constructor(options?: SpinnerOptions);
+    /**
+     * Start the spinner with optional text
+     */
+    start(text?: string): this;
+    /**
+     * Stop the spinner with a success message
+     */
+    succeed(text?: string): this;
+    /**
+     * Stop the spinner with a failure message
+     */
+    fail(text?: string): this;
+    /**
+     * Stop the spinner with a warning message
+     */
+    warn(text?: string): this;
+    /**
+     * Stop the spinner with an info message
+     */
+    info(text?: string): this;
+    /**
+     * Stop the spinner without a status symbol
+     */
+    stop(): this;
+    /**
+     * Update the spinner text
+     */
+    text(text: string): this;
+    /**
+     * Update the spinner color
+     */
+    color(color: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'): this;
+    /**
+     * Check if spinner is currently spinning
+     */
+    get isSpinning(): boolean;
+}
+/**
+ * Create a new spinner instance
+ */
+export declare function createSpinner(textOrOptions?: string | SpinnerOptions): Spinner;
+/**
+ * Run an async operation with a spinner
+ */
+export declare function withSpinner<T>(text: string, operation: () => Promise<T>, options?: {
+    successText?: string | ((result: T) => string);
+    failText?: string | ((error: Error) => string);
+}): Promise<T>;
+/**
+ * Pre-configured spinners for common operations
+ */
+export declare const spinners: {
+    /**
+     * Spinner for scanning operations
+     */
+    scanning(text?: string): Spinner;
+    /**
+     * Spinner for analysis operations
+     */
+    analyzing(text?: string): Spinner;
+    /**
+     * Spinner for loading operations
+     */
+    loading(text?: string): Spinner;
+    /**
+     * Spinner for saving operations
+     */
+    saving(text?: string): Spinner;
+    /**
+     * Spinner for checking operations
+     */
+    checking(text?: string): Spinner;
+};
+/**
+ * Status indicators for non-spinner output
+ */
+export declare const status: {
+    success(message: string): void;
+    error(message: string): void;
+    warning(message: string): void;
+    info(message: string): void;
+    pending(message: string): void;
+};
+//# sourceMappingURL=spinner.d.ts.map