@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/custom-docs.js

@@ -1,164 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/custom-docs.ts
-var custom_docs_exports = {};
-__export(custom_docs_exports, {
-  getCustomDoc: () => getCustomDoc,
-  getCustomDocs: () => getCustomDocs,
-  rmCustomDoc: () => rmCustomDoc,
-  writeCustomDoc: () => writeCustomDoc
-});
-module.exports = __toCommonJS(custom_docs_exports);
-var import_node_path4 = __toESM(require("path"));
-
-// src/internal/utils.ts
-var import_glob = require("glob");
-var import_node_fs = __toESM(require("fs"));
-var import_fs_extra = require("fs-extra");
-var import_node_path = require("path");
-var import_gray_matter = __toESM(require("gray-matter"));
-var import_semver = require("semver");
-var getFiles = async (pattern, ignore = "") => {
-  try {
-    const normalizedInputPattern = (0, import_node_path.normalize)(pattern);
-    const absoluteBaseDir = (0, import_node_path.resolve)(
-      normalizedInputPattern.includes("**") ? normalizedInputPattern.split("**")[0] : (0, import_node_path.dirname)(normalizedInputPattern)
-    );
-    let relativePattern = (0, import_node_path.relative)(absoluteBaseDir, normalizedInputPattern);
-    relativePattern = relativePattern.replace(/\\/g, "/");
-    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];
-    const files = (0, import_glob.globSync)(relativePattern, {
-      cwd: absoluteBaseDir,
-      ignore: ["node_modules/**", ...ignoreList],
-      absolute: true,
-      nodir: true
-    });
-    return files.map(import_node_path.normalize);
-  } catch (error) {
-    const absoluteBaseDirForError = (0, import_node_path.resolve)(
-      (0, import_node_path.normalize)(pattern).includes("**") ? (0, import_node_path.normalize)(pattern).split("**")[0] : (0, import_node_path.dirname)((0, import_node_path.normalize)(pattern))
-    );
-    const relativePatternForError = (0, import_node_path.relative)(absoluteBaseDirForError, (0, import_node_path.normalize)(pattern)).replace(/\\/g, "/");
-    throw new Error(
-      `Error finding files for pattern "${pattern}" (using cwd: "${absoluteBaseDirForError}", globPattern: "${relativePatternForError}"): ${error.message}`
-    );
-  }
-};
-var readMdxFile = async (path3) => {
-  const { data } = import_gray_matter.default.read(path3);
-  const { markdown, ...frontmatter } = data;
-  return { ...frontmatter, markdown };
-};
-
-// src/custom-docs.ts
-var import_node_fs3 = __toESM(require("fs"));
-var import_promises2 = __toESM(require("fs/promises"));
-var import_gray_matter3 = __toESM(require("gray-matter"));
-
-// src/internal/resources.ts
-var import_path = require("path");
-var import_gray_matter2 = __toESM(require("gray-matter"));
-var import_promises = __toESM(require("fs/promises"));
-var import_node_fs2 = __toESM(require("fs"));
-var import_semver2 = require("semver");
-var import_proper_lockfile = require("proper-lockfile");
-var import_node_path2 = require("path");
-var import_node_path3 = __toESM(require("path"));
-var getResources = async (catalogDir, {
-  type,
-  latestOnly = false,
-  ignore = [],
-  pattern = "",
-  attachSchema = false
-}) => {
-  const ignoreList = latestOnly ? `**/versioned/**` : "";
-  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
-  const files = await getFiles(filePattern, [ignoreList, ...ignore]);
-  if (files.length === 0) return;
-  return files.map((file) => {
-    const { data, content } = import_gray_matter2.default.read(file);
-    if (attachSchema && data?.schemaPath) {
-      const resourceDirectory = (0, import_path.dirname)(file);
-      const pathToSchema = (0, import_path.join)(resourceDirectory, data.schemaPath);
-      if (import_node_fs2.default.existsSync(pathToSchema)) {
-        const schema = import_node_fs2.default.readFileSync(pathToSchema, "utf8");
-        try {
-          data.schema = JSON.parse(schema);
-        } catch (error) {
-          data.schema = schema;
-        }
-      }
-    }
-    return {
-      ...data,
-      markdown: content.trim()
-    };
-  });
-};
-
-// src/custom-docs.ts
-var import_slugify = __toESM(require("slugify"));
-var getCustomDoc = (directory) => async (filePath) => {
-  const fullPath = import_node_path4.default.join(directory, filePath);
-  const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
-  const fileExists = import_node_fs3.default.existsSync(fullPathWithExtension);
-  if (!fileExists) {
-    return void 0;
-  }
-  return readMdxFile(fullPathWithExtension);
-};
-var getCustomDocs = (directory) => async (options) => {
-  if (options?.path) {
-    const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;
-    return getResources(directory, { type: "docs", pattern });
-  }
-  return getResources(directory, { type: "docs", pattern: `${directory}/**/*.{md,mdx}` });
-};
-var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) => {
-  const { fileName, ...rest } = customDoc;
-  const name = fileName || (0, import_slugify.default)(customDoc.title, { lower: true });
-  const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
-  const fullPath = import_node_path4.default.join(directory, options.path || "", withExtension);
-  import_node_fs3.default.mkdirSync(import_node_path4.default.dirname(fullPath), { recursive: true });
-  const document = import_gray_matter3.default.stringify(customDoc.markdown.trim(), rest);
-  import_node_fs3.default.writeFileSync(fullPath, document);
-};
-var rmCustomDoc = (directory) => async (filePath) => {
-  const withExtension = filePath.endsWith(".mdx") ? filePath : `${filePath}.mdx`;
-  await import_promises2.default.rm((0, import_node_path4.join)(directory, withExtension), { recursive: true });
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getCustomDoc,
-  getCustomDocs,
-  rmCustomDoc,
-  writeCustomDoc
-});
-//# sourceMappingURL=custom-docs.js.map

package/dist/custom-docs.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/custom-docs.ts","../src/internal/utils.ts","../src/internal/resources.ts"],"sourcesContent":["import path, { join } from 'node:path';\nimport { readMdxFile } from './internal/utils';\nimport type { CustomDoc } from './types';\nimport fsSync from 'node:fs';\nimport fs from 'node:fs/promises';\nimport matter from 'gray-matter';\nimport { getResources } from './internal/resources';\nimport slugify from 'slugify';\n\n/**\n * Returns a custom doc from EventCatalog by the given file path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // Gets the custom doc by the given file path\n * const customDoc = await getCustomDoc('/guides/inventory-management.mdx');\n * ```\n */\nexport const getCustomDoc =\n  (directory: string) =>\n  async (filePath: string): Promise<CustomDoc | undefined> => {\n    const fullPath = path.join(directory, filePath);\n    const fullPathWithExtension = fullPath.endsWith('.mdx') ? fullPath : `${fullPath}.mdx`;\n    const fileExists = fsSync.existsSync(fullPathWithExtension);\n    if (!fileExists) {\n      return undefined;\n    }\n    return readMdxFile(fullPathWithExtension) as Promise<CustomDoc>;\n  };\n\n/**\n * Returns all custom docs for the project.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getCustomDocs } = utils('/path/to/eventcatalog');\n *\n * // Gets all custom docs from the catalog\n * const customDocs = await getCustomDocs();\n *\n * // Gets all custom docs from the given path\n * const customDocs = await getCustomDocs({ path: '/guides' });\n * ```\n */\nexport const getCustomDocs =\n  (directory: string) =>\n  async (options?: { path?: string }): Promise<CustomDoc[]> => {\n    if (options?.path) {\n      const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;\n      return getResources(directory, { type: 'docs', pattern }) as Promise<CustomDoc[]>;\n    }\n    return getResources(directory, { type: 'docs', pattern: `${directory}/**/*.{md,mdx}` }) as Promise<CustomDoc[]>;\n  };\n\n/**\n * Write a custom doc to EventCatalog.\n *\n * You can optionally override the path of the custom doc.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // Write a custom doc to the catalog\n * // Custom doc would be written to docs/inventory-management.mdx\n * await writeCustomDoc({\n *   title: 'Inventory Management',\n *   summary: 'This is a summary',\n *   owners: ['John Doe'],\n *   badges: [{ content: 'Badge', backgroundColor: 'red', textColor: 'white' }],\n *   markdown: '# Hello world',\n *   fileName: 'inventory-management',\n * });\n *\n * // Write a custom doc to the catalog but override the path\n * // Custom doc would be written to docs/guides/inventory-management/introduction.mdx\n * await writeCustomDoc({\n *   title: 'Inventory Management',\n *   summary: 'This is a summary',\n *   owners: ['John Doe'],\n *   badges: [{ content: 'Badge', backgroundColor: 'red', textColor: 'white' }],\n *   markdown: '# Hello world',\n *   fileName: 'introduction',\n * }, { path: \"/guides/inventory-management\"});\n * ```\n */\nexport const writeCustomDoc =\n  (directory: string) =>\n  async (customDoc: CustomDoc, options: { path?: string } = { path: '' }): Promise<void> => {\n    const { fileName, ...rest } = customDoc;\n    const name = fileName || slugify(customDoc.title, { lower: true });\n    const withExtension = name.endsWith('.mdx') ? name : `${name}.mdx`;\n    const fullPath = path.join(directory, options.path || '', withExtension);\n\n    fsSync.mkdirSync(path.dirname(fullPath), { recursive: true });\n    const document = matter.stringify(customDoc.markdown.trim(), rest);\n    fsSync.writeFileSync(fullPath, document);\n  };\n\n/**\n * Delete a custom doc by its' path\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // removes a custom doc at the given path\n * // Removes the custom doc at docs/guides/inventory-management/introduction.mdx\n * await rmCustomDoc('/guides/inventory-management/introduction');\n * ```\n */\nexport const rmCustomDoc = (directory: string) => async (filePath: string) => {\n  const withExtension = filePath.endsWith('.mdx') ? filePath : `${filePath}.mdx`;\n  await fs.rm(join(directory, withExtension), { recursive: true });\n};\n","import { globSync } from 'glob';\nimport fsSync from 'node:fs';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join, dirname, normalize, sep as pathSeparator, resolve, basename, relative } from 'node:path';\nimport matter from 'gray-matter';\nimport { satisfies, validRange, valid } from 'semver';\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,mdx}`);\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,mdx}`);\n\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  // map files into gray matter to get versions\n  const parsedFiles = matchedFiles.map((path) => {\n    const { data } = matter.read(path);\n    return { ...data, path };\n  }) as any[];\n\n  // Handle 'latest' version - return the latest (non-versioned) file\n  if (version === 'latest') {\n    return latestVersion;\n  }\n\n  // First, check for exact version match (handles non-semver versions like '1', '2', etc.)\n  const exactMatch = parsedFiles.find((c) => c.version === version);\n  if (exactMatch) {\n    return exactMatch.path;\n  }\n\n  // Try semver range matching\n  const semverRange = validRange(version);\n\n  if (semverRange) {\n    const match = parsedFiles.filter((c) => {\n      try {\n        return satisfies(c.version, semverRange);\n      } catch (error) {\n        // If satisfies fails (e.g., comparing semver range with non-semver version), skip this file\n        return false;\n      }\n    });\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // If no exact match and no valid semver range, return undefined\n  return undefined;\n};\n\nexport const getFiles = async (pattern: string, ignore: string | string[] = '') => {\n  try {\n    // 1. Normalize the input pattern to handle mixed separators potentially\n    const normalizedInputPattern = normalize(pattern);\n\n    // 2. Determine the absolute base directory (cwd for glob)\n    // Resolve ensures it's absolute. Handles cases with/without globstar.\n    const absoluteBaseDir = resolve(\n      normalizedInputPattern.includes('**') ? normalizedInputPattern.split('**')[0] : dirname(normalizedInputPattern)\n    );\n\n    // 3. Determine the pattern part relative to the absolute base directory\n    // We extract the part of the normalized pattern that comes *after* the absoluteBaseDir\n    let relativePattern = relative(absoluteBaseDir, normalizedInputPattern);\n\n    // On Windows, relative() might return empty string if paths are identical,\n    // or might need normalization if the original pattern didn't have `**`\n    // Example: pattern = 'dir/file.md', absoluteBaseDir='.../dir', normalized='...\\dir\\file.md'\n    // relative() -> 'file.md'\n    // Example: pattern = 'dir/**/file.md', absoluteBaseDir='.../dir', normalized='...\\dir\\**\\file.md'\n    // relative() -> '**\\file.md'\n    // Convert separators in the relative pattern to forward slashes for glob\n    relativePattern = relativePattern.replace(/\\\\/g, '/');\n\n    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];\n\n    const files = globSync(relativePattern, {\n      cwd: absoluteBaseDir,\n      ignore: ['node_modules/**', ...ignoreList],\n      absolute: true,\n      nodir: true,\n    });\n\n    // 5. Normalize results for consistency before returning\n    return files.map(normalize);\n  } catch (error: any) {\n    // Add more diagnostic info to the error\n    const absoluteBaseDirForError = resolve(\n      normalize(pattern).includes('**') ? normalize(pattern).split('**')[0] : dirname(normalize(pattern))\n    );\n    const relativePatternForError = relative(absoluteBaseDirForError, normalize(pattern)).replace(/\\\\/g, '/');\n    throw new Error(\n      `Error finding files for pattern \"${pattern}\" (using cwd: \"${absoluteBaseDirForError}\", globPattern: \"${relativePatternForError}\"): ${error.message}`\n    );\n  }\n};\n\nexport const readMdxFile = async (path: string) => {\n  const { data } = matter.read(path);\n  const { markdown, ...frontmatter } = data;\n  return { ...frontmatter, markdown };\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  // Escape the id to avoid regex issues\n  const escapedId = id.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&');\n  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${escapedId}['\"]?\\\\s*$`, 'm');\n\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = files.map((file) => {\n    const content = fsSync.readFileSync(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  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  fsSync.mkdirSync(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  fsSync.rmSync(tmpDirectory, { recursive: true });\n};\n\n// Makes sure values in sends/recieves are unique\nexport const uniqueVersions = (messages: { id: string; version: string }[]): { id: string; version: string }[] => {\n  const uniqueSet = new Set();\n\n  return messages.filter((message) => {\n    const key = `${message.id}-${message.version}`;\n    if (!uniqueSet.has(key)) {\n      uniqueSet.add(key);\n      return true;\n    }\n    return false;\n  });\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 fsSync from 'node:fs';\nimport { Message, Service, CustomDoc } from '../types';\nimport { satisfies } from 'semver';\nimport { lock, unlock } from 'proper-lockfile';\nimport { basename } from 'node:path';\nimport path from 'node:path';\n\ntype Resource = Service | Message | CustomDoc;\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,mdx}`);\n  const matchedFiles = await searchFilesForId(files, id);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No resource found with id: ${id}`);\n  }\n\n  // Event that is in the route of the project\n  const file = matchedFiles[0];\n  // Handle both forward and back slashes for cross-platform compatibility (Windows uses \\, Unix uses /)\n  const sourceDirectory = dirname(file).replace(/[/\\\\]versioned[/\\\\][^/\\\\]+[/\\\\]/, path.sep);\n  const { data: { version = '0.0.1' } = {} } = matter.read(file);\n  const targetDirectory = getVersionedDirectory(sourceDirectory, version);\n\n  fsSync.mkdirSync(targetDirectory, { recursive: true });\n\n  const ignoreListToCopy = ['events', 'commands', 'queries', 'versioned'];\n\n  // Copy the event to the versioned directory\n  await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n    // get the folder name\n    const folderName = basename(src);\n\n    if (ignoreListToCopy.includes(folderName)) {\n      return false;\n    }\n    return true;\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        // Dont remove anything in the ignore list\n        if (ignoreListToCopy.includes(file)) {\n          return;\n        }\n        if (file !== 'versioned') {\n          fsSync.rmSync(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; override?: boolean; versionExistingContent?: boolean; format?: 'md' | 'mdx' } = {\n    path: '',\n    type: '',\n    override: false,\n    versionExistingContent: false,\n    format: 'mdx',\n  }\n) => {\n  const path = options.path || `/${resource.id}`;\n  const fullPath = join(catalogDir, path);\n  const format = options.format || 'mdx';\n\n  // Create directory if it doesn't exist\n  fsSync.mkdirSync(fullPath, { recursive: true });\n\n  // Create or get lock file path\n  const lockPath = join(fullPath, `index.${format}`);\n\n  // Ensure the file exists before attempting to lock it\n  if (!fsSync.existsSync(lockPath)) {\n    fsSync.writeFileSync(lockPath, '');\n  }\n\n  try {\n    // Acquire lock with retry\n    await lock(lockPath, {\n      retries: 5,\n      stale: 10000, // 10 seconds\n    });\n\n    const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    if (options.versionExistingContent && !exists) {\n      const currentResource = await getResource(catalogDir, resource.id);\n\n      if (currentResource) {\n        if (satisfies(resource.version, `>${currentResource.version}`)) {\n          await versionResource(catalogDir, resource.id);\n        } else {\n          throw new Error(`New version ${resource.version} is not greater than current version ${currentResource.version}`);\n        }\n      }\n    }\n\n    const document = matter.stringify(markdown.trim(), frontmatter);\n    fsSync.writeFileSync(lockPath, document);\n  } finally {\n    // Always release the lock\n    await unlock(lockPath).catch(() => {});\n  }\n};\n\nexport const getResource = async (\n  catalogDir: string,\n  id?: string,\n  version?: string,\n  options?: { type: string; attachSchema?: boolean },\n  filePath?: string\n): Promise<Resource | undefined> => {\n  const attachSchema = options?.attachSchema || false;\n  const file = filePath || (id ? await findFileById(catalogDir, id, version) : undefined);\n  if (!file || !fsSync.existsSync(file)) return;\n\n  const { data, content } = matter.read(file);\n\n  if (attachSchema && data?.schemaPath) {\n    const resourceDirectory = dirname(file);\n    const pathToSchema = join(resourceDirectory, data.schemaPath);\n    if (fsSync.existsSync(pathToSchema)) {\n      const schema = fsSync.readFileSync(pathToSchema, 'utf8');\n      // Try to parse the schema\n      try {\n        data.schema = JSON.parse(schema);\n      } catch (error) {\n        data.schema = schema;\n      }\n    }\n  }\n\n  return {\n    ...data,\n    markdown: content.trim(),\n  } as Resource;\n};\n\nexport const getResourcePath = async (catalogDir: string, id: string, version?: string) => {\n  const file = await findFileById(catalogDir, id, version);\n  if (!file) return;\n\n  return {\n    fullPath: file,\n    relativePath: file.replace(catalogDir, ''),\n    directory: dirname(file.replace(catalogDir, '')),\n  };\n};\n\nexport const getResourceFolderName = async (catalogDir: string, id: string, version?: string) => {\n  const paths = await getResourcePath(catalogDir, id, version);\n  if (!paths) return;\n  return paths?.directory.split(path.sep).filter(Boolean).pop();\n};\n\nexport const toResource = async (catalogDir: string, rawContents: string) => {\n  const { data, content } = matter(rawContents);\n  return {\n    ...data,\n    markdown: content.trim(),\n  } as Resource;\n};\n\nexport const getResources = async (\n  catalogDir: string,\n  {\n    type,\n    latestOnly = false,\n    ignore = [],\n    pattern = '',\n    attachSchema = false,\n  }: { type: string; pattern?: string; latestOnly?: boolean; ignore?: string[]; attachSchema?: boolean }\n): Promise<Resource[] | undefined> => {\n  const ignoreList = latestOnly ? `**/versioned/**` : '';\n  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;\n  const files = await getFiles(filePattern, [ignoreList, ...ignore]);\n\n  if (files.length === 0) return;\n\n  return files.map((file) => {\n    const { data, content } = matter.read(file);\n\n    // Attach the schema if the attachSchema option is set to true\n    if (attachSchema && data?.schemaPath) {\n      const resourceDirectory = dirname(file);\n      const pathToSchema = join(resourceDirectory, data.schemaPath);\n      if (fsSync.existsSync(pathToSchema)) {\n        const schema = fsSync.readFileSync(pathToSchema, 'utf8');\n        // Try to parse the schema\n        try {\n          data.schema = JSON.parse(schema);\n        } catch (error) {\n          data.schema = schema;\n        }\n      }\n    }\n    return {\n      ...data,\n      markdown: content.trim(),\n    } as Resource;\n  });\n};\n\nexport const rmResourceById = async (\n  catalogDir: string,\n  id: string,\n  version?: string,\n  options?: { type: string; persistFiles?: boolean }\n) => {\n  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);\n\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  if (options?.persistFiles) {\n    await Promise.all(\n      matchedFiles.map(async (file) => {\n        await fs.rm(file, { recursive: true });\n        // Verify file is actually removed\n        await waitForFileRemoval(file);\n      })\n    );\n  } else {\n    await Promise.all(\n      matchedFiles.map(async (file) => {\n        const directory = dirname(file);\n        await fs.rm(directory, { recursive: true, force: true });\n        // Verify directory is actually removed\n        await waitForFileRemoval(directory);\n      })\n    );\n  }\n};\n\n// Helper function to ensure file/directory is completely removed\nconst waitForFileRemoval = async (path: string, maxRetries: number = 50, delay: number = 10): Promise<void> => {\n  for (let i = 0; i < maxRetries; i++) {\n    try {\n      await fs.access(path);\n      // If access succeeds, file still exists, wait and retry\n      await new Promise((resolve) => setTimeout(resolve, delay));\n    } catch (error) {\n      // If access fails, file is removed\n      return;\n    }\n  }\n  // If we reach here, file still exists after all retries\n  throw new Error(`File/directory ${path} was not removed after ${maxRetries} attempts`);\n};\n\nexport const addFileToResource = async (\n  catalogDir: string,\n  id: string,\n  file: { content: string; fileName: string },\n  version?: string,\n  options?: { path?: string }\n) => {\n  let pathToResource: string | undefined;\n\n  if (options?.path) {\n    pathToResource = join(catalogDir, options.path, 'index.mdx');\n  } else {\n    // Fall back to global lookup (existing behavior)\n    pathToResource = await findFileById(catalogDir, id, version);\n  }\n\n  if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n  // Create the directory if it doesn't exist\n  fsSync.mkdirSync(path.dirname(pathToResource), { recursive: true });\n\n  let fileContent = file.content.trim();\n\n  try {\n    const json = JSON.parse(fileContent);\n    fileContent = JSON.stringify(json, null, 2);\n  } catch (error) {\n    // Just silently fail if the file is not valid JSON\n    // Write it as it is\n  }\n\n  fsSync.writeFileSync(join(dirname(pathToResource), file.fileName), fileContent);\n};\n\nexport const getFileFromResource = async (catalogDir: string, id: string, file: { fileName: string }, version?: string) => {\n  const pathToResource = await findFileById(catalogDir, id, version);\n\n  if (!pathToResource) throw new Error('Cannot find directory of resource');\n\n  const exists = await fs\n    .access(join(dirname(pathToResource), file.fileName))\n    .then(() => true)\n    .catch(() => false);\n  if (!exists) throw new Error(`File ${file.fileName} does not exist in resource ${id} v(${version})`);\n\n  return fsSync.readFileSync(join(dirname(pathToResource), file.fileName), 'utf-8');\n};\nexport const getVersionedDirectory = (sourceDirectory: string, version: any): string => {\n  return join(sourceDirectory, 'versioned', version);\n};\n\nexport const isLatestVersion = async (catalogDir: string, id: string, version?: string) => {\n  const resource = await getResource(catalogDir, id, version);\n  if (!resource) return false;\n\n  const pathToResource = await getResourcePath(catalogDir, id, version);\n\n  return !pathToResource?.relativePath.replace(/\\\\/g, '/').includes('/versioned/');\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,oBAA2B;;;ACA3B,kBAAyB;AACzB,qBAAmB;AACnB,sBAAsD;AACtD,uBAA4F;AAC5F,yBAAmB;AACnB,oBAA6C;AA0DtC,IAAM,WAAW,OAAO,SAAiB,SAA4B,OAAO;AACjF,MAAI;AAEF,UAAM,6BAAyB,4BAAU,OAAO;AAIhD,UAAM,sBAAkB;AAAA,MACtB,uBAAuB,SAAS,IAAI,IAAI,uBAAuB,MAAM,IAAI,EAAE,CAAC,QAAI,0BAAQ,sBAAsB;AAAA,IAChH;AAIA,QAAI,sBAAkB,2BAAS,iBAAiB,sBAAsB;AAStE,sBAAkB,gBAAgB,QAAQ,OAAO,GAAG;AAEpD,UAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;AAE3D,UAAM,YAAQ,sBAAS,iBAAiB;AAAA,MACtC,KAAK;AAAA,MACL,QAAQ,CAAC,mBAAmB,GAAG,UAAU;AAAA,MACzC,UAAU;AAAA,MACV,OAAO;AAAA,IACT,CAAC;AAGD,WAAO,MAAM,IAAI,0BAAS;AAAA,EAC5B,SAAS,OAAY;AAEnB,UAAM,8BAA0B;AAAA,UAC9B,4BAAU,OAAO,EAAE,SAAS,IAAI,QAAI,4BAAU,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,QAAI,8BAAQ,4BAAU,OAAO,CAAC;AAAA,IACpG;AACA,UAAM,8BAA0B,2BAAS,6BAAyB,4BAAU,OAAO,CAAC,EAAE,QAAQ,OAAO,GAAG;AACxG,UAAM,IAAI;AAAA,MACR,oCAAoC,OAAO,kBAAkB,uBAAuB,oBAAoB,uBAAuB,OAAO,MAAM,OAAO;AAAA,IACrJ;AAAA,EACF;AACF;AAEO,IAAM,cAAc,OAAOC,UAAiB;AACjD,QAAM,EAAE,KAAK,IAAI,mBAAAC,QAAO,KAAKD,KAAI;AACjC,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,SAAO,EAAE,GAAG,aAAa,SAAS;AACpC;;;AD/GA,IAAAE,kBAAmB;AACnB,IAAAC,mBAAe;AACf,IAAAC,sBAAmB;;;AELnB,kBAA8B;AAE9B,IAAAC,sBAAmB;AACnB,sBAAe;AACf,IAAAC,kBAAmB;AAEnB,IAAAC,iBAA0B;AAC1B,6BAA6B;AAC7B,IAAAC,oBAAyB;AACzB,IAAAA,oBAAiB;AA0KV,IAAM,eAAe,OAC1B,YACA;AAAA,EACE;AAAA,EACA,aAAa;AAAA,EACb,SAAS,CAAC;AAAA,EACV,UAAU;AAAA,EACV,eAAe;AACjB,MACoC;AACpC,QAAM,aAAa,aAAa,oBAAoB;AACpD,QAAM,cAAc,WAAW,GAAG,UAAU,OAAO,IAAI;AACvD,QAAM,QAAQ,MAAM,SAAS,aAAa,CAAC,YAAY,GAAG,MAAM,CAAC;AAEjE,MAAI,MAAM,WAAW,EAAG;AAExB,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAC,QAAO,KAAK,IAAI;AAG1C,QAAI,gBAAgB,MAAM,YAAY;AACpC,YAAM,wBAAoB,qBAAQ,IAAI;AACtC,YAAM,mBAAe,kBAAK,mBAAmB,KAAK,UAAU;AAC5D,UAAI,gBAAAC,QAAO,WAAW,YAAY,GAAG;AACnC,cAAM,SAAS,gBAAAA,QAAO,aAAa,cAAc,MAAM;AAEvD,YAAI;AACF,eAAK,SAAS,KAAK,MAAM,MAAM;AAAA,QACjC,SAAS,OAAO;AACd,eAAK,SAAS;AAAA,QAChB;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,MACL,GAAG;AAAA,MACH,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;;;AFlNA,qBAAoB;AAeb,IAAM,eACX,CAAC,cACD,OAAO,aAAqD;AAC1D,QAAM,WAAW,kBAAAC,QAAK,KAAK,WAAW,QAAQ;AAC9C,QAAM,wBAAwB,SAAS,SAAS,MAAM,IAAI,WAAW,GAAG,QAAQ;AAChF,QAAM,aAAa,gBAAAC,QAAO,WAAW,qBAAqB;AAC1D,MAAI,CAAC,YAAY;AACf,WAAO;AAAA,EACT;AACA,SAAO,YAAY,qBAAqB;AAC1C;AAkBK,IAAM,gBACX,CAAC,cACD,OAAO,YAAsD;AAC3D,MAAI,SAAS,MAAM;AACjB,UAAM,UAAU,GAAG,SAAS,IAAI,QAAQ,IAAI;AAC5C,WAAO,aAAa,WAAW,EAAE,MAAM,QAAQ,QAAQ,CAAC;AAAA,EAC1D;AACA,SAAO,aAAa,WAAW,EAAE,MAAM,QAAQ,SAAS,GAAG,SAAS,iBAAiB,CAAC;AACxF;AAoCK,IAAM,iBACX,CAAC,cACD,OAAO,WAAsB,UAA6B,EAAE,MAAM,GAAG,MAAqB;AACxF,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,QAAM,OAAO,gBAAY,eAAAC,SAAQ,UAAU,OAAO,EAAE,OAAO,KAAK,CAAC;AACjE,QAAM,gBAAgB,KAAK,SAAS,MAAM,IAAI,OAAO,GAAG,IAAI;AAC5D,QAAM,WAAW,kBAAAF,QAAK,KAAK,WAAW,QAAQ,QAAQ,IAAI,aAAa;AAEvE,kBAAAC,QAAO,UAAU,kBAAAD,QAAK,QAAQ,QAAQ,GAAG,EAAE,WAAW,KAAK,CAAC;AAC5D,QAAM,WAAW,oBAAAG,QAAO,UAAU,UAAU,SAAS,KAAK,GAAG,IAAI;AACjE,kBAAAF,QAAO,cAAc,UAAU,QAAQ;AACzC;AAgBK,IAAM,cAAc,CAAC,cAAsB,OAAO,aAAqB;AAC5E,QAAM,gBAAgB,SAAS,SAAS,MAAM,IAAI,WAAW,GAAG,QAAQ;AACxE,QAAM,iBAAAG,QAAG,OAAG,wBAAK,WAAW,aAAa,GAAG,EAAE,WAAW,KAAK,CAAC;AACjE;","names":["import_node_path","path","matter","import_node_fs","import_promises","import_gray_matter","import_gray_matter","import_node_fs","import_semver","import_node_path","matter","fsSync","path","fsSync","slugify","matter","fs"]}

package/dist/custom-docs.mjs

@@ -1,122 +0,0 @@
-// src/custom-docs.ts
-import path, { join as join3 } from "node:path";
-
-// src/internal/utils.ts
-import { globSync } from "glob";
-import { copy } from "fs-extra";
-import { join, dirname, normalize, resolve, relative } from "node:path";
-import matter from "gray-matter";
-import { satisfies, validRange } from "semver";
-var getFiles = async (pattern, ignore = "") => {
-  try {
-    const normalizedInputPattern = normalize(pattern);
-    const absoluteBaseDir = resolve(
-      normalizedInputPattern.includes("**") ? normalizedInputPattern.split("**")[0] : dirname(normalizedInputPattern)
-    );
-    let relativePattern = relative(absoluteBaseDir, normalizedInputPattern);
-    relativePattern = relativePattern.replace(/\\/g, "/");
-    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];
-    const files = globSync(relativePattern, {
-      cwd: absoluteBaseDir,
-      ignore: ["node_modules/**", ...ignoreList],
-      absolute: true,
-      nodir: true
-    });
-    return files.map(normalize);
-  } catch (error) {
-    const absoluteBaseDirForError = resolve(
-      normalize(pattern).includes("**") ? normalize(pattern).split("**")[0] : dirname(normalize(pattern))
-    );
-    const relativePatternForError = relative(absoluteBaseDirForError, normalize(pattern)).replace(/\\/g, "/");
-    throw new Error(
-      `Error finding files for pattern "${pattern}" (using cwd: "${absoluteBaseDirForError}", globPattern: "${relativePatternForError}"): ${error.message}`
-    );
-  }
-};
-var readMdxFile = async (path2) => {
-  const { data } = matter.read(path2);
-  const { markdown, ...frontmatter } = data;
-  return { ...frontmatter, markdown };
-};
-
-// src/custom-docs.ts
-import fsSync2 from "node:fs";
-import fs from "node:fs/promises";
-import matter3 from "gray-matter";
-
-// src/internal/resources.ts
-import { dirname as dirname2, join as join2 } from "path";
-import matter2 from "gray-matter";
-import fsSync from "node:fs";
-import { satisfies as satisfies2 } from "semver";
-import { lock, unlock } from "proper-lockfile";
-var getResources = async (catalogDir, {
-  type,
-  latestOnly = false,
-  ignore = [],
-  pattern = "",
-  attachSchema = false
-}) => {
-  const ignoreList = latestOnly ? `**/versioned/**` : "";
-  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
-  const files = await getFiles(filePattern, [ignoreList, ...ignore]);
-  if (files.length === 0) return;
-  return files.map((file) => {
-    const { data, content } = matter2.read(file);
-    if (attachSchema && data?.schemaPath) {
-      const resourceDirectory = dirname2(file);
-      const pathToSchema = join2(resourceDirectory, data.schemaPath);
-      if (fsSync.existsSync(pathToSchema)) {
-        const schema = fsSync.readFileSync(pathToSchema, "utf8");
-        try {
-          data.schema = JSON.parse(schema);
-        } catch (error) {
-          data.schema = schema;
-        }
-      }
-    }
-    return {
-      ...data,
-      markdown: content.trim()
-    };
-  });
-};
-
-// src/custom-docs.ts
-import slugify from "slugify";
-var getCustomDoc = (directory) => async (filePath) => {
-  const fullPath = path.join(directory, filePath);
-  const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
-  const fileExists = fsSync2.existsSync(fullPathWithExtension);
-  if (!fileExists) {
-    return void 0;
-  }
-  return readMdxFile(fullPathWithExtension);
-};
-var getCustomDocs = (directory) => async (options) => {
-  if (options?.path) {
-    const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;
-    return getResources(directory, { type: "docs", pattern });
-  }
-  return getResources(directory, { type: "docs", pattern: `${directory}/**/*.{md,mdx}` });
-};
-var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) => {
-  const { fileName, ...rest } = customDoc;
-  const name = fileName || slugify(customDoc.title, { lower: true });
-  const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
-  const fullPath = path.join(directory, options.path || "", withExtension);
-  fsSync2.mkdirSync(path.dirname(fullPath), { recursive: true });
-  const document = matter3.stringify(customDoc.markdown.trim(), rest);
-  fsSync2.writeFileSync(fullPath, document);
-};
-var rmCustomDoc = (directory) => async (filePath) => {
-  const withExtension = filePath.endsWith(".mdx") ? filePath : `${filePath}.mdx`;
-  await fs.rm(join3(directory, withExtension), { recursive: true });
-};
-export {
-  getCustomDoc,
-  getCustomDocs,
-  rmCustomDoc,
-  writeCustomDoc
-};
-//# sourceMappingURL=custom-docs.mjs.map

package/dist/custom-docs.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/custom-docs.ts","../src/internal/utils.ts","../src/internal/resources.ts"],"sourcesContent":["import path, { join } from 'node:path';\nimport { readMdxFile } from './internal/utils';\nimport type { CustomDoc } from './types';\nimport fsSync from 'node:fs';\nimport fs from 'node:fs/promises';\nimport matter from 'gray-matter';\nimport { getResources } from './internal/resources';\nimport slugify from 'slugify';\n\n/**\n * Returns a custom doc from EventCatalog by the given file path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // Gets the custom doc by the given file path\n * const customDoc = await getCustomDoc('/guides/inventory-management.mdx');\n * ```\n */\nexport const getCustomDoc =\n  (directory: string) =>\n  async (filePath: string): Promise<CustomDoc | undefined> => {\n    const fullPath = path.join(directory, filePath);\n    const fullPathWithExtension = fullPath.endsWith('.mdx') ? fullPath : `${fullPath}.mdx`;\n    const fileExists = fsSync.existsSync(fullPathWithExtension);\n    if (!fileExists) {\n      return undefined;\n    }\n    return readMdxFile(fullPathWithExtension) as Promise<CustomDoc>;\n  };\n\n/**\n * Returns all custom docs for the project.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getCustomDocs } = utils('/path/to/eventcatalog');\n *\n * // Gets all custom docs from the catalog\n * const customDocs = await getCustomDocs();\n *\n * // Gets all custom docs from the given path\n * const customDocs = await getCustomDocs({ path: '/guides' });\n * ```\n */\nexport const getCustomDocs =\n  (directory: string) =>\n  async (options?: { path?: string }): Promise<CustomDoc[]> => {\n    if (options?.path) {\n      const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;\n      return getResources(directory, { type: 'docs', pattern }) as Promise<CustomDoc[]>;\n    }\n    return getResources(directory, { type: 'docs', pattern: `${directory}/**/*.{md,mdx}` }) as Promise<CustomDoc[]>;\n  };\n\n/**\n * Write a custom doc to EventCatalog.\n *\n * You can optionally override the path of the custom doc.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // Write a custom doc to the catalog\n * // Custom doc would be written to docs/inventory-management.mdx\n * await writeCustomDoc({\n *   title: 'Inventory Management',\n *   summary: 'This is a summary',\n *   owners: ['John Doe'],\n *   badges: [{ content: 'Badge', backgroundColor: 'red', textColor: 'white' }],\n *   markdown: '# Hello world',\n *   fileName: 'inventory-management',\n * });\n *\n * // Write a custom doc to the catalog but override the path\n * // Custom doc would be written to docs/guides/inventory-management/introduction.mdx\n * await writeCustomDoc({\n *   title: 'Inventory Management',\n *   summary: 'This is a summary',\n *   owners: ['John Doe'],\n *   badges: [{ content: 'Badge', backgroundColor: 'red', textColor: 'white' }],\n *   markdown: '# Hello world',\n *   fileName: 'introduction',\n * }, { path: \"/guides/inventory-management\"});\n * ```\n */\nexport const writeCustomDoc =\n  (directory: string) =>\n  async (customDoc: CustomDoc, options: { path?: string } = { path: '' }): Promise<void> => {\n    const { fileName, ...rest } = customDoc;\n    const name = fileName || slugify(customDoc.title, { lower: true });\n    const withExtension = name.endsWith('.mdx') ? name : `${name}.mdx`;\n    const fullPath = path.join(directory, options.path || '', withExtension);\n\n    fsSync.mkdirSync(path.dirname(fullPath), { recursive: true });\n    const document = matter.stringify(customDoc.markdown.trim(), rest);\n    fsSync.writeFileSync(fullPath, document);\n  };\n\n/**\n * Delete a custom doc by its' path\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmCustomDoc } = utils('/path/to/eventcatalog');\n *\n * // removes a custom doc at the given path\n * // Removes the custom doc at docs/guides/inventory-management/introduction.mdx\n * await rmCustomDoc('/guides/inventory-management/introduction');\n * ```\n */\nexport const rmCustomDoc = (directory: string) => async (filePath: string) => {\n  const withExtension = filePath.endsWith('.mdx') ? filePath : `${filePath}.mdx`;\n  await fs.rm(join(directory, withExtension), { recursive: true });\n};\n","import { globSync } from 'glob';\nimport fsSync from 'node:fs';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join, dirname, normalize, sep as pathSeparator, resolve, basename, relative } from 'node:path';\nimport matter from 'gray-matter';\nimport { satisfies, validRange, valid } from 'semver';\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,mdx}`);\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,mdx}`);\n\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  // map files into gray matter to get versions\n  const parsedFiles = matchedFiles.map((path) => {\n    const { data } = matter.read(path);\n    return { ...data, path };\n  }) as any[];\n\n  // Handle 'latest' version - return the latest (non-versioned) file\n  if (version === 'latest') {\n    return latestVersion;\n  }\n\n  // First, check for exact version match (handles non-semver versions like '1', '2', etc.)\n  const exactMatch = parsedFiles.find((c) => c.version === version);\n  if (exactMatch) {\n    return exactMatch.path;\n  }\n\n  // Try semver range matching\n  const semverRange = validRange(version);\n\n  if (semverRange) {\n    const match = parsedFiles.filter((c) => {\n      try {\n        return satisfies(c.version, semverRange);\n      } catch (error) {\n        // If satisfies fails (e.g., comparing semver range with non-semver version), skip this file\n        return false;\n      }\n    });\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // If no exact match and no valid semver range, return undefined\n  return undefined;\n};\n\nexport const getFiles = async (pattern: string, ignore: string | string[] = '') => {\n  try {\n    // 1. Normalize the input pattern to handle mixed separators potentially\n    const normalizedInputPattern = normalize(pattern);\n\n    // 2. Determine the absolute base directory (cwd for glob)\n    // Resolve ensures it's absolute. Handles cases with/without globstar.\n    const absoluteBaseDir = resolve(\n      normalizedInputPattern.includes('**') ? normalizedInputPattern.split('**')[0] : dirname(normalizedInputPattern)\n    );\n\n    // 3. Determine the pattern part relative to the absolute base directory\n    // We extract the part of the normalized pattern that comes *after* the absoluteBaseDir\n    let relativePattern = relative(absoluteBaseDir, normalizedInputPattern);\n\n    // On Windows, relative() might return empty string if paths are identical,\n    // or might need normalization if the original pattern didn't have `**`\n    // Example: pattern = 'dir/file.md', absoluteBaseDir='.../dir', normalized='...\\dir\\file.md'\n    // relative() -> 'file.md'\n    // Example: pattern = 'dir/**/file.md', absoluteBaseDir='.../dir', normalized='...\\dir\\**\\file.md'\n    // relative() -> '**\\file.md'\n    // Convert separators in the relative pattern to forward slashes for glob\n    relativePattern = relativePattern.replace(/\\\\/g, '/');\n\n    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];\n\n    const files = globSync(relativePattern, {\n      cwd: absoluteBaseDir,\n      ignore: ['node_modules/**', ...ignoreList],\n      absolute: true,\n      nodir: true,\n    });\n\n    // 5. Normalize results for consistency before returning\n    return files.map(normalize);\n  } catch (error: any) {\n    // Add more diagnostic info to the error\n    const absoluteBaseDirForError = resolve(\n      normalize(pattern).includes('**') ? normalize(pattern).split('**')[0] : dirname(normalize(pattern))\n    );\n    const relativePatternForError = relative(absoluteBaseDirForError, normalize(pattern)).replace(/\\\\/g, '/');\n    throw new Error(\n      `Error finding files for pattern \"${pattern}\" (using cwd: \"${absoluteBaseDirForError}\", globPattern: \"${relativePatternForError}\"): ${error.message}`\n    );\n  }\n};\n\nexport const readMdxFile = async (path: string) => {\n  const { data } = matter.read(path);\n  const { markdown, ...frontmatter } = data;\n  return { ...frontmatter, markdown };\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  // Escape the id to avoid regex issues\n  const escapedId = id.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&');\n  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${escapedId}['\"]?\\\\s*$`, 'm');\n\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = files.map((file) => {\n    const content = fsSync.readFileSync(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  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  fsSync.mkdirSync(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  fsSync.rmSync(tmpDirectory, { recursive: true });\n};\n\n// Makes sure values in sends/recieves are unique\nexport const uniqueVersions = (messages: { id: string; version: string }[]): { id: string; version: string }[] => {\n  const uniqueSet = new Set();\n\n  return messages.filter((message) => {\n    const key = `${message.id}-${message.version}`;\n    if (!uniqueSet.has(key)) {\n      uniqueSet.add(key);\n      return true;\n    }\n    return false;\n  });\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 fsSync from 'node:fs';\nimport { Message, Service, CustomDoc } from '../types';\nimport { satisfies } from 'semver';\nimport { lock, unlock } from 'proper-lockfile';\nimport { basename } from 'node:path';\nimport path from 'node:path';\n\ntype Resource = Service | Message | CustomDoc;\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,mdx}`);\n  const matchedFiles = await searchFilesForId(files, id);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No resource found with id: ${id}`);\n  }\n\n  // Event that is in the route of the project\n  const file = matchedFiles[0];\n  // Handle both forward and back slashes for cross-platform compatibility (Windows uses \\, Unix uses /)\n  const sourceDirectory = dirname(file).replace(/[/\\\\]versioned[/\\\\][^/\\\\]+[/\\\\]/, path.sep);\n  const { data: { version = '0.0.1' } = {} } = matter.read(file);\n  const targetDirectory = getVersionedDirectory(sourceDirectory, version);\n\n  fsSync.mkdirSync(targetDirectory, { recursive: true });\n\n  const ignoreListToCopy = ['events', 'commands', 'queries', 'versioned'];\n\n  // Copy the event to the versioned directory\n  await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {\n    // get the folder name\n    const folderName = basename(src);\n\n    if (ignoreListToCopy.includes(folderName)) {\n      return false;\n    }\n    return true;\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        // Dont remove anything in the ignore list\n        if (ignoreListToCopy.includes(file)) {\n          return;\n        }\n        if (file !== 'versioned') {\n          fsSync.rmSync(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; override?: boolean; versionExistingContent?: boolean; format?: 'md' | 'mdx' } = {\n    path: '',\n    type: '',\n    override: false,\n    versionExistingContent: false,\n    format: 'mdx',\n  }\n) => {\n  const path = options.path || `/${resource.id}`;\n  const fullPath = join(catalogDir, path);\n  const format = options.format || 'mdx';\n\n  // Create directory if it doesn't exist\n  fsSync.mkdirSync(fullPath, { recursive: true });\n\n  // Create or get lock file path\n  const lockPath = join(fullPath, `index.${format}`);\n\n  // Ensure the file exists before attempting to lock it\n  if (!fsSync.existsSync(lockPath)) {\n    fsSync.writeFileSync(lockPath, '');\n  }\n\n  try {\n    // Acquire lock with retry\n    await lock(lockPath, {\n      retries: 5,\n      stale: 10000, // 10 seconds\n    });\n\n    const exists = await versionExists(catalogDir, resource.id, resource.version);\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    if (options.versionExistingContent && !exists) {\n      const currentResource = await getResource(catalogDir, resource.id);\n\n      if (currentResource) {\n        if (satisfies(resource.version, `>${currentResource.version}`)) {\n          await versionResource(catalogDir, resource.id);\n        } else {\n          throw new Error(`New version ${resource.version} is not greater than current version ${currentResource.version}`);\n        }\n      }\n    }\n\n    const document = matter.stringify(markdown.trim(), frontmatter);\n    fsSync.writeFileSync(lockPath, document);\n  } finally {\n    // Always release the lock\n    await unlock(lockPath).catch(() => {});\n  }\n};\n\nexport const getResource = async (\n  catalogDir: string,\n  id?: string,\n  version?: string,\n  options?: { type: string; attachSchema?: boolean },\n  filePath?: string\n): Promise<Resource | undefined> => {\n  const attachSchema = options?.attachSchema || false;\n  const file = filePath || (id ? await findFileById(catalogDir, id, version) : undefined);\n  if (!file || !fsSync.existsSync(file)) return;\n\n  const { data, content } = matter.read(file);\n\n  if (attachSchema && data?.schemaPath) {\n    const resourceDirectory = dirname(file);\n    const pathToSchema = join(resourceDirectory, data.schemaPath);\n    if (fsSync.existsSync(pathToSchema)) {\n      const schema = fsSync.readFileSync(pathToSchema, 'utf8');\n      // Try to parse the schema\n      try {\n        data.schema = JSON.parse(schema);\n      } catch (error) {\n        data.schema = schema;\n      }\n    }\n  }\n\n  return {\n    ...data,\n    markdown: content.trim(),\n  } as Resource;\n};\n\nexport const getResourcePath = async (catalogDir: string, id: string, version?: string) => {\n  const file = await findFileById(catalogDir, id, version);\n  if (!file) return;\n\n  return {\n    fullPath: file,\n    relativePath: file.replace(catalogDir, ''),\n    directory: dirname(file.replace(catalogDir, '')),\n  };\n};\n\nexport const getResourceFolderName = async (catalogDir: string, id: string, version?: string) => {\n  const paths = await getResourcePath(catalogDir, id, version);\n  if (!paths) return;\n  return paths?.directory.split(path.sep).filter(Boolean).pop();\n};\n\nexport const toResource = async (catalogDir: string, rawContents: string) => {\n  const { data, content } = matter(rawContents);\n  return {\n    ...data,\n    markdown: content.trim(),\n  } as Resource;\n};\n\nexport const getResources = async (\n  catalogDir: string,\n  {\n    type,\n    latestOnly = false,\n    ignore = [],\n    pattern = '',\n    attachSchema = false,\n  }: { type: string; pattern?: string; latestOnly?: boolean; ignore?: string[]; attachSchema?: boolean }\n): Promise<Resource[] | undefined> => {\n  const ignoreList = latestOnly ? `**/versioned/**` : '';\n  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;\n  const files = await getFiles(filePattern, [ignoreList, ...ignore]);\n\n  if (files.length === 0) return;\n\n  return files.map((file) => {\n    const { data, content } = matter.read(file);\n\n    // Attach the schema if the attachSchema option is set to true\n    if (attachSchema && data?.schemaPath) {\n      const resourceDirectory = dirname(file);\n      const pathToSchema = join(resourceDirectory, data.schemaPath);\n      if (fsSync.existsSync(pathToSchema)) {\n        const schema = fsSync.readFileSync(pathToSchema, 'utf8');\n        // Try to parse the schema\n        try {\n          data.schema = JSON.parse(schema);\n        } catch (error) {\n          data.schema = schema;\n        }\n      }\n    }\n    return {\n      ...data,\n      markdown: content.trim(),\n    } as Resource;\n  });\n};\n\nexport const rmResourceById = async (\n  catalogDir: string,\n  id: string,\n  version?: string,\n  options?: { type: string; persistFiles?: boolean }\n) => {\n  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);\n\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  if (options?.persistFiles) {\n    await Promise.all(\n      matchedFiles.map(async (file) => {\n        await fs.rm(file, { recursive: true });\n        // Verify file is actually removed\n        await waitForFileRemoval(file);\n      })\n    );\n  } else {\n    await Promise.all(\n      matchedFiles.map(async (file) => {\n        const directory = dirname(file);\n        await fs.rm(directory, { recursive: true, force: true });\n        // Verify directory is actually removed\n        await waitForFileRemoval(directory);\n      })\n    );\n  }\n};\n\n// Helper function to ensure file/directory is completely removed\nconst waitForFileRemoval = async (path: string, maxRetries: number = 50, delay: number = 10): Promise<void> => {\n  for (let i = 0; i < maxRetries; i++) {\n    try {\n      await fs.access(path);\n      // If access succeeds, file still exists, wait and retry\n      await new Promise((resolve) => setTimeout(resolve, delay));\n    } catch (error) {\n      // If access fails, file is removed\n      return;\n    }\n  }\n  // If we reach here, file still exists after all retries\n  throw new Error(`File/directory ${path} was not removed after ${maxRetries} attempts`);\n};\n\nexport const addFileToResource = async (\n  catalogDir: string,\n  id: string,\n  file: { content: string; fileName: string },\n  version?: string,\n  options?: { path?: string }\n) => {\n  let pathToResource: string | undefined;\n\n  if (options?.path) {\n    pathToResource = join(catalogDir, options.path, 'index.mdx');\n  } else {\n    // Fall back to global lookup (existing behavior)\n    pathToResource = await findFileById(catalogDir, id, version);\n  }\n\n  if (!pathToResource) throw new Error('Cannot find directory to write file to');\n\n  // Create the directory if it doesn't exist\n  fsSync.mkdirSync(path.dirname(pathToResource), { recursive: true });\n\n  let fileContent = file.content.trim();\n\n  try {\n    const json = JSON.parse(fileContent);\n    fileContent = JSON.stringify(json, null, 2);\n  } catch (error) {\n    // Just silently fail if the file is not valid JSON\n    // Write it as it is\n  }\n\n  fsSync.writeFileSync(join(dirname(pathToResource), file.fileName), fileContent);\n};\n\nexport const getFileFromResource = async (catalogDir: string, id: string, file: { fileName: string }, version?: string) => {\n  const pathToResource = await findFileById(catalogDir, id, version);\n\n  if (!pathToResource) throw new Error('Cannot find directory of resource');\n\n  const exists = await fs\n    .access(join(dirname(pathToResource), file.fileName))\n    .then(() => true)\n    .catch(() => false);\n  if (!exists) throw new Error(`File ${file.fileName} does not exist in resource ${id} v(${version})`);\n\n  return fsSync.readFileSync(join(dirname(pathToResource), file.fileName), 'utf-8');\n};\nexport const getVersionedDirectory = (sourceDirectory: string, version: any): string => {\n  return join(sourceDirectory, 'versioned', version);\n};\n\nexport const isLatestVersion = async (catalogDir: string, id: string, version?: string) => {\n  const resource = await getResource(catalogDir, id, version);\n  if (!resource) return false;\n\n  const pathToResource = await getResourcePath(catalogDir, id, version);\n\n  return !pathToResource?.relativePath.replace(/\\\\/g, '/').includes('/versioned/');\n};\n"],"mappings":";AAAA,OAAO,QAAQ,QAAAA,aAAY;;;ACA3B,SAAS,gBAAgB;AAEzB,SAAS,YAA6C;AACtD,SAAS,MAAM,SAAS,WAAiC,SAAmB,gBAAgB;AAC5F,OAAO,YAAY;AACnB,SAAS,WAAW,kBAAyB;AA0DtC,IAAM,WAAW,OAAO,SAAiB,SAA4B,OAAO;AACjF,MAAI;AAEF,UAAM,yBAAyB,UAAU,OAAO;AAIhD,UAAM,kBAAkB;AAAA,MACtB,uBAAuB,SAAS,IAAI,IAAI,uBAAuB,MAAM,IAAI,EAAE,CAAC,IAAI,QAAQ,sBAAsB;AAAA,IAChH;AAIA,QAAI,kBAAkB,SAAS,iBAAiB,sBAAsB;AAStE,sBAAkB,gBAAgB,QAAQ,OAAO,GAAG;AAEpD,UAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;AAE3D,UAAM,QAAQ,SAAS,iBAAiB;AAAA,MACtC,KAAK;AAAA,MACL,QAAQ,CAAC,mBAAmB,GAAG,UAAU;AAAA,MACzC,UAAU;AAAA,MACV,OAAO;AAAA,IACT,CAAC;AAGD,WAAO,MAAM,IAAI,SAAS;AAAA,EAC5B,SAAS,OAAY;AAEnB,UAAM,0BAA0B;AAAA,MAC9B,UAAU,OAAO,EAAE,SAAS,IAAI,IAAI,UAAU,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,IAAI,QAAQ,UAAU,OAAO,CAAC;AAAA,IACpG;AACA,UAAM,0BAA0B,SAAS,yBAAyB,UAAU,OAAO,CAAC,EAAE,QAAQ,OAAO,GAAG;AACxG,UAAM,IAAI;AAAA,MACR,oCAAoC,OAAO,kBAAkB,uBAAuB,oBAAoB,uBAAuB,OAAO,MAAM,OAAO;AAAA,IACrJ;AAAA,EACF;AACF;AAEO,IAAM,cAAc,OAAOC,UAAiB;AACjD,QAAM,EAAE,KAAK,IAAI,OAAO,KAAKA,KAAI;AACjC,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,SAAO,EAAE,GAAG,aAAa,SAAS;AACpC;;;AD/GA,OAAOC,aAAY;AACnB,OAAO,QAAQ;AACf,OAAOC,aAAY;;;AELnB,SAAS,WAAAC,UAAS,QAAAC,aAAY;AAE9B,OAAOC,aAAY;AAEnB,OAAO,YAAY;AAEnB,SAAS,aAAAC,kBAAiB;AAC1B,SAAS,MAAM,cAAc;AA4KtB,IAAM,eAAe,OAC1B,YACA;AAAA,EACE;AAAA,EACA,aAAa;AAAA,EACb,SAAS,CAAC;AAAA,EACV,UAAU;AAAA,EACV,eAAe;AACjB,MACoC;AACpC,QAAM,aAAa,aAAa,oBAAoB;AACpD,QAAM,cAAc,WAAW,GAAG,UAAU,OAAO,IAAI;AACvD,QAAM,QAAQ,MAAM,SAAS,aAAa,CAAC,YAAY,GAAG,MAAM,CAAC;AAEjE,MAAI,MAAM,WAAW,EAAG;AAExB,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAIC,QAAO,KAAK,IAAI;AAG1C,QAAI,gBAAgB,MAAM,YAAY;AACpC,YAAM,oBAAoBC,SAAQ,IAAI;AACtC,YAAM,eAAeC,MAAK,mBAAmB,KAAK,UAAU;AAC5D,UAAI,OAAO,WAAW,YAAY,GAAG;AACnC,cAAM,SAAS,OAAO,aAAa,cAAc,MAAM;AAEvD,YAAI;AACF,eAAK,SAAS,KAAK,MAAM,MAAM;AAAA,QACjC,SAAS,OAAO;AACd,eAAK,SAAS;AAAA,QAChB;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,MACL,GAAG;AAAA,MACH,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;;;AFlNA,OAAO,aAAa;AAeb,IAAM,eACX,CAAC,cACD,OAAO,aAAqD;AAC1D,QAAM,WAAW,KAAK,KAAK,WAAW,QAAQ;AAC9C,QAAM,wBAAwB,SAAS,SAAS,MAAM,IAAI,WAAW,GAAG,QAAQ;AAChF,QAAM,aAAaC,QAAO,WAAW,qBAAqB;AAC1D,MAAI,CAAC,YAAY;AACf,WAAO;AAAA,EACT;AACA,SAAO,YAAY,qBAAqB;AAC1C;AAkBK,IAAM,gBACX,CAAC,cACD,OAAO,YAAsD;AAC3D,MAAI,SAAS,MAAM;AACjB,UAAM,UAAU,GAAG,SAAS,IAAI,QAAQ,IAAI;AAC5C,WAAO,aAAa,WAAW,EAAE,MAAM,QAAQ,QAAQ,CAAC;AAAA,EAC1D;AACA,SAAO,aAAa,WAAW,EAAE,MAAM,QAAQ,SAAS,GAAG,SAAS,iBAAiB,CAAC;AACxF;AAoCK,IAAM,iBACX,CAAC,cACD,OAAO,WAAsB,UAA6B,EAAE,MAAM,GAAG,MAAqB;AACxF,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,QAAM,OAAO,YAAY,QAAQ,UAAU,OAAO,EAAE,OAAO,KAAK,CAAC;AACjE,QAAM,gBAAgB,KAAK,SAAS,MAAM,IAAI,OAAO,GAAG,IAAI;AAC5D,QAAM,WAAW,KAAK,KAAK,WAAW,QAAQ,QAAQ,IAAI,aAAa;AAEvE,EAAAA,QAAO,UAAU,KAAK,QAAQ,QAAQ,GAAG,EAAE,WAAW,KAAK,CAAC;AAC5D,QAAM,WAAWC,QAAO,UAAU,UAAU,SAAS,KAAK,GAAG,IAAI;AACjE,EAAAD,QAAO,cAAc,UAAU,QAAQ;AACzC;AAgBK,IAAM,cAAc,CAAC,cAAsB,OAAO,aAAqB;AAC5E,QAAM,gBAAgB,SAAS,SAAS,MAAM,IAAI,WAAW,GAAG,QAAQ;AACxE,QAAM,GAAG,GAAGE,MAAK,WAAW,aAAa,GAAG,EAAE,WAAW,KAAK,CAAC;AACjE;","names":["join","path","fsSync","matter","dirname","join","matter","satisfies","matter","dirname","join","fsSync","matter","join"]}

package/dist/data-products.d.mts

@@ -1,225 +0,0 @@
-import { DataProduct } from './types.d.mjs';
-
-/**
- * Returns a data product from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the data product
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDataProduct } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the data product
- * const dataProduct = await getDataProduct('CustomerDataProduct');
- *
- * // Gets a version of the data product
- * const dataProduct = await getDataProduct('CustomerDataProduct', '0.0.1');
- *
- * ```
- */
-declare const getDataProduct: (directory: string) => (id: string, version?: string) => Promise<DataProduct>;
-/**
- * Returns all data products from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the data products.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDataProducts } = utils('/path/to/eventcatalog');
- *
- * // Gets all data products (and versions) from the catalog
- * const dataProducts = await getDataProducts();
- *
- * // Gets all data products (only latest version) from the catalog
- * const dataProducts = await getDataProducts({ latestOnly: true });
- *
- * ```
- */
-declare const getDataProducts: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<DataProduct[]>;
-/**
- * Write a data product to EventCatalog.
- *
- * You can optionally override the path of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDataProduct } = utils('/path/to/eventcatalog');
- *
- * // Write a data product to the catalog
- * // Data product would be written to data-products/CustomerDataProduct
- * await writeDataProduct({
- *   id: 'CustomerDataProduct',
- *   name: 'Customer Data Product',
- *   version: '0.0.1',
- *   summary: 'Customer data product',
- *   markdown: '# Customer data product',
- * });
- *
- * // Write a data product to the catalog but override the path
- * // Data product would be written to data-products/Account/CustomerDataProduct
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { path: "/Account/CustomerDataProduct"});
- *
- * // Write a data product to the catalog and override the existing content (if there is any)
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { override: true });
- *
- * // Write a data product to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeDataProduct: (directory: string) => (dataProduct: DataProduct, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write a data product to a domain in EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDataProductToDomain } = utils('/path/to/eventcatalog');
- *
- * // Write a data product to a domain
- * // Data product would be written to domains/Shopping/data-products/CustomerDataProduct
- * await writeDataProductToDomain({
- *   id: 'CustomerDataProduct',
- *   name: 'Customer Data Product',
- *   version: '0.0.1',
- *   summary: 'Customer data product',
- *   markdown: '# Customer data product',
- * }, { id: 'Shopping' });
- * ```
- */
-declare const writeDataProductToDomain: (directory: string) => (dataProduct: DataProduct, domain: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a data product at its given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDataProduct } = utils('/path/to/eventcatalog');
- *
- * // removes a data product at the given path (data-products dir is appended to the given path)
- * // Removes the data product at data-products/CustomerDataProduct
- * await rmDataProduct('/CustomerDataProduct');
- * ```
- */
-declare const rmDataProduct: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a data product by its id.
- *
- * Optionally specify a version to delete a specific version of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDataProductById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest CustomerDataProduct data product
- * await rmDataProductById('CustomerDataProduct');
- *
- * // deletes a specific version of the CustomerDataProduct data product
- * await rmDataProductById('CustomerDataProduct', '0.0.1');
- * ```
- */
-declare const rmDataProductById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a data product by its id.
- *
- * Takes the latest data product and moves it to a versioned directory.
- * All files with this data product are also versioned (e.g /data-products/CustomerDataProduct/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionDataProduct } = utils('/path/to/eventcatalog');
- *
- * // moves the latest CustomerDataProduct data product to a versioned directory
- * // the version within that data product is used as the version number.
- * await versionDataProduct('CustomerDataProduct');
- *
- * ```
- */
-declare const versionDataProduct: (directory: string) => (id: string) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { dataProductHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given data product and version (supports semver)
- * await dataProductHasVersion('CustomerDataProduct', '0.0.1');
- * await dataProductHasVersion('CustomerDataProduct', 'latest');
- * await dataProductHasVersion('CustomerDataProduct', '0.0.x');
- *
- * ```
- */
-declare const dataProductHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a file to a data product by its id.
- *
- * Optionally specify a version to add a file to a specific version of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToDataProduct } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest CustomerDataProduct data product
- * await addFileToDataProduct('CustomerDataProduct', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the CustomerDataProduct data product
- * await addFileToDataProduct('CustomerDataProduct', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToDataProduct: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-
-export { addFileToDataProduct, dataProductHasVersion, getDataProduct, getDataProducts, rmDataProduct, rmDataProductById, versionDataProduct, writeDataProduct, writeDataProductToDomain };