@eventcatalog/sdk 2.29.1 → 2.30.0-beta.0

package/LICENSE

@@ -19,13 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
----
-
-Note: Source code within the following directories is licensed under the
-EventCatalog Commercial License and is NOT covered by the MIT License above:
-
-- `packages/core/eventcatalog/src/enterprise/`
-- `packages/core/src/federation/`
-
-See the `LICENSE` file in each directory for the full terms.

package/dist/index.d.mts

@@ -573,12 +573,18 @@ declare enum DataClassification {
 
 interface FlowStep {
   id: string | number;
+  /** @deprecated Ignored by EventCatalog: the kind of step comes from what it points at. */
   type?: 'node' | 'message' | 'agent' | 'user' | 'actor';
-  title: string;
+  /** Defaults to the name of what the step points at (or its id). */
+  title?: string;
   summary?: string;
   message?: ResourcePointer;
   agent?: ResourcePointer;
   service?: ResourcePointer;
+  /** Catalog system referenced by this step. `system` is an alias for `systems`. */
+  systems?: ResourcePointer;
+  system?: ResourcePointer;
+  channel?: ResourcePointer;
   flow?: ResourcePointer;
   container?: ResourcePointer;
   dataProduct?: ResourcePointer;
@@ -587,7 +593,8 @@ interface FlowStep {
     summary?: string;
   };
   custom?: {
-    title: string;
+    /** Defaults to the step's title. */
+    title?: string;
     icon?: string;
     type?: string;
     summary?: string;
@@ -680,7 +687,7 @@ type IndexAsset = {
     hash?: string;
 };
 type IndexReference = ResourcePointer & {
-    kind: 'agent' | 'container' | 'data-product' | 'flow' | 'message' | 'service';
+    kind: 'agent' | 'channel' | 'container' | 'data-product' | 'flow' | 'message' | 'service' | 'system';
 };
 type IndexResource = {
     type: IndexResourceType;
@@ -935,6 +942,16 @@ type FlowServiceStepInput = FlowStepInput & {
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references a channel.
+ */
+type FlowChannelStepInput = FlowStepInput & {
+    channel?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that references a data store/container.
  */
@@ -1169,6 +1186,26 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add a channel step.
+     *
+     * @param step - The channel step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addChannelStep({
+     *     id: 'orders-topic',
+     *     channel: { id: 'orders-topic', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addChannelStep(step: FlowChannelStepInput): this;
     /**
      * Add an agent step.
      *
@@ -1454,7 +1491,9 @@ declare const FederationIndexSchema: z.ZodObject<{
             type: z.ZodOptional<z.ZodString>;
             kind: z.ZodEnum<{
                 service: "service";
+                system: "system";
                 agent: "agent";
+                channel: "channel";
                 message: "message";
                 "data-product": "data-product";
                 container: "container";
@@ -3534,4 +3573,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 Cache, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Conflict, type ConflictKind, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type EdgeDirection, type Entity, type EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type External, FederationIndexSchema, type Fetcher, 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 HydrateOptions, type HydrateResult, type Index, type IndexAsset, type IndexReference, type IndexResource, type IndexResourceType, type IndexSchema, type IndexSidecar, type IndexSpecification, type IndexValidationIssue, InvalidIndexError, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResolutionWarning, type ResolvedAsset, type ResolvedEdge, type ResolvedEntity, type ResolvedGraph, 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, hydrate, parseIndex, resolve };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type Cache, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Conflict, type ConflictKind, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type EdgeDirection, type Entity, type EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type External, FederationIndexSchema, type Fetcher, type FlatCatalogGraph, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowChannelStepInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type GetCatalogGraph, type HydrateOptions, type HydrateResult, type Index, type IndexAsset, type IndexReference, type IndexResource, type IndexResourceType, type IndexSchema, type IndexSidecar, type IndexSpecification, type IndexValidationIssue, InvalidIndexError, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResolutionWarning, type ResolvedAsset, type ResolvedEdge, type ResolvedEntity, type ResolvedGraph, 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, hydrate, parseIndex, resolve };

package/dist/index.d.ts

@@ -573,12 +573,18 @@ declare enum DataClassification {
 
 interface FlowStep {
   id: string | number;
+  /** @deprecated Ignored by EventCatalog: the kind of step comes from what it points at. */
   type?: 'node' | 'message' | 'agent' | 'user' | 'actor';
-  title: string;
+  /** Defaults to the name of what the step points at (or its id). */
+  title?: string;
   summary?: string;
   message?: ResourcePointer;
   agent?: ResourcePointer;
   service?: ResourcePointer;
+  /** Catalog system referenced by this step. `system` is an alias for `systems`. */
+  systems?: ResourcePointer;
+  system?: ResourcePointer;
+  channel?: ResourcePointer;
   flow?: ResourcePointer;
   container?: ResourcePointer;
   dataProduct?: ResourcePointer;
@@ -587,7 +593,8 @@ interface FlowStep {
     summary?: string;
   };
   custom?: {
-    title: string;
+    /** Defaults to the step's title. */
+    title?: string;
     icon?: string;
     type?: string;
     summary?: string;
@@ -680,7 +687,7 @@ type IndexAsset = {
     hash?: string;
 };
 type IndexReference = ResourcePointer & {
-    kind: 'agent' | 'container' | 'data-product' | 'flow' | 'message' | 'service';
+    kind: 'agent' | 'channel' | 'container' | 'data-product' | 'flow' | 'message' | 'service' | 'system';
 };
 type IndexResource = {
     type: IndexResourceType;
@@ -935,6 +942,16 @@ type FlowServiceStepInput = FlowStepInput & {
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references a channel.
+ */
+type FlowChannelStepInput = FlowStepInput & {
+    channel?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that references a data store/container.
  */
@@ -1169,6 +1186,26 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add a channel step.
+     *
+     * @param step - The channel step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addChannelStep({
+     *     id: 'orders-topic',
+     *     channel: { id: 'orders-topic', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addChannelStep(step: FlowChannelStepInput): this;
     /**
      * Add an agent step.
      *
@@ -1454,7 +1491,9 @@ declare const FederationIndexSchema: z.ZodObject<{
             type: z.ZodOptional<z.ZodString>;
             kind: z.ZodEnum<{
                 service: "service";
+                system: "system";
                 agent: "agent";
+                channel: "channel";
                 message: "message";
                 "data-product": "data-product";
                 container: "container";
@@ -3534,4 +3573,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 Cache, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Conflict, type ConflictKind, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type EdgeDirection, type Entity, type EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type External, FederationIndexSchema, type Fetcher, 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 HydrateOptions, type HydrateResult, type Index, type IndexAsset, type IndexReference, type IndexResource, type IndexResourceType, type IndexSchema, type IndexSidecar, type IndexSpecification, type IndexValidationIssue, InvalidIndexError, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResolutionWarning, type ResolvedAsset, type ResolvedEdge, type ResolvedEntity, type ResolvedGraph, 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, hydrate, parseIndex, resolve };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type Cache, type CatalogGraph, type CatalogGraphNode, type CatalogGraphOptions, type CatalogGraphResource, type CatalogGraphResourceType, type CatalogGraphRoot, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Conflict, type ConflictKind, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type EdgeDirection, type Entity, type EntityProperty, type Event, type EventCatalog, type ExtensionProperties, type External, FederationIndexSchema, type Fetcher, type FlatCatalogGraph, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowChannelStepInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type GetCatalogGraph, type HydrateOptions, type HydrateResult, type Index, type IndexAsset, type IndexReference, type IndexResource, type IndexResourceType, type IndexSchema, type IndexSidecar, type IndexSpecification, type IndexValidationIssue, InvalidIndexError, type Message, type MessagePointerInput, type NestedCatalogGraph, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResolutionWarning, type ResolvedAsset, type ResolvedEdge, type ResolvedEntity, type ResolvedGraph, 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, hydrate, parseIndex, resolve };

package/dist/index.js

@@ -2338,6 +2338,7 @@ var getOwnersForResource = (catalogDir) => async (id, version) => {
 // src/eventcatalog.ts
 var import_fs = __toESM(require("fs"));
 var import_node_path18 = __toESM(require("path"));
+var import_node_url = require("url");
 var DUMP_VERSION = "0.0.1";
 var getEventCatalogVersion = async (catalogDir) => {
   try {
@@ -2376,7 +2377,10 @@ var filterCollection = (collection, options) => {
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
     const path11 = (0, import_node_path18.join)(directory, "eventcatalog.config.js");
-    const configModule = await import(path11);
+    const configModule = await import(
+      /* @vite-ignore */
+      (0, import_node_url.pathToFileURL)(path11).href
+    );
     return configModule.default;
   } catch (error) {
     console.error("Error getting event catalog configuration file", error);
@@ -2618,6 +2622,9 @@ var cloneStep = (step) => ({
   ...step.message ? { message: { ...step.message } } : {},
   ...step.agent ? { agent: { ...step.agent } } : {},
   ...step.service ? { service: { ...step.service } } : {},
+  ...step.systems ? { systems: { ...step.systems } } : {},
+  ...step.system ? { system: { ...step.system } } : {},
+  ...step.channel ? { channel: { ...step.channel } } : {},
   ...step.flow ? { flow: { ...step.flow } } : {},
   ...step.container ? { container: { ...step.container } } : {},
   ...step.dataProduct ? { dataProduct: { ...step.dataProduct } } : {},
@@ -2765,6 +2772,41 @@ var FlowBuilder = class _FlowBuilder {
       step.nextSteps
     );
   }
+  /**
+   * Add a channel step.
+   *
+   * @param step - The channel step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addChannelStep({
+   *     id: 'orders-topic',
+   *     channel: { id: 'orders-topic', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addChannelStep(step) {
+    const channel = step.channel || {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        // Left out, EventCatalog names the step after its channel
+        ...step.title ? { title: step.title } : {},
+        ...step.summary ? { summary: step.summary } : {},
+        channel: { ...channel, ...step.version && !channel.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
   /**
    * Add an agent step.
    *
@@ -3370,6 +3412,9 @@ var getGraph = (directory) => {
           if (step.message) await addPointers([step.message], ["event", "command", "query"]);
           if (step.agent) await addPointers([step.agent], ["agent"]);
           if (step.service) await addPointers([step.service], ["service"]);
+          if (step.systems) await addPointers([step.systems], ["system"]);
+          if (step.system) await addPointers([step.system], ["system"]);
+          if (step.channel) await addPointers([step.channel], ["channel"]);
           if (step.flow) await addPointers([step.flow], ["flow"]);
           if (step.container) await addPointers([step.container], ["container"]);
           if (step.dataProduct) await addPointers([step.dataProduct], ["data-product"]);
@@ -3844,6 +3889,9 @@ var normalizeSpecifications = async (resource, resourcePath, hashContent) => {
 };
 var getFlowReferences = (steps) => steps.flatMap((step) => [
   ...step.service ? [{ kind: "service", ...step.service }] : [],
+  ...step.systems ? [{ kind: "system", ...step.systems }] : [],
+  ...step.system ? [{ kind: "system", ...step.system }] : [],
+  ...step.channel ? [{ kind: "channel", ...step.channel }] : [],
   ...step.message ? [{ kind: "message", ...step.message }] : [],
   ...step.agent ? [{ kind: "agent", ...step.agent }] : [],
   ...step.container ? [{ kind: "container", ...step.container }] : [],
@@ -4672,7 +4720,7 @@ var IndexAssetSchema = import_zod.z.object({
   hash: contentHash.optional()
 }).strict();
 var IndexReferenceSchema = ResourcePointerSchema.extend({
-  kind: import_zod.z.enum(["agent", "container", "data-product", "flow", "message", "service"])
+  kind: import_zod.z.enum(["agent", "channel", "container", "data-product", "flow", "message", "service", "system"])
 });
 var AdrPointerSchema = import_zod.z.object({
   id: nonEmptyString,