typeorm 0.3.12-dev.ef64bfc → 0.4.0-alpha.1

package/driver/types/ColumnTypes.d.ts

@@ -1,25 +1,25 @@
 /**
  * Column types used for @PrimaryGeneratedColumn() decorator.
  */
-export declare type PrimaryGeneratedColumnType = "int" | "int2" | "int4" | "int8" | "integer" | "tinyint" | "smallint" | "mediumint" | "bigint" | "dec" | "decimal" | "smalldecimal" | "fixed" | "numeric" | "number";
+export type PrimaryGeneratedColumnType = "int" | "int2" | "int4" | "int8" | "integer" | "tinyint" | "smallint" | "mediumint" | "bigint" | "dec" | "decimal" | "smalldecimal" | "fixed" | "numeric" | "number";
 /**
  * Column types where spatial properties are used.
  */
-export declare type SpatialColumnType = "geometry" | "geography" | "st_geometry" | "st_point";
+export type SpatialColumnType = "geometry" | "geography" | "st_geometry" | "st_point";
 /**
  * Column types where precision and scale properties are used.
  */
-export declare type WithPrecisionColumnType = "float" | "double" | "dec" | "decimal" | "smalldecimal" | "fixed" | "numeric" | "real" | "double precision" | "number" | "datetime" | "datetime2" | "datetimeoffset" | "time" | "time with time zone" | "time without time zone" | "timestamp" | "timestamp without time zone" | "timestamp with time zone" | "timestamp with local time zone";
+export type WithPrecisionColumnType = "float" | "double" | "dec" | "decimal" | "smalldecimal" | "fixed" | "numeric" | "real" | "double precision" | "number" | "datetime" | "datetime2" | "datetimeoffset" | "time" | "time with time zone" | "time without time zone" | "timestamp" | "timestamp without time zone" | "timestamp with time zone" | "timestamp with local time zone";
 /**
  * Column types where column length is used.
  */
-export declare type WithLengthColumnType = "character varying" | "varying character" | "char varying" | "nvarchar" | "national varchar" | "character" | "native character" | "varchar" | "char" | "nchar" | "national char" | "varchar2" | "nvarchar2" | "alphanum" | "shorttext" | "raw" | "binary" | "varbinary" | "string";
-export declare type WithWidthColumnType = "tinyint" | "smallint" | "mediumint" | "int" | "bigint";
+export type WithLengthColumnType = "character varying" | "varying character" | "char varying" | "nvarchar" | "national varchar" | "character" | "native character" | "varchar" | "char" | "nchar" | "national char" | "varchar2" | "nvarchar2" | "alphanum" | "shorttext" | "raw" | "binary" | "varbinary" | "string";
+export type WithWidthColumnType = "tinyint" | "smallint" | "mediumint" | "int" | "bigint";
 /**
  * All other regular column types.
  */
-export declare type SimpleColumnType = "simple-array" | "simple-json" | "simple-enum" | "int2" | "integer" | "int4" | "int8" | "int64" | "unsigned big int" | "float" | "float4" | "float8" | "float64" | "smallmoney" | "money" | "boolean" | "bool" | "tinyblob" | "tinytext" | "mediumblob" | "mediumtext" | "blob" | "text" | "ntext" | "citext" | "hstore" | "longblob" | "longtext" | "alphanum" | "shorttext" | "bytes" | "bytea" | "long" | "raw" | "long raw" | "bfile" | "clob" | "nclob" | "image" | "timetz" | "timestamptz" | "timestamp with local time zone" | "smalldatetime" | "date" | "interval year to month" | "interval day to second" | "interval" | "year" | "seconddate" | "point" | "line" | "lseg" | "box" | "circle" | "path" | "polygon" | "geography" | "geometry" | "linestring" | "multipoint" | "multilinestring" | "multipolygon" | "geometrycollection" | "st_geometry" | "st_point" | "int4range" | "int8range" | "numrange" | "tsrange" | "tstzrange" | "daterange" | "enum" | "set" | "cidr" | "inet" | "macaddr" | "bit" | "bit varying" | "varbit" | "tsvector" | "tsquery" | "uuid" | "xml" | "json" | "jsonb" | "varbinary" | "hierarchyid" | "sql_variant" | "rowid" | "urowid" | "uniqueidentifier" | "rowversion" | "array" | "cube" | "ltree";
+export type SimpleColumnType = "simple-array" | "simple-json" | "simple-enum" | "int2" | "integer" | "int4" | "int8" | "int64" | "unsigned big int" | "float" | "float4" | "float8" | "float64" | "smallmoney" | "money" | "boolean" | "bool" | "tinyblob" | "tinytext" | "mediumblob" | "mediumtext" | "blob" | "text" | "ntext" | "citext" | "hstore" | "longblob" | "longtext" | "alphanum" | "shorttext" | "bytes" | "bytea" | "long" | "raw" | "long raw" | "bfile" | "clob" | "nclob" | "image" | "timetz" | "timestamptz" | "timestamp with local time zone" | "smalldatetime" | "date" | "interval year to month" | "interval day to second" | "interval" | "year" | "seconddate" | "point" | "line" | "lseg" | "box" | "circle" | "path" | "polygon" | "geography" | "geometry" | "linestring" | "multipoint" | "multilinestring" | "multipolygon" | "geometrycollection" | "st_geometry" | "st_point" | "int4range" | "int8range" | "numrange" | "tsrange" | "tstzrange" | "daterange" | "enum" | "set" | "cidr" | "inet" | "macaddr" | "bit" | "bit varying" | "varbit" | "tsvector" | "tsquery" | "uuid" | "xml" | "json" | "jsonb" | "varbinary" | "hierarchyid" | "sql_variant" | "rowid" | "urowid" | "uniqueidentifier" | "rowversion" | "array" | "cube" | "ltree";
 /**
  * Any column type column can be.
  */
-export declare type ColumnType = WithPrecisionColumnType | WithLengthColumnType | WithWidthColumnType | SpatialColumnType | SimpleColumnType | BooleanConstructor | DateConstructor | NumberConstructor | StringConstructor;
+export type ColumnType = WithPrecisionColumnType | WithLengthColumnType | WithWidthColumnType | SpatialColumnType | SimpleColumnType | BooleanConstructor | DateConstructor | NumberConstructor | StringConstructor;

package/driver/types/DatabaseType.d.ts

@@ -1,4 +1,4 @@
 /**
  * Database type.
  */
-export declare type DatabaseType = "mysql" | "postgres" | "cockroachdb" | "sap" | "mariadb" | "sqlite" | "cordova" | "react-native" | "nativescript" | "sqljs" | "oracle" | "mssql" | "mongodb" | "aurora-mysql" | "aurora-postgres" | "expo" | "better-sqlite3" | "capacitor" | "spanner";
+export type DatabaseType = "mysql" | "postgres" | "cockroachdb" | "sap" | "mariadb" | "sqlite" | "cordova" | "react-native" | "nativescript" | "sqljs" | "oracle" | "mssql" | "mongodb" | "aurora-mysql" | "aurora-postgres" | "expo" | "better-sqlite3" | "capacitor" | "spanner";

package/driver/types/GeoJsonTypes.d.ts

@@ -2,7 +2,7 @@
  * Point geometry object.
  * https://tools.ietf.org/html/rfc7946#section-3.1.2
  */
-export declare type Point = {
+export type Point = {
     type: "Point";
     coordinates: number[];
 };
@@ -10,7 +10,7 @@ export declare type Point = {
  * LineString geometry object.
  * https://tools.ietf.org/html/rfc7946#section-3.1.4
  */
-export declare type LineString = {
+export type LineString = {
     type: "LineString";
     coordinates: number[][];
 };
@@ -18,7 +18,7 @@ export declare type LineString = {
  * Polygon geometry object.
  * https://tools.ietf.org/html/rfc7946#section-3.1.6
  */
-export declare type Polygon = {
+export type Polygon = {
     type: "Polygon";
     coordinates: number[][][];
 };
@@ -26,7 +26,7 @@ export declare type Polygon = {
  * MultiPoint geometry object.
  *  https://tools.ietf.org/html/rfc7946#section-3.1.3
  */
-export declare type MultiPoint = {
+export type MultiPoint = {
     type: "MultiPoint";
     coordinates: number[][];
 };
@@ -34,7 +34,7 @@ export declare type MultiPoint = {
  * MultiLineString geometry object.
  * https://tools.ietf.org/html/rfc7946#section-3.1.5
  */
-export declare type MultiLineString = {
+export type MultiLineString = {
     type: "MultiLineString";
     coordinates: number[][][];
 };
@@ -42,7 +42,7 @@ export declare type MultiLineString = {
  * MultiPolygon geometry object.
  * https://tools.ietf.org/html/rfc7946#section-3.1.7
  */
-export declare type MultiPolygon = {
+export type MultiPolygon = {
     type: "MultiPolygon";
     coordinates: number[][][][];
 };
@@ -50,20 +50,20 @@ export declare type MultiPolygon = {
  * Geometry Collection
  * https://tools.ietf.org/html/rfc7946#section-3.1.8
  */
-export declare type GeometryCollection = {
+export type GeometryCollection = {
     type: "GeometryCollection";
     geometries: (Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon)[];
 };
 /**
  * Union of Geometry objects.
  */
-export declare type Geometry = Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon | GeometryCollection;
-export declare type Geography = Geometry;
+export type Geometry = Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon | GeometryCollection;
+export type Geography = Geometry;
 /**
  * A feature object which contains a geometry and associated properties.
  * https://tools.ietf.org/html/rfc7946#section-3.2
  */
-export declare type Feature = {
+export type Feature = {
     type: "Feature";
     geometry: Geometry;
     id?: string | number;
@@ -76,7 +76,7 @@ export declare type Feature = {
  * A collection of feature objects.
  *  https://tools.ietf.org/html/rfc7946#section-3.3
  */
-export declare type FeatureCollection = {
+export type FeatureCollection = {
     type: "FeatureCollection";
     bbox?: number[];
     features: Feature[];
@@ -84,4 +84,4 @@ export declare type FeatureCollection = {
 /**
  * Union of GeoJSON objects.
  */
-export declare type GeoJSON = Geometry | Feature | FeatureCollection;
+export type GeoJSON = Geometry | Feature | FeatureCollection;

package/driver/types/IsolationLevel.d.ts

@@ -1 +1 @@
-export declare type IsolationLevel = "READ UNCOMMITTED" | "READ COMMITTED" | "REPEATABLE READ" | "SERIALIZABLE";
+export type IsolationLevel = "READ UNCOMMITTED" | "READ COMMITTED" | "REPEATABLE READ" | "SERIALIZABLE";

package/driver/types/MappedColumnTypes.d.ts

@@ -1,4 +1,4 @@
-import { ColumnType } from "./ColumnTypes";
+import type { ColumnType } from "./ColumnTypes";
 /**
  * Orm has special columns and we need to know what database column types should be for those types.
  * Column types are driver dependant.

package/driver/types/MappedColumnTypes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/driver/types/MappedColumnTypes.ts"],"names":[],"mappings":"","file":"MappedColumnTypes.js","sourcesContent":["import { ColumnType } from \"./ColumnTypes\"\n\n/**\n * Orm has special columns and we need to know what database column types should be for those types.\n * Column types are driver dependant.\n */\nexport interface MappedColumnTypes {\n    /**\n     * Column type for the create date column.\n     */\n    createDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    createDatePrecision?: number\n\n    /**\n     * Default value should be used by a database for \"created date\" column.\n     */\n    createDateDefault: string\n\n    /**\n     * Column type for the update date column.\n     */\n    updateDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    updateDatePrecision?: number\n\n    /**\n     * Default value should be used by a database for \"updated date\" column.\n     */\n    updateDateDefault: string\n\n    /**\n     * Column type for the delete date column.\n     */\n    deleteDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    deleteDatePrecision?: number\n\n    /**\n     * Nullable value should be used by a database for \"deleted date\" column.\n     */\n    deleteDateNullable: boolean\n\n    /**\n     * Column type for the version column.\n     */\n    version: ColumnType\n\n    /**\n     * Column type for the tree level column.\n     */\n    treeLevel: ColumnType\n\n    /**\n     * Column type of id column used for migrations table.\n     */\n    migrationId: ColumnType\n\n    /**\n     * Column type of timestamp column used for migrations table.\n     */\n    migrationTimestamp: ColumnType\n\n    /**\n     * Column type for migration name column used for migrations table.\n     */\n    migrationName: ColumnType\n\n    /**\n     * Column type for identifier column in query result cache table.\n     */\n    cacheId: ColumnType\n\n    /**\n     * Column type for identifier column in query result cache table.\n     */\n    cacheIdentifier: ColumnType\n\n    /**\n     * Column type for time column in query result cache table.\n     */\n    cacheTime: ColumnType\n\n    /**\n     * Column type for duration column in query result cache table.\n     */\n    cacheDuration: ColumnType\n\n    /**\n     * Column type for query column in query result cache table.\n     */\n    cacheQuery: ColumnType\n\n    /**\n     * Column type for result column in query result cache table.\n     */\n    cacheResult: ColumnType\n\n    /**\n     * Column type for metadata type column in typeorm metadata table.\n     * Stores type of metadata. E.g. 'VIEW' or 'CHECK'\n     */\n    metadataType: ColumnType\n\n    /**\n     * Column type for metadata database name column in typeorm metadata table.\n     */\n    metadataDatabase: ColumnType\n\n    /**\n     * Column type for metadata schema name column in typeorm metadata table.\n     */\n    metadataSchema: ColumnType\n\n    /**\n     * Column type for metadata table name column in typeorm metadata table.\n     */\n    metadataTable: ColumnType\n\n    /**\n     * Column type for metadata name column in typeorm metadata table.\n     */\n    metadataName: ColumnType\n\n    /**\n     * Column type for metadata value column in typeorm metadata table.\n     */\n    metadataValue: ColumnType\n}\n"],"sourceRoot":"../.."}
+{"version":3,"sources":["../../src/driver/types/MappedColumnTypes.ts"],"names":[],"mappings":"","file":"MappedColumnTypes.js","sourcesContent":["import type { ColumnType } from \"./ColumnTypes\"\n\n/**\n * Orm has special columns and we need to know what database column types should be for those types.\n * Column types are driver dependant.\n */\nexport interface MappedColumnTypes {\n    /**\n     * Column type for the create date column.\n     */\n    createDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    createDatePrecision?: number\n\n    /**\n     * Default value should be used by a database for \"created date\" column.\n     */\n    createDateDefault: string\n\n    /**\n     * Column type for the update date column.\n     */\n    updateDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    updateDatePrecision?: number\n\n    /**\n     * Default value should be used by a database for \"updated date\" column.\n     */\n    updateDateDefault: string\n\n    /**\n     * Column type for the delete date column.\n     */\n    deleteDate: ColumnType\n\n    /**\n     * Precision of datetime column. Used in MySql to define milliseconds.\n     */\n    deleteDatePrecision?: number\n\n    /**\n     * Nullable value should be used by a database for \"deleted date\" column.\n     */\n    deleteDateNullable: boolean\n\n    /**\n     * Column type for the version column.\n     */\n    version: ColumnType\n\n    /**\n     * Column type for the tree level column.\n     */\n    treeLevel: ColumnType\n\n    /**\n     * Column type of id column used for migrations table.\n     */\n    migrationId: ColumnType\n\n    /**\n     * Column type of timestamp column used for migrations table.\n     */\n    migrationTimestamp: ColumnType\n\n    /**\n     * Column type for migration name column used for migrations table.\n     */\n    migrationName: ColumnType\n\n    /**\n     * Column type for identifier column in query result cache table.\n     */\n    cacheId: ColumnType\n\n    /**\n     * Column type for identifier column in query result cache table.\n     */\n    cacheIdentifier: ColumnType\n\n    /**\n     * Column type for time column in query result cache table.\n     */\n    cacheTime: ColumnType\n\n    /**\n     * Column type for duration column in query result cache table.\n     */\n    cacheDuration: ColumnType\n\n    /**\n     * Column type for query column in query result cache table.\n     */\n    cacheQuery: ColumnType\n\n    /**\n     * Column type for result column in query result cache table.\n     */\n    cacheResult: ColumnType\n\n    /**\n     * Column type for metadata type column in typeorm metadata table.\n     * Stores type of metadata. E.g. 'VIEW' or 'CHECK'\n     */\n    metadataType: ColumnType\n\n    /**\n     * Column type for metadata database name column in typeorm metadata table.\n     */\n    metadataDatabase: ColumnType\n\n    /**\n     * Column type for metadata schema name column in typeorm metadata table.\n     */\n    metadataSchema: ColumnType\n\n    /**\n     * Column type for metadata table name column in typeorm metadata table.\n     */\n    metadataTable: ColumnType\n\n    /**\n     * Column type for metadata name column in typeorm metadata table.\n     */\n    metadataName: ColumnType\n\n    /**\n     * Column type for metadata value column in typeorm metadata table.\n     */\n    metadataValue: ColumnType\n}\n"],"sourceRoot":"../.."}

package/driver/types/ReplicationMode.d.ts

@@ -1 +1 @@
-export declare type ReplicationMode = "master" | "slave";
+export type ReplicationMode = "master" | "slave";

package/driver/types/UpsertType.d.ts

@@ -1 +1 @@
-export declare type UpsertType = "on-conflict-do-update" | "on-duplicate-key-update" | "primary-key";
+export type UpsertType = "on-conflict-do-update" | "on-duplicate-key-update" | "primary-key";

package/entity-manager/EntityManager.d.ts

@@ -1,26 +1,27 @@
-import { DataSource } from "../data-source/DataSource";
-import { FindManyOptions } from "../find-options/FindManyOptions";
-import { EntityTarget } from "../common/EntityTarget";
-import { ObjectType } from "../common/ObjectType";
-import { FindOneOptions } from "../find-options/FindOneOptions";
-import { DeepPartial } from "../common/DeepPartial";
-import { RemoveOptions } from "../repository/RemoveOptions";
-import { SaveOptions } from "../repository/SaveOptions";
+import type { DataSource } from "../data-source/DataSource";
+import type { FindManyOptions } from "../find-options/FindManyOptions";
+import type { EntityTarget } from "../common/EntityTarget";
+import type { ObjectType } from "../common/ObjectType";
+import type { FindOneOptions } from "../find-options/FindOneOptions";
+import type { DeepPartial } from "../common/DeepPartial";
+import type { RemoveOptions } from "../repository/RemoveOptions";
+import type { SaveOptions } from "../repository/SaveOptions";
 import { MongoRepository } from "../repository/MongoRepository";
 import { TreeRepository } from "../repository/TreeRepository";
 import { Repository } from "../repository/Repository";
 import { PlainObjectToNewEntityTransformer } from "../query-builder/transformer/PlainObjectToNewEntityTransformer";
-import { QueryRunner } from "../query-runner/QueryRunner";
-import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
-import { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity";
-import { ObjectID } from "../driver/mongodb/typings";
-import { InsertResult } from "../query-builder/result/InsertResult";
-import { UpdateResult } from "../query-builder/result/UpdateResult";
-import { DeleteResult } from "../query-builder/result/DeleteResult";
-import { FindOptionsWhere } from "../find-options/FindOptionsWhere";
-import { IsolationLevel } from "../driver/types/IsolationLevel";
-import { UpsertOptions } from "../repository/UpsertOptions";
-import { ObjectLiteral } from "../common/ObjectLiteral";
+import type { QueryRunner } from "../query-runner/QueryRunner";
+import type { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
+import type { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity";
+import type { ObjectID } from "../driver/mongodb/typings";
+import type { InsertResult } from "../query-builder/result/InsertResult";
+import type { UpdateResult } from "../query-builder/result/UpdateResult";
+import type { DeleteResult } from "../query-builder/result/DeleteResult";
+import type { FindOptionsWhere } from "../find-options/FindOptionsWhere";
+import type { IsolationLevel } from "../driver/types/IsolationLevel";
+import type { UpsertOptions } from "../repository/UpsertOptions";
+import type { ObjectLiteral } from "../common/ObjectLiteral";
+import { PickKeysByType } from "../common/PickKeysByType";
 /**
  * Entity manager supposed to work with any entity, automatically find its repository and call its methods,
  * whatever entity type are you passing.
@@ -245,6 +246,23 @@ export declare class EntityManager {
      * Useful for pagination.
      */
     countBy<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, where: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number>;
+    /**
+     * Return the SUM of a column
+     */
+    sum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>;
+    /**
+     * Return the AVG of a column
+     */
+    average<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>;
+    /**
+     * Return the MIN of a column
+     */
+    minimum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>;
+    /**
+     * Return the MAX of a column
+     */
+    maximum<Entity extends ObjectLiteral>(entityClass: EntityTarget<Entity>, columnName: PickKeysByType<Entity, number>, where?: FindOptionsWhere<Entity> | FindOptionsWhere<Entity>[]): Promise<number | null>;
+    private callAggregateFun;
     /**
      * Finds entities that match given find options.
      */

package/entity-manager/EntityManager.js

@@ -479,6 +479,38 @@ class EntityManager {
             .setFindOptions({ where })
             .getCount();
     }
+    /**
+     * Return the SUM of a column
+     */
+    sum(entityClass, columnName, where) {
+        return this.callAggregateFun(entityClass, "SUM", columnName, where);
+    }
+    /**
+     * Return the AVG of a column
+     */
+    average(entityClass, columnName, where) {
+        return this.callAggregateFun(entityClass, "AVG", columnName, where);
+    }
+    /**
+     * Return the MIN of a column
+     */
+    minimum(entityClass, columnName, where) {
+        return this.callAggregateFun(entityClass, "MIN", columnName, where);
+    }
+    /**
+     * Return the MAX of a column
+     */
+    maximum(entityClass, columnName, where) {
+        return this.callAggregateFun(entityClass, "MAX", columnName, where);
+    }
+    async callAggregateFun(entityClass, fnName, columnName, where = {}) {
+        const metadata = this.connection.getMetadata(entityClass);
+        const result = await this.createQueryBuilder(entityClass, metadata.name)
+            .setFindOptions({ where })
+            .select(`${fnName}(${this.connection.driver.escape(String(columnName))})`, fnName)
+            .getRawOne();
+        return result[fnName] === null ? null : parseFloat(result[fnName]);
+    }
     /**
      * Finds entities that match given find options.
      */