@eventcatalog/sdk 1.3.1 → 1.4.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import { join as join9 } from "node:path";
+import { join as join11 } from "node:path";
 
 // src/events.ts
 import fs3 from "node:fs/promises";
@@ -132,7 +132,7 @@ var writeResource = async (catalogDir, resource, options = {
     throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  if (options.versionExistingContent) {
+  if (options.versionExistingContent && !exists) {
     const currentResource = await getResource(catalogDir, resource.id);
     if (currentResource) {
       if (satisfies2(resource.version, `>${currentResource.version}`)) {
@@ -446,6 +446,98 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   await writeMessage(pathToResource)(message);
 };
 
+// src/teams.ts
+import fs9 from "node:fs/promises";
+import { join as join9 } from "node:path";
+import matter3 from "gray-matter";
+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 } = matter3.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 } = matter3.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 = matter3.stringify(markdown, frontmatter);
+  await fs9.mkdir(join9(catalogDir, ""), { recursive: true });
+  await fs9.writeFile(join9(catalogDir, "", `${resource.id}.md`), document);
+};
+var rmTeamById = (catalogDir) => async (id) => {
+  await fs9.rm(join9(catalogDir, `${id}.md`), { recursive: true });
+};
+
+// src/users.ts
+import fs10 from "node:fs/promises";
+import { join as join10 } from "node:path";
+import matter4 from "gray-matter";
+var getUser = (catalogDir) => async (id) => {
+  const files = await getFiles(`${catalogDir}/${id}.md`);
+  if (files.length == 0) return void 0;
+  const file = files[0];
+  const { data, content } = matter4.read(file);
+  return {
+    ...data,
+    id: data.id,
+    name: data.name,
+    avatarUrl: data.avatarUrl,
+    markdown: content.trim()
+  };
+};
+var getUsers = (catalogDir) => async (options) => {
+  const files = await getFiles(`${catalogDir}/users/*.md`);
+  if (files.length === 0) return [];
+  return files.map((file) => {
+    const { data, content } = matter4.read(file);
+    return {
+      ...data,
+      id: data.id,
+      name: data.name,
+      avatarUrl: data.avatarUrl,
+      markdown: content.trim()
+    };
+  });
+};
+var writeUser = (catalogDir) => async (user, options = {}) => {
+  const resource = { ...user };
+  const currentUser = await getUser(catalogDir)(resource.id);
+  const exists = currentUser !== void 0;
+  if (exists && !options.override) {
+    throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
+  }
+  const { markdown, ...frontmatter } = resource;
+  const document = matter4.stringify(markdown, frontmatter);
+  await fs10.mkdir(join10(catalogDir, ""), { recursive: true });
+  await fs10.writeFile(join10(catalogDir, "", `${resource.id}.md`), document);
+};
+var rmUserById = (catalogDir) => async (id) => {
+  await fs10.rm(join10(catalogDir, `${id}.md`), { recursive: true });
+};
+
 // src/index.ts
 var src_default = (path) => {
   return {
@@ -455,13 +547,13 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join9(path)),
+    getEvent: getEvent(join11(path)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents(join9(path)),
+    getEvents: getEvents(join11(path)),
     /**
      * Adds an event to EventCatalog
      *
@@ -469,7 +561,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join9(path, "events")),
+    writeEvent: writeEvent(join11(path, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -478,26 +570,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join9(path, "services")),
+    writeEventToService: writeEventToService(join11(path, "services")),
     /**
      * 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(join9(path, "events")),
+    rmEvent: rmEvent(join11(path, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join9(path)),
+    rmEventById: rmEventById(join11(path)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join9(path)),
+    versionEvent: versionEvent(join11(path)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -505,7 +597,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join9(path)),
+    addFileToEvent: addFileToEvent(join11(path)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -513,14 +605,14 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join9(path)),
+    addSchemaToEvent: addSchemaToEvent(join11(path)),
     /**
      * Check to see if an event version exists
      * @param id - The id of the event
      * @param version - The version of the event (supports semver)
      * @returns
      */
-    eventHasVersion: eventHasVersion(join9(path)),
+    eventHasVersion: eventHasVersion(join11(path)),
     /**
      * ================================
      *            Commands
@@ -532,13 +624,13 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join9(path)),
+    getCommand: getCommand(join11(path)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands(join9(path)),
+    getCommands: getCommands(join11(path)),
     /**
      * Adds an command to EventCatalog
      *
@@ -546,7 +638,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join9(path, "commands")),
+    writeCommand: writeCommand(join11(path, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -555,26 +647,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join9(path, "services")),
+    writeCommandToService: writeCommandToService(join11(path, "services")),
     /**
      * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmCommand: rmCommand(join9(path, "commands")),
+    rmCommand: rmCommand(join11(path, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join9(path)),
+    rmCommandById: rmCommandById(join11(path)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join9(path)),
+    versionCommand: versionCommand(join11(path)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -582,7 +674,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join9(path)),
+    addFileToCommand: addFileToCommand(join11(path)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -590,14 +682,14 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join9(path)),
+    addSchemaToCommand: addSchemaToCommand(join11(path)),
     /**
      * Check to see if a command version exists
      * @param id - The id of the command
      * @param version - The version of the command (supports semver)
      * @returns
      */
-    commandHasVersion: commandHasVersion(join9(path)),
+    commandHasVersion: commandHasVersion(join11(path)),
     /**
      * ================================
      *            Queries
@@ -609,13 +701,13 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join9(path)),
+    getQuery: getQuery(join11(path)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries(join9(path)),
+    getQueries: getQueries(join11(path)),
     /**
      * Adds a query to EventCatalog
      *
@@ -623,7 +715,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join9(path, "queries")),
+    writeQuery: writeQuery(join11(path, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -632,26 +724,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join9(path, "services")),
+    writeQueryToService: writeQueryToService(join11(path, "services")),
     /**
      * Remove an query to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your query, e.g. `/Orders/GetOrder`
      *
      */
-    rmQuery: rmQuery(join9(path, "queries")),
+    rmQuery: rmQuery(join11(path, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join9(path)),
+    rmQueryById: rmQueryById(join11(path)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join9(path)),
+    versionQuery: versionQuery(join11(path)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -659,7 +751,7 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join9(path)),
+    addFileToQuery: addFileToQuery(join11(path)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -667,14 +759,14 @@ var src_default = (path) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join9(path)),
+    addSchemaToQuery: addSchemaToQuery(join11(path)),
     /**
      * Check to see if an query version exists
      * @param id - The id of the query
      * @param version - The version of the query (supports semver)
      * @returns
      */
-    queryHasVersion: queryHasVersion(join9(path)),
+    queryHasVersion: queryHasVersion(join11(path)),
     /**
      * ================================
      *            Channels
@@ -686,13 +778,13 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel(join9(path)),
+    getChannel: getChannel(join11(path)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels(join9(path)),
+    getChannels: getChannels(join11(path)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -700,33 +792,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel(join9(path, "channels")),
+    writeChannel: writeChannel(join11(path, "channels")),
     /**
      * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmChannel: rmChannel(join9(path, "channels")),
+    rmChannel: rmChannel(join11(path, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById(join9(path)),
+    rmChannelById: rmChannelById(join11(path)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel(join9(path)),
+    versionChannel: versionChannel(join11(path)),
     /**
      * Check to see if a channel version exists
      * @param id - The id of the channel
      * @param version - The version of the channel (supports semver)
      * @returns
      */
-    channelHasVersion: channelHasVersion(join9(path)),
+    channelHasVersion: channelHasVersion(join11(path)),
     /**
      * Add a channel to an event
      *
@@ -743,7 +835,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel(join9(path), "events"),
+    addEventToChannel: addMessageToChannel(join11(path), "events"),
     /**
      * Add a channel to an command
      *
@@ -760,7 +852,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel(join9(path), "commands"),
+    addCommandToChannel: addMessageToChannel(join11(path), "commands"),
     /**
      * Add a channel to an query
      *
@@ -777,7 +869,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel(join9(path), "queries"),
+    addQueryToChannel: addMessageToChannel(join11(path), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -790,14 +882,14 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join9(path, "services")),
+    writeService: writeService(join11(path, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join9(path, "services")),
+    writeVersionedService: writeVersionedService(join11(path, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -806,39 +898,39 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join9(path, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join11(path, "domains")),
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Service|Undefined
      */
-    getService: getService(join9(path)),
+    getService: getService(join11(path)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices(join9(path)),
+    getServices: getServices(join11(path)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join9(path)),
+    versionService: versionService(join11(path)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService(join9(path, "services")),
+    rmService: rmService(join11(path, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join9(path)),
+    rmServiceById: rmServiceById(join11(path)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -846,21 +938,21 @@ var src_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join9(path)),
+    addFileToService: addFileToService(join11(path)),
     /**
      * Returns the specifications for a given service
      * @param id - The id of the service to retrieve the specifications for
      * @param version - Optional version of the service
      * @returns
      */
-    getSpecificationFilesForService: getSpecificationFilesForService(join9(path)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join11(path)),
     /**
      * Check to see if a service version exists
      * @param id - The id of the service
      * @param version - The version of the service (supports semver)
      * @returns
      */
-    serviceHasVersion: serviceHasVersion(join9(path)),
+    serviceHasVersion: serviceHasVersion(join11(path)),
     /**
      * Add an event to a service by it's id.
      *
@@ -880,7 +972,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join9(path)),
+    addEventToService: addMessageToService(join11(path)),
     /**
      * Add a command to a service by it's id.
      *
@@ -900,7 +992,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join9(path)),
+    addCommandToService: addMessageToService(join11(path)),
     /**
      * Add a query to a service by it's id.
      *
@@ -920,7 +1012,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService(join9(path)),
+    addQueryToService: addMessageToService(join11(path)),
     /**
      * ================================
      *            Domains
@@ -933,39 +1025,39 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join9(path, "domains")),
+    writeDomain: writeDomain(join11(path, "domains")),
     /**
      * Returns a domain from EventCatalog
      * @param id - The id of the domain to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Domain|Undefined
      */
-    getDomain: getDomain(join9(path, "domains")),
+    getDomain: getDomain(join11(path, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains(join9(path)),
+    getDomains: getDomains(join11(path)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join9(path, "domains")),
+    versionDomain: versionDomain(join11(path, "domains")),
     /**
      * Remove a domain from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your domain, e.g. `/Payment`
      *
      */
-    rmDomain: rmDomain(join9(path, "domains")),
+    rmDomain: rmDomain(join11(path, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join9(path, "domains")),
+    rmDomainById: rmDomainById(join11(path, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -973,14 +1065,14 @@ var src_default = (path) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join9(path, "domains")),
+    addFileToDomain: addFileToDomain(join11(path, "domains")),
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain
      * @param version - The version of the domain (supports semver)
      * @returns
      */
-    domainHasVersion: domainHasVersion(join9(path)),
+    domainHasVersion: domainHasVersion(join11(path)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -988,7 +1080,69 @@ var src_default = (path) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join9(path, "domains"))
+    addServiceToDomain: addServiceToDomain(join11(path, "domains")),
+    /**
+     * ================================
+     *            Teams
+     * ================================
+     */
+    /**
+     * Adds a team to EventCatalog
+     *
+     * @param team - The team to write
+     * @param options - Optional options to write the team
+     *
+     */
+    writeTeam: writeTeam(join11(path, "teams")),
+    /**
+     * Returns a team from EventCatalog
+     * @param id - The id of the team to retrieve
+     * @returns Team|Undefined
+     */
+    getTeam: getTeam(join11(path, "teams")),
+    /**
+     * Returns all teams from EventCatalog
+     * @returns Team[]|Undefined
+     */
+    getTeams: getTeams(join11(path)),
+    /**
+     * Remove a team by the team id
+     *
+     * @param id - The id of the team you want to remove
+     *
+     */
+    rmTeamById: rmTeamById(join11(path, "teams")),
+    /**
+     * ================================
+     *            Users
+     * ================================
+     */
+    /**
+     * Adds a user to EventCatalog
+     *
+     * @param user - The user to write
+     * @param options - Optional options to write the user
+     *
+     */
+    writeUser: writeUser(join11(path, "users")),
+    /**
+     * Returns a user from EventCatalog
+     * @param id - The id of the user to retrieve
+     * @returns User|Undefined
+     */
+    getUser: getUser(join11(path, "users")),
+    /**
+     * Returns all user from EventCatalog
+     * @returns User[]|Undefined
+     */
+    getUsers: getUsers(join11(path)),
+    /**
+     * Remove a user by the user id
+     *
+     * @param id - The id of the user you want to remove
+     *
+     */
+    rmUserById: rmUserById(join11(path, "users"))
   };
 };
 export {