@cubicweb/client 1.4.0 → 1.5.0

package/lib/api/Api.d.ts

@@ -1,28 +1,112 @@
-import { RawSchema } from "../schema/SchemaJSON";
+import { RawSchema } from "../schema/raw/Schema";
+/**
+ * Type representing an RQL request and its associated parameters.
+ */
 export declare type RQLQuery = [string, RQLParams];
+/**
+ * Type representing RQL parameters to send along a request.
+ */
 export interface RQLParams {
     [key: string]: string | number;
 }
+/**
+ * Type representing a row returned in a result set.
+ */
 export declare type RqlRow = Array<string | number | boolean | null>;
+/**
+ * Type representing a RQL request result.
+ */
 export declare type ResultSet = Array<RqlRow>;
+/**
+ * Type representing the body of an error sent by CubicWeb's API.
+ */
 declare type ApiError = {
     title: string;
     message: string;
     data?: Record<string, unknown>;
 };
+/**
+ * Type representing the error data sent to clients when retrieving an API error.
+ */
 export declare type ApiErrorResponse = {
     status: number;
 } & ApiError;
+/**
+ * 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.
+ *
+ * @internal
+ */
 export default class Api {
-    private apiUrl;
-    private transactionApiUrl;
+    private _apiUrl;
+    private _version;
+    private _rqlApiUrl;
+    private _schemaApiUrl;
+    private _loginApiUrl;
+    private _transactionApiUrl;
+    /**
+     * 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.
+     *
+     * @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: string);
+    get apiUrl(): string;
+    private getApiRoute;
+    /**
+     * Executes the given query and waits for the response.
+     *
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     execute(query: string, params: RQLParams): Promise<ResultSet>;
+    /**
+     * Retrieves the CubicWeb instance's JSON schema.
+     *
+     * @returns The CubicWeb instance's JSON schema.
+     */
     schema(): Promise<RawSchema>;
+    /**
+     * 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
+     * @returns A promise returning true if the login was successful, false otherwise
+     */
     login(login: string, password: string): Promise<boolean>;
+    /**
+     * Starts a new transaction.
+     *
+     * @returns A promise with the transaction uuid
+     */
     transactionBegin(): Promise<string>;
+    /**
+     * Executes a RQL request as part of a transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     transactionExecute(uuid: string, query: string, params: RQLParams): Promise<ResultSet | null>;
+    /**
+     * Commits the transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     */
     transactionCommit(uuid: string): Promise<null>;
+    /**
+     * Rollbacks the transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     */
     transactionRollback(uuid: string): Promise<null>;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,oBAAY,QAAQ,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE3C,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,oBAAY,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;AAC7D,oBAAY,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AACtC,aAAK,QAAQ,GAAG;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AACF,oBAAY,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,QAAQ,CAAC;AAEb,MAAM,CAAC,OAAO,OAAO,GAAG;IACtB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,iBAAiB,CAKvB;gBAEU,MAAM,EAAE,MAAM;IAUpB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAQ7D,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;IAO5B,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxD,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOnC,kBAAkB,CACtB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAQtB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9C,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOvD"}
+{"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,oBAAY,QAAQ,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,oBAAY,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;AAE7D;;GAEG;AACH,oBAAY,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEtC;;GAEG;AACH,aAAK,QAAQ,GAAG;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,QAAQ,CAAC;AAEb;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,GAAG;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,kBAAkB,CAKxB;IAEF;;;;;;;;;OASG;gBACS,MAAM,EAAE,MAAM;IAY1B,IAAI,MAAM,WAET;IAED,OAAO,CAAC,WAAW;IAInB;;;;;;OAMG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAQnE;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;IAOlC;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa9D;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOzC;;;;;;;OAOG;IACG,kBAAkB,CACtB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAQ5B;;;;OAIG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpD;;;;OAIG;IACG,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOvD"}

package/lib/api/Api.js

@@ -9,37 +9,85 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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.
+ *
+ * @internal
+ */
 class Api {
+    /**
+     * 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.
+     *
+     * @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.transactionApiUrl = {
+        this._version = "v1";
+        this._transactionApiUrl = {
             begin: "",
             execute: "",
             commit: "",
             rollback: "",
         };
-        this.apiUrl = `${apiUrl}/v1`;
-        Object.keys(this.transactionApiUrl).forEach((k) => (this.transactionApiUrl[k] = `${this.apiUrl}/transaction/${k}`));
+        this._apiUrl = apiUrl;
+        this._rqlApiUrl = this.getApiRoute("rql");
+        this._schemaApiUrl = this.getApiRoute("schema");
+        this._loginApiUrl = this.getApiRoute("login");
+        Object.keys(this._transactionApiUrl).forEach((k) => (this._transactionApiUrl[k] =
+            this.getApiRoute(`transaction/${k}`)));
     }
+    get apiUrl() {
+        return this._apiUrl;
+    }
+    getApiRoute(route) {
+        return `${this._apiUrl}/${this._version}/${route}`;
+    }
+    /**
+     * Executes the given query and waits for the response.
+     *
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     execute(query, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return nonNullFetchApi(`${this.apiUrl}/rql`, {
+            return nonNullFetchApi(this._rqlApiUrl, {
                 method: "POST",
                 body: JSON.stringify({ query, params }),
                 credentials: "include", // FIXME is it secure?
             });
         });
     }
+    /**
+     * Retrieves the CubicWeb instance's JSON schema.
+     *
+     * @returns The CubicWeb instance's JSON schema.
+     */
     schema() {
         return __awaiter(this, void 0, void 0, function* () {
-            return nonNullFetchApi(`${this.apiUrl}/schema`, {
+            return nonNullFetchApi(this._schemaApiUrl, {
                 method: "GET",
                 credentials: "include",
             });
         });
     }
+    /**
+     * 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
+     * @returns A promise returning true if the login was successful, false otherwise
+     */
     login(login, password) {
         return __awaiter(this, void 0, void 0, function* () {
-            return fetchApi(`${this.apiUrl}/login`, {
+            return fetchApi(this._loginApiUrl, {
                 method: "POST",
                 body: JSON.stringify({
                     login,
@@ -51,35 +99,58 @@ class Api {
                 .catch(() => false);
         });
     }
+    /**
+     * Starts a new transaction.
+     *
+     * @returns A promise with the transaction uuid
+     */
     transactionBegin() {
         return __awaiter(this, void 0, void 0, function* () {
-            return nonNullFetchApi(this.transactionApiUrl.begin, {
+            return nonNullFetchApi(this._transactionApiUrl.begin, {
                 method: "POST",
                 credentials: "include",
             });
         });
     }
+    /**
+     * Executes a RQL request as part of a transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     transactionExecute(uuid, query, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return fetchApi(this.transactionApiUrl.execute, {
+            return fetchApi(this._transactionApiUrl.execute, {
                 method: "POST",
                 body: JSON.stringify({ uuid, query, params }),
                 credentials: "include",
             });
         });
     }
+    /**
+     * Commits the transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     */
     transactionCommit(uuid) {
         return __awaiter(this, void 0, void 0, function* () {
-            return fetchApi(this.transactionApiUrl.commit, {
+            return fetchApi(this._transactionApiUrl.commit, {
                 method: "POST",
                 body: JSON.stringify({ uuid }),
                 credentials: "include",
             });
         });
     }
+    /**
+     * Rollbacks the transaction identified by the given uuid.
+     *
+     * @param uuid The transaction's uuid
+     */
     transactionRollback(uuid) {
         return __awaiter(this, void 0, void 0, function* () {
-            return fetchApi(this.transactionApiUrl.rollback, {
+            return fetchApi(this._transactionApiUrl.rollback, {
                 method: "POST",
                 body: JSON.stringify({ uuid }),
                 credentials: "include",
@@ -88,6 +159,15 @@ class Api {
     }
 }
 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
+ */
 const nonNullFetchApi = (input, init) => {
     return new Promise((resolve, reject) => fetchApi(input, init)
         .then((v) => {
@@ -105,6 +185,15 @@ const nonNullFetchApi = (input, init) => {
     })
         .catch(reject));
 };
+/**
+ * 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
+ */
 const fetchApi = (input, init) => {
     let headers = init === null || init === void 0 ? void 0 : init.headers;
     if ((init === null || init === void 0 ? void 0 : init.method) && init.method !== "GET" && init.method !== "DELETE") {

package/lib/api/Api.js.map

@@ -1 +1 @@
-{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":";;;;;;;;;;;AAmBA,MAAqB,GAAG;IAStB,YAAY,MAAc;QAPlB,sBAAiB,GAAG;YAC1B,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;SACb,CAAC;QAGA,IAAI,CAAC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CACzC,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,IAAI,CAAC,iBAAiB,CACrB,CAAwC,CACzC,GAAG,GAAG,IAAI,CAAC,MAAM,gBAAgB,CAAC,EAAE,CAAC,CACzC,CAAC;IACJ,CAAC;IAEK,OAAO,CAAC,KAAa,EAAE,MAAiB;;YAC5C,OAAO,eAAe,CAAY,GAAG,IAAI,CAAC,MAAM,MAAM,EAAE;gBACtD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACvC,WAAW,EAAE,SAAS,EAAE,sBAAsB;aAC/C,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,MAAM;;YACV,OAAO,eAAe,CAAY,GAAG,IAAI,CAAC,MAAM,SAAS,EAAE;gBACzD,MAAM,EAAE,KAAK;gBACb,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,OAAO,QAAQ,CAAO,GAAG,IAAI,CAAC,MAAM,QAAQ,EAAE;gBAC5C,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,KAAK;oBACL,QAAQ;iBACT,CAAC;gBACF,WAAW,EAAE,SAAS;aACvB,CAAC;iBACC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;iBAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;KAAA;IAEK,gBAAgB;;YACpB,OAAO,eAAe,CAAS,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,kBAAkB,CACtB,IAAY,EACZ,KAAa,EACb,MAAiB;;YAEjB,OAAO,QAAQ,CAAY,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;gBACzD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBAC7C,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,iBAAiB,CAAC,IAAY;;YAClC,OAAO,QAAQ,CAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE;gBACnD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC9B,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,mBAAmB,CAAC,IAAY;;YACpC,OAAO,QAAQ,CAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBACrD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC9B,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAjFD,sBAiFC;AAED,MAAM,eAAe,GAAG,CACtB,KAAkB,EAClB,IAAkB,EAClB,EAAE;IACF,OAAO,IAAI,OAAO,CAChB,CAAC,OAA2B,EAAE,MAA0C,EAAE,EAAE,CAC1E,QAAQ,CAAI,KAAK,EAAE,IAAI,CAAC;SACrB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACV,IAAI,CAAC,IAAI,IAAI,EAAE;YACb,MAAM,KAAK,GAAqB;gBAC9B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,0BAA0B;gBACjC,OAAO,EAAE,4CAA4C;aACtD,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC;SACf;aAAM;YACL,OAAO,CAAC,CAAC,CAAC,CAAC;SACZ;IACH,CAAC,CAAC;SACD,KAAK,CAAC,MAAM,CAAC,CACnB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAc,KAAkB,EAAE,IAAkB,EAAE,EAAE;IACvE,IAAI,OAAO,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC;IAC5B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;QACrE,OAAO,mBACL,cAAc,EAAE,gCAAgC,IAC7C,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CACjB,CAAC;KACH;IACD,OAAO,IAAI,OAAO,CAChB,CACE,OAAkC,EAClC,MAA0C,EAC1C,EAAE,CACF,KAAK,CAAC,KAAK,kCACN,IAAI,KACP,OAAO,IACP,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnB,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,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,QAAQ;qBACL,IAAI,EAAE;qBACN,IAAI,CAAC,OAAO,CAAC;qBACb,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;aACN;SACF;aAAM;YACL,QAAQ;iBACL,IAAI,EAAE;iBACN,IAAI,CAAC,CAAC,IAAc,EAAE,EAAE;gBACvB,MAAM,iBACJ,MAAM,IACH,IAAI,EACP,CAAC;YACL,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;SACN;IACH,CAAC,CAAC,CACL,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":";;;;;;;;;;;AAwCA;;;;;;;GAOG;AACH,MAAqB,GAAG;IAatB;;;;;;;;;OASG;IACH,YAAY,MAAc;QArBlB,aAAQ,GAAG,IAAI,CAAC;QAIhB,uBAAkB,GAAG;YAC3B,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;SACb,CAAC;QAaA,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAC1C,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAyC,CAAC;YACjE,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAC1C,CAAC;IACJ,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;;;;;;OAMG;IACG,OAAO,CAAC,KAAa,EAAE,MAAiB;;YAC5C,OAAO,eAAe,CAAY,IAAI,CAAC,UAAU,EAAE;gBACjD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACvC,WAAW,EAAE,SAAS,EAAE,sBAAsB;aAC/C,CAAC,CAAC;QACL,CAAC;KAAA;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,OAAO,QAAQ,CAAO,IAAI,CAAC,YAAY,EAAE;gBACvC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,KAAK;oBACL,QAAQ;iBACT,CAAC;gBACF,WAAW,EAAE,SAAS;aACvB,CAAC;iBACC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;iBAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;KAAA;IAED;;;;OAIG;IACG,gBAAgB;;YACpB,OAAO,eAAe,CAAS,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE;gBAC5D,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,kBAAkB,CACtB,IAAY,EACZ,KAAa,EACb,MAAiB;;YAEjB,OAAO,QAAQ,CAAY,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBAC1D,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBAC7C,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACG,iBAAiB,CAAC,IAAY;;YAClC,OAAO,QAAQ,CAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE;gBACpD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC9B,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACG,mBAAmB,CAAC,IAAY;;YACpC,OAAO,QAAQ,CAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE;gBACtD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC9B,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAnJD,sBAmJC;AAED;;;;;;;;GAQG;AACH,MAAM,eAAe,GAAG,CACtB,KAAkB,EAClB,IAAkB,EAClB,EAAE;IACF,OAAO,IAAI,OAAO,CAChB,CAAC,OAA2B,EAAE,MAA0C,EAAE,EAAE,CAC1E,QAAQ,CAAI,KAAK,EAAE,IAAI,CAAC;SACrB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACV,IAAI,CAAC,IAAI,IAAI,EAAE;YACb,MAAM,KAAK,GAAqB;gBAC9B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,0BAA0B;gBACjC,OAAO,EAAE,4CAA4C;aACtD,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC;SACf;aAAM;YACL,OAAO,CAAC,CAAC,CAAC,CAAC;SACZ;IACH,CAAC,CAAC;SACD,KAAK,CAAC,MAAM,CAAC,CACnB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAc,KAAkB,EAAE,IAAkB,EAAE,EAAE;IACvE,IAAI,OAAO,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC;IAC5B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;QACrE,OAAO,mBACL,cAAc,EAAE,gCAAgC,IAC7C,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CACjB,CAAC;KACH;IACD,OAAO,IAAI,OAAO,CAChB,CACE,OAAkC,EAClC,MAA0C,EAC1C,EAAE,CACF,KAAK,CAAC,KAAK,kCACN,IAAI,KACP,OAAO,IACP,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnB,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,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,QAAQ;qBACL,IAAI,EAAE;qBACN,IAAI,CAAC,OAAO,CAAC;qBACb,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACjB,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC,CAAC,CAAC;aACN;SACF;aAAM;YACL,QAAQ;iBACL,IAAI,EAAE;iBACN,IAAI,CAAC,CAAC,IAAc,EAAE,EAAE;gBACvB,MAAM,iBACJ,MAAM,IACH,IAAI,EACP,CAAC;YACL,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;SACN;IACH,CAAC,CAAC,CACL,CAAC;AACJ,CAAC,CAAC"}

package/lib/api/Client.d.ts

@@ -1,12 +1,50 @@
-import { Schema } from "../schema/Schema";
+import { Schema } from "../schema/classes/Schema";
 import { RQLParams } from "./Api";
 import Transaction from "./Transaction";
+/**
+ * Class used to communicate with a CubicWeb instance's API.
+ */
 export default class Client {
     private api;
+    /**
+     * Class used to communicate with a CubicWeb instance's API.
+     *
+     * @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: string);
+    get apiUrl(): string;
+    /**
+     * Executes the given query and waits for the response.
+     *
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     execute(query: string, params?: RQLParams): Promise<import("./Api").ResultSet>;
+    /**
+     * Retrieves the CubicWeb instance's JSON schema.
+     *
+     * @returns The CubicWeb instance's JSON schema.
+     */
     schema(): Promise<Schema<import("..").EntityRawSchemaArray, import("..").RelationDefinitionRawSchemaArray<import("..").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
+     * @returns A promise returning true if the login was successful, false otherwise
+     */
     login(login: string, password: string): Promise<boolean>;
+    /**
+     * Creates a new transaction and exposes the Transaction object in the given callback.
+     * Use this callback to execute RQL requests as part of the transaction.
+     * Once the callback's end is reached, the transaction is automatically committed.
+     *
+     * @param callback Function to execute transaction requests in.
+     * @returns The promise returned by the callback
+     */
     transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T>;
 }
 //# sourceMappingURL=Client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;gBAEL,MAAM,EAAE,MAAM;IAIpB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAI7C,MAAM;IAKN,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIrC,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS5E"}
+{"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,MAAM,OAAO,CAAC;AACvC,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IAEjB;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM;IAI1B,IAAI,MAAM,WAET;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAInD;;;;OAIG;IACG,MAAM;IAKZ;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAI3C;;;;;;;OAOG;IACG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS5E"}

package/lib/api/Client.js

@@ -12,29 +12,69 @@ 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/Schema");
+const Schema_1 = require("../schema/classes/Schema");
 const Api_1 = __importDefault(require("./Api"));
 const Transaction_1 = __importDefault(require("./Transaction"));
+/**
+ * Class used to communicate with a CubicWeb instance's API.
+ */
 class Client {
+    /**
+     * Class used to communicate with a CubicWeb instance's API.
+     *
+     * @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.api = new Api_1.default(apiUrl);
     }
+    get apiUrl() {
+        return this.api.apiUrl;
+    }
+    /**
+     * Executes the given query and waits for the response.
+     *
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     execute(query, params = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.api.execute(query, params);
         });
     }
+    /**
+     * 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);
         });
     }
+    /**
+     * 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
+     * @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);
         });
     }
+    /**
+     * Creates a new transaction and exposes the Transaction object in the given callback.
+     * Use this callback to execute RQL requests as part of the transaction.
+     * Once the callback's end is reached, the transaction is automatically committed.
+     *
+     * @param callback Function to execute transaction requests in.
+     * @returns The promise returned by the callback
+     */
     transaction(callback) {
         return __awaiter(this, void 0, void 0, function* () {
             const transaction = new Transaction_1.default(this.api);

package/lib/api/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,6CAA0C;AAC1C,gDAAuC;AACvC,gEAAwC;AAExC,MAAqB,MAAM;IAGzB,YAAY,MAAc;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAEK,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEK,MAAM;;YACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;KAAA;IAEK,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEK,WAAW,CAAI,QAAyC;;YAC5D,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC3C,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE;gBAC3B,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC;aAC5B;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AA7BD,yBA6BC"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../src/api/Client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,qDAAkD;AAClD,gDAAuC;AACvC,gEAAwC;AAExC;;GAEG;AACH,MAAqB,MAAM;IAGzB;;;;;;OAMG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACG,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACG,MAAM;;YACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;KAAA;IAED;;;;;;OAMG;IACG,KAAK,CAAC,KAAa,EAAE,QAAgB;;YACzC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,WAAW,CAAI,QAAyC;;YAC5D,MAAM,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC3C,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE;gBAC3B,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC;aAC5B;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAnED,yBAmEC"}

package/lib/api/Transaction.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,MAAM,CAAC,OAAO,OAAO,WAAW;IAIlB,OAAO,CAAC,GAAG;IAHvB,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,OAAO,CAAS;gBAEJ,GAAG,EAAE,GAAG;IAE5B,QAAQ;IAIR,IAAI,IAAI,kBAEP;IAEK,KAAK;IAKL,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAK7C,MAAM;IAMN,QAAQ;IAMd,OAAO,CAAC,oBAAoB;CAK7B"}
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAclB,OAAO,CAAC,GAAG;IAbvB,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,OAAO,CAAS;IAExB;;;;;;;;;OASG;gBACiB,GAAG,EAAE,GAAG;IAE5B;;OAEG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,IAAI,kBAEP;IAED;;OAEG;IACG,KAAK;IAKX;;;;;;;;OAQG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAKnD;;OAEG;IACG,MAAM;IAMZ;;OAEG;IACG,QAAQ;IAMd,OAAO,CAAC,oBAAoB;CAK7B"}

package/lib/api/Transaction.js

@@ -10,30 +10,69 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Errors_1 = require("../Errors");
+/**
+ * Class used to handle CubicWeb's transactions.
+ * A transaction allows to execute several RQL requests without altering the database until all
+ * changes are committed.
+ *
+ * You should never have to create this object yourself.
+ * Instead, retrieve this object from the methods in the `Client` class.
+ */
 class Transaction {
+    /**
+     * Class used to handle CubicWeb's transactions.
+     * A transaction allows to execute several RQL requests without altering the database until all
+     * changes are committed.
+     *
+     * You should never have to create this object yourself.
+     * Instead, retrieve this object from the methods in the `Client` class.
+     *
+     * @param api The API object used to communicate with the CubicWeb backend.
+     */
     constructor(api) {
         this.api = api;
         this._uuid = null;
         this._closed = false;
     }
+    /**
+     * @returns True if the connection is closed.
+     */
     isClosed() {
         return this._closed;
     }
+    /**
+     * This transaction unique identifier.
+     */
     get uuid() {
         return this._uuid;
     }
+    /**
+     * Begins a new transaction an retrieves the associated uuid.
+     */
     begin() {
         return __awaiter(this, void 0, void 0, function* () {
             this._closed = false;
             this._uuid = yield this.api.transactionBegin();
         });
     }
+    /**
+     * Executes the given query and waits for the response.
+     * Make sure you called `begin` before using this method.
+     * As this is a transaction changes will only be applied when you call the `commit` method.
+     *
+     * @param query The RQL query to send
+     * @param params The additional parameters for the request
+     * @returns A promise with the request's result set
+     */
     execute(query, params = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             this.preventUsageIfClosed();
             return yield this.api.transactionExecute(this.uuid, query, params);
         });
     }
+    /**
+     * Commits the transaction to apply all the RQL queries sent with `execute`.
+     */
     commit() {
         return __awaiter(this, void 0, void 0, function* () {
             this.preventUsageIfClosed();
@@ -41,6 +80,9 @@ class Transaction {
             this._closed = true;
         });
     }
+    /**
+     * Rollbacks all the queries sent with `execute` and closes the transaction.
+     */
     rollback() {
         return __awaiter(this, void 0, void 0, function* () {
             this.preventUsageIfClosed();

package/lib/api/Transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAmD;AAGnD,MAAqB,WAAW;IAI9B,YAAoB,GAAQ;QAAR,QAAG,GAAH,GAAG,CAAK;QAHpB,UAAK,GAAkB,IAAI,CAAC;QAC5B,YAAO,GAAG,KAAK,CAAC;IAEO,CAAC;IAEhC,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEK,KAAK;;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACjD,CAAC;KAAA;IAEK,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACrE,CAAC;KAAA;IAEK,MAAM;;YACV,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAEK,QAAQ;;YACZ,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,IAAI,+BAAsB,EAAE,CAAC;SACpC;IACH,CAAC;CACF;AAzCD,8BAyCC"}
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAmD;AAGnD;;;;;;;GAOG;AACH,MAAqB,WAAW;IAI9B;;;;;;;;;OASG;IACH,YAAoB,GAAQ;QAAR,QAAG,GAAH,GAAG,CAAK;QAbpB,UAAK,GAAkB,IAAI,CAAC;QAC5B,YAAO,GAAG,KAAK,CAAC;IAYO,CAAC;IAEhC;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACG,KAAK;;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACjD,CAAC;KAAA;IAED;;;;;;;;OAQG;IACG,OAAO,CAAC,KAAa,EAAE,SAAoB,EAAE;;YACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACrE,CAAC;KAAA;IAED;;OAEG;IACG,MAAM;;YACV,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAED;;OAEG;IACG,QAAQ;;YACZ,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;KAAA;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,IAAI,+BAAsB,EAAE,CAAC;SACpC;IACH,CAAC;CACF;AA3ED,8BA2EC"}

package/lib/index.d.ts

@@ -1,8 +1,14 @@
-export { getLooseSchema, Schema, EntitySchema, RelationDefinitionSchema, } from "./schema/Schema";
-export * from "./schema/SchemaJSON";
+export * from "./schema/raw/Constraints";
+export * from "./schema/raw/Entities";
+export * from "./schema/raw/RelationDefinitions";
+export * from "./schema/raw/Schema";
+export * from "./schema/raw/Utils";
+export * from "./schema/classes/EntitySchema";
+export * from "./schema/classes/RelationDefinitionSchema";
+export * from "./schema/classes/Schema";
+export * from "./schema/classes/Utils";
 export * from "./Errors";
 export { default as Client } from "./api/Client";
-export { default as Api } from "./api/Api";
 export { default as Transaction } from "./api/Transaction";
 export { RQLQuery, RQLParams, RqlRow, ResultSet, ApiErrorResponse, } from "./api/Api";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

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