@eventcatalog/sdk 2.13.1 → 2.13.2

package/dist/index.d.mts

@@ -0,0 +1,1714 @@
+// Base type for all resources (domains, services and messages)
+interface BaseSchema {
+  id: string;
+  name: string;
+  summary?: string;
+  version: string;
+  badges?: Badge[];
+  sidebar?: {
+    badge?: string;
+  };
+  owners?: string[];
+  schemaPath?: string;
+  markdown: string;
+  repository?: {
+    language?: string;
+    url?: string;
+  };
+  deprecated?:
+    | boolean
+    | {
+        date?: string;
+        message?: string;
+      };
+  styles?: {
+    icon?: string;
+    node?: {
+      color?: string;
+      label?: string;
+    };
+  };
+  attachments?:
+    | string[]
+    | {
+        url: string;
+        title?: string;
+        type?: string;
+        description?: string;
+        icon?: string;
+      }[];
+  resourceGroups?: ResourceGroup[];
+  diagrams?: ResourcePointer[];
+  editUrl?: string;
+  draft?: boolean | { title?: string; message?: string };
+  // SDK types
+  schema?: any;
+}
+
+type ResourcePointer = {
+  id: string;
+  version?: string;
+  type?: string;
+};
+
+type SendsPointer = {
+  id: string;
+  version?: string;
+  to?: ChannelPointer[];
+};
+
+type ReceivesPointer = {
+  id: string;
+  version?: string;
+  from?: ChannelPointer[];
+};
+
+interface ResourceGroup {
+  id?: string;
+  title?: string;
+  items: ResourcePointer[];
+  limit?: number;
+  sidebar?: boolean;
+}
+
+interface ChannelPointer extends ResourcePointer {
+  parameters?: Record<string, string>;
+}
+
+type Message = Event | Command | Query;
+
+interface CustomDoc {
+  title: string;
+  summary: string;
+  slug?: string;
+  sidebar?: {
+    label: string;
+    order: number;
+  };
+  owners?: string[];
+  badges?: Badge[];
+  fileName?: string;
+  markdown: string;
+}
+
+interface MessageDetailsPanelProperty {
+  producers?: DetailPanelProperty;
+  consumers?: DetailPanelProperty;
+  channels?: DetailPanelProperty;
+  versions?: DetailPanelProperty;
+  repository?: DetailPanelProperty;
+}
+
+interface Event extends BaseSchema {
+  channels?: ChannelPointer[];
+  detailsPanel?: MessageDetailsPanelProperty;
+}
+interface Command extends BaseSchema {
+  channels?: ChannelPointer[];
+  detailsPanel?: MessageDetailsPanelProperty;
+}
+interface Query extends BaseSchema {
+  channels?: ChannelPointer[];
+  detailsPanel?: MessageDetailsPanelProperty;
+}
+interface Channel extends BaseSchema {
+  address?: string;
+  protocols?: string[];
+  routes?: ChannelPointer[];
+  detailsPanel?: {
+    producers?: DetailPanelProperty;
+    consumers?: DetailPanelProperty;
+    messages?: DetailPanelProperty;
+    protocols?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+  // parameters?: Record<string, Parameter>;
+  parameters?: {
+    [key: string]: {
+      enum?: string[];
+      default?: string;
+      examples?: string[];
+      description?: string;
+    };
+  };
+}
+
+interface Specifications {
+  asyncapiPath?: string;
+  openapiPath?: string;
+  graphqlPath?: string;
+}
+
+interface Specification {
+  type: 'openapi' | 'asyncapi' | 'graphql';
+  path: string;
+  name?: string;
+}
+
+interface Service extends BaseSchema {
+  sends?: SendsPointer[];
+  receives?: ReceivesPointer[];
+  entities?: ResourcePointer[];
+  writesTo?: ResourcePointer[];
+  readsFrom?: ResourcePointer[];
+  specifications?: Specifications | Specification[];
+  detailsPanel?: {
+    domains?: DetailPanelProperty;
+    messages?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    specifications?: DetailPanelProperty;
+    entities?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
+interface Domain extends BaseSchema {
+  services?: ResourcePointer[];
+  domains?: ResourcePointer[];
+  entities?: ResourcePointer[];
+  dataProducts?: ResourcePointer[];
+  sends?: SendsPointer[];
+  receives?: ReceivesPointer[];
+  detailsPanel?: {
+    parentDomains?: DetailPanelProperty;
+    subdomains?: DetailPanelProperty;
+    services?: DetailPanelProperty;
+    entities?: DetailPanelProperty;
+    messages?: DetailPanelProperty;
+    ubiquitousLanguage?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
+interface Team {
+  id: string;
+  name: string;
+  summary?: string;
+  email?: string;
+  hidden?: boolean;
+  slackDirectMessageUrl?: string;
+  members?: User[];
+  ownedCommands?: Command[];
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+  markdown: string;
+}
+
+interface User {
+  id: string;
+  name: string;
+  avatarUrl: string;
+  role?: string;
+  hidden?: boolean;
+  email?: string;
+  slackDirectMessageUrl?: string;
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+  ownedCommands?: Command[];
+  associatedTeams?: Team[];
+  markdown: string;
+}
+
+interface Badge {
+  content: string;
+  backgroundColor: string;
+  textColor: string;
+  icon?: string;
+}
+
+interface UbiquitousLanguage {
+  id: string;
+  name: string;
+  summary?: string;
+  description?: string;
+  icon?: string;
+}
+
+interface UbiquitousLanguageDictionary {
+  dictionary: UbiquitousLanguage[];
+}
+
+interface DetailPanelProperty {
+  visible: boolean;
+}
+
+interface Entity extends BaseSchema {
+  aggregateRoot?: boolean;
+  identifier?: string;
+  properties?: {
+    name: string;
+    type: string;
+    required?: boolean;
+    description?: string;
+    references?: string;
+    referencesIdentifier?: string;
+    relationType?: string;
+  }[];
+  detailsPanel?: {
+    domains?: DetailPanelProperty;
+    services?: DetailPanelProperty;
+    messages?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
+interface Diagram extends BaseSchema {
+  detailsPanel?: {
+    versions?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+    attachments?: DetailPanelProperty;
+  };
+}
+
+type DataProductOutputPointer = {
+  id: string;
+  version?: string;
+  contract?: {
+    path: string;
+    name: string;
+    type?: string;
+  };
+};
+
+interface DataProduct extends BaseSchema {
+  inputs?: ResourcePointer[];
+  outputs?: DataProductOutputPointer[];
+  detailsPanel?: {
+    domains?: DetailPanelProperty;
+    inputs?: DetailPanelProperty;
+    outputs?: DetailPanelProperty;
+    versions?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
+declare enum DataClassification {
+  Public = 'public',
+  Internal = 'internal',
+  Confidential = 'confidential',
+  Regulated = 'regulated',
+}
+
+interface Container extends BaseSchema {
+  container_type: 'database' | 'cache' | 'objectStore' | 'searchIndex' | 'dataWarehouse' | 'dataLake' | 'externalSaaS' | 'other';
+  technology?: string;
+  authoritative?: boolean;
+  access_mode?: string;
+  classification?: DataClassification;
+  residency?: string;
+  retention?: string;
+  detailsPanel?: {
+    versions?: DetailPanelProperty;
+    repository?: DetailPanelProperty;
+    owners?: DetailPanelProperty;
+    changelog?: DetailPanelProperty;
+  };
+}
+
+type EventCatalog = {
+  version: string;
+  catalogVersion: string;
+  createdAt: string;
+  resources: {
+    domains?: ExportedResource<Domain>[];
+    services?: ExportedResource<Service>[];
+    messages?: {
+      events?: ExportedResource<Event>[];
+      queries?: ExportedResource<Query>[];
+      commands?: ExportedResource<Command>[];
+    };
+    teams?: ExportedResource<Team>[];
+    users?: ExportedResource<User>[];
+    channels?: ExportedResource<Channel>[];
+    customDocs?: ExportedResource<CustomDoc>[];
+  };
+};
+
+/**
+ * Init the SDK for EventCatalog
+ *
+ * @param path - The path to the EventCatalog directory
+ *
+ */
+declare const _default: (path: string) => {
+    /**
+     * Returns an events from EventCatalog
+     * @param id - The id of the event to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Event|Undefined
+     */
+    getEvent: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Event>;
+    /**
+     * Returns all events from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Event[]|Undefined
+     */
+    getEvents: (options?: {
+        latestOnly?: boolean;
+        attachSchema?: boolean;
+    }) => Promise<Event[]>;
+    /**
+     * Adds an event to EventCatalog
+     *
+     * @param event - The event to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeEvent: (event: Event, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * 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
+     *
+     */
+    writeEventToService: (event: Event, service: {
+        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)
+     *
+     * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmEvent: (path: string) => Promise<void>;
+    /**
+     * Remove an event by an Event id
+     *
+     * @param id - The id of the event you want to remove
+     *
+     */
+    rmEventById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given event id to the version directory
+     * @param directory
+     */
+    versionEvent: (id: string) => Promise<void>;
+    /**
+     * 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
+     */
+    addFileToEvent: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Adds a schema to the given event
+     * @param id - The id of the event to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the event to add the schema to
+     * @returns
+     */
+    addSchemaToEvent: (id: string, schema: {
+        schema: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Check to see if an event version exists
+     * @param id - The id of the event
+     * @param version - The version of the event (supports semver)
+     * @returns
+     */
+    eventHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Commands
+     * ================================
+     */
+    /**
+     * 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
+     */
+    getCommand: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Command>;
+    /**
+     * Returns all commands from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Command[]|Undefined
+     */
+    getCommands: (options?: {
+        latestOnly?: boolean;
+        attachSchema?: boolean;
+    }) => Promise<Command[]>;
+    /**
+     * Adds an command to EventCatalog
+     *
+     * @param command - The command to write
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommand: (command: Command, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Adds a command to a service in EventCatalog
+     *
+     * @param command - The command to write to the service
+     * @param service - The service and it's id to write to the command to
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommandToService: (command: Command, service: {
+        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)
+     *
+     * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmCommand: (path: string) => Promise<void>;
+    /**
+     * Remove an command by an Event id
+     *
+     * @param id - The id of the command you want to remove
+     *
+     */
+    rmCommandById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given command id to the version directory
+     * @param directory
+     */
+    versionCommand: (id: string) => Promise<void>;
+    /**
+     * Adds a file to the given command
+     * @param id - The id of the command to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the command to add the file to
+     * @returns
+     */
+    addFileToCommand: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Adds a schema to the given command
+     * @param id - The id of the command to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the command to add the schema to
+     * @returns
+     */
+    addSchemaToCommand: (id: string, schema: {
+        schema: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Check to see if a command version exists
+     * @param id - The id of the command
+     * @param version - The version of the command (supports semver)
+     * @returns
+     */
+    commandHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Queries
+     * ================================
+     */
+    /**
+     * Returns a query from EventCatalog
+     * @param id - The id of the query to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Query|Undefined
+     */
+    getQuery: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Query>;
+    /**
+     * Returns all queries from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Query[]|Undefined
+     */
+    getQueries: (options?: {
+        latestOnly?: boolean;
+        attachSchema?: boolean;
+    }) => Promise<Query[]>;
+    /**
+     * Adds a query to EventCatalog
+     *
+     * @param query - The query to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeQuery: (query: Query, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Adds a query to a service in EventCatalog
+     *
+     * @param query - The query to write to the service
+     * @param service - The service and it's id to write to the query to
+     * @param options - Optional options to write the query
+     *
+     */
+    writeQueryToService: (query: Query, service: {
+        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)
+     *
+     * @param path - The path to your query, e.g. `/Orders/GetOrder`
+     *
+     */
+    rmQuery: (path: string) => Promise<void>;
+    /**
+     * Remove a query by a Query id
+     *
+     * @param id - The id of the query you want to remove
+     *
+     */
+    rmQueryById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given query id to the version directory
+     * @param directory
+     */
+    versionQuery: (id: string) => Promise<void>;
+    /**
+     * Adds a file to the given query
+     * @param id - The id of the query to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the query to add the file to
+     * @returns
+     */
+    addFileToQuery: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Adds a schema to the given query
+     * @param id - The id of the query to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the query to add the schema to
+     * @returns
+     */
+    addSchemaToQuery: (id: string, schema: {
+        schema: string;
+        fileName: string;
+    }, version?: string, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Check to see if an query version exists
+     * @param id - The id of the query
+     * @param version - The version of the query (supports semver)
+     * @returns
+     */
+    queryHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Channels
+     * ================================
+     */
+    /**
+     * Returns a channel from EventCatalog
+     * @param id - The id of the channel to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Channel|Undefined
+     */
+    getChannel: (id: string, version?: string) => Promise<Channel>;
+    /**
+     * Returns all channels from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Channel[]|Undefined
+     */
+    getChannels: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Channel[]>;
+    /**
+     * Adds an channel to EventCatalog
+     *
+     * @param command - The channel to write
+     * @param options - Optional options to write the channel
+     *
+     */
+    writeChannel: (channel: Channel, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmChannel: (path: string) => Promise<void>;
+    /**
+     * Remove an channel by an Event id
+     *
+     * @param id - The id of the channel you want to remove
+     *
+     */
+    rmChannelById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given channel id to the version directory
+     * @param directory
+     */
+    versionChannel: (id: string) => Promise<void>;
+    /**
+     * Check to see if a channel version exists
+     * @param id - The id of the channel
+     * @param version - The version of the channel (supports semver)
+     * @returns
+     */
+    channelHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Add a channel to an event
+     *
+     * Optionally specify a version to add the channel to a specific version of the event.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEventToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new event (InventoryUpdatedEvent) to the inventory.{env}.events channel
+     * await addEventToChannel('inventory.{env}.events channel', { id: 'InventoryUpdatedEvent', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addEventToChannel: (id: string, _message: {
+        id: string;
+        version: string;
+        parameters?: {
+            [key: string]: string;
+        };
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a channel to an command
+     *
+     * Optionally specify a version to add the channel to a specific version of the command.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addCommandToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new command (UpdateInventory) to the inventory.{env}.events channel
+     * await addCommandToChannel('inventory.{env}.events channel', { id: 'UpdateInventory', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addCommandToChannel: (id: string, _message: {
+        id: string;
+        version: string;
+        parameters?: {
+            [key: string]: string;
+        };
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a channel to an query
+     *
+     * Optionally specify a version to add the channel to a specific version of the query.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addQueryToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new query (GetInventory) to the inventory.{env}.events channel
+     * await addQueryToChannel('inventory.{env}.events channel', { id: 'GetInventory', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addQueryToChannel: (id: string, _message: {
+        id: string;
+        version: string;
+        parameters?: {
+            [key: string]: string;
+        };
+    }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            SERVICES
+     * ================================
+     */
+    /**
+     * Adds a service to EventCatalog
+     *
+     * @param service - The service to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeService: (service: Service, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Adds a versioned service to EventCatalog
+     *
+     * @param service - The service to write
+     *
+     */
+    writeVersionedService: (service: Service) => Promise<void>;
+    /**
+     * Adds a service to a domain in EventCatalog
+     *
+     * @param service - The service to write
+     * @param domain - The domain to add the service to
+     * @param options - Optional options to write the event
+     *
+     */
+    writeServiceToDomain: (service: Service, domain: {
+        id: string;
+        version?: string;
+        direction
+        /**
+         * Adds a command to a service in EventCatalog
+         *
+         * @param command - The command to write to the service
+         * @param service - The service and it's id to write to the command to
+         * @param options - Optional options to write the command
+         *
+         */
+        ? /**
+         * Adds a command to a service in EventCatalog
+         *
+         * @param command - The command to write to the service
+         * @param service - The service and it's id to write to the command to
+         * @param options - Optional options to write the command
+         *
+         */: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a service from EventCatalog
+     * @param id - The id of the service to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Service|Undefined
+     */
+    getService: (id: string, version?: string) => Promise<Service>;
+    /**
+     * Returns a service from EventCatalog by it's path.
+     * @param path - The path to the service to retrieve
+     * @returns Service|Undefined
+     */
+    getServiceByPath: (path: string) => Promise<Service>;
+    /**
+     * Returns all services from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Service[]|Undefined
+     */
+    getServices: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Service[]>;
+    /**
+     * Moves a given service id to the version directory
+     * @param directory
+     */
+    versionService: (id: string) => Promise<void>;
+    /**
+     * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your service, e.g. `/InventoryService`
+     *
+     */
+    rmService: (path: string) => Promise<void>;
+    /**
+     * Remove an service by an service id
+     *
+     * @param id - The id of the service you want to remove
+     *
+     */
+    rmServiceById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Adds a file to the given service
+     * @param id - The id of the service to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the service to add the file to
+     * @returns
+     */
+    addFileToService: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Returns the specifications for a given service
+     * @param id - The id of the service to retrieve the specifications for
+     * @param version - Optional version of the service
+     * @returns
+     */
+    getSpecificationFilesForService: (id: string, version?: string) => Promise<any>;
+    /**
+     * Check to see if a service version exists
+     * @param id - The id of the service
+     * @param version - The version of the service (supports semver)
+     * @returns
+     */
+    serviceHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Add an event to a service by it's id.
+     *
+     * Optionally specify a version to add the event to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEventToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+     * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+     *
+     * // adds a new event (OrderComplete) that the InventoryService will receive
+     * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+     *
+     * ```
+     */
+    addEventToService: (id: string, direction: string, event: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a data store to a service by it's id.
+     *
+     * Optionally specify a version to add the data store to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addDataStoreToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new data store (orders-db) that the InventoryService will write to
+     * await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });
+     *
+     * ```
+     */
+    addDataStoreToService: (id: string, operation: "writesTo" | "readsFrom", dataStore: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a command to a service by it's id.
+     *
+     * Optionally specify a version to add the event to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addCommandToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new command (UpdateInventoryCommand) that the InventoryService will send
+     * await addCommandToService('InventoryService', 'sends', { command: 'UpdateInventoryCommand', version: '2.0.0' });
+     *
+     * // adds a new command (VerifyInventory) that the InventoryService will receive
+     * await addCommandToService('InventoryService', 'receives', { command: 'VerifyInventory', version: '2.0.0' });
+     *
+     * ```
+     */
+    addCommandToService: (id: string, direction: string, event: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a query to a service by it's id.
+     *
+     * Optionally specify a version to add the event to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addQueryToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new query (UpdateInventory) that the InventoryService will send
+     * await addQueryToService('InventoryService', 'sends', { command: 'UpdateInventory', version: '2.0.0' });
+     *
+     * // adds a new command (VerifyInventory) that the InventoryService will receive
+     * await addQueryToService('InventoryService', 'receives', { command: 'VerifyInventory', version: '2.0.0' });
+     *
+     * ```
+     */
+    addQueryToService: (id: string, direction: string, event: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add an entity to a service by its id.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEntityToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new entity (User) to the InventoryService
+     * await addEntityToService('InventoryService', { id: 'User', version: '1.0.0' });
+     *
+     * // adds a new entity (Product) to a specific version of the InventoryService
+     * await addEntityToService('InventoryService', { id: 'Product', version: '1.0.0' }, '2.0.0');
+     *
+     * ```
+     */
+    addEntityToService: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a service exists by it's path.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { isService } = utils('/path/to/eventcatalog');
+     *
+     * // returns true if the path is a service
+     * await isService('/services/InventoryService/index.mdx');
+     * ```
+     *
+     * @param path - The path to the service to check
+     * @returns boolean
+     */
+    isService: (path: string) => Promise<boolean>;
+    /**
+     * Converts a file to a service.
+     * @param file - The file to convert to a service.
+     * @returns The service.
+     */
+    toService: (file: string) => Promise<Service>;
+    /**
+     * ================================
+     *            Domains
+     * ================================
+     */
+    /**
+     * Adds a domain to EventCatalog
+     *
+     * @param domain - The domain to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeDomain: (domain: Domain, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns a domain from EventCatalog
+     * @param id - The id of the domain to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Domain|Undefined
+     */
+    getDomain: (id: string, version?: string) => Promise<Domain>;
+    /**
+     * Returns all domains from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Domain[]|Undefined
+     */
+    getDomains: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Domain[]>;
+    /**
+     * Moves a given domain id to the version directory
+     * @param directory
+     */
+    versionDomain: (id: string) => Promise<void>;
+    /**
+     * Remove a domain from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your domain, e.g. `/Payment`
+     *
+     */
+    rmDomain: (path: string) => Promise<void>;
+    /**
+     * Remove an service by an domain id
+     *
+     * @param id - The id of the domain you want to remove
+     *
+     */
+    rmDomainById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Adds a file to the given domain
+     * @param id - The id of the domain to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the domain to add the file to
+     * @returns
+     */
+    addFileToDomain: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds an ubiquitous language dictionary to a domain
+     * @param id - The id of the domain to add the ubiquitous language to
+     * @param ubiquitousLanguageDictionary - The ubiquitous language dictionary to add
+     * @param version - Optional version of the domain to add the ubiquitous language to
+     */
+    addUbiquitousLanguageToDomain: (id: string, ubiquitousLanguageDictionary: UbiquitousLanguageDictionary, version?: string) => Promise<void>;
+    /**
+     * Get the ubiquitous language dictionary from a domain
+     * @param id - The id of the domain to get the ubiquitous language from
+     * @param version - Optional version of the domain to get the ubiquitous language from
+     * @returns
+     */
+    getUbiquitousLanguageFromDomain: (id: string, version?: string) => Promise<{
+        markdown: any;
+    } | undefined>;
+    /**
+     * Check to see if a domain version exists
+     * @param id - The id of the domain
+     * @param version - The version of the domain (supports semver)
+     * @returns
+     */
+    domainHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a given service to a domain
+     * @param id - The id of the domain
+     * @param service - The id and version of the service to add
+     * @param version - (Optional) The version of the domain to add the service to
+     * @returns
+     */
+    addServiceToDomain: (id: string, service: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds a given subdomain to a domain
+     * @param id - The id of the domain
+     * @param subDomain - The id and version of the subdomain to add
+     * @param version - (Optional) The version of the domain to add the subdomain to
+     * @returns
+     */
+    addSubDomainToDomain: (id: string, subDomain: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds an entity to a domain
+     * @param id - The id of the domain
+     * @param entity - The id and version of the entity to add
+     * @param version - (Optional) The version of the domain to add the entity to
+     * @returns
+     */
+    addEntityToDomain: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add an event to a domain by its id.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEventToDomain } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new event (OrderCreated) that the Orders domain will send
+     * await addEventToDomain('Orders', 'sends', { id: 'OrderCreated', version: '2.0.0' });
+     *
+     * // adds a new event (PaymentProcessed) that the Orders domain will receive
+     * await addEventToDomain('Orders', 'receives', { id: 'PaymentProcessed', version: '2.0.0' });
+     *
+     * ```
+     */
+    addEventToDomain: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a command to a domain by its id.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addCommandToDomain } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new command (ProcessOrder) that the Orders domain will send
+     * await addCommandToDomain('Orders', 'sends', { id: 'ProcessOrder', version: '2.0.0' });
+     *
+     * // adds a new command (CancelOrder) that the Orders domain will receive
+     * await addCommandToDomain('Orders', 'receives', { id: 'CancelOrder', version: '2.0.0' });
+     *
+     * ```
+     */
+    addCommandToDomain: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Add a query to a domain by its id.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addQueryToDomain } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new query (GetOrderStatus) that the Orders domain will send
+     * await addQueryToDomain('Orders', 'sends', { id: 'GetOrderStatus', version: '2.0.0' });
+     *
+     * // adds a new query (GetInventory) that the Orders domain will receive
+     * await addQueryToDomain('Orders', 'receives', { id: 'GetInventory', version: '2.0.0' });
+     *
+     * ```
+     */
+    addQueryToDomain: (id: string, direction: string, message: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Teams
+     * ================================
+     */
+    /**
+     * Adds a team to EventCatalog
+     *
+     * @param team - The team to write
+     * @param options - Optional options to write the team
+     *
+     */
+    writeTeam: (team: Team, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a team from EventCatalog
+     * @param id - The id of the team to retrieve
+     * @returns Team|Undefined
+     */
+    getTeam: (id: string) => Promise<Team | undefined>;
+    /**
+     * Returns all teams from EventCatalog
+     * @returns Team[]|Undefined
+     */
+    getTeams: (options?: {}) => Promise<Team[]>;
+    /**
+     * Remove a team by the team id
+     *
+     * @param id - The id of the team you want to remove
+     *
+     */
+    rmTeamById: (id: string) => Promise<void>;
+    /**
+     * ================================
+     *            Users
+     * ================================
+     */
+    /**
+     * Adds a user to EventCatalog
+     *
+     * @param user - The user to write
+     * @param options - Optional options to write the user
+     *
+     */
+    writeUser: (user: User, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a user from EventCatalog
+     * @param id - The id of the user to retrieve
+     * @returns User|Undefined
+     */
+    getUser: (id: string) => Promise<User | undefined>;
+    /**
+     * Returns all user from EventCatalog
+     * @returns User[]|Undefined
+     */
+    getUsers: (options?: {}) => Promise<User[]>;
+    /**
+     * Remove a user by the user id
+     *
+     * @param id - The id of the user you want to remove
+     *
+     */
+    rmUserById: (id: string) => Promise<void>;
+    /**
+     * ================================
+     *            Custom Docs
+     * ================================
+     */
+    /**
+     * Returns a custom doc from EventCatalog
+     * @param path - The path to the custom doc to retrieve
+     * @returns CustomDoc|Undefined
+     */
+    getCustomDoc: (filePath: string) => Promise<CustomDoc | undefined>;
+    /**
+     * Returns all custom docs from EventCatalog
+     * @param options - Optional options to get custom docs from a specific path
+     * @returns CustomDoc[]|Undefined
+     */
+    getCustomDocs: (options?: {
+        path?: string;
+    }) => Promise<CustomDoc[]>;
+    /**
+     * Writes a custom doc to EventCatalog
+     * @param customDoc - The custom doc to write
+     * @param options - Optional options to write the custom doc
+     *
+     */
+    writeCustomDoc: (customDoc: CustomDoc, options?: {
+        path?: string;
+    }) => Promise<void>;
+    /**
+     * Removes a custom doc from EventCatalog
+     * @param path - The path to the custom doc to remove
+     *
+     */
+    rmCustomDoc: (filePath: string) => Promise<void>;
+    /**
+     * Dumps the catalog to a JSON file.
+     * @param directory - The directory to dump the catalog to
+     * @returns A JSON file with the catalog
+     */
+    dumpCatalog: (options?: {
+        includeMarkdown?: boolean;
+    }) => Promise<EventCatalog>;
+    /**
+     * Returns the event catalog configuration file.
+     * The event catalog configuration file is the file that contains the configuration for the event catalog.
+     *
+     * @param directory - The directory of the catalog.
+     * @returns A JSON object with the configuration for the event catalog.
+     */
+    getEventCatalogConfigurationFile: () => Promise<any>;
+    /**
+     * ================================
+     *            Resources Utils
+     * ================================
+     */
+    /**
+     * Returns the path to a given resource by id and version
+     */
+    getResourcePath: (catalogDir: string, id: string, version?: string) => Promise<{
+        fullPath: string;
+        relativePath: string;
+        directory: string;
+    } | undefined>;
+    /**
+     * Returns the folder name of a given resource
+     */
+    getResourceFolderName: (catalogDir: string, id: string, version?: string) => Promise<string | undefined>;
+    /**
+     * ================================
+     *            General Message Utils
+     * ================================
+     */
+    /**
+     * Returns a message from EventCatalog by a given schema path.
+     *
+     * @param path - The path to the message to retrieve
+     * @returns Message|Undefined
+     */
+    getMessageBySchemaPath: (path: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Message>;
+    /**
+     * Returns the producers and consumers (services) 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[] }
+     */
+    getProducersAndConsumersForMessage: (id: string, version?: string, options?: {
+        latestOnly?: boolean;
+    }) => Promise<{
+        producers: Service[];
+        consumers: Service[];
+    }>;
+    /**
+     * Returns the consumers of a given schema path
+     * @param path - The path to the schema to get the consumers for
+     * @returns Service[]
+     */
+    getConsumersOfSchema: (path: string) => Promise<Service[]>;
+    /**
+     * Returns the producers of a given schema path
+     * @param path - The path to the schema to get the producers for
+     * @returns Service[]
+     */
+    getProducersOfSchema: (path: string) => Promise<Service[]>;
+    /**
+     * Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
+     * @param id - The id of the resource to get the owners for
+     * @param version - Optional version of the resource
+     * @returns { owners: User[] }
+     */
+    getOwnersForResource: (id: string, version?: string) => Promise<Team[]>;
+    /**
+     * ================================
+     *            Entities
+     * ================================
+     */
+    /**
+     * Returns an entity from EventCatalog
+     * @param id - The id of the entity to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Entity|Undefined
+     */
+    getEntity: (id: string, version?: string) => Promise<Entity>;
+    /**
+     * Returns all entities from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Entity[]|Undefined
+     */
+    getEntities: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Entity[]>;
+    /**
+     * Adds an entity to EventCatalog
+     *
+     * @param entity - The entity to write
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntity: (entity: Entity, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your entity, e.g. `/User`
+     *
+     */
+    rmEntity: (path: string) => Promise<void>;
+    /**
+     * Remove an entity by an entity id
+     *
+     * @param id - The id of the entity you want to remove
+     *
+     */
+    rmEntityById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given entity id to the version directory
+     * @param id - The id of the entity to version
+     */
+    versionEntity: (id: string) => Promise<void>;
+    /**
+     * Check to see if an entity version exists
+     * @param id - The id of the entity
+     * @param version - The version of the entity (supports semver)
+     * @returns
+     */
+    entityHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Data Stores
+     * ================================
+     */
+    /**
+     * Adds a data store to EventCatalog
+     * @param dataStore - The data store to write
+     * @param options - Optional options to write the data store
+     *
+     */
+    writeDataStore: (data: Container, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns a data store from EventCatalog
+     * @param id - The id of the data store to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Container|Undefined
+     */
+    getDataStore: (id: string, version?: string) => Promise<Container>;
+    /**
+     * Returns all data stores from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Container[]|Undefined
+     */
+    getDataStores: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Container[]>;
+    /**
+     * Version a data store by its id
+     * @param id - The id of the data store to version
+     */
+    versionDataStore: (id: string) => Promise<void>;
+    /**
+     * Remove a data store by its path
+     * @param path - The path to the data store to remove
+     */
+    rmDataStore: (path: string) => Promise<void>;
+    /**
+     * Remove a data store by its id
+     * @param id - The id of the data store to remove
+     */
+    rmDataStoreById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Check to see if a data store version exists
+     * @param id - The id of the data store
+     * @param version - The version of the data store (supports semver)
+     * @returns
+     */
+    dataStoreHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a file to a data store by its id
+     * @param id - The id of the data store to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the data store to add the file to
+     * @returns
+     */
+    addFileToDataStore: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Writes a data store to a service by its id
+     * @param dataStore - The data store to write
+     * @param service - The service to write the data store to
+     * @returns
+     */
+    writeDataStoreToService: (container: Container, service: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * ================================
+     *            Data Products
+     * ================================
+     */
+    /**
+     * Adds a data product to EventCatalog
+     * @param dataProduct - The data product to write
+     * @param options - Optional options to write the data product
+     *
+     */
+    writeDataProduct: (dataProduct: DataProduct, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Writes a data product to a domain in EventCatalog
+     * @param dataProduct - The data product to write
+     * @param domain - The domain to write the data product to
+     * @param options - Optional options to write the data product
+     *
+     */
+    writeDataProductToDomain: (dataProduct: DataProduct, domain: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a data product from EventCatalog
+     * @param id - The id of the data product to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns DataProduct|Undefined
+     */
+    getDataProduct: (id: string, version?: string) => Promise<DataProduct>;
+    /**
+     * Returns all data products from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns DataProduct[]|Undefined
+     */
+    getDataProducts: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<DataProduct[]>;
+    /**
+     * Version a data product by its id
+     * @param id - The id of the data product to version
+     */
+    versionDataProduct: (id: string) => Promise<void>;
+    /**
+     * Remove a data product by its path
+     * @param path - The path to the data product to remove
+     */
+    rmDataProduct: (path: string) => Promise<void>;
+    /**
+     * Remove a data product by its id
+     * @param id - The id of the data product to remove
+     * @param version - Optional version of the data product to remove
+     */
+    rmDataProductById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Check to see if a data product version exists
+     * @param id - The id of the data product
+     * @param version - The version of the data product (supports semver)
+     * @returns
+     */
+    dataProductHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a file to a data product by its id
+     * @param id - The id of the data product to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the data product to add the file to
+     * @returns
+     */
+    addFileToDataProduct: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds a data product to a domain
+     * @param id - The id of the domain
+     * @param dataProduct - The id and version of the data product to add
+     * @param version - (Optional) The version of the domain to add the data product to
+     * @returns
+     */
+    addDataProductToDomain: (id: string, dataProduct: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Diagrams
+     * ================================
+     */
+    /**
+     * Returns a diagram from EventCatalog
+     * @param id - The id of the diagram to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Diagram|Undefined
+     */
+    getDiagram: (id: string, version?: string) => Promise<Diagram>;
+    /**
+     * Returns all diagrams from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Diagram[]|Undefined
+     */
+    getDiagrams: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Diagram[]>;
+    /**
+     * Adds a diagram to EventCatalog
+     *
+     * @param diagram - The diagram to write
+     * @param options - Optional options to write the diagram
+     *
+     */
+    writeDiagram: (diagram: Diagram, options?: {
+        path
+        /**
+         * Adds an event to EventCatalog
+         *
+         * @param event - The event to write
+         * @param options - Optional options to write the event
+         *
+         */
+        ? /**
+         * Adds an event to EventCatalog
+         *
+         * @param event - The event to write
+         * @param options - Optional options to write the event
+         *
+         */: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Remove a diagram from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your diagram, e.g. `/ArchitectureDiagram`
+     *
+     */
+    rmDiagram: (path: string) => Promise<void>;
+    /**
+     * Remove a diagram by a diagram id
+     *
+     * @param id - The id of the diagram you want to remove
+     *
+     */
+    rmDiagramById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given diagram id to the version directory
+     * @param id - The id of the diagram to version
+     */
+    versionDiagram: (id: string) => Promise<void>;
+    /**
+     * Check to see if a diagram version exists
+     * @param id - The id of the diagram
+     * @param version - The version of the diagram (supports semver)
+     * @returns
+     */
+    diagramHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a file to the given diagram
+     * @param id - The id of the diagram to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the diagram to add the file to
+     * @returns
+     */
+    addFileToDiagram: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+};
+
+export { type Badge, type BaseSchema, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type Domain, type Entity, type Event, type EventCatalog, type Message, type Query, type ReceivesPointer, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };