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

package/entity/ArrayCollection.d.ts

@@ -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

@@ -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 },
-});