@eventcatalog/sdk 2.21.1 → 2.22.0

package/dist/index.d.mts

@@ -246,6 +246,7 @@ interface Badge {
   backgroundColor: string;
   textColor: string;
   icon?: string;
+  url?: string;
 }
 
 interface Changelog {
@@ -335,10 +336,11 @@ declare enum DataClassification {
 
 interface FlowStep {
   id: string | number;
-  type?: 'node' | 'message' | 'user' | 'actor';
+  type?: 'node' | 'message' | 'agent' | 'user' | 'actor';
   title: string;
   summary?: string;
   message?: ResourcePointer;
+  agent?: ResourcePointer;
   service?: ResourcePointer;
   flow?: ResourcePointer;
   container?: ResourcePointer;
@@ -536,6 +538,16 @@ type FlowMessageStepInput<TMessageId extends string = string> = FlowStepInput &
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references an agent.
+ */
+type FlowAgentStepInput = FlowStepInput & {
+    agent?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that references a service.
  */
@@ -780,6 +792,26 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add an agent step.
+     *
+     * @param step - The agent step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addAgentStep({
+     *     id: 'FraudReviewAgent',
+     *     agent: { id: 'FraudReviewAgent', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addAgentStep(step: FlowAgentStepInput): this;
     /**
      * Add a data store step.
      *
@@ -2521,4 +2553,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.d.ts

@@ -246,6 +246,7 @@ interface Badge {
   backgroundColor: string;
   textColor: string;
   icon?: string;
+  url?: string;
 }
 
 interface Changelog {
@@ -335,10 +336,11 @@ declare enum DataClassification {
 
 interface FlowStep {
   id: string | number;
-  type?: 'node' | 'message' | 'user' | 'actor';
+  type?: 'node' | 'message' | 'agent' | 'user' | 'actor';
   title: string;
   summary?: string;
   message?: ResourcePointer;
+  agent?: ResourcePointer;
   service?: ResourcePointer;
   flow?: ResourcePointer;
   container?: ResourcePointer;
@@ -536,6 +538,16 @@ type FlowMessageStepInput<TMessageId extends string = string> = FlowStepInput &
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references an agent.
+ */
+type FlowAgentStepInput = FlowStepInput & {
+    agent?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that references a service.
  */
@@ -780,6 +792,26 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add an agent step.
+     *
+     * @param step - The agent step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addAgentStep({
+     *     id: 'FraudReviewAgent',
+     *     agent: { id: 'FraudReviewAgent', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addAgentStep(step: FlowAgentStepInput): this;
     /**
      * Add a data store step.
      *
@@ -2521,4 +2553,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.js

@@ -2529,6 +2529,7 @@ var import_node_path19 = require("path");
 var cloneStep = (step) => ({
   ...step,
   ...step.message ? { message: { ...step.message } } : {},
+  ...step.agent ? { agent: { ...step.agent } } : {},
   ...step.service ? { service: { ...step.service } } : {},
   ...step.flow ? { flow: { ...step.flow } } : {},
   ...step.container ? { container: { ...step.container } } : {},
@@ -2677,6 +2678,40 @@ var FlowBuilder = class _FlowBuilder {
       step.nextSteps
     );
   }
+  /**
+   * Add an agent step.
+   *
+   * @param step - The agent step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addAgentStep({
+   *     id: 'FraudReviewAgent',
+   *     agent: { id: 'FraudReviewAgent', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addAgentStep(step) {
+    const agent = step.agent || {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        agent: { ...agent, ...step.version && !agent.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
   /**
    * Add a data store step.
    *