@eventcatalog/sdk 2.21.2 → 2.23.0

package/dist/index.d.mts

@@ -188,8 +188,44 @@ interface Service extends BaseSchema {
   };
 }
 
+type AgentTool = {
+  name: string;
+  type: string;
+  icon?: string;
+  url?: string;
+  description?: string;
+};
+
+type AgentModel = {
+  provider?: string;
+  name?: string;
+  version?: string;
+};
+
+interface Agent extends BaseSchema {
+  sends?: SendsPointer[];
+  receives?: ReceivesPointer[];
+  writesTo?: ResourcePointer[];
+  readsFrom?: ResourcePointer[];
+  flows?: ResourcePointer[];
+  model?: AgentModel;
+  tools?: AgentTool[];
+  detailsPanel?: {
+    domains?: DetailPanelProperty;
+    messages?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+    containers?: DetailPanelProperty;
+    tools?: DetailPanelProperty;
+    model?: DetailPanelProperty;
+  };
+}
+
 interface Domain extends BaseSchema {
   services?: ResourcePointer[];
+  agents?: ResourcePointer[];
   domains?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
@@ -200,6 +236,7 @@ interface Domain extends BaseSchema {
     parentDomains?: DetailPanelProperty;
     subdomains?: DetailPanelProperty;
     services?: DetailPanelProperty;
+    agents?: DetailPanelProperty;
     entities?: DetailPanelProperty;
     messages?: DetailPanelProperty;
     ubiquitousLanguage?: DetailPanelProperty;
@@ -336,10 +373,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;
@@ -400,6 +438,7 @@ type EventCatalog = {
   resources: {
     domains?: ExportedResource<Domain>[];
     services?: ExportedResource<Service>[];
+    agents?: ExportedResource<Agent>[];
     messages?: {
       events?: ExportedResource<Event>[];
       queries?: ExportedResource<Query>[];
@@ -429,6 +468,7 @@ type SnapshotGitInfo = {
 type SnapshotResources = {
     domains: Record<string, any>[];
     services: Record<string, any>[];
+    agents?: Record<string, any>[];
     messages: {
         events: Record<string, any>[];
         commands: Record<string, any>[];
@@ -459,7 +499,7 @@ type SnapshotMeta = {
     filePath: string;
     git?: SnapshotGitInfo;
 };
-type SnapshotResourceType = 'event' | 'command' | 'query' | 'service' | 'domain' | 'channel';
+type SnapshotResourceType = 'event' | 'command' | 'query' | 'service' | 'agent' | 'domain' | 'channel';
 type ResourceChangeType = 'added' | 'removed' | 'modified' | 'versioned';
 type ResourceChange = {
     resourceId: string;
@@ -537,6 +577,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.
  */
@@ -781,6 +831,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.
      *
@@ -986,6 +1056,22 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
+    /**
+     * Adds an event to an agent in EventCatalog
+     *
+     * @param event - The event to write to the agent
+     * @param agent - The agent and its id to write the event to
+     * @param options - Optional options to write the event
+     *
+     */
+    writeEventToAgent: (event: Event, agent: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
      *
@@ -1099,6 +1185,22 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
+    /**
+     * Adds a command to an agent in EventCatalog
+     *
+     * @param command - The command to write to the agent
+     * @param agent - The agent and its id to write the command to
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommandToAgent: (command: Command, agent: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
      *
@@ -1212,6 +1314,22 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
+    /**
+     * Adds a query to an agent in EventCatalog
+     *
+     * @param query - The query to write to the agent
+     * @param agent - The agent and its id to write the query to
+     * @param options - Optional options to write the query
+     *
+     */
+    writeQueryToAgent: (query: Query, agent: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
     /**
      * Remove an query to EventCatalog (modeled on the standard POSIX rm utility)
      *
@@ -1417,14 +1535,7 @@ declare const _default: (path: string) => {
         path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
-        format? /**
-         * Adds an event to a service in EventCatalog
-         *
-         * @param event - The event to write to the service
-         * @param service - The service and it's id to write to the event to
-         * @param options - Optional options to write the event
-         *
-         */: "md" | "mdx";
+        format?: "md" | "mdx";
     }) => Promise<void>;
     /**
      * Adds a versioned service to EventCatalog
@@ -1446,12 +1557,7 @@ declare const _default: (path: string) => {
         version?: string;
         direction?: string;
     }, options?: {
-        path? /**
-         * Returns a command from EventCatalog
-         * @param id - The id of the command to retrieve
-         * @param version - Optional id of the version to get (supports semver)
-         * @returns Command|Undefined
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1659,6 +1765,67 @@ declare const _default: (path: string) => {
      * @returns The service.
      */
     toService: (file: string) => Promise<Service>;
+    /**
+     * ================================
+     *            Agents
+     * ================================
+     */
+    writeAgent: (agent: Agent, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    writeVersionedAgent: (agent: Agent) => Promise<void>;
+    writeAgentToDomain: (agent: Agent, domain: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    getAgent: (id: string, version?: string) => Promise<Agent>;
+    getAgentByPath: (path: string) => Promise<Agent>;
+    getAgents: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Agent[]>;
+    versionAgent: (id: string) => Promise<void>;
+    rmAgent: (path: string) => Promise<void>;
+    rmAgentById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    addFileToAgent: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    addEventToAgent: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+        fields?: string[];
+        group?: string;
+    }, version?: string) => Promise<void>;
+    addCommandToAgent: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+        fields?: string[];
+        group?: string;
+    }, version?: string) => Promise<void>;
+    addQueryToAgent: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+        fields?: string[];
+        group?: string;
+    }, version?: string) => Promise<void>;
+    addDataStoreToAgent: (id: string, direction: string, dataStore: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    addFlowToAgent: (id: string, flow: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    agentHasVersion: (id: string, version?: string) => Promise<boolean>;
+    isAgent: (path: string) => Promise<boolean>;
+    toAgent: (file: string) => Promise<Agent>;
     /**
      * ================================
      *            Domains
@@ -1756,6 +1923,17 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds a given agent to a domain
+     * @param id - The id of the domain
+     * @param agent - The id and version of the agent to add
+     * @param version - (Optional) The version of the domain to add the agent to
+     * @returns
+     */
+    addAgentToDomain: (id: string, agent: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -2045,29 +2223,29 @@ declare const _default: (path: string) => {
         attachSchema?: boolean;
     }) => Promise<Message>;
     /**
-     * Returns the producers and consumers (services) for a given message
+     * Returns the producers and consumers (services and agents) for a given message
      * @param id - The id of the message to get the producers and consumers for
      * @param version - Optional version of the message
-     * @returns { producers: Service[], consumers: Service[] }
+     * @returns { producers: (Service|Agent)[], consumers: (Service|Agent)[] }
      */
     getProducersAndConsumersForMessage: (id: string, version?: string, options?: {
         latestOnly?: boolean;
     }) => Promise<{
-        producers: Service[];
-        consumers: Service[];
+        producers: (Service | Agent)[];
+        consumers: (Service | Agent)[];
     }>;
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
-     * @returns Service[]
+     * @returns (Service|Agent)[]
      */
-    getConsumersOfSchema: (path: string) => Promise<Service[]>;
+    getConsumersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
-     * @returns Service[]
+     * @returns (Service|Agent)[]
      */
-    getProducersOfSchema: (path: string) => Promise<Service[]>;
+    getProducersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
     /**
      * Returns the schema for a given message (event, command or query) by its id and version.
      * If no version is given, the latest version is used.
@@ -2215,6 +2393,28 @@ declare const _default: (path: string) => {
     writeFlowToService: (flow: Flow, service: {
         id: string;
         version?: string;
+    }, options?: {
+        path?: string;
+        format? /**
+         * Adds a file to the given event
+         * @param id - The id of the event to add the file to
+         * @param file - File contents to add including the content and the file name
+         * @param version - Optional version of the event to add the file to
+         * @returns
+         */: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Adds a flow to an agent in EventCatalog
+     *
+     * @param flow - The flow to write to the agent
+     * @param agent - The agent and its id to write the flow to
+     * @param options - Optional options to write the flow
+     *
+     */
+    writeFlowToAgent: (flow: Flow, agent: {
+        id: string;
+        version?: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -2522,4 +2722,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 Agent, type AgentModel, type AgentTool, 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 };