@eventcatalog/sdk 2.15.0 → 2.16.0

package/dist/index.d.mts

@@ -75,6 +75,12 @@ interface ChannelPointer extends ResourcePointer {
   parameters?: Record<string, string>;
 }
 
+type Operation = {
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  path?: string;
+  statusCodes?: string[];
+};
+
 type Message = Event | Command | Query;
 
 interface CustomDoc {
@@ -101,14 +107,17 @@ interface MessageDetailsPanelProperty {
 
 interface Event extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Command extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Query extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Channel extends BaseSchema {
@@ -226,6 +235,12 @@ interface Badge {
   icon?: string;
 }
 
+interface Changelog {
+  createdAt: Date | string;
+  badges?: Badge[];
+  markdown: string;
+}
+
 interface UbiquitousLanguage {
   id: string;
   name: string;
@@ -737,18 +752,7 @@ declare const _default: (path: string) => {
     addEventToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -771,18 +775,7 @@ declare const _default: (path: string) => {
     addCommandToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -805,18 +798,7 @@ declare const _default: (path: string) => {
     addQueryToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -835,15 +817,7 @@ declare const _default: (path: string) => {
     writeService: (service: Service, options?: {
         path?: string;
         override?: 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;
+        versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -1366,6 +1340,56 @@ declare const _default: (path: string) => {
      * @returns A JSON object with the configuration for the event catalog.
      */
     getEventCatalogConfigurationFile: () => Promise<any>;
+    /**
+     * ================================
+     *            Changelogs
+     * ================================
+     */
+    /**
+     * Writes a changelog entry to a resource in EventCatalog
+     *
+     * @param id - The id of the resource to write the changelog to
+     * @param changelog - The changelog entry to write
+     * @param options - Optional options (version, format)
+     *
+     */
+    writeChangelog: (id: string, changelog: Changelog, options?: {
+        version?: string;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Appends a changelog entry to an existing changelog for a resource.
+     * If no changelog exists, one is created.
+     *
+     * @param id - The id of the resource to append the changelog to
+     * @param changelog - The changelog entry to append
+     * @param options - Optional options (version, format)
+     *
+     */
+    appendChangelog: (id: string, changelog: Changelog, options?: {
+        version?: string;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to get the changelog for
+     * @param options - Optional options (version)
+     * @returns Changelog|Undefined
+     */
+    getChangelog: (id: string, options?: {
+        version?: string;
+    }) => Promise<Changelog | undefined>;
+    /**
+     * Removes the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to remove the changelog from
+     * @param options - Optional options (version)
+     *
+     */
+    rmChangelog: (id: string, options?: {
+        version?: string;
+    }) => Promise<void>;
     /**
      * ================================
      *            Resources Utils
@@ -1749,4 +1773,4 @@ declare const _default: (path: string) => {
     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 };
+export { type Badge, type BaseSchema, type Changelog, 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 Operation, 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

@@ -75,6 +75,12 @@ interface ChannelPointer extends ResourcePointer {
   parameters?: Record<string, string>;
 }
 
+type Operation = {
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  path?: string;
+  statusCodes?: string[];
+};
+
 type Message = Event | Command | Query;
 
 interface CustomDoc {
@@ -101,14 +107,17 @@ interface MessageDetailsPanelProperty {
 
 interface Event extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Command extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Query extends BaseSchema {
   channels?: ChannelPointer[];
+  operation?: Operation;
   detailsPanel?: MessageDetailsPanelProperty;
 }
 interface Channel extends BaseSchema {
@@ -226,6 +235,12 @@ interface Badge {
   icon?: string;
 }
 
+interface Changelog {
+  createdAt: Date | string;
+  badges?: Badge[];
+  markdown: string;
+}
+
 interface UbiquitousLanguage {
   id: string;
   name: string;
@@ -737,18 +752,7 @@ declare const _default: (path: string) => {
     addEventToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -771,18 +775,7 @@ declare const _default: (path: string) => {
     addCommandToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -805,18 +798,7 @@ declare const _default: (path: string) => {
     addQueryToChannel: (id: string, _message: {
         id: string;
         version: string;
-        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
-         * ================================
-         */: {
+        parameters?: {
             [key: string]: string;
         };
     }, version?: string) => Promise<void>;
@@ -835,15 +817,7 @@ declare const _default: (path: string) => {
     writeService: (service: Service, options?: {
         path?: string;
         override?: 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;
+        versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -1366,6 +1340,56 @@ declare const _default: (path: string) => {
      * @returns A JSON object with the configuration for the event catalog.
      */
     getEventCatalogConfigurationFile: () => Promise<any>;
+    /**
+     * ================================
+     *            Changelogs
+     * ================================
+     */
+    /**
+     * Writes a changelog entry to a resource in EventCatalog
+     *
+     * @param id - The id of the resource to write the changelog to
+     * @param changelog - The changelog entry to write
+     * @param options - Optional options (version, format)
+     *
+     */
+    writeChangelog: (id: string, changelog: Changelog, options?: {
+        version?: string;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Appends a changelog entry to an existing changelog for a resource.
+     * If no changelog exists, one is created.
+     *
+     * @param id - The id of the resource to append the changelog to
+     * @param changelog - The changelog entry to append
+     * @param options - Optional options (version, format)
+     *
+     */
+    appendChangelog: (id: string, changelog: Changelog, options?: {
+        version?: string;
+        format?: "md" | "mdx";
+    }) => Promise<void>;
+    /**
+     * Returns the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to get the changelog for
+     * @param options - Optional options (version)
+     * @returns Changelog|Undefined
+     */
+    getChangelog: (id: string, options?: {
+        version?: string;
+    }) => Promise<Changelog | undefined>;
+    /**
+     * Removes the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to remove the changelog from
+     * @param options - Optional options (version)
+     *
+     */
+    rmChangelog: (id: string, options?: {
+        version?: string;
+    }) => Promise<void>;
     /**
      * ================================
      *            Resources Utils
@@ -1749,4 +1773,4 @@ declare const _default: (path: string) => {
     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 };
+export { type Badge, type BaseSchema, type Changelog, 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 Operation, 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 };