@cubicweb/client 1.2.2 → 1.5.0

package/lib/schema/SchemaJSON.d.ts

@@ -1,121 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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.map

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

package/src/schema/Schema.ts

@@ -1,352 +0,0 @@
-import { Cardinality } from "..";
-import { InconsistentSchemaError } from "../Errors";
-import {
-  RawSchema,
-  RelationDefinitionRawSchema,
-  RelationDefinitionRawSchemaArray,
-  EntityRawSchemaArray,
-  EntityRawSchemaByType,
-  IsLooseSchema,
-  IsETypeInStrictSchema,
-} from "./SchemaJSON";
-
-const rawSchemaKey: unique symbol = 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
- */
-export const getLooseSchema = <
-  E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
-  R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E> // List of all relation defintions
->(
-  schema: Schema<E, R>
-) => {
-  return schema as unknown as Schema<
-    EntityRawSchemaArray,
-    RelationDefinitionRawSchemaArray<EntityRawSchemaArray>
-  >;
-};
-
-/**
- * Wrapper around the raw JSON Schema
- */
-export class Schema<
-  E extends EntityRawSchemaArray = EntityRawSchemaArray, // List of all entities
-  R extends RelationDefinitionRawSchemaArray<E> = RelationDefinitionRawSchemaArray<E> // List of all relation defintions
-> {
-  [rawSchemaKey]: RawSchema<E, R>;
-
-  constructor(rawSchema: RawSchema<E, R>) {
-    this[rawSchemaKey] = rawSchema;
-  }
-
-  get entities(): EntitySchema<E, R, E[number]>[] {
-    return this[rawSchemaKey].entities.map(
-      (eSchema) => new EntitySchema(this, eSchema)
-    );
-  }
-
-  get relationsDefinitions(): RelationDefinitionSchema<E, R, R[number]>[] {
-    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<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 {
-    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<E, R, E[number]>(
-      this,
-      entityRawSchema as EntityRawSchemaByType<E, EType>
-    );
-  }
-
-  /**
-   * 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"] }>
-  >[] {
-    const matchArray = this[rawSchemaKey].relations_definitions.filter(
-      (relDef) => {
-        for (const key of Object.keys(
-          matcher
-        ) as (keyof RelationDefinitionRawSchema<E>)[]) {
-          if (matcher[key] !== relDef[key]) {
-            return false;
-          }
-        }
-        return true;
-      }
-    ) as MatchedRelationDefinition<
-      E,
-      R,
-      MatchedRelationDefinition<E, R, { subject: E[number]["type"] }>
-    >[];
-    return matchArray.map((m) => new RelationDefinitionSchema(this, m));
-  }
-}
-
-/**
- * Wrapper around raw entities from the Schema
- */
-export 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] // JSON of the represented entity
-> {
-  constructor(
-    private schema: Schema<E, R>,
-    private entityRawSchema: ERawSchema
-  ) {}
-
-  /**
-   * The type of the entity. This can also be referred to as the entity' name.
-   */
-  get type(): ERawSchema["type"] {
-    return this.entityRawSchema.type;
-  }
-
-  /**
-   * A short description which can be used as documentation for the entity.
-   */
-  get description(): ERawSchema["description"] {
-    return this.entityRawSchema.description;
-  }
-
-  /**
-   * True if the current entity is a primitive type such as string or int
-   */
-  get final(): ERawSchema["final"] {
-    return this.entityRawSchema.final;
-  }
-
-  /**
-   * Gets the list of relation definitions with this entity as subject
-   */
-  get subjectRelationDefinitions(): RelationDefinitionSchema<
-    E,
-    R,
-    MatchedRelationDefinition<E, R, { subject: ERawSchema["type"] }>
-  >[] {
-    return this.schema.matchRelationDefinitions({
-      subject: this.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"] }>
-  >[] {
-    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<M extends RelationDefinitionMatcher<E>>(
-    matcher: M
-  ): RelationDefinitionSchema<
-    E,
-    R,
-    MatchedRelationDefinition<E, R, { subject: ERawSchema["type"] }>
-  >[] {
-    return this.schema.matchRelationDefinitions(matcher);
-  }
-
-  /**
-   * Gets the list of attributes names for this entity
-   */
-  get attributes(): RelationDefinitionSchema<E, R, R[number]>[] {
-    return this.schema.matchRelationDefinitions({
-      final: true,
-      subject: this.type,
-    });
-  }
-}
-
-/**
- * Wrapper around raw relation definitions from the Schema
- */
-export 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] // JSON of the represented relation definition
-> {
-  constructor(private schema: Schema<E, R>, private relDef: RDef) {}
-
-  /**
-   * The type of the relation. This can also be referred to as the relation's name.
-   */
-  get type(): RDef["type"] {
-    return this.relDef.type;
-  }
-
-  /**
-   * A short description which can be used as documentation for the relation.
-   */
-  get description(): RDef["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(): RDef["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(): RDef["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(): RDef extends { default: infer V } ? V : undefined {
-    type Default = RDef extends { default: infer V } ? V : undefined;
-
-    return (
-      "default" in this.relDef ? this.relDef.default : undefined
-    ) as Default;
-  }
-
-  get cardinality(): RDef["cardinality"] {
-    return this.relDef.cardinality;
-  }
-
-  get subjectCardinality(): Cardinality {
-    return this.relDef.cardinality[0] as Cardinality;
-  }
-
-  get objectCardinality(): Cardinality {
-    return this.relDef.cardinality[1] as 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"]>> {
-    const subjectSchema = this.schema.getEntity(this.relDef.subject);
-    if (subjectSchema === null) {
-      throw new 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(): IsLooseSchema<E> extends true
-    ? EntitySchema<E, R, E[number]>
-    : EntitySchema<E, R, EntityRawSchemaByType<E, RDef["object"]>> {
-    const objectSchema = this.schema.getEntity(this.relDef.object);
-    if (objectSchema === null) {
-      throw new 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: "subject" | "object") {
-    let cardinality: Cardinality;
-    if (role === "subject") {
-      cardinality = this.cardinality[0] as Cardinality;
-    } else {
-      cardinality = this.cardinality[1] as Cardinality;
-    }
-    return cardinalityRequired(cardinality);
-  }
-}
-
-/**
- * Checks if the given cardinality requires at least one entity to be present
- *
- * @param cardinality The cardinality to check
- * @returns
- */
-function cardinalityRequired(cardinality: Cardinality): boolean {
-  return cardinality === "1" || cardinality === "+";
-}
-
-export type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<
-  RelationDefinitionRawSchema<E>
->;
-
-export type MatchedRelationDefinition<
-  E extends EntityRawSchemaArray,
-  R extends RelationDefinitionRawSchemaArray<EntityRawSchemaArray>,
-  M extends RelationDefinitionMatcher<E>
-> = R[number] extends infer RDef ? (RDef extends M ? RDef : never) : never;

package/src/schema/SchemaJSON.ts

@@ -1,195 +0,0 @@
-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 }
->;
-
-export type FormatConstraint = ConstraintBase<
-  "FormatConstraint",
-  {
-    values: ["text/rest", "text/markdown", "text/html", "text/plain"];
-    msg: ConstraintMessage;
-  }
->;
-
-export type Constraint = Readonly<
-  | UniqueConstraint
-  | SizeConstraint
-  | RegexpConstraint
-  | BoundaryConstraint
-  | IntervalBoundConstraint
-  | StaticVocabularyConstraint
-  | FormatConstraint
->;
-
-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 type BuildObj = Readonly<
-  | StringBuildObj
-  | PasswordBuildObj
-  | BytesBuildObj
-  | IntBuildObj
-  | BigIntBuildObj
-  | FloatBuildObj
-  | BooleanBuildObj
-  | DecimalBuildObj
-  | DateBuildObj
-  | TimeBuildObj
-  | DatetimeBuildObj
-  | TZTimeBuildObj
-  | TZDatetimeBuildObj
-  | IntervalBuildObj
->;
-
-export type Cardinality = "*" | "1" | "?" | "+";
-
-export type CardinalityPair = `${Cardinality}${Cardinality}`;
-
-export type EntityRawSchema = {
-  type: string;
-  final: boolean;
-  description: string;
-};
-
-export type EntityRawSchemaArray = ReadonlyArray<EntityRawSchema>;
-
-export 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 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