@eventcatalog/sdk 2.20.0 → 2.21.1

package/dist/index.js

@@ -30,10 +30,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  FlowBuilder: () => FlowBuilder,
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
-var import_node_path22 = require("path");
+var import_node_path23 = require("path");
 
 // src/dsl/utils.ts
 var import_glob = require("glob");
@@ -2520,13 +2521,480 @@ var entityHasVersion = (directory) => async (id, version) => {
   return !!file;
 };
 
+// src/flows.ts
+var import_promises12 = __toESM(require("fs/promises"));
+var import_node_path19 = require("path");
+
+// src/flow-builder.ts
+var cloneStep = (step) => ({
+  ...step,
+  ...step.message ? { message: { ...step.message } } : {},
+  ...step.service ? { service: { ...step.service } } : {},
+  ...step.flow ? { flow: { ...step.flow } } : {},
+  ...step.container ? { container: { ...step.container } } : {},
+  ...step.dataProduct ? { dataProduct: { ...step.dataProduct } } : {},
+  ...step.actor ? { actor: { ...step.actor } } : {},
+  ...step.custom ? {
+    custom: {
+      ...step.custom,
+      ...step.custom.properties ? { properties: { ...step.custom.properties } } : {},
+      ...step.custom.menu ? { menu: step.custom.menu.map((item) => ({ ...item })) } : {}
+    }
+  } : {},
+  ...step.externalSystem ? { externalSystem: { ...step.externalSystem } } : {},
+  ...step.next_step !== void 0 ? { next_step: typeof step.next_step === "object" ? { ...step.next_step } : step.next_step } : {},
+  ...step.next_steps ? { next_steps: step.next_steps.map((next) => typeof next === "object" ? { ...next } : next) } : {}
+});
+var FlowBuilder = class _FlowBuilder {
+  constructor(flow) {
+    this.steps = /* @__PURE__ */ new Map();
+    this.order = [];
+    this.flowResource = { ...flow };
+    for (const step of flow.steps || []) {
+      this.appendStep(cloneStep(step));
+    }
+  }
+  /**
+   * Create a flow builder.
+   *
+   * The created builder can add steps and then produce a normal `Flow` resource
+   * with `build()`.
+   *
+   * @example
+   * ```ts
+   * const flow = FlowBuilder.create({
+   *   id: 'PaymentFlow',
+   *   name: 'Payment Flow',
+   *   version: '1.0.0',
+   *   markdown: '# Payment Flow',
+   * }).build();
+   * ```
+   */
+  static create(flow) {
+    return new _FlowBuilder(flow);
+  }
+  /**
+   * Add a generic flow step.
+   *
+   * Generic steps are useful for business process stages that do not map to
+   * another catalog resource.
+   *
+   * @param step - The step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addStep({
+   *     id: 'Calculate',
+   *     title: 'Calculate totals',
+   *     nextSteps: [{ id: 'OrderConfirmed' }],
+   *   });
+   * ```
+   */
+  addStep(step) {
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {}
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a message step.
+   *
+   * Message steps can reference an event, command, or query id.
+   *
+   * @param step - The message step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addMessageStep({
+   *     id: 'OrderConfirmed',
+   *     title: 'Order confirmed',
+   *     message: { id: 'OrderConfirmed', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addMessageStep(step) {
+    const message = step.message || {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        message: { ...message, ...step.version && !message.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a service step.
+   *
+   * @param step - The service step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addServiceStep({
+   *     id: 'OrderService',
+   *     service: { id: 'OrderService', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addServiceStep(step) {
+    const service = step.service || {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        service: { ...service, ...step.version && !service.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a data store step.
+   *
+   * Data store steps reference container resources in EventCatalog. If a
+   * version is not provided, EventCatalog resolves the latest matching
+   * container version when rendering the flow.
+   *
+   * @param step - The data store step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addDataStoreStep({
+   *     id: 'OrdersDB',
+   *     container: { id: 'OrdersDB', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addDataStoreStep(step) {
+    const fallbackContainer = {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    const container = step.container ?? fallbackContainer;
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        container: { ...container, ...step.version && !container.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a container step.
+   *
+   * Alias for `addDataStoreStep`.
+   */
+  addContainerStep(step) {
+    return this.addDataStoreStep(step);
+  }
+  /**
+   * Add a data product step.
+   *
+   * If a version is not provided, EventCatalog resolves the latest matching
+   * data product version when rendering the flow.
+   *
+   * @param step - The data product step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addDataProductStep({
+   *     id: 'OrderAnalytics',
+   *     dataProduct: { id: 'OrderAnalytics', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addDataProductStep(step) {
+    const fallbackDataProduct = {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    const dataProduct = step.dataProduct ?? fallbackDataProduct;
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        dataProduct: { ...dataProduct, ...step.version && !dataProduct.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add an actor step.
+   *
+   * @param step - The actor step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addActorStep({
+   *     id: 'Customer',
+   *     actor: { name: 'Customer' },
+   *   });
+   * ```
+   */
+  addActorStep(step) {
+    const actor = step.actor || {
+      name: step.name || step.title || String(step.id),
+      ...step.summary ? { summary: step.summary } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || actor.name,
+        ...step.summary ? { summary: step.summary } : {},
+        actor
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add an external system step.
+   *
+   * @param step - The external system step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'PaymentFlow',
+   *   name: 'Payment Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addExternalSystemStep({
+   *     id: 'Stripe',
+   *     externalSystem: {
+   *       name: 'Stripe',
+   *       summary: 'Payment provider',
+   *       url: 'https://stripe.com',
+   *     },
+   *   });
+   * ```
+   */
+  addExternalSystemStep(step) {
+    const externalSystem = step.externalSystem || {
+      name: step.name || step.title || String(step.id),
+      ...step.summary ? { summary: step.summary } : {},
+      ...step.url ? { url: step.url } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || externalSystem.name,
+        ...step.summary ? { summary: step.summary } : {},
+        externalSystem
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a sub-flow step.
+   *
+   * @param step - The sub-flow step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'OrderFlow',
+   *   name: 'Order Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addFlowStep({
+   *     id: 'PaymentFlow',
+   *     flow: { id: 'PaymentFlow', version: '1.0.0' },
+   *   });
+   * ```
+   */
+  addFlowStep(step) {
+    const flow = step.flow || {
+      id: String(step.id),
+      ...step.version ? { version: step.version } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || String(step.id),
+        ...step.summary ? { summary: step.summary } : {},
+        flow: { ...flow, ...step.version && !flow.version ? { version: step.version } : {} }
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Add a custom flow step.
+   *
+   * @param step - The custom step payload.
+   *
+   * @example
+   * ```ts
+   * FlowBuilder.create({
+   *   id: 'PaymentFlow',
+   *   name: 'Payment Flow',
+   *   version: '1.0.0',
+   *   markdown: '',
+   * })
+   *   .addCustomStep({
+   *     id: 'ManualReview',
+   *     custom: {
+   *       title: 'Manual review',
+   *       type: 'manual',
+   *     },
+   *   });
+   * ```
+   */
+  addCustomStep(step) {
+    const custom = step.custom || {
+      title: step.title || String(step.id),
+      ...step.icon ? { icon: step.icon } : {},
+      ...step.type ? { type: step.type } : {},
+      ...step.summary ? { summary: step.summary } : {},
+      ...step.url ? { url: step.url } : {},
+      ...step.color ? { color: step.color } : {},
+      ...step.properties ? { properties: step.properties } : {},
+      ...step.height ? { height: step.height } : {},
+      ...step.menu ? { menu: step.menu } : {}
+    };
+    return this.addStepWithNext(
+      {
+        id: step.id,
+        title: step.title || custom.title,
+        ...step.summary ? { summary: step.summary } : {},
+        custom
+      },
+      step.nextSteps
+    );
+  }
+  /**
+   * Build the EventCatalog flow resource.
+   *
+   * @returns A `Flow` resource that can be written with `writeFlow`.
+   */
+  build() {
+    this.validateNextSteps();
+    const { steps: _steps, ...flow } = this.flowResource;
+    return {
+      ...flow,
+      steps: this.order.map((id) => cloneStep(this.steps.get(id)))
+    };
+  }
+  addStepWithNext(step, nextSteps) {
+    const normalizedNextSteps = nextSteps?.map((next) => typeof next === "object" ? { ...next } : { id: next }) || [];
+    if (normalizedNextSteps.length === 1) {
+      step.next_step = normalizedNextSteps[0];
+    } else if (normalizedNextSteps.length > 1) {
+      step.next_steps = normalizedNextSteps;
+    }
+    this.appendStep(step);
+    return this;
+  }
+  appendStep(step) {
+    if (this.steps.has(step.id)) {
+      throw new Error(`Flow step with id "${step.id}" already exists`);
+    }
+    this.steps.set(step.id, step);
+    this.order.push(step.id);
+  }
+  validateNextSteps() {
+    for (const step of this.steps.values()) {
+      const nextSteps = step.next_step !== void 0 ? [step.next_step] : step.next_steps || [];
+      for (const next of nextSteps) {
+        const nextStepId = typeof next === "object" && next ? next.id : next;
+        if (!this.steps.has(nextStepId)) {
+          throw new Error(`Flow step "${step.id}" references missing next step "${nextStepId}"`);
+        }
+      }
+    }
+  }
+};
+
 // src/flows.ts
 var getFlow = (directory) => async (id, version) => getResource(directory, id, version, { type: "flow" });
 var getFlows = (directory) => async (options) => getResources(directory, { type: "flows", latestOnly: options?.latestOnly });
+var writeFlow = (directory) => async (flow, options = {
+  path: "",
+  override: false,
+  format: "mdx"
+}) => writeResource(directory, { ...flow }, { ...options, type: "flow" });
+var writeVersionedFlow = (directory) => async (flow) => {
+  const path8 = getVersionedDirectory(flow.id, flow.version);
+  return await writeFlow(directory)({ ...flow }, { path: path8 });
+};
+var writeFlowToDomain = (directory) => async (flow, domain, options = { path: "", format: "mdx", override: false }) => {
+  let pathForFlow = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/flows` : `/${domain.id}/flows`;
+  pathForFlow = (0, import_node_path19.join)(pathForFlow, flow.id);
+  await writeResource(directory, { ...flow }, { ...options, path: pathForFlow, type: "flow" });
+};
+var writeFlowToService = (directory) => async (flow, service, options = { path: "", format: "mdx", override: false }) => {
+  let pathForFlow = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/flows` : `/${service.id}/flows`;
+  pathForFlow = (0, import_node_path19.join)(pathForFlow, flow.id);
+  await writeResource(directory, { ...flow }, { ...options, path: pathForFlow, type: "flow" });
+};
+var rmFlow = (directory) => async (path8) => {
+  await import_promises12.default.rm((0, import_node_path19.join)(directory, path8), { recursive: true });
+  invalidateFileCache();
+};
+var rmFlowById = (directory) => async (id, version, persistFiles) => {
+  await rmResourceById(directory, id, version, { type: "flow", persistFiles });
+};
+var versionFlow = (directory) => async (id) => versionResource(directory, id);
+var flowHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+var addFileToFlow = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version, { type: "flow" });
 
 // src/containers.ts
-var import_promises12 = __toESM(require("fs/promises"));
-var import_node_path19 = require("path");
+var import_promises13 = __toESM(require("fs/promises"));
+var import_node_path20 = require("path");
 var getContainer = (directory) => async (id, version) => getResource(directory, id, version, { type: "container" });
 var getContainers = (directory) => async (options) => getResources(directory, { type: "containers", latestOnly: options?.latestOnly });
 var writeContainer = (directory) => async (data, options = {
@@ -2536,7 +3004,7 @@ var writeContainer = (directory) => async (data, options = {
 }) => writeResource(directory, { ...data }, { ...options, type: "container" });
 var versionContainer = (directory) => async (id) => versionResource(directory, id);
 var rmContainer = (directory) => async (path8) => {
-  await import_promises12.default.rm((0, import_node_path19.join)(directory, path8), { recursive: true });
+  await import_promises13.default.rm((0, import_node_path20.join)(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmContainerById = (directory) => async (id, version, persistFiles) => {
@@ -2553,7 +3021,7 @@ var writeContainerToService = (directory) => async (container, service, options
     throw new Error("Service not found");
   }
   let pathForContainer = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/containers` : `${resourcePath.directory}/containers`;
-  pathForContainer = (0, import_node_path19.join)(pathForContainer, container.id);
+  pathForContainer = (0, import_node_path20.join)(pathForContainer, container.id);
   await writeResource(directory, { ...container }, { ...options, path: pathForContainer, type: "container" });
 };
 
@@ -2569,8 +3037,8 @@ var addFileToDataStore = addFileToContainer;
 var writeDataStoreToService = writeContainerToService;
 
 // src/data-products.ts
-var import_promises13 = __toESM(require("fs/promises"));
-var import_node_path20 = require("path");
+var import_promises14 = __toESM(require("fs/promises"));
+var import_node_path21 = require("path");
 var getDataProduct = (directory) => async (id, version) => getResource(directory, id, version, { type: "data-product" });
 var getDataProducts = (directory) => async (options) => getResources(directory, { type: "data-products", latestOnly: options?.latestOnly });
 var writeDataProduct = (directory) => async (dataProduct, options = {
@@ -2580,11 +3048,11 @@ var writeDataProduct = (directory) => async (dataProduct, options = {
 }) => writeResource(directory, { ...dataProduct }, { ...options, type: "data-product" });
 var writeDataProductToDomain = (directory) => async (dataProduct, domain, options = { path: "", format: "mdx", override: false }) => {
   let pathForDataProduct = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/data-products` : `/${domain.id}/data-products`;
-  pathForDataProduct = (0, import_node_path20.join)(pathForDataProduct, dataProduct.id);
+  pathForDataProduct = (0, import_node_path21.join)(pathForDataProduct, dataProduct.id);
   await writeResource(directory, { ...dataProduct }, { ...options, path: pathForDataProduct, type: "data-product" });
 };
 var rmDataProduct = (directory) => async (path8) => {
-  await import_promises13.default.rm((0, import_node_path20.join)(directory, path8), { recursive: true });
+  await import_promises14.default.rm((0, import_node_path21.join)(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmDataProductById = (directory) => async (id, version, persistFiles) => {
@@ -2598,8 +3066,8 @@ var dataProductHasVersion = (directory) => async (id, version) => {
 var addFileToDataProduct = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
 
 // src/diagrams.ts
-var import_promises14 = __toESM(require("fs/promises"));
-var import_node_path21 = require("path");
+var import_promises15 = __toESM(require("fs/promises"));
+var import_node_path22 = require("path");
 var getDiagram = (directory) => async (id, version) => getResource(directory, id, version, { type: "diagram" });
 var getDiagrams = (directory) => async (options) => getResources(directory, { type: "diagrams", latestOnly: options?.latestOnly });
 var writeDiagram = (directory) => async (diagram, options = {
@@ -2608,7 +3076,7 @@ var writeDiagram = (directory) => async (diagram, options = {
   format: "mdx"
 }) => writeResource(directory, { ...diagram }, { ...options, type: "diagram" });
 var rmDiagram = (directory) => async (path8) => {
-  await import_promises14.default.rm((0, import_node_path21.join)(directory, path8), { recursive: true });
+  await import_promises15.default.rm((0, import_node_path22.join)(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmDiagramById = (directory) => async (id, version, persistFiles) => {
@@ -2630,13 +3098,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path22.join)(path8)),
+    getEvent: getEvent((0, import_node_path23.join)(path8)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents((0, import_node_path22.join)(path8)),
+    getEvents: getEvents((0, import_node_path23.join)(path8)),
     /**
      * Adds an event to EventCatalog
      *
@@ -2644,7 +3112,7 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path22.join)(path8, "events")),
+    writeEvent: writeEvent((0, import_node_path23.join)(path8, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -2653,26 +3121,26 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path22.join)(path8)),
+    writeEventToService: writeEventToService((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8, "events")),
+    rmEvent: rmEvent((0, import_node_path23.join)(path8, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path22.join)(path8)),
+    rmEventById: rmEventById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path22.join)(path8)),
+    versionEvent: versionEvent((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -2680,7 +3148,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path22.join)(path8)),
+    addFileToEvent: addFileToEvent((0, import_node_path23.join)(path8)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -2688,17 +3156,17 @@ var src_default = (path8) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path22.join)(path8)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
-    addExampleToEvent: addExampleToEvent((0, import_node_path22.join)(path8)),
-    getExamplesFromEvent: getExamplesFromEvent((0, import_node_path22.join)(path8)),
-    removeExampleFromEvent: removeExampleFromEvent((0, import_node_path22.join)(path8)),
+    eventHasVersion: eventHasVersion((0, import_node_path23.join)(path8)),
+    addExampleToEvent: addExampleToEvent((0, import_node_path23.join)(path8)),
+    getExamplesFromEvent: getExamplesFromEvent((0, import_node_path23.join)(path8)),
+    removeExampleFromEvent: removeExampleFromEvent((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Commands
@@ -2710,13 +3178,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path22.join)(path8)),
+    getCommand: getCommand((0, import_node_path23.join)(path8)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands((0, import_node_path22.join)(path8)),
+    getCommands: getCommands((0, import_node_path23.join)(path8)),
     /**
      * Adds an command to EventCatalog
      *
@@ -2724,7 +3192,7 @@ var src_default = (path8) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path22.join)(path8, "commands")),
+    writeCommand: writeCommand((0, import_node_path23.join)(path8, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -2733,26 +3201,26 @@ var src_default = (path8) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path22.join)(path8)),
+    writeCommandToService: writeCommandToService((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8, "commands")),
+    rmCommand: rmCommand((0, import_node_path23.join)(path8, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path22.join)(path8)),
+    rmCommandById: rmCommandById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path22.join)(path8)),
+    versionCommand: versionCommand((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -2760,7 +3228,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path22.join)(path8)),
+    addFileToCommand: addFileToCommand((0, import_node_path23.join)(path8)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -2768,17 +3236,17 @@ var src_default = (path8) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path22.join)(path8)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
-    addExampleToCommand: addExampleToCommand((0, import_node_path22.join)(path8)),
-    getExamplesFromCommand: getExamplesFromCommand((0, import_node_path22.join)(path8)),
-    removeExampleFromCommand: removeExampleFromCommand((0, import_node_path22.join)(path8)),
+    commandHasVersion: commandHasVersion((0, import_node_path23.join)(path8)),
+    addExampleToCommand: addExampleToCommand((0, import_node_path23.join)(path8)),
+    getExamplesFromCommand: getExamplesFromCommand((0, import_node_path23.join)(path8)),
+    removeExampleFromCommand: removeExampleFromCommand((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Queries
@@ -2790,13 +3258,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path22.join)(path8)),
+    getQuery: getQuery((0, import_node_path23.join)(path8)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries((0, import_node_path22.join)(path8)),
+    getQueries: getQueries((0, import_node_path23.join)(path8)),
     /**
      * Adds a query to EventCatalog
      *
@@ -2804,7 +3272,7 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path22.join)(path8, "queries")),
+    writeQuery: writeQuery((0, import_node_path23.join)(path8, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -2813,26 +3281,26 @@ var src_default = (path8) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path22.join)(path8)),
+    writeQueryToService: writeQueryToService((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8, "queries")),
+    rmQuery: rmQuery((0, import_node_path23.join)(path8, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path22.join)(path8)),
+    rmQueryById: rmQueryById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path22.join)(path8)),
+    versionQuery: versionQuery((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -2840,7 +3308,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path22.join)(path8)),
+    addFileToQuery: addFileToQuery((0, import_node_path23.join)(path8)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -2848,17 +3316,17 @@ var src_default = (path8) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path22.join)(path8)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
-    addExampleToQuery: addExampleToQuery((0, import_node_path22.join)(path8)),
-    getExamplesFromQuery: getExamplesFromQuery((0, import_node_path22.join)(path8)),
-    removeExampleFromQuery: removeExampleFromQuery((0, import_node_path22.join)(path8)),
+    queryHasVersion: queryHasVersion((0, import_node_path23.join)(path8)),
+    addExampleToQuery: addExampleToQuery((0, import_node_path23.join)(path8)),
+    getExamplesFromQuery: getExamplesFromQuery((0, import_node_path23.join)(path8)),
+    removeExampleFromQuery: removeExampleFromQuery((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Channels
@@ -2870,13 +3338,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path22.join)(path8)),
+    getChannel: getChannel((0, import_node_path23.join)(path8)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels((0, import_node_path22.join)(path8)),
+    getChannels: getChannels((0, import_node_path23.join)(path8)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -2884,33 +3352,33 @@ var src_default = (path8) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path22.join)(path8, "channels")),
+    writeChannel: writeChannel((0, import_node_path23.join)(path8, "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((0, import_node_path22.join)(path8, "channels")),
+    rmChannel: rmChannel((0, import_node_path23.join)(path8, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById((0, import_node_path22.join)(path8)),
+    rmChannelById: rmChannelById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path22.join)(path8)),
+    versionChannel: versionChannel((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
+    channelHasVersion: channelHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Add a channel to an event
      *
@@ -2927,7 +3395,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path22.join)(path8), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path23.join)(path8), "events"),
     /**
      * Add a channel to an command
      *
@@ -2944,7 +3412,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path22.join)(path8), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path23.join)(path8), "commands"),
     /**
      * Add a channel to an query
      *
@@ -2961,7 +3429,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path22.join)(path8), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path23.join)(path8), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -2974,14 +3442,14 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path22.join)(path8, "services")),
+    writeService: writeService((0, import_node_path23.join)(path8, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path22.join)(path8, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path23.join)(path8, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -2990,45 +3458,45 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path22.join)(path8, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path23.join)(path8, "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((0, import_node_path22.join)(path8)),
+    getService: getService((0, import_node_path23.join)(path8)),
     /**
      * Returns a service from EventCatalog by it's path.
      * @param path - The path to the service to retrieve
      * @returns Service|Undefined
      */
-    getServiceByPath: getServiceByPath((0, import_node_path22.join)(path8)),
+    getServiceByPath: getServiceByPath((0, import_node_path23.join)(path8)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices((0, import_node_path22.join)(path8)),
+    getServices: getServices((0, import_node_path23.join)(path8)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path22.join)(path8)),
+    versionService: versionService((0, import_node_path23.join)(path8)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService((0, import_node_path22.join)(path8, "services")),
+    rmService: rmService((0, import_node_path23.join)(path8, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path22.join)(path8)),
+    rmServiceById: rmServiceById((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -3036,21 +3504,21 @@ var src_default = (path8) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path22.join)(path8)),
+    addFileToService: addFileToService((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path23.join)(path8)),
     /**
      * 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((0, import_node_path22.join)(path8)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Add an event to a service by it's id.
      *
@@ -3070,7 +3538,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path22.join)(path8)),
+    addEventToService: addMessageToService((0, import_node_path23.join)(path8)),
     /**
      * Add a data store to a service by it's id.
      *
@@ -3087,7 +3555,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addDataStoreToService: addDataStoreToService((0, import_node_path22.join)(path8)),
+    addDataStoreToService: addDataStoreToService((0, import_node_path23.join)(path8)),
     /**
      * Add a command to a service by it's id.
      *
@@ -3107,7 +3575,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path22.join)(path8)),
+    addCommandToService: addMessageToService((0, import_node_path23.join)(path8)),
     /**
      * Add a query to a service by it's id.
      *
@@ -3127,7 +3595,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path22.join)(path8)),
+    addQueryToService: addMessageToService((0, import_node_path23.join)(path8)),
     /**
      * Add an entity to a service by its id.
      *
@@ -3145,7 +3613,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addEntityToService: addEntityToService((0, import_node_path22.join)(path8)),
+    addEntityToService: addEntityToService((0, import_node_path23.join)(path8)),
     /**
      * Check to see if a service exists by it's path.
      *
@@ -3162,13 +3630,13 @@ var src_default = (path8) => {
      * @param path - The path to the service to check
      * @returns boolean
      */
-    isService: isService((0, import_node_path22.join)(path8)),
+    isService: isService((0, import_node_path23.join)(path8)),
     /**
      * Converts a file to a service.
      * @param file - The file to convert to a service.
      * @returns The service.
      */
-    toService: toService((0, import_node_path22.join)(path8)),
+    toService: toService((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Domains
@@ -3181,39 +3649,39 @@ var src_default = (path8) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path22.join)(path8, "domains")),
+    writeDomain: writeDomain((0, import_node_path23.join)(path8, "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((0, import_node_path22.join)(path8, "domains")),
+    getDomain: getDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains((0, import_node_path22.join)(path8)),
+    getDomains: getDomains((0, import_node_path23.join)(path8)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path22.join)(path8, "domains")),
+    versionDomain: versionDomain((0, import_node_path23.join)(path8, "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((0, import_node_path22.join)(path8, "domains")),
+    rmDomain: rmDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path22.join)(path8, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path23.join)(path8, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -3221,28 +3689,28 @@ var src_default = (path8) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path22.join)(path8, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Adds an ubiquitous language dictionary to a domain
      * @param id - The id of the domain to add the ubiquitous language to
      * @param ubiquitousLanguageDictionary - The ubiquitous language dictionary to add
      * @param version - Optional version of the domain to add the ubiquitous language to
      */
-    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path22.join)(path8, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Get the ubiquitous language dictionary from a domain
      * @param id - The id of the domain to get the ubiquitous language from
      * @param version - Optional version of the domain to get the ubiquitous language from
      * @returns
      */
-    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path22.join)(path8, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path23.join)(path8, "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((0, import_node_path22.join)(path8)),
+    domainHasVersion: domainHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -3250,7 +3718,7 @@ var src_default = (path8) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path22.join)(path8, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -3258,7 +3726,7 @@ var src_default = (path8) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path22.join)(path8, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Adds an entity to a domain
      * @param id - The id of the domain
@@ -3266,7 +3734,7 @@ var src_default = (path8) => {
      * @param version - (Optional) The version of the domain to add the entity to
      * @returns
      */
-    addEntityToDomain: addEntityToDomain((0, import_node_path22.join)(path8, "domains")),
+    addEntityToDomain: addEntityToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Add an event to a domain by its id.
      *
@@ -3284,7 +3752,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addEventToDomain: addMessageToDomain((0, import_node_path22.join)(path8, "domains")),
+    addEventToDomain: addMessageToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Add a command to a domain by its id.
      *
@@ -3302,7 +3770,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addCommandToDomain: addMessageToDomain((0, import_node_path22.join)(path8, "domains")),
+    addCommandToDomain: addMessageToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Add a query to a domain by its id.
      *
@@ -3320,7 +3788,7 @@ var src_default = (path8) => {
      *
      * ```
      */
-    addQueryToDomain: addMessageToDomain((0, import_node_path22.join)(path8, "domains")),
+    addQueryToDomain: addMessageToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * ================================
      *            Teams
@@ -3333,25 +3801,25 @@ var src_default = (path8) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path22.join)(path8, "teams")),
+    writeTeam: writeTeam((0, import_node_path23.join)(path8, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam((0, import_node_path22.join)(path8, "teams")),
+    getTeam: getTeam((0, import_node_path23.join)(path8, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path22.join)(path8, "teams")),
+    getTeams: getTeams((0, import_node_path23.join)(path8, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById((0, import_node_path22.join)(path8, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path23.join)(path8, "teams")),
     /**
      * ================================
      *            Users
@@ -3364,25 +3832,25 @@ var src_default = (path8) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path22.join)(path8, "users")),
+    writeUser: writeUser((0, import_node_path23.join)(path8, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser((0, import_node_path22.join)(path8, "users")),
+    getUser: getUser((0, import_node_path23.join)(path8, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path22.join)(path8)),
+    getUsers: getUsers((0, import_node_path23.join)(path8)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById((0, import_node_path22.join)(path8, "users")),
+    rmUserById: rmUserById((0, import_node_path23.join)(path8, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -3393,32 +3861,32 @@ var src_default = (path8) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc((0, import_node_path22.join)(path8, "docs")),
+    getCustomDoc: getCustomDoc((0, import_node_path23.join)(path8, "docs")),
     /**
      * Returns all custom docs from EventCatalog
      * @param options - Optional options to get custom docs from a specific path
      * @returns CustomDoc[]|Undefined
      */
-    getCustomDocs: getCustomDocs((0, import_node_path22.join)(path8, "docs")),
+    getCustomDocs: getCustomDocs((0, import_node_path23.join)(path8, "docs")),
     /**
      * Writes a custom doc to EventCatalog
      * @param customDoc - The custom doc to write
      * @param options - Optional options to write the custom doc
      *
      */
-    writeCustomDoc: writeCustomDoc((0, import_node_path22.join)(path8, "docs")),
+    writeCustomDoc: writeCustomDoc((0, import_node_path23.join)(path8, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc((0, import_node_path22.join)(path8, "docs")),
+    rmCustomDoc: rmCustomDoc((0, import_node_path23.join)(path8, "docs")),
     /**
      * Dumps the catalog to a JSON file.
      * @param directory - The directory to dump the catalog to
      * @returns A JSON file with the catalog
      */
-    dumpCatalog: dumpCatalog((0, import_node_path22.join)(path8)),
+    dumpCatalog: dumpCatalog((0, import_node_path23.join)(path8)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -3426,7 +3894,7 @@ var src_default = (path8) => {
      * @param directory - The directory of the catalog.
      * @returns A JSON object with the configuration for the event catalog.
      */
-    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path22.join)(path8)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Changelogs
@@ -3440,7 +3908,7 @@ var src_default = (path8) => {
      * @param options - Optional options (version, format)
      *
      */
-    writeChangelog: writeChangelog((0, import_node_path22.join)(path8)),
+    writeChangelog: writeChangelog((0, import_node_path23.join)(path8)),
     /**
      * Appends a changelog entry to an existing changelog for a resource.
      * If no changelog exists, one is created.
@@ -3450,7 +3918,7 @@ var src_default = (path8) => {
      * @param options - Optional options (version, format)
      *
      */
-    appendChangelog: appendChangelog((0, import_node_path22.join)(path8)),
+    appendChangelog: appendChangelog((0, import_node_path23.join)(path8)),
     /**
      * Returns the changelog for a resource in EventCatalog
      *
@@ -3458,7 +3926,7 @@ var src_default = (path8) => {
      * @param options - Optional options (version)
      * @returns Changelog|Undefined
      */
-    getChangelog: getChangelog((0, import_node_path22.join)(path8)),
+    getChangelog: getChangelog((0, import_node_path23.join)(path8)),
     /**
      * Removes the changelog for a resource in EventCatalog
      *
@@ -3466,7 +3934,7 @@ var src_default = (path8) => {
      * @param options - Optional options (version)
      *
      */
-    rmChangelog: rmChangelog((0, import_node_path22.join)(path8)),
+    rmChangelog: rmChangelog((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Resources Utils
@@ -3491,26 +3959,26 @@ var src_default = (path8) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path22.join)(path8)),
+    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path23.join)(path8)),
     /**
      * Returns the producers and consumers (services) for a given message
      * @param id - The id of the message to get the producers and consumers for
      * @param version - Optional version of the message
      * @returns { producers: Service[], consumers: Service[] }
      */
-    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path22.join)(path8)),
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path23.join)(path8)),
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
      * @returns Service[]
      */
-    getConsumersOfSchema: getConsumersOfSchema((0, import_node_path22.join)(path8)),
+    getConsumersOfSchema: getConsumersOfSchema((0, import_node_path23.join)(path8)),
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
      * @returns Service[]
      */
-    getProducersOfSchema: getProducersOfSchema((0, import_node_path22.join)(path8)),
+    getProducersOfSchema: getProducersOfSchema((0, import_node_path23.join)(path8)),
     /**
      * Returns the schema for a given message (event, command or query) by its id and version.
      * If no version is given, the latest version is used.
@@ -3518,14 +3986,14 @@ var src_default = (path8) => {
      * @param version - Optional version of the message
      * @returns { schema: string, fileName: string } | undefined
      */
-    getSchemaForMessage: getSchemaForMessage((0, import_node_path22.join)(path8)),
+    getSchemaForMessage: getSchemaForMessage((0, import_node_path23.join)(path8)),
     /**
      * Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
      * @param id - The id of the resource to get the owners for
      * @param version - Optional version of the resource
      * @returns { owners: User[] }
      */
-    getOwnersForResource: getOwnersForResource((0, import_node_path22.join)(path8)),
+    getOwnersForResource: getOwnersForResource((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Entities
@@ -3537,13 +4005,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Entity|Undefined
      */
-    getEntity: getEntity((0, import_node_path22.join)(path8)),
+    getEntity: getEntity((0, import_node_path23.join)(path8)),
     /**
      * Returns all entities from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Entity[]|Undefined
      */
-    getEntities: getEntities((0, import_node_path22.join)(path8)),
+    getEntities: getEntities((0, import_node_path23.join)(path8)),
     /**
      * Adds an entity to EventCatalog
      *
@@ -3551,33 +4019,33 @@ var src_default = (path8) => {
      * @param options - Optional options to write the entity
      *
      */
-    writeEntity: writeEntity((0, import_node_path22.join)(path8, "entities")),
+    writeEntity: writeEntity((0, import_node_path23.join)(path8, "entities")),
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your entity, e.g. `/User`
      *
      */
-    rmEntity: rmEntity((0, import_node_path22.join)(path8, "entities")),
+    rmEntity: rmEntity((0, import_node_path23.join)(path8, "entities")),
     /**
      * Remove an entity by an entity id
      *
      * @param id - The id of the entity you want to remove
      *
      */
-    rmEntityById: rmEntityById((0, import_node_path22.join)(path8)),
+    rmEntityById: rmEntityById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given entity id to the version directory
      * @param id - The id of the entity to version
      */
-    versionEntity: versionEntity((0, import_node_path22.join)(path8)),
+    versionEntity: versionEntity((0, import_node_path23.join)(path8)),
     /**
      * Check to see if an entity version exists
      * @param id - The id of the entity
      * @param version - The version of the entity (supports semver)
      * @returns
      */
-    entityHasVersion: entityHasVersion((0, import_node_path22.join)(path8)),
+    entityHasVersion: entityHasVersion((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *              Flows
@@ -3590,7 +4058,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the flow
      * @returns Flow
      */
-    getFlow: getFlow((0, import_node_path22.join)(path8)),
+    getFlow: getFlow((0, import_node_path23.join)(path8)),
     /**
      * Returns all flows from EventCatalog
      *
@@ -3598,7 +4066,74 @@ var src_default = (path8) => {
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Flow[]|Undefined
      */
-    getFlows: getFlows((0, import_node_path22.join)(path8)),
+    getFlows: getFlows((0, import_node_path23.join)(path8)),
+    /**
+     * Adds a flow to EventCatalog
+     *
+     * @param flow - The flow to write
+     * @param options - Optional options to write the flow
+     *
+     */
+    writeFlow: writeFlow((0, import_node_path23.join)(path8, "flows")),
+    /**
+     * Adds a versioned flow to EventCatalog
+     *
+     * @param flow - The flow to write
+     *
+     */
+    writeVersionedFlow: writeVersionedFlow((0, import_node_path23.join)(path8, "flows")),
+    /**
+     * Adds a flow to a domain in EventCatalog
+     *
+     * @param flow - The flow to write to the domain
+     * @param domain - The domain and its id to write the flow to
+     * @param options - Optional options to write the flow
+     *
+     */
+    writeFlowToDomain: writeFlowToDomain((0, import_node_path23.join)(path8, "domains")),
+    /**
+     * Adds a flow to a service in EventCatalog
+     *
+     * @param flow - The flow to write to the service
+     * @param service - The service and its id to write the flow to
+     * @param options - Optional options to write the flow
+     *
+     */
+    writeFlowToService: writeFlowToService((0, import_node_path23.join)(path8, "services")),
+    /**
+     * Remove a flow from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your flow, e.g. `/PaymentFlow`
+     *
+     */
+    rmFlow: rmFlow((0, import_node_path23.join)(path8, "flows")),
+    /**
+     * Remove a flow by a flow id
+     *
+     * @param id - The id of the flow you want to remove
+     *
+     */
+    rmFlowById: rmFlowById((0, import_node_path23.join)(path8)),
+    /**
+     * Moves a given flow id to the version directory
+     * @param id - The id of the flow to version
+     */
+    versionFlow: versionFlow((0, import_node_path23.join)(path8)),
+    /**
+     * Check to see if a flow version exists
+     * @param id - The id of the flow
+     * @param version - The version of the flow (supports semver)
+     * @returns
+     */
+    flowHasVersion: flowHasVersion((0, import_node_path23.join)(path8)),
+    /**
+     * Adds a file to the given flow
+     * @param id - The id of the flow to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the flow to add the file to
+     * @returns
+     */
+    addFileToFlow: addFileToFlow((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Data Stores
@@ -3610,42 +4145,42 @@ var src_default = (path8) => {
      * @param options - Optional options to write the data store
      *
      */
-    writeDataStore: writeDataStore((0, import_node_path22.join)(path8, "containers")),
+    writeDataStore: writeDataStore((0, import_node_path23.join)(path8, "containers")),
     /**
      * Returns a data store from EventCatalog
      * @param id - The id of the data store to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Container|Undefined
      */
-    getDataStore: getDataStore((0, import_node_path22.join)(path8)),
+    getDataStore: getDataStore((0, import_node_path23.join)(path8)),
     /**
      * Returns all data stores from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Container[]|Undefined
      */
-    getDataStores: getDataStores((0, import_node_path22.join)(path8)),
+    getDataStores: getDataStores((0, import_node_path23.join)(path8)),
     /**
      * Version a data store by its id
      * @param id - The id of the data store to version
      */
-    versionDataStore: versionDataStore((0, import_node_path22.join)(path8, "containers")),
+    versionDataStore: versionDataStore((0, import_node_path23.join)(path8, "containers")),
     /**
      * Remove a data store by its path
      * @param path - The path to the data store to remove
      */
-    rmDataStore: rmDataStore((0, import_node_path22.join)(path8, "containers")),
+    rmDataStore: rmDataStore((0, import_node_path23.join)(path8, "containers")),
     /**
      * Remove a data store by its id
      * @param id - The id of the data store to remove
      */
-    rmDataStoreById: rmDataStoreById((0, import_node_path22.join)(path8)),
+    rmDataStoreById: rmDataStoreById((0, import_node_path23.join)(path8)),
     /**
      * Check to see if a data store version exists
      * @param id - The id of the data store
      * @param version - The version of the data store (supports semver)
      * @returns
      */
-    dataStoreHasVersion: dataStoreHasVersion((0, import_node_path22.join)(path8)),
+    dataStoreHasVersion: dataStoreHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to a data store by its id
      * @param id - The id of the data store to add the file to
@@ -3653,14 +4188,14 @@ var src_default = (path8) => {
      * @param version - Optional version of the data store to add the file to
      * @returns
      */
-    addFileToDataStore: addFileToDataStore((0, import_node_path22.join)(path8)),
+    addFileToDataStore: addFileToDataStore((0, import_node_path23.join)(path8)),
     /**
      * Writes a data store to a service by its id
      * @param dataStore - The data store to write
      * @param service - The service to write the data store to
      * @returns
      */
-    writeDataStoreToService: writeDataStoreToService((0, import_node_path22.join)(path8)),
+    writeDataStoreToService: writeDataStoreToService((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            Data Products
@@ -3672,7 +4207,7 @@ var src_default = (path8) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProduct: writeDataProduct((0, import_node_path22.join)(path8, "data-products")),
+    writeDataProduct: writeDataProduct((0, import_node_path23.join)(path8, "data-products")),
     /**
      * Writes a data product to a domain in EventCatalog
      * @param dataProduct - The data product to write
@@ -3680,43 +4215,43 @@ var src_default = (path8) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProductToDomain: writeDataProductToDomain((0, import_node_path22.join)(path8, "domains")),
+    writeDataProductToDomain: writeDataProductToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * Returns a data product from EventCatalog
      * @param id - The id of the data product to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns DataProduct|Undefined
      */
-    getDataProduct: getDataProduct((0, import_node_path22.join)(path8)),
+    getDataProduct: getDataProduct((0, import_node_path23.join)(path8)),
     /**
      * Returns all data products from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns DataProduct[]|Undefined
      */
-    getDataProducts: getDataProducts((0, import_node_path22.join)(path8)),
+    getDataProducts: getDataProducts((0, import_node_path23.join)(path8)),
     /**
      * Version a data product by its id
      * @param id - The id of the data product to version
      */
-    versionDataProduct: versionDataProduct((0, import_node_path22.join)(path8)),
+    versionDataProduct: versionDataProduct((0, import_node_path23.join)(path8)),
     /**
      * Remove a data product by its path
      * @param path - The path to the data product to remove
      */
-    rmDataProduct: rmDataProduct((0, import_node_path22.join)(path8, "data-products")),
+    rmDataProduct: rmDataProduct((0, import_node_path23.join)(path8, "data-products")),
     /**
      * Remove a data product by its id
      * @param id - The id of the data product to remove
      * @param version - Optional version of the data product to remove
      */
-    rmDataProductById: rmDataProductById((0, import_node_path22.join)(path8)),
+    rmDataProductById: rmDataProductById((0, import_node_path23.join)(path8)),
     /**
      * Check to see if a data product version exists
      * @param id - The id of the data product
      * @param version - The version of the data product (supports semver)
      * @returns
      */
-    dataProductHasVersion: dataProductHasVersion((0, import_node_path22.join)(path8)),
+    dataProductHasVersion: dataProductHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to a data product by its id
      * @param id - The id of the data product to add the file to
@@ -3724,7 +4259,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the data product to add the file to
      * @returns
      */
-    addFileToDataProduct: addFileToDataProduct((0, import_node_path22.join)(path8)),
+    addFileToDataProduct: addFileToDataProduct((0, import_node_path23.join)(path8)),
     /**
      * Adds a data product to a domain
      * @param id - The id of the domain
@@ -3732,7 +4267,7 @@ var src_default = (path8) => {
      * @param version - (Optional) The version of the domain to add the data product to
      * @returns
      */
-    addDataProductToDomain: addDataProductToDomain((0, import_node_path22.join)(path8, "domains")),
+    addDataProductToDomain: addDataProductToDomain((0, import_node_path23.join)(path8, "domains")),
     /**
      * ================================
      *            Diagrams
@@ -3744,13 +4279,13 @@ var src_default = (path8) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Diagram|Undefined
      */
-    getDiagram: getDiagram((0, import_node_path22.join)(path8)),
+    getDiagram: getDiagram((0, import_node_path23.join)(path8)),
     /**
      * Returns all diagrams from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Diagram[]|Undefined
      */
-    getDiagrams: getDiagrams((0, import_node_path22.join)(path8)),
+    getDiagrams: getDiagrams((0, import_node_path23.join)(path8)),
     /**
      * Adds a diagram to EventCatalog
      *
@@ -3758,33 +4293,33 @@ var src_default = (path8) => {
      * @param options - Optional options to write the diagram
      *
      */
-    writeDiagram: writeDiagram((0, import_node_path22.join)(path8, "diagrams")),
+    writeDiagram: writeDiagram((0, import_node_path23.join)(path8, "diagrams")),
     /**
      * Remove a diagram from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your diagram, e.g. `/ArchitectureDiagram`
      *
      */
-    rmDiagram: rmDiagram((0, import_node_path22.join)(path8, "diagrams")),
+    rmDiagram: rmDiagram((0, import_node_path23.join)(path8, "diagrams")),
     /**
      * Remove a diagram by a diagram id
      *
      * @param id - The id of the diagram you want to remove
      *
      */
-    rmDiagramById: rmDiagramById((0, import_node_path22.join)(path8)),
+    rmDiagramById: rmDiagramById((0, import_node_path23.join)(path8)),
     /**
      * Moves a given diagram id to the version directory
      * @param id - The id of the diagram to version
      */
-    versionDiagram: versionDiagram((0, import_node_path22.join)(path8)),
+    versionDiagram: versionDiagram((0, import_node_path23.join)(path8)),
     /**
      * Check to see if a diagram version exists
      * @param id - The id of the diagram
      * @param version - The version of the diagram (supports semver)
      * @returns
      */
-    diagramHasVersion: diagramHasVersion((0, import_node_path22.join)(path8)),
+    diagramHasVersion: diagramHasVersion((0, import_node_path23.join)(path8)),
     /**
      * Adds a file to the given diagram
      * @param id - The id of the diagram to add the file to
@@ -3792,7 +4327,7 @@ var src_default = (path8) => {
      * @param version - Optional version of the diagram to add the file to
      * @returns
      */
-    addFileToDiagram: addFileToDiagram((0, import_node_path22.join)(path8)),
+    addFileToDiagram: addFileToDiagram((0, import_node_path23.join)(path8)),
     /**
      * ================================
      *            DSL
@@ -3811,22 +4346,26 @@ var src_default = (path8) => {
      * const dsl = await sdk.toDSL(services, { type: 'service', hydrate: true });
      * ```
      */
-    createSnapshot: createSnapshot((0, import_node_path22.join)(path8)),
-    diffSnapshots: diffSnapshots((0, import_node_path22.join)(path8)),
-    listSnapshots: listSnapshots((0, import_node_path22.join)(path8)),
-    toDSL: toDSL((0, import_node_path22.join)(path8), {
-      getEvent: getEvent((0, import_node_path22.join)(path8)),
-      getCommand: getCommand((0, import_node_path22.join)(path8)),
-      getQuery: getQuery((0, import_node_path22.join)(path8)),
-      getService: getService((0, import_node_path22.join)(path8)),
-      getServices: getServices((0, import_node_path22.join)(path8)),
-      getDomain: getDomain((0, import_node_path22.join)(path8, "domains")),
-      getChannel: getChannel((0, import_node_path22.join)(path8)),
-      getChannels: getChannels((0, import_node_path22.join)(path8)),
-      getContainer: getDataStore((0, import_node_path22.join)(path8)),
-      getTeam: getTeam((0, import_node_path22.join)(path8, "teams")),
-      getUser: getUser((0, import_node_path22.join)(path8, "users"))
+    createSnapshot: createSnapshot((0, import_node_path23.join)(path8)),
+    diffSnapshots: diffSnapshots((0, import_node_path23.join)(path8)),
+    listSnapshots: listSnapshots((0, import_node_path23.join)(path8)),
+    toDSL: toDSL((0, import_node_path23.join)(path8), {
+      getEvent: getEvent((0, import_node_path23.join)(path8)),
+      getCommand: getCommand((0, import_node_path23.join)(path8)),
+      getQuery: getQuery((0, import_node_path23.join)(path8)),
+      getService: getService((0, import_node_path23.join)(path8)),
+      getServices: getServices((0, import_node_path23.join)(path8)),
+      getDomain: getDomain((0, import_node_path23.join)(path8, "domains")),
+      getChannel: getChannel((0, import_node_path23.join)(path8)),
+      getChannels: getChannels((0, import_node_path23.join)(path8)),
+      getContainer: getDataStore((0, import_node_path23.join)(path8)),
+      getTeam: getTeam((0, import_node_path23.join)(path8, "teams")),
+      getUser: getUser((0, import_node_path23.join)(path8, "users"))
     })
   };
 };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FlowBuilder
+});
 //# sourceMappingURL=index.js.map