@eventcatalog/sdk 2.8.0 → 2.8.2

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message, Entity } from './types.d.mjs';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message, Entity, Container } from './types.d.mjs';
 export { Badge, BaseSchema, ChannelPointer, ResourceGroup, ResourcePointer, Specification, Specifications, UbiquitousLanguage } from './types.d.mjs';
 
 /**
@@ -135,7 +135,12 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -252,19 +257,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        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";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -456,13 +449,7 @@ declare const _default: (path: string) => {
      *
      */
     writeService: (service: Service, options?: {
-        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;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -682,7 +669,12 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path?: string;
+        path? /**
+         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -834,13 +826,7 @@ declare const _default: (path: string) => {
      *
      */
     writeUser: (user: User, options?: {
-        override? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: boolean;
+        override?: boolean;
     }) => Promise<void>;
     /**
      * Returns a user from EventCatalog
@@ -1027,6 +1013,85 @@ declare const _default: (path: string) => {
      * @returns
      */
     entityHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Data Stores
+     * ================================
+     */
+    /**
+     * Adds a data store to EventCatalog
+     * @param dataStore - The data store to write
+     * @param options - Optional options to write the data store
+     *
+     */
+    writeDataStore: (data: Container, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns a data store from EventCatalog
+     * @param id - The id of the data store to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Container|Undefined
+     */
+    getDataStore: (id: string, version?: string) => Promise<Container>;
+    /**
+     * Returns all data stores from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Container[]|Undefined
+     */
+    getDataStores: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Container[]>;
+    /**
+     * Version a data store by its id
+     * @param id - The id of the data store to version
+     */
+    versionDataStore: (id: string) => Promise<void>;
+    /**
+     * Remove a data store by its path
+     * @param path - The path to the data store to remove
+     */
+    rmDataStore: (path: string) => Promise<void>;
+    /**
+     * Remove a data store by its id
+     * @param id - The id of the data store to remove
+     */
+    rmDataStoreById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Check to see if a data store version exists
+     * @param id - The id of the data store
+     * @param version - The version of the data store (supports semver)
+     * @returns
+     */
+    dataStoreHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a file to a data store by its id
+     * @param id - The id of the data store to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the data store to add the file to
+     * @returns
+     */
+    addFileToDataStore: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Writes a data store to a service by its id
+     * @param dataStore - The data store to write
+     * @param service - The service to write the data store to
+     * @returns
+     */
+    writeDataStoreToService: (container: Container, service: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
 };
 
-export { Channel, Command, CustomDoc, Domain, Entity, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };
+export { Channel, Command, Container, 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, Entity } from './types.d.js';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc, EventCatalog, Message, Entity, Container } from './types.d.js';
 export { Badge, BaseSchema, ChannelPointer, ResourceGroup, ResourcePointer, Specification, Specifications, UbiquitousLanguage } from './types.d.js';
 
 /**
@@ -135,7 +135,12 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -252,19 +257,7 @@ declare const _default: (path: string) => {
         version?: string;
     }, options?: {
         path?: string;
-        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";
+        format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
     /**
@@ -456,13 +449,7 @@ declare const _default: (path: string) => {
      *
      */
     writeService: (service: Service, options?: {
-        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;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -682,7 +669,12 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path?: string;
+        path? /**
+         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -834,13 +826,7 @@ declare const _default: (path: string) => {
      *
      */
     writeUser: (user: User, options?: {
-        override? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: boolean;
+        override?: boolean;
     }) => Promise<void>;
     /**
      * Returns a user from EventCatalog
@@ -1027,6 +1013,85 @@ declare const _default: (path: string) => {
      * @returns
      */
     entityHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * ================================
+     *            Data Stores
+     * ================================
+     */
+    /**
+     * Adds a data store to EventCatalog
+     * @param dataStore - The data store to write
+     * @param options - Optional options to write the data store
+     *
+     */
+    writeDataStore: (data: Container, options?: {
+        path?: string;
+        override?: boolean;
+        versionExistingContent?: boolean;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns a data store from EventCatalog
+     * @param id - The id of the data store to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Container|Undefined
+     */
+    getDataStore: (id: string, version?: string) => Promise<Container>;
+    /**
+     * Returns all data stores from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Container[]|Undefined
+     */
+    getDataStores: (options?: {
+        latestOnly?: boolean;
+    }) => Promise<Container[]>;
+    /**
+     * Version a data store by its id
+     * @param id - The id of the data store to version
+     */
+    versionDataStore: (id: string) => Promise<void>;
+    /**
+     * Remove a data store by its path
+     * @param path - The path to the data store to remove
+     */
+    rmDataStore: (path: string) => Promise<void>;
+    /**
+     * Remove a data store by its id
+     * @param id - The id of the data store to remove
+     */
+    rmDataStoreById: (id: string, version?: string, persistFiles?: boolean) => Promise<void>;
+    /**
+     * Check to see if a data store version exists
+     * @param id - The id of the data store
+     * @param version - The version of the data store (supports semver)
+     * @returns
+     */
+    dataStoreHasVersion: (id: string, version?: string) => Promise<boolean>;
+    /**
+     * Adds a file to a data store by its id
+     * @param id - The id of the data store to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the data store to add the file to
+     * @returns
+     */
+    addFileToDataStore: (id: string, file: {
+        content: string;
+        fileName: string;
+    }, version?: string) => Promise<void>;
+    /**
+     * Writes a data store to a service by its id
+     * @param dataStore - The data store to write
+     * @param service - The service to write the data store to
+     * @returns
+     */
+    writeDataStoreToService: (container: Container, service: {
+        id: string;
+        version?: string;
+    }, options?: {
+        path?: string;
+        format?: "md" | "mdx";
+        override?: boolean;
+    }) => Promise<void>;
 };
 
-export { Channel, Command, CustomDoc, Domain, Entity, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };
+export { Channel, Command, Container, CustomDoc, Domain, Entity, Event, EventCatalog, Message, Query, Service, Team, UbiquitousLanguageDictionary, User, _default as default };