@cubicweb/client 3.0.0-alpha.8 → 3.0.0

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.
      *
@@ -28,8 +16,8 @@ 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) {
-        this.api = new Api_1.default(apiUrl);
+    constructor(apiUrl, options) {
+        this.api = new Api(apiUrl, options ?? {});
     }
     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":"AACA,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;AAO3D;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACjB,GAAG,CAAM;IACjB;;;;;;OAMG;IACH,YAAY,MAAc,EAAE,OAAuB;QACjD,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;IAC5C,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,52 @@
+/**
+ * Interface representing the json returned by the API for a single result set
+ *
+ * @category Api
+ */
+export interface RawResultSet {
+    readonly rows: ResultSetCell[][];
+    readonly column_names: string[];
+}
+/**
+ * Interface representing the json returned by the API for a single row in a result set
+ *
+ * @category Api
+ */
+export type RawResultSetRow = ResultSetCell[];
+/**
+ * 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;
+/**
+ * Class representing a row returned in a result set.
+ *
+ * @category Api
+ */
+export declare class ResultSetRow implements Iterable<ResultSetCell> {
+    readonly columnNames: string[];
+    private readonly cells;
+    constructor(columnNames: string[], cells: RawResultSetRow);
+    [Symbol.iterator](): Generator<ResultSetCell, void, unknown>;
+    get length(): number;
+    getCell(column: number | string): ResultSetCell;
+}
+/**
+ * Class representing a RQL request result.
+ *
+ * @category Api
+ */
+export declare class ResultSet {
+    #private;
+    readonly columnNames: string[];
+    constructor(rawResultSet: RawResultSet);
+    [Symbol.iterator](): Generator<ResultSetRow, void, unknown>;
+    get length(): number;
+    getRow(row: number): ResultSetRow;
+    getCell(row: number, column: number | string): ResultSetCell;
+}
+//# 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;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,EAAE,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,YAAa,YAAW,QAAQ,CAAC,aAAa,CAAC;aAExC,WAAW,EAAE,MAAM,EAAE;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK;gBADN,WAAW,EAAE,MAAM,EAAE,EACpB,KAAK,EAAE,eAAe;IAGxC,CAAC,MAAM,CAAC,QAAQ,CAAC;IAMlB,IAAI,MAAM,WAET;IAED,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAQhC;AAED;;;;GAIG;AACH,qBAAa,SAAS;;IACpB,SAAgB,WAAW,EAAE,MAAM,EAAE,CAAC;gBAG1B,YAAY,EAAE,YAAY;IAKrC,CAAC,MAAM,CAAC,QAAQ,CAAC;IAMlB,IAAI,MAAM,WAET;IAED,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIjC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa;CAQ7D"}

package/lib/api/ResultSet.js

@@ -0,0 +1,64 @@
+/**
+ * Class representing a row returned in a result set.
+ *
+ * @category Api
+ */
+export class ResultSetRow {
+    columnNames;
+    cells;
+    constructor(columnNames, cells) {
+        this.columnNames = columnNames;
+        this.cells = cells;
+    }
+    *[Symbol.iterator]() {
+        for (const cell of this.cells) {
+            yield cell;
+        }
+    }
+    get length() {
+        return this.cells.length;
+    }
+    getCell(column) {
+        if (typeof column === "number") {
+            return this.cells[column];
+        }
+        else {
+            const columnIndex = this.columnNames.indexOf(column);
+            return this.cells[columnIndex];
+        }
+    }
+}
+/**
+ * Class representing a RQL request result.
+ *
+ * @category Api
+ */
+export class ResultSet {
+    columnNames;
+    #rows;
+    constructor(rawResultSet) {
+        this.columnNames = rawResultSet.column_names;
+        this.#rows = rawResultSet.rows;
+    }
+    *[Symbol.iterator]() {
+        for (const r of this.#rows) {
+            yield new ResultSetRow(this.columnNames, r);
+        }
+    }
+    get length() {
+        return this.#rows.length;
+    }
+    getRow(row) {
+        return new ResultSetRow(this.columnNames, this.#rows[row]);
+    }
+    getCell(row, column) {
+        if (typeof column === "number") {
+            return this.#rows[row][column];
+        }
+        else {
+            const columnIndex = this.columnNames.indexOf(column);
+            return this.#rows[row][columnIndex];
+        }
+    }
+}
+//# 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":"AA2BA;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAEL;IACC;IAFnB,YACkB,WAAqB,EACpB,KAAsB;QADvB,gBAAW,GAAX,WAAW,CAAU;QACpB,UAAK,GAAL,KAAK,CAAiB;IACtC,CAAC;IAEJ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,MAAuB;QAC7B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACJ,WAAW,CAAW;IAC7B,KAAK,CAAoB;IAElC,YAAY,YAA0B;QACpC,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,YAAY,CAAC;QAC7C,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,MAAuB;QAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;CACF"}

package/lib/api/authenticators/CookieAuthenticator.d.ts

@@ -0,0 +1,10 @@
+import { AuthenticatedRequest, Authenticator } from "../../Authenticator.js";
+export interface CookieAuthenticatorOptions {
+    credentials?: RequestCredentials;
+}
+export declare class CookieAuthenticator implements Authenticator {
+    private options?;
+    constructor(options?: CookieAuthenticatorOptions | undefined);
+    authenticate(url: string, init: RequestInit): Promise<AuthenticatedRequest>;
+}
+//# sourceMappingURL=CookieAuthenticator.d.ts.map

package/lib/api/authenticators/CookieAuthenticator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CookieAuthenticator.d.ts","sourceRoot":"","sources":["../../../src/api/authenticators/CookieAuthenticator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE7E,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,qBAAa,mBAAoB,YAAW,aAAa;IAC3C,OAAO,CAAC,OAAO,CAAC;gBAAR,OAAO,CAAC,wCAA4B;IAElD,YAAY,CAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,oBAAoB,CAAC;CAIjC"}

package/lib/api/authenticators/CookieAuthenticator.js

@@ -0,0 +1,11 @@
+export class CookieAuthenticator {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    async authenticate(url, init) {
+        const credentials = this.options?.credentials;
+        return { url, init: { ...init, credentials } };
+    }
+}
+//# sourceMappingURL=CookieAuthenticator.js.map

package/lib/api/authenticators/CookieAuthenticator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CookieAuthenticator.js","sourceRoot":"","sources":["../../../src/api/authenticators/CookieAuthenticator.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,mBAAmB;IACV;IAApB,YAAoB,OAAoC;QAApC,YAAO,GAAP,OAAO,CAA6B;IAAG,CAAC;IAE5D,KAAK,CAAC,YAAY,CAChB,GAAW,EACX,IAAiB;QAEjB,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC;QAC9C,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;IACjD,CAAC;CACF"}

package/lib/api/authenticators/SignedRequestAuthenticator.d.ts

@@ -0,0 +1,32 @@
+import { AuthenticatedRequest, Authenticator } from "../../Authenticator.js";
+export interface SignedRequestAuthToken {
+    /**
+     * id of the token
+     */
+    id: string;
+    /**
+     * secret value of the token
+     */
+    token: string;
+}
+/**
+ * Authenticator allowing to authenticate requests made to a cubicweb instance
+ * with the [signedrequest](https://forge.extranet.logilab.fr/cubicweb/cubes/signedrequest) cube (v3.x).
+ *
+ * @param token A {@link SignedRequestAuthToken}. This token must be enabled.
+ */
+export declare class SignedRequestAuthenticator implements Authenticator {
+    private token;
+    private cachedCryptoKey?;
+    constructor(token: SignedRequestAuthToken);
+    private digestBody;
+    private encodeBody;
+    private getCryptoKey;
+    /**
+     * Compute headers used to sign the request and encode the content as bytes
+     */
+    private prepareRequest;
+    private signContent;
+    authenticate(url: string, init: RequestInit): Promise<AuthenticatedRequest>;
+}
+//# sourceMappingURL=SignedRequestAuthenticator.d.ts.map

package/lib/api/authenticators/SignedRequestAuthenticator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignedRequestAuthenticator.d.ts","sourceRoot":"","sources":["../../../src/api/authenticators/SignedRequestAuthenticator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAG7E,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAUD;;;;;GAKG;AACH,qBAAa,0BAA2B,YAAW,aAAa;IAGlD,OAAO,CAAC,KAAK;IAFzB,OAAO,CAAC,eAAe,CAAC,CAAY;gBAEhB,KAAK,EAAE,sBAAsB;YAEnC,UAAU;YAMV,UAAU;YAoBV,YAAY;IAmB1B;;OAEG;YACW,cAAc;YA6Bd,WAAW;IASnB,YAAY,CAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,oBAAoB,CAAC;CAUjC"}

package/lib/api/authenticators/SignedRequestAuthenticator.js

@@ -0,0 +1,89 @@
+import { encodeFormData } from "../../encodeFormData.js";
+function bytesToHex(hashBuffer) {
+    const hashArray = Array.from(new Uint8Array(hashBuffer)); // convert buffer to byte array
+    const hashHex = hashArray
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join(""); // convert bytes to hex string
+    return hashHex;
+}
+/**
+ * Authenticator allowing to authenticate requests made to a cubicweb instance
+ * with the [signedrequest](https://forge.extranet.logilab.fr/cubicweb/cubes/signedrequest) cube (v3.x).
+ *
+ * @param token A {@link SignedRequestAuthToken}. This token must be enabled.
+ */
+export class SignedRequestAuthenticator {
+    token;
+    cachedCryptoKey;
+    constructor(token) {
+        this.token = token;
+    }
+    async digestBody(body) {
+        const contentHash = await crypto.subtle.digest("SHA-512", body);
+        const hashHex = bytesToHex(contentHash);
+        return hashHex;
+    }
+    async encodeBody(body) {
+        if (typeof body === "string") {
+            return {
+                body: new TextEncoder().encode(body),
+                headers: new Headers(),
+            };
+        }
+        else if (body instanceof FormData) {
+            return await encodeFormData(body);
+        }
+        else if (body == null) {
+            return {
+                body: null,
+                headers: new Headers(),
+            };
+        }
+        else {
+            throw new Error("Unexpected body type.");
+        }
+    }
+    async getCryptoKey() {
+        if (this.cachedCryptoKey) {
+            return this.cachedCryptoKey;
+        }
+        const textEncoder = new TextEncoder();
+        this.cachedCryptoKey = await crypto.subtle.importKey("raw", textEncoder.encode(this.token.token), {
+            name: "HMAC",
+            hash: "SHA-512",
+        }, false, ["sign"]);
+        return this.cachedCryptoKey;
+    }
+    /**
+     * Compute headers used to sign the request and encode the content as bytes
+     */
+    async prepareRequest(url, init) {
+        const headers = new Headers(init?.headers);
+        const { body: encodedBody, headers: encodingHeaders } = await this.encodeBody(init.body || null);
+        init.body = encodedBody;
+        encodingHeaders.forEach((value, name) => headers.append(name, value));
+        const bodyBytes = encodedBody ?? new Uint8Array();
+        const bodyHash = await this.digestBody(bodyBytes);
+        headers.append("Content-SHA512", bodyHash);
+        const date = new Date();
+        headers.append("X-Cubicweb-Date", date.toUTCString());
+        return {
+            contentToSign: (init?.method ?? "GET") +
+                url +
+                bodyHash +
+                (headers.get("Content-Type") ?? "") +
+                (headers.get("X-Cubicweb-Date") ?? ""),
+            headers,
+        };
+    }
+    async signContent(contentToSign) {
+        const textEncoder = new TextEncoder();
+        return await crypto.subtle.sign("HMAC", await this.getCryptoKey(), textEncoder.encode(contentToSign));
+    }
+    async authenticate(url, init) {
+        const { contentToSign, headers } = await this.prepareRequest(url, init);
+        headers.append("Authorization", `Cubicweb ${this.token.id}:${bytesToHex(await this.signContent(contentToSign))}`);
+        return { url, init: { ...init, headers } };
+    }
+}
+//# sourceMappingURL=SignedRequestAuthenticator.js.map

package/lib/api/authenticators/SignedRequestAuthenticator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignedRequestAuthenticator.js","sourceRoot":"","sources":["../../../src/api/authenticators/SignedRequestAuthenticator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAazD,SAAS,UAAU,CAAC,UAAuB;IACzC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,+BAA+B;IACzF,MAAM,OAAO,GAAG,SAAS;SACtB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3C,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,8BAA8B;IAC3C,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,0BAA0B;IAGjB;IAFZ,eAAe,CAAa;IAEpC,YAAoB,KAA6B;QAA7B,UAAK,GAAL,KAAK,CAAwB;IAAG,CAAC;IAE7C,KAAK,CAAC,UAAU,CAAC,IAAgB;QACvC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,IAAyB;QAEzB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO;gBACL,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;gBACpC,OAAO,EAAE,IAAI,OAAO,EAAE;aACvB,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;YACpC,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;aAAM,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI,OAAO,EAAE;aACvB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,eAAe,CAAC;QAC9B,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,eAAe,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAClD,KAAK,EACL,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EACpC;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;SAChB,EACD,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;QACF,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,cAAc,CAC1B,GAAW,EACX,IAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3C,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,GACnD,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAEtE,MAAM,SAAS,GAAG,WAAW,IAAI,IAAI,UAAU,EAAE,CAAC;QAElD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAClD,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAE3C,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAEtD,OAAO;YACL,aAAa,EACX,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC;gBACvB,GAAG;gBACH,QAAQ;gBACR,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;gBACnC,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;YACxC,OAAO;SACR,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,aAAqB;QAC7C,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAC7B,MAAM,EACN,MAAM,IAAI,CAAC,YAAY,EAAE,EACzB,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,GAAW,EACX,IAAiB;QAEjB,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxE,OAAO,CAAC,MAAM,CACZ,eAAe,EACf,YAAY,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,UAAU,CACrC,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CACtC,EAAE,CACJ,CAAC;QACF,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC;IAC7C,CAAC;CACF"}

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.js";
+import { RQLQueryParams } from "../Api.js";
+/**
+ * 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 | string): 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,iBAAiB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C;;;;;;;;;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,MAAM,GAAG,eAAe;CAG/D"}

package/lib/api/query/RQLQuery.js

@@ -0,0 +1,48 @@
+import { v4 as uuidv4 } from "uuid";
+import { RQLQueryCellRef, RQLQueryRowRef } from "./references.js";
+/**
+ * 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,iBAAiB,CAAC;AAGlE;;;;;;;;;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,MAAuB;QAC1C,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 | string): 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 | string;
+    constructor(queryUUID: string, row: number, column: number | string);
+}
+//# 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,MAAM,GAAG,eAAe;CAG5C;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;aAER,SAAS,EAAE,MAAM;aACjB,GAAG,EAAE,MAAM;aACX,MAAM,EAAE,MAAM,GAAG,MAAM;gBAFvB,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,GAAG,MAAM;CAE1C"}