@olympeio/runtime-node 9.3.1 → 9.4.1

package/types/runtime.d.ts

@@ -164,13 +164,15 @@ export abstract class Brick extends CloudObject {
 
     /**
      * Return the list of inputs tags as an ordered array.
+     * @const
      */
-    readonly getInputs: () => string[];
+    getInputs(): string[];
 
     /**
      * Return the list of outputs tags as an ordered array
+     * @const
      */
-    readonly getOutputs: () => string[];
+    getOutputs(): string[];
 
     /**
      * Run the brick itself using the specified context.
@@ -284,4 +286,3 @@ export abstract class VisualBrick extends Brick {
      */
     protected draw($: BrickContext, domElement: Element);
 }
-

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.
@@ -129,6 +149,20 @@ export class ServiceRequest {
     fail(error: Error): Promise<void>;
 }
 
+interface ServiceConfig {
+    /**
+     * After how much time (in ms) the message must be considered as timeout by the service.
+     */
+    timeout?: number
+}
+
+interface SubscriptionServiceConfig extends ServiceConfig {
+    /**
+     * A callback to be called in case the subscription to the service is re-sent to the service (eg: after a reconnection).
+     */
+    onRetry?: () => void;
+}
+
 /**
  * A service that processes requests coming from other VMs connected to the data cloud.
  */
@@ -148,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.
      */
@@ -166,18 +210,20 @@ export class Service {
      *
      * @param service the service id
      * @param payload the message payload, optional
+     * @param config optional parameters for the message
      * @return a Promise that completes when the call has been executed
      */
-    static send(service: string, payload?: Object): Promise<void>;
+    static send(service: string, payload?: Object, config?: ServiceConfig): Promise<void>;
 
     /**
      * Send a request to a {@apilink Service} and wait for a reply with a payload..
      *
      * @param service the service id
      * @param payload the message payload
+     * @param config optional parameters for the message
      * @return a Promise wrapping the resulting value
      */
-    static get(service: string, payload: Object): Promise<Object>;
+    static get(service: string, payload: Object, config?: ServiceConfig): Promise<Object>;
 
     /**
      * Send a request to a {@apilink Service} and subscribe to notifications published from that service.
@@ -185,17 +231,43 @@ export class Service {
      * @param service the service id
      * @param context the context used to link its lifecycle to this subscription
      * @param payload the message payload, optional
+     * @param config optional parameters for the message
      * @return an Observable emitting notifications
      */
-    static observe(service: string, context: Context, payload?: Object): Observable<Object>;
+    static observe(service: string, context: Context, payload?: Object, config?: SubscriptionServiceConfig): Observable<Object>;
 }
 
 // -- Authentication --
+
+declare type UserToken = {
+    user: string, // The username
+    userTag: string, // Tag of the User in the datacloud
+    nonce: string, // Nonce that identify the user in the auth service of Olympe
+    protocol: AuthProtocol, // The protocol used to authenticate the user
+    idpName: string, // The name of the IDP used to authenticate the user
+    payload: Object // The raw payload sent by the IDP (ie: JWT for 0Auth2 or SAML response or empty for SP)
+}
+
+declare enum AuthProtocol {
+    SAML = 'saml',
+    OAUTH2 = 'oauth2',
+    SRP = 'srp'
+}
+
 /**
  * A static class that gathers all the required methods to handle the authentication and sessions with Olympe.
  */
 export class Auth {
 
+    /**
+    * Returns the full token of the current user. It contains:
+    * - the username, the unique ID of the user for the IDP used
+    * - the tag of the user in the datacloud
+    * - the protocol and IDP used
+    * - the raw payload sent by the IDP (eg: JWT for OAuth2 or SAML response).
+    */
+    static getUserToken(): UserToken;
+
     /**
      * Based on the username and password, it generates a salt and verifier to configure a SRP user
      *
@@ -212,16 +284,25 @@ export class Auth {
 
     /**
      * Return the token currently used to identify the current session.
+     * @deprecated see {@apilink Auth.getUserToken}
      * @return The current token
      */
     static getToken(): string;
 
     /**
      * Return the IDP token (zipped & base64 encoded XML) for the current user.
+     * @deprecated use {@apilink Auth.getUserToken} instead
      * @return The current IDP token
      */
     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