@eventcatalog/sdk 2.10.0 → 2.12.0

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@eventcatalog/sdk",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "SDK to integrate with EventCatalog",
+  "bin": {
+    "eventcatalog": "./dist/cli/index.js"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -24,12 +27,17 @@
   ],
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
       "types": [
         "./dist/index.d.ts",
         "./dist/events.t.ts"
-      ]
+      ],
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./cli-docs": {
+      "types": "./dist/cli-docs.d.ts",
+      "require": "./dist/cli-docs.js",
+      "import": "./dist/cli-docs.mjs"
     }
   },
   "main": "./dist/index.js",
@@ -37,6 +45,7 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "@changesets/cli": "^2.29.8",
+    "commander": "^12.0.0",
     "fs-extra": "^11.3.2",
     "glob": "^11.1.0",
     "gray-matter": "^4.0.3",

package/dist/channels.d.mts

@@ -1,214 +0,0 @@
-import { Channel } from './types.d.mjs';
-
-/**
- * Returns a channel from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the channel
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getChannel } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the channel
- * const channel = await getChannel('InventoryChannel');
- *
- * // Gets a version of the channel
- * const channel = await getChannel('InventoryChannel', '0.0.1');
- * ```
- */
-declare const getChannel: (directory: string) => (id: string, version?: string) => Promise<Channel>;
-/**
- * Returns all channels from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the channels.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getChannels } = utils('/path/to/eventcatalog');
- *
- * // Gets all channels (and versions) from the catalog
- * const channels = await getChannels();
- *
- * // Gets all channels (only latest version) from the catalog
- * const channels = await getChannels({ latestOnly: true });
- * ```
- */
-declare const getChannels: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Channel[]>;
-/**
- * Write a channel to EventCatalog.
- *
- * You can optionally override the path of the channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeChannel } = utils('/path/to/eventcatalog');
- *
- * // Write a channel to the catalog
- * // channel would be written to channels/inventory.{env}.events
- * await writeChannel({
- *   id: 'inventory.{env}.events',
- *   name: 'Inventory channel',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- *   address: inventory.{env}.events,
- * protocols: ['http'],
- * });
- *
- * // Write a channel to the catalog but override the path
- * // channel would be written to channels/Inventory/InventoryChannel
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { path: "/channels/Inventory/InventoryChannel"});
- *
- * // Write a channel to the catalog and override the existing content (if there is any)
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { override: true });
- *
- * // Write a channel to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { versionExistingContent: true });
- * ```
- */
-declare const writeChannel: (directory: string) => (channel: Channel, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Delete a channel at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmChannel } = utils('/path/to/eventcatalog');
- *
- * // removes a channel at the given path (channels dir is appended to the given path)
- * // Removes the channel at channels/InventoryChannel
- * await rmChannel('/InventoryChannel');
- * ```
- */
-declare const rmChannel: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a channel by it's id.
- *
- * Optionally specify a version to delete a specific version of the channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmChannelById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest InventoryChannel channel
- * await rmChannelById('inventory.{env}.events');
- *
- * // deletes a specific version of the InventoryChannel channel
- * await rmChannelById('inventory.{env}.events', '0.0.1');
- * ```
- */
-declare const rmChannelById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a channel by it's id.
- *
- * Takes the latest channel and moves it to a versioned directory.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionChannel } = utils('/path/to/eventcatalog');
- *
- * // moves the latest inventory.{env}.events channel to a versioned directory
- * // the version within that channel is used as the version number.
- * await versionChannel('inventory.{env}.events');
- *
- * ```
- */
-declare const versionChannel: (directory: string) => (id: string) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { channelHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await channelHasVersion('inventory.{env}.events', '0.0.1');
- * await channelHasVersion('inventory.{env}.events', 'latest');
- * await channelHasVersion('inventory.{env}.events', '0.0.x');*
- *
- * ```
- */
-declare const channelHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add an event/command/query to a channel by it's id.
- *
- * Optionally specify a version to add the message to a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an event to the service or command to the service
- * const { addEventToChannel, addCommandToChannel, addQueryToChannel } = utils('/path/to/eventcatalog');
- *
- * // Adds a new event (InventoryUpdatedEvent) that the InventoryService will send
- * await addEventToChannel('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
- * * // Adds a new event (OrderComplete) that the InventoryService will receive
- * await addEventToChannel('InventoryService', 'receives', { event: 'OrderComplete', version: '1.0.0' });
- *
- * // Adds a new command (UpdateInventoryCommand) that the InventoryService will send
- * await addCommandToChannel('InventoryService', 'sends', { command: 'UpdateInventoryCommand', version: '2.0.0' });
- * // Adds a new command (VerifyInventory) that the InventoryService will receive
- * await addCommandToChannel('InventoryService', 'receives', { command: 'VerifyInventory', version: '1.0.0' });
- *
- * // Adds a new query (GetInventoryQuery) that the InventoryService will send
- * await addQueryToChannel('InventoryService', 'sends', { query: 'GetInventoryQuery', version: '2.0.0' });
- * // Adds a new query (GetOrder) that the InventoryService will receive
- * await addQueryToChannel('InventoryService', 'receives', { query: 'GetOrder', version: '1.0.0' });
- *
- * ```
- */
-declare const addMessageToChannel: (directory: string, collection: string) => (id: string, _message: {
-    id: string;
-    version: string;
-    parameters?: {
-        [key: string]: string;
-    };
-}, version?: string) => Promise<void>;
-
-export { addMessageToChannel, channelHasVersion, getChannel, getChannels, rmChannel, rmChannelById, versionChannel, writeChannel };

package/dist/channels.d.ts

@@ -1,214 +0,0 @@
-import { Channel } from './types.d.js';
-
-/**
- * Returns a channel from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the channel
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getChannel } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the channel
- * const channel = await getChannel('InventoryChannel');
- *
- * // Gets a version of the channel
- * const channel = await getChannel('InventoryChannel', '0.0.1');
- * ```
- */
-declare const getChannel: (directory: string) => (id: string, version?: string) => Promise<Channel>;
-/**
- * Returns all channels from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the channels.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getChannels } = utils('/path/to/eventcatalog');
- *
- * // Gets all channels (and versions) from the catalog
- * const channels = await getChannels();
- *
- * // Gets all channels (only latest version) from the catalog
- * const channels = await getChannels({ latestOnly: true });
- * ```
- */
-declare const getChannels: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Channel[]>;
-/**
- * Write a channel to EventCatalog.
- *
- * You can optionally override the path of the channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeChannel } = utils('/path/to/eventcatalog');
- *
- * // Write a channel to the catalog
- * // channel would be written to channels/inventory.{env}.events
- * await writeChannel({
- *   id: 'inventory.{env}.events',
- *   name: 'Inventory channel',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- *   address: inventory.{env}.events,
- * protocols: ['http'],
- * });
- *
- * // Write a channel to the catalog but override the path
- * // channel would be written to channels/Inventory/InventoryChannel
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { path: "/channels/Inventory/InventoryChannel"});
- *
- * // Write a channel to the catalog and override the existing content (if there is any)
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { override: true });
- *
- * // Write a channel to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeChannel({
- *    id: 'InventoryChannel',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- *    address: inventory.{env}.events,
- *    protocols: ['http'],
- * }, { versionExistingContent: true });
- * ```
- */
-declare const writeChannel: (directory: string) => (channel: Channel, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Delete a channel at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmChannel } = utils('/path/to/eventcatalog');
- *
- * // removes a channel at the given path (channels dir is appended to the given path)
- * // Removes the channel at channels/InventoryChannel
- * await rmChannel('/InventoryChannel');
- * ```
- */
-declare const rmChannel: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a channel by it's id.
- *
- * Optionally specify a version to delete a specific version of the channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmChannelById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest InventoryChannel channel
- * await rmChannelById('inventory.{env}.events');
- *
- * // deletes a specific version of the InventoryChannel channel
- * await rmChannelById('inventory.{env}.events', '0.0.1');
- * ```
- */
-declare const rmChannelById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a channel by it's id.
- *
- * Takes the latest channel and moves it to a versioned directory.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionChannel } = utils('/path/to/eventcatalog');
- *
- * // moves the latest inventory.{env}.events channel to a versioned directory
- * // the version within that channel is used as the version number.
- * await versionChannel('inventory.{env}.events');
- *
- * ```
- */
-declare const versionChannel: (directory: string) => (id: string) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given channel.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { channelHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await channelHasVersion('inventory.{env}.events', '0.0.1');
- * await channelHasVersion('inventory.{env}.events', 'latest');
- * await channelHasVersion('inventory.{env}.events', '0.0.x');*
- *
- * ```
- */
-declare const channelHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add an event/command/query to a channel by it's id.
- *
- * Optionally specify a version to add the message to a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an event to the service or command to the service
- * const { addEventToChannel, addCommandToChannel, addQueryToChannel } = utils('/path/to/eventcatalog');
- *
- * // Adds a new event (InventoryUpdatedEvent) that the InventoryService will send
- * await addEventToChannel('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
- * * // Adds a new event (OrderComplete) that the InventoryService will receive
- * await addEventToChannel('InventoryService', 'receives', { event: 'OrderComplete', version: '1.0.0' });
- *
- * // Adds a new command (UpdateInventoryCommand) that the InventoryService will send
- * await addCommandToChannel('InventoryService', 'sends', { command: 'UpdateInventoryCommand', version: '2.0.0' });
- * // Adds a new command (VerifyInventory) that the InventoryService will receive
- * await addCommandToChannel('InventoryService', 'receives', { command: 'VerifyInventory', version: '1.0.0' });
- *
- * // Adds a new query (GetInventoryQuery) that the InventoryService will send
- * await addQueryToChannel('InventoryService', 'sends', { query: 'GetInventoryQuery', version: '2.0.0' });
- * // Adds a new query (GetOrder) that the InventoryService will receive
- * await addQueryToChannel('InventoryService', 'receives', { query: 'GetOrder', version: '1.0.0' });
- *
- * ```
- */
-declare const addMessageToChannel: (directory: string, collection: string) => (id: string, _message: {
-    id: string;
-    version: string;
-    parameters?: {
-        [key: string]: string;
-    };
-}, version?: string) => Promise<void>;
-
-export { addMessageToChannel, channelHasVersion, getChannel, getChannels, rmChannel, rmChannelById, versionChannel, writeChannel };