@olympeio/runtime-node 9.5.0 → 9.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.5.0",
+  "version": "9.5.1",
   "description": "Olympe Node Runtime Environment",
   "types": "types/index.d.ts",
   "dependencies": {

package/types/base.d.ts

@@ -1,5 +1,5 @@
 // @ts-ignore
-import Observable from 'rxjs';
+import {Observable} from 'rxjs';
 import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
 
 // **********************************
@@ -7,8 +7,8 @@ import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
 // **********************************
 
 /**
- * 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`
+ * A InstanceOrTag can be either a `string`, a `HasTag` (CloudObject instance, Property, Relation, ...)
+ * or the class constructor for a `CloudObject`
  */
 export type InstanceOrTag = string | HasTag | typeof CloudObject;
 
@@ -24,7 +24,7 @@ export type Class<T> = {new (): T};
 export function generateTag(): string;
 
 /**
- * Get the unique identifier of the specified Tag as a string
+ * Get the unique identifier of the specified InstanceOrTag as a string
  *
  * If the given tag is a `CloudObject` instance, the tag of that instance is returned.
  * If a class constructor is given, the tag of the corresponding `CloudObject` is returned.
@@ -36,7 +36,7 @@ export function tagToString(tag: InstanceOrTag): string;
 
 /**
  * The HasTag interface defines objects that have a tag.
- * The tag of these objects must be returned by the override method: `getTag()`
+ * The tag of these objects must be returned by the overridden method: `getTag()`
  */
 export interface HasTag {
     /**
@@ -113,7 +113,7 @@ export abstract class Context {
  * In essence, it represents a remote reference to an object in the data cloud.
  * It is identified by its unique ID, or tag. From a `CloudObject` you can access related `CloudObjects`.
  *
- * A `CloudObject` can be instantiated via the {@apilink Tag} of its model, and it can be instantiated multiple times with different properties values.
+ * A `CloudObject` can be instantiated via the {@apilink InstanceOrTag} of its model, and it can be instantiated multiple times with different properties values.
  * *Data types* defined in DRAW are such `CloudObjects`, instances of Data types are also `CloudObjects`.
  *
  * **Example:**
@@ -241,6 +241,13 @@ export abstract class CloudObject implements HasTag {
      *  @return a boolean indicating if this object is persisted in a non-volatile way.
      */
     isPersisted(): boolean;
+
+    /**
+     * Compare this CloudObject and the given one and return whether they are identical or not.
+     *
+     * @param object the object to compare
+     * @return true if the specified object is the same CloudObject
+     */
     equals(object: any): boolean;
 
     /**
@@ -288,7 +295,7 @@ export abstract class CloudObject implements HasTag {
      *
      * @param context context to which the Observable is attached
      * @param property property or property's tag to observe
-     * @param waitForValue [=true] whether the observable wait for a first value to get a value.
+     * @param waitForValue whether the observable wait for a first value to get a value. (Default = true)
      * @return Observable of property values
      */
     observe<T>(context: Context, property: Property<T> | InstanceOrTag, waitForValue?: boolean): Observable<T>;
@@ -311,6 +318,12 @@ export abstract class CloudObject implements HasTag {
      */
     toObject(namesAsKey?: boolean, inheritedProperties?: boolean): Object;
 
+    /**
+     * Create a Javascript object from this CloudObject current state, including its tag and property values.
+     * It provides the same result as {@apiLink CloudObject#toObject | toObject} called with nameAsKey = true and inheritedProperties = false.
+     */
+    toJSON(): Object;
+
     // Properties and Relations
     /**
      * Name property for all `CloudObjects`

package/types/cloud.d.ts

@@ -5,7 +5,8 @@
 // *********************************************
 
 // @ts-ignore
-import Observable from 'rxjs';
+import {Observable} from 'rxjs';
+import {Readable} from 'stream';
 import {Context, CloudObject, Relation, Property, InstanceOrTag, Class} from "./base";
 import {Brick, BrickContext} from './runtime';
 import {Color} from "./utils";
@@ -128,7 +129,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: InstanceOrTag, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string);
+    static setContent(transaction: Transaction, file: InstanceOrTag, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string): void;
 
     /**
      * Set the content of a `File` from a specified URL
@@ -138,7 +139,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: InstanceOrTag, name: string, url: string, mimeType?: string);
+    static setURLContent(transaction: Transaction, file: InstanceOrTag, name: string, url: string, mimeType?: string): void;
 
     /**
      * @deprecated Please use {@apilink File.setContent}
@@ -173,7 +174,7 @@ export class File extends CloudObject {
      * @param onSuccess callback to execute when byte content has been retrieved successfully
      * @param onFailure callback to execute when content retrieval has failed
      */
-    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (string) => void): void;
+    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (errMsg: string) => void): void;
 
     /**
      * Retrieve string content from this file asynchronously
@@ -181,7 +182,7 @@ export class File extends CloudObject {
      * @param onSuccess callback to execute when string content has been retrieved successfully
      * @param onFailure callback to execute when content retrieval has failed
      */
-    getContentAsString(onSuccess: (content: string) => void, onFailure?: (string) => void): void;
+    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void): void;
 
     /**
      * Retrieve string content from URL asynchronously
@@ -875,13 +876,17 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     concat(...others: QueryResult<T>[]): QueryResult<T>;
 }
 
-interface QueryOptions {
+declare type QueryOptions = {
     cacheBucketName?: string; // Name of the cache bucket - if provided, it means that the query must be cached under this name
 }
 
+declare type ImplicitQueryOption = {
+    storeInCacheDB?: boolean // indicates if this follow rule query must be cached in browser DB (IndexedDB) for potential offline use. Default is false.
+}
+
 /**
  * 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).
+ * It starts from an `origin` InstanceOrTag (typically, the `InstanceOrTag` of a data type or of an instance).
  * From there, it can follow relations between data types and filter results.
  *
  * Example:
@@ -974,9 +979,8 @@ export class Query<T extends CloudObject, R> {
      * @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 InstanceOrTag>(ctx: Context, root: T, rule: FollowRule, source?: Source, options?: {storeInCacheDB?: boolean}): Observable<QueryResult<T extends CloudObject ? T : CloudObject>>;
+    static followRule<T extends InstanceOrTag>(ctx: Context, root: T, rule: FollowRule, source?: Source, options?: ImplicitQueryOption): 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.
@@ -1197,10 +1201,9 @@ export class QuerySingle<T extends CloudObject> {
     /**
      * Execute the query single, see {@apilink Query.execute | Query.execute()}
      *
-     * @param context
      * @return promise containing the single result or `null`
      */
-    execute(context: Context): Promise<T | null>;
+    execute(): Promise<T | null>;
 
     /**
      * Execute the query single on the local data cloud,
@@ -1361,7 +1364,7 @@ export class DataResult {
     static fromQuery(query: Query<CloudObject, any>): DataResult;
 
     /**
-     * Create a new Data Type instance with the specified {@apilink Tag}, Data Type and properties.
+     * Create a new Data Type instance with the specified {@apilink InstanceOrTag}, Data Type and properties.
      * @param tag The unique identifier of the object instance to create.
      * @param model The Data Type of the instance to create.
      * @param properties The properties to set on the instance.
@@ -1587,14 +1590,14 @@ export abstract class DataSource extends CloudObject {
 
     /**
      * Returns the tag of the data source.
-     * @return {string} tag of the data source.
+     * @return tag of the data source.
      */
     getId(): string;
 
     /**
      * Retrieves the configuration value associated with the provided key in the data source oConfig.
-     * @param {string} key - Key to retrieve the configuration value for.
-     * @return {*} The configuration value associated with the provided key.
+     * @param key - Key to retrieve the configuration value for.
+     * @return The configuration value associated with the provided key.
      */
     getConfig(key: string): any;
 
@@ -1603,60 +1606,60 @@ export abstract class DataSource extends CloudObject {
      * It can also perform a health check to ensure the connection is active.
      * Subscribes to the {@apilink DataSource.observeDataTypes} observable to handle changes to the data types in the data source.
      *
-     * @param {!Context} context a context with the same livecycle as the Data Source
+     * @param context a context with the same livecycle as the Data Source
      * @return A promise that resolves with void when initialization is complete. Reject if initialization did not complete.
      */
-    protected init(context): Promise<void>;
+    protected init(context: BrickContext): Promise<void>;
 
     /**
      * Performs a health check on the data source, checking if the connection is alive.
-     * @return {Promise<void>} A Promise that resolves when the health check is completed successfully, rejects otherwise.
+     * @return A Promise that resolves when the health check is completed successfully, rejects otherwise.
      */
     protected healthCheck(): Promise<void>;
 
     /**
      * Disconnects the data source.
-     * @return {Promise<void>} A Promise that resolves when the data source is destroyed.
+     * @return A Promise that resolves when the data source is destroyed.
      */
     protected destroy(): Promise<void>;
 
     /**
      * Executes the provided {@apilink Query} once and returns a {@apilink DataResult}.
-     * @param {Query<CloudObject, any>} query - The {@apilink Query} object to execute.
-     * @return {Promise<DataResult>} A Promise that resolves with the {@apilink DataResult} object.
+     * @param query - The {@apilink Query} object to execute.
+     * @return A Promise that resolves with the {@apilink DataResult} object.
      */
     protected executeQuery(query: Query<CloudObject, any>): Promise<DataResult>;
 
     /**
      * Applies the provided {@apilink Operation} array to the data source as one transaction
-     * @param {Operation[]} transaction - The {@apilink Operation} array to apply.
-     * @param {?TransactionOptions} options
-     * @return {Promise<void>} A Promise that resolves when the transaction is completed. Rejects when the transaction fails.
+     * @param transaction - The {@apilink Operation} array to apply.
+     * @param options the options
+     * @return A Promise that resolves when the transaction is completed. Rejects when the transaction fails.
      */
     protected applyTransaction(transaction: Operation[], options?: TransactionOptions): Promise<void>;
 
     /**
      * Uploads one file's content to the data source.
-     * @param {string} fileTag - The tag of the file.
-     * @param {string} dataType - The file data type
-     * @param {Uint8Array} binary - The binary data of the file.
-     * @return {Promise<void>} A Promise that resolves when the file content is uploaded. Rejects otherwise.
+     * @param fileTag - The tag of the file.
+     * @param dataType - The file data type
+     * @param binary - The binary data of the file.
+     * @return A Promise that resolves when the file content is uploaded. Rejects otherwise.
      */
     protected uploadFileContent(fileTag: string, dataType: string, binary: Uint8Array): Promise<void>;
 
     /**
      * Downloads one file's content from the data source.
-     * @param {string} fileTag - The tag of the file.
-     * @param {string} dataType - The file data type
-     * @return {Promise<Uint8Array>} A Promise that resolves with the binary data of the file as a Uint8Array. Rejects otherwise.
+     * @param fileTag - The tag of the file.
+     * @param dataType - The file data type
+     * @return A Promise that resolves with the binary data of the file as an Uint8Array or a node Readable Stream. Rejects otherwise.
      */
-    protected downloadFileContent(fileTag: string, dataType: string): Promise<Uint8Array>;
+    protected downloadFileContent(fileTag: string, dataType: string): Promise<Uint8Array | Readable>;
 
     /**
      * Deletes file content from the data source.
-     * @param {string} fileTag - The tag of the file.
-     * @param {string} dataType - The file data type
-     * @return {Promise<void>} A Promise that resolves when the file content is successfully deleted. Rejects otherwise.
+     * @param fileTag - The tag of the file.
+     * @param dataType - The file data type
+     * @return A Promise that resolves when the file content is successfully deleted. Rejects otherwise.
      */
     protected deleteFileContent(fileTag: string, dataType: string): Promise<void>;
 }

package/types/legacy.d.ts

@@ -1,5 +1,5 @@
 // @ts-ignore
-import Observable from 'rxjs';
+import {Observable} from 'rxjs';
 import {CloudObject, Direction, HasTag, Property, Relation, InstanceOrTag} from "./base";
 import {Brick, VisualBrick} from "./runtime";
 /**

package/types/runtime.d.ts

@@ -2,8 +2,9 @@
 // Runtime classes
 // **********************************
 // @ts-ignore
-import Observable from 'rxjs';
+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>;
@@ -144,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: InstanceOrTag): BrickContext | null;
+    getClosest(selector: {modelTag: InstanceOrTag}): BrickContext | null;
 
     /**
      * Listen to the creation of the context with the specified id.
@@ -167,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,7 +3,9 @@
 // **********************************
 
 // @ts-ignore
-import { BehaviorSubject, Observable } from "rxjs";
+import {Observable} from 'rxjs';
+// @ts-ignore
+import {Error} from 'es5';
 import {Context} from "./base";
 
 // -- Configuration --
@@ -79,7 +81,7 @@ export class Color {
     getAlpha(): number;
     toRGBString(): string;
     toHexString(): string;
-    equals(obj): boolean;
+    equals(obj: any): boolean;
 }
 
 /**
@@ -114,12 +116,12 @@ export class ErrorFlow extends Error {
  * 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.
@@ -436,7 +438,7 @@ export class Cache {
     /**
      * Return the list of cache ids saved in previous execute or observe
      */
-    static getCacheEntriesList(): Observable<Array<string>>;
+    static getCacheEntries(): Observable<Array<string>>;
 
     /**
      * Clear the cached data related to this cache id. If not cache id provided => clear all cache ids
@@ -444,10 +446,10 @@ export class Cache {
     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
+     * 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 isProcessing(): Observable<boolean>
+    static getProcessingStatus(): Observable<CacheStatus>
 
     /**
      * Return an Observable which emit a new value for each Error encountered when
@@ -500,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,
+    }
+}