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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usearazzo/runner",
-  "version": "1.0.1-alpha.24",
+  "version": "1.0.1-alpha.25",
   "description": "Runner for Arazzo Workflows.",
   "keywords": [
     "arazzo",
@@ -73,8 +73,8 @@
     "@swaggerexpert/json-pointer": "^3.0.2",
     "@swaggerexpert/jsonpath": "^4.0.5",
     "@swaggerexpert/media-types": "^1.0.2",
-    "@usearazzo/parser": "1.0.1-alpha.24",
-    "@usearazzo/resolver": "1.0.1-alpha.24",
+    "@usearazzo/parser": "1.0.1-alpha.25",
+    "@usearazzo/resolver": "1.0.1-alpha.25",
     "@xmldom/xmldom": "^0.9.12",
     "fontoxpath": "^3.34.0",
     "ramda": "^0.32.0",
@@ -94,5 +94,5 @@
   "devDependencies": {
     "swagger-client": "^3.38.4"
   },
-  "gitHead": "ba457d4dfc1a0a0ccd91e38ad9b33b08d07dc3f0"
+  "gitHead": "37de6e45a52dabf8a924f09fed3ae4d41396be7d"
 }

package/src/document/ArazzoDocument.cjs

@@ -6,11 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
 var _APIDocument = _interopRequireDefault(require("./APIDocument.cjs"));
+/**
+ * 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.default {
@@ -46,6 +54,30 @@ class ArazzoDocument extends _APIDocument.default {
     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, _apidomJsonPointer.evaluate)(this.parseResult.api, jsonPointer);
+      return {
+        workflowId,
+        jsonPointer,
+        ...((0, _apidomDatamodel.isStringElement)(summary) && {
+          summary: (0, _apidomCore.toValue)(summary)
+        }),
+        ...((0, _apidomDatamodel.isStringElement)(description) && {
+          description: (0, _apidomCore.toValue)(description)
+        })
+      };
+    });
+  }
+
   /**
    * Resolves a source description name to its canonical URI — precomputed by
    * the provider, resolved against this document's base URI.

package/src/document/ArazzoDocument.mjs

@@ -1,9 +1,16 @@
 import { toValue } from '@speclynx/apidom-core';
+import { isStringElement } from '@speclynx/apidom-datamodel';
+import { evaluate } from '@speclynx/apidom-json-pointer';
 import APIDocument from "./APIDocument.mjs";
+/**
+ * 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 {
@@ -39,6 +46,30 @@ class ArazzoDocument extends APIDocument {
     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
+      } = evaluate(this.parseResult.api, jsonPointer);
+      return {
+        workflowId,
+        jsonPointer,
+        ...(isStringElement(summary) && {
+          summary: toValue(summary)
+        }),
+        ...(isStringElement(description) && {
+          description: toValue(description)
+        })
+      };
+    });
+  }
+
   /**
    * Resolves a source description name to its canonical URI — precomputed by
    * the provider, resolved against this document's base URI.

package/types/runner.d.ts

@@ -97,7 +97,7 @@ export declare abstract class APIDocument {
 /**
  * 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
  */
 export declare class ArazzoDocument extends APIDocument {
@@ -123,6 +123,12 @@ export declare class ArazzoDocument extends APIDocument {
      * Type guard for ArazzoDocument.
      */
     static is(doc: APIDocument): doc is ArazzoDocument;
+    /**
+     * 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(): WorkflowDescriptor[];
     /**
      * Resolves a source description name to its canonical URI — precomputed by
      * the provider, resolved against this document's base URI.
@@ -2402,6 +2408,31 @@ export declare class UnmatchedProviderError extends ArazzoRunnerError {
     readonly uri?: string;
 }
 
+/**
+ * A workflow of an Arazzo document, as listed by
+ * {@link ArazzoDocument.listWorkflows}.
+ * @public
+ */
+export declare interface WorkflowDescriptor {
+    /**
+     * The id `ArazzoRunner.execute` takes to run the workflow.
+     */
+    workflowId: WorkflowId;
+    /**
+     * JSON Pointer to the workflow within the document.
+     */
+    jsonPointer: JSONPointer;
+    /**
+     * Present only when the workflow has a string `summary`.
+     */
+    summary?: string;
+    /**
+     * Present only when the workflow has a string `description`, as written
+     * (CommonMark).
+     */
+    description?: string;
+}
+
 /**
  * Per-call options for {@link WorkflowExecutor.execute}.
  * @public