@cubicweb/client 1.9.0 → 2.0.0

package/lib/api/Client.d.ts

@@ -1,11 +1,12 @@
 import { Schema } from "../schema/classes/Schema";
 import { RQLParams, ResultSet, CurrentUser } from "./Api";
-import Transaction from "./Transaction";
+import { Transaction, TransactionBackend, TransactionResult } from "./Transaction";
 /**
  * Class used to communicate with a CubicWeb instance's API.
  */
 export default class Client {
     private api;
+    private transactionBackend;
     /**
      * Class used to communicate with a CubicWeb instance's API.
      *
@@ -13,7 +14,9 @@ export default class Client {
      * Example: if you can retrieve the schema with https://example.com/api/v1/schema,
      * use https://example.com/api as `apiUrl`.
      */
-    constructor(apiUrl: string);
+    constructor(apiUrl: string, { transactionBackend: transactionBackend, }: {
+        transactionBackend?: TransactionBackend;
+    });
     get apiUrl(): string;
     /**
      * Executes the given query and waits for the response.
@@ -44,15 +47,9 @@ export default class Client {
      */
     currentUser(): Promise<CurrentUser>;
     /**
-     * Creates a new transaction and exposes the Transaction object in the given callback.
-     * Use this callback to execute RQL requests as part of the transaction.
-     * Once the callback's end is reached, the transaction is automatically committed.
-     * Note that any exception thrown by the callback will lead to the
-     * transaction being rolled back.
-     *
-     * @param callback Function to execute transaction requests in.
-     * @returns The promise returned by the callback
+     * @param transaction Transaction to execute
+     * @returns A promise fulfilled when the transaction is completed
      */
-    transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T>;
+    executeTransaction(transaction: Transaction): Promise<TransactionResult>;
 }
 //# sourceMappingURL=Client.d.ts.map

package/lib/api/Client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC/D,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IAEjB;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM;IAI1B,IAAI,MAAM,WAET;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAIxE;;;;OAIG;IACG,MAAM;IAKZ;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3C;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAIzC;;;;;;;;;OASG;IACG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAkB5E"}
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC/D,OAAO,EAEL,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IACjB,OAAO,CAAC,kBAAkB,CAAqB;IAE/C;;;;;;OAMG;gBAED,MAAM,EAAE,MAAM,EACd,EACE,kBAAkB,EAAE,kBAAkB,GACvC,EAAE;QAAE,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;KAAE;IAUhD,IAAI,MAAM,WAET;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAIxE;;;;OAIG;IACG,MAAM;IAKZ;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3C;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAIzC;;;OAGG;IACG,kBAAkB,CACtB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,iBAAiB,CAAC;CAG9B"}

package/lib/api/Client.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Schema_1 = require("../schema/classes/Schema");
 const Api_1 = __importDefault(require("./Api"));
-const Transaction_1 = __importDefault(require("./Transaction"));
+const Transaction_1 = require("./Transaction");
 /**
  * Class used to communicate with a CubicWeb instance's API.
  */
@@ -26,8 +26,14 @@ class Client {
      * Example: if you can retrieve the schema with https://example.com/api/v1/schema,
      * use https://example.com/api as `apiUrl`.
      */
-    constructor(apiUrl) {
+    constructor(apiUrl, { transactionBackend: transactionBackend, }) {
         this.api = new Api_1.default(apiUrl);
+        if (transactionBackend === undefined) {
+            this.transactionBackend = new Transaction_1.NativeTransactionBackend();
+        }
+        else {
+            this.transactionBackend = transactionBackend;
+        }
     }
     get apiUrl() {
         return this.api.apiUrl;
@@ -78,33 +84,12 @@ class Client {
         });
     }
     /**
-     * Creates a new transaction and exposes the Transaction object in the given callback.
-     * Use this callback to execute RQL requests as part of the transaction.
-     * Once the callback's end is reached, the transaction is automatically committed.
-     * Note that any exception thrown by the callback will lead to the
-     * transaction being rolled back.
-     *
-     * @param callback Function to execute transaction requests in.
-     * @returns The promise returned by the callback
+     * @param transaction Transaction to execute
+     * @returns A promise fulfilled when the transaction is completed
      */
-    transaction(callback) {
+    executeTransaction(transaction) {
         return __awaiter(this, void 0, void 0, function* () {
-            const transaction = new Transaction_1.default(this.api);
-            yield transaction.begin();
-            let result;
-            try {
-                result = yield callback(transaction);
-            }
-            catch (error) {
-                if (!transaction.isClosed()) {
-                    yield transaction.rollback();
-                }
-                throw error;
-            }
-            if (!transaction.isClosed()) {
-                yield transaction.commit();
-            }
-            return result;
+            return yield this.transactionBackend.execute(transaction);
         });
     }
 }

package/lib/api/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,qDAAkD;AAClD,gDAA+D;AAC/D,gEAAwC;AAExC;;GAEG;AACH,MAAqB,MAAM;IAGzB;;;;;;OAMG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACG,MAAM;;YACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;KAAA;IAED;;;;;;OAMG;IACG,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACG,WAAW;;YACf,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KAAA;IAED;;;;;;;;;OASG;IACG,WAAW,CAAI,QAAyC;;YAC5D,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAE1B,IAAI,MAAS,CAAC;YACd,IAAI;gBACF,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE;oBAC3B,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;iBAC9B;gBACD,MAAM,KAAK,CAAC;aACb;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE;gBAC3B,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC;aAC5B;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAvFD,yBAuFC"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,qDAAkD;AAClD,gDAA+D;AAC/D,+CAKuB;AAEvB;;GAEG;AACH,MAAqB,MAAM;IAIzB;;;;;;OAMG;IACH,YACE,MAAc,EACd,EACE,kBAAkB,EAAE,kBAAkB,GACM;QAE9C,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,kBAAkB,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,kBAAkB,GAAG,IAAI,sCAAwB,EAAE,CAAC;SAC1D;aAAM;YACL,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;SAC9C;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACG,MAAM;;YACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;KAAA;IAED;;;;;;OAMG;IACG,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACG,WAAW;;YACf,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KAAA;IAED;;;OAGG;IACG,kBAAkB,CACtB,WAAwB;;YAExB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC5D,CAAC;KAAA;CACF;AA/ED,yBA+EC"}

package/lib/api/Transaction.d.ts

@@ -1,57 +1,31 @@
-import Api, { RQLParams } from "./Api";
-/**
- * Class used to handle CubicWeb's transactions.
- * A transaction allows to execute several RQL requests without altering the database until all
- * changes are committed.
- *
- * You should never have to create this object yourself.
- * Instead, retrieve this object from the methods in the `Client` class.
- */
-export default class Transaction {
-    private api;
-    private _uuid;
-    private _closed;
-    /**
-     * Class used to handle CubicWeb's transactions.
-     * A transaction allows to execute several RQL requests without altering the database until all
-     * changes are committed.
-     *
-     * You should never have to create this object yourself.
-     * Instead, retrieve this object from the methods in the `Client` class.
-     *
-     * @param api The API object used to communicate with the CubicWeb backend.
-     */
-    constructor(api: Api);
-    /**
-     * @returns True if the connection is closed.
-     */
-    isClosed(): boolean;
-    /**
-     * This transaction unique identifier.
-     */
-    get uuid(): string | null;
-    /**
-     * Begins a new transaction an retrieves the associated uuid.
-     */
-    begin(): Promise<void>;
-    /**
-     * Executes the given query and waits for the response.
-     * Make sure you called `begin` before using this method.
-     * As this is a transaction changes will only be applied when you call the `commit` method.
-     *
-     * @param query The RQL query to send
-     * @param params The additional parameters for the request
-     * @returns A promise with the request's result set
-     */
-    execute(query: string, params?: RQLParams): Promise<import("./Api").ResultSet | null>;
-    /**
-     * Commits the transaction to apply all the RQL queries sent with `execute`.
-     */
-    commit(): Promise<void>;
-    /**
-     * Rollbacks all the queries sent with `execute` and closes the transaction.
-     */
-    rollback(): Promise<void>;
-    private preventUsageIfClosed;
+import { ResultSet } from "./Api";
+export declare class Transaction {
+    private _queries;
+    push(query: string, params: Record<string, string | number | TransactionQueryRef>): TransactionQuery;
+    get queries(): ReadonlyArray<TransactionQuery>;
+}
+export declare class TransactionResult {
+    private resultSets;
+    constructor(resultSets: ReadonlyArray<ResultSet>);
+    resolve(ref: TransactionQueryRef): string | number | boolean | null;
+}
+export interface TransactionQueryRef {
+    queryIndex: number;
+    row: number;
+    column: number;
+}
+export declare class TransactionQuery {
+    readonly query: string;
+    readonly params: Record<string, string | number | TransactionQueryRef>;
+    readonly index: number;
+    constructor(query: string, params: Record<string, string | number | TransactionQueryRef>, index: number);
+    ref(row?: number, column?: number): TransactionQueryRef;
+}
+export declare function isTransactionQueryRef(value: string | number | TransactionQueryRef): value is TransactionQueryRef;
+export interface TransactionBackend {
+    execute(transaction: Transaction): Promise<TransactionResult>;
+}
+export declare class NativeTransactionBackend {
+    execute(): Promise<TransactionResult>;
 }
 //# sourceMappingURL=Transaction.d.ts.map

package/lib/api/Transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAclB,OAAO,CAAC,GAAG;IAbvB,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,OAAO,CAAS;IAExB;;;;;;;;;OASG;gBACiB,GAAG,EAAE,GAAG;IAE5B;;OAEG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,IAAI,kBAEP;IAED;;OAEG;IACG,KAAK;IAKX;;;;;;;;OAQG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAKnD;;OAEG;IACG,MAAM;IAMZ;;OAEG;IACG,QAAQ;IAMd,OAAO,CAAC,oBAAoB;CAK7B"}
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAA+B;IAE/C,IAAI,CACF,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,mBAAmB,CAAC,GAC5D,gBAAgB;IAUnB,IAAI,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAE7C;CACF;AAED,qBAAa,iBAAiB;IAChB,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC;IAExD,OAAO,CAAC,GAAG,EAAE,mBAAmB;CAGjC;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,gBAAgB;aAET,KAAK,EAAE,MAAM;aACb,MAAM,EAAE,MAAM,CAC5B,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,mBAAmB,CACtC;aACe,KAAK,EAAE,MAAM;gBALb,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,CAC5B,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,mBAAmB,CACtC,EACe,KAAK,EAAE,MAAM;IAG/B,GAAG,CAAC,GAAG,SAAI,EAAE,MAAM,SAAI,GAAG,mBAAmB;CAO9C;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,mBAAmB,GAC3C,KAAK,IAAI,mBAAmB,CAO9B;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC/D;AAED,qBAAa,wBAAwB;IAC7B,OAAO,IAAI,OAAO,CAAC,iBAAiB,CAAC;CAG5C"}

package/lib/api/Transaction.js

@@ -9,92 +9,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Errors_1 = require("../Errors");
-/**
- * Class used to handle CubicWeb's transactions.
- * A transaction allows to execute several RQL requests without altering the database until all
- * changes are committed.
- *
- * You should never have to create this object yourself.
- * Instead, retrieve this object from the methods in the `Client` class.
- */
+exports.NativeTransactionBackend = exports.isTransactionQueryRef = exports.TransactionQuery = exports.TransactionResult = exports.Transaction = void 0;
 class Transaction {
-    /**
-     * Class used to handle CubicWeb's transactions.
-     * A transaction allows to execute several RQL requests without altering the database until all
-     * changes are committed.
-     *
-     * You should never have to create this object yourself.
-     * Instead, retrieve this object from the methods in the `Client` class.
-     *
-     * @param api The API object used to communicate with the CubicWeb backend.
-     */
-    constructor(api) {
-        this.api = api;
-        this._uuid = null;
-        this._closed = false;
+    constructor() {
+        this._queries = [];
     }
-    /**
-     * @returns True if the connection is closed.
-     */
-    isClosed() {
-        return this._closed;
+    push(query, params) {
+        const stackedQuery = new TransactionQuery(query, params, this._queries.length);
+        this._queries.push(stackedQuery);
+        return stackedQuery;
     }
-    /**
-     * This transaction unique identifier.
-     */
-    get uuid() {
-        return this._uuid;
+    get queries() {
+        return this._queries;
     }
-    /**
-     * Begins a new transaction an retrieves the associated uuid.
-     */
-    begin() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this._closed = false;
-            this._uuid = yield this.api.transactionBegin();
-        });
+}
+exports.Transaction = Transaction;
+class TransactionResult {
+    constructor(resultSets) {
+        this.resultSets = resultSets;
     }
-    /**
-     * Executes the given query and waits for the response.
-     * Make sure you called `begin` before using this method.
-     * As this is a transaction changes will only be applied when you call the `commit` method.
-     *
-     * @param query The RQL query to send
-     * @param params The additional parameters for the request
-     * @returns A promise with the request's result set
-     */
-    execute(query, params = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.preventUsageIfClosed();
-            return yield this.api.transactionExecute(this.uuid, query, params);
-        });
+    resolve(ref) {
+        return this.resultSets[ref.queryIndex][ref.row][ref.column];
     }
-    /**
-     * Commits the transaction to apply all the RQL queries sent with `execute`.
-     */
-    commit() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.preventUsageIfClosed();
-            yield this.api.transactionCommit(this.uuid);
-            this._closed = true;
-        });
+}
+exports.TransactionResult = TransactionResult;
+class TransactionQuery {
+    constructor(query, params, index) {
+        this.query = query;
+        this.params = params;
+        this.index = index;
+    }
+    ref(row = 0, column = 0) {
+        return {
+            queryIndex: this.index,
+            row,
+            column,
+        };
     }
-    /**
-     * Rollbacks all the queries sent with `execute` and closes the transaction.
-     */
-    rollback() {
+}
+exports.TransactionQuery = TransactionQuery;
+function isTransactionQueryRef(value) {
+    return (typeof value === "object" &&
+        ["queryIndex", "row", "column"].every((key) => Object.keys(value).includes(key)));
+}
+exports.isTransactionQueryRef = isTransactionQueryRef;
+class NativeTransactionBackend {
+    execute() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.preventUsageIfClosed();
-            yield this.api.transactionRollback(this.uuid);
-            this._closed = true;
+            throw new Error("NativeTransactionBackend.execute not yet implemented.");
         });
     }
-    preventUsageIfClosed() {
-        if (this.isClosed()) {
-            throw new Errors_1.TransactionClosedError();
-        }
-    }
 }
-exports.default = Transaction;
+exports.NativeTransactionBackend = NativeTransactionBackend;
 //# sourceMappingURL=Transaction.js.map

package/lib/api/Transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAmD;AAGnD;;;;;;;GAOG;AACH,MAAqB,WAAW;IAI9B;;;;;;;;;OASG;IACH,YAAoB,GAAQ;QAAR,QAAG,GAAH,GAAG,CAAK;QAbpB,UAAK,GAAkB,IAAI,CAAC;QAC5B,YAAO,GAAG,KAAK,CAAC;IAYO,CAAC;IAEhC;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACG,KAAK;;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACjD,CAAC;KAAA;IAED;;;;;;;;OAQG;IACG,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACrE,CAAC;KAAA;IAED;;OAEG;IACG,MAAM;;YACV,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAED;;OAEG;IACG,QAAQ;;YACZ,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,IAAI,+BAAsB,EAAE,CAAC;SACpC;IACH,CAAC;CACF;AA3ED,8BA2EC"}
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,MAAa,WAAW;IAAxB;QACU,aAAQ,GAA4B,EAAE,CAAC;IAkBjD,CAAC;IAhBC,IAAI,CACF,KAAa,EACb,MAA6D;QAE7D,MAAM,YAAY,GAAG,IAAI,gBAAgB,CACvC,KAAK,EACL,MAAM,EACN,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAnBD,kCAmBC;AAED,MAAa,iBAAiB;IAC5B,YAAoB,UAAoC;QAApC,eAAU,GAAV,UAAU,CAA0B;IAAG,CAAC;IAE5D,OAAO,CAAC,GAAwB;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;CACF;AAND,8CAMC;AAQD,MAAa,gBAAgB;IAC3B,YACkB,KAAa,EACb,MAGf,EACe,KAAa;QALb,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAGrB;QACe,UAAK,GAAL,KAAK,CAAQ;IAC5B,CAAC;IAEJ,GAAG,CAAC,GAAG,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC;QACrB,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,KAAK;YACtB,GAAG;YACH,MAAM;SACP,CAAC;IACJ,CAAC;CACF;AAjBD,4CAiBC;AAED,SAAgB,qBAAqB,CACnC,KAA4C;IAE5C,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CACjC,CACF,CAAC;AACJ,CAAC;AATD,sDASC;AAMD,MAAa,wBAAwB;IAC7B,OAAO;;YACX,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;KAAA;CACF;AAJD,4DAIC"}

package/lib/index.d.ts

@@ -9,6 +9,6 @@ export * from "./schema/classes/Schema";
 export * from "./schema/classes/Utils";
 export * from "./Errors";
 export { default as Client } from "./api/Client";
-export { default as Transaction } from "./api/Transaction";
+export * from "./api/Transaction";
 export { RQLQuery, RQLParams, RqlRow, ResultSet, ApiErrorResponse, } from "./api/Api";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,UAAU,CAAC;AAGzB,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EACL,QAAQ,EACR,SAAS,EACT,MAAM,EACN,SAAS,EACT,gBAAgB,GACjB,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,UAAU,CAAC;AAGzB,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,cAAc,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,OAAO,EACL,QAAQ,EACR,SAAS,EACT,MAAM,EACN,SAAS,EACT,gBAAgB,GACjB,MAAM,WAAW,CAAC"}

package/lib/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transaction = exports.Client = void 0;
+exports.Client = void 0;
 // Raw Schema
 __exportStar(require("./schema/raw/Constraints"), exports);
 __exportStar(require("./schema/raw/Entities"), exports);
@@ -33,6 +33,5 @@ __exportStar(require("./Errors"), exports);
 // API
 var Client_1 = require("./api/Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return __importDefault(Client_1).default; } });
-var Transaction_1 = require("./api/Transaction");
-Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return __importDefault(Transaction_1).default; } });
+__exportStar(require("./api/Transaction"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,aAAa;AACb,2DAAyC;AACzC,wDAAsC;AACtC,mEAAiD;AACjD,sDAAoC;AACpC,qDAAmC;AAEnC,2BAA2B;AAC3B,gEAA8C;AAC9C,4EAA0D;AAC1D,0DAAwC;AACxC,yDAAuC;AAEvC,2CAAyB;AAEzB,MAAM;AACN,uCAAiD;AAAxC,iHAAA,OAAO,OAAU;AAC1B,iDAA2D;AAAlD,2HAAA,OAAO,OAAe"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,aAAa;AACb,2DAAyC;AACzC,wDAAsC;AACtC,mEAAiD;AACjD,sDAAoC;AACpC,qDAAmC;AAEnC,2BAA2B;AAC3B,gEAA8C;AAC9C,4EAA0D;AAC1D,0DAAwC;AACxC,yDAAuC;AAEvC,2CAAyB;AAEzB,MAAM;AACN,uCAAiD;AAAxC,iHAAA,OAAO,OAAU;AAC1B,oDAAkC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@cubicweb/client",
   "description": "Official JS client for CubicWeb API",
   "author": "Logilab",
-  "version": "1.9.0",
+  "version": "2.0.0",
   "license": "LGPL-3.0-or-later",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/api/Client.ts

@@ -1,12 +1,18 @@
 import { Schema } from "../schema/classes/Schema";
 import Api, { RQLParams, ResultSet, CurrentUser } from "./Api";
-import Transaction from "./Transaction";
+import {
+  NativeTransactionBackend,
+  Transaction,
+  TransactionBackend,
+  TransactionResult,
+} from "./Transaction";
 
 /**
  * Class used to communicate with a CubicWeb instance's API.
  */
 export default class Client {
   private api: Api;
+  private transactionBackend: TransactionBackend;
 
   /**
    * Class used to communicate with a CubicWeb instance's API.
@@ -15,8 +21,18 @@ export default class Client {
    * Example: if you can retrieve the schema with https://example.com/api/v1/schema,
    * use https://example.com/api as `apiUrl`.
    */
-  constructor(apiUrl: string) {
+  constructor(
+    apiUrl: string,
+    {
+      transactionBackend: transactionBackend,
+    }: { transactionBackend?: TransactionBackend }
+  ) {
     this.api = new Api(apiUrl);
+    if (transactionBackend === undefined) {
+      this.transactionBackend = new NativeTransactionBackend();
+    } else {
+      this.transactionBackend = transactionBackend;
+    }
   }
 
   get apiUrl() {
@@ -65,31 +81,12 @@ export default class Client {
   }
 
   /**
-   * Creates a new transaction and exposes the Transaction object in the given callback.
-   * Use this callback to execute RQL requests as part of the transaction.
-   * Once the callback's end is reached, the transaction is automatically committed.
-   * Note that any exception thrown by the callback will lead to the
-   * transaction being rolled back.
-   *
-   * @param callback Function to execute transaction requests in.
-   * @returns The promise returned by the callback
+   * @param transaction Transaction to execute
+   * @returns A promise fulfilled when the transaction is completed
    */
-  async transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T> {
-    const transaction = new Transaction(this.api);
-    await transaction.begin();
-
-    let result: T;
-    try {
-      result = await callback(transaction);
-    } catch (error) {
-      if (!transaction.isClosed()) {
-        await transaction.rollback();
-      }
-      throw error;
-    }
-    if (!transaction.isClosed()) {
-      await transaction.commit();
-    }
-    return result;
+  async executeTransaction(
+    transaction: Transaction
+  ): Promise<TransactionResult> {
+    return await this.transactionBackend.execute(transaction);
   }
 }

package/src/api/Transaction.ts

@@ -1,87 +1,76 @@
-import { TransactionClosedError } from "../Errors";
-import Api, { RQLParams } from "./Api";
+import { ResultSet } from "./Api";
 
-/**
- * Class used to handle CubicWeb's transactions.
- * A transaction allows to execute several RQL requests without altering the database until all
- * changes are committed.
- *
- * You should never have to create this object yourself.
- * Instead, retrieve this object from the methods in the `Client` class.
- */
-export default class Transaction {
-  private _uuid: string | null = null;
-  private _closed = false;
+export class Transaction {
+  private _queries: Array<TransactionQuery> = [];
 
-  /**
-   * Class used to handle CubicWeb's transactions.
-   * A transaction allows to execute several RQL requests without altering the database until all
-   * changes are committed.
-   *
-   * You should never have to create this object yourself.
-   * Instead, retrieve this object from the methods in the `Client` class.
-   *
-   * @param api The API object used to communicate with the CubicWeb backend.
-   */
-  constructor(private api: Api) {}
-
-  /**
-   * @returns True if the connection is closed.
-   */
-  isClosed() {
-    return this._closed;
+  push(
+    query: string,
+    params: Record<string, string | number | TransactionQueryRef>
+  ): TransactionQuery {
+    const stackedQuery = new TransactionQuery(
+      query,
+      params,
+      this._queries.length
+    );
+    this._queries.push(stackedQuery);
+    return stackedQuery;
   }
 
-  /**
-   * This transaction unique identifier.
-   */
-  get uuid() {
-    return this._uuid;
+  get queries(): ReadonlyArray<TransactionQuery> {
+    return this._queries;
   }
+}
 
-  /**
-   * Begins a new transaction an retrieves the associated uuid.
-   */
-  async begin() {
-    this._closed = false;
-    this._uuid = await this.api.transactionBegin();
-  }
+export class TransactionResult {
+  constructor(private resultSets: ReadonlyArray<ResultSet>) {}
 
-  /**
-   * Executes the given query and waits for the response.
-   * Make sure you called `begin` before using this method.
-   * As this is a transaction changes will only be applied when you call the `commit` method.
-   *
-   * @param query The RQL query to send
-   * @param params The additional parameters for the request
-   * @returns A promise with the request's result set
-   */
-  async execute(query: string, params: RQLParams = {}) {
-    this.preventUsageIfClosed();
-    return await this.api.transactionExecute(this.uuid, query, params);
+  resolve(ref: TransactionQueryRef) {
+    return this.resultSets[ref.queryIndex][ref.row][ref.column];
   }
+}
 
-  /**
-   * Commits the transaction to apply all the RQL queries sent with `execute`.
-   */
-  async commit() {
-    this.preventUsageIfClosed();
-    await this.api.transactionCommit(this.uuid);
-    this._closed = true;
-  }
+export interface TransactionQueryRef {
+  queryIndex: number;
+  row: number;
+  column: number;
+}
 
-  /**
-   * Rollbacks all the queries sent with `execute` and closes the transaction.
-   */
-  async rollback() {
-    this.preventUsageIfClosed();
-    await this.api.transactionRollback(this.uuid);
-    this._closed = true;
+export class TransactionQuery {
+  constructor(
+    public readonly query: string,
+    public readonly params: Record<
+      string,
+      string | number | TransactionQueryRef
+    >,
+    public readonly index: number
+  ) {}
+
+  ref(row = 0, column = 0): TransactionQueryRef {
+    return {
+      queryIndex: this.index,
+      row,
+      column,
+    };
   }
+}
+
+export function isTransactionQueryRef(
+  value: string | number | TransactionQueryRef
+): value is TransactionQueryRef {
+  return (
+    typeof value === "object" &&
+    ["queryIndex", "row", "column"].every((key) =>
+      Object.keys(value).includes(key)
+    )
+  );
+}
+
+export interface TransactionBackend {
+  execute(transaction: Transaction): Promise<TransactionResult>;
+}
 
-  private preventUsageIfClosed(): asserts this is { uuid: string } {
-    if (this.isClosed()) {
-      throw new TransactionClosedError();
-    }
+export class NativeTransactionBackend {
+  async execute(): Promise<TransactionResult> {
+    throw new Error("NativeTransactionBackend.execute not yet implemented.");
   }
 }

package/src/index.ts

@@ -15,7 +15,7 @@ export * from "./Errors";
 
 // API
 export { default as Client } from "./api/Client";
-export { default as Transaction } from "./api/Transaction";
+export * from "./api/Transaction";
 export {
   RQLQuery,
   RQLParams,