@cubicweb/client 1.5.0 → 1.7.0

package/lib/schema/raw/Constraints.d.ts

@@ -1,58 +1,65 @@
 /**
  * Base type used to describe a constraint.
  */
-declare type ConstraintBase<T extends string, V extends Record<string, unknown> | null> = {
+type ConstraintBase<T extends string, V extends Record<string, unknown> | null> = {
     type: T;
     value: V;
 };
 /**
  * All the possible operators inside a constraint.
  */
-export declare type ConstraintOperator = ">" | ">=" | "<" | "<=";
+export type ConstraintOperator = ">" | ">=" | "<" | "<=";
 /**
  * THe type of a constraint message when one is present.
  */
-declare type ConstraintMessage = string | null;
-export declare type UniqueConstraint = ConstraintBase<"UniqueConstraint", null>;
-export declare type SizeConstraint = ConstraintBase<"SizeConstraint", {
+type ConstraintMessage = string | null;
+export type UniqueConstraint = ConstraintBase<"UniqueConstraint", {
+    msg: ConstraintMessage;
+}>;
+export type SizeConstraint = ConstraintBase<"SizeConstraint", {
     min: number | null;
     max: number | null;
     msg: ConstraintMessage;
 }>;
-export declare type RegexpConstraint = ConstraintBase<"RegexpConstraint", {
+export type RegexpConstraint = ConstraintBase<"RegexpConstraint", {
     regexp: string;
     flags: number;
     msg: ConstraintMessage;
 }>;
-export declare type BoundaryConstraint = ConstraintBase<"BoundaryConstraint", {
+export type BoundaryConstraint = ConstraintBase<"BoundaryConstraint", {
     boundary: number | null;
     op: ConstraintOperator;
     msg: ConstraintMessage;
 }>;
-export declare type IntervalBoundConstraint = ConstraintBase<"IntervalBoundConstraint", {
+export type IntervalBoundConstraint = ConstraintBase<"IntervalBoundConstraint", {
     minvalue: number | null;
     maxvalue: number | null;
     msg: ConstraintMessage;
 }>;
-export declare type StaticVocabularyConstraint = ConstraintBase<"StaticVocabularyConstraint", {
+export type StaticVocabularyConstraint = ConstraintBase<"StaticVocabularyConstraint", {
     values: string[];
     msg: ConstraintMessage;
 }>;
-export declare type FormatConstraint = ConstraintBase<"FormatConstraint", {
+export type FormatConstraint = ConstraintBase<"FormatConstraint", {
     values: ["text/rest", "text/markdown", "text/html", "text/plain"];
     msg: ConstraintMessage;
 }>;
-export declare type RQLVocabularyConstraint = ConstraintBase<"RQLVocabularyConstraint", {
+export type RQLVocabularyConstraint = ConstraintBase<"RQLVocabularyConstraint", {
+    expression: string;
+    mainvars: string[];
+}>;
+export type RQLConstraint = ConstraintBase<"RQLConstraint", {
     expression: string;
     mainvars: string[];
+    msg: ConstraintMessage;
 }>;
 /**
  * Type representing all possible constraints for attributes.
  */
-export declare type AttributeConstraint = Readonly<UniqueConstraint | SizeConstraint | RegexpConstraint | BoundaryConstraint | IntervalBoundConstraint | StaticVocabularyConstraint | FormatConstraint>;
+export type AttributeConstraint = Readonly<UniqueConstraint | SizeConstraint | RegexpConstraint | BoundaryConstraint | IntervalBoundConstraint | StaticVocabularyConstraint | FormatConstraint | RQLConstraint>;
 /**
  * Type representing all possible constraints for relations.
  */
-export declare type RelationConstraint = Readonly<RQLVocabularyConstraint>;
+export type RelationConstraint = Readonly<RQLVocabularyConstraint | RQLConstraint>;
 export {};
 //# sourceMappingURL=Constraints.d.ts.map

package/lib/schema/raw/Constraints.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Constraints.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Constraints.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,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;;GAEG;AACH,oBAAY,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AAEzD;;GAEG;AACH,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,uBAAuB,GAAG,cAAc,CAClD,yBAAyB,EACzB;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB,GAAG,QAAQ,CACtC,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,gBAAgB,CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,kBAAkB,GAAG,QAAQ,CAAC,uBAAuB,CAAC,CAAC"}
+{"version":3,"file":"Constraints.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Constraints.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,KAAK,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;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AAEzD;;GAEG;AACH,KAAK,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,kBAAkB,EAClB;IAAE,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC3B,CAAC;AAEF,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,0BAA0B,GAAG,cAAc,CACrD,4BAA4B,EAC5B;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CAC7C,CAAC;AAEF,MAAM,MAAM,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,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAClD,yBAAyB,EACzB;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAC3C,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,cAAc,CACxC,eAAe,EACf;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,iBAAiB,CAAA;CAAE,CACnE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CACtC,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,gBAAgB,GAChB,aAAa,CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CACvC,uBAAuB,GAAG,aAAa,CACxC,CAAC"}

package/lib/schema/raw/Entities.d.ts

@@ -1,7 +1,7 @@
 /**
  * Type representing an entity schema.
  */
-export declare type EntityRawSchema = {
+export type EntityRawSchema = {
     type: string;
     final: boolean;
     description: string;
@@ -9,5 +9,5 @@ export declare type EntityRawSchema = {
 /**
  * Type representing a list of entity schemas.
  */
-export declare type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
+export type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
 //# sourceMappingURL=Entities.d.ts.map

package/lib/schema/raw/Entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Entities.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,oBAAoB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC"}
+{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Entities.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC"}

package/lib/schema/raw/RelationDefinitions.d.ts

@@ -3,17 +3,17 @@ import { EntityRawSchema, EntityRawSchemaArray } from "./Entities";
 /**
  * Type representing all the possible cardinalities in CubicWeb.
  */
-export declare type Cardinality = "*" | "1" | "?" | "+";
+export type Cardinality = "*" | "1" | "?" | "+";
 /**
  * Type representing a cardinality pair as used in relation definitions.
  */
-export declare type CardinalityPair = `${Cardinality}${Cardinality}`;
+export type CardinalityPair = `${Cardinality}${Cardinality}`;
 /**
  * Type used as a base to build final relation definitions with primitive types (Int, String, ...).
  *
  * @internal
  */
-declare type BuildObjBase<T extends string> = {
+type BuildObjBase<T extends string> = {
     object: T;
     final: true;
     required?: boolean;
@@ -60,17 +60,21 @@ interface TZDatetimeBuildObj extends BuildObjBase<"TZDatetime"> {
 interface IntervalBuildObj extends BuildObjBase<"Interval"> {
     default: unknown;
 }
+interface CustomBuildObj<T extends string> extends BuildObjBase<T> {
+    type: T;
+    default: unknown;
+}
 /**
  * Type allowing to link the type of an object to the type of their default values in a
  * relation definition. It only works for final relations using primitive types.
  *
  * @internal
  */
-export declare type BuildObj = Readonly<StringBuildObj | PasswordBuildObj | BytesBuildObj | IntBuildObj | BigIntBuildObj | FloatBuildObj | BooleanBuildObj | DecimalBuildObj | DateBuildObj | TimeBuildObj | DatetimeBuildObj | TZTimeBuildObj | TZDatetimeBuildObj | IntervalBuildObj>;
+export type BuildObj = Readonly<StringBuildObj | PasswordBuildObj | BytesBuildObj | IntBuildObj | BigIntBuildObj | FloatBuildObj | BooleanBuildObj | DecimalBuildObj | DateBuildObj | TimeBuildObj | DatetimeBuildObj | TZTimeBuildObj | TZDatetimeBuildObj | IntervalBuildObj | CustomBuildObj<string>>;
 /**
  * Type representing the possible options for an attribute.
  */
-export declare type AttributeOptions = {
+export type AttributeOptions = {
     indexed?: boolean;
     fulltextindexed?: boolean;
     internationalizable?: boolean;
@@ -78,7 +82,7 @@ export declare type AttributeOptions = {
 /**
  * Type representing the possible options for a relation definition.
  */
-export declare type RelationOptions = {
+export type RelationOptions = {
     symmetric?: boolean;
     inlined?: boolean;
     fulltext_container?: "subject" | "object";
@@ -90,7 +94,7 @@ export declare type RelationOptions = {
  *
  * It can infer default values type depending on the object type if the relation is final.
  */
-export declare type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, Final extends boolean = boolean> = Readonly<{
+export type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, Final extends boolean = boolean> = Readonly<{
     type: string;
     description: string;
     cardinality: CardinalityPair;
@@ -108,6 +112,6 @@ export declare type RelationDefinitionRawSchema<ESchemas extends EntityRawSchema
 /**
  * Type representing a list of relation definitions.
  */
-export declare type RelationDefinitionRawSchemaArray<ESchemas extends EntityRawSchemaArray> = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
+export type RelationDefinitionRawSchemaArray<ESchemas extends EntityRawSchemaArray> = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
 export {};
 //# sourceMappingURL=RelationDefinitions.d.ts.map

package/lib/schema/raw/RelationDefinitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelationDefinitions.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/RelationDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEnE;;GAEG;AACH,oBAAY,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD;;GAEG;AACH,oBAAY,eAAe,GAAG,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAE7D;;;;GAIG;AACH,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;;;;;GAKG;AACH,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;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CAClC,CAAC;AAEF;;;;;GAKG;AACH,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,KAAK,EAAE,IAAI,CAAC;IACZ,WAAW,EAAE,mBAAmB,EAAE,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC;CAC3B,GACD;IACE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC,CACP,CAAC;AAEF;;GAEG;AACH,oBAAY,gCAAgC,CAC1C,QAAQ,SAAS,oBAAoB,IACnC,aAAa,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC"}
+{"version":3,"file":"RelationDefinitions.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/RelationDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAE7D;;;;GAIG;AACH,KAAK,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,UAAU,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;IAChE,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,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,GAChB,cAAc,CAAC,MAAM,CAAC,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CAClC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,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,KAAK,EAAE,IAAI,CAAC;IACZ,WAAW,EAAE,mBAAmB,EAAE,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC;CAC3B,GACD;IACE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC,CACP,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,CAC1C,QAAQ,SAAS,oBAAoB,IACnC,aAAa,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC"}

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

@@ -6,7 +6,7 @@ import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions";
  *
  * `cubicweb-ctl export-schema -f typescript <YOUR_INSTANCE_NAME>`
  */
-export declare type RawSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> = {
+export type RawSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> = {
     entities: E;
     relations_definitions: R;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAEzE;;;;;GAKG;AACH,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"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,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"}

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

@@ -6,17 +6,17 @@ import { EntityRawSchemaArray } from "./Entities";
  * In the given EntityRawSchemaArray, if the entities type is a string, the schema is loosely typed.
  * If the schema is strongly typed, the entities type would be a word (which is stricter than string).
  */
-export declare type IsLooseSchema<E extends EntityRawSchemaArray> = string extends E[number]["type"] ? true : false;
+export type IsLooseSchema<E extends EntityRawSchemaArray> = string extends E[number]["type"] ? true : false;
 /**
  * Checks if the given entity type is present in the EntityRawSchemaArray.
  * Use this to create conditional types.
  */
-export declare type IsETypeInStrictSchema<E extends EntityRawSchemaArray, EType extends string> = EType extends E[number]["type"] ? true : false;
+export 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 {
+export type EntityRawSchemaByType<E extends EntityRawSchemaArray, T extends string> = E[number] extends infer ESchema ? ESchema extends {
     type: T;
 } ? ESchema : never : never;
 //# sourceMappingURL=Utils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;GAMG;AACH,oBAAY,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD;;;GAGG;AACH,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;;;GAGG;AACH,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"}
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,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;;;GAGG;AACH,MAAM,MAAM,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/package.json

@@ -2,12 +2,13 @@
   "name": "@cubicweb/client",
   "description": "Official JS client for CubicWeb API",
   "author": "Logilab",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "license": "LGPL-3.0-or-later",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
-    "build": "tsc  --project tsconfig.build.json"
+    "build": "tsc  --project tsconfig.build.json",
+    "docs": "typedoc"
   },
   "repository": {
     "type": "hg",
@@ -22,5 +23,9 @@
     "lib/**",
     "src/**",
     "!**/__tests__/**"
-  ]
-}
+  ],
+  "devDependencies": {
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.4"
+  }
+}

package/src/Errors.ts

@@ -5,6 +5,13 @@ export class InconsistentSchemaError extends Error {
   }
 }
 
+export class ValidationError extends Error {
+  constructor(message: string) {
+    super(message);
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
 export class TransactionClosedError extends Error {
   constructor() {
     super("Trying to use a closed transaction");

package/src/api/Api.ts

@@ -1,3 +1,4 @@
+import { ValidationError } from "../Errors";
 import { RawSchema } from "../schema/raw/Schema";
 
 /**
@@ -97,11 +98,15 @@ export default class Api {
    * @returns A promise with the request's result set
    */
   async execute(query: string, params: RQLParams): Promise<ResultSet> {
-    return nonNullFetchApi<ResultSet>(this._rqlApiUrl, {
-      method: "POST",
-      body: JSON.stringify({ query, params }),
-      credentials: "include", // FIXME is it secure?
-    });
+    try {
+      return await nonNullFetchApi<ResultSet>(this._rqlApiUrl, {
+        method: "POST",
+        body: JSON.stringify({ query, params }),
+        credentials: "include", // FIXME is it secure?
+      });
+    } catch (e) {
+      this.handleUserErrors(e);
+    }
   }
 
   /**
@@ -124,16 +129,19 @@ export default class Api {
    * @returns A promise returning true if the login was successful, false otherwise
    */
   async login(login: string, password: string): Promise<boolean> {
-    return fetchApi<null>(this._loginApiUrl, {
-      method: "POST",
-      body: JSON.stringify({
-        login,
-        password,
-      }),
-      credentials: "include",
-    })
-      .then(() => true)
-      .catch(() => false);
+    try {
+      await fetchApi<null>(this._loginApiUrl, {
+        method: "POST",
+        body: JSON.stringify({
+          login,
+          password,
+        }),
+        credentials: "include",
+      });
+      return true;
+    } catch (_error) {
+      return false;
+    }
   }
 
   /**
@@ -161,11 +169,15 @@ export default class Api {
     query: string,
     params: RQLParams
   ): Promise<ResultSet | null> {
-    return fetchApi<ResultSet>(this._transactionApiUrl.execute, {
-      method: "POST",
-      body: JSON.stringify({ uuid, query, params }),
-      credentials: "include",
-    });
+    try {
+      return await fetchApi<ResultSet>(this._transactionApiUrl.execute, {
+        method: "POST",
+        body: JSON.stringify({ uuid, query, params }),
+        credentials: "include",
+      });
+    } catch (e) {
+      this.handleUserErrors(e);
+    }
   }
 
   /**
@@ -174,11 +186,15 @@ export default class Api {
    * @param uuid The transaction's uuid
    */
   async transactionCommit(uuid: string): Promise<null> {
-    return fetchApi<null>(this._transactionApiUrl.commit, {
-      method: "POST",
-      body: JSON.stringify({ uuid }),
-      credentials: "include",
-    });
+    try {
+      return await fetchApi<null>(this._transactionApiUrl.commit, {
+        method: "POST",
+        body: JSON.stringify({ uuid }),
+        credentials: "include",
+      });
+    } catch (e) {
+      this.handleUserErrors(e);
+    }
   }
 
   /**
@@ -193,6 +209,23 @@ export default class Api {
       credentials: "include",
     });
   }
+
+  private handleUserErrors(error: unknown): never {
+    if (
+      typeof error === "object" &&
+      error !== null &&
+      "title" in error &&
+      typeof error.title === "string" &&
+      "message" in error &&
+      typeof error.message === "string"
+    ) {
+      if (error.title === "ValidationError") {
+        throw new ValidationError(error.message);
+      }
+      throw error;
+    }
+    throw error;
+  }
 }
 
 /**
@@ -204,28 +237,21 @@ export default class Api {
  * @param init Additional request parameters
  * @returns A promise with the non-null fetched result
  */
-const nonNullFetchApi = <R = unknown>(
+async function nonNullFetchApi<R = unknown>(
   input: RequestInfo,
   init?: RequestInit
-) => {
-  return new Promise(
-    (resolve: (value: R) => void, reject: (reason: ApiErrorResponse) => void) =>
-      fetchApi<R>(input, init)
-        .then((v) => {
-          if (v == null) {
-            const error: ApiErrorResponse = {
-              status: 500,
-              title: "Unexpected null response",
-              message: "Response was null but a value was expected",
-            };
-            reject(error);
-          } else {
-            resolve(v);
-          }
-        })
-        .catch(reject)
-  );
-};
+) {
+  const result = await fetchApi<R>(input, init);
+  if (result == null) {
+    const error: ApiErrorResponse = {
+      status: 500,
+      title: "Unexpected null response",
+      message: "Response was null but a value was expected",
+    };
+    throw error;
+  }
+  return result;
+}
 
 /**
  * Sends a request to the given API route with the `Content-Type` header set and waits for a response.
@@ -236,7 +262,10 @@ const nonNullFetchApi = <R = unknown>(
  * @param init Additional request parameters
  * @returns A promise with the fetched result
  */
-const fetchApi = <R = unknown>(input: RequestInfo, init?: RequestInit) => {
+async function fetchApi<R = unknown>(
+  input: RequestInfo,
+  init?: RequestInit
+): Promise<R | null> {
   let headers = init?.headers;
   if (init?.method && init.method !== "GET" && init.method !== "DELETE") {
     headers = {
@@ -244,42 +273,30 @@ const fetchApi = <R = unknown>(input: RequestInfo, init?: RequestInit) => {
       ...init?.headers,
     };
   }
-  return new Promise(
-    (
-      resolve: (value: R | null) => void,
-      reject: (reason: ApiErrorResponse) => void
-    ) =>
-      fetch(input, {
-        ...init,
-        headers,
-      }).then((response) => {
-        const status = response.status;
-        if (status >= 200 && status < 300) {
-          if (status === 204) {
-            resolve(null);
-          } else {
-            response
-              .json()
-              .then(resolve)
-              .catch((e) => {
-                console.error(e);
-                resolve(null);
-              });
-          }
-        } else {
-          response
-            .json()
-            .then((data: ApiError) => {
-              reject({
-                status,
-                ...data,
-              });
-            })
-            .catch((e) => {
-              console.error(e);
-              reject({ status, title: "Error", message: "" });
-            });
-        }
-      })
-  );
-};
+
+  const response = await fetch(input, {
+    ...init,
+    headers,
+  });
+  const status = response.status;
+  if (status >= 200 && status < 300) {
+    if (status === 204) {
+      return null;
+    }
+    try {
+      return await response.json();
+    } catch (e) {
+      console.error(e);
+      return null;
+    }
+  } else {
+    let json;
+    try {
+      json = await response.json();
+    } catch (e) {
+      console.error(e);
+      throw { status, title: "Error", message: "" };
+    }
+    throw { status, ...json };
+  }
+}

package/src/api/Client.ts

@@ -1,5 +1,5 @@
 import { Schema } from "../schema/classes/Schema";
-import Api, { RQLParams } from "./Api";
+import Api, { RQLParams, ResultSet } from "./Api";
 import Transaction from "./Transaction";
 
 /**
@@ -30,7 +30,7 @@ export default class Client {
    * @param params The additional parameters for the request
    * @returns A promise with the request's result set
    */
-  async execute(query: string, params: RQLParams = {}) {
+  async execute(query: string, params: RQLParams = {}): Promise<ResultSet> {
     return await this.api.execute(query, params);
   }
 
@@ -59,6 +59,8 @@ export default class Client {
    * Creates a new transaction and exposes the Transaction object in the given callback.
    * Use this callback to execute RQL requests as part of the transaction.
    * Once the callback's end is reached, the transaction is automatically committed.
+   * Note that any exception thrown by the callback will lead to the
+   * transaction being rolled back.
    *
    * @param callback Function to execute transaction requests in.
    * @returns The promise returned by the callback
@@ -66,7 +68,16 @@ export default class Client {
   async transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T> {
     const transaction = new Transaction(this.api);
     await transaction.begin();
-    const result = await callback(transaction);
+
+    let result: T;
+    try {
+      result = await callback(transaction);
+    } catch (error) {
+      if (!transaction.isClosed()) {
+        await transaction.rollback();
+      }
+      throw error;
+    }
     if (!transaction.isClosed()) {
       await transaction.commit();
     }

package/src/schema/raw/Constraints.ts

@@ -19,7 +19,10 @@ export type ConstraintOperator = ">" | ">=" | "<" | "<=";
  */
 type ConstraintMessage = string | null;
 
-export type UniqueConstraint = ConstraintBase<"UniqueConstraint", null>;
+export type UniqueConstraint = ConstraintBase<
+  "UniqueConstraint",
+  { msg: ConstraintMessage }
+>;
 
 export type SizeConstraint = ConstraintBase<
   "SizeConstraint",
@@ -58,6 +61,11 @@ export type RQLVocabularyConstraint = ConstraintBase<
   { expression: string; mainvars: string[] }
 >;
 
+export type RQLConstraint = ConstraintBase<
+  "RQLConstraint",
+  { expression: string; mainvars: string[]; msg: ConstraintMessage }
+>;
+
 /**
  * Type representing all possible constraints for attributes.
  */
@@ -69,9 +77,12 @@ export type AttributeConstraint = Readonly<
   | IntervalBoundConstraint
   | StaticVocabularyConstraint
   | FormatConstraint
+  | RQLConstraint
 >;
 
 /**
  * Type representing all possible constraints for relations.
  */
-export type RelationConstraint = Readonly<RQLVocabularyConstraint>;
+export type RelationConstraint = Readonly<
+  RQLVocabularyConstraint | RQLConstraint
+>;

package/src/schema/raw/RelationDefinitions.ts

@@ -78,6 +78,11 @@ interface IntervalBuildObj extends BuildObjBase<"Interval"> {
   default: unknown;
 }
 
+interface CustomBuildObj<T extends string> extends BuildObjBase<T> {
+  type: T;
+  default: unknown;
+}
+
 /**
  * Type allowing to link the type of an object to the type of their default values in a
  * relation definition. It only works for final relations using primitive types.
@@ -99,6 +104,7 @@ export type BuildObj = Readonly<
   | TZTimeBuildObj
   | TZDatetimeBuildObj
   | IntervalBuildObj
+  | CustomBuildObj<string>
 >;
 
 /**