@cubicweb/client 3.0.0-alpha.4 → 3.0.0-alpha.6

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

@@ -3,10 +3,14 @@ import { AttributeConstraint, RelationConstraint } from "./Constraints";
 import { EntityRawSchema, EntityRawSchemaArray } from "./Entities";
 /**
  * Type representing all the possible cardinalities in CubicWeb.
+ *
+ * @category Schema
  */
 export type Cardinality = "*" | "1" | "?" | "+";
 /**
  * Type representing a cardinality pair as used in relation definitions.
+ *
+ * @category Schema
  */
 export type CardinalityPair = `${Cardinality}${Cardinality}`;
 /**
@@ -74,6 +78,8 @@ interface CustomBuildObj<T extends string> extends BuildObjBase<T> {
 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.
+ *
+ * @category Schema
  */
 export type AttributeOptions = {
     indexed?: boolean;
@@ -82,6 +88,8 @@ export type AttributeOptions = {
 };
 /**
  * Type representing the possible options for a relation definition.
+ *
+ * @category Schema
  */
 export type RelationOptions = {
     symmetric?: boolean;
@@ -94,6 +102,8 @@ export type RelationOptions = {
  * It can represent both attributes and relations depending on the value of Final.
  *
  * It can infer default values type depending on the object type if the relation is final.
+ *
+ * @category Schema
  */
 export type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, Final extends boolean = boolean> = Readonly<{
     type: string;
@@ -112,6 +122,8 @@ export type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, F
 })>;
 /**
  * Type representing a list of relation definitions.
+ *
+ * @category Schema
  */
 export type RelationDefinitionRawSchemaArray<ESchemas extends EntityRawSchemaArray> = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
 export {};

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,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,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,UAAU,CAAC;IAChC,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB,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"}
+{"version":3,"file":"RelationDefinitions.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/RelationDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD;;;;GAIG;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;;;;GAIG;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;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,UAAU,CAAC;IAChC,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;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;;;;GAIG;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

@@ -5,6 +5,8 @@ import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions";
  * You can export this schema from your CubicWeb instance using the command:
  *
  * `cubicweb-ctl export-schema -f typescript <YOUR_INSTANCE_NAME>`
+ *
+ * @category Schema
  */
 export type RawSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> = {
     entities: E;

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,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"}
+{"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;;;;;;;GAOG;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

@@ -5,16 +5,22 @@ 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).
+ *
+ * @category Schema
  */
 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.
+ *
+ * @category Schema
  */
 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.
+ *
+ * @category Schema
  */
 export type EntityRawSchemaByType<E extends EntityRawSchemaArray, T extends string> = E[number] extends infer ESchema ? ESchema extends {
     type: T;

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,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"}
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/raw/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD;;;;;GAKG;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;;;;;GAKG;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,13 +2,13 @@
   "name": "@cubicweb/client",
   "description": "Official JS client for CubicWeb API",
   "author": "Logilab",
-  "version": "3.0.0-alpha.4",
+  "version": "3.0.0-alpha.6",
   "license": "LGPL-3.0-or-later",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
-    "build": "tsc  --project tsconfig.build.json",
-    "docs": "typedoc"
+    "build": "run -T tsc  --project tsconfig.build.json",
+    "docs": "run -T typedoc"
   },
   "repository": {
     "type": "hg",
@@ -23,9 +23,5 @@
     "lib/**",
     "src/**",
     "!**/__tests__/**"
-  ],
-  "devDependencies": {
-    "typedoc": "^0.23.24",
-    "typescript": "^4.9.4"
-  }
+  ]
 }

package/src/api/Api.ts

@@ -3,17 +3,21 @@ import { RawSchema } from "../schema/raw/Schema";
 import {
   TransactionResult,
   Transaction,
-  isTransactionQueryRef,
+  isTransactionQueryScalarRef,
 } from "./Transaction";
 
 /**
  * Type representing an RQL request and its associated parameters.
+ *
+ * @category Api
  */
 export type RQLQuery = [string, RQLParams];
 
 export type RQLParamValue = string | number | boolean | null;
 /**
  * Type representing RQL parameters to send along a request.
+ *
+ * @category Api
  */
 export interface RQLParams {
   [key: string]: RQLParamValue;
@@ -21,16 +25,22 @@ export interface RQLParams {
 
 /**
  * Type representing a row returned in a result set.
+ *
+ * @category Api
  */
 export type RqlRow = Array<string | number | boolean | null>;
 
 /**
  * Type representing a RQL request result.
+ *
+ * @category Api
  */
 export type ResultSet = Array<RqlRow>;
 
 /**
  * Type representing the currently logged user's data
+ *
+ * @category Api
  */
 export interface CurrentUser {
   login: string;
@@ -40,6 +50,8 @@ export interface CurrentUser {
 
 /**
  * Type representing the body of an error sent by CubicWeb's API.
+ *
+ * @category Api
  */
 type ApiError = {
   title: string;
@@ -49,6 +61,8 @@ type ApiError = {
 
 /**
  * Type representing the error data sent to clients when retrieving an API error.
+ *
+ * @category Api
  */
 export type ApiErrorResponse = {
   status: number;
@@ -69,7 +83,7 @@ export default class Api {
   private _schemaApiUrl: string;
   private _loginApiUrl: string;
   private _currentUserApiUrl: string;
-  private _transactionApiUrl: string;
+  private _binaryApiUrl: string;
 
   /**
    * Class used to handle requests to the CubicWeb API.
@@ -87,7 +101,7 @@ export default class Api {
     this._schemaApiUrl = this.getApiRoute("schema");
     this._loginApiUrl = this.getApiRoute("login");
     this._currentUserApiUrl = this.getApiRoute("current-user");
-    this._transactionApiUrl = this.getApiRoute("transaction");
+    this._binaryApiUrl = this.getApiRoute("binary");
   }
 
   get apiUrl() {
@@ -98,25 +112,6 @@ export default class Api {
     return `${this._apiUrl}/${this._version}/${route}`;
   }
 
-  /**
-   * Executes the given query and waits for the response.
-   *
-   * @param query The RQL query to send
-   * @param params The additional parameters for the request
-   * @returns A promise with the request's result set
-   */
-  async execute(query: string, params: RQLParams): Promise<ResultSet> {
-    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);
-    }
-  }
-
   /**
    * Retrieves the CubicWeb instance's JSON schema.
    *
@@ -164,15 +159,41 @@ export default class Api {
     });
   }
 
-  async executeTransaction(
-    transaction: Transaction
-  ): Promise<TransactionResult> {
-    const data = transaction.queries.map((transactionQuery) => ({
+  /**
+   * Get the binary for the given entity attribute
+   *
+   * @returns A promise resolving to the binary
+   */
+  async binary(eid: number, attribute: string): Promise<Blob> {
+    const params = new URLSearchParams({
+      eid: eid.toString(),
+      attribute,
+    });
+    return await nonNullFetchApi<Blob>(this._binaryApiUrl + params, {
+      method: "GET",
+      credentials: "include",
+    });
+  }
+
+  async rql(transaction: Transaction): Promise<TransactionResult> {
+    try {
+      if (Object.keys(transaction.binaries).length > 0) {
+        return await this.multipartTransaction(transaction);
+      } else {
+        return await this.jsonTransaction(transaction);
+      }
+    } catch (e) {
+      this.handleUserErrors(e);
+    }
+  }
+
+  private getTransactionParams(transaction: Transaction) {
+    return transaction.queries.map((transactionQuery) => ({
       query: transactionQuery.query,
       params: Object.fromEntries(
         Object.entries(transactionQuery.params).map(([key, value]) => [
           key,
-          isTransactionQueryRef(value)
+          isTransactionQueryScalarRef(value)
             ? {
                 queryIndex: value.queryIndex,
                 row: value.row,
@@ -182,19 +203,37 @@ export default class Api {
         ])
       ),
     }));
-    try {
-      const resultSets = await nonNullFetchApi<ReadonlyArray<ResultSet>>(
-        this._transactionApiUrl,
-        {
-          method: "POST",
-          credentials: "include",
-          body: JSON.stringify(data),
-        }
-      );
-      return new TransactionResult(resultSets);
-    } catch (e) {
-      this.handleUserErrors(e);
-    }
+  }
+
+  private async multipartTransaction(transaction: Transaction) {
+    const jsonParams = this.getTransactionParams(transaction);
+    const formData = new FormData();
+    formData.append("queries", JSON.stringify(jsonParams));
+    Object.entries(transaction.binaries).forEach(([key, value]) => {
+      formData.append(key, value);
+    });
+
+    const resultSets = await nonNullFetchApi<ReadonlyArray<ResultSet>>(
+      this._rqlApiUrl,
+      {
+        method: "POST",
+        credentials: "include",
+        body: formData,
+      }
+    );
+    return new TransactionResult(resultSets);
+  }
+
+  private async jsonTransaction(transaction: Transaction) {
+    const resultSets = await nonNullFetchApi<ReadonlyArray<ResultSet>>(
+      this._rqlApiUrl,
+      {
+        method: "POST",
+        credentials: "include",
+        body: JSON.stringify(this.getTransactionParams(transaction)),
+      }
+    );
+    return new TransactionResult(resultSets);
   }
 
   private handleUserErrors(error: unknown): never {
@@ -257,6 +296,8 @@ async function fetchApi<R = unknown>(
   if (init?.method && init.method !== "GET" && init.method !== "DELETE") {
     headers = {
       "Content-Type": "application/json;charset=UTF-8",
+      // CSRF custom header necessary for POST requests
+      "X-Client-Name": "XMLHttpRequest",
       ...init?.headers,
     };
   }

package/src/api/Client.ts

@@ -1,18 +1,14 @@
 import { Schema } from "../schema/classes/Schema";
 import Api, { RQLParams, ResultSet, CurrentUser } from "./Api";
-import {
-  NativeTransactionBackend,
-  Transaction,
-  TransactionBackend,
-  TransactionResult,
-} from "./Transaction";
+import { BinariesParam, Transaction, TransactionResult } from "./Transaction";
 
 /**
  * Class used to communicate with a CubicWeb instance's API.
+ *
+ * @category Api
  */
 export default class Client {
   private api: Api;
-  private transactionBackend: TransactionBackend;
 
   /**
    * Class used to communicate with a CubicWeb instance's API.
@@ -21,17 +17,8 @@ export default class Client {
    * Example: if you can retrieve the schema with https://example.com/api/v1/schema,
    * use https://example.com/api as `apiUrl`.
    */
-  constructor(
-    apiUrl: string,
-    options: { transactionBackend?: TransactionBackend } = {}
-  ) {
+  constructor(apiUrl: string) {
     this.api = new Api(apiUrl);
-    const { transactionBackend } = options;
-    if (transactionBackend === undefined) {
-      this.transactionBackend = new NativeTransactionBackend(this.api);
-    } else {
-      this.transactionBackend = transactionBackend;
-    }
   }
 
   get apiUrl() {
@@ -45,8 +32,16 @@ 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 = {}): Promise<ResultSet> {
-    return await this.api.execute(query, params);
+  async execute(
+    query: string,
+    params: RQLParams = {},
+    binaries?: BinariesParam
+  ): Promise<ResultSet> {
+    const transaction = new Transaction();
+    const transactionQuery = transaction.push(query, params);
+    transaction.setBinaries(binaries);
+    const result = await this.executeTransaction(transaction);
+    return result.resolveQuery(transactionQuery.ref());
   }
 
   /**
@@ -86,6 +81,15 @@ export default class Client {
   async executeTransaction(
     transaction: Transaction
   ): Promise<TransactionResult> {
-    return await this.transactionBackend.execute(transaction);
+    return await this.api.rql(transaction);
+  }
+
+  /**
+   * Get the binary for the given entity attribute
+   *
+   * @returns A promise resolving to the binary
+   */
+  async getBinary(eid: number, attribute: string) {
+    return await this.api.binary(eid, attribute);
   }
 }

package/src/api/Transaction.ts

@@ -1,11 +1,14 @@
-import Api, { ResultSet, RQLParamValue } from "./Api";
+import { ResultSet, RQLParamValue } from "./Api";
+
+export type BinariesParam = Record<string, Blob>;
 
 export class Transaction {
   private _queries: Array<TransactionQuery> = [];
+  private _binaries: BinariesParam = {};
 
   push(
     query: string,
-    params: Record<string, RQLParamValue | TransactionQueryRef>
+    params: Record<string, RQLParamValue | TransactionQueryScalarRef>
   ): TransactionQuery {
     const stackedQuery = new TransactionQuery(
       query,
@@ -16,44 +19,78 @@ export class Transaction {
     return stackedQuery;
   }
 
+  setBinaries(binaries?: BinariesParam) {
+    this._binaries = binaries ?? {};
+  }
+
+  get binaries(): BinariesParam {
+    return this._binaries;
+  }
+
   get queries(): ReadonlyArray<TransactionQuery> {
     return this._queries;
   }
 }
 
+export class TransactionQuery {
+  constructor(
+    public readonly query: string,
+    public readonly params: Record<
+      string,
+      RQLParamValue | TransactionQueryScalarRef
+    >,
+    public readonly index: number
+  ) {}
+
+  ref(): TransactionQueryRef {
+    return new TransactionQueryRef(this.index);
+  }
+}
+
 export class TransactionResult {
   constructor(private resultSets: ReadonlyArray<ResultSet>) {}
 
-  resolve(ref: TransactionQueryRef) {
+  resolveQuery(ref: TransactionQueryRef) {
+    return this.resultSets[ref.queryIndex];
+  }
+
+  resolveRow(ref: TransactionQueryRowRef) {
+    return this.resultSets[ref.queryIndex][ref.row];
+  }
+
+  resolveScalar(ref: TransactionQueryScalarRef) {
     return this.resultSets[ref.queryIndex][ref.row][ref.column];
   }
 }
 
-export interface TransactionQueryRef {
-  queryIndex: number;
-  row: number;
-  column: number;
+export class TransactionQueryRef {
+  constructor(public readonly queryIndex: number) {}
+
+  row(r: number): TransactionQueryRowRef {
+    return new TransactionQueryRowRef(this.queryIndex, r);
+  }
 }
 
-export class TransactionQuery {
+export class TransactionQueryRowRef {
   constructor(
-    public readonly query: string,
-    public readonly params: Record<string, RQLParamValue | TransactionQueryRef>,
-    public readonly index: number
+    public readonly queryIndex: number,
+    public readonly row: number
   ) {}
 
-  ref(row = 0, column = 0): TransactionQueryRef {
-    return {
-      queryIndex: this.index,
-      row,
-      column,
-    };
+  column(c: number): TransactionQueryScalarRef {
+    return { queryIndex: this.queryIndex, row: this.row, column: c };
   }
 }
 
-export function isTransactionQueryRef(
-  value: RQLParamValue | TransactionQueryRef
-): value is TransactionQueryRef {
+export interface TransactionQueryScalarRef {
+  readonly queryIndex: number;
+  readonly row: number;
+  readonly column: number;
+}
+
+export function isTransactionQueryScalarRef(
+  value: RQLParamValue | TransactionQueryScalarRef
+): value is TransactionQueryScalarRef {
   return (
     typeof value === "object" &&
     value !== null &&
@@ -62,14 +99,3 @@ export function isTransactionQueryRef(
     )
   );
 }
-
-export interface TransactionBackend {
-  execute(transaction: Transaction): Promise<TransactionResult>;
-}
-
-export class NativeTransactionBackend implements TransactionBackend {
-  constructor(private _api: Api) {}
-  async execute(transaction: Transaction): Promise<TransactionResult> {
-    return this._api.executeTransaction(transaction);
-  }
-}

package/src/schema/classes/EntitySchema.ts

@@ -8,6 +8,8 @@ import { MatchedRelationDefinition, RelationDefinitionMatcher } from "./Utils";
  * 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
  */
 export class EntitySchema<
   E extends EntityRawSchemaArray = EntityRawSchemaArray,

package/src/schema/classes/RelationDefinitionSchema.ts

@@ -13,6 +13,8 @@ import { EntityRole, isCardinalityRequired } from "./Utils";
  * 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 class RelationDefinitionSchema<
   E extends EntityRawSchemaArray = EntityRawSchemaArray,

package/src/schema/classes/Schema.ts

@@ -19,6 +19,8 @@ const rawSchemaKey: unique symbol = 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
  */
 export class Schema<
   E extends EntityRawSchemaArray = EntityRawSchemaArray,