@eventcatalog/sdk 0.0.1 → 0.0.3

package/README.md

@@ -21,4 +21,3 @@ await getEvent('InventoryEvent');
 // Gets event by id and version
 await getEvent('InventoryEvent', '1.0.0');
 ```
-

package/dist/docs.d.mts

@@ -0,0 +1,2 @@
+export { addFileToEvent, addSchemaToEvent, getEvent, rmEvent, rmEventById, versionEvent, writeEvent } from './events.mjs';
+import './types.d.mjs';

package/dist/docs.d.ts

@@ -0,0 +1,2 @@
+export { addFileToEvent, addSchemaToEvent, getEvent, rmEvent, rmEventById, versionEvent, writeEvent } from './events.js';
+import './types.d.js';

package/dist/docs.js

@@ -0,0 +1,181 @@
+"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/docs.ts
+var docs_exports = {};
+__export(docs_exports, {
+  addFileToEvent: () => addFileToEvent,
+  addSchemaToEvent: () => addSchemaToEvent,
+  getEvent: () => getEvent,
+  rmEvent: () => rmEvent,
+  rmEventById: () => rmEventById,
+  versionEvent: () => versionEvent,
+  writeEvent: () => writeEvent
+});
+module.exports = __toCommonJS(docs_exports);
+
+// src/events.ts
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_promises2 = __toESM(require("fs/promises"));
+var import_node_path2 = require("path");
+var import_node_path3 = require("path");
+
+// 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 versionExists = async (catalogDir, id, version) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id, version) || [];
+  return matchedFiles.length > 0;
+};
+var findFileById = async (catalogDir, id, version) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id) || [];
+  if (!version) {
+    return matchedFiles.find((path) => !path.includes("versioned"));
+  }
+  return matchedFiles.find((path) => path.includes(`versioned/${version}`));
+};
+var getFiles = async (pattern) => {
+  try {
+    const files = await (0, import_glob.glob)(pattern, { ignore: "node_modules/**" });
+    return files;
+  } catch (error) {
+    throw new Error(`Error finding files: ${error}`);
+  }
+};
+var searchFilesForId = async (files, id, version) => {
+  const idRegex = new RegExp(`^id:\\s*['"]?${id}['"]?\\s*$`, "m");
+  const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
+  const matches = await Promise.all(
+    files.map(async (file) => {
+      const content = await import_promises.default.readFile(file, "utf-8");
+      const hasIdMatch = content.match(idRegex);
+      if (version && !content.match(versionRegex)) {
+        return void 0;
+      }
+      if (hasIdMatch) {
+        return file;
+      }
+    })
+  );
+  return matches.filter(Boolean).filter((file) => file !== void 0);
+};
+var copyDir = async (catalogDir, source, target, filter) => {
+  const tmpDirectory = (0, import_node_path.join)(catalogDir, "tmp");
+  await import_promises.default.mkdir(tmpDirectory, { recursive: true });
+  await (0, import_fs_extra.copy)(source, tmpDirectory, {
+    overwrite: true,
+    filter
+  });
+  await (0, import_fs_extra.copy)(tmpDirectory, target, {
+    overwrite: true,
+    filter
+  });
+  await import_promises.default.rm(tmpDirectory, { recursive: true });
+};
+
+// src/events.ts
+var getEvent = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
+  const { data, content } = import_gray_matter.default.read(file);
+  return {
+    ...data,
+    markdown: content.trim()
+  };
+};
+var writeEvent = (directory) => async (event, options = { path: "" }) => {
+  const path = options.path || `/${event.id}`;
+  const exists = await versionExists(directory, event.id, event.version);
+  if (exists) {
+    throw new Error(`Failed to write event as the version ${event.version} already exists`);
+  }
+  const { markdown, ...frontmatter } = event;
+  const document = import_gray_matter.default.stringify(markdown.trim(), frontmatter);
+  await import_promises2.default.mkdir((0, import_node_path2.join)(directory, path), { recursive: true });
+  await import_promises2.default.writeFile((0, import_node_path2.join)(directory, path, "index.md"), document);
+};
+var rmEvent = (directory) => async (path) => {
+  await import_promises2.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
+};
+var rmEventById = (directory) => async (id, version) => {
+  const files = await getFiles(`${directory}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id, version);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No event found with id: ${id}`);
+  }
+  await Promise.all(matchedFiles.map((file) => import_promises2.default.rm(file)));
+};
+var versionEvent = (directory) => async (id) => {
+  const files = await getFiles(`${directory}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No event found with id: ${id}`);
+  }
+  const file = matchedFiles[0];
+  const eventDirectory = (0, import_node_path3.dirname)(file);
+  const { data: { version = "0.0.1" } = {} } = import_gray_matter.default.read(file);
+  const targetDirectory = (0, import_node_path2.join)(eventDirectory, "versioned", version);
+  await import_promises2.default.mkdir(targetDirectory, { recursive: true });
+  await copyDir(directory, eventDirectory, targetDirectory, (src) => {
+    return !src.includes("versioned");
+  });
+  await import_promises2.default.readdir(eventDirectory).then(async (resourceFiles) => {
+    await Promise.all(
+      resourceFiles.map(async (file2) => {
+        if (file2 !== "versioned") {
+          await import_promises2.default.rm((0, import_node_path2.join)(eventDirectory, file2), { recursive: true });
+        }
+      })
+    );
+  });
+};
+var addFileToEvent = (directory) => async (id, file, version) => {
+  const pathToEvent = await findFileById(directory, id, version);
+  if (!pathToEvent) throw new Error("Cannot find directory to write file to");
+  const contentDirectory = (0, import_node_path3.dirname)(pathToEvent);
+  await import_promises2.default.writeFile((0, import_node_path2.join)(contentDirectory, file.fileName), file.content);
+};
+var addSchemaToEvent = (directory) => async (id, schema, version) => {
+  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  addFileToEvent,
+  addSchemaToEvent,
+  getEvent,
+  rmEvent,
+  rmEventById,
+  versionEvent,
+  writeEvent
+});
+//# sourceMappingURL=docs.js.map

package/dist/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/docs.ts","../src/events.ts","../src/internal/utils.ts"],"sourcesContent":["/**\n * ## EventCatalog SDK\n *\n * The EventCatalog SDK provides methods to interact with domains, services, and messages.\n *\n * ## Installation\n *\n * ```sh\n * npm install @eventcatalog/sdk\n * ```\n *\n * ## Usage\n *\n * ```ts\n * import utils from '@eventcatalog/sdk';\n *\n * const { getEvent } = utils(PATH_TO_CATALOG);\n *\n * // Get an event by the id\n * const event = getEvent('event-name');\n *\n * // Get an event by the id and it's version\n * const event = getEvent('event-name', '0.3.4');\n * ```\n *\n * @module docs\n */\nexport * from './events';\n","import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\n\n/**\n * Returns an event from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the event\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getEvent } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the event\n * cont event = await getEvent('InventoryAdjusted');\n *\n * // Gets a version of the event\n * cont event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const getEvent =\n  (directory: string) =>\n  async (id: string, version?: string): Promise<Event> => {\n    const file = await findFileById(directory, id, version);\n\n    if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ''));\n\n    const { data, content } = matter.read(file);\n\n    return {\n      ...data,\n      markdown: content.trim(),\n    } as Event;\n  };\n\n/**\n * Write an event to EventCatalog.\n *\n * You can optionally overide the path of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeEvent } = utils('/path/to/eventcatalog');\n *\n * // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n *   id: 'InventoryAdjusted',\n *   name: 'Inventory Adjusted',\n *   version: '0.0.1',\n *   summary: 'This is a summary',\n *   markdown: '# Hello world',\n * });\n *\n * // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n *    id: 'InventoryAdjusted',\n *    name: 'Inventory Adjusted',\n *    version: '0.0.1',\n *    summary: 'This is a summary',\n *    markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n */\nexport const writeEvent =\n  (directory: string) =>\n  async (event: Event, options: { path: string } = { path: '' }) => {\n    // Get the path\n    const path = options.path || `/${event.id}`;\n    const exists = await versionExists(directory, event.id, event.version);\n\n    if (exists) {\n      throw new Error(`Failed to write event as the version ${event.version} already exists`);\n    }\n\n    const { markdown, ...frontmatter } = event;\n    const document = matter.stringify(markdown.trim(), frontmatter);\n    await fs.mkdir(join(directory, path), { recursive: true });\n    await fs.writeFile(join(directory, path, 'index.md'), document);\n  };\n\n/**\n * Delete an event at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEvent } = utils('/path/to/eventcatalog');\n *\n * // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n */\nexport const rmEvent = (directory: string) => async (path: string) => {\n  await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete an event by it's id.\n *\n * Optionally specify a version to delete a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEventById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n *\n * // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const rmEventById = (directory: string) => async (id: string, version?: string) => {\n  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/index.md`);\n\n  const matchedFiles = await searchFilesForId(files, id, version);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No event found with id: ${id}`);\n  }\n\n  await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\n/**\n * Version an event by it's id.\n *\n * Takes the latest event and moves it to a versioned directory.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionEvent } = utils('/path/to/eventcatalog');\n *\n * // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await verionEvent('InventoryAdjusted');\n *\n * ```\n */\nexport const versionEvent = (directory: string) => async (id: string) => {\n  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/index.md`);\n  const matchedFiles = await searchFilesForId(files, id);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No event found with id: ${id}`);\n  }\n\n  // Event that is in the route of the project\n  const file = matchedFiles[0];\n  const eventDirectory = dirname(file);\n  const { data: { version = '0.0.1' } = {} } = matter.read(file);\n  const targetDirectory = join(eventDirectory, 'versioned', version);\n\n  await fs.mkdir(targetDirectory, { recursive: true });\n\n  // Copy the event to the versioned directory\n  await copyDir(directory, eventDirectory, targetDirectory, (src) => {\n    return !src.includes('versioned');\n  });\n\n  // Remove all the files in the root of the resource as they have now been versioned\n  await fs.readdir(eventDirectory).then(async (resourceFiles) => {\n    await Promise.all(\n      resourceFiles.map(async (file) => {\n        if (file !== 'versioned') {\n          await fs.rm(join(eventDirectory, file), { recursive: true });\n        }\n      })\n    );\n  });\n};\n\n/**\n * Add a file to an event by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToEvent } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\nexport const addFileToEvent =\n  (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) => {\n    const pathToEvent = await findFileById(directory, id, version);\n    if (!pathToEvent) throw new Error('Cannot find directory to write file to');\n    const contentDirectory = dirname(pathToEvent);\n    await fs.writeFile(join(contentDirectory, file.fileName), file.content);\n  };\n\n/**\n * Add a schema to an event by it's id.\n *\n * Optionally specify a version to add a schame to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n *\n * // JSON schema example\n * const schema = {\n *    \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n *    \"type\": \"object\",\n *    \"properties\": {\n *        \"name\": {\n *        \"type\": \"string\"\n *    },\n *    \"age\": {\n *      \"type\": \"number\"\n *    }\n *  },\n *  \"required\": [\"name\", \"age\"]\n * };\n *\n * // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n *\n * ```\n */\nexport const addSchemaToEvent =\n  (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n    await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n  };\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/**\n * Returns true if a given version of a resource id exists in the catalog\n */\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n  return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id)) || [];\n\n  // Return the latest one\n  if (!version) {\n    return matchedFiles.find((path) => !path.includes('versioned'));\n  }\n\n  // Find the versioned event\n  return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n  try {\n    const files = await glob(pattern, { ignore: 'node_modules/**' });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\n  }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  const idRegex = new RegExp(`^id:\\\\s*['\"]?${id}['\"]?\\\\s*$`, 'm');\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = await Promise.all(\n    files.map(async (file) => {\n      const content = await fs.readFile(file, 'utf-8');\n      const hasIdMatch = content.match(idRegex);\n\n      // Check version if provided\n      if (version && !content.match(versionRegex)) {\n        return undefined;\n      }\n\n      if (hasIdMatch) {\n        return file;\n      }\n    })\n  );\n\n  return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n  const tmpDirectory = join(catalogDir, 'tmp');\n  await fs.mkdir(tmpDirectory, { recursive: true });\n\n  // Copy everything over\n  await copy(source, tmpDirectory, {\n    overwrite: true,\n    filter,\n  });\n\n  await copy(tmpDirectory, target, {\n    overwrite: true,\n    filter,\n  });\n\n  // Remove the tmp directory\n  await fs.rm(tmpDirectory, { recursive: true });\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,yBAAmB;AACnB,IAAAA,mBAAe;AACf,IAAAC,oBAAqB;AACrB,IAAAA,oBAAwB;;;ACHxB,kBAAqB;AACrB,sBAAe;AACf,sBAAsD;AACtD,uBAAqB;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,UAAM,kBAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,mBAAe,uBAAK,YAAY,KAAK;AAC3C,QAAM,gBAAAA,QAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,YAAM,sBAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,YAAM,sBAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,gBAAAA,QAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;AD1DO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YAAqC;AACtD,QAAM,OAAO,MAAM,aAAa,WAAW,IAAI,OAAO;AAEtD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,oCAAoC,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK,GAAG;AAEhH,QAAM,EAAE,MAAM,QAAQ,IAAI,mBAAAC,QAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAkCK,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAAM;AAEhE,QAAM,OAAO,QAAQ,QAAQ,IAAI,MAAM,EAAE;AACzC,QAAM,SAAS,MAAM,cAAc,WAAW,MAAM,IAAI,MAAM,OAAO;AAErE,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,wCAAwC,MAAM,OAAO,iBAAiB;AAAA,EACxF;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,mBAAAA,QAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAM,iBAAAC,QAAG,UAAM,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACzD,QAAM,iBAAAA,QAAG,cAAU,wBAAK,WAAW,MAAM,UAAU,GAAG,QAAQ;AAChE;AAgBK,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAM,iBAAAA,QAAG,OAAG,wBAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YAAqB;AAExF,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AAEvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAAS,iBAAAA,QAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAmBO,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AACvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,qBAAiB,2BAAQ,IAAI;AACnC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,mBAAAD,QAAO,KAAK,IAAI;AAC7D,QAAM,sBAAkB,wBAAK,gBAAgB,aAAa,OAAO;AAEjE,QAAM,iBAAAC,QAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,WAAW,gBAAgB,iBAAiB,CAAC,QAAQ;AACjE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAM,iBAAAA,QAAG,QAAQ,cAAc,EAAE,KAAK,OAAO,kBAAkB;AAC7D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOC,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAM,iBAAAD,QAAG,OAAG,wBAAK,gBAAgBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAqBO,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YAAqB;AAC1G,QAAM,cAAc,MAAM,aAAa,WAAW,IAAI,OAAO;AAC7D,MAAI,CAAC,YAAa,OAAM,IAAI,MAAM,wCAAwC;AAC1E,QAAM,uBAAmB,2BAAQ,WAAW;AAC5C,QAAM,iBAAAD,QAAG,cAAU,wBAAK,kBAAkB,KAAK,QAAQ,GAAG,KAAK,OAAO;AACxE;AAoCK,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;","names":["import_promises","import_node_path","fs","matter","fs","file"]}

package/dist/docs.mjs

@@ -0,0 +1,138 @@
+// src/events.ts
+import matter from "gray-matter";
+import fs2 from "fs/promises";
+import { join as join2 } from "path";
+import { dirname } from "path";
+
+// src/internal/utils.ts
+import { glob } from "glob";
+import fs from "fs/promises";
+import { copy } from "fs-extra";
+import { join } from "path";
+var versionExists = async (catalogDir, id, version) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id, version) || [];
+  return matchedFiles.length > 0;
+};
+var findFileById = async (catalogDir, id, version) => {
+  const files = await getFiles(`${catalogDir}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id) || [];
+  if (!version) {
+    return matchedFiles.find((path) => !path.includes("versioned"));
+  }
+  return matchedFiles.find((path) => path.includes(`versioned/${version}`));
+};
+var getFiles = async (pattern) => {
+  try {
+    const files = await glob(pattern, { ignore: "node_modules/**" });
+    return files;
+  } catch (error) {
+    throw new Error(`Error finding files: ${error}`);
+  }
+};
+var searchFilesForId = async (files, id, version) => {
+  const idRegex = new RegExp(`^id:\\s*['"]?${id}['"]?\\s*$`, "m");
+  const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
+  const matches = await Promise.all(
+    files.map(async (file) => {
+      const content = await fs.readFile(file, "utf-8");
+      const hasIdMatch = content.match(idRegex);
+      if (version && !content.match(versionRegex)) {
+        return void 0;
+      }
+      if (hasIdMatch) {
+        return file;
+      }
+    })
+  );
+  return matches.filter(Boolean).filter((file) => file !== void 0);
+};
+var copyDir = async (catalogDir, source, target, filter) => {
+  const tmpDirectory = join(catalogDir, "tmp");
+  await fs.mkdir(tmpDirectory, { recursive: true });
+  await copy(source, tmpDirectory, {
+    overwrite: true,
+    filter
+  });
+  await copy(tmpDirectory, target, {
+    overwrite: true,
+    filter
+  });
+  await fs.rm(tmpDirectory, { recursive: true });
+};
+
+// src/events.ts
+var getEvent = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
+  const { data, content } = matter.read(file);
+  return {
+    ...data,
+    markdown: content.trim()
+  };
+};
+var writeEvent = (directory) => async (event, options = { path: "" }) => {
+  const path = options.path || `/${event.id}`;
+  const exists = await versionExists(directory, event.id, event.version);
+  if (exists) {
+    throw new Error(`Failed to write event as the version ${event.version} already exists`);
+  }
+  const { markdown, ...frontmatter } = event;
+  const document = matter.stringify(markdown.trim(), frontmatter);
+  await fs2.mkdir(join2(directory, path), { recursive: true });
+  await fs2.writeFile(join2(directory, path, "index.md"), document);
+};
+var rmEvent = (directory) => async (path) => {
+  await fs2.rm(join2(directory, path), { recursive: true });
+};
+var rmEventById = (directory) => async (id, version) => {
+  const files = await getFiles(`${directory}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id, version);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No event found with id: ${id}`);
+  }
+  await Promise.all(matchedFiles.map((file) => fs2.rm(file)));
+};
+var versionEvent = (directory) => async (id) => {
+  const files = await getFiles(`${directory}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No event found with id: ${id}`);
+  }
+  const file = matchedFiles[0];
+  const eventDirectory = dirname(file);
+  const { data: { version = "0.0.1" } = {} } = matter.read(file);
+  const targetDirectory = join2(eventDirectory, "versioned", version);
+  await fs2.mkdir(targetDirectory, { recursive: true });
+  await copyDir(directory, eventDirectory, targetDirectory, (src) => {
+    return !src.includes("versioned");
+  });
+  await fs2.readdir(eventDirectory).then(async (resourceFiles) => {
+    await Promise.all(
+      resourceFiles.map(async (file2) => {
+        if (file2 !== "versioned") {
+          await fs2.rm(join2(eventDirectory, file2), { recursive: true });
+        }
+      })
+    );
+  });
+};
+var addFileToEvent = (directory) => async (id, file, version) => {
+  const pathToEvent = await findFileById(directory, id, version);
+  if (!pathToEvent) throw new Error("Cannot find directory to write file to");
+  const contentDirectory = dirname(pathToEvent);
+  await fs2.writeFile(join2(contentDirectory, file.fileName), file.content);
+};
+var addSchemaToEvent = (directory) => async (id, schema, version) => {
+  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+export {
+  addFileToEvent,
+  addSchemaToEvent,
+  getEvent,
+  rmEvent,
+  rmEventById,
+  versionEvent,
+  writeEvent
+};
+//# sourceMappingURL=docs.mjs.map

package/dist/docs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/events.ts","../src/internal/utils.ts"],"sourcesContent":["import matter from 'gray-matter';\nimport fs from 'node:fs/promises';\nimport { join } from 'node:path';\nimport { dirname } from 'node:path';\nimport { copyDir, findFileById, getFiles, searchFilesForId, versionExists } from './internal/utils';\nimport type { Event } from './types';\n\n/**\n * Returns an event from EventCatalog.\n *\n * You can optionally specify a version to get a specific version of the event\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { getEvent } = utils('/path/to/eventcatalog');\n *\n * // Gets the latest version of the event\n * cont event = await getEvent('InventoryAdjusted');\n *\n * // Gets a version of the event\n * cont event = await getEvent('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const getEvent =\n  (directory: string) =>\n  async (id: string, version?: string): Promise<Event> => {\n    const file = await findFileById(directory, id, version);\n\n    if (!file) throw new Error(`No event found for the given id: ${id}` + (version ? ` and version ${version}` : ''));\n\n    const { data, content } = matter.read(file);\n\n    return {\n      ...data,\n      markdown: content.trim(),\n    } as Event;\n  };\n\n/**\n * Write an event to EventCatalog.\n *\n * You can optionally overide the path of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { writeEvent } = utils('/path/to/eventcatalog');\n *\n * // Write an event to the catalog\n * // Event would be written to events/InventoryAdjusted\n * await writeEvent({\n *   id: 'InventoryAdjusted',\n *   name: 'Inventory Adjusted',\n *   version: '0.0.1',\n *   summary: 'This is a summary',\n *   markdown: '# Hello world',\n * });\n *\n * // Write an event to the catalog but override the path\n * // Event would be written to events/Inventory/InventoryAdjusted\n * await writeEvent({\n *    id: 'InventoryAdjusted',\n *    name: 'Inventory Adjusted',\n *    version: '0.0.1',\n *    summary: 'This is a summary',\n *    markdown: '# Hello world',\n * }, { path: \"/Inventory/InventoryAdjusted\"});\n * ```\n */\nexport const writeEvent =\n  (directory: string) =>\n  async (event: Event, options: { path: string } = { path: '' }) => {\n    // Get the path\n    const path = options.path || `/${event.id}`;\n    const exists = await versionExists(directory, event.id, event.version);\n\n    if (exists) {\n      throw new Error(`Failed to write event as the version ${event.version} already exists`);\n    }\n\n    const { markdown, ...frontmatter } = event;\n    const document = matter.stringify(markdown.trim(), frontmatter);\n    await fs.mkdir(join(directory, path), { recursive: true });\n    await fs.writeFile(join(directory, path, 'index.md'), document);\n  };\n\n/**\n * Delete an event at it's given path.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEvent } = utils('/path/to/eventcatalog');\n *\n * // removes an event at the given path (events dir is appended to the given path)\n * // Removes the event at events/InventoryAdjusted\n * await rmEvent('/InventoryAdjusted');\n * ```\n */\nexport const rmEvent = (directory: string) => async (path: string) => {\n  await fs.rm(join(directory, path), { recursive: true });\n};\n\n/**\n * Delete an event by it's id.\n *\n * Optionally specify a version to delete a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { rmEventById } = utils('/path/to/eventcatalog');\n *\n * // deletes the latest InventoryAdjusted event\n * await rmEventById('InventoryAdjusted');\n *\n * // deletes a specific version of the InventoryAdjusted event\n * await rmEventById('InventoryAdjusted', '0.0.1');\n * ```\n */\nexport const rmEventById = (directory: string) => async (id: string, version?: string) => {\n  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/index.md`);\n\n  const matchedFiles = await searchFilesForId(files, id, version);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No event found with id: ${id}`);\n  }\n\n  await Promise.all(matchedFiles.map((file) => fs.rm(file)));\n};\n\n/**\n * Version an event by it's id.\n *\n * Takes the latest event and moves it to a versioned directory.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { versionEvent } = utils('/path/to/eventcatalog');\n *\n * // moves the latest InventoryAdjusted event to a versioned directory\n * // the version within that event is used as the version number.\n * await verionEvent('InventoryAdjusted');\n *\n * ```\n */\nexport const versionEvent = (directory: string) => async (id: string) => {\n  // Find all the events in the directory\n  const files = await getFiles(`${directory}/**/index.md`);\n  const matchedFiles = await searchFilesForId(files, id);\n\n  if (matchedFiles.length === 0) {\n    throw new Error(`No event found with id: ${id}`);\n  }\n\n  // Event that is in the route of the project\n  const file = matchedFiles[0];\n  const eventDirectory = dirname(file);\n  const { data: { version = '0.0.1' } = {} } = matter.read(file);\n  const targetDirectory = join(eventDirectory, 'versioned', version);\n\n  await fs.mkdir(targetDirectory, { recursive: true });\n\n  // Copy the event to the versioned directory\n  await copyDir(directory, eventDirectory, targetDirectory, (src) => {\n    return !src.includes('versioned');\n  });\n\n  // Remove all the files in the root of the resource as they have now been versioned\n  await fs.readdir(eventDirectory).then(async (resourceFiles) => {\n    await Promise.all(\n      resourceFiles.map(async (file) => {\n        if (file !== 'versioned') {\n          await fs.rm(join(eventDirectory, file), { recursive: true });\n        }\n      })\n    );\n  });\n};\n\n/**\n * Add a file to an event by it's id.\n *\n * Optionally specify a version to add a file to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addFileToEvent } = utils('/path/to/eventcatalog');\n *\n * // adds a file to the latest InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');\n *\n * ```\n */\nexport const addFileToEvent =\n  (directory: string) => async (id: string, file: { content: string; fileName: string }, version?: string) => {\n    const pathToEvent = await findFileById(directory, id, version);\n    if (!pathToEvent) throw new Error('Cannot find directory to write file to');\n    const contentDirectory = dirname(pathToEvent);\n    await fs.writeFile(join(contentDirectory, file.fileName), file.content);\n  };\n\n/**\n * Add a schema to an event by it's id.\n *\n * Optionally specify a version to add a schame to a specific version of the event.\n *\n * @example\n * ```ts\n * import utils from '@eventcatalog/utils';\n *\n * const { addSchemaToEvent } = utils('/path/to/eventcatalog');\n *\n * // JSON schema example\n * const schema = {\n *    \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n *    \"type\": \"object\",\n *    \"properties\": {\n *        \"name\": {\n *        \"type\": \"string\"\n *    },\n *    \"age\": {\n *      \"type\": \"number\"\n *    }\n *  },\n *  \"required\": [\"name\", \"age\"]\n * };\n *\n * // adds a schema to the latest InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });\n *\n * // adds a file to a specific version of the InventoryAdjusted event\n * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');\n *\n * ```\n */\nexport const addSchemaToEvent =\n  (directory: string) => async (id: string, schema: { schema: string; fileName: string }, version?: string) => {\n    await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);\n  };\n","import { glob } from 'glob';\nimport fs from 'node:fs/promises';\nimport { copy, CopyFilterAsync, CopyFilterSync } from 'fs-extra';\nimport { join } from 'node:path';\n\n/**\n * Returns true if a given version of a resource id exists in the catalog\n */\nexport const versionExists = async (catalogDir: string, id: string, version: string) => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id, version)) || [];\n  return matchedFiles.length > 0;\n};\n\nexport const findFileById = async (catalogDir: string, id: string, version?: string): Promise<string | undefined> => {\n  const files = await getFiles(`${catalogDir}/**/index.md`);\n  const matchedFiles = (await searchFilesForId(files, id)) || [];\n\n  // Return the latest one\n  if (!version) {\n    return matchedFiles.find((path) => !path.includes('versioned'));\n  }\n\n  // Find the versioned event\n  return matchedFiles.find((path) => path.includes(`versioned/${version}`));\n};\n\nexport const getFiles = async (pattern: string) => {\n  try {\n    const files = await glob(pattern, { ignore: 'node_modules/**' });\n    return files;\n  } catch (error) {\n    throw new Error(`Error finding files: ${error}`);\n  }\n};\n\nexport const searchFilesForId = async (files: string[], id: string, version?: string) => {\n  const idRegex = new RegExp(`^id:\\\\s*['\"]?${id}['\"]?\\\\s*$`, 'm');\n  const versionRegex = new RegExp(`^version:\\\\s*['\"]?${version}['\"]?\\\\s*$`, 'm');\n\n  const matches = await Promise.all(\n    files.map(async (file) => {\n      const content = await fs.readFile(file, 'utf-8');\n      const hasIdMatch = content.match(idRegex);\n\n      // Check version if provided\n      if (version && !content.match(versionRegex)) {\n        return undefined;\n      }\n\n      if (hasIdMatch) {\n        return file;\n      }\n    })\n  );\n\n  return matches.filter(Boolean).filter((file) => file !== undefined);\n};\n\n/**\n * Function to copy a directory from source to target, uses a tmp directory\n * @param catalogDir\n * @param source\n * @param target\n * @param filter\n */\nexport const copyDir = async (catalogDir: string, source: string, target: string, filter?: CopyFilterAsync | CopyFilterSync) => {\n  const tmpDirectory = join(catalogDir, 'tmp');\n  await fs.mkdir(tmpDirectory, { recursive: true });\n\n  // Copy everything over\n  await copy(source, tmpDirectory, {\n    overwrite: true,\n    filter,\n  });\n\n  await copy(tmpDirectory, target, {\n    overwrite: true,\n    filter,\n  });\n\n  // Remove the tmp directory\n  await fs.rm(tmpDirectory, { recursive: true });\n};\n"],"mappings":";AAAA,OAAO,YAAY;AACnB,OAAOA,SAAQ;AACf,SAAS,QAAAC,aAAY;AACrB,SAAS,eAAe;;;ACHxB,SAAS,YAAY;AACrB,OAAO,QAAQ;AACf,SAAS,YAA6C;AACtD,SAAS,YAAY;AAKd,IAAM,gBAAgB,OAAO,YAAoB,IAAY,YAAoB;AACtF,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,IAAI,OAAO,KAAM,CAAC;AACtE,SAAO,aAAa,SAAS;AAC/B;AAEO,IAAM,eAAe,OAAO,YAAoB,IAAY,YAAkD;AACnH,QAAM,QAAQ,MAAM,SAAS,GAAG,UAAU,cAAc;AACxD,QAAM,eAAgB,MAAM,iBAAiB,OAAO,EAAE,KAAM,CAAC;AAG7D,MAAI,CAAC,SAAS;AACZ,WAAO,aAAa,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,WAAW,CAAC;AAAA,EAChE;AAGA,SAAO,aAAa,KAAK,CAAC,SAAS,KAAK,SAAS,aAAa,OAAO,EAAE,CAAC;AAC1E;AAEO,IAAM,WAAW,OAAO,YAAoB;AACjD,MAAI;AACF,UAAM,QAAQ,MAAM,KAAK,SAAS,EAAE,QAAQ,kBAAkB,CAAC;AAC/D,WAAO;AAAA,EACT,SAAS,OAAO;AACd,UAAM,IAAI,MAAM,wBAAwB,KAAK,EAAE;AAAA,EACjD;AACF;AAEO,IAAM,mBAAmB,OAAO,OAAiB,IAAY,YAAqB;AACvF,QAAM,UAAU,IAAI,OAAO,gBAAgB,EAAE,cAAc,GAAG;AAC9D,QAAM,eAAe,IAAI,OAAO,qBAAqB,OAAO,cAAc,GAAG;AAE7E,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,UAAU,MAAM,GAAG,SAAS,MAAM,OAAO;AAC/C,YAAM,aAAa,QAAQ,MAAM,OAAO;AAGxC,UAAI,WAAW,CAAC,QAAQ,MAAM,YAAY,GAAG;AAC3C,eAAO;AAAA,MACT;AAEA,UAAI,YAAY;AACd,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,OAAO,OAAO,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AACpE;AASO,IAAM,UAAU,OAAO,YAAoB,QAAgB,QAAgB,WAA8C;AAC9H,QAAM,eAAe,KAAK,YAAY,KAAK;AAC3C,QAAM,GAAG,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAGhD,QAAM,KAAK,QAAQ,cAAc;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAED,QAAM,KAAK,cAAc,QAAQ;AAAA,IAC/B,WAAW;AAAA,IACX;AAAA,EACF,CAAC;AAGD,QAAM,GAAG,GAAG,cAAc,EAAE,WAAW,KAAK,CAAC;AAC/C;;;AD1DO,IAAM,WACX,CAAC,cACD,OAAO,IAAY,YAAqC;AACtD,QAAM,OAAO,MAAM,aAAa,WAAW,IAAI,OAAO;AAEtD,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,oCAAoC,EAAE,MAAM,UAAU,gBAAgB,OAAO,KAAK,GAAG;AAEhH,QAAM,EAAE,MAAM,QAAQ,IAAI,OAAO,KAAK,IAAI;AAE1C,SAAO;AAAA,IACL,GAAG;AAAA,IACH,UAAU,QAAQ,KAAK;AAAA,EACzB;AACF;AAkCK,IAAM,aACX,CAAC,cACD,OAAO,OAAc,UAA4B,EAAE,MAAM,GAAG,MAAM;AAEhE,QAAM,OAAO,QAAQ,QAAQ,IAAI,MAAM,EAAE;AACzC,QAAM,SAAS,MAAM,cAAc,WAAW,MAAM,IAAI,MAAM,OAAO;AAErE,MAAI,QAAQ;AACV,UAAM,IAAI,MAAM,wCAAwC,MAAM,OAAO,iBAAiB;AAAA,EACxF;AAEA,QAAM,EAAE,UAAU,GAAG,YAAY,IAAI;AACrC,QAAM,WAAW,OAAO,UAAU,SAAS,KAAK,GAAG,WAAW;AAC9D,QAAMC,IAAG,MAAMC,MAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACzD,QAAMD,IAAG,UAAUC,MAAK,WAAW,MAAM,UAAU,GAAG,QAAQ;AAChE;AAgBK,IAAM,UAAU,CAAC,cAAsB,OAAO,SAAiB;AACpE,QAAMD,IAAG,GAAGC,MAAK,WAAW,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AACxD;AAoBO,IAAM,cAAc,CAAC,cAAsB,OAAO,IAAY,YAAqB;AAExF,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AAEvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,IAAI,OAAO;AAE9D,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAEA,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,SAASD,IAAG,GAAG,IAAI,CAAC,CAAC;AAC3D;AAmBO,IAAM,eAAe,CAAC,cAAsB,OAAO,OAAe;AAEvE,QAAM,QAAQ,MAAM,SAAS,GAAG,SAAS,cAAc;AACvD,QAAM,eAAe,MAAM,iBAAiB,OAAO,EAAE;AAErD,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI,MAAM,2BAA2B,EAAE,EAAE;AAAA,EACjD;AAGA,QAAM,OAAO,aAAa,CAAC;AAC3B,QAAM,iBAAiB,QAAQ,IAAI;AACnC,QAAM,EAAE,MAAM,EAAE,UAAU,QAAQ,IAAI,CAAC,EAAE,IAAI,OAAO,KAAK,IAAI;AAC7D,QAAM,kBAAkBC,MAAK,gBAAgB,aAAa,OAAO;AAEjE,QAAMD,IAAG,MAAM,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAGnD,QAAM,QAAQ,WAAW,gBAAgB,iBAAiB,CAAC,QAAQ;AACjE,WAAO,CAAC,IAAI,SAAS,WAAW;AAAA,EAClC,CAAC;AAGD,QAAMA,IAAG,QAAQ,cAAc,EAAE,KAAK,OAAO,kBAAkB;AAC7D,UAAM,QAAQ;AAAA,MACZ,cAAc,IAAI,OAAOE,UAAS;AAChC,YAAIA,UAAS,aAAa;AACxB,gBAAMF,IAAG,GAAGC,MAAK,gBAAgBC,KAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAqBO,IAAM,iBACX,CAAC,cAAsB,OAAO,IAAY,MAA6C,YAAqB;AAC1G,QAAM,cAAc,MAAM,aAAa,WAAW,IAAI,OAAO;AAC7D,MAAI,CAAC,YAAa,OAAM,IAAI,MAAM,wCAAwC;AAC1E,QAAM,mBAAmB,QAAQ,WAAW;AAC5C,QAAMF,IAAG,UAAUC,MAAK,kBAAkB,KAAK,QAAQ,GAAG,KAAK,OAAO;AACxE;AAoCK,IAAM,mBACX,CAAC,cAAsB,OAAO,IAAY,QAA8C,YAAqB;AAC3G,QAAM,eAAe,SAAS,EAAE,IAAI,EAAE,SAAS,OAAO,QAAQ,UAAU,OAAO,SAAS,GAAG,OAAO;AACpG;","names":["fs","join","fs","join","file"]}

package/dist/events.d.mts

@@ -0,0 +1,171 @@
+import { Event } from './types.d.mjs';
+
+/**
+ * Returns an event from EventCatalog.
+ *
+ * You can optionally specify a version to get a specific version of the event
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { getEvent } = utils('/path/to/eventcatalog');
+ *
+ * // Gets the latest version of the event
+ * cont event = await getEvent('InventoryAdjusted');
+ *
+ * // Gets a version of the event
+ * cont event = await getEvent('InventoryAdjusted', '0.0.1');
+ * ```
+ */
+declare const getEvent: (directory: string) => (id: string, version?: string) => Promise<Event>;
+/**
+ * Write an event to EventCatalog.
+ *
+ * You can optionally overide the path of the event.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { writeEvent } = utils('/path/to/eventcatalog');
+ *
+ * // Write an event to the catalog
+ * // Event would be written to events/InventoryAdjusted
+ * await writeEvent({
+ *   id: 'InventoryAdjusted',
+ *   name: 'Inventory Adjusted',
+ *   version: '0.0.1',
+ *   summary: 'This is a summary',
+ *   markdown: '# Hello world',
+ * });
+ *
+ * // Write an event to the catalog but override the path
+ * // Event would be written to events/Inventory/InventoryAdjusted
+ * await writeEvent({
+ *    id: 'InventoryAdjusted',
+ *    name: 'Inventory Adjusted',
+ *    version: '0.0.1',
+ *    summary: 'This is a summary',
+ *    markdown: '# Hello world',
+ * }, { path: "/Inventory/InventoryAdjusted"});
+ * ```
+ */
+declare const writeEvent: (directory: string) => (event: Event, options?: {
+    path: string;
+}) => Promise<void>;
+/**
+ * Delete an event at it's given path.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmEvent } = utils('/path/to/eventcatalog');
+ *
+ * // removes an event at the given path (events dir is appended to the given path)
+ * // Removes the event at events/InventoryAdjusted
+ * await rmEvent('/InventoryAdjusted');
+ * ```
+ */
+declare const rmEvent: (directory: string) => (path: string) => Promise<void>;
+/**
+ * Delete an event by it's id.
+ *
+ * Optionally specify a version to delete a specific version of the event.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { rmEventById } = utils('/path/to/eventcatalog');
+ *
+ * // deletes the latest InventoryAdjusted event
+ * await rmEventById('InventoryAdjusted');
+ *
+ * // deletes a specific version of the InventoryAdjusted event
+ * await rmEventById('InventoryAdjusted', '0.0.1');
+ * ```
+ */
+declare const rmEventById: (directory: string) => (id: string, version?: string) => Promise<void>;
+/**
+ * Version an event by it's id.
+ *
+ * Takes the latest event and moves it to a versioned directory.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { versionEvent } = utils('/path/to/eventcatalog');
+ *
+ * // moves the latest InventoryAdjusted event to a versioned directory
+ * // the version within that event is used as the version number.
+ * await verionEvent('InventoryAdjusted');
+ *
+ * ```
+ */
+declare const versionEvent: (directory: string) => (id: string) => Promise<void>;
+/**
+ * Add a file to an event by it's id.
+ *
+ * Optionally specify a version to add a file to a specific version of the event.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { addFileToEvent } = utils('/path/to/eventcatalog');
+ *
+ * // adds a file to the latest InventoryAdjusted event
+ * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });
+ *
+ * // adds a file to a specific version of the InventoryAdjusted event
+ * await addFileToEvent('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
+ *
+ * ```
+ */
+declare const addFileToEvent: (directory: string) => (id: string, file: {
+    content: string;
+    fileName: string;
+}, version?: string) => Promise<void>;
+/**
+ * Add a schema to an event by it's id.
+ *
+ * Optionally specify a version to add a schame to a specific version of the event.
+ *
+ * @example
+ * ```ts
+ * import utils from '@eventcatalog/utils';
+ *
+ * const { addSchemaToEvent } = utils('/path/to/eventcatalog');
+ *
+ * // JSON schema example
+ * const schema = {
+ *    "$schema": "http://json-schema.org/draft-07/schema#",
+ *    "type": "object",
+ *    "properties": {
+ *        "name": {
+ *        "type": "string"
+ *    },
+ *    "age": {
+ *      "type": "number"
+ *    }
+ *  },
+ *  "required": ["name", "age"]
+ * };
+ *
+ * // adds a schema to the latest InventoryAdjusted event
+ * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' });
+ *
+ * // adds a file to a specific version of the InventoryAdjusted event
+ * await addSchemaToEvent('InventoryAdjusted', { schema, fileName: 'schema.json' }, '0.0.1');
+ *
+ * ```
+ */
+declare const addSchemaToEvent: (directory: string) => (id: string, schema: {
+    schema: string;
+    fileName: string;
+}, version?: string) => Promise<void>;
+
+export { addFileToEvent, addSchemaToEvent, getEvent, rmEvent, rmEventById, versionEvent, writeEvent };