@eventcatalog/core 3.35.0 → 3.36.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-LUWCWNOR.js → chunk-6D65JSOA.js} +1 -1
- package/dist/{chunk-NEWQKEP7.js → chunk-C7JCOHTI.js} +1 -1
- package/dist/chunk-D6IBLY3O.js +320 -0
- package/dist/{chunk-Y5O6SCX3.js → chunk-HDENGAZL.js} +1 -1
- package/dist/{chunk-DFLUDECO.js → chunk-UJ7DX4SA.js} +3 -3
- package/dist/{chunk-3KXCGYET.js → chunk-ULZYHF3V.js} +5 -0
- package/dist/{chunk-B2LDVIVY.js → chunk-V22QY5Q3.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/01-overview.md +74 -0
- package/dist/docs/api/02-config.md +959 -0
- package/dist/docs/api/03-domain-api.md +394 -0
- package/dist/docs/api/04-service-api.md +368 -0
- package/dist/docs/api/05-command-api.md +319 -0
- package/dist/docs/api/06-event-api.md +318 -0
- package/dist/docs/api/06-query-api.md +316 -0
- package/dist/docs/api/08-channel-api.md +317 -0
- package/dist/docs/api/08-code-blocks.md +53 -0
- package/dist/docs/api/09-flow-api.md +362 -0
- package/dist/docs/api/10-entity-api.md +285 -0
- package/dist/docs/api/11-data-api.md +268 -0
- package/dist/docs/api/12-data-product-api.md +416 -0
- package/dist/docs/api/_category_.json +12 -0
- package/dist/docs/cli/channels.md +180 -0
- package/dist/docs/cli/commands.md +183 -0
- package/dist/docs/cli/custom-docs.md +78 -0
- package/dist/docs/cli/data-products.md +177 -0
- package/dist/docs/cli/data-stores.md +166 -0
- package/dist/docs/cli/diagrams.md +147 -0
- package/dist/docs/cli/domains.md +280 -0
- package/dist/docs/cli/entities.md +138 -0
- package/dist/docs/cli/events.md +186 -0
- package/dist/docs/cli/export.md +27 -0
- package/dist/docs/cli/governance.md +24 -0
- package/dist/docs/cli/import.md +26 -0
- package/dist/docs/cli/index.md +121 -0
- package/dist/docs/cli/messages.md +69 -0
- package/dist/docs/cli/queries.md +183 -0
- package/dist/docs/cli/services.md +266 -0
- package/dist/docs/cli/snapshots.md +44 -0
- package/dist/docs/cli/teams.md +75 -0
- package/dist/docs/cli/users.md +75 -0
- package/dist/docs/cli/utilities.md +43 -0
- package/dist/docs/contributing/01-overview.md +186 -0
- package/dist/docs/contributing/_category_.json +12 -0
- package/dist/docs/development/00-why-eventcatalog.md +87 -0
- package/dist/docs/development/01-fundamentals.md +34 -0
- package/dist/docs/development/01-getting-started/_category_.json +12 -0
- package/dist/docs/development/01-getting-started/configuration-overview.md +124 -0
- package/dist/docs/development/01-getting-started/develop-and-build.md +71 -0
- package/dist/docs/development/01-getting-started/installation.md +103 -0
- package/dist/docs/development/01-getting-started/project-structure.md +269 -0
- package/dist/docs/development/_category_.json +12 -0
- package/dist/docs/development/_getting-started.mdx +15 -0
- package/dist/docs/development/agent-resources/_category_.json +6 -0
- package/dist/docs/development/agent-resources/eventcatalog-skills.md +17 -0
- package/dist/docs/development/agent-resources/llms-full.md +17 -0
- package/dist/docs/development/agent-resources/llms.md +17 -0
- package/dist/docs/development/ask-your-architecture/01-intro.md +89 -0
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +23 -0
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +72 -0
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +385 -0
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +11 -0
- package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +12 -0
- package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +216 -0
- package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +47 -0
- package/dist/docs/development/ask-your-architecture/04-skills/01-introduction.md +40 -0
- package/dist/docs/development/ask-your-architecture/04-skills/02-installation.md +60 -0
- package/dist/docs/development/ask-your-architecture/04-skills/_category_.json +11 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/01-introduction.md +63 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/02-slack-app-setup.md +154 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/03-installation.md +169 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/04-deployment.md +236 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/05-usage.md +140 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/06-troubleshooting.md +268 -0
- package/dist/docs/development/ask-your-architecture/05-slack-integration/_category_.json +12 -0
- package/dist/docs/development/ask-your-architecture/_category_.json +12 -0
- package/dist/docs/development/authentication/01-introduction.md +78 -0
- package/dist/docs/development/authentication/02-enabling-authentication.md +152 -0
- package/dist/docs/development/authentication/07-rbac-middleware.md +269 -0
- package/dist/docs/development/authentication/_category_.json +11 -0
- package/dist/docs/development/authentication/providers/03-setting-up-github.md +83 -0
- package/dist/docs/development/authentication/providers/03a-setting-up-google.md +92 -0
- package/dist/docs/development/authentication/providers/04-setting-up-azure-ad.md +100 -0
- package/dist/docs/development/authentication/providers/05-setting-up-okta.md +105 -0
- package/dist/docs/development/authentication/providers/06-setting-up-auth0.md +106 -0
- package/dist/docs/development/authentication/providers/_category_.json +11 -0
- package/dist/docs/development/bring-your-own-documentation/01-introduction.md +48 -0
- package/dist/docs/development/bring-your-own-documentation/_category_.json +12 -0
- package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +60 -0
- package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +207 -0
- package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +46 -0
- package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +45 -0
- package/dist/docs/development/bring-your-own-documentation/custom-pages/_category_.json +11 -0
- package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +34 -0
- package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +143 -0
- package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +68 -0
- package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +45 -0
- package/dist/docs/development/bring-your-own-documentation/resource-docs/_category_.json +11 -0
- package/dist/docs/development/components/04-snippets.md +134 -0
- package/dist/docs/development/components/05-using-components.md +67 -0
- package/dist/docs/development/components/07-resource-references.md +136 -0
- package/dist/docs/development/components/_category_.json +12 -0
- package/dist/docs/development/components/components/01-accordian.md +41 -0
- package/dist/docs/development/components/components/02-accordian-group.md +57 -0
- package/dist/docs/development/components/components/03-admonitions.md +43 -0
- package/dist/docs/development/components/components/04-attachments.md +56 -0
- package/dist/docs/development/components/components/05-channel-information.md +29 -0
- package/dist/docs/development/components/components/06-design.md +66 -0
- package/dist/docs/development/components/components/07-entitymap.md +71 -0
- package/dist/docs/development/components/components/08-flow.md +46 -0
- package/dist/docs/development/components/components/09-link.md +32 -0
- package/dist/docs/development/components/components/10-mermaid-file-loader.md +63 -0
- package/dist/docs/development/components/components/11-message-table.md +43 -0
- package/dist/docs/development/components/components/12-nodegraph.md +167 -0
- package/dist/docs/development/components/components/13-openapi.md +55 -0
- package/dist/docs/development/components/components/14-prompt.md +69 -0
- package/dist/docs/development/components/components/15-remote-schema.md +174 -0
- package/dist/docs/development/components/components/16-resource-group-table.md +86 -0
- package/dist/docs/development/components/components/17-resource-link.md +57 -0
- package/dist/docs/development/components/components/18-schema.md +44 -0
- package/dist/docs/development/components/components/19-schema-viewer.md +69 -0
- package/dist/docs/development/components/components/20-steps.md +83 -0
- package/dist/docs/development/components/components/21-tabs.md +55 -0
- package/dist/docs/development/components/components/22-tiles.md +53 -0
- package/dist/docs/development/components/components/23-visibility.md +61 -0
- package/dist/docs/development/components/components/_category_.json +12 -0
- package/dist/docs/development/components/diagram-syntax/01-mermaid.md +218 -0
- package/dist/docs/development/components/diagram-syntax/02-plantuml.md +140 -0
- package/dist/docs/development/components/diagram-syntax/03-structurizr.md +24 -0
- package/dist/docs/development/components/diagram-syntax/04-icepanel.md +75 -0
- package/dist/docs/development/components/diagram-syntax/_category_.json +12 -0
- package/dist/docs/development/components/external-diagram-embeds/01-miro.md +64 -0
- package/dist/docs/development/components/external-diagram-embeds/02-lucid.md +47 -0
- package/dist/docs/development/components/external-diagram-embeds/03-drawio.md +46 -0
- package/dist/docs/development/components/external-diagram-embeds/04-figjam.md +44 -0
- package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md +68 -0
- package/dist/docs/development/components/external-diagram-embeds/_category_.json +12 -0
- package/dist/docs/development/customization/01-customize-landing-page.md +155 -0
- package/dist/docs/development/customization/02-themes.md +429 -0
- package/dist/docs/development/customization/03-search.md +79 -0
- package/dist/docs/development/customization/06-customize-tables.md +194 -0
- package/dist/docs/development/customization/_category_.json +12 -0
- package/dist/docs/development/customization/custom-components/00-what-is-mdx.md +73 -0
- package/dist/docs/development/customization/custom-components/01-introduction.md +28 -0
- package/dist/docs/development/customization/custom-components/02-adding-components.md +145 -0
- package/dist/docs/development/customization/custom-components/03-component-styling.md +27 -0
- package/dist/docs/development/customization/custom-components/04-javascript-components.md +32 -0
- package/dist/docs/development/customization/custom-components/_category_.json +11 -0
- package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md +45 -0
- package/dist/docs/development/customization/customize-sidebars/01-documentation-sidebar.md +187 -0
- package/dist/docs/development/customization/customize-sidebars/_category_.json +11 -0
- package/dist/docs/development/customization/customize-visualizer/00-visualizer-nodes.md +50 -0
- package/dist/docs/development/customization/customize-visualizer/_category_.json +11 -0
- package/dist/docs/development/deployment/_category_.json +12 -0
- package/dist/docs/development/deployment/build-and-deploy.md +71 -0
- package/dist/docs/development/deployment/build-ssr-mode.md +50 -0
- package/dist/docs/development/deployment/deployment-workflows.md +43 -0
- package/dist/docs/development/deployment/hosting-options.md +112 -0
- package/dist/docs/development/deployment/licenses.md +50 -0
- package/dist/docs/development/design/_category_.json +12 -0
- package/dist/docs/development/design/embed-designs-into-eventcatalog.md +29 -0
- package/dist/docs/development/design/further-reading.md +19 -0
- package/dist/docs/development/design/import-resources.md +27 -0
- package/dist/docs/development/design/intro.md +22 -0
- package/dist/docs/development/developer-tools/_category_.json +12 -0
- package/dist/docs/development/developer-tools/eventcatalog-linter.md +597 -0
- package/dist/docs/development/developer-tools/github-action.md +147 -0
- package/dist/docs/development/developer-tools/llms.txt.md +55 -0
- package/dist/docs/development/developer-tools/schemas.txt.md +42 -0
- package/dist/docs/development/governance/_category_.json +6 -0
- package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +62 -0
- package/dist/docs/development/governance/architecture-change-detection/02-configuration.md +134 -0
- package/dist/docs/development/governance/architecture-change-detection/03-recipes.md +309 -0
- package/dist/docs/development/governance/architecture-change-detection/04-webhooks.md +187 -0
- package/dist/docs/development/governance/architecture-change-detection/05-ci-cd.md +121 -0
- package/dist/docs/development/governance/architecture-change-detection/06-pipeline-gates.md +162 -0
- package/dist/docs/development/governance/architecture-change-detection/_category_.json +6 -0
- package/dist/docs/development/guides/12-customize-your-sidebar.md +12 -0
- package/dist/docs/development/guides/99-adding-analytics.md +138 -0
- package/dist/docs/development/guides/_category_.json +11 -0
- package/dist/docs/development/guides/changelogs/01-introduction.md +33 -0
- package/dist/docs/development/guides/changelogs/02-adding-changelogs.md +94 -0
- package/dist/docs/development/guides/changelogs/03-automated-changelogs.md +44 -0
- package/dist/docs/development/guides/changelogs/_category_.json +11 -0
- package/dist/docs/development/guides/channels/01-introduction.md +111 -0
- package/dist/docs/development/guides/channels/02-adding-channels.md +198 -0
- package/dist/docs/development/guides/channels/04-adding-messages-to-services.md +292 -0
- package/dist/docs/development/guides/channels/09-configuration +39 -0
- package/dist/docs/development/guides/channels/_category_.json +11 -0
- package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md +44 -0
- package/dist/docs/development/guides/channels/ownership-and-components/02-components.md +16 -0
- package/dist/docs/development/guides/channels/ownership-and-components/_category_.json +11 -0
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md +31 -0
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md +56 -0
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/guides/data/01-introduction.md +34 -0
- package/dist/docs/development/guides/data/02-adding-data.md +86 -0
- package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md +73 -0
- package/dist/docs/development/guides/data/_category_.json +11 -0
- package/dist/docs/development/guides/data/ownership-and-components/01-owners.md +45 -0
- package/dist/docs/development/guides/data/ownership-and-components/02-components.md +17 -0
- package/dist/docs/development/guides/data/ownership-and-components/_category_.json +11 -0
- package/dist/docs/development/guides/data/versioning-and-lifecycle/01-versioning.md +32 -0
- package/dist/docs/development/guides/data/versioning-and-lifecycle/02-changelog.md +57 -0
- package/dist/docs/development/guides/data/versioning-and-lifecycle/03-deprecating.md +71 -0
- package/dist/docs/development/guides/data/versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/guides/data-products/01-introduction.md +116 -0
- package/dist/docs/development/guides/data-products/02-adding-data-products.md +157 -0
- package/dist/docs/development/guides/data-products/03-inputs-and-outputs.md +128 -0
- package/dist/docs/development/guides/data-products/04-contracts.md +102 -0
- package/dist/docs/development/guides/data-products/05-versioning.md +240 -0
- package/dist/docs/development/guides/data-products/06-adding-to-domains.md +52 -0
- package/dist/docs/development/guides/data-products/_category_.json +11 -0
- package/dist/docs/development/guides/diagrams/01-introduction.md +78 -0
- package/dist/docs/development/guides/diagrams/02-creating-diagrams.md +195 -0
- package/dist/docs/development/guides/diagrams/03-referencing-diagrams.md +195 -0
- package/dist/docs/development/guides/diagrams/04-versioning-diagrams.md +204 -0
- package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +145 -0
- package/dist/docs/development/guides/diagrams/06-diagrams-with-llms.md +165 -0
- package/dist/docs/development/guides/diagrams/_category_.json +10 -0
- package/dist/docs/development/guides/domains/01-introduction.md +22 -0
- package/dist/docs/development/guides/domains/02-creating-domains/02-adding-domains.md +108 -0
- package/dist/docs/development/guides/domains/02-creating-domains/02a-subdomains.md +84 -0
- package/dist/docs/development/guides/domains/02-creating-domains/03-adding-services-to-domains.md +90 -0
- package/dist/docs/development/guides/domains/02-creating-domains/04-adding-messages-to-domains.md +107 -0
- package/dist/docs/development/guides/domains/02-creating-domains/05-adding-data-products-to-domains.md +105 -0
- package/dist/docs/development/guides/domains/02-creating-domains/_category_.json +11 -0
- package/dist/docs/development/guides/domains/03-ownership-and-language/01-owners.md +36 -0
- package/dist/docs/development/guides/domains/03-ownership-and-language/02-adding-ubiquitous-language.md +75 -0
- package/dist/docs/development/guides/domains/03-ownership-and-language/_category_.json +10 -0
- package/dist/docs/development/guides/domains/04-versioning-and-changelogs/01-versioning.md +40 -0
- package/dist/docs/development/guides/domains/04-versioning-and-changelogs/02-changelog.md +53 -0
- package/dist/docs/development/guides/domains/04-versioning-and-changelogs/_category_.json +10 -0
- package/dist/docs/development/guides/domains/05-entities/01-introduction.md +24 -0
- package/dist/docs/development/guides/domains/05-entities/02-adding-entities.md +157 -0
- package/dist/docs/development/guides/domains/05-entities/03-adding-entities-to-domains.md +30 -0
- package/dist/docs/development/guides/domains/05-entities/04-domain-entity-map.md +134 -0
- package/dist/docs/development/guides/domains/05-entities/_category_.json +11 -0
- package/dist/docs/development/guides/domains/08-domain-integration-map.md +41 -0
- package/dist/docs/development/guides/domains/_category_.json +11 -0
- package/dist/docs/development/guides/flows/01-introduction.md +36 -0
- package/dist/docs/development/guides/flows/02-adding-flows.md +198 -0
- package/dist/docs/development/guides/flows/03-flow-nodes.md +273 -0
- package/dist/docs/development/guides/flows/04-adding-flows-to-services.md +42 -0
- package/dist/docs/development/guides/flows/05-adding-flows-to-domains.md +43 -0
- package/dist/docs/development/guides/flows/06-versioning.md +27 -0
- package/dist/docs/development/guides/flows/07-create-flow-with-ai.md +171 -0
- package/dist/docs/development/guides/flows/_category_.json +11 -0
- package/dist/docs/development/guides/messages/01-overview.md +57 -0
- package/dist/docs/development/guides/messages/_category_.json +11 -0
- package/dist/docs/development/guides/messages/commands/01-introduction.md +26 -0
- package/dist/docs/development/guides/messages/commands/02-adding-commands.md +131 -0
- package/dist/docs/development/guides/messages/commands/_category_.json +11 -0
- package/dist/docs/development/guides/messages/common/01-map-to-producers-and-consumers.md +37 -0
- package/dist/docs/development/guides/messages/common/02-adding-schemas.md +58 -0
- package/dist/docs/development/guides/messages/common/02-deprecating.md +71 -0
- package/dist/docs/development/guides/messages/common/02-draft-messages.md +63 -0
- package/dist/docs/development/guides/messages/common/02-examples.md +99 -0
- package/dist/docs/development/guides/messages/common/03-owners.md +40 -0
- package/dist/docs/development/guides/messages/common/04-versioning.md +27 -0
- package/dist/docs/development/guides/messages/common/05-changelog.md +73 -0
- package/dist/docs/development/guides/messages/common/07-components.md +12 -0
- package/dist/docs/development/guides/messages/common/08-shared-messages-across-boundaries.md +70 -0
- package/dist/docs/development/guides/messages/common/09-grouping-messages.md +98 -0
- package/dist/docs/development/guides/messages/common/_category_.json +11 -0
- package/dist/docs/development/guides/messages/events/01-introduction.md +25 -0
- package/dist/docs/development/guides/messages/events/02-adding-events.md +130 -0
- package/dist/docs/development/guides/messages/events/_category_.json +11 -0
- package/dist/docs/development/guides/messages/queries/01-introduction.md +25 -0
- package/dist/docs/development/guides/messages/queries/02-adding-queries.md +130 -0
- package/dist/docs/development/guides/messages/queries/_category_.json +11 -0
- package/dist/docs/development/guides/owners/_category_.json +11 -0
- package/dist/docs/development/guides/owners/teams/01-introduction.md +21 -0
- package/dist/docs/development/guides/owners/teams/02-adding-teams.md +73 -0
- package/dist/docs/development/guides/owners/teams/_category_.json +11 -0
- package/dist/docs/development/guides/owners/users/01-introduction.md +20 -0
- package/dist/docs/development/guides/owners/users/02-adding-users.md +70 -0
- package/dist/docs/development/guides/owners/users/_category_.json +11 -0
- package/dist/docs/development/guides/schemas/01-introduction.md +64 -0
- package/dist/docs/development/guides/schemas/02-schema-explorer.md +74 -0
- package/dist/docs/development/guides/schemas/03-schema-api.md +59 -0
- package/dist/docs/development/guides/schemas/04-schema-mcp.md +22 -0
- package/dist/docs/development/guides/schemas/05-field-usage.md +120 -0
- package/dist/docs/development/guides/schemas/06-fields-explorer.md +120 -0
- package/dist/docs/development/guides/schemas/_category_.json +11 -0
- package/dist/docs/development/guides/services/01-introduction.md +33 -0
- package/dist/docs/development/guides/services/02-adding-services.md +113 -0
- package/dist/docs/development/guides/services/03-creating-external-systems.md +71 -0
- package/dist/docs/development/guides/services/_category_.json +11 -0
- package/dist/docs/development/guides/services/adding-to-services/01-messages.md +229 -0
- package/dist/docs/development/guides/services/adding-to-services/02-datastores.md +77 -0
- package/dist/docs/development/guides/services/adding-to-services/03-entities.md +47 -0
- package/dist/docs/development/guides/services/adding-to-services/04-openapi.md +97 -0
- package/dist/docs/development/guides/services/adding-to-services/05-asyncapi.md +97 -0
- package/dist/docs/development/guides/services/adding-to-services/06-graphql.md +96 -0
- package/dist/docs/development/guides/services/adding-to-services/_category_.json +10 -0
- package/dist/docs/development/guides/services/ownership-and-components/01-owners.md +41 -0
- package/dist/docs/development/guides/services/ownership-and-components/02-components.md +13 -0
- package/dist/docs/development/guides/services/ownership-and-components/_category_.json +11 -0
- package/dist/docs/development/guides/services/versioning-and-lifecycle/01-versioning.md +27 -0
- package/dist/docs/development/guides/services/versioning-and-lifecycle/02-changelog.md +52 -0
- package/dist/docs/development/guides/services/versioning-and-lifecycle/03-deprecating.md +70 -0
- package/dist/docs/development/guides/services/versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/upgrading/_category_.json +12 -0
- package/dist/docs/development/upgrading/upgrading.md +142 -0
- package/dist/docs/development/upgrading/v2.md +69 -0
- package/dist/docs/development/upgrading/v3.md +277 -0
- package/dist/docs/miro/_category_.json +12 -0
- package/dist/docs/miro/contributing/01-getting-involved.md +53 -0
- package/dist/docs/miro/contributing/_category_.json +11 -0
- package/dist/docs/miro/getting-started/01-overview.md +63 -0
- package/dist/docs/miro/getting-started/02-installation.md +37 -0
- package/dist/docs/miro/getting-started/03-connecting-to-eventcatalog.md +59 -0
- package/dist/docs/miro/getting-started/_category_.json +11 -0
- package/dist/docs/miro/guides/01-adding-resources-to-board.md +90 -0
- package/dist/docs/miro/guides/02-creating-new-resources.md +61 -0
- package/dist/docs/miro/guides/03-editing-resources.md +50 -0
- package/dist/docs/miro/guides/04-connected-resources.md +54 -0
- package/dist/docs/miro/guides/05-services-and-dependencies.md +54 -0
- package/dist/docs/miro/guides/06-navigating-the-board.md +44 -0
- package/dist/docs/miro/guides/07-exporting-to-eventcatalog.md +75 -0
- package/dist/docs/miro/guides/_category_.json +11 -0
- package/dist/docs/miro/specifications/01-asyncapi.md +86 -0
- package/dist/docs/miro/specifications/02-openapi.md +86 -0
- package/dist/docs/miro/specifications/03-schema-registries.md +88 -0
- package/dist/docs/miro/specifications/_category_.json +11 -0
- package/dist/docs/miro/using-ai/01-overview.md +105 -0
- package/dist/docs/miro/using-ai/_category_.json +11 -0
- package/dist/docs/plugins/01-intro.md +49 -0
- package/dist/docs/plugins/02-generators.md +76 -0
- package/dist/docs/plugins/03-all-plugins.md +26 -0
- package/dist/docs/plugins/_category_.json +12 -0
- package/dist/docs/plugins/amazon-apigateway/00-intro.md +75 -0
- package/dist/docs/plugins/amazon-apigateway/01-installation.md +198 -0
- package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +136 -0
- package/dist/docs/plugins/amazon-apigateway/03-features.md +71 -0
- package/dist/docs/plugins/amazon-apigateway/04-examples.md +15 -0
- package/dist/docs/plugins/amazon-apigateway/_category_.json +11 -0
- package/dist/docs/plugins/apicurio/00-intro.md +102 -0
- package/dist/docs/plugins/apicurio/01-installation.md +165 -0
- package/dist/docs/plugins/apicurio/02-plugin-configuration.md +682 -0
- package/dist/docs/plugins/apicurio/03-features.md +221 -0
- package/dist/docs/plugins/apicurio/04-examples.md +20 -0
- package/dist/docs/plugins/apicurio/_category_.json +12 -0
- package/dist/docs/plugins/asyncapi/00-intro.md +81 -0
- package/dist/docs/plugins/asyncapi/01-installation.md +155 -0
- package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +312 -0
- package/dist/docs/plugins/asyncapi/03-features.md +698 -0
- package/dist/docs/plugins/asyncapi/03a-workflows.md +153 -0
- package/dist/docs/plugins/asyncapi/04-examples.md +23 -0
- package/dist/docs/plugins/asyncapi/04-using-reference-objects.md +45 -0
- package/dist/docs/plugins/asyncapi/_category_.json +12 -0
- package/dist/docs/plugins/aws-glue-registry/00-intro.md +104 -0
- package/dist/docs/plugins/aws-glue-registry/00a-installation.md +305 -0
- package/dist/docs/plugins/aws-glue-registry/01-features.md +287 -0
- package/dist/docs/plugins/aws-glue-registry/02-examples.md +368 -0
- package/dist/docs/plugins/aws-glue-registry/03-api.md +282 -0
- package/dist/docs/plugins/aws-glue-registry/_category_.json +11 -0
- package/dist/docs/plugins/azure-schema-registry/00-intro.md +92 -0
- package/dist/docs/plugins/azure-schema-registry/01-installation.md +409 -0
- package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +375 -0
- package/dist/docs/plugins/azure-schema-registry/03-features.md +347 -0
- package/dist/docs/plugins/azure-schema-registry/04-examples.md +378 -0
- package/dist/docs/plugins/azure-schema-registry/_category_.json +12 -0
- package/dist/docs/plugins/backstage/00-intro.md +67 -0
- package/dist/docs/plugins/backstage/01-installation.md +250 -0
- package/dist/docs/plugins/backstage/02-api.md +51 -0
- package/dist/docs/plugins/backstage/03-examples.md +12 -0
- package/dist/docs/plugins/backstage/_category_.json +11 -0
- package/dist/docs/plugins/confluent-schema-registry/00-intro.md +90 -0
- package/dist/docs/plugins/confluent-schema-registry/01-installation.md +223 -0
- package/dist/docs/plugins/confluent-schema-registry/02-plugin-configuration.md +473 -0
- package/dist/docs/plugins/confluent-schema-registry/03-features.md +43 -0
- package/dist/docs/plugins/confluent-schema-registry/04-examples.md +19 -0
- package/dist/docs/plugins/confluent-schema-registry/_category_.json +12 -0
- package/dist/docs/plugins/eventbridge/00-intro.md +55 -0
- package/dist/docs/plugins/eventbridge/00a-installation.md +317 -0
- package/dist/docs/plugins/eventbridge/01-features.md +225 -0
- package/dist/docs/plugins/eventbridge/02-examples.md +17 -0
- package/dist/docs/plugins/eventbridge/03-api.md +441 -0
- package/dist/docs/plugins/eventbridge/03a-workflows.md +133 -0
- package/dist/docs/plugins/eventbridge/_category_.json +11 -0
- package/dist/docs/plugins/eventcatalog-federation/00-introduction.md +69 -0
- package/dist/docs/plugins/eventcatalog-federation/01-installation.md +182 -0
- package/dist/docs/plugins/eventcatalog-federation/02-plugin-configuration.md +208 -0
- package/dist/docs/plugins/eventcatalog-federation/03-examples.md +15 -0
- package/dist/docs/plugins/eventcatalog-federation/04-configuration.md +193 -0
- package/dist/docs/plugins/eventcatalog-federation/05-setup-team-catalog.md +97 -0
- package/dist/docs/plugins/eventcatalog-federation/_category_.json +11 -0
- package/dist/docs/plugins/github/00-intro.md +93 -0
- package/dist/docs/plugins/github/01-installation.md +293 -0
- package/dist/docs/plugins/github/02-plugin-configuration.md +253 -0
- package/dist/docs/plugins/github/03-features.md +42 -0
- package/dist/docs/plugins/github/04-examples.md +17 -0
- package/dist/docs/plugins/github/_category_.json +12 -0
- package/dist/docs/plugins/graphql/00-intro.md +74 -0
- package/dist/docs/plugins/graphql/01-installation.md +144 -0
- package/dist/docs/plugins/graphql/02-plugin-configuration.md +127 -0
- package/dist/docs/plugins/graphql/03-features.md +197 -0
- package/dist/docs/plugins/graphql/04-examples.md +15 -0
- package/dist/docs/plugins/graphql/_category_.json +12 -0
- package/dist/docs/plugins/hookdeck/01-intro.md +152 -0
- package/dist/docs/plugins/hookdeck/02-api.md +133 -0
- package/dist/docs/plugins/hookdeck/03-cli.md +45 -0
- package/dist/docs/plugins/hookdeck/_category_.json +11 -0
- package/dist/docs/plugins/openapi/00-intro.md +78 -0
- package/dist/docs/plugins/openapi/01-installation.md +148 -0
- package/dist/docs/plugins/openapi/02-plugin-configuration.md +332 -0
- package/dist/docs/plugins/openapi/03-features.md +790 -0
- package/dist/docs/plugins/openapi/03a-workflows.md +153 -0
- package/dist/docs/plugins/openapi/04-examples.md +23 -0
- package/dist/docs/plugins/openapi/_category_.json +12 -0
- package/dist/eventcatalog.cjs +434 -35
- package/dist/eventcatalog.config.d.cts +8 -0
- package/dist/eventcatalog.config.d.ts +8 -0
- package/dist/eventcatalog.js +87 -10
- package/dist/features.cjs +6 -0
- package/dist/features.d.cts +2 -1
- package/dist/features.d.ts +2 -1
- package/dist/features.js +3 -1
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/search-indexer.cjs +356 -0
- package/dist/search-indexer.d.cts +30 -0
- package/dist/search-indexer.d.ts +30 -0
- package/dist/search-indexer.js +10 -0
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/eventcatalog/astro.config.mjs +28 -32
- package/eventcatalog/src/components/Search/SearchModal.tsx +248 -148
- package/eventcatalog/src/components/Search/search-utils.spec.ts +138 -1
- package/eventcatalog/src/components/Search/search-utils.ts +271 -0
- package/eventcatalog/src/env.d.ts +1 -0
- package/package.json +4 -3
package/dist/eventcatalog.js
CHANGED
|
@@ -1,34 +1,40 @@
|
|
|
1
|
+
import {
|
|
2
|
+
log_build_default
|
|
3
|
+
} from "./chunk-UJ7DX4SA.js";
|
|
4
|
+
import "./chunk-4UVFXLPI.js";
|
|
1
5
|
import {
|
|
2
6
|
resolve_catalog_dependencies_default
|
|
3
7
|
} from "./chunk-WAJIJEI3.js";
|
|
8
|
+
import {
|
|
9
|
+
buildSearchIndex
|
|
10
|
+
} from "./chunk-D6IBLY3O.js";
|
|
4
11
|
import {
|
|
5
12
|
watch
|
|
6
13
|
} from "./chunk-K3ZVEX2Y.js";
|
|
7
|
-
import {
|
|
8
|
-
log_build_default
|
|
9
|
-
} from "./chunk-DFLUDECO.js";
|
|
10
|
-
import "./chunk-B2LDVIVY.js";
|
|
11
|
-
import "./chunk-4UVFXLPI.js";
|
|
12
14
|
import {
|
|
13
15
|
runMigrations
|
|
14
16
|
} from "./chunk-XUAF2H54.js";
|
|
15
17
|
import "./chunk-CA4U2JP7.js";
|
|
18
|
+
import "./chunk-V22QY5Q3.js";
|
|
16
19
|
import {
|
|
17
20
|
catalogToAstro
|
|
18
21
|
} from "./chunk-YDXB3BD2.js";
|
|
19
22
|
import "./chunk-55D645EH.js";
|
|
20
23
|
import {
|
|
24
|
+
getProjectOutDir,
|
|
25
|
+
isAuthEnabled,
|
|
26
|
+
isIndexedSearchEnabled,
|
|
21
27
|
isOutputServer
|
|
22
|
-
} from "./chunk-
|
|
28
|
+
} from "./chunk-ULZYHF3V.js";
|
|
23
29
|
import {
|
|
24
30
|
generate
|
|
25
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-HDENGAZL.js";
|
|
26
32
|
import {
|
|
27
33
|
logger
|
|
28
|
-
} from "./chunk-
|
|
34
|
+
} from "./chunk-6D65JSOA.js";
|
|
29
35
|
import {
|
|
30
36
|
VERSION
|
|
31
|
-
} from "./chunk-
|
|
37
|
+
} from "./chunk-C7JCOHTI.js";
|
|
32
38
|
import {
|
|
33
39
|
getEventCatalogConfigFile,
|
|
34
40
|
verifyRequiredFieldsAreInCatalogConfigFile
|
|
@@ -678,6 +684,57 @@ var createAstroDevLineFilter = () => {
|
|
|
678
684
|
return shouldFilterAstroLine(line) || line.includes("[router]");
|
|
679
685
|
};
|
|
680
686
|
};
|
|
687
|
+
var buildDevSearchIndex = async ({ config }) => {
|
|
688
|
+
const result = await buildSearchIndex({
|
|
689
|
+
projectDir: dir,
|
|
690
|
+
outDir: path2.join(core, "public"),
|
|
691
|
+
searchOutputPath: path2.join(core, "public", "pagefind"),
|
|
692
|
+
config,
|
|
693
|
+
isServer: false
|
|
694
|
+
});
|
|
695
|
+
logger.info(`Indexed ${result.records} page(s) into ${path2.relative(core, result.outputPath)}`, "search");
|
|
696
|
+
};
|
|
697
|
+
var warnIfIndexedSearchUsesAuth = async () => {
|
|
698
|
+
if (!await isAuthEnabled()) {
|
|
699
|
+
return;
|
|
700
|
+
}
|
|
701
|
+
logger.info(
|
|
702
|
+
"Indexed search creates client-readable search files. Make sure your deployment protects /pagefind assets if your catalog is private.",
|
|
703
|
+
"search"
|
|
704
|
+
);
|
|
705
|
+
};
|
|
706
|
+
var createDevSearchIndexWatcher = ({ config }) => {
|
|
707
|
+
let timeout;
|
|
708
|
+
let isBuilding = false;
|
|
709
|
+
let queued = false;
|
|
710
|
+
const run = async () => {
|
|
711
|
+
if (isBuilding) {
|
|
712
|
+
queued = true;
|
|
713
|
+
return;
|
|
714
|
+
}
|
|
715
|
+
isBuilding = true;
|
|
716
|
+
try {
|
|
717
|
+
await buildDevSearchIndex({ config });
|
|
718
|
+
} catch (err) {
|
|
719
|
+
logger.info(`Failed to rebuild indexed search: ${err.message}`, "search");
|
|
720
|
+
} finally {
|
|
721
|
+
isBuilding = false;
|
|
722
|
+
if (queued) {
|
|
723
|
+
queued = false;
|
|
724
|
+
run();
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
};
|
|
728
|
+
return (_err, events) => {
|
|
729
|
+
if (!events.some((event) => event.path.endsWith(".md") || event.path.endsWith(".mdx"))) {
|
|
730
|
+
return;
|
|
731
|
+
}
|
|
732
|
+
if (timeout) {
|
|
733
|
+
clearTimeout(timeout);
|
|
734
|
+
}
|
|
735
|
+
timeout = setTimeout(run, 500);
|
|
736
|
+
};
|
|
737
|
+
};
|
|
681
738
|
var replaceAstroReadyVersionLine = (line) => {
|
|
682
739
|
const matches = line.match(/^(\s*)astro(\s+)v\S+(\s+ready.*)$/i);
|
|
683
740
|
if (!matches) {
|
|
@@ -823,6 +880,7 @@ program.command("dev").description("Run development server of EventCatalog").opt
|
|
|
823
880
|
await resolve_catalog_dependencies_default(dir, core);
|
|
824
881
|
await runMigrations(dir);
|
|
825
882
|
await catalogToAstro(dir, core);
|
|
883
|
+
const config = await getEventCatalogConfigFile(dir);
|
|
826
884
|
const canEmbedPages = await isFeatureEnabled(
|
|
827
885
|
"@eventcatalog/backstage-plugin-eventcatalog",
|
|
828
886
|
process.env.EVENTCATALOG_LICENSE_KEY_BACKSTAGE
|
|
@@ -842,10 +900,16 @@ program.command("dev").description("Run development server of EventCatalog").opt
|
|
|
842
900
|
logger.info(`Failed to build fields index: ${err.message}`, "fields");
|
|
843
901
|
}
|
|
844
902
|
}
|
|
903
|
+
const shouldBuildIndexedSearch = await isIndexedSearchEnabled();
|
|
904
|
+
if (shouldBuildIndexedSearch) {
|
|
905
|
+
await warnIfIndexedSearchUsesAuth();
|
|
906
|
+
logger.info("Building indexed search for local development...", "search");
|
|
907
|
+
await buildDevSearchIndex({ config });
|
|
908
|
+
}
|
|
845
909
|
checkForUpdate();
|
|
846
910
|
let watchUnsub;
|
|
847
911
|
try {
|
|
848
|
-
watchUnsub = await watch(dir, core);
|
|
912
|
+
watchUnsub = await watch(dir, core, shouldBuildIndexedSearch ? createDevSearchIndexWatcher({ config }) : void 0);
|
|
849
913
|
const args = command.args.join(" ").trim();
|
|
850
914
|
if (options.prewarm) {
|
|
851
915
|
const prewarmPort = await resolveDevPort({
|
|
@@ -929,6 +993,19 @@ program.command("build").description("Run build of EventCatalog").action(async (
|
|
|
929
993
|
},
|
|
930
994
|
shouldFilterLine: createAstroLineFilter()
|
|
931
995
|
});
|
|
996
|
+
if (await isIndexedSearchEnabled()) {
|
|
997
|
+
await warnIfIndexedSearchUsesAuth();
|
|
998
|
+
const config = await getEventCatalogConfigFile(dir);
|
|
999
|
+
const outDir = path2.resolve(dir, await getProjectOutDir());
|
|
1000
|
+
logger.info("Building indexed search...", "search");
|
|
1001
|
+
const result = await buildSearchIndex({
|
|
1002
|
+
projectDir: dir,
|
|
1003
|
+
outDir,
|
|
1004
|
+
config,
|
|
1005
|
+
isServer
|
|
1006
|
+
});
|
|
1007
|
+
logger.info(`Indexed ${result.records} page(s) into ${path2.relative(dir, result.outputPath)}`, "search");
|
|
1008
|
+
}
|
|
932
1009
|
});
|
|
933
1010
|
var previewCatalog = ({
|
|
934
1011
|
command,
|
package/dist/features.cjs
CHANGED
|
@@ -32,6 +32,7 @@ var features_exports = {};
|
|
|
32
32
|
__export(features_exports, {
|
|
33
33
|
getProjectOutDir: () => getProjectOutDir,
|
|
34
34
|
isAuthEnabled: () => isAuthEnabled,
|
|
35
|
+
isIndexedSearchEnabled: () => isIndexedSearchEnabled,
|
|
35
36
|
isOutputServer: () => isOutputServer
|
|
36
37
|
});
|
|
37
38
|
module.exports = __toCommonJS(features_exports);
|
|
@@ -86,6 +87,10 @@ var isOutputServer = async () => {
|
|
|
86
87
|
const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
|
|
87
88
|
return config?.output === "server";
|
|
88
89
|
};
|
|
90
|
+
var isIndexedSearchEnabled = async () => {
|
|
91
|
+
const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
|
|
92
|
+
return config?.search?.type === "indexed";
|
|
93
|
+
};
|
|
89
94
|
var isAuthEnabled = async () => {
|
|
90
95
|
const directory = process.env.PROJECT_DIR || process.cwd();
|
|
91
96
|
const hasAuthConfig = import_node_fs2.default.existsSync((0, import_node_path2.join)(directory, "eventcatalog.auth.js"));
|
|
@@ -95,5 +100,6 @@ var isAuthEnabled = async () => {
|
|
|
95
100
|
0 && (module.exports = {
|
|
96
101
|
getProjectOutDir,
|
|
97
102
|
isAuthEnabled,
|
|
103
|
+
isIndexedSearchEnabled,
|
|
98
104
|
isOutputServer
|
|
99
105
|
});
|
package/dist/features.d.cts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
declare const getProjectOutDir: () => Promise<any>;
|
|
2
2
|
declare const isOutputServer: () => Promise<boolean>;
|
|
3
|
+
declare const isIndexedSearchEnabled: () => Promise<boolean>;
|
|
3
4
|
declare const isAuthEnabled: () => Promise<boolean>;
|
|
4
5
|
|
|
5
|
-
export { getProjectOutDir, isAuthEnabled, isOutputServer };
|
|
6
|
+
export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer };
|
package/dist/features.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
declare const getProjectOutDir: () => Promise<any>;
|
|
2
2
|
declare const isOutputServer: () => Promise<boolean>;
|
|
3
|
+
declare const isIndexedSearchEnabled: () => Promise<boolean>;
|
|
3
4
|
declare const isAuthEnabled: () => Promise<boolean>;
|
|
4
5
|
|
|
5
|
-
export { getProjectOutDir, isAuthEnabled, isOutputServer };
|
|
6
|
+
export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer };
|
package/dist/features.js
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import {
|
|
2
2
|
getProjectOutDir,
|
|
3
3
|
isAuthEnabled,
|
|
4
|
+
isIndexedSearchEnabled,
|
|
4
5
|
isOutputServer
|
|
5
|
-
} from "./chunk-
|
|
6
|
+
} from "./chunk-ULZYHF3V.js";
|
|
6
7
|
import "./chunk-5T63CXKU.js";
|
|
7
8
|
export {
|
|
8
9
|
getProjectOutDir,
|
|
9
10
|
isAuthEnabled,
|
|
11
|
+
isIndexedSearchEnabled,
|
|
10
12
|
isOutputServer
|
|
11
13
|
};
|
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-HDENGAZL.js";
|
|
4
|
+
import "./chunk-6D65JSOA.js";
|
|
5
|
+
import "./chunk-C7JCOHTI.js";
|
|
6
6
|
import "./chunk-5T63CXKU.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
|
@@ -0,0 +1,356 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
|
|
30
|
+
// src/search-indexer.ts
|
|
31
|
+
var search_indexer_exports = {};
|
|
32
|
+
__export(search_indexer_exports, {
|
|
33
|
+
buildSearchIndex: () => buildSearchIndex,
|
|
34
|
+
collectSearchRecords: () => collectSearchRecords,
|
|
35
|
+
markdownToSearchText: () => markdownToSearchText
|
|
36
|
+
});
|
|
37
|
+
module.exports = __toCommonJS(search_indexer_exports);
|
|
38
|
+
var import_promises = __toESM(require("fs/promises"), 1);
|
|
39
|
+
var import_node_path = __toESM(require("path"), 1);
|
|
40
|
+
var import_glob = require("glob");
|
|
41
|
+
var import_gray_matter = __toESM(require("gray-matter"), 1);
|
|
42
|
+
var RESOURCE_COLLECTIONS = {
|
|
43
|
+
channels: { docsPath: "channels", type: "Channel" },
|
|
44
|
+
commands: { docsPath: "commands", type: "Command" },
|
|
45
|
+
containers: { docsPath: "containers", type: "Container" },
|
|
46
|
+
"data-products": { docsPath: "data-products", type: "Data Product" },
|
|
47
|
+
domains: { docsPath: "domains", type: "Domain" },
|
|
48
|
+
entities: { docsPath: "entities", type: "Entity" },
|
|
49
|
+
events: { docsPath: "events", type: "Event" },
|
|
50
|
+
flows: { docsPath: "flows", type: "Flow" },
|
|
51
|
+
queries: { docsPath: "queries", type: "Query" },
|
|
52
|
+
services: { docsPath: "services", type: "Service" },
|
|
53
|
+
subdomains: { docsPath: "domains", type: "Domain" }
|
|
54
|
+
};
|
|
55
|
+
var IGNORED_GLOBS = [
|
|
56
|
+
"**/.git/**",
|
|
57
|
+
"**/.eventcatalog-core/**",
|
|
58
|
+
"**/dist/**",
|
|
59
|
+
"**/node_modules/**",
|
|
60
|
+
"**/public/**",
|
|
61
|
+
"**/snippets/**",
|
|
62
|
+
"**/chat-prompts/**"
|
|
63
|
+
];
|
|
64
|
+
var trimSlashes = (value) => value.replace(/^\/+|\/+$/g, "");
|
|
65
|
+
var normalizePath = (value) => value.replace(/\\/g, "/");
|
|
66
|
+
var removeExtension = (value) => value.replace(/\.(md|mdx)$/i, "");
|
|
67
|
+
var stripNumericPrefix = (value) => value.replace(/^\d+(?:[-_.\s]+)?/, "") || value;
|
|
68
|
+
var normalizeUrlPath = (value) => {
|
|
69
|
+
const withoutIndex = value.replace(/\/index$/i, "");
|
|
70
|
+
return withoutIndex || "";
|
|
71
|
+
};
|
|
72
|
+
var buildUrl = (pathname, config) => {
|
|
73
|
+
const base = config.base ? `/${trimSlashes(config.base)}` : "";
|
|
74
|
+
const cleanPath = `/${trimSlashes(pathname)}`;
|
|
75
|
+
const url = `${base}${cleanPath}`.replace(/\/{2,}/g, "/");
|
|
76
|
+
if (config.trailingSlash === true && !url.endsWith("/")) {
|
|
77
|
+
return `${url}/`;
|
|
78
|
+
}
|
|
79
|
+
return url || "/";
|
|
80
|
+
};
|
|
81
|
+
var valueToSearchText = (value) => {
|
|
82
|
+
if (value === null || value === void 0) return "";
|
|
83
|
+
if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") return String(value);
|
|
84
|
+
if (Array.isArray(value)) return value.map(valueToSearchText).filter(Boolean).join(" ");
|
|
85
|
+
if (typeof value === "object") return Object.values(value).map(valueToSearchText).filter(Boolean).join(" ");
|
|
86
|
+
return "";
|
|
87
|
+
};
|
|
88
|
+
var markdownToSearchText = (content) => {
|
|
89
|
+
return content.replace(/<!--[\s\S]*?-->/g, " ").replace(/^\s*import\s+.*$/gm, " ").replace(/^\s*export\s+.*$/gm, " ").replace(/```[\s\S]*?```/g, (match) => match.replace(/```[a-zA-Z0-9-]*\n?/g, " ").replace(/```/g, " ")).replace(/<([A-Z][A-Za-z0-9.]*)\b([^>]*)\/?>/g, (_match, _component, attributes) => {
|
|
90
|
+
const quotedValues = [...String(attributes).matchAll(/(?:title|label|description|alt|summary)=["'`]([^"'`]+)["'`]/g)];
|
|
91
|
+
return quotedValues.map((entry) => entry[1]).join(" ");
|
|
92
|
+
}).replace(/<\/?[A-Za-z][^>]*>/g, " ").replace(/\[\[([^|\]]+)\|([^\]]+)\]\]/g, "$2").replace(/\[([^\]]+)\]\([^)]+\)/g, "$1").replace(/[`*_~>#|{}[\]():]/g, " ").replace(/\s+/g, " ").trim();
|
|
93
|
+
};
|
|
94
|
+
var inferDocIdFromFile = (relativePath, frontmatterId) => {
|
|
95
|
+
if (frontmatterId) return frontmatterId;
|
|
96
|
+
const fileName = import_node_path.default.posix.basename(removeExtension(relativePath));
|
|
97
|
+
if (fileName.toLowerCase() === "index") {
|
|
98
|
+
return import_node_path.default.posix.basename(import_node_path.default.posix.dirname(relativePath));
|
|
99
|
+
}
|
|
100
|
+
return stripNumericPrefix(fileName);
|
|
101
|
+
};
|
|
102
|
+
var findResourceSegment = (segments) => {
|
|
103
|
+
let match = null;
|
|
104
|
+
for (let index = 0; index < segments.length - 1; index++) {
|
|
105
|
+
const segment = segments[index];
|
|
106
|
+
if (RESOURCE_COLLECTIONS[segment] && segments[index + 1]) {
|
|
107
|
+
match = { index, segment };
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
return match;
|
|
111
|
+
};
|
|
112
|
+
var readResourceFrontmatter = async (projectDir, resourcePath) => {
|
|
113
|
+
const candidates = [import_node_path.default.join(projectDir, resourcePath, "index.mdx"), import_node_path.default.join(projectDir, resourcePath, "index.md")];
|
|
114
|
+
for (const candidate of candidates) {
|
|
115
|
+
try {
|
|
116
|
+
const file = await import_promises.default.readFile(candidate, "utf8");
|
|
117
|
+
return (0, import_gray_matter.default)(file).data;
|
|
118
|
+
} catch {
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
return {};
|
|
122
|
+
};
|
|
123
|
+
var deriveRecordFromPath = async ({
|
|
124
|
+
projectDir,
|
|
125
|
+
relativePath,
|
|
126
|
+
data,
|
|
127
|
+
config
|
|
128
|
+
}) => {
|
|
129
|
+
const normalizedRelativePath = normalizePath(relativePath);
|
|
130
|
+
const segments = normalizedRelativePath.split("/").filter(Boolean);
|
|
131
|
+
const fileName = segments[segments.length - 1] || "";
|
|
132
|
+
const fileNameWithoutExtension = removeExtension(fileName);
|
|
133
|
+
if (data.hidden === true || data.draft) {
|
|
134
|
+
return null;
|
|
135
|
+
}
|
|
136
|
+
if (segments[0] === "docs") {
|
|
137
|
+
const customPath = normalizeUrlPath(removeExtension(segments.slice(1).join("/")));
|
|
138
|
+
const title = data.title || data.label || import_node_path.default.posix.basename(customPath) || "Custom docs";
|
|
139
|
+
return {
|
|
140
|
+
url: buildUrl(`/docs/custom/${customPath}`, config),
|
|
141
|
+
title,
|
|
142
|
+
summary: data.summary,
|
|
143
|
+
type: "Custom Doc",
|
|
144
|
+
collection: "custom-docs",
|
|
145
|
+
id: customPath
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
if (segments[0] === "users" || segments[0] === "teams") {
|
|
149
|
+
const id = data.id || (fileNameWithoutExtension === "index" ? segments[1] : fileNameWithoutExtension);
|
|
150
|
+
const type = segments[0] === "users" ? "User" : "Team";
|
|
151
|
+
return {
|
|
152
|
+
url: buildUrl(`/docs/${segments[0]}/${id}`, config),
|
|
153
|
+
title: data.name || data.title || id,
|
|
154
|
+
summary: data.summary,
|
|
155
|
+
type,
|
|
156
|
+
collection: segments[0],
|
|
157
|
+
id
|
|
158
|
+
};
|
|
159
|
+
}
|
|
160
|
+
const resourceMatch = findResourceSegment(segments);
|
|
161
|
+
if (!resourceMatch) {
|
|
162
|
+
return null;
|
|
163
|
+
}
|
|
164
|
+
const resourceConfig = RESOURCE_COLLECTIONS[resourceMatch.segment];
|
|
165
|
+
const resourceFolderId = segments[resourceMatch.index + 1];
|
|
166
|
+
const resourcePathSegments = segments.slice(0, resourceMatch.index + 2);
|
|
167
|
+
const versionFromPath = segments[resourceMatch.index + 2] === "versioned" && segments[resourceMatch.index + 3] ? segments[resourceMatch.index + 3] : void 0;
|
|
168
|
+
if (versionFromPath) {
|
|
169
|
+
resourcePathSegments.push("versioned", versionFromPath);
|
|
170
|
+
}
|
|
171
|
+
const resourcePath = resourcePathSegments.join("/");
|
|
172
|
+
const resourceData = fileNameWithoutExtension === "index" ? data : await readResourceFrontmatter(projectDir, resourcePath);
|
|
173
|
+
const resourceId = resourceData.id || data.resourceId || resourceFolderId;
|
|
174
|
+
const resourceVersion = versionFromPath || resourceData.version || data.resourceVersion || data.version;
|
|
175
|
+
if (!resourceVersion) {
|
|
176
|
+
return null;
|
|
177
|
+
}
|
|
178
|
+
if (fileNameWithoutExtension === "index") {
|
|
179
|
+
return {
|
|
180
|
+
url: buildUrl(`/docs/${resourceConfig.docsPath}/${resourceId}/${resourceVersion}`, config),
|
|
181
|
+
title: data.name || data.title || resourceId,
|
|
182
|
+
summary: data.summary,
|
|
183
|
+
type: resourceConfig.type,
|
|
184
|
+
collection: resourceConfig.docsPath,
|
|
185
|
+
id: resourceId,
|
|
186
|
+
version: resourceVersion
|
|
187
|
+
};
|
|
188
|
+
}
|
|
189
|
+
if (fileNameWithoutExtension === "ubiquitous-language") {
|
|
190
|
+
return {
|
|
191
|
+
url: buildUrl(`/docs/${resourceConfig.docsPath}/${resourceId}/language`, config),
|
|
192
|
+
title: data.title || `${resourceData.name || resourceId} ubiquitous language`,
|
|
193
|
+
summary: data.summary,
|
|
194
|
+
type: "Language",
|
|
195
|
+
collection: "language",
|
|
196
|
+
id: resourceId,
|
|
197
|
+
version: resourceVersion
|
|
198
|
+
};
|
|
199
|
+
}
|
|
200
|
+
if (fileNameWithoutExtension === "changelog") {
|
|
201
|
+
return {
|
|
202
|
+
url: buildUrl(`/docs/${resourceConfig.docsPath}/${resourceId}/${resourceVersion}/changelog`, config),
|
|
203
|
+
title: data.title || `${resourceData.name || resourceId} changelog`,
|
|
204
|
+
summary: data.summary,
|
|
205
|
+
type: "Changelog",
|
|
206
|
+
collection: "changelog",
|
|
207
|
+
id: resourceId,
|
|
208
|
+
version: resourceVersion
|
|
209
|
+
};
|
|
210
|
+
}
|
|
211
|
+
const docsIndex = segments.indexOf("docs");
|
|
212
|
+
if (docsIndex > resourceMatch.index) {
|
|
213
|
+
const docType = data.type || segments[docsIndex + 1] || "pages";
|
|
214
|
+
const docId = inferDocIdFromFile(normalizedRelativePath, data.id);
|
|
215
|
+
const title = data.title || stripNumericPrefix(removeExtension(fileName));
|
|
216
|
+
return {
|
|
217
|
+
url: buildUrl(`/docs/${resourceConfig.docsPath}/${resourceId}/${resourceVersion}/${docType}/${docId}`, config),
|
|
218
|
+
title,
|
|
219
|
+
summary: data.summary,
|
|
220
|
+
type: "Resource Doc",
|
|
221
|
+
collection: docType,
|
|
222
|
+
id: docId,
|
|
223
|
+
version: data.version || resourceVersion
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
if (segments[0] === "diagrams") {
|
|
227
|
+
const id = data.id || resourceFolderId;
|
|
228
|
+
const version = data.version || resourceVersion;
|
|
229
|
+
return {
|
|
230
|
+
url: buildUrl(`/diagrams/${id}/${version}`, config),
|
|
231
|
+
title: data.name || data.title || id,
|
|
232
|
+
summary: data.summary,
|
|
233
|
+
type: "Design",
|
|
234
|
+
collection: "diagrams",
|
|
235
|
+
id,
|
|
236
|
+
version
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
return null;
|
|
240
|
+
};
|
|
241
|
+
var collectSearchRecords = async ({
|
|
242
|
+
projectDir,
|
|
243
|
+
config
|
|
244
|
+
}) => {
|
|
245
|
+
const files = await (0, import_glob.glob)("**/*.{md,mdx}", {
|
|
246
|
+
cwd: projectDir,
|
|
247
|
+
absolute: true,
|
|
248
|
+
nodir: true,
|
|
249
|
+
ignore: IGNORED_GLOBS,
|
|
250
|
+
windowsPathsNoEscape: process.platform === "win32"
|
|
251
|
+
});
|
|
252
|
+
const records = await Promise.all(
|
|
253
|
+
files.map(async (file) => {
|
|
254
|
+
const raw = await import_promises.default.readFile(file, "utf8");
|
|
255
|
+
const parsed = (0, import_gray_matter.default)(raw);
|
|
256
|
+
const relativePath = normalizePath(import_node_path.default.relative(projectDir, file));
|
|
257
|
+
const baseRecord = await deriveRecordFromPath({
|
|
258
|
+
projectDir,
|
|
259
|
+
relativePath,
|
|
260
|
+
data: parsed.data,
|
|
261
|
+
config
|
|
262
|
+
});
|
|
263
|
+
if (!baseRecord) {
|
|
264
|
+
return null;
|
|
265
|
+
}
|
|
266
|
+
const frontmatterText = valueToSearchText({
|
|
267
|
+
id: baseRecord.id,
|
|
268
|
+
title: baseRecord.title,
|
|
269
|
+
summary: baseRecord.summary,
|
|
270
|
+
version: baseRecord.version,
|
|
271
|
+
owners: parsed.data.owners,
|
|
272
|
+
badges: parsed.data.badges
|
|
273
|
+
});
|
|
274
|
+
const content = [frontmatterText, markdownToSearchText(parsed.content)].filter(Boolean).join("\n\n");
|
|
275
|
+
if (!content.trim()) {
|
|
276
|
+
return null;
|
|
277
|
+
}
|
|
278
|
+
return {
|
|
279
|
+
...baseRecord,
|
|
280
|
+
content
|
|
281
|
+
};
|
|
282
|
+
})
|
|
283
|
+
);
|
|
284
|
+
const uniqueRecords = /* @__PURE__ */ new Map();
|
|
285
|
+
for (const record of records) {
|
|
286
|
+
if (!record) continue;
|
|
287
|
+
uniqueRecords.set(record.url, record);
|
|
288
|
+
}
|
|
289
|
+
return [...uniqueRecords.values()].sort((a, b) => a.url.localeCompare(b.url));
|
|
290
|
+
};
|
|
291
|
+
var getSearchOutputPath = ({
|
|
292
|
+
outDir,
|
|
293
|
+
isServer,
|
|
294
|
+
searchOutputPath
|
|
295
|
+
}) => {
|
|
296
|
+
if (searchOutputPath) {
|
|
297
|
+
return searchOutputPath;
|
|
298
|
+
}
|
|
299
|
+
return import_node_path.default.join(outDir, isServer ? "client" : "", "pagefind");
|
|
300
|
+
};
|
|
301
|
+
var buildSearchIndex = async ({ projectDir, outDir, config, isServer, searchOutputPath }) => {
|
|
302
|
+
const records = await collectSearchRecords({ projectDir, config });
|
|
303
|
+
if (records.length === 0) {
|
|
304
|
+
throw new Error("No searchable Markdown or MDX content was found.");
|
|
305
|
+
}
|
|
306
|
+
const pagefind = await import("pagefind");
|
|
307
|
+
const { index } = await pagefind.createIndex({
|
|
308
|
+
keepIndexUrl: false,
|
|
309
|
+
writePlayground: false
|
|
310
|
+
});
|
|
311
|
+
const errors = [];
|
|
312
|
+
for (const record of records) {
|
|
313
|
+
const result = await index.addCustomRecord({
|
|
314
|
+
url: record.url,
|
|
315
|
+
content: record.content,
|
|
316
|
+
language: "en",
|
|
317
|
+
meta: {
|
|
318
|
+
title: record.title,
|
|
319
|
+
summary: record.summary || "",
|
|
320
|
+
type: record.type,
|
|
321
|
+
collection: record.collection,
|
|
322
|
+
id: record.id || "",
|
|
323
|
+
version: record.version || ""
|
|
324
|
+
},
|
|
325
|
+
filters: {
|
|
326
|
+
type: [record.type],
|
|
327
|
+
collection: [record.collection]
|
|
328
|
+
}
|
|
329
|
+
});
|
|
330
|
+
if (result.errors?.length) {
|
|
331
|
+
errors.push(...result.errors.map((error) => `${record.url}: ${error.message || error}`));
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
const outputPath = getSearchOutputPath({ outDir, isServer, searchOutputPath });
|
|
335
|
+
await import_promises.default.rm(outputPath, { recursive: true, force: true });
|
|
336
|
+
const writeResult = await index.writeFiles({ outputPath });
|
|
337
|
+
if (writeResult.errors?.length) {
|
|
338
|
+
errors.push(...writeResult.errors.map((error) => error.message || String(error)));
|
|
339
|
+
}
|
|
340
|
+
await index.deleteIndex?.();
|
|
341
|
+
await pagefind.close?.();
|
|
342
|
+
if (errors.length > 0) {
|
|
343
|
+
throw new Error(`Failed to build indexed search:
|
|
344
|
+
${errors.join("\n")}`);
|
|
345
|
+
}
|
|
346
|
+
return {
|
|
347
|
+
records: records.length,
|
|
348
|
+
outputPath
|
|
349
|
+
};
|
|
350
|
+
};
|
|
351
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
352
|
+
0 && (module.exports = {
|
|
353
|
+
buildSearchIndex,
|
|
354
|
+
collectSearchRecords,
|
|
355
|
+
markdownToSearchText
|
|
356
|
+
});
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Config } from './eventcatalog.config.cjs';
|
|
2
|
+
|
|
3
|
+
type SearchRecord = {
|
|
4
|
+
url: string;
|
|
5
|
+
title: string;
|
|
6
|
+
content: string;
|
|
7
|
+
type: string;
|
|
8
|
+
collection: string;
|
|
9
|
+
id?: string;
|
|
10
|
+
version?: string;
|
|
11
|
+
summary?: string;
|
|
12
|
+
};
|
|
13
|
+
type BuildSearchIndexOptions = {
|
|
14
|
+
projectDir: string;
|
|
15
|
+
outDir: string;
|
|
16
|
+
config: Config;
|
|
17
|
+
isServer: boolean;
|
|
18
|
+
searchOutputPath?: string;
|
|
19
|
+
};
|
|
20
|
+
declare const markdownToSearchText: (content: string) => string;
|
|
21
|
+
declare const collectSearchRecords: ({ projectDir, config, }: {
|
|
22
|
+
projectDir: string;
|
|
23
|
+
config: Config;
|
|
24
|
+
}) => Promise<SearchRecord[]>;
|
|
25
|
+
declare const buildSearchIndex: ({ projectDir, outDir, config, isServer, searchOutputPath }: BuildSearchIndexOptions) => Promise<{
|
|
26
|
+
records: number;
|
|
27
|
+
outputPath: string;
|
|
28
|
+
}>;
|
|
29
|
+
|
|
30
|
+
export { buildSearchIndex, collectSearchRecords, markdownToSearchText };
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Config } from './eventcatalog.config.js';
|
|
2
|
+
|
|
3
|
+
type SearchRecord = {
|
|
4
|
+
url: string;
|
|
5
|
+
title: string;
|
|
6
|
+
content: string;
|
|
7
|
+
type: string;
|
|
8
|
+
collection: string;
|
|
9
|
+
id?: string;
|
|
10
|
+
version?: string;
|
|
11
|
+
summary?: string;
|
|
12
|
+
};
|
|
13
|
+
type BuildSearchIndexOptions = {
|
|
14
|
+
projectDir: string;
|
|
15
|
+
outDir: string;
|
|
16
|
+
config: Config;
|
|
17
|
+
isServer: boolean;
|
|
18
|
+
searchOutputPath?: string;
|
|
19
|
+
};
|
|
20
|
+
declare const markdownToSearchText: (content: string) => string;
|
|
21
|
+
declare const collectSearchRecords: ({ projectDir, config, }: {
|
|
22
|
+
projectDir: string;
|
|
23
|
+
config: Config;
|
|
24
|
+
}) => Promise<SearchRecord[]>;
|
|
25
|
+
declare const buildSearchIndex: ({ projectDir, outDir, config, isServer, searchOutputPath }: BuildSearchIndexOptions) => Promise<{
|
|
26
|
+
records: number;
|
|
27
|
+
outputPath: string;
|
|
28
|
+
}>;
|
|
29
|
+
|
|
30
|
+
export { buildSearchIndex, collectSearchRecords, markdownToSearchText };
|