@olympeio/runtime-node 9.0.3 → 9.1.0

package/package.json

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

package/types/base.d.ts

@@ -1,6 +1,6 @@
 // @ts-ignore
 import Observable from 'rxjs';
-import {Empty, PropertyModel, Query, QueryResult, QuerySingle} from "./cloud";
+import {PropertyModel, Query, QueryResult, QuerySingle} from "./cloud";
 
 // **********************************
 // Primitives
@@ -13,7 +13,7 @@ declare type Class<T> = { new(): T };
  */
 export type Tag = string | HasTag | Class<CloudObject>;
 
-export type List<T> = Array<T> | QueryResult<T>;
+export type List<T> = Array<T> | (T extends CloudObject | CloudObject[] ? QueryResult<T> : never);
 
 /**
  * Generates a unique olympe tag used to identify `CloudObjects`
@@ -141,7 +141,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: Tag): Query<T, Empty>;
+    static instancesOf<T extends CloudObject>(model: Class<T> | Tag): Query<T, never>;
 
     /**
      * Get the CloudObject whose tag is specified.
@@ -206,7 +206,7 @@ export abstract class CloudObject implements HasTag {
      *
      * @return a query starting at this `CloudObject` instance
      */
-    query(): Query<this, Empty>;
+    query(): Query<this, never>;
 
     /**
      * Return the persistence state of this instance.
@@ -234,7 +234,7 @@ export abstract class CloudObject implements HasTag {
      * @param relation the relation to follow from the starting instance (`this`)
      * @return query starting from `this` and following the relation `relation` as first step of the query
      */
-    follow<D extends CloudObject>(relation: Relation<this, D>): Query<D, Empty>;
+    follow<D extends CloudObject>(relation: Relation<this, D>): Query<D, never>;
 
     /**
      * Start a `querySingle` from this instance that follows 0..1 relations
@@ -261,12 +261,32 @@ export abstract class CloudObject implements HasTag {
      *
      * 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}.
+     * 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 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
      */
-    observe<T>(context: Context, property: Property<T> | Tag): Observable<T>;
+    observe<T>(context: Context, property: Property<T> | Tag, waitForValue?: boolean): Observable<T>;
+
+    /**
+     * 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}.
+     *
+     * @param context [context]{@link Context} to which the Observable is attached
+     * @return Observable of property values
+     */
+    observeProperties<T>(context: Context): Observable<[Property<T>, T]>;
+
+    /**
+     * Create a Javascript object from this CloudObject current state.
+     * @param namesAsKey If true, use the property name instead of the property tag as keys of the generated object.
+     * @param inheritedProperties If false, do not including inherited property. By default, it includes them.
+     */
+    toObject(namesAsKey?: boolean, inheritedProperties?: boolean): Object;
 
     // Properties and Relations
     /**
@@ -330,13 +350,14 @@ export enum Direction {
     DESTINATION = '>'
 }
 
-/**
- * Relations can be defined between from a `CloudObject` to another, for example between two data types.
- * Relations are directed and have two types: the origin type, the destination type.
- *
- * Defining a relation between two data types means that instances of these data types can be related with that relation.
- */
-export class Relation<O extends CloudObject, D extends CloudObject> implements HasTag {
+interface RelationConstructor {
+    /**
+     * Create a relation between two CloudObject classes
+     * @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>;
+
     /**
      * Create a relation between two CloudObject classes
      * @param tag tag of the relation to create
@@ -344,7 +365,21 @@ export class Relation<O extends CloudObject, D extends CloudObject> implements H
      * @param origin origin class of the relation
      * @param destination destination class of the relation
      */
-    constructor(tag: Tag, direction?: Direction, origin?: Class<O>, destination?: Class<D>);
+    new<O extends CloudObject, D extends CloudObject>(tag: Tag, direction?: Direction, origin?: Class<O>, destination?: Class<D>): Relation<O, D>;
+}
+
+/**
+ * Global variable, constructor of class Relation.
+ */
+export declare const Relation: RelationConstructor;
+
+/**
+ * Relations can be defined between from a `CloudObject` to another, for example between two data types.
+ * Relations are directed and have two types: the origin type, the destination type.
+ *
+ * Defining a relation between two data types means that instances of these data types can be related with that relation.
+ */
+export interface Relation<O extends CloudObject, D extends CloudObject> extends HasTag {
 
     /**
      * @return tag of the relation

package/types/cloud.d.ts

@@ -7,7 +7,7 @@
 // @ts-ignore
 import Observable from 'rxjs';
 import {Context, CloudObject, Relation, Property, Tag, Class} from "./base";
-import {BrickContext} from './runtime';
+import {Brick, BrickContext} from './runtime';
 import {Color} from "./utils";
 
 // --------------------------
@@ -178,7 +178,7 @@ export class User extends CloudObject {
     static loginProp: Property<string>;
     static saltProp: Property<string>;
     static verifierProp: Property<string>;
-    static SAMLNameIdProp: Property<string>;
+    static SAMLnameIdProp: Property<string>;
 }
 
 /**
@@ -234,6 +234,69 @@ export class EnumValue extends CloudObject {
     static rankProp: Property<number>;
 }
 
+// -------------------------
+// -- Workflow data types --
+// -------------------------
+
+/**
+ * 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}.
+ */
+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` */
+    static statesRel: Relation<Workflow, WorkflowState>;
+    /** The initial {@link WorkflowState} of the `Workflow` */
+    static initialStateRel: Relation<Workflow, WorkflowState>;
+}
+
+/**
+ * A `WorkflowState` defines a state in a {@link Workflow}.
+ */
+export class WorkflowState extends CloudObject { /* empty */ }
+
+/**
+ * A `WorkflowTransition` defines a transition between 2 {@link 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.
+ */
+export class WorkflowTransition extends CloudObject {
+    /**
+     * The `WorkflowTransition` optional _process function_.
+     * It has this signature: (ControlFlow, CloudObject, User, Map) -> (ControlFlow, ErrorFlow)
+     */
+    static processRefProp: Property<Brick>;
+    /** The {@link WorkflowState} from which this transition starts */
+    static fromStateRel: Relation<WorkflowTransition, WorkflowState>;
+    /** The {@link 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}.
+ */
+export class WorkflowObjectState extends CloudObject {
+    /** The name of the {@link Workflow} associated */
+    static workflowProp: Property<string>;
+    /** The name of the {@link WorkflowState} */
+    static stateProp: Property<string>;
+    /** The name (login) of the {@link 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 */
+    static serializedObjectProp: Property<string>;
+    /** The related instance this object state represents */
+    static objectRel: Relation<WorkflowObjectState, CloudObject>;
+    /** The related instance this object state represents. This relation only reference the current state */
+    static currentObjectRel: Relation<WorkflowObjectState, CloudObject>;
+}
+
 // ---------------------------
 // -- Database transactions --
 // ---------------------------
@@ -503,7 +566,6 @@ export class BurstTransaction {
 // ----------------------
 // -- Database queries --
 // ----------------------
-type Empty = [];
 
 /**
  * A QueryResult is a list of key-value pairs that has been generated as a result of a `Query`.
@@ -521,7 +583,7 @@ type Empty = [];
  *
  * A QueryResult can be easily manipulated and transformed to a standard Array.
  */
-export class QueryResult<T> {
+export class QueryResult<T extends CloudObject | CloudObject[]> {
     /**
      *@return empty `QueryResult`
      */
@@ -578,7 +640,6 @@ export class QueryResult<T> {
      *
      * @param key the value to search for
      * @return true if the value `key` is found
-     * @TODO why T, it's CloudObjects
      */
     has(key: T | string): boolean;
 
@@ -591,7 +652,6 @@ export class QueryResult<T> {
      *
      * @param key the value to find the index of
      * @return index of the argument value or -1 if the value is not found
-     * TODO why T, it's CloudObjects
      */
     indexOf(key: T | string): number;
 
@@ -676,7 +736,7 @@ export class QueryResult<T> {
      * @param predicate filter {@link Predicate}
      * @return array of matching values
      */
-    filter(predicate: (entry: T) => boolean): T[];
+    filter(predicate: (entry: T, index: number) => boolean): T[];
 
     /**
      * Returns the first value matching the predicate, `null` otherwise.
@@ -687,14 +747,14 @@ export class QueryResult<T> {
      * @param predicate
      * @return the first value evaluating to true or `null`
      */
-    find(predicate: (entry: T) => boolean): T | null;
+    find(predicate: (entry: T, index: number) => boolean): T | null;
 
     /**
      * Execute the specified callback function for each value of this `QueryResult`
      *
      * @param callback
      */
-    forEach(callback: (entry: T) => void): void;
+    forEach(callback: (entry: T, index: number) => void): void;
 
     /**
      * Execute the specified callback function for each value of this `QueryResult`.
@@ -703,7 +763,7 @@ export class QueryResult<T> {
      * @param callback
      * @return new array of transformed values
      */
-    map<S>(callback: (entry: T) => S): S[];
+    map<S>(callback: (entry: T, index: number) => S): S[];
 
     /**
      * Return a sorted copy of this QueryResult.
@@ -726,7 +786,7 @@ export class QueryResult<T> {
      * @param initial initial value of the accumulator
      * @return  accumulated result applying the `reducer` function iteratively
      */
-    reduce<S>(reducer: (accumulator: S, entry: T) => S, initial: S): S;
+    reduce<S>(reducer: (accumulator: S, entry: T, index: number) => S, initial: S): S;
 
     /**
      * Return a new QueryResult that contains the concatenation of two or more QueryResults.
@@ -803,15 +863,16 @@ export class QueryResult<T> {
  * - observe(): it runs the query on the datacloud and subscribes to updates. It returns an Observable which provides a new QueryResult every time the result changes.
  * - executeFromCache(): it runs the query on the *local* datacloud which may be incomplete view of the datacloud (it is the local cache). It is executed synchronously.
  */
-export class Query<T extends CloudObject, R extends any[]> {
+export class Query<T extends CloudObject, R> {
 
     /**
      * Create a query starting from the `CloudObject` specified tag
      *
      * @param tag tag of the `CloudObject` the query is starting from
+     * @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 CloudObject>(tag: Tag): Query<T, Empty>;
+    static from<T extends Tag>(tag: T, source?: string): Query<T extends CloudObject ? T : CloudObject, never>;
 
     /**
      * Create a query starting from the instances of the specified model
@@ -822,7 +883,7 @@ export class Query<T extends CloudObject, R extends any[]> {
      * an external data source ('<DBConnectorTag>')
      * @return a new query object starting from model instances
      */
-    static instancesOf<T extends CloudObject>(model: Tag, source?: string): Query<T, Empty>;
+    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.
@@ -865,7 +926,7 @@ export class Query<T extends CloudObject, R extends any[]> {
      *
      * @return a new query object with the current level flagged to be returned.
      */
-    andReturn(): Query<T, [...R, T]>;
+    andReturn(): Query<T, R extends never ? T : R extends CloudObject[] ? [...R, T] : [R, T]>;
 
     /**
      * Define a filter operation on the current working set of nodes.
@@ -941,7 +1002,7 @@ export class Query<T extends CloudObject, R extends any[]> {
      * one has to provide a context that won't be destroyed before the query has a result.
      * @return promise resolving to query result or failing otherwise.
      */
-    execute(context: Context): Promise<QueryResult<R>>;
+    execute(context: Context): 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.
@@ -953,7 +1014,7 @@ export class Query<T extends CloudObject, R extends any[]> {
      * @param context [context]{@link Context} to which the Observable is attached
      * @return Observable of QueryResult values
      */
-    observe(context: Context): Observable<QueryResult<R>>;
+    observe(context: Context): Observable<QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>>;
 
     /**
      * Execute synchronously the query on the local datacloud cache.
@@ -961,7 +1022,7 @@ export class Query<T extends CloudObject, R extends any[]> {
      *
      * @return query result of the execution on the local cache
      */
-    executeFromCache(): QueryResult<R>;
+    executeFromCache(): QueryResult<R extends never ? T : R extends CloudObject | CloudObject[] ? R : never>;
 }
 
 /**

package/types/utils.d.ts

@@ -65,11 +65,6 @@ export class ServiceRequest {
      */
     userTag(): Promise<string>;
 
-    /**
-     * @return the type of the request
-     */
-    getType(): RequestType;
-
     /**
      * Get the request body.
      *
@@ -170,16 +165,6 @@ export class Service {
     static observe(service: string, context: Context, payload?: Object): Observable<Object>;
 }
 
-/**
- * Possible types of request coming for services.
- */
-export enum RequestType {
-    SEND,
-    GET,
-    PUBLISH,
-    SUBSCRIBE
-}
-
 // -- Authentication --
 /**
  * A static class that gathers all the required methods to handle the authentication and sessions with Olympe.