@mikro-orm/core 7.0.2-dev.8 → 7.0.2

package/cache/FileCacheAdapter.js

@@ -2,88 +2,90 @@ import { existsSync, readFileSync, writeFileSync, unlinkSync } from 'node:fs';
 import { fs } from '../utils/fs-utils.js';
 import { Utils } from '../utils/Utils.js';
 export class FileCacheAdapter {
-    #VERSION = Utils.getORMVersion();
-    #cache = {};
-    #options;
-    #baseDir;
-    #pretty;
-    constructor(options = {}, baseDir, pretty = false) {
-        this.#options = options;
-        this.#baseDir = baseDir;
-        this.#pretty = pretty;
-        this.#options.cacheDir ??= process.cwd() + '/temp';
+  #VERSION = Utils.getORMVersion();
+  #cache = {};
+  #options;
+  #baseDir;
+  #pretty;
+  constructor(options = {}, baseDir, pretty = false) {
+    this.#options = options;
+    this.#baseDir = baseDir;
+    this.#pretty = pretty;
+    this.#options.cacheDir ??= process.cwd() + '/temp';
+  }
+  /**
+   * @inheritDoc
+   */
+  get(name) {
+    const path = this.path(name);
+    if (!existsSync(path)) {
+      return null;
     }
-    /**
-     * @inheritDoc
-     */
-    get(name) {
-        const path = this.path(name);
-        if (!existsSync(path)) {
-            return null;
-        }
-        const payload = fs.readJSONSync(path);
-        const hash = this.getHash(payload.origin);
-        if (!hash || payload.hash !== hash) {
-            return null;
-        }
-        return payload.data;
+    const payload = fs.readJSONSync(path);
+    const hash = this.getHash(payload.origin);
+    if (!hash || payload.hash !== hash) {
+      return null;
     }
-    /**
-     * @inheritDoc
-     */
-    set(name, data, origin) {
-        if (this.#options.combined) {
-            this.#cache[name.replace(/\.[jt]s$/, '')] = data;
-            return;
-        }
-        const path = this.path(name);
-        const hash = this.getHash(origin);
-        writeFileSync(path, JSON.stringify({ data, origin, hash, version: this.#VERSION }, null, this.#pretty ? 2 : undefined));
+    return payload.data;
+  }
+  /**
+   * @inheritDoc
+   */
+  set(name, data, origin) {
+    if (this.#options.combined) {
+      this.#cache[name.replace(/\.[jt]s$/, '')] = data;
+      return;
     }
-    /**
-     * @inheritDoc
-     */
-    remove(name) {
-        const path = this.path(name);
-        unlinkSync(path);
+    const path = this.path(name);
+    const hash = this.getHash(origin);
+    writeFileSync(
+      path,
+      JSON.stringify({ data, origin, hash, version: this.#VERSION }, null, this.#pretty ? 2 : undefined),
+    );
+  }
+  /**
+   * @inheritDoc
+   */
+  remove(name) {
+    const path = this.path(name);
+    unlinkSync(path);
+  }
+  /**
+   * @inheritDoc
+   */
+  clear() {
+    const path = this.path('*');
+    const files = fs.glob(path);
+    for (const file of files) {
+      /* v8 ignore next */
+      try {
+        unlinkSync(file);
+      } catch {
+        // ignore if file is already gone
+      }
     }
-    /**
-     * @inheritDoc
-     */
-    clear() {
-        const path = this.path('*');
-        const files = fs.glob(path);
-        for (const file of files) {
-            /* v8 ignore next */
-            try {
-                unlinkSync(file);
-            }
-            catch {
-                // ignore if file is already gone
-            }
-        }
-        this.#cache = {};
+    this.#cache = {};
+  }
+  combine() {
+    if (!this.#options.combined) {
+      return;
     }
-    combine() {
-        if (!this.#options.combined) {
-            return;
-        }
-        let path = typeof this.#options.combined === 'string' ? this.#options.combined : './metadata.json';
-        path = fs.normalizePath(this.#options.cacheDir, path);
-        this.#options.combined = path; // override in the options, so we can log it from the CLI in `cache:generate` command
-        writeFileSync(path, JSON.stringify(this.#cache, null, this.#pretty ? 2 : undefined));
-        return path;
-    }
-    path(name) {
-        fs.ensureDir(this.#options.cacheDir);
-        return `${this.#options.cacheDir}/${name}.json`;
-    }
-    getHash(origin) {
-        origin = fs.absolutePath(origin, this.#baseDir);
-        if (!existsSync(origin)) {
-            return null;
-        }
-        const contents = readFileSync(origin);
-        return Utils.hash(contents.toString() + this.#VERSION);
+    let path = typeof this.#options.combined === 'string' ? this.#options.combined : './metadata.json';
+    path = fs.normalizePath(this.#options.cacheDir, path);
+    this.#options.combined = path; // override in the options, so we can log it from the CLI in `cache:generate` command
+    writeFileSync(path, JSON.stringify(this.#cache, null, this.#pretty ? 2 : undefined));
+    return path;
+  }
+  path(name) {
+    fs.ensureDir(this.#options.cacheDir);
+    return `${this.#options.cacheDir}/${name}.json`;
+  }
+  getHash(origin) {
+    origin = fs.absolutePath(origin, this.#baseDir);
+    if (!existsSync(origin)) {
+      return null;
     }
+    const contents = readFileSync(origin);
+    return Utils.hash(contents.toString() + this.#VERSION);
+  }
 }

package/cache/GeneratedCacheAdapter.d.ts

@@ -1,24 +1,23 @@
 import type { CacheAdapter } from './CacheAdapter.js';
 import type { Dictionary } from '../typings.js';
+/** Cache adapter backed by pre-generated static data, typically produced by the CLI cache:generate command. */
 export declare class GeneratedCacheAdapter implements CacheAdapter {
-    #private;
-    constructor(options: {
-        data: Dictionary;
-    });
-    /**
-     * @inheritDoc
-     */
-    get<T = any>(name: string): T | undefined;
-    /**
-     * @inheritDoc
-     */
-    set(name: string, data: any, origin: string): void;
-    /**
-     * @inheritDoc
-     */
-    remove(name: string): void;
-    /**
-     * @inheritDoc
-     */
-    clear(): void;
+  #private;
+  constructor(options: { data: Dictionary });
+  /**
+   * @inheritDoc
+   */
+  get<T = any>(name: string): T | undefined;
+  /**
+   * @inheritDoc
+   */
+  set(name: string, data: any, origin: string): void;
+  /**
+   * @inheritDoc
+   */
+  remove(name: string): void;
+  /**
+   * @inheritDoc
+   */
+  clear(): void;
 }

package/cache/GeneratedCacheAdapter.js

@@ -1,32 +1,33 @@
+/** Cache adapter backed by pre-generated static data, typically produced by the CLI cache:generate command. */
 export class GeneratedCacheAdapter {
-    #data;
-    constructor(options) {
-        this.#data = new Map(Object.entries(options.data));
-    }
-    /**
-     * @inheritDoc
-     */
-    get(name) {
-        const key = name.replace(/\.[jt]s$/, '');
-        const data = this.#data.get(key);
-        return data;
-    }
-    /**
-     * @inheritDoc
-     */
-    set(name, data, origin) {
-        this.#data.set(name, { data });
-    }
-    /**
-     * @inheritDoc
-     */
-    remove(name) {
-        this.#data.delete(name);
-    }
-    /**
-     * @inheritDoc
-     */
-    clear() {
-        this.#data.clear();
-    }
+  #data;
+  constructor(options) {
+    this.#data = new Map(Object.entries(options.data));
+  }
+  /**
+   * @inheritDoc
+   */
+  get(name) {
+    const key = name.replace(/\.[jt]s$/, '');
+    const data = this.#data.get(key);
+    return data;
+  }
+  /**
+   * @inheritDoc
+   */
+  set(name, data, origin) {
+    this.#data.set(name, { data });
+  }
+  /**
+   * @inheritDoc
+   */
+  remove(name) {
+    this.#data.delete(name);
+  }
+  /**
+   * @inheritDoc
+   */
+  clear() {
+    this.#data.clear();
+  }
 }

package/cache/MemoryCacheAdapter.d.ts

@@ -1,23 +1,22 @@
 import type { CacheAdapter } from './CacheAdapter.js';
+/** In-memory cache adapter with time-based expiration. Used as the default result cache. */
 export declare class MemoryCacheAdapter implements CacheAdapter {
-    #private;
-    constructor(options: {
-        expiration: number;
-    });
-    /**
-     * @inheritDoc
-     */
-    get<T = any>(name: string): T | undefined;
-    /**
-     * @inheritDoc
-     */
-    set(name: string, data: any, origin: string, expiration?: number): void;
-    /**
-     * @inheritDoc
-     */
-    remove(name: string): void;
-    /**
-     * @inheritDoc
-     */
-    clear(): void;
+  #private;
+  constructor(options: { expiration: number });
+  /**
+   * @inheritDoc
+   */
+  get<T = any>(name: string): T | undefined;
+  /**
+   * @inheritDoc
+   */
+  set(name: string, data: any, origin: string, expiration?: number): void;
+  /**
+   * @inheritDoc
+   */
+  remove(name: string): void;
+  /**
+   * @inheritDoc
+   */
+  clear(): void;
 }

package/cache/MemoryCacheAdapter.js

@@ -1,40 +1,40 @@
+/** In-memory cache adapter with time-based expiration. Used as the default result cache. */
 export class MemoryCacheAdapter {
-    #data = new Map();
-    #options;
-    constructor(options) {
-        this.#options = options;
-    }
-    /**
-     * @inheritDoc
-     */
-    get(name) {
-        const data = this.#data.get(name);
-        if (data) {
-            if (data.expiration < Date.now()) {
-                this.#data.delete(name);
-            }
-            else {
-                return data.data;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * @inheritDoc
-     */
-    set(name, data, origin, expiration) {
-        this.#data.set(name, { data, expiration: Date.now() + (expiration ?? this.#options.expiration) });
-    }
-    /**
-     * @inheritDoc
-     */
-    remove(name) {
+  #data = new Map();
+  #options;
+  constructor(options) {
+    this.#options = options;
+  }
+  /**
+   * @inheritDoc
+   */
+  get(name) {
+    const data = this.#data.get(name);
+    if (data) {
+      if (data.expiration < Date.now()) {
         this.#data.delete(name);
+      } else {
+        return data.data;
+      }
     }
-    /**
-     * @inheritDoc
-     */
-    clear() {
-        this.#data.clear();
-    }
+    return undefined;
+  }
+  /**
+   * @inheritDoc
+   */
+  set(name, data, origin, expiration) {
+    this.#data.set(name, { data, expiration: Date.now() + (expiration ?? this.#options.expiration) });
+  }
+  /**
+   * @inheritDoc
+   */
+  remove(name) {
+    this.#data.delete(name);
+  }
+  /**
+   * @inheritDoc
+   */
+  clear() {
+    this.#data.clear();
+  }
 }

package/cache/NullCacheAdapter.d.ts

@@ -1,19 +1,20 @@
 import type { SyncCacheAdapter } from './CacheAdapter.js';
+/** No-op cache adapter that never stores or returns any data. Used to disable caching. */
 export declare class NullCacheAdapter implements SyncCacheAdapter {
-    /**
-     * @inheritDoc
-     */
-    get(name: string): any;
-    /**
-     * @inheritDoc
-     */
-    set(name: string, data: any, origin: string): void;
-    /**
-     * @inheritDoc
-     */
-    remove(name: string): void;
-    /**
-     * @inheritDoc
-     */
-    clear(): void;
+  /**
+   * @inheritDoc
+   */
+  get(name: string): any;
+  /**
+   * @inheritDoc
+   */
+  set(name: string, data: any, origin: string): void;
+  /**
+   * @inheritDoc
+   */
+  remove(name: string): void;
+  /**
+   * @inheritDoc
+   */
+  clear(): void;
 }

package/cache/NullCacheAdapter.js

@@ -1,26 +1,27 @@
+/** No-op cache adapter that never stores or returns any data. Used to disable caching. */
 export class NullCacheAdapter {
-    /**
-     * @inheritDoc
-     */
-    get(name) {
-        return null;
-    }
-    /**
-     * @inheritDoc
-     */
-    set(name, data, origin) {
-        // ignore
-    }
-    /**
-     * @inheritDoc
-     */
-    remove(name) {
-        // ignore
-    }
-    /**
-     * @inheritDoc
-     */
-    clear() {
-        // ignore
-    }
+  /**
+   * @inheritDoc
+   */
+  get(name) {
+    return null;
+  }
+  /**
+   * @inheritDoc
+   */
+  set(name, data, origin) {
+    // ignore
+  }
+  /**
+   * @inheritDoc
+   */
+  remove(name) {
+    // ignore
+  }
+  /**
+   * @inheritDoc
+   */
+  clear() {
+    // ignore
+  }
 }