@cubicweb/client 0.1.0

package/lib/schema/Schema.js

@@ -0,0 +1,269 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationDefinitionSchema = exports.EntitySchema = exports.Schema = exports.getLooseSchema = void 0;
+const Errors_1 = require("../Errors");
+const rawSchemaKey = Symbol("Indexer of the rawSchema");
+/**
+ * Returns the given schema using loose typing.
+ * Can be useful when working for generic schemas
+ *
+ * @param schema The schema to create a loose type for
+ * @returns
+ */
+const getLooseSchema = (schema) => {
+    return schema;
+};
+exports.getLooseSchema = getLooseSchema;
+/**
+ * Wrapper around the raw JSON Schema
+ */
+class Schema {
+    constructor(rawSchema) {
+        this[rawSchemaKey] = rawSchema;
+    }
+    get entities() {
+        return this[rawSchemaKey].entities.map((eSchema) => new EntitySchema(this, eSchema));
+    }
+    get relationsDefinitions() {
+        return this[rawSchemaKey].relations_definitions.map((rdefSchema) => new RelationDefinitionSchema(this, rdefSchema));
+    }
+    /**
+     * Returns the entity schema for the given entity type if it exists.
+     * When using TypeScript, this method can detect if the given type does not exist
+     * in the schema.
+     *
+     * @param entityType The entity type string
+     * @returns A new EntitySchema or null if the type does not exist
+     */
+    getEntity(entityType) {
+        const entityRawSchema = this[rawSchemaKey].entities.filter((eSchema) => eSchema.type === entityType)[0];
+        if (!entityRawSchema) {
+            // Is only null when the given type is not in the schema.
+            // Thus the return type will be (EntitySchema | null)
+            // but TypeScript does not understand this
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            return null;
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return new EntitySchema(this, entityRawSchema);
+    }
+    /**
+     * Finds relations in the Schema matching the partial relation given
+     *
+     * @param matcher Partial relation definition to match against
+     * @returns Matched relation schema classes
+     */
+    matchRelationDefinitions(matcher) {
+        const matchArray = this[rawSchemaKey].relations_definitions.filter((relDef) => {
+            for (const key of Object.keys(matcher)) {
+                if (matcher[key] !== relDef[key]) {
+                    return false;
+                }
+            }
+            return true;
+        });
+        return matchArray.map((m) => new RelationDefinitionSchema(this, m));
+    }
+}
+exports.Schema = Schema;
+/**
+ * Wrapper around raw entities from the Schema
+ */
+class EntitySchema {
+    constructor(schema, entityRawSchema) {
+        this.schema = schema;
+        this.entityRawSchema = entityRawSchema;
+    }
+    /**
+     * The type of the entity. This can also be referred to as the entity' name.
+     */
+    get type() {
+        return this.entityRawSchema.type;
+    }
+    /**
+     * A short description which can be used as documentation for the entity.
+     */
+    get description() {
+        return this.entityRawSchema.description;
+    }
+    /**
+     * True if the current entity is a primitive type such as string or int
+     */
+    get final() {
+        return this.entityRawSchema.final;
+    }
+    /**
+     * Gets the list of relation definitions with this entity as subject
+     */
+    get subjectRelationDefinitions() {
+        return this.schema.matchRelationDefinitions({
+            subject: this.type,
+            final: false,
+        });
+    }
+    /**
+     * Gets the list of relation definitions with this entity as object
+     */
+    get objectRelationsDefinitions() {
+        return this.schema.matchRelationDefinitions({
+            object: this.type,
+            final: false,
+        });
+    }
+    /**
+     * 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) {
+        const resultArray = this.schema.matchRelationDefinitions({
+            subject: this.type,
+            type: relationType,
+        });
+        if (resultArray.length > 0) {
+            return resultArray[0];
+        }
+        throw new Errors_1.RelationNotFoundError(relationType, "subject", this.type);
+    }
+    /**
+     * Finds the first relation of the given type with this entity as object
+     *
+     * @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
+     */
+    getObjectRelationDefinition(relationType) {
+        const resultArray = this.schema.matchRelationDefinitions({
+            object: this.type,
+            type: relationType,
+        });
+        if (resultArray.length > 0) {
+            return resultArray[0];
+        }
+        throw new Errors_1.RelationNotFoundError(relationType, "object", this.type);
+    }
+    /**
+     * Gets the list of attributes names for this entity
+     */
+    get attributes() {
+        return this.schema.matchRelationDefinitions({
+            final: true,
+            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, role) {
+        let relation;
+        let cardinality;
+        if (role === "subject") {
+            relation = this.getSubjectRelationDefinition(relationType);
+            cardinality = relation.cardinality[0];
+        }
+        else {
+            relation = this.getObjectRelationDefinition(relationType);
+            cardinality = relation.cardinality[1];
+        }
+        return cardinalityRequired(cardinality);
+    }
+}
+exports.EntitySchema = EntitySchema;
+/**
+ * Wrapper around raw relation definitions from the Schema
+ */
+class RelationDefinitionSchema {
+    constructor(schema, relDef) {
+        this.schema = schema;
+        this.relDef = relDef;
+    }
+    /**
+     * The type of the relation. This can also be referred to as the relation's name.
+     */
+    get type() {
+        return this.relDef.type;
+    }
+    /**
+     * A short description which can be used as documentation for the relation.
+     */
+    get description() {
+        return this.relDef.description;
+    }
+    /**
+     * True if the object of the relation is a primitive type.
+     * In this case the relation iscalled an "attribute"
+     */
+    get final() {
+        return this.relDef.final;
+    }
+    /**
+     * The list of constraints if any. Only attributes (relations with final = true) have constraints.
+     * In other cases this returns null.
+     */
+    get constraints() {
+        return this.relDef.constraints;
+    }
+    /**
+     * The default value for this relation.
+     * It can be used when creating new relations if user did not enter a value (even if required).
+     */
+    get default() {
+        return ("default" in this.relDef ? this.relDef.default : undefined);
+    }
+    get cardinality() {
+        return this.relDef.cardinality;
+    }
+    get subjectCardinality() {
+        return this.relDef.cardinality[0];
+    }
+    get objectCardinality() {
+        return this.relDef.cardinality[1];
+    }
+    /**
+     * Gets the entity associated to this relation's subject
+     *
+     * @throws InconsistentSchemaError if the relation's subject is not a valid entity
+     */
+    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`);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return subjectSchema;
+    }
+    /**
+     * Gets the entity associated to this relation's object
+     *
+     * @throws InconsistentSchemaError if the relation's object is not a valid entity
+     */
+    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`);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return objectSchema;
+    }
+}
+exports.RelationDefinitionSchema = RelationDefinitionSchema;
+/**
+ * Checks if the given cardinality requires at least one entity to be present
+ *
+ * @param cardinality The cardinality to check
+ * @returns
+ */
+function cardinalityRequired(cardinality) {
+    return cardinality === "1" || cardinality === "+";
+}
+//# sourceMappingURL=Schema.js.map

package/lib/schema/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/schema/Schema.ts"],"names":[],"mappings":";;;AACA,sCAA2E;AAW3E,MAAM,YAAY,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAEvE;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAGN,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF;;GAEG;AACH,MAAa,MAAM;IAMjB,YAAY,SAA0B;QACpC,IAAI,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACjC,CAAC;IAED,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,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,yDAAyD;YACzD,qDAAqD;YACrD,0CAA0C;YAC1C,6DAA6D;YAC7D,aAAa;YACb,OAAO,IAAI,CAAC;SACb;QACD,6DAA6D;QAC7D,aAAa;QACb,OAAO,IAAI,YAAY,CACrB,IAAI,EACJ,eAAkD,CACnD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;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;AAvFD,wBAuFC;AAED;;GAEG;AACH,MAAa,YAAY;IAKvB,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;;OAEG;IACH,IAAI,0BAA0B;QAK5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,0BAA0B;QAK5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B,CAO1B,YAA0B;QAU1B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YACvD,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB;QACD,MAAM,IAAI,8BAAqB,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,2BAA2B,CAOzB,YAA0B;QAU1B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YACvD,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;SACvB;QACD,MAAM,IAAI,8BAAqB,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAMhB,YAA0B,EAAE,IAA0B;QACtD,IAAI,QAAQ,CAAC;QACb,IAAI,WAAwB,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,QAAQ,GAAG,IAAI,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;YAC3D,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvC;aAAM;YACL,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;YAC1D,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACvC;QACD,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;CACF;AAlKD,oCAkKC;AAED;;GAEG;AACH,MAAa,wBAAwB;IAKnC,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;;;OAGG;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,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;IACnD,CAAC;IAED,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,6DAA6D;QAC7D,aAAa;QACb,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,6DAA6D;QAC7D,aAAa;QACb,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAlGD,4DAkGC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,WAAwB;IACnD,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC"}

package/lib/schema/SchemaJSON.d.ts

@@ -0,0 +1,121 @@
+declare type ConstraintBase<T extends string, V extends Record<string, unknown> | null> = {
+    type: T;
+    value: V;
+};
+export declare type ConstraintOperator = ">" | ">=" | "<" | "<=";
+declare type ConstraintMessage = string | null;
+export declare type UniqueConstraint = ConstraintBase<"UniqueConstraint", null>;
+export declare type SizeConstraint = ConstraintBase<"SizeConstraint", {
+    min: number | null;
+    max: number | null;
+    msg: ConstraintMessage;
+}>;
+export declare type RegexpConstraint = ConstraintBase<"RegexpConstraint", {
+    regexp: string;
+    flags: number;
+    msg: ConstraintMessage;
+}>;
+export declare type BoundaryConstraint = ConstraintBase<"BoundaryConstraint", {
+    boundary: number | null;
+    op: ConstraintOperator;
+    msg: ConstraintMessage;
+}>;
+export declare type IntervalBoundConstraint = ConstraintBase<"IntervalBoundConstraint", {
+    minvalue: number | null;
+    maxvalue: number | null;
+    msg: ConstraintMessage;
+}>;
+export declare type StaticVocabularyConstraint = ConstraintBase<"StaticVocabularyConstraint", {
+    values: string[];
+    msg: ConstraintMessage;
+}>;
+export declare type FormatConstraint = ConstraintBase<"FormatConstraint", {
+    values: ["text/rest", "text/markdown", "text/html", "text/plain"];
+    msg: ConstraintMessage;
+}>;
+export declare type Constraint = Readonly<UniqueConstraint | SizeConstraint | RegexpConstraint | BoundaryConstraint | IntervalBoundConstraint | StaticVocabularyConstraint | FormatConstraint>;
+declare type BuildObjBase<T extends string> = {
+    object: T;
+    final: true;
+    required?: boolean;
+};
+interface StringBuildObj extends BuildObjBase<"String"> {
+    default: string | null;
+}
+interface PasswordBuildObj extends BuildObjBase<"Password"> {
+    default: string | null;
+}
+interface BytesBuildObj extends BuildObjBase<"Bytes"> {
+    default: string | null;
+}
+interface IntBuildObj extends BuildObjBase<"Int"> {
+    default: number | null;
+}
+interface BigIntBuildObj extends BuildObjBase<"BigInt"> {
+    default: number | null;
+}
+interface FloatBuildObj extends BuildObjBase<"Float"> {
+    default: number | null;
+}
+interface BooleanBuildObj extends BuildObjBase<"Boolean"> {
+    default: boolean | null;
+}
+interface DecimalBuildObj extends BuildObjBase<"Decimal"> {
+    default: number | null;
+}
+interface DateBuildObj extends BuildObjBase<"Date"> {
+    default: unknown;
+}
+interface TimeBuildObj extends BuildObjBase<"Time"> {
+    default: unknown;
+}
+interface DatetimeBuildObj extends BuildObjBase<"Datetime"> {
+    default: Date | "NOW" | "TODAY" | null;
+}
+interface TZTimeBuildObj extends BuildObjBase<"TZTime"> {
+    default: unknown;
+}
+interface TZDatetimeBuildObj extends BuildObjBase<"TZDatetime"> {
+    default: unknown;
+}
+interface IntervalBuildObj extends BuildObjBase<"Interval"> {
+    default: unknown;
+}
+export declare type BuildObj = Readonly<StringBuildObj | PasswordBuildObj | BytesBuildObj | IntBuildObj | BigIntBuildObj | FloatBuildObj | BooleanBuildObj | DecimalBuildObj | DateBuildObj | TimeBuildObj | DatetimeBuildObj | TZTimeBuildObj | TZDatetimeBuildObj | IntervalBuildObj>;
+export declare type Cardinality = "*" | "1" | "?" | "+";
+export declare type CardinalityPair = `${Cardinality}${Cardinality}`;
+export declare type EntityRawSchema = {
+    type: string;
+    final: boolean;
+    description: string;
+};
+export declare type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
+export declare type RelationDefinitionRawSchema<ESchemas extends EntityRawSchemaArray, Final extends boolean = boolean> = Readonly<{
+    type: string;
+    description: string;
+    cardinality: CardinalityPair;
+    subject: ESchemas[number]["type"];
+} & (Final extends true ? BuildObj & {
+    constraints: Constraint[];
+} : {
+    object: EntityRawSchema["type"];
+    final: false;
+    constraints: null;
+})>;
+export declare type RelationDefinitionRawSchemaArray<ESchemas extends EntityRawSchemaArray> = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
+export declare type RawSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> = {
+    entities: E;
+    relations_definitions: R;
+};
+export declare type IsLooseSchema<E extends EntityRawSchemaArray> = string extends E[number]["type"] ? true : false;
+export declare 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 {
+    type: T;
+} ? ESchema : never : never;
+export {};
+//# sourceMappingURL=SchemaJSON.d.ts.map

package/lib/schema/SchemaJSON.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJSON.d.ts","sourceRoot":"","sources":["../../src/schema/SchemaJSON.ts"],"names":[],"mappings":"AAAA,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,oBAAY,kBAAkB,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;AACzD,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,UAAU,GAAG,QAAQ,CAC7B,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,uBAAuB,GACvB,0BAA0B,GAC1B,gBAAgB,CACnB,CAAC;AAEF,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,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,oBAAY,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhD,oBAAY,eAAe,GAAG,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAE7D,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAY,oBAAoB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAElE,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,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,GACD;IAAE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,IAAI,CAAA;CAAE,CAAC,CAC1E,CAAC;AAEF,oBAAY,gCAAgC,CAC1C,QAAQ,SAAS,oBAAoB,IACnC,aAAa,CAAC,2BAA2B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AAElE,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;AAEF,oBAAY,aAAa,CAAC,CAAC,SAAS,oBAAoB,IACtD,MAAM,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElD,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;;;;IAII;AACJ,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"}

package/lib/schema/SchemaJSON.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SchemaJSON.js.map

package/lib/schema/SchemaJSON.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJSON.js","sourceRoot":"","sources":["../../src/schema/SchemaJSON.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@cubicweb/client",
+  "description": "Official JS client for CubicWeb API",
+  "author": "Logilab",
+  "version": "0.1.0",
+  "license": "LGPL-2.1-or-later",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc  --project tsconfig.build.json"
+  },
+  "repository": {
+    "type": "hg",
+    "url": "https://forge.extranet.logilab.fr/cubicweb/cubicwebjs"
+  },
+  "keywords": [
+    "cubicweb",
+    "client",
+    "js"
+  ]
+}

package/src/Errors.ts

@@ -0,0 +1,26 @@
+export class InconsistentSchemaError extends Error {
+  constructor(message: string) {
+    super(`Inconsistent schema: ${message}`);
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+export class RelationNotFoundError extends Error {
+  constructor(
+    entityType: string,
+    role: "object" | "subject",
+    relationType: string
+  ) {
+    super(
+      `Relation Not Found: relation type ${relationType} with entity type ${entityType} as ${role} is not declared`
+    );
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+export class TransactionClosedError extends Error {
+  constructor() {
+    super("Trying to use a closed transaction");
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}

package/src/api/Api.ts

@@ -0,0 +1,97 @@
+import { RawSchema } from "../schema/SchemaJSON";
+
+export type RQLQuery = [string, RQLParams];
+
+export interface RQLParams {
+  [key: string]: string | number;
+}
+
+export type RqlRow = Array<string | number | boolean | null>;
+export type ResultSet = Array<RqlRow>;
+export type ApiError = { error: string; message: string };
+export type ApiErrorResponse = {
+  status: number;
+} & ApiError;
+
+export default class Api {
+  private apiUrl: string;
+  private transactionApiUrl: string;
+
+  constructor(apiUrl: string) {
+    this.apiUrl = `${apiUrl}/v1`;
+    this.transactionApiUrl = `${this.apiUrl}/transaction`;
+  }
+
+  async execute(query: string, params: RQLParams) {
+    return fetchApi(`${this.apiUrl}/rql`, {
+      method: "POST",
+      body: JSON.stringify({ query, params }),
+      credentials: "include", // FIXME is it secure?
+    });
+  }
+
+  async schema(): Promise<RawSchema> {
+    const res = await fetch(`${this.apiUrl}/schema`);
+    const schema = await res.json();
+    return schema as RawSchema;
+  }
+
+  async transactionBegin() {
+    const body = JSON.stringify({ action: "begin" });
+    return await fetch(this.transactionApiUrl, {
+      method: "POST",
+      body,
+      credentials: "include",
+    });
+  }
+
+  async transactionExecute(uuid: string, query: string, params: RQLParams) {
+    const body = JSON.stringify({ action: "execute", uuid, query, params });
+    return fetchApi(this.transactionApiUrl, {
+      method: "POST",
+      body,
+      credentials: "include",
+    });
+  }
+
+  async transactionCommit(uuid: string) {
+    const body = JSON.stringify({ action: "commit", uuid });
+    return await fetch(this.transactionApiUrl, {
+      method: "POST",
+      body,
+      credentials: "include",
+    });
+  }
+
+  async transactionRollback(uuid: string) {
+    const body = JSON.stringify({ action: "commit", uuid });
+    return await fetch(this.transactionApiUrl, {
+      method: "POST",
+      body,
+      credentials: "include",
+    });
+  }
+}
+
+export const fetchApi = (input: RequestInfo, init?: RequestInit) => {
+  return new Promise(
+    (
+      resolve: (value: ResultSet) => void,
+      reject: (reason: ApiErrorResponse) => void
+    ) =>
+      fetch(input, init).then((response) => {
+        const status = response.status;
+        if (status === 200) {
+          response.json().then(resolve);
+        } else {
+          response.json().then((data: ApiError) => {
+            reject({
+              status,
+              error: data.error,
+              message: data.message,
+            });
+          });
+        }
+      })
+  );
+};

package/src/api/Client.ts

@@ -0,0 +1,30 @@
+import { Schema } from "../schema/Schema";
+import Api, { RQLParams } from "./Api";
+import Transaction from "./Transaction";
+
+export default class Client {
+  private api: Api;
+
+  constructor(apiUrl: string) {
+    this.api = new Api(apiUrl);
+  }
+
+  async execute(query: string, params: RQLParams = {}) {
+    return await this.api.execute(query, params);
+  }
+
+  async schema(): Promise<Schema> {
+    const schema = await this.api.schema();
+    return new Schema(schema);
+  }
+
+  async transaction<T>(callback: (tr: Transaction) => Promise<T>): Promise<T> {
+    const transaction = new Transaction(this.api);
+    await transaction.begin();
+    const result = await callback(transaction);
+    if (!transaction.isClosed()) {
+      transaction.commit();
+    }
+    return result;
+  }
+}

package/src/api/Transaction.ts

@@ -0,0 +1,47 @@
+import { TransactionClosedError } from "../Errors";
+import Api, { RQLParams } from "./Api";
+
+export default class Transaction {
+  private _uuid: string | null = null;
+  private _closed = false;
+
+  constructor(private api: Api) {}
+
+  isClosed() {
+    return this._closed;
+  }
+
+  get uuid() {
+    return this._uuid;
+  }
+
+  async begin() {
+    this._closed = false;
+    const response = await this.api.transactionBegin();
+    const json = await response.json();
+    this._uuid = json;
+  }
+
+  async execute(query: string, params: RQLParams = {}) {
+    this.preventUsageIfClosed();
+    return await this.api.transactionExecute(this.uuid, query, params);
+  }
+
+  async commit() {
+    this.preventUsageIfClosed();
+    await this.api.transactionCommit(this.uuid);
+    this._closed = true;
+  }
+
+  async rollback() {
+    this.preventUsageIfClosed();
+    await this.api.transactionRollback(this.uuid);
+    this._closed = true;
+  }
+
+  private preventUsageIfClosed(): asserts this is { uuid: string } {
+    if (this.isClosed()) {
+      throw new TransactionClosedError();
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,16 @@
+export {
+  getLooseSchema,
+  Schema,
+  EntitySchema,
+  RelationDefinitionSchema,
+} from "./schema/Schema";
+export * from "./schema/SchemaJSON";
+export * from "./Errors";
+export { default as Client } from "./api/Client";
+export {
+  RQLQuery,
+  RQLParams,
+  RqlRow,
+  ResultSet,
+  ApiErrorResponse,
+} from "./api/Api";