@optique/zod 1.0.0-dev.1424 → 1.0.0-dev.1436

package/dist/index.cjs

@@ -23,6 +23,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 const __optique_core_message = __toESM(require("@optique/core/message"));
 const __optique_core_nonempty = __toESM(require("@optique/core/nonempty"));
+const zod = __toESM(require("zod"));
 
 //#region src/index.ts
 /**
@@ -39,6 +40,114 @@ function isZodAsyncError(error) {
 	if (error.message === "Async refinement encountered during synchronous parse operation. Use .parseAsync instead." || error.message === "Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead." || error.message === "Synchronous parse encountered promise.") return true;
 	return false;
 }
+const BOOL_TRUE_LITERALS = [
+	"true",
+	"1",
+	"yes",
+	"on"
+];
+const BOOL_FALSE_LITERALS = [
+	"false",
+	"0",
+	"no",
+	"off"
+];
+/**
+* Analyzes whether the given Zod schema represents a boolean type,
+* unwrapping all known Zod wrappers.  Also determines whether it is
+* safe to expose `choices` and `suggest()` — wrappers that can narrow
+* the accepted domain (effects, catch) suppress choice exposure.
+*/
+function analyzeBooleanSchema(schema) {
+	const result = analyzeBooleanInner(schema, true, /* @__PURE__ */ new WeakSet());
+	if (!result.isBoolean) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	return result;
+}
+function analyzeBooleanInner(schema, canExposeChoices, visited) {
+	if (visited.has(schema)) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	visited.add(schema);
+	const def = schema._def;
+	if (!def) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	const typeName = def.typeName ?? def.type;
+	if (typeName === "ZodBoolean" || typeName === "boolean") {
+		const hasCustomChecks = Array.isArray(def.checks) && def.checks.some((c) => c.kind === "custom" || c.type === "custom" || c._zod?.def?.check === "custom");
+		return {
+			isBoolean: true,
+			exposeChoices: canExposeChoices && !hasCustomChecks,
+			isCoerced: def.coerce === true
+		};
+	}
+	if (typeName === "ZodOptional" || typeName === "optional" || typeName === "ZodNullable" || typeName === "nullable" || typeName === "ZodDefault" || typeName === "default" || typeName === "ZodReadonly" || typeName === "readonly" || typeName === "prefault" || typeName === "nonoptional") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, canExposeChoices, visited);
+	}
+	if (typeName === "ZodLazy" || typeName === "lazy") {
+		if (typeof def.getter === "function") return analyzeBooleanInner(def.getter(), canExposeChoices, visited);
+	}
+	if (typeName === "ZodEffects" || typeName === "effects") {
+		if (def.effect?.type === "preprocess") return {
+			isBoolean: false,
+			exposeChoices: false,
+			isCoerced: false
+		};
+		const innerSchema = def.schema;
+		if (innerSchema != null) return analyzeBooleanInner(innerSchema, false, visited);
+	}
+	if (typeName === "ZodCatch" || typeName === "catch") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "ZodBranded" || typeName === "branded") {
+		const innerType = def.innerType ?? (typeof def.type === "object" && def.type != null ? def.type : void 0);
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "pipe" || typeName === "ZodPipeline") {
+		const inSchema = def.in;
+		if (inSchema != null) return analyzeBooleanInner(inSchema, false, visited);
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "pipeline") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+}
+/**
+* Pre-converts a CLI string input to an actual boolean value using
+* CLI-friendly literals (true/false, 1/0, yes/no, on/off).
+*/
+function preConvertBoolean(input) {
+	const normalized = input.trim().toLowerCase();
+	if (BOOL_TRUE_LITERALS.includes(normalized)) return {
+		success: true,
+		value: true
+	};
+	if (BOOL_FALSE_LITERALS.includes(normalized)) return {
+		success: true,
+		value: false
+	};
+	return {
+		success: false,
+		error: __optique_core_message.message`Invalid Boolean value: ${input}. Expected one of ${(0, __optique_core_message.valueSet)([...BOOL_TRUE_LITERALS, ...BOOL_FALSE_LITERALS], { locale: "en-US" })}.`
+	};
+}
 /**
 * Infers an appropriate metavar string from a Zod schema.
 *
@@ -249,14 +358,86 @@ function inferChoices(schema) {
 *   operations that cannot be executed synchronously.
 * @since 0.7.0
 */
-function zod(schema, options = {}) {
+function zod$1(schema, options = {}) {
 	const choices = inferChoices(schema);
-	const metavar = options.metavar ?? inferMetavar(schema);
+	const boolInfo = analyzeBooleanSchema(schema);
+	const metavar = options.metavar ?? (boolInfo.isBoolean ? "BOOLEAN" : inferMetavar(schema));
 	(0, __optique_core_nonempty.ensureNonEmptyString)(metavar);
+	function doSafeParse(input, rawInput) {
+		let result;
+		try {
+			result = schema.safeParse(input);
+		} catch (error) {
+			if (error instanceof Error && isZodAsyncError(error)) throw new TypeError("Async Zod schemas (e.g., async refinements) are not supported by zod(). Use synchronous schemas instead.");
+			throw error;
+		}
+		if (result.success) return {
+			success: true,
+			value: result.data
+		};
+		if (options.errors?.zodError) return {
+			success: false,
+			error: typeof options.errors.zodError === "function" ? options.errors.zodError(result.error, rawInput) : options.errors.zodError
+		};
+		const zodModule = schema;
+		if (typeof zodModule.constructor?.prettifyError === "function") try {
+			const pretty = zodModule.constructor.prettifyError(result.error);
+			return {
+				success: false,
+				error: __optique_core_message.message`${pretty}`
+			};
+		} catch {}
+		const firstError = result.error.issues[0];
+		return {
+			success: false,
+			error: __optique_core_message.message`${firstError?.message ?? "Validation failed"}`
+		};
+	}
+	/**
+	* Handles a failed boolean literal pre-conversion.
+	*
+	*  -  *Non-coerced* (`z.boolean()`): falls through to `doSafeParse`
+	*     so that catch/default, custom errors, and async detection all
+	*     work.  This is safe because `safeParse(string)` fails at the
+	*     type level before any refinements execute.
+	*  -  *Coerced* (`z.coerce.boolean()`): runs the lazy async probe
+	*     (if not yet completed), then returns the pre-conversion error
+	*     or delegates to the custom `zodError` callback.
+	*/
+	function handleBooleanLiteralError(boolResult, rawInput) {
+		if (!boolInfo.isCoerced) return doSafeParse(rawInput, rawInput);
+		if (options.errors?.zodError) {
+			if (typeof options.errors.zodError !== "function") return {
+				success: false,
+				error: options.errors.zodError
+			};
+			const zodError = new zod.ZodError([{
+				code: "invalid_type",
+				expected: "boolean",
+				message: `Invalid Boolean value: ${rawInput}`,
+				path: []
+			}]);
+			return {
+				success: false,
+				error: options.errors.zodError(zodError, rawInput)
+			};
+		}
+		return boolResult;
+	}
 	const parser = {
 		$mode: "sync",
 		metavar,
-		...choices != null && choices.length > 0 ? {
+		...boolInfo.exposeChoices ? {
+			choices: Object.freeze([true, false]),
+			suggest(prefix) {
+				const allLiterals = [...BOOL_TRUE_LITERALS, ...BOOL_FALSE_LITERALS];
+				const normalizedPrefix = prefix.toLowerCase();
+				return allLiterals.filter((lit) => lit.startsWith(normalizedPrefix)).map((lit) => ({
+					kind: "literal",
+					text: lit
+				}));
+			}
+		} : choices != null && choices.length > 0 ? {
 			choices: Object.freeze(choices),
 			*suggest(prefix) {
 				for (const c of choices) if (c.startsWith(prefix)) yield {
@@ -266,34 +447,12 @@ function zod(schema, options = {}) {
 			}
 		} : {},
 		parse(input) {
-			let result;
-			try {
-				result = schema.safeParse(input);
-			} catch (error) {
-				if (error instanceof Error && isZodAsyncError(error)) throw new TypeError("Async Zod schemas (e.g., async refinements) are not supported by zod(). Use synchronous schemas instead.");
-				throw error;
+			if (boolInfo.isBoolean) {
+				const boolResult = preConvertBoolean(input);
+				if (!boolResult.success) return handleBooleanLiteralError(boolResult, input);
+				return doSafeParse(boolResult.value, input);
 			}
-			if (result.success) return {
-				success: true,
-				value: result.data
-			};
-			if (options.errors?.zodError) return {
-				success: false,
-				error: typeof options.errors.zodError === "function" ? options.errors.zodError(result.error, input) : options.errors.zodError
-			};
-			const zodModule = schema;
-			if (typeof zodModule.constructor?.prettifyError === "function") try {
-				const pretty = zodModule.constructor.prettifyError(result.error);
-				return {
-					success: false,
-					error: __optique_core_message.message`${pretty}`
-				};
-			} catch {}
-			const firstError = result.error.issues[0];
-			return {
-				success: false,
-				error: __optique_core_message.message`${firstError?.message ?? "Validation failed"}`
-			};
+			return doSafeParse(input, input);
 		},
 		format(value) {
 			if (options.format) return options.format(value);
@@ -313,4 +472,4 @@ function zod(schema, options = {}) {
 }
 
 //#endregion
-exports.zod = zod;
+exports.zod = zod$1;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Message } from "@optique/core/message";
-import { NonEmptyString, ValueParser } from "@optique/core/valueparser";
 import { z } from "zod";
+import { NonEmptyString, ValueParser } from "@optique/core/valueparser";
 
 //#region src/index.d.ts
 

package/dist/index.js

@@ -1,5 +1,6 @@
-import { message } from "@optique/core/message";
+import { message, valueSet } from "@optique/core/message";
 import { ensureNonEmptyString } from "@optique/core/nonempty";
+import { ZodError } from "zod";
 
 //#region src/index.ts
 /**
@@ -16,6 +17,114 @@ function isZodAsyncError(error) {
 	if (error.message === "Async refinement encountered during synchronous parse operation. Use .parseAsync instead." || error.message === "Asynchronous transform encountered during synchronous parse operation. Use .parseAsync instead." || error.message === "Synchronous parse encountered promise.") return true;
 	return false;
 }
+const BOOL_TRUE_LITERALS = [
+	"true",
+	"1",
+	"yes",
+	"on"
+];
+const BOOL_FALSE_LITERALS = [
+	"false",
+	"0",
+	"no",
+	"off"
+];
+/**
+* Analyzes whether the given Zod schema represents a boolean type,
+* unwrapping all known Zod wrappers.  Also determines whether it is
+* safe to expose `choices` and `suggest()` — wrappers that can narrow
+* the accepted domain (effects, catch) suppress choice exposure.
+*/
+function analyzeBooleanSchema(schema) {
+	const result = analyzeBooleanInner(schema, true, /* @__PURE__ */ new WeakSet());
+	if (!result.isBoolean) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	return result;
+}
+function analyzeBooleanInner(schema, canExposeChoices, visited) {
+	if (visited.has(schema)) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	visited.add(schema);
+	const def = schema._def;
+	if (!def) return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+	const typeName = def.typeName ?? def.type;
+	if (typeName === "ZodBoolean" || typeName === "boolean") {
+		const hasCustomChecks = Array.isArray(def.checks) && def.checks.some((c) => c.kind === "custom" || c.type === "custom" || c._zod?.def?.check === "custom");
+		return {
+			isBoolean: true,
+			exposeChoices: canExposeChoices && !hasCustomChecks,
+			isCoerced: def.coerce === true
+		};
+	}
+	if (typeName === "ZodOptional" || typeName === "optional" || typeName === "ZodNullable" || typeName === "nullable" || typeName === "ZodDefault" || typeName === "default" || typeName === "ZodReadonly" || typeName === "readonly" || typeName === "prefault" || typeName === "nonoptional") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, canExposeChoices, visited);
+	}
+	if (typeName === "ZodLazy" || typeName === "lazy") {
+		if (typeof def.getter === "function") return analyzeBooleanInner(def.getter(), canExposeChoices, visited);
+	}
+	if (typeName === "ZodEffects" || typeName === "effects") {
+		if (def.effect?.type === "preprocess") return {
+			isBoolean: false,
+			exposeChoices: false,
+			isCoerced: false
+		};
+		const innerSchema = def.schema;
+		if (innerSchema != null) return analyzeBooleanInner(innerSchema, false, visited);
+	}
+	if (typeName === "ZodCatch" || typeName === "catch") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "ZodBranded" || typeName === "branded") {
+		const innerType = def.innerType ?? (typeof def.type === "object" && def.type != null ? def.type : void 0);
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "pipe" || typeName === "ZodPipeline") {
+		const inSchema = def.in;
+		if (inSchema != null) return analyzeBooleanInner(inSchema, false, visited);
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	if (typeName === "pipeline") {
+		const innerType = def.innerType;
+		if (innerType != null) return analyzeBooleanInner(innerType, false, visited);
+	}
+	return {
+		isBoolean: false,
+		exposeChoices: false,
+		isCoerced: false
+	};
+}
+/**
+* Pre-converts a CLI string input to an actual boolean value using
+* CLI-friendly literals (true/false, 1/0, yes/no, on/off).
+*/
+function preConvertBoolean(input) {
+	const normalized = input.trim().toLowerCase();
+	if (BOOL_TRUE_LITERALS.includes(normalized)) return {
+		success: true,
+		value: true
+	};
+	if (BOOL_FALSE_LITERALS.includes(normalized)) return {
+		success: true,
+		value: false
+	};
+	return {
+		success: false,
+		error: message`Invalid Boolean value: ${input}. Expected one of ${valueSet([...BOOL_TRUE_LITERALS, ...BOOL_FALSE_LITERALS], { locale: "en-US" })}.`
+	};
+}
 /**
 * Infers an appropriate metavar string from a Zod schema.
 *
@@ -228,12 +337,84 @@ function inferChoices(schema) {
 */
 function zod(schema, options = {}) {
 	const choices = inferChoices(schema);
-	const metavar = options.metavar ?? inferMetavar(schema);
+	const boolInfo = analyzeBooleanSchema(schema);
+	const metavar = options.metavar ?? (boolInfo.isBoolean ? "BOOLEAN" : inferMetavar(schema));
 	ensureNonEmptyString(metavar);
+	function doSafeParse(input, rawInput) {
+		let result;
+		try {
+			result = schema.safeParse(input);
+		} catch (error) {
+			if (error instanceof Error && isZodAsyncError(error)) throw new TypeError("Async Zod schemas (e.g., async refinements) are not supported by zod(). Use synchronous schemas instead.");
+			throw error;
+		}
+		if (result.success) return {
+			success: true,
+			value: result.data
+		};
+		if (options.errors?.zodError) return {
+			success: false,
+			error: typeof options.errors.zodError === "function" ? options.errors.zodError(result.error, rawInput) : options.errors.zodError
+		};
+		const zodModule = schema;
+		if (typeof zodModule.constructor?.prettifyError === "function") try {
+			const pretty = zodModule.constructor.prettifyError(result.error);
+			return {
+				success: false,
+				error: message`${pretty}`
+			};
+		} catch {}
+		const firstError = result.error.issues[0];
+		return {
+			success: false,
+			error: message`${firstError?.message ?? "Validation failed"}`
+		};
+	}
+	/**
+	* Handles a failed boolean literal pre-conversion.
+	*
+	*  -  *Non-coerced* (`z.boolean()`): falls through to `doSafeParse`
+	*     so that catch/default, custom errors, and async detection all
+	*     work.  This is safe because `safeParse(string)` fails at the
+	*     type level before any refinements execute.
+	*  -  *Coerced* (`z.coerce.boolean()`): runs the lazy async probe
+	*     (if not yet completed), then returns the pre-conversion error
+	*     or delegates to the custom `zodError` callback.
+	*/
+	function handleBooleanLiteralError(boolResult, rawInput) {
+		if (!boolInfo.isCoerced) return doSafeParse(rawInput, rawInput);
+		if (options.errors?.zodError) {
+			if (typeof options.errors.zodError !== "function") return {
+				success: false,
+				error: options.errors.zodError
+			};
+			const zodError = new ZodError([{
+				code: "invalid_type",
+				expected: "boolean",
+				message: `Invalid Boolean value: ${rawInput}`,
+				path: []
+			}]);
+			return {
+				success: false,
+				error: options.errors.zodError(zodError, rawInput)
+			};
+		}
+		return boolResult;
+	}
 	const parser = {
 		$mode: "sync",
 		metavar,
-		...choices != null && choices.length > 0 ? {
+		...boolInfo.exposeChoices ? {
+			choices: Object.freeze([true, false]),
+			suggest(prefix) {
+				const allLiterals = [...BOOL_TRUE_LITERALS, ...BOOL_FALSE_LITERALS];
+				const normalizedPrefix = prefix.toLowerCase();
+				return allLiterals.filter((lit) => lit.startsWith(normalizedPrefix)).map((lit) => ({
+					kind: "literal",
+					text: lit
+				}));
+			}
+		} : choices != null && choices.length > 0 ? {
 			choices: Object.freeze(choices),
 			*suggest(prefix) {
 				for (const c of choices) if (c.startsWith(prefix)) yield {
@@ -243,34 +424,12 @@ function zod(schema, options = {}) {
 			}
 		} : {},
 		parse(input) {
-			let result;
-			try {
-				result = schema.safeParse(input);
-			} catch (error) {
-				if (error instanceof Error && isZodAsyncError(error)) throw new TypeError("Async Zod schemas (e.g., async refinements) are not supported by zod(). Use synchronous schemas instead.");
-				throw error;
+			if (boolInfo.isBoolean) {
+				const boolResult = preConvertBoolean(input);
+				if (!boolResult.success) return handleBooleanLiteralError(boolResult, input);
+				return doSafeParse(boolResult.value, input);
 			}
-			if (result.success) return {
-				success: true,
-				value: result.data
-			};
-			if (options.errors?.zodError) return {
-				success: false,
-				error: typeof options.errors.zodError === "function" ? options.errors.zodError(result.error, input) : options.errors.zodError
-			};
-			const zodModule = schema;
-			if (typeof zodModule.constructor?.prettifyError === "function") try {
-				const pretty = zodModule.constructor.prettifyError(result.error);
-				return {
-					success: false,
-					error: message`${pretty}`
-				};
-			} catch {}
-			const firstError = result.error.issues[0];
-			return {
-				success: false,
-				error: message`${firstError?.message ?? "Validation failed"}`
-			};
+			return doSafeParse(input, input);
 		},
 		format(value) {
 			if (options.format) return options.format(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/zod",
-  "version": "1.0.0-dev.1424+71e81eec",
+  "version": "1.0.0-dev.1436+4ad8f445",
   "description": "Zod value parsers for Optique",
   "keywords": [
     "CLI",
@@ -57,7 +57,7 @@
     "zod": "^3.25.0 || ^4.0.0"
   },
   "dependencies": {
-    "@optique/core": "1.0.0-dev.1424+71e81eec"
+    "@optique/core": "1.0.0-dev.1436+4ad8f445"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",