@olympeio/runtime-node 9.2.2 → 9.3.0

package/types/runtime.d.ts

@@ -25,7 +25,7 @@ export class BrickContext extends Context {
      * Returns a boolean indicating whether a property has a value or not.
      *
      * @param key the property or key string
-     * @param global [=false] whether or not the method checks parent contexts
+     * @param global [=false] whether the method checks parent contexts
      * @return whether `property` has a value or not
      */
     has<T>(key: string | Property<T>, global?: boolean): boolean;
@@ -34,7 +34,7 @@ export class BrickContext extends Context {
      * Return the current value of the specified property. If there is currently no value, return null.
      *
      * @param key the property or key string
-     * @param global [=false] whether or not the method checks parent contexts
+     * @param global [=false] whether the method checks parent contexts
      * @return the current value
      */
     get<T>(key: string | Property<T>, global?: boolean): T | null;
@@ -46,8 +46,8 @@ export class BrickContext extends Context {
      * If `global` is set to TRUE (FALSE by default), it observes values coming from other contexts accessible from the current one.
      *
      * @param key the property or key string
-     * @param waitForValue [=true] whether or not the observable wait for a first value to get a value.
-     * @param global [=false] whether or not listen to a value coming from other contexts.
+     * @param waitForValue [=true] whether the observable should wait for a first value to get a value.
+     * @param global [=false] whether to listen to a value coming from other contexts.
      * @return the observable
      */
     observe<T>(key: string | Property<T>, waitForValue?: boolean, global?: boolean): Observable<T>;
@@ -56,7 +56,7 @@ export class BrickContext extends Context {
      * Wait for the property to get a new value, wrapped in a promise.
      *
      * @param key the property
-     * @param global [=false] whether or not the method checks parent contexts
+     * @param global [=false] whether the method checks parent contexts
      * @return a promise of the next value of property
      */
     waitFor<T>(key: string | Property<T>, global?: boolean): Promise<T>;
@@ -220,13 +220,13 @@ export abstract class Brick extends CloudObject {
     protected destroy($: BrickContext): void;
 
     /**
-     * @deprecated use {@link BrickContext#init} instead
+     * @deprecated use {@apilink Brick.init} instead
      * @param $ the brick context
      */
     protected onInit($: BrickContext): void;
 
     /**
-     * @deprecated use {@link BrickContext#update} instead
+     * @deprecated use {@apilink Brick.update} instead
      * @param $ the brick context
      * @param inputs array of input values
      * @param outputs array of output setter functions.
@@ -234,7 +234,7 @@ export abstract class Brick extends CloudObject {
     protected onUpdate($: BrickContext, inputs: Array<any>, outputs: Array<(value: any) => void>): void;
 
     /**
-     * @deprecated use {@link BrickContext#destroy} instead
+     * @deprecated use {@apilink Brick.destroy} instead
      * @param $ the brick context
      */
     protected onDestroy($: BrickContext): void;
@@ -279,7 +279,7 @@ export abstract class VisualBrick extends Brick {
     /**
      * Called when the DOM Element associated to that brick has been added to the document and is ready to be drawn.
      *
-     * @deprecated override {@link VisualBrick#render} and {@link VisualBrick#updateParent} instead.
+     * @deprecated override {@apilink VisualBrick.render} and {@apilink VisualBrick.updateParent} instead.
      * @param $ the brick context
      * @param domElement the associated DOM Element
      */

package/types/utils.d.ts

@@ -17,6 +17,31 @@ export class Config {
     static getParameter(id: string): unknown | undefined;
 }
 
+// Health check and shutdown
+export class Process {
+
+    /**
+     * Static method to register a callback that is used to check the health status of the process.
+     * This is typically used by kubernetes environment to maintain backend healthy
+     *
+     * The callback must return a Promise which returns a string as valid message.
+     * The process is considered by the runtime as unhealthy if the promise is rejected.
+     *
+     * @param callback the callback executed each time the runtime check the health of the process.
+     */
+    static onHealthCheck(callback: () => Promise<string>): () => void;
+
+    /**
+     * Static method to register a callback called by the runtime when it receives the signal to be terminated.
+     * This is typically used to graceful shutdown some connections or drivers to external processes.
+     *
+     * The callback must return a Promise which is resolved when the shutdown process is done.
+     *
+     * @param callback the callback executed when the runtime terminates.
+     */
+    static onShutdown(callback: () => Promise<void>): () => void;
+}
+
 // -- Primitive types classes --
 export class Color {
     static create(r: number, g: number, b: number, a?: number): Color;
@@ -137,7 +162,7 @@ export class Service {
     static publish(service: string, payload: Object): Promise<void>;
 
     /**
-     * Send a request to a {@link Service} and wait for an ack.
+     * Send a request to a {@apilink Service} and wait for an ack.
      *
      * @param service the service id
      * @param payload the message payload, optional
@@ -146,7 +171,7 @@ export class Service {
     static send(service: string, payload?: Object): Promise<void>;
 
     /**
-     * Send a request to a {@link Service} and wait for a reply with a payload..
+     * 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
@@ -155,7 +180,7 @@ export class Service {
     static get(service: string, payload: Object): Promise<Object>;
 
     /**
-     * Send a request to a {@link Service} and subscribe to notifications published from that service.
+     * Send a request to a {@apilink Service} and subscribe to notifications published from that service.
      *
      * @param service the service id
      * @param context the context used to link its lifecycle to this subscription
@@ -181,27 +206,32 @@ export class Auth {
 
     /**
      * Return the current state of the authentication manager
+     * @return the current state
      */
     static getState(): AuthState;
 
     /**
      * Return the token currently used to identify the current session.
+     * @return The current token
      */
     static getToken(): string;
 
     /**
      * Return the IDP token (zipped & base64 encoded XML) for the current user.
+     * @return The current IDP token
      */
     static getIDPToken(): string;
 
     /**
-     * Returns an Observable that is updated each time the user tag changes.
+     * Returns an `Observable` that is updated each time the user tag changes.
      * @param context The brick context
+     * @return An `Observable`
      */
     static observeUser(context: Context): Observable<string>
 
     /**
      * Return the tag of the current authenticated user.
+     * @return The tag of the current user
      */
     static getCurrentUser(): string
 
@@ -240,7 +270,7 @@ export class Auth {
      * Try to login using SAML protocol with the specified username and password.
      * Returns a promise resolved when logged in or that catches an error if refused.
      *
-     * @deprecated use {@link Auth#loginSSO} instead
+     * @deprecated use {@apilink Auth.loginSSO} instead
      * @throws {Error} If the provider's configuration is incorrect.
      */
     static loginSAML(): Promise<void>;
@@ -249,7 +279,7 @@ export class Auth {
      * Try to login using the configured OpenID Provider.
      * Returns a promise resolved when logged in or that catches an error if the login is not valid.
      *
-     * @deprecated use {@link Auth#loginSSO} instead
+     * @deprecated use {@apilink Auth.loginSSO} instead
      * @throws {Error} If the provider's configuration is incorrect.
      */
     static loginOpenID(): Promise<void>;