@eventcatalog/sdk 2.18.2 → 2.18.4

package/LICENSE

@@ -0,0 +1,28 @@
+MIT License
+
+Copyright (c) 2022-2026 boyney123
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+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 `packages/core/eventcatalog/src/enterprise/` is
+licensed under the EventCatalog Commercial License and is NOT covered by the
+MIT License above. See `packages/core/eventcatalog/src/enterprise/LICENSE`
+for the full terms.

package/dist/index.d.mts

@@ -128,18 +128,20 @@ interface Query extends BaseSchema {
 interface Channel extends BaseSchema {
   address?: string;
   protocols?: string[];
+  deliveryGuarantee?: 'at-most-once' | 'at-least-once' | 'exactly-once';
   routes?: ChannelPointer[];
   detailsPanel?: {
     producers?: DetailPanelProperty;
     consumers?: DetailPanelProperty;
     messages?: DetailPanelProperty;
     protocols?: DetailPanelProperty;
+    parameters?: DetailPanelProperty;
     versions?: DetailPanelProperty;
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    attachments?: DetailPanelProperty;
   };
-  // parameters?: Record<string, Parameter>;
   parameters?: {
     [key: string]: {
       enum?: string[];
@@ -168,6 +170,7 @@ interface Service extends BaseSchema {
   entities?: ResourcePointer[];
   writesTo?: ResourcePointer[];
   readsFrom?: ResourcePointer[];
+  flows?: ResourcePointer[];
   specifications?: Specifications | Specification[];
   detailsPanel?: {
     domains?: DetailPanelProperty;
@@ -186,6 +189,7 @@ interface Domain extends BaseSchema {
   domains?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
+  flows?: ResourcePointer[];
   sends?: SendsPointer[];
   receives?: ReceivesPointer[];
   detailsPanel?: {
@@ -324,6 +328,47 @@ declare enum DataClassification {
   Regulated = 'regulated',
 }
 
+interface FlowStep {
+  id: string | number;
+  type?: 'node' | 'message' | 'user' | 'actor';
+  title: string;
+  summary?: string;
+  message?: ResourcePointer;
+  service?: ResourcePointer;
+  flow?: ResourcePointer;
+  actor?: {
+    name: string;
+    summary?: string;
+  };
+  custom?: {
+    title: string;
+    icon?: string;
+    type?: string;
+    summary?: string;
+    url?: string;
+    color?: string;
+    properties?: Record<string, string | number>;
+    height?: number;
+    menu?: { label: string; url?: string }[];
+  };
+  externalSystem?: {
+    name: string;
+    summary?: string;
+    url?: string;
+  };
+  next_step?: string | number | { id: string | number; label?: string };
+  next_steps?: (string | number | { id: string | number; label?: string })[];
+}
+
+interface Flow extends BaseSchema {
+  steps: FlowStep[];
+  detailsPanel?: {
+    owners?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
 interface Container extends BaseSchema {
   container_type: 'database' | 'cache' | 'objectStore' | 'searchIndex' | 'dataWarehouse' | 'dataLake' | 'externalSaaS' | 'other';
   technology?: string;
@@ -355,6 +400,9 @@ type EventCatalog = {
     teams?: ExportedResource<Team>[];
     users?: ExportedResource<User>[];
     channels?: ExportedResource<Channel>[];
+    entities?: ExportedResource<Entity>[];
+    containers?: ExportedResource<Container>[];
+    flows?: ExportedResource<Flow>[];
     customDocs?: ExportedResource<CustomDoc>[];
   };
 };
@@ -478,11 +526,7 @@ declare const _default: (path: string) => {
      *
      */
     writeEvent: (event: Event, options?: {
-        path? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -499,12 +543,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path? /**
-         * Remove an event by an Event id
-         *
-         * @param id - The id of the event you want to remove
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1052,12 +1091,7 @@ declare const _default: (path: string) => {
     addEventToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
@@ -1101,12 +1135,7 @@ declare const _default: (path: string) => {
     addCommandToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
@@ -1130,12 +1159,7 @@ declare const _default: (path: string) => {
     addQueryToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
@@ -1195,7 +1219,12 @@ declare const _default: (path: string) => {
      */
     writeDomain: (domain: Domain, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -1664,6 +1693,29 @@ declare const _default: (path: string) => {
      * @returns
      */
     entityHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *              Flows
+     * ================================
+     */
+    /**
+     * Returns a flow from EventCatalog
+     *
+     * @param id - The id of the flow to retrieve
+     * @param version - Optional version of the flow
+     * @returns Flow
+     */
+    getFlow: (id: string, version?: string) => Promise<Flow>;
+    /**
+     * Returns all flows from EventCatalog
+     *
+     * @param options - optional options to get flows
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Flow[]|Undefined
+     */
+    getFlows: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Flow[]>;
     /**
      * ================================
      *            Data Stores
@@ -1740,11 +1792,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Returns all commands from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Command[]|Undefined
-         */: "md" | "mdx";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -1933,4 +1981,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 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 FlowStep, 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

@@ -128,18 +128,20 @@ interface Query extends BaseSchema {
 interface Channel extends BaseSchema {
   address?: string;
   protocols?: string[];
+  deliveryGuarantee?: 'at-most-once' | 'at-least-once' | 'exactly-once';
   routes?: ChannelPointer[];
   detailsPanel?: {
     producers?: DetailPanelProperty;
     consumers?: DetailPanelProperty;
     messages?: DetailPanelProperty;
     protocols?: DetailPanelProperty;
+    parameters?: DetailPanelProperty;
     versions?: DetailPanelProperty;
     repository?: DetailPanelProperty;
     owners?: DetailPanelProperty;
     changelog?: DetailPanelProperty;
+    attachments?: DetailPanelProperty;
   };
-  // parameters?: Record<string, Parameter>;
   parameters?: {
     [key: string]: {
       enum?: string[];
@@ -168,6 +170,7 @@ interface Service extends BaseSchema {
   entities?: ResourcePointer[];
   writesTo?: ResourcePointer[];
   readsFrom?: ResourcePointer[];
+  flows?: ResourcePointer[];
   specifications?: Specifications | Specification[];
   detailsPanel?: {
     domains?: DetailPanelProperty;
@@ -186,6 +189,7 @@ interface Domain extends BaseSchema {
   domains?: ResourcePointer[];
   entities?: ResourcePointer[];
   dataProducts?: ResourcePointer[];
+  flows?: ResourcePointer[];
   sends?: SendsPointer[];
   receives?: ReceivesPointer[];
   detailsPanel?: {
@@ -324,6 +328,47 @@ declare enum DataClassification {
   Regulated = 'regulated',
 }
 
+interface FlowStep {
+  id: string | number;
+  type?: 'node' | 'message' | 'user' | 'actor';
+  title: string;
+  summary?: string;
+  message?: ResourcePointer;
+  service?: ResourcePointer;
+  flow?: ResourcePointer;
+  actor?: {
+    name: string;
+    summary?: string;
+  };
+  custom?: {
+    title: string;
+    icon?: string;
+    type?: string;
+    summary?: string;
+    url?: string;
+    color?: string;
+    properties?: Record<string, string | number>;
+    height?: number;
+    menu?: { label: string; url?: string }[];
+  };
+  externalSystem?: {
+    name: string;
+    summary?: string;
+    url?: string;
+  };
+  next_step?: string | number | { id: string | number; label?: string };
+  next_steps?: (string | number | { id: string | number; label?: string })[];
+}
+
+interface Flow extends BaseSchema {
+  steps: FlowStep[];
+  detailsPanel?: {
+    owners?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
 interface Container extends BaseSchema {
   container_type: 'database' | 'cache' | 'objectStore' | 'searchIndex' | 'dataWarehouse' | 'dataLake' | 'externalSaaS' | 'other';
   technology?: string;
@@ -355,6 +400,9 @@ type EventCatalog = {
     teams?: ExportedResource<Team>[];
     users?: ExportedResource<User>[];
     channels?: ExportedResource<Channel>[];
+    entities?: ExportedResource<Entity>[];
+    containers?: ExportedResource<Container>[];
+    flows?: ExportedResource<Flow>[];
     customDocs?: ExportedResource<CustomDoc>[];
   };
 };
@@ -478,11 +526,7 @@ declare const _default: (path: string) => {
      *
      */
     writeEvent: (event: Event, options?: {
-        path? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -499,12 +543,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path? /**
-         * Remove an event by an Event id
-         *
-         * @param id - The id of the event you want to remove
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1052,12 +1091,7 @@ declare const _default: (path: string) => {
     addEventToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
@@ -1101,12 +1135,7 @@ declare const _default: (path: string) => {
     addCommandToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
@@ -1130,12 +1159,7 @@ declare const _default: (path: string) => {
     addQueryToService: (id: string, direction: string, event: {
         id: string;
         version: string;
-        fields? /**
-         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string[];
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
@@ -1195,7 +1219,12 @@ declare const _default: (path: string) => {
      */
     writeDomain: (domain: Domain, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -1664,6 +1693,29 @@ declare const _default: (path: string) => {
      * @returns
      */
     entityHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *              Flows
+     * ================================
+     */
+    /**
+     * Returns a flow from EventCatalog
+     *
+     * @param id - The id of the flow to retrieve
+     * @param version - Optional version of the flow
+     * @returns Flow
+     */
+    getFlow: (id: string, version?: string) => Promise<Flow>;
+    /**
+     * Returns all flows from EventCatalog
+     *
+     * @param options - optional options to get flows
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Flow[]|Undefined
+     */
+    getFlows: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Flow[]>;
     /**
      * ================================
      *            Data Stores
@@ -1740,11 +1792,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format? /**
-         * Returns all commands from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Command[]|Undefined
-         */: "md" | "mdx";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -1933,4 +1981,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 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 FlowStep, 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

@@ -2004,7 +2004,19 @@ var getEventCatalogConfigurationFile = (directory) => async () => {
   }
 };
 var dumpCatalog = (directory) => async (options) => {
-  const { getDomains: getDomains2, getServices: getServices2, getEvents: getEvents2, getQueries: getQueries2, getCommands: getCommands2, getChannels: getChannels2, getTeams: getTeams2, getUsers: getUsers3 } = src_default(directory);
+  const {
+    getDomains: getDomains2,
+    getServices: getServices2,
+    getEvents: getEvents2,
+    getQueries: getQueries2,
+    getCommands: getCommands2,
+    getChannels: getChannels2,
+    getTeams: getTeams2,
+    getUsers: getUsers3,
+    getEntities: getEntities2,
+    getDataStores: getDataStores2,
+    getFlows: getFlows2
+  } = src_default(directory);
   const { includeMarkdown = true } = options || {};
   const domains = await getDomains2();
   const services = await getServices2();
@@ -2014,6 +2026,9 @@ var dumpCatalog = (directory) => async (options) => {
   const teams = await getTeams2();
   const users = await getUsers3();
   const channels = await getChannels2();
+  const entities = await getEntities2();
+  const containers = await getDataStores2();
+  const flows = await getFlows2();
   const [
     hydratedDomains,
     hydratedServices,
@@ -2022,7 +2037,10 @@ var dumpCatalog = (directory) => async (options) => {
     hydratedCommands,
     hydratedTeams,
     hydratedUsers,
-    hydratedChannels
+    hydratedChannels,
+    hydratedEntities,
+    hydratedContainers,
+    hydratedFlows
   ] = await Promise.all([
     hydrateResource(directory, domains),
     hydrateResource(directory, services),
@@ -2031,7 +2049,10 @@ var dumpCatalog = (directory) => async (options) => {
     hydrateResource(directory, commands),
     hydrateResource(directory, teams),
     hydrateResource(directory, users),
-    hydrateResource(directory, channels)
+    hydrateResource(directory, channels),
+    hydrateResource(directory, entities),
+    hydrateResource(directory, containers),
+    hydrateResource(directory, flows)
   ]);
   return {
     version: DUMP_VERSION,
@@ -2047,7 +2068,10 @@ var dumpCatalog = (directory) => async (options) => {
       },
       teams: filterCollection(hydratedTeams, { includeMarkdown }),
       users: filterCollection(hydratedUsers, { includeMarkdown }),
-      channels: filterCollection(hydratedChannels, { includeMarkdown })
+      channels: filterCollection(hydratedChannels, { includeMarkdown }),
+      entities: filterCollection(hydratedEntities, { includeMarkdown }),
+      containers: filterCollection(hydratedContainers, { includeMarkdown }),
+      flows: filterCollection(hydratedFlows, { includeMarkdown })
     }
   };
 };
@@ -2492,6 +2516,10 @@ var entityHasVersion = (directory) => async (id, version) => {
   return !!file;
 };
 
+// src/flows.ts
+var getFlow = (directory) => async (id, version) => getResource(directory, id, version, { type: "flow" });
+var getFlows = (directory) => async (options) => getResources(directory, { type: "flows", latestOnly: options?.latestOnly });
+
 // src/containers.ts
 var import_promises12 = __toESM(require("fs/promises"));
 var import_node_path19 = require("path");
@@ -3546,6 +3574,27 @@ var src_default = (path8) => {
      * @returns
      */
     entityHasVersion: entityHasVersion((0, import_node_path22.join)(path8)),
+    /**
+     * ================================
+     *              Flows
+     * ================================
+     */
+    /**
+     * Returns a flow from EventCatalog
+     *
+     * @param id - The id of the flow to retrieve
+     * @param version - Optional version of the flow
+     * @returns Flow
+     */
+    getFlow: getFlow((0, import_node_path22.join)(path8)),
+    /**
+     * Returns all flows from EventCatalog
+     *
+     * @param options - optional options to get flows
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Flow[]|Undefined
+     */
+    getFlows: getFlows((0, import_node_path22.join)(path8)),
     /**
      * ================================
      *            Data Stores