@cubicweb/client 3.0.0-alpha.10 → 3.0.0-alpha.12

package/lib/api/Client.d.ts

@@ -1,6 +1,8 @@
-import { Schema } from "../schema/classes/Schema";
-import { RQLParams, ResultSet, CurrentUser } from "./Api";
-import { BinariesParam, Transaction, TransactionResult } from "./Transaction";
+import { Schema } from "../schema/classes/Schema.js";
+import { RQLQueryParams, CurrentUser } from "./Api.js";
+import { ResultSet } from "./ResultSet.js";
+import { Transaction } from "./transaction/Transaction.js";
+import { TransactionResult } from "./transaction/TransactionResult.js";
 /**
  * Class used to communicate with a CubicWeb instance's API.
  *
@@ -20,22 +22,25 @@ export default class Client {
     /**
      * Executes the given query and waits for the response.
      *
-     * @param query The RQL query to send
+     * If binaries are given, the request is automatically
+     * sent using `multipart/form-data` to allow uploading binaries.
+     *
+     * @param rql 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, binaries?: BinariesParam): Promise<ResultSet>;
+    execute(rql: string, params?: RQLQueryParams): Promise<ResultSet>;
     /**
      * Retrieves the CubicWeb instance's JSON schema.
      *
      * @returns The CubicWeb instance's JSON schema.
      */
-    schema(): Promise<Schema<import("..").EntityRawSchemaArray, import("..").RelationDefinitionRawSchemaArray<import("..").EntityRawSchemaArray>>>;
+    schema(): Promise<Schema<import("../index.js").EntityRawSchemaArray, import("../index.js").RelationDefinitionRawSchemaArray<import("../index.js").EntityRawSchemaArray>>>;
     /**
      * Tries to log in the user on the configured CubicWeb instance with the given credentials.
      *
      * @param login The user login
-     * @param password THe user password
+     * @param password The user password
      * @returns A promise returning true if the login was successful, false otherwise
      */
     login(login: string, password: string): Promise<boolean>;
@@ -52,14 +57,21 @@ export default class Client {
      */
     currentUser(): Promise<CurrentUser>;
     /**
+     * Executes the given transaction.
+     *
+     * If the {@link Transaction} object contains binaries, the request is automatically
+     * sent using `multipart/form-data` to allow uploading binaries.
+     *
      * @param transaction Transaction to execute
-     * @returns A promise fulfilled when the transaction is completed
+     * @returns A promise returning the transaction result on success
      */
     executeTransaction(transaction: Transaction): Promise<TransactionResult>;
     /**
      * Get the binary for the given entity attribute
      *
-     * @returns A promise resolving to the binary
+     * @param eid Entity eid to fetch the binary from
+     * @param attribute Attribute on the entity in which the binary is stored
+     * @returns A promise resolving to the binary as a Blob
      */
     getBinary(eid: number, attribute: string): Promise<Blob>;
 }

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,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE9E;;;;GAIG;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,CACX,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,SAAc,EACtB,QAAQ,CAAC,EAAE,aAAa,GACvB,OAAO,CAAC,SAAS,CAAC;IAQrB;;;;OAIG;IACG,MAAM;IAKZ;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3C;;;;OAIG;IACG,MAAM;IAIZ;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAIzC;;;OAGG;IACG,kBAAkB,CACtB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAI7B;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAG/C"}
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IAEjB;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM;IAI1B,IAAI,MAAM,WAET;IAED;;;;;;;;;OASG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,cAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAQ3E;;;;OAIG;IACG,MAAM;IAKZ;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3C;;;;OAIG;IACG,MAAM;IAIZ;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAIzC;;;;;;;;OAQG;IACG,kBAAkB,CACtB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAI7B;;;;;;OAMG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAG/C"}

package/lib/api/Client.js

@@ -1,26 +1,14 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Schema_1 = require("../schema/classes/Schema");
-const Api_1 = __importDefault(require("./Api"));
-const Transaction_1 = require("./Transaction");
+import { Schema } from "../schema/classes/Schema.js";
+import Api from "./Api.js";
+import { RQLQuery } from "./query/RQLQuery.js";
+import { Transaction } from "./transaction/Transaction.js";
 /**
  * Class used to communicate with a CubicWeb instance's API.
  *
  * @category Api
  */
-class Client {
+export default class Client {
+    api;
     /**
      * Class used to communicate with a CubicWeb instance's API.
      *
@@ -29,7 +17,7 @@ class Client {
      * use https://example.com/api as `apiUrl`.
      */
     constructor(apiUrl) {
-        this.api = new Api_1.default(apiUrl);
+        this.api = new Api(apiUrl);
     }
     get apiUrl() {
         return this.api.apiUrl;
@@ -37,81 +25,76 @@ class Client {
     /**
      * Executes the given query and waits for the response.
      *
-     * @param query The RQL query to send
+     * If binaries are given, the request is automatically
+     * sent using `multipart/form-data` to allow uploading binaries.
+     *
+     * @param rql 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 = {}, binaries) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const transaction = new Transaction_1.Transaction();
-            const transactionQuery = transaction.push(query, params);
-            transaction.setBinaries(binaries);
-            const result = yield this.executeTransaction(transaction);
-            return result.resolveQuery(transactionQuery.ref());
-        });
+    async execute(rql, params = {}) {
+        const transaction = new Transaction();
+        const query = new RQLQuery(rql, params);
+        transaction.push(query);
+        const result = await this.executeTransaction(transaction);
+        return result.getResultSet(query);
     }
     /**
      * Retrieves the CubicWeb instance's JSON schema.
      *
      * @returns The CubicWeb instance's JSON schema.
      */
-    schema() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const schema = yield this.api.schema();
-            return new Schema_1.Schema(schema);
-        });
+    async schema() {
+        const schema = await this.api.schema();
+        return new Schema(schema);
     }
     /**
      * Tries to log in the user on the configured CubicWeb instance with the given credentials.
      *
      * @param login The user login
-     * @param password THe user password
+     * @param password The user password
      * @returns A promise returning true if the login was successful, false otherwise
      */
-    login(login, password) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.login(login, password);
-        });
+    async login(login, password) {
+        return await this.api.login(login, password);
     }
     /**
      * Logs out the current user. Will invalidate any authentication cookie active.
      *
      * @returns A promise which will resolve when the user is properly logged out
      */
-    logout() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.logout();
-        });
+    async logout() {
+        return await this.api.logout();
     }
     /**
      * Get the user associated to this client
      *
      * @returns A promise resolving to the current user
      */
-    currentUser() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.currentUser();
-        });
+    async currentUser() {
+        return await this.api.currentUser();
     }
     /**
+     * Executes the given transaction.
+     *
+     * If the {@link Transaction} object contains binaries, the request is automatically
+     * sent using `multipart/form-data` to allow uploading binaries.
+     *
      * @param transaction Transaction to execute
-     * @returns A promise fulfilled when the transaction is completed
+     * @returns A promise returning the transaction result on success
      */
-    executeTransaction(transaction) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.rql(transaction);
-        });
+    async executeTransaction(transaction) {
+        return await this.api.rql(transaction);
     }
     /**
      * Get the binary for the given entity attribute
      *
-     * @returns A promise resolving to the binary
+     * @param eid Entity eid to fetch the binary from
+     * @param attribute Attribute on the entity in which the binary is stored
+     * @returns A promise resolving to the binary as a Blob
      */
-    getBinary(eid, attribute) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.binary(eid, attribute);
-        });
+    async getBinary(eid, attribute) {
+        return await this.api.binary(eid, attribute);
     }
 }
-exports.default = Client;
 //# sourceMappingURL=Client.js.map

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,+CAA8E;AAE9E;;;;GAIG;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,CACX,KAAa,EACb,SAAoB,EAAE,EACtB,QAAwB;;YAExB,MAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;YACtC,MAAM,gBAAgB,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACzD,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QACrD,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,MAAM;;YACV,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QACjC,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,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS,CAAC,GAAW,EAAE,SAAiB;;YAC5C,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC/C,CAAC;KAAA;CACF;AA9FD,yBA8FC"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,GAAoC,MAAM,UAAU,CAAC;AAE5D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAG3D;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACjB,GAAG,CAAM;IAEjB;;;;;;OAMG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,SAAyB,EAAE;QACpD,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,KAAa,EAAE,QAAgB;QACzC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CACtB,WAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,SAAiB;QAC5C,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC/C,CAAC;CACF"}

package/lib/api/ResultSet.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Type representing a final value in a result set.
+ *
+ * Please not this type may not be accurate if you use entity methods,
+ * as those methods may return any data structure.
+ *
+ * @category Api
+ */
+export type ResultSetCell = string | number | boolean | null;
+/**
+ * Type representing a row returned in a result set.
+ *
+ * @category Api
+ */
+export type ResultSetRow<T extends ReadonlyArray<ResultSetCell> = ReadonlyArray<ResultSetCell>> = T;
+/**
+ * Class representing a RQL request result.
+ *
+ * @category Api
+ */
+export declare class ResultSet<T extends ReadonlyArray<ResultSetCell> = ReadonlyArray<ResultSetCell>> {
+    readonly rows: T[];
+    constructor(rows: T[]);
+}
+//# sourceMappingURL=ResultSet.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ResultSet.d.ts","sourceRoot":"","sources":["../../src/api/ResultSet.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,aAAa,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC,aAAa,CAAC,IACnE,CAAC,CAAC;AAEN;;;;GAIG;AACH,qBAAa,SAAS,CACpB,CAAC,SAAS,aAAa,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC,aAAa,CAAC;aAEzC,IAAI,EAAE,CAAC,EAAE;gBAAT,IAAI,EAAE,CAAC,EAAE;CACtC"}

package/lib/api/ResultSet.js

@@ -0,0 +1,12 @@
+/**
+ * Class representing a RQL request result.
+ *
+ * @category Api
+ */
+export class ResultSet {
+    rows;
+    constructor(rows) {
+        this.rows = rows;
+    }
+}
+//# sourceMappingURL=ResultSet.js.map

package/lib/api/ResultSet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultSet.js","sourceRoot":"","sources":["../../src/api/ResultSet.ts"],"names":[],"mappings":"AAmBA;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAGQ;IAA5B,YAA4B,IAAS;QAAT,SAAI,GAAJ,IAAI,CAAK;IAAG,CAAC;CAC1C"}

package/lib/api/binary/RQLBinary.d.ts

@@ -0,0 +1,6 @@
+export declare class RQLBinary {
+    readonly blob: Blob;
+    readonly uuid: string;
+    constructor(blob: Blob);
+}
+//# sourceMappingURL=RQLBinary.d.ts.map

package/lib/api/binary/RQLBinary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RQLBinary.d.ts","sourceRoot":"","sources":["../../../src/api/binary/RQLBinary.ts"],"names":[],"mappings":"AAEA,qBAAa,SAAS;aAGQ,IAAI,EAAE,IAAI;IAFtC,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAED,IAAI,EAAE,IAAI;CAGvC"}

package/lib/api/binary/RQLBinary.js

@@ -0,0 +1,10 @@
+import { v4 as uuidv4 } from "uuid";
+export class RQLBinary {
+    blob;
+    uuid;
+    constructor(blob) {
+        this.blob = blob;
+        this.uuid = uuidv4();
+    }
+}
+//# sourceMappingURL=RQLBinary.js.map

package/lib/api/binary/RQLBinary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RQLBinary.js","sourceRoot":"","sources":["../../../src/api/binary/RQLBinary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,MAAM,OAAO,SAAS;IAGQ;IAFZ,IAAI,CAAS;IAE7B,YAA4B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;QACpC,IAAI,CAAC,IAAI,GAAG,MAAM,EAAE,CAAC;IACvB,CAAC;CACF"}

package/lib/api/query/RQLQuery.d.ts

@@ -0,0 +1,40 @@
+import { RQLQueryCellRef, RQLQueryRowRef } from "./references";
+import { RQLQueryParams } from "../Api";
+/**
+ * Class representing a RQL query to be sent to the API.
+ *
+ * Queries are identified by a uuid and are independent from transactions.
+ *
+ * If a query has been used in a transaction, RQLQuery objects can easily retrieve
+ * a reference to the query for later resolving the values in a {@link TransactionResult}.
+ *
+ * @category Api
+ */
+export declare class RQLQuery {
+    readonly rql: string;
+    readonly params: RQLQueryParams;
+    readonly queryUUID: string;
+    /**
+     * Class representing a RQL query to be sent to the API.
+     *
+     * Queries are identified by a uuid and are independent from transactions.
+     *
+     * If a query has been used in a transaction, RQLQuery objects can easily retrieve
+     * a reference to the query for later resolving the values in a {@link TransactionResult}.
+     *
+     * @param rql The rql query
+     * @param params The parameters for the rql query
+     *
+     * @category Api
+     */
+    constructor(rql: string, params?: RQLQueryParams);
+    /**
+     * @returns A reference to a {@link ResultSetRow} in the result of this query.
+     */
+    rowRef(row: number): RQLQueryRowRef;
+    /**
+     * @returns A reference to a {@link ResultSetCell} in the result of this query.
+     */
+    cellRef(row: number, column: number): RQLQueryCellRef;
+}
+//# sourceMappingURL=RQLQuery.d.ts.map

package/lib/api/query/RQLQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RQLQuery.d.ts","sourceRoot":"","sources":["../../../src/api/query/RQLQuery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAExC;;;;;;;;;GASG;AACH,qBAAa,QAAQ;aAiBD,GAAG,EAAE,MAAM;aACX,MAAM,EAAE,cAAc;IAjBxC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;OAYG;gBAEe,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,cAAmB;IAK7C;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc;IAInC;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,eAAe;CAGtD"}

package/lib/api/query/RQLQuery.js

@@ -0,0 +1,48 @@
+import { v4 as uuidv4 } from "uuid";
+import { RQLQueryCellRef, RQLQueryRowRef } from "./references";
+/**
+ * Class representing a RQL query to be sent to the API.
+ *
+ * Queries are identified by a uuid and are independent from transactions.
+ *
+ * If a query has been used in a transaction, RQLQuery objects can easily retrieve
+ * a reference to the query for later resolving the values in a {@link TransactionResult}.
+ *
+ * @category Api
+ */
+export class RQLQuery {
+    rql;
+    params;
+    queryUUID;
+    /**
+     * Class representing a RQL query to be sent to the API.
+     *
+     * Queries are identified by a uuid and are independent from transactions.
+     *
+     * If a query has been used in a transaction, RQLQuery objects can easily retrieve
+     * a reference to the query for later resolving the values in a {@link TransactionResult}.
+     *
+     * @param rql The rql query
+     * @param params The parameters for the rql query
+     *
+     * @category Api
+     */
+    constructor(rql, params = {}) {
+        this.rql = rql;
+        this.params = params;
+        this.queryUUID = uuidv4();
+    }
+    /**
+     * @returns A reference to a {@link ResultSetRow} in the result of this query.
+     */
+    rowRef(row) {
+        return new RQLQueryRowRef(this.queryUUID, row);
+    }
+    /**
+     * @returns A reference to a {@link ResultSetCell} in the result of this query.
+     */
+    cellRef(row, column) {
+        return new RQLQueryCellRef(this.queryUUID, row, column);
+    }
+}
+//# sourceMappingURL=RQLQuery.js.map

package/lib/api/query/RQLQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RQLQuery.js","sourceRoot":"","sources":["../../../src/api/query/RQLQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG/D;;;;;;;;;GASG;AACH,MAAM,OAAO,QAAQ;IAiBD;IACA;IAjBF,SAAS,CAAS;IAElC;;;;;;;;;;;;OAYG;IACH,YACkB,GAAW,EACX,SAAyB,EAAE;QAD3B,QAAG,GAAH,GAAG,CAAQ;QACX,WAAM,GAAN,MAAM,CAAqB;QAE3C,IAAI,CAAC,SAAS,GAAG,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,GAAW,EAAE,MAAc;QACjC,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;CACF"}

package/lib/api/query/references.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Class representing a reference to a {@link ResultSetRow} in the result of a {@link RQLQuery}.
+ *
+ * Use this to resolve a {@link ResultSetRow} of the referenced {@link RQLQuery}
+ * from a {@link TransactionResult}.
+ *
+ * @category Api
+ */
+export declare class RQLQueryRowRef {
+    readonly queryUUID: string;
+    readonly row: number;
+    constructor(queryUUID: string, row: number);
+    /**
+     * Retrieve a reference to the given column in this row.
+     *
+     * @param c The column to get a reference for
+     * @returns A reference to the given column in the current row
+     *
+     * @category Api
+     */
+    column(c: number): RQLQueryCellRef;
+}
+/**
+ * Class representing a reference to a {@link ResultSetCell} in the result of a {@link RQLQuery}.
+ *
+ * Use this to resolve a {@link ResultSetCell} of the referenced {@link RQLQuery}
+ * from a {@link TransactionResult}.
+ *
+ * This reference can also be used in parameters of other {@link RQLQuery}.
+ * If both {@link RQLQuery} are used in the same {@link RQLQuery},
+ * then the resolved value from the first query will be used in the second.
+ *
+ * @category Api
+ */
+export declare class RQLQueryCellRef {
+    readonly queryUUID: string;
+    readonly row: number;
+    readonly column: number;
+    constructor(queryUUID: string, row: number, column: number);
+}
+//# sourceMappingURL=references.d.ts.map

package/lib/api/query/references.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../../src/api/query/references.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,qBAAa,cAAc;aACG,SAAS,EAAE,MAAM;aAAkB,GAAG,EAAE,MAAM;gBAA9C,SAAS,EAAE,MAAM,EAAkB,GAAG,EAAE,MAAM;IAE1E;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,eAAe;CAGnC;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;aAER,SAAS,EAAE,MAAM;aACjB,GAAG,EAAE,MAAM;aACX,MAAM,EAAE,MAAM;gBAFd,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM;CAEjC"}

package/lib/api/query/references.js

@@ -0,0 +1,50 @@
+/**
+ * Class representing a reference to a {@link ResultSetRow} in the result of a {@link RQLQuery}.
+ *
+ * Use this to resolve a {@link ResultSetRow} of the referenced {@link RQLQuery}
+ * from a {@link TransactionResult}.
+ *
+ * @category Api
+ */
+export class RQLQueryRowRef {
+    queryUUID;
+    row;
+    constructor(queryUUID, row) {
+        this.queryUUID = queryUUID;
+        this.row = row;
+    }
+    /**
+     * Retrieve a reference to the given column in this row.
+     *
+     * @param c The column to get a reference for
+     * @returns A reference to the given column in the current row
+     *
+     * @category Api
+     */
+    column(c) {
+        return new RQLQueryCellRef(this.queryUUID, this.row, c);
+    }
+}
+/**
+ * Class representing a reference to a {@link ResultSetCell} in the result of a {@link RQLQuery}.
+ *
+ * Use this to resolve a {@link ResultSetCell} of the referenced {@link RQLQuery}
+ * from a {@link TransactionResult}.
+ *
+ * This reference can also be used in parameters of other {@link RQLQuery}.
+ * If both {@link RQLQuery} are used in the same {@link RQLQuery},
+ * then the resolved value from the first query will be used in the second.
+ *
+ * @category Api
+ */
+export class RQLQueryCellRef {
+    queryUUID;
+    row;
+    column;
+    constructor(queryUUID, row, column) {
+        this.queryUUID = queryUUID;
+        this.row = row;
+        this.column = column;
+    }
+}
+//# sourceMappingURL=references.js.map

package/lib/api/query/references.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../src/api/query/references.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,OAAO,cAAc;IACG;IAAmC;IAA/D,YAA4B,SAAiB,EAAkB,GAAW;QAA9C,cAAS,GAAT,SAAS,CAAQ;QAAkB,QAAG,GAAH,GAAG,CAAQ;IAAG,CAAC;IAE9E;;;;;;;OAOG;IACH,MAAM,CAAC,CAAS;QACd,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAe;IAER;IACA;IACA;IAHlB,YACkB,SAAiB,EACjB,GAAW,EACX,MAAc;QAFd,cAAS,GAAT,SAAS,CAAQ;QACjB,QAAG,GAAH,GAAG,CAAQ;QACX,WAAM,GAAN,MAAM,CAAQ;IAC7B,CAAC;CACL"}

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

@@ -0,0 +1,25 @@
+import { RQLQuery } from "../query/RQLQuery.js";
+/**
+ * Class representing a set of {@link RQLQuery} executed one after the other in a single HTTP request.
+ *
+ * These {@link RQLQuery} can be linked together by using a {@link RQLQueryCellRef}
+ * of one {@link RQLQuery} in the parameters of a subsequent {@link RQLQuery}.
+ *
+ * Binary files are global to the transaction and can be referenced using a {@link RQLQueryBinaryRef}
+ * in the parameters of a {@link RQLQuery}.
+ */
+export declare class Transaction {
+    private _queries;
+    /**
+     * Adds the given queries to the transaction.
+     *
+     * Each {@link RQLQuery} will be executed one after the other.
+     * These {@link RQLQuery} can be linked together by using a {@link RQLQueryCellRef}
+     * of one {@link RQLQuery} in the parameters of a subsequent {@link RQLQuery}.
+     *
+     * @param queries New queries to add to the transaction
+     */
+    push(...queries: RQLQuery[]): void;
+    get queries(): ReadonlyArray<RQLQuery>;
+}
+//# sourceMappingURL=Transaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../../src/api/transaction/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAuB;IAEvC;;;;;;;;OAQG;IACH,IAAI,CAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI;IAIlC,IAAI,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,CAErC;CACF"}

package/lib/api/transaction/Transaction.js

@@ -0,0 +1,28 @@
+/**
+ * Class representing a set of {@link RQLQuery} executed one after the other in a single HTTP request.
+ *
+ * These {@link RQLQuery} can be linked together by using a {@link RQLQueryCellRef}
+ * of one {@link RQLQuery} in the parameters of a subsequent {@link RQLQuery}.
+ *
+ * Binary files are global to the transaction and can be referenced using a {@link RQLQueryBinaryRef}
+ * in the parameters of a {@link RQLQuery}.
+ */
+export class Transaction {
+    _queries = [];
+    /**
+     * Adds the given queries to the transaction.
+     *
+     * Each {@link RQLQuery} will be executed one after the other.
+     * These {@link RQLQuery} can be linked together by using a {@link RQLQueryCellRef}
+     * of one {@link RQLQuery} in the parameters of a subsequent {@link RQLQuery}.
+     *
+     * @param queries New queries to add to the transaction
+     */
+    push(...queries) {
+        this._queries.push(...queries);
+    }
+    get queries() {
+        return this._queries;
+    }
+}
+//# sourceMappingURL=Transaction.js.map

package/lib/api/transaction/Transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/api/transaction/Transaction.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAW;IACd,QAAQ,GAAoB,EAAE,CAAC;IAEvC;;;;;;;;OAQG;IACH,IAAI,CAAC,GAAG,OAAmB;QACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF"}

package/lib/api/transaction/TransactionResult.d.ts

@@ -0,0 +1,32 @@
+import { ResultSet, ResultSetCell, ResultSetRow } from "../ResultSet";
+import { RQLQuery } from "../query/RQLQuery";
+import { RQLQueryCellRef, RQLQueryRowRef } from "../query/references";
+import { Transaction } from "./Transaction";
+/**
+ * Class representing the result of a transaction.
+ *
+ * Retrieving the values is done using query references.
+ *
+ * @example
+ *
+ * Retrieving the first value in a result set
+ *
+ * ```tsx
+ * const transaction = new Transaction()
+ * const query = new RQLQuery("Any X WHERE X name 'test'", {})
+ * transaction.push(query)
+ * const result = client.executeTransaction(transaction)
+ * const eid = result.resolve(query.cellRef(0, 0))
+ * ```
+ *
+ * @category Api
+ */
+export declare class TransactionResult {
+    private transaction;
+    private resultSets;
+    constructor(transaction: Transaction, resultSets: ReadonlyArray<ResultSet>);
+    getResultSet(query: RQLQuery): ResultSet;
+    getRow(ref: RQLQueryRowRef): ResultSetRow;
+    getCell(ref: RQLQueryCellRef): ResultSetCell;
+}
+//# sourceMappingURL=TransactionResult.d.ts.map

package/lib/api/transaction/TransactionResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionResult.d.ts","sourceRoot":"","sources":["../../../src/api/transaction/TransactionResult.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,iBAAiB;IAE1B,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,UAAU;gBADV,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC;IAG9C,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS;IAKxC,MAAM,CAAC,GAAG,EAAE,cAAc,GAAG,YAAY;IAKzC,OAAO,CAAC,GAAG,EAAE,eAAe,GAAG,aAAa;CAI7C"}