@cubicweb/client 1.4.0 → 1.5.0

package/src/schema/{SchemaJSON.ts → raw/RelationDefinitions.ts}

@@ -1,65 +1,21 @@
-type ConstraintBase<
-  T extends string,
-  V extends Record<string, unknown> | null
-> = {
-  type: T;
-  value: V;
-};
-
-export type ConstraintOperator = ">" | ">=" | "<" | "<=";
-type ConstraintMessage = string | null;
-
-export type UniqueConstraint = ConstraintBase<"UniqueConstraint", null>;
-
-export type SizeConstraint = ConstraintBase<
-  "SizeConstraint",
-  { min: number | null; max: number | null; msg: ConstraintMessage }
->;
-
-export type RegexpConstraint = ConstraintBase<
-  "RegexpConstraint",
-  { regexp: string; flags: number; msg: ConstraintMessage }
->;
-
-export type BoundaryConstraint = ConstraintBase<
-  "BoundaryConstraint",
-  { boundary: number | null; op: ConstraintOperator; msg: ConstraintMessage }
->;
-export type IntervalBoundConstraint = ConstraintBase<
-  "IntervalBoundConstraint",
-  { minvalue: number | null; maxvalue: number | null; msg: ConstraintMessage }
->;
-
-export type StaticVocabularyConstraint = ConstraintBase<
-  "StaticVocabularyConstraint",
-  { values: string[]; msg: ConstraintMessage }
->;
+import { AttributeConstraint, RelationConstraint } from "./Constraints";
+import { EntityRawSchema, EntityRawSchemaArray } from "./Entities";
 
-export type FormatConstraint = ConstraintBase<
-  "FormatConstraint",
-  {
-    values: ["text/rest", "text/markdown", "text/html", "text/plain"];
-    msg: ConstraintMessage;
-  }
->;
-
-export type RQLVocabularyConstraint = ConstraintBase<
-  "RQLVocabularyConstraint",
-  { expression: string; mainvars: string[] }
->;
-
-export type AttributeConstraint = Readonly<
-  | UniqueConstraint
-  | SizeConstraint
-  | RegexpConstraint
-  | BoundaryConstraint
-  | IntervalBoundConstraint
-  | StaticVocabularyConstraint
-  | FormatConstraint
->;
+/**
+ * Type representing all the possible cardinalities in CubicWeb.
+ */
+export type Cardinality = "*" | "1" | "?" | "+";
 
-export type RelationConstraint = Readonly<RQLVocabularyConstraint>;
+/**
+ * Type representing a cardinality pair as used in relation definitions.
+ */
+export type CardinalityPair = `${Cardinality}${Cardinality}`;
 
+/**
+ * Type used as a base to build final relation definitions with primitive types (Int, String, ...).
+ *
+ * @internal
+ */
 type BuildObjBase<T extends string> = {
   object: T;
   final: true;
@@ -122,6 +78,12 @@ interface IntervalBuildObj extends BuildObjBase<"Interval"> {
   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 type BuildObj = Readonly<
   | StringBuildObj
   | PasswordBuildObj
@@ -139,24 +101,18 @@ export type BuildObj = Readonly<
   | IntervalBuildObj
 >;
 
-export type Cardinality = "*" | "1" | "?" | "+";
-
-export type CardinalityPair = `${Cardinality}${Cardinality}`;
-
-export type EntityRawSchema = {
-  type: string;
-  final: boolean;
-  description: string;
-};
-
-export type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
-
+/**
+ * Type representing the possible options for an attribute.
+ */
 export type AttributeOptions = {
   indexed?: boolean;
   fulltextindexed?: boolean;
   internationalizable?: boolean;
 };
 
+/**
+ * Type representing the possible options for a relation definition.
+ */
 export type RelationOptions = {
   symmetric?: boolean;
   inlined?: boolean;
@@ -164,6 +120,12 @@ export type RelationOptions = {
   composite?: "subject" | "object";
 };
 
+/**
+ * Type representing a relation definition schema.
+ * 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.
+ */
 export type RelationDefinitionRawSchema<
   ESchemas extends EntityRawSchemaArray,
   Final extends boolean = boolean
@@ -187,36 +149,9 @@ export type RelationDefinitionRawSchema<
       })
 >;
 
+/**
+ * Type representing a list of relation definitions.
+ */
 export type RelationDefinitionRawSchemaArray<
   ESchemas extends EntityRawSchemaArray
 > = ReadonlyArray<RelationDefinitionRawSchema<ESchemas, boolean>>;
-
-export type RawSchema<
-  E extends EntityRawSchemaArray = EntityRawSchemaArray,
-  R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>
-> = {
-  entities: E;
-  relations_definitions: R;
-};
-
-export type IsLooseSchema<E extends EntityRawSchemaArray> =
-  string 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 type EntityRawSchemaByType<
-  E extends EntityRawSchemaArray,
-  T extends string
-> = E[number] extends infer ESchema
-  ? ESchema extends { type: T }
-    ? ESchema
-    : never
-  : never; // Will never happen E[number] always has a type

package/src/schema/raw/Schema.ts

@@ -0,0 +1,16 @@
+import { EntityRawSchemaArray } from "./Entities";
+import { RelationDefinitionRawSchemaArray } from "./RelationDefinitions";
+
+/**
+ * The full raw JSON schema type as returned by the API.
+ * You can export this schema from your CubicWeb instance using the command:
+ *
+ * `cubicweb-ctl export-schema -f typescript <YOUR_INSTANCE_NAME>`
+ */
+export type RawSchema<
+  E extends EntityRawSchemaArray = EntityRawSchemaArray,
+  R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>
+> = {
+  entities: E;
+  relations_definitions: R;
+};

package/src/schema/raw/Utils.ts

@@ -0,0 +1,33 @@
+import { EntityRawSchemaArray } from "./Entities";
+
+/**
+ * Type used to check if a schema is loosely typed.
+ * Use this to create conditional types.
+ *
+ * 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 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 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 type EntityRawSchemaByType<
+  E extends EntityRawSchemaArray,
+  T extends string
+> = E[number] extends infer ESchema
+  ? ESchema extends { type: T }
+    ? ESchema
+    : never
+  : never; // Will never happen E[number] always has a type

package/lib/schema/Schema.d.ts

@@ -1,156 +0,0 @@
-import { Cardinality } from "..";
-import { RawSchema, RelationDefinitionRawSchema, RelationDefinitionRawSchemaArray, EntityRawSchemaArray, EntityRawSchemaByType, IsLooseSchema, IsETypeInStrictSchema } from "./SchemaJSON";
-declare const rawSchemaKey: unique symbol;
-/**
- * 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
- */
-export declare const getLooseSchema: <E extends EntityRawSchemaArray = EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>>(schema: Schema<E, R>) => Schema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>>;
-/**
- * Wrapper around the raw JSON Schema
- */
-export declare class Schema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
-R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>> {
-    [rawSchemaKey]: RawSchema<E, R>;
-    constructor(rawSchema: RawSchema<E, R>);
-    get entities(): EntitySchema<E, R, E[number]>[];
-    get relationsDefinitions(): RelationDefinitionSchema<E, R, R[number]>[];
-    /**
-     * 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<EType extends string>(entityType: EType): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> | null : IsETypeInStrictSchema<E, EType> extends true ? EntitySchema<E, R, EntityRawSchemaByType<E, EType>> : null;
-    /**
-     * Finds relations in the Schema matching the partial relation given
-     *
-     * @param matcher Partial relation definition to match against
-     * @returns Matched relation schema classes
-     */
-    matchRelationDefinitions<M extends RelationDefinitionMatcher<E>>(matcher: M): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
-        subject: E[number]["type"];
-    }>>[];
-}
-/**
- * Wrapper around raw entities from the Schema
- */
-export declare class EntitySchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
-R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>, // List of all relation defintions
-ERawSchema extends E[number] = E[number]> {
-    private schema;
-    private entityRawSchema;
-    constructor(schema: Schema<E, R>, entityRawSchema: ERawSchema);
-    /**
-     * The type of the entity. This can also be referred to as the entity' name.
-     */
-    get type(): ERawSchema["type"];
-    /**
-     * A short description which can be used as documentation for the entity.
-     */
-    get description(): ERawSchema["description"];
-    /**
-     * True if the current entity is a primitive type such as string or int
-     */
-    get final(): ERawSchema["final"];
-    /**
-     * Gets the list of relation definitions with this entity as subject
-     */
-    get subjectRelationDefinitions(): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
-        subject: ERawSchema["type"];
-        final: false;
-    }>>[];
-    /**
-     * Gets the list of relation definitions with this entity as object
-     */
-    get objectRelationsDefinitions(): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
-        object: ERawSchema["type"];
-        final: false;
-    }>>[];
-    /**
-     * Finds relations in the Schema matching the partial relation given
-     *
-     * @param matcher Partial relation definition to match against
-     * @returns Matched relation schema classes
-     */
-    matchRelationDefinitions<M extends RelationDefinitionMatcher<E>>(matcher: M): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
-        subject: ERawSchema["type"];
-    }>>[];
-    /**
-     * Gets the list of attributes names for this entity
-     */
-    get attributes(): RelationDefinitionSchema<E, R, MatchedRelationDefinition<E, R, {
-        subject: ERawSchema["type"];
-        final: true;
-    }>>[];
-}
-/**
- * Wrapper around raw relation definitions from the Schema
- */
-export declare class RelationDefinitionSchema<E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
-R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E>, // List of all relation defintions
-RDef extends R[number] = R[number]> {
-    private schema;
-    private relDef;
-    constructor(schema: Schema<E, R>, relDef: RDef);
-    /**
-     * The type of the relation. This can also be referred to as the relation's name.
-     */
-    get type(): RDef["type"];
-    /**
-     * A short description which can be used as documentation for the relation.
-     */
-    get description(): RDef["description"];
-    /**
-     * True if the object of the relation is a primitive type.
-     * In this case the relation iscalled an "attribute"
-     */
-    get final(): RDef["final"];
-    /**
-     * The list of options set for this relation
-     */
-    get options(): RDef["options"];
-    /**
-     * The list of constraints if any. Only attributes (relations with final = true) have constraints.
-     * In other cases this returns null.
-     */
-    get constraints(): RDef["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(): RDef extends {
-        default: infer V;
-    } ? V : undefined;
-    get cardinality(): RDef["cardinality"];
-    get subjectCardinality(): Cardinality;
-    get objectCardinality(): Cardinality;
-    /**
-     * Gets the entity associated to this relation's subject
-     *
-     * @throws InconsistentSchemaError if the relation's subject is not a valid entity
-     */
-    get subject(): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> : EntitySchema<E, R, EntityRawSchemaByType<E, RDef["subject"]>>;
-    /**
-     * Gets the entity associated to this relation's object
-     *
-     * @throws InconsistentSchemaError if the relation's object is not a valid entity
-     */
-    get object(): IsLooseSchema<E> extends true ? EntitySchema<E, R, E[number]> : EntitySchema<E, R, EntityRawSchemaByType<E, RDef["object"]>>;
-    /**
-     * Checks if the relation is required when using the subject or object pointof view
-     *
-     * @param role The point of view to use
-     * @returns
-     */
-    isRequired(role: "subject" | "object"): boolean;
-}
-export declare type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<RelationDefinitionRawSchema<E>>;
-export declare type MatchedRelationDefinition<E extends EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<EntityRawSchemaArray>, M extends RelationDefinitionMatcher<E>> = R[number] extends infer RDef ? (RDef extends M ? RDef : never) : never;
-export {};
-//# sourceMappingURL=Schema.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/schema/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAEjC,OAAO,EACL,SAAS,EACT,2BAA2B,EAC3B,gCAAgC,EAChC,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACtB,MAAM,cAAc,CAAC;AAEtB,QAAA,MAAM,YAAY,EAAE,OAAO,MAA2C,CAAC;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,4PAO1B,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAM,CACjB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC;IAEnF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAEpB,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IAItC,IAAI,QAAQ,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAI9C;IAED,IAAI,oBAAoB,IAAI,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAItE;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,SAAS,MAAM,EAC5B,UAAU,EAAE,KAAK,GAChB,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GAC5B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,GACpC,qBAAqB,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,IAAI,GAC5C,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GACnD,IAAI;IAoBR;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,EAC7D,OAAO,EAAE,CAAC,GACT,wBAAwB,CACzB,CAAC,EACD,CAAC,EACD,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAChE,EAAE;CAmBJ;AAED;;GAEG;AACH,qBAAa,YAAY,CACvB,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAAE,kCAAkC;AACvH,UAAU,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAGtC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,eAAe;gBADf,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,eAAe,EAAE,UAAU;IAGrC;;OAEG;IACH,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC,CAE7B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,UAAU,CAAC,aAAa,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,UAAU,CAAC,OAAO,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,0BAA0B,IAAI,wBAAwB,CACxD,CAAC,EACD,CAAC,EACD,yBAAyB,CACvB,CAAC,EACD,CAAC,EACD;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAC9C,CACF,EAAE,CAKF;IAED;;OAEG;IACH,IAAI,0BAA0B,IAAI,wBAAwB,CACxD,CAAC,EACD,CAAC,EACD,yBAAyB,CACvB,CAAC,EACD,CAAC,EACD;QAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAC7C,CACF,EAAE,CAKF;IAED;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,EAC7D,OAAO,EAAE,CAAC,GACT,wBAAwB,CACzB,CAAC,EACD,CAAC,EACD,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CACjE,EAAE;IAIH;;OAEG;IACH,IAAI,UAAU,IAAI,wBAAwB,CACxC,CAAC,EACD,CAAC,EACD,yBAAyB,CACvB,CAAC,EACD,CAAC,EACD;QAAE,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,CAC7C,CACF,EAAE,CAKF;CACF;AAED;;GAEG;AACH,qBAAa,wBAAwB,CACnC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,uBAAuB;AAC9E,CAAC,SAAS,gCAAgC,CAAC,CAAC,CAAC,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAAE,kCAAkC;AACvH,IAAI,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IAEtB,OAAO,CAAC,MAAM;IAAgB,OAAO,CAAC,MAAM;gBAApC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAU,MAAM,EAAE,IAAI;IAE9D;;OAEG;IACH,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,CAEvB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,CAEzB;IACD;;OAEG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAE7B;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,IAAI,SAAS;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,CAAC,GAAG,SAAS,CAM/D;IAED,IAAI,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,CAErC;IAED,IAAI,kBAAkB,IAAI,WAAW,CAEpC;IAED,IAAI,iBAAiB,IAAI,WAAW,CAEnC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GACxC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAC7B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAUhE;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GACvC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAC7B,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAU/D;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,QAAQ;CAStC;AAYD,oBAAY,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF,oBAAY,yBAAyB,CACnC,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,gCAAgC,CAAC,oBAAoB,CAAC,EAChE,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,IACpC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC"}

package/lib/schema/Schema.js

@@ -1,246 +0,0 @@
-"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 relations in the Schema matching the partial relation given
-     *
-     * @param matcher Partial relation definition to match against
-     * @returns Matched relation schema classes
-     */
-    matchRelationDefinitions(matcher) {
-        return this.schema.matchRelationDefinitions(matcher);
-    }
-    /**
-     * Gets the list of attributes names for this entity
-     */
-    get attributes() {
-        return this.schema.matchRelationDefinitions({
-            final: true,
-            subject: this.type,
-        });
-    }
-}
-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 options set for this relation
-     */
-    get options() {
-        return this.relDef.options;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * Checks if the relation is required when using the subject or object pointof view
-     *
-     * @param role The point of view to use
-     * @returns
-     */
-    isRequired(role) {
-        let cardinality;
-        if (role === "subject") {
-            cardinality = this.cardinality[0];
-        }
-        else {
-            cardinality = this.cardinality[1];
-        }
-        return cardinalityRequired(cardinality);
-    }
-}
-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

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/schema/Schema.ts"],"names":[],"mappings":";;;AACA,sCAAoD;AAWpD,MAAM,YAAY,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAEvE;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAA2B,CAAC;AACrC,CAAC,CAAC;AAPW,QAAA,cAAc,kBAOzB;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;QAS5B,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;QAS5B,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,MAAM,EAAE,IAAI,CAAC,IAAI;YACjB,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,OAAU;QAMV,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QASZ,OAAO,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC;YAC1C,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;CACF;AApGD,oCAoGC;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;IACD;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,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;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAA0B;QACnC,IAAI,WAAwB,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;SAClD;aAAM;YACL,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAgB,CAAC;SAClD;QACD,OAAO,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC1C,CAAC;CACF;AAxHD,4DAwHC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,WAAwB;IACnD,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC"}