npm - @mikro-orm/core - Versions diffs - 7.0.0-dev.66 → 7.0.0-dev.67 - Mend

@mikro-orm/core 7.0.0-dev.66 → 7.0.0-dev.67

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/entity/Collection.d.ts +95 -27
package/entity/Collection.js +412 -90
package/entity/index.d.ts +0 -1
package/entity/index.js +0 -1
package/package.json +2 -2
package/entity/ArrayCollection.d.ts +0 -118
package/entity/ArrayCollection.js +0 -410

package/entity/Collection.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
-import type { EntityDTO, EntityKey, FilterQuery, Loaded, LoadedCollection, Populate } from '../typings.js';
-import { ArrayCollection } from './ArrayCollection.js';
+import { inspect } from 'node:util';
+import type { EntityDTO, EntityKey, EntityProperty, FilterQuery, IPrimaryKey, Loaded, LoadedCollection, Populate, Primary } from '../typings.js';
 import { Reference } from './Reference.js';
 import type { Transaction } from '../connections/Connection.js';
 import type { CountOptions, FindOptions } from '../drivers/IDatabaseDriver.js';
@@ -9,10 +9,18 @@ export interface MatchingOptions<T extends object, P extends string = never> ext
     store?: boolean;
     ctx?: Transaction;
 }
-export declare class Collection<T extends object, O extends object = object> extends ArrayCollection<T, O> {
+export declare class Collection<T extends object, O extends object = object> {
+    readonly owner: O;
+    [k: number]: T;
+    protected readonly items: Set<T>;
+    protected initialized: boolean;
+    protected dirty: boolean;
+    protected partial: boolean;
+    protected snapshot: T[] | undefined;
     private readonly?;
+    protected _count?: number;
+    private _property?;
     private _populated?;
-    private _snapshot?;
     constructor(owner: O, items?: T[], initialized?: boolean);
     /**
      * Creates new Collection instance, assigns it to the owning entity and sets the items to it (propagating them to their inverse sides)
@@ -41,57 +49,117 @@ export declare class Collection<T extends object, O extends object = object> ext
     toJSON<TT extends T>(): EntityDTO<TT>[];
     add<TT extends T>(entity: TT | Reference<TT> | Iterable<TT | Reference<TT>>, ...entities: (TT | Reference<TT>)[]): number;
     /**
-     * @inheritDoc
+     * Remove specified item(s) from the collection. Note that removing item from collection does not necessarily imply deleting the target entity,
+     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
+     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
+     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
      */
     remove<TT extends T>(entity: TT | Reference<TT> | Iterable<TT | Reference<TT>> | ((item: TT) => boolean), ...entities: (TT | Reference<TT>)[]): number;
     contains<TT extends T>(item: TT | Reference<TT>, check?: boolean): boolean;
     count(): number;
     isEmpty(): boolean;
+    shouldPopulate(populated?: boolean): boolean;
+    populated(populated?: boolean | undefined): void;
+    init<TT extends T, P extends string = never>(options?: InitCollectionOptions<TT, P>): Promise<LoadedCollection<Loaded<TT, P>>>;
+    private getEntityManager;
+    private createCondition;
+    private createOrderBy;
+    private createManyToManyCondition;
+    private createLoadCountCondition;
+    private checkInitialized;
+    /**
+     * re-orders items after searching with `$in` operator
+     */
+    private reorderItems;
+    private cancelOrphanRemoval;
+    private validateModification;
+    toArray<TT extends T>(): EntityDTO<TT>[];
+    getIdentifiers<U extends IPrimaryKey = Primary<T> & IPrimaryKey>(field?: string | string[]): U[];
+    /**
+     * @internal
+     */
+    addWithoutPropagation(entity: T): void;
+    set(items: Iterable<T | Reference<T>>): void;
+    private compare;
+    /**
+     * @internal
+     */
+    hydrate(items: T[], forcePropagate?: boolean, partial?: boolean): void;
+    /**
+     * Remove all items from the collection. Note that removing items from collection does not necessarily imply deleting the target entity,
+     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
+     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
+     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
+     */
+    removeAll(): void;
+    /**
+     * @internal
+     */
+    removeWithoutPropagation(entity: T): void;
     /**
-     * @inheritDoc
+     * Extracts a slice of the collection items starting at position start to end (exclusive) of the collection.
+     * If end is null it returns all elements from start to the end of the collection.
      */
     slice(start?: number, end?: number): T[];
     /**
-     * @inheritDoc
+     * Tests for the existence of an element that satisfies the given predicate.
      */
     exists(cb: (item: T) => boolean): boolean;
     /**
-     * @inheritDoc
+     * Returns the first element of this collection that satisfies the predicate.
      */
     find(cb: (item: T, index: number) => boolean): T | undefined;
     /**
-     * @inheritDoc
+     * Extracts a subset of the collection items.
      */
     filter(cb: (item: T, index: number) => boolean): T[];
     /**
-     * @inheritDoc
+     * Maps the collection items based on your provided mapper function.
      */
     map<R>(mapper: (item: T, index: number) => R): R[];
     /**
-     * @inheritDoc
+     * Maps the collection items based on your provided mapper function to a single object.
+     */
+    reduce<R>(cb: (obj: R, item: T, index: number) => R, initial?: R): R;
+    /**
+     * Maps the collection items to a dictionary, indexed by the key you specify.
+     * If there are more items with the same key, only the first one will be present.
      */
     indexBy<K1 extends keyof T, K2 extends keyof T = never>(key: K1): Record<T[K1] & PropertyKey, T>;
     /**
-     * @inheritDoc
+     * Maps the collection items to a dictionary, indexed by the key you specify.
+     * If there are more items with the same key, only the first one will be present.
      */
     indexBy<K1 extends keyof T, K2 extends keyof T = never>(key: K1, valueKey: K2): Record<T[K1] & PropertyKey, T[K2]>;
-    shouldPopulate(populated?: boolean): boolean;
-    populated(populated?: boolean | undefined): void;
-    init<TT extends T, P extends string = never>(options?: InitCollectionOptions<TT, P>): Promise<LoadedCollection<Loaded<TT, P>>>;
-    private getEntityManager;
-    private createCondition;
-    private createOrderBy;
-    private createManyToManyCondition;
-    private createLoadCountCondition;
-    private modify;
-    private checkInitialized;
+    isInitialized(fully?: boolean): boolean;
+    isDirty(): boolean;
+    isPartial(): boolean;
+    setDirty(dirty?: boolean): void;
+    get length(): number;
+    [Symbol.iterator](): IterableIterator<T>;
     /**
-     * re-orders items after searching with `$in` operator
+     * @internal
      */
-    private reorderItems;
-    private cancelOrphanRemoval;
-    private validateItemType;
-    private validateModification;
+    takeSnapshot(forcePropagate?: boolean): void;
+    /**
+     * @internal
+     */
+    getSnapshot(): T[] | undefined;
+    /**
+     * @internal
+     */
+    get property(): EntityProperty;
+    /**
+     * @internal
+     */
+    set property(prop: EntityProperty);
+    protected propagate(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
+    protected propagateToInverseSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
+    protected propagateToOwningSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
+    protected shouldPropagateToCollection(collection: Collection<O, T>, method: 'add' | 'remove' | 'takeSnapshot'): boolean;
+    protected incrementCount(value: number): void;
+    /** @ignore */
+    [inspect.custom](depth?: number): string;
 }
 export interface InitCollectionOptions<T, P extends string = never, F extends string = '*', E extends string = never> extends EntityLoaderOptions<T, F, E> {
     dataloader?: boolean;

package/entity/Collection.js CHANGED Viewed

@@ -1,17 +1,29 @@
-import { ArrayCollection } from './ArrayCollection.js';
+import { inspect } from 'node:util';
 import { Utils } from '../utils/Utils.js';
-import { ValidationError } from '../errors.js';
+import { MetadataError, ValidationError } from '../errors.js';
 import { DataloaderType, ReferenceKind } from '../enums.js';
 import { Reference } from './Reference.js';
-import { helper } from './wrap.js';
+import { helper, wrap } from './wrap.js';
 import { QueryHelper } from '../utils/QueryHelper.js';
-export class Collection extends ArrayCollection {
+export class Collection {
+    owner;
+    items = new Set();
+    initialized = true;
+    dirty = false;
+    partial = false; // mark partially loaded collections, propagation is disabled for those
+    snapshot = []; // used to create a diff of the collection at commit time, undefined marks overridden values so we need to wipe when flushing
     readonly;
+    _count;
+    _property;
     _populated;
-    // this is for some reason needed for TS, otherwise it can fail with `Type instantiation is excessively deep and possibly infinite.`
-    _snapshot;
     constructor(owner, items, initialized = true) {
-        super(owner, items);
+        this.owner = owner;
+        /* v8 ignore next 5 */
+        if (items) {
+            let i = 0;
+            this.items = new Set(items);
+            this.items.forEach(item => this[i++] = item);
+        }
         this.initialized = !!items || initialized;
     }
     /**
@@ -54,7 +66,7 @@ export class Collection extends ArrayCollection {
      */
     async loadItems(options) {
         await this.load(options);
-        return super.getItems();
+        return this.getItems(false);
     }
     /**
      * Gets the count of collection items from database instead of counting loaded items.
@@ -105,24 +117,42 @@ export class Collection extends ArrayCollection {
         if (check) {
             this.checkInitialized();
         }
-        return super.getItems();
+        return [...this.items];
     }
     toJSON() {
         if (!this.isInitialized()) {
             return [];
         }
-        return super.toJSON();
+        return this.toArray();
     }
     add(entity, ...entities) {
         entities = Utils.asArray(entity).concat(entities);
         const unwrapped = entities.map(i => Reference.unwrapReference(i));
-        unwrapped.forEach(entity => this.validateItemType(entity));
-        const added = this.modify('add', unwrapped);
+        this.validateModification(unwrapped);
+        const em = this.getEntityManager(entities, false);
+        let added = 0;
+        for (const item of entities) {
+            const entity = Reference.unwrapReference(item);
+            if (!this.contains(entity, false)) {
+                this.incrementCount(1);
+                this[this.items.size] = entity;
+                this.items.add(entity);
+                added++;
+                this.dirty = true;
+                this.propagate(entity, 'add');
+            }
+        }
+        if (this.property.kind === ReferenceKind.ONE_TO_MANY && em) {
+            em.persist(entities);
+        }
         this.cancelOrphanRemoval(unwrapped);
         return added;
     }
     /**
-     * @inheritDoc
+     * Remove specified item(s) from the collection. Note that removing item from collection does not necessarily imply deleting the target entity,
+     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
+     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
+     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
      */
     remove(entity, ...entities) {
         if (entity instanceof Function) {
@@ -134,72 +164,50 @@ export class Collection extends ArrayCollection {
             }
             return removed;
         }
+        this.checkInitialized();
         entities = Utils.asArray(entity).concat(entities);
         const unwrapped = entities.map(i => Reference.unwrapReference(i));
-        const removed = this.modify('remove', unwrapped);
-        const em = this.getEntityManager(unwrapped, false);
-        if (this.property.orphanRemoval && em) {
-            for (const item of unwrapped) {
-                em.getUnitOfWork().scheduleOrphanRemoval(item);
+        this.validateModification(unwrapped);
+        const em = this.getEntityManager(entities, false);
+        let removed = 0;
+        for (const item of entities) {
+            if (!item) {
+                continue;
+            }
+            const entity = Reference.unwrapReference(item);
+            if (this.items.delete(entity)) {
+                this.incrementCount(-1);
+                delete this[this.items.size]; // remove last item
+                this.propagate(entity, 'remove');
+                removed++;
+                this.dirty = true;
+            }
+            if (this.property.orphanRemoval && em) {
+                em.getUnitOfWork().scheduleOrphanRemoval(entity);
             }
         }
+        if (this.property.kind === ReferenceKind.ONE_TO_MANY && !this.property.orphanRemoval && em) {
+            em.persist(entities);
+        }
+        if (removed > 0) {
+            Object.assign(this, [...this.items]); // reassign array access
+        }
         return removed;
     }
     contains(item, check = true) {
         if (check) {
             this.checkInitialized();
         }
-        return super.contains(item);
+        const entity = Reference.unwrapReference(item);
+        return this.items.has(entity);
     }
     count() {
         this.checkInitialized();
-        return super.count();
+        return this.items.size;
     }
     isEmpty() {
         this.checkInitialized();
-        return super.isEmpty();
-    }
-    /**
-     * @inheritDoc
-     */
-    slice(start, end) {
-        this.checkInitialized();
-        return super.slice(start, end);
-    }
-    /**
-     * @inheritDoc
-     */
-    exists(cb) {
-        this.checkInitialized();
-        return super.exists(cb);
-    }
-    /**
-     * @inheritDoc
-     */
-    find(cb) {
-        this.checkInitialized();
-        return super.find(cb);
-    }
-    /**
-     * @inheritDoc
-     */
-    filter(cb) {
-        this.checkInitialized();
-        return super.filter(cb);
-    }
-    /**
-     * @inheritDoc
-     */
-    map(mapper) {
-        this.checkInitialized();
-        return super.map(mapper);
-    }
-    /**
-     * @inheritDoc
-     */
-    indexBy(key, valueKey) {
-        this.checkInitialized();
-        return super.indexBy(key, valueKey);
+        return this.count() === 0;
     }
     shouldPopulate(populated) {
         if (!this.isInitialized(true)) {
@@ -267,10 +275,8 @@ export class Collection extends ArrayCollection {
     getEntityManager(items = [], required = true) {
         const wrapped = helper(this.owner);
         let em = wrapped.__em;
-        // console.log('wat 1', em, this.owner);
         if (!em) {
             for (const i of items) {
-                // console.log('wat 2', i, i && helper(i).__em);
                 if (i && helper(i).__em) {
                     em = helper(i).__em;
                     break;
@@ -322,20 +328,6 @@ export class Collection extends ArrayCollection {
         }
         return cond;
     }
-    modify(method, items) {
-        if (method === 'remove') {
-            this.checkInitialized();
-        }
-        this.validateModification(items);
-        const modified = super[method](items);
-        if (modified > 0) {
-            this.setDirty();
-        }
-        if (this.property.kind === ReferenceKind.ONE_TO_MANY && (method === 'add' || !this.property.orphanRemoval)) {
-            this.getEntityManager(items, false)?.persist(items);
-        }
-        return modified;
-    }
     checkInitialized() {
         if (!this.isInitialized()) {
             throw new Error(`Collection<${this.property.type}> of entity ${this.owner.constructor.name}[${helper(this.owner).getSerializedPrimaryKey()}] not initialized`);
@@ -358,32 +350,362 @@ export class Collection extends ArrayCollection {
             em.getUnitOfWork().cancelOrphanRemoval(item);
         }
     }
-    validateItemType(item) {
-        if (!Utils.isEntity(item)) {
-            throw ValidationError.notEntity(this.owner, this.property, item);
-        }
-    }
     validateModification(items) {
         if (this.readonly) {
             throw ValidationError.cannotModifyReadonlyCollection(this.owner, this.property);
         }
-        // currently we allow persisting to inverse sides only in SQL drivers
-        if (this.property.pivotTable || !this.property.mappedBy) {
-            return;
-        }
         const check = (item) => {
-            if (!item || helper(item).__initialized) {
+            if (!item) {
+                return false;
+            }
+            if (!Utils.isEntity(item)) {
+                throw ValidationError.notEntity(this.owner, this.property, item);
+            }
+            // currently we allow persisting to inverse sides only in SQL drivers
+            if (this.property.pivotTable || !this.property.mappedBy) {
+                return false;
+            }
+            if (helper(item).__initialized) {
                 return false;
             }
             return !item[this.property.mappedBy] && this.property.kind === ReferenceKind.MANY_TO_MANY;
         };
         // throw if we are modifying inverse side of M:N collection when owning side is initialized (would be ignored when persisting)
-        if (items.find(item => check(item))) {
+        if (items.some(item => check(item))) {
             throw ValidationError.cannotModifyInverseCollection(this.owner, this.property);
         }
     }
+    toArray() {
+        if (this.items.size === 0) {
+            return [];
+        }
+        return this.map(item => wrap(item).toJSON());
+    }
+    getIdentifiers(field) {
+        const items = this.getItems();
+        const targetMeta = this.property.targetMeta;
+        if (items.length === 0) {
+            return [];
+        }
+        field ??= targetMeta.compositePK ? targetMeta.primaryKeys : (targetMeta.serializedPrimaryKey ?? targetMeta.primaryKeys[0]);
+        const cb = (i, f) => {
+            if (Utils.isEntity(i[f], true)) {
+                return wrap(i[f], true).getPrimaryKey();
+            }
+            return i[f];
+        };
+        return items.map(i => {
+            if (Array.isArray(field)) {
+                return field.map(f => cb(i, f));
+            }
+            return cb(i, field);
+        });
+    }
+    /**
+     * @internal
+     */
+    addWithoutPropagation(entity) {
+        if (!this.contains(entity, false)) {
+            this.incrementCount(1);
+            this[this.items.size] = entity;
+            this.items.add(entity);
+            this.dirty = true;
+        }
+    }
+    set(items) {
+        if (!this.initialized) {
+            this.initialized = true;
+            this.snapshot = undefined;
+        }
+        if (this.compare(Utils.asArray(items).map(item => Reference.unwrapReference(item)))) {
+            return;
+        }
+        this.remove(this.items);
+        this.add(items);
+    }
+    compare(items) {
+        if (items.length !== this.items.size) {
+            return false;
+        }
+        let idx = 0;
+        for (const item of this.items) {
+            if (item !== items[idx++]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * @internal
+     */
+    hydrate(items, forcePropagate, partial) {
+        for (let i = 0; i < this.items.size; i++) {
+            delete this[i];
+        }
+        this.initialized = true;
+        this.partial = !!partial;
+        this.items.clear();
+        this._count = 0;
+        this.add(items);
+        this.takeSnapshot(forcePropagate);
+    }
+    /**
+     * Remove all items from the collection. Note that removing items from collection does not necessarily imply deleting the target entity,
+     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
+     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
+     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
+     */
+    removeAll() {
+        if (!this.initialized) {
+            this.initialized = true;
+            this.snapshot = undefined;
+        }
+        this.remove(this.items);
+        this.dirty = true;
+    }
+    /**
+     * @internal
+     */
+    removeWithoutPropagation(entity) {
+        if (!this.items.delete(entity)) {
+            return;
+        }
+        this.incrementCount(-1);
+        delete this[this.items.size];
+        Object.assign(this, [...this.items]);
+        this.dirty = true;
+    }
+    /**
+     * Extracts a slice of the collection items starting at position start to end (exclusive) of the collection.
+     * If end is null it returns all elements from start to the end of the collection.
+     */
+    slice(start = 0, end) {
+        this.checkInitialized();
+        let index = 0;
+        end ??= this.items.size;
+        const items = [];
+        for (const item of this.items) {
+            if (index === end) {
+                break;
+            }
+            if (index >= start && index < end) {
+                items.push(item);
+            }
+            index++;
+        }
+        return items;
+    }
+    /**
+     * Tests for the existence of an element that satisfies the given predicate.
+     */
+    exists(cb) {
+        this.checkInitialized();
+        for (const item of this.items) {
+            if (cb(item)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Returns the first element of this collection that satisfies the predicate.
+     */
+    find(cb) {
+        this.checkInitialized();
+        let index = 0;
+        for (const item of this.items) {
+            if (cb(item, index++)) {
+                return item;
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Extracts a subset of the collection items.
+     */
+    filter(cb) {
+        this.checkInitialized();
+        const items = [];
+        let index = 0;
+        for (const item of this.items) {
+            if (cb(item, index++)) {
+                items.push(item);
+            }
+        }
+        return items;
+    }
+    /**
+     * Maps the collection items based on your provided mapper function.
+     */
+    map(mapper) {
+        this.checkInitialized();
+        const items = [];
+        let index = 0;
+        for (const item of this.items) {
+            items.push(mapper(item, index++));
+        }
+        return items;
+    }
+    /**
+     * Maps the collection items based on your provided mapper function to a single object.
+     */
+    reduce(cb, initial = {}) {
+        this.checkInitialized();
+        let index = 0;
+        for (const item of this.items) {
+            initial = cb(initial, item, index++);
+        }
+        return initial;
+    }
+    /**
+     * Maps the collection items to a dictionary, indexed by the key you specify.
+     * If there are more items with the same key, only the first one will be present.
+     */
+    indexBy(key, valueKey) {
+        return this.reduce((obj, item) => {
+            obj[item[key]] ??= valueKey ? item[valueKey] : item;
+            return obj;
+        }, {});
+    }
+    isInitialized(fully = false) {
+        if (!this.initialized || !fully) {
+            return this.initialized;
+        }
+        for (const item of this.items) {
+            if (!helper(item).__initialized) {
+                return false;
+            }
+        }
+        return true;
+    }
+    isDirty() {
+        return this.dirty;
+    }
+    isPartial() {
+        return this.partial;
+    }
+    setDirty(dirty = true) {
+        this.dirty = dirty;
+    }
+    get length() {
+        return this.count();
+    }
+    *[Symbol.iterator]() {
+        for (const item of this.getItems()) {
+            yield item;
+        }
+    }
+    /**
+     * @internal
+     */
+    takeSnapshot(forcePropagate) {
+        this.snapshot = [...this.items];
+        this.dirty = false;
+        if (this.property.owner || forcePropagate) {
+            this.items.forEach(item => {
+                this.propagate(item, 'takeSnapshot');
+            });
+        }
+    }
+    /**
+     * @internal
+     */
+    getSnapshot() {
+        return this.snapshot;
+    }
+    /**
+     * @internal
+     */
+    get property() {
+        if (!this._property) {
+            const meta = wrap(this.owner, true).__meta;
+            /* v8 ignore next 3 */
+            if (!meta) {
+                throw MetadataError.fromUnknownEntity(this.owner.constructor.name, 'Collection.property getter, maybe you just forgot to initialize the ORM?');
+            }
+            this._property = meta.relations.find(prop => this.owner[prop.name] === this);
+        }
+        return this._property;
+    }
+    /**
+     * @internal
+     */
+    set property(prop) {
+        this._property = prop;
+    }
+    propagate(item, method) {
+        if (this.property.owner && this.property.inversedBy) {
+            this.propagateToInverseSide(item, method);
+        }
+        else if (!this.property.owner && this.property.mappedBy) {
+            this.propagateToOwningSide(item, method);
+        }
+    }
+    propagateToInverseSide(item, method) {
+        const collection = item[this.property.inversedBy];
+        if (this.shouldPropagateToCollection(collection, method)) {
+            method = method === 'takeSnapshot' ? method : (method + 'WithoutPropagation');
+            collection[method](this.owner);
+        }
+    }
+    propagateToOwningSide(item, method) {
+        const mappedBy = this.property.mappedBy;
+        const collection = item[mappedBy];
+        if (this.property.kind === ReferenceKind.MANY_TO_MANY) {
+            if (this.shouldPropagateToCollection(collection, method)) {
+                collection[method](this.owner);
+            }
+        }
+        else if (this.property.kind === ReferenceKind.ONE_TO_MANY && method !== 'takeSnapshot') {
+            const prop2 = this.property.targetMeta.properties[mappedBy];
+            const owner = prop2.mapToPk ? helper(this.owner).getPrimaryKey() : this.owner;
+            const value = method === 'add' ? owner : null;
+            if (this.property.orphanRemoval && method === 'remove') {
+                // cache the PK before we propagate, as its value might be needed when flushing
+                helper(item).__pk = helper(item).getPrimaryKey();
+            }
+            if (!prop2.nullable && prop2.deleteRule !== 'cascade' && method === 'remove') {
+                if (!this.property.orphanRemoval) {
+                    throw ValidationError.cannotRemoveFromCollectionWithoutOrphanRemoval(this.owner, this.property);
+                }
+                return;
+            }
+            // skip if already propagated
+            if (Reference.unwrapReference(item[mappedBy]) !== value) {
+                item[mappedBy] = value;
+            }
+        }
+    }
+    shouldPropagateToCollection(collection, method) {
+        if (!collection) {
+            return false;
+        }
+        switch (method) {
+            case 'add':
+                return !collection.contains(this.owner, false);
+            case 'remove':
+                return collection.isInitialized() && collection.contains(this.owner, false);
+            case 'takeSnapshot':
+                return collection.isDirty();
+        }
+    }
+    incrementCount(value) {
+        if (typeof this._count === 'number' && this.initialized) {
+            this._count += value;
+        }
+    }
+    /** @ignore */
+    [inspect.custom](depth = 2) {
+        const object = { ...this };
+        const hidden = ['items', 'owner', '_property', '_count', 'snapshot', '_populated', '_lazyInitialized', '_em', 'readonly', 'partial'];
+        hidden.forEach(k => delete object[k]);
+        const ret = inspect(object, { depth });
+        const name = `${this.constructor.name}<${this.property?.type ?? 'unknown'}>`;
+        return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
+    }
 }
 Object.defineProperties(Collection.prototype, {
     $: { get() { return this; } },
     get: { get() { return () => this; } },
+    __collection: { value: true, enumerable: false, writable: false },
 });

package/entity/index.d.ts CHANGED Viewed

@@ -4,7 +4,6 @@ export * from './EntityValidator.js';
 export * from './EntityAssigner.js';
 export * from './EntityHelper.js';
 export * from './EntityFactory.js';
-export * from './ArrayCollection.js';
 export * from './Collection.js';
 export * from './EntityLoader.js';
 export * from './Reference.js';

package/entity/index.js CHANGED Viewed

@@ -4,7 +4,6 @@ export * from './EntityValidator.js';
 export * from './EntityAssigner.js';
 export * from './EntityHelper.js';
 export * from './EntityFactory.js';
-export * from './ArrayCollection.js';
 export * from './Collection.js';
 export * from './EntityLoader.js';
 export * from './Reference.js';

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.66",
+  "version": "7.0.0-dev.67",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "exports": {
     "./package.json": "./package.json",
@@ -52,7 +52,7 @@
     "access": "public"
   },
   "dependencies": {
-    "mikro-orm": "7.0.0-dev.66"
+    "mikro-orm": "7.0.0-dev.67"
   },
   "peerDependencies": {
     "dataloader": "2.2.3"

package/entity/ArrayCollection.d.ts DELETED Viewed

@@ -1,118 +0,0 @@
-import { inspect } from 'node:util';
-import type { EntityDTO, EntityProperty, IPrimaryKey, Primary } from '../typings.js';
-import { Reference } from './Reference.js';
-export declare class ArrayCollection<T extends object, O extends object> {
-    readonly owner: O;
-    protected readonly items: Set<T>;
-    protected initialized: boolean;
-    protected dirty: boolean;
-    protected partial: boolean;
-    protected snapshot: T[] | undefined;
-    protected _count?: number;
-    private _property?;
-    constructor(owner: O, items?: T[]);
-    loadCount(): Promise<number>;
-    getItems(): T[];
-    toArray<TT extends T>(): EntityDTO<TT>[];
-    toJSON(): EntityDTO<T>[];
-    getIdentifiers<U extends IPrimaryKey = Primary<T> & IPrimaryKey>(field?: string | string[]): U[];
-    add(entity: T | Reference<T> | Iterable<T | Reference<T>>, ...entities: (T | Reference<T>)[]): number;
-    /**
-     * @internal
-     */
-    addWithoutPropagation(entity: T): void;
-    set(items: Iterable<T | Reference<T>>): void;
-    private compare;
-    /**
-     * @internal
-     */
-    hydrate(items: T[], forcePropagate?: boolean, partial?: boolean): void;
-    /**
-     * Remove specified item(s) from the collection. Note that removing item from collection does not necessarily imply deleting the target entity,
-     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
-     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
-     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
-     */
-    remove(entity: T | Reference<T> | Iterable<T | Reference<T>>, ...entities: (T | Reference<T>)[]): number;
-    /**
-     * Remove all items from the collection. Note that removing items from collection does not necessarily imply deleting the target entity,
-     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
-     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
-     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
-     */
-    removeAll(): void;
-    /**
-     * @internal
-     */
-    removeWithoutPropagation(entity: T): void;
-    contains(item: T | Reference<T>, check?: boolean): boolean;
-    /**
-     * Extracts a slice of the collection items starting at position start to end (exclusive) of the collection.
-     * If end is null it returns all elements from start to the end of the collection.
-     */
-    slice(start?: number, end?: number): T[];
-    /**
-     * Tests for the existence of an element that satisfies the given predicate.
-     */
-    exists(cb: (item: T) => boolean): boolean;
-    /**
-     * Returns the first element of this collection that satisfies the predicate.
-     */
-    find(cb: (item: T, index: number) => boolean): T | undefined;
-    /**
-     * Extracts a subset of the collection items.
-     */
-    filter(cb: (item: T, index: number) => boolean): T[];
-    /**
-     * Maps the collection items based on your provided mapper function.
-     */
-    map<R>(mapper: (item: T, index: number) => R): R[];
-    /**
-     * Maps the collection items based on your provided mapper function to a single object.
-     */
-    reduce<R>(cb: (obj: R, item: T, index: number) => R, initial?: R): R;
-    /**
-     * Maps the collection items to a dictionary, indexed by the key you specify.
-     * If there are more items with the same key, only the first one will be present.
-     */
-    indexBy<K1 extends keyof T, K2 extends keyof T = never>(key: K1): Record<T[K1] & PropertyKey, T>;
-    /**
-     * Maps the collection items to a dictionary, indexed by the key you specify.
-     * If there are more items with the same key, only the first one will be present.
-     */
-    indexBy<K1 extends keyof T, K2 extends keyof T = never>(key: K1, valueKey: K2): Record<T[K1] & PropertyKey, T[K2]>;
-    count(): number;
-    isInitialized(fully?: boolean): boolean;
-    isDirty(): boolean;
-    isPartial(): boolean;
-    isEmpty(): boolean;
-    setDirty(dirty?: boolean): void;
-    get length(): number;
-    [Symbol.iterator](): IterableIterator<T>;
-    /**
-     * @internal
-     */
-    takeSnapshot(forcePropagate?: boolean): void;
-    /**
-     * @internal
-     */
-    getSnapshot(): T[] | undefined;
-    /**
-     * @internal
-     */
-    get property(): EntityProperty;
-    /**
-     * @internal
-     */
-    set property(prop: EntityProperty);
-    protected propagate(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
-    protected propagateToInverseSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
-    protected propagateToOwningSide(item: T, method: 'add' | 'remove' | 'takeSnapshot'): void;
-    protected shouldPropagateToCollection(collection: ArrayCollection<O, T>, method: 'add' | 'remove' | 'takeSnapshot'): boolean;
-    protected incrementCount(value: number): void;
-    /** @ignore */
-    [inspect.custom](depth?: number): string;
-}
-export interface ArrayCollection<T, O> {
-    [k: number]: T;
-}

package/entity/ArrayCollection.js DELETED Viewed

@@ -1,410 +0,0 @@
-import { inspect } from 'node:util';
-import { Reference } from './Reference.js';
-import { helper, wrap } from './wrap.js';
-import { MetadataError, ValidationError } from '../errors.js';
-import { ReferenceKind } from '../enums.js';
-import { Utils } from '../utils/Utils.js';
-export class ArrayCollection {
-    owner;
-    items = new Set();
-    initialized = true;
-    dirty = false;
-    partial = false; // mark partially loaded collections, propagation is disabled for those
-    snapshot = []; // used to create a diff of the collection at commit time, undefined marks overridden values so we need to wipe when flushing
-    _count;
-    _property;
-    constructor(owner, items) {
-        this.owner = owner;
-        /* v8 ignore next 5 */
-        if (items) {
-            let i = 0;
-            this.items = new Set(items);
-            this.items.forEach(item => this[i++] = item);
-        }
-    }
-    async loadCount() {
-        return this.items.size;
-    }
-    getItems() {
-        return [...this.items];
-    }
-    toArray() {
-        if (this.items.size === 0) {
-            return [];
-        }
-        return this.map(item => wrap(item).toJSON());
-    }
-    toJSON() {
-        return this.toArray();
-    }
-    getIdentifiers(field) {
-        const items = this.getItems();
-        const targetMeta = this.property.targetMeta;
-        if (items.length === 0) {
-            return [];
-        }
-        field ??= targetMeta.compositePK ? targetMeta.primaryKeys : (targetMeta.serializedPrimaryKey ?? targetMeta.primaryKeys[0]);
-        const cb = (i, f) => {
-            if (Utils.isEntity(i[f], true)) {
-                return wrap(i[f], true).getPrimaryKey();
-            }
-            return i[f];
-        };
-        return items.map(i => {
-            if (Array.isArray(field)) {
-                return field.map(f => cb(i, f));
-            }
-            return cb(i, field);
-        });
-    }
-    add(entity, ...entities) {
-        entities = Utils.asArray(entity).concat(entities);
-        let added = 0;
-        for (const item of entities) {
-            const entity = Reference.unwrapReference(item);
-            if (!this.contains(entity, false)) {
-                this.incrementCount(1);
-                this[this.items.size] = entity;
-                this.items.add(entity);
-                added++;
-                this.propagate(entity, 'add');
-            }
-        }
-        return added;
-    }
-    /**
-     * @internal
-     */
-    addWithoutPropagation(entity) {
-        if (!this.contains(entity, false)) {
-            this.incrementCount(1);
-            this[this.items.size] = entity;
-            this.items.add(entity);
-            this.dirty = true;
-        }
-    }
-    set(items) {
-        if (!this.initialized) {
-            this.initialized = true;
-            this.snapshot = undefined;
-        }
-        if (this.compare(Utils.asArray(items).map(item => Reference.unwrapReference(item)))) {
-            return;
-        }
-        this.remove(this.items);
-        this.add(items);
-    }
-    compare(items) {
-        if (items.length !== this.items.size) {
-            return false;
-        }
-        let idx = 0;
-        for (const item of this.items) {
-            if (item !== items[idx++]) {
-                return false;
-            }
-        }
-        return true;
-    }
-    /**
-     * @internal
-     */
-    hydrate(items, forcePropagate, partial) {
-        for (let i = 0; i < this.items.size; i++) {
-            delete this[i];
-        }
-        this.initialized = true;
-        this.partial = !!partial;
-        this.items.clear();
-        this._count = 0;
-        this.add(items);
-        this.takeSnapshot(forcePropagate);
-    }
-    /**
-     * Remove specified item(s) from the collection. Note that removing item from collection does not necessarily imply deleting the target entity,
-     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
-     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
-     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
-     */
-    remove(entity, ...entities) {
-        entities = Utils.asArray(entity).concat(entities);
-        let removed = 0;
-        for (const item of entities) {
-            if (!item) {
-                continue;
-            }
-            const entity = Reference.unwrapReference(item);
-            if (this.items.delete(entity)) {
-                this.incrementCount(-1);
-                delete this[this.items.size]; // remove last item
-                this.propagate(entity, 'remove');
-                removed++;
-            }
-        }
-        if (removed > 0) {
-            Object.assign(this, [...this.items]); // reassign array access
-        }
-        return removed;
-    }
-    /**
-     * Remove all items from the collection. Note that removing items from collection does not necessarily imply deleting the target entity,
-     * it means we are disconnecting the relation - removing items from collection, not removing entities from database - `Collection.remove()`
-     * is not the same as `em.remove()`. If we want to delete the entity by removing it from collection, we need to enable `orphanRemoval: true`,
-     * which tells the ORM we don't want orphaned entities to exist, so we know those should be removed.
-     */
-    removeAll() {
-        if (!this.initialized) {
-            this.initialized = true;
-            this.snapshot = undefined;
-        }
-        this.remove(this.items);
-        this.setDirty();
-    }
-    /**
-     * @internal
-     */
-    removeWithoutPropagation(entity) {
-        if (!this.items.delete(entity)) {
-            return;
-        }
-        this.incrementCount(-1);
-        delete this[this.items.size];
-        Object.assign(this, [...this.items]);
-        this.dirty = true;
-    }
-    contains(item, check) {
-        const entity = Reference.unwrapReference(item);
-        return this.items.has(entity);
-    }
-    /**
-     * Extracts a slice of the collection items starting at position start to end (exclusive) of the collection.
-     * If end is null it returns all elements from start to the end of the collection.
-     */
-    slice(start = 0, end) {
-        let index = 0;
-        end ??= this.items.size;
-        const items = [];
-        for (const item of this.items) {
-            if (index === end) {
-                break;
-            }
-            if (index >= start && index < end) {
-                items.push(item);
-            }
-            index++;
-        }
-        return items;
-    }
-    /**
-     * Tests for the existence of an element that satisfies the given predicate.
-     */
-    exists(cb) {
-        for (const item of this.items) {
-            if (cb(item)) {
-                return true;
-            }
-        }
-        return false;
-    }
-    /**
-     * Returns the first element of this collection that satisfies the predicate.
-     */
-    find(cb) {
-        let index = 0;
-        for (const item of this.items) {
-            if (cb(item, index++)) {
-                return item;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Extracts a subset of the collection items.
-     */
-    filter(cb) {
-        const items = [];
-        let index = 0;
-        for (const item of this.items) {
-            if (cb(item, index++)) {
-                items.push(item);
-            }
-        }
-        return items;
-    }
-    /**
-     * Maps the collection items based on your provided mapper function.
-     */
-    map(mapper) {
-        const items = [];
-        let index = 0;
-        for (const item of this.items) {
-            items.push(mapper(item, index++));
-        }
-        return items;
-    }
-    /**
-     * Maps the collection items based on your provided mapper function to a single object.
-     */
-    reduce(cb, initial = {}) {
-        let index = 0;
-        for (const item of this.items) {
-            initial = cb(initial, item, index++);
-        }
-        return initial;
-    }
-    /**
-     * Maps the collection items to a dictionary, indexed by the key you specify.
-     * If there are more items with the same key, only the first one will be present.
-     */
-    indexBy(key, valueKey) {
-        return this.reduce((obj, item) => {
-            obj[item[key]] ??= valueKey ? item[valueKey] : item;
-            return obj;
-        }, {});
-    }
-    count() {
-        return this.items.size;
-    }
-    isInitialized(fully = false) {
-        if (!this.initialized || !fully) {
-            return this.initialized;
-        }
-        for (const item of this.items) {
-            if (!helper(item).__initialized) {
-                return false;
-            }
-        }
-        return true;
-    }
-    isDirty() {
-        return this.dirty;
-    }
-    isPartial() {
-        return this.partial;
-    }
-    isEmpty() {
-        return this.count() === 0;
-    }
-    setDirty(dirty = true) {
-        this.dirty = dirty;
-    }
-    get length() {
-        return this.count();
-    }
-    *[Symbol.iterator]() {
-        for (const item of this.getItems()) {
-            yield item;
-        }
-    }
-    /**
-     * @internal
-     */
-    takeSnapshot(forcePropagate) {
-        this.snapshot = [...this.items];
-        this.setDirty(false);
-        if (this.property.owner || forcePropagate) {
-            this.items.forEach(item => {
-                this.propagate(item, 'takeSnapshot');
-            });
-        }
-    }
-    /**
-     * @internal
-     */
-    getSnapshot() {
-        return this.snapshot;
-    }
-    /**
-     * @internal
-     */
-    get property() {
-        if (!this._property) {
-            const meta = wrap(this.owner, true).__meta;
-            /* v8 ignore next 3 */
-            if (!meta) {
-                throw MetadataError.fromUnknownEntity(this.owner.constructor.name, 'Collection.property getter, maybe you just forgot to initialize the ORM?');
-            }
-            this._property = meta.relations.find(prop => this.owner[prop.name] === this);
-        }
-        return this._property;
-    }
-    /**
-     * @internal
-     */
-    set property(prop) {
-        this._property = prop;
-    }
-    propagate(item, method) {
-        if (this.property.owner && this.property.inversedBy) {
-            this.propagateToInverseSide(item, method);
-        }
-        else if (!this.property.owner && this.property.mappedBy) {
-            this.propagateToOwningSide(item, method);
-        }
-    }
-    propagateToInverseSide(item, method) {
-        const collection = item[this.property.inversedBy];
-        if (this.shouldPropagateToCollection(collection, method)) {
-            method = method === 'takeSnapshot' ? method : (method + 'WithoutPropagation');
-            collection[method](this.owner);
-        }
-    }
-    propagateToOwningSide(item, method) {
-        const mappedBy = this.property.mappedBy;
-        const collection = item[mappedBy];
-        if (this.property.kind === ReferenceKind.MANY_TO_MANY) {
-            if (this.shouldPropagateToCollection(collection, method)) {
-                collection[method](this.owner);
-            }
-        }
-        else if (this.property.kind === ReferenceKind.ONE_TO_MANY && method !== 'takeSnapshot') {
-            const prop2 = this.property.targetMeta.properties[mappedBy];
-            const owner = prop2.mapToPk ? helper(this.owner).getPrimaryKey() : this.owner;
-            const value = method === 'add' ? owner : null;
-            if (this.property.orphanRemoval && method === 'remove') {
-                // cache the PK before we propagate, as its value might be needed when flushing
-                helper(item).__pk = helper(item).getPrimaryKey();
-            }
-            if (!prop2.nullable && prop2.deleteRule !== 'cascade' && method === 'remove') {
-                if (!this.property.orphanRemoval) {
-                    throw ValidationError.cannotRemoveFromCollectionWithoutOrphanRemoval(this.owner, this.property);
-                }
-                return;
-            }
-            // skip if already propagated
-            if (Reference.unwrapReference(item[mappedBy]) !== value) {
-                item[mappedBy] = value;
-            }
-        }
-    }
-    shouldPropagateToCollection(collection, method) {
-        if (!collection) {
-            return false;
-        }
-        switch (method) {
-            case 'add':
-                return !collection.contains(this.owner, false);
-            case 'remove':
-                return collection.isInitialized() && collection.contains(this.owner, false);
-            case 'takeSnapshot':
-                return collection.isDirty();
-        }
-    }
-    incrementCount(value) {
-        if (typeof this._count === 'number' && this.initialized) {
-            this._count += value;
-        }
-    }
-    /** @ignore */
-    [inspect.custom](depth = 2) {
-        const object = { ...this };
-        const hidden = ['items', 'owner', '_property', '_count', 'snapshot', '_populated', '_snapshot', '_lazyInitialized', '_em', 'readonly', 'partial'];
-        hidden.forEach(k => delete object[k]);
-        const ret = inspect(object, { depth });
-        const name = `${this.constructor.name}<${this.property?.type ?? 'unknown'}>`;
-        return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
-    }
-}
-Object.defineProperties(ArrayCollection.prototype, {
-    __collection: { value: true, enumerable: false, writable: false },
-});