@eventcatalog/sdk 2.11.0 → 2.12.1

package/dist/data-products.d.ts

@@ -1,225 +0,0 @@
-import { DataProduct } from './types.d.js';
-
-/**
- * Returns a data product from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the data product
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDataProduct } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the data product
- * const dataProduct = await getDataProduct('CustomerDataProduct');
- *
- * // Gets a version of the data product
- * const dataProduct = await getDataProduct('CustomerDataProduct', '0.0.1');
- *
- * ```
- */
-declare const getDataProduct: (directory: string) => (id: string, version?: string) => Promise<DataProduct>;
-/**
- * Returns all data products from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the data products.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDataProducts } = utils('/path/to/eventcatalog');
- *
- * // Gets all data products (and versions) from the catalog
- * const dataProducts = await getDataProducts();
- *
- * // Gets all data products (only latest version) from the catalog
- * const dataProducts = await getDataProducts({ latestOnly: true });
- *
- * ```
- */
-declare const getDataProducts: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<DataProduct[]>;
-/**
- * Write a data product to EventCatalog.
- *
- * You can optionally override the path of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDataProduct } = utils('/path/to/eventcatalog');
- *
- * // Write a data product to the catalog
- * // Data product would be written to data-products/CustomerDataProduct
- * await writeDataProduct({
- *   id: 'CustomerDataProduct',
- *   name: 'Customer Data Product',
- *   version: '0.0.1',
- *   summary: 'Customer data product',
- *   markdown: '# Customer data product',
- * });
- *
- * // Write a data product to the catalog but override the path
- * // Data product would be written to data-products/Account/CustomerDataProduct
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { path: "/Account/CustomerDataProduct"});
- *
- * // Write a data product to the catalog and override the existing content (if there is any)
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { override: true });
- *
- * // Write a data product to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeDataProduct({
- *    id: 'CustomerDataProduct',
- *    name: 'Customer Data Product',
- *    version: '0.0.1',
- *    summary: 'Customer data product',
- *    markdown: '# Customer data product',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeDataProduct: (directory: string) => (dataProduct: DataProduct, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write a data product to a domain in EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDataProductToDomain } = utils('/path/to/eventcatalog');
- *
- * // Write a data product to a domain
- * // Data product would be written to domains/Shopping/data-products/CustomerDataProduct
- * await writeDataProductToDomain({
- *   id: 'CustomerDataProduct',
- *   name: 'Customer Data Product',
- *   version: '0.0.1',
- *   summary: 'Customer data product',
- *   markdown: '# Customer data product',
- * }, { id: 'Shopping' });
- * ```
- */
-declare const writeDataProductToDomain: (directory: string) => (dataProduct: DataProduct, domain: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Delete a data product at its given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDataProduct } = utils('/path/to/eventcatalog');
- *
- * // removes a data product at the given path (data-products dir is appended to the given path)
- * // Removes the data product at data-products/CustomerDataProduct
- * await rmDataProduct('/CustomerDataProduct');
- * ```
- */
-declare const rmDataProduct: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a data product by its id.
- *
- * Optionally specify a version to delete a specific version of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDataProductById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest CustomerDataProduct data product
- * await rmDataProductById('CustomerDataProduct');
- *
- * // deletes a specific version of the CustomerDataProduct data product
- * await rmDataProductById('CustomerDataProduct', '0.0.1');
- * ```
- */
-declare const rmDataProductById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Version a data product by its id.
- *
- * Takes the latest data product and moves it to a versioned directory.
- * All files with this data product are also versioned (e.g /data-products/CustomerDataProduct/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionDataProduct } = utils('/path/to/eventcatalog');
- *
- * // moves the latest CustomerDataProduct data product to a versioned directory
- * // the version within that data product is used as the version number.
- * await versionDataProduct('CustomerDataProduct');
- *
- * ```
- */
-declare const versionDataProduct: (directory: string) => (id: string) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { dataProductHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given data product and version (supports semver)
- * await dataProductHasVersion('CustomerDataProduct', '0.0.1');
- * await dataProductHasVersion('CustomerDataProduct', 'latest');
- * await dataProductHasVersion('CustomerDataProduct', '0.0.x');
- *
- * ```
- */
-declare const dataProductHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a file to a data product by its id.
- *
- * Optionally specify a version to add a file to a specific version of the data product.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToDataProduct } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest CustomerDataProduct data product
- * await addFileToDataProduct('CustomerDataProduct', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the CustomerDataProduct data product
- * await addFileToDataProduct('CustomerDataProduct', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToDataProduct: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-
-export { addFileToDataProduct, dataProductHasVersion, getDataProduct, getDataProducts, rmDataProduct, rmDataProductById, versionDataProduct, writeDataProduct, writeDataProductToDomain };

package/dist/data-products.js

@@ -1,375 +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/data-products.ts
-var data_products_exports = {};
-__export(data_products_exports, {
-  addFileToDataProduct: () => addFileToDataProduct,
-  dataProductHasVersion: () => dataProductHasVersion,
-  getDataProduct: () => getDataProduct,
-  getDataProducts: () => getDataProducts,
-  rmDataProduct: () => rmDataProduct,
-  rmDataProductById: () => rmDataProductById,
-  versionDataProduct: () => versionDataProduct,
-  writeDataProduct: () => writeDataProduct,
-  writeDataProductToDomain: () => writeDataProductToDomain
-});
-module.exports = __toCommonJS(data_products_exports);
-var import_promises2 = __toESM(require("fs/promises"));
-var import_node_path4 = 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((path2) => !path2.includes("versioned"));
-  if (!version) {
-    return latestVersion;
-  }
-  const parsedFiles = matchedFiles.map((path2) => {
-    const { data } = import_gray_matter.default.read(path2);
-    return { ...data, path: path2 };
-  });
-  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 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 });
-};
-
-// src/internal/resources.ts
-var import_path = require("path");
-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 path2 = options.path || `/${resource.id}`;
-  const fullPath = (0, import_path.join)(catalogDir, path2);
-  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 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 (path2, maxRetries = 50, delay = 10) => {
-  for (let i = 0; i < maxRetries; i++) {
-    try {
-      await import_promises.default.access(path2);
-      await new Promise((resolve2) => setTimeout(resolve2, delay));
-    } catch (error) {
-      return;
-    }
-  }
-  throw new Error(`File/directory ${path2} 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/data-products.ts
-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 = {
-  path: "",
-  override: false,
-  format: "mdx"
-}) => 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_path4.join)(pathForDataProduct, dataProduct.id);
-  await writeResource(directory, { ...dataProduct }, { ...options, path: pathForDataProduct, type: "data-product" });
-};
-var rmDataProduct = (directory) => async (path2) => {
-  await import_promises2.default.rm((0, import_node_path4.join)(directory, path2), { recursive: true });
-};
-var rmDataProductById = (directory) => async (id, version, persistFiles) => {
-  await rmResourceById(directory, id, version, { type: "data-product", persistFiles });
-};
-var versionDataProduct = (directory) => async (id) => versionResource(directory, id);
-var dataProductHasVersion = (directory) => async (id, version) => {
-  const file = await findFileById(directory, id, version);
-  return !!file;
-};
-var addFileToDataProduct = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  addFileToDataProduct,
-  dataProductHasVersion,
-  getDataProduct,
-  getDataProducts,
-  rmDataProduct,
-  rmDataProductById,
-  versionDataProduct,
-  writeDataProduct,
-  writeDataProductToDomain
-});
-//# sourceMappingURL=data-products.js.map