@cubicweb/client 2.1.1 → 3.0.0-alpha.11

package/lib/schema/classes/EntitySchema.js

@@ -1,12 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntitySchema = void 0;
 /**
  * Wrapper around raw entity schemas from the Schema.
  * You should never have to create this object yourself.
  * Instead, retrieve these objects from the methods in the `Schema` class.
+ *
+ * @category Schema
  */
-class EntitySchema {
+export class EntitySchema {
+    schema;
+    entityRawSchema;
     /**
      * Wrapper around raw entity schemas from the Schema.
      * You should never have to create this object yourself.
@@ -38,26 +39,26 @@ class EntitySchema {
         return this.entityRawSchema.final;
     }
     /**
-     * Gets the list of relation definitions schemas with this entity as subject.
-     * In case a relation definition schema has this entity as both object and subject,
-     * there will be dupicates when used along with `objectRelationsDefinitions`.
+     * Gets the list of attribute schemas (relation definition schemas with final at false)
+     * for this entity schema.
      */
-    get subjectRelationDefinitions() {
+    get attributes() {
         return this.schema.matchRelationDefinitions({
+            final: true,
             subject: this.type,
-            final: false,
         });
     }
-    /**
-     * Gets the list of relation definitions schemas with this entity as object.
-     * In case a relation definition schema has this entity as both object and subject,
-     * there will be dupicates when used along with `subjectRelationDefinitions`.
-     */
-    get objectRelationsDefinitions() {
-        return this.schema.matchRelationDefinitions({
-            object: this.type,
-            final: false,
-        });
+    get relationDefinitions() {
+        return {
+            subject: this.schema.matchRelationDefinitions({
+                subject: this.type,
+                final: false,
+            }),
+            object: this.schema.matchRelationDefinitions({
+                object: this.type,
+                final: false,
+            }),
+        };
     }
     /**
      * Finds relations in the Schema matching the partial relation given.
@@ -68,16 +69,5 @@ class EntitySchema {
     matchRelationDefinitions(matcher) {
         return this.schema.matchRelationDefinitions(matcher);
     }
-    /**
-     * Gets the list of attribute schemas (relation definition schemas with final at false)
-     * for this entity schema.
-     */
-    get attributes() {
-        return this.schema.matchRelationDefinitions({
-            final: true,
-            subject: this.type,
-        });
-    }
 }
-exports.EntitySchema = EntitySchema;
 //# sourceMappingURL=EntitySchema.js.map

package/lib/schema/classes/EntitySchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntitySchema.js","sourceRoot":"","sources":["../../../src/schema/classes/EntitySchema.ts"],"names":[],"mappings":";;;AAMA;;;;GAIG;AACH,MAAa,YAAY;IAKvB;;;;;;;OAOG;IACH,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;;;;OAIG;IACH,IAAI,0BAA0B;QAS5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,IAAI,0BAA0B;QAS5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,OAAU;QAMV,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QASZ,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;CACF;AAjHD,oCAiHC"}
+{"version":3,"file":"EntitySchema.js","sourceRoot":"","sources":["../../../src/schema/classes/EntitySchema.ts"],"names":[],"mappings":"AASA;;;;;;GAMG;AACH,MAAM,OAAO,YAAY;IAcb;IACA;IAVV;;;;;;;OAOG;IACH,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;;;OAGG;IACH,IAAI,UAAU;QASZ,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,mBAAmB;QAoBrB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;gBAC5C,OAAO,EAAE,IAAI,CAAC,IAAI;gBAClB,KAAK,EAAE,KAAK;aACb,CAAC;YACF,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;gBAC3C,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,KAAK,EAAE,KAAK;aACb,CAAC;SACH,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,OAAU;QAMV,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;CACF"}

package/lib/schema/classes/RelationDefinitionSchema.d.ts

@@ -1,12 +1,15 @@
-import { EntityRawSchemaArray } from "../raw/Entities";
-import { RelationDefinitionRawSchemaArray, Cardinality } from "../raw/RelationDefinitions";
-import { IsLooseSchema, EntityRawSchemaByType } from "../raw/Utils";
-import { EntitySchema } from "./EntitySchema";
-import { Schema } from "./Schema";
+import { EntityRawSchemaArray } from "../raw/Entities.js";
+import { RelationDefinitionRawSchemaArray, Cardinality } from "../raw/RelationDefinitions.js";
+import { IsLooseSchema, EntityRawSchemaByType } from "../raw/Utils.js";
+import { EntitySchema } from "./EntitySchema.js";
+import { Schema } from "./Schema.js";
+import { EntityRole } from "./Utils.js";
 /**
  * Wrapper around raw relation definition schemas from the Schema.
  * You should never have to create this object yourself.
  * Instead, retrieve these objects from the methods in the `Schema` class.
+ *
+ * @category Schema
  */
 export declare class RelationDefinitionSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>, RDef extends R[number] = R[number]> {
     private schema;
@@ -55,15 +58,10 @@ export declare class RelationDefinitionSchema<E extends EntityRawSchemaArray = E
     /**
      * The cardinality of this relation definition schema.
      */
-    get cardinality(): RDef["cardinality"];
-    /**
-     * The cardinality of this relation definition schema's subject.
-     */
-    get subjectCardinality(): Cardinality;
-    /**
-     * The cardinality of this relation definition schema's object.
-     */
-    get objectCardinality(): Cardinality;
+    get cardinality(): {
+        subject: Cardinality;
+        object: Cardinality;
+    };
     /**
      * Gets the entity associated to this relation definition schema's subject.
      *
@@ -82,6 +80,6 @@ export declare class RelationDefinitionSchema<E extends EntityRawSchemaArray = E
      * @param role The point of view to use
      * @returns
      */
-    isRequired(role: "subject" | "object"): boolean;
+    isRequired(role: EntityRole): boolean;
 }
 //# sourceMappingURL=RelationDefinitionSchema.d.ts.map

package/lib/schema/classes/RelationDefinitionSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelationDefinitionSchema.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/RelationDefinitionSchema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,gCAAgC,EAChC,WAAW,EACZ,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC;;;;GAIG;AACH,qBAAa,wBAAwB,CACnC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EACnF,IAAI,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAUtB,OAAO,CAAC,MAAM;IAAgB,OAAO,CAAC,MAAM;IARxD;;;;;;;OAOG;gBACiB,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;;;;OAIG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAE7B;IAED;;;;OAIG;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;;OAEG;IACH,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED;;OAEG;IACH,IAAI,kBAAkB,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,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,CAShE;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,CAS/D;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,QAAQ;CAStC"}
+{"version":3,"file":"RelationDefinitionSchema.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/RelationDefinitionSchema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EACL,gCAAgC,EAChC,WAAW,EACZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAyB,MAAM,YAAY,CAAC;AAE/D;;;;;;GAMG;AACH,qBAAa,wBAAwB,CACnC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EACnF,IAAI,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAUtB,OAAO,CAAC,MAAM;IAAgB,OAAO,CAAC,MAAM;IARxD;;;;;;;OAOG;gBACiB,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;;;;OAIG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAE7B;IAED;;;;OAIG;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;;OAEG;IACH,IAAI,WAAW,IAAI;QAAE,OAAO,EAAE,WAAW,CAAC;QAAC,MAAM,EAAE,WAAW,CAAA;KAAE,CAK/D;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,CAShE;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,CAS/D;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,UAAU;CAG5B"}

package/lib/schema/classes/RelationDefinitionSchema.js

@@ -1,14 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelationDefinitionSchema = void 0;
-const Errors_1 = require("../../Errors");
-const Utils_1 = require("./Utils");
+import { InconsistentSchemaError } from "../../Errors.js";
+import { isCardinalityRequired } from "./Utils.js";
 /**
  * Wrapper around raw relation definition schemas from the Schema.
  * You should never have to create this object yourself.
  * Instead, retrieve these objects from the methods in the `Schema` class.
+ *
+ * @category Schema
  */
-class RelationDefinitionSchema {
+export class RelationDefinitionSchema {
+    schema;
+    relDef;
     /**
      * Wrapper around raw relation definition schemas from the Schema.
      * You should never have to create this object yourself.
@@ -67,19 +68,10 @@ class RelationDefinitionSchema {
      * The cardinality of this relation definition schema.
      */
     get cardinality() {
-        return this.relDef.cardinality;
-    }
-    /**
-     * The cardinality of this relation definition schema's subject.
-     */
-    get subjectCardinality() {
-        return this.relDef.cardinality[0];
-    }
-    /**
-     * The cardinality of this relation definition schema's object.
-     */
-    get objectCardinality() {
-        return this.relDef.cardinality[1];
+        return {
+            subject: this.relDef.cardinality[0],
+            object: this.relDef.cardinality[1],
+        };
     }
     /**
      * Gets the entity associated to this relation definition schema's subject.
@@ -89,7 +81,7 @@ class RelationDefinitionSchema {
     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`);
+            throw new InconsistentSchemaError(`entity type ${this.relDef.subject} used as subject of relation ${this.type} is not declared`);
         }
         // @ts-ignore: Cannot be null as we checked for this above
         return subjectSchema;
@@ -102,7 +94,7 @@ class RelationDefinitionSchema {
     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`);
+            throw new InconsistentSchemaError(`entity type ${this.relDef.object} used as object of relation ${this.type} is not declared`);
         }
         // @ts-ignore: Cannot be null as we checked for this above
         return objectSchema;
@@ -114,15 +106,7 @@ class RelationDefinitionSchema {
      * @returns
      */
     isRequired(role) {
-        let cardinality;
-        if (role === "subject") {
-            cardinality = this.subjectCardinality;
-        }
-        else {
-            cardinality = this.objectCardinality;
-        }
-        return (0, Utils_1.cardinalityRequired)(cardinality);
+        return isCardinalityRequired(this.cardinality[role]);
     }
 }
-exports.RelationDefinitionSchema = RelationDefinitionSchema;
 //# sourceMappingURL=RelationDefinitionSchema.js.map

package/lib/schema/classes/RelationDefinitionSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationDefinitionSchema.js","sourceRoot":"","sources":["../../../src/schema/classes/RelationDefinitionSchema.ts"],"names":[],"mappings":";;;AAAA,yCAAuD;AASvD,mCAA8C;AAE9C;;;;GAIG;AACH,MAAa,wBAAwB;IAKnC;;;;;;;OAOG;IACH,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;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;;OAIG;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;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,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,0DAA0D;QAC1D,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,0DAA0D;QAC1D,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAA0B;QACnC,IAAI,WAAwB,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC;SACvC;aAAM;YACL,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC;SACtC;QACD,OAAO,IAAA,2BAAmB,EAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;CACF;AA3ID,4DA2IC"}
+{"version":3,"file":"RelationDefinitionSchema.js","sourceRoot":"","sources":["../../../src/schema/classes/RelationDefinitionSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAS1D,OAAO,EAAc,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,OAAO,wBAAwB;IAaf;IAA8B;IARlD;;;;;;;OAOG;IACH,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;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;;OAIG;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;;OAEG;IACH,IAAI,WAAW;QACb,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB;YAClD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB;SAClD,CAAC;IACJ,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,uBAAuB,CAC/B,eAAe,IAAI,CAAC,MAAM,CAAC,OAAO,gCAAgC,IAAI,CAAC,IAAI,kBAAkB,CAC9F,CAAC;SACH;QACD,0DAA0D;QAC1D,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,uBAAuB,CAC/B,eAAe,IAAI,CAAC,MAAM,CAAC,MAAM,+BAA+B,IAAI,CAAC,IAAI,kBAAkB,CAC5F,CAAC;SACH;QACD,0DAA0D;QAC1D,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAgB;QACzB,OAAO,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}

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

@@ -1,15 +1,17 @@
-import { EntityRawSchemaArray } from "../raw/Entities";
-import { RelationDefinitionRawSchemaArray } from "../raw/RelationDefinitions";
-import { RawSchema } from "../raw/Schema";
-import { EntityRawSchemaByType, IsETypeInStrictSchema, IsLooseSchema } from "../raw/Utils";
-import { EntitySchema } from "./EntitySchema";
-import { RelationDefinitionSchema } from "./RelationDefinitionSchema";
-import { RelationDefinitionMatcher, MatchedRelationDefinition } from "./Utils";
+import { EntityRawSchemaArray } from "../raw/Entities.js";
+import { RelationDefinitionRawSchemaArray } from "../raw/RelationDefinitions.js";
+import { RawSchema } from "../raw/Schema.js";
+import { EntityRawSchemaByType, IsETypeInStrictSchema, IsLooseSchema } from "../raw/Utils.js";
+import { EntitySchema } from "./EntitySchema.js";
+import { RelationDefinitionSchema } from "./RelationDefinitionSchema.js";
+import { RelationDefinitionMatcher, MatchedRelationDefinition } from "./Utils.js";
 declare const rawSchemaKey: unique symbol;
 /**
  * Wrapper around the raw JSON Schema.
  * It is recommended to use this class instead of the raw JSON Schema
  * as it is more robust to schema changes and provides utility functions.
+ *
+ * @category Schema
  */
 export declare class Schema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> {
     [rawSchemaKey]: RawSchema<E, R>;

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

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAEL,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAE/E,QAAA,MAAM,YAAY,EAAE,OAAO,MAA2C,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,MAAM,CACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC;IAEnF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEhC;;;;;;OAMG;gBACS,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAItC;;OAEG;IACH,IAAI,QAAQ,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAI9C;IAED;;;OAGG;IACH,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;IAiBR;;;;;;OAMG;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"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAEL,gCAAgC,EACjC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAEpB,QAAA,MAAM,YAAY,EAAE,OAAO,MAA2C,CAAC;AAEvE;;;;;;GAMG;AACH,qBAAa,MAAM,CACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EACrD,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC;IAEnF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEhC;;;;;;OAMG;gBACS,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAItC;;OAEG;IACH,IAAI,QAAQ,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAI9C;IAED;;;OAGG;IACH,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;IAiBR;;;;;;OAMG;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"}

package/lib/schema/classes/Schema.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schema = void 0;
-const EntitySchema_1 = require("./EntitySchema");
-const RelationDefinitionSchema_1 = require("./RelationDefinitionSchema");
+import { EntitySchema } from "./EntitySchema.js";
+import { RelationDefinitionSchema } from "./RelationDefinitionSchema.js";
 const rawSchemaKey = Symbol("Indexer of the rawSchema");
 /**
  * Wrapper around the raw JSON Schema.
  * It is recommended to use this class instead of the raw JSON Schema
  * as it is more robust to schema changes and provides utility functions.
+ *
+ * @category Schema
  */
-class Schema {
+export class Schema {
+    [rawSchemaKey];
     /**
      * Wrapper around the raw JSON Schema.
      * It is recommended to use this class instead of the raw JSON Schema
@@ -24,14 +24,14 @@ class Schema {
      * Returns the list of entity schemas in the schema using the EntitySchema abstraction class.
      */
     get entities() {
-        return this[rawSchemaKey].entities.map((eSchema) => new EntitySchema_1.EntitySchema(this, eSchema));
+        return this[rawSchemaKey].entities.map((eSchema) => new EntitySchema(this, eSchema));
     }
     /**
      * Returns the list of relation definitions schemas in the schema
      * using the RelationDefinitionSchema abstraction class.
      */
     get relationsDefinitions() {
-        return this[rawSchemaKey].relations_definitions.map((rdefSchema) => new RelationDefinitionSchema_1.RelationDefinitionSchema(this, rdefSchema));
+        return this[rawSchemaKey].relations_definitions.map((rdefSchema) => new RelationDefinitionSchema(this, rdefSchema));
     }
     /**
      * Returns the entity schema for the given entity type if it exists.
@@ -50,7 +50,7 @@ class Schema {
             return null;
         }
         // @ts-ignore: see above
-        return new EntitySchema_1.EntitySchema(this, entityRawSchema);
+        return new EntitySchema(this, entityRawSchema);
     }
     /**
      * Finds relations definition schemas in the Schema matching the
@@ -68,8 +68,7 @@ class Schema {
             }
             return true;
         });
-        return matchArray.map((m) => new RelationDefinitionSchema_1.RelationDefinitionSchema(this, m));
+        return matchArray.map((m) => new RelationDefinitionSchema(this, m));
     }
 }
-exports.Schema = Schema;
 //# sourceMappingURL=Schema.js.map

package/lib/schema/classes/Schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/schema/classes/Schema.ts"],"names":[],"mappings":";;;AAWA,iDAA8C;AAC9C,yEAAsE;AAGtE,MAAM,YAAY,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAEvE;;;;GAIG;AACH,MAAa,MAAM;IAMjB;;;;;;OAMG;IACH,YAAY,SAA0B;QACpC,IAAI,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CACpC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,2BAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAC7C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,GAAG,CACjD,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,mDAAwB,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,qEAAqE;YACrE,qDAAqD;YACrD,0CAA0C;YAC1C,OAAO,IAAI,CAAC;SACb;QACD,wBAAwB;QACxB,OAAO,IAAI,2BAAY,CACrB,IAAI,EACJ,eAAkD,CACnD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;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,mDAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAnGD,wBAmGC"}
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/schema/classes/Schema.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAMzE,MAAM,YAAY,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAEvE;;;;;;GAMG;AACH,MAAM,OAAO,MAAM;IAIjB,CAAC,YAAY,CAAC,CAAkB;IAEhC;;;;;;OAMG;IACH,YAAY,SAA0B;QACpC,IAAI,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,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;;;OAGG;IACH,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,qEAAqE;YACrE,qDAAqD;YACrD,0CAA0C;YAC1C,OAAO,IAAI,CAAC;SACb;QACD,wBAAwB;QACxB,OAAO,IAAI,YAAY,CACrB,IAAI,EACJ,eAAkD,CACnD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;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"}

package/lib/schema/classes/Utils.d.ts

@@ -1,13 +1,21 @@
-import { EntityRawSchemaArray } from "../raw/Entities";
-import { Cardinality, RelationDefinitionRawSchema, RelationDefinitionRawSchemaArray } from "../raw/RelationDefinitions";
-import { Schema } from "./Schema";
-import { EntitySchema } from "./EntitySchema";
+import { EntityRawSchemaArray } from "../raw/Entities.js";
+import { Cardinality, RelationDefinitionRawSchema, RelationDefinitionRawSchemaArray } from "../raw/RelationDefinitions.js";
+import { Schema } from "./Schema.js";
+import { EntitySchema } from "./EntitySchema.js";
+/**
+ * An entity role in a relation.
+ *
+ * @category Utils
+ */
+export type EntityRole = "subject" | "object";
 /**
  * Returns the given schema using loose typing.
  * Can be useful when working with generic schemas
  *
  * @param schema The schema to create a loose type for
  * @returns A loosely typed schema
+ *
+ * @category Utils
  */
 export declare const getLooseSchema: <E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>>(schema: Schema<E, R>) => Schema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>>;
 /**
@@ -15,10 +23,134 @@ export declare const getLooseSchema: <E extends EntityRawSchemaArray = EntityRaw
  *
  * @param cardinality The cardinality to check
  * @returns True if the cardinality is 1 or +
+ *
+ * @category Utils
+ */
+export declare function isCardinalityRequired(cardinality: Cardinality): boolean;
+/**
+ * Checks if the cardinality allows multiple entities to be present
+ *
+ * @param cardinality The cardinility to check
+ * @returns True if the cardinality is `*` or `+`
+ *
+ * @category Utils
+ */
+export declare const isCardinalityMultiple: (cardinality: Cardinality) => boolean;
+/**
+ * Checks if the cardinality allows entities to be absent
+ *
+ * @param cardinality The cardinility to check
+ * @returns True if the cardinality is `?` or `*`
+ *
+ * @category Utils
+ */
+export declare const isCardinalityOptional: (cardinality: Cardinality) => boolean;
+/**
+ * Reverses the given role name
+ *
+ * @param role The role to reverse
+ * @returns "object" if the given role was "subject", "subject" otherwise
+ *
+ * @category Utils
+ */
+export declare function getOppositeRelationRole(role: EntityRole): EntityRole;
+/**
+ * Checks if the given relation type is reversed.
+ *
+ * A reversed relation means the relation is considered from the object entity
+ * point of view.
+ * The reverse indicator is a prefix added as a convention in CubicWeb.
+ *
+ * @param relationType The relation type to check
+ * @returns True if the relation type starts with the reverse indicator
+ *
+ * @category Utils
+ */
+export declare const isRelationTypeReversed: (relationType: string) => boolean;
+/**
+ * Gets the entity role in the given relation type by
+ * checking for the reverse indicator
+ *
+ * A reversed relation means the relation is considered from the object entity
+ * point of view.
+ * The reverse indicator is a prefix added as a convention in CubicWeb.
+ *
+ * @param relationType The relation type to check
+ * @returns "subject" if the relation is not reversed, "object" otherwise
+ *
+ * @category Utils
+ */
+export declare const getRoleFromRelationType: (relationType: string) => EntityRole;
+/**
+ * Adds the reverse indicator from the relation type if it is not already present.
+ *
+ * A reversed relation means the relation is considered from the object entity
+ * point of view.
+ * The reverse indicator is a prefix added as a convention in CubicWeb.
+ *
+ * @param relationType The relation type to transform
+ * @returns The relation type with the reverse indicator added or removed
+ *
+ * @category Utils
+ */
+export declare const getReverseRelationType: (relationType: string) => string;
+/**
+ * Clears the reverse indicator from the relation type if it is present.
+ *
+ * A reversed relation means the relation is considered from the object entity
+ * point of view.
+ * The reverse indicator is a prefix added as a convention in CubicWeb.
+ *
+ * @param relationType The relation type to transform
+ * @returns The relation type with the reverse indicator added or removed
+ *
+ * @category Utils
+ */
+export declare const getRawRelationType: (relationType: string) => string;
+/**
+ * Returns the relation type with the reverse indicator added if necessary.
+ *
+ * A reversed relation means the relation is considered from the object entity
+ * point of view.
+ * The reverse indicator is a prefix added as a convention in CubicWeb.
+ *
+ * @param relationType The relation type to transform
+ * @param role The entity role in the relation
+ * @returns A relation type with the reverse indicator if necessary
+ *
+ * @category Utils
  */
-export declare function cardinalityRequired(cardinality: Cardinality): boolean;
+export declare const getRelationType: (relationType: string, role: EntityRole) => string;
+/**
+ * Finds the relation matching the provided source, relation typ and target
+ *
+ * @param entitySchema The entity schema the relation is from
+ * @param sourceType The entity type acting as source for the relation
+ * @param relationType The type of the relation to use. Can have the reverse indicator to decide the role of the source/target entities
+ * @param targetType The entity type acting as target for the relation
+ * @returns The relation definition matching the triplet source relation target
+ *
+ * @category Utils
+ */
+export declare const getRelationDefinition: (entitySchema: EntitySchema, sourceType: string, relationType: string, targetType: string) => import("./RelationDefinitionSchema.js").RelationDefinitionSchema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>, Readonly<{
+    type: string;
+    description: string;
+    cardinality: "**" | "*1" | "*?" | "*+" | "1*" | "11" | "1?" | "1+" | "?*" | "?1" | "??" | "?+" | "+*" | "+1" | "+?" | "++";
+    subject: string;
+} & ((import("../raw/RelationDefinitions.js").BuildObj & {
+    final: true;
+    constraints: import("../raw/Constraints.js").AttributeConstraint[];
+    options: import("../raw/RelationDefinitions.js").AttributeOptions;
+}) | {
+    object: string;
+    final: false;
+    constraints: import("../raw/Constraints.js").RelationConstraint[];
+    options: import("../raw/RelationDefinitions.js").RelationOptions;
+})>> | undefined;
 /**
  * Partial raw relation definition schema type.
+ *
+ * @category Utils
  */
 export type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<RelationDefinitionRawSchema<E>>;
 /**
@@ -26,6 +158,8 @@ export type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<
  * If it finds a relation definition matching the partial one given, it will return its type.
  * If it cannot find any relation definition matching, it will return the `never` type
  * and TypeScript will give compile errors.
+ *
+ * @category Utils
  */
 export 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 declare function hasAttributeWithName(entitySchema: EntitySchema, attributeNameSearched: string): boolean;

package/lib/schema/classes/Utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,WAAW,EACX,2BAA2B,EAC3B,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,4PAO1B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,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;AAE3E,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAOT;AAED,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAET"}
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EACL,WAAW,EACX,2BAA2B,EAC3B,gCAAgC,EACjC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOjD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE9C;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,4PAO1B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEvE;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,gBAAiB,WAAW,KAAG,OAEhE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,gBAAiB,WAAW,KAAG,OAEhE,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAEpE;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,iBAAkB,MAAM,KAAG,OAE7D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,iBAAkB,MAAM,KAAG,UAE9D,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,iBAAkB,MAAM,KAAG,MAM7D,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB,iBAAkB,MAAM,KAAG,MAMzD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,iBAAkB,MAAM,QAAQ,UAAU,WAIrE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,iBAClB,YAAY,cACd,MAAM,gBACJ,MAAM,cACR,MAAM;;;;;;;;;;;;;;gBAYnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,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;AAE3E,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAOT;AAED,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAET"}