@pixel-brewery/archipel-platform-reporting
Classes
| Class | Description |
|---|---|
| ReportingContributorRegistry | Registry responsible for tracking feature-provided reporting contributors. |
| ReportingDatasetNotFoundError | Error thrown when a dataset definition could not be resolved. |
| ReportingExecutionError | Error thrown when a reporting query execution fails unexpectedly. |
| ReportingFacade | Facade orchestrating dataset resolution and query execution for reporting consumers. |
| ReportingModule | Global module providing the reporting facade and contributor registry. |
| ReportingQueryValidationError | Error thrown when a reporting query contains invalid filter or sort fields. |
Interfaces
| Interface | Description |
|---|---|
| IReportingContributor | Describes a feature-level contributor that exposes reporting datasets. |
| IReportingDataset | Represents a dataset definition that can be consumed through the reporting API. |
| IReportingDatasetField | Describes a single field inside a reporting dataset. |
| IReportingQuery | Represents an execution request for a dataset query. |
| IReportingQueryFilter | Describes a single filter applied to a dataset query execution. |
| IReportingQueryResult | Represents the result of a dataset query execution. |
| IReportingQuerySort | Represents a sorting instruction for a dataset query. |
Type Aliases
| Type Alias | Description |
|---|---|
| ReportingFieldType | - |
| ReportingFilterOperator | - |
| ReportingQueryResultRow | Represents a single row returned by a reporting dataset. |
Variables
| Variable | Description |
|---|---|
| ReportingFieldTypes | Enumerates the supported field data types for reporting datasets. |
| ReportingFilterOperators | Enumerates supported filter operators for dataset queries. |