@tsed/objection 8.11.0 → 8.11.2-rc.1

package/src/decorators/belongsToOne.spec.ts

@@ -1,138 +0,0 @@
-import {Model} from "objection";
-
-import {BelongsToOne} from "./belongsToOne.js";
-import {Entity} from "./entity.js";
-import {IdColumn} from "./idColumn.js";
-
-describe("@BelongsToOne", () => {
-  it("should set metadata", () => {
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-    }
-
-    @Entity("movie")
-    class Movie extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-      @BelongsToOne()
-      user?: User;
-    }
-    expect(Movie.relationMappings).toEqual({
-      user: {
-        relation: Model.BelongsToOneRelation,
-        modelClass: User,
-        join: {
-          from: "movie.userId",
-          to: "user.id"
-        }
-      }
-    });
-  });
-  it("should set custom relationship path", () => {
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-    }
-    @Entity("movie")
-    class Movie extends Model {
-      @IdColumn()
-      id!: string;
-      ownerId!: string;
-      @BelongsToOne({from: "ownerId", to: "userId"})
-      user?: User;
-    }
-    expect(Movie.relationMappings).toEqual({
-      user: {
-        relation: Model.BelongsToOneRelation,
-        modelClass: User,
-        join: {
-          from: "movie.ownerId",
-          to: "user.userId"
-        }
-      }
-    });
-  });
-  it("should set custom relationship model", () => {
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-    }
-    @Entity("movie")
-    class Movie extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-      @BelongsToOne(() => User)
-      user?: User;
-    }
-    expect(Movie.relationMappings).toEqual({
-      user: {
-        relation: Model.BelongsToOneRelation,
-        modelClass: User,
-        join: {
-          from: "movie.userId",
-          to: "user.id"
-        }
-      }
-    });
-  });
-
-  it("should set custom relationship model and relationship path", () => {
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-    }
-    @Entity("movie")
-    class Movie extends Model {
-      @IdColumn()
-      id!: string;
-      ownerId!: string;
-      @BelongsToOne(() => User, {from: "ownerId", to: "userId"})
-      user?: User;
-    }
-    expect(Movie.relationMappings).toEqual({
-      user: {
-        relation: Model.BelongsToOneRelation,
-        modelClass: User,
-        join: {
-          from: "movie.ownerId",
-          to: "user.userId"
-        }
-      }
-    });
-  });
-  it("should work when options supplied as 2nd argument without first provided", () => {
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-    }
-    @Entity("movie")
-    class Movie extends Model {
-      @IdColumn()
-      id!: string;
-      ownerId!: string;
-      @BelongsToOne(undefined, {from: "ownerId", to: "userId"})
-      user?: User;
-    }
-    expect(Movie.relationMappings).toEqual({
-      user: {
-        relation: Model.BelongsToOneRelation,
-        modelClass: User,
-        join: {
-          from: "movie.ownerId",
-          to: "user.userId"
-        }
-      }
-    });
-  });
-});

package/src/decorators/belongsToOne.ts

@@ -1,53 +0,0 @@
-import {Model, ModelClassSpecifier} from "objection";
-
-import {isModelClassSpecifier, RelationshipOpts, RelationshipOptsWithoutThrough} from "../domain/RelationshipOpts.js";
-import {RelatesTo} from "./relatesTo.js";
-
-/**
- *
- * @param type
- * @decorator
- * @objection
- */
-export function BelongsToOne(type?: ModelClassSpecifier): PropertyDecorator;
-/**
- *
- * @param opts
- * @decorator
- * @objection
- */
-export function BelongsToOne(opts?: RelationshipOptsWithoutThrough): PropertyDecorator;
-/**
- *
- * @param opts
- * @param type
- * @decorator
- * @objection
- */
-export function BelongsToOne(type?: ModelClassSpecifier, opts?: RelationshipOptsWithoutThrough): PropertyDecorator;
-/**
- *
- * @param typeOrOpts
- * @param opts
- * @decorator
- * @objection
- */
-export function BelongsToOne(
-  typeOrOpts?: ModelClassSpecifier | RelationshipOptsWithoutThrough,
-  opts?: RelationshipOptsWithoutThrough
-): PropertyDecorator {
-  // For backwards compatibility
-  if (!typeOrOpts && !opts) return RelatesTo(Model.BelongsToOneRelation, undefined);
-  if (!typeOrOpts && opts) {
-    typeOrOpts = opts;
-    opts = undefined;
-  }
-
-  const options: RelationshipOpts | undefined = isModelClassSpecifier(typeOrOpts)
-    ? opts
-      ? {...opts, type: typeOrOpts}
-      : {type: typeOrOpts}
-    : typeOrOpts;
-
-  return RelatesTo(Model.BelongsToOneRelation, options);
-}

package/src/decorators/columnOptions.ts

@@ -1,13 +0,0 @@
-import {StoreSet} from "@tsed/core";
-
-import type {ColumnOpts} from "../domain/ColumnOpts.js";
-
-/**
- *
- * @param options
- * @decorator
- * @objection
- */
-export function ColumnOptions(options: Partial<ColumnOpts>): PropertyDecorator {
-  return StoreSet("objection", options) as any;
-}

package/src/decorators/decimal.spec.ts

@@ -1,52 +0,0 @@
-import {Store} from "@tsed/core";
-import {getJsonSchema} from "@tsed/schema";
-
-import {Decimal} from "./decimal.js";
-
-describe("@Decimal", () => {
-  it("should set metadata", () => {
-    class MyModel {
-      @Decimal({scale: 1, precision: 12})
-      prop: number;
-    }
-
-    expect(getJsonSchema(MyModel)).toEqual({
-      properties: {
-        prop: {
-          type: "number"
-        }
-      },
-      type: "object"
-    });
-    expect(Store.from(MyModel, "prop").get("objection")).toEqual({
-      columnType: "number",
-      options: {
-        precision: 12,
-        scale: 1,
-        type: "decimal"
-      }
-    });
-  });
-
-  it("should set metadata (without options)", () => {
-    class MyModel {
-      @Decimal()
-      prop: number;
-    }
-
-    expect(getJsonSchema(MyModel)).toEqual({
-      properties: {
-        prop: {
-          type: "number"
-        }
-      },
-      type: "object"
-    });
-    expect(Store.from(MyModel, "prop").get("objection")).toEqual({
-      columnType: "number",
-      options: {
-        type: "decimal"
-      }
-    });
-  });
-});

package/src/decorators/decimal.ts

@@ -1,35 +0,0 @@
-import {StoreSet, useDecorators} from "@tsed/core";
-import {Property} from "@tsed/schema";
-
-import {ColumnOptions} from "./columnOptions.js";
-
-export interface DecimalOptions {
-  precision?: number | null;
-  scale?: number;
-}
-
-/**
- *
- * @param options
- * @decorator
- * @objection
- */
-export function Decimal(options: DecimalOptions = {}) {
-  return useDecorators(
-    Property(),
-    ColumnOptions({
-      columnType: "number",
-      options: {
-        type: "decimal",
-        ...options
-      }
-    }),
-    StoreSet("objection", {
-      columnType: "number",
-      options: {
-        type: "decimal",
-        ...options
-      }
-    })
-  );
-}

package/src/decorators/entity.spec.ts

@@ -1,24 +0,0 @@
-import {Entity} from "./entity.js";
-
-describe("@Entity", () => {
-  it("should set metadata", () => {
-    @Entity("models")
-    class MyModel {}
-
-    expect((MyModel as any).jsonSchema).toEqual({
-      type: "object"
-    });
-    expect((MyModel as any).tableName).toEqual("models");
-  });
-
-  it("should throw metadata when the tableName is empty", () => {
-    let actualError: any;
-    try {
-      @Entity("")
-      class MyModel {}
-    } catch (er) {
-      actualError = er;
-    }
-    expect(actualError.message).toEqual("Please provide a table name");
-  });
-});

package/src/decorators/entity.ts

@@ -1,29 +0,0 @@
-import {Type} from "@tsed/core";
-import {getJsonSchema} from "@tsed/schema";
-
-import {defineStaticGetter} from "../utils/defineStaticGetter.js";
-import {getJsonEntityRelationships} from "../utils/getJsonEntityRelationships.js";
-
-/**
- *
- * @param tableName
- * @decorator
- * @objection
- */
-export function Entity(tableName: string): ClassDecorator {
-  if (!tableName) {
-    throw new Error("Please provide a table name");
-  }
-
-  return (target: any) => {
-    const originalRelationMappings = target["relationMappings"];
-    defineStaticGetter(target, "tableName", () => tableName);
-    defineStaticGetter(target, "jsonSchema", () => getJsonSchema(target));
-    defineStaticGetter(target, "relationMappings", () => originalRelationMappings || getJsonEntityRelationships(target));
-    return target;
-  };
-}
-
-export interface EntityMethods<T> extends Type<T> {
-  readonly tableName: string;
-}

package/src/decorators/hasMany.spec.ts

@@ -1,60 +0,0 @@
-import {Model} from "objection";
-
-import {Entity} from "./entity.js";
-import {HasMany} from "./hasMany.js";
-import {IdColumn} from "./idColumn.js";
-
-describe("@HasMany", () => {
-  it("should set metadata", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      userId?: string;
-    }
-
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      @HasMany(Pet)
-      pets?: Pet[];
-    }
-    expect(User.relationMappings).toEqual({
-      pets: {
-        relation: Model.HasManyRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.id",
-          to: "pet.userId"
-        }
-      }
-    });
-  });
-  it("should set custom relationship path", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      ownerId?: string;
-    }
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-      @HasMany(Pet, {from: "userId", to: "ownerId"})
-      pets?: Pet[];
-    }
-    expect(User.relationMappings).toEqual({
-      pets: {
-        relation: Model.HasManyRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.userId",
-          to: "pet.ownerId"
-        }
-      }
-    });
-  });
-});

package/src/decorators/hasMany.ts

@@ -1,14 +0,0 @@
-import {Model, ModelClassSpecifier} from "objection";
-
-import {RelationshipOptsWithThrough} from "../domain/RelationshipOpts.js";
-import {RelatesTo} from "./relatesTo.js";
-
-/**
- *
- * @param opts
- * @decorator
- * @objection
- */
-export function HasMany(type: ModelClassSpecifier, opts?: RelationshipOptsWithThrough): PropertyDecorator {
-  return RelatesTo(Model.HasManyRelation, {...opts, type});
-}

package/src/decorators/hasOne.spec.ts

@@ -1,60 +0,0 @@
-import {Model} from "objection";
-
-import {Entity} from "./entity.js";
-import {HasOne} from "./hasOne.js";
-import {IdColumn} from "./idColumn.js";
-
-describe("@HasOne", () => {
-  it("should set metadata", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      userId?: string;
-    }
-
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      @HasOne()
-      pet?: Pet;
-    }
-    expect(User.relationMappings).toEqual({
-      pet: {
-        relation: Model.HasOneRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.id",
-          to: "pet.userId"
-        }
-      }
-    });
-  });
-  it("should set custom relationship path", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      ownerId?: string;
-    }
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-      @HasOne({from: "userId", to: "ownerId"})
-      pet?: Pet;
-    }
-    expect(User.relationMappings).toEqual({
-      pet: {
-        relation: Model.HasOneRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.userId",
-          to: "pet.ownerId"
-        }
-      }
-    });
-  });
-});

package/src/decorators/hasOne.ts

@@ -1,14 +0,0 @@
-import {Model} from "objection";
-
-import {RelationshipOptsWithoutThrough} from "../domain/RelationshipOpts.js";
-import {RelatesTo} from "./relatesTo.js";
-
-/**
- *
- * @param opts
- * @decorator
- * @objection
- */
-export function HasOne(opts?: RelationshipOptsWithoutThrough): PropertyDecorator {
-  return RelatesTo(Model.HasOneRelation, opts);
-}

package/src/decorators/hasOneThroughRelation.spec.ts

@@ -1,72 +0,0 @@
-import {Model} from "objection";
-
-import {Entity} from "./entity.js";
-import {HasOneThroughRelation} from "./hasOneThroughRelation.js";
-import {IdColumn} from "./idColumn.js";
-
-describe("@HasOneThroughRelation", () => {
-  it("should set metadata", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      userId?: string;
-    }
-
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      @HasOneThroughRelation()
-      pet?: Pet;
-    }
-    expect(User.relationMappings).toEqual({
-      pet: {
-        relation: Model.HasOneThroughRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.id",
-          through: {
-            from: "user_pet.userId",
-            to: "user_pet.petId"
-          },
-          to: "pet.id"
-        }
-      }
-    });
-  });
-  it("should set custom relationship path", () => {
-    @Entity("pet")
-    class Pet extends Model {
-      @IdColumn()
-      id!: string;
-      petId?: string;
-    }
-    @Entity("user")
-    class User extends Model {
-      @IdColumn()
-      id!: string;
-      userId!: string;
-      @HasOneThroughRelation({
-        from: "userId",
-        through: {from: "user_pet.ownerId", to: "user_pet.petId"},
-        to: "petId"
-      })
-      pet?: Pet;
-    }
-    expect(User.relationMappings).toEqual({
-      pet: {
-        relation: Model.HasOneThroughRelation,
-        modelClass: Pet,
-        join: {
-          from: "user.userId",
-          through: {
-            from: "user_pet.ownerId",
-            to: "user_pet.petId"
-          },
-          to: "pet.petId"
-        }
-      }
-    });
-  });
-});

package/src/decorators/hasOneThroughRelation.ts

@@ -1,14 +0,0 @@
-import {Model} from "objection";
-
-import {RelationshipOptsWithoutThrough, RelationshipOptsWithThrough} from "../domain/RelationshipOpts.js";
-import {RelatesTo} from "./relatesTo.js";
-
-/**
- *
- * @param opts
- * @decorator
- * @objection
- */
-export function HasOneThroughRelation(opts?: RelationshipOptsWithThrough): PropertyDecorator {
-  return RelatesTo(Model.HasOneThroughRelation, opts);
-}

package/src/decorators/idColumn.spec.ts

@@ -1,31 +0,0 @@
-import {Store} from "@tsed/core";
-import {getJsonSchema} from "@tsed/schema";
-import {Model} from "objection";
-
-import {IdColumn} from "./idColumn.js";
-
-describe("@IdColumn", () => {
-  it("should set metadata", () => {
-    class MyModel extends Model {
-      @IdColumn()
-      id: number;
-    }
-
-    expect(getJsonSchema(MyModel)).toEqual({
-      properties: {
-        id: {
-          type: "number"
-        }
-      },
-      type: "object"
-    });
-    expect(Store.from(MyModel, "id").get("objection")).toEqual({
-      columnType: "idColumn",
-      options: {
-        type: "increments"
-      }
-    });
-
-    expect(MyModel.idColumn).toEqual("id");
-  });
-});

package/src/decorators/idColumn.ts

@@ -1,26 +0,0 @@
-import {useDecorators} from "@tsed/core";
-import {Property} from "@tsed/schema";
-
-import {defineStaticGetter} from "../utils/defineStaticGetter.js";
-import {ColumnOptions} from "./columnOptions.js";
-
-/**
- *
- * @param type
- * @decorator
- * @objection
- */
-export function IdColumn(type: "uuid" | "increments" | "bigIncrements" = "increments"): PropertyDecorator {
-  return useDecorators(
-    Property(),
-    ColumnOptions({
-      columnType: "idColumn",
-      options: {
-        type
-      }
-    }),
-    (target: any, propertyKey: string) => {
-      defineStaticGetter(target, "idColumn", () => propertyKey);
-    }
-  );
-}