@eventcatalog/sdk 2.10.0 → 2.11.0

package/dist/data-products.d.mts

@@ -0,0 +1,225 @@
+import { DataProduct } from './types.d.mjs';
+
+/**
+ * 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.d.ts

@@ -0,0 +1,225 @@
+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 };