@eventcatalog/core 2.28.1 → 2.28.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  <div align="center">
2
2
 
3
3
  <h1>📖 EventCatalog</h1>
4
+ <h3>The open source tool to help you discover and document your event-driven architectures</h3>
4
5
 
5
6
  [![MIT License][license-badge]][license]
6
7
  [![PRs Welcome][prs-badge]][prs]
@@ -24,18 +25,19 @@
24
25
 
25
26
  <!-- <hr /> -->
26
27
 
27
- <img width="745" alt="Screenshot 2024-12-13 at 09 56 05" src="https://github.com/user-attachments/assets/f537ec1f-54ee-4de1-996c-c6b72191be39" />
28
+ <!-- <img width="745" alt="Screenshot 2024-12-13 at 09 56 05" src="https://github.com/user-attachments/assets/f537ec1f-54ee-4de1-996c-c6b72191be39" /> -->
29
+ <img width="745" alt="EventCatalog" src="./images/example.png" />
28
30
 
29
31
 
30
32
 
31
33
 
32
- <h4>Features: Documentation generator for Event Driven Architectures, Integration with any broker, Docs and Code, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...</h4>
34
+ <h4>Features: Documentation for Event Driven Architectures, Integration with any broker, Generator from your OpenAPI and AsyncAPI documents, Docs and Code, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...</h4>
33
35
 
34
36
  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
35
37
  [![All Contributors](https://img.shields.io/badge/all_contributors-49-orange.svg?style=flat-square)](#contributors-)
36
38
  <!-- ALL-CONTRIBUTORS-BADGE:END -->
37
39
 
38
- [Read the Docs](https://www.eventcatalog.dev/product/documentation) | [View Demo](https://demo.eventcatalog.dev/docs)
40
+ [Read the Docs](https://www.eventcatalog.dev/docs/development/getting-started/introduction) | [View Demo](https://demo.eventcatalog.dev)
39
41
 
40
42
  </div>
41
43
 
@@ -45,7 +47,7 @@
45
47
 
46
48
  - 📃 Document domains, services and messages ([demo](https://demo.eventcatalog.dev/docs))
47
49
  - 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser/domains/Orders))
48
- - ⭐ Supports any Schema format (e.g Avro, JSON) ([demo](https://demo.eventcatalog.dev/docs/events/InventoryAdjusted/0.0.4))
50
+ - ⭐ Supports any Schema format (e.g Avro, JSON) ([demo](https://demo.eventcatalog.dev/docs/events/OrderConfirmed/0.0.1))
49
51
  - 🗂️ Document any code examples (Any code snippet)
50
52
  - 💅 Custom MDX components ([read more](https://eventcatalog.dev/docs/development/components/using-components))
51
53
  - 🗄️ Version domains, services and messages
@@ -37,7 +37,7 @@ var import_axios = __toESM(require("axios"), 1);
37
37
  var import_os = __toESM(require("os"), 1);
38
38
 
39
39
  // package.json
40
- var version = "2.28.1";
40
+ var version = "2.28.3";
41
41
 
42
42
  // src/constants.ts
43
43
  var VERSION = version;
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  raiseEvent
3
- } from "../chunk-2TWZFRC5.js";
4
- import "../chunk-32CT66GO.js";
3
+ } from "../chunk-OLUQUKIU.js";
4
+ import "../chunk-EMGVI2N7.js";
5
5
  export {
6
6
  raiseEvent
7
7
  };
@@ -106,7 +106,7 @@ var import_axios = __toESM(require("axios"), 1);
106
106
  var import_os = __toESM(require("os"), 1);
107
107
 
108
108
  // package.json
109
- var version = "2.28.1";
109
+ var version = "2.28.3";
110
110
 
111
111
  // src/constants.ts
112
112
  var VERSION = version;
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  log_build_default
3
- } from "../chunk-3AWWP5JR.js";
4
- import "../chunk-2TWZFRC5.js";
5
- import "../chunk-32CT66GO.js";
3
+ } from "../chunk-MLOKQD4T.js";
4
+ import "../chunk-OLUQUKIU.js";
5
+ import "../chunk-EMGVI2N7.js";
6
6
  import "../chunk-E7TXTI7G.js";
7
7
  export {
8
8
  log_build_default as default
@@ -1,5 +1,5 @@
1
1
  // package.json
2
- var version = "2.28.1";
2
+ var version = "2.28.3";
3
3
 
4
4
  // src/constants.ts
5
5
  var VERSION = version;
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  raiseEvent
3
- } from "./chunk-2TWZFRC5.js";
3
+ } from "./chunk-OLUQUKIU.js";
4
4
  import {
5
5
  getEventCatalogConfigFile,
6
6
  verifyRequiredFieldsAreInCatalogConfigFile
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-32CT66GO.js";
3
+ } from "./chunk-EMGVI2N7.js";
4
4
 
5
5
  // src/analytics/analytics.js
6
6
  import axios from "axios";
@@ -25,7 +25,7 @@ __export(constants_exports, {
25
25
  module.exports = __toCommonJS(constants_exports);
26
26
 
27
27
  // package.json
28
- var version = "2.28.1";
28
+ var version = "2.28.3";
29
29
 
30
30
  // src/constants.ts
31
31
  var VERSION = version;
package/dist/constants.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-32CT66GO.js";
3
+ } from "./chunk-EMGVI2N7.js";
4
4
  export {
5
5
  VERSION
6
6
  };
@@ -161,7 +161,7 @@ var import_axios = __toESM(require("axios"), 1);
161
161
  var import_os = __toESM(require("os"), 1);
162
162
 
163
163
  // package.json
164
- var version = "2.28.1";
164
+ var version = "2.28.3";
165
165
 
166
166
  // src/constants.ts
167
167
  var VERSION = version;
@@ -6,14 +6,14 @@ import {
6
6
  } from "./chunk-WUCY3QHK.js";
7
7
  import {
8
8
  log_build_default
9
- } from "./chunk-3AWWP5JR.js";
10
- import "./chunk-2TWZFRC5.js";
9
+ } from "./chunk-MLOKQD4T.js";
10
+ import "./chunk-OLUQUKIU.js";
11
11
  import {
12
12
  catalogToAstro
13
13
  } from "./chunk-R2NILSWL.js";
14
14
  import {
15
15
  VERSION
16
- } from "./chunk-32CT66GO.js";
16
+ } from "./chunk-EMGVI2N7.js";
17
17
  import {
18
18
  isBackstagePluginEnabled
19
19
  } from "./chunk-XMDPVKIJ.js";
@@ -14,9 +14,10 @@ export interface ExtendedDomain extends CollectionEntry<'domains'> {
14
14
 
15
15
  interface DomainGridProps {
16
16
  domains: ExtendedDomain[];
17
+ embeded: boolean;
17
18
  }
18
19
 
19
- export default function DomainGrid({ domains }: DomainGridProps) {
20
+ export default function DomainGrid({ domains, embeded }: DomainGridProps) {
20
21
  const [searchQuery, setSearchQuery] = useState('');
21
22
 
22
23
  const filteredDomains = useMemo(() => {
@@ -9,6 +9,7 @@ import { SearchBar, TypeFilters, Pagination } from './components';
9
9
 
10
10
  interface MessageGridProps {
11
11
  messages: CollectionEntry<CollectionMessageTypes>[];
12
+ embeded: boolean;
12
13
  }
13
14
 
14
15
  interface GroupedMessages {
@@ -17,7 +18,7 @@ interface GroupedMessages {
17
18
  receives?: CollectionEntry<CollectionMessageTypes>[];
18
19
  }
19
20
 
20
- export default function MessageGrid({ messages }: MessageGridProps) {
21
+ export default function MessageGrid({ messages, embeded }: MessageGridProps) {
21
22
  const [searchQuery, setSearchQuery] = useState('');
22
23
  const [urlParams, setUrlParams] = useState<{
23
24
  serviceId?: string;
@@ -171,20 +172,18 @@ export default function MessageGrid({ messages }: MessageGridProps) {
171
172
  >
172
173
  {messages.map((message) => {
173
174
  const { color, Icon } = getCollectionStyles(message.collection);
174
- const hasProducers = message.data.producers && message.data.producers.length > 0;
175
- const hasConsumers = message.data.consumers && message.data.consumers.length > 0;
176
175
  return (
177
176
  <a
178
177
  key={message.data.name}
179
178
  href={buildUrl(`/docs/${message.collection}/${message.data.id}/${message.data.version}`)}
180
179
  className={`group bg-white border hover:bg-${color}-100 rounded-lg shadow-sm hover:shadow-lg transition-all duration-200 overflow-hidden border-${color}-500 `}
181
180
  >
182
- <div className="p-4 flex-1">
181
+ <div className="p-4 py-2 flex-1">
183
182
  <div className="flex items-center justify-between mb-3">
184
183
  <div className="flex items-center gap-2">
185
- <Icon className={`h-5 w-5 text-${color}-500`} />
184
+ {!embeded && <Icon className={`h-5 w-5 text-${color}-500`} />}
186
185
  <h3
187
- className={`text-md font-semibold text-gray-900 truncate group-hover:text-${color}-500 transition-colors duration-200`}
186
+ className={`font-semibold text-gray-900 truncate group-hover:text-${color}-500 transition-colors duration-200 ${embeded ? 'text-sm' : 'text-md'}`}
188
187
  >
189
188
  {message.data.name} (v{message.data.version})
190
189
  </h3>
@@ -377,7 +376,7 @@ export default function MessageGrid({ messages }: MessageGridProps) {
377
376
  {/* Receives Section */}
378
377
  <div className="bg-blue-50 bg-opacity-50 border border-blue-300 border-dashed rounded-lg p-4">
379
378
  <div className="mb-6">
380
- <h2 className="text-xl font-semibold text-gray-900 flex items-center gap-2">
379
+ <h2 className={`font-semibold text-gray-900 flex items-center gap-2 ${embeded ? 'text-sm' : 'text-xl'}`}>
381
380
  <ServerIcon className="h-5 w-5 text-blue-500" />
382
381
  Receives messages ({groupedMessages.receives?.length || 0})
383
382
  </h2>
@@ -418,7 +417,7 @@ export default function MessageGrid({ messages }: MessageGridProps) {
418
417
  {/* Sends Section */}
419
418
  <div className="bg-green-50 border border-green-300 border-dashed rounded-lg p-4">
420
419
  <div className="mb-6">
421
- <h2 className="text-xl font-semibold text-gray-900 flex items-center gap-2">
420
+ <h2 className={`font-semibold text-gray-900 flex items-center gap-2 ${embeded ? 'text-sm' : 'text-xl'}`}>
422
421
  <ServerIcon className="h-5 w-5 text-emerald-500" />
423
422
  Sends messages ({groupedMessages.sends?.length || 0})
424
423
  </h2>
@@ -9,9 +9,10 @@ import { SearchBar, TypeFilters, Pagination } from './components';
9
9
 
10
10
  interface ServiceGridProps {
11
11
  services: CollectionEntry<'services'>[];
12
+ embeded: boolean;
12
13
  }
13
14
 
14
- export default function ServiceGrid({ services }: ServiceGridProps) {
15
+ export default function ServiceGrid({ services, embeded }: ServiceGridProps) {
15
16
  const [searchQuery, setSearchQuery] = useState('');
16
17
  const [currentPage, setCurrentPage] = useState(1);
17
18
  const [selectedTypes, setSelectedTypes] = useState<CollectionMessageTypes[]>([]);
@@ -208,7 +209,7 @@ export default function ServiceGrid({ services }: ServiceGridProps) {
208
209
  </>
209
210
  )}
210
211
 
211
- <div className="grid grid-cols-1 sm:grid-cols-1 lg:grid-cols-2 xl:grid-cols-2 gap-6">
212
+ <div className={`grid grid-cols-1 sm:grid-cols-1 lg:grid-cols-1 xl:grid-cols-${embeded ? 1 : 2} gap-6`}>
212
213
  {paginatedServices.map((service) => {
213
214
  return (
214
215
  <a
@@ -21,7 +21,7 @@ interface Service extends CollectionEntry<'services'> {
21
21
  receives: CollectionEntry<'events' | 'commands' | 'queries'>[];
22
22
  }
23
23
 
24
- const { type } = Astro.props as { type: ValidType };
24
+ const { type, embeded = false } = Astro.props as { type: ValidType; embeded: boolean };
25
25
 
26
26
  // Get data based on type
27
27
  let items: ExtendedDomain[] | Service[] | CollectionEntry<'commands'>[] | CollectionEntry<CollectionMessageTypes>[] = [];
@@ -71,9 +71,13 @@ if (type === 'domains') {
71
71
  <div class="bg-white min-h-screen">
72
72
  <div class="max-w-[90em] mx-auto">
73
73
  <div class="px-6 py-6" transition:animate={fade({ duration: '0.4s' })}>
74
- {type === 'domains' && <DomainGrid domains={items as ExtendedDomain[]} client:load />}
75
- {type === 'services' && <ServiceGrid services={items as unknown as Service[]} client:load />}
76
- {type === 'messages' && <MessageGrid messages={items as CollectionEntry<CollectionMessageTypes>[]} client:load />}
74
+ {type === 'domains' && <DomainGrid domains={items as ExtendedDomain[]} embeded={embeded} client:load />}
75
+ {type === 'services' && <ServiceGrid services={items as unknown as Service[]} embeded={embeded} client:load />}
76
+ {
77
+ type === 'messages' && (
78
+ <MessageGrid messages={items as CollectionEntry<CollectionMessageTypes>[]} embeded={embeded} client:load />
79
+ )
80
+ }
77
81
  </div>
78
82
  </div>
79
83
  <ClientRouter />
@@ -11,4 +11,4 @@ export async function getStaticPaths() {
11
11
  const { type } = Astro.params;
12
12
  ---
13
13
 
14
- <Architecture type={type} />
14
+ <Architecture type={type} embeded={true} />
@@ -40,5 +40,5 @@ export const buildUrlWithParams = (baseUrl: string, params: Record<string, strin
40
40
  .map(([key, value]) => `${key}=${value}`)
41
41
  .join('&');
42
42
 
43
- return buildUrl(`${baseUrl}?${queryString}`);
43
+ return `${buildUrl(baseUrl)}?${queryString}`;
44
44
  };
package/package.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "url": "https://github.com/event-catalog/eventcatalog.git"
7
7
  },
8
8
  "type": "module",
9
- "version": "2.28.1",
9
+ "version": "2.28.3",
10
10
  "publishConfig": {
11
11
  "access": "public"
12
12
  },