@tsed/objection 7.79.4 → 7.80.0

package/lib/esm/utils/createColumns.js

@@ -1,8 +1,8 @@
 import { getProperties } from "@tsed/schema";
-import "../components/createBooleanColumn.js";
-import "../components/createIdColumn.js";
-import "../components/createNumberColumn.js";
-import "../components/createStringColumn.js";
+import "../components/createBooleanColumn";
+import "../components/createIdColumn";
+import "../components/createNumberColumn";
+import "../components/createStringColumn";
 import { ColumnTypesContainer } from "../services/ColumnTypesContainer.js";
 import { getColumnCtx } from "./getColumnCtx.js";
 /**

package/lib/types-esm/components/createBooleanColumn.d.ts

@@ -0,0 +1,6 @@
+import type { Knex } from "knex";
+import { ColumnCtx } from "../utils/getColumnCtx.js";
+/**
+ * @ignore
+ */
+export declare function createBooleanColumn(table: Knex.TableBuilder, { entity }: ColumnCtx): void;

package/lib/types-esm/components/createIdColumn.d.ts

@@ -0,0 +1,6 @@
+import { ColumnCtx } from "../utils/getColumnCtx.js";
+import type { Knex } from "knex";
+/**
+ * @ignore
+ */
+export declare function createIdColumn(table: Knex.TableBuilder, { entity, options }: ColumnCtx): void;

package/lib/types-esm/components/createNumberColumn.d.ts

@@ -0,0 +1,6 @@
+import type { Knex } from "knex";
+import { ColumnCtx } from "../utils/getColumnCtx.js";
+/**
+ * @ignore
+ */
+export declare function createNumberColumn(table: Knex.TableBuilder, { entity, options }: ColumnCtx): void;

package/lib/types-esm/components/createStringColumn.d.ts

@@ -0,0 +1,6 @@
+import type { Knex } from "knex";
+import { ColumnCtx } from "../utils/getColumnCtx.js";
+/**
+ * @ignore
+ */
+export declare function createStringColumn(table: Knex.TableBuilder, { entity, schema }: ColumnCtx): void;

package/lib/types-esm/decorators/belongsToOne.d.ts

@@ -0,0 +1,8 @@
+import { RelationshipOptsWithoutThrough } from "../domain/RelationshipOpts.js";
+/**
+ *
+ * @param opts
+ * @decorator
+ * @objection
+ */
+export declare function BelongsToOne(opts?: RelationshipOptsWithoutThrough): PropertyDecorator;

package/lib/types-esm/decorators/columnOptions.d.ts

@@ -0,0 +1,8 @@
+import type { ColumnOpts } from "../domain/ColumnOpts.js";
+/**
+ *
+ * @param options
+ * @decorator
+ * @objection
+ */
+export declare function ColumnOptions(options: Partial<ColumnOpts>): PropertyDecorator;

package/lib/types-esm/decorators/decimal.d.ts

@@ -0,0 +1,11 @@
+export interface DecimalOptions {
+    precision?: number | null;
+    scale?: number;
+}
+/**
+ *
+ * @param options
+ * @decorator
+ * @objection
+ */
+export declare function Decimal(options?: DecimalOptions): any;

package/lib/types-esm/decorators/entity.d.ts

@@ -0,0 +1,11 @@
+import { Type } from "@tsed/core";
+/**
+ *
+ * @param tableName
+ * @decorator
+ * @objection
+ */
+export declare function Entity(tableName: string): ClassDecorator;
+export interface EntityMethods<T> extends Type<T> {
+    readonly tableName: string;
+}

package/lib/types-esm/decorators/hasMany.d.ts

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

package/lib/types-esm/decorators/hasOne.d.ts

@@ -0,0 +1,8 @@
+import { RelationshipOptsWithoutThrough } from "../domain/RelationshipOpts.js";
+/**
+ *
+ * @param opts
+ * @decorator
+ * @objection
+ */
+export declare function HasOne(opts?: RelationshipOptsWithoutThrough): PropertyDecorator;

package/lib/types-esm/decorators/hasOneThroughRelation.d.ts

@@ -0,0 +1,8 @@
+import { RelationshipOptsWithThrough } from "../domain/RelationshipOpts.js";
+/**
+ *
+ * @param opts
+ * @decorator
+ * @objection
+ */
+export declare function HasOneThroughRelation(opts?: RelationshipOptsWithThrough): PropertyDecorator;

package/lib/types-esm/decorators/idColumn.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param type
+ * @decorator
+ * @objection
+ */
+export declare function IdColumn(type?: "uuid" | "increments" | "bigIncrements"): PropertyDecorator;

package/lib/types-esm/decorators/manyToMany.d.ts

@@ -0,0 +1,9 @@
+import { ModelClassSpecifier } from "objection";
+import { RelationshipOptsWithThrough } from "../domain/RelationshipOpts.js";
+/**
+ *
+ * @param opts
+ * @decorator
+ * @objection
+ */
+export declare function ManyToMany(type: ModelClassSpecifier, opts?: RelationshipOptsWithThrough): PropertyDecorator;

package/lib/types-esm/decorators/relatesTo.d.ts

@@ -0,0 +1,10 @@
+import { RelationshipOpts } from "../domain/RelationshipOpts.js";
+import { RelationType } from "objection";
+/**
+ *
+ * @param relation
+ * @param opts
+ * @decorator
+ * @objection
+ */
+export declare function RelatesTo(relation: RelationType, opts?: RelationshipOpts): PropertyDecorator;

package/lib/types-esm/domain/ColumnOpts.d.ts

@@ -0,0 +1,4 @@
+export interface ColumnOpts {
+    columnType: "idColumn" | "string" | "number" | "boolean";
+    options: any;
+}

package/lib/types-esm/domain/RelationshipOpts.d.ts

@@ -0,0 +1,8 @@
+import { ModelClassFactory, ModelClassSpecifier, RelationJoin, RelationMapping } from "objection";
+export type RelationshipOptsWithThrough = Partial<RelationJoin> & Omit<RelationMapping<any>, "relation" | "join" | "modelClass">;
+export type RelationshipOptsWithoutThrough = Omit<RelationshipOptsWithThrough, "through">;
+export type RelationshipOpts = (RelationshipOptsWithThrough | RelationshipOptsWithoutThrough) & {
+    type?: ModelClassSpecifier;
+};
+export declare const isRelationshipOptsWithThrough: (opts?: RelationshipOpts) => opts is RelationshipOptsWithThrough;
+export declare const isModelClassFactory: (type?: ModelClassSpecifier) => type is ModelClassFactory;

package/lib/types-esm/domain/interfaces.d.ts

@@ -0,0 +1,8 @@
+import { Knex } from "knex";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            knex: Knex.Config;
+        }
+    }
+}

package/lib/types-esm/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./components/createBooleanColumn.js";
+export * from "./components/createIdColumn.js";
+export * from "./components/createNumberColumn.js";
+export * from "./components/createStringColumn.js";
+export * from "./decorators/belongsToOne.js";
+export * from "./decorators/columnOptions.js";
+export * from "./decorators/decimal.js";
+export * from "./decorators/entity.js";
+export * from "./decorators/hasMany.js";
+export * from "./decorators/hasOne.js";
+export * from "./decorators/hasOneThroughRelation.js";
+export * from "./decorators/idColumn.js";
+export * from "./decorators/manyToMany.js";
+export * from "./decorators/relatesTo.js";
+export * from "./domain/ColumnOpts.js";
+export * from "./domain/interfaces.js";
+export * from "./domain/RelationshipOpts.js";
+export * from "./services/ColumnTypesContainer.js";
+export * from "./services/ObjectionConnection.js";
+export * from "./utils/connect.js";
+export * from "./utils/createColumns.js";
+export * from "./utils/createJoinKeys.js";
+export * from "./utils/createRelationshipMapping.js";
+export * from "./utils/defineStaticGetter.js";
+export * from "./utils/getColumnCtx.js";
+export * from "./utils/getJsonEntityRelationships.js";

package/lib/types-esm/services/ColumnTypesContainer.d.ts

@@ -0,0 +1,6 @@
+import type { Knex } from "knex";
+import { ColumnCtx } from "../utils/getColumnCtx.js";
+/**
+ * @ignore
+ */
+export declare const ColumnTypesContainer: Map<string, (table: Knex.TableBuilder, ctx: ColumnCtx) => void>;

package/lib/types-esm/services/ObjectionConnection.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from "knex";
+export declare const OBJECTION_CONNECTION: unique symbol;
+export type OBJECTION_CONNECTION = Knex<any, unknown[]>;

package/lib/types-esm/utils/connect.d.ts

@@ -0,0 +1,2 @@
+import { Knex } from "knex";
+export declare function createConnection(connectionOptions: Knex.Config): Knex;

package/lib/types-esm/utils/createColumns.d.ts

@@ -0,0 +1,18 @@
+import { JsonEntityStore } from "@tsed/schema";
+import { Knex } from "knex";
+import "../components/createBooleanColumn";
+import "../components/createIdColumn";
+import "../components/createNumberColumn";
+import "../components/createStringColumn";
+/**
+ * @ignore
+ */
+export declare function createColumn(table: Knex.TableBuilder, entity: JsonEntityStore): void;
+/**
+ * @ignore
+ */
+export declare function getColumns(model: any): import("@tsed/schema").JsonPropertyStore[];
+/**
+ * @ignore
+ */
+export declare function createColumns(table: Knex.TableBuilder, model: any): void;

package/lib/types-esm/utils/createJoinKeys.d.ts

@@ -0,0 +1,14 @@
+import { RelationType } from "objection";
+import { RelationshipOpts } from "../domain/RelationshipOpts.js";
+/**
+ * @ignore
+ */
+export declare function createJoinKeys(targetClass: any, targetSuper: any, propertyKey: string, relation: RelationType, opts?: RelationshipOpts): {
+    from: string;
+    to: string;
+    through?: undefined;
+} | {
+    from: string;
+    through: import("objection").RelationThrough<any>;
+    to: string;
+};

package/lib/types-esm/utils/createRelationshipMapping.d.ts

@@ -0,0 +1,24 @@
+import { DecoratorParameters } from "@tsed/core";
+import { RelationType } from "objection";
+import { RelationshipOpts } from "../domain/RelationshipOpts.js";
+/**
+ * @ignore
+ */
+export declare function createRelationshipMapping([target, propertyKey]: DecoratorParameters, relation: RelationType, opts?: RelationshipOpts): (targetClass: any) => {
+    [x: string]: {
+        relation: RelationType;
+        modelClass: any;
+        join: {
+            from: string;
+            to: string;
+            through?: undefined;
+        } | {
+            from: string;
+            through: import("objection").RelationThrough<any>;
+            to: string;
+        };
+        modify: import("objection").Modifier<any> | undefined;
+        filter: import("objection").Modifier<any> | undefined;
+        beforeInsert: import("objection").RelationMappingHook<any> | undefined;
+    };
+};

package/lib/types-esm/utils/defineStaticGetter.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @ignore
+ */
+export declare function defineStaticGetter(target: any, propertyKey: string, fn: any): any;

package/lib/types-esm/utils/getColumnCtx.d.ts

@@ -0,0 +1,13 @@
+import { JsonEntityStore } from "@tsed/schema";
+import { ColumnOpts } from "../domain/ColumnOpts.js";
+/**
+ * @ignore
+ */
+export interface ColumnCtx extends ColumnOpts {
+    entity: JsonEntityStore;
+    schema: any;
+}
+/**
+ * @ignore
+ */
+export declare function getColumnCtx(entity: JsonEntityStore): ColumnCtx;

package/lib/types-esm/utils/getJsonEntityRelationships.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @ignore
+ */
+export declare const OBJECTION_RELATIONSHIP_KEY = "objectionRelationship";
+/**
+ * @ignore
+ */
+export declare function getJsonEntityRelationships(target: any): any;

package/package.json

@@ -1,46 +1,50 @@
 {
   "name": "@tsed/objection",
-  "version": "7.79.4",
   "description": "Objection.js package for Ts.ED framework",
+  "type": "commonjs",
+  "version": "7.80.0",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js",
-    "default": "./lib/esm/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/cjs/index.js"
+    }
   },
   "scripts": {
     "build": "yarn barrels && yarn build:ts",
     "barrels": "barrels",
-    "test": "jest && jest-coverage-thresholds-bumper",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/ajv": "7.79.4",
-    "@tsed/barrels": "7.79.4",
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/json-mapper": "7.79.4",
-    "@tsed/schema": "7.79.4",
-    "@tsed/typescript": "7.79.4",
+    "@tsed/ajv": "7.80.0",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/json-mapper": "7.80.0",
+    "@tsed/schema": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
     "knex": "^3.1.0",
     "objection": "^2.2.18",
-    "sqlite3": "^5.1.7"
+    "sqlite3": "^5.1.7",
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
-    "@tsed/ajv": "7.79.4",
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/json-mapper": "7.79.4",
-    "@tsed/schema": "7.79.4",
+    "@tsed/ajv": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/json-mapper": "7.80.0",
+    "@tsed/schema": "7.80.0",
     "knex": ">=0.94.0",
     "objection": ">=2.0.0"
   },

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);

package/jest.config.js

@@ -1,20 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-const config = require("@tsed/jest-config");
-
-module.exports = {
-  ...config,
-  roots: ["<rootDir>/src", "<rootDir>/test"],
-  moduleNameMapper: {
-    ...config.moduleNameMapper,
-    "@tsed/objection": "<rootDir>/src/index.ts"
-  },
-  coverageThreshold: {
-    global: {
-      branches: 96.87,
-      functions: 91.48,
-      lines: 98.26,
-      statements: 98.26
-    }
-  }
-};

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/tsconfig.esm.json

@@ -1,45 +0,0 @@
-{
-  "extends": "@tsed/typescript/tsconfig.node.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "ES2020",
-    "rootDir": "src",
-    "outDir": "./lib/esm",
-    "declaration": true,
-    "declarationDir": "./lib/types",
-    "composite": true,
-    "noEmit": false
-  },
-  "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js",
-    "**/__mock__/**",
-    "webpack.config.js"
-  ],
-  "references": [
-    {
-      "path": "../../specs/ajv"
-    },
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    },
-    {
-      "path": "../../specs/json-mapper"
-    },
-    {
-      "path": "../../specs/schema"
-    }
-  ]
-}