typeorm 1.0.0-beta.1 → 1.0.0-beta.3

package/entity-manager/MongoEntityManager.d.ts

@@ -29,6 +29,7 @@ export declare class MongoEntityManager extends EntityManager {
      */
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param entityClassOrName
      * @param optionsOrConditions
      */
@@ -37,18 +38,21 @@ export declare class MongoEntityManager extends EntityManager {
      * Finds entities that match given find options or conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param entityClassOrName
      * @param options
      */
     findAndCount<Entity>(entityClassOrName: EntityTarget<Entity>, options?: MongoFindManyOptions<Entity>): Promise<[Entity[], number]>;
     /**
      * Finds entities that match given where conditions.
+     *
      * @param entityClassOrName
      * @param where
      */
     findAndCountBy<Entity>(entityClassOrName: EntityTarget<Entity>, where: any): Promise<[Entity[], number]>;
     /**
      * Finds entities that match given WHERE conditions.
+     *
      * @param entityClassOrName
      * @param where
      */
@@ -56,6 +60,7 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Finds entities by ids.
      * Optionally find options can be applied.
+     *
      * @param entityClassOrName
      * @param ids
      * @param optionsOrConditions
@@ -63,12 +68,14 @@ export declare class MongoEntityManager extends EntityManager {
     findByIds<Entity>(entityClassOrName: EntityTarget<Entity>, ids: any[], optionsOrConditions?: FindManyOptions<Entity> | Partial<Entity>): Promise<Entity[]>;
     /**
      * Finds first entity that matches given conditions and/or find options.
+     *
      * @param entityClassOrName
      * @param options
      */
     findOne<Entity>(entityClassOrName: EntityTarget<Entity>, options: MongoFindOneOptions<Entity>): Promise<Entity | null>;
     /**
      * Finds first entity that matches given WHERE conditions.
+     *
      * @param entityClassOrName
      * @param where
      */
@@ -79,6 +86,7 @@ export declare class MongoEntityManager extends EntityManager {
      * Executes fast and efficient INSERT query.
      * Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted.
      * You can execute bulk inserts using this method.
+     *
      * @param target
      * @param entity
      */
@@ -88,6 +96,7 @@ export declare class MongoEntityManager extends EntityManager {
      * Unlike save method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient UPDATE query.
      * Does not check if entity exist in the database.
+     *
      * @param target
      * @param criteria
      * @param partialEntity
@@ -98,12 +107,14 @@ export declare class MongoEntityManager extends EntityManager {
      * Unlike save method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient DELETE query.
      * Does not check if entity exist in the database.
+     *
      * @param target
      * @param criteria
      */
     delete<Entity>(target: EntityTarget<Entity>, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | ObjectLiteral[]): Promise<DeleteResult>;
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      */
@@ -111,12 +122,14 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param entityClassOrName
      * @param query
      */
     createEntityCursor<Entity>(entityClassOrName: EntityTarget<Entity>, query?: ObjectLiteral): FindCursor<Entity>;
     /**
      * Execute an aggregation framework pipeline against the collection.
+     *
      * @param entityClassOrName
      * @param pipeline
      * @param options
@@ -125,6 +138,7 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Execute an aggregation framework pipeline against the collection.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param entityClassOrName
      * @param pipeline
      * @param options
@@ -132,6 +146,7 @@ export declare class MongoEntityManager extends EntityManager {
     aggregateEntity<Entity>(entityClassOrName: EntityTarget<Entity>, pipeline: Document[], options?: AggregateOptions): AggregationCursor<Entity>;
     /**
      * Perform a bulkWrite operation without a fluent API.
+     *
      * @param entityClassOrName
      * @param operations
      * @param options
@@ -139,6 +154,7 @@ export declare class MongoEntityManager extends EntityManager {
     bulkWrite<Entity>(entityClassOrName: EntityTarget<Entity>, operations: AnyBulkWriteOperation<Document>[], options?: BulkWriteOptions): Promise<BulkWriteResult>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -146,6 +162,7 @@ export declare class MongoEntityManager extends EntityManager {
     count<Entity>(entityClassOrName: EntityTarget<Entity>, query?: Filter<Document>, options?: CountOptions): Promise<number>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -153,6 +170,7 @@ export declare class MongoEntityManager extends EntityManager {
     countDocuments<Entity>(entityClassOrName: EntityTarget<Entity>, query?: Filter<Document>, options?: CountDocumentsOptions): Promise<number>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -160,6 +178,7 @@ export declare class MongoEntityManager extends EntityManager {
     countBy<Entity>(entityClassOrName: EntityTarget<Entity>, query?: ObjectLiteral, options?: CountOptions): Promise<number>;
     /**
      * Creates an index on the db and collection.
+     *
      * @param entityClassOrName
      * @param fieldOrSpec
      * @param options
@@ -169,12 +188,14 @@ export declare class MongoEntityManager extends EntityManager {
      * Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher.
      * Earlier version of MongoDB will throw a command not supported error.
      * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.
+     *
      * @param entityClassOrName
      * @param indexSpecs
      */
     createCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>, indexSpecs: IndexDescription[]): Promise<string[]>;
     /**
      * Delete multiple documents on MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -182,6 +203,7 @@ export declare class MongoEntityManager extends EntityManager {
     deleteMany<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, options?: DeleteOptions): Promise<DeleteResultMongoDb>;
     /**
      * Delete a document on MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -189,6 +211,7 @@ export declare class MongoEntityManager extends EntityManager {
     deleteOne<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, options?: DeleteOptions): Promise<DeleteResultMongoDb>;
     /**
      * The distinct command returns returns a list of distinct values for the given key across a collection.
+     *
      * @param entityClassOrName
      * @param key
      * @param query
@@ -197,6 +220,7 @@ export declare class MongoEntityManager extends EntityManager {
     distinct<Entity>(entityClassOrName: EntityTarget<Entity>, key: string, query: Filter<Document>, options?: CommandOperationOptions): Promise<any>;
     /**
      * Drops an index from this collection.
+     *
      * @param entityClassOrName
      * @param indexName
      * @param options
@@ -204,11 +228,13 @@ export declare class MongoEntityManager extends EntityManager {
     dropCollectionIndex<Entity>(entityClassOrName: EntityTarget<Entity>, indexName: string, options?: CommandOperationOptions): Promise<any>;
     /**
      * Drops all indexes from the collection.
+     *
      * @param entityClassOrName
      */
     dropCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<any>;
     /**
      * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param entityClassOrName
      * @param query
      * @param options
@@ -216,6 +242,7 @@ export declare class MongoEntityManager extends EntityManager {
     findOneAndDelete<Entity>(entityClassOrName: EntityTarget<Entity>, query: ObjectLiteral, options?: FindOneAndDeleteOptions): Promise<Document | null>;
     /**
      * Find a document and replace it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param entityClassOrName
      * @param query
      * @param replacement
@@ -224,6 +251,7 @@ export declare class MongoEntityManager extends EntityManager {
     findOneAndReplace<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, replacement: Document, options?: FindOneAndReplaceOptions): Promise<Document | null>;
     /**
      * Find a document and update it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param entityClassOrName
      * @param query
      * @param update
@@ -232,35 +260,41 @@ export declare class MongoEntityManager extends EntityManager {
     findOneAndUpdate<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, update: UpdateFilter<Document>, options?: FindOneAndUpdateOptions): Promise<Document | null>;
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param entityClassOrName
      */
     collectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<Document>;
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param entityClassOrName
      * @param indexes
      */
     collectionIndexExists<Entity>(entityClassOrName: EntityTarget<Entity>, indexes: string | string[]): Promise<boolean>;
     /**
      * Retrieves this collections index info.
+     *
      * @param entityClassOrName
      * @param options
      */
     collectionIndexInformation<Entity>(entityClassOrName: EntityTarget<Entity>, options?: IndexInformationOptions): Promise<any>;
     /**
      * Initiate an In order bulk write operation, operations will be serially executed in the order they are added, creating a new operation for each switch in types.
+     *
      * @param entityClassOrName
      * @param options
      */
     initializeOrderedBulkOp<Entity>(entityClassOrName: EntityTarget<Entity>, options?: BulkWriteOptions): OrderedBulkOperation;
     /**
      * Initiate a Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
+     *
      * @param entityClassOrName
      * @param options
      */
     initializeUnorderedBulkOp<Entity>(entityClassOrName: EntityTarget<Entity>, options?: BulkWriteOptions): UnorderedBulkOperation;
     /**
      * Inserts an array of documents into MongoDB.
+     *
      * @param entityClassOrName
      * @param docs
      * @param options
@@ -268,6 +302,7 @@ export declare class MongoEntityManager extends EntityManager {
     insertMany<Entity>(entityClassOrName: EntityTarget<Entity>, docs: OptionalId<Document>[], options?: BulkWriteOptions): Promise<InsertManyResult>;
     /**
      * Inserts a single document into MongoDB.
+     *
      * @param entityClassOrName
      * @param doc
      * @param options
@@ -275,17 +310,20 @@ export declare class MongoEntityManager extends EntityManager {
     insertOne<Entity>(entityClassOrName: EntityTarget<Entity>, doc: OptionalId<Document>, options?: InsertOneOptions): Promise<InsertOneResult>;
     /**
      * Returns if the collection is a capped collection.
+     *
      * @param entityClassOrName
      */
     isCapped<Entity>(entityClassOrName: EntityTarget<Entity>): Promise<any>;
     /**
      * Get the list of all indexes information for the collection.
+     *
      * @param entityClassOrName
      * @param options
      */
     listCollectionIndexes<Entity>(entityClassOrName: EntityTarget<Entity>, options?: ListIndexesOptions): ListIndexesCursor;
     /**
      * Reindex all indexes on the collection Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections.
+     *
      * @param entityClassOrName
      * @param newName
      * @param options
@@ -293,6 +331,7 @@ export declare class MongoEntityManager extends EntityManager {
     rename<Entity>(entityClassOrName: EntityTarget<Entity>, newName: string, options?: RenameOptions): Promise<Collection<Document>>;
     /**
      * Replace a document on MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      * @param doc
@@ -302,6 +341,7 @@ export declare class MongoEntityManager extends EntityManager {
     watch<Entity>(entityClassOrName: EntityTarget<Entity>, pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream;
     /**
      * Update multiple documents on MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      * @param update
@@ -310,6 +350,7 @@ export declare class MongoEntityManager extends EntityManager {
     updateMany<Entity>(entityClassOrName: EntityTarget<Entity>, query: Filter<Document>, update: UpdateFilter<Document>, options?: UpdateOptions): Promise<Document | UpdateResultMongoDb>;
     /**
      * Update a single document on MongoDB.
+     *
      * @param entityClassOrName
      * @param query
      * @param update
@@ -319,6 +360,7 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Replaces the entity's ObjectId property name (e.g. "id") with "_id" in a
      * query object so that `findOneBy({ id: value })` works as expected.
+     *
      * @param metadata
      * @param query
      */
@@ -326,6 +368,7 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Recursively rewrites a query object, renaming the given property to
      * "_id" and converting values to ObjectId instances. Walks into $or/$and.
+     *
      * @param obj
      * @param propertyName
      * @param objectIdClass
@@ -334,38 +377,46 @@ export declare class MongoEntityManager extends EntityManager {
     /**
      * Converts a query value to ObjectId, handling scalars, arrays, and
      * MongoDB operator objects (e.g. { $in: [...] }, { $ne: ... }).
+     *
      * @param value
      * @param objectIdClass
      */
     private convertToObjectId;
     /**
      * Converts FindManyOptions to mongodb query.
+     *
      * @param optionsOrConditions
      */
     protected convertFindManyOptionsOrConditionsToMongodbQuery<Entity>(optionsOrConditions: MongoFindManyOptions<Entity> | Partial<Entity> | FilterOperators<Entity> | any[] | undefined): ObjectLiteral | undefined;
     /**
      * Converts FindOneOptions to mongodb query.
+     *
      * @param optionsOrConditions
      */
     protected convertFindOneOptionsOrConditionsToMongodbQuery<Entity>(optionsOrConditions: MongoFindOneOptions<Entity> | Partial<Entity> | undefined): ObjectLiteral | undefined;
     /**
      * Converts FindOptions into mongodb order by criteria.
+     *
      * @param order
      */
     protected convertFindOptionsOrderToOrderCriteria(order: ObjectLiteral): ObjectLiteral;
     /**
      * Converts FindOptions into mongodb select by criteria.
+     *
      * @param selects
+     * @param metadata
      */
-    protected convertFindOptionsSelectToProjectCriteria(selects: FindOptionsSelect<any>): {};
+    protected convertFindOptionsSelectToProjectCriteria(selects: FindOptionsSelect<any>, metadata: EntityMetadata): ObjectLiteral;
     /**
      * Ensures given id is an id for query.
+     *
      * @param metadata
      * @param idMap
      */
     protected convertMixedCriteria(metadata: EntityMetadata, idMap: any): ObjectLiteral;
     /**
      * Overrides cursor's toArray and next methods to convert results to entity automatically.
+     *
      * @param metadata
      * @param cursor
      */
@@ -373,6 +424,7 @@ export declare class MongoEntityManager extends EntityManager {
     protected filterSoftDeleted<Entity>(cursor: FindCursor<Entity>, deleteDateColumn: ColumnMetadata, query?: ObjectLiteral): void;
     /**
      * Finds first entity that matches given conditions and/or find options.
+     *
      * @param entityClassOrName
      * @param optionsOrConditions
      * @param maybeOptions
@@ -381,6 +433,7 @@ export declare class MongoEntityManager extends EntityManager {
     protected executeFind<Entity>(entityClassOrName: EntityTarget<Entity>, optionsOrConditions?: MongoFindManyOptions<Entity> | Partial<Entity> | any[]): Promise<Entity[]>;
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param entityClassOrName
      * @param optionsOrConditions
      */