@olympeio/runtime-node 9.4.0 → 9.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.4.0",
+  "version": "9.4.2",
   "description": "Olympe Node Runtime Environment",
   "types": "types/index.d.ts",
   "dependencies": {
@@ -8,7 +8,7 @@
     "bufferutil": "~4.0.7",
     "utf-8-validate": "~5.0.10",
     "lowdb": "~1.0.0",
-    "rxjs": "7.8.0",
+    "rxjs": "7.8.1",
     "fastify": "~3.29.4",
     "@fastify/cors": "~7.0.0"
   },

package/types/cloud.d.ts

@@ -1013,13 +1013,13 @@ export class Query<T extends CloudObject, R> {
      *
      * Example:
      * const people = [
-     *   { name: "Alice", children: ["Bob", "Carol"], siblings: ["David"] },
-     *   { name: "Bob", children: ["Emily"], siblings: ["Alice", "Carol", "David"] },
-     *   { name: "Carol", children: ["Frank"], siblings: ["Alice", "Bob", "David"] },
-     *   { name: "David", children: ["Greg"], siblings: ["Alice", "Bob", "Carol"] },
-     *   { name: "Emily", children: [], siblings: [] },
-     *   { name: "Frank", children: [], siblings: [] },
-     *   { name: "Greg", children: [], siblings: [] }
+     *   \{ name: "Alice", children: ["Bob", "Carol"], siblings: ["David"] \},
+     *   \{ name: "Bob", children: ["Emily"], siblings: ["Alice", "Carol", "David"] \},
+     *   \{ name: "Carol", children: ["Frank"], siblings: ["Alice", "Bob", "David"] \},
+     *   \{ name: "David", children: ["Greg"], siblings: ["Alice", "Bob", "Carol"] \},
+     *   \{ name: "Emily", children: [], siblings: [] \},
+     *   \{ name: "Frank", children: [], siblings: [] \},
+     *   \{ name: "Greg", children: [], siblings: [] \}
      * ];
      *
      * // Create a new query starting from Alice
@@ -1032,7 +1032,7 @@ export class Query<T extends CloudObject, R> {
      * const aliceSiblingsQuery = aliceChildrenQuery.back().follow("siblings").andReturn();
      *
      * // Execute the query, the output is:
-     * Output: [ { sibling: 'David', child: 'Bob' }, { sibling: 'David', child: 'Carol' } ]
+     * Output: [ \{ sibling: 'David', child: 'Bob' \}, \{ sibling: 'David', child: 'Carol' \} ]
      * @param times
      * @return {!Query}
      */

package/types/utils.d.ts

@@ -78,6 +78,17 @@ export class ErrorFlow {
     getCode(): number;
 }
 
+/**
+ * Types of requests that can be received in a Service.
+ * This is used to know what method call on the request to answer the requester.
+ */
+export type ServiceRequestType = {
+    PUBLISH,
+    SEND,
+    GET,
+    SUBSCRIBE
+};
+
 /**
  * A request consumed by a service.
  */
@@ -90,6 +101,13 @@ export class ServiceRequest {
      */
     userTag(): Promise<string>;
 
+    /**
+     * Return the type of this Service Request
+     *
+     * @return the type of this request.
+     */
+    requestType(): ServiceRequestType;
+
     /**
      * Get the request body.
      *
@@ -114,11 +132,13 @@ export class ServiceRequest {
 
     /**
      * Send the topic where the requester should listen to get notifications. Used for OBSERVE requests.
+     * The string returned by the Promise is the id of that subscription. It can be used in parallel with
+     * the {@apilink Service.setUnsubscriptionHandler} method of the service to execute instructions when a subscription is removed.
      *
      * @param topic the topic where the client should
-     * @return a Promise that completes once the reply is sent
+     * @return a Promise that completes once the consumer has started to the listen to notifications. The
      */
-    notifyOn(topic: string): Promise<void>;
+    notifyOn(topic: string): Promise<string>;
 
     /**
      * Reply to the request with and error.
@@ -162,6 +182,16 @@ export class Service {
      */
     listen(): Observable<ServiceRequest>;
 
+    /**
+     * Set a function to be executed each time a subscription to that service is closed.
+     * The function receives the subscription id that has been closed.
+     * The subscription id is the one that has been set and returned by the {@apilink ServiceRequest.notifyOn} method.
+     *
+     * @param handler the handler function to be executed when a subscription is closed.
+     * @return this Service instance.
+     */
+    setUnsubscriptionHandler(handler: (subId: string) => void): this
+
     /**
      * Stop the service.
      */
@@ -266,6 +296,13 @@ export class Auth {
      */
     static getIDPToken(): string;
 
+    /**
+     * Refresh the expiration time for the current authentication token
+     *
+     * @return Promise success when the refresh is done
+     */
+    static refreshToken(): Promise<void>;
+
     /**
      * Returns an `Observable` that is updated each time the user tag changes.
      * @param context The brick context