@eventcatalog/sdk 1.3.2 → 1.4.0

package/dist/teams.d.mts

@@ -0,0 +1,83 @@
+import { Team } from './types.d.mjs';
+
+/**
+ * Returns a team from EventCatalog.
+ *
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getTeam } = utils('/path/to/eventcatalog');
+ *
+ * // Gets the team with the given id
+ * const team = await getTeam('eventcatalog-core-team');
+ *
+ * ```
+ */
+declare const getTeam: (catalogDir: string) => (id: string) => Promise<Team | undefined>;
+/**
+ * Returns all teams from EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getTeams } = utils('/path/to/eventcatalog');
+ *
+ * // Gets all teams from the catalog
+ * const channels = await getTeams();
+ *
+ * ```
+ */
+declare const getTeams: (catalogDir: string) => (options?: {}) => Promise<Team[]>;
+/**
+ * Write a team to EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { writeTeam } = utils('/path/to/eventcatalog');
+ *
+ * // Write a team to the catalog
+ * // team would be written to teams/EventCatalogCoreTeam
+ * await writeTeam({
+ *   id: 'eventcatalog-core-team',
+ *   name: 'EventCatalogCoreTeam',
+ *   members: ['dboyne', 'asmith', 'msmith'],
+ *   email: 'test@test.com',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * });
+ *
+ * // Write a team to the catalog and override the existing content (if there is any)
+ * await writeTeam({
+ *   id: 'eventcatalog-core-team',
+ *   name: 'EventCatalogCoreTeam',
+ *   members: ['dboyne', 'asmith', 'msmith'],
+ *   email: 'test@test.com',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * }, { override: true });
+ *
+ * ```
+ */
+declare const writeTeam: (catalogDir: string) => (team: Team, options?: {
+    override?: boolean;
+}) => Promise<void>;
+/**
+ * Delete a team by it's id.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmTeamById } = utils('/path/to/eventcatalog');
+ *
+ * // deletes the EventCatalogCoreTeam team
+ * await rmTeamById('eventcatalog-core-team');
+ *
+ * ```
+ */
+declare const rmTeamById: (catalogDir: string) => (id: string) => Promise<void>;
+
+export { getTeam, getTeams, rmTeamById, writeTeam };

package/dist/teams.d.ts

@@ -0,0 +1,83 @@
+import { Team } from './types.d.js';
+
+/**
+ * Returns a team from EventCatalog.
+ *
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getTeam } = utils('/path/to/eventcatalog');
+ *
+ * // Gets the team with the given id
+ * const team = await getTeam('eventcatalog-core-team');
+ *
+ * ```
+ */
+declare const getTeam: (catalogDir: string) => (id: string) => Promise<Team | undefined>;
+/**
+ * Returns all teams from EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getTeams } = utils('/path/to/eventcatalog');
+ *
+ * // Gets all teams from the catalog
+ * const channels = await getTeams();
+ *
+ * ```
+ */
+declare const getTeams: (catalogDir: string) => (options?: {}) => Promise<Team[]>;
+/**
+ * Write a team to EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { writeTeam } = utils('/path/to/eventcatalog');
+ *
+ * // Write a team to the catalog
+ * // team would be written to teams/EventCatalogCoreTeam
+ * await writeTeam({
+ *   id: 'eventcatalog-core-team',
+ *   name: 'EventCatalogCoreTeam',
+ *   members: ['dboyne', 'asmith', 'msmith'],
+ *   email: 'test@test.com',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * });
+ *
+ * // Write a team to the catalog and override the existing content (if there is any)
+ * await writeTeam({
+ *   id: 'eventcatalog-core-team',
+ *   name: 'EventCatalogCoreTeam',
+ *   members: ['dboyne', 'asmith', 'msmith'],
+ *   email: 'test@test.com',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * }, { override: true });
+ *
+ * ```
+ */
+declare const writeTeam: (catalogDir: string) => (team: Team, options?: {
+    override?: boolean;
+}) => Promise<void>;
+/**
+ * Delete a team by it's id.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmTeamById } = utils('/path/to/eventcatalog');
+ *
+ * // deletes the EventCatalogCoreTeam team
+ * await rmTeamById('eventcatalog-core-team');
+ *
+ * ```
+ */
+declare const rmTeamById: (catalogDir: string) => (id: string) => Promise<void>;
+
+export { getTeam, getTeams, rmTeamById, writeTeam };

package/dist/teams.js

@@ -0,0 +1,107 @@
+"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/teams.ts
+var teams_exports = {};
+__export(teams_exports, {
+  getTeam: () => getTeam,
+  getTeams: () => getTeams,
+  rmTeamById: () => rmTeamById,
+  writeTeam: () => writeTeam
+});
+module.exports = __toCommonJS(teams_exports);
+var import_promises2 = __toESM(require("fs/promises"));
+var import_node_path2 = require("path");
+var import_gray_matter2 = __toESM(require("gray-matter"));
+
+// src/internal/utils.ts
+var import_glob = require("glob");
+var import_promises = __toESM(require("fs/promises"));
+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 files = await (0, import_glob.glob)(pattern, { ignore: ["node_modules/**", ignore] });
+    return files;
+  } catch (error) {
+    throw new Error(`Error finding files: ${error}`);
+  }
+};
+
+// src/teams.ts
+var getTeam = (catalogDir) => async (id) => {
+  const files = await getFiles(`${catalogDir}/${id}.md`);
+  if (files.length == 0) return void 0;
+  const file = files[0];
+  const { data, content } = import_gray_matter2.default.read(file);
+  return {
+    ...data,
+    id: data.id,
+    name: data.name,
+    markdown: content.trim()
+  };
+};
+var getTeams = (catalogDir) => async (options) => {
+  const files = await getFiles(`${catalogDir}/teams/*.md`);
+  if (files.length === 0) return [];
+  return files.map((file) => {
+    const { data, content } = import_gray_matter2.default.read(file);
+    return {
+      ...data,
+      id: data.id,
+      name: data.name,
+      markdown: content.trim()
+    };
+  });
+};
+var writeTeam = (catalogDir) => async (team, options = {}) => {
+  const resource = { ...team };
+  const currentTeam = await getTeam(catalogDir)(resource.id);
+  const exists = currentTeam !== void 0;
+  if (exists && !options.override) {
+    throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
+  }
+  const { markdown, ...frontmatter } = resource;
+  const document = import_gray_matter2.default.stringify(markdown, frontmatter);
+  await import_promises2.default.mkdir((0, import_node_path2.join)(catalogDir, ""), { recursive: true });
+  await import_promises2.default.writeFile((0, import_node_path2.join)(catalogDir, "", `${resource.id}.md`), document);
+};
+var rmTeamById = (catalogDir) => async (id) => {
+  await import_promises2.default.rm((0, import_node_path2.join)(catalogDir, `${id}.md`), { recursive: true });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getTeam,
+  getTeams,
+  rmTeamById,
+  writeTeam
+});
+//# sourceMappingURL=teams.js.map

package/dist/teams.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/teams.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\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`);\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`);\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    await fs.mkdir(join(catalogDir, ''), { recursive: true });\n    await fs.writeFile(join(catalogDir, '', `${resource.id}.md`), 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}.md`), { recursive: true });\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\nimport matter from 'gray-matter';\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`);\n  const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n  return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id)) || [];\n  const latestVersion = matchedFiles.find((path) => !path.includes('versioned'));\n\n  // If no version is provided, return the latest version\n  if (!version) {\n    return latestVersion;\n  }\n\n  // 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 = '') => {\n  try {\n    const files = await glob(pattern, { ignore: ['node_modules/**', ignore] });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\n  }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = await Promise.all(\n    files.map(async (file) => {\n      const content = await fs.readFile(file, 'utf-8');\n      const hasIdMatch = content.match(idRegex);\n\n      // Check version if provided\n      if (version && !content.match(versionRegex)) {\n        return undefined;\n      }\n\n      if (hasIdMatch) {\n        return file;\n      }\n    })\n  );\n\n  return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n  const tmpDirectory = join(catalogDir, 'tmp');\n  await fs.mkdir(tmpDirectory, { recursive: true });\n\n  // Copy everything over\n  await copy(source, tmpDirectory, {\n    overwrite: true,\n    filter,\n  });\n\n  await copy(tmpDirectory, target, {\n    overwrite: true,\n    filter,\n  });\n\n  // Remove the tmp directory\n  await fs.rm(tmpDirectory, { recursive: true });\n};\n\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;AAAA,IAAAA,mBAAe;AACf,IAAAC,oBAAqB;AAErB,IAAAC,sBAAmB;;;ACHnB,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AACrB,yBAAmB;AACnB,oBAA6C;AA+CtC,IAAM,WAAW,OAAO,SAAiB,SAAiB,OAAO;AACtE,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,CAAC,mBAAmB,MAAM,EAAE,CAAC;AACzE,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;;;ADtCO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,KAAK;AAErD,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,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAgBK,IAAM,WACX,CAAC,eACD,OAAO,YAAkC;AACvC,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,aAAa;AACvD,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,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,QAAM,iBAAAC,QAAG,UAAM,wBAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD,QAAM,iBAAAA,QAAG,cAAU,wBAAK,YAAY,IAAI,GAAG,SAAS,EAAE,KAAK,GAAG,QAAQ;AACxE;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,QAAM,iBAAAA,QAAG,OAAG,wBAAK,YAAY,GAAG,EAAE,KAAK,GAAG,EAAE,WAAW,KAAK,CAAC;AAC/D;","names":["import_promises","import_node_path","import_gray_matter","matter","fs"]}

package/dist/teams.mjs

@@ -0,0 +1,67 @@
+// src/teams.ts
+import fs from "node:fs/promises";
+import { join } from "node:path";
+import matter2 from "gray-matter";
+
+// src/internal/utils.ts
+import { glob } from "glob";
+import { copy } from "fs-extra";
+import matter from "gray-matter";
+import { satisfies, validRange, valid } from "semver";
+var getFiles = async (pattern, ignore = "") => {
+  try {
+    const files = await glob(pattern, { ignore: ["node_modules/**", ignore] });
+    return files;
+  } catch (error) {
+    throw new Error(`Error finding files: ${error}`);
+  }
+};
+
+// src/teams.ts
+var getTeam = (catalogDir) => async (id) => {
+  const files = await getFiles(`${catalogDir}/${id}.md`);
+  if (files.length == 0) return void 0;
+  const file = files[0];
+  const { data, content } = matter2.read(file);
+  return {
+    ...data,
+    id: data.id,
+    name: data.name,
+    markdown: content.trim()
+  };
+};
+var getTeams = (catalogDir) => async (options) => {
+  const files = await getFiles(`${catalogDir}/teams/*.md`);
+  if (files.length === 0) return [];
+  return files.map((file) => {
+    const { data, content } = matter2.read(file);
+    return {
+      ...data,
+      id: data.id,
+      name: data.name,
+      markdown: content.trim()
+    };
+  });
+};
+var writeTeam = (catalogDir) => async (team, options = {}) => {
+  const resource = { ...team };
+  const currentTeam = await getTeam(catalogDir)(resource.id);
+  const exists = currentTeam !== void 0;
+  if (exists && !options.override) {
+    throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
+  }
+  const { markdown, ...frontmatter } = resource;
+  const document = matter2.stringify(markdown, frontmatter);
+  await fs.mkdir(join(catalogDir, ""), { recursive: true });
+  await fs.writeFile(join(catalogDir, "", `${resource.id}.md`), document);
+};
+var rmTeamById = (catalogDir) => async (id) => {
+  await fs.rm(join(catalogDir, `${id}.md`), { recursive: true });
+};
+export {
+  getTeam,
+  getTeams,
+  rmTeamById,
+  writeTeam
+};
+//# sourceMappingURL=teams.mjs.map

package/dist/teams.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/teams.ts","../src/internal/utils.ts"],"sourcesContent":["import fs from 'node:fs/promises';\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`);\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`);\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    await fs.mkdir(join(catalogDir, ''), { recursive: true });\n    await fs.writeFile(join(catalogDir, '', `${resource.id}.md`), 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}.md`), { recursive: true });\n};\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\nimport matter from 'gray-matter';\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`);\n  const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n  return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id)) || [];\n  const latestVersion = matchedFiles.find((path) => !path.includes('versioned'));\n\n  // If no version is provided, return the latest version\n  if (!version) {\n    return latestVersion;\n  }\n\n  // 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 = '') => {\n  try {\n    const files = await glob(pattern, { ignore: ['node_modules/**', ignore] });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\n  }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  const idRegex = new RegExp(`^id:\\\\s*(['\"]|>-)?\\\\s*${id}['\"]?\\\\s*$`, 'm');\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = await Promise.all(\n    files.map(async (file) => {\n      const content = await fs.readFile(file, 'utf-8');\n      const hasIdMatch = content.match(idRegex);\n\n      // Check version if provided\n      if (version && !content.match(versionRegex)) {\n        return undefined;\n      }\n\n      if (hasIdMatch) {\n        return file;\n      }\n    })\n  );\n\n  return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n  const tmpDirectory = join(catalogDir, 'tmp');\n  await fs.mkdir(tmpDirectory, { recursive: true });\n\n  // Copy everything over\n  await copy(source, tmpDirectory, {\n    overwrite: true,\n    filter,\n  });\n\n  await copy(tmpDirectory, target, {\n    overwrite: true,\n    filter,\n  });\n\n  // Remove the tmp directory\n  await fs.rm(tmpDirectory, { recursive: true });\n};\n\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,SAAS,YAAY;AAErB,OAAOA,aAAY;;;ACHnB,SAAS,YAAY;AAErB,SAAS,YAA6C;AAEtD,OAAO,YAAY;AACnB,SAAS,WAAW,YAAY,aAAa;AA+CtC,IAAM,WAAW,OAAO,SAAiB,SAAiB,OAAO;AACtE,MAAI;AACF,UAAM,QAAQ,MAAM,KAAK,SAAS,EAAE,QAAQ,CAAC,mBAAmB,MAAM,EAAE,CAAC;AACzE,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;;;ADtCO,IAAM,UACX,CAAC,eACD,OAAO,OAA0C;AAC/C,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,IAAI,EAAE,KAAK;AAErD,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,aAAa;AACvD,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,QAAM,GAAG,MAAM,KAAK,YAAY,EAAE,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD,QAAM,GAAG,UAAU,KAAK,YAAY,IAAI,GAAG,SAAS,EAAE,KAAK,GAAG,QAAQ;AACxE;AAgBK,IAAM,aAAa,CAAC,eAAuB,OAAO,OAAe;AACtE,QAAM,GAAG,GAAG,KAAK,YAAY,GAAG,EAAE,KAAK,GAAG,EAAE,WAAW,KAAK,CAAC;AAC/D;","names":["matter","matter"]}

package/dist/types.d.d.mts

@@ -70,6 +70,7 @@ interface Team {
   ownedCommands?: Command[];
   ownedServices?: Service[];
   ownedEvents?: Event[];
+  markdown: string;
 }
 
 interface User {
@@ -84,6 +85,7 @@ interface User {
   ownedEvents?: Event[];
   ownedCommands?: Command[];
   associatedTeams?: Team[];
+  markdown: string;
 }
 
 interface Badge {

package/dist/types.d.d.ts

@@ -70,6 +70,7 @@ interface Team {
   ownedCommands?: Command[];
   ownedServices?: Service[];
   ownedEvents?: Event[];
+  markdown: string;
 }
 
 interface User {
@@ -84,6 +85,7 @@ interface User {
   ownedEvents?: Event[];
   ownedCommands?: Command[];
   associatedTeams?: Team[];
+  markdown: string;
 }
 
 interface Badge {

package/dist/types.d.js.map

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

package/dist/users.d.mts

@@ -0,0 +1,83 @@
+import { User } from './types.d.mjs';
+
+/**
+ * Returns a user from EventCatalog.
+ *
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getUser } = utils('/path/to/eventcatalog');
+ *
+ * // Gets the user with the given id
+ * const user = await getUser('eventcatalog-core-user');
+ *
+ * ```
+ */
+declare const getUser: (catalogDir: string) => (id: string) => Promise<User | undefined>;
+/**
+ * Returns all users from EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getUsers } = utils('/path/to/eventcatalog');
+ *
+ * // Gets all users from the catalog
+ * const channels = await getUsers();
+ *
+ * ```
+ */
+declare const getUsers: (catalogDir: string) => (options?: {}) => Promise<User[]>;
+/**
+ * Write a user to EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { writeUser } = utils('/path/to/eventcatalog');
+ *
+ * // Write a user to the catalog
+ * // user would be written to users/eventcatalog-tech-lead
+ * await writeUser({
+ *   id: 'eventcatalog-tech-lead',
+ *   name: 'EventCatalog Tech Lead',
+ *   email: 'test@test.com',
+ *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * });
+ *
+ * // Write a team to the catalog and override the existing content (if there is any)
+ * await writeUser({
+ *   id: 'eventcatalog-tech-lead',
+ *   name: 'EventCatalog Tech Lead',
+ *   email: 'test@test.com',
+ *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * }, { override: true });
+ *
+ * ```
+ */
+declare const writeUser: (catalogDir: string) => (user: User, options?: {
+    override?: boolean;
+}) => Promise<void>;
+/**
+ * Delete a user by it's id.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmUserById } = utils('/path/to/eventcatalog');
+ *
+ * // deletes the user with id eventcatalog-core-user
+ * await rmUserById('eventcatalog-core-user');
+ *
+ * ```
+ */
+declare const rmUserById: (catalogDir: string) => (id: string) => Promise<void>;
+
+export { getUser, getUsers, rmUserById, writeUser };

package/dist/users.d.ts

@@ -0,0 +1,83 @@
+import { User } from './types.d.js';
+
+/**
+ * Returns a user from EventCatalog.
+ *
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getUser } = utils('/path/to/eventcatalog');
+ *
+ * // Gets the user with the given id
+ * const user = await getUser('eventcatalog-core-user');
+ *
+ * ```
+ */
+declare const getUser: (catalogDir: string) => (id: string) => Promise<User | undefined>;
+/**
+ * Returns all users from EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getUsers } = utils('/path/to/eventcatalog');
+ *
+ * // Gets all users from the catalog
+ * const channels = await getUsers();
+ *
+ * ```
+ */
+declare const getUsers: (catalogDir: string) => (options?: {}) => Promise<User[]>;
+/**
+ * Write a user to EventCatalog.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { writeUser } = utils('/path/to/eventcatalog');
+ *
+ * // Write a user to the catalog
+ * // user would be written to users/eventcatalog-tech-lead
+ * await writeUser({
+ *   id: 'eventcatalog-tech-lead',
+ *   name: 'EventCatalog Tech Lead',
+ *   email: 'test@test.com',
+ *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * });
+ *
+ * // Write a team to the catalog and override the existing content (if there is any)
+ * await writeUser({
+ *   id: 'eventcatalog-tech-lead',
+ *   name: 'EventCatalog Tech Lead',
+ *   email: 'test@test.com',
+ *   avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+ *   slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
+ * }, { override: true });
+ *
+ * ```
+ */
+declare const writeUser: (catalogDir: string) => (user: User, options?: {
+    override?: boolean;
+}) => Promise<void>;
+/**
+ * Delete a user by it's id.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmUserById } = utils('/path/to/eventcatalog');
+ *
+ * // deletes the user with id eventcatalog-core-user
+ * await rmUserById('eventcatalog-core-user');
+ *
+ * ```
+ */
+declare const rmUserById: (catalogDir: string) => (id: string) => Promise<void>;
+
+export { getUser, getUsers, rmUserById, writeUser };