@plyaz/types 1.15.20 → 1.16.0

package/dist/errors/validation.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Validation types - abstraction over underlying validation library (Zod)
+ * These types are exposed to consumers and should not leak implementation details
+ *
+ * @module @plyaz/types/validation
+ */
+/**
+ * A single validation issue
+ * Abstraction over ZodIssue - consumers don't need to know about Zod
+ */
+export interface ValidationIssue {
+    /** Path to the field that failed validation (e.g., ['user', 'email']) */
+    path: (string | number)[];
+    /** Error message */
+    message: string;
+    /** Error code (e.g., 'invalid_type', 'too_small', 'invalid_string') */
+    code: string;
+    /** Additional metadata about the error */
+    [key: string]: unknown;
+}
+/**
+ * Result of schema validation
+ * Generic result type that doesn't expose Zod
+ * Named SchemaValidationResult to avoid conflict with common ValidationResult
+ */
+export type SchemaValidationResult<T> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    errors: ValidationIssue[];
+};
+/**
+ * Validation schema interface
+ * Minimal interface that any validation schema must implement
+ * Abstracts away the underlying validation library
+ */
+export interface ValidationSchema<T = unknown> {
+    /** Parse and validate data, throwing on error */
+    parse(data: unknown): T;
+    /** Safely parse and validate data, returning result */
+    safeParse(data: unknown): SchemaValidationResult<T>;
+}
+/**
+ * Internal validation issue structure
+ * Matches Zod's actual ZodIssue structure
+ * NOT exposed to consumers - this is an implementation detail
+ *
+ * @internal
+ */
+export interface InternalValidationIssue {
+    readonly path: PropertyKey[];
+    readonly message: string;
+    readonly code: string;
+}
+/**
+ * Internal validation schema interface
+ * Used internally by validation utilities - matches Zod's actual API
+ * NOT exposed to consumers - this is an implementation detail
+ *
+ * @internal
+ */
+export interface InternalValidationSchema<T> {
+    safeParse(data: unknown): {
+        success: boolean;
+        data?: T;
+        error?: {
+            issues: ReadonlyArray<InternalValidationIssue>;
+        };
+    };
+}