@useinsider/guido 1.3.1-beta.cf510dd → 1.3.1

package/dist/src/@types/config/validator.d.ts

@@ -1,119 +0,0 @@
-/**
- * Guido Configuration Validator
- *
- * Utilities for validating and parsing Guido configuration.
- * Provides both throwing and non-throwing validation methods.
- * @module @types/config/validator
- */
-import type { GuidoConfig, GuidoConfigInput } from './types';
-/**
- * Result of config validation
- */
-export interface ValidationResult {
-    /** Whether validation was successful */
-    success: boolean;
-    /** Validated and transformed config (only if success) */
-    data?: GuidoConfig;
-    /** Validation error messages (only if failed) */
-    errors?: string[];
-}
-/**
- * Formatted validation error with path and message
- */
-export interface ValidationError {
-    /** Dot-notation path to the invalid field */
-    path: string;
-    /** Error message */
-    message: string;
-}
-/**
- * Validates configuration input and returns a result object.
- *
- * Use this for non-throwing validation where you want to handle errors yourself.
- * @example
- * ```typescript
- * const result = validateConfig({
- *   identity: { templateId: 'tpl-1', userId: 'usr-1' },
- *   partner: { name: 'acme-corp' },
- * });
- *
- * if (result.success) {
- *   console.log(result.data); // Full GuidoConfig with defaults
- * } else {
- *   console.error(result.errors); // ['[identity.templateId] templateId is required']
- * }
- * ```
- * @param input - Raw configuration input
- * @returns Validation result with success status and data or errors
- */
-export declare function validateConfig(input: GuidoConfigInput): ValidationResult;
-/**
- * Validates configuration and throws on error.
- *
- * Use this during component initialization where invalid config should halt execution.
- * @example
- * ```typescript
- * try {
- *   const config = parseConfig({
- *     identity: { templateId: 'tpl-1', userId: 'usr-1' },
- *     partner: { name: 'acme-corp' },
- *   });
- *   // config is fully typed GuidoConfig
- * } catch (error) {
- *   console.error('Invalid configuration:', error.message);
- * }
- * ```
- * @param input - Raw configuration input
- * @returns Validated GuidoConfig with all defaults applied
- */
-export declare function parseConfig(input: GuidoConfigInput): GuidoConfig;
-/**
- * Validates configuration with console warnings (non-throwing).
- *
- * Use this when you want to attempt recovery from invalid config.
- * Returns null on failure instead of throwing.
- * @example
- * ```typescript
- * const config = parseConfigSafe(userInput);
- * if (!config) {
- *   // Use fallback configuration
- *   return defaultConfig;
- * }
- * ```
- * @param input - Raw configuration input
- * @returns Validated GuidoConfig or null if validation fails
- */
-export declare function parseConfigSafe(input: GuidoConfigInput): GuidoConfig | null;
-/**
- * Get structured validation errors for detailed error handling.
- * @example
- * ```typescript
- * const errors = getValidationErrors(input);
- * errors.forEach(({ path, message }) => {
- *   formErrors[path] = message;
- * });
- * ```
- * @param input - Raw configuration input
- * @returns Array of validation errors with paths, or empty array if valid
- */
-export declare function getValidationErrors(input: GuidoConfigInput): ValidationError[];
-/**
- * Check if a configuration input is valid without parsing.
- * @example
- * ```typescript
- * if (isValidConfig(userInput)) {
- *   saveConfig(userInput);
- * }
- * ```
- * @param input - Raw configuration input
- * @returns True if valid, false otherwise
- */
-export declare function isValidConfig(input: unknown): input is GuidoConfigInput;
-/**
- * Validate just the identity section
- */
-export declare function validateIdentity(input: unknown): ValidationResult;
-/**
- * Validate just the partner section
- */
-export declare function validatePartner(input: unknown): ValidationResult;