docs: rename product references to Heimdall

Author: argahsuknesib

README.md

@@ -1,8 +1,8 @@
-# Solid Stream Aggregator
+# Heimdall
 
-<img src="./solid-stream-aggregator.webp" alt="Logo" width="150">
+<img src="./heimdall.webp" alt="Logo" width="150">
 
-The Solid Stream Aggregator is a service which can be used on top of one or multiple Solid Pods and constructs a materialized view on top of the stream measurements stored in the Solid Pod. The Solid Stream Aggregator currently functions under the assumptions that the Solid Pod uses the [LDES in LDP](https://woutslabbinck.github.io/LDESinLDP/) specification to store the stream measrements. The aggregated results are sent to the client requesting the data, as well as the materialized view was published to the Solid Stream Aggregator's Solid Pod for further re-use by other clients, and processes which have similar requirements of the aggregated results.
+Heimdall, a Solid Stream Analytics Service, can be used on top of one or multiple Solid Pods and constructs a materialized view on top of the stream measurements stored in the Solid Pod. Heimdall currently functions under the assumption that the Solid Pod uses the [LDES in LDP](https://woutslabbinck.github.io/LDESinLDP/) specification to store the stream measurements. The aggregated results are sent to the client requesting the data, and the materialized view is published to Heimdall's Solid Pod for further reuse by other clients and processes with similar aggregated-result requirements.
 
 ## Requirements 
 
@@ -12,39 +12,39 @@ The Solid Stream Aggregator is a service which can be used on top of one or mult
 
 ## Configuration of the Solid Pod
 
-- We are under the assumption that the client queries the solid pod using the solid stream aggregator, however the client does not know the location of the LDES Stream by default. 
-We employ [Type Indexes](https://solid.github.io/type-indexes/) to store the location of one or more LDES streams. When querying the Solid Pod, the aggregator first queries the Type Index to get the location of the LDES stream and then retrieves the LDES stream to get the sensor events.
+- We are under the assumption that the client queries the Solid Pod using Heimdall, but the client does not know the location of the LDES stream by default.
+We employ [Type Indexes](https://solid.github.io/type-indexes/) to store the location of one or more LDES streams. When querying the Solid Pod, Heimdall first queries the Type Index to get the location of the LDES stream and then retrieves the LDES stream to get the sensor events.
 
 ## Installation
 
 - Clone the repository
 - Install the dependencies using `npm install`
-- Start the Solid Stream Aggregator's Solid Pod with the command
+- Start Heimdall's Solid Pod with the command
 ```bash
 npm run start-solid-server
 ``` 
-The command will start a Solid Server on the port 3000 with a Solid Pod named `aggregation_pod` which can be accessed at `http://localhost:3000/aggregation_pod/`. The aggregation results are stored in the aggregator's Solid Pod in form of the LDES stream using the [LDES in LDP](https://woutslabbinck.github.io/LDESinLDP/) specification.
-- Create a folder and a file named `logs/aggregation.log` in the root directory of the project. The logs of the Solid Stream Aggregator are stored in this file.
-- Now, start the Solid Stream Aggregator with the command
+The command will start a Solid Server on the port 3000 with a Solid Pod named `aggregation_pod` which can be accessed at `http://localhost:3000/aggregation_pod/`. The aggregation results are stored in Heimdall's Solid Pod in the form of an LDES stream using the [LDES in LDP](https://woutslabbinck.github.io/LDESinLDP/) specification.
+- Create a folder and a file named `logs/aggregation.log` in the root directory of the project. Heimdall stores its logs in this file.
+- Now, start Heimdall with the command
 ```bash
 npm run start aggregation 
 ```
-The command will start the Solid Stream Aggregator on the port 8080. The Solid Stream Aggregator exposes a HTTP as well as a WebSocket server at the port 8080 where the client can send a request for aggregated results from a Solid Pod.
+The command will start Heimdall on port 8080. Heimdall exposes both an HTTP server and a WebSocket server on port 8080 where the client can send a request for aggregated results from a Solid Pod.
 
-- The protocol to communicate to the Solid Stream Aggregator is by sending a RSP-QL query to the Aggregator.
+- The protocol to communicate with Heimdall is by sending a RSP-QL query to the service.
 ```ts
 let message = {
-    // The query to be sent to the Solid Stream Aggregator (RSP-QL query)
+    // The query to be sent to Heimdall (RSP-QL query)
     query: `INSERT YOUR QUERY HERE`,
     // The type of mointoring query can be either, `historical+live` or `live`
     type: `INSERT YOUR TYPE HERE`
 }
 ```
-and send this message object to the aggregator using the WebSocket connection.
+and send this message object to Heimdall using the WebSocket connection.
 
 ## Tests
 
-The tests for the Solid Stream Aggregator are written using the Jest framework. The coverage isn't 100% yet, but will be done in the recent future.
+The tests for Heimdall are written using the Jest framework. Coverage is not yet 100%.
 
 ## Linting
 

src/service/publishing-stream-to-pod/QueryAnnotationPublishing.ts

@@ -15,7 +15,7 @@ const ldfetch = require('ldfetch');
 const fetch = new ldfetch({});
 /**
  * The QueryAnnotationPublishing class is responsible for publishing the generated aggregation events from the RSP Engine with the
- * Function Ontology Metadata to the LDP container in a LDES in LDP fashion to the Solid Pod of the Aggregator. The aggregator's Solid Pod stores the materialized results.
+ * Function Ontology Metadata to the LDP container in a LDES in LDP fashion to Heimdall's Solid Pod. Heimdall's Solid Pod stores the materialized results.
  * @class QueryAnnotationPublishing
  */
 export class QueryAnnotationPublishing {
@@ -36,8 +36,8 @@ export class QueryAnnotationPublishing {
 
     /**
      * Published the generated aggregation events from the RSP Engine with the
-     * Function Ontology Metadata to the LDP container in a LDES in LDP fashion to the
-     * Solid Pod of the Aggregator. The aggregator's Solid Pod stores the materialized results
+     * Function Ontology Metadata to the LDP container in a LDES in LDP fashion to
+     * Heimdall's Solid Pod. Heimdall's Solid Pod stores the materialized results
      * Which can be used, and reused by other query processes.
      * @param {string} query - The RSPQL query.
      * @param {string} ldes_in_ldp_url - The URL of the LDES in LDP inside the Solid Pod.
@@ -216,4 +216,4 @@ export class QueryAnnotationPublishing {
  */
 export function patchSparqlUpdateDelete(store: Store): string {
     return `DELETE DATA {${storeToString(store)}}`
-}
+}