@eventcatalog/core 3.36.3 → 3.36.4
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-6L5LHQ3C.js → chunk-6JY6QF7D.js} +1 -1
- package/dist/{chunk-ZE3NM2MH.js → chunk-7WJEUZFM.js} +3 -3
- package/dist/{chunk-4U6TPQGC.js → chunk-HF27CRFY.js} +1 -1
- package/dist/{chunk-DTE424XY.js → chunk-NV7DNZ3X.js} +1 -1
- package/dist/{chunk-SPFT3VTV.js → chunk-XTJ636IF.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/09-flow-api.md +38 -0
- package/dist/docs/api/11-data-api.md +6 -1
- package/dist/docs/development/guides/flows/01-introduction.md +1 -1
- package/dist/docs/development/guides/flows/03-flow-nodes.md +58 -4
- 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/MDX/Flow/Flow.astro +10 -6
- package/eventcatalog/src/enterprise/custom-documentation/pages/docs/custom/index.astro +8 -3
- package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro +41 -12
- package/eventcatalog/src/utils/markdown.ts +8 -3
- package/package.json +2 -2
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
4
|
-
import "../chunk-4U6TPQGC.js";
|
|
3
|
+
} from "../chunk-7WJEUZFM.js";
|
|
5
4
|
import "../chunk-4UVFXLPI.js";
|
|
6
|
-
import "../chunk-
|
|
5
|
+
import "../chunk-HF27CRFY.js";
|
|
6
|
+
import "../chunk-NV7DNZ3X.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-4U6TPQGC.js";
|
|
4
1
|
import {
|
|
5
2
|
countResources,
|
|
6
3
|
serializeCounts
|
|
7
4
|
} from "./chunk-4UVFXLPI.js";
|
|
5
|
+
import {
|
|
6
|
+
raiseEvent
|
|
7
|
+
} from "./chunk-HF27CRFY.js";
|
|
8
8
|
import {
|
|
9
9
|
getEventCatalogConfigFile,
|
|
10
10
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
|
@@ -261,7 +261,45 @@ Flows allow you to create [service nodes](/docs/services). Services link to your
|
|
|
261
261
|
|
|
262
262
|
_[See example of Message node in a workflow](https://demo.eventcatalog.dev/visualiser/flows/CancelSubscription/0.0.1)._
|
|
263
263
|
|
|
264
|
+
#### Container Nodes
|
|
264
265
|
|
|
266
|
+
<AddedIn version="3.36.3" />
|
|
267
|
+
|
|
268
|
+
Flows allow you to create [container (data store) nodes](/docs/development/guides/data/introduction). Containers link to your defined data stores in EventCatalog. The container's sidebar will automatically show a "Flows" section linking back to any flow that references it.
|
|
269
|
+
|
|
270
|
+
```md title="Example"
|
|
271
|
+
---
|
|
272
|
+
steps:
|
|
273
|
+
- id: "orders_db"
|
|
274
|
+
title: "Orders DB"
|
|
275
|
+
container:
|
|
276
|
+
id: "orders-db"
|
|
277
|
+
version: "1.0.0"
|
|
278
|
+
next_step:
|
|
279
|
+
id: "next_step"
|
|
280
|
+
label: "Persist order records"
|
|
281
|
+
---
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
#### Data Product Nodes
|
|
285
|
+
|
|
286
|
+
<AddedIn version="3.36.3" />
|
|
287
|
+
|
|
288
|
+
Flows allow you to create [data product nodes](/docs/development/guides/data-products/introduction). Data products link to your defined data products in EventCatalog. The data product's sidebar will automatically show a "Flows" section linking back to any flow that references it.
|
|
289
|
+
|
|
290
|
+
```md title="Example"
|
|
291
|
+
---
|
|
292
|
+
steps:
|
|
293
|
+
- id: "order_analytics"
|
|
294
|
+
title: "Order Analytics"
|
|
295
|
+
dataProduct:
|
|
296
|
+
id: "order-analytics"
|
|
297
|
+
version: "1.0.0"
|
|
298
|
+
next_step:
|
|
299
|
+
id: "next_step"
|
|
300
|
+
label: "Prepare fulfillment KPIs"
|
|
301
|
+
---
|
|
302
|
+
```
|
|
265
303
|
|
|
266
304
|
## Optional fields {#optional-fields}
|
|
267
305
|
|
|
@@ -235,7 +235,12 @@ Options:
|
|
|
235
235
|
| `changelog` | `object` | No | An object with a `visible` property to show/hide the changelog button |
|
|
236
236
|
| `owners` | `object` | No | An object with a `visible` property to show/hide the owners section |
|
|
237
237
|
| `attachments` | `object` | No | An object with a `visible` property to show/hide the attachments section |
|
|
238
|
-
| `repository` | `object` | No | An object with a `visible` property to show/hide the repository section |
|
|
238
|
+
| `repository` | `object` | No | An object with a `visible` property to show/hide the repository section |
|
|
239
|
+
| `flows` | `object` | No | An object with a `visible` property to show/hide the flows section |
|
|
240
|
+
|
|
241
|
+
**`flows`** <AddedIn version="3.36.3" />
|
|
242
|
+
|
|
243
|
+
Shows which flows reference this data store as a step. Flows are surfaced automatically when a [flow step](/docs/development/guides/flows/flow-nodes) uses the `container` node type to reference this resource.
|
|
239
244
|
|
|
240
245
|
### `attachments` {#attachments}
|
|
241
246
|
|
|
@@ -12,7 +12,7 @@ import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
|
12
12
|
|
|
13
13
|
<AddedIn version="2.5.0" />
|
|
14
14
|
|
|
15
|
-
Flows are a way to document business workflows in your organization. You can reuse your documented resources (e.g services, messages, data stores) in your flows.
|
|
15
|
+
Flows are a way to document business workflows in your organization. You can reuse your documented resources (e.g services, messages, data stores, data products) in your flows.
|
|
16
16
|
|
|
17
17
|
An example of a flow would be when a user makes a payment to an e-commence system, this interaction triggers many parts of the architecture (services, external services, commands, queries and events):
|
|
18
18
|
|
|
@@ -13,9 +13,7 @@ import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
|
13
13
|
|
|
14
14
|
Flow nodes are the building blocks of flows. They are used to represent the different steps in a flow.
|
|
15
15
|
|
|
16
|
-
With flow nodes you can reference your services, events, commands and queries, external systems, users (actors) or
|
|
17
|
-
|
|
18
|
-
EventCatalog (> 2.34.2) you can also reference flows as a node type.
|
|
16
|
+
With flow nodes you can reference your services, events, commands and queries, external systems, users (actors), data stores (containers), data products, or create your own custom nodes.
|
|
19
17
|
|
|
20
18
|
## Common step properties
|
|
21
19
|
|
|
@@ -31,7 +29,7 @@ Every flow step (regardless of node type) supports these properties:
|
|
|
31
29
|
| `next_steps` | [Step reference](#connecting-steps)[] | No | Multiple next steps for branching (cannot be used with `next_step`) |
|
|
32
30
|
|
|
33
31
|
:::tip Type exclusivity rule
|
|
34
|
-
Each step can only use **one** node type property. You cannot combine `message`, `service`, `flow`, `actor`, `custom`, or `externalSystem` on the same step.
|
|
32
|
+
Each step can only use **one** node type property. You cannot combine `message`, `service`, `flow`, `container`, `dataProduct`, `actor`, `custom`, or `externalSystem` on the same step.
|
|
35
33
|
:::
|
|
36
34
|
|
|
37
35
|
## Connecting steps {#connecting-steps}
|
|
@@ -67,6 +65,8 @@ next_steps:
|
|
|
67
65
|
- [message](#message) — Represents an event, command or query resource in EventCatalog
|
|
68
66
|
- [service](#service) — Represents a service resource in EventCatalog
|
|
69
67
|
- [flow](#flow) — Represents a flow in EventCatalog (added in EventCatalog 2.34.2)
|
|
68
|
+
- [container](#container) — Represents a data store (container) resource in EventCatalog
|
|
69
|
+
- [dataProduct](#dataproduct) — Represents a data product resource in EventCatalog
|
|
70
70
|
- [custom](#custom) — A custom node type with configurable title, summary, icon, properties and more
|
|
71
71
|
|
|
72
72
|
|
|
@@ -202,6 +202,60 @@ Click a flow node in the visualiser to expand the referenced flow's steps inline
|
|
|
202
202
|
|
|
203
203
|
---
|
|
204
204
|
|
|
205
|
+
### container
|
|
206
|
+
|
|
207
|
+
<AddedIn version="3.36.3" />
|
|
208
|
+
|
|
209
|
+
Represents and refers to a data store (container) resource in EventCatalog. When a flow references a container, the container's sidebar automatically shows a "Flows" section linking back to the referencing flow.
|
|
210
|
+
|
|
211
|
+
#### Container properties
|
|
212
|
+
|
|
213
|
+
| Property | Type | Required | Description |
|
|
214
|
+
|----------|------|----------|-------------|
|
|
215
|
+
| `id` | `string` | **Yes** | The id of the container in your catalog |
|
|
216
|
+
| `version` | `string` | No | The version to reference (defaults to `latest`) |
|
|
217
|
+
|
|
218
|
+
```yml
|
|
219
|
+
steps:
|
|
220
|
+
- id: "orders_db"
|
|
221
|
+
title: "Orders DB"
|
|
222
|
+
container:
|
|
223
|
+
id: "orders-db"
|
|
224
|
+
version: "1.0.0"
|
|
225
|
+
next_step:
|
|
226
|
+
id: "next_step"
|
|
227
|
+
label: "Persist order records"
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
### dataProduct
|
|
233
|
+
|
|
234
|
+
<AddedIn version="3.36.3" />
|
|
235
|
+
|
|
236
|
+
Represents and refers to a data product resource in EventCatalog. When a flow references a data product, the data product's sidebar automatically shows a "Flows" section linking back to the referencing flow.
|
|
237
|
+
|
|
238
|
+
#### Data product properties
|
|
239
|
+
|
|
240
|
+
| Property | Type | Required | Description |
|
|
241
|
+
|----------|------|----------|-------------|
|
|
242
|
+
| `id` | `string` | **Yes** | The id of the data product in your catalog |
|
|
243
|
+
| `version` | `string` | No | The version to reference (defaults to `latest`) |
|
|
244
|
+
|
|
245
|
+
```yml
|
|
246
|
+
steps:
|
|
247
|
+
- id: "order_analytics"
|
|
248
|
+
title: "Order Analytics"
|
|
249
|
+
dataProduct:
|
|
250
|
+
id: "order-analytics"
|
|
251
|
+
version: "1.0.0"
|
|
252
|
+
next_step:
|
|
253
|
+
id: "next_step"
|
|
254
|
+
label: "Prepare fulfillment KPIs"
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
205
259
|
### custom
|
|
206
260
|
|
|
207
261
|
<AddedIn version="2.30.6" />
|
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.36.
|
|
117
|
+
var version = "3.36.4";
|
|
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-7WJEUZFM.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-HF27CRFY.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-6JY6QF7D.js";
|
|
32
32
|
import {
|
|
33
33
|
logger
|
|
34
|
-
} from "./chunk-
|
|
34
|
+
} from "./chunk-XTJ636IF.js";
|
|
35
35
|
import {
|
|
36
36
|
VERSION
|
|
37
|
-
} from "./chunk-
|
|
37
|
+
} from "./chunk-NV7DNZ3X.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-6JY6QF7D.js";
|
|
4
|
+
import "./chunk-XTJ636IF.js";
|
|
5
|
+
import "./chunk-NV7DNZ3X.js";
|
|
6
6
|
import "./chunk-5T63CXKU.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
package/dist/utils/cli-logger.js
CHANGED
|
@@ -6,10 +6,15 @@ import AstroNodeGraph from '../NodeGraph/AstroNodeGraph';
|
|
|
6
6
|
import { getVersionFromCollection } from '@utils/collections/versions';
|
|
7
7
|
import { isVisualiserEnabled, isEventCatalogChatEnabled, isDevMode } from '@utils/feature';
|
|
8
8
|
import { loadSavedLayout, applyLayoutToNodes, buildResourceKey } from '@utils/node-graphs/layout-persistence';
|
|
9
|
+
import { randomUUID } from 'node:crypto';
|
|
10
|
+
import { parseMdxBooleanProp } from '@utils/markdown';
|
|
9
11
|
|
|
10
12
|
const isChatEnabled = isEventCatalogChatEnabled();
|
|
11
13
|
|
|
12
|
-
const { id, version = 'latest', maxHeight,
|
|
14
|
+
const { id, version = 'latest', maxHeight, mode = 'simple' } = Astro.props;
|
|
15
|
+
const includeKey = parseMdxBooleanProp(Astro.props.legend ?? Astro.props.includeKey, true);
|
|
16
|
+
const search = parseMdxBooleanProp(Astro.props.search, false);
|
|
17
|
+
const walkthrough = parseMdxBooleanProp(Astro.props.walkthrough, false);
|
|
13
18
|
|
|
14
19
|
// Find the flow for the given id and version
|
|
15
20
|
const flows = await getFlows();
|
|
@@ -28,6 +33,7 @@ const { nodes, edges } = await getNodesAndEdges({
|
|
|
28
33
|
const resourceKey = buildResourceKey('flows', id, flow.data.version);
|
|
29
34
|
const savedLayout = await loadSavedLayout(resourceKey);
|
|
30
35
|
const nodesWithLayout = applyLayoutToNodes(nodes, savedLayout);
|
|
36
|
+
const portalId = `${id}-${flow.data.version}-flow-${randomUUID()}-portal`;
|
|
31
37
|
---
|
|
32
38
|
|
|
33
39
|
{
|
|
@@ -45,7 +51,7 @@ const nodesWithLayout = applyLayoutToNodes(nodes, savedLayout);
|
|
|
45
51
|
|
|
46
52
|
<div
|
|
47
53
|
class="h-[30em] my-6 mb-12 w-full relative border border-[rgb(var(--ec-page-border))] rounded-md"
|
|
48
|
-
id={
|
|
54
|
+
id={portalId}
|
|
49
55
|
style={{
|
|
50
56
|
maxHeight: maxHeight ? `${maxHeight}em` : `30em`,
|
|
51
57
|
}}
|
|
@@ -57,12 +63,10 @@ const nodesWithLayout = applyLayoutToNodes(nodes, savedLayout);
|
|
|
57
63
|
id={id}
|
|
58
64
|
nodes={nodesWithLayout}
|
|
59
65
|
edges={edges}
|
|
60
|
-
|
|
61
|
-
href={isVisualiserEnabled() ? `/visualiser/flows/${id}/${version}` : undefined}
|
|
62
|
-
linkTo={'visualiser'}
|
|
66
|
+
mode={mode}
|
|
63
67
|
includeKey={includeKey}
|
|
64
|
-
footerLabel=`Flow diagram - ${flow.data.name} - v(${flow.data.version})`
|
|
65
68
|
client:only="react"
|
|
69
|
+
portalId={portalId}
|
|
66
70
|
showFlowWalkthrough={walkthrough}
|
|
67
71
|
showSearch={search}
|
|
68
72
|
isChatEnabled={isChatEnabled}
|
|
@@ -9,7 +9,7 @@ import mdxComponents from '@components/MDX/components';
|
|
|
9
9
|
import { getOwner } from '@utils/collections/owners';
|
|
10
10
|
import { buildUrl, buildEditUrlForResource } from '@utils/url-builder';
|
|
11
11
|
import { resourceToCollectionMap } from '@utils/collections/util';
|
|
12
|
-
import { getMDXComponentsByName } from '@utils/markdown';
|
|
12
|
+
import { getMDXComponentsByName, parseMdxBooleanProp } from '@utils/markdown';
|
|
13
13
|
import { getAdjacentPages, getNavigationItems } from '@enterprise/custom-documentation/utils/custom-docs';
|
|
14
14
|
import CustomDocsNav from '@enterprise/custom-documentation/components/CustomDocsNav/CustomDocsNav.astro';
|
|
15
15
|
import NodeGraph from '@components/MDX/NodeGraph/NodeGraph.astro';
|
|
@@ -22,7 +22,10 @@ const doc = props.data;
|
|
|
22
22
|
const { Content, headings } = await render(props as any);
|
|
23
23
|
const currentSlug = props.id;
|
|
24
24
|
|
|
25
|
-
const nodeGraphs =
|
|
25
|
+
const nodeGraphs =
|
|
26
|
+
getMDXComponentsByName(props.body, 'NodeGraph')?.filter((nodeGraph: any) => {
|
|
27
|
+
return nodeGraph.id && nodeGraph.version && nodeGraph.type;
|
|
28
|
+
}) || [];
|
|
26
29
|
|
|
27
30
|
const { prev, next } = await getAdjacentPages(currentSlug);
|
|
28
31
|
|
|
@@ -152,8 +155,10 @@ const editUrl =
|
|
|
152
155
|
version={nodeGraph.version}
|
|
153
156
|
collection={collection}
|
|
154
157
|
title={nodeGraph.title}
|
|
155
|
-
mode=
|
|
158
|
+
mode={nodeGraph.mode || 'simple'}
|
|
156
159
|
linksToVisualiser={true}
|
|
160
|
+
showSearch={parseMdxBooleanProp(nodeGraph.search, true)}
|
|
161
|
+
showLegend={parseMdxBooleanProp(nodeGraph.legend, true)}
|
|
157
162
|
href={
|
|
158
163
|
isVisualiserEnabled()
|
|
159
164
|
? {
|
|
@@ -43,7 +43,7 @@ import {
|
|
|
43
43
|
isRSSEnabled,
|
|
44
44
|
isExportPDFEnabled,
|
|
45
45
|
} from '@utils/feature';
|
|
46
|
-
import { getMDXComponentsByName } from '@utils/markdown';
|
|
46
|
+
import { getMDXComponentsByName, parseMdxBooleanProp } from '@utils/markdown';
|
|
47
47
|
|
|
48
48
|
import type { CollectionTypes } from '@types';
|
|
49
49
|
|
|
@@ -265,10 +265,40 @@ const generatePromptForResource = (props: any) => {
|
|
|
265
265
|
};
|
|
266
266
|
|
|
267
267
|
// Handle node graphs in the markdown
|
|
268
|
-
|
|
268
|
+
const currentPageNodeGraph = {
|
|
269
|
+
id: props.data.id,
|
|
270
|
+
version: props.data.version,
|
|
271
|
+
type: collectionToResourceMap[props.collection as keyof typeof collectionToResourceMap],
|
|
272
|
+
};
|
|
273
|
+
|
|
274
|
+
let nodeGraphs =
|
|
275
|
+
getMDXComponentsByName(props.body || '', 'NodeGraph')?.map((nodeGraph: any) => {
|
|
276
|
+
const graph = nodeGraph.id === undefined ? { ...currentPageNodeGraph, ...nodeGraph } : nodeGraph;
|
|
277
|
+
|
|
278
|
+
return {
|
|
279
|
+
...graph,
|
|
280
|
+
search: parseMdxBooleanProp(nodeGraph.search, true),
|
|
281
|
+
legend: parseMdxBooleanProp(nodeGraph.legend, true),
|
|
282
|
+
};
|
|
283
|
+
}) || [];
|
|
284
|
+
const flowEmbeds = getMDXComponentsByName(props.body || '', 'Flow') || [];
|
|
269
285
|
|
|
270
286
|
// Get props for the node graph (when no id is passed, we assume its the current page)
|
|
271
|
-
const
|
|
287
|
+
const hasCurrentFlowEmbed =
|
|
288
|
+
props.collection === 'flows' &&
|
|
289
|
+
flowEmbeds.some((flowEmbed: any) => {
|
|
290
|
+
const flowId = flowEmbed.id;
|
|
291
|
+
const flowVersion = flowEmbed.version || 'latest';
|
|
292
|
+
|
|
293
|
+
return flowId === props.data.id && (flowVersion === 'latest' || flowVersion === props.data.version);
|
|
294
|
+
});
|
|
295
|
+
const hasCurrentPageNodeGraph = nodeGraphs.some((nodeGraph: any) => {
|
|
296
|
+
return (
|
|
297
|
+
nodeGraph.id === currentPageNodeGraph.id &&
|
|
298
|
+
nodeGraph.version === currentPageNodeGraph.version &&
|
|
299
|
+
nodeGraph.type === currentPageNodeGraph.type
|
|
300
|
+
);
|
|
301
|
+
});
|
|
272
302
|
|
|
273
303
|
const shouldRenderVersionList =
|
|
274
304
|
shouldRenderSideBarSection(props, 'versions') && props.data.versions && props.data.versions.length > 1;
|
|
@@ -287,15 +317,14 @@ const httpMethodStyle = httpOperation?.method
|
|
|
287
317
|
? httpMethodColors[httpOperation.method.toUpperCase()] || { background: '#6b7280', color: '#ffffff' }
|
|
288
318
|
: undefined;
|
|
289
319
|
|
|
290
|
-
// This will render the graph for this page
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
});
|
|
320
|
+
// This will render the graph for this page. Flow pages can already render their graph explicitly via <Flow />.
|
|
321
|
+
if (!hasCurrentFlowEmbed && !hasCurrentPageNodeGraph) {
|
|
322
|
+
nodeGraphs.push({
|
|
323
|
+
...currentPageNodeGraph,
|
|
324
|
+
search: true,
|
|
325
|
+
legend: true,
|
|
326
|
+
});
|
|
327
|
+
}
|
|
299
328
|
---
|
|
300
329
|
|
|
301
330
|
<VerticalSideBarLayout title={pageTitle} description={props.data.summary}>
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
// rarely used, but useful for components that need to know how many times
|
|
3
3
|
// the user wants to render a component in a markdown file
|
|
4
4
|
export const getMDXComponentsByName = (document: string, componentName: string) => {
|
|
5
|
-
// Define regex pattern to match
|
|
6
|
-
const pattern = new RegExp(`<${componentName}\\s+
|
|
5
|
+
// Define regex pattern to match self-closing MDX components with or without props.
|
|
6
|
+
const pattern = new RegExp(`<${componentName}(\\s+[^>]*)?\\s*\\/>`, 'g');
|
|
7
7
|
|
|
8
8
|
// Find all matches of the pattern
|
|
9
9
|
const matches = [...document.matchAll(pattern)];
|
|
10
10
|
|
|
11
11
|
// Extract the properties of each SchemaViewer
|
|
12
12
|
const components = matches.map((match) => {
|
|
13
|
-
const propsString = match[1];
|
|
13
|
+
const propsString = match[1] || '';
|
|
14
14
|
const props = {};
|
|
15
15
|
|
|
16
16
|
// Use regex to extract key-value pairs from propsString
|
|
@@ -28,3 +28,8 @@ export const getMDXComponentsByName = (document: string, componentName: string)
|
|
|
28
28
|
|
|
29
29
|
return components;
|
|
30
30
|
};
|
|
31
|
+
|
|
32
|
+
export const parseMdxBooleanProp = (value: unknown, defaultValue: boolean) => {
|
|
33
|
+
if (value === undefined) return defaultValue;
|
|
34
|
+
return value === true || value === 'true';
|
|
35
|
+
};
|
package/package.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
},
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE",
|
|
9
9
|
"type": "module",
|
|
10
|
-
"version": "3.36.
|
|
10
|
+
"version": "3.36.4",
|
|
11
11
|
"publishConfig": {
|
|
12
12
|
"access": "public"
|
|
13
13
|
},
|
|
@@ -107,7 +107,7 @@
|
|
|
107
107
|
"uuid": "^10.0.0",
|
|
108
108
|
"zod": "^4.3.6",
|
|
109
109
|
"@eventcatalog/linter": "1.0.23",
|
|
110
|
-
"@eventcatalog/visualiser": "^3.20.
|
|
110
|
+
"@eventcatalog/visualiser": "^3.20.3",
|
|
111
111
|
"@eventcatalog/sdk": "2.21.1"
|
|
112
112
|
},
|
|
113
113
|
"devDependencies": {
|