@eventcatalog/sdk 1.3.1 → 1.4.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain } from './types.d.mjs';
+import { Event, Command, Query, Channel, Service, Domain, Team, User } from './types.d.mjs';
 
 /**
  * Init the SDK for EventCatalog
@@ -463,11 +463,7 @@ declare const _default: (path: string) => {
      * @returns Service[]|Undefined
      */
     getServices: (options?: {
-        latestOnly? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: boolean;
+        latestOnly?: boolean;
     }) => Promise<Service[]>;
     /**
      * Moves a given service id to the version directory
@@ -662,6 +658,72 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Teams
+     * ================================
+     */
+    /**
+     * Adds a team to EventCatalog
+     *
+     * @param team - The team to write
+     * @param options - Optional options to write the team
+     *
+     */
+    writeTeam: (team: Team, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a team from EventCatalog
+     * @param id - The id of the team to retrieve
+     * @returns Team|Undefined
+     */
+    getTeam: (id: string) => Promise<Team | undefined>;
+    /**
+     * Returns all teams from EventCatalog
+     * @returns Team[]|Undefined
+     */
+    getTeams: (options?: {}) => Promise<Team[]>;
+    /**
+     * Remove a team by the team id
+     *
+     * @param id - The id of the team you want to remove
+     *
+     */
+    rmTeamById: (id: string) => Promise<void>;
+    /**
+     * ================================
+     *            Users
+     * ================================
+     */
+    /**
+     * Adds a user to EventCatalog
+     *
+     * @param user - The user to write
+     * @param options - Optional options to write the user
+     *
+     */
+    writeUser: (user: User, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a user from EventCatalog
+     * @param id - The id of the user to retrieve
+     * @returns User|Undefined
+     */
+    getUser: (id: string) => Promise<User | undefined>;
+    /**
+     * Returns all user from EventCatalog
+     * @returns User[]|Undefined
+     */
+    getUsers: (options?: {}) => Promise<User[]>;
+    /**
+     * Remove a user by the user id
+     *
+     * @param id - The id of the user you want to remove
+     *
+     */
+    rmUserById: (id: string) => Promise<void>;
 };
 
 export { _default as default };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Event, Command, Query, Channel, Service, Domain } from './types.d.js';
+import { Event, Command, Query, Channel, Service, Domain, Team, User } from './types.d.js';
 
 /**
  * Init the SDK for EventCatalog
@@ -463,11 +463,7 @@ declare const _default: (path: string) => {
      * @returns Service[]|Undefined
      */
     getServices: (options?: {
-        latestOnly? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: boolean;
+        latestOnly?: boolean;
     }) => Promise<Service[]>;
     /**
      * Moves a given service id to the version directory
@@ -662,6 +658,72 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            Teams
+     * ================================
+     */
+    /**
+     * Adds a team to EventCatalog
+     *
+     * @param team - The team to write
+     * @param options - Optional options to write the team
+     *
+     */
+    writeTeam: (team: Team, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a team from EventCatalog
+     * @param id - The id of the team to retrieve
+     * @returns Team|Undefined
+     */
+    getTeam: (id: string) => Promise<Team | undefined>;
+    /**
+     * Returns all teams from EventCatalog
+     * @returns Team[]|Undefined
+     */
+    getTeams: (options?: {}) => Promise<Team[]>;
+    /**
+     * Remove a team by the team id
+     *
+     * @param id - The id of the team you want to remove
+     *
+     */
+    rmTeamById: (id: string) => Promise<void>;
+    /**
+     * ================================
+     *            Users
+     * ================================
+     */
+    /**
+     * Adds a user to EventCatalog
+     *
+     * @param user - The user to write
+     * @param options - Optional options to write the user
+     *
+     */
+    writeUser: (user: User, options?: {
+        override?: boolean;
+    }) => Promise<void>;
+    /**
+     * Returns a user from EventCatalog
+     * @param id - The id of the user to retrieve
+     * @returns User|Undefined
+     */
+    getUser: (id: string) => Promise<User | undefined>;
+    /**
+     * Returns all user from EventCatalog
+     * @returns User[]|Undefined
+     */
+    getUsers: (options?: {}) => Promise<User[]>;
+    /**
+     * Remove a user by the user id
+     *
+     * @param id - The id of the user you want to remove
+     *
+     */
+    rmUserById: (id: string) => Promise<void>;
 };
 
 export { _default as default };