@sourceloop/reporting-service / Exports

@sourceloop/reporting-service

Table of contents

Namespaces

• ReportingServiceComponentBindings

Classes

• BaseSequelize
• ColumnForDataSourceModel
• CreateDashboardDto
• Dashboard
• DashboardWidget
• DataSet
• DataSetsService
• DataSourcesService
• IngestionMapping
• IngestionMappingsService
• MysqlSequelizeStrategy
• PsqlSequelizeStrategy
• ReportIngestionMessagingService
• ReportingServiceComponent
• StateTracking
• StateTrackingService
• Widget

Interfaces

• CDC
• ColumnEntityPair
• CustomFilter
• CustomTypeConvertor
• DashboardInterface
• DataSetServiceConfig
• DataSourceList
• DataStoreAdapter
• DataStoreDataTypeConversionFunctions
• IngestReportRecord
• IngestionHandler
• PermissionModel
• QueryUtilityInterface
• S3DataStoreConfiguration
• SequelizeDataStoreConfiguration
• StructuredQueryInterface
• WidgetInterface

Type Aliases

• DataStoreConfiguration
• JSONSupportedTypes
• JSONValueType
• WhereClause
• WhereCondition

Functions

• customTypeConversion
• handleRecordType

Type Aliases

DataStoreConfiguration

Ƭ DataStoreConfiguration: SequelizeDataStoreConfiguration | S3DataStoreConfiguration

Defined in

services/reporting-service/src/interfaces/data-store-config.interface.ts:4

---

JSONSupportedTypes

Ƭ JSONSupportedTypes: "string" | "number" | "boolean" | "null" | "array" | "object"

Defined in

services/reporting-service/src/interfaces/json-types.interface.ts:3

---

JSONValueType

Ƭ JSONValueType: string | number | boolean | null | AnyObject[] | Record<string, AnyObject>

Defined in

services/reporting-service/src/interfaces/json-types.interface.ts:10

---

WhereClause

Ƭ WhereClause: Object

Index signature

▪ [field: string]: WhereCondition | (WhereCondition | WhereClause)[] | undefined

Type declaration

Name	Type
and?	(WhereCondition | WhereClause)[]
or?	(WhereCondition | WhereClause)[]

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:10

---

WhereCondition

Ƭ WhereCondition: Object

Type declaration

Name	Type
field	string
operator	Operator
value	string | number

Defined in

services/reporting-service/src/interfaces/structured-query.interface.ts:3

Functions

customTypeConversion

▸ customTypeConversion(convertType): ClassDecorator

The function CustomTypeConverterDecorator creates a decorator for a custom type converter with the specified convertType.

Parameters

Name	Type	Description
convertType	string	The convertType parameter is a string that represents the type that needs to be converted.

Returns

ClassDecorator

a decorator created by the ClassDecoratorFactory.createDecorator method. The decorator is created with the ReportingServiceComponentBindings.CUSTOM_TYPE_CONVERTER_METADATA as the first argument and an object with the convertType property set to the convertType parameter as the second argument.

Defined in

services/reporting-service/src/decorators/custom-type-converter.decorator.ts:14

---

handleRecordType

▸ handleRecordType(recordType): ClassDecorator

The function creates a class decorator factory that binds a record type to a reporting service event listener metadata.

Parameters

Name	Type	Description
recordType	string	The recordType parameter is a string that represents the type of record.

Returns

ClassDecorator

a decorator created by the ClassDecoratorFactory.createDecorator method.

Defined in

services/reporting-service/src/decorators/report-event-listener.decorator.ts:11