docs(website): report

README.md

@@ -15,7 +15,6 @@ the [revue-sample-thing](https://github.com/revue-org/revue-sample-thing) reposi
 ### Frontend
 
 [![Vue](https://img.shields.io/badge/Vue-4FC08D?style=for-the-badge&logo=vuedotjs&logoColor=white)](https://vuejs.org/)
-[![WebRTC](https://img.shields.io/badge/WebRTC-333333?style=for-the-badge&logo=webrtc&logoColor=white)](https://webrtc.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 
 ### Backend
@@ -35,6 +34,7 @@ the [revue-sample-thing](https://github.com/revue-org/revue-sample-thing) reposi
 [![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://docker.com)
 [![Apache Kafka](https://img.shields.io/badge/Apache_Kafka-231F20?style=for-the-badge&logo=apachekafka&logoColor=white)](https://kafka.apache.org/)
 [![Traefik](https://img.shields.io/badge/Traefik-24A1C1?style=for-the-badge&logo=traefikproxy&logoColor=white)](https://doc.traefik.io/traefik/)
+[![WebRTC](https://img.shields.io/badge/WebRTC-333333?style=for-the-badge&logo=webrtc&logoColor=white)](https://webrtc.org/)
 [![Minikube](https://img.shields.io/badge/Minikube-F7B93E?style=for-the-badge&logo=kubernetes&logoColor=white)](https://minikube.sigs.k8s.io/docs/)
 [![Kubernetes](https://img.shields.io/badge/Kubernetes-326CE5?style=for-the-badge&logo=kubernetes&logoColor=white)](https://kubernetes.io/)
 [![Helm](https://img.shields.io/badge/Helm-0F1689?style=for-the-badge&logo=helm&logoColor=white)](https://helm.sh/)
@@ -59,8 +59,7 @@ the [revue-sample-thing](https://github.com/revue-org/revue-sample-thing) reposi
 ## Prerequisites
 
 - [Docker](https://docker.com) (for development mode)
-- [Minikube](https://minikube.sigs.k8s.io/docs/), [Kubectl](https://kubernetes.io/docs/tasks/tools/)
-  and [Helm](https://helm.sh/) (for production mode)
+- [Kubectl](https://kubernetes.io/docs/tasks/tools/) and [Helm](https://helm.sh/) (for production mode)
 
 ## Getting Started
 

device/src/domain/factories/CapabilityFactory.ts

@@ -1,6 +1,7 @@
 import { CapabilityType } from '@/domain/core/capabilities/CapabilityType.js'
 import { Measure } from '@common/domain/core/Measure.js'
 import { SensoringCapability } from '@/domain/core/capabilities/SensoringCapability.js'
+import { VideoStreamingCapability } from '@/domain/core/capabilities/VideoStreamingCapability.js'
 
 export class CapabilityFactory {
   static sensoringCapabilityOf(capturingInterval: number, measure: Measure): SensoringCapability {
@@ -11,7 +12,7 @@ export class CapabilityFactory {
     }
   }
 
-  static videoStreamingCapabilityOf(resolution: '576p' | '720p' | '1080p' | '4k') {
+  static videoStreamingCapabilityOf(resolution: '576p' | '720p' | '1080p' | '4k'): VideoStreamingCapability {
     return {
       type: CapabilityType.VIDEO,
       resolution

docs/uml/domain/bounded-context/new/Alarm.puml

@@ -0,0 +1,111 @@
+@startuml
+
+interface DomainEvent
+
+interface AlarmEventsHub {
+  +publishAnomaly(anomaly: Anomaly): void
+  +subscribeToMeasurements(handler: Runnable): void
+  +subscribeToDetections(handler: Runnable)): void
+  +addMeasurementTopics(topics: string[]): void
+  +removeMeasurementTopics(topics: string[]): void
+  +subscribeToDevices(handler: Runnable): void
+}
+note left of AlarmEventsHub : Service
+AlarmEventsHub -right-> SecurityRule : uses
+AlarmEventsHub --> DomainEvent : uses
+note right of DomainEvent : Anomaly,\nDeviceEvent,\nDetection,\nMeasurement
+
+
+
+interface AlarmService {
+  +getSecurityRuleById(id: SecurityRuleId): SecurityRule
+  +getRangeRules(): RangeRule[]
+  +getIntrusionRules(): IntrusionRule[]
+  +createRangeRule(...): SecurityRuleId
+  +createIntrusionRule(...): SecurityRuleId
+  +updateRangeRule(...): void
+  +updateIntrusionRule(...): void
+  +enableSecurityRule(id: SecurityRuleId): void
+  +disableSecurityRule(id: SecurityRuleId): void
+  +deleteSecurityRule(id: SecurityRuleId): void
+  +getSecurityRuleContacts(id: SecurityRuleId): Contact[]
+}
+note top of AlarmService : Service
+
+
+AlarmService -left-> SecurityRuleRepository : uses
+AlarmService --> SecurityRuleFactory : uses
+
+interface SecurityRuleRepository {
+  getSecurityRules(): SecurityRule[]
+  getSecurityRuleById(id: SecurityRuleId): SecurityRule
+  saveSecurityRule(securityRule: SecurityRule): void
+  updateSecurityRule(securityRule: SecurityRule): void
+  removeSecurityRule(securityRuleId: SecurityRuleId): void
+  getRangeRules(): RangeRule[]
+  getIntrusionRules(): IntrusionRule[]
+  enableSecurityRule(securityRuleId: SecurityRuleId): void
+  disableSecurityRule(securityRuleId: SecurityRuleId): void
+}
+note top of SecurityRuleRepository : Repository
+
+
+interface SecurityRuleId {
+  + value: string
+}
+
+interface SecurityRule {
+  + type: SecurityRuleType
+  + id: SecurityRuleId
+  + creatorId: string
+  + activeOn: string
+  + description: string
+  + contacts: Contact[]
+  + enabled: boolean
+  + validity: TimeSlot
+}
+
+note left of SecurityRule : Entity
+
+SecurityRuleRepository --> SecurityRule: uses
+
+interface TimeSlot {
+  + from: Date
+  + to: Date
+}
+note right of TimeSlot : Value Object
+
+interface SecurityRuleFactory {
+  + intrusionRuleOf(...): IntrusionRule
+  + createIntrusionRule(...): IntrusionRule
+  + rangeRuleOf(...): RangeRule
+  + createRangeRule(...): RangeRule
+}
+note right of SecurityRuleFactory : Factory
+
+SecurityRuleFactory -left-> SecurityRule : creates
+SecurityRule *-- SecurityRuleId
+
+interface IntrusionRule {
+  + objectClass: ObjectClass
+}
+IntrusionRule o-- ObjectClass
+
+interface RangeRule {
+  + min: Float
+  + max: Float
+  + measure: Measure
+}
+
+enum ObjectClass {
+  PERSON
+  BICYCLE
+  CAR
+  ...
+}
+
+SecurityRule <|-- RangeRule
+SecurityRule <|-- IntrusionRule
+SecurityRule *-- TimeSlot
+
+@enduml