npm - @eventcatalog/sdk - Versions diffs - 0.0.6 → 0.0.8 - Mend

@eventcatalog/sdk 0.0.6 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts","../src/events.ts","../src/internal/resources.ts","../src/internal/utils.ts","../src/commands.ts","../src/services.ts"],"sourcesContent":["import { join } from 'node:path';\nimport { rmEvent, rmEventById, writeEvent, versionEvent, getEvent, addFileToEvent, addSchemaToEvent } from './events';\nimport {\n rmCommand,\n rmCommandById,\n writeCommand,\n versionCommand,\n getCommand,\n addFileToCommand,\n addSchemaToCommand,\n} from './commands';\nimport { writeService, getService, versionService, rmService, rmServiceById, addFileToService } from './services';\n\n/*\n Init the SDK for EventCatalog\n \n @param path - The path to the EventCatalog directory\n \n /\nexport default (path: string) => {\n return {\n /*\n Returns an events from EventCatalog\n * @param id - The id of the event to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getEvent: getEvent(join(path, 'events')),\n /\n Adds an event to EventCatalog\n \n @param event - The event to write\n * @param options - Optional options to write the event\n \n /\n writeEvent: writeEvent(join(path, 'events')),\n /*\n Remove an event to EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`\n \n /\n rmEvent: rmEvent(join(path, 'events')),\n /*\n Remove an event by an Event id\n \n @param id - The id of the event you want to remove\n \n /\n rmEventById: rmEventById(join(path, 'events')),\n /*\n Moves a given event id to the version directory\n * @param directory\n /\n versionEvent: versionEvent(join(path, 'events')),\n /\n Adds a file to the given event\n * @param id - The id of the event to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the event to add the file to\n * @returns\n /\n addFileToEvent: addFileToEvent(join(path, 'events')),\n /\n Adds a schema to the given event\n * @param id - The id of the event to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the event to add the schema to\n * @returns\n /\n addSchemaToEvent: addSchemaToEvent(join(path, 'events')),\n\n /\n ================================\n * Commands\n * ================================\n /\n\n /\n Returns a command from EventCatalog\n * @param id - The id of the command to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getCommand: getCommand(join(path, 'commands')),\n /\n Adds an command to EventCatalog\n \n @param command - The command to write\n * @param options - Optional options to write the command\n \n /\n writeCommand: writeCommand(join(path, 'commands')),\n /*\n Remove an command to EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`\n \n /\n rmCommand: rmCommand(join(path, 'commands')),\n /*\n Remove an command by an Event id\n \n @param id - The id of the command you want to remove\n \n /\n rmCommandById: rmCommandById(join(path, 'commands')),\n /*\n Moves a given command id to the version directory\n * @param directory\n /\n versionCommand: versionCommand(join(path, 'commands')),\n /\n Adds a file to the given command\n * @param id - The id of the command to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the command to add the file to\n * @returns\n /\n addFileToCommand: addFileToCommand(join(path, 'commands')),\n /\n Adds a schema to the given command\n * @param id - The id of the command to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the command to add the schema to\n * @returns\n /\n addSchemaToCommand: addSchemaToCommand(join(path, 'commands')),\n\n /\n ================================\n * SERVICES\n * ================================\n /\n\n /\n Adds a service to EventCatalog\n \n @param service - The service to write\n * @param options - Optional options to write the event\n \n /\n writeService: writeService(join(path, 'services')),\n /*\n Returns a service from EventCatalog\n * @param id - The id of the service to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getService: getService(join(path, 'services')),\n /\n Moves a given service id to the version directory\n * @param directory\n /\n versionService: versionService(join(path, 'services')),\n /\n Remove a service from EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your service, e.g. `/InventoryService`\n \n /\n rmService: rmService(join(path, 'services')),\n /*\n Remove an service by an service id\n \n @param id - The id of the service you want to remove\n \n /\n rmServiceById: rmServiceById(join(path, 'services')),\n /*\n Adds a file to the given service\n * @param id - The id of the service to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the service to add the file to\n * @returns\n /\n addFileToService: addFileToService(join(path, 'services')),\n };\n};\n","import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns an event from EventCatalog.\n \n You can optionally specify a version to get a specific version of the event\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getEvent } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the event\n * const event = await getEvent('InventoryAdjusted');\n \n // Gets a version of the event\n * const event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n /\nexport const getEvent =\n (directory: string) =>\n async (id: string, version?: string): Promise<Event> =>\n getResource(directory, id, version, { type: 'event' }) as Promise<Event>;\n\n/\n Write an event to EventCatalog.\n \n You can optionally overide the path of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeEvent } = utils('/path/to/eventcatalog');\n \n // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n \n // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n /\nexport const writeEvent =\n (directory: string) =>\n async (event: Event, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...event }, { ...options, type: 'event' });\n\n/\n Delete an event at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmEvent } = utils('/path/to/eventcatalog');\n \n // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n /\nexport const rmEvent = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete an event by it's id.\n \n Optionally specify a version to delete a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmEventById } = utils('/path/to/eventcatalog');\n \n // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n \n // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n /\nexport const rmEventById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'event' });\n\n/\n Version an event by it's id.\n \n Takes the latest event and moves it to a versioned directory.\n * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionEvent } = utils('/path/to/eventcatalog');\n \n // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await versionEvent('InventoryAdjusted');\n \n ```\n /\nexport const versionEvent = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Add a file to an event by it's id.\n \n Optionally specify a version to add a file to a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToEvent } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n /\nexport const addFileToEvent =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/\n Add a schema to an event by it's id.\n \n Optionally specify a version to add a schema to a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n \n // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n \n // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n \n // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n \n ```\n /\nexport const addSchemaToEvent =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import { dirname, join } from 'path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './utils';\nimport matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { Message, Service } from '../types';\n\ntype Resource = Service \| Message;\n\nexport const versionResource = async (catalogDir: string, id: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = await searchFilesForId(files, id);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n // Event that is in the route of the project\n const file = matchedFiles[0];\n const sourceDirectory = dirname(file);\n const { data: { version = '0.0.1' } = {} } = matter.read(file);\n const targetDirectory = join(sourceDirectory, 'versioned', version);\n\n await fs.mkdir(targetDirectory, { recursive: true });\n\n // Copy the event to the versioned directory\n await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n return !src.includes('versioned');\n });\n\n // Remove all the files in the root of the resource as they have now been versioned\n await fs.readdir(sourceDirectory).then(async (resourceFiles) => {\n await Promise.all(\n resourceFiles.map(async (file) => {\n if (file !== 'versioned') {\n await fs.rm(join(sourceDirectory, file), { recursive: true });\n }\n })\n );\n });\n};\n\nexport const writeResource = async (\n catalogDir: string,\n resource: Resource,\n options: { path: string; type: string } = { path: '', type: '' }\n) => {\n // Get the path\n const path = options.path \|\| `/${resource.id}`;\n const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n if (exists) {\n throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);\n }\n\n const { markdown, ...frontmatter } = resource;\n const document = matter.stringify(markdown.trim(), frontmatter);\n await fs.mkdir(join(catalogDir, path), { recursive: true });\n await fs.writeFile(join(catalogDir, path, 'index.md'), document);\n};\n\nexport const getResource = async (\n catalogDir: string,\n id: string,\n version?: string,\n options?: { type: string }\n): Promise<Resource> => {\n const file = await findFileById(catalogDir, id, version);\n\n if (!file)\n throw new Error(\n `No ${options?.type \|\| 'resource'} found for the given id: ${id}` + (version ? ` and version ${version}` : '')\n );\n\n const { data, content } = matter.read(file);\n\n return {\n ...data,\n markdown: content.trim(),\n } as Resource;\n};\n\nexport const rmResourceById = async (catalogDir: string, id: string, version?: string, options?: { type: string }) => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = await searchFilesForId(files, id, version);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No ${options?.type \|\| 'resource'} found with id: ${id}`);\n }\n\n await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\nexport const addFileToResource = async (\n catalogDir: string,\n id: string,\n file: { content: string; fileName: string },\n version?: string\n) => {\n const pathToResource = await findFileById(catalogDir, id, version);\n\n if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n await fs.writeFile(join(dirname(pathToResource), file.fileName), file.content);\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/\n Returns true if a given version of a resource id exists in the catalog\n /\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = (await searchFilesForId(files, id, version)) \|\| [];\n return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string \| undefined> => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = (await searchFilesForId(files, id)) \|\| [];\n\n // Return the latest one\n if (!version) {\n return matchedFiles.find((path) => !path.includes('versioned'));\n }\n\n // Find the versioned event\n return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n try {\n const files = await glob(pattern, { ignore: 'node_modules/' });\n return files;\n } catch (error) {\n throw new Error(`Error finding files: ${error}`);\n }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n const idRegex = new RegExp(`^id:\\\\s['\"]?${id}['\"]?\\\\s$`, 'm');\n const versionRegex = new RegExp(`^version:\\\\s['\"]?${version}['\"]?\\\\s$`, 'm');\n\n const matches = await Promise.all(\n files.map(async (file) => {\n const content = await fs.readFile(file, 'utf-8');\n const hasIdMatch = content.match(idRegex);\n\n // Check version if provided\n if (version && !content.match(versionRegex)) {\n return undefined;\n }\n\n if (hasIdMatch) {\n return file;\n }\n })\n );\n\n return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/\n Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n /\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync \| CopyFilterSync) => {\n const tmpDirectory = join(catalogDir, 'tmp');\n await fs.mkdir(tmpDirectory, { recursive: true });\n\n // Copy everything over\n await copy(source, tmpDirectory, {\n overwrite: true,\n filter,\n });\n\n await copy(tmpDirectory, target, {\n overwrite: true,\n filter,\n });\n\n // Remove the tmp directory\n await fs.rm(tmpDirectory, { recursive: true });\n};\n","import fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport type { Command } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns a command from EventCatalog.\n \n You can optionally specify a version to get a specific version of the command\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getCommand } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the command\n * const command = await getCommand('UpdateInventory');\n \n // Gets a version of the command\n * const command = await getCommand('UpdateInventory', '0.0.1');\n * ```\n /\nexport const getCommand =\n (directory: string) =>\n async (id: string, version?: string): Promise<Command> =>\n getResource(directory, id, version, { type: 'command' }) as Promise<Command>;\n\n/\n Write a command to EventCatalog.\n \n You can optionally override the path of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeCommand } = utils('/path/to/eventcatalog');\n \n // Write a command to the catalog\n * // Command would be written to commands/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n \n // Write a command to the catalog but override the path\n * // Command would be written to commands/Inventory/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/UpdateInventory\"});\n * ```\n /\nexport const writeCommand =\n (directory: string) =>\n async (command: Command, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...command }, { ...options, type: 'command' });\n\n/\n Delete a command at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmCommand } = utils('/path/to/eventcatalog');\n \n // removes a command at the given path (commands dir is appended to the given path)\n * // Removes the command at commands/UpdateInventory\n * await rmCommand('/UpdateInventory');\n * ```\n /\nexport const rmCommand = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete a command by it's id.\n \n Optionally specify a version to delete a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmCommandById } = utils('/path/to/eventcatalog');\n \n // deletes the latest UpdateInventory command\n * await rmCommandById('UpdateInventory');\n \n // deletes a specific version of the UpdateInventory command\n * await rmCommandById('UpdateInventory', '0.0.1');\n * ```\n /\nexport const rmCommandById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'command' });\n\n/\n Version a command by it's id.\n \n Takes the latest command and moves it to a versioned directory.\n * All files with this command are also versioned (e.g /commands/UpdateInventory/schema.json)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionCommand } = utils('/path/to/eventcatalog');\n \n // moves the latest UpdateInventory command to a versioned directory\n * // the version within that command is used as the version number.\n * await versionCommand('UpdateInventory');\n \n ```\n /\nexport const versionCommand = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Add a file to a command by it's id.\n \n Optionally specify a version to add a file to a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToCommand } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n /\nexport const addFileToCommand =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/\n Add a schema to a command by it's id.\n \n Optionally specify a version to add a schema to a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addSchemaToCommand } = utils('/path/to/eventcatalog');\n \n // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n \n // adds a schema to the latest UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' });\n \n // adds a file to a specific version of the UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' }, '0.0.1');\n \n ```\n /\nexport const addSchemaToCommand =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import matter from 'gray-matter';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Service } from './types';\nimport fs from 'node:fs/promises';\nimport { dirname, join } from 'node:path';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns a service from EventCatalog.\n \n You can optionally specify a version to get a specific version of the service\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getService } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the event\n * const service = await getService('InventoryService');\n \n // Gets a version of the event\n * const service = await getService('InventoryService', '0.0.1');\n * ```\n /\nexport const getService =\n (directory: string) =>\n async (id: string, version?: string): Promise<Service> =>\n getResource(directory, id, version, { type: 'service' }) as Promise<Service>;\n/\n Write an event to EventCatalog.\n \n You can optionally overide the path of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeService } = utils('/path/to/eventcatalog');\n \n // Write a service\n * // Event would be written to services/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Service',\n * version: '0.0.1',\n * summary: 'Service that handles the inventory',\n * markdown: '# Hello world',\n * });\n \n // Write an event to the catalog but override the path\n * // Event would be written to services/Inventory/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryService\"});\n * ```\n /\nexport const writeService =\n (directory: string) =>\n async (service: Service, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...service }, { ...options, type: 'service' });\n\n/\n Version a service by it's id.\n \n Takes the latest service and moves it to a versioned directory.\n * All files with this service are also versioned. (e.g /services/InventoryService/openapi.yml)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionService } = utils('/path/to/eventcatalog');\n \n // moves the latest InventoryService service to a versioned directory\n * // the version within that service is used as the version number.\n * await versionService('InventoryService');\n \n ```\n /\nexport const versionService = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Delete a service at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmService } = utils('/path/to/eventcatalog');\n \n // Removes the service at services/InventoryService\n * await rmService('/InventoryService');\n * ```\n /\nexport const rmService = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete a service by it's id.\n \n Optionally specify a version to delete a specific version of the service.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmServiceById } = utils('/path/to/eventcatalog');\n \n // deletes the latest InventoryService event\n * await rmServiceById('InventoryService');\n \n // deletes a specific version of the InventoryService event\n * await rmServiceById('InventoryService', '0.0.1');\n * ```\n /\nexport const rmServiceById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'service' });\n\n/\n Add a file to a service by it's id.\n \n Optionally specify a version to add a file to a specific version of the service.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToService } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n */\n\nexport const addFileToService =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,oBAAqB;;;ACCrB,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;;;ACFrB,kBAA8B;;;ACA9B,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,mBAAe,uBAAK,YAAY,KAAK;AAC3C,QAAM,gBAAAA,QAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,YAAM,sBAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,YAAM,sBAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,gBAAAA,QAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;ADjFA,yBAAmB;AACnB,IAAAC,mBAAe;AAKR,IAAM,kBAAkB,OAAO,YAAoB,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,sBAAkB,qBAAQ,IAAI;AACpC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,mBAAAC,QAAO,KAAK,IAAI;AAC7D,QAAM,sBAAkB,kBAAK,iBAAiB,aAAa,OAAO;AAElE,QAAM,iBAAAC,QAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,YAAY,iBAAiB,iBAAiB,CAAC,QAAQ;AACnE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAM,iBAAAA,QAAG,QAAQ,eAAe,EAAE,KAAK,OAAO,kBAAkB;AAC9D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOC,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAM,iBAAAD,QAAG,OAAG,kBAAK,iBAAiBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC9D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAEO,IAAM,gBAAgB,OAC3B,YACA,UACA,UAA0C,EAAE,MAAM,IAAI,MAAM,GAAG,MAC5D;AAEH,QAAM,OAAO,QAAQ,QAAQ,IAAI,SAAS,EAAE;AAC5C,QAAM,SAAS,MAAM,cAAc,YAAY,SAAS,IAAI,SAAS,OAAO;AAE5E,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,mBAAmB,QAAQ,IAAI,mBAAmB,SAAS,OAAO,iBAAiB;AAAA,EACrG;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,mBAAAF,QAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAM,iBAAAC,QAAG,UAAM,kBAAK,YAAY,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,QAAM,iBAAAA,QAAG,cAAU,kBAAK,YAAY,MAAM,UAAU,GAAG,QAAQ;AACjE;AAEO,IAAM,cAAc,OACzB,YACA,IACA,SACA,YACsB;AACtB,QAAM,OAAO,MAAM,aAAa,YAAY,IAAI,OAAO;AAEvD,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR,MAAM,SAAS,QAAQ,UAAU,4BAA4B,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK;AAAA,IAC7G;AAEF,QAAM,EAAE,MAAM,QAAQ,IAAI,mBAAAD,QAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAEO,IAAM,iBAAiB,OAAO,YAAoB,IAAY,SAAkB,YAA+B;AACpH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,MAAM,SAAS,QAAQ,UAAU,mBAAmB,EAAE,EAAE;AAAA,EAC1E;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAAS,iBAAAC,QAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAEO,IAAM,oBAAoB,OAC/B,YACA,IACA,MACA,YACG;AACH,QAAM,iBAAiB,MAAM,aAAa,YAAY,IAAI,OAAO;AAEjE,MAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,wCAAwC;AAE7E,QAAM,iBAAAA,QAAG,cAAU,sBAAK,qBAAQ,cAAc,GAAG,KAAK,QAAQ,GAAG,KAAK,OAAO;AAC/E;;;AD9EO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAkClD,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAC1D,cAAc,WAAW,EAAE,GAAG,MAAM,GAAG,EAAE,GAAG,SAAS,MAAM,QAAQ,CAAC;AAgBjE,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAM,iBAAAE,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YACnE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAoBnD,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqB/F,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;;;AG3LF,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;AAsBd,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAkCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAgBrE,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAoBrD,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqBjG,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,qBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,iBAAiB,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACtG;;;ACrLF,IAAAC,mBAAe;AACf,IAAAC,oBAA8B;AAqBvB,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAiCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAoBrE,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAejG,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAsBrD,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;;;AL/HlD,IAAO,cAAQ,CAAC,SAAiB;AAC/B,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOL,UAAU,aAAS,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvC,YAAY,eAAW,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,SAAS,YAAQ,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrC,aAAa,gBAAY,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,cAAc,iBAAa,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/C,gBAAgB,mBAAe,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAcvD,YAAY,eAAW,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ7C,cAAc,iBAAa,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,WAAW,cAAU,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,eAAe,kBAAc,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAKnD,gBAAgB,mBAAe,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQrD,kBAAkB,qBAAiB,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQzD,oBAAoB,uBAAmB,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAe7D,cAAc,iBAAa,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,YAAY,eAAW,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,gBAAgB,mBAAe,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,WAAW,cAAU,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,eAAe,kBAAc,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,UAAU,CAAC;AAAA,EAC3D;AACF;","names":["import_node_path","import_promises","import_node_path","fs","import_promises","matter","fs","file","fs","import_promises","import_node_path","fs","import_promises","import_node_path","fs"]}
1	+ {"version":3,"sources":["../src/index.ts","../src/events.ts","../src/internal/resources.ts","../src/internal/utils.ts","../src/commands.ts","../src/services.ts","../src/domains.ts"],"sourcesContent":["import { join } from 'node:path';\nimport { rmEvent, rmEventById, writeEvent, versionEvent, getEvent, addFileToEvent, addSchemaToEvent } from './events';\nimport {\n rmCommand,\n rmCommandById,\n writeCommand,\n versionCommand,\n getCommand,\n addFileToCommand,\n addSchemaToCommand,\n} from './commands';\nimport { writeService, getService, versionService, rmService, rmServiceById, addFileToService } from './services';\nimport { writeDomain, getDomain, versionDomain, rmDomain, rmDomainById, addFileToDomain } from './domains';\n\n/*\n Init the SDK for EventCatalog\n \n @param path - The path to the EventCatalog directory\n \n /\nexport default (path: string) => {\n return {\n /*\n Returns an events from EventCatalog\n * @param id - The id of the event to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getEvent: getEvent(join(path, 'events')),\n /\n Adds an event to EventCatalog\n \n @param event - The event to write\n * @param options - Optional options to write the event\n \n /\n writeEvent: writeEvent(join(path, 'events')),\n /*\n Remove an event to EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`\n \n /\n rmEvent: rmEvent(join(path, 'events')),\n /*\n Remove an event by an Event id\n \n @param id - The id of the event you want to remove\n \n /\n rmEventById: rmEventById(join(path, 'events')),\n /*\n Moves a given event id to the version directory\n * @param directory\n /\n versionEvent: versionEvent(join(path, 'events')),\n /\n Adds a file to the given event\n * @param id - The id of the event to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the event to add the file to\n * @returns\n /\n addFileToEvent: addFileToEvent(join(path, 'events')),\n /\n Adds a schema to the given event\n * @param id - The id of the event to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the event to add the schema to\n * @returns\n /\n addSchemaToEvent: addSchemaToEvent(join(path, 'events')),\n\n /\n ================================\n * Commands\n * ================================\n /\n\n /\n Returns a command from EventCatalog\n * @param id - The id of the command to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getCommand: getCommand(join(path, 'commands')),\n /\n Adds an command to EventCatalog\n \n @param command - The command to write\n * @param options - Optional options to write the command\n \n /\n writeCommand: writeCommand(join(path, 'commands')),\n /*\n Remove an command to EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`\n \n /\n rmCommand: rmCommand(join(path, 'commands')),\n /*\n Remove an command by an Event id\n \n @param id - The id of the command you want to remove\n \n /\n rmCommandById: rmCommandById(join(path, 'commands')),\n /*\n Moves a given command id to the version directory\n * @param directory\n /\n versionCommand: versionCommand(join(path, 'commands')),\n /\n Adds a file to the given command\n * @param id - The id of the command to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the command to add the file to\n * @returns\n /\n addFileToCommand: addFileToCommand(join(path, 'commands')),\n /\n Adds a schema to the given command\n * @param id - The id of the command to add the schema to\n * @param schema - Schema contents to add including the content and the file name\n * @param version - Optional version of the command to add the schema to\n * @returns\n /\n addSchemaToCommand: addSchemaToCommand(join(path, 'commands')),\n\n /\n ================================\n * SERVICES\n * ================================\n /\n\n /\n Adds a service to EventCatalog\n \n @param service - The service to write\n * @param options - Optional options to write the event\n \n /\n writeService: writeService(join(path, 'services')),\n /*\n Returns a service from EventCatalog\n * @param id - The id of the service to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getService: getService(join(path, 'services')),\n /\n Moves a given service id to the version directory\n * @param directory\n /\n versionService: versionService(join(path, 'services')),\n /\n Remove a service from EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your service, e.g. `/InventoryService`\n \n /\n rmService: rmService(join(path, 'services')),\n /*\n Remove an service by an service id\n \n @param id - The id of the service you want to remove\n \n /\n rmServiceById: rmServiceById(join(path, 'services')),\n /*\n Adds a file to the given service\n * @param id - The id of the service to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the service to add the file to\n * @returns\n /\n addFileToService: addFileToService(join(path, 'services')),\n\n /\n ================================\n * Domains\n * ================================\n /\n\n /\n Adds a domain to EventCatalog\n \n @param domain - The domain to write\n * @param options - Optional options to write the event\n \n /\n writeDomain: writeDomain(join(path, 'domains')),\n /*\n Returns a domain from EventCatalog\n * @param id - The id of the domain to retrieve\n * @param version - Optional id of the version to get\n * @returns\n /\n getDomain: getDomain(join(path, 'domains')),\n /\n Moves a given domain id to the version directory\n * @param directory\n /\n versionDomain: versionDomain(join(path, 'domains')),\n /\n Remove a domain from EventCatalog (modeled on the standard POSIX rm utility)\n \n @param path - The path to your domain, e.g. `/Payment`\n \n /\n rmDomain: rmDomain(join(path, 'domains')),\n /*\n Remove an service by an domain id\n \n @param id - The id of the domain you want to remove\n \n /\n rmDomainById: rmDomainById(join(path, 'domains')),\n /*\n Adds a file to the given domain\n * @param id - The id of the domain to add the file to\n * @param file - File contents to add including the content and the file name\n * @param version - Optional version of the domain to add the file to\n * @returns\n /\n addFileToDomain: addFileToDomain(join(path, 'domains')),\n };\n};\n","import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns an event from EventCatalog.\n \n You can optionally specify a version to get a specific version of the event\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getEvent } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the event\n * const event = await getEvent('InventoryAdjusted');\n \n // Gets a version of the event\n * const event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n /\nexport const getEvent =\n (directory: string) =>\n async (id: string, version?: string): Promise<Event> =>\n getResource(directory, id, version, { type: 'event' }) as Promise<Event>;\n\n/\n Write an event to EventCatalog.\n \n You can optionally overide the path of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeEvent } = utils('/path/to/eventcatalog');\n \n // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n \n // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n * id: 'InventoryAdjusted',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n /\nexport const writeEvent =\n (directory: string) =>\n async (event: Event, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...event }, { ...options, type: 'event' });\n\n/\n Delete an event at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmEvent } = utils('/path/to/eventcatalog');\n \n // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n /\nexport const rmEvent = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete an event by it's id.\n \n Optionally specify a version to delete a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmEventById } = utils('/path/to/eventcatalog');\n \n // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n \n // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n /\nexport const rmEventById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'event' });\n\n/\n Version an event by it's id.\n \n Takes the latest event and moves it to a versioned directory.\n * All files with this event are also versioned (e.g /events/InventoryAdjusted/schema.json)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionEvent } = utils('/path/to/eventcatalog');\n \n // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await versionEvent('InventoryAdjusted');\n \n ```\n /\nexport const versionEvent = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Add a file to an event by it's id.\n \n Optionally specify a version to add a file to a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToEvent } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n /\nexport const addFileToEvent =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/\n Add a schema to an event by it's id.\n \n Optionally specify a version to add a schema to a specific version of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n \n // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n \n // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n \n // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n \n ```\n /\nexport const addSchemaToEvent =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import { dirname, join } from 'path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './utils';\nimport matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { Message, Service } from '../types';\n\ntype Resource = Service \| Message;\n\nexport const versionResource = async (catalogDir: string, id: string) => {\n // Find all the events in the directory\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = await searchFilesForId(files, id);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No event found with id: ${id}`);\n }\n\n // Event that is in the route of the project\n const file = matchedFiles[0];\n const sourceDirectory = dirname(file);\n const { data: { version = '0.0.1' } = {} } = matter.read(file);\n const targetDirectory = join(sourceDirectory, 'versioned', version);\n\n await fs.mkdir(targetDirectory, { recursive: true });\n\n // Copy the event to the versioned directory\n await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n return !src.includes('versioned');\n });\n\n // Remove all the files in the root of the resource as they have now been versioned\n await fs.readdir(sourceDirectory).then(async (resourceFiles) => {\n await Promise.all(\n resourceFiles.map(async (file) => {\n if (file !== 'versioned') {\n await fs.rm(join(sourceDirectory, file), { recursive: true });\n }\n })\n );\n });\n};\n\nexport const writeResource = async (\n catalogDir: string,\n resource: Resource,\n options: { path: string; type: string } = { path: '', type: '' }\n) => {\n // Get the path\n const path = options.path \|\| `/${resource.id}`;\n const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n if (exists) {\n throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);\n }\n\n const { markdown, ...frontmatter } = resource;\n const document = matter.stringify(markdown.trim(), frontmatter);\n await fs.mkdir(join(catalogDir, path), { recursive: true });\n await fs.writeFile(join(catalogDir, path, 'index.md'), document);\n};\n\nexport const getResource = async (\n catalogDir: string,\n id: string,\n version?: string,\n options?: { type: string }\n): Promise<Resource> => {\n const file = await findFileById(catalogDir, id, version);\n\n if (!file)\n throw new Error(\n `No ${options?.type \|\| 'resource'} found for the given id: ${id}` + (version ? ` and version ${version}` : '')\n );\n\n const { data, content } = matter.read(file);\n\n return {\n ...data,\n markdown: content.trim(),\n } as Resource;\n};\n\nexport const rmResourceById = async (catalogDir: string, id: string, version?: string, options?: { type: string }) => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = await searchFilesForId(files, id, version);\n\n if (matchedFiles.length === 0) {\n throw new Error(`No ${options?.type \|\| 'resource'} found with id: ${id}`);\n }\n\n await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\nexport const addFileToResource = async (\n catalogDir: string,\n id: string,\n file: { content: string; fileName: string },\n version?: string\n) => {\n const pathToResource = await findFileById(catalogDir, id, version);\n\n if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n await fs.writeFile(join(dirname(pathToResource), file.fileName), file.content);\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\nimport matter from 'gray-matter';\n\n/\n Returns true if a given version of a resource id exists in the catalog\n /\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = (await searchFilesForId(files, id, version)) \|\| [];\n return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string \| undefined> => {\n const files = await getFiles(`${catalogDir}//index.md`);\n const matchedFiles = (await searchFilesForId(files, id)) \|\| [];\n const latestVersion = matchedFiles.find((path) => !path.includes('versioned'));\n\n // If no version is provided, return the latest version\n if (!version) {\n return latestVersion;\n }\n\n // Check if the version exists\n const match = matchedFiles.find((path) => path.includes(`versioned/${version}`));\n\n // Version is given but can't be found in the versioned directory, check if it's the latest version\n if (!match && latestVersion) {\n const { data } = matter.read(latestVersion);\n if (data.version === version) {\n return latestVersion;\n }\n }\n\n return match;\n};\n\nexport const getFiles = async (pattern: string) => {\n try {\n const files = await glob(pattern, { ignore: 'node_modules/' });\n return files;\n } catch (error) {\n throw new Error(`Error finding files: ${error}`);\n }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n const idRegex = new RegExp(`^id:\\\\s['\"]?${id}['\"]?\\\\s$`, 'm');\n const versionRegex = new RegExp(`^version:\\\\s['\"]?${version}['\"]?\\\\s$`, 'm');\n\n const matches = await Promise.all(\n files.map(async (file) => {\n const content = await fs.readFile(file, 'utf-8');\n const hasIdMatch = content.match(idRegex);\n\n // Check version if provided\n if (version && !content.match(versionRegex)) {\n return undefined;\n }\n\n if (hasIdMatch) {\n return file;\n }\n })\n );\n\n return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/\n Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n /\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync \| CopyFilterSync) => {\n const tmpDirectory = join(catalogDir, 'tmp');\n await fs.mkdir(tmpDirectory, { recursive: true });\n\n // Copy everything over\n await copy(source, tmpDirectory, {\n overwrite: true,\n filter,\n });\n\n await copy(tmpDirectory, target, {\n overwrite: true,\n filter,\n });\n\n // Remove the tmp directory\n await fs.rm(tmpDirectory, { recursive: true });\n};\n","import fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport type { Command } from './types';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns a command from EventCatalog.\n \n You can optionally specify a version to get a specific version of the command\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getCommand } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the command\n * const command = await getCommand('UpdateInventory');\n \n // Gets a version of the command\n * const command = await getCommand('UpdateInventory', '0.0.1');\n * ```\n /\nexport const getCommand =\n (directory: string) =>\n async (id: string, version?: string): Promise<Command> =>\n getResource(directory, id, version, { type: 'command' }) as Promise<Command>;\n\n/\n Write a command to EventCatalog.\n \n You can optionally override the path of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeCommand } = utils('/path/to/eventcatalog');\n \n // Write a command to the catalog\n * // Command would be written to commands/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * });\n \n // Write a command to the catalog but override the path\n * // Command would be written to commands/Inventory/UpdateInventory\n * await writeCommand({\n * id: 'UpdateInventory',\n * name: 'Update Inventory',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/UpdateInventory\"});\n * ```\n /\nexport const writeCommand =\n (directory: string) =>\n async (command: Command, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...command }, { ...options, type: 'command' });\n\n/\n Delete a command at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmCommand } = utils('/path/to/eventcatalog');\n \n // removes a command at the given path (commands dir is appended to the given path)\n * // Removes the command at commands/UpdateInventory\n * await rmCommand('/UpdateInventory');\n * ```\n /\nexport const rmCommand = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete a command by it's id.\n \n Optionally specify a version to delete a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmCommandById } = utils('/path/to/eventcatalog');\n \n // deletes the latest UpdateInventory command\n * await rmCommandById('UpdateInventory');\n \n // deletes a specific version of the UpdateInventory command\n * await rmCommandById('UpdateInventory', '0.0.1');\n * ```\n /\nexport const rmCommandById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'command' });\n\n/\n Version a command by it's id.\n \n Takes the latest command and moves it to a versioned directory.\n * All files with this command are also versioned (e.g /commands/UpdateInventory/schema.json)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionCommand } = utils('/path/to/eventcatalog');\n \n // moves the latest UpdateInventory command to a versioned directory\n * // the version within that command is used as the version number.\n * await versionCommand('UpdateInventory');\n \n ```\n /\nexport const versionCommand = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Add a file to a command by it's id.\n \n Optionally specify a version to add a file to a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToCommand } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the UpdateInventory command\n * await addFileToCommand('UpdateInventory', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n /\nexport const addFileToCommand =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n\n/\n Add a schema to a command by it's id.\n \n Optionally specify a version to add a schema to a specific version of the command.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addSchemaToCommand } = utils('/path/to/eventcatalog');\n \n // JSON schema example\n * const schema = {\n * \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n * \"type\": \"object\",\n * \"properties\": {\n * \"name\": {\n * \"type\": \"string\"\n * },\n * \"age\": {\n * \"type\": \"number\"\n * }\n * },\n * \"required\": [\"name\", \"age\"]\n * };\n \n // adds a schema to the latest UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' });\n \n // adds a file to a specific version of the UpdateInventory command\n * await addSchemaToCommand('UpdateInventory', { schema, fileName: 'schema.json' }, '0.0.1');\n \n ```\n /\nexport const addSchemaToCommand =\n (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n };\n","import type { Service } from './types';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns a service from EventCatalog.\n \n You can optionally specify a version to get a specific version of the service\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getService } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the event\n * const service = await getService('InventoryService');\n \n // Gets a version of the event\n * const service = await getService('InventoryService', '0.0.1');\n * ```\n /\nexport const getService =\n (directory: string) =>\n async (id: string, version?: string): Promise<Service> =>\n getResource(directory, id, version, { type: 'service' }) as Promise<Service>;\n/\n Write an event to EventCatalog.\n \n You can optionally overide the path of the event.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeService } = utils('/path/to/eventcatalog');\n \n // Write a service\n * // Event would be written to services/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Service',\n * version: '0.0.1',\n * summary: 'Service that handles the inventory',\n * markdown: '# Hello world',\n * });\n \n // Write an event to the catalog but override the path\n * // Event would be written to services/Inventory/InventoryService\n * await writeService({\n * id: 'InventoryService',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryService\"});\n * ```\n /\nexport const writeService =\n (directory: string) =>\n async (service: Service, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...service }, { ...options, type: 'service' });\n\n/\n Version a service by it's id.\n \n Takes the latest service and moves it to a versioned directory.\n * All files with this service are also versioned. (e.g /services/InventoryService/openapi.yml)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionService } = utils('/path/to/eventcatalog');\n \n // moves the latest InventoryService service to a versioned directory\n * // the version within that service is used as the version number.\n * await versionService('InventoryService');\n \n ```\n /\nexport const versionService = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Delete a service at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmService } = utils('/path/to/eventcatalog');\n \n // Removes the service at services/InventoryService\n * await rmService('/InventoryService');\n * ```\n /\nexport const rmService = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete a service by it's id.\n \n Optionally specify a version to delete a specific version of the service.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmServiceById } = utils('/path/to/eventcatalog');\n \n // deletes the latest InventoryService event\n * await rmServiceById('InventoryService');\n \n // deletes a specific version of the InventoryService event\n * await rmServiceById('InventoryService', '0.0.1');\n * ```\n /\nexport const rmServiceById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'service' });\n\n/\n Add a file to a service by it's id.\n \n Optionally specify a version to add a file to a specific version of the service.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToService } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the InventoryService event\n * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n /\n\nexport const addFileToService =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n","import type { Domain } from './types';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { addFileToResource, getResource, rmResourceById, versionResource, writeResource } from './internal/resources';\n\n/\n Returns a domain from EventCatalog.\n \n You can optionally specify a version to get a specific version of the domain\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { getDomain } = utils('/path/to/eventcatalog');\n \n // Gets the latest version of the domain\n * const domain = await getDomain('Payment');\n \n // Gets a version of the domain\n * const domain = await getDomain('Payment', '0.0.1');\n * ```\n /\nexport const getDomain =\n (directory: string) =>\n async (id: string, version?: string): Promise<Domain> =>\n getResource(directory, id, version, { type: 'domain' }) as Promise<Domain>;\n/\n Write a domain to EventCatalog.\n \n You can optionally overide the path of the domain.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { writeDomain } = utils('/path/to/eventcatalog');\n \n // Write a domain\n * // Event would be written to domains/Payment\n * await writeDomain({\n * id: 'Payment',\n * name: 'Payment domain',\n * version: '0.0.1',\n * summary: 'Domain for all things to do with payments',\n * markdown: '# Hello world',\n * });\n \n // Write a domain to the catalog but override the path\n * // Event would be written to domains/Inventory/Payment\n * await writeDomain({\n * id: 'Payment',\n * name: 'Inventory Adjusted',\n * version: '0.0.1',\n * summary: 'This is a summary',\n * markdown: '# Hello world',\n * }, { path: \"/Inventory/Payment\"});\n * ```\n /\nexport const writeDomain =\n (directory: string) =>\n async (domain: Domain, options: { path: string } = { path: '' }) =>\n writeResource(directory, { ...domain }, { ...options, type: 'domain' });\n\n/\n Version a domain by it's id.\n \n Takes the latest domain and moves it to a versioned directory.\n * All files with this domain are also versioned. (e.g /domains/Payment/openapi.yml)\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { versionDomain } = utils('/path/to/eventcatalog');\n \n // moves the latest Payment domain to a versioned directory\n * // the version within that domain is used as the version number.\n * await versionDomain('Payment');\n \n ```\n /\nexport const versionDomain = (directory: string) => async (id: string) => versionResource(directory, id);\n\n/\n Delete a domain at it's given path.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmDomain } = utils('/path/to/eventcatalog');\n \n // Removes the domain at domains/Payment\n * await rmDomain('/Payment');\n * ```\n /\nexport const rmDomain = (directory: string) => async (path: string) => {\n await fs.rm(join(directory, path), { recursive: true });\n};\n\n/\n Delete a domain by it's id.\n \n Optionally specify a version to delete a specific version of the domain.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { rmDomainById } = utils('/path/to/eventcatalog');\n \n // deletes the latest Payment event\n * await rmDomainById('Payment');\n \n // deletes a specific version of the Payment event\n * await rmDomainById('Payment', '0.0.1');\n * ```\n /\nexport const rmDomainById = (directory: string) => async (id: string, version?: string) =>\n rmResourceById(directory, id, version, { type: 'domain' });\n\n/\n Add a file to a domain by it's id.\n \n Optionally specify a version to add a file to a specific version of the domain.\n \n @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n \n const { addFileToDomain } = utils('/path/to/eventcatalog');\n \n // adds a file to the latest Payment event\n * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' });\n \n // adds a file to a specific version of the Payment event\n * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n \n ```\n */\n\nexport const addFileToDomain =\n (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) =>\n addFileToResource(directory, id, file, version);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,oBAAqB;;;ACCrB,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;;;ACFrB,kBAA8B;;;ACA9B,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AACrB,yBAAmB;AAKZ,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAC7D,QAAM,gBAAgB,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAG7E,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AAGA,QAAM,QAAQ,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAG/E,MAAI,CAAC,SAAS,eAAe;AAC3B,UAAM,EAAE,KAAK,IAAI,mBAAAC,QAAO,KAAK,aAAa;AAC1C,QAAI,KAAK,YAAY,SAAS;AAC5B,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,mBAAe,uBAAK,YAAY,KAAK;AAC3C,QAAM,gBAAAA,QAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,YAAM,sBAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,YAAM,sBAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,gBAAAA,QAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;AD7FA,IAAAC,sBAAmB;AACnB,IAAAC,mBAAe;AAKR,IAAM,kBAAkB,OAAO,YAAoB,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,sBAAkB,qBAAQ,IAAI;AACpC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,oBAAAC,QAAO,KAAK,IAAI;AAC7D,QAAM,sBAAkB,kBAAK,iBAAiB,aAAa,OAAO;AAElE,QAAM,iBAAAC,QAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,YAAY,iBAAiB,iBAAiB,CAAC,QAAQ;AACnE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAM,iBAAAA,QAAG,QAAQ,eAAe,EAAE,KAAK,OAAO,kBAAkB;AAC9D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOC,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAM,iBAAAD,QAAG,OAAG,kBAAK,iBAAiBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC9D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAEO,IAAM,gBAAgB,OAC3B,YACA,UACA,UAA0C,EAAE,MAAM,IAAI,MAAM,GAAG,MAC5D;AAEH,QAAM,OAAO,QAAQ,QAAQ,IAAI,SAAS,EAAE;AAC5C,QAAM,SAAS,MAAM,cAAc,YAAY,SAAS,IAAI,SAAS,OAAO;AAE5E,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,mBAAmB,QAAQ,IAAI,mBAAmB,SAAS,OAAO,iBAAiB;AAAA,EACrG;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,oBAAAF,QAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAM,iBAAAC,QAAG,UAAM,kBAAK,YAAY,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,QAAM,iBAAAA,QAAG,cAAU,kBAAK,YAAY,MAAM,UAAU,GAAG,QAAQ;AACjE;AAEO,IAAM,cAAc,OACzB,YACA,IACA,SACA,YACsB;AACtB,QAAM,OAAO,MAAM,aAAa,YAAY,IAAI,OAAO;AAEvD,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR,MAAM,SAAS,QAAQ,UAAU,4BAA4B,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK;AAAA,IAC7G;AAEF,QAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAD,QAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAEO,IAAM,iBAAiB,OAAO,YAAoB,IAAY,SAAkB,YAA+B;AACpH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,MAAM,SAAS,QAAQ,UAAU,mBAAmB,EAAE,EAAE;AAAA,EAC1E;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAAS,iBAAAC,QAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAEO,IAAM,oBAAoB,OAC/B,YACA,IACA,MACA,YACG;AACH,QAAM,iBAAiB,MAAM,aAAa,YAAY,IAAI,OAAO;AAEjE,MAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,wCAAwC;AAE7E,QAAM,iBAAAA,QAAG,cAAU,sBAAK,qBAAQ,cAAc,GAAG,KAAK,QAAQ,GAAG,KAAK,OAAO;AAC/E;;;AD9EO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAkClD,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAC1D,cAAc,WAAW,EAAE,GAAG,MAAM,GAAG,EAAE,GAAG,SAAS,MAAM,QAAQ,CAAC;AAgBjE,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAM,iBAAAE,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YACnE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAoBnD,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqB/F,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;;;AG3LF,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;AAsBd,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAkCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAgBrE,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAoBrD,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAqBjG,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;AAoC3C,IAAM,qBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,iBAAiB,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACtG;;;ACvLF,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;AAqBd,IAAM,aACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAiCpD,IAAM,eACX,CAAC,cACD,OAAO,SAAkB,UAA4B,EAAE,MAAM,GAAG,MAC9D,cAAc,WAAW,EAAE,GAAG,QAAQ,GAAG,EAAE,GAAG,SAAS,MAAM,UAAU,CAAC;AAoBrE,IAAM,iBAAiB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAejG,IAAM,YAAY,CAAC,cAAsB,OAAO,SAAiB;AACtE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,gBAAgB,CAAC,cAAsB,OAAO,IAAY,YACrE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAsBrD,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;;;AC/IlD,IAAAC,mBAAe;AACf,IAAAC,oBAAqB;AAqBd,IAAM,YACX,CAAC,cACD,OAAO,IAAY,YACjB,YAAY,WAAW,IAAI,SAAS,EAAE,MAAM,SAAS,CAAC;AAiCnD,IAAM,cACX,CAAC,cACD,OAAO,QAAgB,UAA4B,EAAE,MAAM,GAAG,MAC5D,cAAc,WAAW,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,SAAS,MAAM,SAAS,CAAC;AAoBnE,IAAM,gBAAgB,CAAC,cAAsB,OAAO,OAAe,gBAAgB,WAAW,EAAE;AAehG,IAAM,WAAW,CAAC,cAAsB,OAAO,SAAiB;AACrE,QAAM,iBAAAC,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,eAAe,CAAC,cAAsB,OAAO,IAAY,YACpE,eAAe,WAAW,IAAI,SAAS,EAAE,MAAM,SAAS,CAAC;AAsBpD,IAAM,kBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YACrF,kBAAkB,WAAW,IAAI,MAAM,OAAO;;;AN5HlD,IAAO,cAAQ,CAAC,SAAiB;AAC/B,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOL,UAAU,aAAS,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvC,YAAY,eAAW,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,SAAS,YAAQ,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrC,aAAa,gBAAY,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,cAAc,iBAAa,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ/C,gBAAgB,mBAAe,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAcvD,YAAY,eAAW,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQ7C,cAAc,iBAAa,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,WAAW,cAAU,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,eAAe,kBAAc,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAKnD,gBAAgB,mBAAe,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQrD,kBAAkB,qBAAiB,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQzD,oBAAoB,uBAAmB,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAe7D,cAAc,iBAAa,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOjD,YAAY,eAAW,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7C,gBAAgB,mBAAe,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOrD,WAAW,cAAU,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,eAAe,kBAAc,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQnD,kBAAkB,qBAAiB,wBAAK,MAAM,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAezD,aAAa,gBAAY,wBAAK,MAAM,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO9C,WAAW,cAAU,wBAAK,MAAM,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK1C,eAAe,kBAAc,wBAAK,MAAM,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOlD,UAAU,aAAS,wBAAK,MAAM,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOxC,cAAc,iBAAa,wBAAK,MAAM,SAAS,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQhD,iBAAiB,oBAAgB,wBAAK,MAAM,SAAS,CAAC;AAAA,EACxD;AACF;","names":["import_node_path","import_promises","import_node_path","matter","fs","import_gray_matter","import_promises","matter","fs","file","fs","import_promises","import_node_path","fs","import_promises","import_node_path","fs","import_promises","import_node_path","fs"]}

package/dist/index.mjs CHANGED Viewed

@@ -1,5 +1,5 @@
 // src/index.ts
-import { join as join6 } from "path";
+import { join as join7 } from "path";
 // src/events.ts
 import fs3 from "fs/promises";
@@ -13,6 +13,7 @@ import { glob } from "glob";
 import fs from "fs/promises";
 import { copy } from "fs-extra";
 import { join } from "path";
+import matter from "gray-matter";
 var versionExists = async (catalogDir, id, version) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id, version) || [];
@@ -21,10 +22,18 @@ var versionExists = async (catalogDir, id, version) => {
 var findFileById = async (catalogDir, id, version) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id) || [];
+  const latestVersion = matchedFiles.find((path) => !path.includes("versioned"));
   if (!version) {
-    return matchedFiles.find((path) => !path.includes("versioned"));
+    return latestVersion;
+  }
+  const match = matchedFiles.find((path) => path.includes(`versioned/${version}`));
+  if (!match && latestVersion) {
+    const { data } = matter.read(latestVersion);
+    if (data.version === version) {
+      return latestVersion;
+    }
   }
-  return matchedFiles.find((path) => path.includes(`versioned/${version}`));
+  return match;
 };
 var getFiles = async (pattern) => {
   try {
@@ -66,7 +75,7 @@ var copyDir = async (catalogDir, source, target, filter) => {
 };
 // src/internal/resources.ts
-import matter from "gray-matter";
+import matter2 from "gray-matter";
 import fs2 from "fs/promises";
 var versionResource = async (catalogDir, id) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
@@ -76,7 +85,7 @@ var versionResource = async (catalogDir, id) => {
   }
   const file = matchedFiles[0];
   const sourceDirectory = dirname(file);
-  const { data: { version = "0.0.1" } = {} } = matter.read(file);
+  const { data: { version = "0.0.1" } = {} } = matter2.read(file);
   const targetDirectory = join2(sourceDirectory, "versioned", version);
   await fs2.mkdir(targetDirectory, { recursive: true });
   await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
@@ -99,7 +108,7 @@ var writeResource = async (catalogDir, resource, options = { path: "", type: ""
     throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  const document = matter.stringify(markdown.trim(), frontmatter);
+  const document = matter2.stringify(markdown.trim(), frontmatter);
   await fs2.mkdir(join2(catalogDir, path), { recursive: true });
   await fs2.writeFile(join2(catalogDir, path, "index.md"), document);
 };
@@ -109,7 +118,7 @@ var getResource = async (catalogDir, id, version, options) => {
     throw new Error(
       `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
     );
-  const { data, content } = matter.read(file);
+  const { data, content } = matter2.read(file);
   return {
     ...data,
     markdown: content.trim()
@@ -169,6 +178,18 @@ var rmService = (directory) => async (path) => {
 var rmServiceById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "service" });
 var addFileToService = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+// src/domains.ts
+import fs6 from "fs/promises";
+import { join as join6 } from "path";
+var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
+var writeDomain = (directory) => async (domain, options = { path: "" }) => writeResource(directory, { ...domain }, { ...options, type: "domain" });
+var versionDomain = (directory) => async (id) => versionResource(directory, id);
+var rmDomain = (directory) => async (path) => {
+  await fs6.rm(join6(directory, path), { recursive: true });
+};
+var rmDomainById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "domain" });
+var addFileToDomain = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
 // src/index.ts
 var src_default = (path) => {
   return {
@@ -178,7 +199,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get
      * @returns
      */
-    getEvent: getEvent(join6(path, "events")),
+    getEvent: getEvent(join7(path, "events")),
     /**
      * Adds an event to EventCatalog
      *
@@ -186,26 +207,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join6(path, "events")),
+    writeEvent: writeEvent(join7(path, "events")),
     /**
      * 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(join6(path, "events")),
+    rmEvent: rmEvent(join7(path, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join6(path, "events")),
+    rmEventById: rmEventById(join7(path, "events")),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join6(path, "events")),
+    versionEvent: versionEvent(join7(path, "events")),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -213,7 +234,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join6(path, "events")),
+    addFileToEvent: addFileToEvent(join7(path, "events")),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -221,7 +242,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join6(path, "events")),
+    addSchemaToEvent: addSchemaToEvent(join7(path, "events")),
     /**
      * ================================
      *            Commands
@@ -233,7 +254,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get
      * @returns
      */
-    getCommand: getCommand(join6(path, "commands")),
+    getCommand: getCommand(join7(path, "commands")),
     /**
      * Adds an command to EventCatalog
      *
@@ -241,26 +262,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join6(path, "commands")),
+    writeCommand: writeCommand(join7(path, "commands")),
     /**
      * 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(join6(path, "commands")),
+    rmCommand: rmCommand(join7(path, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join6(path, "commands")),
+    rmCommandById: rmCommandById(join7(path, "commands")),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join6(path, "commands")),
+    versionCommand: versionCommand(join7(path, "commands")),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -268,7 +289,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join6(path, "commands")),
+    addFileToCommand: addFileToCommand(join7(path, "commands")),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -276,7 +297,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join6(path, "commands")),
+    addSchemaToCommand: addSchemaToCommand(join7(path, "commands")),
     /**
      * ================================
      *            SERVICES
@@ -289,33 +310,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join6(path, "services")),
+    writeService: writeService(join7(path, "services")),
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
      * @param version - Optional id of the version to get
      * @returns
      */
-    getService: getService(join6(path, "services")),
+    getService: getService(join7(path, "services")),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join6(path, "services")),
+    versionService: versionService(join7(path, "services")),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService(join6(path, "services")),
+    rmService: rmService(join7(path, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join6(path, "services")),
+    rmServiceById: rmServiceById(join7(path, "services")),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -323,7 +344,54 @@ var src_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join6(path, "services"))
+    addFileToService: addFileToService(join7(path, "services")),
+    /**
+     * ================================
+     *            Domains
+     * ================================
+     */
+    /**
+     * Adds a domain to EventCatalog
+     *
+     * @param domain - The domain to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeDomain: writeDomain(join7(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
+     * @returns
+     */
+    getDomain: getDomain(join7(path, "domains")),
+    /**
+     * Moves a given domain id to the version directory
+     * @param directory
+     */
+    versionDomain: versionDomain(join7(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(join7(path, "domains")),
+    /**
+     * Remove an service by an domain id
+     *
+     * @param id - The id of the domain you want to remove
+     *
+     */
+    rmDomainById: rmDomainById(join7(path, "domains")),
+    /**
+     * Adds a file to the given domain
+     * @param id - The id of the domain to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the domain to add the file to
+     * @returns
+     */
+    addFileToDomain: addFileToDomain(join7(path, "domains"))
   };
 };
 export {