@cubicweb/client 1.0.3 → 1.0.4

package/lib/Errors.d.ts

@@ -0,0 +1,10 @@
+export declare class InconsistentSchemaError extends Error {
+    constructor(message: string);
+}
+export declare class RelationNotFoundError extends Error {
+    constructor(relationType: string, role: "object" | "subject", entityType: string);
+}
+export declare class TransactionClosedError extends Error {
+    constructor();
+}
+//# sourceMappingURL=Errors.d.ts.map

package/lib/Errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.d.ts","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":"AAAA,qBAAa,uBAAwB,SAAQ,KAAK;gBACpC,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAE5C,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM;CAOrB;AAED,qBAAa,sBAAuB,SAAQ,KAAK;;CAKhD"}

package/lib/Errors.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionClosedError = exports.RelationNotFoundError = exports.InconsistentSchemaError = void 0;
+class InconsistentSchemaError extends Error {
+    constructor(message) {
+        super(`Inconsistent schema: ${message}`);
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.InconsistentSchemaError = InconsistentSchemaError;
+class RelationNotFoundError extends Error {
+    constructor(relationType, role, entityType) {
+        super(`Relation Not Found: relation type ${relationType} with entity type ${entityType} as ${role} is not declared`);
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.RelationNotFoundError = RelationNotFoundError;
+class TransactionClosedError extends Error {
+    constructor() {
+        super("Trying to use a closed transaction");
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.TransactionClosedError = TransactionClosedError;
+//# sourceMappingURL=Errors.js.map

package/lib/Errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,OAAe;QACzB,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AALD,0DAKC;AAED,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YACE,YAAoB,EACpB,IAA0B,EAC1B,UAAkB;QAElB,KAAK,CACH,qCAAqC,YAAY,qBAAqB,UAAU,OAAO,IAAI,kBAAkB,CAC9G,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AAXD,sDAWC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAC/C;QACE,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC5C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AALD,wDAKC"}

package/lib/api/Api.d.ts

@@ -0,0 +1,27 @@
+import { RawSchema } from "../schema/SchemaJSON";
+export declare type RQLQuery = [string, RQLParams];
+export interface RQLParams {
+    [key: string]: string | number;
+}
+export declare type RqlRow = Array<string | number | boolean | null>;
+export declare type ResultSet = Array<RqlRow>;
+export declare type ApiError = {
+    error: string;
+    message: string;
+};
+export declare type ApiErrorResponse = {
+    status: number;
+} & ApiError;
+export default class Api {
+    private apiUrl;
+    private transactionApiUrl;
+    constructor(apiUrl: string);
+    execute(query: string, params: RQLParams): Promise<ResultSet>;
+    schema(): Promise<RawSchema>;
+    transactionBegin(): Promise<Response>;
+    transactionExecute(uuid: string, query: string, params: RQLParams): Promise<ResultSet>;
+    transactionCommit(uuid: string): Promise<Response>;
+    transactionRollback(uuid: string): Promise<Response>;
+}
+export declare const fetchApi: (input: RequestInfo, init?: RequestInit | undefined) => Promise<ResultSet>;
+//# sourceMappingURL=Api.d.ts.map

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

@@ -0,0 +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,oBAAY,QAAQ,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAC1D,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,CAAS;gBAEtB,MAAM,EAAE,MAAM;IAKpB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IAQxC,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;IAM5B,gBAAgB;IAShB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IASjE,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAS9B,mBAAmB,CAAC,IAAI,EAAE,MAAM;CAQvC;AAED,eAAO,MAAM,QAAQ,UAAW,WAAW,uDAqB1C,CAAC"}

package/lib/api/Api.js

@@ -0,0 +1,94 @@
+"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 });
+exports.fetchApi = void 0;
+class Api {
+    constructor(apiUrl) {
+        this.apiUrl = `${apiUrl}/v1`;
+        this.transactionApiUrl = `${this.apiUrl}/transaction`;
+    }
+    execute(query, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, exports.fetchApi)(`${this.apiUrl}/rql`, {
+                method: "POST",
+                body: JSON.stringify({ query, params }),
+                credentials: "include", // FIXME is it secure?
+            });
+        });
+    }
+    schema() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.apiUrl}/schema`);
+            const schema = yield res.json();
+            return schema;
+        });
+    }
+    transactionBegin() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = JSON.stringify({ action: "begin" });
+            return yield fetch(this.transactionApiUrl, {
+                method: "POST",
+                body,
+                credentials: "include",
+            });
+        });
+    }
+    transactionExecute(uuid, query, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = JSON.stringify({ action: "execute", uuid, query, params });
+            return (0, exports.fetchApi)(this.transactionApiUrl, {
+                method: "POST",
+                body,
+                credentials: "include",
+            });
+        });
+    }
+    transactionCommit(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = JSON.stringify({ action: "commit", uuid });
+            return yield fetch(this.transactionApiUrl, {
+                method: "POST",
+                body,
+                credentials: "include",
+            });
+        });
+    }
+    transactionRollback(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = JSON.stringify({ action: "commit", uuid });
+            return yield fetch(this.transactionApiUrl, {
+                method: "POST",
+                body,
+                credentials: "include",
+            });
+        });
+    }
+}
+exports.default = Api;
+const fetchApi = (input, init) => {
+    return new Promise((resolve, reject) => fetch(input, init).then((response) => {
+        const status = response.status;
+        if (status === 200) {
+            response.json().then(resolve);
+        }
+        else {
+            response.json().then((data) => {
+                reject({
+                    status,
+                    error: data.error,
+                    message: data.message,
+                });
+            });
+        }
+    }));
+};
+exports.fetchApi = fetchApi;
+//# sourceMappingURL=Api.js.map

package/lib/api/Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../src/api/Api.ts"],"names":[],"mappings":";;;;;;;;;;;;AAeA,MAAqB,GAAG;IAItB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,GAAG,IAAI,CAAC,MAAM,cAAc,CAAC;IACxD,CAAC;IAEK,OAAO,CAAC,KAAa,EAAE,MAAiB;;YAC5C,OAAO,IAAA,gBAAQ,EAAC,GAAG,IAAI,CAAC,MAAM,MAAM,EAAE;gBACpC,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,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC;YACjD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;YAChC,OAAO,MAAmB,CAAC;QAC7B,CAAC;KAAA;IAEK,gBAAgB;;YACpB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YACjD,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBACzC,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,kBAAkB,CAAC,IAAY,EAAE,KAAa,EAAE,MAAiB;;YACrE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YACxE,OAAO,IAAA,gBAAQ,EAAC,IAAI,CAAC,iBAAiB,EAAE;gBACtC,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,iBAAiB,CAAC,IAAY;;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YACxD,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBACzC,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,mBAAmB,CAAC,IAAY;;YACpC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YACxD,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBACzC,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,WAAW,EAAE,SAAS;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA1DD,sBA0DC;AAEM,MAAM,QAAQ,GAAG,CAAC,KAAkB,EAAE,IAAkB,EAAE,EAAE;IACjE,OAAO,IAAI,OAAO,CAChB,CACE,OAAmC,EACnC,MAA0C,EAC1C,EAAE,CACF,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC/B;aAAM;YACL,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,IAAc,EAAE,EAAE;gBACtC,MAAM,CAAC;oBACL,MAAM;oBACN,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CACL,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,QAAQ,YAqBnB"}

package/lib/api/Client.d.ts

@@ -0,0 +1,11 @@
+import { Schema } from "../schema/Schema";
+import { RQLParams } from "./Api";
+import Transaction from "./Transaction";
+export default class Client {
+    private api;
+    constructor(apiUrl: string);
+    execute(query: string, params?: RQLParams): Promise<import("./Api").ResultSet>;
+    schema(): Promise<Schema>;
+    transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T>;
+}
+//# sourceMappingURL=Client.d.ts.map

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

@@ -0,0 +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,IAAI,OAAO,CAAC,MAAM,CAAC;IAKzB,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

@@ -0,0 +1,46 @@
+"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/Schema");
+const Api_1 = __importDefault(require("./Api"));
+const Transaction_1 = __importDefault(require("./Transaction"));
+class Client {
+    constructor(apiUrl) {
+        this.api = new Api_1.default(apiUrl);
+    }
+    execute(query, params = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.api.execute(query, params);
+        });
+    }
+    schema() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const schema = yield this.api.schema();
+            return new Schema_1.Schema(schema);
+        });
+    }
+    transaction(callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const transaction = new Transaction_1.default(this.api);
+            yield transaction.begin();
+            const result = yield callback(transaction);
+            if (!transaction.isClosed()) {
+                transaction.commit();
+            }
+            return result;
+        });
+    }
+}
+exports.default = Client;
+//# sourceMappingURL=Client.js.map

package/lib/api/Client.js.map

@@ -0,0 +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,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,WAAW,CAAC,MAAM,EAAE,CAAC;aACtB;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAzBD,yBAyBC"}

package/lib/api/Transaction.d.ts

@@ -0,0 +1,15 @@
+import Api, { RQLParams } from "./Api";
+export default class Transaction {
+    private api;
+    private _uuid;
+    private _closed;
+    constructor(api: Api);
+    isClosed(): boolean;
+    get uuid(): string | null;
+    begin(): Promise<void>;
+    execute(query: string, params?: RQLParams): Promise<import("./Api").ResultSet>;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+    private preventUsageIfClosed;
+}
+//# sourceMappingURL=Transaction.d.ts.map

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

@@ -0,0 +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;IAOL,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,SAAc;IAK7C,MAAM;IAMN,QAAQ;IAMd,OAAO,CAAC,oBAAoB;CAK7B"}

package/lib/api/Transaction.js

@@ -0,0 +1,60 @@
+"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");
+class Transaction {
+    constructor(api) {
+        this.api = api;
+        this._uuid = null;
+        this._closed = false;
+    }
+    isClosed() {
+        return this._closed;
+    }
+    get uuid() {
+        return this._uuid;
+    }
+    begin() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._closed = false;
+            const response = yield this.api.transactionBegin();
+            const json = yield response.json();
+            this._uuid = json;
+        });
+    }
+    execute(query, params = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.preventUsageIfClosed();
+            return yield this.api.transactionExecute(this.uuid, query, params);
+        });
+    }
+    commit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.preventUsageIfClosed();
+            yield this.api.transactionCommit(this.uuid);
+            this._closed = true;
+        });
+    }
+    rollback() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.preventUsageIfClosed();
+            yield this.api.transactionRollback(this.uuid);
+            this._closed = true;
+        });
+    }
+    preventUsageIfClosed() {
+        if (this.isClosed()) {
+            throw new Errors_1.TransactionClosedError();
+        }
+    }
+}
+exports.default = Transaction;
+//# sourceMappingURL=Transaction.js.map

package/lib/api/Transaction.js.map

@@ -0,0 +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,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACnD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,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;AA3CD,8BA2CC"}

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+export { getLooseSchema, Schema, EntitySchema, RelationDefinitionSchema, } from "./schema/Schema";
+export * from "./schema/SchemaJSON";
+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

@@ -0,0 +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"}

package/lib/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transaction = exports.Api = exports.Client = exports.RelationDefinitionSchema = exports.EntitySchema = exports.Schema = exports.getLooseSchema = void 0;
+var Schema_1 = require("./schema/Schema");
+Object.defineProperty(exports, "getLooseSchema", { enumerable: true, get: function () { return Schema_1.getLooseSchema; } });
+Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return Schema_1.Schema; } });
+Object.defineProperty(exports, "EntitySchema", { enumerable: true, get: function () { return Schema_1.EntitySchema; } });
+Object.defineProperty(exports, "RelationDefinitionSchema", { enumerable: true, get: function () { return Schema_1.RelationDefinitionSchema; } });
+__exportStar(require("./schema/SchemaJSON"), exports);
+__exportStar(require("./Errors"), exports);
+var Client_1 = require("./api/Client");
+Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return __importDefault(Client_1).default; } });
+var Api_1 = require("./api/Api");
+Object.defineProperty(exports, "Api", { enumerable: true, get: function () { return __importDefault(Api_1).default; } });
+var Transaction_1 = require("./api/Transaction");
+Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return __importDefault(Transaction_1).default; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,0CAKyB;AAJvB,wGAAA,cAAc,OAAA;AACd,gGAAA,MAAM,OAAA;AACN,sGAAA,YAAY,OAAA;AACZ,kHAAA,wBAAwB,OAAA;AAE1B,sDAAoC;AACpC,2CAAyB;AACzB,uCAAiD;AAAxC,iHAAA,OAAO,OAAU;AAC1B,iCAA2C;AAAlC,2GAAA,OAAO,OAAO;AACvB,iDAA2D;AAAlD,2HAAA,OAAO,OAAe"}

package/lib/schema/Schema.d.ts

@@ -0,0 +1,169 @@
+import { Cardinality } from "..";
+import { RawSchema, RelationDefinitionRawSchema, RelationDefinitionRawSchemaArray, EntityRawSchemaArray, EntityRawSchemaByType, IsLooseSchema, IsETypeInStrictSchema } from "./SchemaJSON";
+declare const rawSchemaKey: unique symbol;
+/**
+ * Returns the given schema using loose typing.
+ * Can be useful when working for generic schemas
+ *
+ * @param schema The schema to create a loose type for
+ * @returns
+ */
+export declare const getLooseSchema: <E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>>(schema: Schema<E, R>) => Schema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>>;
+/**
+ * Wrapper around the raw JSON Schema
+ */
+export declare class Schema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
+R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> {
+    [rawSchemaKey]: RawSchema<E, R>;
+    constructor(rawSchema: RawSchema<E, R>);
+    get entities(): EntitySchema<E, R, E[number]>[];
+    get relationsDefinitions(): RelationDefinitionSchema<E, R, R[number]>[];
+    /**
+     * Returns the entity schema for the given entity type if it exists.
+     * When using TypeScript, this method can detect if the given type does not exist
+     * in the schema.
+     *
+     * @param entityType The entity type string
+     * @returns A new EntitySchema or null if the type does not exist
+     */
+    getEntity<EType extends string>(entityType: EType): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> | null : IsETypeInStrictSchema<E, EType> extends true ? EntitySchema<E, R, EntityRawSchemaByType<E, EType>> : null;
+    /**
+     * Finds relations in the Schema matching the partial relation given
+     *
+     * @param matcher Partial relation definition to match against
+     * @returns Matched relation schema classes
+     */
+    matchRelationDefinitions<M extends RelationDefinitionMatcher<E>>(matcher: M): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
+        subject: E[number]["type"];
+    }>>[];
+}
+/**
+ * Wrapper around raw entities from the Schema
+ */
+export declare class EntitySchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
+R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>, // List of all relation defintions
+ERawSchema extends E[number] = E[number]> {
+    private schema;
+    private entityRawSchema;
+    constructor(schema: Schema<E, R>, entityRawSchema: ERawSchema);
+    /**
+     * The type of the entity. This can also be referred to as the entity' name.
+     */
+    get type(): ERawSchema["type"];
+    /**
+     * A short description which can be used as documentation for the entity.
+     */
+    get description(): ERawSchema["description"];
+    /**
+     * True if the current entity is a primitive type such as string or int
+     */
+    get final(): ERawSchema["final"];
+    /**
+     * Gets the list of relation definitions with this entity as subject
+     */
+    get subjectRelationDefinitions(): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
+        subject: ERawSchema["type"];
+    }>>[];
+    /**
+     * Gets the list of relation definitions with this entity as object
+     */
+    get objectRelationsDefinitions(): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
+        object: ERawSchema["type"];
+    }>>[];
+    /**
+     * Finds the first relation of the given type with this entity as subject
+     *
+     * @param relationType The relation type to find
+     * @throws RelationNotFoundError if the current entity is not a subject of the given relation
+     * @returns The found relation
+     */
+    getSubjectRelationDefinition<RelationType extends MatchedRelationDefinition<E, R, {
+        subject: ERawSchema["type"];
+    }>["type"]>(relationType: RelationType): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
+        subject: ERawSchema["type"];
+        type: RelationType;
+    }>>;
+    /**
+     * Finds the first relation of the given type with this entity as object
+     *
+     * @param relationType The relation type to find
+     * @throws RelationNotFoundError if the current entity is not an object of the given relation
+     * @returns The found relation
+     */
+    getObjectRelationDefinition<RelationType extends MatchedRelationDefinition<E, R, {
+        object: ERawSchema["type"];
+    }>["type"]>(relationType: RelationType): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
+        object: ERawSchema["type"];
+        type: RelationType;
+    }>>;
+    /**
+     * Gets the list of attributes names for this entity
+     */
+    get attributes(): RelationDefinitionSchema<E, R, R[number]>[];
+    /**
+     * Checks whether the current entity is required for the given relation and role
+     *
+     * @param relationType The relation to check
+     * @param role The role for this entity in the given relation
+     * @returns True if this entity is required in the relation for the given role
+     */
+    isRelationRequired<RelationType extends MatchedRelationDefinition<E, R, {
+        subject: ERawSchema["type"];
+    } | {
+        object: ERawSchema["type"];
+    }>["type"]>(relationType: RelationType, role: "subject" | "object"): boolean;
+}
+/**
+ * Wrapper around raw relation definitions from the Schema
+ */
+export declare class RelationDefinitionSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
+R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>, // List of all relation defintions
+RDef extends R[number] = R[number]> {
+    private schema;
+    private relDef;
+    constructor(schema: Schema<E, R>, relDef: RDef);
+    /**
+     * The type of the relation. This can also be referred to as the relation's name.
+     */
+    get type(): RDef["type"];
+    /**
+     * A short description which can be used as documentation for the relation.
+     */
+    get description(): RDef["description"];
+    /**
+     * True if the object of the relation is a primitive type.
+     * In this case the relation iscalled an "attribute"
+     */
+    get final(): RDef["final"];
+    /**
+     * The list of constraints if any. Only attributes (relations with final = true) have constraints.
+     * In other cases this returns null.
+     */
+    get constraints(): RDef["constraints"];
+    /**
+     * The default value for this relation.
+     * It can be used when creating new relations if user did not enter a value (even if required).
+     */
+    get default(): RDef extends {
+        default: infer V;
+    } ? V : undefined;
+    get cardinality(): RDef["cardinality"];
+    get subjectCardinality(): Cardinality;
+    get objectCardinality(): Cardinality;
+    /**
+     * Gets the entity associated to this relation's subject
+     *
+     * @throws InconsistentSchemaError if the relation's subject is not a valid entity
+     */
+    get subject(): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> : EntitySchema<E, R, EntityRawSchemaByType<E, RDef["subject"]>>;
+    /**
+     * Gets the entity associated to this relation's object
+     *
+     * @throws InconsistentSchemaError if the relation's object is not a valid entity
+     */
+    get object(): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> : EntitySchema<E, R, EntityRawSchemaByType<E, RDef["object"]>>;
+}
+export declare type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<RelationDefinitionRawSchema<E>>;
+export declare type MatchedRelationDefinition<E extends EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<EntityRawSchemaArray>, M extends RelationDefinitionMatcher<E>> = R[number] extends infer RDef ? (RDef extends M ? RDef : never) : never;
+export {};
+//# sourceMappingURL=Schema.d.ts.map

package/lib/schema/Schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/schema/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAEjC,OAAO,EACL,SAAS,EACT,2BAA2B,EAC3B,gCAAgC,EAChC,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACtB,MAAM,cAAc,CAAC;AAEtB,QAAA,MAAM,YAAY,EAAE,OAAO,MAA2C,CAAC;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,4PAU1B,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAM,CACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC;IAEnF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEpB,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAItC,IAAI,QAAQ,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAI9C;IAED,IAAI,oBAAoB,IAAI,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAItE;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,SAAS,MAAM,EAC5B,UAAU,EAAE,KAAK,GAChB,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GAC5B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,GACpC,qBAAqB,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,IAAI,GAC5C,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GACnD,IAAI;IAoBR;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,EAC7D,OAAO,EAAE,CAAC,GACT,wBAAwB,CACzB,CAAC,EACD,CAAC,EACD,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAChE,EAAE;CAmBJ;AAED;;GAEG;AACH,qBAAa,YAAY,CACvB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAAE,kCAAkC;AACvH,UAAU,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAGtC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,eAAe;gBADf,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,eAAe,EAAE,UAAU;IAGrC;;OAEG;IACH,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC,CAE7B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,UAAU,CAAC,aAAa,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,UAAU,CAAC,OAAO,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,0BAA0B,IAAI,wBAAwB,CACxD,CAAC,EACD,CAAC,EACD,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CACjE,EAAE,CAKF;IAED;;OAEG;IACH,IAAI,0BAA0B,IAAI,wBAAwB,CACxD,CAAC,EACD,CAAC,EACD,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE;QAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAChE,EAAE,CAKF;IAED;;;;;;OAMG;IACH,4BAA4B,CAC1B,YAAY,SAAS,yBAAyB,CAC5C,CAAC,EACD,CAAC,EACD;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CAChC,CAAC,MAAM,CAAC,EAET,YAAY,EAAE,YAAY,GACzB,wBAAwB,CACzB,CAAC,EACD,CAAC,EACD,yBAAyB,CACvB,CAAC,EACD,CAAC,EACD;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAE,CACpD,CACF;IAWD;;;;;;OAMG;IACH,2BAA2B,CACzB,YAAY,SAAS,yBAAyB,CAC5C,CAAC,EACD,CAAC,EACD;QAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CAC/B,CAAC,MAAM,CAAC,EAET,YAAY,EAAE,YAAY,GACzB,wBAAwB,CACzB,CAAC,EACD,CAAC,EACD,yBAAyB,CACvB,CAAC,EACD,CAAC,EACD;QAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAE,CACnD,CACF;IAWD;;OAEG;IACH,IAAI,UAAU,IAAI,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAK5D;IAED;;;;;;OAMG;IACH,kBAAkB,CAChB,YAAY,SAAS,yBAAyB,CAC5C,CAAC,EACD,CAAC,EACD;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,GAAG;QAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CACjE,CAAC,MAAM,CAAC,EACT,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO;CAYnE;AAED;;GAEG;AACH,qBAAa,wBAAwB,CACnC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAAE,kCAAkC;AACvH,IAAI,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAEtB,OAAO,CAAC,MAAM;IAAgB,OAAO,CAAC,MAAM;gBAApC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAU,MAAM,EAAE,IAAI;IAE9D;;OAEG;IACH,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAEvB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,CAEzB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,IAAI,SAAS;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,CAAC,GAAG,SAAS,CAM/D;IAED,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED,IAAI,kBAAkB,IAAI,WAAW,CAEpC;IAED,IAAI,iBAAiB,IAAI,WAAW,CAEnC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GACxC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAC7B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAUhE;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GACvC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAC7B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAU/D;CACF;AAYD,oBAAY,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF,oBAAY,yBAAyB,CACnC,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,gCAAgC,CAAC,oBAAoB,CAAC,EAChE,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,IACpC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC"}

package/lib/schema/Schema.js

@@ -0,0 +1,269 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationDefinitionSchema = exports.EntitySchema = exports.Schema = exports.getLooseSchema = void 0;
+const Errors_1 = require("../Errors");
+const rawSchemaKey = Symbol("Indexer of the rawSchema");
+/**
+ * Returns the given schema using loose typing.
+ * Can be useful when working for generic schemas
+ *
+ * @param schema The schema to create a loose type for
+ * @returns
+ */
+const getLooseSchema = (schema) => {
+    return schema;
+};
+exports.getLooseSchema = getLooseSchema;
+/**
+ * Wrapper around the raw JSON Schema
+ */
+class Schema {
+    constructor(rawSchema) {
+        this[rawSchemaKey] = rawSchema;
+    }
+    get entities() {
+        return this[rawSchemaKey].entities.map((eSchema) => new EntitySchema(this, eSchema));
+    }
+    get relationsDefinitions() {
+        return this[rawSchemaKey].relations_definitions.map((rdefSchema) => new RelationDefinitionSchema(this, rdefSchema));
+    }
+    /**
+     * Returns the entity schema for the given entity type if it exists.
+     * When using TypeScript, this method can detect if the given type does not exist
+     * in the schema.
+     *
+     * @param entityType The entity type string
+     * @returns A new EntitySchema or null if the type does not exist
+     */
+    getEntity(entityType) {
+        const entityRawSchema = this[rawSchemaKey].entities.filter((eSchema) => eSchema.type === entityType)[0];
+        if (!entityRawSchema) {
+            // Is only null when the given type is not in the schema.
+            // Thus the return type will be (EntitySchema | null)
+            // but TypeScript does not understand this
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            return null;
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return new EntitySchema(this, entityRawSchema);
+    }
+    /**
+     * Finds relations in the Schema matching the partial relation given
+     *
+     * @param matcher Partial relation definition to match against
+     * @returns Matched relation schema classes
+     */
+    matchRelationDefinitions(matcher) {
+        const matchArray = this[rawSchemaKey].relations_definitions.filter((relDef) => {
+            for (const key of Object.keys(matcher)) {
+                if (matcher[key] !== relDef[key]) {
+                    return false;
+                }
+            }
+            return true;
+        });
+        return matchArray.map((m) => new RelationDefinitionSchema(this, m));
+    }
+}
+exports.Schema = Schema;
+/**
+ * Wrapper around raw entities from the Schema
+ */
+class EntitySchema {
+    constructor(schema, entityRawSchema) {
+        this.schema = schema;
+        this.entityRawSchema = entityRawSchema;
+    }
+    /**
+     * The type of the entity. This can also be referred to as the entity' name.
+     */
+    get type() {
+        return this.entityRawSchema.type;
+    }
+    /**
+     * A short description which can be used as documentation for the entity.
+     */
+    get description() {
+        return this.entityRawSchema.description;
+    }
+    /**
+     * True if the current entity is a primitive type such as string or int
+     */
+    get final() {
+        return this.entityRawSchema.final;
+    }
+    /**
+     * Gets the list of relation definitions with this entity as subject
+     */
+    get subjectRelationDefinitions() {
+        return this.schema.matchRelationDefinitions({
+            subject: this.type,
+            final: false,
+        });
+    }
+    /**
+     * Gets the list of relation definitions with this entity as object
+     */
+    get objectRelationsDefinitions() {
+        return this.schema.matchRelationDefinitions({
+            object: this.type,
+            final: false,
+        });
+    }
+    /**
+     * Finds the first relation of the given type with this entity as subject
+     *
+     * @param relationType The relation type to find
+     * @throws RelationNotFoundError if the current entity is not a subject of the given relation
+     * @returns The found relation
+     */
+    getSubjectRelationDefinition(relationType) {
+        const resultArray = this.schema.matchRelationDefinitions({
+            subject: this.type,
+            type: relationType,
+        });
+        if (resultArray.length > 0) {
+            return resultArray[0];
+        }
+        throw new Errors_1.RelationNotFoundError(relationType, "subject", this.type);
+    }
+    /**
+     * Finds the first relation of the given type with this entity as object
+     *
+     * @param relationType The relation type to find
+     * @throws RelationNotFoundError if the current entity is not an object of the given relation
+     * @returns The found relation
+     */
+    getObjectRelationDefinition(relationType) {
+        const resultArray = this.schema.matchRelationDefinitions({
+            object: this.type,
+            type: relationType,
+        });
+        if (resultArray.length > 0) {
+            return resultArray[0];
+        }
+        throw new Errors_1.RelationNotFoundError(relationType, "object", this.type);
+    }
+    /**
+     * Gets the list of attributes names for this entity
+     */
+    get attributes() {
+        return this.schema.matchRelationDefinitions({
+            final: true,
+            subject: this.type,
+        });
+    }
+    /**
+     * Checks whether the current entity is required for the given relation and role
+     *
+     * @param relationType The relation to check
+     * @param role The role for this entity in the given relation
+     * @returns True if this entity is required in the relation for the given role
+     */
+    isRelationRequired(relationType, role) {
+        let relation;
+        let cardinality;
+        if (role === "subject") {
+            relation = this.getSubjectRelationDefinition(relationType);
+            cardinality = relation.cardinality[0];
+        }
+        else {
+            relation = this.getObjectRelationDefinition(relationType);
+            cardinality = relation.cardinality[1];
+        }
+        return cardinalityRequired(cardinality);
+    }
+}
+exports.EntitySchema = EntitySchema;
+/**
+ * Wrapper around raw relation definitions from the Schema
+ */
+class RelationDefinitionSchema {
+    constructor(schema, relDef) {
+        this.schema = schema;
+        this.relDef = relDef;
+    }
+    /**
+     * The type of the relation. This can also be referred to as the relation's name.
+     */
+    get type() {
+        return this.relDef.type;
+    }
+    /**
+     * A short description which can be used as documentation for the relation.
+     */
+    get description() {
+        return this.relDef.description;
+    }
+    /**
+     * True if the object of the relation is a primitive type.
+     * In this case the relation iscalled an "attribute"
+     */
+    get final() {
+        return this.relDef.final;
+    }
+    /**
+     * The list of constraints if any. Only attributes (relations with final = true) have constraints.
+     * In other cases this returns null.
+     */
+    get constraints() {
+        return this.relDef.constraints;
+    }
+    /**
+     * The default value for this relation.
+     * It can be used when creating new relations if user did not enter a value (even if required).
+     */
+    get default() {
+        return ("default" in this.relDef ? this.relDef.default : undefined);
+    }
+    get cardinality() {
+        return this.relDef.cardinality;
+    }
+    get subjectCardinality() {
+        return this.relDef.cardinality[0];
+    }
+    get objectCardinality() {
+        return this.relDef.cardinality[1];
+    }
+    /**
+     * Gets the entity associated to this relation's subject
+     *
+     * @throws InconsistentSchemaError if the relation's subject is not a valid entity
+     */
+    get subject() {
+        const subjectSchema = this.schema.getEntity(this.relDef.subject);
+        if (subjectSchema === null) {
+            throw new Errors_1.InconsistentSchemaError(`entity type ${this.relDef.subject} used as subject of relation ${this.type} is not declared`);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return subjectSchema;
+    }
+    /**
+     * Gets the entity associated to this relation's object
+     *
+     * @throws InconsistentSchemaError if the relation's object is not a valid entity
+     */
+    get object() {
+        const objectSchema = this.schema.getEntity(this.relDef.object);
+        if (objectSchema === null) {
+            throw new Errors_1.InconsistentSchemaError(`entity type ${this.relDef.object} used as object of relation ${this.type} is not declared`);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return objectSchema;
+    }
+}
+exports.RelationDefinitionSchema = RelationDefinitionSchema;
+/**
+ * Checks if the given cardinality requires at least one entity to be present
+ *
+ * @param cardinality The cardinality to check
+ * @returns
+ */
+function cardinalityRequired(cardinality) {
+    return cardinality === "1" || cardinality === "+";
+}
+//# sourceMappingURL=Schema.js.map

package/lib/schema/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/schema/Schema.ts"],"names":[],"mappings":";;;AACA,sCAA2E;AAW3E,MAAM,YAAY,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAEvE;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAGN,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF;;GAEG;AACH,MAAa,MAAM;IAMjB,YAAY,SAA0B;QACpC,IAAI,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CACpC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAC7C,CAAC;IACJ,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,GAAG,CACjD,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,wBAAwB,CAAC,IAAI,EAAE,UAAU,CAAC,CAC/D,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,UAAiB;QAMjB,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CACxD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CACzC,CAAC,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,eAAe,EAAE;YACpB,yDAAyD;YACzD,qDAAqD;YACrD,0CAA0C;YAC1C,6DAA6D;YAC7D,aAAa;YACb,OAAO,IAAI,CAAC;SACb;QACD,6DAA6D;QAC7D,aAAa;QACb,OAAO,IAAI,YAAY,CACrB,IAAI,EACJ,eAAkD,CACnD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,OAAU;QAMV,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,MAAM,CAChE,CAAC,MAAM,EAAE,EAAE;YACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAC3B,OAAO,CACoC,EAAE;gBAC7C,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE;oBAChC,OAAO,KAAK,CAAC;iBACd;aACF;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAKA,CAAC;QACJ,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAvFD,wBAuFC;AAED;;GAEG;AACH,MAAa,YAAY;IAKvB,YACU,MAAoB,EACpB,eAA2B;QAD3B,WAAM,GAAN,MAAM,CAAc;QACpB,oBAAe,GAAf,eAAe,CAAY;IAClC,CAAC;IAEJ;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI,0BAA0B;QAK5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,0BAA0B;QAK5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B,CAO1B,YAA0B;QAU1B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YACvD,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB;QACD,MAAM,IAAI,8BAAqB,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,2BAA2B,CAOzB,YAA0B;QAU1B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YACvD,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB;QACD,MAAM,IAAI,8BAAqB,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAMhB,YAA0B,EAAE,IAA0B;QACtD,IAAI,QAAQ,CAAC;QACb,IAAI,WAAwB,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,QAAQ,GAAG,IAAI,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;YAC3D,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvC;aAAM;YACL,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;YAC1D,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvC;QACD,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;CACF;AAlKD,oCAkKC;AAED;;GAEG;AACH,MAAa,wBAAwB;IAKnC,YAAoB,MAAoB,EAAU,MAAY;QAA1C,WAAM,GAAN,MAAM,CAAc;QAAU,WAAM,GAAN,MAAM,CAAM;IAAG,CAAC;IAElE;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QAGT,OAAO,CACL,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAChD,CAAC;IACf,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QAGT,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjE,IAAI,aAAa,KAAK,IAAI,EAAE;YAC1B,MAAM,IAAI,gCAAuB,CAC/B,eAAe,IAAI,CAAC,MAAM,CAAC,OAAO,gCAAgC,IAAI,CAAC,IAAI,kBAAkB,CAC9F,CAAC;SACH;QACD,6DAA6D;QAC7D,aAAa;QACb,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QAGR,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/D,IAAI,YAAY,KAAK,IAAI,EAAE;YACzB,MAAM,IAAI,gCAAuB,CAC/B,eAAe,IAAI,CAAC,MAAM,CAAC,MAAM,+BAA+B,IAAI,CAAC,IAAI,kBAAkB,CAC5F,CAAC;SACH;QACD,6DAA6D;QAC7D,aAAa;QACb,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAlGD,4DAkGC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,WAAwB;IACnD,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC"}

package/lib/schema/SchemaJSON.d.ts

@@ -0,0 +1,121 @@
+declare type ConstraintBase<T extends string, V extends Record<string, unknown> | null> = {
+    type: T;
+    value: V;
+};
+export declare type ConstraintOperator = ">" | ">=" | "<" | "<=";
+declare type ConstraintMessage = string | null;
+export declare type UniqueConstraint = ConstraintBase<"UniqueConstraint", null>;
+export declare type SizeConstraint = ConstraintBase<"SizeConstraint", {
+    min: number | null;
+    max: number | null;
+    msg: ConstraintMessage;
+}>;
+export declare type RegexpConstraint = ConstraintBase<"RegexpConstraint", {
+    regexp: string;
+    flags: number;
+    msg: ConstraintMessage;
+}>;
+export declare type BoundaryConstraint = ConstraintBase<"BoundaryConstraint", {
+    boundary: number | null;
+    op: ConstraintOperator;
+    msg: ConstraintMessage;
+}>;
+export declare type IntervalBoundConstraint = ConstraintBase<"IntervalBoundConstraint", {
+    minvalue: number | null;
+    maxvalue: number | null;
+    msg: ConstraintMessage;
+}>;
+export declare type StaticVocabularyConstraint = ConstraintBase<"StaticVocabularyConstraint", {
+    values: string[];
+    msg: ConstraintMessage;
+}>;
+export declare type FormatConstraint = ConstraintBase<"FormatConstraint", {
+    values: ["text/rest", "text/markdown", "text/html", "text/plain"];
+    msg: ConstraintMessage;
+}>;
+export declare type Constraint = Readonly<UniqueConstraint | SizeConstraint | RegexpConstraint | BoundaryConstraint | IntervalBoundConstraint | StaticVocabularyConstraint | FormatConstraint>;
+declare type BuildObjBase<T extends string> = {
+    object: T;
+    final: true;
+    required?: boolean;
+};
+interface StringBuildObj extends BuildObjBase<"String"> {
+    default: string | null;
+}
+interface PasswordBuildObj extends BuildObjBase<"Password"> {
+    default: string | null;
+}
+interface BytesBuildObj extends BuildObjBase<"Bytes"> {
+    default: string | null;
+}
+interface IntBuildObj extends BuildObjBase<"Int"> {
+    default: number | null;
+}
+interface BigIntBuildObj extends BuildObjBase<"BigInt"> {
+    default: number | null;
+}
+interface FloatBuildObj extends BuildObjBase<"Float"> {
+    default: number | null;
+}
+interface BooleanBuildObj extends BuildObjBase<"Boolean"> {
+    default: boolean | null;
+}
+interface DecimalBuildObj extends BuildObjBase<"Decimal"> {
+    default: number | null;
+}
+interface DateBuildObj extends BuildObjBase<"Date"> {
+    default: unknown;
+}
+interface TimeBuildObj extends BuildObjBase<"Time"> {
+    default: unknown;
+}
+interface DatetimeBuildObj extends BuildObjBase<"Datetime"> {
+    default: Date | "NOW" | "TODAY" | null;
+}
+interface TZTimeBuildObj extends BuildObjBase<"TZTime"> {
+    default: unknown;
+}
+interface TZDatetimeBuildObj extends BuildObjBase<"TZDatetime"> {
+    default: unknown;
+}
+interface IntervalBuildObj extends BuildObjBase<"Interval"> {
+    default: unknown;
+}
+export declare type BuildObj = Readonly<StringBuildObj | PasswordBuildObj | BytesBuildObj | IntBuildObj | BigIntBuildObj | FloatBuildObj | BooleanBuildObj | DecimalBuildObj | DateBuildObj | TimeBuildObj | DatetimeBuildObj | TZTimeBuildObj | TZDatetimeBuildObj | IntervalBuildObj>;
+export declare type Cardinality = "*" | "1" | "?" | "+";
+export declare type CardinalityPair = `${Cardinality}${Cardinality}`;
+export declare type EntityRawSchema = {
+    type: string;
+    final: boolean;
+    description: string;
+};
+export declare type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
+export declare type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, Final extends boolean = boolean> = Readonly<{
+    type: string;
+    description: string;
+    cardinality: CardinalityPair;
+    subject: ESchemas[number]["type"];
+} & (Final extends true ? BuildObj & {
+    constraints: Constraint[];
+} : {
+    object: EntityRawSchema["type"];
+    final: false;
+    constraints: null;
+})>;
+export declare type RelationDefinitionRawSchemaArray<ESchemas extends EntityRawSchemaArray> = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
+export declare type RawSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> = {
+    entities: E;
+    relations_definitions: R;
+};
+export declare type IsLooseSchema<E extends EntityRawSchemaArray> = string extends E[number]["type"] ? true : false;
+export declare type IsETypeInStrictSchema<E extends EntityRawSchemaArray, EType extends string> = EType extends E[number]["type"] ? true : false;
+/**
+ * Type representing the entity's raw schema matching this type.
+ * This type only works for EntityRawSchemaArray with literals as "type" property.
+ *
+ **/
+export declare type EntityRawSchemaByType<E extends EntityRawSchemaArray, T extends string> = E[number] extends infer ESchema ? ESchema extends {
+    type: T;
+} ? ESchema : never : never;
+export {};
+//# sourceMappingURL=SchemaJSON.d.ts.map

package/lib/schema/SchemaJSON.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJSON.d.ts","sourceRoot":"","sources":["../../src/schema/SchemaJSON.ts"],"names":[],"mappings":"AAAA,aAAK,cAAc,CACjB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,IACtC;IACF,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,oBAAY,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AACzD,aAAK,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC;AAEvC,oBAAY,gBAAgB,GAAG,cAAc,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;AAExE,oBAAY,cAAc,GAAG,cAAc,CACzC,gBAAgB,EAChB;IAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CACnE,CAAC;AAEF,oBAAY,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC1D,CAAC;AAEF,oBAAY,kBAAkB,GAAG,cAAc,CAC7C,oBAAoB,EACpB;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,EAAE,EAAE,kBAAkB,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC5E,CAAC;AACF,oBAAY,uBAAuB,GAAG,cAAc,CAClD,yBAAyB,EACzB;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC7E,CAAC;AAEF,oBAAY,0BAA0B,GAAG,cAAc,CACrD,4BAA4B,EAC5B;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC7C,CAAC;AAEF,oBAAY,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IACE,MAAM,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAClE,GAAG,EAAE,iBAAiB,CAAC;CACxB,CACF,CAAC;AAEF,oBAAY,UAAU,GAAG,QAAQ,CAC7B,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,gBAAgB,CACnB,CAAC;AAEF,aAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI;IACpC,MAAM,EAAE,CAAC,CAAC;IACV,KAAK,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,aAAc,SAAQ,YAAY,CAAC,OAAO,CAAC;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,WAAY,SAAQ,YAAY,CAAC,KAAK,CAAC;IAC/C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,aAAc,SAAQ,YAAY,CAAC,OAAO,CAAC;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,eAAgB,SAAQ,YAAY,CAAC,SAAS,CAAC;IACvD,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,eAAgB,SAAQ,YAAY,CAAC,SAAS,CAAC;IACvD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,UAAU,YAAa,SAAQ,YAAY,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,YAAa,SAAQ,YAAY,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CACxC;AAED,UAAU,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,kBAAmB,SAAQ,YAAY,CAAC,YAAY,CAAC;IAC7D,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IACzD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,oBAAY,QAAQ,GAAG,QAAQ,CAC3B,cAAc,GACd,gBAAgB,GAChB,aAAa,GACb,WAAW,GACX,cAAc,GACd,aAAa,GACb,eAAe,GACf,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,CACnB,CAAC;AAEF,oBAAY,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD,oBAAY,eAAe,GAAG,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAE7D,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAY,oBAAoB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAElE,oBAAY,2BAA2B,CACrC,QAAQ,SAAS,oBAAoB,EACrC,KAAK,SAAS,OAAO,GAAG,OAAO,IAC7B,QAAQ,CACV;IACE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,eAAe,CAAC;IAC7B,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;CACnC,GAAG,CAAC,KAAK,SAAS,IAAI,GACnB,QAAQ,GAAG;IACT,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,GACD;IAAE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,IAAI,CAAA;CAAE,CAAC,CAC1E,CAAC;AAEF,oBAAY,gCAAgC,CAC1C,QAAQ,SAAS,oBAAoB,IACnC,aAAa,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AAElE,oBAAY,SAAS,CACnB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,IACjF;IACF,QAAQ,EAAE,CAAC,CAAC;IACZ,qBAAqB,EAAE,CAAC,CAAC;CAC1B,CAAC;AAEF,oBAAY,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD,oBAAY,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,EAC9B,KAAK,SAAS,MAAM,IAClB,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEnD;;;;IAII;AACJ,oBAAY,qBAAqB,CAC/B,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,MAAM,IACd,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,OAAO,GAC/B,OAAO,SAAS;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GACzB,OAAO,GACP,KAAK,GACP,KAAK,CAAC"}

package/lib/schema/SchemaJSON.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SchemaJSON.js.map

package/lib/schema/SchemaJSON.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJSON.js","sourceRoot":"","sources":["../../src/schema/SchemaJSON.ts"],"names":[],"mappings":""}

package/package.json

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