@eventcatalog/sdk 1.1.3 → 1.2.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import { join as join8 } from "node:path";
+import { join as join9 } from "node:path";
 
 // src/events.ts
 import fs3 from "node:fs/promises";
@@ -123,7 +123,7 @@ var writeResource = async (catalogDir, resource, options = { path: "", type: ""
   const path = options.path || `/${resource.id}`;
   const exists = await versionExists(catalogDir, resource.id, resource.version);
   if (exists) {
-    throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
+    throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter2.stringify(markdown.trim(), frontmatter);
@@ -355,6 +355,51 @@ var addServiceToDomain = (directory) => async (id, service, version) => {
   await writeDomain(directory)(domain);
 };
 
+// src/channels.ts
+import fs8 from "node:fs/promises";
+import { join as join8 } from "node: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 fs8.rm(join8(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 {
@@ -364,7 +409,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join8(path)),
+    getEvent: getEvent(join9(path)),
     /**
      * Adds an event to EventCatalog
      *
@@ -372,7 +417,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join8(path, "events")),
+    writeEvent: writeEvent(join9(path, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -381,26 +426,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join8(path, "services")),
+    writeEventToService: writeEventToService(join9(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(join8(path, "events")),
+    rmEvent: rmEvent(join9(path, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join8(path)),
+    rmEventById: rmEventById(join9(path)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join8(path)),
+    versionEvent: versionEvent(join9(path)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -408,7 +453,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join8(path)),
+    addFileToEvent: addFileToEvent(join9(path)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -416,14 +461,14 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join8(path)),
+    addSchemaToEvent: addSchemaToEvent(join9(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(join8(path)),
+    eventHasVersion: eventHasVersion(join9(path)),
     /**
      * ================================
      *            Commands
@@ -435,7 +480,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join8(path)),
+    getCommand: getCommand(join9(path)),
     /**
      * Adds an command to EventCatalog
      *
@@ -443,7 +488,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join8(path, "commands")),
+    writeCommand: writeCommand(join9(path, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -452,26 +497,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join8(path, "services")),
+    writeCommandToService: writeCommandToService(join9(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(join8(path, "commands")),
+    rmCommand: rmCommand(join9(path, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join8(path)),
+    rmCommandById: rmCommandById(join9(path)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join8(path)),
+    versionCommand: versionCommand(join9(path)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -479,7 +524,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join8(path)),
+    addFileToCommand: addFileToCommand(join9(path)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -487,14 +532,14 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join8(path)),
+    addSchemaToCommand: addSchemaToCommand(join9(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(join8(path)),
+    commandHasVersion: commandHasVersion(join9(path)),
     /**
      * ================================
      *            Queries
@@ -506,7 +551,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join8(path)),
+    getQuery: getQuery(join9(path)),
     /**
      * Adds a query to EventCatalog
      *
@@ -514,7 +559,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join8(path, "queries")),
+    writeQuery: writeQuery(join9(path, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -523,26 +568,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join8(path, "services")),
+    writeQueryToService: writeQueryToService(join9(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(join8(path, "queries")),
+    rmQuery: rmQuery(join9(path, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join8(path)),
+    rmQueryById: rmQueryById(join9(path)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join8(path)),
+    versionQuery: versionQuery(join9(path)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -550,7 +595,7 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join8(path)),
+    addFileToQuery: addFileToQuery(join9(path)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -558,14 +603,111 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join8(path)),
+    addSchemaToQuery: addSchemaToQuery(join9(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(join8(path)),
+    queryHasVersion: queryHasVersion(join9(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(join9(path)),
+    /**
+     * Adds an channel to EventCatalog
+     *
+     * @param command - The channel to write
+     * @param options - Optional options to write the channel
+     *
+     */
+    writeChannel: writeChannel(join9(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(join9(path, "channels")),
+    /**
+     * Remove an channel by an Event id
+     *
+     * @param id - The id of the channel you want to remove
+     *
+     */
+    rmChannelById: rmChannelById(join9(path)),
+    /**
+     * Moves a given channel id to the version directory
+     * @param directory
+     */
+    versionChannel: versionChannel(join9(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(join9(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(join9(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(join9(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(join9(path), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -578,14 +720,14 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join8(path, "services")),
+    writeService: writeService(join9(path, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join8(path, "services")),
+    writeVersionedService: writeVersionedService(join9(path, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -594,33 +736,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join8(path, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join9(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(join8(path)),
+    getService: getService(join9(path)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join8(path)),
+    versionService: versionService(join9(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(join8(path, "services")),
+    rmService: rmService(join9(path, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join8(path)),
+    rmServiceById: rmServiceById(join9(path)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -628,21 +770,81 @@ var src_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join8(path)),
+    addFileToService: addFileToService(join9(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(join8(path)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join9(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(join8(path)),
+    serviceHasVersion: serviceHasVersion(join9(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(join9(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(join9(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(join9(path)),
     /**
      * ================================
      *            Domains
@@ -655,33 +857,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join8(path, "domains")),
+    writeDomain: writeDomain(join9(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(join8(path, "domains")),
+    getDomain: getDomain(join9(path, "domains")),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join8(path, "domains")),
+    versionDomain: versionDomain(join9(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(join8(path, "domains")),
+    rmDomain: rmDomain(join9(path, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join8(path, "domains")),
+    rmDomainById: rmDomainById(join9(path, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -689,54 +891,14 @@ var src_default = (path) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join8(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(join8(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(join8(path)),
+    addFileToDomain: addFileToDomain(join9(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(join8(path)),
+    domainHasVersion: domainHasVersion(join9(path)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -744,7 +906,7 @@ var src_default = (path) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join8(path, "domains"))
+    addServiceToDomain: addServiceToDomain(join9(path, "domains"))
   };
 };
 export {