@eventcatalog/sdk 0.0.2 → 0.0.4

package/dist/test/events.test.mjs

@@ -16051,7 +16051,7 @@ var VitestIndex = /* @__PURE__ */ Object.freeze({
 var expectTypeOf = dist.expectTypeOf;
 
 // src/index.ts
-import { join as join4 } from "path";
+import { join as join5 } from "path";
 
 // src/events.ts
 import matter from "gray-matter";
@@ -16182,6 +16182,72 @@ var addSchemaToEvent = (directory) => async (id, schema, version) => {
   await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
 };
 
+// src/services.ts
+import matter2 from "gray-matter";
+import fs3 from "fs/promises";
+import { dirname as dirname3, join as join4 } from "path";
+var getService = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  if (!file) throw new Error(`No service found for the given id: ${id}` + (version ? ` and version ${version}` : ""));
+  const { data, content } = matter2.read(file);
+  return {
+    ...data,
+    markdown: content.trim()
+  };
+};
+var writeService = (directory) => async (service, options = { path: "" }) => {
+  const path3 = options.path || `/${service.id}`;
+  const exists = await versionExists(directory, service.id, service.version);
+  if (exists) {
+    throw new Error(`Failed to write service as the version ${service.version} already exists`);
+  }
+  const { markdown, ...frontmatter } = service;
+  const document = matter2.stringify(markdown.trim(), frontmatter);
+  await fs3.mkdir(join4(directory, path3), { recursive: true });
+  await fs3.writeFile(join4(directory, path3, "index.md"), document);
+};
+var versionService = (directory) => async (id) => {
+  const files = await getFiles(`${directory}/**/index.md`);
+  const matchedFiles = await searchFilesForId(files, id);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No service found with id: ${id}`);
+  }
+  const file = matchedFiles[0];
+  const eventDirectory = dirname3(file);
+  const { data: { version = "0.0.1" } = {} } = matter2.read(file);
+  const targetDirectory = join4(eventDirectory, "versioned", version);
+  await fs3.mkdir(targetDirectory, { recursive: true });
+  await copyDir(directory, eventDirectory, targetDirectory, (src) => {
+    return !src.includes("versioned");
+  });
+  await fs3.readdir(eventDirectory).then(async (resourceFiles) => {
+    await Promise.all(
+      resourceFiles.map(async (file2) => {
+        if (file2 !== "versioned") {
+          await fs3.rm(join4(eventDirectory, file2), { recursive: true });
+        }
+      })
+    );
+  });
+};
+var rmService = (directory) => async (path3) => {
+  await fs3.rm(join4(directory, path3), { recursive: true });
+};
+var rmServiceById = (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 service found with id: ${id}`);
+  }
+  await Promise.all(matchedFiles.map((file) => fs3.rm(file)));
+};
+var addFileToService = (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 = dirname3(pathToEvent);
+  await fs3.writeFile(join4(contentDirectory, file.fileName), file.content);
+};
+
 // src/index.ts
 var src_default = (path3) => {
   return {
@@ -16191,7 +16257,7 @@ var src_default = (path3) => {
      * @param version - Optional id of the version to get
      * @returns
      */
-    getEvent: getEvent(join4(path3, "events")),
+    getEvent: getEvent(join5(path3, "events")),
     /**
      * Adds an event to EventCatalog
      *
@@ -16199,26 +16265,26 @@ var src_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join4(path3, "events")),
+    writeEvent: writeEvent(join5(path3, "events")),
     /**
      * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmEvent: rmEvent(join4(path3, "events")),
+    rmEvent: rmEvent(join5(path3, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join4(path3, "events")),
+    rmEventById: rmEventById(join5(path3, "events")),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join4(path3, "events")),
+    versionEvent: versionEvent(join5(path3, "events")),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -16226,7 +16292,7 @@ var src_default = (path3) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join4(path3, "events")),
+    addFileToEvent: addFileToEvent(join5(path3, "events")),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -16234,20 +16300,68 @@ var src_default = (path3) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join4(path3, "events"))
+    addSchemaToEvent: addSchemaToEvent(join5(path3, "events")),
+    /**
+     * ================================
+     *            SERVICES
+     * ================================
+     */
+    /**
+     * Adds a service to EventCatalog
+     *
+     * @param service - The service to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeService: writeService(join5(path3, "services")),
+    /**
+     * Returns a service from EventCatalog
+     * @param id - The id of the service to retrieve
+     * @param version - Optional id of the version to get
+     * @returns
+     */
+    getService: getService(join5(path3, "services")),
+    /**
+     * Moves a given service id to the version directory
+     * @param directory
+     */
+    versionService: versionService(join5(path3, "services")),
+    /**
+     * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your service, e.g. `/InventoryService`
+     *
+     */
+    rmService: rmService(join5(path3, "services")),
+    /**
+     * Remove an service by an service id
+     *
+     * @param id - The id of the service you want to remove
+     *
+     */
+    rmServiceById: rmServiceById(join5(path3, "services")),
+    /**
+     * Adds a file to the given service
+     * @param id - The id of the service to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the service to add the file to
+     * @returns
+     */
+    addFileToService: addFileToService(join5(path3, "services"))
   };
 };
 
 // src/test/events.test.ts
 import path2 from "path";
-import fs3 from "fs";
-var CATALOG_PATH = path2.join(__dirname, "catalog");
+import fs4 from "fs";
+var CATALOG_PATH = path2.join(__dirname, "catalog-events");
 var { writeEvent: writeEvent2, getEvent: getEvent2, rmEvent: rmEvent2, rmEventById: rmEventById2, versionEvent: versionEvent2, addFileToEvent: addFileToEvent2, addSchemaToEvent: addSchemaToEvent2 } = src_default(CATALOG_PATH);
 beforeEach(() => {
-  fs3.rmSync(CATALOG_PATH, { recursive: true, force: true });
-  fs3.mkdirSync(CATALOG_PATH, { recursive: true });
+  fs4.rmSync(CATALOG_PATH, { recursive: true, force: true });
+  fs4.mkdirSync(CATALOG_PATH, { recursive: true });
 });
 afterEach(() => {
+  fs4.rmSync(CATALOG_PATH, { recursive: true, force: true });
 });
 describe("Events SDK", () => {
   describe("getEvent", () => {
@@ -16319,7 +16433,7 @@ describe("Events SDK", () => {
         markdown: "# Hello world"
       });
       const event = await getEvent2("InventoryAdjusted");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
       globalExpect(event).toEqual({
         id: "InventoryAdjusted",
         name: "Inventory Adjusted",
@@ -16339,7 +16453,7 @@ describe("Events SDK", () => {
         },
         { path: "/Inventory/InventoryAdjusted" }
       );
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/Inventory/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/Inventory/InventoryAdjusted", "index.md"))).toBe(true);
     });
     it("throws an error when trying to write an event that already exists", async () => {
       const createEvent = async () => writeEvent2({
@@ -16370,9 +16484,9 @@ describe("Events SDK", () => {
         summary: "This is a summary",
         markdown: "# Hello world"
       });
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
       await rmEvent2("/InventoryAdjusted");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
     });
   });
   describe("rmEventById", () => {
@@ -16384,9 +16498,9 @@ describe("Events SDK", () => {
         summary: "This is a summary",
         markdown: "# Hello world"
       });
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
       await rmEventById2("InventoryAdjusted");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
     });
     it("removes an event from eventcatalog by id and version", async () => {
       await writeEvent2({
@@ -16396,9 +16510,9 @@ describe("Events SDK", () => {
         summary: "This is a summary",
         markdown: "# Hello world"
       });
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
       await rmEventById2("InventoryAdjusted", "0.0.1");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
     });
     it("if version is given, only removes that version and not any other versions of the event", async () => {
       await writeEvent2({
@@ -16416,11 +16530,11 @@ describe("Events SDK", () => {
         summary: "This is a summary",
         markdown: "# Hello world"
       });
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "index.md"))).toBe(true);
       await rmEventById2("InventoryAdjusted", "0.0.1");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(false);
     });
   });
   describe("versionEvent", () => {
@@ -16433,8 +16547,8 @@ describe("Events SDK", () => {
         markdown: "# Hello world"
       });
       await versionEvent2("InventoryAdjusted");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(true);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
     });
     it("adds the given event to the versioned directory and all files that are associated to it", async () => {
       await writeEvent2({
@@ -16444,12 +16558,12 @@ describe("Events SDK", () => {
         summary: "This is a summary",
         markdown: "# Hello world"
       });
-      await fs3.writeFileSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"), "SCHEMA!");
+      await fs4.writeFileSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"), "SCHEMA!");
       await versionEvent2("InventoryAdjusted");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(true);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "schema.json"))).toBe(true);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "index.md"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.2", "schema.json"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "index.md"))).toBe(false);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"))).toBe(false);
     });
   });
   describe("addFileToEvent", () => {
@@ -16463,7 +16577,7 @@ describe("Events SDK", () => {
         markdown: "# Hello world"
       });
       await addFileToEvent2("InventoryAdjusted", file);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "test.txt"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "test.txt"))).toBe(true);
     });
     it("takes a given file and version and writes the file to the correct location", async () => {
       const file = { content: "hello", fileName: "test.txt" };
@@ -16476,7 +16590,7 @@ describe("Events SDK", () => {
       });
       await versionEvent2("InventoryAdjusted");
       await addFileToEvent2("InventoryAdjusted", file, "0.0.1");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "test.txt"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "test.txt"))).toBe(true);
     });
     it("throws an error when trying to write to a event that does not exist", () => {
       const file = { content: "hello", fileName: "test.txt" };
@@ -16505,7 +16619,7 @@ describe("Events SDK", () => {
         markdown: "# Hello world"
       });
       await addSchemaToEvent2("InventoryAdjusted", file);
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted", "schema.json"))).toBe(true);
     });
     it("takes a given file and version and writes the file to the correct location", async () => {
       const schema = `{
@@ -16529,7 +16643,7 @@ describe("Events SDK", () => {
       });
       await versionEvent2("InventoryAdjusted");
       await addSchemaToEvent2("InventoryAdjusted", file, "0.0.1");
-      globalExpect(fs3.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "schema.json"))).toBe(true);
+      globalExpect(fs4.existsSync(path2.join(CATALOG_PATH, "events/InventoryAdjusted/versioned/0.0.1", "schema.json"))).toBe(true);
     });
     it("throws an error when trying to write to a event that does not exist", () => {
       const file = { schema: "hello", fileName: "test.txt" };