@eventcatalog/sdk 2.13.2 → 2.14.1

package/dist/index.d.mts

@@ -191,6 +191,8 @@ interface Domain extends BaseSchema {
 interface Team {
   id: string;
   name: string;
+  avatarUrl?: string;
+  role?: string;
   summary?: string;
   email?: string;
   hidden?: boolean;
@@ -337,6 +339,12 @@ type EventCatalog = {
   };
 };
 
+type ResourceType = 'event' | 'command' | 'query' | 'service' | 'domain';
+interface ToDSLOptions {
+    type: ResourceType;
+    hydrate?: boolean;
+}
+
 /**
  * Init the SDK for EventCatalog
  *
@@ -729,7 +737,18 @@ declare const _default: (path: string) => {
     addEventToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -752,7 +771,18 @@ declare const _default: (path: string) => {
     addCommandToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -775,7 +805,18 @@ declare const _default: (path: string) => {
     addQueryToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -794,7 +835,15 @@ declare const _default: (path: string) => {
     writeService: (service: Service, options?: {
         path?: string;
         override?: boolean;
-        versionExistingContent?: boolean;
+        versionExistingContent
+        /**
+         * Moves a given event id to the version directory
+         * @param directory
+         */
+        ? /**
+         * Moves a given event id to the version directory
+         * @param directory
+         */: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -815,23 +864,7 @@ declare const _default: (path: string) => {
     writeServiceToDomain: (service: Service, domain: {
         id: string;
         version?: string;
-        direction
-        /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */
-        ? /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */: string;
+        direction?: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -1653,21 +1686,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDiagram: (diagram: Diagram, options?: {
-        path
-        /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */
-        ? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -1709,6 +1728,25 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            DSL
+     * ================================
+     */
+    /**
+     * Converts catalog resources to EventCatalog DSL (.ec) format strings.
+     *
+     * @param resource - A resource or array of resources to convert
+     * @param options - Options including type ('event'|'command'|'query'|'service'|'domain') and optional hydrate flag
+     * @returns A DSL string representation
+     *
+     * @example
+     * ```ts
+     * const dsl = await sdk.toDSL(event, { type: 'event' });
+     * const dsl = await sdk.toDSL(services, { type: 'service', hydrate: true });
+     * ```
+     */
+    toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
 export { type Badge, type BaseSchema, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type Domain, type Entity, type Event, type EventCatalog, type Message, type Query, type ReceivesPointer, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.d.ts

@@ -191,6 +191,8 @@ interface Domain extends BaseSchema {
 interface Team {
   id: string;
   name: string;
+  avatarUrl?: string;
+  role?: string;
   summary?: string;
   email?: string;
   hidden?: boolean;
@@ -337,6 +339,12 @@ type EventCatalog = {
   };
 };
 
+type ResourceType = 'event' | 'command' | 'query' | 'service' | 'domain';
+interface ToDSLOptions {
+    type: ResourceType;
+    hydrate?: boolean;
+}
+
 /**
  * Init the SDK for EventCatalog
  *
@@ -729,7 +737,18 @@ declare const _default: (path: string) => {
     addEventToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -752,7 +771,18 @@ declare const _default: (path: string) => {
     addCommandToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -775,7 +805,18 @@ declare const _default: (path: string) => {
     addQueryToChannel: (id: string, _message: {
         id: string;
         version: string;
-        parameters?: {
+        parameters
+        /**
+         * Returns a query from EventCatalog
+         * @param id - The id of the query to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Query|Undefined
+         */
+        ? /**
+         * ================================
+         *            Queries
+         * ================================
+         */: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -794,7 +835,15 @@ declare const _default: (path: string) => {
     writeService: (service: Service, options?: {
         path?: string;
         override?: boolean;
-        versionExistingContent?: boolean;
+        versionExistingContent
+        /**
+         * Moves a given event id to the version directory
+         * @param directory
+         */
+        ? /**
+         * Moves a given event id to the version directory
+         * @param directory
+         */: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -815,23 +864,7 @@ declare const _default: (path: string) => {
     writeServiceToDomain: (service: Service, domain: {
         id: string;
         version?: string;
-        direction
-        /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */
-        ? /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */: string;
+        direction?: string;
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
@@ -1653,21 +1686,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDiagram: (diagram: Diagram, options?: {
-        path
-        /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */
-        ? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -1709,6 +1728,25 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * ================================
+     *            DSL
+     * ================================
+     */
+    /**
+     * Converts catalog resources to EventCatalog DSL (.ec) format strings.
+     *
+     * @param resource - A resource or array of resources to convert
+     * @param options - Options including type ('event'|'command'|'query'|'service'|'domain') and optional hydrate flag
+     * @returns A DSL string representation
+     *
+     * @example
+     * ```ts
+     * const dsl = await sdk.toDSL(event, { type: 'event' });
+     * const dsl = await sdk.toDSL(services, { type: 'service', hydrate: true });
+     * ```
+     */
+    toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
 export { type Badge, type BaseSchema, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type Domain, type Entity, type Event, type EventCatalog, type Message, type Query, type ReceivesPointer, type ResourceGroup, type ResourcePointer, type SendsPointer, type Service, type Specification, type Specifications, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };