@eventcatalog/sdk 2.21.0 → 2.21.2

package/dist/index.d.mts

@@ -184,6 +184,7 @@ interface Service extends BaseSchema {
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    flows?: DetailPanelProperty;
   };
 }
 
@@ -245,6 +246,7 @@ interface Badge {
   backgroundColor: string;
   textColor: string;
   icon?: string;
+  url?: string;
 }
 
 interface Changelog {
@@ -321,6 +323,7 @@ interface DataProduct extends BaseSchema {
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    flows?: DetailPanelProperty;
   };
 }
 
@@ -339,6 +342,8 @@ interface FlowStep {
   message?: ResourcePointer;
   service?: ResourcePointer;
   flow?: ResourcePointer;
+  container?: ResourcePointer;
+  dataProduct?: ResourcePointer;
   actor?: {
     name: string;
     summary?: string;
@@ -542,6 +547,26 @@ type FlowServiceStepInput = FlowStepInput & {
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references a data store/container.
+ */
+type FlowDataStoreStepInput = FlowStepInput & {
+    container?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
+/**
+ * Payload for a flow step that references a data product.
+ */
+type FlowDataProductStepInput = FlowStepInput & {
+    dataProduct?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that represents a user or actor.
  */
@@ -756,6 +781,59 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add a data store step.
+     *
+     * Data store steps reference container resources in EventCatalog. If a
+     * version is not provided, EventCatalog resolves the latest matching
+     * container version when rendering the flow.
+     *
+     * @param step - The data store step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addDataStoreStep({
+     *     id: 'OrdersDB',
+     *     container: { id: 'OrdersDB', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addDataStoreStep(step: FlowDataStoreStepInput): this;
+    /**
+     * Add a container step.
+     *
+     * Alias for `addDataStoreStep`.
+     */
+    addContainerStep(step: FlowDataStoreStepInput): this;
+    /**
+     * Add a data product step.
+     *
+     * If a version is not provided, EventCatalog resolves the latest matching
+     * data product version when rendering the flow.
+     *
+     * @param step - The data product step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addDataProductStep({
+     *     id: 'OrderAnalytics',
+     *     dataProduct: { id: 'OrderAnalytics', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addDataProductStep(step: FlowDataProductStepInput): this;
     /**
      * Add an actor step.
      *
@@ -1339,7 +1417,14 @@ declare const _default: (path: string) => {
         path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
-        format?: "md" | "mdx";
+        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";
     }) => Promise<void>;
     /**
      * Adds a versioned service to EventCatalog
@@ -1361,7 +1446,12 @@ declare const _default: (path: string) => {
         version?: string;
         direction?: 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
+         */: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1583,19 +1673,7 @@ declare const _default: (path: string) => {
      */
     writeDomain: (domain: Domain, options?: {
         path?: string;
-        override
-        /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */
-        ? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -2256,12 +2334,7 @@ declare const _default: (path: string) => {
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
-        override? /**
-         * 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
-         */: boolean;
+        override?: boolean;
     }) => Promise<void>;
     /**
      * ================================
@@ -2449,4 +2522,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 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, 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

@@ -184,6 +184,7 @@ interface Service extends BaseSchema {
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    flows?: DetailPanelProperty;
   };
 }
 
@@ -245,6 +246,7 @@ interface Badge {
   backgroundColor: string;
   textColor: string;
   icon?: string;
+  url?: string;
 }
 
 interface Changelog {
@@ -321,6 +323,7 @@ interface DataProduct extends BaseSchema {
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    flows?: DetailPanelProperty;
   };
 }
 
@@ -339,6 +342,8 @@ interface FlowStep {
   message?: ResourcePointer;
   service?: ResourcePointer;
   flow?: ResourcePointer;
+  container?: ResourcePointer;
+  dataProduct?: ResourcePointer;
   actor?: {
     name: string;
     summary?: string;
@@ -542,6 +547,26 @@ type FlowServiceStepInput = FlowStepInput & {
     };
     version?: string;
 };
+/**
+ * Payload for a flow step that references a data store/container.
+ */
+type FlowDataStoreStepInput = FlowStepInput & {
+    container?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
+/**
+ * Payload for a flow step that references a data product.
+ */
+type FlowDataProductStepInput = FlowStepInput & {
+    dataProduct?: {
+        id: string;
+        version?: string;
+    };
+    version?: string;
+};
 /**
  * Payload for a flow step that represents a user or actor.
  */
@@ -756,6 +781,59 @@ declare class FlowBuilder<TMessageId extends string = string> {
      * ```
      */
     addServiceStep(step: FlowServiceStepInput): this;
+    /**
+     * Add a data store step.
+     *
+     * Data store steps reference container resources in EventCatalog. If a
+     * version is not provided, EventCatalog resolves the latest matching
+     * container version when rendering the flow.
+     *
+     * @param step - The data store step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addDataStoreStep({
+     *     id: 'OrdersDB',
+     *     container: { id: 'OrdersDB', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addDataStoreStep(step: FlowDataStoreStepInput): this;
+    /**
+     * Add a container step.
+     *
+     * Alias for `addDataStoreStep`.
+     */
+    addContainerStep(step: FlowDataStoreStepInput): this;
+    /**
+     * Add a data product step.
+     *
+     * If a version is not provided, EventCatalog resolves the latest matching
+     * data product version when rendering the flow.
+     *
+     * @param step - The data product step payload.
+     *
+     * @example
+     * ```ts
+     * FlowBuilder.create({
+     *   id: 'OrderFlow',
+     *   name: 'Order Flow',
+     *   version: '1.0.0',
+     *   markdown: '',
+     * })
+     *   .addDataProductStep({
+     *     id: 'OrderAnalytics',
+     *     dataProduct: { id: 'OrderAnalytics', version: '1.0.0' },
+     *   });
+     * ```
+     */
+    addDataProductStep(step: FlowDataProductStepInput): this;
     /**
      * Add an actor step.
      *
@@ -1339,7 +1417,14 @@ declare const _default: (path: string) => {
         path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
-        format?: "md" | "mdx";
+        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";
     }) => Promise<void>;
     /**
      * Adds a versioned service to EventCatalog
@@ -1361,7 +1446,12 @@ declare const _default: (path: string) => {
         version?: string;
         direction?: 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
+         */: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1583,19 +1673,7 @@ declare const _default: (path: string) => {
      */
     writeDomain: (domain: Domain, options?: {
         path?: string;
-        override
-        /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */
-        ? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -2256,12 +2334,7 @@ declare const _default: (path: string) => {
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
-        override? /**
-         * 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
-         */: boolean;
+        override?: boolean;
     }) => Promise<void>;
     /**
      * ================================
@@ -2449,4 +2522,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 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, 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

@@ -2531,6 +2531,8 @@ var cloneStep = (step) => ({
   ...step.message ? { message: { ...step.message } } : {},
   ...step.service ? { service: { ...step.service } } : {},
   ...step.flow ? { flow: { ...step.flow } } : {},
+  ...step.container ? { container: { ...step.container } } : {},
+  ...step.dataProduct ? { dataProduct: { ...step.dataProduct } } : {},
   ...step.actor ? { actor: { ...step.actor } } : {},
   ...step.custom ? {
     custom: {
@@ -2675,6 +2677,91 @@ var FlowBuilder = class _FlowBuilder {
       step.nextSteps
     );
   }
+  /**
+   * Add a data store step.
+   *
+   * Data store steps reference container resources in EventCatalog. If a
+   * version is not provided, EventCatalog resolves the latest matching
+   * container version when rendering the flow.
+   *
+   * @param step - The data store step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addDataStoreStep({
+   *     id: 'OrdersDB',
+   *     container: { id: 'OrdersDB', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addDataStoreStep(step) {
+    const fallbackContainer = {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    const container = step.container ?? fallbackContainer;
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        container: { ...container, ...step.version && !container.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a container step.
+   *
+   * Alias for `addDataStoreStep`.
+   */
+  addContainerStep(step) {
+    return this.addDataStoreStep(step);
+  }
+  /**
+   * Add a data product step.
+   *
+   * If a version is not provided, EventCatalog resolves the latest matching
+   * data product version when rendering the flow.
+   *
+   * @param step - The data product step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addDataProductStep({
+   *     id: 'OrderAnalytics',
+   *     dataProduct: { id: 'OrderAnalytics', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addDataProductStep(step) {
+    const fallbackDataProduct = {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    const dataProduct = step.dataProduct ?? fallbackDataProduct;
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        dataProduct: { ...dataProduct, ...step.version && !dataProduct.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
   /**
    * Add an actor step.
    *