@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/containers.d.mts

@@ -1,179 +0,0 @@
-import { Container } from './types.d.mjs';
-
-/**
- * Returns an container (e.g. data store) from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the container
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getContainer } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the container
- * const container = await getContainer('User');
- *
- * // Gets a version of the entity
- * const container = await getContainer('User', '0.0.1');
- *
- * ```
- */
-declare const getContainer: (directory: string) => (id: string, version?: string) => Promise<Container>;
-/**
- * Returns all containers (e.g. data stores) from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the containers.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getContainers } = utils('/path/to/eventcatalog');
- *
- * // Gets all containers (and versions) from the catalog
- * const containers = await getContainers();
- *
- * // Gets all entities (only latest version) from the catalog
- * const containers = await getContainers({ latestOnly: true });
- *
- * ```
- */
-declare const getContainers: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Container[]>;
-/**
- * Write a container (e.g. data store) to EventCatalog.
- */
-declare const writeContainer: (directory: string) => (data: Container, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Version an container (e.g. data store) by its id.
- *
- * Takes the latest container and moves it to a versioned directory.
- * All files with this container are also versioned (e.g /containers/orders-db/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionContainer } = utils('/path/to/eventcatalog');
- *
- * // moves the latest orders-db container to a versioned directory
- * // the version within that container is used as the version number.
- * await versionContainer('orders-db');
- *
- * ```
- */
-declare const versionContainer: (directory: string) => (id: string) => Promise<void>;
-/**
- * Delete an container (e.g. data store) at its given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmContainer } = utils('/path/to/eventcatalog');
- *
- * // removes an container at the given path (containers dir is appended to the given path)
- * // Removes the container at containers/orders-db
- * await rmContainer('/orders-db');
- * ```
- */
-declare const rmContainer: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete an container (e.g. data store) by its id.
- *
- * Optionally specify a version to delete a specific version of the container.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmContainerById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest orders-db container
- * await rmContainerById('orders-db');
- *
- * // deletes a specific version of the orders-db container
- * await rmContainerById('orders-db', '0.0.1');
- * ```
- */
-declare const rmContainerById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given container (e.g. data store).
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { containerHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given entity and version (supports semver)
- * await containerHasVersion('orders-db', '0.0.1');
- * await containerHasVersion('orders-db', 'latest');
- * await containerHasVersion('orders-db', '0.0.x');
- *
- * ```
- */
-declare const containerHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a file to a container (e.g. data store) by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the container.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToContainer } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToContainer('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToContainer('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToContainer: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-/**
- * Write an data store (e.g. data store) to a service in EventCatalog.
- *
- * You can optionally override the path of the data store.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeContainerToService } = utils('/path/to/eventcatalog');
- *
- * // Write a container to a given service in the catalog
- * // Container would be written to services/Inventory/containers/orders-db
- * await writeContainerToService({
- *   id: 'orders-db',
- *   name: 'Orders DB',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- *   container_type: 'database',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeContainerToService: (directory: string) => (container: Container, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-
-export { addFileToContainer, containerHasVersion, getContainer, getContainers, rmContainer, rmContainerById, versionContainer, writeContainer, writeContainerToService };

package/dist/containers.d.ts

@@ -1,179 +0,0 @@
-import { Container } from './types.d.js';
-
-/**
- * Returns an container (e.g. data store) from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the container
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getContainer } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the container
- * const container = await getContainer('User');
- *
- * // Gets a version of the entity
- * const container = await getContainer('User', '0.0.1');
- *
- * ```
- */
-declare const getContainer: (directory: string) => (id: string, version?: string) => Promise<Container>;
-/**
- * Returns all containers (e.g. data stores) from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the containers.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getContainers } = utils('/path/to/eventcatalog');
- *
- * // Gets all containers (and versions) from the catalog
- * const containers = await getContainers();
- *
- * // Gets all entities (only latest version) from the catalog
- * const containers = await getContainers({ latestOnly: true });
- *
- * ```
- */
-declare const getContainers: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Container[]>;
-/**
- * Write a container (e.g. data store) to EventCatalog.
- */
-declare const writeContainer: (directory: string) => (data: Container, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Version an container (e.g. data store) by its id.
- *
- * Takes the latest container and moves it to a versioned directory.
- * All files with this container are also versioned (e.g /containers/orders-db/schema.json)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionContainer } = utils('/path/to/eventcatalog');
- *
- * // moves the latest orders-db container to a versioned directory
- * // the version within that container is used as the version number.
- * await versionContainer('orders-db');
- *
- * ```
- */
-declare const versionContainer: (directory: string) => (id: string) => Promise<void>;
-/**
- * Delete an container (e.g. data store) at its given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmContainer } = utils('/path/to/eventcatalog');
- *
- * // removes an container at the given path (containers dir is appended to the given path)
- * // Removes the container at containers/orders-db
- * await rmContainer('/orders-db');
- * ```
- */
-declare const rmContainer: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete an container (e.g. data store) by its id.
- *
- * Optionally specify a version to delete a specific version of the container.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmContainerById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest orders-db container
- * await rmContainerById('orders-db');
- *
- * // deletes a specific version of the orders-db container
- * await rmContainerById('orders-db', '0.0.1');
- * ```
- */
-declare const rmContainerById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given container (e.g. data store).
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { containerHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given entity and version (supports semver)
- * await containerHasVersion('orders-db', '0.0.1');
- * await containerHasVersion('orders-db', 'latest');
- * await containerHasVersion('orders-db', '0.0.x');
- *
- * ```
- */
-declare const containerHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a file to a container (e.g. data store) by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the container.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToContainer } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest InventoryAdjusted event
- * await addFileToContainer('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the InventoryAdjusted event
- * await addFileToContainer('InventoryAdjusted', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToContainer: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-/**
- * Write an data store (e.g. data store) to a service in EventCatalog.
- *
- * You can optionally override the path of the data store.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeContainerToService } = utils('/path/to/eventcatalog');
- *
- * // Write a container to a given service in the catalog
- * // Container would be written to services/Inventory/containers/orders-db
- * await writeContainerToService({
- *   id: 'orders-db',
- *   name: 'Orders DB',
- *   version: '0.0.1',
- *   summary: 'This is a summary',
- *   markdown: '# Hello world',
- *   container_type: 'database',
- * }, { id: 'Inventory' });
- * ```
- */
-declare const writeContainerToService: (directory: string) => (container: Container, service: {
-    id: string;
-    version?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-
-export { addFileToContainer, containerHasVersion, getContainer, getContainers, rmContainer, rmContainerById, versionContainer, writeContainer, writeContainerToService };