zlient 1.0.4 → 1.0.5

package/dist/validation.d.ts

@@ -1,5 +1,44 @@
 import { z } from 'zod';
 import { SafeParseResult } from './types';
+/**
+ * Safely parse data with a Zod schema without throwing.
+ * Returns a result object with success status and data or error.
+ *
+ * @param schema - Zod schema to validate against
+ * @param data - Data to validate
+ * @returns Result object with success flag and data/error
+ *
+ * @example
+ * ```ts
+ * const result = safeParse(UserSchema, userData);
+ * if (result.success) {
+ *   console.log(result.data);
+ * } else {
+ *   console.error(result.error);
+ * }
+ * ```
+ */
 export declare function safeParse<T>(schema: z.ZodTypeAny, data: unknown): SafeParseResult<T>;
+/**
+ * Parse data with a Zod schema, throwing an ApiError on validation failure.
+ * Use this when you want to fail fast on invalid data.
+ *
+ * @param schema - Zod schema to validate against
+ * @param data - Data to validate
+ * @returns Validated and typed data
+ * @throws {ApiError} If validation fails
+ *
+ * @example
+ * ```ts
+ * try {
+ *   const user = parseOrThrow(UserSchema, userData);
+ *   console.log(user);
+ * } catch (error) {
+ *   if (error instanceof ApiError && error.zodError) {
+ *     console.error('Validation failed:', error.zodError.issues);
+ *   }
+ * }
+ * ```
+ */
 export declare function parseOrThrow<T>(schema: z.ZodTypeAny, data: unknown): T;
 //# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../lib/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAY,eAAe,EAAE,MAAM,SAAS,CAAC;AAEpD,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,CAIpF;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,CAMtE"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../lib/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAY,eAAe,EAAE,MAAM,SAAS,CAAC;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,CAIpF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,CAMtE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zlient",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A type-safe HTTP client framework with Zod validation for building robust API clients",
   "type": "module",
   "main": "./dist/index.cjs",