Skip to content
@archipel/platform-reporting Auto-generated

@breadstone/archipel-platform-reporting

Classes

ClassDescription
ReportingContributorRegistryRegistry responsible for tracking feature-provided reporting contributors.
ReportingDatasetNotFoundErrorError thrown when a dataset definition could not be resolved.
ReportingFacadeFacade orchestrating dataset resolution and query execution for reporting consumers.
ReportingModuleGlobal module providing the reporting facade and contributor registry.

Interfaces

InterfaceDescription
IReportingContributorDescribes a feature-level contributor that exposes reporting datasets.
IReportingDatasetRepresents a dataset definition that can be consumed through the reporting API.
IReportingDatasetFieldDescribes a single field inside a reporting dataset.
IReportingQueryRepresents an execution request for a dataset query.
IReportingQueryFilterDescribes a single filter applied to a dataset query execution.
IReportingQueryResultRepresents the result of a dataset query execution.
IReportingQuerySortRepresents a sorting instruction for a dataset query.

Type Aliases

Type AliasDescription
ReportingFieldType-
ReportingFilterOperator-
ReportingQueryResultRowRepresents a single row returned by a reporting dataset.

Variables

VariableDescription
ReportingFieldTypesEnumerates the supported field data types for reporting datasets.
ReportingFilterOperatorsEnumerates supported filter operators for dataset queries.

Released under the MIT License.