@politty/zod 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,799 @@
+import { $ as toKebabCase, A as LogEntry, B as RunResultSuccess, C as Command, D as GlobalCleanupContext, E as GlobalArgs, F as NonRunnableCommand, G as UnknownSubcommandHandler, H as SetupContext, I as PromptResolver, J as lazy, K as LazyCommand, L as RunCommandOptions, M as LogStream, N as Logger, O as GlobalSetupContext, P as MainOptions, Q as toCamelCase, R as RunResult, S as CollectedLogs, T as Example, U as SubCommandValue, V as RunnableCommand, W as SubCommandsRecord, X as ResolvedFieldMeta, Y as ExtractedFields, Z as UnknownKeysMode, _ as DynamicCompletionResult, a as CustomCompletion, b as ArgsSchema$1, c as PromptType, d as ExpandCompletion, et as InferSchemaOutput, f as ResolvedExpandCandidate, g as DynamicCompletionResolver, h as DynamicCompletionContext, i as CompletionType, j as LogLevel, k as IsEmpty, l as ValidateArgMeta, m as DynamicCompletionCandidate, n as ArgMeta, o as EffectContext, p as CompletionDirectiveMask, q as isLazyCommand, r as CompletionMeta, s as PromptMeta, t as ArgFn, tt as SchemaLike, u as ExpandCandidate, v as AnyCommand, w as CommandBase, x as CleanupContext, y as ArgSource, z as RunResultFailure } from "./arg-registry-YaWTVu_x.js";
+import { C as CompletionResult, D as InternalArgsSchema, S as CompletionOptions, c as withCompletionCommand, l as GenerateBundledCompletionWorkerOptions, o as generateCompletion, p as generateBundledCompletionWorker, t as WithCompletionOptions, u as GenerateBundledCompletionWorkerResult } from "./index-CvhsecfS.js";
+import { z } from "zod";
+//#region ../core/src/core/schema-extractor.d.ts
+/**
+ * Detect the unknown-keys handling mode of an args schema. Works for any
+ * schema politty itself attaches to a command (including internal
+ * descriptor-based commands), not just user-provided library schemas.
+ */
+declare function getUnknownKeysMode(schema: ArgsSchema$1): UnknownKeysMode;
+/**
+ * Extract all fields from a schema
+ *
+ * @param schema - The args schema (ZodObject, ZodDiscriminatedUnion, etc.)
+ * @returns Extracted field information
+ */
+declare function extractFields(schema: ArgsSchema$1): ExtractedFields;
+//#endregion
+//#region ../core/src/adapter/types.d.ts
+/**
+ * Validation error details
+ */
+interface ValidationError {
+  /** Path to the invalid field */
+  path: string[];
+  /** Error message */
+  message: string;
+  /** Error code (adapter-specific, e.g. zod issue code) */
+  code: string;
+  /** Value that was received */
+  received?: unknown | undefined;
+  /** Expected type or value */
+  expected?: string | undefined;
+}
+/**
+ * Validation result
+ */
+type ValidationResult<T> = {
+  success: true;
+  data: T;
+} | {
+  success: false;
+  errors: ValidationError[];
+};
+//#endregion
+//#region ../core/src/compile-cache-shim.d.ts
+/**
+ * Generator for compile-cache bin shims.
+ *
+ * Emits the minimal entry file described in docs/recipes.md ("Faster
+ * Startup"): a shim that enables the Node.js on-disk compile cache via
+ * `politty/compile-cache` and then loads the real CLI with a dynamic
+ * import. Meant to be wired into a `postbuild` or `prepack` script via
+ * `politty generate-shim` so the shim never has to live in source.
+ */
+/**
+ * Options for {@link generateCompileCacheShim}.
+ */
+interface GenerateCompileCacheShimOptions {
+  /**
+   * Module specifier(s) the shim imports to start the CLI, relative to the
+   * generated shim file (e.g. `./cli.js`). Pass one per shim; when `out` is
+   * omitted the count must match the package's `bin` entries (paired in
+   * order). Defaults to the first of `./cli.js`, `./cli.mjs`, `./index.js`,
+   * `./index.mjs` that exists next to each shim.
+   */
+  entry?: string | string[];
+  /**
+   * Output path(s) for the generated shim(s) (e.g. `dist/bin.js`). When
+   * given, the count must match `entry` (paired in order). Defaults to all
+   * `bin` paths in the nearest `package.json` — the places the executables
+   * must live.
+   */
+  out?: string | string[];
+  /**
+   * Program name used to derive the cache directory, applied to every
+   * generated shim. Defaults per shim to the `bin` name whose path is the
+   * shim's output, falling back to the first `bin` name and then the
+   * package name without its scope. The fallback never happens silently: a
+   * warning is printed when an explicit `out` path cannot be matched to a
+   * `bin` entry.
+   */
+  program?: string;
+  /**
+   * Base directory for resolving paths and locating the nearest
+   * `package.json` (default: `process.cwd()`).
+   */
+  cwd?: string;
+}
+/**
+ * One generated shim from {@link generateCompileCacheShim}.
+ */
+interface GenerateCompileCacheShimResult {
+  /** Absolute path of the generated shim. */
+  outputPath: string;
+  /** Program name baked into the shim. */
+  program: string;
+  /** Entry specifier baked into the shim. */
+  entry: string;
+}
+/**
+ * Generate executable compile-cache bin shims.
+ *
+ * With no explicit paths, one shim is generated per `bin` entry of the
+ * nearest `package.json`, each importing a conventional built module next
+ * to it — so a bare `politty generate-shim` in a `postbuild` script is
+ * usually enough. Explicit `entry` values are paired in order with the
+ * `bin` entries (or with explicit `out` values of the same count).
+ *
+ * The generated files are ESM (they use top-level `await import`), so `.js`
+ * output requires `"type": "module"` in the package; use a `.mjs` extension
+ * otherwise. Refuses to overwrite an existing file it did not generate, so
+ * a `bin` path still pointing at the real CLI entry fails loudly instead of
+ * clobbering the build output.
+ */
+declare function generateCompileCacheShim(options?: GenerateCompileCacheShimOptions): GenerateCompileCacheShimResult[];
+//#endregion
+//#region ../core/src/core/case-types.d.ts
+/**
+ * TypeScript utility types for case conversion between camelCase and kebab-case.
+ *
+ * These types enable dual-case access on CLI args objects,
+ * so that both `args.myOption` and `args["my-option"]` are valid.
+ */
+/**
+ * Convert a kebab-case string to camelCase at the type level.
+ *
+ * @example
+ * type R = CamelCase<"my-option">; // "myOption"
+ * type R2 = CamelCase<"already">; // "already"
+ */
+type CamelCase<S extends string> = S extends `${infer P}-${infer C}${infer R}` ? `${P}${Uppercase<C>}${CamelCase<R>}` : S;
+/**
+ * Internal helper: insert hyphens before uppercase-to-lowercase transitions.
+ * Matches the runtime `toKebabCase()` behavior:
+ * - `([a-z])([A-Z])` → insert hyphen (e.g. "myOption" → "my-Option")
+ * - `([A-Z]+)([A-Z][a-z])` → insert hyphen before last capital in a run
+ *   (e.g. "XMLParser" → "XML-Parser" → "xml-parser")
+ *
+ * Note: TypeScript template literal types have limited ability to match
+ * multi-character uppercase runs precisely. This implementation handles
+ * common CLI naming patterns (camelCase, PascalCase). For exotic acronym
+ * patterns (e.g. "XMLParser"), the type-level result may differ slightly
+ * from the runtime result. Dual-case proxy handles runtime resolution.
+ */
+type KebabCaseInner<S extends string> = S extends `${infer First}${infer Rest}` ? Rest extends "" ? First extends Lowercase<First> ? First : `-${Lowercase<First>}` : First extends Lowercase<First> ? `${First}${KebabCaseInner<Rest>}` : Rest extends `${infer Next}${infer Tail}` ? Next extends Lowercase<Next> ? `-${Lowercase<First>}${Next}${KebabCaseInner<Tail>}` : `${Lowercase<First>}${KebabCaseInner<Rest>}` : `-${Lowercase<First>}` : S;
+/**
+ * Strip a leading hyphen (produced when the first char is uppercase).
+ */
+type StripLeadingHyphen<S extends string> = S extends `-${infer R}` ? R : S;
+/**
+ * Convert a camelCase string to kebab-case at the type level.
+ * Aligned with the runtime `toKebabCase()` function in schema-extractor.ts.
+ *
+ * @example
+ * type R = KebabCase<"myOption">; // "my-option"
+ * type R2 = KebabCase<"already">; // "already"
+ */
+type KebabCase<S extends string> = StripLeadingHyphen<KebabCaseInner<S>>;
+/**
+ * Add both camelCase and kebab-case variants for every key in T.
+ *
+ * Given `{ "my-option": string }`, produces
+ * `{ "my-option": string } & { myOption: string }`.
+ *
+ * Given `{ myOption: string }`, produces
+ * `{ myOption: string } & { "my-option": string }`.
+ *
+ * Keys that are identical in both cases (e.g. single-word keys) are not duplicated.
+ * Uses a distributive conditional type so it works correctly with discriminated unions.
+ */
+type WithCaseVariants<T> = T extends unknown ? T & { [K in keyof T as CamelCase<K & string>]: T[K]; } & { [K in keyof T as KebabCase<K & string>]: T[K]; } : never;
+//#endregion
+//#region ../core/src/core/case-proxy.d.ts
+/**
+ * Wrap an args object with a Proxy that allows dual-case access.
+ *
+ * Given `{ "my-option": "value" }`, both `obj["my-option"]` and `obj.myOption`
+ * will return `"value"`.
+ *
+ * - `Object.keys()`, `JSON.stringify()`, and spread return only the original keys.
+ * - The `in` operator detects both case variants.
+ */
+declare function createDualCaseProxy<T extends Record<string, unknown>>(obj: T): WithCaseVariants<T>;
+//#endregion
+//#region ../core/src/core/command.d.ts
+/**
+ * Infer args type from schema, defaults to empty object if undefined.
+ * Wraps with WithCaseVariants so both camelCase and kebab-case access is typed.
+ *
+ * politty's internal validator-free descriptors are checked before the
+ * schema-library branch: they present themselves as `ArgsSchema` at the
+ * type level (see `InternalArgsSchema`), so without the brand check they
+ * would fall into `z.infer` and lose their field types.
+ */
+type InferArgs<TArgsSchema> = TArgsSchema extends InternalArgsSchema<infer TInternalOut> ? WithCaseVariants<TInternalOut> : TArgsSchema extends SchemaLike ? WithCaseVariants<InferSchemaOutput<TArgsSchema>> : Record<string, never>;
+/**
+ * Merge local args with global args.
+ * No-op when TGlobalArgs is empty (default GlobalArgs not extended).
+ * Wraps TGlobalArgs with WithCaseVariants for dual-case access.
+ */
+type MergedArgs<TLocalArgs, TGlobalArgs> = IsEmpty<TGlobalArgs> extends true ? TLocalArgs : TLocalArgs & WithCaseVariants<TGlobalArgs>;
+/**
+ * Add the `$source` helper, which reports whether a given field's final
+ * value came from an explicit CLI token, a `field.env` fallback, or
+ * neither (schema default / `prompt` resolution).
+ *
+ * `name` is typed as a plain `string` (not `keyof T`) since the runtime
+ * helper deliberately accepts either camelCase or kebab-case field names
+ * (matching `createDualCaseProxy`'s dual-case access) and returns
+ * `"default"` for anything it doesn't recognize. A `keyof T`-based type
+ * would also be unsound for discriminated-union `args` schemas, where
+ * narrowing `args` to one branch doesn't retroactively narrow `$source`'s
+ * already-fixed parameter type.
+ */
+type WithArgSource<T> = T & {
+  $source?: (name: string) => ArgSource;
+};
+/**
+ * Resolve merged args from schema and global args type
+ */
+type ResolvedArgs<TArgsSchema, TGlobalArgs> = WithArgSource<MergedArgs<InferArgs<TArgsSchema>, TGlobalArgs>>;
+/**
+ * Config for defining a command
+ * @template TArgsSchema - The args schema type (from the CLI's schema library)
+ * @template TResult - The return type of run function (void if no run)
+ * @template TGlobalArgs - Global args type (from declaration merging or factory)
+ */
+interface DefineCommandConfig<TArgsSchema extends ArgsSchema$1 | undefined, TResult, TGlobalArgs> {
+  name: string;
+  description?: string;
+  aliases?: string[];
+  args?: TArgsSchema;
+  subCommands?: SubCommandsRecord;
+  setup?: (context: {
+    args: ResolvedArgs<TArgsSchema, TGlobalArgs>;
+  }) => void | Promise<void>;
+  run?: (args: ResolvedArgs<TArgsSchema, TGlobalArgs>) => TResult;
+  cleanup?: (context: {
+    args: ResolvedArgs<TArgsSchema, TGlobalArgs>;
+    error?: Error | undefined;
+  }) => void | Promise<void>;
+  notes?: string;
+  examples?: Example[];
+}
+/**
+ * The overloaded `defineCommand` signature, parameterized by the args-schema
+ * constraint. Core's `defineCommand` uses the Standard-Schema-based
+ * {@link ArgsSchema}; adapter packages re-pin the same runtime function to
+ * their library's schema type (e.g. `DefineCommandFn<z.ZodType<...>>` in
+ * `@politty/zod`) so a schema from the wrong library is rejected at the type
+ * level instead of failing at runtime in the registered adapter.
+ */
+interface DefineCommandFn<TArgsBase extends ArgsSchema$1 = ArgsSchema$1> {
+  <TArgsSchema extends TArgsBase | undefined = undefined, TResult = void, TGlobalArgs = GlobalArgs>(config: RunnableConfig<TArgsSchema, TResult, TGlobalArgs>): RunnableCommand<TArgsSchema, ResolvedArgs<TArgsSchema, TGlobalArgs>, TResult>;
+  <TArgsSchema extends TArgsBase | undefined = undefined, TGlobalArgs = GlobalArgs>(config: NonRunnableConfig<TArgsSchema, TGlobalArgs>): NonRunnableCommand<TArgsSchema, ResolvedArgs<TArgsSchema, TGlobalArgs>>;
+}
+/**
+ * `defineCommand` with a pre-bound global args type — the shape returned by
+ * {@link createDefineCommand}. Parameterized by the args-schema constraint
+ * for the same adapter re-pinning as {@link DefineCommandFn}.
+ */
+interface BoundDefineCommandFn<TGlobalArgs, TArgsBase extends ArgsSchema$1 = ArgsSchema$1> {
+  <TArgsSchema extends TArgsBase | undefined = undefined, TResult = void>(config: RunnableConfig<TArgsSchema, TResult, TGlobalArgs>): RunnableCommand<TArgsSchema, ResolvedArgs<TArgsSchema, TGlobalArgs>, TResult>;
+  <TArgsSchema extends TArgsBase | undefined = undefined>(config: NonRunnableConfig<TArgsSchema, TGlobalArgs>): NonRunnableCommand<TArgsSchema, ResolvedArgs<TArgsSchema, TGlobalArgs>>;
+}
+/**
+ * The `createDefineCommand` signature, parameterized by the args-schema
+ * constraint for adapter re-pinning (see {@link DefineCommandFn}).
+ */
+interface CreateDefineCommandFn<TArgsBase extends ArgsSchema$1 = ArgsSchema$1> {
+  <TGlobalArgs>(): BoundDefineCommandFn<TGlobalArgs, TArgsBase>;
+}
+/**
+ * Config with run function (runnable command)
+ */
+interface RunnableConfig<TArgsSchema extends ArgsSchema$1 | undefined, TResult, TGlobalArgs> extends DefineCommandConfig<TArgsSchema, TResult, TGlobalArgs> {
+  run: (args: ResolvedArgs<TArgsSchema, TGlobalArgs>) => TResult;
+}
+/**
+ * Config without run function (non-runnable command)
+ */
+interface NonRunnableConfig<TArgsSchema extends ArgsSchema$1 | undefined, TGlobalArgs> extends Omit<DefineCommandConfig<TArgsSchema, void, TGlobalArgs>, "run"> {
+  run?: undefined;
+}
+//#endregion
+//#region ../core/src/core/runner.d.ts
+/**
+ * Run a command with the given arguments (programmatic/test usage)
+ *
+ * This function parses arguments, validates them, routes to subcommands,
+ * and executes the command. It does NOT call process.exit.
+ *
+ * @param command - The command to run
+ * @param argv - Command line arguments to parse
+ * @param options - Run options
+ * @returns The result of command execution
+ *
+ * @example
+ * ```ts
+ * import { defineCommand, runCommand } from "politty";
+ *
+ * const command = defineCommand({
+ *   name: "my-cli",
+ *   args: z.object({ name: z.string() }),
+ *   run: ({ name }) => console.log(`Hello, ${name}!`),
+ * });
+ *
+ * // In tests
+ * const result = await runCommand(command, ["--name", "World"]);
+ * expect(result.exitCode).toBe(0);
+ * ```
+ */
+declare function runCommand<TResult = unknown>(command: AnyCommand, argv: string[], options?: RunCommandOptions): Promise<RunResult<TResult>>;
+/**
+ * Run a CLI command as the main entry point
+ *
+ * This function:
+ * - Uses process.argv for arguments
+ * - Handles SIGINT/SIGTERM signals
+ * - Calls process.exit with the appropriate exit code
+ * - Invokes `command.runMainHook` once before parsing if set, so plug-ins
+ *   like `withCompletionCommand` can fire detached background work
+ * - Bypasses user `setup`/`cleanup`/`prompt` and required `globalArgs`
+ *   for registered hidden subcommands whose name starts with `__`
+ *   (e.g. `__refresh-completion`)
+ *
+ * @param command - The command to run
+ * @param options - Main options (version, debug)
+ *
+ * @example
+ * ```ts
+ * import { defineCommand, runMain } from "politty";
+ *
+ * const command = defineCommand({
+ *   name: "my-cli",
+ *   run: () => console.log("Hello!"),
+ * });
+ *
+ * runMain(command, { version: "1.0.0" });
+ * ```
+ */
+declare function runMain(command: AnyCommand, options?: MainOptions): Promise<never>;
+//#endregion
+//#region ../core/src/output/help-generator.d.ts
+/**
+ * Descriptions for built-in options
+ */
+interface BuiltinOptionDescriptions {
+  /** Description for --help option */
+  help?: string;
+  /** Description for --help-all option */
+  helpAll?: string;
+  /** Description for --version option */
+  version?: string;
+}
+/**
+ * Context for command hierarchy
+ */
+interface CommandContext {
+  /** Full command path (e.g., ["config", "get"]) */
+  commandPath?: string[] | undefined;
+  /** Root command name */
+  rootName?: string | undefined;
+  /** Root command version */
+  rootVersion?: string | undefined;
+  /** Extracted fields from global args schema */
+  globalExtracted?: ExtractedFields | undefined;
+  /** When the command was accessed via an alias, the canonical command name */
+  aliasFor?: string | undefined;
+}
+/**
+ * Options for help generation
+ */
+interface HelpOptions {
+  /** Show subcommand list */
+  showSubcommands?: boolean | undefined;
+  /** Show subcommand options */
+  showSubcommandOptions?: boolean | undefined;
+  /** Custom descriptions for built-in options */
+  descriptions?: BuiltinOptionDescriptions | undefined;
+  /** Command hierarchy context */
+  context?: CommandContext | undefined;
+}
+/**
+ * Generate help text for a command
+ *
+ * @param command - The command to generate help for
+ * @param options - Help generation options
+ * @returns Formatted help text
+ */
+declare function generateHelp(command: AnyCommand, options: HelpOptions): string;
+//#endregion
+//#region ../core/src/output/logger.d.ts
+/**
+ * Enable or disable color output programmatically
+ */
+declare function setColorEnabled(enabled: boolean): void;
+/**
+ * Check if color output is currently enabled
+ */
+declare function isColorEnabled(): boolean;
+/**
+ * Semantic style functions for inline text styling
+ */
+declare const styles: {
+  success: (text: string) => string;
+  error: (text: string) => string;
+  warning: (text: string) => string;
+  info: (text: string) => string;
+  bold: (text: string) => string;
+  dim: (text: string) => string;
+  italic: (text: string) => string;
+  underline: (text: string) => string;
+  red: (text: string) => string;
+  green: (text: string) => string;
+  yellow: (text: string) => string;
+  blue: (text: string) => string;
+  magenta: (text: string) => string;
+  cyan: (text: string) => string;
+  white: (text: string) => string;
+  gray: (text: string) => string;
+  command: (text: string) => string;
+  commandName: (text: string) => string;
+  option: (text: string) => string;
+  optionName: (text: string) => string;
+  placeholder: (text: string) => string;
+  defaultValue: (text: string) => string;
+  required: (text: string) => string;
+  description: (text: string) => string;
+  sectionHeader: (text: string) => string;
+  version: (text: string) => string;
+};
+/**
+ * Standardized symbols for CLI output
+ */
+declare const symbols: {
+  success: string;
+  error: string;
+  warning: string;
+  info: string;
+  bullet: string;
+  arrow: string;
+};
+/**
+ * Logger for CLI output
+ */
+declare const logger: {
+  /**
+   * Log informational message
+   */
+  info(message: string): void;
+  /**
+   * Log success message
+   */
+  success(message: string): void;
+  /**
+   * Log warning message
+   */
+  warn(message: string): void;
+  /**
+   * Log error message
+   */
+  error(message: string): void;
+  /**
+   * Log raw message without prefix
+   */
+  log(message: string): void;
+  /**
+   * Log empty line
+   */
+  newline(): void;
+  /**
+   * Log debug message with dim color
+   */
+  debug(message: string): void;
+};
+//#endregion
+//#region ../core/src/output/markdown-renderer.d.ts
+/**
+ * Lightweight Markdown-to-terminal renderer.
+ *
+ * Supports a subset of Markdown tailored for CLI help notes:
+ * - Inline: bold, italic, inline code, links
+ * - Block: paragraphs, unordered/ordered lists, blockquotes, headings,
+ *          horizontal rules, fenced code blocks
+ */
+/**
+ * Apply inline Markdown formatting to a string.
+ *
+ * Processing order matters to avoid conflicts:
+ *   1. Inline code (backticks) — content inside is literal, no further processing
+ *   2. Bold (**text**)
+ *   3. Italic (*text* or _text_)
+ *   4. Links [text](url)
+ */
+declare function renderInline(text: string): string;
+/**
+ * Render a Markdown string to styled terminal output.
+ *
+ * Block-level processing:
+ *   - Splits input into blocks separated by blank lines
+ *   - Detects headings, horizontal rules, blockquotes, lists, code blocks, and paragraphs
+ *   - Applies inline formatting within each block
+ */
+declare function renderMarkdown(markdown: string): string;
+//#endregion
+//#region ../core/src/parser/argv-parser.d.ts
+/**
+ * Parsed arguments result
+ */
+interface ParsedArgv {
+  /** Named options (--flag, -f) */
+  options: Record<string, unknown>;
+  /** Positional arguments */
+  positionals: string[];
+  /** Arguments after -- */
+  rest: string[];
+}
+/**
+ * Parser options
+ */
+interface ParserOptions {
+  /** Alias map (short -> long) */
+  aliasMap?: Map<string, string>;
+  /** Boolean flags (no value expected) */
+  booleanFlags?: Set<string>;
+  /** Array flags (can be repeated) */
+  arrayFlags?: Set<string>;
+  /**
+   * All known canonical option names (as defined in the schema).
+   * Used to disambiguate negation: when `--no-flag` or `--noFlag` matches
+   * a name in this set, it is treated as a regular option rather than
+   * boolean negation of `flag`.
+   */
+  definedNames?: Set<string>;
+  /**
+   * Map from a custom negation CLI name (and camelCase variant) to the
+   * canonical field name. Used to recognize user-defined boolean negation
+   * options (e.g. `--disable-cache` → `{ cache: false }`).
+   */
+  negationMap?: Map<string, string>;
+  /**
+   * Canonical field names whose default `--no-<name>` / `--no<Name>`
+   * negation forms are suppressed. When omitted, every field in
+   * `booleanFlags` has default negation suppressed.
+   */
+  defaultNegationDisabledFields?: Set<string>;
+}
+/**
+ * Parse argv into a flat record
+ *
+ * Supports:
+ * - Long options: --flag, --flag=value, --flag value
+ * - Short options: -f, -f=value, -f value
+ * - Combined short options: -abc (treated as -a -b -c if all are boolean)
+ * - Positional arguments
+ * - -- to stop parsing options
+ * - Boolean negation: --no-flag, --noFlag (requires `booleanFlags` and `negation: true`)
+ *
+ * **Note:** When using negation detection (`--noFlag` / `--no-flag`),
+ * supply `definedNames` so that options whose names happen to start with
+ * "no" (e.g. `noDryRun`) are not mistaken for negation of another flag.
+ * Without `definedNames`, all `--noX` forms matching a boolean flag will
+ * be treated as negation.
+ *
+ * @param argv - Command line arguments
+ * @param options - Parser options
+ * @returns Parsed arguments
+ */
+declare function parseArgv(argv: string[], options?: ParserOptions): ParsedArgv;
+//#endregion
+//#region ../core/src/validator/args-validator.d.ts
+/**
+ * Format validation errors for display
+ */
+declare function formatValidationErrors(errors: ValidationError[]): string;
+//#endregion
+//#region ../core/src/validator/validation-errors.d.ts
+/**
+ * Error thrown when positional argument configuration is invalid
+ */
+declare class PositionalConfigError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when a reserved alias is used
+ */
+declare class ReservedAliasError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when duplicate field names are detected
+ */
+declare class DuplicateFieldError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when duplicate aliases are detected
+ */
+declare class DuplicateAliasError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when fields are case variants of each other (e.g. "my-option" and "myOption")
+ */
+declare class CaseVariantCollisionError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when a custom boolean negation name collides with another
+ * field's name, cliName, alias, or another field's negation (including
+ * derived camelCase variants).
+ */
+declare class DuplicateNegationError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when a field name collides with a reserved, framework-injected
+ * key on the final args object (e.g. `$source`).
+ */
+declare class ReservedFieldNameError extends Error {
+  constructor(message: string);
+}
+/**
+ * Error thrown when a global field and a same-named local field have
+ * different definitions (per `extractFields()`'s type bucket, whether the
+ * field is positional, and enum values). Only exactly-matching definitions
+ * are allowed to share a name across global/local schemas — anything else
+ * is rejected at validation time rather than risking a value from one
+ * schema silently flowing into the other.
+ */
+declare class FieldTypeConflictError extends Error {
+  constructor(message: string);
+}
+//#endregion
+//#region ../core/src/validator/command-validator.d.ts
+/**
+ * Error detail for command validation
+ */
+interface CommandValidationError {
+  /** Path to the command (e.g., ["cli", "build", "watch"]) */
+  commandPath: string[];
+  /** Error type */
+  type: "duplicate_field" | "duplicate_alias" | "invalid_alias" | "positional_config" | "reserved_alias" | "reserved_field_name" | "case_variant_collision" | "duplicate_negation" | "field_type_conflict";
+  /** Error message */
+  message: string;
+  /** Related field name (if applicable) */
+  field?: string;
+}
+/**
+ * Result of command validation
+ */
+type CommandValidationResult = {
+  valid: true;
+} | {
+  valid: false;
+  errors: CommandValidationError[];
+};
+/**
+ * Options for validateCommand
+ */
+interface ValidateCommandOptions {
+  /** Starting command path (for nested validation) */
+  commandPath?: string[];
+  /**
+   * Global args schema to check the command tree against for cross-schema
+   * field collisions (case-variant collisions and `FieldTypeConflictError`
+   * conflicts) -- the same check `runCommand()` performs per-invocation at
+   * parse time, but here applied eagerly to every command and subcommand
+   * regardless of which subcommand path actually gets invoked at runtime.
+   */
+  globalArgs?: ArgsSchema$1;
+}
+/**
+ * Validate that no duplicate field names exist
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {DuplicateFieldError} If duplicate field names are found
+ */
+declare function validateDuplicateFields(extracted: ExtractedFields): void;
+/**
+ * Validate that no duplicate aliases exist
+ *
+ * Also checks for conflicts between aliases and field names
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {DuplicateAliasError} If duplicate aliases are found or alias conflicts with field name
+ */
+declare function validateDuplicateAliases(extracted: ExtractedFields): void;
+/**
+ * Validate positional argument configuration
+ *
+ * Rules:
+ * - Array positional arguments must be the last positional
+ * - No positional arguments can follow an array positional
+ * - Required positional arguments cannot follow optional positional arguments
+ * - Array positional and optional positional cannot be used together (ambiguous parsing)
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {PositionalConfigError} If configuration is invalid
+ */
+declare function validatePositionalConfig(extracted: ExtractedFields): void;
+/**
+ * Validate that no reserved aliases are used without explicit override
+ *
+ * Reserved aliases:
+ * - 'h' is reserved for --help
+ * - 'H' is reserved for --help-all
+ *
+ * Users can override these by setting overrideBuiltinAlias: true
+ *
+ * @param extracted - Extracted fields from schema
+ * @param _hasSubCommands - Whether the command has subcommands (reserved for future use)
+ * @throws {ReservedAliasError} If a reserved alias is used without override flag
+ */
+declare function validateReservedAliases(extracted: ExtractedFields, _hasSubCommands: boolean): void;
+/**
+ * Validate that no field name starts with `$`
+ *
+ * The `$` prefix is reserved for framework-injected helpers on the final
+ * args object (e.g. `$source`), and is unusable as a real CLI flag anyway
+ * since an unquoted `$name` gets shell-expanded before the program sees it.
+ *
+ * Checking `field.name` alone is sufficient: aliases can't start with `$`
+ * (schema extraction already restricts alias characters to `[A-Za-z0-9-]`),
+ * and `cliName` is derived from `name` via `toKebabCase`, which never strips
+ * or moves a leading `$`. See {@link checkReservedFieldNames}.
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {ReservedFieldNameError} If a field name starts with "$"
+ */
+declare function validateReservedFieldNames(extracted: ExtractedFields): void;
+/**
+ * Validate that custom boolean negation names do not collide with anything
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {DuplicateNegationError} If a colliding negation is found
+ */
+declare function validateDuplicateNegations(extracted: ExtractedFields): void;
+/**
+ * Validate that no case-variant collisions exist
+ *
+ * @param extracted - Extracted fields from schema
+ * @throws {CaseVariantCollisionError} If case-variant collisions are found
+ */
+declare function validateCaseVariantCollisions(extracted: ExtractedFields): void;
+/**
+ * Validate that no cross-schema collisions exist between two schemas
+ * (e.g., global args and command args): neither a case-variant collision
+ * (same canonical name, different spelling) nor a same-named field with a
+ * different definition (same spelling, but the two schemas don't agree on
+ * what values are valid).
+ *
+ * @param extractedA - Extracted fields from first schema (e.g., global args)
+ * @param extractedB - Extracted fields from second schema (e.g., command args)
+ * @throws {CaseVariantCollisionError} If cross-schema case-variant collisions are found
+ * @throws {FieldTypeConflictError} If a same-named field has a different definition on each schema
+ */
+declare function validateCrossSchemaCollisions(extractedA: ExtractedFields, extractedB: ExtractedFields): void;
+/**
+ * Validate a command and all its subcommands recursively
+ *
+ * This function collects all validation errors without throwing,
+ * making it suitable for test assertions.
+ *
+ * @param command - The command to validate
+ * @param options - Validation options
+ * @returns Validation result with all errors collected
+ *
+ * @example
+ * ```ts
+ * const result = await validateCommand(myCommand);
+ * if (!result.valid) {
+ *   console.error(result.errors);
+ * }
+ * ```
+ */
+declare function validateCommand(command: AnyCommand, options?: ValidateCommandOptions): Promise<CommandValidationResult>;
+/**
+ * Format command validation errors for display
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error message
+ */
+declare function formatCommandValidationErrors(errors: CommandValidationError[]): string;
+//#endregion
+//#region src/index.d.ts
+/**
+ * Supported schema types for args in this package: zod schemas whose
+ * output is an object. Narrows `@politty/core`'s Standard-Schema-based
+ * `ArgsSchema` back to politty's historical zod-typed public surface.
+ */
+type ArgsSchema = z.ZodType<Record<string, any>>;
+declare const defineCommand: DefineCommandFn<ArgsSchema>;
+declare const createDefineCommand: CreateDefineCommandFn<ArgsSchema>;
+declare const arg: ArgFn<z.ZodType>;
+//#endregion
+export { type AnyCommand, type ArgFn, type ArgMeta, type ArgSource, ArgsSchema, type BoundDefineCommandFn, type BuiltinOptionDescriptions, type CamelCase, CaseVariantCollisionError, type CleanupContext, type CollectedLogs, type Command, type CommandBase, type CommandContext, type CommandValidationError, type CommandValidationResult, type CompletionDirectiveMask, type CompletionMeta, type CompletionOptions, type CompletionResult, type CompletionType, type CreateDefineCommandFn, type CustomCompletion, type DefineCommandFn, DuplicateAliasError, DuplicateFieldError, DuplicateNegationError, type DynamicCompletionCandidate, type DynamicCompletionContext, type DynamicCompletionResolver, type DynamicCompletionResult, type EffectContext, type Example, type ExpandCandidate, type ExpandCompletion, type ExtractedFields, FieldTypeConflictError, type GenerateBundledCompletionWorkerOptions, type GenerateBundledCompletionWorkerResult, type GenerateCompileCacheShimOptions, type GenerateCompileCacheShimResult, type GlobalArgs, type GlobalCleanupContext, type GlobalSetupContext, type HelpOptions, type InferSchemaOutput, type KebabCase, type LazyCommand, type LogEntry, type LogLevel, type LogStream, type Logger, type MainOptions, type MergedArgs, type NonRunnableCommand, type ParsedArgv, type ParserOptions, PositionalConfigError, type PromptMeta, type PromptResolver, type PromptType, ReservedAliasError, ReservedFieldNameError, type ResolvedExpandCandidate, type ResolvedFieldMeta, type RunCommandOptions, type RunResult, type RunResultFailure, type RunResultSuccess, type RunnableCommand, type SchemaLike, type SetupContext, type SubCommandValue, type SubCommandsRecord, type UnknownKeysMode, type UnknownSubcommandHandler, type ValidateArgMeta, type ValidationError, type ValidationResult, type WithCaseVariants, type WithCompletionOptions, arg, createDefineCommand, createDualCaseProxy, defineCommand, extractFields, formatCommandValidationErrors, formatValidationErrors, generateBundledCompletionWorker, generateCompileCacheShim, generateCompletion, generateHelp, getUnknownKeysMode, isColorEnabled, isLazyCommand, lazy, logger, parseArgv, renderInline, renderMarkdown, runCommand, runMain, setColorEnabled, styles, symbols, toCamelCase, toKebabCase, validateCaseVariantCollisions, validateCommand, validateCrossSchemaCollisions, validateDuplicateAliases, validateDuplicateFields, validateDuplicateNegations, validatePositionalConfig, validateReservedAliases, validateReservedFieldNames, withCompletionCommand };