@olympeio/runtime-node 9.9.1 → 9.10.0

package/package.json

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

package/types/cloud.d.ts

@@ -800,6 +800,22 @@ export class QueryResult<T extends CloudObject | CloudObject[]> {
      */
     getAt(index: number): T | null;
 
+    /**
+     * Query Results, when used in a subscription, can be used to observe changes compare to the previous QueryResult.
+     * This method returns the values that have added from the previous QueryResult.
+     *
+     * @return array of added values (CloudObjects or tuples of CloudObjects)
+     */
+    getAdded(): T[];
+
+    /**
+     * Query Results, when used in a subscription, can be used to observe changes compare to the previous QueryResult.
+     * This method returns the values the keys (eg: tags) of values that have been removed from the previous QueryResult.
+     *
+     * @return array of removed keys (tags or tags concatenation (tuples))
+     */
+    getRemoved(): string[];
+
     /**
      * Returns an array equivalent to {@apilink QueryResult.toArray | this.toArray().push(...object)}
      *
@@ -1320,16 +1336,6 @@ export class Predicate {
      */
     static smallerThan(property: Property<number>, value: number, strict?: boolean): Predicate;
 
-    /**
-     * Create a predicate matching the expected model. If extend=true, the predicate will match
-     * against inherited models as well
-     *
-     * @param expectedModel the expected model
-     * @param extend should the predicate also match against inherited models
-     * @return new Predicate
-     */
-    static instanceOf(expectedModel: InstanceOrTag, extend: boolean): Predicate;
-
     /**
      * Create a predicate matching a specified number property to a number property lower bound
      *
@@ -1622,6 +1628,14 @@ export interface QueryPart {
  * Represents a data source that can be used to retrieve, manipulate and store data outside the Olympe application environment.
  * This class provides several methods for performing CRUD (create, read, update, delete) operations on data,
  * as well as file upload and download functionality.
+ *
+ * To create a new data source, add a _Data Connector_ in your project in DRAW and download the boilerplate.
+ * Then implement or extend the required methods: `init`, `destroy`, `healthCheck`, `executeQuery` and `applyTransaction`
+ * For file capabilities, you must also implement: `uploadFileContent`, `downloadFileContent` and `deleteFileContent`
+ *
+ * The CORE library already provide some default connectors such as PostgreSQL and MSSQL.
+ * Their implementation is open source and available in [CORE on Github](https://github.com/olympeio/CORE/tree/master/src/core/data/connectors).
+ *
  * @abstract
  * @extends {@apilink CloudObject}
  */

package/types/runtime.d.ts

@@ -253,7 +253,9 @@ export abstract class Brick extends CloudObject {
     protected onDestroy($: BrickContext): void;
 }
 
-
+/**
+ * @deprecated use {@apilink Brick} instead
+ */
 export abstract class ActionBrick extends Brick { }
 
 // **********************