@eventcatalog/sdk 2.10.0 → 2.12.0

package/dist/domains.d.mts

@@ -1,297 +0,0 @@
-import { Domain, UbiquitousLanguageDictionary } from './types.d.mjs';
-
-/**
- * Returns a domain from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the domain
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDomain } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the domain
- * const domain = await getDomain('Payment');
- *
- * // Gets a version of the domain
- * const domain = await getDomain('Payment', '0.0.1');
- * ```
- */
-declare const getDomain: (directory: string) => (id: string, version?: string) => Promise<Domain>;
-/**
- * Returns all domains from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the domains.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDomains } = utils('/path/to/eventcatalog');
- *
- * // Gets all domains (and versions) from the catalog
- * const domains = await getDomains();
- *
- * // Gets all domains (only latest version) from the catalog
- * const domains = await getDomains({ latestOnly: true });
- * ```
- */
-declare const getDomains: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Domain[]>;
-/**
- * Write a domain to EventCatalog.
- *
- * You can optionally overide the path of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDomain } = utils('/path/to/eventcatalog');
- *
- * // Write a domain
- * // Domain would be written to domains/Payment
- * await writeDomain({
- *   id: 'Payment',
- *   name: 'Payment domain',
- *   version: '0.0.1',
- *   summary: 'Domain for all things to do with payments',
- *   markdown: '# Hello world',
- * });
- *
- * // Write a domain to the catalog but override the path
- * // Domain would be written to domains/Inventory/Payment
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/Payment"});
- *
- * // Write a domain to the catalog and override the existing content (if there is any)
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a domain to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeDomain: (directory: string) => (domain: Domain, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Version a domain by it's id.
- *
- * Takes the latest domain and moves it to a versioned directory.
- * All files with this domain are also versioned. (e.g /domains/Payment/openapi.yml)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionDomain } = utils('/path/to/eventcatalog');
- *
- * // moves the latest Payment domain to a versioned directory
- * // the version within that domain is used as the version number.
- * await versionDomain('Payment');
- *
- * ```
- */
-declare const versionDomain: (directory: string) => (id: string) => Promise<void>;
-/**
- * Delete a domain at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDomain } = utils('/path/to/eventcatalog');
- *
- * // Removes the domain at domains/Payment
- * await rmDomain('/Payment');
- * ```
- */
-declare const rmDomain: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a domain by it's id.
- *
- * Optionally specify a version to delete a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDomainById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest Payment event
- * await rmDomainById('Payment');
- *
- * // deletes a specific version of the Payment event
- * await rmDomainById('Payment', '0.0.1');
- * ```
- */
-declare const rmDomainById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Add a file to a domain by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToDomain } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest Payment event
- * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the Payment event
- * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToDomain: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-/**
- * Adds a ubiquitous language dictionary to a domain.
- *
- * Optionally specify a version to add a ubiquitous language dictionary to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addUbiquitousLanguageToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a ubiquitous language dictionary to the latest Payment domain
- * await addUbiquitousLanguageToDomain('Payment', { dictionary: [{ id: 'Order', name: 'Order', summary: 'All things to do with the payment systems', description: 'This is a description', icon: 'KeyIcon' }] });
- *
- * // Adds a ubiquitous language dictionary to a specific version of the domain
- * await addUbiquitousLanguageToDomain('Payment', { dictionary: [{ id: 'Order', name: 'Order', summary: 'All things to do with the payment systems', description: 'This is a description', icon: 'KeyIcon' }] }, '0.0.1');
- * ```
- */
-declare const addUbiquitousLanguageToDomain: (directory: string) => (id: string, ubiquitousLanguageDictionary: UbiquitousLanguageDictionary, version?: string) => Promise<void>;
-/**
- * Returns the ubiquitous language dictionary from a domain.
- *
- * Optionally specify a version to get the ubiquitous language dictionary from a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUbiquitousLanguageFromDomain } = utils('/path/to/eventcatalog');
- *
- * const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment');
- *
- * // Returns the ubiquitous language dictionary from a specific version of the domain
- * const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment', '0.0.1');
- * ```
- */
-declare const getUbiquitousLanguageFromDomain: (directory: string) => (id: string, version?: string) => Promise<{
-    markdown: any;
-} | undefined>;
-/**
- * Check to see if the catalog has a version for the given domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { domainHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await domainHasVersion('Orders', '0.0.1');
- * await domainHasVersion('Orders', 'latest');
- * await domainHasVersion('Orders', '0.0.x');*
- *
- * ```
- */
-declare const domainHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a service to a domain by it's id.
- *
- * Optionally specify a version to add the service to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds a service to the domain
- * const { addServiceToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a service (Orders Service) to the domain (Orders)
- * await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' });
- * // Adds a service (Orders Service) to the domain (Orders) with a specific version
- * await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addServiceToDomain: (directory: string) => (id: string, service: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Add a subdomain to a domain by it's id.
- * Optionally specify a version to add the subdomain to a specific version of the domain
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds a subdomain to the given domain
- * const { addSubDomainToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a subdomain (Payment Domain) to the domain (Orders)
- * await addSubDomainToDomain('Orders', { service: 'Payment Domain', version: '2.0.0' });
- * // Adds a subdomain (Inventory Domain) to the domain (Orders) with a specific version
- * await addSubDomainToDomain('Orders', { service: 'Inventory Domain', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addSubDomainToDomain: (directory: string) => (id: string, subDomain: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Add an entity to a domain by its id.
- * Optionally specify a version to add the entity to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an entity to the domain
- * const { addEntityToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds an entity (User) to the domain (Orders)
- * await addEntityToDomain('Orders', { id: 'User', version: '1.0.0' });
- * // Adds an entity (Product) to the domain (Orders) with a specific version
- * await addEntityToDomain('Orders', { id: 'Product', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addEntityToDomain: (directory: string) => (id: string, entity: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-
-export { addEntityToDomain, addFileToDomain, addServiceToDomain, addSubDomainToDomain, addUbiquitousLanguageToDomain, domainHasVersion, getDomain, getDomains, getUbiquitousLanguageFromDomain, rmDomain, rmDomainById, versionDomain, writeDomain };

package/dist/domains.d.ts

@@ -1,297 +0,0 @@
-import { Domain, UbiquitousLanguageDictionary } from './types.d.js';
-
-/**
- * Returns a domain from EventCatalog.
- *
- * You can optionally specify a version to get a specific version of the domain
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDomain } = utils('/path/to/eventcatalog');
- *
- * // Gets the latest version of the domain
- * const domain = await getDomain('Payment');
- *
- * // Gets a version of the domain
- * const domain = await getDomain('Payment', '0.0.1');
- * ```
- */
-declare const getDomain: (directory: string) => (id: string, version?: string) => Promise<Domain>;
-/**
- * Returns all domains from EventCatalog.
- *
- * You can optionally specify if you want to get the latest version of the domains.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getDomains } = utils('/path/to/eventcatalog');
- *
- * // Gets all domains (and versions) from the catalog
- * const domains = await getDomains();
- *
- * // Gets all domains (only latest version) from the catalog
- * const domains = await getDomains({ latestOnly: true });
- * ```
- */
-declare const getDomains: (directory: string) => (options?: {
-    latestOnly?: boolean;
-}) => Promise<Domain[]>;
-/**
- * Write a domain to EventCatalog.
- *
- * You can optionally overide the path of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { writeDomain } = utils('/path/to/eventcatalog');
- *
- * // Write a domain
- * // Domain would be written to domains/Payment
- * await writeDomain({
- *   id: 'Payment',
- *   name: 'Payment domain',
- *   version: '0.0.1',
- *   summary: 'Domain for all things to do with payments',
- *   markdown: '# Hello world',
- * });
- *
- * // Write a domain to the catalog but override the path
- * // Domain would be written to domains/Inventory/Payment
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { path: "/Inventory/Payment"});
- *
- * // Write a domain to the catalog and override the existing content (if there is any)
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { override: true });
- *
- * // Write a domain to the catalog and version the previous version
- * // only works if the new version is greater than the previous version
- * await writeDomain({
- *    id: 'Payment',
- *    name: 'Inventory Adjusted',
- *    version: '0.0.1',
- *    summary: 'This is a summary',
- *    markdown: '# Hello world',
- * }, { versionExistingContent: true });
- *
- * ```
- */
-declare const writeDomain: (directory: string) => (domain: Domain, options?: {
-    path?: string;
-    override?: boolean;
-    versionExistingContent?: boolean;
-    format?: "md" | "mdx";
-}) => Promise<void>;
-/**
- * Version a domain by it's id.
- *
- * Takes the latest domain and moves it to a versioned directory.
- * All files with this domain are also versioned. (e.g /domains/Payment/openapi.yml)
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { versionDomain } = utils('/path/to/eventcatalog');
- *
- * // moves the latest Payment domain to a versioned directory
- * // the version within that domain is used as the version number.
- * await versionDomain('Payment');
- *
- * ```
- */
-declare const versionDomain: (directory: string) => (id: string) => Promise<void>;
-/**
- * Delete a domain at it's given path.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDomain } = utils('/path/to/eventcatalog');
- *
- * // Removes the domain at domains/Payment
- * await rmDomain('/Payment');
- * ```
- */
-declare const rmDomain: (directory: string) => (path: string) => Promise<void>;
-/**
- * Delete a domain by it's id.
- *
- * Optionally specify a version to delete a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { rmDomainById } = utils('/path/to/eventcatalog');
- *
- * // deletes the latest Payment event
- * await rmDomainById('Payment');
- *
- * // deletes a specific version of the Payment event
- * await rmDomainById('Payment', '0.0.1');
- * ```
- */
-declare const rmDomainById: (directory: string) => (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
-/**
- * Add a file to a domain by it's id.
- *
- * Optionally specify a version to add a file to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addFileToDomain } = utils('/path/to/eventcatalog');
- *
- * // adds a file to the latest Payment event
- * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' });
- *
- * // adds a file to a specific version of the Payment event
- * await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');
- *
- * ```
- */
-declare const addFileToDomain: (directory: string) => (id: string, file: {
-    content: string;
-    fileName: string;
-}, version?: string) => Promise<void>;
-/**
- * Adds a ubiquitous language dictionary to a domain.
- *
- * Optionally specify a version to add a ubiquitous language dictionary to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { addUbiquitousLanguageToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a ubiquitous language dictionary to the latest Payment domain
- * await addUbiquitousLanguageToDomain('Payment', { dictionary: [{ id: 'Order', name: 'Order', summary: 'All things to do with the payment systems', description: 'This is a description', icon: 'KeyIcon' }] });
- *
- * // Adds a ubiquitous language dictionary to a specific version of the domain
- * await addUbiquitousLanguageToDomain('Payment', { dictionary: [{ id: 'Order', name: 'Order', summary: 'All things to do with the payment systems', description: 'This is a description', icon: 'KeyIcon' }] }, '0.0.1');
- * ```
- */
-declare const addUbiquitousLanguageToDomain: (directory: string) => (id: string, ubiquitousLanguageDictionary: UbiquitousLanguageDictionary, version?: string) => Promise<void>;
-/**
- * Returns the ubiquitous language dictionary from a domain.
- *
- * Optionally specify a version to get the ubiquitous language dictionary from a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { getUbiquitousLanguageFromDomain } = utils('/path/to/eventcatalog');
- *
- * const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment');
- *
- * // Returns the ubiquitous language dictionary from a specific version of the domain
- * const ubiquitousLanguage = await getUbiquitousLanguageFromDomain('Payment', '0.0.1');
- * ```
- */
-declare const getUbiquitousLanguageFromDomain: (directory: string) => (id: string, version?: string) => Promise<{
-    markdown: any;
-} | undefined>;
-/**
- * Check to see if the catalog has a version for the given domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * const { domainHasVersion } = utils('/path/to/eventcatalog');
- *
- * // returns true if version is found for the given event and version (supports semver)
- * await domainHasVersion('Orders', '0.0.1');
- * await domainHasVersion('Orders', 'latest');
- * await domainHasVersion('Orders', '0.0.x');*
- *
- * ```
- */
-declare const domainHasVersion: (directory: string) => (id: string, version?: string) => Promise<boolean>;
-/**
- * Add a service to a domain by it's id.
- *
- * Optionally specify a version to add the service to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds a service to the domain
- * const { addServiceToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a service (Orders Service) to the domain (Orders)
- * await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' });
- * // Adds a service (Orders Service) to the domain (Orders) with a specific version
- * await addServiceToDomain('Orders', { service: 'Order Service', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addServiceToDomain: (directory: string) => (id: string, service: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Add a subdomain to a domain by it's id.
- * Optionally specify a version to add the subdomain to a specific version of the domain
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds a subdomain to the given domain
- * const { addSubDomainToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds a subdomain (Payment Domain) to the domain (Orders)
- * await addSubDomainToDomain('Orders', { service: 'Payment Domain', version: '2.0.0' });
- * // Adds a subdomain (Inventory Domain) to the domain (Orders) with a specific version
- * await addSubDomainToDomain('Orders', { service: 'Inventory Domain', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addSubDomainToDomain: (directory: string) => (id: string, subDomain: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-/**
- * Add an entity to a domain by its id.
- * Optionally specify a version to add the entity to a specific version of the domain.
- *
- * @example
- * ```ts
- * import utils from '@eventcatalog/utils';
- *
- * // Adds an entity to the domain
- * const { addEntityToDomain } = utils('/path/to/eventcatalog');
- *
- * // Adds an entity (User) to the domain (Orders)
- * await addEntityToDomain('Orders', { id: 'User', version: '1.0.0' });
- * // Adds an entity (Product) to the domain (Orders) with a specific version
- * await addEntityToDomain('Orders', { id: 'Product', version: '2.0.0' }, '1.0.0');
- * ```
- */
-declare const addEntityToDomain: (directory: string) => (id: string, entity: {
-    id: string;
-    version: string;
-}, version?: string) => Promise<void>;
-
-export { addEntityToDomain, addFileToDomain, addServiceToDomain, addSubDomainToDomain, addUbiquitousLanguageToDomain, domainHasVersion, getDomain, getDomains, getUbiquitousLanguageFromDomain, rmDomain, rmDomainById, versionDomain, writeDomain };