@cubicweb/client 1.0.3 → 1.1.1

package/src/schema/Schema.ts

@@ -1,5 +1,5 @@
 import { Cardinality } from "..";
-import { InconsistentSchemaError, RelationNotFoundError } from "../Errors";
+import { InconsistentSchemaError } from "../Errors";
 import {
   RawSchema,
   RelationDefinitionRawSchema,
@@ -186,71 +186,19 @@ export class EntitySchema<
   }
 
   /**
-   * 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 }
-    >
-  > {
-    const resultArray = this.schema.matchRelationDefinitions({
-      subject: this.type,
-      type: relationType,
-    });
-    if (resultArray.length > 0) {
-      return resultArray[0];
-    }
-    throw new RelationNotFoundError(relationType, "subject", this.type);
-  }
-
-  /**
-   * Finds the first relation of the given type with this entity as object
+   * Finds relations in the Schema matching the partial relation given
    *
-   * @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
+   * @param matcher Partial relation definition to match against
+   * @returns Matched relation schema classes
    */
-  getObjectRelationDefinition<
-    RelationType extends MatchedRelationDefinition<
-      E,
-      R,
-      { object: ERawSchema["type"] }
-    >["type"]
-  >(
-    relationType: RelationType
+  matchRelationDefinitions<M extends RelationDefinitionMatcher<E>>(
+    matcher: M
   ): RelationDefinitionSchema<
     E,
     R,
-    MatchedRelationDefinition<
-      E,
-      R,
-      { object: ERawSchema["type"]; type: RelationType }
-    >
-  > {
-    const resultArray = this.schema.matchRelationDefinitions({
-      object: this.type,
-      type: relationType,
-    });
-    if (resultArray.length > 0) {
-      return resultArray[0];
-    }
-    throw new RelationNotFoundError(relationType, "object", this.type);
+    MatchedRelationDefinition<E, R, { subject: ERawSchema["type"] }>
+  >[] {
+    return this.schema.matchRelationDefinitions(matcher);
   }
 
   /**
@@ -262,32 +210,6 @@ export class EntitySchema<
       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 extends MatchedRelationDefinition<
-      E,
-      R,
-      { subject: ERawSchema["type"] } | { object: ERawSchema["type"] }
-    >["type"]
-  >(relationType: RelationType, role: "subject" | "object"): boolean {
-    let relation;
-    let cardinality: Cardinality;
-    if (role === "subject") {
-      relation = this.getSubjectRelationDefinition(relationType);
-      cardinality = relation.cardinality[0];
-    } else {
-      relation = this.getObjectRelationDefinition(relationType);
-      cardinality = relation.cardinality[1];
-    }
-    return cardinalityRequired(cardinality);
-  }
 }
 
 /**
@@ -391,6 +313,22 @@ export class RelationDefinitionSchema<
     // @ts-ignore
     return objectSchema;
   }
+
+  /**
+   * Checks if the relation is required when using the subject or object pointof view
+   *
+   * @param role The point of view to use
+   * @returns
+   */
+  isRequired(role: "subject" | "object") {
+    let cardinality: Cardinality;
+    if (role === "subject") {
+      cardinality = this.cardinality[0] as Cardinality;
+    } else {
+      cardinality = this.cardinality[1] as Cardinality;
+    }
+    return cardinalityRequired(cardinality);
+  }
 }
 
 /**