@eventcatalog/sdk 2.1.1 → 2.1.2

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain, Team, User, CustomDoc } from './types.d.mjs';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc } from './types.d.mjs';
 
 /**
  * Init the SDK for EventCatalog
@@ -208,13 +208,7 @@ declare const _default: (path: string) => {
      * @returns Query[]|Undefined
      */
     getQueries: (options: {
-        latestOnly? /**
-         * Adds a file to the given event
-         * @param id - The id of the event to add the file to
-         * @param file - File contents to add including the content and the file name
-         * @param version - Optional version of the event to add the file to
-         * @returns
-         */: boolean;
+        latestOnly?: boolean;
     }) => Promise<Query[]>;
     /**
      * Adds a query to EventCatalog
@@ -431,13 +425,7 @@ declare const _default: (path: string) => {
      */
     writeService: (service: Service, options?: {
         path?: string;
-        override? /**
-         * 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
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
     }) => Promise<void>;
     /**
@@ -652,6 +640,22 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds an ubiquitous language dictionary to a domain
+     * @param id - The id of the domain to add the ubiquitous language to
+     * @param ubiquitousLanguageDictionary - The ubiquitous language dictionary to add
+     * @param version - Optional version of the domain to add the ubiquitous language to
+     */
+    addUbiquitousLanguageToDomain: (id: string, ubiquitousLanguageDictionary: UbiquitousLanguageDictionary, version?: string) => Promise<void>;
+    /**
+     * Get the ubiquitous language dictionary from a domain
+     * @param id - The id of the domain to get the ubiquitous language from
+     * @param version - Optional version of the domain to get the ubiquitous language from
+     * @returns
+     */
+    getUbiquitousLanguageFromDomain: (id: string, version?: string) => Promise<{
+        markdown: any;
+    } | undefined>;
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain, Team, User, CustomDoc } from './types.d.js';
+import { Event, Command, Query, Channel, Service, Domain, UbiquitousLanguageDictionary, Team, User, CustomDoc } from './types.d.js';
 
 /**
  * Init the SDK for EventCatalog
@@ -208,13 +208,7 @@ declare const _default: (path: string) => {
      * @returns Query[]|Undefined
      */
     getQueries: (options: {
-        latestOnly? /**
-         * Adds a file to the given event
-         * @param id - The id of the event to add the file to
-         * @param file - File contents to add including the content and the file name
-         * @param version - Optional version of the event to add the file to
-         * @returns
-         */: boolean;
+        latestOnly?: boolean;
     }) => Promise<Query[]>;
     /**
      * Adds a query to EventCatalog
@@ -431,13 +425,7 @@ declare const _default: (path: string) => {
      */
     writeService: (service: Service, options?: {
         path?: string;
-        override? /**
-         * 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
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
     }) => Promise<void>;
     /**
@@ -652,6 +640,22 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Adds an ubiquitous language dictionary to a domain
+     * @param id - The id of the domain to add the ubiquitous language to
+     * @param ubiquitousLanguageDictionary - The ubiquitous language dictionary to add
+     * @param version - Optional version of the domain to add the ubiquitous language to
+     */
+    addUbiquitousLanguageToDomain: (id: string, ubiquitousLanguageDictionary: UbiquitousLanguageDictionary, version?: string) => Promise<void>;
+    /**
+     * Get the ubiquitous language dictionary from a domain
+     * @param id - The id of the domain to get the ubiquitous language from
+     * @param version - Optional version of the domain to get the ubiquitous language from
+     * @returns
+     */
+    getUbiquitousLanguageFromDomain: (id: string, version?: string) => Promise<{
+        markdown: any;
+    } | undefined>;
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain