@usearazzo/runner 1.0.1-alpha.22 → 1.0.1-alpha.23

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.1-alpha.23](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.22...v1.0.1-alpha.23) (2026-11-04)
+
+### Bug Fixes
+
+- **runner:** align operation reference errors and name the workflow ([#318](https://github.com/usearazzo/arazzo-toolkit/issues/318)) ([308e386](https://github.com/usearazzo/arazzo-toolkit/commit/308e3860074d145983410c4d891471147bb2c3a7)), closes [#317](https://github.com/usearazzo/arazzo-toolkit/issues/317)
+
 ## [1.0.1-alpha.22](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.21...v1.0.1-alpha.22) (2026-11-04)
 
 ### Bug Fixes

package/dist/arazzo-runner.browser.js

@@ -12031,8 +12031,10 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _speclynx_apidom_reference_configuration_empty__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(30698);
 /* harmony import */ var _document_OpenAPIDocument_ts__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(35043);
 /* harmony import */ var _expression_RuntimeExpressionEvaluator_ts__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(77370);
-/* harmony import */ var _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(90713);
-/* harmony import */ var _SourceDescriptionsLocatorNormalizer_ts__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(83461);
+/* harmony import */ var _extractor_OpenAPIOperationExtractor_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(57658);
+/* harmony import */ var _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(17658);
+/* harmony import */ var _SourceDescriptionsLocatorNormalizer_ts__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(83461);
+
 
 
 
@@ -12063,7 +12065,7 @@ __webpack_require__.r(__webpack_exports__);
  *   `$sourceDescriptions.{name}.{operationId}`. Per the Arazzo Specification, a
  *   plain name is only valid when a single (non-arazzo) source description is
  *   defined; multiple sources require the expression form. A plain name is
- *   therefore resolved against the first source description that has it.
+ *   therefore looked up in the first OpenAPI source description only.
  * - `operationPath` embeds a `{$sourceDescriptions.{name}.url}` runtime
  *   expression followed by a JSON Pointer to the operation.
  *
@@ -12071,21 +12073,31 @@ __webpack_require__.r(__webpack_exports__);
  * or wrong); a source is classified by what it actually parses to. The
  * normalizer acquires the referenced source documents from the registry on
  * demand.
+ *
+ * A reference that cannot be resolved throws {@link ExecutionError}, attributed
+ * to the referencing step when a {@link StepScope} is given:
+ * `operation-not-found` when no operation answers it,
+ * `source-description-not-found` for a source name the document does not
+ * define, `source-description-not-openapi` for a source that is not an OpenAPI
+ * document, and `invalid-operation-reference` for a reference malformed as
+ * written. Every returned locator names an existing operation.
  * @public
  */
-class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormalizer_ts__WEBPACK_IMPORTED_MODULE_6__["default"] {
+class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormalizer_ts__WEBPACK_IMPORTED_MODULE_7__["default"] {
+  #extractor = new _extractor_OpenAPIOperationExtractor_ts__WEBPACK_IMPORTED_MODULE_5__["default"]();
+
   /**
    * Normalizes a plain or expression `operationId` to a canonical locator.
    *
    * A whole runtime expression (`$sourceDescriptions.{name}.{operationId}`) is
-   * resolved against its named source; a plain name is resolved against the
-   * first source description that has it.
+   * resolved against its named source; a plain name is looked up in the first
+   * OpenAPI source description only.
    */
-  async normalizeOperationId(operationId, document) {
+  async normalizeOperationId(operationId, document, scope) {
     if ((0,_swaggerexpert_arazzo_runtime_expression__WEBPACK_IMPORTED_MODULE_0__.test)(operationId)) {
-      return this.#resolveSourced(operationId, document);
+      return this.#resolveSourced(operationId, document, scope);
     }
-    return this.#resolvePlainOperationId(operationId, document);
+    return this.#resolvePlainOperationId(operationId, document, scope);
   }
 
   /**
@@ -12101,10 +12113,21 @@ class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormal
    * The runner only needs a URL and a JSON Pointer, so it does not enforce that
    * the source description is identified by a runtime expression rather than a
    * literal URL (a literal URL interpolates to itself and still resolves) — that
-   * is a conformance concern for the validator. It fails only when the URL does
-   * not resolve to an OpenAPI source or the JSON Pointer is invalid.
-   */
-  async normalizeOperationPath(operationPath, document) {
+   * is a conformance concern for the validator. A source name the document does
+   * not define is detected before interpolation, so it is reported as such
+   * rather than as the empty URL it would interpolate to; the JSON Pointer must
+   * locate an operation in the acquired OpenAPI document.
+   */
+  async normalizeOperationPath(operationPath, document, scope) {
+    for (const expression of (0,_swaggerexpert_arazzo_runtime_expression__WEBPACK_IMPORTED_MODULE_0__.extract)(operationPath) ?? []) {
+      const parsed = this.parseSourceDescriptionsExpression(expression);
+      if (parsed !== undefined && document.resolveSourceDescriptionURI(parsed.sourceName) === undefined) {
+        throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationPath "${operationPath}" names source description "${parsed.sourceName}", which the Arazzo document at "${document.uri}" does not define`, {
+          ...scope,
+          reason: 'source-description-not-found'
+        });
+      }
+    }
     const evaluator = new _expression_RuntimeExpressionEvaluator_ts__WEBPACK_IMPORTED_MODULE_4__["default"]({}, {
       strict: false,
       document,
@@ -12113,23 +12136,35 @@ class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormal
     const uriReference = evaluator.interpolate(operationPath);
     const documentURI = _speclynx_apidom_reference_configuration_empty__WEBPACK_IMPORTED_MODULE_2__.sanitize(_speclynx_apidom_reference_configuration_empty__WEBPACK_IMPORTED_MODULE_2__.stripHash(uriReference));
     if (documentURI === '') {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`operationPath "${operationPath}" does not resolve to a source description URL`, {
-        pointer: operationPath,
-        uri: document.uri
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationPath "${operationPath}" does not resolve to a source description URL`, {
+        ...scope,
+        reason: 'invalid-operation-reference'
       });
     }
     const jsonPointer = _swaggerexpert_json_pointer__WEBPACK_IMPORTED_MODULE_1__.URIFragmentIdentifier.fromURIReference(uriReference);
     if (!(0,_swaggerexpert_json_pointer__WEBPACK_IMPORTED_MODULE_1__.testJSONPointer)(jsonPointer)) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`operationPath "${operationPath}" has an invalid JSON Pointer`, {
-        pointer: operationPath,
-        uri: document.uri
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationPath "${operationPath}" has an invalid JSON Pointer`, {
+        ...scope,
+        reason: 'invalid-operation-reference'
       });
     }
     const source = await this.registry.acquire(documentURI);
     if (!_document_OpenAPIDocument_ts__WEBPACK_IMPORTED_MODULE_3__["default"].is(source)) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`operationPath "${operationPath}" does not reference an OpenAPI document`, {
-        pointer: operationPath,
-        uri: documentURI
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationPath "${operationPath}" references "${documentURI}", which is not an OpenAPI document`, {
+        ...scope,
+        reason: 'source-description-not-openapi'
+      });
+    }
+
+    // the extractor owns locating an operation by pointer; its failure here
+    // means the pointer names no operation in this document.
+    try {
+      this.#extractor.extractByPointer(source, jsonPointer);
+    } catch (error) {
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationPath "${operationPath}" does not locate an operation in the OpenAPI document at "${source.uri}"`, {
+        cause: error,
+        ...scope,
+        reason: 'operation-not-found'
       });
     }
     return {
@@ -12137,31 +12172,24 @@ class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormal
       jsonPointer
     };
   }
-
-  /**
-   * Parses a `$sourceDescriptions.{name}.{reference}` expression, asserting
-   * it is a source-descriptions expression.
-   */
-  #parseSourceDescriptionsExpression(expression) {
+  async #resolveSourced(expression, document, scope) {
     const parsed = this.parseSourceDescriptionsExpression(expression);
     if (parsed === undefined) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Unsupported operationId expression "${expression}"`, {
-        operationId: expression
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`operationId "${expression}" is not a $sourceDescriptions.{name}.{operationId} expression`, {
+        ...scope,
+        reason: 'invalid-operation-reference'
       });
     }
-    return parsed;
-  }
-  async #resolveSourced(expression, document) {
     const {
       sourceName,
       reference: operationId
-    } = this.#parseSourceDescriptionsExpression(expression);
-    const openapiDocument = await this.#sourceDocument(sourceName, document);
+    } = parsed;
+    const openapiDocument = await this.#sourceDocument(sourceName, document, scope);
     const jsonPointer = openapiDocument.operationIndex.get(operationId);
     if (jsonPointer === undefined) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Operation "${operationId}" not found in source description "${sourceName}"`, {
-        operationId,
-        uri: openapiDocument.uri
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`Operation "${operationId}" not found in source description "${sourceName}" at "${openapiDocument.uri}"`, {
+        ...scope,
+        reason: 'operation-not-found'
       });
     }
     return {
@@ -12182,15 +12210,15 @@ class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormal
    * Non-OpenAPI (arazzo) sources are skipped. Sources are acquired one at a time
    * until the first OpenAPI source is reached.
    */
-  async #resolvePlainOperationId(operationId, document) {
+  async #resolvePlainOperationId(operationId, document, scope) {
     for (const uri of document.sourceDescriptionURIs()) {
       const source = await this.registry.acquire(uri);
       if (!_document_OpenAPIDocument_ts__WEBPACK_IMPORTED_MODULE_3__["default"].is(source)) continue;
       const jsonPointer = source.operationIndex.get(operationId);
       if (jsonPointer === undefined) {
-        throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Operation "${operationId}" not found in source description at "${source.uri}"`, {
-          operationId,
-          uri: source.uri
+        throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`Operation "${operationId}" not found in source description at "${source.uri}"`, {
+          ...scope,
+          reason: 'operation-not-found'
         });
       }
       return {
@@ -12198,26 +12226,31 @@ class OpenAPIOperationLocatorNormalizer extends _SourceDescriptionsLocatorNormal
         jsonPointer
       };
     }
-    throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Operation "${operationId}" has no OpenAPI source description`, {
-      operationId,
-      uri: document.uri
+
+    // no source was named, so this is not a missing source description: there
+    // is simply no OpenAPI document for the operation to be in.
+    throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`Operation "${operationId}" not found: the Arazzo document at "${document.uri}" has no OpenAPI source description`, {
+      ...scope,
+      reason: 'operation-not-found'
     });
   }
 
   /**
    * Acquires a source description by name and asserts it is an OpenAPI document.
    */
-  async #sourceDocument(sourceName, document) {
+  async #sourceDocument(sourceName, document, scope) {
     const uri = document.resolveSourceDescriptionURI(sourceName);
     if (uri === undefined) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Source description "${sourceName}" not found`, {
-        uri: document.uri
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`Source description "${sourceName}" not found in the Arazzo document at "${document.uri}"`, {
+        ...scope,
+        reason: 'source-description-not-found'
       });
     }
     const source = await this.registry.acquire(uri);
     if (!_document_OpenAPIDocument_ts__WEBPACK_IMPORTED_MODULE_3__["default"].is(source)) {
-      throw new _errors_ExtractionError_ts__WEBPACK_IMPORTED_MODULE_5__["default"](`Source description "${sourceName}" is not an OpenAPI document`, {
-        uri
+      throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_6__["default"](`Source description "${sourceName}" at "${uri}" is not an OpenAPI document`, {
+        ...scope,
+        reason: 'source-description-not-openapi'
       });
     }
     return source;
@@ -12431,38 +12464,45 @@ class StepExecutor {
    * request nobody is waiting for, whose wire-level cancellation would surface
    * as a transport {@link ClientError} — a request that failed on its own terms
    * — rather than as the withdrawal it is.
+   *
+   * `workflowId` names the workflow the step belongs to; every error raised
+   * here then carries it alongside the `stepId`, since step ids are only
+   * unique within a workflow. The workflow executor always passes it.
    */
-  async execute(step, state, executeOptions = {}) {
+  async execute(step, state, executeOptions = {}, workflowId) {
     const stepId = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.stepId);
+    const scope = {
+      ...(workflowId === undefined ? {} : {
+        workflowId
+      }),
+      stepId
+    };
 
     // a step's target fields are mutually exclusive; declaring more than one is
     // malformed and has no defined resolution.
     const declaredTargets = STEP_TARGET_FIELDS.filter(field => (0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(step[field]));
     if (declaredTargets.length > 1) {
       throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_10__["default"](`Step "${stepId}" declares more than one of ${STEP_TARGET_FIELDS.join(', ')} (mutually exclusive)`, {
-        stepId,
+        ...scope,
         reason: 'ambiguous-target'
       });
     }
     if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(step.workflowId)) {
       throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_10__["default"](`Step "${stepId}" targets a workflowId; use the workflow executor`, {
-        stepId,
+        ...scope,
         reason: 'workflow-step'
       });
     }
-    this.assertSuccessCriteria(step);
+    this.assertSuccessCriteria(step, workflowId);
 
     // locate which operation the step invokes — reduced to a (document, JSON
     // Pointer) locator that the operation executor extracts, normalizes,
     // assembles into a standalone doc, and runs.
-    const locator = await this.#locateOperation(step, stepId);
+    const locator = await this.#locateOperation(step, scope);
 
     // resolve parameters and request body against the pre-request context.
     // keyed by '{in}.{name}' rather than bare name, so two parameters that
     // legally differ only in their location each reach their own place.
-    const scope = {
-      stepId
-    };
     const preContext = state.toContext();
     const parameters = this.#parameterResolver.resolve(step.parameters, expression => this.#evaluate(preContext, expression), scope);
     const requestBody = this.#requestBodyResolver.resolve(step.requestBody, expression => this.#evaluate(preContext, expression), scope);
@@ -12473,9 +12513,7 @@ class StepExecutor {
     // live side effect. The signal stays in the bag, so a request already in
     // flight is aborted by the transport as before.
     const signal = (0,_abort_ts__WEBPACK_IMPORTED_MODULE_13__.readAbortSignal)(executeOptions);
-    (0,_abort_ts__WEBPACK_IMPORTED_MODULE_13__.throwIfAborted)(signal, {
-      stepId
-    });
+    (0,_abort_ts__WEBPACK_IMPORTED_MODULE_13__.throwIfAborted)(signal, scope);
 
     // the Arazzo-derived parameters and request body are spread after the opaque
     // executeOptions bag so they take precedence over it. the operation executor
@@ -12494,22 +12532,20 @@ class StepExecutor {
       // cancelled, it did not: reporting it as the abort keeps one error shape
       // whether the run was withdrawn between two steps or mid-flight, and keeps
       // the whole feature from reading differently per transport.
-      ;(0,_abort_ts__WEBPACK_IMPORTED_MODULE_13__.throwIfAborted)(signal, {
-        stepId
-      });
+      ;(0,_abort_ts__WEBPACK_IMPORTED_MODULE_13__.throwIfAborted)(signal, scope);
       throw error;
     }
 
     // evaluate criteria, outputs, and the next action against the post-request
     // context (with $request / $url / $method and $response / $statusCode).
     const postContext = state.toContext(this.#requestContext(response), this.#responseContext(response));
-    const successCriteria = this.evaluateCriteria(step, postContext);
+    const successCriteria = this.evaluateCriteria(step, postContext, workflowId);
     const successful = successCriteria.every(criterion => criterion.met);
     const outputs = this.#outputResolver.resolve(step.outputs, expression => this.#evaluate(postContext, expression), scope);
     const {
       matchedActions,
       actionCriteria
-    } = this.selectActions(step, successful, postContext);
+    } = this.selectActions(step, successful, postContext, workflowId);
     return {
       stepId,
       response,
@@ -12539,15 +12575,15 @@ class StepExecutor {
       requestContentType: requestBody.contentType
     };
   }
-  async #locateOperation(step, stepId) {
+  async #locateOperation(step, scope) {
     if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(step.operationId)) {
-      return this.#locatorNormalizer.normalizeOperationId((0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.operationId), this.#document);
+      return this.#locatorNormalizer.normalizeOperationId((0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.operationId), this.#document, scope);
     }
     if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(step.operationPath)) {
-      return this.#locatorNormalizer.normalizeOperationPath((0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.operationPath), this.#document);
+      return this.#locatorNormalizer.normalizeOperationPath((0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.operationPath), this.#document, scope);
     }
-    throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_10__["default"](`Step "${stepId}" has no operationId or operationPath`, {
-      stepId,
+    throw new _errors_ExecutionError_ts__WEBPACK_IMPORTED_MODULE_10__["default"](`Step "${scope.stepId}" has no operationId or operationPath`, {
+      ...scope,
       reason: 'missing-operation'
     });
   }
@@ -12601,10 +12637,12 @@ class StepExecutor {
    * Public for the same reason as {@link StepExecutor.selectActions}: a step
    * targeting a `workflowId` is run by the workflow executor and never reaches
    * {@link StepExecutor.execute}, but its criteria are still the author's
-   * assertion about the step and must be evaluated somewhere.
+   * assertion about the step and must be evaluated somewhere. `workflowId`
+   * names the step's workflow on a thrown error, as for
+   * {@link StepExecutor.execute}.
    */
-  evaluateCriteria(step, context) {
-    this.assertSuccessCriteria(step);
+  evaluateCriteria(step, context, workflowId) {
+    this.assertSuccessCriteria(step, workflowId);
     const criteria = step.successCriteria;
     if (criteria === undefined) return [];
 
@@ -12632,8 +12670,10 @@ class StepExecutor {
    * it runs itself and which therefore never reaches
    * {@link StepExecutor.execute}. Both callers reach the criteria evaluator and
    * the expression context through this one method rather than wiring their own.
+   * `workflowId` names the step's workflow on a thrown error, as for
+   * {@link StepExecutor.execute}.
    */
-  selectActions(step, successful, context) {
+  selectActions(step, successful, context, workflowId) {
     const actionCriteria = [];
     const isCriterionMet = (criterion, action) => {
       const record = {
@@ -12644,6 +12684,9 @@ class StepExecutor {
       return record.met;
     };
     const scope = {
+      ...(workflowId === undefined ? {} : {
+        workflowId
+      }),
       stepId: (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(step.stepId)
     };
     const matchedActions = successful ? this.#actionResolver.resolveOnSuccess(step.onSuccess, isCriterionMet, scope) : this.#actionResolver.resolveOnFailure(step.onFailure, isCriterionMet, scope);
@@ -14088,10 +14131,11 @@ class WorkflowExecutor {
       callStack
     } = invocation;
     if (!(0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(step.workflowId)) {
-      return () => this.#stepExecutor.forDocument(document).execute(step, state, scope.executeOptions);
+      return () => this.#stepExecutor.forDocument(document).execute(step, state, scope.executeOptions, workflowId);
     }
     const reference = this.#subWorkflowReference(step, stepId, workflowId);
     const stepScope = {
+      workflowId,
       stepId
     };
     // the reference resolves to the same locator on every attempt, so it is
@@ -14169,12 +14213,12 @@ class WorkflowExecutor {
       // evaluated by the parent document's step executor — only the sub-run
       // itself switched documents.
       const stepExecutor = this.#stepExecutor.forDocument(document);
-      const successCriteria = stepExecutor.evaluateCriteria(step, context);
+      const successCriteria = stepExecutor.evaluateCriteria(step, context, workflowId);
       const successful = !this.#settledFailed(result) && successCriteria.every(criterion => criterion.met);
       const {
         matchedActions,
         actionCriteria
-      } = stepExecutor.selectActions(step, successful, context);
+      } = stepExecutor.selectActions(step, successful, context, workflowId);
       return {
         stepId,
         successful,