Interface MonitoringRepository

Repository interface responsible for persisting and retrieving monitoring data.

interface MonitoringRepository {
    deleteHouseholdUserTagFromMeasurements(
        username: HouseholdUserUsername,
    ): Promise<void>;
    deleteZoneIDTagFromMeasurements(zoneID: ZoneID): Promise<void>;
    deleteZoneIDTagFromMeasurements(zoneID: ZoneID): Promise<void>;
    findActiveSmartFurnitureHookups(): Promise<ActiveSmartFurnitureHookup[]>;
    findUtilityConsumptions(
        utilityType: UtilityType,
        filter?: TimeSeriesFilter,
        tagsFilter?: TagsFilter,
    ): Promise<UtilityConsumptionPoint[]>;
    findUtilityMeters(
        filter?: TimeRangeFilter,
        tagsFilter?: TagsFilter,
    ): Promise<UtilityMeters>;
    saveMeasurement(measurement: Measurement): Promise<void>;
}

Implemented by

Index

Methods

deleteHouseholdUserTagFromMeasurements deleteZoneIDTagFromMeasurements findActiveSmartFurnitureHookups findUtilityConsumptions findUtilityMeters saveMeasurement

Methods

deleteHouseholdUserTagFromMeasurements

deleteHouseholdUserTagFromMeasurements(
username: HouseholdUserUsername,
): Promise<void>
Deletes a username tag from all measurements.
Parameters
- username: HouseholdUserUsername
  The household user's username to remove from measurements.
Returns Promise<void>
- Defined in src/domain/ports/MonitoringRepository.ts:29

deleteZoneIDTagFromMeasurements

deleteZoneIDTagFromMeasurements(zoneID: ZoneID): Promise<void>
Deletes a zone id tag from all measurements.
Parameters
- zoneID: ZoneID
  The zone's id to remove from measurements.
Returns Promise<void>
- Defined in src/domain/ports/MonitoringRepository.ts:38
deleteZoneIDTagFromMeasurements(zoneID: ZoneID): Promise<void>
Deletes a zone id tag from all measurements.
Parameters
- zoneID: ZoneID
  The zone's id to remove from measurements.
Returns Promise<void>
- Defined in src/domain/ports/MonitoringRepository.ts:45

findActiveSmartFurnitureHookups

findActiveSmartFurnitureHookups(): Promise<ActiveSmartFurnitureHookup[]>
Finds all currently active smart furniture hookups along with their
- current consumption information.
A smart furniture hookup is considered active if it has produced at least one measurement within a recent time window.
Returns Promise<ActiveSmartFurnitureHookup[]>
A promise resolving to a list of SmartFurnitureHookupID values together with the most recent consumption data.
- Defined in src/domain/ports/MonitoringRepository.ts:57

findUtilityConsumptions

findUtilityConsumptions(
    utilityType: UtilityType,
    filter?: TimeSeriesFilter,
    tagsFilter?: TagsFilter,
): Promise<UtilityConsumptionPoint[]>
Retrieves utility consumption data for a given utility type, optionally filtered by a time-series configuration and by associated tags.
Parameters
- utilityType: UtilityType
  The specific utility type for which consumption is requested.
- Optionalfilter: TimeSeriesFilter
  Optional time-series filter.
- OptionaltagsFilter: TagsFilter
  Optional measurement tags filter.
Returns Promise<UtilityConsumptionPoint[]>
A promise resolving to an array of utility consumption points matching the filters.
- Defined in src/domain/ports/MonitoringRepository.ts:81

findUtilityMeters

findUtilityMeters(
filter?: TimeRangeFilter,
tagsFilter?: TagsFilter,
): Promise<UtilityMeters>
Retrieves utility meter information, optionally filtered by time range and by associated tags.
Parameters
- Optionalfilter: TimeRangeFilter
  Optional time range filter.
- OptionaltagsFilter: TagsFilter
  Optional measurement tags filter.
Returns Promise<UtilityMeters>
A promise resolving to the matching utility meters.
- Defined in src/domain/ports/MonitoringRepository.ts:67

saveMeasurement

saveMeasurement(measurement: Measurement): Promise<void>
Persists a single measurement.
Parameters
- measurement: Measurement
  The measurement to save.
Returns Promise<void>
A promise that resolves once the measurement has been stored.
- Defined in src/domain/ports/MonitoringRepository.ts:22