@eventcatalog/sdk 0.0.4 → 0.0.6

package/dist/events.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/events.ts","../src/internal/utils.ts"],"sourcesContent":["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';\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 * cont event = await getEvent('InventoryAdjusted');\n *\n * // Gets a version of the event\n * cont event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const getEvent =\n  (directory: string) =>\n  async (id: string, version?: string): Promise<Event> => {\n    const file = await findFileById(directory, id, version);\n\n    if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ''));\n\n    const { data, content } = matter.read(file);\n\n    return {\n      ...data,\n      markdown: content.trim(),\n    } as Event;\n  };\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    // Get the path\n    const path = options.path || `/${event.id}`;\n    const exists = await versionExists(directory, event.id, event.version);\n\n    if (exists) {\n      throw new Error(`Failed to write event as the version ${event.version} already exists`);\n    }\n\n    const { markdown, ...frontmatter } = event;\n    const document = matter.stringify(markdown.trim(), frontmatter);\n    await fs.mkdir(join(directory, path), { recursive: true });\n    await fs.writeFile(join(directory, path, 'index.md'), document);\n  };\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  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/index.md`);\n\n  const matchedFiles = await searchFilesForId(files, id, version);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No event found with id: ${id}`);\n  }\n\n  await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\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) => {\n  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/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 eventDirectory = dirname(file);\n  const { data: { version = '0.0.1' } = {} } = matter.read(file);\n  const targetDirectory = join(eventDirectory, 'versioned', version);\n\n  await fs.mkdir(targetDirectory, { recursive: true });\n\n  // Copy the event to the versioned directory\n  await copyDir(directory, eventDirectory, 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(eventDirectory).then(async (resourceFiles) => {\n    await Promise.all(\n      resourceFiles.map(async (file) => {\n        if (file !== 'versioned') {\n          await fs.rm(join(eventDirectory, file), { recursive: true });\n        }\n      })\n    );\n  });\n};\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    const pathToEvent = await findFileById(directory, id, version);\n    if (!pathToEvent) throw new Error('Cannot find directory to write file to');\n    const contentDirectory = dirname(pathToEvent);\n    await fs.writeFile(join(contentDirectory, file.fileName), file.content);\n  };\n\n/**\n * Add a schema to an event by it's id.\n *\n * Optionally specify a version to add a schame 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 { 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"],"mappings":";AAAA,OAAO,YAAY;AACnB,OAAOA,SAAQ;AACf,SAAS,QAAAC,aAAY;AACrB,SAAS,eAAe;;;ACHxB,SAAS,YAAY;AACrB,OAAO,QAAQ;AACf,SAAS,YAA6C;AACtD,SAAS,YAAY;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,MAAM,KAAK,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,GAAG,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,eAAe,KAAK,YAAY,KAAK;AAC3C,QAAM,GAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,QAAM,KAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,QAAM,KAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,GAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;AD1DO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YAAqC;AACtD,QAAM,OAAO,MAAM,aAAa,WAAW,IAAI,OAAO;AAEtD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,oCAAoC,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK,GAAG;AAEhH,QAAM,EAAE,MAAM,QAAQ,IAAI,OAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAkCK,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAAM;AAEhE,QAAM,OAAO,QAAQ,QAAQ,IAAI,MAAM,EAAE;AACzC,QAAM,SAAS,MAAM,cAAc,WAAW,MAAM,IAAI,MAAM,OAAO;AAErE,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,wCAAwC,MAAM,OAAO,iBAAiB;AAAA,EACxF;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,OAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAMC,IAAG,MAAMC,MAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACzD,QAAMD,IAAG,UAAUC,MAAK,WAAW,MAAM,UAAU,GAAG,QAAQ;AAChE;AAgBK,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAMD,IAAG,GAAGC,MAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YAAqB;AAExF,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AAEvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAASD,IAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAoBO,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AACvD,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,iBAAiB,QAAQ,IAAI;AACnC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,OAAO,KAAK,IAAI;AAC7D,QAAM,kBAAkBC,MAAK,gBAAgB,aAAa,OAAO;AAEjE,QAAMD,IAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,WAAW,gBAAgB,iBAAiB,CAAC,QAAQ;AACjE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAMA,IAAG,QAAQ,cAAc,EAAE,KAAK,OAAO,kBAAkB;AAC7D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOE,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAMF,IAAG,GAAGC,MAAK,gBAAgBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAqBO,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YAAqB;AAC1G,QAAM,cAAc,MAAM,aAAa,WAAW,IAAI,OAAO;AAC7D,MAAI,CAAC,YAAa,OAAM,IAAI,MAAM,wCAAwC;AAC1E,QAAM,mBAAmB,QAAQ,WAAW;AAC5C,QAAMF,IAAG,UAAUC,MAAK,kBAAkB,KAAK,QAAQ,GAAG,KAAK,OAAO;AACxE;AAoCK,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;","names":["fs","join","fs","join","file"]}
+{"version":3,"sources":["../src/events.ts","../src/internal/resources.ts","../src/internal/utils.ts"],"sourcesContent":["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"],"mappings":";AACA,OAAOA,SAAQ;AACf,SAAS,QAAAC,aAAY;;;ACFrB,SAAS,SAAS,QAAAC,aAAY;;;ACA9B,SAAS,YAAY;AACrB,OAAO,QAAQ;AACf,SAAS,YAA6C;AACtD,SAAS,YAAY;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,MAAM,KAAK,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,GAAG,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,eAAe,KAAK,YAAY,KAAK;AAC3C,QAAM,GAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,QAAM,KAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,QAAM,KAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,GAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;ADjFA,OAAO,YAAY;AACnB,OAAOC,SAAQ;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,kBAAkB,QAAQ,IAAI;AACpC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,OAAO,KAAK,IAAI;AAC7D,QAAM,kBAAkBC,MAAK,iBAAiB,aAAa,OAAO;AAElE,QAAMD,IAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,YAAY,iBAAiB,iBAAiB,CAAC,QAAQ;AACnE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAMA,IAAG,QAAQ,eAAe,EAAE,KAAK,OAAO,kBAAkB;AAC9D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOE,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAMF,IAAG,GAAGC,MAAK,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,OAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAMF,IAAG,MAAMC,MAAK,YAAY,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,QAAMD,IAAG,UAAUC,MAAK,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,OAAO,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,SAASD,IAAG,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,QAAMA,IAAG,UAAUC,MAAK,QAAQ,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,QAAME,IAAG,GAAGC,MAAK,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;","names":["fs","join","join","fs","join","file","fs","join"]}

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Service } from './types.d.mjs';
+import { Event, Command, Service } from './types.d.mjs';
 
 /**
  * Init the SDK for EventCatalog
@@ -65,6 +65,69 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Commands
+     * ================================
+     */
+    /**
+     * Returns a command from EventCatalog
+     * @param id - The id of the command to retrieve
+     * @param version - Optional id of the version to get
+     * @returns
+     */
+    getCommand: (id: string, version?: string) => Promise<Command>;
+    /**
+     * Adds an command to EventCatalog
+     *
+     * @param command - The command to write
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommand: (command: Command, options?: {
+        path: string;
+    }) => Promise<void>;
+    /**
+     * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmCommand: (path: string) => Promise<void>;
+    /**
+     * Remove an command by an Event id
+     *
+     * @param id - The id of the command you want to remove
+     *
+     */
+    rmCommandById: (id: string, version?: string) => Promise<void>;
+    /**
+     * Moves a given command id to the version directory
+     * @param directory
+     */
+    versionCommand: (id: string) => Promise<void>;
+    /**
+     * Adds a file to the given command
+     * @param id - The id of the command to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the command to add the file to
+     * @returns
+     */
+    addFileToCommand: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds a schema to the given command
+     * @param id - The id of the command to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the command to add the schema to
+     * @returns
+     */
+    addSchemaToCommand: (id: string, schema: {
+        schema: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
     /**
      * ================================
      *            SERVICES

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Event, Service } from './types.d.js';
+import { Event, Command, Service } from './types.d.js';
 
 /**
  * Init the SDK for EventCatalog
@@ -65,6 +65,69 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Commands
+     * ================================
+     */
+    /**
+     * Returns a command from EventCatalog
+     * @param id - The id of the command to retrieve
+     * @param version - Optional id of the version to get
+     * @returns
+     */
+    getCommand: (id: string, version?: string) => Promise<Command>;
+    /**
+     * Adds an command to EventCatalog
+     *
+     * @param command - The command to write
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommand: (command: Command, options?: {
+        path: string;
+    }) => Promise<void>;
+    /**
+     * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
+     *
+     */
+    rmCommand: (path: string) => Promise<void>;
+    /**
+     * Remove an command by an Event id
+     *
+     * @param id - The id of the command you want to remove
+     *
+     */
+    rmCommandById: (id: string, version?: string) => Promise<void>;
+    /**
+     * Moves a given command id to the version directory
+     * @param directory
+     */
+    versionCommand: (id: string) => Promise<void>;
+    /**
+     * Adds a file to the given command
+     * @param id - The id of the command to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the command to add the file to
+     * @returns
+     */
+    addFileToCommand: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Adds a schema to the given command
+     * @param id - The id of the command to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the command to add the schema to
+     * @returns
+     */
+    addSchemaToCommand: (id: string, schema: {
+        schema: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
     /**
      * ================================
      *            SERVICES

package/dist/index.js

@@ -36,10 +36,11 @@ module.exports = __toCommonJS(src_exports);
 var import_node_path5 = require("path");
 
 // src/events.ts
-var import_gray_matter = __toESM(require("gray-matter"));
-var import_promises2 = __toESM(require("fs/promises"));
+var import_promises3 = __toESM(require("fs/promises"));
 var import_node_path2 = require("path");
-var import_node_path3 = require("path");
+
+// src/internal/resources.ts
+var import_path = require("path");
 
 // src/internal/utils.ts
 var import_glob = require("glob");
@@ -98,138 +99,110 @@ var copyDir = async (catalogDir, source, target, filter) => {
   await import_promises.default.rm(tmpDirectory, { recursive: true });
 };
 
-// src/events.ts
-var getEvent = (directory) => async (id, version) => {
-  const file = await findFileById(directory, id, version);
-  if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
-  const { data, content } = import_gray_matter.default.read(file);
-  return {
-    ...data,
-    markdown: content.trim()
-  };
-};
-var writeEvent = (directory) => async (event, options = { path: "" }) => {
-  const path = options.path || `/${event.id}`;
-  const exists = await versionExists(directory, event.id, event.version);
-  if (exists) {
-    throw new Error(`Failed to write event as the version ${event.version} already exists`);
-  }
-  const { markdown, ...frontmatter } = event;
-  const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
-  await import_promises2.default.mkdir((0, import_node_path2.join)(directory, path), { recursive: true });
-  await import_promises2.default.writeFile((0, import_node_path2.join)(directory, path, "index.md"), document);
-};
-var rmEvent = (directory) => async (path) => {
-  await import_promises2.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
-};
-var rmEventById = (directory) => async (id, version) => {
-  const files = await getFiles(`${directory}/**/index.md`);
-  const matchedFiles = await searchFilesForId(files, id, version);
-  if (matchedFiles.length === 0) {
-    throw new Error(`No event found with id: ${id}`);
-  }
-  await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
-};
-var versionEvent = (directory) => async (id) => {
-  const files = await getFiles(`${directory}/**/index.md`);
+// src/internal/resources.ts
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_promises2 = __toESM(require("fs/promises"));
+var versionResource = async (catalogDir, id) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id);
   if (matchedFiles.length === 0) {
     throw new Error(`No event found with id: ${id}`);
   }
   const file = matchedFiles[0];
-  const eventDirectory = (0, import_node_path3.dirname)(file);
+  const sourceDirectory = (0, import_path.dirname)(file);
   const { data: { version = "0.0.1" } = {} } = import_gray_matter.default.read(file);
-  const targetDirectory = (0, import_node_path2.join)(eventDirectory, "versioned", version);
+  const targetDirectory = (0, import_path.join)(sourceDirectory, "versioned", version);
   await import_promises2.default.mkdir(targetDirectory, { recursive: true });
-  await copyDir(directory, eventDirectory, targetDirectory, (src) => {
+  await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
     return !src.includes("versioned");
   });
-  await import_promises2.default.readdir(eventDirectory).then(async (resourceFiles) => {
+  await import_promises2.default.readdir(sourceDirectory).then(async (resourceFiles) => {
     await Promise.all(
       resourceFiles.map(async (file2) => {
         if (file2 !== "versioned") {
-          await import_promises2.default.rm((0, import_node_path2.join)(eventDirectory, file2), { recursive: true });
+          await import_promises2.default.rm((0, import_path.join)(sourceDirectory, file2), { recursive: true });
         }
       })
     );
   });
 };
-var addFileToEvent = (directory) => async (id, file, version) => {
-  const pathToEvent = await findFileById(directory, id, version);
-  if (!pathToEvent) throw new Error("Cannot find directory to write file to");
-  const contentDirectory = (0, import_node_path3.dirname)(pathToEvent);
-  await import_promises2.default.writeFile((0, import_node_path2.join)(contentDirectory, file.fileName), file.content);
-};
-var addSchemaToEvent = (directory) => async (id, schema, version) => {
-  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+var writeResource = async (catalogDir, resource, options = { path: "", type: "" }) => {
+  const path = options.path || `/${resource.id}`;
+  const exists = await versionExists(catalogDir, resource.id, resource.version);
+  if (exists) {
+    throw new Error(`Failed to write ${options.type} as the version ${resource.version} already exists`);
+  }
+  const { markdown, ...frontmatter } = resource;
+  const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
+  await import_promises2.default.mkdir((0, import_path.join)(catalogDir, path), { recursive: true });
+  await import_promises2.default.writeFile((0, import_path.join)(catalogDir, path, "index.md"), document);
 };
-
-// src/services.ts
-var import_gray_matter2 = __toESM(require("gray-matter"));
-var import_promises3 = __toESM(require("fs/promises"));
-var import_node_path4 = require("path");
-var getService = (directory) => async (id, version) => {
-  const file = await findFileById(directory, id, version);
-  if (!file) throw new Error(`No service found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
-  const { data, content } = import_gray_matter2.default.read(file);
+var getResource = async (catalogDir, id, version, options) => {
+  const file = await findFileById(catalogDir, id, version);
+  if (!file)
+    throw new Error(
+      `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
+    );
+  const { data, content } = import_gray_matter.default.read(file);
   return {
     ...data,
     markdown: content.trim()
   };
 };
-var writeService = (directory) => async (service, options = { path: "" }) => {
-  const path = options.path || `/${service.id}`;
-  const exists = await versionExists(directory, service.id, service.version);
-  if (exists) {
-    throw new Error(`Failed to write service as the version ${service.version} already exists`);
-  }
-  const { markdown, ...frontmatter } = service;
-  const document = import_gray_matter2.default.stringify(markdown.trim(), frontmatter);
-  await import_promises3.default.mkdir((0, import_node_path4.join)(directory, path), { recursive: true });
-  await import_promises3.default.writeFile((0, import_node_path4.join)(directory, path, "index.md"), document);
-};
-var versionService = (directory) => async (id) => {
-  const files = await getFiles(`${directory}/**/index.md`);
-  const matchedFiles = await searchFilesForId(files, id);
+var rmResourceById = async (catalogDir, id, version, options) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id, version);
   if (matchedFiles.length === 0) {
-    throw new Error(`No service found with id: ${id}`);
+    throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
   }
-  const file = matchedFiles[0];
-  const eventDirectory = (0, import_node_path4.dirname)(file);
-  const { data: { version = "0.0.1" } = {} } = import_gray_matter2.default.read(file);
-  const targetDirectory = (0, import_node_path4.join)(eventDirectory, "versioned", version);
-  await import_promises3.default.mkdir(targetDirectory, { recursive: true });
-  await copyDir(directory, eventDirectory, targetDirectory, (src) => {
-    return !src.includes("versioned");
-  });
-  await import_promises3.default.readdir(eventDirectory).then(async (resourceFiles) => {
-    await Promise.all(
-      resourceFiles.map(async (file2) => {
-        if (file2 !== "versioned") {
-          await import_promises3.default.rm((0, import_node_path4.join)(eventDirectory, file2), { recursive: true });
-        }
-      })
-    );
-  });
+  await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
 };
-var rmService = (directory) => async (path) => {
-  await import_promises3.default.rm((0, import_node_path4.join)(directory, path), { recursive: true });
+var addFileToResource = async (catalogDir, id, file, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find directory to write file to");
+  await import_promises2.default.writeFile((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), file.content);
 };
-var rmServiceById = (directory) => async (id, version) => {
-  const files = await getFiles(`${directory}/**/index.md`);
-  const matchedFiles = await searchFilesForId(files, id, version);
-  if (matchedFiles.length === 0) {
-    throw new Error(`No service found with id: ${id}`);
-  }
-  await Promise.all(matchedFiles.map((file) => import_promises3.default.rm(file)));
+
+// src/events.ts
+var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
+var writeEvent = (directory) => async (event, options = { path: "" }) => writeResource(directory, { ...event }, { ...options, type: "event" });
+var rmEvent = (directory) => async (path) => {
+  await import_promises3.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
+};
+var rmEventById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "event" });
+var versionEvent = (directory) => async (id) => versionResource(directory, id);
+var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToEvent = (directory) => async (id, schema, version) => {
+  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
 };
-var addFileToService = (directory) => async (id, file, version) => {
-  const pathToEvent = await findFileById(directory, id, version);
-  if (!pathToEvent) throw new Error("Cannot find directory to write file to");
-  const contentDirectory = (0, import_node_path4.dirname)(pathToEvent);
-  await import_promises3.default.writeFile((0, import_node_path4.join)(contentDirectory, file.fileName), file.content);
+
+// src/commands.ts
+var import_promises4 = __toESM(require("fs/promises"));
+var import_node_path3 = require("path");
+var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
+var writeCommand = (directory) => async (command, options = { path: "" }) => writeResource(directory, { ...command }, { ...options, type: "command" });
+var rmCommand = (directory) => async (path) => {
+  await import_promises4.default.rm((0, import_node_path3.join)(directory, path), { recursive: true });
+};
+var rmCommandById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "command" });
+var versionCommand = (directory) => async (id) => versionResource(directory, id);
+var addFileToCommand = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToCommand = (directory) => async (id, schema, version) => {
+  await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
 };
 
+// src/services.ts
+var import_promises5 = __toESM(require("fs/promises"));
+var import_node_path4 = require("path");
+var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
+var writeService = (directory) => async (service, options = { path: "" }) => writeResource(directory, { ...service }, { ...options, type: "service" });
+var versionService = (directory) => async (id) => versionResource(directory, id);
+var rmService = (directory) => async (path) => {
+  await import_promises5.default.rm((0, import_node_path4.join)(directory, path), { recursive: true });
+};
+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/index.ts
 var src_default = (path) => {
   return {
@@ -283,6 +256,61 @@ var src_default = (path) => {
      * @returns
      */
     addSchemaToEvent: addSchemaToEvent((0, import_node_path5.join)(path, "events")),
+    /**
+     * ================================
+     *            Commands
+     * ================================
+     */
+    /**
+     * Returns a command from EventCatalog
+     * @param id - The id of the command to retrieve
+     * @param version - Optional id of the version to get
+     * @returns
+     */
+    getCommand: getCommand((0, import_node_path5.join)(path, "commands")),
+    /**
+     * Adds an command to EventCatalog
+     *
+     * @param command - The command to write
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommand: writeCommand((0, import_node_path5.join)(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((0, import_node_path5.join)(path, "commands")),
+    /**
+     * Remove an command by an Event id
+     *
+     * @param id - The id of the command you want to remove
+     *
+     */
+    rmCommandById: rmCommandById((0, import_node_path5.join)(path, "commands")),
+    /**
+     * Moves a given command id to the version directory
+     * @param directory
+     */
+    versionCommand: versionCommand((0, import_node_path5.join)(path, "commands")),
+    /**
+     * Adds a file to the given command
+     * @param id - The id of the command to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the command to add the file to
+     * @returns
+     */
+    addFileToCommand: addFileToCommand((0, import_node_path5.join)(path, "commands")),
+    /**
+     * Adds a schema to the given command
+     * @param id - The id of the command to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the command to add the schema to
+     * @returns
+     */
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path5.join)(path, "commands")),
     /**
      * ================================
      *            SERVICES