@olympeio/runtime-node 9.3.0 → 9.4.0

package/types/runtime.d.ts

@@ -3,8 +3,7 @@
 // **********************************
 // @ts-ignore
 import Observable from 'rxjs';
-import {CloudObject, Context, Property} from "./base";
-import {Entry} from "./legacy";
+import {CloudObject, Context, Property, Tag} from "./base";
 
 /**
  * Label of global properties used by convention through bricks and applications.
@@ -15,7 +14,7 @@ import {Entry} from "./legacy";
  * The brick "Begin Transaction" push a transaction inside the context so it can be reused by other bricks before the "End Transaction" brick.
  */
 export enum GlobalProperties {
-    EDITION_MODE = '__editionMode',
+    EDITION = '__editionMode',
     PRODUCTION = '__production',
     TRANSACTION = '__transaction'
 }
@@ -165,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.
@@ -285,4 +286,3 @@ export abstract class VisualBrick extends Brick {
      */
     protected draw($: BrickContext, domElement: Element);
 }
-

package/types/utils.d.ts

@@ -129,6 +129,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.
  */
@@ -166,18 +180,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 +201,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,12 +254,14 @@ 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;