@optique/core 0.10.0-dev.305 → 0.10.0-dev.307

package/dist/dependency.d.cts

@@ -11,42 +11,42 @@ import { Mode, Suggestion } from "./parser.cjs";
  * {@link ValueParser} instances.
  * @since 0.10.0
  */
-declare const DependencySourceMarker: unique symbol;
+declare const dependencySourceMarker: unique symbol;
 /**
  * A unique symbol used to identify derived value parsers at compile time.
  * This marker is used to distinguish {@link DerivedValueParser} from regular
  * {@link ValueParser} instances.
  * @since 0.10.0
  */
-declare const DerivedValueParserMarker: unique symbol;
+declare const derivedValueParserMarker: unique symbol;
 /**
  * A unique symbol used to store the dependency ID on value parsers.
  * @since 0.10.0
  */
-declare const DependencyId: unique symbol;
+declare const dependencyId: unique symbol;
 /**
  * A unique symbol used to store multiple dependency IDs on derived parsers
  * that depend on multiple sources (created via {@link deriveFrom}).
  * @since 0.10.0
  */
-declare const DependencyIds: unique symbol;
+declare const dependencyIds: unique symbol;
 /**
  * A unique symbol used to store the default values function on derived parsers.
  * This is used during partial dependency resolution to fill in missing values.
  * @since 0.10.0
  */
-declare const DefaultValues: unique symbol;
+declare const defaultValues: unique symbol;
 /**
  * A unique symbol used to access the parseWithDependency method on derived parsers.
  * @since 0.10.0
  */
-declare const ParseWithDependency: unique symbol;
+declare const parseWithDependency: unique symbol;
 /**
  * A unique symbol used to access the suggestWithDependency method on derived parsers.
  * This method generates suggestions using the provided dependency values instead of defaults.
  * @since 0.10.0
  */
-declare const SuggestWithDependency: unique symbol;
+declare const suggestWithDependency: unique symbol;
 /**
  * Combines two modes into a single mode.
  * If either mode is async, the result is async.
@@ -145,12 +145,12 @@ interface DependencySource<M extends Mode = "sync", T = unknown> extends ValuePa
    * Marker to identify this as a dependency source.
    * @internal
    */
-  readonly [DependencySourceMarker]: true;
+  readonly [dependencySourceMarker]: true;
   /**
    * Unique identifier for this dependency source.
    * @internal
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * Creates a derived value parser whose behavior depends on this
    * dependency source's value.
@@ -323,28 +323,28 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * Marker to identify this as a derived value parser.
    * @internal
    */
-  readonly [DerivedValueParserMarker]: true;
+  readonly [derivedValueParserMarker]: true;
   /**
    * The unique identifier of the dependency source this parser depends on.
    * For parsers created with {@link deriveFrom} that have multiple dependencies,
    * this is set to the first dependency's ID for backwards compatibility.
    * @internal
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * The unique identifiers of all dependency sources this parser depends on.
    * Present only for parsers created with {@link deriveFrom} that have multiple
-   * dependencies. If present, this takes precedence over {@link DependencyId}
+   * dependencies. If present, this takes precedence over {@link dependencyId}
    * during dependency resolution.
    * @internal
    */
-  readonly [DependencyIds]?: readonly symbol[];
+  readonly [dependencyIds]?: readonly symbol[];
   /**
    * The default values function for this parser's dependencies.
    * Used during partial dependency resolution to fill in missing values.
    * @internal
    */
-  readonly [DefaultValues]?: () => readonly unknown[];
+  readonly [defaultValues]?: () => readonly unknown[];
   /**
    * Parses the input using the actual dependency value instead of the default.
    * This method is used during dependency resolution in `complete()`.
@@ -354,7 +354,7 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * @returns The parse result.
    * @internal
    */
-  readonly [ParseWithDependency]: (input: string, dependencyValue: S) => ValueParserResult<T> | Promise<ValueParserResult<T>>;
+  readonly [parseWithDependency]: (input: string, dependencyValue: S) => ValueParserResult<T> | Promise<ValueParserResult<T>>;
   /**
    * Generates suggestions using the provided dependency value instead of the default.
    * This method is used during shell completion when dependency sources have been parsed.
@@ -364,7 +364,7 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * @returns An iterable of suggestions.
    * @internal
    */
-  readonly [SuggestWithDependency]?: (prefix: string, dependencyValue: S) => Iterable<Suggestion> | AsyncIterable<Suggestion>;
+  readonly [suggestWithDependency]?: (prefix: string, dependencyValue: S) => Iterable<Suggestion> | AsyncIterable<Suggestion>;
 }
 /**
  * Creates a dependency source from a {@link ValueParser}.
@@ -478,7 +478,7 @@ declare function deriveFromAsync<Deps extends readonly AnyDependencySource[], T>
  * A unique symbol used to identify deferred parse states.
  * @since 0.10.0
  */
-declare const DeferredParseMarker: unique symbol;
+declare const deferredParseMarker: unique symbol;
 /**
  * Represents a deferred parse state for a DerivedValueParser.
  *
@@ -494,7 +494,7 @@ interface DeferredParseState<T = unknown> {
   /**
    * Marker to identify this as a deferred parse state.
    */
-  readonly [DeferredParseMarker]: true;
+  readonly [deferredParseMarker]: true;
   /**
    * The raw input string to be parsed.
    */
@@ -549,7 +549,7 @@ declare function createDeferredParseState<T, S>(rawInput: string, parser: Derive
  * A unique symbol used to identify dependency source parse states.
  * @since 0.10.0
  */
-declare const DependencySourceStateMarker: unique symbol;
+declare const dependencySourceStateMarker: unique symbol;
 /**
  * Represents a parse state from a DependencySource.
  * This wraps the normal ValueParserResult with the dependency ID so that
@@ -562,11 +562,11 @@ interface DependencySourceState<T = unknown> {
   /**
    * Marker to identify this as a dependency source state.
    */
-  readonly [DependencySourceStateMarker]: true;
+  readonly [dependencySourceStateMarker]: true;
   /**
    * The dependency ID of the source.
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * The underlying parse result.
    */
@@ -585,16 +585,16 @@ declare function isDependencySourceState<T>(value: unknown): value is Dependency
  *
  * @template T The type of value the state contains.
  * @param result The parse result.
- * @param dependencyId The dependency ID.
+ * @param depId The dependency ID.
  * @returns A DependencySourceState object.
  * @since 0.10.0
  */
-declare function createDependencySourceState<T>(result: ValueParserResult<T>, dependencyId: symbol): DependencySourceState<T>;
+declare function createDependencySourceState<T>(result: ValueParserResult<T>, depId: symbol): DependencySourceState<T>;
 /**
  * A unique symbol used to identify pending dependency source states.
  * @since 0.10.0
  */
-declare const PendingDependencySourceStateMarker: unique symbol;
+declare const pendingDependencySourceStateMarker: unique symbol;
 /**
  * Represents a pending dependency source state.
  * This is used when a dependency source option was not provided, but its
@@ -607,11 +607,11 @@ interface PendingDependencySourceState {
   /**
    * Marker to identify this as a pending dependency source state.
    */
-  readonly [PendingDependencySourceStateMarker]: true;
+  readonly [pendingDependencySourceStateMarker]: true;
   /**
    * The dependency ID of the source.
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
 }
 /**
  * Checks if a value is a {@link PendingDependencySourceState}.
@@ -624,18 +624,18 @@ declare function isPendingDependencySourceState(value: unknown): value is Pendin
 /**
  * Creates a pending dependency source state.
  *
- * @param dependencyId The dependency ID.
+ * @param depId The dependency ID.
  * @returns A PendingDependencySourceState object.
  * @since 0.10.0
  */
-declare function createPendingDependencySourceState(dependencyId: symbol): PendingDependencySourceState;
+declare function createPendingDependencySourceState(depId: symbol): PendingDependencySourceState;
 /**
  * A unique symbol used to identify parsers that wrap a dependency source.
  * This is used by withDefault to indicate it contains an inner parser
  * with a PendingDependencySourceState initialState.
  * @since 0.10.0
  */
-declare const WrappedDependencySourceMarker: unique symbol;
+declare const wrappedDependencySourceMarker: unique symbol;
 /**
  * A unique symbol used to indicate that a wrapper transforms the dependency
  * source value. This is used by withDefault to determine whether its default
@@ -647,26 +647,26 @@ declare const WrappedDependencySourceMarker: unique symbol;
  *
  * @since 0.10.0
  */
-declare const TransformsDependencyValueMarker: unique symbol;
+declare const transformsDependencyValueMarker: unique symbol;
 /**
- * Checks if a parser transforms the dependency value (has TransformsDependencyValueMarker).
+ * Checks if a parser transforms the dependency value (has transformsDependencyValueMarker).
  *
  * @param parser The parser to check.
  * @returns `true` if the parser transforms the dependency value.
  * @since 0.10.0
  */
 declare function transformsDependencyValue(parser: unknown): parser is {
-  [TransformsDependencyValueMarker]: true;
+  [transformsDependencyValueMarker]: true;
 };
 /**
- * Checks if a parser wraps a dependency source (has WrappedDependencySourceMarker).
+ * Checks if a parser wraps a dependency source (has wrappedDependencySourceMarker).
  *
  * @param parser The parser to check.
  * @returns `true` if the parser wraps a dependency source.
  * @since 0.10.0
  */
 declare function isWrappedDependencySource(parser: unknown): parser is {
-  [WrappedDependencySourceMarker]: PendingDependencySourceState;
+  [wrappedDependencySourceMarker]: PendingDependencySourceState;
 };
 /**
  * Represents a resolved dependency value stored during parsing.
@@ -747,4 +747,4 @@ type DependencyError = {
  */
 declare function formatDependencyError(error: DependencyError): Message;
 //#endregion
-export { AnyDependencySource, CombineMode, CombinedDependencyMode, DefaultValues, DeferredParseMarker, DeferredParseState, DependencyError, DependencyId, DependencyIds, DependencyMode, DependencyRegistry, DependencySource, DependencySourceMarker, DependencySourceState, DependencySourceStateMarker, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DerivedValueParserMarker, ParseWithDependency, PendingDependencySourceState, PendingDependencySourceStateMarker, ResolvedDependency, SuggestWithDependency, TransformsDependencyValueMarker, WrappedDependencySourceMarker, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, dependency, deriveFrom, deriveFromAsync, deriveFromSync, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isPendingDependencySourceState, isWrappedDependencySource, transformsDependencyValue };
+export { AnyDependencySource, CombineMode, CombinedDependencyMode, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, PendingDependencySourceState, ResolvedDependency, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isPendingDependencySourceState, isWrappedDependencySource, parseWithDependency, pendingDependencySourceStateMarker, suggestWithDependency, transformsDependencyValue, transformsDependencyValueMarker, wrappedDependencySourceMarker };

package/dist/dependency.d.ts

@@ -11,42 +11,42 @@ import { Mode, Suggestion } from "./parser.js";
  * {@link ValueParser} instances.
  * @since 0.10.0
  */
-declare const DependencySourceMarker: unique symbol;
+declare const dependencySourceMarker: unique symbol;
 /**
  * A unique symbol used to identify derived value parsers at compile time.
  * This marker is used to distinguish {@link DerivedValueParser} from regular
  * {@link ValueParser} instances.
  * @since 0.10.0
  */
-declare const DerivedValueParserMarker: unique symbol;
+declare const derivedValueParserMarker: unique symbol;
 /**
  * A unique symbol used to store the dependency ID on value parsers.
  * @since 0.10.0
  */
-declare const DependencyId: unique symbol;
+declare const dependencyId: unique symbol;
 /**
  * A unique symbol used to store multiple dependency IDs on derived parsers
  * that depend on multiple sources (created via {@link deriveFrom}).
  * @since 0.10.0
  */
-declare const DependencyIds: unique symbol;
+declare const dependencyIds: unique symbol;
 /**
  * A unique symbol used to store the default values function on derived parsers.
  * This is used during partial dependency resolution to fill in missing values.
  * @since 0.10.0
  */
-declare const DefaultValues: unique symbol;
+declare const defaultValues: unique symbol;
 /**
  * A unique symbol used to access the parseWithDependency method on derived parsers.
  * @since 0.10.0
  */
-declare const ParseWithDependency: unique symbol;
+declare const parseWithDependency: unique symbol;
 /**
  * A unique symbol used to access the suggestWithDependency method on derived parsers.
  * This method generates suggestions using the provided dependency values instead of defaults.
  * @since 0.10.0
  */
-declare const SuggestWithDependency: unique symbol;
+declare const suggestWithDependency: unique symbol;
 /**
  * Combines two modes into a single mode.
  * If either mode is async, the result is async.
@@ -145,12 +145,12 @@ interface DependencySource<M extends Mode = "sync", T = unknown> extends ValuePa
    * Marker to identify this as a dependency source.
    * @internal
    */
-  readonly [DependencySourceMarker]: true;
+  readonly [dependencySourceMarker]: true;
   /**
    * Unique identifier for this dependency source.
    * @internal
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * Creates a derived value parser whose behavior depends on this
    * dependency source's value.
@@ -323,28 +323,28 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * Marker to identify this as a derived value parser.
    * @internal
    */
-  readonly [DerivedValueParserMarker]: true;
+  readonly [derivedValueParserMarker]: true;
   /**
    * The unique identifier of the dependency source this parser depends on.
    * For parsers created with {@link deriveFrom} that have multiple dependencies,
    * this is set to the first dependency's ID for backwards compatibility.
    * @internal
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * The unique identifiers of all dependency sources this parser depends on.
    * Present only for parsers created with {@link deriveFrom} that have multiple
-   * dependencies. If present, this takes precedence over {@link DependencyId}
+   * dependencies. If present, this takes precedence over {@link dependencyId}
    * during dependency resolution.
    * @internal
    */
-  readonly [DependencyIds]?: readonly symbol[];
+  readonly [dependencyIds]?: readonly symbol[];
   /**
    * The default values function for this parser's dependencies.
    * Used during partial dependency resolution to fill in missing values.
    * @internal
    */
-  readonly [DefaultValues]?: () => readonly unknown[];
+  readonly [defaultValues]?: () => readonly unknown[];
   /**
    * Parses the input using the actual dependency value instead of the default.
    * This method is used during dependency resolution in `complete()`.
@@ -354,7 +354,7 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * @returns The parse result.
    * @internal
    */
-  readonly [ParseWithDependency]: (input: string, dependencyValue: S) => ValueParserResult<T> | Promise<ValueParserResult<T>>;
+  readonly [parseWithDependency]: (input: string, dependencyValue: S) => ValueParserResult<T> | Promise<ValueParserResult<T>>;
   /**
    * Generates suggestions using the provided dependency value instead of the default.
    * This method is used during shell completion when dependency sources have been parsed.
@@ -364,7 +364,7 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
    * @returns An iterable of suggestions.
    * @internal
    */
-  readonly [SuggestWithDependency]?: (prefix: string, dependencyValue: S) => Iterable<Suggestion> | AsyncIterable<Suggestion>;
+  readonly [suggestWithDependency]?: (prefix: string, dependencyValue: S) => Iterable<Suggestion> | AsyncIterable<Suggestion>;
 }
 /**
  * Creates a dependency source from a {@link ValueParser}.
@@ -478,7 +478,7 @@ declare function deriveFromAsync<Deps extends readonly AnyDependencySource[], T>
  * A unique symbol used to identify deferred parse states.
  * @since 0.10.0
  */
-declare const DeferredParseMarker: unique symbol;
+declare const deferredParseMarker: unique symbol;
 /**
  * Represents a deferred parse state for a DerivedValueParser.
  *
@@ -494,7 +494,7 @@ interface DeferredParseState<T = unknown> {
   /**
    * Marker to identify this as a deferred parse state.
    */
-  readonly [DeferredParseMarker]: true;
+  readonly [deferredParseMarker]: true;
   /**
    * The raw input string to be parsed.
    */
@@ -549,7 +549,7 @@ declare function createDeferredParseState<T, S>(rawInput: string, parser: Derive
  * A unique symbol used to identify dependency source parse states.
  * @since 0.10.0
  */
-declare const DependencySourceStateMarker: unique symbol;
+declare const dependencySourceStateMarker: unique symbol;
 /**
  * Represents a parse state from a DependencySource.
  * This wraps the normal ValueParserResult with the dependency ID so that
@@ -562,11 +562,11 @@ interface DependencySourceState<T = unknown> {
   /**
    * Marker to identify this as a dependency source state.
    */
-  readonly [DependencySourceStateMarker]: true;
+  readonly [dependencySourceStateMarker]: true;
   /**
    * The dependency ID of the source.
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
   /**
    * The underlying parse result.
    */
@@ -585,16 +585,16 @@ declare function isDependencySourceState<T>(value: unknown): value is Dependency
  *
  * @template T The type of value the state contains.
  * @param result The parse result.
- * @param dependencyId The dependency ID.
+ * @param depId The dependency ID.
  * @returns A DependencySourceState object.
  * @since 0.10.0
  */
-declare function createDependencySourceState<T>(result: ValueParserResult<T>, dependencyId: symbol): DependencySourceState<T>;
+declare function createDependencySourceState<T>(result: ValueParserResult<T>, depId: symbol): DependencySourceState<T>;
 /**
  * A unique symbol used to identify pending dependency source states.
  * @since 0.10.0
  */
-declare const PendingDependencySourceStateMarker: unique symbol;
+declare const pendingDependencySourceStateMarker: unique symbol;
 /**
  * Represents a pending dependency source state.
  * This is used when a dependency source option was not provided, but its
@@ -607,11 +607,11 @@ interface PendingDependencySourceState {
   /**
    * Marker to identify this as a pending dependency source state.
    */
-  readonly [PendingDependencySourceStateMarker]: true;
+  readonly [pendingDependencySourceStateMarker]: true;
   /**
    * The dependency ID of the source.
    */
-  readonly [DependencyId]: symbol;
+  readonly [dependencyId]: symbol;
 }
 /**
  * Checks if a value is a {@link PendingDependencySourceState}.
@@ -624,18 +624,18 @@ declare function isPendingDependencySourceState(value: unknown): value is Pendin
 /**
  * Creates a pending dependency source state.
  *
- * @param dependencyId The dependency ID.
+ * @param depId The dependency ID.
  * @returns A PendingDependencySourceState object.
  * @since 0.10.0
  */
-declare function createPendingDependencySourceState(dependencyId: symbol): PendingDependencySourceState;
+declare function createPendingDependencySourceState(depId: symbol): PendingDependencySourceState;
 /**
  * A unique symbol used to identify parsers that wrap a dependency source.
  * This is used by withDefault to indicate it contains an inner parser
  * with a PendingDependencySourceState initialState.
  * @since 0.10.0
  */
-declare const WrappedDependencySourceMarker: unique symbol;
+declare const wrappedDependencySourceMarker: unique symbol;
 /**
  * A unique symbol used to indicate that a wrapper transforms the dependency
  * source value. This is used by withDefault to determine whether its default
@@ -647,26 +647,26 @@ declare const WrappedDependencySourceMarker: unique symbol;
  *
  * @since 0.10.0
  */
-declare const TransformsDependencyValueMarker: unique symbol;
+declare const transformsDependencyValueMarker: unique symbol;
 /**
- * Checks if a parser transforms the dependency value (has TransformsDependencyValueMarker).
+ * Checks if a parser transforms the dependency value (has transformsDependencyValueMarker).
  *
  * @param parser The parser to check.
  * @returns `true` if the parser transforms the dependency value.
  * @since 0.10.0
  */
 declare function transformsDependencyValue(parser: unknown): parser is {
-  [TransformsDependencyValueMarker]: true;
+  [transformsDependencyValueMarker]: true;
 };
 /**
- * Checks if a parser wraps a dependency source (has WrappedDependencySourceMarker).
+ * Checks if a parser wraps a dependency source (has wrappedDependencySourceMarker).
  *
  * @param parser The parser to check.
  * @returns `true` if the parser wraps a dependency source.
  * @since 0.10.0
  */
 declare function isWrappedDependencySource(parser: unknown): parser is {
-  [WrappedDependencySourceMarker]: PendingDependencySourceState;
+  [wrappedDependencySourceMarker]: PendingDependencySourceState;
 };
 /**
  * Represents a resolved dependency value stored during parsing.
@@ -747,4 +747,4 @@ type DependencyError = {
  */
 declare function formatDependencyError(error: DependencyError): Message;
 //#endregion
-export { AnyDependencySource, CombineMode, CombinedDependencyMode, DefaultValues, DeferredParseMarker, DeferredParseState, DependencyError, DependencyId, DependencyIds, DependencyMode, DependencyRegistry, DependencySource, DependencySourceMarker, DependencySourceState, DependencySourceStateMarker, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DerivedValueParserMarker, ParseWithDependency, PendingDependencySourceState, PendingDependencySourceStateMarker, ResolvedDependency, SuggestWithDependency, TransformsDependencyValueMarker, WrappedDependencySourceMarker, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, dependency, deriveFrom, deriveFromAsync, deriveFromSync, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isPendingDependencySourceState, isWrappedDependencySource, transformsDependencyValue };
+export { AnyDependencySource, CombineMode, CombinedDependencyMode, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, PendingDependencySourceState, ResolvedDependency, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isPendingDependencySourceState, isWrappedDependencySource, parseWithDependency, pendingDependencySourceStateMarker, suggestWithDependency, transformsDependencyValue, transformsDependencyValueMarker, wrappedDependencySourceMarker };