@politty/zod 0.0.0

package/dist/arg-registry-YaWTVu_x.d.ts

@@ -0,0 +1,1025 @@
+//#region ../core/src/adapter/standard-schema.d.ts
+/**
+ * Type-level subset of the Standard Schema V1 interface
+ * (https://standardschema.dev), vendored so `@politty/core` can constrain
+ * and infer user schemas without importing any schema library.
+ *
+ * Both zod v4 and valibot v1 type their schemas against the official
+ * `@standard-schema/spec` interface, so any schema from either library is
+ * structurally assignable to {@link SchemaLike}. Only the properties core
+ * needs for constraints and output inference are declared here — extra
+ * properties on the real `~standard` object don't affect assignability.
+ *
+ * This is a TYPE-ONLY neutrality layer: core never calls
+ * `~standard.validate` (rich validation goes through the registered
+ * `ValidatorAdapter` so error output keeps library-specific detail).
+ */
+/** The `~standard` properties politty relies on. */
+interface StandardSchemaProps<Output = unknown> {
+  /** Version of the Standard Schema spec the library implements */
+  readonly version: 1;
+  /** Name of the implementing library (e.g. "zod", "valibot") */
+  readonly vendor: string;
+  /** Standard validation entry point (unused by politty; see module doc) */
+  readonly validate: (value: unknown) => unknown;
+  /** Type-inference carrier (never exists at runtime) */
+  readonly types?: {
+    readonly output: Output;
+  } | undefined;
+}
+/**
+ * A schema from any Standard Schema implementing library, constrained by
+ * its output type.
+ *
+ * A primitive cannot satisfy this (it has no `~standard` property), which is
+ * what matters in practice: schemas are used as `WeakMap` keys by the
+ * `arg()` metadata registry. Intersecting with `object` would not add
+ * safety — TypeScript still accepts a hand-written `string & SchemaLike<…>`
+ * against an object-constrained type, and such a value throws
+ * `Invalid value used as weak map key` the moment `arg()` registers it.
+ */
+interface SchemaLike<Output = unknown> {
+  readonly "~standard": StandardSchemaProps<Output>;
+}
+/** Infer the output type of a {@link SchemaLike}. */
+type InferSchemaOutput<S> = S extends SchemaLike ? NonNullable<S["~standard"]["types"]>["output"] : never;
+//#endregion
+//#region ../core/src/adapter/field-meta.d.ts
+/**
+ * Resolved metadata for an argument field
+ */
+interface ResolvedFieldMeta {
+  /** Field name (camelCase, as defined in schema) */
+  name: string;
+  /** CLI option name (kebab-case, for command line usage) */
+  cliName: string;
+  /**
+   * Aliases for this option, normalized to an array.
+   * 1-char entries are short aliases (`-v`); multi-char entries are long
+   * aliases (`--to-be`).
+   */
+  alias?: string[] | undefined;
+  /**
+   * Aliases that are accepted at parse time but hidden from help,
+   * generated docs, and shell completion.
+   */
+  hiddenAlias?: string[] | undefined;
+  /** Argument description */
+  description?: string | undefined;
+  /** Whether this is a positional argument */
+  positional: boolean;
+  /** Placeholder for help display */
+  placeholder?: string | undefined;
+  /**
+   * Environment variable name(s) to read value from.
+   * If an array, earlier entries take priority.
+   */
+  env?: string | string[] | undefined;
+  /** Whether this argument is required */
+  required: boolean;
+  /** Default value if any */
+  defaultValue?: unknown;
+  /** Detected type from schema */
+  type: "string" | "number" | "boolean" | "array" | "unknown";
+  /**
+   * Original field schema, carried through opaquely for downstream
+   * consumers. Its concrete type belongs to the adapter's schema library
+   * (zod, valibot, or an internal descriptor); core never calls into it.
+   */
+  schema: unknown;
+  /** True if this overrides built-in aliases (-h, -H) */
+  overrideBuiltinAlias?: true;
+  /** Enum values if detected from schema (z.enum) */
+  enumValues?: string[] | undefined;
+  /** Completion metadata from arg() */
+  completion?: CompletionMeta | undefined;
+  /** Prompt metadata from arg() for interactive input */
+  prompt?: PromptMeta | undefined;
+  /**
+   * Negation configuration for this boolean field.
+   *
+   * - String (e.g. `"disable-cache"`): the default `--no-<cliName>` form is
+   *   suppressed and only `--<negation>` (plus its camelCase variant) is
+   *   accepted as the negation flag.
+   * - `true`: the default `--no-<cliName>` form is accepted **and** shown in
+   *   help, generated docs, and shell completions.
+   * - `false`: neither the default `--no-<cliName>` nor any custom name is
+   *   accepted; the field only responds to the positive flag.
+   * - `undefined`: no negation form is accepted or shown.
+   *
+   * Only applies to boolean fields; populated as `undefined` otherwise.
+   */
+  negation?: string | boolean | undefined;
+  /**
+   * Derived display name (no `--` prefix) for the negation flag in help,
+   * generated docs, and shell completions. `undefined` means the negation
+   * is hidden from those surfaces. Computed from `negation` + `cliName`.
+   */
+  negationDisplay?: string | undefined;
+  /** Description shown for the negation option in help/docs. */
+  negationDescription?: string | undefined;
+  /** Side-effect callback from arg() metadata */
+  effect?: ((value: unknown, context: EffectContext) => void | PromiseLike<void>) | undefined;
+}
+/**
+ * Extracted fields from a schema
+ */
+interface ExtractedFields {
+  /** All field definitions */
+  fields: ResolvedFieldMeta[];
+  /** Original schema for validation */
+  schema: ArgsSchema;
+  /** Schema type */
+  schemaType: "object" | "discriminatedUnion" | "union" | "xor" | "intersection";
+  /** Discriminator key (for discriminatedUnion) */
+  discriminator?: string;
+  /** Variants (for discriminatedUnion) */
+  variants?: Array<{
+    discriminatorValue: string;
+    fields: ResolvedFieldMeta[];
+    description?: string;
+  }>;
+  /** Options (for union) */
+  unionOptions?: ExtractedFields[];
+  /** Schema description */
+  description?: string;
+  /**
+   * Unknown keys handling mode
+   * - "strict": Unknown keys cause validation errors (z.strictObject or z.object().strict())
+   * - "strip": Unknown keys trigger warnings (default, z.object())
+   * - "passthrough": Unknown keys are silently ignored (z.looseObject or z.object().passthrough())
+   */
+  unknownKeysMode: UnknownKeysMode;
+}
+/**
+ * Unknown keys handling mode for object schemas
+ * - "strict": Unknown keys cause validation errors
+ * - "strip": Unknown keys are silently ignored (default)
+ * - "passthrough": Unknown keys are passed through
+ */
+type UnknownKeysMode = "strict" | "strip" | "passthrough";
+/**
+ * Convert camelCase to kebab-case
+ * @example toKebabCase("dryRun") => "dry-run"
+ * @example toKebabCase("outputDir") => "output-dir"
+ * @example toKebabCase("XMLParser") => "xml-parser"
+ */
+declare function toKebabCase(str: string): string;
+/**
+ * Convert hyphen-separated sequences to camelCase.
+ *
+ * Replaces `-x` (hyphen followed by a lowercase letter) with the uppercase
+ * variant. Non-hyphenated input (e.g., already camelCase) is returned as-is.
+ *
+ * @param str - A string that may contain hyphens
+ * @example toCamelCase("dry-run") => "dryRun"
+ * @example toCamelCase("output-dir") => "outputDir"
+ * @example toCamelCase("dryRun") => "dryRun"
+ */
+declare function toCamelCase(str: string): string;
+//#endregion
+//#region ../core/src/lazy.d.ts
+/**
+ * A lazily-loaded command that carries synchronous metadata for
+ * static analysis (completion, help) while deferring full module
+ * loading to execution time.
+ */
+interface LazyCommand<T extends AnyCommand = AnyCommand> {
+  readonly __politty_lazy__: true;
+  readonly meta: T;
+  readonly load: () => Promise<AnyCommand>;
+}
+/**
+ * Type guard: check if a value is a LazyCommand
+ */
+declare function isLazyCommand(value: unknown): value is LazyCommand;
+/**
+ * Create a lazily-loaded subcommand with synchronous metadata.
+ *
+ * The `meta` command provides names, descriptions, and args schema
+ * for static analysis (completion scripts, help text) without loading
+ * the full command module.
+ *
+ * The `load` function is called only at execution time.
+ *
+ * @example
+ * ```ts
+ * import { lazy, defineCommand } from "politty";
+ *
+ * const cli = defineCommand({
+ *   name: "mycli",
+ *   subCommands: {
+ *     deploy: lazy(
+ *       defineCommand({
+ *         name: "deploy",
+ *         description: "Deploy the application",
+ *         args: z.object({ env: arg(z.string()) }),
+ *       }),
+ *       () => import("./deploy.js").then((m) => m.deployCommand),
+ *     ),
+ *   },
+ * });
+ * ```
+ */
+declare function lazy<T extends AnyCommand>(meta: T, load: () => Promise<AnyCommand>): LazyCommand<T>;
+//#endregion
+//#region ../core/src/types.d.ts
+/**
+ * Global args interface for declaration merging (Pattern 3).
+ * Users can extend this interface to add global options to all commands:
+ *
+ * ```ts
+ * declare module "politty" {
+ *   interface GlobalArgs { verbose: boolean; config?: string; }
+ * }
+ * ```
+ */
+interface GlobalArgs {}
+/**
+ * Detect empty interface (used for GlobalArgs declaration merging)
+ */
+type IsEmpty<T> = keyof T extends never ? true : false;
+/**
+ * Where a resolved arg value came from:
+ * - `"cli"`: an explicit CLI token (flag or positional)
+ * - `"env"`: `field.env` fallback (no CLI token was provided)
+ * - `"default"`: neither of the above (e.g. a schema default, or a value
+ *   resolved by a `prompt` handler)
+ */
+type ArgSource = "cli" | "env" | "default";
+/**
+ * Example definition for a command
+ */
+interface Example {
+  /** Command arguments to execute (e.g., "World" or "--loud Alice") */
+  cmd: string;
+  /** Description of the example */
+  desc: string;
+  /** Expected output (optional, for documentation) */
+  output?: string;
+}
+/**
+ * Logger interface for CLI output
+ * Can be overridden by passing a custom logger to runMain or runCommand
+ */
+interface Logger {
+  /** Log informational message to stdout */
+  log(message: string): void;
+  /** Log error message to stderr */
+  error(message: string): void;
+  /** Log warning message to stderr */
+  warn?(message: string): void;
+}
+/**
+ * Supported schema types for args: any Standard Schema (zod, valibot, ...)
+ * whose output is an object. Adapter packages narrow this back to their
+ * library's own schema type in their public exports (e.g. `@politty/zod`
+ * exports `ArgsSchema = z.ZodType<Record<string, any>>`).
+ */
+type ArgsSchema = SchemaLike<Record<string, any>>;
+/**
+ * Context provided to setup function
+ */
+interface SetupContext<TArgs = unknown> {
+  /** Parsed and validated arguments */
+  args: TArgs;
+}
+/**
+ * Context provided to cleanup function
+ */
+interface CleanupContext<TArgs = unknown> {
+  /** Parsed and validated arguments */
+  args: TArgs;
+  /** Error if command execution failed */
+  error?: Error | undefined;
+}
+/**
+ * Context provided to global setup function (runMain/runCommand level)
+ */
+interface GlobalSetupContext {}
+/**
+ * Context provided to global cleanup function (runMain/runCommand level)
+ */
+interface GlobalCleanupContext {
+  /** Error if command execution failed */
+  error?: Error | undefined;
+}
+/**
+ * Base command interface (shared properties)
+ * @template TArgsSchema - The args schema type (from the CLI's schema library)
+ * @template TArgs - The inferred args type from the schema
+ */
+interface CommandBase<TArgsSchema extends ArgsSchema | undefined = undefined, TArgs = unknown> {
+  /** Command name (required) */
+  name: string;
+  /** Command description */
+  description?: string | undefined;
+  /** Alternative names for this command (used as subcommand aliases) */
+  aliases?: string[] | undefined;
+  /** Argument schema (preserves the original schema type) */
+  args: TArgsSchema;
+  /** Subcommands */
+  subCommands?: SubCommandsRecord | undefined;
+  /** Setup hook */
+  setup?: ((context: SetupContext<TArgs>) => void | Promise<void>) | undefined;
+  /** Cleanup hook */
+  cleanup?: ((context: CleanupContext<TArgs>) => void | Promise<void>) | undefined;
+  /** Additional notes */
+  notes?: string | undefined;
+  /** Example usages for this command */
+  examples?: Example[] | undefined;
+  /**
+   * @internal
+   * Hook invoked once at the top of `runMain`, before any parsing. Used
+   * by `withCompletionCommand` to fire its detached background-refresh
+   * spawn. Best-effort; never throws.
+   */
+  runMainHook?: ((argv: readonly string[]) => void) | undefined;
+}
+/**
+ * A command with a run function
+ * @template TArgsSchema - The args schema type (from the CLI's schema library)
+ * @template TArgs - The inferred args type from the schema
+ * @template TResult - The return type of the run function
+ */
+interface RunnableCommand<TArgsSchema extends ArgsSchema | undefined = undefined, TArgs = unknown, TResult = unknown> extends CommandBase<TArgsSchema, TArgs> {
+  /** Main run function */
+  run: (args: TArgs) => TResult;
+}
+/**
+ * A command without a run function (e.g., subcommand-only parent)
+ * @template TArgsSchema - The args schema type (from the CLI's schema library)
+ * @template TArgs - The inferred args type from the schema
+ */
+interface NonRunnableCommand<TArgsSchema extends ArgsSchema | undefined = undefined, TArgs = unknown> extends CommandBase<TArgsSchema, TArgs> {
+  /** No run function */
+  run?: undefined;
+}
+/**
+ * A defined command (union of runnable and non-runnable)
+ */
+type Command<TArgsSchema extends ArgsSchema | undefined = undefined, TArgs = unknown, TResult = unknown> = RunnableCommand<TArgsSchema, TArgs, TResult> | NonRunnableCommand<TArgsSchema, TArgs>;
+/**
+ * Type alias for any args type.
+ * Note: `any` is required here due to TypeScript's function parameter contravariance.
+ * Using `unknown` would make it impossible to assign concrete command types to AnyCommand.
+ * @internal
+ */
+type AnyArgs = any;
+/**
+ * Type alias for any result type.
+ * @internal
+ */
+type AnyResult = any;
+/**
+ * Command type that accepts any args/result types
+ * Used in internal functions that don't need specific type information
+ */
+type AnyCommand = Command<ArgsSchema | undefined, AnyArgs, AnyResult>;
+/**
+ * Subcommand value type (either a command or a lazy-loaded command)
+ */
+type SubCommandValue = AnyCommand | (() => Promise<AnyCommand>) | LazyCommand;
+/**
+ * Record of subcommands indexed by name
+ */
+type SubCommandsRecord = Record<string, SubCommandValue>;
+/**
+ * Async callback to resolve missing argument values interactively.
+ * Called after env fallback, before schema validation.
+ * Provided by adapter subpath modules (e.g. `politty/prompt/clack`).
+ */
+type PromptResolver = (rawArgs: Record<string, unknown>, extracted: ExtractedFields) => Promise<Record<string, unknown>>;
+/**
+ * Options for runMain (CLI entry point)
+ */
+interface MainOptions {
+  /** Command version */
+  version?: string;
+  /** Enable debug mode (show stack traces on errors) */
+  debug?: boolean;
+  /** Capture console output during execution (default: false) */
+  captureLogs?: boolean;
+  /** Skip command definition validation (useful in production where tests already verified) */
+  skipValidation?: boolean;
+  /** Custom logger for output (default: console) */
+  logger?: Logger;
+  /** Global args schema (shared across all subcommands) */
+  globalArgs?: ArgsSchema;
+  /** Global setup hook (runs before command execution) */
+  setup?: ((context: GlobalSetupContext) => void | Promise<void>) | undefined;
+  /** Global cleanup hook (runs after command execution, always executes even on error) */
+  cleanup?: ((context: GlobalCleanupContext) => void | Promise<void>) | undefined;
+  /** Whether to display errors to stderr before process.exit (default: true) */
+  displayErrors?: boolean;
+  /** Prompt resolver for interactive missing-arg prompts (e.g. from `politty/prompt/clack`). */
+  prompt?: PromptResolver | undefined;
+  /**
+   * Fallback hook for CLI plugin dispatch, invoked when a positional is not a
+   * known subcommand at any level whose command exposes subcommands (e.g. exec
+   * an external `<cli>-<path...>-<name>` binary).
+   *
+   * Return a number to treat it as handled and exit with that code; return
+   * `undefined` (or omit) to fall back to the default unknown-subcommand/help
+   * behavior. Not invoked for internal `__*` subcommands.
+   */
+  onUnknownSubcommand?: UnknownSubcommandHandler | undefined;
+  /**
+   * Node.js on-disk compile cache (V8 code cache) control. `runMain` enables
+   * it before executing the command so dynamically imported modules (e.g.
+   * `lazy()` subcommands) skip recompilation on warm starts (Node >= 22.8.0;
+   * no-op otherwise).
+   * - omitted / `true`: derive the directory from the command name
+   *   (`${XDG_CACHE_HOME:-$HOME/.cache}/<sanitized name>/node-compile-cache`,
+   *   shared with shell-completion workers; the name is reduced to a single
+   *   safe path segment, e.g. `@scope/cli` → `scope-cli`)
+   * - `string`: use this cache directory
+   * - `false`: do not enable
+   *
+   * The `NODE_COMPILE_CACHE` environment variable always takes precedence.
+   * Note: the entry module's static import graph is compiled before `runMain`
+   * runs and cannot be cached here — see `politty/compile-cache` for the
+   * bin-shim pattern that covers it.
+   */
+  compileCache?: boolean | string;
+}
+/**
+ * Handler for an unrecognized subcommand. See {@link MainOptions.onUnknownSubcommand}.
+ */
+type UnknownSubcommandHandler = (context: {
+  /**
+   * Known subcommand names traversed before the unknown name (excludes the
+   * root command name). Empty at the root level.
+   */
+  commandPath: readonly string[];
+  /** The unrecognized subcommand name (first unmatched positional). */
+  name: string;
+  /** Args following the name, forwarded verbatim to the plugin. */
+  args: readonly string[];
+  /**
+   * Option tokens the host consumed before the unknown name across every
+   * traversed level (e.g. global flags typed before the plugin command),
+   * excluding the traversed subcommand names themselves. Concatenate with
+   * `args` to reconstruct the user's full flag set when forwarding to a
+   * plugin: `[...precedingArgs, ...args]`.
+   */
+  precedingArgs: readonly string[];
+}) => number | undefined | Promise<number | undefined>;
+/**
+ * Options for runCommand (programmatic/test usage)
+ */
+interface RunCommandOptions {
+  /** Enable debug mode (show stack traces on errors) */
+  debug?: boolean;
+  /** Capture console output during execution (default: false) */
+  captureLogs?: boolean;
+  /** Skip command definition validation (useful in production where tests already verified) */
+  skipValidation?: boolean;
+  /** Custom logger for output (default: console) */
+  logger?: Logger;
+  /** Global args schema (shared across all subcommands) */
+  globalArgs?: ArgsSchema;
+  /** Global setup hook (runs before command execution) */
+  setup?: ((context: GlobalSetupContext) => void | Promise<void>) | undefined;
+  /** Global cleanup hook (runs after command execution, always executes even on error) */
+  cleanup?: ((context: GlobalCleanupContext) => void | Promise<void>) | undefined;
+  /** Prompt resolver for interactive missing-arg prompts (e.g. from `politty/prompt/clack`). */
+  prompt?: PromptResolver | undefined;
+}
+/**
+ * Log level type
+ */
+type LogLevel = "log" | "info" | "debug" | "warn" | "error";
+/**
+ * Output stream type
+ */
+type LogStream = "stdout" | "stderr";
+/**
+ * A single log entry collected during command execution
+ */
+interface LogEntry {
+  /** Log message */
+  message: string;
+  /** Timestamp when the log was recorded */
+  timestamp: Date;
+  /** Log level */
+  level: LogLevel;
+  /** Output stream (stdout or stderr) */
+  stream: LogStream;
+}
+/**
+ * Collected logs during command execution
+ */
+interface CollectedLogs {
+  /** All log entries in order */
+  entries: LogEntry[];
+}
+/**
+ * Successful command execution result
+ */
+interface RunResultSuccess<T = unknown> {
+  /** Indicates successful execution */
+  success: true;
+  /** Command return value */
+  result: T | undefined;
+  /** Error that occurred during execution */
+  error?: never;
+  /** Exit code (always 0 for success) */
+  exitCode: 0;
+  /** Collected logs during execution */
+  logs: CollectedLogs;
+}
+/**
+ * Failed command execution result
+ */
+interface RunResultFailure {
+  /** Indicates failed execution */
+  success: false;
+  /** Command return value */
+  result?: never;
+  /** Error that occurred during execution */
+  error: Error;
+  /** Exit code (non-zero for failure) */
+  exitCode: number;
+  /** Collected logs during execution */
+  logs: CollectedLogs;
+}
+/**
+ * Result of command execution (discriminated union)
+ */
+type RunResult<T = unknown> = RunResultSuccess<T> | RunResultFailure;
+//#endregion
+//#region ../core/src/core/dynamic-completion-types.d.ts
+/**
+ * Types for in-process dynamic value completion.
+ *
+ * A `resolve` callback registered on `arg(...)` receives parsed context
+ * (other arg values typed so far, previous values supplied to the same
+ * option, the current word being completed, target shell) and returns
+ * candidates. The callback runs inside the `__complete` command. Dispatcher
+ * shell scripts call `__complete` for every completion request; static shell
+ * scripts delegate to it for any spec that uses `resolve`.
+ *
+ * Defined under `core/` (not `completion/`) so `arg-registry.ts` can
+ * reference the resolver type without crossing the lint-enforced
+ * `completion → core` boundary.
+ */
+/** Bitmask combining `CompletionDirective` values. */
+type CompletionDirectiveMask = number;
+interface DynamicCompletionContext {
+  /** Word being completed. `--field=` inline prefix is stripped before this is set. */
+  currentWord: string;
+  /** Target shell formatting requested by the caller. */
+  shell: "bash" | "zsh" | "fish";
+  /**
+   * Best-effort parsed values of OTHER args on the same command, keyed by
+   * camelCase name. Includes positionals and other options. Zod validation
+   * is NOT applied; values are raw strings (or arrays of raw strings for
+   * array-typed options/variadic positionals).
+   */
+  parsedArgs: Readonly<Record<string, unknown>>;
+  /**
+   * Values already supplied for the SAME option/positional being completed.
+   * Useful for de-duplicating repeated array options.
+   */
+  previousValues: readonly string[];
+  /**
+   * Subcommand path from root (e.g. ["api"]). Reflects what the user
+   * actually typed — aliases are NOT resolved to their canonical names, so
+   * resolvers that branch on the path should accept every alias they care
+   * about.
+   */
+  subcommandPath: readonly string[];
+}
+interface DynamicCompletionCandidate {
+  value: string;
+  description?: string;
+}
+interface DynamicCompletionResult {
+  /** Candidates to surface. Strings or `{value, description}` objects. */
+  candidates: Array<string | DynamicCompletionCandidate>;
+  /**
+   * Optional directive override. When omitted, defaults to
+   * `FilterPrefix | NoFileCompletion` (matches `choices` behaviour).
+   */
+  directive?: CompletionDirectiveMask;
+}
+type DynamicCompletionResolver = (ctx: DynamicCompletionContext) => DynamicCompletionResult | Promise<DynamicCompletionResult>;
+//#endregion
+//#region ../core/src/core/expand-completion-types.d.ts
+/**
+ * Types for "expand" completion — candidates that depend on sibling arg
+ * values.
+ *
+ * The user provides `dependsOn` (sibling arg names that must have static
+ * `choices` or an enum schema) and `enumerate(deps)`. Dispatcher scripts call
+ * `enumerate` inside `__complete` for the dependency values already typed on
+ * the command line. Static scripts walk the cartesian product of the
+ * dependsOn values, call `enumerate` for each combination, and emit a shell
+ * lookup table.
+ *
+ * Defined under `core/` (not `completion/`) so `arg-registry.ts` can
+ * reference these types without crossing the lint-enforced
+ * `completion → core` boundary.
+ */
+/** Candidate returned by an `enumerate` callback. */
+interface ExpandCandidate {
+  value: string;
+  description?: string;
+}
+/** Resolved candidate stored on a {@link ValueCompletion} after enumeration. */
+interface ResolvedExpandCandidate {
+  value: string;
+  description?: string;
+}
+/**
+ * User-facing spec attached to `completion.custom.expand`.
+ *
+ * `dependsOn` lists sibling args (camelCase names) whose values determine
+ * which candidates apply. Each named arg must have a static set of values —
+ * either an explicit `completion.custom.choices` or an enum schema. The
+ * order of `dependsOn` is the order in which `deps` keys are exposed to
+ * `enumerate`.
+ *
+ * In dispatcher mode, `enumerate` runs during `__complete` for the dependency
+ * values already typed by the user. In static mode, it runs once per
+ * cartesian-product combination at script-generation time (e.g. when the user
+ * runs `<program> completion zsh --static`). It must be a pure function of
+ * `deps`.
+ */
+interface ExpandCompletion {
+  dependsOn: readonly string[];
+  enumerate: (deps: Readonly<Record<string, string>>) => ReadonlyArray<string | ExpandCandidate>;
+}
+//#endregion
+//#region ../core/src/core/arg-registry.d.ts
+/**
+ * Built-in completion types
+ */
+type CompletionType = "file" | "directory" | "none";
+/**
+ * Custom completion specification.
+ *
+ * `choices`, `shellCommand`, `resolve`, and `expand` are mutually exclusive —
+ * specifying more than one throws when the field metadata is resolved.
+ */
+interface CustomCompletion {
+  /** Static list of choices for completion */
+  choices?: string[];
+  /** Shell command to execute for dynamic completion */
+  shellCommand?: string;
+  /**
+   * In-process JS callback for dynamic completion. Receives parsed context
+   * (other arg values typed so far, previously supplied values for this same
+   * option) and returns candidates. Dispatcher scripts call
+   * `<program> __complete` for every completion request; static scripts
+   * delegate to it whenever this is set.
+   */
+  resolve?: DynamicCompletionResolver;
+  /**
+   * Completion whose candidates depend on sibling arg values. Dispatcher
+   * scripts call `enumerate` inside `__complete` for the dependency values
+   * already typed on the command line. Static scripts pre-enumerate every
+   * combination of `dependsOn` values at script-generation time and dispatch
+   * via a shell lookup table.
+   */
+  expand?: ExpandCompletion;
+}
+/**
+ * Completion metadata for an argument
+ *
+ * @example
+ * ```ts
+ * // File completion with extension filter
+ * input: arg(z.string(), {
+ *   completion: { type: "file", extensions: ["json", "yaml"] }
+ * })
+ *
+ * // Directory completion
+ * outputDir: arg(z.string(), {
+ *   completion: { type: "directory" }
+ * })
+ *
+ * // Custom static choices
+ * logLevel: arg(z.string(), {
+ *   completion: { custom: { choices: ["debug", "info", "warn", "error"] } }
+ * })
+ *
+ * // Dynamic completion from shell command
+ * branch: arg(z.string(), {
+ *   completion: { custom: { shellCommand: "git branch --format='%(refname:short)'" } }
+ * })
+ *
+ * // File completion with glob pattern matcher
+ * envFile: arg(z.string(), {
+ *   completion: { type: "file", matcher: [".env.*"] }
+ * })
+ * ```
+ */
+type CompletionMeta = {
+  /** Built-in completion type */
+  type?: CompletionType;
+  /** Custom completion (takes precedence over type if both specified) */
+  custom?: CustomCompletion;
+} & ({
+  /** File extension filter (only applies when type is "file") */ extensions?: string[];
+  matcher?: never;
+} | {
+  /** Glob patterns for file matching (only applies when type is "file") */ matcher?: string[];
+  extensions?: never;
+});
+/**
+ * Prompt input type for interactive prompts
+ *
+ * - "text": free-form text input (default for string schemas)
+ * - "password": masked text input
+ * - "confirm": yes/no prompt (default for boolean schemas)
+ * - "select": single selection from choices (default for enum schemas)
+ * - "file": file path input (inherited from completion type)
+ * - "directory": directory path input (inherited from completion type)
+ */
+type PromptType = "text" | "password" | "confirm" | "select" | "file" | "directory";
+/**
+ * Prompt metadata for interactive input when a value is missing.
+ * Used by the `politty/prompt` module to request user input for unresolved arguments.
+ *
+ * @example
+ * ```ts
+ * // Custom prompt message
+ * name: arg(z.string(), {
+ *   prompt: { message: "What is your name?" }
+ * })
+ *
+ * // Password input (masked)
+ * token: arg(z.string(), {
+ *   prompt: { type: "password", message: "Enter API token" }
+ * })
+ *
+ * // Select with custom choices
+ * region: arg(z.string(), {
+ *   prompt: { choices: ["us-east-1", "eu-west-1", "ap-northeast-1"] }
+ * })
+ * ```
+ */
+interface PromptMeta {
+  /** Prompt message shown to the user. Defaults to the field's description or name. */
+  message?: string;
+  /** Explicit prompt type. Overrides auto-detection from schema/completion. */
+  type?: PromptType;
+  /** Choices for select prompt. Overrides enum values from schema. */
+  choices?: Array<string | {
+    label: string;
+    value: string;
+  }>;
+  /** Whether to enable prompting for this field (default: true when prompt is set) */
+  enabled?: boolean;
+}
+/**
+ * Context provided to effect callbacks.
+ * When GlobalArgs is extended via declaration merging, `globalArgs` is typed accordingly.
+ */
+type EffectContext = {
+  /** Field name (camelCase) */
+  name: string;
+  /** Validated args for this schema (global args for global effects, command args for command effects) */
+  args: Readonly<Record<string, unknown>>;
+} & (IsEmpty<GlobalArgs> extends true ? {
+  globalArgs?: Readonly<Record<string, unknown>>;
+} : {
+  globalArgs?: Readonly<GlobalArgs>;
+});
+/**
+ * Base metadata shared by all argument types
+ */
+interface BaseArgMeta<TValue = unknown> {
+  /** Argument description */
+  description?: string;
+  /** Treat as positional argument */
+  positional?: boolean;
+  /** Placeholder for help display */
+  placeholder?: string;
+  /**
+   * Environment variable name(s) to read value from.
+   * If an array is provided, earlier entries take priority.
+   * CLI arguments always take precedence over environment variables.
+   *
+   * @example
+   * ```ts
+   * // Single env var
+   * port: arg(z.coerce.number(), { env: "PORT" })
+   *
+   * // Multiple env vars (PORT takes priority over SERVER_PORT)
+   * port: arg(z.coerce.number(), { env: ["PORT", "SERVER_PORT"] })
+   * ```
+   */
+  env?: string | string[];
+  /** Completion configuration for shell tab-completion */
+  completion?: CompletionMeta;
+  /**
+   * Interactive prompt configuration for missing values.
+   * When set, the `politty/prompt` module will prompt the user interactively
+   * if this argument is not provided via CLI args or environment variables.
+   *
+   * @example
+   * ```ts
+   * name: arg(z.string(), {
+   *   description: "User name",
+   *   prompt: { message: "What is your name?" },
+   * })
+   * ```
+   */
+  prompt?: PromptMeta;
+  /**
+   * Control the boolean negation option.
+   *
+   * Boolean fields accept `--no-<cliName>` (and the camelCase `--no<Name>`
+   * form) to set the value to `false` only when `negation: true` is set.
+   * By default no negation form is accepted. This option lets you customize
+   * or expose that behavior:
+   *
+   * - `string` — replaces the auto-generated `--no-*` form with a custom
+   *   name. The default `--no-*` is no longer recognized.
+   * - `true`  — enables the default `--no-<cliName>` form and advertises it
+   *   in help, generated docs, and shell completions.
+   * - `false` — disables negation entirely; same as the default, but explicit.
+   *   Neither the default `--no-*` nor any custom name is accepted.
+   *
+   * String values follow the same naming conventions as `cliName`
+   * (kebab-case is recommended). Only valid on boolean fields; setting
+   * `negation` on a non-boolean field is a type error and raises a
+   * runtime error during command parsing.
+   *
+   * @example
+   * ```ts
+   * // Custom negation name
+   * cache: arg(z.boolean().default(true), {
+   *   description: "Enable caching",
+   *   negation: "disable-cache",
+   * })
+   * // Accepts: --cache (true), --disable-cache (false)
+   * // No longer accepts: --no-cache
+   *
+   * // Enable default `--no-X` in parsing/help/docs/completion
+   * verbose: arg(z.boolean().default(false), {
+   *   negation: true,
+   * })
+   * // Help shows `--verbose / --no-verbose`
+   *
+   * // Disable negation entirely
+   * dryRun: arg(z.boolean().default(false), {
+   *   negation: false,
+   * })
+   * // Accepts: --dry-run (true)
+   * // No longer accepts: --no-dry-run
+   * ```
+   */
+  negation?: string | boolean;
+  /**
+   * Description shown for the negation option in help and generated docs.
+   * Only meaningful when `negation` is set to a custom name string or `true`.
+   * Disallowed when `negation` is `false`.
+   */
+  negationDescription?: string;
+  /**
+   * Side-effect callback executed after argument parsing and validation.
+   * Runs before the command lifecycle (setup/run/cleanup).
+   * Use Zod .transform() for value transformation instead.
+   *
+   * @example
+   * ```ts
+   * verbose: arg(z.boolean().default(false), {
+   *   alias: "v",
+   *   effect: (value) => {
+   *     if (value) logger.setLevel("debug");
+   *   },
+   * })
+   * ```
+   */
+  effect?: (value: TValue, context: EffectContext) => void | PromiseLike<void>;
+}
+/**
+ * Metadata for regular arguments (non-builtin aliases)
+ *
+ * `alias` accepts either a single string or an array of strings.
+ * Single-character entries become short options (e.g. `-v`); multi-character
+ * entries become additional long options (e.g. `--to-be` for `--tobe`).
+ */
+interface RegularArgMeta<TValue = unknown> extends BaseArgMeta<TValue> {
+  /**
+   * Alias name(s) for this option.
+   * - 1-char string  → short alias (`-v`)
+   * - >1-char string → long alias (`--long-name`)
+   * - array          → multiple aliases of either kind
+   */
+  alias?: string | string[] | readonly string[];
+  /**
+   * Alias name(s) that are accepted by the parser but hidden from help,
+   * generated docs, and shell completion. Useful for legacy or deprecated
+   * names that should still work without being advertised.
+   */
+  hiddenAlias?: string | string[] | readonly string[];
+}
+/**
+ * Metadata for overriding built-in aliases (-h, -H)
+ */
+interface BuiltinOverrideArgMeta<TValue = unknown> extends BaseArgMeta<TValue> {
+  /** Built-in alias to override ('h' or 'H'), optionally combined with extra aliases */
+  alias: "h" | "H" | Array<"h" | "H" | string> | ReadonlyArray<"h" | "H" | string>;
+  /** Hidden aliases (accepted but not surfaced in help/docs/completion) */
+  hiddenAlias?: string | string[] | readonly string[];
+  /** Must be true to override built-in aliases */
+  overrideBuiltinAlias: true;
+}
+/**
+ * Metadata options for argument definition
+ */
+type ArgMeta<TValue = unknown> = RegularArgMeta<TValue> | BuiltinOverrideArgMeta<TValue>;
+/**
+ * Register metadata for a schema
+ *
+ * @param schema - The schema to attach metadata to
+ * @param meta - Argument metadata
+ * @returns The same schema (for chaining)
+ *
+ * @example
+ * ```ts
+ * import { z } from "zod";
+ * import { arg, defineCommand } from "politty";
+ *
+ * const cmd = defineCommand({
+ *   args: z.object({
+ *     name: arg(z.string(), { description: "User name", positional: true }),
+ *     verbose: arg(z.boolean().default(false), { alias: "v" }),
+ *   }),
+ *   run: (args) => {
+ *     console.log(args.name, args.verbose);
+ *   },
+ * });
+ * ```
+ */
+/**
+ * Detect whether `A` contains a reserved alias ("h" or "H"), for either a
+ * plain string or a tuple/array of strings. Uses `[A] extends [never]` to
+ * prevent distribution returning `never` for missing fields.
+ */
+type ContainsReservedAlias<A> = [A] extends [never] ? false : A extends "h" | "H" ? true : A extends readonly (infer E)[] ? [Extract<E, "h" | "H">] extends [never] ? false : true : false;
+type ReservedAliasTypeError<M> = { [K in keyof M]: M[K]; } & {
+  __typeError: "Alias 'h' or 'H' requires overrideBuiltinAlias: true";
+};
+type NegationTypeError<M> = { [K in keyof M]: M[K]; } & {
+  __typeError: "negation/negationDescription can only be used on boolean fields";
+};
+type AliasFieldOf<M> = M extends {
+  alias: infer A;
+} ? A : never;
+type HiddenAliasFieldOf<M> = M extends {
+  hiddenAlias: infer H;
+} ? H : never;
+/**
+ * Check whether a Zod output type is a (possibly optional) boolean.
+ * Strips `undefined` to allow `z.boolean().optional()`. Requires both
+ * `boolean extends NonNullable<T>` (so `z.literal(true)` is rejected — the full
+ * `boolean` domain is needed) and `NonNullable<T> extends boolean` (so unions
+ * such as `z.union([z.boolean(), z.string()])` are rejected at the type level
+ * to match the runtime check).
+ */
+type IsBooleanField<T> = boolean extends NonNullable<T> ? ([NonNullable<T>] extends [boolean] ? true : false) : false;
+/**
+ * Detect whether `M` has `K` set to a non-undefined value.
+ *
+ * When `M` is inferred from a literal such as `{ negation: "off" }`,
+ * `M["negation"]` is `"off"` (without `undefined`), so this returns `true`.
+ * When `M` is the wider `ArgMeta` type, `M["negation"]` is
+ * `string | boolean | undefined`, so this returns `false` and avoids
+ * false-positive type errors on broadly-typed meta values.
+ */
+type HasExplicit<M, K extends string> = K extends keyof M ? undefined extends M[K] ? false : true : false;
+/**
+ * Reject `negation` / `negationDescription` on non-boolean fields.
+ * Uses {@link HasExplicit} so the error only fires when the user explicitly
+ * sets the field on a narrowly-inferred meta literal.
+ */
+type ValidateNegation<M, TValue> = HasExplicit<M, "negation"> extends true ? IsBooleanField<TValue> extends true ? M : NegationTypeError<M> : HasExplicit<M, "negationDescription"> extends true ? IsBooleanField<TValue> extends true ? M : NegationTypeError<M> : M;
+/**
+ * Type helper to validate ArgMeta.
+ * Forces a type error when a reserved alias ("h" / "H") is used without
+ * `overrideBuiltinAlias: true`, whether the alias is provided as a string
+ * or as part of an array, and whether it appears in `alias` or `hiddenAlias`.
+ * Also rejects `negation` / `negationDescription` on non-boolean fields.
+ */
+type ValidateArgMeta<M, TValue = unknown> = M extends {
+  overrideBuiltinAlias: true;
+} ? ValidateNegation<M, TValue> : ContainsReservedAlias<AliasFieldOf<M>> extends true ? ReservedAliasTypeError<M> : ContainsReservedAlias<HiddenAliasFieldOf<M>> extends true ? ReservedAliasTypeError<M> : ValidateNegation<M, TValue>;
+/**
+ * The overloaded `arg()` signature, parameterized by the schema constraint.
+ * Core's `arg` accepts any Standard Schema; adapter packages re-pin the same
+ * runtime function to their library's schema type (e.g. `ArgFn<z.ZodType>`
+ * in `@politty/zod`) so a schema from the wrong library is rejected at the
+ * type level.
+ */
+interface ArgFn<TSchemaBase extends SchemaLike = SchemaLike> {
+  <T extends TSchemaBase>(schema: T): T;
+  <T extends TSchemaBase, M extends ArgMeta<InferSchemaOutput<T>>>(schema: T, meta: ValidateArgMeta<M, InferSchemaOutput<T>>): T;
+}
+//#endregion
+export { toKebabCase as $, LogEntry as A, RunResultSuccess as B, Command as C, GlobalCleanupContext as D, GlobalArgs as E, NonRunnableCommand as F, UnknownSubcommandHandler as G, SetupContext as H, PromptResolver as I, lazy as J, LazyCommand as K, RunCommandOptions as L, LogStream as M, Logger as N, GlobalSetupContext as O, MainOptions as P, toCamelCase as Q, RunResult as R, CollectedLogs as S, Example as T, SubCommandValue as U, RunnableCommand as V, SubCommandsRecord as W, ResolvedFieldMeta as X, ExtractedFields as Y, UnknownKeysMode as Z, DynamicCompletionResult as _, CustomCompletion as a, ArgsSchema as b, PromptType as c, ExpandCompletion as d, InferSchemaOutput as et, ResolvedExpandCandidate as f, DynamicCompletionResolver as g, DynamicCompletionContext as h, CompletionType as i, LogLevel as j, IsEmpty as k, ValidateArgMeta as l, DynamicCompletionCandidate as m, ArgMeta as n, EffectContext as o, CompletionDirectiveMask as p, isLazyCommand as q, CompletionMeta as r, PromptMeta as s, ArgFn as t, SchemaLike as tt, ExpandCandidate as u, AnyCommand as v, CommandBase as w, CleanupContext as x, ArgSource as y, RunResultFailure as z };