@olympeio/runtime-node 9.4.5 → 9.5.1

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.4.5",
+  "version": "9.5.1",
   "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

@@ -1,5 +1,5 @@
 // @ts-ignore
-import Observable from 'rxjs';
+import {Observable} from 'rxjs';
 import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
 
 // **********************************
@@ -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, ...)
+ * A InstanceOrTag 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);
 
@@ -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.
@@ -32,11 +32,11 @@ 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.
- * 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:**
@@ -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.
@@ -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;
 
     /**
@@ -277,7 +284,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.
@@ -288,10 +295,10 @@ 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> | 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.
@@ -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`
@@ -379,7 +392,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 +401,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 +453,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 +462,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 +475,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 +485,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

@@ -5,8 +5,9 @@
 // *********************************************
 
 // @ts-ignore
-import Observable from 'rxjs';
-import {Context, CloudObject, Relation, Property, Tag, Class} from "./base";
+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: Tag, 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: Tag, 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
@@ -246,7 +247,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 +411,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 +421,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 +430,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 +438,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 +448,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 +460,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 +479,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 +525,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,9 +876,17 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     concat(...others: QueryResult<T>[]): QueryResult<T>;
 }
 
+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:
@@ -934,7 +945,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 +957,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 +970,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 +978,9 @@ 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
      */
-    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?: 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.
@@ -1121,14 +1133,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 +1149,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 +1179,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
@@ -1189,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,
@@ -1219,7 +1230,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 +1246,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 +1255,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 +1289,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
@@ -1353,13 +1364,13 @@ 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.
      * @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 +1379,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;
 }
 
 /**
@@ -1579,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;
 
@@ -1595,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,6 +1,6 @@
 // @ts-ignore
-import Observable from 'rxjs';
-import {CloudObject, Direction, HasTag, Property, Relation, Tag} from "./base";
+import {Observable} from 'rxjs';
+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;