@eventcatalog/core 3.37.0 → 3.39.1
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/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/{chunk-C24AACHY.js → chunk-DNU6WL3Q.js} +1 -1
- package/dist/{chunk-6UFDH5SD.js → chunk-KIRJD3RR.js} +1 -1
- package/dist/{chunk-R6AVEQA4.js → chunk-MOMRC6JV.js} +1 -1
- package/dist/{chunk-3N5OG33R.js → chunk-NQ35I4PT.js} +3 -3
- package/dist/{chunk-G6DWKVUO.js → chunk-ZVTW5LU6.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/02-config.md +1 -1
- package/dist/docs/development/components/components/23-visibility.md +1 -1
- package/dist/docs/development/developer-tools/llms.txt.md +19 -8
- package/dist/eventcatalog.cjs +1 -1
- package/dist/eventcatalog.js +10 -10
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/eventcatalog/src/components/Search/SearchModal.tsx +8 -1
- package/eventcatalog/src/components/Search/search-utils.ts +1 -0
- package/eventcatalog/src/components/Settings/LlmAccessSettingsForm.tsx +2 -4
- package/eventcatalog/src/enterprise/auth/middleware/middleware-auth.ts +8 -1
- package/eventcatalog/src/pages/docs/[type]/[id]/[version].md.ts +2 -0
- package/eventcatalog/src/pages/docs/[type]/[id]/[version].mdx.ts +2 -0
- package/eventcatalog/src/pages/docs/llm/llms-full.txt.ts +6 -0
- package/eventcatalog/src/pages/docs/llm/llms.txt.ts +3 -0
- package/eventcatalog/src/pages/llms-full.txt.ts +1 -0
- package/eventcatalog/src/pages/llms.txt.ts +1 -0
- package/eventcatalog/src/pages/settings/llm-access.astro +2 -2
- package/package.json +3 -3
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
4
|
-
import "../chunk-6UFDH5SD.js";
|
|
3
|
+
} from "../chunk-NQ35I4PT.js";
|
|
5
4
|
import "../chunk-4UVFXLPI.js";
|
|
6
|
-
import "../chunk-
|
|
5
|
+
import "../chunk-KIRJD3RR.js";
|
|
6
|
+
import "../chunk-DNU6WL3Q.js";
|
|
7
7
|
import "../chunk-5T63CXKU.js";
|
|
8
8
|
export {
|
|
9
9
|
log_build_default as default
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
raiseEvent
|
|
3
|
-
} from "./chunk-6UFDH5SD.js";
|
|
4
1
|
import {
|
|
5
2
|
countResources,
|
|
6
3
|
serializeCounts
|
|
7
4
|
} from "./chunk-4UVFXLPI.js";
|
|
5
|
+
import {
|
|
6
|
+
raiseEvent
|
|
7
|
+
} from "./chunk-KIRJD3RR.js";
|
|
8
8
|
import {
|
|
9
9
|
getEventCatalogConfigFile,
|
|
10
10
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
|
@@ -669,7 +669,7 @@ After RSS is enabled, EventCatalog serves feeds at these paths:
|
|
|
669
669
|
|
|
670
670
|
<AddedIn version="2.20.0" />
|
|
671
671
|
|
|
672
|
-
Enable tools like Claude, ChatGPT, GitHub Copilot, and Cursor to quickly understand your EventCatalog.
|
|
672
|
+
Enable tools like Claude, ChatGPT, GitHub Copilot, and Cursor to quickly understand your EventCatalog. When enabled, your catalog is accessible at `/llms.txt` and `/llms-full.txt`.
|
|
673
673
|
|
|
674
674
|
```js title="eventcatalog.config.js"
|
|
675
675
|
{
|
|
@@ -36,7 +36,7 @@ import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
|
36
36
|
|
|
37
37
|
In the browser UI, only `for="humans"` blocks render. The `for="agents"` block returns nothing and is never visible to human readers.
|
|
38
38
|
|
|
39
|
-
When an AI agent or LLM fetches the raw markdown for a resource — via the `.md` / `.mdx` endpoints, the `/
|
|
39
|
+
When an AI agent or LLM fetches the raw markdown for a resource — via the `.md` / `.mdx` endpoints, the `/llms-full.txt` feed, custom docs, team/user pages, language pages, or diagram pages — the `for="humans"` blocks are stripped and only `for="agents"` content remains.
|
|
40
40
|
|
|
41
41
|
This means the same file can give a human reader UI-oriented guidance ("click the Schema tab") while giving an agent structured, machine-actionable context ("treat this as a read-only lookup") without any duplication.
|
|
42
42
|
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
sidebar_position: 3
|
|
3
3
|
keywords:
|
|
4
|
-
-
|
|
4
|
+
- llms.txt
|
|
5
|
+
- AI
|
|
6
|
+
- LLM
|
|
5
7
|
sidebar_label: llms.txt
|
|
6
8
|
title: LLMS.txt
|
|
7
9
|
description: Understanding how to use LLMS.txt with EventCatalog and your LLMs
|
|
@@ -21,9 +23,11 @@ The file is automatically generated and maintained as part of your documentation
|
|
|
21
23
|
|
|
22
24
|
### llms.txt and llms-full.txt
|
|
23
25
|
|
|
24
|
-
The `llms.txt` file includes your EventCatalog resources in a simple format
|
|
26
|
+
The `llms.txt` file includes your EventCatalog resources in a simple format, listing each resource with a short summary.
|
|
25
27
|
|
|
26
|
-
The `llms-full.txt` file includes your EventCatalog resources in a more detailed format
|
|
28
|
+
The `llms-full.txt` file includes your EventCatalog resources in a more detailed format — all the contents of your catalog resources are included in the file.
|
|
29
|
+
|
|
30
|
+
Both files cover events, commands, queries, services, domains, flows, channels, teams, users, entities, data products, and ubiquitous languages.
|
|
27
31
|
|
|
28
32
|
### Enable in EventCatalog
|
|
29
33
|
|
|
@@ -37,11 +41,18 @@ llmsTxt: {
|
|
|
37
41
|
},
|
|
38
42
|
```
|
|
39
43
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
44
|
+
### Access the files
|
|
45
|
+
|
|
46
|
+
<AddedIn version="3.37.0" />
|
|
47
|
+
|
|
48
|
+
The recommended URLs for AI tools are at the catalog root:
|
|
49
|
+
|
|
50
|
+
- `https://<your-catalog-url>/llms.txt`
|
|
51
|
+
- Demo: https://demo.eventcatalog.dev/llms.txt
|
|
52
|
+
- `https://<your-catalog-url>/llms-full.txt`
|
|
53
|
+
- Demo: https://demo.eventcatalog.dev/llms-full.txt
|
|
54
|
+
|
|
55
|
+
The legacy paths `/docs/llm/llms.txt` and `/docs/llm/llms-full.txt` still work for backward compatibility.
|
|
45
56
|
|
|
46
57
|
### How to use LLMS.txt?
|
|
47
58
|
|
package/dist/eventcatalog.cjs
CHANGED
|
@@ -114,7 +114,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
|
|
|
114
114
|
var import_picocolors = __toESM(require("picocolors"), 1);
|
|
115
115
|
|
|
116
116
|
// package.json
|
|
117
|
-
var version = "3.
|
|
117
|
+
var version = "3.39.1";
|
|
118
118
|
|
|
119
119
|
// src/constants.ts
|
|
120
120
|
var VERSION = version;
|
package/dist/eventcatalog.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import {
|
|
2
|
-
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
2
|
+
log_build_default
|
|
3
|
+
} from "./chunk-NQ35I4PT.js";
|
|
4
|
+
import "./chunk-4UVFXLPI.js";
|
|
5
5
|
import {
|
|
6
6
|
resolve_catalog_dependencies_default
|
|
7
7
|
} from "./chunk-WAJIJEI3.js";
|
|
@@ -12,10 +12,10 @@ import {
|
|
|
12
12
|
watch
|
|
13
13
|
} from "./chunk-K3ZVEX2Y.js";
|
|
14
14
|
import {
|
|
15
|
-
|
|
16
|
-
} from "./chunk-
|
|
17
|
-
import "./chunk-
|
|
18
|
-
import "./chunk-
|
|
15
|
+
runMigrations
|
|
16
|
+
} from "./chunk-XUAF2H54.js";
|
|
17
|
+
import "./chunk-CA4U2JP7.js";
|
|
18
|
+
import "./chunk-KIRJD3RR.js";
|
|
19
19
|
import {
|
|
20
20
|
catalogToAstro
|
|
21
21
|
} from "./chunk-YDXB3BD2.js";
|
|
@@ -28,13 +28,13 @@ import {
|
|
|
28
28
|
} from "./chunk-ULZYHF3V.js";
|
|
29
29
|
import {
|
|
30
30
|
generate
|
|
31
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-MOMRC6JV.js";
|
|
32
32
|
import {
|
|
33
33
|
logger
|
|
34
|
-
} from "./chunk-
|
|
34
|
+
} from "./chunk-ZVTW5LU6.js";
|
|
35
35
|
import {
|
|
36
36
|
VERSION
|
|
37
|
-
} from "./chunk-
|
|
37
|
+
} from "./chunk-DNU6WL3Q.js";
|
|
38
38
|
import {
|
|
39
39
|
getEventCatalogConfigFile,
|
|
40
40
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/generate.cjs
CHANGED
package/dist/generate.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
generate
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
5
|
-
import "./chunk-
|
|
3
|
+
} from "./chunk-MOMRC6JV.js";
|
|
4
|
+
import "./chunk-ZVTW5LU6.js";
|
|
5
|
+
import "./chunk-DNU6WL3Q.js";
|
|
6
6
|
import "./chunk-5T63CXKU.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
package/dist/utils/cli-logger.js
CHANGED
|
@@ -385,7 +385,14 @@ export default function SearchModal() {
|
|
|
385
385
|
url,
|
|
386
386
|
type: fav.badge || node?.badge || 'Page',
|
|
387
387
|
key: fav.nodeKey,
|
|
388
|
-
rawNode: node || {
|
|
388
|
+
rawNode: node || {
|
|
389
|
+
title: fav.title,
|
|
390
|
+
badge: fav.badge,
|
|
391
|
+
summary: undefined,
|
|
392
|
+
icon: undefined,
|
|
393
|
+
leftIcon: undefined,
|
|
394
|
+
matchedExcerpt: undefined,
|
|
395
|
+
},
|
|
389
396
|
isFavorite: true,
|
|
390
397
|
};
|
|
391
398
|
})
|
|
@@ -83,7 +83,7 @@ export const LlmAccessSettingsForm = ({
|
|
|
83
83
|
|
|
84
84
|
<Row
|
|
85
85
|
title="llms.txt"
|
|
86
|
-
description="Generate llms.txt files so tools like Claude, ChatGPT, and Cursor can read your catalog at /
|
|
86
|
+
description="Generate llms.txt files so tools like Claude, ChatGPT, and Cursor can read your catalog at /llms.txt."
|
|
87
87
|
canEdit={canEdit}
|
|
88
88
|
dirty={dirty}
|
|
89
89
|
saving={saving}
|
|
@@ -93,9 +93,7 @@ export const LlmAccessSettingsForm = ({
|
|
|
93
93
|
icon={<Bot className="h-4 w-4" aria-hidden />}
|
|
94
94
|
label={llmsTxtEnabled ? 'Enabled' : 'Disabled'}
|
|
95
95
|
hint={
|
|
96
|
-
llmsTxtEnabled
|
|
97
|
-
? 'AI tools can read your catalog at /docs/llm/llms.txt.'
|
|
98
|
-
: 'AI tools will not be able to read your catalog.'
|
|
96
|
+
llmsTxtEnabled ? 'AI tools can read your catalog at /llms.txt.' : 'AI tools will not be able to read your catalog.'
|
|
99
97
|
}
|
|
100
98
|
checked={llmsTxtEnabled}
|
|
101
99
|
disabled={!canEdit}
|
|
@@ -87,7 +87,14 @@ export function getPublicRoutes(isLLMSTextEnabled: boolean) {
|
|
|
87
87
|
return publicRoutes;
|
|
88
88
|
}
|
|
89
89
|
|
|
90
|
-
return [
|
|
90
|
+
return [
|
|
91
|
+
...publicRoutes,
|
|
92
|
+
'/llms.txt',
|
|
93
|
+
'/llms-full.txt',
|
|
94
|
+
'/docs/llm/llms.txt',
|
|
95
|
+
'/docs/llm/llms-full.txt',
|
|
96
|
+
'/docs/llm/schemas.txt',
|
|
97
|
+
];
|
|
91
98
|
}
|
|
92
99
|
|
|
93
100
|
export const authMiddleware: MiddlewareHandler = async (context, next) => {
|
|
@@ -14,6 +14,7 @@ const events = await getCollection('events');
|
|
|
14
14
|
const commands = await getCollection('commands');
|
|
15
15
|
const queries = await getCollection('queries');
|
|
16
16
|
const services = await getCollection('services');
|
|
17
|
+
const dataProducts = await getCollection('data-products');
|
|
17
18
|
const domains = await getCollection('domains');
|
|
18
19
|
const flows = await getCollection('flows');
|
|
19
20
|
const channels = await getCollection('channels');
|
|
@@ -25,6 +26,7 @@ const collections = {
|
|
|
25
26
|
commands,
|
|
26
27
|
queries,
|
|
27
28
|
services,
|
|
29
|
+
'data-products': dataProducts,
|
|
28
30
|
domains,
|
|
29
31
|
flows,
|
|
30
32
|
channels,
|
|
@@ -12,6 +12,7 @@ const events = await getCollection('events');
|
|
|
12
12
|
const commands = await getCollection('commands');
|
|
13
13
|
const queries = await getCollection('queries');
|
|
14
14
|
const services = await getCollection('services');
|
|
15
|
+
const dataProducts = await getCollection('data-products');
|
|
15
16
|
const domains = await getCollection('domains');
|
|
16
17
|
const flows = await getCollection('flows');
|
|
17
18
|
const channels = await getCollection('channels');
|
|
@@ -25,6 +26,7 @@ const collections = {
|
|
|
25
26
|
commands,
|
|
26
27
|
queries,
|
|
27
28
|
services,
|
|
29
|
+
'data-products': dataProducts,
|
|
28
30
|
domains,
|
|
29
31
|
flows,
|
|
30
32
|
channels,
|
|
@@ -9,6 +9,7 @@ type AllowedCollections =
|
|
|
9
9
|
| 'commands'
|
|
10
10
|
| 'queries'
|
|
11
11
|
| 'services'
|
|
12
|
+
| 'data-products'
|
|
12
13
|
| 'domains'
|
|
13
14
|
| 'teams'
|
|
14
15
|
| 'users'
|
|
@@ -17,12 +18,14 @@ type AllowedCollections =
|
|
|
17
18
|
| 'entities'
|
|
18
19
|
| 'flows'
|
|
19
20
|
| 'containers'
|
|
21
|
+
| 'ubiquitousLanguages'
|
|
20
22
|
| 'resourceDocs';
|
|
21
23
|
|
|
22
24
|
const events = await getCollection('events');
|
|
23
25
|
const commands = await getCollection('commands');
|
|
24
26
|
const queries = await getCollection('queries');
|
|
25
27
|
const services = await getCollection('services');
|
|
28
|
+
const dataProducts = await getCollection('data-products');
|
|
26
29
|
const domains = await getCollection('domains');
|
|
27
30
|
const teams = await getCollection('teams');
|
|
28
31
|
const users = await getCollection('users');
|
|
@@ -30,6 +33,7 @@ const entities = await getCollection('entities');
|
|
|
30
33
|
const channels = await getCollection('channels');
|
|
31
34
|
const flows = await getCollection('flows');
|
|
32
35
|
const containers = await getCollection('containers');
|
|
36
|
+
const ubiquitousLanguages = await getCollection('ubiquitousLanguages');
|
|
33
37
|
const customDocs = await getCollection('customPages');
|
|
34
38
|
const resourceDocs = isResourceDocsEnabled() ? await getCollection('resourceDocs') : [];
|
|
35
39
|
|
|
@@ -43,6 +47,7 @@ export const GET: APIRoute = async ({ params, request }) => {
|
|
|
43
47
|
...commands,
|
|
44
48
|
...queries,
|
|
45
49
|
...services,
|
|
50
|
+
...dataProducts,
|
|
46
51
|
...domains,
|
|
47
52
|
...teams,
|
|
48
53
|
...users,
|
|
@@ -50,6 +55,7 @@ export const GET: APIRoute = async ({ params, request }) => {
|
|
|
50
55
|
...channels,
|
|
51
56
|
...containers,
|
|
52
57
|
...flows,
|
|
58
|
+
...ubiquitousLanguages,
|
|
53
59
|
];
|
|
54
60
|
|
|
55
61
|
if (isCustomDocsEnabled()) {
|
|
@@ -11,6 +11,7 @@ const commands = await getCollection('commands');
|
|
|
11
11
|
const queries = await getCollection('queries');
|
|
12
12
|
|
|
13
13
|
const services = await getCollection('services');
|
|
14
|
+
const dataProducts = await getCollection('data-products');
|
|
14
15
|
const domains = await getCollection('domains');
|
|
15
16
|
|
|
16
17
|
const teams = await getCollection('teams');
|
|
@@ -141,6 +142,8 @@ export const GET: APIRoute = async ({ params, request }) => {
|
|
|
141
142
|
queries.map((item) => formatVersionedItem(item, 'queries')).join(''),
|
|
142
143
|
'\n## Services',
|
|
143
144
|
services.map((item) => formatVersionedItem(item, 'services')).join(''),
|
|
145
|
+
'\n## Data Products',
|
|
146
|
+
dataProducts.map((item) => formatVersionedItem(item, 'data-products')).join('\n'),
|
|
144
147
|
'\n## Domains',
|
|
145
148
|
domains.map((item) => formatVersionedItem(item, 'domains')).join(''),
|
|
146
149
|
'\n## Flows',
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GET } from './docs/llm/llms-full.txt.ts';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GET } from './docs/llm/llms.txt.ts';
|
|
@@ -15,8 +15,8 @@ const initial = {
|
|
|
15
15
|
const hasScalePlan = isEventCatalogScaleEnabled();
|
|
16
16
|
|
|
17
17
|
const apiBase = buildUrl('/api/settings');
|
|
18
|
-
const llmsTxtUrl = buildUrl('/
|
|
19
|
-
const llmsFullTxtUrl = buildUrl('/
|
|
18
|
+
const llmsTxtUrl = buildUrl('/llms.txt');
|
|
19
|
+
const llmsFullTxtUrl = buildUrl('/llms-full.txt');
|
|
20
20
|
const schemasTxtUrl = buildUrl('/docs/llm/schemas.txt');
|
|
21
21
|
---
|
|
22
22
|
|
package/package.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
},
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE",
|
|
9
9
|
"type": "module",
|
|
10
|
-
"version": "3.
|
|
10
|
+
"version": "3.39.1",
|
|
11
11
|
"publishConfig": {
|
|
12
12
|
"access": "public"
|
|
13
13
|
},
|
|
@@ -107,8 +107,8 @@
|
|
|
107
107
|
"uuid": "^10.0.0",
|
|
108
108
|
"zod": "^4.3.6",
|
|
109
109
|
"@eventcatalog/linter": "1.0.23",
|
|
110
|
-
"@eventcatalog/
|
|
111
|
-
"@eventcatalog/
|
|
110
|
+
"@eventcatalog/visualiser": "^3.21.0",
|
|
111
|
+
"@eventcatalog/sdk": "2.21.1"
|
|
112
112
|
},
|
|
113
113
|
"devDependencies": {
|
|
114
114
|
"@astrojs/check": "^0.9.9",
|