@cubicweb/client 3.0.0-alpha.9 → 3.0.2

package/lib/api/Api.js

@@ -1,37 +1,35 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Errors_1 = require("../Errors");
-const Transaction_1 = require("./Transaction");
+import { ValidationError } from "../errors.js";
+import { getBinariesFromTransaction, serializeQueryParams } from "../utils.js";
+import { TransactionResult, } from "./transaction/TransactionResult.js";
 /**
  * Class used to handle requests to the CubicWeb API.
  *
  * You should never have to create this object yourself.
- * Instead, retrieve this object from the methods in the `Client` class.
+ * Instead, retrieve this object from the methods in the {@link Client} class.
  *
  * @internal
  */
-class Api {
+export default class Api {
+    _apiUrl;
+    _version = "v1";
+    _rqlApiUrl;
+    _schemaApiUrl;
+    _loginApiUrl;
+    _logoutApiUrl;
+    _currentUserApiUrl;
+    _binaryApiUrl;
+    _authenticator;
     /**
      * Class used to handle requests to the CubicWeb API.
      *
      * You should never have to create this object yourself.
-     * Instead, retrieve this object from the methods in the `Client` class.
+     * Instead, retrieve this object from the methods in the {@link Client} class.
      *
      * @param apiUrl The API url. It should not include the API version as it will be automatically added.
      * Example: if you can retrieve the schema with https://example.com/api/v1/schema,
      * use https://example.com/api as `apiUrl`.
      */
-    constructor(apiUrl) {
-        this._version = "v1";
+    constructor(apiUrl, options) {
         this._apiUrl = apiUrl;
         this._rqlApiUrl = this.getApiRoute("rql");
         this._schemaApiUrl = this.getApiRoute("schema");
@@ -39,6 +37,7 @@ class Api {
         this._logoutApiUrl = this.getApiRoute("logout");
         this._currentUserApiUrl = this.getApiRoute("current-user");
         this._binaryApiUrl = this.getApiRoute("binary");
+        this._authenticator = options.authenticator;
     }
     get apiUrl() {
         return this._apiUrl;
@@ -51,50 +50,41 @@ class Api {
      *
      * @returns The CubicWeb instance's JSON schema.
      */
-    schema() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return nonNullFetchApi(this._schemaApiUrl, {
-                method: "GET",
-                credentials: "include",
-            });
+    async schema() {
+        return this.nonNullFetchApi(this._schemaApiUrl, {
+            method: "GET",
         });
     }
     /**
      * 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* () {
-            try {
-                yield fetchApi(this._loginApiUrl, {
-                    method: "POST",
-                    body: JSON.stringify({
-                        login,
-                        password,
-                    }),
-                    credentials: "include",
-                });
-                return true;
-            }
-            catch (_error) {
-                return false;
-            }
-        });
+    async login(login, password) {
+        try {
+            await this.fetchApi(this._loginApiUrl, {
+                method: "POST",
+                body: JSON.stringify({
+                    login,
+                    password,
+                }),
+            });
+            return true;
+        }
+        catch (_error) {
+            return false;
+        }
     }
     /**
      * 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* () {
-            yield fetchApi(this._logoutApiUrl, {
-                method: "POST",
-                credentials: "include",
-            });
+    async logout() {
+        await this.fetchApi(this._logoutApiUrl, {
+            method: "POST",
         });
     }
     /**
@@ -102,80 +92,85 @@ class Api {
      *
      * @returns A promise resolving to the current user
      */
-    currentUser() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield nonNullFetchApi(this._currentUserApiUrl, {
-                method: "GET",
-                credentials: "include",
-            });
+    async currentUser() {
+        return await this.nonNullFetchApi(this._currentUserApiUrl, {
+            method: "GET",
         });
     }
     /**
      * 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
      */
-    binary(eid, attribute) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const params = new URLSearchParams({
-                eid: eid.toString(),
-                attribute,
-            });
-            return yield nonNullFetchApi(this._binaryApiUrl + params, {
-                method: "GET",
-                credentials: "include",
-            });
+    async binary(eid, attribute) {
+        const params = new URLSearchParams({
+            eid: eid.toString(),
+            attribute,
+        });
+        const response = await this.fetchApi(`${this._binaryApiUrl}?${params}`, {
+            method: "GET",
         });
+        const blob = await response?.blob();
+        if (blob == null) {
+            const error = {
+                status: 500,
+                title: "Unexpected null response",
+                message: `No blob found for ${params}`,
+            };
+            throw error;
+        }
+        return blob;
     }
-    rql(transaction) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                if (Object.keys(transaction.binaries).length > 0) {
-                    return yield this.multipartTransaction(transaction);
-                }
-                else {
-                    return yield this.jsonTransaction(transaction);
-                }
+    /**
+     * 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 returning the transaction result on success
+     */
+    async rql(transaction) {
+        const binaries = getBinariesFromTransaction(transaction);
+        try {
+            if (binaries.length > 0) {
+                return await this.multipartTransaction(transaction, binaries);
             }
-            catch (e) {
-                this.handleUserErrors(e);
+            else {
+                return await this.jsonTransaction(transaction);
             }
-        });
+        }
+        catch (e) {
+            this.handleUserErrors(e);
+        }
     }
     getTransactionParams(transaction) {
-        return transaction.queries.map((transactionQuery) => ({
-            query: transactionQuery.query,
-            params: transactionQuery.params,
+        return transaction.queries.map((rqlQuery) => ({
+            query: rqlQuery.rql,
+            params: serializeQueryParams(transaction, rqlQuery.params),
         }));
     }
-    multipartTransaction(transaction) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const jsonParams = this.getTransactionParams(transaction);
-            const formData = new FormData();
-            formData.append("queries", JSON.stringify(jsonParams));
-            Object.entries(transaction.binaries).forEach(([key, value]) => {
-                formData.append(key, value);
-            });
-            const resultSets = yield nonNullFetchApi(this._rqlApiUrl, {
-                method: "POST",
-                credentials: "include",
-                body: formData,
-                headers: {
-                    "Content-Type": "multipart/form-data",
-                },
-            });
-            return new Transaction_1.TransactionResult(resultSets);
+    async multipartTransaction(transaction, binaries) {
+        const jsonParams = this.getTransactionParams(transaction);
+        const formData = new FormData();
+        formData.append("queries", JSON.stringify(jsonParams));
+        binaries.forEach((binary) => {
+            formData.append(binary.uuid, binary.blob);
+        });
+        const resultSets = await this.nonNullFetchApi(this._rqlApiUrl, {
+            method: "POST",
+            body: formData,
         });
+        return new TransactionResult(transaction, resultSets);
     }
-    jsonTransaction(transaction) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const resultSets = yield nonNullFetchApi(this._rqlApiUrl, {
-                method: "POST",
-                credentials: "include",
-                body: JSON.stringify(this.getTransactionParams(transaction)),
-            });
-            return new Transaction_1.TransactionResult(resultSets);
+    async jsonTransaction(transaction) {
+        const resultSets = await this.nonNullFetchApi(this._rqlApiUrl, {
+            method: "POST",
+            body: JSON.stringify(this.getTransactionParams(transaction)),
         });
+        return new TransactionResult(transaction, resultSets);
     }
     handleUserErrors(error) {
         if (typeof error === "object" &&
@@ -185,26 +180,24 @@ class Api {
             "message" in error &&
             typeof error.message === "string") {
             if (error.title === "ValidationError") {
-                throw new Errors_1.ValidationError(error.message);
+                throw new ValidationError(error.message);
             }
             throw error;
         }
         throw error;
     }
-}
-exports.default = Api;
-/**
- * Behaves the same as `fetchAPI` but forbids null responses.
- * If this function detects a null response from the API,
- * the promise will be rejected with a 500 error code.
- *
- * @param input The API route to use
- * @param init Additional request parameters
- * @returns A promise with the non-null fetched result
- */
-function nonNullFetchApi(input, init) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const result = yield fetchApi(input, init);
+    /**
+     * Behaves the same as `fetchAPI` but forbids null responses.
+     * If this function detects a null response from the API,
+     * the promise will be rejected with a 500 error code.
+     *
+     * @param input The API route to use
+     * @param init Additional request parameters
+     * @returns A promise with the non-null fetched result
+     */
+    async nonNullFetchApi(url, init) {
+        const response = await this.fetchApi(url, init);
+        const result = await response?.json();
         if (result == null) {
             const error = {
                 status: 500,
@@ -214,50 +207,60 @@ function nonNullFetchApi(input, init) {
             throw error;
         }
         return result;
-    });
-}
-/**
- * Sends a request to the given API route with the `Content-Type` header set and waits for a response.
- * The returned promise will be rejected if the API returns HTTP error codes.
- * The rejected promise will contain an `ApiErrorResponse` object.
- *
- * @param input The API route to use
- * @param init Additional request parameters
- * @returns A promise with the fetched result
- */
-function fetchApi(input, init) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let headers = init === null || init === void 0 ? void 0 : init.headers;
-        if ((init === null || init === void 0 ? void 0 : init.method) && init.method !== "GET") {
-            headers = Object.assign({ "Content-Type": "application/json;charset=UTF-8", 
-                // CSRF custom header necessary for POST requests
-                "X-Client-Name": "XMLHttpRequest" }, init === null || init === void 0 ? void 0 : init.headers);
+    }
+    /**
+     * Sends a request to the given API route with the `Content-Type` header set and waits for a response.
+     * The returned promise will be rejected if the API returns HTTP error codes.
+     * The rejected promise will contain an `ApiErrorResponse` object.
+     *
+     * @param input The API route to use
+     * @param init Additional request parameters
+     * @returns A promise with the response
+     */
+    async fetchApi(url, init) {
+        const headers = new Headers(init.headers);
+        // Add custom header  used as CSRF protection
+        // note: it is only necessary for non GET requests but can also be useful
+        // while debugging.
+        if (!headers.has("X-Client-Name")) {
+            headers.append("X-Client-Name", "XMLHttpRequest");
+        }
+        // Add a "Content-Type" header whenever a body is passed.
+        // The header might already have been set (either by the caller of this
+        // function or by and encoder)
+        if (init.body &&
+            !headers.has("Content-Type") &&
+            !(init.body instanceof FormData)) {
+            headers.append("Content-Type", "application/json;charset=UTF-8");
+        }
+        init.headers = headers;
+        // Authenticate request
+        if (this._authenticator) {
+            const authenticatedRequest = await this._authenticator.authenticate(url, init);
+            url = authenticatedRequest.url;
+            init = authenticatedRequest.init;
         }
-        const response = yield fetch(input, Object.assign(Object.assign({}, init), { headers }));
+        // Execute request
+        const response = await fetch(url, init);
+        // Parse response body and handle errors
         const status = response.status;
         if (status >= 200 && status < 300) {
             if (status === 204) {
                 return null;
             }
-            try {
-                return yield response.json();
-            }
-            catch (e) {
-                console.error(e);
-                return null;
-            }
+            return response;
         }
         else {
             let json;
             try {
-                json = yield response.json();
+                json = await response.json();
             }
             catch (e) {
                 console.error(e);
                 throw { status, title: "Error", message: "" };
             }
-            throw Object.assign({ status }, json);
+            throw { status, ...json };
         }
-    });
+    }
 }
 //# sourceMappingURL=Api.js.map

package/lib/api/Api.js.map

@@ -1 +1 @@
-{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAA4C;AAE5C,+CAKuB;AAiEvB;;;;;;;GAOG;AACH,MAAqB,GAAG;IAUtB;;;;;;;;;OASG;IACH,YAAY,MAAc;QAlBlB,aAAQ,GAAG,IAAI,CAAC;QAmBtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,WAAW,CAAC,KAAa;QAC/B,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACG,MAAM;;YACV,OAAO,eAAe,CAAY,IAAI,CAAC,aAAa,EAAE;gBACpD,MAAM,EAAE,KAAK;gBACb,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACG,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,IAAI;gBACF,MAAM,QAAQ,CAAO,IAAI,CAAC,YAAY,EAAE;oBACtC,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,KAAK;wBACL,QAAQ;qBACT,CAAC;oBACF,WAAW,EAAE,SAAS;iBACvB,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,MAAM,EAAE;gBACf,OAAO,KAAK,CAAC;aACd;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,MAAM;;YACV,MAAM,QAAQ,CAAO,IAAI,CAAC,aAAa,EAAE;gBACvC,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACG,WAAW;;YACf,OAAO,MAAM,eAAe,CAAc,IAAI,CAAC,kBAAkB,EAAE;gBACjE,MAAM,EAAE,KAAK;gBACb,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACG,MAAM,CAAC,GAAW,EAAE,SAAiB;;YACzC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;gBACjC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;gBACnB,SAAS;aACV,CAAC,CAAC;YACH,OAAO,MAAM,eAAe,CAAO,IAAI,CAAC,aAAa,GAAG,MAAM,EAAE;gBAC9D,MAAM,EAAE,KAAK;gBACb,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,GAAG,CAAC,WAAwB;;YAChC,IAAI;gBACF,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;oBAChD,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;iBACrD;qBAAM;oBACL,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAChD;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;aAC1B;QACH,CAAC;KAAA;IAEO,oBAAoB,CAAC,WAAwB;QACnD,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YACpD,KAAK,EAAE,gBAAgB,CAAC,KAAK;YAC7B,MAAM,EAAE,gBAAgB,CAAC,MAAM;SAChC,CAAC,CAAC,CAAC;IACN,CAAC;IAEa,oBAAoB,CAAC,WAAwB;;YACzD,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;YAChC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBAC5D,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,MAAM,eAAe,CACtC,IAAI,CAAC,UAAU,EACf;gBACE,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,qBAAqB;iBACtC;aACF,CACF,CAAC;YACF,OAAO,IAAI,+BAAiB,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEa,eAAe,CAAC,WAAwB;;YACpD,MAAM,UAAU,GAAG,MAAM,eAAe,CACtC,IAAI,CAAC,UAAU,EACf;gBACE,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;aAC7D,CACF,CAAC;YACF,OAAO,IAAI,+BAAiB,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEO,gBAAgB,CAAC,KAAc;QACrC,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,OAAO,IAAI,KAAK;YAChB,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;YAC/B,SAAS,IAAI,KAAK;YAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC;YACA,IAAI,KAAK,CAAC,KAAK,KAAK,iBAAiB,EAAE;gBACrC,MAAM,IAAI,wBAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC1C;YACD,MAAM,KAAK,CAAC;SACb;QACD,MAAM,KAAK,CAAC;IACd,CAAC;CACF;AAtLD,sBAsLC;AAED;;;;;;;;GAQG;AACH,SAAe,eAAe,CAC5B,KAAkB,EAClB,IAAkB;;QAElB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAI,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,MAAM,KAAK,GAAqB;gBAC9B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,0BAA0B;gBACjC,OAAO,EAAE,4CAA4C;aACtD,CAAC;YACF,MAAM,KAAK,CAAC;SACb;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,SAAe,QAAQ,CACrB,KAAkB,EAClB,IAAkB;;QAElB,IAAI,OAAO,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC;QAC5B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE;YACzC,OAAO,mBACL,cAAc,EAAE,gCAAgC;gBAChD,iDAAiD;gBACjD,eAAe,EAAE,gBAAgB,IAC9B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CACjB,CAAC;SACH;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,kCAC7B,IAAI,KACP,OAAO,IACP,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAG,EAAE;YACjC,IAAI,MAAM,KAAK,GAAG,EAAE;gBAClB,OAAO,IAAI,CAAC;aACb;YACD,IAAI;gBACF,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;aAC9B;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,OAAO,IAAI,CAAC;aACb;SACF;aAAM;YACL,IAAI,IAAI,CAAC;YACT,IAAI;gBACF,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;aAC9B;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;aAC/C;YACD,sBAAQ,MAAM,IAAK,IAAI,EAAG;SAC3B;IACH,CAAC;CAAA"}
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAI/E,OAAO,EAEL,iBAAiB,GAClB,MAAM,oCAAoC,CAAC;AA6D5C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,GAAG;IACd,OAAO,CAAS;IAChB,QAAQ,GAAG,IAAI,CAAC;IAChB,UAAU,CAAS;IACnB,aAAa,CAAS;IACtB,YAAY,CAAS;IACrB,aAAa,CAAS;IACtB,kBAAkB,CAAS;IAC3B,aAAa,CAAS;IACtB,cAAc,CAAiB;IAEvC;;;;;;;;;OASG;IACH,YAAY,MAAc,EAAE,OAAmB;QAC7C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,WAAW,CAAC,KAAa;QAC/B,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,IAAI,CAAC,eAAe,CAAY,IAAI,CAAC,aAAa,EAAE;YACzD,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,KAAa,EAAE,QAAgB;QACzC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE;gBACrC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,KAAK;oBACL,QAAQ;iBACT,CAAC;aACH,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE;YACtC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,MAAM,IAAI,CAAC,eAAe,CAAc,IAAI,CAAC,kBAAkB,EAAE;YACtE,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,SAAiB;QACzC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;YACjC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,SAAS;SACV,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,aAAa,IAAI,MAAM,EAAE,EAAE;YACtE,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACjB,MAAM,KAAK,GAAqB;gBAC9B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,0BAA0B;gBACjC,OAAO,EAAE,qBAAqB,MAAM,EAAE;aACvC,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,WAAwB;QAChC,MAAM,QAAQ,GAAG,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,oBAAoB,CAAC,WAAwB;QACnD,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC5C,KAAK,EAAE,QAAQ,CAAC,GAAG;YACnB,MAAM,EAAE,oBAAoB,CAAC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC;SAC3D,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,WAAwB,EACxB,QAAqB;QAErB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QACvD,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAC3C,IAAI,CAAC,UAAU,EACf;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;SACf,CACF,CAAC;QACF,OAAO,IAAI,iBAAiB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,WAAwB;QACpD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAC3C,IAAI,CAAC,UAAU,EACf;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;SAC7D,CACF,CAAC;QACF,OAAO,IAAI,iBAAiB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAEO,gBAAgB,CAAC,KAAc;QACrC,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,OAAO,IAAI,KAAK;YAChB,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;YAC/B,SAAS,IAAI,KAAK;YAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC,CAAC;YACD,IAAI,KAAK,CAAC,KAAK,KAAK,iBAAiB,EAAE,CAAC;gBACtC,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,eAAe,CAAc,GAAW,EAAE,IAAiB;QACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,MAAM,GAAM,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC;QACzC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,KAAK,GAAqB;gBAC9B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,0BAA0B;gBACjC,OAAO,EAAE,4CAA4C;aACtD,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,QAAQ,CACpB,GAAW,EACX,IAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE1C,6CAA6C;QAC7C,yEAAyE;QACzE,mBAAmB;QACnB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;QACpD,CAAC;QAED,yDAAyD;QACzD,uEAAuE;QACvE,8BAA8B;QAC9B,IACE,IAAI,CAAC,IAAI;YACT,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAC5B,CAAC,CAAC,IAAI,CAAC,IAAI,YAAY,QAAQ,CAAC,EAChC,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,gCAAgC,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,uBAAuB;QACvB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CACjE,GAAG,EACH,IAAI,CACL,CAAC;YACF,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC;YAC/B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;QACnC,CAAC;QAED,kBAAkB;QAClB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAExC,wCAAwC;QACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAG,EAAE,CAAC;YAClC,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC;YACT,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC/B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAChD,CAAC;YACD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;CACF"}

package/lib/api/Client.d.ts

@@ -1,6 +1,12 @@
-import { Schema } from "../schema/classes/Schema";
-import { RQLParams, ResultSet, CurrentUser } from "./Api";
-import { BinariesParam, Transaction, TransactionResult } from "./Transaction";
+import { Authenticator } from "../Authenticator.js";
+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";
+export interface ClientOptions {
+    authenticator?: Authenticator;
+}
 /**
  * Class used to communicate with a CubicWeb instance's API.
  *
@@ -15,27 +21,30 @@ 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, options?: ClientOptions);
     get apiUrl(): string;
     /**
      * 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 +61,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,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,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,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IACjB;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAInD,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"}