@eventcatalog/sdk 2.6.9 → 2.7.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message } from './types.d.mjs';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message, Entity } from './types.d.mjs';
 export { Badge, BaseSchema, ChannelPointer, ResourceGroup, ResourcePointer, Specifications, UbiquitousLanguage } from './types.d.mjs';
 
 /**
@@ -252,7 +252,19 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format?: "md" | "mdx";
+        format
+        /**
+         * Check to see if an event version exists
+         * @param id - The id of the event
+         * @param version - The version of the event (supports semver)
+         * @returns
+         */
+        ? /**
+         * Check to see if an event version exists
+         * @param id - The id of the event
+         * @param version - The version of the event (supports semver)
+         * @returns
+         */: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -444,7 +456,13 @@ declare const _default: (path: string) => {
      *
      */
     writeService: (service: Service, options?: {
-        path?: string;
+        path? /**
+         * Adds a schema to the given event
+         * @param id - The id of the event to add the schema to
+         * @param schema - Schema contents to add including the content and the file name
+         * @param version - Optional version of the event to add the schema to
+         * @returns
+         */: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -607,6 +625,27 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * 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');
+     *
+     * ```
+     */
+    addEntityToService: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Check to see if a service exists by it's path.
      *
@@ -738,6 +777,17 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds an entity to a domain
+     * @param id - The id of the domain
+     * @param entity - The id and version of the entity to add
+     * @param version - (Optional) The version of the domain to add the entity to
+     * @returns
+     */
+    addEntityToDomain: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * ================================
      *            Teams
@@ -784,7 +834,13 @@ declare const _default: (path: string) => {
      *
      */
     writeUser: (user: User, options?: {
-        override?: boolean;
+        override? /**
+         * Adds an event to EventCatalog
+         *
+         * @param event - The event to write
+         * @param options - Optional options to write the event
+         *
+         */: boolean;
     }) => Promise<void>;
     /**
      * Returns a user from EventCatalog
@@ -912,6 +968,65 @@ declare const _default: (path: string) => {
      * @returns { owners: User[] }
      */
     getOwnersForResource: (id: string, version?: string) => Promise<Team[]>;
+    /**
+     * ================================
+     *            Entities
+     * ================================
+     */
+    /**
+     * Returns an entity from EventCatalog
+     * @param id - The id of the entity to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Entity|Undefined
+     */
+    getEntity: (id: string, version?: string) => Promise<Entity>;
+    /**
+     * Returns all entities from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Entity[]|Undefined
+     */
+    getEntities: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Entity[]>;
+    /**
+     * Adds an entity to EventCatalog
+     *
+     * @param entity - The entity to write
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntity: (entity: Entity, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your entity, e.g. `/User`
+     *
+     */
+    rmEntity: (path: string) => Promise<void>;
+    /**
+     * Remove an entity by an entity id
+     *
+     * @param id - The id of the entity you want to remove
+     *
+     */
+    rmEntityById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given entity id to the version directory
+     * @param id - The id of the entity to version
+     */
+    versionEntity: (id: string) => Promise<void>;
+    /**
+     * Check to see if an entity version exists
+     * @param id - The id of the entity
+     * @param version - The version of the entity (supports semver)
+     * @returns
+     */
+    entityHasVersion: (id: string, version?: string) => Promise<boolean>;
 };
 
-export { Channel, Command, CustomDoc, Domain, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };
+export { Channel, Command, CustomDoc, Domain, Entity, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message } from './types.d.js';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message, Entity } from './types.d.js';
 export { Badge, BaseSchema, ChannelPointer, ResourceGroup, ResourcePointer, Specifications, UbiquitousLanguage } from './types.d.js';
 
 /**
@@ -252,7 +252,19 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        format?: "md" | "mdx";
+        format
+        /**
+         * Check to see if an event version exists
+         * @param id - The id of the event
+         * @param version - The version of the event (supports semver)
+         * @returns
+         */
+        ? /**
+         * Check to see if an event version exists
+         * @param id - The id of the event
+         * @param version - The version of the event (supports semver)
+         * @returns
+         */: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -444,7 +456,13 @@ declare const _default: (path: string) => {
      *
      */
     writeService: (service: Service, options?: {
-        path?: string;
+        path? /**
+         * Adds a schema to the given event
+         * @param id - The id of the event to add the schema to
+         * @param schema - Schema contents to add including the content and the file name
+         * @param version - Optional version of the event to add the schema to
+         * @returns
+         */: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -607,6 +625,27 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * 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');
+     *
+     * ```
+     */
+    addEntityToService: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Check to see if a service exists by it's path.
      *
@@ -738,6 +777,17 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds an entity to a domain
+     * @param id - The id of the domain
+     * @param entity - The id and version of the entity to add
+     * @param version - (Optional) The version of the domain to add the entity to
+     * @returns
+     */
+    addEntityToDomain: (id: string, entity: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * ================================
      *            Teams
@@ -784,7 +834,13 @@ declare const _default: (path: string) => {
      *
      */
     writeUser: (user: User, options?: {
-        override?: boolean;
+        override? /**
+         * Adds an event to EventCatalog
+         *
+         * @param event - The event to write
+         * @param options - Optional options to write the event
+         *
+         */: boolean;
     }) => Promise<void>;
     /**
      * Returns a user from EventCatalog
@@ -912,6 +968,65 @@ declare const _default: (path: string) => {
      * @returns { owners: User[] }
      */
     getOwnersForResource: (id: string, version?: string) => Promise<Team[]>;
+    /**
+     * ================================
+     *            Entities
+     * ================================
+     */
+    /**
+     * Returns an entity from EventCatalog
+     * @param id - The id of the entity to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Entity|Undefined
+     */
+    getEntity: (id: string, version?: string) => Promise<Entity>;
+    /**
+     * Returns all entities from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Entity[]|Undefined
+     */
+    getEntities: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Entity[]>;
+    /**
+     * Adds an entity to EventCatalog
+     *
+     * @param entity - The entity to write
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntity: (entity: Entity, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your entity, e.g. `/User`
+     *
+     */
+    rmEntity: (path: string) => Promise<void>;
+    /**
+     * Remove an entity by an entity id
+     *
+     * @param id - The id of the entity you want to remove
+     *
+     */
+    rmEntityById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Moves a given entity id to the version directory
+     * @param id - The id of the entity to version
+     */
+    versionEntity: (id: string) => Promise<void>;
+    /**
+     * Check to see if an entity version exists
+     * @param id - The id of the entity
+     * @param version - The version of the entity (supports semver)
+     * @returns
+     */
+    entityHasVersion: (id: string, version?: string) => Promise<boolean>;
 };
 
-export { Channel, Command, CustomDoc, Domain, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };
+export { Channel, Command, CustomDoc, Domain, Entity, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };