Skip to main content

@backstage/plugin-tech-insights-node

Home > @backstage/plugin-tech-insights-node

Interfaces

InterfaceDescription
FactChecker

FactChecker interface

A generic interface that can be implemented to create checkers for specific check and check return types. This is used especially when creating Scorecards and displaying results of rules when run against facts.

FactCheckerFactoryA factory wrapper to construct FactChecker implementations.
FactRetrieverFactRetriever interface
FactRetrieverRegistry
TechInsightCheckGeneric definition of a check for Tech Insights
TechInsightCheckRegistryRegistry containing checks for tech insights.
TechInsightsFactCheckerFactoryExtensionPoint
TechInsightsFactRetrieverRegistryExtensionPoint
TechInsightsFactRetrieversExtensionPoint
TechInsightsPersistenceContextExtensionPoint
TechInsightsStoreTechInsights Database

Variables

VariableDescription
techInsightsFactCheckerFactoryExtensionPointAn extension point that allows other plugins or modules to set a FactCheckerFactory.
techInsightsFactRetrieverRegistryExtensionPointAn extension point that allows other plugins or modules to set a custom FactRetrieverRegistry.
techInsightsFactRetrieversExtensionPointAn extension point that allows other plugins or modules to add fact retrievers.
techInsightsPersistenceContextExtensionPointAn extension point that allows other plugins or modules to set a custom PersistenceContext.

Type Aliases

Type AliasDescription
CheckValidationResponse

Validation response from CheckValidator

May contain additional data for display purposes

FactLifecycleA fact lifecycle definition. Determines which strategy to use to purge expired facts from the database.
FactRetrieverContextFactRetrieverContext injected into individual handler methods of FactRetriever implementations. The context can be used to construct logic to retrieve entities, contact integration points and fetch and calculate fact values from external sources.
FactRetrieverRegistrationRegistration of a fact retriever Used to add and schedule individual fact retrievers to the fact retriever engine.
FactSchemaDefinitionA flat serializable structure for Facts. Containing information about fact schema, version, id, and entity filters
FlatTechInsightFactResponse type used when returning from database and API. Adds a field for ref for easier usage
MaxItemsA maximum number for items to be kept in the database for each fact retriever/entity pair
PersistenceContextA Container for persistence related components in TechInsights
TechInsightFact

A container for facts. The shape of the fact records needs to correspond to the FactSchema with same ref value. Each container contains a reference to an entity which can be a Backstage entity or a generic construct outside of backstage with same shape.

Container may contain multiple individual facts and their values

TTLA Luxon duration like object for time to live value