@optique/core 0.10.0-dev.292 → 0.10.0-dev.294

package/dist/dependency.cjs

@@ -20,6 +20,12 @@ const DerivedValueParserMarker = Symbol.for("@optique/core/dependency/DerivedVal
 */
 const DependencyId = Symbol.for("@optique/core/dependency/DependencyId");
 /**
+* 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
+*/
+const DependencyIds = Symbol.for("@optique/core/dependency/DependencyIds");
+/**
 * A unique symbol used to access the parseWithDependency method on derived parsers.
 * @since 0.10.0
 */
@@ -55,14 +61,22 @@ const ParseWithDependency = Symbol.for("@optique/core/dependency/ParseWithDepend
 */
 function dependency(parser) {
 	const id = Symbol();
-	return {
+	const result = {
 		...parser,
 		[DependencySourceMarker]: true,
 		[DependencyId]: id,
 		derive(options) {
 			return createDerivedValueParser(id, parser, options);
+		},
+		deriveSync(options) {
+			if (parser.$mode === "async") return createAsyncDerivedParserFromSyncFactory(id, options);
+			return createSyncDerivedParser(id, options);
+		},
+		deriveAsync(options) {
+			return createDerivedValueParser(id, parser, options);
 		}
 	};
+	return result;
 }
 /**
 * Checks if a value parser is a {@link DependencySource}.
@@ -116,17 +130,70 @@ function isDerivedValueParser(parser) {
 * @since 0.10.0
 */
 function deriveFrom(options) {
-	const isAsync = options.dependencies.some((dep) => dep.$mode === "async");
+	const depsAsync = options.dependencies.some((dep) => dep.$mode === "async");
+	const factoryReturnsAsync = determineFactoryModeForDeriveFrom(options);
+	const sourceId = options.dependencies.length > 0 ? options.dependencies[0][DependencyId] : Symbol();
+	const isAsync = depsAsync || factoryReturnsAsync;
+	if (isAsync) {
+		if (factoryReturnsAsync) return createAsyncDerivedFromParserFromAsyncFactory(sourceId, options);
+		return createAsyncDerivedFromParserFromSyncFactory(sourceId, options);
+	}
+	return createSyncDerivedFromParser(sourceId, options);
+}
+/**
+* Creates a derived value parser from multiple dependency sources
+* with a synchronous factory.
+*
+* This function allows creating a parser whose behavior depends on
+* multiple other parsers' values. The factory explicitly returns
+* a sync parser.
+*
+* @template Deps A tuple of DependencySource types.
+* @template T The type of value the derived parser produces.
+* @param options Configuration for the derived parser with sync factory.
+* @returns A {@link DerivedValueParser} that depends on the given sources.
+* @since 0.10.0
+*/
+function deriveFromSync(options) {
+	const depsAsync = options.dependencies.some((dep) => dep.$mode === "async");
 	const sourceId = options.dependencies.length > 0 ? options.dependencies[0][DependencyId] : Symbol();
-	if (isAsync) return createAsyncDerivedFromParser(sourceId, options);
+	if (depsAsync) return createAsyncDerivedFromParserFromSyncFactory(sourceId, options);
 	return createSyncDerivedFromParser(sourceId, options);
 }
+/**
+* Creates a derived value parser from multiple dependency sources
+* with an asynchronous factory.
+*
+* This function allows creating a parser whose behavior depends on
+* multiple other parsers' values. The factory explicitly returns
+* an async parser.
+*
+* @template Deps A tuple of DependencySource types.
+* @template T The type of value the derived parser produces.
+* @param options Configuration for the derived parser with async factory.
+* @returns A {@link DerivedValueParser} that depends on the given sources.
+* @since 0.10.0
+*/
+function deriveFromAsync(options) {
+	const sourceId = options.dependencies.length > 0 ? options.dependencies[0][DependencyId] : Symbol();
+	return createAsyncDerivedFromParserFromAsyncFactory(sourceId, options);
+}
+/**
+* Determines if the factory returns an async parser for deriveFrom options.
+*/
+function determineFactoryModeForDeriveFrom(options) {
+	const defaultValues = options.defaultValues();
+	const parser = options.factory(...defaultValues);
+	return parser.$mode === "async";
+}
 function createSyncDerivedFromParser(sourceId, options) {
+	const allDependencyIds = options.dependencies.map((dep) => dep[DependencyId]);
 	return {
 		$mode: "sync",
 		metavar: options.metavar,
 		[DerivedValueParserMarker]: true,
 		[DependencyId]: sourceId,
+		[DependencyIds]: allDependencyIds,
 		parse(input) {
 			const sourceValues = options.defaultValues();
 			const derivedParser = options.factory(...sourceValues);
@@ -148,12 +215,51 @@ function createSyncDerivedFromParser(sourceId, options) {
 		}
 	};
 }
-function createAsyncDerivedFromParser(sourceId, options) {
+/**
+* Creates an async derived parser from multiple dependencies when the
+* factory returns an async parser.
+*/
+function createAsyncDerivedFromParserFromAsyncFactory(sourceId, options) {
+	const allDependencyIds = options.dependencies.map((dep) => dep[DependencyId]);
+	return {
+		$mode: "async",
+		metavar: options.metavar,
+		[DerivedValueParserMarker]: true,
+		[DependencyId]: sourceId,
+		[DependencyIds]: allDependencyIds,
+		parse(input) {
+			const sourceValues = options.defaultValues();
+			const derivedParser = options.factory(...sourceValues);
+			return derivedParser.parse(input);
+		},
+		[ParseWithDependency](input, dependencyValue) {
+			const derivedParser = options.factory(...dependencyValue);
+			return derivedParser.parse(input);
+		},
+		format(value) {
+			const sourceValues = options.defaultValues();
+			const derivedParser = options.factory(...sourceValues);
+			return derivedParser.format(value);
+		},
+		async *suggest(prefix) {
+			const sourceValues = options.defaultValues();
+			const derivedParser = options.factory(...sourceValues);
+			if (derivedParser.suggest) for await (const suggestion of derivedParser.suggest(prefix)) yield suggestion;
+		}
+	};
+}
+/**
+* Creates an async derived parser from multiple dependencies when the
+* sources are async but the factory returns a sync parser.
+*/
+function createAsyncDerivedFromParserFromSyncFactory(sourceId, options) {
+	const allDependencyIds = options.dependencies.map((dep) => dep[DependencyId]);
 	return {
 		$mode: "async",
 		metavar: options.metavar,
 		[DerivedValueParserMarker]: true,
 		[DependencyId]: sourceId,
+		[DependencyIds]: allDependencyIds,
 		parse(input) {
 			const sourceValues = options.defaultValues();
 			const derivedParser = options.factory(...sourceValues);
@@ -176,9 +282,23 @@ function createAsyncDerivedFromParser(sourceId, options) {
 	};
 }
 function createDerivedValueParser(sourceId, sourceParser, options) {
-	if (sourceParser.$mode === "async") return createAsyncDerivedParser(sourceId, options);
+	const factoryReturnsAsync = determineFactoryMode(options);
+	const isAsync = sourceParser.$mode === "async" || factoryReturnsAsync;
+	if (isAsync) {
+		if (factoryReturnsAsync) return createAsyncDerivedParserFromAsyncFactory(sourceId, options);
+		return createAsyncDerivedParserFromSyncFactory(sourceId, options);
+	}
 	return createSyncDerivedParser(sourceId, options);
 }
+/**
+* Determines if the factory returns an async parser by calling it with
+* the default value and checking the mode.
+*/
+function determineFactoryMode(options) {
+	const defaultValue = options.defaultValue();
+	const parser = options.factory(defaultValue);
+	return parser.$mode === "async";
+}
 function createSyncDerivedParser(sourceId, options) {
 	return {
 		$mode: "sync",
@@ -206,7 +326,42 @@ function createSyncDerivedParser(sourceId, options) {
 		}
 	};
 }
-function createAsyncDerivedParser(sourceId, options) {
+/**
+* Creates an async derived parser when the factory returns an async parser.
+* The parse result is awaited since the factory returns an async parser.
+*/
+function createAsyncDerivedParserFromAsyncFactory(sourceId, options) {
+	return {
+		$mode: "async",
+		metavar: options.metavar,
+		[DerivedValueParserMarker]: true,
+		[DependencyId]: sourceId,
+		parse(input) {
+			const sourceValue = options.defaultValue();
+			const derivedParser = options.factory(sourceValue);
+			return derivedParser.parse(input);
+		},
+		[ParseWithDependency](input, dependencyValue) {
+			const derivedParser = options.factory(dependencyValue);
+			return derivedParser.parse(input);
+		},
+		format(value) {
+			const sourceValue = options.defaultValue();
+			const derivedParser = options.factory(sourceValue);
+			return derivedParser.format(value);
+		},
+		async *suggest(prefix) {
+			const sourceValue = options.defaultValue();
+			const derivedParser = options.factory(sourceValue);
+			if (derivedParser.suggest) for await (const suggestion of derivedParser.suggest(prefix)) yield suggestion;
+		}
+	};
+}
+/**
+* Creates an async derived parser when the source is async but the factory
+* returns a sync parser. The sync result is wrapped in a Promise.
+*/
+function createAsyncDerivedParserFromSyncFactory(sourceId, options) {
 	return {
 		$mode: "async",
 		metavar: options.metavar,
@@ -260,11 +415,13 @@ function isDeferredParseState(value) {
 * @since 0.10.0
 */
 function createDeferredParseState(rawInput, parser, preliminaryResult) {
+	const multipleIds = DependencyIds in parser ? parser[DependencyIds] : void 0;
 	return {
 		[DeferredParseMarker]: true,
 		rawInput,
 		parser,
 		dependencyId: parser[DependencyId],
+		dependencyIds: multipleIds,
 		preliminaryResult
 	};
 }
@@ -367,6 +524,7 @@ function formatDependencyError(error) {
 //#endregion
 exports.DeferredParseMarker = DeferredParseMarker;
 exports.DependencyId = DependencyId;
+exports.DependencyIds = DependencyIds;
 exports.DependencyRegistry = DependencyRegistry;
 exports.DependencySourceMarker = DependencySourceMarker;
 exports.DependencySourceStateMarker = DependencySourceStateMarker;
@@ -376,6 +534,8 @@ exports.createDeferredParseState = createDeferredParseState;
 exports.createDependencySourceState = createDependencySourceState;
 exports.dependency = dependency;
 exports.deriveFrom = deriveFrom;
+exports.deriveFromAsync = deriveFromAsync;
+exports.deriveFromSync = deriveFromSync;
 exports.formatDependencyError = formatDependencyError;
 exports.isDeferredParseState = isDeferredParseState;
 exports.isDependencySource = isDependencySource;

package/dist/dependency.d.cts

@@ -24,19 +24,34 @@ declare const DerivedValueParserMarker: unique symbol;
  * @since 0.10.0
  */
 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;
 /**
  * A unique symbol used to access the parseWithDependency method on derived parsers.
  * @since 0.10.0
  */
 declare const ParseWithDependency: unique symbol;
+/**
+ * Combines two modes into a single mode.
+ * If either mode is async, the result is async.
+ * @template M1 The first mode.
+ * @template M2 The second mode.
+ * @since 0.10.0
+ */
+type CombineMode<M1 extends Mode, M2 extends Mode> = M1 extends "async" ? "async" : M2 extends "async" ? "async" : "sync";
 /**
  * Options for creating a derived value parser.
  *
  * @template S The type of the source dependency value.
  * @template T The type of the derived parser value.
+ * @template FM The mode of the factory's returned parser.
  * @since 0.10.0
  */
-interface DeriveOptions<S, T> {
+interface DeriveOptions<S, T, FM extends Mode = Mode> {
   /**
    * The metavariable name for the derived parser. Used in help messages
    * to indicate what kind of value this parser expects.
@@ -49,7 +64,7 @@ interface DeriveOptions<S, T> {
    * @param sourceValue The value parsed from the dependency source.
    * @returns A {@link ValueParser} for the derived value.
    */
-  readonly factory: (sourceValue: S) => ValueParser<"sync", T>;
+  readonly factory: (sourceValue: S) => ValueParser<FM, T>;
   /**
    * Default value to use when the dependency source is not provided.
    * This allows the derived parser to work even when the dependency
@@ -59,6 +74,48 @@ interface DeriveOptions<S, T> {
    */
   readonly defaultValue: () => S;
 }
+/**
+ * Options for creating a derived value parser with a synchronous factory.
+ *
+ * @template S The type of the source dependency value.
+ * @template T The type of the derived parser value.
+ * @since 0.10.0
+ */
+interface DeriveSyncOptions<S, T> {
+  /**
+   * The metavariable name for the derived parser.
+   */
+  readonly metavar: NonEmptyString;
+  /**
+   * Factory function that creates a synchronous {@link ValueParser}.
+   */
+  readonly factory: (sourceValue: S) => ValueParser<"sync", T>;
+  /**
+   * Default value to use when the dependency source is not provided.
+   */
+  readonly defaultValue: () => S;
+}
+/**
+ * Options for creating a derived value parser with an asynchronous factory.
+ *
+ * @template S The type of the source dependency value.
+ * @template T The type of the derived parser value.
+ * @since 0.10.0
+ */
+interface DeriveAsyncOptions<S, T> {
+  /**
+   * The metavariable name for the derived parser.
+   */
+  readonly metavar: NonEmptyString;
+  /**
+   * Factory function that creates an asynchronous {@link ValueParser}.
+   */
+  readonly factory: (sourceValue: S) => ValueParser<"async", T>;
+  /**
+   * Default value to use when the dependency source is not provided.
+   */
+  readonly defaultValue: () => S;
+}
 /**
  * Represents a dependency source that can be used to create derived parsers.
  *
@@ -87,14 +144,40 @@ interface DependencySource<M extends Mode = "sync", T = unknown> extends ValuePa
    * dependency source's value.
    *
    * The derived parser uses a factory function to create parsers based on
-   * the source value. Currently, only synchronous factory functions are
-   * supported.
+   * the source value. The factory can return either a sync or async parser,
+   * and the resulting derived parser's mode will be the combination of
+   * the source mode and the factory's returned parser mode.
    *
    * @template U The type of value the derived parser produces.
+   * @template FM The mode of the factory's returned parser.
    * @param options Configuration for the derived parser.
    * @returns A {@link DerivedValueParser} that depends on this source.
    */
-  derive<U>(options: DeriveOptions<T, U>): DerivedValueParser<M, U, T>;
+  derive<U, FM extends Mode = "sync">(options: DeriveOptions<T, U, FM>): DerivedValueParser<CombineMode<M, FM>, U, T>;
+  /**
+   * Creates a derived value parser with a synchronous factory.
+   *
+   * This is a convenience method that explicitly requires a sync factory,
+   * making the type inference more predictable.
+   *
+   * @template U The type of value the derived parser produces.
+   * @param options Configuration for the derived parser with sync factory.
+   * @returns A {@link DerivedValueParser} that depends on this source.
+   * @since 0.10.0
+   */
+  deriveSync<U>(options: DeriveSyncOptions<T, U>): DerivedValueParser<M, U, T>;
+  /**
+   * Creates a derived value parser with an asynchronous factory.
+   *
+   * This is a convenience method that explicitly requires an async factory,
+   * making the type inference more predictable.
+   *
+   * @template U The type of value the derived parser produces.
+   * @param options Configuration for the derived parser with async factory.
+   * @returns A {@link DerivedValueParser} that depends on this source.
+   * @since 0.10.0
+   */
+  deriveAsync<U>(options: DeriveAsyncOptions<T, U>): DerivedValueParser<"async", U, T>;
 }
 /**
  * Extracts the value type from a DependencySource.
@@ -131,9 +214,10 @@ type AnyDependencySource = DependencySource<Mode, any>;
  *
  * @template Deps A tuple of DependencySource types.
  * @template T The type of the derived parser value.
+ * @template FM The mode of the factory's returned parser.
  * @since 0.10.0
  */
-interface DeriveFromOptions<Deps extends readonly AnyDependencySource[], T> {
+interface DeriveFromOptions<Deps extends readonly AnyDependencySource[], T, FM extends Mode = Mode> {
   /**
    * The metavariable name for the derived parser. Used in help messages
    * to indicate what kind of value this parser expects.
@@ -150,7 +234,7 @@ interface DeriveFromOptions<Deps extends readonly AnyDependencySource[], T> {
    * @param values The values parsed from the dependency sources (in order).
    * @returns A {@link ValueParser} for the derived value.
    */
-  readonly factory: (...values: DependencyValues<Deps>) => ValueParser<"sync", T>;
+  readonly factory: (...values: DependencyValues<Deps>) => ValueParser<FM, T>;
   /**
    * Default values to use when the dependency sources are not provided.
    * Must return a tuple with the same length and types as the dependencies.
@@ -159,6 +243,58 @@ interface DeriveFromOptions<Deps extends readonly AnyDependencySource[], T> {
    */
   readonly defaultValues: () => DependencyValues<Deps>;
 }
+/**
+ * Options for creating a derived value parser from multiple dependencies
+ * with a synchronous factory.
+ *
+ * @template Deps A tuple of DependencySource types.
+ * @template T The type of the derived parser value.
+ * @since 0.10.0
+ */
+interface DeriveFromSyncOptions<Deps extends readonly AnyDependencySource[], T> {
+  /**
+   * The metavariable name for the derived parser.
+   */
+  readonly metavar: NonEmptyString;
+  /**
+   * The dependency sources that this derived parser depends on.
+   */
+  readonly dependencies: Deps;
+  /**
+   * Factory function that creates a synchronous {@link ValueParser}.
+   */
+  readonly factory: (...values: DependencyValues<Deps>) => ValueParser<"sync", T>;
+  /**
+   * Default values to use when the dependency sources are not provided.
+   */
+  readonly defaultValues: () => DependencyValues<Deps>;
+}
+/**
+ * Options for creating a derived value parser from multiple dependencies
+ * with an asynchronous factory.
+ *
+ * @template Deps A tuple of DependencySource types.
+ * @template T The type of the derived parser value.
+ * @since 0.10.0
+ */
+interface DeriveFromAsyncOptions<Deps extends readonly AnyDependencySource[], T> {
+  /**
+   * The metavariable name for the derived parser.
+   */
+  readonly metavar: NonEmptyString;
+  /**
+   * The dependency sources that this derived parser depends on.
+   */
+  readonly dependencies: Deps;
+  /**
+   * Factory function that creates an asynchronous {@link ValueParser}.
+   */
+  readonly factory: (...values: DependencyValues<Deps>) => ValueParser<"async", T>;
+  /**
+   * Default values to use when the dependency sources are not provided.
+   */
+  readonly defaultValues: () => DependencyValues<Deps>;
+}
 /**
  * A value parser that depends on another parser's value.
  *
@@ -178,9 +314,19 @@ interface DerivedValueParser<M extends Mode = "sync", T = unknown, S = unknown>
   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;
+  /**
+   * 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}
+   * during dependency resolution.
+   * @internal
+   */
+  readonly [DependencyIds]?: readonly symbol[];
   /**
    * Parses the input using the actual dependency value instead of the default.
    * This method is used during dependency resolution in `complete()`.
@@ -269,7 +415,37 @@ declare function isDerivedValueParser<M extends Mode, T>(parser: ValueParser<M,
  * ```
  * @since 0.10.0
  */
-declare function deriveFrom<Deps extends readonly AnyDependencySource[], T>(options: DeriveFromOptions<Deps, T>): DerivedValueParser<CombinedDependencyMode<Deps>, T, DependencyValues<Deps>>;
+declare function deriveFrom<Deps extends readonly AnyDependencySource[], T, FM extends Mode = "sync">(options: DeriveFromOptions<Deps, T, FM>): DerivedValueParser<CombineMode<CombinedDependencyMode<Deps>, FM>, T, DependencyValues<Deps>>;
+/**
+ * Creates a derived value parser from multiple dependency sources
+ * with a synchronous factory.
+ *
+ * This function allows creating a parser whose behavior depends on
+ * multiple other parsers' values. The factory explicitly returns
+ * a sync parser.
+ *
+ * @template Deps A tuple of DependencySource types.
+ * @template T The type of value the derived parser produces.
+ * @param options Configuration for the derived parser with sync factory.
+ * @returns A {@link DerivedValueParser} that depends on the given sources.
+ * @since 0.10.0
+ */
+declare function deriveFromSync<Deps extends readonly AnyDependencySource[], T>(options: DeriveFromSyncOptions<Deps, T>): DerivedValueParser<CombinedDependencyMode<Deps>, T, DependencyValues<Deps>>;
+/**
+ * Creates a derived value parser from multiple dependency sources
+ * with an asynchronous factory.
+ *
+ * This function allows creating a parser whose behavior depends on
+ * multiple other parsers' values. The factory explicitly returns
+ * an async parser.
+ *
+ * @template Deps A tuple of DependencySource types.
+ * @template T The type of value the derived parser produces.
+ * @param options Configuration for the derived parser with async factory.
+ * @returns A {@link DerivedValueParser} that depends on the given sources.
+ * @since 0.10.0
+ */
+declare function deriveFromAsync<Deps extends readonly AnyDependencySource[], T>(options: DeriveFromAsyncOptions<Deps, T>): DerivedValueParser<"async", T, DependencyValues<Deps>>;
 /**
  * A unique symbol used to identify deferred parse states.
  * @since 0.10.0
@@ -300,9 +476,14 @@ interface DeferredParseState<T = unknown> {
    */
   readonly parser: DerivedValueParser<Mode, T, unknown>;
   /**
-   * The dependency ID that this parser depends on.
+   * The dependency ID that this parser depends on (for single-dependency parsers).
    */
   readonly dependencyId: symbol;
+  /**
+   * The dependency IDs that this parser depends on (for multi-dependency parsers).
+   * If present, this is used instead of `dependencyId`.
+   */
+  readonly dependencyIds?: readonly symbol[];
   /**
    * The preliminary parse result using the default dependency value.
    * This is used as a fallback if dependency resolution is not needed
@@ -454,4 +635,4 @@ type DependencyError = {
  */
 declare function formatDependencyError(error: DependencyError): Message;
 //#endregion
-export { AnyDependencySource, CombinedDependencyMode, DeferredParseMarker, DeferredParseState, DependencyError, DependencyId, DependencyMode, DependencyRegistry, DependencySource, DependencySourceMarker, DependencySourceState, DependencySourceStateMarker, DependencyValue, DependencyValues, DeriveFromOptions, DeriveOptions, DerivedValueParser, DerivedValueParserMarker, ParseWithDependency, ResolvedDependency, createDeferredParseState, createDependencySourceState, dependency, deriveFrom, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser };
+export { AnyDependencySource, CombineMode, CombinedDependencyMode, DeferredParseMarker, DeferredParseState, DependencyError, DependencyId, DependencyIds, DependencyMode, DependencyRegistry, DependencySource, DependencySourceMarker, DependencySourceState, DependencySourceStateMarker, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DerivedValueParserMarker, ParseWithDependency, ResolvedDependency, createDeferredParseState, createDependencySourceState, dependency, deriveFrom, deriveFromAsync, deriveFromSync, formatDependencyError, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser };