@usearazzo/runner 1.0.1-alpha.17 → 1.0.1-alpha.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usearazzo/runner",
-  "version": "1.0.1-alpha.17",
+  "version": "1.0.1-alpha.19",
   "description": "Runner for Arazzo Workflows.",
   "keywords": [
     "arazzo",
@@ -57,24 +57,24 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^8.0.8",
-    "@speclynx/apidom-core": "^6.1.0",
-    "@speclynx/apidom-datamodel": "^6.1.0",
-    "@speclynx/apidom-error": "^6.1.0",
-    "@speclynx/apidom-json-pointer": "^6.1.0",
-    "@speclynx/apidom-ns-arazzo-1": "^6.1.0",
-    "@speclynx/apidom-ns-openapi-2": "^6.1.0",
-    "@speclynx/apidom-ns-openapi-3-0": "^6.1.0",
-    "@speclynx/apidom-ns-openapi-3-1": "^6.1.0",
-    "@speclynx/apidom-reference": "^6.1.0",
-    "@speclynx/apidom-traverse": "^6.1.0",
+    "@speclynx/apidom-core": "^6.1.2",
+    "@speclynx/apidom-datamodel": "^6.1.2",
+    "@speclynx/apidom-error": "^6.1.2",
+    "@speclynx/apidom-json-pointer": "^6.1.2",
+    "@speclynx/apidom-ns-arazzo-1": "^6.1.2",
+    "@speclynx/apidom-ns-openapi-2": "^6.1.2",
+    "@speclynx/apidom-ns-openapi-3-0": "^6.1.2",
+    "@speclynx/apidom-ns-openapi-3-1": "^6.1.2",
+    "@speclynx/apidom-reference": "^6.1.2",
+    "@speclynx/apidom-traverse": "^6.1.2",
     "@swaggerexpert/arazzo-criterion": "^1.0.1",
     "@swaggerexpert/arazzo-runtime-expression": "^3.3.0",
     "@swaggerexpert/cookie": "^2.0.2",
     "@swaggerexpert/json-pointer": "^3.0.2",
     "@swaggerexpert/jsonpath": "^4.0.5",
-    "@swaggerexpert/media-types": "^1.0.1",
-    "@usearazzo/parser": "1.0.1-alpha.17",
-    "@usearazzo/resolver": "1.0.1-alpha.17",
+    "@swaggerexpert/media-types": "^1.0.2",
+    "@usearazzo/parser": "1.0.1-alpha.19",
+    "@usearazzo/resolver": "1.0.1-alpha.19",
     "@xmldom/xmldom": "^0.9.12",
     "fontoxpath": "^3.34.0",
     "ramda": "^0.32.0",
@@ -94,5 +94,5 @@
   "devDependencies": {
     "swagger-client": "^3.38.4"
   },
-  "gitHead": "92ccbcd1dff00a1744e6c0543db9d17ee5a91ef2"
+  "gitHead": "54a9b81c5607984c87d82ec159506f522b33a4d7"
 }

package/src/ArazzoRunner.cjs

@@ -45,6 +45,7 @@ class ArazzoRunner {
    * Loads the entry Arazzo document at `uri` (a file system path or URL) and
    * returns a runner bound to it.
    *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
    * @throws UnmatchedProviderError - When no provider can load the document
    * @throws InvalidEntryDocumentError - When the document is not an Arazzo
    * document, or the given registry already backs another entry document

package/src/ArazzoRunner.mjs

@@ -36,6 +36,7 @@ class ArazzoRunner {
    * Loads the entry Arazzo document at `uri` (a file system path or URL) and
    * returns a runner bound to it.
    *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
    * @throws UnmatchedProviderError - When no provider can load the document
    * @throws InvalidEntryDocumentError - When the document is not an Arazzo
    * document, or the given registry already backs another entry document

package/src/errors/DocumentLoadError.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ArazzoRunnerError = _interopRequireDefault(require("./ArazzoRunnerError.cjs"));
+/** @public */
+class DocumentLoadError extends _ArazzoRunnerError.default {}
+var _default = exports.default = DocumentLoadError;

package/src/errors/DocumentLoadError.mjs

@@ -0,0 +1,4 @@
+import ArazzoRunnerError from "./ArazzoRunnerError.mjs";
+/** @public */
+class DocumentLoadError extends ArazzoRunnerError {}
+export default DocumentLoadError;

package/src/index.cjs

@@ -119,6 +119,12 @@ Object.defineProperty(exports, "CriterionEvaluator", {
     return _CriterionEvaluator.default;
   }
 });
+Object.defineProperty(exports, "DocumentLoadError", {
+  enumerable: true,
+  get: function () {
+    return _DocumentLoadError.default;
+  }
+});
 Object.defineProperty(exports, "DocumentRegistry", {
   enumerable: true,
   get: function () {
@@ -420,6 +426,7 @@ var _NormalizationError = _interopRequireDefault(require("./errors/Normalization
 var _ExtractionError = _interopRequireDefault(require("./errors/ExtractionError.cjs"));
 var _InvalidEntryDocumentError = _interopRequireDefault(require("./errors/InvalidEntryDocumentError.cjs"));
 var _UnmatchedProviderError = _interopRequireDefault(require("./errors/UnmatchedProviderError.cjs"));
+var _DocumentLoadError = _interopRequireDefault(require("./errors/DocumentLoadError.cjs"));
 var _RuntimeExpressionError = _interopRequireDefault(require("./errors/RuntimeExpressionError.cjs"));
 var _CriterionError = _interopRequireDefault(require("./errors/CriterionError.cjs"));
 var _ResolverError = _interopRequireDefault(require("./errors/ResolverError.cjs"));

package/src/index.mjs

@@ -69,6 +69,7 @@ export { default as NormalizationError } from "./errors/NormalizationError.mjs";
 export { default as ExtractionError } from "./errors/ExtractionError.mjs";
 export { default as InvalidEntryDocumentError } from "./errors/InvalidEntryDocumentError.mjs";
 export { default as UnmatchedProviderError } from "./errors/UnmatchedProviderError.mjs";
+export { default as DocumentLoadError } from "./errors/DocumentLoadError.mjs";
 export { default as RuntimeExpressionError } from "./errors/RuntimeExpressionError.mjs";
 export { default as CriterionError } from "./errors/CriterionError.mjs";
 export { default as ResolverError } from "./errors/ResolverError.mjs";

package/src/registry/DocumentRegistry.cjs

@@ -10,6 +10,8 @@ var _empty = require("@speclynx/apidom-reference/configuration/empty");
 var _ArazzoDocument = _interopRequireDefault(require("../document/ArazzoDocument.cjs"));
 var _ArazzoDocumentRegistryProvider = _interopRequireDefault(require("./providers/ArazzoDocumentRegistryProvider.cjs"));
 var _OpenAPIDocumentRegistryProvider = _interopRequireDefault(require("./providers/OpenAPIDocumentRegistryProvider.cjs"));
+var _ArazzoRunnerError = _interopRequireDefault(require("../errors/ArazzoRunnerError.cjs"));
+var _DocumentLoadError = _interopRequireDefault(require("../errors/DocumentLoadError.cjs"));
 var _InvalidEntryDocumentError = _interopRequireDefault(require("../errors/InvalidEntryDocumentError.cjs"));
 var _UnmatchedProviderError = _interopRequireDefault(require("../errors/UnmatchedProviderError.cjs"));
 var constants = _interopRequireWildcard(require("../constants.cjs"));
@@ -49,16 +51,29 @@ class DocumentRegistry {
    * Acquires a document by URI. Returns cached document if available,
    * otherwise detects the format, loads via the matching provider,
    * caches, and returns it.
+   *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
+   * @throws UnmatchedProviderError - When no provider can load the document
    */
   async acquire(uri) {
     const canonicalURI = this.#canonicalize(uri);
     const cachedDocument = this.#get(canonicalURI);
     if (cachedDocument) return cachedDocument;
     for (const provider of this.#providers) {
-      if (await provider.canProvide(canonicalURI)) {
-        const document = await provider.provide(canonicalURI);
-        this.#set(canonicalURI, document);
-        return document;
+      try {
+        if (await provider.canProvide(canonicalURI)) {
+          const document = await provider.provide(canonicalURI);
+          this.#set(canonicalURI, document);
+          return document;
+        }
+      } catch (error) {
+        // a document that cannot be read or loaded fails in ApiDOM or the parser;
+        // wrapping it keeps every load failure inside the runner's error hierarchy.
+        if (error instanceof _ArazzoRunnerError.default) throw error;
+        throw new _DocumentLoadError.default(`Failed to load the document at "${canonicalURI}"`, {
+          uri: canonicalURI,
+          cause: error
+        });
       }
     }
     throw new _UnmatchedProviderError.default(`No provider can handle the document at "${canonicalURI}"`, {
@@ -97,6 +112,10 @@ class DocumentRegistry {
   /**
    * Acquires the entry Arazzo document and marks it with `isEntry: true`.
    * Validates that the document is an Arazzo specification.
+   *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
+   * @throws UnmatchedProviderError - When no provider can load the document
+   * @throws InvalidEntryDocumentError - When the document is not an Arazzo document
    */
   async acquireEntryDocument(uri) {
     const document = await this.acquire(uri);

package/src/registry/DocumentRegistry.mjs

@@ -2,6 +2,8 @@ import { url } from '@speclynx/apidom-reference/configuration/empty';
 import ArazzoDocument from "../document/ArazzoDocument.mjs";
 import ArazzoDocumentRegistryProvider from "./providers/ArazzoDocumentRegistryProvider.mjs";
 import OpenAPIDocumentRegistryProvider from "./providers/OpenAPIDocumentRegistryProvider.mjs";
+import ArazzoRunnerError from "../errors/ArazzoRunnerError.mjs";
+import DocumentLoadError from "../errors/DocumentLoadError.mjs";
 import InvalidEntryDocumentError from "../errors/InvalidEntryDocumentError.mjs";
 import UnmatchedProviderError from "../errors/UnmatchedProviderError.mjs";
 import * as constants from "../constants.mjs";
@@ -40,16 +42,29 @@ class DocumentRegistry {
    * Acquires a document by URI. Returns cached document if available,
    * otherwise detects the format, loads via the matching provider,
    * caches, and returns it.
+   *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
+   * @throws UnmatchedProviderError - When no provider can load the document
    */
   async acquire(uri) {
     const canonicalURI = this.#canonicalize(uri);
     const cachedDocument = this.#get(canonicalURI);
     if (cachedDocument) return cachedDocument;
     for (const provider of this.#providers) {
-      if (await provider.canProvide(canonicalURI)) {
-        const document = await provider.provide(canonicalURI);
-        this.#set(canonicalURI, document);
-        return document;
+      try {
+        if (await provider.canProvide(canonicalURI)) {
+          const document = await provider.provide(canonicalURI);
+          this.#set(canonicalURI, document);
+          return document;
+        }
+      } catch (error) {
+        // a document that cannot be read or loaded fails in ApiDOM or the parser;
+        // wrapping it keeps every load failure inside the runner's error hierarchy.
+        if (error instanceof ArazzoRunnerError) throw error;
+        throw new DocumentLoadError(`Failed to load the document at "${canonicalURI}"`, {
+          uri: canonicalURI,
+          cause: error
+        });
       }
     }
     throw new UnmatchedProviderError(`No provider can handle the document at "${canonicalURI}"`, {
@@ -88,6 +103,10 @@ class DocumentRegistry {
   /**
    * Acquires the entry Arazzo document and marks it with `isEntry: true`.
    * Validates that the document is an Arazzo specification.
+   *
+   * @throws DocumentLoadError - When the document cannot be read or loaded
+   * @throws UnmatchedProviderError - When no provider can load the document
+   * @throws InvalidEntryDocumentError - When the document is not an Arazzo document
    */
   async acquireEntryDocument(uri) {
     const document = await this.acquire(uri);