@olympeio/runtime-node 9.4.5 → 9.5.1

package/types/runtime.d.ts

@@ -2,8 +2,9 @@
 // Runtime classes
 // **********************************
 // @ts-ignore
-import Observable from 'rxjs';
-import {CloudObject, Context, Property, Tag} from "./base";
+import {Observable} from 'rxjs';
+import {CloudObject, Context, Property, InstanceOrTag} from "./base";
+import {ErrorFlow} from "./utils";
 
 /**
  * Label of global properties used by convention through bricks and applications.
@@ -24,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 the method checks parent contexts
+     * @param global whether the method checks parent contexts (Default = false)
      * @return whether `property` has a value or not
      */
     has<T>(key: string | Property<T>, global?: boolean): boolean;
@@ -33,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 the method checks parent contexts
+     * @param global whether the method checks parent contexts (Default = false)
      * @return the current value
      */
     get<T>(key: string | Property<T>, global?: boolean): T | null;
@@ -45,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 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.
+     * @param waitForValue whether the observable should wait for a first value to get a value. (Default = true)
+     * @param global whether to listen to a value coming from other contexts. (Default = false)
      * @return the observable
      */
     observe<T>(key: string | Property<T>, waitForValue?: boolean, global?: boolean): Observable<T>;
@@ -56,7 +57,7 @@ export class BrickContext extends Context {
      * The promise is rejected if no value is set to the specified property before the destruction of this BrickContext.
      *
      * @param key the property
-     * @param global [=false] whether the method checks parent contexts
+     * @param global whether the method checks parent contexts (Default = false)
      * @return a promise of the next value of property
      */
     waitFor<T>(key: string | Property<T>, global?: boolean): Promise<T>;
@@ -94,6 +95,14 @@ export class BrickContext extends Context {
      */
     trigger<T>(key: string | Property<T>): this;
 
+    /**
+     * Throw the specified error to this context. The error will be propagated until it finds an error handler.
+     *
+     * @param error the error to throw and propagate in the contexts hierarchy
+     * @return this context
+     */
+    throw(error: ErrorFlow | Error | string): this;
+
     /**
      * Run a runnable property and returns its context.
      *
@@ -136,9 +145,10 @@ export class BrickContext extends Context {
     /**
      * Return the closest parent of a given type
      *
-     * @param modelTag tag of the "type" of context you want to find in the parent tree
+     * @param selector the context selector
+     * @param selector.modelTag tag of the "type" of context you want to find in the parent tree
      */
-    getClosest(modelTag: Tag): BrickContext | null;
+    getClosest(selector: {modelTag: InstanceOrTag}): BrickContext | null;
 
     /**
      * Listen to the creation of the context with the specified id.
@@ -159,7 +169,7 @@ export class BrickContext extends Context {
  * @param brick the brick class
  * @param args Extra arguments
  */
-export function registerBrick(tag: string, brick: new () => Brick, ...args: any);
+export function registerBrick(tag: string, brick: new () => Brick, ...args: any): void;
 
 export abstract class Brick extends CloudObject {
 

package/types/utils.d.ts

@@ -3,14 +3,16 @@
 // **********************************
 
 // @ts-ignore
-import {Observable} from "rxjs";
+import {Observable} from 'rxjs';
+// @ts-ignore
+import {Error} from 'es5';
 import {Context} from "./base";
 
 // -- Configuration --
 export class Config {
     /**
      * Return the value of the specified parameter.
-     * Parameters can get their values from the oConfig.json file or be override from the URL / command that opened the application.
+     * Parameters can get their values from the oConfig.json file or be overridden from the URL / command that opened the application.
      *
      * @param id the parameter id
      */
@@ -40,6 +42,33 @@ export class Process {
      * @param callback the callback executed when the runtime terminates.
      */
     static onShutdown(callback: () => Promise<void>): () => void;
+
+    /**
+     * Static method that manually triggers a connection attempt to the server to go ONLINE.
+     * If you have called {@apilink Process.disconnect()} before, it will cancel the OFFLINE mode,
+     * next time the app will be opened, it will try to go ONLINE on its own.
+     *
+     * Returns a promise that resolves when the server connection is established. If it fails, the promise is rejected.
+     */
+    static connect(): Promise<void>;
+
+    /**
+     * Static method that manually close the connection to the server to go OFFLINE.
+     * Persists the offline status so the app restart offline after being closed.
+     * The only way to clean that status is to call {@apilink Process.connect()}.
+     *
+     * Returns a promise that resolves when the server connection is indeed disconnected and the state is OFFLINE.
+     * If the flag `offline.enabled` is not set to true, the promise is rejected.
+     */
+    static disconnect(): Promise<void>;
+
+    /**
+     * Static method that returns an observable on the connection state: the observable send TRUE if the process is considered
+     * as ONLINE and false if not.
+     *
+     * @param context the context of the brick to garbage collect the observable when not needed anymore.
+     */
+    static isOnline(context: Context): Observable<boolean>;
 }
 
 // -- Primitive types classes --
@@ -52,13 +81,13 @@ export class Color {
     getAlpha(): number;
     toRGBString(): string;
     toHexString(): string;
-    equals(obj): boolean;
+    equals(obj: any): boolean;
 }
 
 /**
  * Error type used to propagate errors through flows between bricks.
  */
-export class ErrorFlow {
+export class ErrorFlow extends Error {
     /**
      * Create a new Error object to be sent in an error flow
      *
@@ -76,18 +105,23 @@ export class ErrorFlow {
      * Return the code associated to this error
      */
     getCode(): number;
+
+    /**
+     * Return the stack with the hierarchy of bricks that run the one having thrown the error.
+     */
+    getStack(): string;
 }
 
 /**
  * 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 = {
+export enum ServiceRequestType {
     PUBLISH,
     SEND,
     GET,
     SUBSCRIBE
-};
+}
 
 /**
  * A request consumed by a service.
@@ -278,6 +312,8 @@ export class Auth {
 
     /**
      * Return the current state of the authentication manager
+     *
+     * @deprecated use {@apilink Auth.isAuthenticated} instead
      * @return the current state
      */
     static getState(): AuthState;
@@ -304,6 +340,14 @@ export class Auth {
      */
     static refreshToken(): Promise<void>;
 
+    /**
+     * Returns an `Observable` that is updated each time the authentication status changes.
+     * If the user is authenticated, gets true, otherwise (e.g. Guest) get false.
+     * @param context The brick context
+     * @return An `Observable`
+     */
+    static isAuthenticated(context: Context): Observable<boolean>
+
     /**
      * Returns an `Observable` that is updated each time the user tag changes.
      * @param context The brick context
@@ -389,6 +433,60 @@ export class Auth {
     static logout(): Promise<void>;
 }
 
+export class Cache {
+
+    /**
+     * Return the list of cache ids saved in previous execute or observe
+     */
+    static getCacheEntries(): Observable<Array<string>>;
+
+    /**
+     * Clear the cached data related to this cache id. If not cache id provided => clear all cache ids
+     */
+    static clearCache(id?: string): Promise<void>;
+
+    /**
+     * Return an Observable which returns the current processing status of the Cache layer.
+     * `processing` is set to TRUE if the Cache is processing some queries or downloading files to keep the offline database up-to-date
+     */
+    static getProcessingStatus(): Observable<CacheStatus>
+
+    /**
+     * Return an Observable which emit a new value for each Error encountered when
+     * processing data results asynchronously
+     */
+    static getProcessingErrors(): Observable<boolean>
+
+    /**
+     * Return an observable which gets TRUE if one or more changes must be
+     * synced with remoted database
+     *
+     */
+    static hasPendingChanges(): Observable<boolean>;
+
+    /**
+     * Sync the local changes made offline with the online data source
+     * Returns an observable in the form [nbChanges, nbSyncedChanges]
+     */
+    static synchroniseChanges(): Observable<[number, number]>;
+
+    /**
+     * Return a string containing all changes and there related files. This method can be used to "backup" pending changes
+     * at any point in time before a synchronisation
+     */
+    static getPendingChanges(): Promise<string>;
+
+    /**
+     * Clear the list of pending changes without applying or syncing them.
+     */
+    static clearPendingChanges(): Promise<void>;
+
+    /**
+     * Load the given pending changes into the local offline database
+     */
+    static loadPendingChanges(data: string): Promise<void>;
+}
+
 declare type SRPData = {
     username: string,
     login: string
@@ -404,3 +502,15 @@ declare enum AuthState {
     ERROR = 'error',
     AUTHENTICATED = 'authenticated'
 }
+
+declare type CacheStatus = {
+    processing: boolean,
+    queries: {
+        total: number,
+        processed: number,
+    },
+    files: {
+        total: number,
+        processed: number,
+    }
+}