@cubicweb/client 3.0.0-alpha.9 → 3.0.2

package/src/schema/raw/Constraints.ts

@@ -14,16 +14,25 @@ type ConstraintBase<
  */
 type ConstraintMessage = string | null;
 
+/**
+ * A Unique constraint on an attribute.
+ */
 export type UniqueConstraint = ConstraintBase<
   "UniqueConstraint",
   { msg: ConstraintMessage }
 >;
 
+/**
+ * A constraint on the size of a string
+ */
 export type SizeConstraint = ConstraintBase<
   "SizeConstraint",
   { min: number | null; max: number | null; msg: ConstraintMessage }
 >;
 
+/**
+ * A Regexp constraint on a string
+ */
 export type RegexpConstraint = ConstraintBase<
   "RegexpConstraint",
   { regexp: string; flags: number; msg: ConstraintMessage }
@@ -81,6 +90,9 @@ export interface Now {
  */
 export type ConstraintOperator = ">" | ">=" | "<" | "<=";
 
+/**
+ * A boundary constraint on a number attribute.
+ */
 export type BoundaryConstraint = ConstraintBase<
   "BoundaryConstraint",
   {
@@ -89,6 +101,10 @@ export type BoundaryConstraint = ConstraintBase<
     msg: ConstraintMessage;
   }
 >;
+
+/**
+ * An interval constraint on a number attribute.
+ */
 export type IntervalBoundConstraint = ConstraintBase<
   "IntervalBoundConstraint",
   {
@@ -98,11 +114,17 @@ export type IntervalBoundConstraint = ConstraintBase<
   }
 >;
 
+/**
+ * A static vocabulary constraint on a string attribute.
+ */
 export type StaticVocabularyConstraint = ConstraintBase<
   "StaticVocabularyConstraint",
   { values: string[]; msg: ConstraintMessage }
 >;
 
+/**
+ * A format constraint on a string attribute.
+ */
 export type FormatConstraint = ConstraintBase<
   "FormatConstraint",
   {
@@ -111,11 +133,17 @@ export type FormatConstraint = ConstraintBase<
   }
 >;
 
+/**
+ * A vocabulary constraint on a string attribute described by a RQL.
+ */
 export type RQLVocabularyConstraint = ConstraintBase<
   "RQLVocabularyConstraint",
   { expression: string; mainvars: string[] }
 >;
 
+/**
+ * A constraint on an attribute described by a RQL.
+ */
 export type RQLConstraint = ConstraintBase<
   "RQLConstraint",
   { expression: string; mainvars: string[]; msg: ConstraintMessage }

package/src/schema/raw/RelationDefinitions.ts

@@ -1,6 +1,6 @@
-import { EntityRole } from "../classes/Utils";
-import { AttributeConstraint, RelationConstraint } from "./Constraints";
-import { EntityRawSchema, EntityRawSchemaArray } from "./Entities";
+import { EntityRole } from "../classes/Utils.js";
+import { AttributeConstraint, RelationConstraint } from "./Constraints.js";
+import { EntityRawSchema, EntityRawSchemaArray } from "./Entities.js";
 
 /**
  * Type representing all the possible cardinalities in CubicWeb.

package/src/schema/raw/Schema.ts

@@ -1,5 +1,5 @@
-import { EntityRawSchemaArray } from "./Entities";
-import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions";
+import { EntityRawSchemaArray } from "./Entities.js";
+import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions.js";
 
 /**
  * The full raw JSON schema type as returned by the API.

package/src/schema/raw/Utils.ts

@@ -1,4 +1,4 @@
-import { EntityRawSchemaArray } from "./Entities";
+import { EntityRawSchemaArray } from "./Entities.js";
 
 /**
  * Type used to check if a schema is loosely typed.

package/src/utils.ts

@@ -0,0 +1,91 @@
+import { RQLQueryParams, RQLQueryParamValue } from "./api/Api.js";
+import { RQLBinary } from "./api/binary/RQLBinary.js";
+import { RQLQuery } from "./api/query/RQLQuery.js";
+import { RQLQueryCellRef } from "./api/query/references.js";
+import { Transaction } from "./api/transaction/Transaction.js";
+
+type SerializedRQLParams = Record<
+  string,
+  RQLQueryParamValue | SerializedRqlQueryCellRef | SerializedRqlQueryBinaryRef
+>;
+
+interface SerializedRqlQueryCellRef {
+  readonly queryIndex: number;
+  readonly row: number;
+  readonly column: number;
+  readonly type: "query_reference";
+}
+
+interface SerializedRqlQueryBinaryRef {
+  readonly ref: string;
+  readonly type: "binary_reference";
+}
+
+/**
+ * Retrieves the query index in the given transaction from its eid
+ *
+ * @param transaction The transaction to search the query in
+ * @param queryUUID The UUID of the query to find
+ * @returns The query index in the transaction if found
+ * @throws When no query with the given UUID is found
+ *
+ * @internal
+ */
+export function getQueryIndexInTransaction(
+  transaction: Transaction,
+  queryUUID: string
+) {
+  const index = transaction.queries.findIndex((q) => q.queryUUID === queryUUID);
+  if (index < 0) {
+    throw new Error(
+      `Cannot find query of id '${queryUUID}' in the transaction`
+    );
+  }
+  return index;
+}
+
+/**
+ * Serializes the user parameters to the format understood by the API
+ *
+ * @param params The params passed by the user
+ * @returns A serialized version of the parameters as understood by the API
+ *
+ * @internal
+ */
+export function serializeQueryParams(
+  transaction: Transaction,
+  params: RQLQueryParams
+) {
+  const newParams: SerializedRQLParams = {};
+  Object.entries(params).forEach(([k, v]) => {
+    if (v instanceof RQLQueryCellRef) {
+      const queryIndex = getQueryIndexInTransaction(transaction, v.queryUUID);
+      newParams[k] = {
+        queryIndex,
+        column: v.column,
+        row: v.row,
+        type: "query_reference",
+      } as SerializedRqlQueryCellRef;
+    } else if (v instanceof RQLBinary) {
+      newParams[k] = {
+        ref: v.uuid,
+        type: "binary_reference",
+      } as SerializedRqlQueryBinaryRef;
+    } else {
+      newParams[k] = v;
+    }
+  });
+  return newParams;
+}
+
+export function getBinariesFromTransaction(
+  transaction: Transaction
+): RQLBinary[] {
+  return transaction.queries.flatMap(getBinariesFromRQLQuery);
+}
+
+export function getBinariesFromRQLQuery(query: RQLQuery): RQLBinary[] {
+  return Object.values(query.params).filter(
+    (p): p is RQLBinary => p instanceof RQLBinary
+  );
+}

package/lib/Errors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Errors.d.ts","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":"AAAA,qBAAa,uBAAwB,SAAQ,KAAK;gBACpC,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,sBAAuB,SAAQ,KAAK;;CAKhD"}

package/lib/Errors.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionClosedError = exports.ValidationError = exports.InconsistentSchemaError = void 0;
-class InconsistentSchemaError extends Error {
-    constructor(message) {
-        super(`Inconsistent schema: ${message}`);
-        Object.setPrototypeOf(this, new.target.prototype);
-    }
-}
-exports.InconsistentSchemaError = InconsistentSchemaError;
-class ValidationError extends Error {
-    constructor(message) {
-        super(message);
-        Object.setPrototypeOf(this, new.target.prototype);
-    }
-}
-exports.ValidationError = ValidationError;
-class TransactionClosedError extends Error {
-    constructor() {
-        super("Trying to use a closed transaction");
-        Object.setPrototypeOf(this, new.target.prototype);
-    }
-}
-exports.TransactionClosedError = TransactionClosedError;
-//# sourceMappingURL=Errors.js.map

package/lib/Errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Errors.js","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,OAAe;QACzB,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AALD,0DAKC;AAED,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AALD,0CAKC;AAED,MAAa,sBAAuB,SAAQ,KAAK;IAC/C;QACE,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC5C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AALD,wDAKC"}

package/lib/api/Transaction.d.ts

@@ -1,46 +0,0 @@
-import { RQLParams, ResultSet } from "./Api";
-export type BinariesParam = Record<string, Blob>;
-export declare class Transaction {
-    private _queries;
-    private _binaries;
-    push(query: string, params: RQLParams): TransactionQuery;
-    setBinaries(binaries?: BinariesParam): void;
-    get binaries(): BinariesParam;
-    get queries(): ReadonlyArray<TransactionQuery>;
-}
-export declare class TransactionQuery {
-    readonly query: string;
-    readonly params: RQLParams;
-    readonly index: number;
-    constructor(query: string, params: RQLParams, index: number);
-    ref(): TransactionQueryRef;
-}
-export declare class TransactionResult {
-    private resultSets;
-    constructor(resultSets: ReadonlyArray<ResultSet>);
-    resolveQuery(ref: TransactionQueryRef): ResultSet;
-    resolveRow(ref: TransactionQueryRowRef): import("./Api").RqlRow;
-    resolveScalar(ref: TransactionQueryScalarRef): string | number | boolean | null;
-}
-export declare class TransactionQueryRef {
-    readonly queryIndex: number;
-    constructor(queryIndex: number);
-    row(r: number): TransactionQueryRowRef;
-}
-export declare class TransactionQueryRowRef {
-    readonly queryIndex: number;
-    readonly row: number;
-    constructor(queryIndex: number, row: number);
-    column(c: number): TransactionQueryScalarRef;
-}
-export interface TransactionQueryScalarRef {
-    readonly queryIndex: number;
-    readonly row: number;
-    readonly column: number;
-    readonly type: "query_reference";
-}
-export interface TransactionQueryBinaryRef {
-    readonly ref: string;
-    readonly type: "binary_reference";
-}
-//# sourceMappingURL=Transaction.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEjD,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,SAAS,CAAqB;IAEtC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,gBAAgB;IAUxD,WAAW,CAAC,QAAQ,CAAC,EAAE,aAAa;IAIpC,IAAI,QAAQ,IAAI,aAAa,CAE5B;IAED,IAAI,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAE7C;CACF;AAED,qBAAa,gBAAgB;aAET,KAAK,EAAE,MAAM;aACb,MAAM,EAAE,SAAS;aACjB,KAAK,EAAE,MAAM;gBAFb,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,EACjB,KAAK,EAAE,MAAM;IAG/B,GAAG,IAAI,mBAAmB;CAG3B;AAED,qBAAa,iBAAiB;IAChB,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC;IAExD,YAAY,CAAC,GAAG,EAAE,mBAAmB;IAIrC,UAAU,CAAC,GAAG,EAAE,sBAAsB;IAItC,aAAa,CAAC,GAAG,EAAE,yBAAyB;CAG7C;AAED,qBAAa,mBAAmB;aACF,UAAU,EAAE,MAAM;gBAAlB,UAAU,EAAE,MAAM;IAE9C,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB;CAGvC;AAED,qBAAa,sBAAsB;aAEf,UAAU,EAAE,MAAM;aAClB,GAAG,EAAE,MAAM;gBADX,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM;IAG7B,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,yBAAyB;CAQ7C;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;CAClC;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;CACnC"}

package/lib/api/Transaction.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionQueryRowRef = exports.TransactionQueryRef = exports.TransactionResult = exports.TransactionQuery = exports.Transaction = void 0;
-class Transaction {
-    constructor() {
-        this._queries = [];
-        this._binaries = {};
-    }
-    push(query, params) {
-        const stackedQuery = new TransactionQuery(query, params, this._queries.length);
-        this._queries.push(stackedQuery);
-        return stackedQuery;
-    }
-    setBinaries(binaries) {
-        this._binaries = binaries !== null && binaries !== void 0 ? binaries : {};
-    }
-    get binaries() {
-        return this._binaries;
-    }
-    get queries() {
-        return this._queries;
-    }
-}
-exports.Transaction = Transaction;
-class TransactionQuery {
-    constructor(query, params, index) {
-        this.query = query;
-        this.params = params;
-        this.index = index;
-    }
-    ref() {
-        return new TransactionQueryRef(this.index);
-    }
-}
-exports.TransactionQuery = TransactionQuery;
-class TransactionResult {
-    constructor(resultSets) {
-        this.resultSets = resultSets;
-    }
-    resolveQuery(ref) {
-        return this.resultSets[ref.queryIndex];
-    }
-    resolveRow(ref) {
-        return this.resultSets[ref.queryIndex][ref.row];
-    }
-    resolveScalar(ref) {
-        return this.resultSets[ref.queryIndex][ref.row][ref.column];
-    }
-}
-exports.TransactionResult = TransactionResult;
-class TransactionQueryRef {
-    constructor(queryIndex) {
-        this.queryIndex = queryIndex;
-    }
-    row(r) {
-        return new TransactionQueryRowRef(this.queryIndex, r);
-    }
-}
-exports.TransactionQueryRef = TransactionQueryRef;
-class TransactionQueryRowRef {
-    constructor(queryIndex, row) {
-        this.queryIndex = queryIndex;
-        this.row = row;
-    }
-    column(c) {
-        return {
-            type: "query_reference",
-            queryIndex: this.queryIndex,
-            row: this.row,
-            column: c,
-        };
-    }
-}
-exports.TransactionQueryRowRef = TransactionQueryRowRef;
-//# sourceMappingURL=Transaction.js.map

package/lib/api/Transaction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/api/Transaction.ts"],"names":[],"mappings":";;;AAIA,MAAa,WAAW;IAAxB;QACU,aAAQ,GAA4B,EAAE,CAAC;QACvC,cAAS,GAAkB,EAAE,CAAC;IAuBxC,CAAC;IArBC,IAAI,CAAC,KAAa,EAAE,MAAiB;QACnC,MAAM,YAAY,GAAG,IAAI,gBAAgB,CACvC,KAAK,EACL,MAAM,EACN,IAAI,CAAC,QAAQ,CAAC,MAAM,CACrB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,QAAwB;QAClC,IAAI,CAAC,SAAS,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC;IAClC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAzBD,kCAyBC;AAED,MAAa,gBAAgB;IAC3B,YACkB,KAAa,EACb,MAAiB,EACjB,KAAa;QAFb,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAAW;QACjB,UAAK,GAAL,KAAK,CAAQ;IAC5B,CAAC;IAEJ,GAAG;QACD,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;CACF;AAVD,4CAUC;AAED,MAAa,iBAAiB;IAC5B,YAAoB,UAAoC;QAApC,eAAU,GAAV,UAAU,CAA0B;IAAG,CAAC;IAE5D,YAAY,CAAC,GAAwB;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,UAAU,CAAC,GAA2B;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,aAAa,CAAC,GAA8B;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;CACF;AAdD,8CAcC;AAED,MAAa,mBAAmB;IAC9B,YAA4B,UAAkB;QAAlB,eAAU,GAAV,UAAU,CAAQ;IAAG,CAAC;IAElD,GAAG,CAAC,CAAS;QACX,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;CACF;AAND,kDAMC;AAED,MAAa,sBAAsB;IACjC,YACkB,UAAkB,EAClB,GAAW;QADX,eAAU,GAAV,UAAU,CAAQ;QAClB,QAAG,GAAH,GAAG,CAAQ;IAC1B,CAAC;IAEJ,MAAM,CAAC,CAAS;QACd,OAAO;YACL,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,MAAM,EAAE,CAAC;SACV,CAAC;IACJ,CAAC;CACF;AAdD,wDAcC"}

package/src/api/Transaction.ts

@@ -1,94 +0,0 @@
-import { RQLParams, ResultSet } from "./Api";
-
-export type BinariesParam = Record<string, Blob>;
-
-export class Transaction {
-  private _queries: Array<TransactionQuery> = [];
-  private _binaries: BinariesParam = {};
-
-  push(query: string, params: RQLParams): TransactionQuery {
-    const stackedQuery = new TransactionQuery(
-      query,
-      params,
-      this._queries.length
-    );
-    this._queries.push(stackedQuery);
-    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: RQLParams,
-    public readonly index: number
-  ) {}
-
-  ref(): TransactionQueryRef {
-    return new TransactionQueryRef(this.index);
-  }
-}
-
-export class TransactionResult {
-  constructor(private resultSets: ReadonlyArray<ResultSet>) {}
-
-  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 class TransactionQueryRef {
-  constructor(public readonly queryIndex: number) {}
-
-  row(r: number): TransactionQueryRowRef {
-    return new TransactionQueryRowRef(this.queryIndex, r);
-  }
-}
-
-export class TransactionQueryRowRef {
-  constructor(
-    public readonly queryIndex: number,
-    public readonly row: number
-  ) {}
-
-  column(c: number): TransactionQueryScalarRef {
-    return {
-      type: "query_reference",
-      queryIndex: this.queryIndex,
-      row: this.row,
-      column: c,
-    };
-  }
-}
-
-export interface TransactionQueryScalarRef {
-  readonly queryIndex: number;
-  readonly row: number;
-  readonly column: number;
-  readonly type: "query_reference";
-}
-
-export interface TransactionQueryBinaryRef {
-  readonly ref: string;
-  readonly type: "binary_reference";
-}