@eventcatalog/sdk 1.0.0 → 1.1.1

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import { join as join7 } from "node:path";
+import { join as join8 } from "node:path";
 
 // src/events.ts
 import fs3 from "node:fs/promises";
@@ -208,9 +208,35 @@ var commandHasVersion = (directory) => async (id, version) => {
   return !!file;
 };
 
-// src/services.ts
+// src/queries.ts
 import fs5 from "node:fs/promises";
-import { join as join5, dirname as dirname2 } from "node:path";
+import { join as join5 } from "node:path";
+var getQuery = (directory) => async (id, version) => getResource(directory, id, version, { type: "query" });
+var writeQuery = (directory) => async (query, options = { path: "" }) => writeResource(directory, { ...query }, { ...options, type: "query" });
+var writeQueryToService = (directory) => async (query, service, options = { path: "" }) => {
+  let pathForQuery = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/queries` : `/${service.id}/queries`;
+  pathForQuery = join5(pathForQuery, query.id);
+  await writeResource(directory, { ...query }, { ...options, path: pathForQuery, type: "query" });
+};
+var rmQuery = (directory) => async (path) => {
+  await fs5.rm(join5(directory, path), { recursive: true });
+};
+var rmQueryById = (directory) => async (id, version) => {
+  await rmResourceById(directory, id, version, { type: "query" });
+};
+var versionQuery = (directory) => async (id) => versionResource(directory, id);
+var addFileToQuery = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToQuery = (directory) => async (id, schema, version) => {
+  await addFileToQuery(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+var queryHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
+// src/services.ts
+import fs6 from "node:fs/promises";
+import { join as join6, dirname as dirname2 } from "node:path";
 var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
 var writeService = (directory) => async (service, options = { path: "" }) => {
   const resource = { ...service };
@@ -224,12 +250,12 @@ var writeService = (directory) => async (service, options = { path: "" }) => {
 };
 var writeServiceToDomain = (directory) => async (service, domain, options = { path: "" }) => {
   let pathForService = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/services` : `/${domain.id}/services`;
-  pathForService = join5(pathForService, service.id);
+  pathForService = join6(pathForService, service.id);
   await writeResource(directory, { ...service }, { ...options, path: pathForService, type: "service" });
 };
 var versionService = (directory) => async (id) => versionResource(directory, id);
 var rmService = (directory) => async (path) => {
-  await fs5.rm(join5(directory, path), { recursive: true });
+  await fs6.rm(join6(directory, path), { recursive: true });
 };
 var rmServiceById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "service" });
 var addFileToService = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
@@ -247,7 +273,7 @@ var getSpecificationFilesForService = (directory) => async (id, version) => {
         throw new Error(`Specification file name for ${specFile} is undefined`);
       }
       const rawFile = await getFileFromResource(directory, id, { fileName }, version);
-      return { key: specFile, content: rawFile, fileName, path: join5(dirname2(filePathToService), fileName) };
+      return { key: specFile, content: rawFile, fileName, path: join6(dirname2(filePathToService), fileName) };
     });
     specs = await Promise.all(getSpecs);
   }
@@ -287,13 +313,13 @@ var serviceHasVersion = (directory) => async (id, version) => {
 };
 
 // src/domains.ts
-import fs6 from "node:fs/promises";
-import { join as join6 } from "node:path";
+import fs7 from "node:fs/promises";
+import { join as join7 } from "node:path";
 var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
 var writeDomain = (directory) => async (domain, options = { path: "" }) => writeResource(directory, { ...domain }, { ...options, type: "domain" });
 var versionDomain = (directory) => async (id) => versionResource(directory, id);
 var rmDomain = (directory) => async (path) => {
-  await fs6.rm(join6(directory, path), { recursive: true });
+  await fs7.rm(join7(directory, path), { recursive: true });
 };
 var rmDomainById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "domain" });
 var addFileToDomain = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
@@ -324,7 +350,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join7(path)),
+    getEvent: getEvent(join8(path)),
     /**
      * Adds an event to EventCatalog
      *
@@ -332,7 +358,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join7(path, "events")),
+    writeEvent: writeEvent(join8(path, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -341,26 +367,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join7(path, "services")),
+    writeEventToService: writeEventToService(join8(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(join7(path, "events")),
+    rmEvent: rmEvent(join8(path, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join7(path)),
+    rmEventById: rmEventById(join8(path)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join7(path)),
+    versionEvent: versionEvent(join8(path)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -368,7 +394,7 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join7(path)),
+    addFileToEvent: addFileToEvent(join8(path)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -376,14 +402,14 @@ var src_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join7(path)),
+    addSchemaToEvent: addSchemaToEvent(join8(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(join7(path)),
+    eventHasVersion: eventHasVersion(join8(path)),
     /**
      * ================================
      *            Commands
@@ -395,7 +421,7 @@ var src_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join7(path)),
+    getCommand: getCommand(join8(path)),
     /**
      * Adds an command to EventCatalog
      *
@@ -403,7 +429,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join7(path, "commands")),
+    writeCommand: writeCommand(join8(path, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -412,26 +438,26 @@ var src_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join7(path, "services")),
+    writeCommandToService: writeCommandToService(join8(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(join7(path, "commands")),
+    rmCommand: rmCommand(join8(path, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join7(path)),
+    rmCommandById: rmCommandById(join8(path)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join7(path)),
+    versionCommand: versionCommand(join8(path)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -439,7 +465,7 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join7(path)),
+    addFileToCommand: addFileToCommand(join8(path)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -447,14 +473,85 @@ var src_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join7(path)),
+    addSchemaToCommand: addSchemaToCommand(join8(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(join7(path)),
+    commandHasVersion: commandHasVersion(join8(path)),
+    /**
+     * ================================
+     *            Queries
+     * ================================
+     */
+    /**
+     * Returns a query from EventCatalog
+     * @param id - The id of the query to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Query|Undefined
+     */
+    getQuery: getQuery(join8(path)),
+    /**
+     * Adds a query to EventCatalog
+     *
+     * @param query - The query to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeQuery: writeQuery(join8(path, "queries")),
+    /**
+     * Adds a query to a service in EventCatalog
+     *
+     * @param query - The query to write to the service
+     * @param service - The service and it's id to write to the query to
+     * @param options - Optional options to write the query
+     *
+     */
+    writeQueryToService: writeQueryToService(join8(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(join8(path, "queries")),
+    /**
+     * Remove a query by a Query id
+     *
+     * @param id - The id of the query you want to remove
+     *
+     */
+    rmQueryById: rmQueryById(join8(path)),
+    /**
+     * Moves a given query id to the version directory
+     * @param directory
+     */
+    versionQuery: versionQuery(join8(path)),
+    /**
+     * Adds a file to the given query
+     * @param id - The id of the query to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the query to add the file to
+     * @returns
+     */
+    addFileToQuery: addFileToQuery(join8(path)),
+    /**
+     * Adds a schema to the given query
+     * @param id - The id of the query to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the query to add the schema to
+     * @returns
+     */
+    addSchemaToQuery: addSchemaToQuery(join8(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(join8(path)),
     /**
      * ================================
      *            SERVICES
@@ -467,7 +564,7 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join7(path, "services")),
+    writeService: writeService(join8(path, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -476,33 +573,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join7(path, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join8(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(join7(path)),
+    getService: getService(join8(path)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join7(path)),
+    versionService: versionService(join8(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(join7(path, "services")),
+    rmService: rmService(join8(path, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join7(path)),
+    rmServiceById: rmServiceById(join8(path)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -510,21 +607,21 @@ var src_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join7(path)),
+    addFileToService: addFileToService(join8(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(join7(path)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join8(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(join7(path)),
+    serviceHasVersion: serviceHasVersion(join8(path)),
     /**
      * ================================
      *            Domains
@@ -537,33 +634,33 @@ var src_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join7(path, "domains")),
+    writeDomain: writeDomain(join8(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(join7(path, "domains")),
+    getDomain: getDomain(join8(path, "domains")),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join7(path, "domains")),
+    versionDomain: versionDomain(join8(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(join7(path, "domains")),
+    rmDomain: rmDomain(join8(path, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join7(path, "domains")),
+    rmDomainById: rmDomainById(join8(path, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -571,7 +668,7 @@ var src_default = (path) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join7(path, "domains")),
+    addFileToDomain: addFileToDomain(join8(path, "domains")),
     /**
      * Add an event to a service by it's id.
      *
@@ -591,7 +688,7 @@ var src_default = (path) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join7(path)),
+    addEventToService: addMessageToService(join8(path)),
     /**
      * Add a command to a service by it's id.
      *
@@ -611,14 +708,14 @@ var src_default = (path) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join7(path)),
+    addCommandToService: addMessageToService(join8(path)),
     /**
      * 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(join7(path)),
+    domainHasVersion: domainHasVersion(join8(path)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -626,7 +723,7 @@ var src_default = (path) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join7(path, "domains"))
+    addServiceToDomain: addServiceToDomain(join8(path, "domains"))
   };
 };
 export {