@eventcatalog/sdk 2.11.0 → 2.12.0

package/dist/services.d.mts

@@ -1,384 +0,0 @@
-import { Service } from './types.d.mjs';
-
-/**
- * Returns a service from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the service
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getService } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the event
- * const service = await getService('InventoryService');
- *
- * // Gets a version of the event
- * const service = await getService('InventoryService', '0.0.1');
- * ```
- */
-declare const getService: (directory: string) => (id: string, version?: string) => Promise<Service>;
-/**
- * Returns a service from EventCatalog by it's path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getServiceByPath } = utils('/path/to/eventcatalog');
- *
- * // Returns a service from the catalog by it's path
- * const service = await getServiceByPath('/services/InventoryService/index.mdx');
- * ```
- */
-declare const getServiceByPath: (directory: string) => (path: string) => Promise<Service>;
-/**
- * Returns all services from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the services.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getServices } = utils('/path/to/eventcatalog');
- *
- * // Gets all services (and versions) from the catalog
- * const services = await getServices();
- *
- * // Gets all services (only latest version) from the catalog
- * const services = await getServices({ latestOnly: true });
- * ```
- */
-declare const getServices: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Service[]>;
-/**
- * Write a Service to EventCatalog.
- *
- * You can optionally overide the path of the Service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeService } = utils('/path/to/eventcatalog');
- *
- * // Write a Service
- * // Service would be written to services/InventoryService
- * await writeService({
- *   id: 'InventoryService',
- *   name: 'Inventory Service',
- *   version: '0.0.1',
- *   summary: 'Service that handles the inventory',
- *   markdown: '# Hello world',
- * });
- *
- * // Write a service to the catalog but override the path
- * // Service would be written to services/Inventory/InventoryService
- * await writeService({
- *    id: 'InventoryService',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/InventoryService"});
- *
- * // Write a service to the catalog and override the existing content (if there is any)
- * await writeService({
- *    id: 'InventoryService',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a service to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeService({
- *    id: 'InventoryService',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeService: (directory: string) => (service: Service, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Write a versioned service to EventCatalog.
- *
- * You can optionally overide the path of the Service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeVersionedService } = utils('/path/to/eventcatalog');
- *
- * // Write a service
- * // Service would be written to services/InventoryService/versioned/0.0.1
- * await writeVersionedService({
- *   id: 'InventoryService',
- *   name: 'Inventory Service',
- *   version: '0.0.1',
- *   summary: 'Service that handles the inventory',
- *   markdown: '# Hello world',
- * });
- *
- * ```
- */
-declare const writeVersionedService: (directory: string) => (service: Service) => Promise<void>;
-/**
- * Write a service to a domain in EventCatalog.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeServiceToDomain } = utils('/path/to/eventcatalog');
- *
- * // Write a service to a domain
- * // Service would be written to domains/Shopping/services/InventoryService
- * await writeServiceToDomain({
- *   id: 'InventoryService',
- *   name: 'Inventory Service',
- *   version: '0.0.1',
- *   summary: 'Service that handles the inventory',
- *   markdown: '# Hello world',
- * }, { id: 'Shopping' });
- * ```
- */
-declare const writeServiceToDomain: (directory: string) => (service: Service, domain: {
-    id: string;
-    version?: string;
-    direction?: string;
-}, options?: {
-    path?: string;
-    format?: "md" | "mdx";
-    override?: boolean;
-}) => Promise<void>;
-/**
- * Version a service by it's id.
- *
- * Takes the latest service and moves it to a versioned directory.
- * All files with this service are also versioned. (e.g /services/InventoryService/openapi.yml)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionService } = utils('/path/to/eventcatalog');
- *
- * // moves the latest InventoryService service to a versioned directory
- * // the version within that service is used as the version number.
- * await versionService('InventoryService');
- *
- * ```
- */
-declare const versionService: (directory: string) => (id: string) => Promise<void>;
-/**
- * Delete a service at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmService } = utils('/path/to/eventcatalog');
- *
- * // Removes the service at services/InventoryService
- * await rmService('/InventoryService');
- * ```
- */
-declare const rmService: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a service by it's id.
- *
- * Optionally specify a version to delete a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmServiceById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest InventoryService event
- * await rmServiceById('InventoryService');
- *
- * // deletes a specific version of the InventoryService event
- * await rmServiceById('InventoryService', '0.0.1');
- * ```
- */
-declare const rmServiceById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Add a file to a service by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToService } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest InventoryService event
- * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the InventoryService event
- * await addFileToService('InventoryService', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToService: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-/**
- * Returns specification files for a service
- *
- * Optionally specify a version to of the service
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getSpecificationFilesForService } = utils('/path/to/eventcatalog');
- *
- * // returns a list of specification files for a service
- * await getSpecificationFilesForService('InventoryService', '0.0.1');
- *
- * ```
- */
-declare const getSpecificationFilesForService: (directory: string) => (id: string, version?: string) => Promise<any>;
-/**
- * Add an event/command to a service by it's id.
- *
- * Optionally specify a version to add the event to a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an event to the service or command to the service
- * const { addEventToService, addCommandToService } = utils('/path/to/eventcatalog');
- *
- * // Adds a new event (InventoryUpdatedEvent) that the InventoryService will send
- * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
- * * // Adds a new event (OrderComplete) that the InventoryService will receive
- * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '1.0.0' });
- *
- * // Adds a new command (UpdateInventoryCommand) that the InventoryService will send
- * await addCommandToService('InventoryService', 'sends', { command: 'UpdateInventoryCommand', version: '2.0.0' });
- * // Adds a new command (VerifyInventory) that the InventoryService will receive
- * await addCommandToService('InventoryService', 'receives', { command: 'VerifyInventory', version: '1.0.0' });
- *
- * ```
- */
-declare const addMessageToService: (directory: string) => (id: string, direction: string, event: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Check to see if the catalog has a version for the given service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { serviceHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await serviceHasVersion('InventoryService', '0.0.1');
- * await serviceHasVersion('InventoryService', 'latest');
- * await serviceHasVersion('InventoryService', '0.0.x');*
- *
- * ```
- */
-declare const serviceHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Check to see if the path is a service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { isService } = utils('/path/to/eventcatalog');
- *
- * // returns true if the path is a service
- * await isService('/services/InventoryService/index.mdx');
- * ```
- */
-declare const isService: (directory: string) => (path: string) => Promise<boolean>;
-/**
- * Takes a given raw file and converts it to a service.
- *
- * @param directory - The directory to convert the file to a service.
- * @returns The service.
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { toService } = utils('/path/to/eventcatalog');
- *
- * // Read the file from somewhere
- * const file = fs.readFileSync('/path/to/services/InventoryService/index.mdx', 'utf8');
- *
- * // Converts the raw file to a service
- * await toService(file);
- * ```
- */
-declare const toService: (directory: string) => (file: string) => Promise<Service>;
-/**
- * Add an entity to a service by its id.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addEntityToService } = utils('/path/to/eventcatalog');
- *
- * // adds a new entity (User) to the InventoryService
- * await addEntityToService('InventoryService', { id: 'User', version: '1.0.0' });
- *
- * // adds a new entity (Product) to a specific version of the InventoryService
- * await addEntityToService('InventoryService', { id: 'Product', version: '1.0.0' }, '2.0.0');
- *
- * ```
- */
-declare const addEntityToService: (directory: string) => (id: string, entity: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Add a data store to a service by it's id.
- *
- * Optionally specify a version to add the data store to a specific version of the service.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an data store to the service
- * const { addDataStoreToService } = utils('/path/to/eventcatalog');
- *
- * // Adds a new data store (orders-db) that the InventoryService will write to
- * await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });
- *
- * * // Adds a new data store (OrderComplete) that the InventoryService will read from
- * await addDataStoreToService('InventoryService', 'readsFrom', { id: 'orders-db', version: '1.0.0' });
- *
- * ```
- */
-declare const addDataStoreToService: (directory: string) => (id: string, operation: "writesTo" | "readsFrom", dataStore: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-
-export { addDataStoreToService, addEntityToService, addFileToService, addMessageToService, getService, getServiceByPath, getServices, getSpecificationFilesForService, isService, rmService, rmServiceById, serviceHasVersion, toService, versionService, writeService, writeServiceToDomain, writeVersionedService };