@usearazzo/runner 1.0.1-alpha.24 → 1.0.1-alpha.25

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.25](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.24...v1.0.1-alpha.25) (2026-11-04)
+
+### Features
+
+- **runner:** list the workflows of an Arazzo document ([#321](https://github.com/usearazzo/arazzo-toolkit/issues/321)) ([93a2fc9](https://github.com/usearazzo/arazzo-toolkit/commit/93a2fc9738d095fab25bb5ba7afffe791ed4eb20)), closes [#83](https://github.com/usearazzo/arazzo-toolkit/issues/83)
+
 ## [1.0.1-alpha.24](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.23...v1.0.1-alpha.24) (2026-11-04)
 
 ### Features

package/README.md

@@ -112,6 +112,8 @@ const result = await runner.execute('authenticateAndOrderPet', {
 
 `runner.document` and `runner.registry` are the loaded entry document and the registry holding its source descriptions; unless you pass one, every runner `load` returns has a registry of its own. `load` takes the seams of the building blocks it wires: `registry` (one registry backs one entry document, so loading a different document into it throws `InvalidEntryDocumentError`), `httpClient` and `requestInterceptor`, and the workflow executor's `maxSteps`, `maxWorkflowDepth`, `sleep` and `now`. To bind a runner to a document you already acquired, use `new ArazzoRunner({ document, registry })`; it throws `InvalidEntryDocumentError` unless `document` is the entry document of `registry`.
 
+To see what a document offers before running it, `runner.document.listWorkflows()` returns a `WorkflowDescriptor` for each workflow `execute` accepts, in document order: its `workflowId`, its `jsonPointer` in the document and, when the document gives them as strings, its `summary` and `description`. It reads the entry document only; source descriptions are not loaded.
+
 To add credentials, pass a `requestInterceptor`:
 
 ```js

package/dist/arazzo-runner.browser.js

@@ -10573,16 +10573,27 @@ class APIDocument {
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(7456);
-/* harmony import */ var _APIDocument_ts__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(44919);
+/* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(62823);
+/* harmony import */ var _speclynx_apidom_json_pointer__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(94851);
+/* harmony import */ var _APIDocument_ts__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(44919);
+
+
+
+
 
+/**
+ * A workflow of an Arazzo document, as listed by
+ * {@link ArazzoDocument.listWorkflows}.
+ * @public
+ */
 
 /**
  * An Arazzo document held by the document registry: the parse result together
  * with the indexes the provider built over it — a container, not a logic
- * bearer. The methods below are thin reads of the source description index.
+ * bearer. The methods below are thin reads of those indexes.
  * @public
  */
-class ArazzoDocument extends _APIDocument_ts__WEBPACK_IMPORTED_MODULE_1__["default"] {
+class ArazzoDocument extends _APIDocument_ts__WEBPACK_IMPORTED_MODULE_3__["default"] {
   type = 'arazzo';
   isEntry;
   /**
@@ -10615,6 +10626,30 @@ class ArazzoDocument extends _APIDocument_ts__WEBPACK_IMPORTED_MODULE_1__["defau
     return doc.type === 'arazzo';
   }
 
+  /**
+   * The workflows of this document that can be addressed by `workflowId`, in
+   * document order. Reads this document only: source descriptions are neither
+   * loaded nor listed.
+   */
+  listWorkflows() {
+    return [...this.workflowIndex].map(([workflowId, jsonPointer]) => {
+      const {
+        summary,
+        description
+      } = (0,_speclynx_apidom_json_pointer__WEBPACK_IMPORTED_MODULE_2__.evaluate)(this.parseResult.api, jsonPointer);
+      return {
+        workflowId,
+        jsonPointer,
+        ...((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(summary) && {
+          summary: (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(summary)
+        }),
+        ...((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.isStringElement)(description) && {
+          description: (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_0__["default"])(description)
+        })
+      };
+    });
+  }
+
   /**
    * Resolves a source description name to its canonical URI — precomputed by
    * the provider, resolved against this document's base URI.