@kunickiaj/backstage-plugin-catalog-history-node
v0.5.0
Published
Backend-only contracts and service refs for the Backstage catalog history plugin family.
Maintainers
Readme
@kunickiaj/backstage-plugin-catalog-history-node
Backend-only contracts and service refs for the Backstage catalog history plugin family.
This package owns:
- the
HistoryStorewrite contract and its row/cycle types (EntityRow,CycleInput,CaptureSource); historyStoreServiceRef, the plugin-scoped service ref that backend modules use to obtain a history store through Backstage DI;HistoryQueryService, the backend-only read contract for timelines, cycles, versions, as-of reads, and diffs;InMemoryHistoryStoreandInMemoryHistoryQueryService, test doubles for history integrations, exported from the@kunickiaj/backstage-plugin-catalog-history-node/testUtilssubpath so they stay out of the production contract surface.
Custom store implementations can optionally implement HistoryStore.ensureReady() for schema bootstrap or other startup preparation. Consumers call it before registering capture layers; simple in-memory or always-ready stores can omit it.
CaptureSource and MutationType are aliases of the isomorphic enums in
@kunickiaj/backstage-plugin-catalog-history-common, so backend and frontend code share one
vocabulary.
The default service factories ship with @kunickiaj/backstage-plugin-catalog-history-storage-node.
The 0.2.0 query router and service wiring use the same history storage as the
catalog writer rather than a separate plugin-scoped database.
Frontend packages must not depend on this package.
For architecture and roadmap details, see the workspace README.
