@eventcatalog/sdk 2.2.9 → 2.3.0

package/dist/teams.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/teams.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { Team } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a team from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getTeam } = utils('/path/to/eventcatalog');\n *\n * // Gets the team with the given id\n * const team = await getTeam('eventcatalog-core-team');\n *\n * ```\n */\nexport const getTeam =\n  (catalogDir: string) =>\n  async (id: string): Promise<Team | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      markdown: content.trim(),\n    } as Team;\n  };\n\n/**\n * Returns all teams from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getTeams } = utils('/path/to/eventcatalog');\n *\n * // Gets all teams from the catalog\n * const channels = await getTeams();\n *\n * ```\n */\nexport const getTeams =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<Team[]> => {\n    const files = await getFiles(`${catalogDir}/teams/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        markdown: content.trim(),\n      } as Team;\n    });\n  };\n\n/**\n * Write a team to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeTeam } = utils('/path/to/eventcatalog');\n *\n * // Write a team to the catalog\n * // team would be written to teams/EventCatalogCoreTeam\n * await writeTeam({\n *   id: 'eventcatalog-core-team',\n *   name: 'EventCatalogCoreTeam',\n *   members: ['dboyne', 'asmith', 'msmith'],\n *   email: 'test@test.com',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeTeam({\n *   id: 'eventcatalog-core-team',\n *   name: 'EventCatalogCoreTeam',\n *   members: ['dboyne', 'asmith', 'msmith'],\n *   email: 'test@test.com',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeTeam =\n  (catalogDir: string) =>\n  async (team: Team, options: { override?: boolean } = {}) => {\n    const resource: Team = { ...team };\n\n    // Get the path\n    const currentTeam = await getTeam(catalogDir)(resource.id);\n    const exists = currentTeam !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (team) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a team by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmTeamById } = utils('/path/to/eventcatalog');\n *\n * // deletes the EventCatalogCoreTeam team\n * await rmTeamById('eventcatalog-core-team');\n *\n * ```\n */\nexport const rmTeamById = (catalogDir: string) => async (id: string) => {\n  await fs.rm(join(catalogDir, `${id}.mdx`), { recursive: true });\n};\n","import { globSync } from 'glob';\nimport fsSync from 'node:fs';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join, dirname } 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\n};\n\nexport const getFiles = async (pattern: string, ignore: string | string[] = '') => {\n  try {\n    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];\n    const baseDir = pattern.includes('**') ? pattern.split('**')[0] : dirname(pattern);\n    const files = globSync(pattern, { cwd: baseDir, ignore: ['node_modules/**', ...ignoreList] });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";AAAA,OAAO,QAAQ;AACf,OAAO,YAAY;AACnB,SAAS,QAAAA,aAAY;AAErB,OAAOC,aAAY;;;ACJnB,SAAS,gBAAgB;AAEzB,SAAS,YAA6C;AACtD,SAAS,MAAM,eAAe;AAC9B,OAAO,YAAY;AACnB,SAAS,WAAW,YAAY,aAAa;AAgDtC,IAAM,WAAW,OAAO,SAAiB,SAA4B,OAAO;AACjF,MAAI;AACF,UAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;AAC3D,UAAM,UAAU,QAAQ,SAAS,IAAI,IAAI,QAAQ,MAAM,IAAI,EAAE,CAAC,IAAI,QAAQ,OAAO;AACjF,UAAM,QAAQ,SAAS,SAAS,EAAE,KAAK,SAAS,QAAQ,CAAC,mBAAmB,GAAG,UAAU,EAAE,CAAC;AAC5F,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;;;ADxCO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAIC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAIA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAWA,QAAO,UAAU,UAAU,WAAW;AACvD,SAAO,UAAUC,MAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,SAAO,cAAcA,MAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,QAAM,GAAG,GAAGA,MAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAChE;","names":["join","matter","matter","join"]}
+{"version":3,"sources":["../src/teams.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { Team } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a team from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getTeam } = utils('/path/to/eventcatalog');\n *\n * // Gets the team with the given id\n * const team = await getTeam('eventcatalog-core-team');\n *\n * ```\n */\nexport const getTeam =\n  (catalogDir: string) =>\n  async (id: string): Promise<Team | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      markdown: content.trim(),\n    } as Team;\n  };\n\n/**\n * Returns all teams from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getTeams } = utils('/path/to/eventcatalog');\n *\n * // Gets all teams from the catalog\n * const channels = await getTeams();\n *\n * ```\n */\nexport const getTeams =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<Team[]> => {\n    const files = await getFiles(`${catalogDir}/teams/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        markdown: content.trim(),\n      } as Team;\n    });\n  };\n\n/**\n * Write a team to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeTeam } = utils('/path/to/eventcatalog');\n *\n * // Write a team to the catalog\n * // team would be written to teams/EventCatalogCoreTeam\n * await writeTeam({\n *   id: 'eventcatalog-core-team',\n *   name: 'EventCatalogCoreTeam',\n *   members: ['dboyne', 'asmith', 'msmith'],\n *   email: 'test@test.com',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeTeam({\n *   id: 'eventcatalog-core-team',\n *   name: 'EventCatalogCoreTeam',\n *   members: ['dboyne', 'asmith', 'msmith'],\n *   email: 'test@test.com',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeTeam =\n  (catalogDir: string) =>\n  async (team: Team, options: { override?: boolean } = {}) => {\n    const resource: Team = { ...team };\n\n    // Get the path\n    const currentTeam = await getTeam(catalogDir)(resource.id);\n    const exists = currentTeam !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (team) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a team by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmTeamById } = utils('/path/to/eventcatalog');\n *\n * // deletes the EventCatalogCoreTeam team\n * await rmTeamById('eventcatalog-core-team');\n *\n * ```\n */\nexport const rmTeamById = (catalogDir: string) => async (id: string) => {\n  await fs.rm(join(catalogDir, `${id}.mdx`), { 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";AAAA,OAAO,QAAQ;AACf,OAAO,YAAY;AACnB,SAAS,QAAAA,aAAY;AAErB,OAAOC,aAAY;;;ACJnB,SAAS,gBAAgB;AAEzB,SAAS,YAA6C;AACtD,SAAS,MAAM,SAAS,WAAiC,SAAmB,gBAAgB;AAC5F,OAAO,YAAY;AACnB,SAAS,WAAW,YAAY,aAAa;AAgDtC,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;;;AD5EO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAIC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAIA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAWA,QAAO,UAAU,UAAU,WAAW;AACvD,SAAO,UAAUC,MAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,SAAO,cAAcA,MAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,QAAM,GAAG,GAAGA,MAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAChE;","names":["join","matter","matter","join"]}

package/dist/users.js

@@ -49,12 +49,28 @@ 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 baseDir = pattern.includes("**") ? pattern.split("**")[0] : (0, import_node_path.dirname)(pattern);
-    const files = (0, import_glob.globSync)(pattern, { cwd: baseDir, ignore: ["node_modules/**", ...ignoreList] });
-    return files;
+    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) {
-    throw new Error(`Error finding files: ${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}`
+    );
   }
 };
 

package/dist/users.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/users.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { User } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a user from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUser } = utils('/path/to/eventcatalog');\n *\n * // Gets the user with the given id\n * const user = await getUser('eventcatalog-core-user');\n *\n * ```\n */\nexport const getUser =\n  (catalogDir: string) =>\n  async (id: string): Promise<User | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      avatarUrl: data.avatarUrl,\n      markdown: content.trim(),\n    } as User;\n  };\n\n/**\n * Returns all users from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUsers } = utils('/path/to/eventcatalog');\n *\n * // Gets all users from the catalog\n * const channels = await getUsers();\n *\n * ```\n */\nexport const getUsers =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<User[]> => {\n    const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        avatarUrl: data.avatarUrl,\n        markdown: content.trim(),\n      } as User;\n    });\n  };\n\n/**\n * Write a user to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeUser } = utils('/path/to/eventcatalog');\n *\n * // Write a user to the catalog\n * // user would be written to users/eventcatalog-tech-lead\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeUser =\n  (catalogDir: string) =>\n  async (user: User, options: { override?: boolean } = {}) => {\n    const resource: User = { ...user };\n\n    // Get the path\n    const currentUser = await getUser(catalogDir)(resource.id);\n    const exists = currentUser !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (user) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a user by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmUserById } = utils('/path/to/eventcatalog');\n *\n * // deletes the user with id eventcatalog-core-user\n * await rmUserById('eventcatalog-core-user');\n *\n * ```\n */\nexport const rmUserById = (catalogDir: string) => async (id: string) => {\n  fsSync.rmSync(join(catalogDir, `${id}.mdx`), { recursive: true });\n};\n","import { globSync } from 'glob';\nimport fsSync from 'node:fs';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join, dirname } 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\n};\n\nexport const getFiles = async (pattern: string, ignore: string | string[] = '') => {\n  try {\n    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];\n    const baseDir = pattern.includes('**') ? pattern.split('**')[0] : dirname(pattern);\n    const files = globSync(pattern, { cwd: baseDir, ignore: ['node_modules/**', ...ignoreList] });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,IAAAA,kBAAmB;AACnB,IAAAC,oBAAqB;AAErB,IAAAC,sBAAmB;;;ACJnB,kBAAyB;AACzB,qBAAmB;AACnB,sBAAsD;AACtD,uBAA8B;AAC9B,yBAAmB;AACnB,oBAA6C;AAgDtC,IAAM,WAAW,OAAO,SAAiB,SAA4B,OAAO;AACjF,MAAI;AACF,UAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;AAC3D,UAAM,UAAU,QAAQ,SAAS,IAAI,IAAI,QAAQ,MAAM,IAAI,EAAE,CAAC,QAAI,0BAAQ,OAAO;AACjF,UAAM,YAAQ,sBAAS,SAAS,EAAE,KAAK,SAAS,QAAQ,CAAC,mBAAmB,GAAG,UAAU,EAAE,CAAC;AAC5F,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;;;ADxCO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,WAAW,KAAK;AAAA,IAChB,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAW,oBAAAA,QAAO,UAAU,UAAU,WAAW;AACvD,kBAAAC,QAAO,cAAU,wBAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,kBAAAA,QAAO,kBAAc,wBAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,kBAAAA,QAAO,WAAO,wBAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAClE;","names":["import_node_fs","import_node_path","import_gray_matter","matter","fsSync"]}
+{"version":3,"sources":["../src/users.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { User } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a user from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUser } = utils('/path/to/eventcatalog');\n *\n * // Gets the user with the given id\n * const user = await getUser('eventcatalog-core-user');\n *\n * ```\n */\nexport const getUser =\n  (catalogDir: string) =>\n  async (id: string): Promise<User | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      avatarUrl: data.avatarUrl,\n      markdown: content.trim(),\n    } as User;\n  };\n\n/**\n * Returns all users from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUsers } = utils('/path/to/eventcatalog');\n *\n * // Gets all users from the catalog\n * const channels = await getUsers();\n *\n * ```\n */\nexport const getUsers =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<User[]> => {\n    const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        avatarUrl: data.avatarUrl,\n        markdown: content.trim(),\n      } as User;\n    });\n  };\n\n/**\n * Write a user to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeUser } = utils('/path/to/eventcatalog');\n *\n * // Write a user to the catalog\n * // user would be written to users/eventcatalog-tech-lead\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeUser =\n  (catalogDir: string) =>\n  async (user: User, options: { override?: boolean } = {}) => {\n    const resource: User = { ...user };\n\n    // Get the path\n    const currentUser = await getUser(catalogDir)(resource.id);\n    const exists = currentUser !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (user) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a user by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmUserById } = utils('/path/to/eventcatalog');\n *\n * // deletes the user with id eventcatalog-core-user\n * await rmUserById('eventcatalog-core-user');\n *\n * ```\n */\nexport const rmUserById = (catalogDir: string) => async (id: string) => {\n  fsSync.rmSync(join(catalogDir, `${id}.mdx`), { 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,IAAAA,kBAAmB;AACnB,IAAAC,oBAAqB;AAErB,IAAAC,sBAAmB;;;ACJnB,kBAAyB;AACzB,qBAAmB;AACnB,sBAAsD;AACtD,uBAA4F;AAC5F,yBAAmB;AACnB,oBAA6C;AAgDtC,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;;;AD5EO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,WAAW,KAAK;AAAA,IAChB,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAI,oBAAAA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAW,oBAAAA,QAAO,UAAU,UAAU,WAAW;AACvD,kBAAAC,QAAO,cAAU,wBAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,kBAAAA,QAAO,kBAAc,wBAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,kBAAAA,QAAO,WAAO,wBAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAClE;","names":["import_node_fs","import_node_path","import_gray_matter","matter","fsSync"]}

package/dist/users.mjs

@@ -6,17 +6,33 @@ import matter2 from "gray-matter";
 // src/internal/utils.ts
 import { globSync } from "glob";
 import { copy } from "fs-extra";
-import { join, dirname } from "node:path";
+import { join, dirname, normalize, resolve, relative } from "node:path";
 import matter from "gray-matter";
 import { satisfies, validRange, valid } 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 baseDir = pattern.includes("**") ? pattern.split("**")[0] : dirname(pattern);
-    const files = globSync(pattern, { cwd: baseDir, ignore: ["node_modules/**", ...ignoreList] });
-    return files;
+    const files = globSync(relativePattern, {
+      cwd: absoluteBaseDir,
+      ignore: ["node_modules/**", ...ignoreList],
+      absolute: true,
+      nodir: true
+    });
+    return files.map(normalize);
   } catch (error) {
-    throw new Error(`Error finding files: ${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}`
+    );
   }
 };
 

package/dist/users.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/users.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { User } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a user from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUser } = utils('/path/to/eventcatalog');\n *\n * // Gets the user with the given id\n * const user = await getUser('eventcatalog-core-user');\n *\n * ```\n */\nexport const getUser =\n  (catalogDir: string) =>\n  async (id: string): Promise<User | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      avatarUrl: data.avatarUrl,\n      markdown: content.trim(),\n    } as User;\n  };\n\n/**\n * Returns all users from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUsers } = utils('/path/to/eventcatalog');\n *\n * // Gets all users from the catalog\n * const channels = await getUsers();\n *\n * ```\n */\nexport const getUsers =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<User[]> => {\n    const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        avatarUrl: data.avatarUrl,\n        markdown: content.trim(),\n      } as User;\n    });\n  };\n\n/**\n * Write a user to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeUser } = utils('/path/to/eventcatalog');\n *\n * // Write a user to the catalog\n * // user would be written to users/eventcatalog-tech-lead\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeUser =\n  (catalogDir: string) =>\n  async (user: User, options: { override?: boolean } = {}) => {\n    const resource: User = { ...user };\n\n    // Get the path\n    const currentUser = await getUser(catalogDir)(resource.id);\n    const exists = currentUser !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (user) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a user by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmUserById } = utils('/path/to/eventcatalog');\n *\n * // deletes the user with id eventcatalog-core-user\n * await rmUserById('eventcatalog-core-user');\n *\n * ```\n */\nexport const rmUserById = (catalogDir: string) => async (id: string) => {\n  fsSync.rmSync(join(catalogDir, `${id}.mdx`), { recursive: true });\n};\n","import { globSync } from 'glob';\nimport fsSync from 'node:fs';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join, dirname } 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\n};\n\nexport const getFiles = async (pattern: string, ignore: string | string[] = '') => {\n  try {\n    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];\n    const baseDir = pattern.includes('**') ? pattern.split('**')[0] : dirname(pattern);\n    const files = globSync(pattern, { cwd: baseDir, ignore: ['node_modules/**', ...ignoreList] });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";AACA,OAAO,YAAY;AACnB,SAAS,QAAAA,aAAY;AAErB,OAAOC,aAAY;;;ACJnB,SAAS,gBAAgB;AAEzB,SAAS,YAA6C;AACtD,SAAS,MAAM,eAAe;AAC9B,OAAO,YAAY;AACnB,SAAS,WAAW,YAAY,aAAa;AAgDtC,IAAM,WAAW,OAAO,SAAiB,SAA4B,OAAO;AACjF,MAAI;AACF,UAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;AAC3D,UAAM,UAAU,QAAQ,SAAS,IAAI,IAAI,QAAQ,MAAM,IAAI,EAAE,CAAC,IAAI,QAAQ,OAAO;AACjF,UAAM,QAAQ,SAAS,SAAS,EAAE,KAAK,SAAS,QAAQ,CAAC,mBAAmB,GAAG,UAAU,EAAE,CAAC;AAC5F,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;;;ADxCO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAIC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,WAAW,KAAK;AAAA,IAChB,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAIA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAWA,QAAO,UAAU,UAAU,WAAW;AACvD,SAAO,UAAUC,MAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,SAAO,cAAcA,MAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,SAAO,OAAOA,MAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAClE;","names":["join","matter","matter","join"]}
+{"version":3,"sources":["../src/users.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\nimport fsSync from 'node:fs';\nimport { join } from 'node:path';\nimport type { User } from './types';\nimport matter from 'gray-matter';\nimport { getFiles } from './internal/utils';\n\n/**\n * Returns a user from EventCatalog.\n *\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUser } = utils('/path/to/eventcatalog');\n *\n * // Gets the user with the given id\n * const user = await getUser('eventcatalog-core-user');\n *\n * ```\n */\nexport const getUser =\n  (catalogDir: string) =>\n  async (id: string): Promise<User | undefined> => {\n    const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);\n\n    if (files.length == 0) return undefined;\n    const file = files[0];\n\n    const { data, content } = matter.read(file);\n    return {\n      ...data,\n      id: data.id,\n      name: data.name,\n      avatarUrl: data.avatarUrl,\n      markdown: content.trim(),\n    } as User;\n  };\n\n/**\n * Returns all users from EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getUsers } = utils('/path/to/eventcatalog');\n *\n * // Gets all users from the catalog\n * const channels = await getUsers();\n *\n * ```\n */\nexport const getUsers =\n  (catalogDir: string) =>\n  async (options?: {}): Promise<User[]> => {\n    const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);\n    if (files.length === 0) return [];\n\n    return files.map((file) => {\n      const { data, content } = matter.read(file);\n      return {\n        ...data,\n        id: data.id,\n        name: data.name,\n        avatarUrl: data.avatarUrl,\n        markdown: content.trim(),\n      } as User;\n    });\n  };\n\n/**\n * Write a user to EventCatalog.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeUser } = utils('/path/to/eventcatalog');\n *\n * // Write a user to the catalog\n * // user would be written to users/eventcatalog-tech-lead\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * });\n *\n * // Write a team to the catalog and override the existing content (if there is any)\n * await writeUser({\n *   id: 'eventcatalog-tech-lead',\n *   name: 'EventCatalog Tech Lead',\n *   email: 'test@test.com',\n *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',\n *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123\n * }, { override: true });\n *\n * ```\n */\nexport const writeUser =\n  (catalogDir: string) =>\n  async (user: User, options: { override?: boolean } = {}) => {\n    const resource: User = { ...user };\n\n    // Get the path\n    const currentUser = await getUser(catalogDir)(resource.id);\n    const exists = currentUser !== undefined;\n\n    if (exists && !options.override) {\n      throw new Error(`Failed to write ${resource.id} (user) as it already exists`);\n    }\n\n    const { markdown, ...frontmatter } = resource;\n\n    const document = matter.stringify(markdown, frontmatter);\n    fsSync.mkdirSync(join(catalogDir, ''), { recursive: true });\n    fsSync.writeFileSync(join(catalogDir, '', `${resource.id}.mdx`), document);\n  };\n\n/**\n * Delete a user by it's id.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmUserById } = utils('/path/to/eventcatalog');\n *\n * // deletes the user with id eventcatalog-core-user\n * await rmUserById('eventcatalog-core-user');\n *\n * ```\n */\nexport const rmUserById = (catalogDir: string) => async (id: string) => {\n  fsSync.rmSync(join(catalogDir, `${id}.mdx`), { 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  const semverRange = validRange(version);\n\n  if (semverRange && valid(version)) {\n    const match = parsedFiles.filter((c) => satisfies(c.version, semverRange));\n    return match.length > 0 ? match[0].path : undefined;\n  }\n\n  // Order by version\n  const sorted = parsedFiles.sort((a, b) => {\n    return a.version.localeCompare(b.version);\n  });\n\n  // latest version\n  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];\n\n  if (match.length > 0) {\n    return match[0].path;\n  }\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  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\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"],"mappings":";AACA,OAAO,YAAY;AACnB,SAAS,QAAAA,aAAY;AAErB,OAAOC,aAAY;;;ACJnB,SAAS,gBAAgB;AAEzB,SAAS,YAA6C;AACtD,SAAS,MAAM,SAAS,WAAiC,SAAmB,gBAAgB;AAC5F,OAAO,YAAY;AACnB,SAAS,WAAW,YAAY,aAAa;AAgDtC,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;;;AD5EO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,WAAW;AAE3D,MAAI,MAAM,UAAU,EAAG,QAAO;AAC9B,QAAM,OAAO,MAAM,CAAC;AAEpB,QAAM,EAAE,MAAM,QAAQ,IAAIC,QAAO,KAAK,IAAI;AAC1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,IAAI,KAAK;AAAA,IACT,MAAM,KAAK;AAAA,IACX,WAAW,KAAK;AAAA,IAChB,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,mBAAmB;AAC7D,MAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,EAAE,MAAM,QAAQ,IAAIA,QAAO,KAAK,IAAI;AAC1C,WAAO;AAAA,MACL,GAAG;AAAA,MACH,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,UAAU,QAAQ,KAAK;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAgCK,IAAM,YACX,CAAC,eACD,OAAO,MAAY,UAAkC,CAAC,MAAM;AAC1D,QAAM,WAAiB,EAAE,GAAG,KAAK;AAGjC,QAAM,cAAc,MAAM,QAAQ,UAAU,EAAE,SAAS,EAAE;AACzD,QAAM,SAAS,gBAAgB;AAE/B,MAAI,UAAU,CAAC,QAAQ,UAAU;AAC/B,UAAM,IAAI,MAAM,mBAAmB,SAAS,EAAE,8BAA8B;AAAA,EAC9E;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AAErC,QAAM,WAAWA,QAAO,UAAU,UAAU,WAAW;AACvD,SAAO,UAAUC,MAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AAC1D,SAAO,cAAcA,MAAK,YAAY,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,QAAQ;AAC3E;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,SAAO,OAAOA,MAAK,YAAY,GAAG,EAAE,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;AAClE;","names":["join","matter","matter","join"]}

package/package.json

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