@eventcatalog/core 2.30.0 → 2.30.2
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/LICENSE.md +1 -1
- package/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +1 -1
- package/dist/analytics/log-build.js +3 -3
- package/dist/catalog-to-astro-content-directory.cjs +1 -1
- package/dist/catalog-to-astro-content-directory.js +1 -1
- package/dist/{chunk-DE2TXYKB.js → chunk-7SI5EVOX.js} +1 -1
- package/dist/{chunk-MZLYNODU.js → chunk-CIVWQLRA.js} +1 -1
- package/dist/{chunk-T2XS2ZVB.js → chunk-QVPNBOPX.js} +1 -1
- package/dist/{chunk-4Q54XOED.js → chunk-RT7R2WPP.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/eventcatalog.cjs +2 -2
- package/dist/eventcatalog.config.d.cts +3 -7
- package/dist/eventcatalog.config.d.ts +3 -7
- package/dist/eventcatalog.js +4 -4
- package/eventcatalog/src/components/MDX/Schema.astro +3 -2
- package/eventcatalog/src/components/MDX/Tiles/Tile.astro +3 -2
- package/eventcatalog/src/components/MDX/Tiles/Tiles.astro +4 -4
- package/eventcatalog/src/content.config.ts +4 -1
- package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +7 -1
- package/eventcatalog/src/pages/docs/_default-docs.mdx +16 -15
- package/eventcatalog/src/pages/docs/index.astro +6 -2
- package/eventcatalog/src/utils/pages.ts +2 -2
- package/package.json +1 -1
package/LICENSE.md
CHANGED
|
@@ -5,7 +5,7 @@ Source code in this repository is split into two parts:
|
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
All code outside of the
|
|
8
|
+
All code outside of the `eventcatalog/src/enterprise` directory is licensed under the MIT license which is below.
|
|
9
9
|
|
|
10
10
|
MIT License
|
|
11
11
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
4
|
-
import "../chunk-
|
|
5
|
-
import "../chunk-
|
|
3
|
+
} from "../chunk-CIVWQLRA.js";
|
|
4
|
+
import "../chunk-QVPNBOPX.js";
|
|
5
|
+
import "../chunk-RT7R2WPP.js";
|
|
6
6
|
import "../chunk-E7TXTI7G.js";
|
|
7
7
|
export {
|
|
8
8
|
log_build_default as default
|
|
@@ -222,7 +222,7 @@ var checkAndConvertMdToMdx = async (source, astroDir) => {
|
|
|
222
222
|
const files = await (0, import_glob.glob)(path3.join(source, "**"), {
|
|
223
223
|
nodir: true,
|
|
224
224
|
windowsPathsNoEscape: import_node_os.default.platform() == "win32",
|
|
225
|
-
ignore: ["node_modules/**", "**/dist/**"]
|
|
225
|
+
ignore: ["node_modules/**", "**/dist/**", "**/README.md"]
|
|
226
226
|
});
|
|
227
227
|
if (files.some((file) => file.endsWith(".md"))) {
|
|
228
228
|
console.log(`EventCatalog now requires all markdown files to be .mdx files. Converting all .md files to .mdx...`);
|
|
@@ -41,7 +41,7 @@ var checkAndConvertMdToMdx = async (source, astroDir) => {
|
|
|
41
41
|
const files = await glob(path.join(source, "**"), {
|
|
42
42
|
nodir: true,
|
|
43
43
|
windowsPathsNoEscape: os.platform() == "win32",
|
|
44
|
-
ignore: ["node_modules/**", "**/dist/**"]
|
|
44
|
+
ignore: ["node_modules/**", "**/dist/**", "**/README.md"]
|
|
45
45
|
});
|
|
46
46
|
if (files.some((file) => file.endsWith(".md"))) {
|
|
47
47
|
console.log(`EventCatalog now requires all markdown files to be .mdx files. Converting all .md files to .mdx...`);
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
package/dist/eventcatalog.cjs
CHANGED
|
@@ -157,7 +157,7 @@ var import_axios = __toESM(require("axios"), 1);
|
|
|
157
157
|
var import_os = __toESM(require("os"), 1);
|
|
158
158
|
|
|
159
159
|
// package.json
|
|
160
|
-
var version = "2.30.
|
|
160
|
+
var version = "2.30.2";
|
|
161
161
|
|
|
162
162
|
// src/constants.ts
|
|
163
163
|
var VERSION = version;
|
|
@@ -404,7 +404,7 @@ var checkAndConvertMdToMdx = async (source, astroDir) => {
|
|
|
404
404
|
const files = await (0, import_glob.glob)(path5.join(source, "**"), {
|
|
405
405
|
nodir: true,
|
|
406
406
|
windowsPathsNoEscape: import_node_os.default.platform() == "win32",
|
|
407
|
-
ignore: ["node_modules/**", "**/dist/**"]
|
|
407
|
+
ignore: ["node_modules/**", "**/dist/**", "**/README.md"]
|
|
408
408
|
});
|
|
409
409
|
if (files.some((file) => file.endsWith(".md"))) {
|
|
410
410
|
console.log(`EventCatalog now requires all markdown files to be .mdx files. Converting all .md files to .mdx...`);
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
type SideBarConfig = {
|
|
2
|
+
id: string;
|
|
2
3
|
visible: boolean;
|
|
3
4
|
};
|
|
4
5
|
type ResourceDependency = {
|
|
@@ -31,15 +32,10 @@ interface Config {
|
|
|
31
32
|
renderParsedSchemas?: boolean;
|
|
32
33
|
};
|
|
33
34
|
mdxOptimize?: boolean;
|
|
35
|
+
sidebar?: SideBarConfig[];
|
|
34
36
|
docs: {
|
|
35
37
|
sidebar: {
|
|
36
38
|
type?: 'TREE_VIEW' | 'LIST_VIEW';
|
|
37
|
-
showPageHeadings: true;
|
|
38
|
-
services?: SideBarConfig;
|
|
39
|
-
messages?: SideBarConfig;
|
|
40
|
-
domains?: SideBarConfig;
|
|
41
|
-
teams?: SideBarConfig;
|
|
42
|
-
users?: SideBarConfig;
|
|
43
39
|
};
|
|
44
40
|
};
|
|
45
41
|
dependencies?: {
|
|
@@ -59,4 +55,4 @@ interface Config {
|
|
|
59
55
|
};
|
|
60
56
|
}
|
|
61
57
|
|
|
62
|
-
export type { Config };
|
|
58
|
+
export type { Config, SideBarConfig };
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
type SideBarConfig = {
|
|
2
|
+
id: string;
|
|
2
3
|
visible: boolean;
|
|
3
4
|
};
|
|
4
5
|
type ResourceDependency = {
|
|
@@ -31,15 +32,10 @@ interface Config {
|
|
|
31
32
|
renderParsedSchemas?: boolean;
|
|
32
33
|
};
|
|
33
34
|
mdxOptimize?: boolean;
|
|
35
|
+
sidebar?: SideBarConfig[];
|
|
34
36
|
docs: {
|
|
35
37
|
sidebar: {
|
|
36
38
|
type?: 'TREE_VIEW' | 'LIST_VIEW';
|
|
37
|
-
showPageHeadings: true;
|
|
38
|
-
services?: SideBarConfig;
|
|
39
|
-
messages?: SideBarConfig;
|
|
40
|
-
domains?: SideBarConfig;
|
|
41
|
-
teams?: SideBarConfig;
|
|
42
|
-
users?: SideBarConfig;
|
|
43
39
|
};
|
|
44
40
|
};
|
|
45
41
|
dependencies?: {
|
|
@@ -59,4 +55,4 @@ interface Config {
|
|
|
59
55
|
};
|
|
60
56
|
}
|
|
61
57
|
|
|
62
|
-
export type { Config };
|
|
58
|
+
export type { Config, SideBarConfig };
|
package/dist/eventcatalog.js
CHANGED
|
@@ -6,15 +6,15 @@ import {
|
|
|
6
6
|
} from "./chunk-UKJ7F5WR.js";
|
|
7
7
|
import {
|
|
8
8
|
log_build_default
|
|
9
|
-
} from "./chunk-
|
|
10
|
-
import "./chunk-
|
|
9
|
+
} from "./chunk-CIVWQLRA.js";
|
|
10
|
+
import "./chunk-QVPNBOPX.js";
|
|
11
11
|
import {
|
|
12
12
|
catalogToAstro,
|
|
13
13
|
checkAndConvertMdToMdx
|
|
14
|
-
} from "./chunk-
|
|
14
|
+
} from "./chunk-7SI5EVOX.js";
|
|
15
15
|
import {
|
|
16
16
|
VERSION
|
|
17
|
-
} from "./chunk-
|
|
17
|
+
} from "./chunk-RT7R2WPP.js";
|
|
18
18
|
import {
|
|
19
19
|
isBackstagePluginEnabled
|
|
20
20
|
} from "./chunk-XMDPVKIJ.js";
|
|
@@ -10,9 +10,10 @@ interface Props {
|
|
|
10
10
|
};
|
|
11
11
|
title?: string;
|
|
12
12
|
filePath: string;
|
|
13
|
+
lang?: string;
|
|
13
14
|
}
|
|
14
15
|
|
|
15
|
-
const { file = 'schema.json', catalog, title, filePath } = Astro.props;
|
|
16
|
+
const { file = 'schema.json', catalog, title, filePath, lang = 'json' } = Astro.props;
|
|
16
17
|
|
|
17
18
|
let code: string | null = null;
|
|
18
19
|
|
|
@@ -25,7 +26,7 @@ if (exists) {
|
|
|
25
26
|
{
|
|
26
27
|
code ? (
|
|
27
28
|
<div class="not-prose max-w-4xl overflow-x-auto">
|
|
28
|
-
<Code code={code} title={title || file} lang=
|
|
29
|
+
<Code code={code} title={title || file} lang={lang} />
|
|
29
30
|
</div>
|
|
30
31
|
) : (
|
|
31
32
|
<div class="italic">Tried to load schema from {path.join(catalog.filePath, file)}, but no schema can be found</div>
|
|
@@ -6,12 +6,13 @@ import { buildUrl } from '@utils/url-builder';
|
|
|
6
6
|
interface Props {
|
|
7
7
|
href: string;
|
|
8
8
|
icon: keyof typeof Icons;
|
|
9
|
+
iconColor?: string;
|
|
9
10
|
title: string;
|
|
10
11
|
openWindow?: boolean;
|
|
11
12
|
description: string;
|
|
12
13
|
}
|
|
13
14
|
|
|
14
|
-
const { href, icon, title, description, openWindow } = Astro.props;
|
|
15
|
+
const { href, icon, title, description, openWindow, iconColor = 'text-primary' } = Astro.props;
|
|
15
16
|
|
|
16
17
|
const IconComponent: ComponentType<{ className?: string }> | undefined = Icons[icon];
|
|
17
18
|
|
|
@@ -28,7 +29,7 @@ function startsWithProtocol(str: string) {
|
|
|
28
29
|
class="block bg-white border border-gray-200 rounded-lg p-6 transition-all duration-300 ease-in-out hover:shadow-md hover:border-primary focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-offset-primary focus:ring-white"
|
|
29
30
|
>
|
|
30
31
|
<div class="flex flex-col h-full space-y-8">
|
|
31
|
-
{IconComponent && <IconComponent className=
|
|
32
|
+
{IconComponent && <IconComponent className={`w-6 h-6 ${iconColor}`} />}
|
|
32
33
|
<div>
|
|
33
34
|
<h2 class="text-gray-800 text-lg font-semibold transition-colors duration-300 ease-in-out group-hover:text-gray-300">
|
|
34
35
|
{title}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
|
-
const { title } = Astro.props;
|
|
2
|
+
const { title, columns = 2 } = Astro.props;
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
<
|
|
5
|
+
<section class="not-prose">
|
|
6
6
|
{title && <h2 class="text-2xl font-bold text-gray-800 mb-4">{title}</h2>}
|
|
7
|
-
<div class={`grid grid-cols-1 md:grid-cols
|
|
7
|
+
<div class={`grid grid-cols-1 md:grid-cols-${columns} gap-4 w-full not-prose`}>
|
|
8
8
|
<slot />
|
|
9
9
|
</div>
|
|
10
|
-
</
|
|
10
|
+
</section>
|
|
@@ -9,6 +9,8 @@ import { BookOpenText, Workflow, TableProperties, House, BookUser, MessageSquare
|
|
|
9
9
|
import Header from '../components/Header.astro';
|
|
10
10
|
import SEO from '../components/Seo.astro';
|
|
11
11
|
import SideNav from '../components/SideNav/SideNav.astro';
|
|
12
|
+
import config from '@config';
|
|
13
|
+
|
|
12
14
|
import '@fontsource/inter';
|
|
13
15
|
import '@fontsource/inter/400.css'; // Specify weight
|
|
14
16
|
import '@fontsource/inter/700.css'; // Specify weight
|
|
@@ -54,6 +56,7 @@ const getDefaultUrl = (route: string, defaultValue: string) => {
|
|
|
54
56
|
return buildUrl(defaultValue);
|
|
55
57
|
};
|
|
56
58
|
|
|
59
|
+
const userSideBarConfiguration = config.sidebar || [];
|
|
57
60
|
const navigationItems = [
|
|
58
61
|
{
|
|
59
62
|
id: '/',
|
|
@@ -111,7 +114,10 @@ const navigationItems = [
|
|
|
111
114
|
href: buildUrl('/chat'),
|
|
112
115
|
current: currentPath.includes('/chat'),
|
|
113
116
|
},
|
|
114
|
-
]
|
|
117
|
+
].filter((item) => {
|
|
118
|
+
const userSideBarOption = userSideBarConfiguration.find((config: { id: string; visible: boolean }) => config.id === item.id);
|
|
119
|
+
return userSideBarOption ? userSideBarOption.visible : true;
|
|
120
|
+
});
|
|
115
121
|
|
|
116
122
|
const currentNavigationItem = navigationItems.find((item) => item.current);
|
|
117
123
|
const { title, description } = Astro.props;
|
|
@@ -1,24 +1,25 @@
|
|
|
1
|
-
# **EventCatalog**
|
|
2
|
-
|
|
3
|
-
Welcome to [EventCatalog](https://www.eventcatalog.dev/).
|
|
1
|
+
# **Welcome to EventCatalog**
|
|
4
2
|
|
|
5
3
|
This open-source project is designed to help you and your teams bring discoverability and clarity to your event-driven architectures (EDA).
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
This page can be replaced with your own content, but to help you get started, we have created a few guides and resources.
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
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>
|
|
17
15
|
|
|
18
16
|
### **Join the community**
|
|
19
17
|
|
|
20
|
-
|
|
18
|
+
Our project and community is growing fast. We have over 1000+ members in our [Discord community](https://discord.gg/3rjaZMmrAm).
|
|
21
19
|
|
|
22
|
-
|
|
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>
|
|
23
24
|
|
|
24
|
-
|
|
25
|
+
---
|
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
import Footer from '@layouts/Footer.astro';
|
|
3
3
|
import components from '@components/MDX/page-components';
|
|
4
|
+
import mdxComponents from '@components/MDX/components';
|
|
4
5
|
import { getIndexPage } from '@utils/pages';
|
|
5
6
|
import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
|
|
7
|
+
import { render } from 'astro:content';
|
|
6
8
|
|
|
7
9
|
const page = await getIndexPage();
|
|
8
10
|
let CustomContent = null;
|
|
9
11
|
|
|
12
|
+
const props = Astro.props;
|
|
13
|
+
|
|
10
14
|
if (page) {
|
|
11
|
-
const { Content } = await
|
|
15
|
+
const { Content } = await render(page);
|
|
12
16
|
CustomContent = Content;
|
|
13
17
|
} else {
|
|
14
18
|
CustomContent = await import('./_default-docs.mdx').then((mod) => mod.default);
|
|
@@ -20,7 +24,7 @@ if (page) {
|
|
|
20
24
|
<div class="flex docs-layout w-full">
|
|
21
25
|
<div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8">
|
|
22
26
|
<div class="prose prose-md w-full !max-w-none">
|
|
23
|
-
<CustomContent components={components} />
|
|
27
|
+
<CustomContent components={{ ...components, ...mdxComponents(props) }} />
|
|
24
28
|
</div>
|
|
25
29
|
<Footer />
|
|
26
30
|
</div>
|
|
@@ -11,10 +11,10 @@ export const getPages = async (): Promise<Page[]> => {
|
|
|
11
11
|
|
|
12
12
|
export const getIndexPage = async (): Promise<Page> => {
|
|
13
13
|
const pages = await getCollection('pages');
|
|
14
|
-
return pages.find((page) => page.
|
|
14
|
+
return pages.find((page) => page.data?.id === 'index')!;
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
export const hasLandingPageForDocs = async (): Promise<boolean> => {
|
|
18
18
|
const pages = await getCollection('pages');
|
|
19
|
-
return pages.some((page) => page.
|
|
19
|
+
return pages.some((page) => page.data?.id === 'index')!;
|
|
20
20
|
};
|