@olympeio/runtime-node 9.3.0 → 9.3.1

package/package.json

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

package/types/cloud.d.ts

@@ -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.

package/types/runtime.d.ts

@@ -3,8 +3,7 @@
 // **********************************
 // @ts-ignore
 import Observable from 'rxjs';
-import {CloudObject, Context, Property} from "./base";
-import {Entry} from "./legacy";
+import {CloudObject, Context, Property, Tag} from "./base";
 
 /**
  * Label of global properties used by convention through bricks and applications.
@@ -15,7 +14,7 @@ import {Entry} from "./legacy";
  * The brick "Begin Transaction" push a transaction inside the context so it can be reused by other bricks before the "End Transaction" brick.
  */
 export enum GlobalProperties {
-    EDITION_MODE = '__editionMode',
+    EDITION = '__editionMode',
     PRODUCTION = '__production',
     TRANSACTION = '__transaction'
 }