@eventcatalog/sdk 1.1.4 → 1.2.1

package/dist/index.js

@@ -33,7 +33,7 @@ __export(src_exports, {
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
-var import_node_path7 = require("path");
+var import_node_path8 = require("path");
 
 // src/events.ts
 var import_promises3 = __toESM(require("fs/promises"));
@@ -389,6 +389,51 @@ var addServiceToDomain = (directory) => async (id, service, version) => {
   await writeDomain(directory)(domain);
 };
 
+// src/channels.ts
+var import_promises8 = __toESM(require("fs/promises"));
+var import_node_path7 = require("path");
+var getChannel = (directory) => async (id, version) => getResource(directory, id, version, { type: "channel" });
+var writeChannel = (directory) => async (channel, options = { path: "" }) => writeResource(directory, { ...channel }, { ...options, type: "channel" });
+var rmChannel = (directory) => async (path) => {
+  await import_promises8.default.rm((0, import_node_path7.join)(directory, path), { recursive: true });
+};
+var rmChannelById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "channel" });
+var versionChannel = (directory) => async (id) => versionResource(directory, id);
+var channelHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+var addMessageToChannel = (directory, collection) => async (id, _message, version) => {
+  let channel = await getChannel(directory)(id, version);
+  const functions = {
+    events: {
+      getMessage: getEvent,
+      rmMessageById: rmEventById,
+      writeMessage: writeEvent
+    },
+    commands: {
+      getMessage: getCommand,
+      rmMessageById: rmCommandById,
+      writeMessage: writeCommand
+    },
+    queries: {
+      getMessage: getQuery,
+      rmMessageById: rmQueryById,
+      writeMessage: writeQuery
+    }
+  };
+  const { getMessage, rmMessageById, writeMessage } = functions[collection];
+  const message = await getMessage(directory)(_message.id, _message.version);
+  if (!message) throw new Error(`Message ${_message.id} with version ${_message.version} not found`);
+  if (message.channels === void 0) {
+    message.channels = [];
+  }
+  const channelInfo = { id, version: channel.version, ..._message.parameters && { parameters: _message.parameters } };
+  message.channels.push(channelInfo);
+  await rmMessageById(directory)(_message.id, _message.version);
+  await writeMessage(directory)(message);
+};
+
 // src/index.ts
 var src_default = (path) => {
   return {
@@ -398,7 +443,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path7.join)(path)),
+    getEvent: getEvent((0, import_node_path8.join)(path)),
     /**
      * Adds an event to EventCatalog
      *
@@ -406,7 +451,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path7.join)(path, "events")),
+    writeEvent: writeEvent((0, import_node_path8.join)(path, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -415,26 +460,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path7.join)(path, "services")),
+    writeEventToService: writeEventToService((0, import_node_path8.join)(path, "services")),
     /**
      * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmEvent: rmEvent((0, import_node_path7.join)(path, "events")),
+    rmEvent: rmEvent((0, import_node_path8.join)(path, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path7.join)(path)),
+    rmEventById: rmEventById((0, import_node_path8.join)(path)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path7.join)(path)),
+    versionEvent: versionEvent((0, import_node_path8.join)(path)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -442,7 +487,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path7.join)(path)),
+    addFileToEvent: addFileToEvent((0, import_node_path8.join)(path)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -450,14 +495,14 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path7.join)(path)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path8.join)(path)),
     /**
      * 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: eventHasVersion((0, import_node_path7.join)(path)),
+    eventHasVersion: eventHasVersion((0, import_node_path8.join)(path)),
     /**
      * ================================
      *            Commands
@@ -469,7 +514,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path7.join)(path)),
+    getCommand: getCommand((0, import_node_path8.join)(path)),
     /**
      * Adds an command to EventCatalog
      *
@@ -477,7 +522,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path7.join)(path, "commands")),
+    writeCommand: writeCommand((0, import_node_path8.join)(path, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -486,26 +531,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path7.join)(path, "services")),
+    writeCommandToService: writeCommandToService((0, import_node_path8.join)(path, "services")),
     /**
      * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmCommand: rmCommand((0, import_node_path7.join)(path, "commands")),
+    rmCommand: rmCommand((0, import_node_path8.join)(path, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path7.join)(path)),
+    rmCommandById: rmCommandById((0, import_node_path8.join)(path)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path7.join)(path)),
+    versionCommand: versionCommand((0, import_node_path8.join)(path)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -513,7 +558,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path7.join)(path)),
+    addFileToCommand: addFileToCommand((0, import_node_path8.join)(path)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -521,14 +566,14 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path7.join)(path)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path8.join)(path)),
     /**
      * 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: commandHasVersion((0, import_node_path7.join)(path)),
+    commandHasVersion: commandHasVersion((0, import_node_path8.join)(path)),
     /**
      * ================================
      *            Queries
@@ -540,7 +585,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path7.join)(path)),
+    getQuery: getQuery((0, import_node_path8.join)(path)),
     /**
      * Adds a query to EventCatalog
      *
@@ -548,7 +593,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path7.join)(path, "queries")),
+    writeQuery: writeQuery((0, import_node_path8.join)(path, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -557,26 +602,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path7.join)(path, "services")),
+    writeQueryToService: writeQueryToService((0, import_node_path8.join)(path, "services")),
     /**
      * Remove an query to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your query, e.g. `/Orders/GetOrder`
      *
      */
-    rmQuery: rmQuery((0, import_node_path7.join)(path, "queries")),
+    rmQuery: rmQuery((0, import_node_path8.join)(path, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path7.join)(path)),
+    rmQueryById: rmQueryById((0, import_node_path8.join)(path)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path7.join)(path)),
+    versionQuery: versionQuery((0, import_node_path8.join)(path)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -584,7 +629,7 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path7.join)(path)),
+    addFileToQuery: addFileToQuery((0, import_node_path8.join)(path)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -592,14 +637,111 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path7.join)(path)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path8.join)(path)),
     /**
      * 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: queryHasVersion((0, import_node_path7.join)(path)),
+    queryHasVersion: queryHasVersion((0, import_node_path8.join)(path)),
+    /**
+     * ================================
+     *            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: getChannel((0, import_node_path8.join)(path)),
+    /**
+     * Adds an channel to EventCatalog
+     *
+     * @param command - The channel to write
+     * @param options - Optional options to write the channel
+     *
+     */
+    writeChannel: writeChannel((0, import_node_path8.join)(path, "channels")),
+    /**
+     * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmChannel: rmChannel((0, import_node_path8.join)(path, "channels")),
+    /**
+     * Remove an channel by an Event id
+     *
+     * @param id - The id of the channel you want to remove
+     *
+     */
+    rmChannelById: rmChannelById((0, import_node_path8.join)(path)),
+    /**
+     * Moves a given channel id to the version directory
+     * @param directory
+     */
+    versionChannel: versionChannel((0, import_node_path8.join)(path)),
+    /**
+     * 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: channelHasVersion((0, import_node_path8.join)(path)),
+    /**
+     * 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: addMessageToChannel((0, import_node_path8.join)(path), "events"),
+    /**
+     * 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: addMessageToChannel((0, import_node_path8.join)(path), "commands"),
+    /**
+     * 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: addMessageToChannel((0, import_node_path8.join)(path), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -612,14 +754,14 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path7.join)(path, "services")),
+    writeService: writeService((0, import_node_path8.join)(path, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path7.join)(path, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path8.join)(path, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -628,33 +770,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path7.join)(path, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * 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: getService((0, import_node_path7.join)(path)),
+    getService: getService((0, import_node_path8.join)(path)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path7.join)(path)),
+    versionService: versionService((0, import_node_path8.join)(path)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService((0, import_node_path7.join)(path, "services")),
+    rmService: rmService((0, import_node_path8.join)(path, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path7.join)(path)),
+    rmServiceById: rmServiceById((0, import_node_path8.join)(path)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -662,21 +804,81 @@ var src_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path7.join)(path)),
+    addFileToService: addFileToService((0, import_node_path8.join)(path)),
     /**
      * 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: getSpecificationFilesForService((0, import_node_path7.join)(path)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path8.join)(path)),
     /**
      * 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: serviceHasVersion((0, import_node_path7.join)(path)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path8.join)(path)),
+    /**
+     * 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: addMessageToService((0, import_node_path8.join)(path)),
+    /**
+     * 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: addMessageToService((0, import_node_path8.join)(path)),
+    /**
+     * 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: addMessageToService((0, import_node_path8.join)(path)),
     /**
      * ================================
      *            Domains
@@ -689,33 +891,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path7.join)(path, "domains")),
+    writeDomain: writeDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * 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: getDomain((0, import_node_path7.join)(path, "domains")),
+    getDomain: getDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path7.join)(path, "domains")),
+    versionDomain: versionDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * Remove a domain from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your domain, e.g. `/Payment`
      *
      */
-    rmDomain: rmDomain((0, import_node_path7.join)(path, "domains")),
+    rmDomain: rmDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path7.join)(path, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path8.join)(path, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -723,54 +925,14 @@ var src_default = (path) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path7.join)(path, "domains")),
-    /**
-     * 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: addMessageToService((0, import_node_path7.join)(path)),
-    /**
-     * 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: addMessageToService((0, import_node_path7.join)(path)),
+    addFileToDomain: addFileToDomain((0, import_node_path8.join)(path, "domains")),
     /**
      * 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: domainHasVersion((0, import_node_path7.join)(path)),
+    domainHasVersion: domainHasVersion((0, import_node_path8.join)(path)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -778,7 +940,7 @@ var src_default = (path) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path7.join)(path, "domains"))
+    addServiceToDomain: addServiceToDomain((0, import_node_path8.join)(path, "domains"))
   };
 };
 //# sourceMappingURL=index.js.map