@eventcatalog/sdk 0.0.5 → 0.0.7

package/dist/services.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/services.ts","../src/internal/resources.ts","../src/internal/utils.ts"],"sourcesContent":["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 * cont event = await getService('InventoryService');\n *\n * // Gets a version of the event\n * cont event = 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 { 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":";AAGA,OAAOA,SAAQ;AACf,SAAkB,QAAAC,aAAY;;;ACJ9B,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;;;AD/EO,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,QAAME,IAAG,GAAGC,MAAK,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;","names":["fs","join","join","fs","join","file","fs","join"]}
+{"version":3,"sources":["../src/services.ts","../src/internal/resources.ts","../src/internal/utils.ts"],"sourcesContent":["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 { 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;;;ADjFO,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,QAAME,IAAG,GAAGC,MAAK,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;","names":["fs","join","join","fs","join","file","fs","join"]}

package/dist/types.d.d.mts

@@ -25,6 +25,10 @@ interface Service extends BaseSchema {
   receives?: ResourcePointer[];
 }
 
+interface Domain extends BaseSchema {
+  services?: ResourcePointer[];
+}
+
 interface Team {
   id: string;
   name: string;
@@ -58,4 +62,4 @@ interface Badge {
   textColor: string;
 }
 
-export type { Badge, BaseSchema, Command, Event, Message, ResourcePointer, Service, Team, User };
+export type { Badge, BaseSchema, Command, Domain, Event, Message, ResourcePointer, Service, Team, User };

package/dist/types.d.d.ts

@@ -25,6 +25,10 @@ interface Service extends BaseSchema {
   receives?: ResourcePointer[];
 }
 
+interface Domain extends BaseSchema {
+  services?: ResourcePointer[];
+}
+
 interface Team {
   id: string;
   name: string;
@@ -58,4 +62,4 @@ interface Badge {
   textColor: string;
 }
 
-export type { Badge, BaseSchema, Command, Event, Message, ResourcePointer, Service, Team, User };
+export type { Badge, BaseSchema, Command, Domain, Event, Message, ResourcePointer, Service, Team, User };

package/dist/types.d.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["// Base type for all resources (domains, services and messages)\nexport interface BaseSchema {\n  id: string;\n  name: string;\n  summary?: string;\n  version: string;\n  badges?: Badge[];\n  owners?: string[];\n  schemaPath?: string;\n  markdown: string;\n}\n\nexport type ResourcePointer = {\n  id: string;\n  version: string;\n};\n\nexport type Message = Event | Command;\n\nenum ResourceType {\n  Service = 'service',\n  Event = 'event',\n  Command = 'command',\n}\n\nexport interface Event extends BaseSchema {}\nexport interface Command extends BaseSchema {}\n\nexport interface Service extends BaseSchema {\n  sends?: ResourcePointer[];\n  receives?: ResourcePointer[];\n}\n\nexport interface Team {\n  id: string;\n  name: string;\n  summary?: string;\n  email?: string;\n  hidden?: boolean;\n  slackDirectMessageUrl?: string;\n  members?: User[];\n  ownedCommands?: Command[];\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n}\n\nexport interface User {\n  id: string;\n  name: string;\n  avatarUrl: string;\n  role?: string;\n  hidden?: boolean;\n  email?: string;\n  slackDirectMessageUrl?: string;\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n  ownedCommands?: Command[];\n  associatedTeams?: Team[];\n}\n\nexport interface Badge {\n  content: string;\n  backgroundColor: string;\n  textColor: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["// Base type for all resources (domains, services and messages)\nexport interface BaseSchema {\n  id: string;\n  name: string;\n  summary?: string;\n  version: string;\n  badges?: Badge[];\n  owners?: string[];\n  schemaPath?: string;\n  markdown: string;\n}\n\nexport type ResourcePointer = {\n  id: string;\n  version: string;\n};\n\nexport type Message = Event | Command;\n\nenum ResourceType {\n  Service = 'service',\n  Event = 'event',\n  Command = 'command',\n}\n\nexport interface Event extends BaseSchema {}\nexport interface Command extends BaseSchema {}\n\nexport interface Service extends BaseSchema {\n  sends?: ResourcePointer[];\n  receives?: ResourcePointer[];\n}\n\nexport interface Domain extends BaseSchema {\n  services?: ResourcePointer[];\n}\n\nexport interface Team {\n  id: string;\n  name: string;\n  summary?: string;\n  email?: string;\n  hidden?: boolean;\n  slackDirectMessageUrl?: string;\n  members?: User[];\n  ownedCommands?: Command[];\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n}\n\nexport interface User {\n  id: string;\n  name: string;\n  avatarUrl: string;\n  role?: string;\n  hidden?: boolean;\n  email?: string;\n  slackDirectMessageUrl?: string;\n  ownedServices?: Service[];\n  ownedEvents?: Event[];\n  ownedCommands?: Command[];\n  associatedTeams?: Team[];\n}\n\nexport interface Badge {\n  content: string;\n  backgroundColor: string;\n  textColor: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventcatalog/sdk",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "SDK to integrate with EventCatalog",
   "publishConfig": {
     "access": "public"