@eventcatalog/sdk 2.11.0 → 2.12.1

package/dist/domains.js

@@ -1,547 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/domains.ts
-var domains_exports = {};
-__export(domains_exports, {
-  addDataProductToDomain: () => addDataProductToDomain,
-  addEntityToDomain: () => addEntityToDomain,
-  addFileToDomain: () => addFileToDomain,
-  addMessageToDomain: () => addMessageToDomain,
-  addServiceToDomain: () => addServiceToDomain,
-  addSubDomainToDomain: () => addSubDomainToDomain,
-  addUbiquitousLanguageToDomain: () => addUbiquitousLanguageToDomain,
-  domainHasVersion: () => domainHasVersion,
-  getDomain: () => getDomain,
-  getDomains: () => getDomains,
-  getUbiquitousLanguageFromDomain: () => getUbiquitousLanguageFromDomain,
-  rmDomain: () => rmDomain,
-  rmDomainById: () => rmDomainById,
-  versionDomain: () => versionDomain,
-  writeDomain: () => writeDomain
-});
-module.exports = __toCommonJS(domains_exports);
-var import_promises2 = __toESM(require("fs/promises"));
-var import_node_path4 = __toESM(require("path"));
-var import_node_fs3 = __toESM(require("fs"));
-
-// src/internal/resources.ts
-var import_path = require("path");
-
-// src/internal/utils.ts
-var import_glob = require("glob");
-var import_node_fs = __toESM(require("fs"));
-var import_fs_extra = require("fs-extra");
-var import_node_path = require("path");
-var import_gray_matter = __toESM(require("gray-matter"));
-var import_semver = require("semver");
-var versionExists = async (catalogDir, id, version) => {
-  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
-  const matchedFiles = await searchFilesForId(files, id, version) || [];
-  return matchedFiles.length > 0;
-};
-var findFileById = async (catalogDir, id, version) => {
-  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
-  const matchedFiles = await searchFilesForId(files, id) || [];
-  const latestVersion = matchedFiles.find((path3) => !path3.includes("versioned"));
-  if (!version) {
-    return latestVersion;
-  }
-  const parsedFiles = matchedFiles.map((path3) => {
-    const { data } = import_gray_matter.default.read(path3);
-    return { ...data, path: path3 };
-  });
-  if (version === "latest") {
-    return latestVersion;
-  }
-  const exactMatch = parsedFiles.find((c) => c.version === version);
-  if (exactMatch) {
-    return exactMatch.path;
-  }
-  const semverRange = (0, import_semver.validRange)(version);
-  if (semverRange) {
-    const match = parsedFiles.filter((c) => {
-      try {
-        return (0, import_semver.satisfies)(c.version, semverRange);
-      } catch (error) {
-        return false;
-      }
-    });
-    return match.length > 0 ? match[0].path : void 0;
-  }
-  return void 0;
-};
-var getFiles = async (pattern, ignore = "") => {
-  try {
-    const normalizedInputPattern = (0, import_node_path.normalize)(pattern);
-    const absoluteBaseDir = (0, import_node_path.resolve)(
-      normalizedInputPattern.includes("**") ? normalizedInputPattern.split("**")[0] : (0, import_node_path.dirname)(normalizedInputPattern)
-    );
-    let relativePattern = (0, import_node_path.relative)(absoluteBaseDir, normalizedInputPattern);
-    relativePattern = relativePattern.replace(/\\/g, "/");
-    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];
-    const files = (0, import_glob.globSync)(relativePattern, {
-      cwd: absoluteBaseDir,
-      ignore: ["node_modules/**", ...ignoreList],
-      absolute: true,
-      nodir: true
-    });
-    return files.map(import_node_path.normalize);
-  } catch (error) {
-    const absoluteBaseDirForError = (0, import_node_path.resolve)(
-      (0, import_node_path.normalize)(pattern).includes("**") ? (0, import_node_path.normalize)(pattern).split("**")[0] : (0, import_node_path.dirname)((0, import_node_path.normalize)(pattern))
-    );
-    const relativePatternForError = (0, import_node_path.relative)(absoluteBaseDirForError, (0, import_node_path.normalize)(pattern)).replace(/\\/g, "/");
-    throw new Error(
-      `Error finding files for pattern "${pattern}" (using cwd: "${absoluteBaseDirForError}", globPattern: "${relativePatternForError}"): ${error.message}`
-    );
-  }
-};
-var readMdxFile = async (path3) => {
-  const { data } = import_gray_matter.default.read(path3);
-  const { markdown, ...frontmatter } = data;
-  return { ...frontmatter, markdown };
-};
-var searchFilesForId = async (files, id, version) => {
-  const escapedId = id.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-  const idRegex = new RegExp(`^id:\\s*(['"]|>-)?\\s*${escapedId}['"]?\\s*$`, "m");
-  const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
-  const matches = files.map((file) => {
-    const content = import_node_fs.default.readFileSync(file, "utf-8");
-    const hasIdMatch = content.match(idRegex);
-    if (version && !content.match(versionRegex)) {
-      return void 0;
-    }
-    if (hasIdMatch) {
-      return file;
-    }
-  });
-  return matches.filter(Boolean).filter((file) => file !== void 0);
-};
-var copyDir = async (catalogDir, source, target, filter) => {
-  const tmpDirectory = (0, import_node_path.join)(catalogDir, "tmp");
-  import_node_fs.default.mkdirSync(tmpDirectory, { recursive: true });
-  await (0, import_fs_extra.copy)(source, tmpDirectory, {
-    overwrite: true,
-    filter
-  });
-  await (0, import_fs_extra.copy)(tmpDirectory, target, {
-    overwrite: true,
-    filter
-  });
-  import_node_fs.default.rmSync(tmpDirectory, { recursive: true });
-};
-var uniqueVersions = (messages) => {
-  const uniqueSet = /* @__PURE__ */ new Set();
-  return messages.filter((message) => {
-    const key = `${message.id}-${message.version}`;
-    if (!uniqueSet.has(key)) {
-      uniqueSet.add(key);
-      return true;
-    }
-    return false;
-  });
-};
-
-// src/internal/resources.ts
-var import_gray_matter2 = __toESM(require("gray-matter"));
-var import_promises = __toESM(require("fs/promises"));
-var import_node_fs2 = __toESM(require("fs"));
-var import_semver2 = require("semver");
-var import_proper_lockfile = require("proper-lockfile");
-var import_node_path2 = require("path");
-var import_node_path3 = __toESM(require("path"));
-var versionResource = async (catalogDir, id) => {
-  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
-  const matchedFiles = await searchFilesForId(files, id);
-  if (matchedFiles.length === 0) {
-    throw new Error(`No resource found with id: ${id}`);
-  }
-  const file = matchedFiles[0];
-  const sourceDirectory = (0, import_path.dirname)(file).replace(/[/\\]versioned[/\\][^/\\]+[/\\]/, import_node_path3.default.sep);
-  const { data: { version = "0.0.1" } = {} } = import_gray_matter2.default.read(file);
-  const targetDirectory = getVersionedDirectory(sourceDirectory, version);
-  import_node_fs2.default.mkdirSync(targetDirectory, { recursive: true });
-  const ignoreListToCopy = ["events", "commands", "queries", "versioned"];
-  await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
-    const folderName = (0, import_node_path2.basename)(src);
-    if (ignoreListToCopy.includes(folderName)) {
-      return false;
-    }
-    return true;
-  });
-  await import_promises.default.readdir(sourceDirectory).then(async (resourceFiles) => {
-    await Promise.all(
-      resourceFiles.map(async (file2) => {
-        if (ignoreListToCopy.includes(file2)) {
-          return;
-        }
-        if (file2 !== "versioned") {
-          import_node_fs2.default.rmSync((0, import_path.join)(sourceDirectory, file2), { recursive: true });
-        }
-      })
-    );
-  });
-};
-var writeResource = async (catalogDir, resource, options = {
-  path: "",
-  type: "",
-  override: false,
-  versionExistingContent: false,
-  format: "mdx"
-}) => {
-  const path3 = options.path || `/${resource.id}`;
-  const fullPath = (0, import_path.join)(catalogDir, path3);
-  const format = options.format || "mdx";
-  import_node_fs2.default.mkdirSync(fullPath, { recursive: true });
-  const lockPath = (0, import_path.join)(fullPath, `index.${format}`);
-  if (!import_node_fs2.default.existsSync(lockPath)) {
-    import_node_fs2.default.writeFileSync(lockPath, "");
-  }
-  try {
-    await (0, import_proper_lockfile.lock)(lockPath, {
-      retries: 5,
-      stale: 1e4
-      // 10 seconds
-    });
-    const exists = await versionExists(catalogDir, resource.id, resource.version);
-    if (exists && !options.override) {
-      throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);
-    }
-    const { markdown, ...frontmatter } = resource;
-    if (options.versionExistingContent && !exists) {
-      const currentResource = await getResource(catalogDir, resource.id);
-      if (currentResource) {
-        if ((0, import_semver2.satisfies)(resource.version, `>${currentResource.version}`)) {
-          await versionResource(catalogDir, resource.id);
-        } else {
-          throw new Error(`New version ${resource.version} is not greater than current version ${currentResource.version}`);
-        }
-      }
-    }
-    const document = import_gray_matter2.default.stringify(markdown.trim(), frontmatter);
-    import_node_fs2.default.writeFileSync(lockPath, document);
-  } finally {
-    await (0, import_proper_lockfile.unlock)(lockPath).catch(() => {
-    });
-  }
-};
-var getResource = async (catalogDir, id, version, options, filePath) => {
-  const attachSchema = options?.attachSchema || false;
-  const file = filePath || (id ? await findFileById(catalogDir, id, version) : void 0);
-  if (!file || !import_node_fs2.default.existsSync(file)) return;
-  const { data, content } = import_gray_matter2.default.read(file);
-  if (attachSchema && data?.schemaPath) {
-    const resourceDirectory = (0, import_path.dirname)(file);
-    const pathToSchema = (0, import_path.join)(resourceDirectory, data.schemaPath);
-    if (import_node_fs2.default.existsSync(pathToSchema)) {
-      const schema = import_node_fs2.default.readFileSync(pathToSchema, "utf8");
-      try {
-        data.schema = JSON.parse(schema);
-      } catch (error) {
-        data.schema = schema;
-      }
-    }
-  }
-  return {
-    ...data,
-    markdown: content.trim()
-  };
-};
-var getResourcePath = async (catalogDir, id, version) => {
-  const file = await findFileById(catalogDir, id, version);
-  if (!file) return;
-  return {
-    fullPath: file,
-    relativePath: file.replace(catalogDir, ""),
-    directory: (0, import_path.dirname)(file.replace(catalogDir, ""))
-  };
-};
-var getResources = async (catalogDir, {
-  type,
-  latestOnly = false,
-  ignore = [],
-  pattern = "",
-  attachSchema = false
-}) => {
-  const ignoreList = latestOnly ? `**/versioned/**` : "";
-  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
-  const files = await getFiles(filePattern, [ignoreList, ...ignore]);
-  if (files.length === 0) return;
-  return files.map((file) => {
-    const { data, content } = import_gray_matter2.default.read(file);
-    if (attachSchema && data?.schemaPath) {
-      const resourceDirectory = (0, import_path.dirname)(file);
-      const pathToSchema = (0, import_path.join)(resourceDirectory, data.schemaPath);
-      if (import_node_fs2.default.existsSync(pathToSchema)) {
-        const schema = import_node_fs2.default.readFileSync(pathToSchema, "utf8");
-        try {
-          data.schema = JSON.parse(schema);
-        } catch (error) {
-          data.schema = schema;
-        }
-      }
-    }
-    return {
-      ...data,
-      markdown: content.trim()
-    };
-  });
-};
-var rmResourceById = async (catalogDir, id, version, options) => {
-  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
-  const matchedFiles = await searchFilesForId(files, id, version);
-  if (matchedFiles.length === 0) {
-    throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
-  }
-  if (options?.persistFiles) {
-    await Promise.all(
-      matchedFiles.map(async (file) => {
-        await import_promises.default.rm(file, { recursive: true });
-        await waitForFileRemoval(file);
-      })
-    );
-  } else {
-    await Promise.all(
-      matchedFiles.map(async (file) => {
-        const directory = (0, import_path.dirname)(file);
-        await import_promises.default.rm(directory, { recursive: true, force: true });
-        await waitForFileRemoval(directory);
-      })
-    );
-  }
-};
-var waitForFileRemoval = async (path3, maxRetries = 50, delay = 10) => {
-  for (let i = 0; i < maxRetries; i++) {
-    try {
-      await import_promises.default.access(path3);
-      await new Promise((resolve2) => setTimeout(resolve2, delay));
-    } catch (error) {
-      return;
-    }
-  }
-  throw new Error(`File/directory ${path3} was not removed after ${maxRetries} attempts`);
-};
-var addFileToResource = async (catalogDir, id, file, version, options) => {
-  let pathToResource;
-  if (options?.path) {
-    pathToResource = (0, import_path.join)(catalogDir, options.path, "index.mdx");
-  } else {
-    pathToResource = await findFileById(catalogDir, id, version);
-  }
-  if (!pathToResource) throw new Error("Cannot find directory to write file to");
-  import_node_fs2.default.mkdirSync(import_node_path3.default.dirname(pathToResource), { recursive: true });
-  let fileContent = file.content.trim();
-  try {
-    const json = JSON.parse(fileContent);
-    fileContent = JSON.stringify(json, null, 2);
-  } catch (error) {
-  }
-  import_node_fs2.default.writeFileSync((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), fileContent);
-};
-var getVersionedDirectory = (sourceDirectory, version) => {
-  return (0, import_path.join)(sourceDirectory, "versioned", version);
-};
-
-// src/domains.ts
-var import_gray_matter3 = __toESM(require("gray-matter"));
-var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
-var getDomains = (directory) => async (options) => getResources(directory, {
-  type: "domains",
-  ignore: ["**/services/**", "**/events/**", "**/commands/**", "**/queries/**", "**/flows/**", "**/entities/**"],
-  ...options
-});
-var writeDomain = (directory) => async (domain, options = {
-  path: "",
-  override: false,
-  versionExistingContent: false,
-  format: "mdx"
-}) => {
-  const resource = { ...domain };
-  if (Array.isArray(domain.services)) {
-    resource.services = uniqueVersions(domain.services);
-  }
-  if (Array.isArray(domain.domains)) {
-    resource.domains = uniqueVersions(domain.domains);
-  }
-  if (Array.isArray(domain.sends)) {
-    resource.sends = uniqueVersions(domain.sends);
-  }
-  if (Array.isArray(domain.receives)) {
-    resource.receives = uniqueVersions(domain.receives);
-  }
-  if (Array.isArray(domain.dataProducts)) {
-    resource.dataProducts = uniqueVersions(domain.dataProducts);
-  }
-  return await writeResource(directory, resource, { ...options, type: "domain" });
-};
-var versionDomain = (directory) => async (id) => versionResource(directory, id);
-var rmDomain = (directory) => async (path3) => {
-  await import_promises2.default.rm((0, import_node_path4.join)(directory, path3), { recursive: true });
-};
-var rmDomainById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "domain", persistFiles });
-var addFileToDomain = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
-var addUbiquitousLanguageToDomain = (directory) => async (id, ubiquitousLanguageDictionary, version) => {
-  const content = import_gray_matter3.default.stringify("", {
-    ...ubiquitousLanguageDictionary
-  });
-  await addFileToResource(directory, id, { content, fileName: "ubiquitous-language.mdx" }, version);
-};
-var getUbiquitousLanguageFromDomain = (directory) => async (id, version) => {
-  const pathToDomain = await findFileById(directory, id, version) || "";
-  const pathToUbiquitousLanguage = import_node_path4.default.join(import_node_path4.default.dirname(pathToDomain), "ubiquitous-language.mdx");
-  const fileExists = import_node_fs3.default.existsSync(pathToUbiquitousLanguage);
-  if (!fileExists) {
-    return void 0;
-  }
-  const content = await readMdxFile(pathToUbiquitousLanguage);
-  return content;
-};
-var domainHasVersion = (directory) => async (id, version) => {
-  const file = await findFileById(directory, id, version);
-  return !!file;
-};
-var addServiceToDomain = (directory) => async (id, service, version) => {
-  let domain = await getDomain(directory)(id, version);
-  const domainPath = await getResourcePath(directory, id, version);
-  const extension = import_node_path4.default.extname(domainPath?.fullPath || "");
-  if (domain.services === void 0) {
-    domain.services = [];
-  }
-  const serviceExistsInList = domain.services.some((s) => s.id === service.id && s.version === service.version);
-  if (serviceExistsInList) {
-    return;
-  }
-  domain.services.push(service);
-  await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
-};
-var addSubDomainToDomain = (directory) => async (id, subDomain, version) => {
-  let domain = await getDomain(directory)(id, version);
-  const domainPath = await getResourcePath(directory, id, version);
-  const extension = import_node_path4.default.extname(domainPath?.fullPath || "");
-  if (domain.domains === void 0) {
-    domain.domains = [];
-  }
-  const subDomainExistsInList = domain.domains.some((s) => s.id === subDomain.id && s.version === subDomain.version);
-  if (subDomainExistsInList) {
-    return;
-  }
-  domain.domains.push(subDomain);
-  await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
-};
-var addEntityToDomain = (directory) => async (id, entity, version) => {
-  let domain = await getDomain(directory)(id, version);
-  const domainPath = await getResourcePath(directory, id, version);
-  const extension = import_node_path4.default.extname(domainPath?.fullPath || "");
-  if (domain.entities === void 0) {
-    domain.entities = [];
-  }
-  const entityExistsInList = domain.entities.some((e) => e.id === entity.id && e.version === entity.version);
-  if (entityExistsInList) {
-    return;
-  }
-  domain.entities.push(entity);
-  await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
-};
-var addDataProductToDomain = (directory) => async (id, dataProduct, version) => {
-  let domain = await getDomain(directory)(id, version);
-  const domainPath = await getResourcePath(directory, id, version);
-  const extension = import_node_path4.default.extname(domainPath?.fullPath || "");
-  if (domain.dataProducts === void 0) {
-    domain.dataProducts = [];
-  }
-  const dataProductExistsInList = domain.dataProducts.some(
-    (dp) => dp.id === dataProduct.id && dp.version === dataProduct.version
-  );
-  if (dataProductExistsInList) {
-    return;
-  }
-  domain.dataProducts.push(dataProduct);
-  await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
-};
-var addMessageToDomain = (directory) => async (id, direction, message, version) => {
-  let domain = await getDomain(directory)(id, version);
-  const domainPath = await getResourcePath(directory, id, version);
-  const extension = import_node_path4.default.extname(domainPath?.fullPath || "");
-  if (direction === "sends") {
-    if (domain.sends === void 0) {
-      domain.sends = [];
-    }
-    for (let i = 0; i < domain.sends.length; i++) {
-      if (domain.sends[i].id === message.id && domain.sends[i].version === message.version) {
-        return;
-      }
-    }
-    domain.sends.push({ id: message.id, version: message.version });
-  } else if (direction === "receives") {
-    if (domain.receives === void 0) {
-      domain.receives = [];
-    }
-    for (let i = 0; i < domain.receives.length; i++) {
-      if (domain.receives[i].id === message.id && domain.receives[i].version === message.version) {
-        return;
-      }
-    }
-    domain.receives.push({ id: message.id, version: message.version });
-  } else {
-    throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
-  }
-  const existingResource = await findFileById(directory, id, version);
-  if (!existingResource) {
-    throw new Error(`Cannot find domain ${id} in the catalog`);
-  }
-  const normalizedPath = existingResource.replace(/\\/g, "/");
-  const lastDomainsIndex = normalizedPath.lastIndexOf("/domains/");
-  const pathToResource = existingResource.substring(0, lastDomainsIndex + "/domains".length);
-  await rmDomainById(directory)(id, version, true);
-  await writeDomain(pathToResource)(domain, { format: extension === ".md" ? "md" : "mdx" });
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  addDataProductToDomain,
-  addEntityToDomain,
-  addFileToDomain,
-  addMessageToDomain,
-  addServiceToDomain,
-  addSubDomainToDomain,
-  addUbiquitousLanguageToDomain,
-  domainHasVersion,
-  getDomain,
-  getDomains,
-  getUbiquitousLanguageFromDomain,
-  rmDomain,
-  rmDomainById,
-  versionDomain,
-  writeDomain
-});
-//# sourceMappingURL=domains.js.map