@eventcatalog/core 3.0.0-beta.21 → 3.0.0-beta.22

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.
Files changed (31) hide show
  1. package/README.md +41 -108
  2. package/dist/analytics/analytics.cjs +1 -1
  3. package/dist/analytics/analytics.js +2 -2
  4. package/dist/analytics/log-build.cjs +1 -1
  5. package/dist/analytics/log-build.js +3 -3
  6. package/dist/{chunk-HABY2LVH.js → chunk-7INEOCHF.js} +1 -1
  7. package/dist/{chunk-KQAMO3R4.js → chunk-BLLOCEIH.js} +1 -1
  8. package/dist/{chunk-2FUEBPD3.js → chunk-FZN27QZ7.js} +1 -1
  9. package/dist/{chunk-Q6KRYWPV.js → chunk-KNMWRR6J.js} +1 -1
  10. package/dist/{chunk-RRP2B7BL.js → chunk-MO2LVZ2H.js} +1 -1
  11. package/dist/constants.cjs +1 -1
  12. package/dist/constants.js +1 -1
  13. package/dist/eventcatalog.cjs +1 -1
  14. package/dist/eventcatalog.js +5 -5
  15. package/dist/generate.cjs +1 -1
  16. package/dist/generate.js +3 -3
  17. package/dist/utils/cli-logger.cjs +1 -1
  18. package/dist/utils/cli-logger.js +2 -2
  19. package/eventcatalog/src/content.config.ts +0 -3
  20. package/eventcatalog/src/utils/collections/channels.ts +0 -2
  21. package/eventcatalog/src/utils/collections/commands.ts +0 -2
  22. package/eventcatalog/src/utils/collections/containers.ts +0 -2
  23. package/eventcatalog/src/utils/collections/domains.ts +0 -2
  24. package/eventcatalog/src/utils/collections/entities.ts +0 -2
  25. package/eventcatalog/src/utils/collections/events.ts +0 -2
  26. package/eventcatalog/src/utils/collections/flows.ts +0 -2
  27. package/eventcatalog/src/utils/collections/queries.ts +0 -2
  28. package/eventcatalog/src/utils/collections/services.ts +0 -2
  29. package/package.json +1 -1
  30. package/eventcatalog/src/pages/docs/_default-docs.mdx +0 -25
  31. package/eventcatalog/src/pages/docs/index.astro +0 -33
package/README.md CHANGED
@@ -1,12 +1,7 @@
1
1
  <div align="center">
2
2
 
3
- <h1>📖 EventCatalog</h1>
4
- <h3>The open source tool to help you discover and document your event-driven architectures</h3>
5
-
6
- [![MIT License][license-badge]][license]
7
- [![PRs Welcome][prs-badge]][prs]
8
- <img src="https://img.shields.io/github/actions/workflow/status/event-catalog/eventcatalog/verify-build.yml"/>
9
- [![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub)
3
+ <!-- <h1>📖 EventCatalog</h1> -->
4
+ <!-- <h3>The open source tool to help you discover and document your event-driven architectures</h3> -->
10
5
 
11
6
 
12
7
 
@@ -25,144 +20,82 @@
25
20
 
26
21
  <!-- <hr /> -->
27
22
 
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" />
30
-
31
23
 
32
24
 
25
+ <img width="745" alt="EventCatalog" src="./images/example.png" />
33
26
 
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>
27
+ <p align="center">
28
+ <br/>
29
+ <a href="https://eventcatalog.dev">EventCatalog</a> is a documentation tool for software architectures &mdash;
30
+ <br/>
31
+ bring discoverability to complex systems.
32
+ <br/><br/>
33
+ </p>
35
34
 
36
- <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
37
- [![All Contributors](https://img.shields.io/badge/all_contributors-67-orange.svg?style=flat-square)](#contributors-)
38
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
35
+ <div align="center">
39
36
 
40
- [Read the Docs](https://www.eventcatalog.dev/docs/development/getting-started/introduction) | [View Demo](https://demo.eventcatalog.dev)
37
+ [![main](https://github.com/event-catalog/eventcatalog/actions/workflows/verify-build.yml/badge.svg)](https://github.com/event-catalog/eventcatalog/actions/workflows/verify-build.yml)
38
+ [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE)
39
+ [![npm version](https://badge.fury.io/js/@eventcatalog%2Fcore.svg)](https://badge.fury.io/js/@eventcatalog/core)
41
40
 
42
41
  </div>
43
42
 
44
- <hr/>
45
-
46
- # Core Features
47
-
48
- - 📃 Document domains, services and messages ([demo](https://demo.eventcatalog.dev/docs))
49
- - 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser/domains/Orders))
50
- - ⭐ Supports any Schema format (e.g Avro, JSON) ([demo](https://demo.eventcatalog.dev/docs/events/OrderConfirmed/0.0.1))
51
- - 🗂️ Document any code examples (Any code snippet)
52
- - 💅 Custom MDX components ([read more](https://eventcatalog.dev/docs/development/components/using-components))
53
- - 🗄️ Version domains, services and messages
54
- - ⭐ Discoverability feature (search, filter and more) ([demo](https://demo.eventcatalog.dev/discover/events))
55
- - ⭐ Document teams and users ([demo](https://demo.eventcatalog.dev/docs/teams/full-stack))
56
- - 🤖 Automate your catalogs with [generators](https://www.eventcatalog.dev/docs/development/plugins/plugin-overview) (e.g generate your catalogs from your [AsyncAPI](https://www.eventcatalog.dev/docs/asyncapi)/[OpenAPI](https://www.eventcatalog.dev/docs/openapi) documents)
57
- - 👨🏼‍💻 Follows [Docs as code](https://www.writethedocs.org/guide/docs-as-code/) principles
58
- - ⭐ And much more...
59
-
60
-
61
- # The problem
62
-
63
- Event-driven architectures are becoming more popular, giving us the ability to write decoupled architectures and use messages as away to communicate between domains/teams.
64
-
65
- When starting with event-driven architectures you may have a handful of services and messages. As this scales with your team and organization it becomes very hard to manage and govern this.
66
-
67
- Over a period of time more events are added to our domain, requirements change, and our architecture scales.
68
-
69
- As more domains, services or messages get added to our architecture they can be hard for teams to discover and explore.
70
-
71
- Many teams ignore documentation and governance and end up in a [sea of complexity (watch the talk here)](https://www.youtube.com/watch?v=VLUvfIm9wnQ&t=1s) .
72
43
 
73
- **EventCatalog was built to help document your event-driven architectures and help your teams explore and understand events, schemas and much more.**
44
+ <!--
74
45
 
75
- Read more on these blogposts and videos:
76
-
77
- - [Introducing EventCatalog v2 (2024)](https://eventcatalog.dev/blog/eventcatalog-v2)
78
- - [Introducing EventCatalog v1 (2022)](https://www.boyney.io/blog/2022-01-11-introducing-eventcatalog)
79
- - [Event-Driven Architecture: Beyond the Schema Registry (blog)](https://www.boyney.io/blog/2021-12-05-documenting-events)
80
- - [Complexity is the Gotcha of Event-driven Architecture (VIDEO) by David Boyne](https://www.youtube.com/watch?v=VLUvfIm9wnQ&t=1s)
81
-
82
- # This solution
46
+ [![MIT License][license-badge]][license]
47
+ [![PRs Welcome][prs-badge]][prs]
48
+ <img src="https://img.shields.io/github/actions/workflow/status/event-catalog/eventcatalog/verify-build.yml"/>
49
+ [![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub)
50
+ -->
83
51
 
84
- Think of EventCatalog as a website generator that allows you to document your event architectures powered by markdown.
85
52
 
86
- EventCatalog is focused on discovery and documentation and allows you to:
87
53
 
88
- - Document Domains/Services/Messages/Schemas/Code Examples and more...
89
- - Visually shows relationships between upstream/downstream services using your Events
90
- - Allows you to version your documentation and supports changelogs
91
- - Add owners to domains,services and messages so your teams know who owns which parts of your domain
92
- - And much more...
93
54
 
94
- EventCatalog is technology agnostic, which means you can integrate your Catalog with any EDA technology of your choice and any schema formats.
95
55
 
96
- EventCatalog supports a [Plugin Architecture](https://github.com/event-catalog/generators) which lets you generate documentation from your systems including OpenAPI, AsyncAPI, Event Brokers and more.
56
+ <!--
97
57
 
98
- You can read more on [how it works on GitHub](https://github.com/event-catalog/eventcatalog)
58
+ <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> -->
99
59
 
100
- # Getting Started
60
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
61
+ <!-- [![All Contributors](https://img.shields.io/badge/all_contributors-67-orange.svg?style=flat-square)](#contributors-) -->
62
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
101
63
 
102
- You should be able to get setup within minutes if you head over to our documentation to get started 👇
64
+ <!-- [Read the Docs](https://www.eventcatalog.dev/docs/development/getting-started/introduction) | [View Demo](https://demo.eventcatalog.dev) -->
103
65
 
104
- ➡️ [Get Started](https://www.eventcatalog.dev/docs/development/getting-started)
66
+ </div>
105
67
 
106
- Or run this command to build a new catalog
68
+ ## Install
107
69
 
70
+ The **recommended** way to install the latest version of EventCatalog is by running the command below:
108
71
  ```
109
72
  npx @eventcatalog/create-eventcatalog@latest my-catalog
110
73
  ```
111
74
 
112
- # Demo
113
-
114
- Here is an example of a Retail system using domains, services and messages.
75
+ Looking for help? Start with our [Getting Started](https://www.eventcatalog.dev/docs/development/starting-a-new-project/installation) guide
115
76
 
116
- [demo.eventcatalog.dev](https://demo.eventcatalog.dev)
77
+ ## Documentation
78
+ Visit our [official documentation](https://www.eventcatalog.dev/docs/development/getting-started).
117
79
 
118
- You can see the markdown files that generated the website in the GitHub repo under [examples](/examples).
80
+ ## Support
81
+ Having trouble? Get help in the official [EventCatalog Discord](https://discord.gg/3rjaZMmrAm).
119
82
 
120
- # Enterprise support
83
+ ## Demos
121
84
 
122
- Interested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.
85
+ Here are some examples of EventCatalog in action:
123
86
 
124
- Find more details on our [services page](https://eventcatalog.dev/services).
87
+ - [Finance System](https://eventcatalog-examples-finance.vercel.app/)
88
+ - [Healthcare System](https://eventcatalog-examples-healthcare.vercel.app/)
89
+ - [E-Commerce System](https://demo.eventcatalog.dev/)
90
+ - [SaaS System](https://eventcatalog-examples-saas.vercel.app/)
125
91
 
126
- # Looking for v2?
127
92
 
128
- You can find v2 on our [release/v2 branch](https://github.com/event-catalog/eventcatalog/tree/release/v2).
129
-
130
- We are currently working on `main` which is the current major version of EventCatalog.
131
-
132
- We are only applying patch fixes and security updates to `v2.x.x` going forward.
133
-
134
- If you would like to make a change to v2, please raise a pull request against the `release/v2` branch.
135
-
136
- # Looking for v1?
137
-
138
- - Documentation: https://v1.eventcatalog.dev
139
- - Code: https://github.com/event-catalog/eventcatalog/tree/v1
140
-
141
- _Still using v1 of EventCatalog? We recommnded upgrading to the latest version. [Read more in the migration guide](https://eventcatalog.dev/docs/development/guides/upgrading-from-version-1)._
142
-
143
-
144
- # Contributing
93
+ ## Contributing
145
94
 
146
95
  If you have any questions, features or issues please raise any issue or pull requests you like. We will try my best to get back to you.
147
96
 
148
97
  You can find the [contributing guidelines here](https://eventcatalog.dev/docs/contributing/overview).
149
98
 
150
- ## Running the project locally
151
-
152
- 1. Clone the repo
153
- 1. Install required dependencies `pnpm install`
154
- 1. Run the command `pnpm run start:catalog`
155
- - This will start the catalog found in `/examples` repo, locally on your machine
156
-
157
- [license-badge]: https://img.shields.io/github/license/event-catalog/eventcatalog.svg?color=yellow
158
- [license]: https://github.com/event-catalog/eventcatalog/blob/main/LICENSE
159
- [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
160
- [prs]: http://makeapullrequest.com
161
- [github-watch-badge]: https://img.shields.io/github/watchers/event-catalog/eventcatalog.svg?style=social
162
- [github-watch]: https://github.com/event-catalog/eventcatalog/watchers
163
- [github-star-badge]: https://img.shields.io/github/stars/event-catalog/eventcatalog.svg?style=social
164
- [github-star]: https://github.com/event-catalog/eventcatalog/stargazers
165
-
166
99
  ## Contributors ✨
167
100
 
168
101
  Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -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 = "3.0.0-beta.21";
40
+ var version = "3.0.0-beta.22";
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-2FUEBPD3.js";
4
- import "../chunk-KQAMO3R4.js";
3
+ } from "../chunk-FZN27QZ7.js";
4
+ import "../chunk-BLLOCEIH.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 = "3.0.0-beta.21";
109
+ var version = "3.0.0-beta.22";
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-RRP2B7BL.js";
4
- import "../chunk-2FUEBPD3.js";
5
- import "../chunk-KQAMO3R4.js";
3
+ } from "../chunk-MO2LVZ2H.js";
4
+ import "../chunk-FZN27QZ7.js";
5
+ import "../chunk-BLLOCEIH.js";
6
6
  import "../chunk-UPONRQSN.js";
7
7
  export {
8
8
  log_build_default as default
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  logger
3
- } from "./chunk-Q6KRYWPV.js";
3
+ } from "./chunk-KNMWRR6J.js";
4
4
  import {
5
5
  cleanup,
6
6
  getEventCatalogConfigFile
@@ -1,5 +1,5 @@
1
1
  // package.json
2
- var version = "3.0.0-beta.21";
2
+ var version = "3.0.0-beta.22";
3
3
 
4
4
  // src/constants.ts
5
5
  var VERSION = version;
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-KQAMO3R4.js";
3
+ } from "./chunk-BLLOCEIH.js";
4
4
 
5
5
  // src/analytics/analytics.js
6
6
  import axios from "axios";
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  VERSION
3
- } from "./chunk-KQAMO3R4.js";
3
+ } from "./chunk-BLLOCEIH.js";
4
4
 
5
5
  // src/utils/cli-logger.ts
6
6
  import pc from "picocolors";
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  raiseEvent
3
- } from "./chunk-2FUEBPD3.js";
3
+ } from "./chunk-FZN27QZ7.js";
4
4
  import {
5
5
  getEventCatalogConfigFile,
6
6
  verifyRequiredFieldsAreInCatalogConfigFile
@@ -25,7 +25,7 @@ __export(constants_exports, {
25
25
  module.exports = __toCommonJS(constants_exports);
26
26
 
27
27
  // package.json
28
- var version = "3.0.0-beta.21";
28
+ var version = "3.0.0-beta.22";
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-KQAMO3R4.js";
3
+ } from "./chunk-BLLOCEIH.js";
4
4
  export {
5
5
  VERSION
6
6
  };
@@ -109,7 +109,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
109
109
  var import_picocolors = __toESM(require("picocolors"), 1);
110
110
 
111
111
  // package.json
112
- var version = "3.0.0-beta.21";
112
+ var version = "3.0.0-beta.22";
113
113
 
114
114
  // src/constants.ts
115
115
  var VERSION = version;
@@ -6,8 +6,8 @@ import {
6
6
  } from "./chunk-PLNJC7NZ.js";
7
7
  import {
8
8
  log_build_default
9
- } from "./chunk-RRP2B7BL.js";
10
- import "./chunk-2FUEBPD3.js";
9
+ } from "./chunk-MO2LVZ2H.js";
10
+ import "./chunk-FZN27QZ7.js";
11
11
  import {
12
12
  runMigrations
13
13
  } from "./chunk-BH3JMNAV.js";
@@ -22,13 +22,13 @@ import {
22
22
  } from "./chunk-5VBIXL6C.js";
23
23
  import {
24
24
  generate
25
- } from "./chunk-HABY2LVH.js";
25
+ } from "./chunk-7INEOCHF.js";
26
26
  import {
27
27
  logger
28
- } from "./chunk-Q6KRYWPV.js";
28
+ } from "./chunk-KNMWRR6J.js";
29
29
  import {
30
30
  VERSION
31
- } from "./chunk-KQAMO3R4.js";
31
+ } from "./chunk-BLLOCEIH.js";
32
32
  import "./chunk-UPONRQSN.js";
33
33
 
34
34
  // src/eventcatalog.ts
package/dist/generate.cjs CHANGED
@@ -73,7 +73,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
73
73
  var import_picocolors = __toESM(require("picocolors"), 1);
74
74
 
75
75
  // package.json
76
- var version = "3.0.0-beta.21";
76
+ var version = "3.0.0-beta.22";
77
77
 
78
78
  // src/constants.ts
79
79
  var VERSION = version;
package/dist/generate.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  generate
3
- } from "./chunk-HABY2LVH.js";
4
- import "./chunk-Q6KRYWPV.js";
5
- import "./chunk-KQAMO3R4.js";
3
+ } from "./chunk-7INEOCHF.js";
4
+ import "./chunk-KNMWRR6J.js";
5
+ import "./chunk-BLLOCEIH.js";
6
6
  import "./chunk-UPONRQSN.js";
7
7
  export {
8
8
  generate
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(cli_logger_exports);
36
36
  var import_picocolors = __toESM(require("picocolors"), 1);
37
37
 
38
38
  // package.json
39
- var version = "3.0.0-beta.21";
39
+ var version = "3.0.0-beta.22";
40
40
 
41
41
  // src/constants.ts
42
42
  var VERSION = version;
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  logger
3
- } from "../chunk-Q6KRYWPV.js";
4
- import "../chunk-KQAMO3R4.js";
3
+ } from "../chunk-KNMWRR6J.js";
4
+ import "../chunk-BLLOCEIH.js";
5
5
  export {
6
6
  logger
7
7
  };
@@ -91,8 +91,6 @@ const changelogs = defineCollection({
91
91
  catalog: z
92
92
  .object({
93
93
  path: z.string(),
94
- absoluteFilePath: z.string(),
95
- astroContentFilePath: z.string(),
96
94
  filePath: z.string(),
97
95
  publicPath: z.string(),
98
96
  type: z.string(),
@@ -196,7 +194,6 @@ const baseSchema = z.object({
196
194
  .object({
197
195
  path: z.string(),
198
196
  filePath: z.string(),
199
- astroContentFilePath: z.string(),
200
197
  publicPath: z.string(),
201
198
  type: z.string(),
202
199
  })
@@ -122,8 +122,6 @@ export const getChannels = async ({ getAllVersions = true }: Props = {}): Promis
122
122
  },
123
123
  catalog: {
124
124
  path: path.join(channel.collection, channel.id.replace('/index.mdx', '')),
125
- absoluteFilePath: path.join(PROJECT_DIR, channel.collection, channel.id.replace('/index.mdx', '/index.md')),
126
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', channel.collection, channel.id),
127
125
  filePath: path.join(process.cwd(), 'src', 'catalog-files', channel.collection, channel.id.replace('/index.mdx', '')),
128
126
  publicPath: path.join('/generated', channel.collection, channelFolderName),
129
127
  type: 'event',
@@ -112,8 +112,6 @@ export const getCommands = async ({ getAllVersions = true, hydrateServices = tru
112
112
  },
113
113
  catalog: {
114
114
  path: path.join(command.collection, command.id.replace('/index.mdx', '')),
115
- absoluteFilePath: path.join(PROJECT_DIR, command.collection, command.id.replace('/index.mdx', '/index.md')),
116
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', command.collection, command.id),
117
115
  filePath: path.join(process.cwd(), 'src', 'catalog-files', command.collection, command.id.replace('/index.mdx', '')),
118
116
  publicPath: path.join('/generated', command.collection, commandFolderName),
119
117
  type: 'command',
@@ -94,8 +94,6 @@ export const getContainers = async ({ getAllVersions = true }: Props = {}): Prom
94
94
  },
95
95
  catalog: {
96
96
  path: path.join(container.collection, container.id.replace('/index.mdx', '')),
97
- absoluteFilePath: path.join(PROJECT_DIR, container.collection, container.id.replace('/index.mdx', '/index.md')),
98
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', container.collection, container.id),
99
97
  filePath: path.join(
100
98
  process.cwd(),
101
99
  'src',
@@ -213,8 +213,6 @@ export const getDomains = async ({
213
213
  },
214
214
  catalog: {
215
215
  path: path.join(domain.collection, domain.id.replace('/index.mdx', '')),
216
- absoluteFilePath: path.join(PROJECT_DIR, domain.collection, domain.id.replace('/index.mdx', '/index.md')),
217
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', domain.collection, domain.id),
218
216
  filePath: path.join(process.cwd(), 'src', 'catalog-files', domain.collection, domain.id.replace('/index.mdx', '')),
219
217
  publicPath: path.join('/generated', domain.collection, domainFolderName),
220
218
  type: 'service',
@@ -94,8 +94,6 @@ export const getEntities = async ({ getAllVersions = true }: Props = {}): Promis
94
94
  },
95
95
  catalog: {
96
96
  path: path.join(entity.collection, entity.id.replace('/index.mdx', '')),
97
- absoluteFilePath: path.join(PROJECT_DIR, entity.collection, entity.id.replace('/index.mdx', '/index.md')),
98
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', entity.collection, entity.id),
99
97
  filePath: path.join(process.cwd(), 'src', 'catalog-files', entity.collection, entity.id.replace('/index.mdx', '')),
100
98
  publicPath: path.join('/generated', entity.collection, entityFolderName),
101
99
  type: 'entity',
@@ -114,8 +114,6 @@ export const getEvents = async ({ getAllVersions = true, hydrateServices = true
114
114
  },
115
115
  catalog: {
116
116
  path: path.join(event.collection, event.id.replace('/index.mdx', '')),
117
- absoluteFilePath: path.join(PROJECT_DIR, event.collection, event.id.replace('/index.mdx', '/index.md')),
118
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', event.collection, event.id),
119
117
  filePath: path.join(process.cwd(), 'src', 'catalog-files', event.collection, event.id.replace('/index.mdx', '')),
120
118
  publicPath: path.join('/generated', event.collection, eventFolderName),
121
119
  type: 'event',
@@ -76,8 +76,6 @@ export const getFlows = async ({ getAllVersions = true }: Props = {}): Promise<F
76
76
  },
77
77
  catalog: {
78
78
  path: path.join(flow.collection, flow.id.replace('/index.mdx', '')),
79
- absoluteFilePath: path.join(PROJECT_DIR, flow.collection, flow.id.replace('/index.mdx', '/index.md')),
80
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', flow.collection, flow.id),
81
79
  filePath: path.join(process.cwd(), 'src', 'catalog-files', flow.collection, flow.id.replace('/index.mdx', '')),
82
80
  publicPath: path.join('/generated', flow.collection),
83
81
  type: 'flow',
@@ -107,8 +107,6 @@ export const getQueries = async ({ getAllVersions = true, hydrateServices = true
107
107
  },
108
108
  catalog: {
109
109
  path: path.join(query.collection, query.id.replace('/index.mdx', '')),
110
- absoluteFilePath: path.join(PROJECT_DIR, query.collection, query.id.replace('/index.mdx', '/index.md')),
111
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', query.collection, query.id),
112
110
  filePath: path.join(process.cwd(), 'src', 'catalog-files', query.collection, query.id.replace('/index.mdx', '')),
113
111
  publicPath: path.join('/generated', query.collection, queryFolderName),
114
112
  type: 'event', // Kept as 'event' to match original file, though likely should be 'query'
@@ -118,8 +118,6 @@ export const getServices = async ({ getAllVersions = true, returnBody = false }:
118
118
  catalog: {
119
119
  // TODO: avoid use string replace at path due to win32
120
120
  path: path.join(service.collection, service.id.replace('/index.mdx', '')),
121
- absoluteFilePath: path.join(PROJECT_DIR, service.collection, service.id.replace('/index.mdx', '/index.md')),
122
- astroContentFilePath: path.join(process.cwd(), 'src', 'content', service.collection, service.id),
123
121
  filePath: path.join(process.cwd(), 'src', 'catalog-files', service.collection, service.id.replace('/index.mdx', '')),
124
122
  // service will be MySerive-0.0.1 remove the version
125
123
  publicPath: path.join('/generated', service.collection, serviceFolderName),
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": "3.0.0-beta.21",
9
+ "version": "3.0.0-beta.22",
10
10
  "publishConfig": {
11
11
  "access": "public"
12
12
  },
@@ -1,25 +0,0 @@
1
- # **Welcome to EventCatalog**
2
-
3
- This open-source project is designed to help you and your teams bring discoverability and clarity to your event-driven architectures (EDA).
4
-
5
- This page can be replaced with your own content, but to help you get started, we have created a few guides and resources.
6
-
7
- <Tiles columns={3}>
8
- <Tile icon="BookOpenIcon" href="https://eventcatalog.dev/docs/development/getting-started/introduction" title="Getting started with EventCatalog" description="How to get started with EventCatalog" />
9
- <Tile icon="RectangleGroupIcon" href="https://eventcatalog.dev/docs/development/guides/domains/adding-domains" title="Creating domains" description="Learn how to create domains in your event catalog" />
10
- <Tile icon="ServerIcon" href="https://eventcatalog.dev/docs/development/guides/services/adding-services" title="Creating services" description="Learn how to create services in your event catalog" />
11
- <Tile icon="ChatBubbleLeftIcon" iconColor="text-blue-500" href="https://eventcatalog.dev/docs/development/guides/messages/commands/introduction" title="Creating commands" description="Learn how to create commands in your event catalog" />
12
- <Tile icon="BoltIcon" iconColor="text-orange-500" href="https://eventcatalog.dev/docs/development/guides/messages/events/introduction" title="Creating events" description="Learn how to create events in your event catalog" />
13
- <Tile icon="UserGroupIcon" iconColor="text-green-500" href="https://eventcatalog.dev/docs/owners" title="Assigning owners to resources" description="Learn how to assign owners to resources in your event catalog" />
14
- </Tiles>
15
-
16
- ### **Join the community**
17
-
18
- Our project and community is growing fast. We have over 1000+ members in our [Discord community](https://discord.gg/3rjaZMmrAm).
19
-
20
- <Tiles columns={2}>
21
- <Tile icon="UserGroupIcon" iconColor="text-green-500" href="https://discord.gg/3rjaZMmrAm" title="Join the Discord community" description="Join the community to get help and support" />
22
- <Tile icon="StarIcon" iconColor="text-yellow-500" href="https://github.com/event-catalog/eventcatalog/stargazers" title="Star EventCatalog on GitHub" description="If you like the project, please star it on GitHub to show your support ❤️" />
23
- </Tiles>
24
-
25
- ---
@@ -1,33 +0,0 @@
1
- ---
2
- import Footer from '@layouts/Footer.astro';
3
- import components from '@components/MDX/page-components';
4
- import mdxComponents from '@components/MDX/components';
5
- import { getIndexPage } from '@utils/pages';
6
- import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
7
- import { render } from 'astro:content';
8
-
9
- const page = await getIndexPage();
10
- let CustomContent = null;
11
-
12
- const props = Astro.props;
13
-
14
- if (page) {
15
- const { Content } = await render(page);
16
- CustomContent = Content;
17
- } else {
18
- CustomContent = await import('./_default-docs.mdx').then((mod) => mod.default);
19
- }
20
- ---
21
-
22
- <VerticalSideBarLayout title="EventCatalog">
23
- <main class="flex sm:px-8 docs-layout h-full">
24
- <div class="flex docs-layout w-full">
25
- <div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8">
26
- <div class="prose prose-md w-full !max-w-none">
27
- <CustomContent components={{ ...components, ...mdxComponents(props) }} />
28
- </div>
29
- <Footer />
30
- </div>
31
- </div>
32
- </main>
33
- </VerticalSideBarLayout>