@olympeio/runtime-node 9.4.5 → 9.5.0

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.4.5",
+  "version": "9.5.0",
   "description": "Olympe Node Runtime Environment",
   "types": "types/index.d.ts",
   "dependencies": {
     "ws": "~8.11.0",
     "bufferutil": "~4.0.7",
     "utf-8-validate": "~5.0.10",
-    "lowdb": "~1.0.0",
     "rxjs": "7.8.1",
     "fastify": "~3.29.4"
   },

package/types/base.d.ts

@@ -7,10 +7,10 @@ import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
 // **********************************
 
 /**
- * A Tag can be either a `string`, a `HasTag` (CloudObject instance, Property, Relation, ...)
- * or the class constructor for a `CloudObject`
+ * An InstanceOrTag is an alias for types that represent a CloudObject.
+ * It can be either a `string`, a `HasTag` (CloudObject instance, Property, Relation, ...) or the class constructor for a `CloudObject`
  */
-export type Tag = string | HasTag | typeof CloudObject;
+export type InstanceOrTag = string | HasTag | typeof CloudObject;
 
 export type List<T> = Array<T> | (T extends CloudObject | CloudObject[] ? QueryResult<T> : never);
 
@@ -32,7 +32,7 @@ export function generateTag(): string;
  * @param tag
  * @return string tag of given input
  */
-export function tagToString(tag: Tag): string;
+export function tagToString(tag: InstanceOrTag): string;
 
 /**
  * The HasTag interface defines objects that have a tag.
@@ -147,7 +147,7 @@ export abstract class CloudObject implements HasTag {
      * @param model data type to get instances of
      * @return A query starting from the instances of the specified model.
      */
-    static instancesOf<T extends CloudObject>(model: Class<T> | Tag): Query<T, never>;
+    static instancesOf<T extends CloudObject>(model: Class<T> | InstanceOrTag): Query<T, never>;
 
     /**
      * Get the CloudObject whose tag is specified.
@@ -159,7 +159,7 @@ export abstract class CloudObject implements HasTag {
      * @param tag tag of the `CloudObject`
      * @return `CloudObject` specified by the tag
      */
-    static get<T extends CloudObject>(tag: Tag): T;
+    static get<T extends CloudObject>(tag: InstanceOrTag): T;
 
     /**
      * Checks whether a `CloudObject` exists or not.
@@ -168,7 +168,7 @@ export abstract class CloudObject implements HasTag {
      * @param tag tag of the `CloudObject`
      * @return `true` if `tag` is valid and references a CloudObject.
      */
-    static exists(tag: Tag): boolean;
+    static exists(tag: InstanceOrTag): boolean;
 
     /**
      * Create an instance of the specified data type (or `model`)
@@ -181,7 +181,7 @@ export abstract class CloudObject implements HasTag {
      * @param source
      * @return newly created `CloudObject`
      */
-    static createWith<T>(this: Class<T>, properties: Map<Tag, any>, model?: Tag, source?: Source): T;
+    static createWith<T>(this: Class<T>, properties: Map<InstanceOrTag, any>, model?: InstanceOrTag, source?: Source): T;
 
     /**
      * Get this `CloudObject` class as a `CloudObject` instance.
@@ -277,7 +277,7 @@ export abstract class CloudObject implements HasTag {
      * @param property property or property's tag
      * @return property value
      */
-    get<T>(property: Property<T> | Tag): T | null;
+    get<T>(property: Property<T> | InstanceOrTag): T | null;
 
     /**
      * Get an observable to the current value of the specified property for this `CloudObject` instance.
@@ -291,7 +291,7 @@ export abstract class CloudObject implements HasTag {
      * @param waitForValue [=true] whether the observable wait for a first value to get a value.
      * @return Observable of property values
      */
-    observe<T>(context: Context, property: Property<T> | Tag, waitForValue?: boolean): Observable<T>;
+    observe<T>(context: Context, property: Property<T> | InstanceOrTag, waitForValue?: boolean): Observable<T>;
 
     /**
      * Get an observable to pair [property, value] for this `CloudObject` instance.
@@ -379,7 +379,7 @@ interface RelationConstructor {
      * @param tag tag of the relation to create
      * @param direction whether the relation points to the origin or destination
      */
-    new(tag: Tag, direction?: Direction): Relation<CloudObject, CloudObject>;
+    new(tag: InstanceOrTag, direction?: Direction): Relation<CloudObject, CloudObject>;
 
     /**
      * Create a relation between two CloudObject classes
@@ -388,7 +388,7 @@ interface RelationConstructor {
      * @param origin origin class of the relation
      * @param destination destination class of the relation
      */
-    new<O extends CloudObject, D extends CloudObject>(tag: Tag, direction?: Direction, origin?: Class<O>, destination?: Class<D>): Relation<O, D>;
+    new<O extends CloudObject, D extends CloudObject>(tag: InstanceOrTag, direction?: Direction, origin?: Class<O>, destination?: Class<D>): Relation<O, D>;
 }
 
 /**
@@ -440,7 +440,7 @@ export interface Relation<O extends CloudObject, D extends CloudObject> extends
  * @param tag tag of the DataType
  * @param object `CloudObject` constructor
  */
-export function register(tag: Tag, object: typeof CloudObject): void;
+export function register(tag: InstanceOrTag, object: typeof CloudObject): void;
 
 /**
  * Create a constant property object which has the specified tag and type to be used in coded bricks.
@@ -449,7 +449,7 @@ export function register(tag: Tag, object: typeof CloudObject): void;
  * @param type type the property holds values of
  * @return newly defined property
  */
-export function defineProperty<T>(tag: Tag, type?: Class<T>): Property<T>;
+export function defineProperty<T>(tag: InstanceOrTag, type?: Class<T>): Property<T>;
 
 /**
  * Create a constant relation object between two specified DataTypes.
@@ -462,7 +462,7 @@ export function defineProperty<T>(tag: Tag, type?: Class<T>): Property<T>;
  * @param direction direction of the relation, pointing towards origin or destination. Default is `DESTINATION`
  * @return newly defined relation
  */
-export function defineRelation<O extends CloudObject, D extends CloudObject>(tag: Tag, origin?: Class<O>, destination?: Class<D>, direction?: Direction): Relation<O, D>;
+export function defineRelation<O extends CloudObject, D extends CloudObject>(tag: InstanceOrTag, origin?: Class<O>, destination?: Class<D>, direction?: Direction): Relation<O, D>;
 /**
  * Create a constant relation object between two generic `CloudObjects`
  *
@@ -472,7 +472,7 @@ export function defineRelation<O extends CloudObject, D extends CloudObject>(tag
  * @param direction direction of the relation, pointing towards origin or destination. Default is `DESTINATION`
  * @return newly defined relation
  */
-export function defineRelation(tag: Tag, direction?: Direction): Relation<CloudObject, CloudObject>;
+export function defineRelation(tag: InstanceOrTag, direction?: Direction): Relation<CloudObject, CloudObject>;
 
 /**
  * Returns a constant object corresponding to the specified relation going to the opposite direction

package/types/cloud.d.ts

@@ -6,7 +6,7 @@
 
 // @ts-ignore
 import Observable from 'rxjs';
-import {Context, CloudObject, Relation, Property, Tag, Class} from "./base";
+import {Context, CloudObject, Relation, Property, InstanceOrTag, Class} from "./base";
 import {Brick, BrickContext} from './runtime';
 import {Color} from "./utils";
 
@@ -128,7 +128,7 @@ export class File extends CloudObject {
      * @param content byte content of the file
      * @param mimeType optional mime type of the file
      */
-    static setContent(transaction: Transaction, file: Tag, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string);
+    static setContent(transaction: Transaction, file: InstanceOrTag, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string);
 
     /**
      * Set the content of a `File` from a specified URL
@@ -138,7 +138,7 @@ export class File extends CloudObject {
      * @param url url to retrieve content from
      * @param mimeType optional mime type of the file
      */
-    static setURLContent(transaction: Transaction, file: Tag, name: string, url: string, mimeType?: string);
+    static setURLContent(transaction: Transaction, file: InstanceOrTag, name: string, url: string, mimeType?: string);
 
     /**
      * @deprecated Please use {@apilink File.setContent}
@@ -246,7 +246,7 @@ export class EnumValue extends CloudObject {
      * @param name name of the `EnumValue`
      * @param rank position of the `EnumValue` in the `Enum`
      */
-    static createValue(transaction: Transaction, enumModel: Tag, value: string, name?: string, rank?: number): string;
+    static createValue(transaction: Transaction, enumModel: InstanceOrTag, value: string, name?: string, rank?: number): string;
 
     /**
      * Name property for an EnumValue
@@ -410,7 +410,7 @@ export class Transaction {
      * @param tag optional tag of the instance to be created and must be unique
      * @return  the tag of the instance to be created
      */
-    create(model: Tag, properties?: Map<Tag, any>, source?: Source, tag?: string): string;
+    create(model: InstanceOrTag, properties?: Map<InstanceOrTag, any>, source?: Source, tag?: string): string;
 
     /**
      * Update the property of an instance
@@ -420,7 +420,7 @@ export class Transaction {
      * @param value the value of the property to be updated to
      * @return this transaction
      */
-    update<T>(instance: Tag, property?: Property<T>, value?: T): this;
+    update<T>(instance: InstanceOrTag, property?: Property<T>, value?: T): this;
 
     /**
      * Update multiple properties of a single instance
@@ -429,7 +429,7 @@ export class Transaction {
      * @param properties map of properties to update
      * @return this transaction
      */
-    multiUpdate(instance: Tag, properties: Map<Tag, any>): this;
+    multiUpdate(instance: InstanceOrTag, properties: Map<InstanceOrTag, any>): this;
 
     /**
      * Delete an instance
@@ -437,7 +437,7 @@ export class Transaction {
      * @param instance tag of the instance to be deleted
      * @return this transaction
      */
-    delete(instance: Tag): this;
+    delete(instance: InstanceOrTag): this;
 
     /**
      * Create relation between two instances
@@ -447,7 +447,7 @@ export class Transaction {
      * @param to tag ofo the DESTINATION instance of the relation
      * @return this transaction with the create relation operation registered
      */
-    createRelation(relation: Tag, from: Tag, to: Tag): this;
+    createRelation(relation: InstanceOrTag, from: InstanceOrTag, to: InstanceOrTag): this;
 
     /**
      * Delete a relation between two specified instances.
@@ -459,7 +459,7 @@ export class Transaction {
      * @param to destination instance tag
      * @return this transaction
      */
-    deleteRelation(relation: Tag, from: Tag, to: Tag): this;
+    deleteRelation(relation: InstanceOrTag, from: InstanceOrTag, to: InstanceOrTag): this;
 
     /**
      * Delete any number of the relation starting from specified node.
@@ -478,25 +478,27 @@ export class Transaction {
      * @param relation deleted relation, indicates relation tag *and* direction
      * @param origin starting node
      */
-    deleteAllRelations(relation: Relation<any, any>, origin: Tag): this;
+    deleteAllRelations(relation: Relation<any, any>, origin: InstanceOrTag): this;
 
     /**
-     * Change the persistence mode of all instances in this transaction
+     * Set the specified instance to be persisted or not in this transaction.
+     * Default value of persist is true.
      *
-     * @param persist whether instances are persisted outside
-     * the local datacloud
+     * @param instance the instance to be persisted
+     * @param persist determine if the specified instance should be persisted or not (true by default).
      * @return this transaction
      */
-    persist(persist?: boolean): this;
+    persist(instance: InstanceOrTag, persist?: boolean): this;
 
     /**
      * Change the persistence mode for a single instance in this transaction
      *
+     * @deprecated use {@apilink Transaction.persist} instead
      * @param instance the instance to be persisted
      * @param persist the persisting mode
      * @return this transaction
      */
-    persistInstance(instance: Tag, persist?: boolean): this;
+    persistInstance(instance: InstanceOrTag, persist?: boolean): this;
 
     /**
      * Change the source of all instances created in this transaction
@@ -522,7 +524,7 @@ export class Transaction {
      * @param tag the instance to find the model of
      * @return the tag of the model of the given instance
      */
-    model(tag: Tag): string | null;
+    model(tag: InstanceOrTag): string | null;
 
     /**
      * Add all operations of another transaction into this transaction
@@ -873,6 +875,10 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     concat(...others: QueryResult<T>[]): QueryResult<T>;
 }
 
+interface QueryOptions {
+    cacheBucketName?: string; // Name of the cache bucket - if provided, it means that the query must be cached under this name
+}
+
 /**
  * A Query is an immutable object used to build queries on the datacloud. It is a graph query builder.
  * It starts from an `origin` Tag (typically, the `Tag` of a data type or of an instance).
@@ -934,7 +940,7 @@ export class Query<T extends CloudObject, R> {
      * @param source optional source of the data to answer the query
      * @return an empty Query whose starting point is defined by a single `CloudObject`
      */
-    static from<T extends Tag>(tag: T, source?: Source): Query<T extends CloudObject ? T : CloudObject, never>;
+    static from<T extends InstanceOrTag>(tag: T, source?: Source): Query<T extends CloudObject ? T : CloudObject, never>;
 
     /**
      * Create a query starting from the `CloudObject` specified tag.
@@ -946,7 +952,7 @@ export class Query<T extends CloudObject, R> {
      * @param source optional source of the data to answer the query
      * @return an empty Query whose starting point is defined by a single `CloudObject`
      */
-    static fromTag<T extends CloudObject>(tag: string, dataType: Class<T> | Tag, source?: Source): Query<T, never>;
+    static fromTag<T extends CloudObject>(tag: string, dataType: Class<T> | InstanceOrTag, source?: Source): Query<T, never>;
 
     /**
      * Create a query starting from the instances of the specified model. By default, it does include the instances of
@@ -959,7 +965,7 @@ export class Query<T extends CloudObject, R> {
      * an external data source (Tag of a `DBConnectorTag`)
      * @return a new query object starting from model instances
      */
-    static instancesOf<T extends Tag>(model: Class<T> | Tag, includeInheritance?: boolean, source?: Source): Query<T extends CloudObject ? T : CloudObject, never>;
+    static instancesOf<T extends InstanceOrTag>(model: Class<T> | InstanceOrTag, includeInheritance?: boolean, source?: Source): Query<T extends CloudObject ? T : CloudObject, never>;
 
     /**
      * Create a query starting from a specific root instance, then following relations based on a rule constraint.
@@ -967,8 +973,10 @@ export class Query<T extends CloudObject, R> {
      * @param root Starting point of the query. See `root` of {@apilink RootQueryPart}
      * @param rule Discriminate which relations to follow
      * @param source The tag of the source responsible for executing the query
+     * @param options options
+     * @param options.storeInCacheDB indicates if this follow rule query must be cached in browser DB (IndexedDB) for potential offline use. Default is false.
      */
-    static followRule<T extends Tag>(ctx: Context, root: T, rule: FollowRule, source?: Source): Observable<QueryResult<T extends CloudObject ? T : CloudObject>>;
+    static followRule<T extends InstanceOrTag>(ctx: Context, root: T, rule: FollowRule, source?: Source, options?: {storeInCacheDB?: boolean}): Observable<QueryResult<T extends CloudObject ? T : CloudObject>>;
 
     /**
      * Instruct the query to follow a specified relation. This does not add any key-value pair to the result.
@@ -1121,14 +1129,13 @@ export class Query<T extends CloudObject, R> {
     parse(): RootQueryPart;
 
     /**
-     * Execute the query asynchronously on the datacloud and deletes it afterwards.
+     * Execute the query asynchronously on the datacloud and deletes it afterward.
      * In other words, one cannot call execute twice on the same `Query`.
      *
-     * @param context context in which the query must be executed. As this is an asynchronous operation,
-     * one has to provide a context that won't be destroyed before the query has a result.
+     * @param options options
      * @return promise resolving to query result or failing otherwise.
      */
-    execute(context: Context): Promise<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
+    execute(options?: QueryOptions): Promise<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
 
     /**
      * Get an observable to the current value of the QueryResult for this Query instance.
@@ -1138,9 +1145,10 @@ export class Query<T extends CloudObject, R> {
      * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
      *
      * @param context {@apilink Context} to which the Observable is attached
+     * @param options options
      * @return Observable of QueryResult values
      */
-    observe(context: Context): Observable<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
+    observe(context: Context, options?: QueryOptions): Observable<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
 
     /**
      * Execute synchronously the query on the local datacloud cache.
@@ -1167,7 +1175,7 @@ export class QuerySingle<T extends CloudObject> {
      * @param object starting node for the graph query single
      * @return new query single only accepting 0..1 relations
      */
-    static from<T extends CloudObject>(object: Tag): QuerySingle<T>;
+    static from<T extends CloudObject>(object: InstanceOrTag): QuerySingle<T>;
 
     /**
      * Follow a 0..1 relation
@@ -1219,7 +1227,7 @@ export class Predicate {
      *
      * @param tags the object or unique identifier (tag) of the objects to look for.
      */
-    static in(...tags: Tag[]): Predicate;
+    static in(...tags: InstanceOrTag[]): Predicate;
 
     /**
      * Create a predicate matching a specified property to a specified value.
@@ -1235,7 +1243,7 @@ export class Predicate {
      *
      * @param property the string property to use for filtering
      * @param value the value the string property must match
-     * @param caseSensitive if the match must pay attention to case sensitivity, default value is false
+     * @param caseSensitive if the match must pay attention to case sensitivity, default value is true
      * @return new Predicate with the contains string operation
      */
     static contains(property: Property<string>, value: string, caseSensitive?: boolean): Predicate;
@@ -1244,11 +1252,11 @@ export class Predicate {
      * Create a predicate matching a specified string property to a regular expression.
      *
      * @param property the string property to use for filtering
-     * @param value the regex the string property must match
-     * @param caseSensitive if the match must pay attention to case sensitivity, default value is false
+     * @param value the regex or pattern the string property must match
+     * @param caseSensitive if the match must pay attention to case sensitivity, default value is true
      * @return new Predicate with the match regex operation
      */
-    static regex(property: Property<string>, value: RegExp, caseSensitive?: boolean): Predicate;
+    static regex(property: Property<string>, value: RegExp | string, caseSensitive?: boolean): Predicate;
 
     /**
      * Create a predicate matching a specified number property to a numerical lower bound
@@ -1278,7 +1286,7 @@ export class Predicate {
      * @param extend should the predicate also match against inherited models
      * @return new Predicate
      */
-    static instanceOf(expectedModel: Tag, extend: boolean): Predicate;
+    static instanceOf(expectedModel: InstanceOrTag, extend: boolean): Predicate;
 
     /**
      * Create a predicate matching a specified number property to a number property lower bound
@@ -1359,7 +1367,7 @@ export class DataResult {
      * @param properties The properties to set on the instance.
      * @return This {@apilink DataResult} instance.
      */
-    create(tag: Tag, model: Tag, properties?: Map<Tag, any>): this;
+    create(tag: InstanceOrTag, model: InstanceOrTag, properties?: Map<InstanceOrTag, any>): this;
 
     /**
      * Create a relation between two instances with the specified {@apilink Relation}, `from`, and `to` instance tags.
@@ -1368,7 +1376,7 @@ export class DataResult {
      * @param to The unique identifier of the destination instance.
      * @return This {@apilink DataResult} instance.
      */
-    createRelation(relation: Tag, from: Tag, to: Tag): this;
+    createRelation(relation: InstanceOrTag, from: InstanceOrTag, to: InstanceOrTag): this;
 }
 
 /**

package/types/legacy.d.ts

@@ -1,6 +1,6 @@
 // @ts-ignore
 import Observable from 'rxjs';
-import {CloudObject, Direction, HasTag, Property, Relation, Tag} from "./base";
+import {CloudObject, Direction, HasTag, Property, Relation, InstanceOrTag} from "./base";
 import {Brick, VisualBrick} from "./runtime";
 /**
  * The entry of a brick is a static object linked to the brick class itself that is used to make the link between the
@@ -41,7 +41,7 @@ export type FunctionBrick = Brick;
        DATACLOUD
 ====================== */
 
-export type InstanceTag = Tag | Entry;
+export type InstanceTag = InstanceOrTag | Entry;
 
 /** @deprecated */
 export function instanceToTag(instance: InstanceTag): string;

package/types/runtime.d.ts

@@ -3,7 +3,7 @@
 // **********************************
 // @ts-ignore
 import Observable from 'rxjs';
-import {CloudObject, Context, Property, Tag} from "./base";
+import {CloudObject, Context, Property, InstanceOrTag} from "./base";
 
 /**
  * Label of global properties used by convention through bricks and applications.
@@ -94,6 +94,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.
      *
@@ -138,7 +146,7 @@ export class BrickContext extends Context {
      *
      * @param modelTag tag of the "type" of context you want to find in the parent tree
      */
-    getClosest(modelTag: Tag): BrickContext | null;
+    getClosest(modelTag: InstanceOrTag): BrickContext | null;
 
     /**
      * Listen to the creation of the context with the specified id.

package/types/utils.d.ts

@@ -3,14 +3,14 @@
 // **********************************
 
 // @ts-ignore
-import {Observable} from "rxjs";
+import { BehaviorSubject, Observable } from "rxjs";
 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 +40,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 --
@@ -58,7 +85,7 @@ export class Color {
 /**
  * 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,6 +103,11 @@ 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;
 }
 
 /**
@@ -278,6 +310,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 +338,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 +431,60 @@ export class Auth {
     static logout(): Promise<void>;
 }
 
+export class Cache {
+
+    /**
+     * Return the list of cache ids saved in previous execute or observe
+     */
+    static getCacheEntriesList(): 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 gets TRUE if the Cache is processing some queries
+     * to keep the offline database up-to-date
+     */
+    static isProcessing(): Observable<boolean>
+
+    /**
+     * 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