@eventcatalog/sdk 2.26.1 → 2.26.3

package/dist/index.d.mts

@@ -56,6 +56,61 @@ type ResourcePointer = {
   type?: string;
 };
 
+type CatalogGraphResourceType =
+  | 'domain'
+  | 'system'
+  | 'service'
+  | 'agent'
+  | 'event'
+  | 'command'
+  | 'query'
+  | 'flow'
+  | 'channel'
+  | 'entity'
+  | 'container'
+  | 'data-product'
+  | 'adr';
+
+type CatalogGraphRoot = {
+  type: CatalogGraphResourceType;
+  id: string;
+  version?: string;
+};
+
+type CatalogGraphOptions = {
+  /** Number of relationship levels to traverse. Defaults to the complete reachable graph. */
+  depth?: number;
+  /** Return one deduplicated resource list instead of nested children. */
+  flat?: boolean;
+};
+
+type CatalogGraphResource = {
+  type: CatalogGraphResourceType;
+  id: string;
+  version: string;
+};
+
+type CatalogGraphNode = CatalogGraphResource & {
+  children: CatalogGraphNode[];
+};
+
+type NestedCatalogGraph = {
+  root: CatalogGraphNode;
+};
+
+type FlatCatalogGraph = {
+  root: CatalogGraphResource;
+  resources: CatalogGraphResource[];
+};
+
+type CatalogGraph = NestedCatalogGraph | FlatCatalogGraph;
+
+interface GetCatalogGraph {
+  (root: CatalogGraphRoot, options: CatalogGraphOptions & { flat: true }): Promise<FlatCatalogGraph | undefined>;
+  (root: CatalogGraphRoot, options?: CatalogGraphOptions & { flat?: false }): Promise<NestedCatalogGraph | undefined>;
+  (root: CatalogGraphRoot, options: CatalogGraphOptions): Promise<CatalogGraph | undefined>;
+}
+
 type SystemScope = 'internal' | 'external';
 
 type SystemRelationshipPointer = {
@@ -392,18 +447,27 @@ interface DetailPanelProperty {
   visible: boolean;
 }
 
+interface EntityProperty {
+  name: string;
+  type: string;
+  required?: boolean;
+  description?: string;
+  references?: string;
+  referencesIdentifier?: string;
+  referenceTarget?: 'entity';
+  relationType?: string;
+  enum?: string[];
+  properties?: EntityProperty[];
+  items?: {
+    type: string;
+    properties?: EntityProperty[];
+  };
+}
+
 interface Entity extends BaseSchema {
   aggregateRoot?: boolean;
   identifier?: string;
-  properties?: {
-    name: string;
-    type: string;
-    required?: boolean;
-    description?: string;
-    references?: string;
-    referencesIdentifier?: string;
-    relationType?: string;
-  }[];
+  properties?: EntityProperty[];
   detailsPanel?: {
     domains?: DetailPanelProperty;
     services?: DetailPanelProperty;
@@ -1460,23 +1524,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path
-        /**
-         * 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
-         *
-         */
-        ? /**
-         * 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
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2315,6 +2363,13 @@ declare const _default: (path: string) => {
     dumpCatalog: (options?: {
         includeMarkdown?: boolean;
     }) => Promise<EventCatalog>;
+    /**
+     * Returns the resources reachable from a catalog resource.
+     * @param root - Resource to use as the root of the graph
+     * @param options - Traversal depth and whether to return a flat resource list
+     * @returns The resolved graph, or undefined when the root does not exist
+     */
+    getGraph: GetCatalogGraph;
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -2584,13 +2639,19 @@ declare const _default: (path: string) => {
      */
     writeFlowToDomain: (flow: Flow, domain: {
         id: string;
-        version? /**
+        version?: string;
+    }, options?: {
+        path
+        /**
+         * Returns all events from EventCatalog
+         * @param latestOnly - optional boolean, set to true to get only latest versions
+         * @returns Event[]|Undefined
+         */
+        ? /**
          * Returns all events from EventCatalog
          * @param latestOnly - optional boolean, set to true to get only latest versions
          * @returns Event[]|Undefined
          */: string;
-    }, options?: {
-        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2607,12 +2668,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: "md" | "mdx";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -2643,7 +2699,18 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path?: string;
+        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
+         */
+        ? /**
+         * ================================
+         *            Commands
+         * ================================
+         */: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2986,4 +3053,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, 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 ExtensionProperties, 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 MessagePointerInput, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, 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 EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type FlatCatalogGraph, 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 GetCatalogGraph, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.d.ts

@@ -56,6 +56,61 @@ type ResourcePointer = {
   type?: string;
 };
 
+type CatalogGraphResourceType =
+  | 'domain'
+  | 'system'
+  | 'service'
+  | 'agent'
+  | 'event'
+  | 'command'
+  | 'query'
+  | 'flow'
+  | 'channel'
+  | 'entity'
+  | 'container'
+  | 'data-product'
+  | 'adr';
+
+type CatalogGraphRoot = {
+  type: CatalogGraphResourceType;
+  id: string;
+  version?: string;
+};
+
+type CatalogGraphOptions = {
+  /** Number of relationship levels to traverse. Defaults to the complete reachable graph. */
+  depth?: number;
+  /** Return one deduplicated resource list instead of nested children. */
+  flat?: boolean;
+};
+
+type CatalogGraphResource = {
+  type: CatalogGraphResourceType;
+  id: string;
+  version: string;
+};
+
+type CatalogGraphNode = CatalogGraphResource & {
+  children: CatalogGraphNode[];
+};
+
+type NestedCatalogGraph = {
+  root: CatalogGraphNode;
+};
+
+type FlatCatalogGraph = {
+  root: CatalogGraphResource;
+  resources: CatalogGraphResource[];
+};
+
+type CatalogGraph = NestedCatalogGraph | FlatCatalogGraph;
+
+interface GetCatalogGraph {
+  (root: CatalogGraphRoot, options: CatalogGraphOptions & { flat: true }): Promise<FlatCatalogGraph | undefined>;
+  (root: CatalogGraphRoot, options?: CatalogGraphOptions & { flat?: false }): Promise<NestedCatalogGraph | undefined>;
+  (root: CatalogGraphRoot, options: CatalogGraphOptions): Promise<CatalogGraph | undefined>;
+}
+
 type SystemScope = 'internal' | 'external';
 
 type SystemRelationshipPointer = {
@@ -392,18 +447,27 @@ interface DetailPanelProperty {
   visible: boolean;
 }
 
+interface EntityProperty {
+  name: string;
+  type: string;
+  required?: boolean;
+  description?: string;
+  references?: string;
+  referencesIdentifier?: string;
+  referenceTarget?: 'entity';
+  relationType?: string;
+  enum?: string[];
+  properties?: EntityProperty[];
+  items?: {
+    type: string;
+    properties?: EntityProperty[];
+  };
+}
+
 interface Entity extends BaseSchema {
   aggregateRoot?: boolean;
   identifier?: string;
-  properties?: {
-    name: string;
-    type: string;
-    required?: boolean;
-    description?: string;
-    references?: string;
-    referencesIdentifier?: string;
-    relationType?: string;
-  }[];
+  properties?: EntityProperty[];
   detailsPanel?: {
     domains?: DetailPanelProperty;
     services?: DetailPanelProperty;
@@ -1460,23 +1524,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path
-        /**
-         * 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
-         *
-         */
-        ? /**
-         * 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
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2315,6 +2363,13 @@ declare const _default: (path: string) => {
     dumpCatalog: (options?: {
         includeMarkdown?: boolean;
     }) => Promise<EventCatalog>;
+    /**
+     * Returns the resources reachable from a catalog resource.
+     * @param root - Resource to use as the root of the graph
+     * @param options - Traversal depth and whether to return a flat resource list
+     * @returns The resolved graph, or undefined when the root does not exist
+     */
+    getGraph: GetCatalogGraph;
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -2584,13 +2639,19 @@ declare const _default: (path: string) => {
      */
     writeFlowToDomain: (flow: Flow, domain: {
         id: string;
-        version? /**
+        version?: string;
+    }, options?: {
+        path
+        /**
+         * Returns all events from EventCatalog
+         * @param latestOnly - optional boolean, set to true to get only latest versions
+         * @returns Event[]|Undefined
+         */
+        ? /**
          * Returns all events from EventCatalog
          * @param latestOnly - optional boolean, set to true to get only latest versions
          * @returns Event[]|Undefined
          */: string;
-    }, options?: {
-        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2607,12 +2668,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: "md" | "mdx";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -2643,7 +2699,18 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path?: string;
+        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
+         */
+        ? /**
+         * ================================
+         *            Commands
+         * ================================
+         */: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -2986,4 +3053,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, 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 ExtensionProperties, 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 MessagePointerInput, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, 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 EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type FlatCatalogGraph, 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 GetCatalogGraph, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };