@eventcatalog/sdk 2.11.0 → 2.12.1

package/dist/commands.d.mts

@@ -1,274 +0,0 @@
-import { Command } from './types.d.mjs';
-
-/**
- * Returns a command from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the command
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getCommand } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the command
- * const command = await getCommand('UpdateInventory');
- *
- * // Gets a version of the command
- * const command = await getCommand('UpdateInventory', '0.0.1');
- *
- * // Gets the command with the schema attached
- * const command = await getCommand('UpdateInventory', '0.0.1', { attachSchema: true });
- * ```
- */
-declare const getCommand: (directory: string) => (id: string, version?: string, options?: {
-    attachSchema?: boolean;
-}) => Promise<Command>;
-/**
- * Returns all commands from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the events.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getCommands } = utils('/path/to/eventcatalog');
- *
- * // Gets all commands (and versions) from the catalog
- * const commands = await getCommands();
- *
- * // Gets all commands (only latest version) from the catalog
- * const commands = await getCommands({ latestOnly: true });
- *
- * // Gets all commands with the schema attached
- * const commands = await getCommands({ attachSchema: true });
- * ```
- */
-declare const getCommands: (directory: string) => (options?: {
-    latestOnly?: boolean;
-    attachSchema?: boolean;
-}) => Promise<Command[]>;
-/**
- * Write a command to EventCatalog.
- *
- * You can optionally override the path of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeCommand } = utils('/path/to/eventcatalog');
- *
- * // Write a command to the catalog
- * // Command would be written to commands/UpdateInventory
- * await writeCommand({
- *   id: 'UpdateInventory',
- *   name: 'Update Inventory',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * });
- *
- * // Write a command to the catalog but override the path
- * // Command would be written to commands/Inventory/UpdateInventory
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/UpdateInventory"});
- *
- * // Write a command to the catalog and override the existing content (if there is any)
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a command to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeCommand: (directory: string) => (command: Command, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write an command to a service in EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeCommandToService } = utils('/path/to/eventcatalog');
- *
- * // Write an event to a given service in the catalog
- * // Event would be written to services/Inventory/commands/UpdateInventory
- * await writeCommandToService({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeCommandToService: (directory: string) => (command: Command, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a command at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmCommand } = utils('/path/to/eventcatalog');
- *
- * // removes a command at the given path (commands dir is appended to the given path)
- * // Removes the command at commands/UpdateInventory
- * await rmCommand('/UpdateInventory');
- * ```
- */
-declare const rmCommand: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a command by it's id.
- *
- * Optionally specify a version to delete a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmCommandById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest UpdateInventory command
- * await rmCommandById('UpdateInventory');
- *
- * // deletes a specific version of the UpdateInventory command
- * await rmCommandById('UpdateInventory', '0.0.1');
- * ```
- */
-declare const rmCommandById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a command by it's id.
- *
- * Takes the latest command and moves it to a versioned directory.
- * All files with this command are also versioned (e.g /commands/UpdateInventory/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionCommand } = utils('/path/to/eventcatalog');
- *
- * // moves the latest UpdateInventory command to a versioned directory
- * // the version within that command is used as the version number.
- * await versionCommand('UpdateInventory');
- *
- * ```
- */
-declare const versionCommand: (directory: string) => (id: string) => Promise<void>;
-/**
- * Add a file to a command by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToCommand } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest UpdateInventory command
- * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the UpdateInventory command
- * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToCommand: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Add a schema to a command by it's id.
- *
- * Optionally specify a version to add a schema to a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addSchemaToCommand } = utils('/path/to/eventcatalog');
- *
- * // JSON schema example
- * const schema = {
- *    "$schema": "http://json-schema.org/draft-07/schema#",
- *    "type": "object",
- *    "properties": {
- *        "name": {
- *        "type": "string"
- *    },
- *    "age": {
- *      "type": "number"
- *    }
- *  },
- *  "required": ["name", "age"]
- * };
- *
- * // adds a schema to the latest UpdateInventory command
- * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' });
- *
- * // adds a file to a specific version of the UpdateInventory command
- * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' }, '0.0.1');
- *
- * ```
- */
-declare const addSchemaToCommand: (directory: string) => (id: string, schema: {
-    schema: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { commandHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await commandHasVersion('InventoryAdjusted', '0.0.1');
- * await commandHasVersion('InventoryAdjusted', 'latest');
- * await commandHasVersion('InventoryAdjusted', '0.0.x');*
- *
- * ```
- */
-declare const commandHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-
-export { addFileToCommand, addSchemaToCommand, commandHasVersion, getCommand, getCommands, rmCommand, rmCommandById, versionCommand, writeCommand, writeCommandToService };

package/dist/commands.d.ts

@@ -1,274 +0,0 @@
-import { Command } from './types.d.js';
-
-/**
- * Returns a command from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the command
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getCommand } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the command
- * const command = await getCommand('UpdateInventory');
- *
- * // Gets a version of the command
- * const command = await getCommand('UpdateInventory', '0.0.1');
- *
- * // Gets the command with the schema attached
- * const command = await getCommand('UpdateInventory', '0.0.1', { attachSchema: true });
- * ```
- */
-declare const getCommand: (directory: string) => (id: string, version?: string, options?: {
-    attachSchema?: boolean;
-}) => Promise<Command>;
-/**
- * Returns all commands from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the events.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getCommands } = utils('/path/to/eventcatalog');
- *
- * // Gets all commands (and versions) from the catalog
- * const commands = await getCommands();
- *
- * // Gets all commands (only latest version) from the catalog
- * const commands = await getCommands({ latestOnly: true });
- *
- * // Gets all commands with the schema attached
- * const commands = await getCommands({ attachSchema: true });
- * ```
- */
-declare const getCommands: (directory: string) => (options?: {
-    latestOnly?: boolean;
-    attachSchema?: boolean;
-}) => Promise<Command[]>;
-/**
- * Write a command to EventCatalog.
- *
- * You can optionally override the path of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeCommand } = utils('/path/to/eventcatalog');
- *
- * // Write a command to the catalog
- * // Command would be written to commands/UpdateInventory
- * await writeCommand({
- *   id: 'UpdateInventory',
- *   name: 'Update Inventory',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- * });
- *
- * // Write a command to the catalog but override the path
- * // Command would be written to commands/Inventory/UpdateInventory
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/UpdateInventory"});
- *
- * // Write a command to the catalog and override the existing content (if there is any)
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a command to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeCommand({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeCommand: (directory: string) => (command: Command, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write an command to a service in EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeCommandToService } = utils('/path/to/eventcatalog');
- *
- * // Write an event to a given service in the catalog
- * // Event would be written to services/Inventory/commands/UpdateInventory
- * await writeCommandToService({
- *    id: 'UpdateInventory',
- *    name: 'Update Inventory',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeCommandToService: (directory: string) => (command: Command, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a command at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmCommand } = utils('/path/to/eventcatalog');
- *
- * // removes a command at the given path (commands dir is appended to the given path)
- * // Removes the command at commands/UpdateInventory
- * await rmCommand('/UpdateInventory');
- * ```
- */
-declare const rmCommand: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a command by it's id.
- *
- * Optionally specify a version to delete a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmCommandById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest UpdateInventory command
- * await rmCommandById('UpdateInventory');
- *
- * // deletes a specific version of the UpdateInventory command
- * await rmCommandById('UpdateInventory', '0.0.1');
- * ```
- */
-declare const rmCommandById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a command by it's id.
- *
- * Takes the latest command and moves it to a versioned directory.
- * All files with this command are also versioned (e.g /commands/UpdateInventory/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionCommand } = utils('/path/to/eventcatalog');
- *
- * // moves the latest UpdateInventory command to a versioned directory
- * // the version within that command is used as the version number.
- * await versionCommand('UpdateInventory');
- *
- * ```
- */
-declare const versionCommand: (directory: string) => (id: string) => Promise<void>;
-/**
- * Add a file to a command by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToCommand } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest UpdateInventory command
- * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the UpdateInventory command
- * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToCommand: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Add a schema to a command by it's id.
- *
- * Optionally specify a version to add a schema to a specific version of the command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addSchemaToCommand } = utils('/path/to/eventcatalog');
- *
- * // JSON schema example
- * const schema = {
- *    "$schema": "http://json-schema.org/draft-07/schema#",
- *    "type": "object",
- *    "properties": {
- *        "name": {
- *        "type": "string"
- *    },
- *    "age": {
- *      "type": "number"
- *    }
- *  },
- *  "required": ["name", "age"]
- * };
- *
- * // adds a schema to the latest UpdateInventory command
- * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' });
- *
- * // adds a file to a specific version of the UpdateInventory command
- * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' }, '0.0.1');
- *
- * ```
- */
-declare const addSchemaToCommand: (directory: string) => (id: string, schema: {
-    schema: string;
-    fileName: string;
-}, version?: string, options?: {
-    path?: string;
-}) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given command.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { commandHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await commandHasVersion('InventoryAdjusted', '0.0.1');
- * await commandHasVersion('InventoryAdjusted', 'latest');
- * await commandHasVersion('InventoryAdjusted', '0.0.x');*
- *
- * ```
- */
-declare const commandHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-
-export { addFileToCommand, addSchemaToCommand, commandHasVersion, getCommand, getCommands, rmCommand, rmCommandById, versionCommand, writeCommand, writeCommandToService };