@olympeio/runtime-node 9.2.2 → 9.3.1

package/package.json

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

package/types/base.d.ts

@@ -6,15 +6,16 @@ import {PropertyModel, Query, QueryResult, QuerySingle} from "./cloud";
 // Primitives
 // **********************************
 
-declare type Class<T> = { new(): T };
 /**
  * A Tag can be either a `string`, a `HasTag` (CloudObject instance, Property, Relation, ...)
  * or the class constructor for a `CloudObject`
  */
-export type Tag = string | HasTag | Class<CloudObject>;
+export type Tag = string | HasTag | typeof CloudObject;
 
 export type List<T> = Array<T> | (T extends CloudObject | CloudObject[] ? QueryResult<T> : never);
 
+export type Class<T> = {new (): T};
+
 /**
  * Generates a unique olympe tag used to identify `CloudObjects`
  *
@@ -50,11 +51,11 @@ export interface HasTag {
  * Contexts have parents and children, they represent the lifecycle of bricks.
  * They contain callbacks executed at specific time of the brick lifespan.
  *
- * Each time a brick is updated with new inputs, {@link clear} is called,
- * executing all callbacks registered with {@link onClear}.
+ * Each time a brick is updated with new inputs, {@apilink Context.clear} is called,
+ * executing all callbacks registered with {@apilink Context.onClear}.
  *
- * When a brick is destroyed, {@link destroy} is called,
- * executing all callbacks registered with {@link onClear} and {@link onDestroy}
+ * When a brick is destroyed, {@apilink Context.destroy} is called,
+ * executing all callbacks registered with {@apilink Context.onClear} and {@apilink Context.onDestroy}
  */
 export abstract class Context {
     /**
@@ -78,7 +79,7 @@ export abstract class Context {
     onDestroy(callback: () => void): string;
 
     /**
-     * Remove a previously registered callback with {@link Context#onDestroy} method using its id.
+     * Remove a previously registered callback with {@apilink Context.onDestroy} method using its id.
      *
      * @param callbackId the id of the callback to unregister
      */
@@ -95,7 +96,7 @@ export abstract class Context {
     onClear(callback: () => void): string;
 
     /**
-     * Remove a previously registered callback with {@link Context#onClear} method using its id.
+     * Remove a previously registered callback with {@apilink Context.onClear} method using its id.
      *
      * @param id the id of the callback to unregister
      */
@@ -107,18 +108,18 @@ 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 [Tag]{@link Tag} of its model, and it can be instantiated multiple times with different properties values.
+ * A `CloudObject` can be instantiated via the {@apilink Tag} 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:**
  * ```javascript
- * const dcObject = olympe.dc.CloudObject.get(tag);
+ * const dcObject = CloudObject.get(tag);
  * ```
  */
 export abstract class CloudObject implements HasTag {
     /**
      * The attributes of a CloudObject are called properties. Properties can be of different types,
-     * e.g. `Property<string>`, `Property<number>`, Property<Date>`.
+     * e.g. `Property<string>`, `Property<number>`, `Property<Date>`.
      *
      * If a `Person` `CloudObject` has an `age` property, all the instances of `Person` can access
      * the `age` property using the same tag, the tag of the `age` property. This method returns all
@@ -129,7 +130,7 @@ export abstract class CloudObject implements HasTag {
     static getProperties(): Property<any>[];
 
     /**
-     * Return all the relations whose origin OR destination is the `CloudObject` associated to this class.
+     * Return all the relations whose origin OR destination is the {@apilink CloudObject} associated to this class.
      *
      * @return All relations defined on the current data type. It can be the destination or the origin of the relations.
      */
@@ -147,8 +148,9 @@ export abstract class CloudObject implements HasTag {
      * Get the CloudObject whose tag is specified.
      *
      * This only works if the `CloudObject` is already present in the local datacloud cache.
-     * (NB: you can use a {@link Query} to retrieve a distant `CloudObject`)
+     * (NB: you can use a {@apilink Query} to retrieve a distant {@apilink CloudObject})
      *
+     * @static
      * @param tag tag of the `CloudObject`
      * @return `CloudObject` specified by the tag
      */
@@ -161,6 +163,7 @@ export abstract class CloudObject implements HasTag {
      *
      * @param properties mappings of (propertyTag -> propertyValue)
      * @param model tag of the model of the `CloudObject` you want to create.
+     * @param source
      * @return newly created `CloudObject`
      */
     static createWith<T>(this: Class<T>, properties: Map<Tag, any>, model?: Tag, source?: string): T;
@@ -223,7 +226,7 @@ export abstract class CloudObject implements HasTag {
     /**
      * Start a query from this instance and follow the relation given as argument.
      * The query starts from this single instance, and follows a relation to an arbitrary
-     * number of destination instances. See [Query.follow]{@link Query#follow}
+     * number of destination instances. See {@apilink Query.follow | Query.follow(relation)}
      *
      * The following are equivalent:
      * ```javascript
@@ -249,7 +252,7 @@ export abstract class CloudObject implements HasTag {
 
     // Properties getters
     /**
-     * Get the current value of the specified property for this `CloudObject` instance
+     * Get the current value of the specified property for this {@apilink CloudObject} instance
      *
      * @param property property or property's tag
      * @return property value
@@ -260,10 +263,10 @@ export abstract class CloudObject implements HasTag {
      * Get an observable to the current value of the specified property for this `CloudObject` instance.
      *
      * The observable gets the new value each time the property gets updated in the datacloud.
-     * The observable gets completed automatically once the specified context is [cleared]{@link Context#onClear}.
+     * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
      * If `waitForValue` is set to FALSE (TRUE by default), the first value received by the observable is null if there is no value at call time.
      *
-     * @param context [context]{@link Context} to which the Observable is attached
+     * @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.
      * @return Observable of property values
@@ -274,9 +277,9 @@ export abstract class CloudObject implements HasTag {
      * Get an observable to pair [property, value] for this `CloudObject` instance.
      *
      * The observable gets the new value each time any property gets updated in the datacloud.
-     * The observable gets completed automatically once the specified context is [cleared]{@link Context#onClear}.
+     * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
      *
-     * @param context [context]{@link Context} to which the Observable is attached
+     * @param context Context to which the Observable will be attached
      * @return Observable of property values
      */
     observeProperties<T>(context: Context): Observable<[Property<T>, T]>;
@@ -296,12 +299,12 @@ export abstract class CloudObject implements HasTag {
 
     /**
      * Relation between a `CloudObject`and its model
-     * instance --modelRel-> model
+     * `instance --modelRel-> model`
      */
     static modelRel: Relation<CloudObject, CloudObject>;
 
     /**
-     * Inverse relation of {@link modelRel} between a model and its instances
+     * Inverse relation of {@apilink modelRel} between a model and its instances
      * Equivalent to `modelRel.getInverse()`
      */
     static instancesRel: Relation<CloudObject, CloudObject>;
@@ -310,12 +313,12 @@ export abstract class CloudObject implements HasTag {
      * from another `CloudObject` model to mimic their behaviour.
      *
      * Relation from a model to the CloudObject model it extends.
-     * A --extendRel-> B
+     * `A --extendRel-> B`
      * A inherits B's properties and relations.
      */
     static extendRel: Relation<CloudObject, CloudObject>;
     /**
-     * Inverse relation of {@link extendRel}
+     * Inverse relation of {@apilink extendRel}
      */
     static extendedByRel: Relation<CloudObject, CloudObject>;
     /**
@@ -337,15 +340,15 @@ export abstract class CloudObject implements HasTag {
 export interface Property<T> extends HasTag {}
 
 /**
- * Relations are directed from A -> B and can be followed in either direction.
+ * Relations are directed from A to B and can be followed in either direction.
  */
 export enum Direction {
     /**
-     * For relation A -> B, go to A, the origin
+     * For relation A to B, go to A, the origin
      */
     ORIGIN = '<',
     /**
-     * For relation A -> B, go to B, the destination
+     * For relation A to B, go to B, the destination
      */
     DESTINATION = '>'
 }
@@ -412,12 +415,12 @@ export interface Relation<O extends CloudObject, D extends CloudObject> extends
  *
  * This creates the link between a class and an DataType in the database.
  * Once this link is created, all the instances of the DataType (model)
- * are instantiated as JS objects using the specified class (see [CloudObject.get]{@link CloudObject#get})
+ * are instantiated as JS objects using the specified class (see {@apilink CloudObject.get})
  *
  * @param tag tag of the DataType
  * @param object `CloudObject` constructor
  */
-export function register(tag: Tag, object: Class<CloudObject>): void;
+export function register(tag: Tag, object: typeof CloudObject): void;
 
 /**
  * Create a constant property object which has the specified tag and type to be used in coded bricks.
@@ -431,7 +434,7 @@ export function defineProperty<T>(tag: Tag, type?: Class<T>): Property<T>;
 /**
  * Create a constant relation object between two specified DataTypes.
  *
- * That constant is used especially to create queries see [Query.follow(relation)]{@link Query#follow}
+ * That constant is used especially to create queries see {@apilink Query.follow | Query.follow(relation)}
  *
  * @param tag tag of the relation
  * @param origin origin DataType of the relation
@@ -443,7 +446,7 @@ export function defineRelation<O extends CloudObject, D extends CloudObject>(tag
 /**
  * Create a constant relation object between two generic `CloudObjects`
  *
- * That constant is used especially to create queries see [Query.follow(relation)]{@link Query#follow}
+ * That constant is used especially to create queries see {@apilink Query.follow | Query.follow(relation)}
  *
  * @param tag tag of the relation
  * @param direction direction of the relation, pointing towards origin or destination. Default is `DESTINATION`

package/types/cloud.d.ts

@@ -48,7 +48,7 @@ export class RelationModel extends CloudObject {
     /**
      * Relation from the origin data type to the RelationModel
      * */
-    static originModelRel: Relation<CloudObject, RelationModel>;
+    static originModelRel: Relation<RelationModel, CloudObject>;
     /**
      * Relation from a RelationModel to the destination data type
      * */
@@ -68,35 +68,35 @@ export class RelationModel extends CloudObject {
 }
 
 /**
- * StringModel represents a {@link PropertyModel} for a string property of a data type.
+ * StringModel represents a {@apilink PropertyModel} for a string property of a data type.
  */
 export class StringModel extends CloudObject {
     static valueProp: Property<string>;
 }
 
 /**
- * NumberModel represents a {@link PropertyModel} for a number property of a data type.
+ * NumberModel represents a {@apilink PropertyModel} for a number property of a data type.
  */
 export class NumberModel extends CloudObject {
     static valueProp: Property<number>;
 }
 
 /**
- * BooleanModel represents a {@link PropertyModel} for a boolean property of a data type.
+ * BooleanModel represents a {@apilink PropertyModel} for a boolean property of a data type.
  */
 export class BooleanModel extends CloudObject {
     static valueProp: Property<boolean>;
 }
 
 /**
- * DatetimeModel represents a {@link PropertyModel} for a datetime property of a data type.
+ * DatetimeModel represents a {@apilink PropertyModel} for a datetime property of a data type.
  */
 export class DatetimeModel extends CloudObject {
     static valueProp: Property<Date>;
 }
 
 /**
- * ColorModel represents a {@link PropertyModel} for a color property of a data type.
+ * ColorModel represents a {@apilink PropertyModel} for a color property of a data type.
  */
 export class ColorModel extends CloudObject {
     static valueProp: Property<Color>;
@@ -188,7 +188,7 @@ export class Enum extends CloudObject {
     /**
      * Create an empty `Enum?`  without any value
      *
-     * See {@link EnumValue#createValue} to create values for an Enum.
+     * See {@apilink EnumValue.createValue} to create values for an Enum.
      *
      * @param transaction transaction in which to create the Enum
      * @param name optional name of the Enum
@@ -239,28 +239,28 @@ export class EnumValue extends CloudObject {
 // -------------------------
 
 /**
- * A `Workflow` is a sequence of {@link WorkflowState} in which instances of a model goes through.
- * {@link WorkflowState} are linked by {@link WorkflowTransition} that can have an optional _process function_.
- * The `Workflow` also historize the {@link WorkflowState} of the instance and optionally serialize the object itself in a {@link WorkflowObjectState}.
+ * A `Workflow` is a sequence of {@apilink WorkflowState} in which instances of a model goes through.
+ * {@apilink WorkflowState} are linked by {@apilink WorkflowTransition} that can have an optional _process function_.
+ * The `Workflow` also historize the {@apilink WorkflowState} of the instance and optionally serialize the object itself in a {@apilink WorkflowObjectState}.
  */
 export class Workflow extends CloudObject {
     /** Is the instance serialization enabled or not */
     static serializationEnabledProp: Property<boolean>;
     /** The model to which the `Workflow` is associated */
     static dataTypeRel: Relation<Workflow, CloudObject>;
-    /** The {@link WorkflowState} that are in the `Workflow` */
+    /** The {@apilink WorkflowState} that are in the `Workflow` */
     static statesRel: Relation<Workflow, WorkflowState>;
-    /** The initial {@link WorkflowState} of the `Workflow` */
+    /** The initial {@apilink WorkflowState} of the `Workflow` */
     static initialStateRel: Relation<Workflow, WorkflowState>;
 }
 
 /**
- * A `WorkflowState` defines a state in a {@link Workflow}.
+ * A `WorkflowState` defines a state in a {@apilink Workflow}.
  */
 export class WorkflowState extends CloudObject { /* empty */ }
 
 /**
- * A `WorkflowTransition` defines a transition between 2 {@link WorkflowState}.
+ * A `WorkflowTransition` defines a transition between 2 {@apilink WorkflowState}.
  * It has a direction (`fromStateRel` to `toStateRel`) and can have an optional _process function_.
  * The _process function_ (`processRefProp`) is automatically triggered when the transition occurs.
  */
@@ -270,26 +270,26 @@ export class WorkflowTransition extends CloudObject {
      * It has this signature: (ControlFlow, CloudObject, User, Map) -> (ControlFlow, ErrorFlow)
      */
     static processRefProp: Property<Brick>;
-    /** The {@link WorkflowState} from which this transition starts */
+    /** The {@apilink WorkflowState} from which this transition starts */
     static fromStateRel: Relation<WorkflowTransition, WorkflowState>;
-    /** The {@link WorkflowState} to which this transition ends */
+    /** The {@apilink WorkflowState} to which this transition ends */
     static toStateRel: Relation<WorkflowTransition, WorkflowState>;
 }
 
 /**
  * A `WorkflowObjectState` represents the state of an instance at a certain point in time.
- * It is automatically created when initializing a {@link Workflow} on an instance or when triggering a {@link WorkflowTransition}.
+ * It is automatically created when initializing a {@apilink Workflow} on an instance or when triggering a {@apilink WorkflowTransition}.
  */
 export class WorkflowObjectState extends CloudObject {
-    /** The name of the {@link Workflow} associated */
+    /** The name of the {@apilink Workflow} associated */
     static workflowProp: Property<string>;
-    /** The name of the {@link WorkflowState} */
+    /** The name of the {@apilink WorkflowState} */
     static stateProp: Property<string>;
-    /** The name (login) of the {@link User} */
+    /** The name (login) of the {@apilink User} */
     static assigneeProp: Property<string>;
     /** The point in time of this object state */
     static dateTimeProp: Property<Date>;
-    /** If the {@link Workflow} has serialization enabled, the object's property are saved here in JSON */
+    /** If the {@apilink Workflow} has serialization enabled, the object's property are saved here in JSON */
     static serializedObjectProp: Property<string>;
     /** The related instance this object state represents */
     static objectRel: Relation<WorkflowObjectState, CloudObject>;
@@ -373,7 +373,7 @@ export class Transaction {
      * A custom map can specify property values for the instance.
      *
      * A source can be the orchestrator ('server'), local ('self') or
-     * an external data source ('<DBConnectorTag>'). The source is where
+     * an external data source (tag of DBConnector). The source is where
      * the object is persisted and its true value outside local scopes.
      *
      * @param model tag of the model of the instance to be created
@@ -398,7 +398,7 @@ export class Transaction {
      * Update multiple properties of a single instance
      *
      * @param instance tag of the instance to be updated
-     * @param properties (<propertyTag>, <propertyValue>) map to update properties
+     * @param properties map of properties to update
      * @return this transaction
      */
     multiUpdate(instance: Tag, properties: Map<Tag, any>): this;
@@ -476,7 +476,7 @@ export class Transaction {
      * `source` can be specified as :
      * 1. the orchestrator ('server'),
      * 2. local ('self') or
-     * 3. an external data source ('<DBConnectorTag>')
+     * 3. an external data source (Tag of a `DBConnector`)
      *
      * The source of a data object is where the object is persisted.
      *
@@ -516,21 +516,21 @@ export class Transaction {
     afterExecution(callback: (success: boolean, message?: string) => void): this;
 
     /**
-     * Execute atomically the transaction at the source
+     * Execute atomically the transaction at the data sources. Return the transaction result if succeeds.
      *
-     * @return promise resolving if the transaction succeeds,
+     * @return promise resolving with the corresponding TransactionResult if the transaction succeeds,
      * rejecting if the transaction fails
      */
-    execute(): Promise<void>;
+    execute(): Promise<TransactionResult>;
 
     /**
-     * Execute atomically a transaction at the source
+     * Execute atomically a transaction at the data source and returns the transaction result if succeeds.
      * The `large` mode sends the transaction over HTTP
      *
-     * @return promise resolving if the transaction succeeds,
+     * @return promise resolving with the corresponding TransactionResult if the transaction succeeds,
      * rejecting if the transaction fails.
      */
-    executeAsLarge(): Promise<void>;
+    executeAsLarge(): Promise<TransactionResult>;
 
     /**
      * Start a transaction using an existing transaction in the provided context
@@ -551,6 +551,20 @@ export class Transaction {
     static process($: BrickContext, transaction: Transaction): Promise<boolean>;
 }
 
+/**
+ * A transaction result is the object received after a transaction has been executed successfully.
+ * It provides information about what has been done.
+ */
+export class TransactionResult {
+
+    /**
+     * Return the ordered list of CloudObjects created in this transaction.
+     *
+     * @return the list of CloudObjects instances
+     */
+    getCreatedObjects(): CloudObject[];
+}
+
 /**
  * BurstTransactions are designed to continuously apply high rates of updates on properties (FIFO ordering).
  * The only operation supported by BurstTransactions is to update properties of an instance.
@@ -569,14 +583,14 @@ export class BurstTransaction {
      * Push all property values from specified Observable to update specified object
      *
      * @param object the object to update
-     * @param values observable of a `Map<Property<T>, T>` mapping properties to new values
+     * @param values observable mapping properties to new values
      */
     push<T>(object: CloudObject, values: Observable<Map<Property<T>, T>>): void;
 
     /**
      * Commit and close the burst transaction
      *
-     * @return Promise<void> completing with commit success/failure
+     * @return A `Promise` completing with commit success/failure
      */
     complete(): Promise<void>;
 }
@@ -590,7 +604,7 @@ export class BurstTransaction {
  * It contains the result of a query at a specific time.
  *
  * The keys are tags (e.g. `myTag`) that correspond to a `CloudObject` (e.g. `myCloudObject`).
- * When the {@link Query} contains more than one [Query.andReturn()]{@link Query#andReturn} clause,
+ * When the {@apilink Query} contains more than one {@apilink Query.andReturn Query.andReturn()} clause,
  * keys are composite tags (e.g. `'tag1.tag2.tag3'`) and values are tuples of `CloudObjects` (e.g. `[cloudObj1, cloudObj2, cloudObj3]`).
  * Such a QueryResult can be obtained via:
  * ```javascript
@@ -697,7 +711,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     getAt(index: number): T | null;
 
     /**
-     * Returns an array equivalent to [this.toArray().push(...object)]{@link toArray}
+     * Returns an array equivalent to {@apilink QueryResult.toArray | this.toArray().push(...object)}
      *
      * This operation returns a new array and does not modify this QueryResult.
      *
@@ -709,7 +723,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     /**
      * Returns the QueryResult values as an array whose last value has been removed.
      *
-     * If [QueryResult.size()]{@link size} is 0 or 1, this method returns an empty array.
+     * If {@apilink QueryResult.size} is 0 or 1, this method returns an empty array.
      *
      * This operation returns a new array and does not modify this QueryResult.
      *
@@ -720,7 +734,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     /**
      * Returns the QueryResult values as an array whose first value has been removed.
      *
-     * If [QueryResult.size()]{@link size} is 0 or 1, this method returns an empty array.
+     * If {@apilink QueryResult.size} is 0 or 1, this method returns an empty array.
      *
      * This operation returns a new array and does not modify this QueryResult.
      *
@@ -732,7 +746,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
      * Returns the new values added since the last `QueryResult` update.
      * In other words, `getAdded` returns the new values that exists in this query result, but did not in the previous query result pushed by the Observable.
      *
-     * This applies only when *observing* a [Query]{@link Query#observe}.
+     * This applies only when {@apilink Query.observe | observing} a {@apilink Query}.
      *
      * @return values added
      */
@@ -742,7 +756,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
      * Returns the keys of values removed since the last `QueryResult` update.
      * In other words, `getRemoved` returns the old values that existed in the previous query result, but are no longer present in this query result pushed by the Observable.
      *
-     * This applies only when *observing* a [Query]{@link Query#observe}.
+     * This applies only when {@apilink Query.observe | observing} a {@apilink Query}.
      *
      * @return keys of the removed values
      */
@@ -751,7 +765,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     /**
      * Returns an array containing the values matching the provided filter predicate.
      *
-     * @param predicate filter {@link Predicate}
+     * @param predicate filter {@apilink Predicate}
      * @return array of matching values
      */
     filter(predicate: (entry: T, index: number) => boolean): T[];
@@ -798,7 +812,7 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
     /**
      * Return a reduced value for this QueryResult.
      *
-     * The specified `reducer` callback reduces the QueryResult values as [reduce]{@link Array#reduce}
+     * The specified `reducer` callback reduces the QueryResult values. Similar to `Array.reduce()`.
      *
      * @param reducer callback
      * @param initial initial value of the accumulator
@@ -813,8 +827,8 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
      *
      * - the keys of the QueryResults are concatenated
      * - the values of the QueryResults are concatenated
-     * - the arrays returned by {@link getAdded} are concatenated
-     * - the arrays returned by {@link getRemoved} are concatenated
+     * - the arrays returned by {@apilink QueryResult.getAdded} are concatenated
+     * - the arrays returned by {@apilink QueryResult.getRemoved} are concatenated
      *
      * Example : ```javascript
      * const result1 = Query.fromInstances(myModel1).executeFromCache();
@@ -898,14 +912,14 @@ export class Query<T extends CloudObject, R> {
      * @param model tag/class of the model to find the instances of
      * @param source optional source of the data to answer the query
      * A source can be the orchestrator ('server'), local ('self') or
-     * an external data source ('<DBConnectorTag>')
+     * 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, source?: string): Query<T extends CloudObject ? T : CloudObject, never>;
 
     /**
      * Instruct the query to follow a specified relation. This does not add any key-value pair to the result.
-     * (see {@link andReturn}). This operation defines a new step in the path defined by our graph query.
+     * (see {@apilink Query.andReturn}). This operation defines a new step in the path defined by our graph query.
      *
      * Example:
      * Find the model of a single object.
@@ -919,7 +933,7 @@ export class Query<T extends CloudObject, R> {
     follow<D extends CloudObject>(relation: Relation<T, D>): Query<D, R>;
 
     /**
-     * Follow a relation recursively, see {@link follow}.
+     * Follow a relation recursively, see {@apilink Query.follow}.
      * The relation that is followed is automatically recursively followed.
      * All nodes that are recursively followed are part of the same step in the path defined by this graph query.
      *
@@ -948,7 +962,7 @@ export class Query<T extends CloudObject, R> {
 
     /**
      * Define a filter operation on the current working set of nodes.
-     * It filters out instances that don't match the given {@link Predicate}
+     * It filters out instances that don't match the given {@apilink Predicate}
      *
      * @param predicate
      * @return a new query object with the new filter operation
@@ -1007,7 +1021,7 @@ export class Query<T extends CloudObject, R> {
      * ascending order.
      *
      * @param property the property used for sorting
-     * @param order optional [Order.ASC]{@link Order#ASC} (default) or [Order.DESC]{@link Order#DESC} order
+     * @param order optional {@apilink Order.ASC} (default) or {@apilink Order.DESC} order
      * @return new query with sort operation
      */
     sortBy(property: Property<any>, order?: Order): Query<T, R>;
@@ -1027,9 +1041,9 @@ export class Query<T extends CloudObject, R> {
      *
      * The observable gets the new value each time data modification in the datacloud changes the result of the query.
      *
-     * The observable gets completed automatically once the specified context is [cleared]{@link Context#onClear}.
+     * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
      *
-     * @param context [context]{@link Context} to which the Observable is attached
+     * @param context {@apilink Context} to which the Observable is attached
      * @return Observable of QueryResult values
      */
     observe(context: Context): Observable<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
@@ -1054,7 +1068,7 @@ export class Query<T extends CloudObject, R> {
 export class QuerySingle<T extends CloudObject> {
     /**
      * Create a `query single` from a single node.
-     * See [Query.from]{@link Query#from}
+     * See {@apilink Query.from}
      *
      * @param object starting node for the graph query single
      * @return new query single only accepting 0..1 relations
@@ -1063,7 +1077,7 @@ export class QuerySingle<T extends CloudObject> {
 
     /**
      * Follow a 0..1 relation
-     * See [Query.follow()]{@link Query#follow}
+     * See {@apilink Query.follow | Query.follow()}
      *
      * @param relation relation to next node
      * @return new query single with follow operation
@@ -1071,7 +1085,7 @@ export class QuerySingle<T extends CloudObject> {
     follow<D extends CloudObject>(relation: Relation<T, D>): QuerySingle<D>;
 
     /**
-     * See [Query.cast()]{@link Query#cast}
+     * See {@apilink Query.cast | Query.cast()}
      *
      * @param type the new type
      * @return query single on a node of the specified type
@@ -1079,7 +1093,7 @@ export class QuerySingle<T extends CloudObject> {
     cast<S extends CloudObject>(type: Class<S>): QuerySingle<S>;
 
     /**
-     * Execute the query single, see [Query.execute()]{@link Query#execute}
+     * Execute the query single, see {@apilink Query.execute | Query.execute()}
      *
      * @param context
      * @return promise containing the single result or `null`
@@ -1088,7 +1102,7 @@ export class QuerySingle<T extends CloudObject> {
 
     /**
      * Execute the query single on the local data cloud,
-     * see [Query.executeFromCache()]{@link Query#executeFromCache}
+     * see {@apilink Query.executeFromCache | Query.executeFromCache()}
      *
      * @return single result value or `null`
      */