@eventcatalog/sdk 1.1.4 → 1.2.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Service, Domain } from './types.d.mjs';
+import { Event, Command, Query, Channel, Service, Domain } from './types.d.mjs';
 
 /**
  * Init the SDK for EventCatalog
@@ -254,6 +254,123 @@ declare const _default: (path: string) => {
      * @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>;
+    /**
+     * 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;
+    }) => 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) => 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
@@ -342,6 +459,75 @@ declare const _default: (path: string) => {
      * @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 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>;
     /**
      * ================================
      *            Domains
@@ -394,52 +580,6 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
-    /**
-     * 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 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>;
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Service, Domain } from './types.d.js';
+import { Event, Command, Query, Channel, Service, Domain } from './types.d.js';
 
 /**
  * Init the SDK for EventCatalog
@@ -254,6 +254,123 @@ declare const _default: (path: string) => {
      * @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>;
+    /**
+     * 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;
+    }) => 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) => 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
@@ -342,6 +459,75 @@ declare const _default: (path: string) => {
      * @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 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>;
     /**
      * ================================
      *            Domains
@@ -394,52 +580,6 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
-    /**
-     * 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 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>;
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain