@eventcatalog/sdk 2.6.4 → 2.6.6

package/dist/index.d.ts

@@ -23,14 +23,7 @@ declare const _default: (path: string) => {
      * @returns Event[]|Undefined
      */
     getEvents: (options?: {
-        latestOnly
-        /**
-         * Init the SDK for EventCatalog
-         *
-         * @param path - The path to the EventCatalog directory
-         *
-         */
-        ?: boolean;
+        latestOnly?: boolean;
         attachSchema?: boolean;
     }) => Promise<Event[]>;
     /**
@@ -60,7 +53,19 @@ declare const _default: (path: string) => {
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
-        override?: boolean;
+        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
+         */
+        ? /**
+         * 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;
     }) => Promise<void>;
     /**
      * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
@@ -242,14 +247,7 @@ declare const _default: (path: string) => {
      */
     writeQuery: (query: Query, options?: {
         path?: string;
-        override? /**
-         * 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
-         *
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -263,18 +261,7 @@ declare const _default: (path: string) => {
      */
     writeQueryToService: (query: Query, service: {
         id: string;
-        version
-        /**
-         * Returns a command from EventCatalog
-         * @param id - The id of the command to retrieve
-         * @param version - Optional id of the version to get (supports semver)
-         * @returns Command|Undefined
-         */
-        ? /**
-         * ================================
-         *            Commands
-         * ================================
-         */: string;
+        version?: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -505,6 +492,12 @@ declare const _default: (path: string) => {
      * @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
@@ -626,6 +619,29 @@ declare const _default: (path: string) => {
         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
@@ -780,7 +796,14 @@ declare const _default: (path: string) => {
      *
      */
     writeUser: (user: User, options?: {
-        override?: boolean;
+        override? /**
+         * 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
+         *
+         */: boolean;
     }) => Promise<void>;
     /**
      * Returns a user from EventCatalog
@@ -889,6 +912,13 @@ declare const _default: (path: string) => {
         producers: Service[];
         consumers: 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[]>;
 };
 
 export { Channel, Command, CustomDoc, Domain, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };