@optique/core 1.1.3 → 1.1.5

package/dist/internal/parser.d.ts

@@ -42,6 +42,51 @@ type ModeValue<M extends Mode, T> = M extends "async" ? Promise<T> : T;
  * @since 0.9.0
  */
 type ModeIterable<M extends Mode, T> = M extends "async" ? AsyncIterable<T> : Iterable<T>;
+/**
+ * Internal symbol used by transparent combinators to expose independently
+ * competing parse operations to shared-buffer parents.
+ * @internal
+ */
+declare const parseLanesKey: unique symbol;
+/**
+ * An owner-consumption requirement for a parse lane.
+ * @internal
+ */
+interface ParseLaneConsumptionGroup {
+  /** Identity shared by lanes belonging to the same owning parser. */
+  readonly id: object;
+  /** Whether the owning parser is active after a consuming lane succeeds. */
+  readonly isActive?: (state: unknown) => boolean;
+}
+/**
+ * A state-preserving parse operation that competes at one exact priority.
+ * @internal
+ */
+interface ParseLane<TState> {
+  /** The exact priority at which this lane competes. */
+  readonly priority: number;
+  /**
+   * Identity shared by lanes that must all succeed before their
+   * zero-consumption state updates can be committed.
+   */
+  readonly zeroConsumptionGroup?: object;
+  /**
+   * Whether a zero-consumption success can settle the owning parser while
+   * input remains.  Defaults to `true`.
+   */
+  readonly settlesZeroConsumption?: boolean;
+  /** Fixed tokens reachable through this lane. */
+  readonly leadingNames: ReadonlySet<string>;
+  /** Whether this lane accepts any positional token. */
+  readonly acceptingAnyToken: boolean;
+  /**
+   * Groups in which a zero-consumption update is valid only after another
+   * lane in every group has consumed input during the same arbitration.
+   */
+  readonly requiredConsumptionGroups?: readonly ParseLaneConsumptionGroup[];
+  /** Parses through the owning parser's state and execution context. */
+  parse(context: ParserContext<TState>): ParserResult<TState> | Promise<ParserResult<TState>>;
+}
 /**
  * Combines multiple modes into a single mode.
  * If any mode is `"async"`, the result is `"async"`; otherwise `"sync"`.
@@ -162,6 +207,13 @@ interface Parser<M extends Mode = "sync", TValue = unknown, TState = unknown> {
    * state when parsing starts.
    */
   readonly initialState: TState;
+  /**
+   * Independently competing parse operations exposed by transparent
+   * combinators.  Shared-buffer parents use these to arbitrate below an
+   * aggregate parser boundary without bypassing the owner's state adapters.
+   * @internal
+   */
+  readonly [parseLanesKey]?: readonly ParseLane<TState>[];
   /**
    * Internal marker for wrappers whose `{ hasCliValue: false }` states should
    * be treated as unmatched dependency-source states during completion-time
@@ -851,6 +903,22 @@ declare function getDelegatingSuggestRuntimeNodes<TInnerState>(innerParser: Pars
  * @internal
  */
 declare function composeWrappedSourceMetadata(dependencyMetadata: ParserDependencyMetadata | undefined, wrapSource: (source: NonNullable<ParserDependencyMetadata["source"]>) => NonNullable<ParserDependencyMetadata["source"]>): ParserDependencyMetadata | undefined;
+/**
+ * Defines internal parse-lane metadata without exposing it through object
+ * spreads used by custom parser wrappers.
+ *
+ * @internal
+ */
+declare function defineParseLanes<TState>(parser: object, lanes: readonly ParseLane<TState>[] | undefined): void;
+/**
+ * Gets parse-lane metadata defined directly on a parser.
+ *
+ * Inherited metadata belongs to the parser's prototype and must not bypass an
+ * overriding `parse()` implementation on a custom wrapper.
+ *
+ * @internal
+ */
+declare function getOwnParseLanes<TState>(parser: object): readonly ParseLane<TState>[] | undefined;
 /**
  * Marks a parser as inheriting parent-state annotations through wrapper-state
  * reconstruction.
@@ -999,4 +1067,4 @@ declare function getDocPage(parser: Parser<"sync", unknown, unknown>, argsOrOpti
 declare function getDocPage(parser: Parser<"async", unknown, unknown>, argsOrOptions?: readonly string[] | ParseOptions, options?: ParseOptions): Promise<DocPage | undefined>;
 declare function getDocPage<M extends Mode>(parser: Parser<M, unknown, unknown>, argsOrOptions?: readonly string[] | ParseOptions, options?: ParseOptions): ModeValue<M, DocPage | undefined>;
 //#endregion
-export { CombineModes, DocState, ExecutionContext, ExecutionPhase, InferMode, InferValue, Mode, ModeIterable, ModeValue, ParseFrame, type ParseOptions, Parser, ParserContext, ParserResult, Result, Suggestion, annotationWrapperRequiresSourceBindingKey, composeWrappedSourceMetadata, createParserContext, defineInheritedAnnotationParser, defineSourceBindingOnlyAnnotationCompletionParser, getDelegatingSuggestRuntimeNodes, getDocPage, getDocPageAsync, getDocPageSync, getParserSuggestRuntimeNodes, inheritParentAnnotationsKey, parse, parseAsync, parseSync, suggest, suggestAsync, suggestSync, unmatchedNonCliDependencySourceStateMarker };
+export { CombineModes, DocState, ExecutionContext, ExecutionPhase, InferMode, InferValue, Mode, ModeIterable, ModeValue, ParseFrame, ParseLane, ParseLaneConsumptionGroup, type ParseOptions, Parser, ParserContext, ParserResult, Result, Suggestion, annotationWrapperRequiresSourceBindingKey, composeWrappedSourceMetadata, createParserContext, defineInheritedAnnotationParser, defineParseLanes, defineSourceBindingOnlyAnnotationCompletionParser, getDelegatingSuggestRuntimeNodes, getDocPage, getDocPageAsync, getDocPageSync, getOwnParseLanes, getParserSuggestRuntimeNodes, inheritParentAnnotationsKey, parse, parseAsync, parseLanesKey, parseSync, suggest, suggestAsync, suggestSync, unmatchedNonCliDependencySourceStateMarker };

package/dist/internal/parser.js

@@ -8,6 +8,12 @@ import { createInputTrace } from "../input-trace.js";
 
 //#region src/internal/parser.ts
 /**
+* Internal symbol used by transparent combinators to expose independently
+* competing parse operations to shared-buffer parents.
+* @internal
+*/
+const parseLanesKey = Symbol("parseLanes");
+/**
 * Internal marker for wrappers whose `{ hasCliValue: false }` states should
 * be treated as unmatched dependency-source states during completion-time
 * Phase 1.
@@ -387,6 +393,32 @@ function composeWrappedSourceMetadata(dependencyMetadata, wrapSource) {
 	};
 }
 /**
+* Defines internal parse-lane metadata without exposing it through object
+* spreads used by custom parser wrappers.
+*
+* @internal
+*/
+function defineParseLanes(parser, lanes) {
+	if (lanes == null) return;
+	Object.defineProperty(parser, parseLanesKey, {
+		value: lanes,
+		configurable: true,
+		enumerable: false
+	});
+}
+/**
+* Gets parse-lane metadata defined directly on a parser.
+*
+* Inherited metadata belongs to the parser's prototype and must not bypass an
+* overriding `parse()` implementation on a custom wrapper.
+*
+* @internal
+*/
+function getOwnParseLanes(parser) {
+	if (!Object.hasOwn(parser, parseLanesKey)) return void 0;
+	return parser[parseLanesKey];
+}
+/**
 * Marks a parser as inheriting parent-state annotations through wrapper-state
 * reconstruction.
 *
@@ -793,4 +825,4 @@ function buildDocPage(parser, context, args, matchedCommandArgIndices) {
 }
 
 //#endregion
-export { annotationWrapperRequiresSourceBindingKey, composeWrappedSourceMetadata, createParserContext, defineInheritedAnnotationParser, defineSourceBindingOnlyAnnotationCompletionParser, getDelegatingSuggestRuntimeNodes, getDocPage, getDocPageAsync, getDocPageSync, getParserSuggestRuntimeNodes, inheritParentAnnotationsKey, parse, parseAsync, parseSync, suggest, suggestAsync, suggestSync, unmatchedNonCliDependencySourceStateMarker };
+export { annotationWrapperRequiresSourceBindingKey, composeWrappedSourceMetadata, createParserContext, defineInheritedAnnotationParser, defineParseLanes, defineSourceBindingOnlyAnnotationCompletionParser, getDelegatingSuggestRuntimeNodes, getDocPage, getDocPageAsync, getDocPageSync, getOwnParseLanes, getParserSuggestRuntimeNodes, inheritParentAnnotationsKey, parse, parseAsync, parseLanesKey, parseSync, suggest, suggestAsync, suggestSync, unmatchedNonCliDependencySourceStateMarker };

package/dist/modifiers.cjs

@@ -231,6 +231,44 @@ function processOptionalStyleResult(result, innerState, context) {
 	};
 	return result;
 }
+function adaptOptionalStyleParseLanes(parser) {
+	const lanes = require_internal_parser.getOwnParseLanes(parser);
+	if (lanes == null) return void 0;
+	const consumptionGroup = {};
+	return lanes.map((lane) => ({
+		priority: lane.priority,
+		zeroConsumptionGroup: lane.zeroConsumptionGroup,
+		settlesZeroConsumption: lane.settlesZeroConsumption,
+		leadingNames: lane.leadingNames,
+		acceptingAnyToken: false,
+		requiredConsumptionGroups: [...lane.requiredConsumptionGroups?.map((group) => ({
+			id: group.id,
+			...group.isActive == null ? {} : { isActive(state) {
+				const innerState = Array.isArray(state) ? state[0] : parser.initialState;
+				return group.isActive?.(innerState) ?? true;
+			} }
+		})) ?? [], {
+			id: consumptionGroup,
+			isActive(state) {
+				return Array.isArray(state);
+			}
+		}],
+		parse(context) {
+			const innerState = deriveOptionalInnerParseState(context.state, parser);
+			const innerContext = {
+				...context,
+				state: innerState
+			};
+			return require_mode_dispatch.dispatchByMode(parser.mode, () => {
+				const result = lane.parse(innerContext);
+				return processOptionalStyleResult(result, innerState, context);
+			}, async () => {
+				const result = await lane.parse(innerContext);
+				return processOptionalStyleResult(result, innerState, context);
+			});
+		}
+	}));
+}
 /**
 * Creates a `shouldDeferCompletion` adapter that unwraps the outer state
 * shape (`[TState] | undefined`) used by {@link optional} and
@@ -420,6 +458,7 @@ function optional(parser) {
 		const composed = require_dependency_metadata.composeDependencyMetadata(parser.dependencyMetadata, "optional");
 		if (composed != null) optionalParser.dependencyMetadata = composed;
 	}
+	require_internal_parser.defineParseLanes(optionalParser, adaptOptionalStyleParseLanes(parser));
 	require_internal_parser.defineInheritedAnnotationParser(optionalParser);
 	require_internal_parser.defineSourceBindingOnlyAnnotationCompletionParser(optionalParser);
 	return optionalParser;
@@ -654,6 +693,7 @@ function withDefault(parser, defaultValue, options) {
 		} });
 		if (composed != null) withDefaultParser.dependencyMetadata = composed;
 	}
+	require_internal_parser.defineParseLanes(withDefaultParser, adaptOptionalStyleParseLanes(parser));
 	require_internal_parser.defineInheritedAnnotationParser(withDefaultParser);
 	require_internal_parser.defineSourceBindingOnlyAnnotationCompletionParser(withDefaultParser);
 	return withDefaultParser;
@@ -793,6 +833,7 @@ function map(parser, transform) {
 			return parser.getDocFragments(state, void 0);
 		}
 	};
+	require_internal_parser.defineParseLanes(mappedParser, require_internal_parser.getOwnParseLanes(parser));
 	delete mappedParser.normalizeValue;
 	delete mappedParser.validateValue;
 	if ("placeholder" in parser) Object.defineProperty(mappedParser, "placeholder", {
@@ -1509,6 +1550,7 @@ function multiple(parser, options = {}) {
 function nonEmpty(parser) {
 	const syncParser = parser;
 	const initialState = parser.initialState;
+	const consumptionGroup = {};
 	const processNonEmptyResult = (result) => {
 		if (!result.success) return result;
 		if (result.consumed.length === 0) return {
@@ -1561,6 +1603,17 @@ function nonEmpty(parser) {
 			return syncParser.getDocFragments(state, defaultValue);
 		}
 	};
+	require_internal_parser.defineParseLanes(nonEmptyParser, require_internal_parser.getOwnParseLanes(parser)?.map((lane) => ({
+		priority: lane.priority,
+		zeroConsumptionGroup: lane.zeroConsumptionGroup,
+		settlesZeroConsumption: lane.settlesZeroConsumption,
+		leadingNames: lane.leadingNames,
+		acceptingAnyToken: lane.acceptingAnyToken,
+		requiredConsumptionGroups: [...lane.requiredConsumptionGroups ?? [], { id: consumptionGroup }],
+		parse(context) {
+			return lane.parse(context);
+		}
+	})));
 	if ("placeholder" in parser) Object.defineProperty(nonEmptyParser, "placeholder", {
 		get() {
 			return parser.placeholder;

package/dist/modifiers.js

@@ -1,7 +1,7 @@
 import { annotateFreshArray, annotationKey, getAnnotations, inheritAnnotations, isInjectedAnnotationWrapper, unwrapInjectedAnnotationWrapper } from "./internal/annotations.js";
 import { formatMessage, message, text } from "./message.js";
 import { dispatchByMode, dispatchIterableByMode, mapModeValue, wrapForMode } from "./internal/mode-dispatch.js";
-import { defineInheritedAnnotationParser, defineSourceBindingOnlyAnnotationCompletionParser, unmatchedNonCliDependencySourceStateMarker } from "./internal/parser.js";
+import { defineInheritedAnnotationParser, defineParseLanes, defineSourceBindingOnlyAnnotationCompletionParser, getOwnParseLanes, unmatchedNonCliDependencySourceStateMarker } from "./internal/parser.js";
 import { getDelegatedAnnotationState, hasDelegatedAnnotationCarrier, isAnnotationWrappedInitialState, normalizeDelegatedAnnotationState, normalizeNestedDelegatedAnnotationState } from "./annotation-state.js";
 import { mergeChildExec, withChildContext, withChildExecPath } from "./execution-context.js";
 import { completeOrExtractPhase2Seed, extractPhase2Seed, extractPhase2SeedKey, phase2SeedFromValueResult } from "./phase2-seed.js";
@@ -231,6 +231,44 @@ function processOptionalStyleResult(result, innerState, context) {
 	};
 	return result;
 }
+function adaptOptionalStyleParseLanes(parser) {
+	const lanes = getOwnParseLanes(parser);
+	if (lanes == null) return void 0;
+	const consumptionGroup = {};
+	return lanes.map((lane) => ({
+		priority: lane.priority,
+		zeroConsumptionGroup: lane.zeroConsumptionGroup,
+		settlesZeroConsumption: lane.settlesZeroConsumption,
+		leadingNames: lane.leadingNames,
+		acceptingAnyToken: false,
+		requiredConsumptionGroups: [...lane.requiredConsumptionGroups?.map((group) => ({
+			id: group.id,
+			...group.isActive == null ? {} : { isActive(state) {
+				const innerState = Array.isArray(state) ? state[0] : parser.initialState;
+				return group.isActive?.(innerState) ?? true;
+			} }
+		})) ?? [], {
+			id: consumptionGroup,
+			isActive(state) {
+				return Array.isArray(state);
+			}
+		}],
+		parse(context) {
+			const innerState = deriveOptionalInnerParseState(context.state, parser);
+			const innerContext = {
+				...context,
+				state: innerState
+			};
+			return dispatchByMode(parser.mode, () => {
+				const result = lane.parse(innerContext);
+				return processOptionalStyleResult(result, innerState, context);
+			}, async () => {
+				const result = await lane.parse(innerContext);
+				return processOptionalStyleResult(result, innerState, context);
+			});
+		}
+	}));
+}
 /**
 * Creates a `shouldDeferCompletion` adapter that unwraps the outer state
 * shape (`[TState] | undefined`) used by {@link optional} and
@@ -420,6 +458,7 @@ function optional(parser) {
 		const composed = composeDependencyMetadata(parser.dependencyMetadata, "optional");
 		if (composed != null) optionalParser.dependencyMetadata = composed;
 	}
+	defineParseLanes(optionalParser, adaptOptionalStyleParseLanes(parser));
 	defineInheritedAnnotationParser(optionalParser);
 	defineSourceBindingOnlyAnnotationCompletionParser(optionalParser);
 	return optionalParser;
@@ -654,6 +693,7 @@ function withDefault(parser, defaultValue, options) {
 		} });
 		if (composed != null) withDefaultParser.dependencyMetadata = composed;
 	}
+	defineParseLanes(withDefaultParser, adaptOptionalStyleParseLanes(parser));
 	defineInheritedAnnotationParser(withDefaultParser);
 	defineSourceBindingOnlyAnnotationCompletionParser(withDefaultParser);
 	return withDefaultParser;
@@ -793,6 +833,7 @@ function map(parser, transform) {
 			return parser.getDocFragments(state, void 0);
 		}
 	};
+	defineParseLanes(mappedParser, getOwnParseLanes(parser));
 	delete mappedParser.normalizeValue;
 	delete mappedParser.validateValue;
 	if ("placeholder" in parser) Object.defineProperty(mappedParser, "placeholder", {
@@ -1509,6 +1550,7 @@ function multiple(parser, options = {}) {
 function nonEmpty(parser) {
 	const syncParser = parser;
 	const initialState = parser.initialState;
+	const consumptionGroup = {};
 	const processNonEmptyResult = (result) => {
 		if (!result.success) return result;
 		if (result.consumed.length === 0) return {
@@ -1561,6 +1603,17 @@ function nonEmpty(parser) {
 			return syncParser.getDocFragments(state, defaultValue);
 		}
 	};
+	defineParseLanes(nonEmptyParser, getOwnParseLanes(parser)?.map((lane) => ({
+		priority: lane.priority,
+		zeroConsumptionGroup: lane.zeroConsumptionGroup,
+		settlesZeroConsumption: lane.settlesZeroConsumption,
+		leadingNames: lane.leadingNames,
+		acceptingAnyToken: lane.acceptingAnyToken,
+		requiredConsumptionGroups: [...lane.requiredConsumptionGroups ?? [], { id: consumptionGroup }],
+		parse(context) {
+			return lane.parse(context);
+		}
+	})));
 	if ("placeholder" in parser) Object.defineProperty(nonEmptyParser, "placeholder", {
 		get() {
 			return parser.placeholder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",
@@ -196,11 +196,11 @@
   },
   "sideEffects": false,
   "devDependencies": {
+    "@optique/env": "1.1.5",
     "@types/node": "^24.0.0",
     "fast-check": "^4.7.0",
     "tsdown": "^0.13.0",
-    "typescript": "^5.8.3",
-    "@optique/env": "1.1.3"
+    "typescript": "^5.8.3"
   },
   "scripts": {
     "build": "tsdown",