joist-core 2.3.0 → 2.4.0-next.2

package/build/relations/CustomReference.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomReference.cjs","names":["lazyField","AbstractRelationImpl","#isLoaded","#loadHint","fail","#hasBeenSet","getProperties","getMetadata","RelationT","RelationU","ReferenceN"],"sources":["../../src/relations/CustomReference.ts"],"sourcesContent":["import { type Entity } from \"src/Entity.ts\";\nimport { type IdOf, type TaggedId, getEmInternalApi } from \"src/EntityManager.ts\";\nimport { type LoadHint, type Reference, ensureNotDeleted, fail, getMetadata, getProperties } from \"src/index.ts\";\nimport { lazyField } from \"src/newEntity.ts\";\nimport { AbstractRelationImpl } from \"src/relations/AbstractRelationImpl.ts\";\nimport { ReferenceN } from \"src/relations/ReferenceSymbols.ts\";\nimport { RelationT, RelationU } from \"src/relations/RelationSymbols.ts\";\n\n/** An alias for creating `CustomReference`s. */\nexport function hasCustomReference<T extends Entity, U extends Entity, N extends never | undefined>(\n  opts: CustomReferenceOpts<T, U, N>,\n): CustomReference<T, U, N> {\n  return lazyField((entity: T) => {\n    return new CustomReference<T, U, N>(entity, opts);\n  });\n}\n\nexport type CustomReferenceOpts<T extends Entity, U extends Entity, N extends never | undefined> = {\n  // We purposefully don't capture the return value of `load` b/c we want `get` to re-calc from `entity`\n  // each time it's invoked so that it reflects any changed values.\n  load: (entity: T, opts: { forceReload?: boolean }) => Promise<unknown>;\n  get: (entity: T) => U | N;\n  set?: (entity: T, other: U) => void;\n  /** Whether the reference is loaded, even w/o an explicit `.load` call, i.e. for DeepNew test instances. */\n  isLoaded: (entity: T) => boolean;\n  /**\n   * A load hint that can be used to speculatively traverse the dependencies of this reference.  Currently\n   * only used by em.importEntity and can be omitted if the reference isn't used with it.\n   */\n  loadHint?: ((entity: T) => LoadHint<T>) | LoadHint<T>;\n};\n\n/**\n * Allows user-defined references that will work in `populate` / preload hints.\n *\n * This works because Joist's `populate`/preloading is not based on creating giant SQL joins,\n * but instead by just walking \"1 dataloader per level\". Given this, we don't really care\n * what happens at each \"level\" of resolution, as long as: a) it's a promise, and b) the\n * caller uses dataloader to be batch friendly.\n *\n * This `CustomReference` API is fairly low-level; users should more likely prefer higher-level\n * abstractions like `hasOneThrough`, which are built on `CustomReference.\n */\nexport class CustomReference<T extends Entity, U extends Entity, N extends never | undefined>\n  extends AbstractRelationImpl<T, U>\n  implements Reference<T, U, N>\n{\n  // We keep both a promise+loaded flag and not an actual `this.loaded = await load` because\n  // the value can become stale; we want to each `.get` call to repeatedly evaluate the latest value.\n  private loadPromise: Promise<unknown> | undefined;\n  #hasBeenSet = false;\n  #isLoaded: boolean | undefined;\n  #loadHint: LoadHint<T> | undefined;\n\n  constructor(\n    entity: T,\n    private opts: CustomReferenceOpts<T, U, N>,\n  ) {\n    super(entity);\n  }\n\n  get get(): U | N {\n    return this.doGet({ withDeleted: false });\n  }\n\n  get getWithDeleted(): U | N {\n    return this.doGet({ withDeleted: true });\n  }\n\n  get isLoaded(): boolean {\n    if (this.#isLoaded !== undefined) return this.#isLoaded;\n    getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);\n    this.#isLoaded = this.opts.isLoaded(this.entity);\n    return this.#isLoaded;\n  }\n\n  resetIsLoaded(): void {\n    this.#isLoaded = undefined;\n  }\n\n  get loadHint(): LoadHint<T> | undefined {\n    if (this.#loadHint === undefined && this.opts.loadHint !== undefined) {\n      const { loadHint } = this.opts;\n      this.#loadHint = typeof loadHint === \"function\" ? loadHint(this.entity) : loadHint;\n    }\n    return this.#loadHint;\n  }\n\n  async load(opts: { withDeleted?: boolean; forceReload?: boolean } = {}): Promise<U | N> {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded || opts.forceReload) {\n      if (this.loadPromise === undefined) {\n        this.loadPromise = this.opts.load(this.entity, opts);\n        await this.loadPromise;\n        this.loadPromise = undefined;\n        this.#isLoaded = true;\n      } else {\n        await this.loadPromise;\n      }\n    }\n    return this.doGet(opts);\n  }\n\n  get isPreloaded(): boolean {\n    return false;\n  }\n\n  preload(): void {\n    throw new Error(\"Not implemented\");\n  }\n\n  get id(): IdOf<U> {\n    return fail(`CustomReference cannot resolve 'id'`);\n  }\n\n  get idMaybe(): IdOf<U> | undefined {\n    return fail(`CustomReference cannot resolve 'idMaybe'`);\n  }\n\n  get idTaggedMaybe(): TaggedId | undefined {\n    return fail(`CustomReference cannot resolve 'idTaggedMaybe'`);\n  }\n\n  get idUntagged(): string {\n    return fail(`CustomReference cannot resolve 'idUntagged'`);\n  }\n\n  get idUntaggedMaybe(): string | undefined {\n    return fail(`CustomReference cannot resolve 'idUntaggedMaybe'`);\n  }\n\n  get isSet(): boolean {\n    this.ensureNewOrLoaded();\n    const { get } = this.opts;\n    return get(this.entity) !== undefined;\n  }\n\n  set(value: U): void {\n    // We allow setting CustomReferences on new entities w/o being loaded\n    if (!this.entity.isNewEntity) {\n      this.ensureNewOrLoaded();\n    }\n    const { set } = this.opts;\n    if (set === undefined) {\n      throw new Error(`'set' not implemented on ${this}`);\n    }\n    set(this.entity, value);\n    this.#hasBeenSet = true;\n  }\n\n  setFromOpts(value: U): void {\n    this.set(value);\n  }\n\n  // these callbacks should be no-ops as they ought to be handled by the underlying relations\n  async cleanupOnEntityDeleted(): Promise<void> {}\n  maybeCascadeDelete(): void {}\n\n  /** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */\n  get fieldName(): string {\n    return Object.entries(getProperties(getMetadata(this.entity))).filter(\n      ([key]) => (this.entity as any)[key] === this,\n    )[0][0];\n  }\n\n  get hasBeenSet() {\n    return this.#hasBeenSet;\n  }\n\n  toString(): string {\n    return `CustomReference(entity: ${this.entity}, fieldName: ${this.fieldName})`;\n  }\n\n  private doGet(opts?: { withDeleted?: boolean }): U | N {\n    ensureNotDeleted(this.entity, \"pending\");\n    this.ensureNewOrLoaded();\n    return this.filterDeleted(this.opts.get(this.entity), opts);\n  }\n\n  private filterDeleted(entity: U | N, opts?: { withDeleted?: boolean }): U | N {\n    return opts?.withDeleted === true || entity === undefined || !entity.isDeletedEntity ? entity : (undefined as N);\n  }\n\n  private ensureNewOrLoaded() {\n    // This should only be callable in the type system if we've already resolved this to an instance\n    if (this.isLoaded) {\n      return;\n    }\n    fail(`${this.entity}.${this.fieldName} was not loaded`);\n  }\n\n  [RelationT]: T = null!;\n  [RelationU]: U = null!;\n  [ReferenceN]: N = null!;\n}\n"],"mappings":";;;;;;;;;;;;;AASA,SAAgB,mBACd,MAC0B;CAC1B,OAAOA,kBAAAA,WAAW,WAAc;EAC9B,OAAO,IAAI,gBAAyB,QAAQ,IAAI;CAClD,CAAC;AACH;;;;;;;;;;;;AA4BA,IAAa,kBAAb,cACUC,uCAAAA,qBAEV;CAUY;CAPV;CACA,cAAc;CACd;CACA;CAEA,YACE,QACA,MACA;EACA,MAAM,MAAM;EAFJ,KAAA,OAAA;CAGV;CAEA,IAAI,MAAa;EACf,OAAO,KAAK,MAAM,EAAE,aAAa,MAAM,CAAC;CAC1C;CAEA,IAAI,iBAAwB;EAC1B,OAAO,KAAK,MAAM,EAAE,aAAa,KAAK,CAAC;CACzC;CAEA,IAAI,WAAoB;EACtB,IAAI,KAAKC,cAAc,KAAA,GAAW,OAAO,KAAKA;EAC9C,sBAAA,iBAAiB,KAAK,OAAO,EAAE,CAAC,CAAC,cAAc,SAAS,IAAI;EAC5D,KAAKA,YAAY,KAAK,KAAK,SAAS,KAAK,MAAM;EAC/C,OAAO,KAAKA;CACd;CAEA,gBAAsB;EACpB,KAAKA,YAAY,KAAA;CACnB;CAEA,IAAI,WAAoC;EACtC,IAAI,KAAKC,cAAc,KAAA,KAAa,KAAK,KAAK,aAAa,KAAA,GAAW;GACpE,MAAM,EAAE,aAAa,KAAK;GAC1B,KAAKA,YAAY,OAAO,aAAa,aAAa,SAAS,KAAK,MAAM,IAAI;EAC5E;EACA,OAAO,KAAKA;CACd;CAEA,MAAM,KAAK,OAAyD,CAAC,GAAmB;EACtF,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,YAAY,KAAK,aAAa;GACtC,IAAI,KAAK,gBAAgB,KAAA,GAAW;IAClC,KAAK,cAAc,KAAK,KAAK,KAAK,KAAK,QAAQ,IAAI;IACnD,MAAM,KAAK;IACX,KAAK,cAAc,KAAA;IACnB,KAAKD,YAAY;GACnB,OACE,MAAM,KAAK;EAEf;EACA,OAAO,KAAK,MAAM,IAAI;CACxB;CAEA,IAAI,cAAuB;EACzB,OAAO;CACT;CAEA,UAAgB;EACd,MAAM,IAAI,MAAM,iBAAiB;CACnC;CAEA,IAAI,KAAc;EAChB,OAAOE,cAAAA,KAAK,qCAAqC;CACnD;CAEA,IAAI,UAA+B;EACjC,OAAOA,cAAAA,KAAK,0CAA0C;CACxD;CAEA,IAAI,gBAAsC;EACxC,OAAOA,cAAAA,KAAK,gDAAgD;CAC9D;CAEA,IAAI,aAAqB;EACvB,OAAOA,cAAAA,KAAK,6CAA6C;CAC3D;CAEA,IAAI,kBAAsC;EACxC,OAAOA,cAAAA,KAAK,kDAAkD;CAChE;CAEA,IAAI,QAAiB;EACnB,KAAK,kBAAkB;EACvB,MAAM,EAAE,QAAQ,KAAK;EACrB,OAAO,IAAI,KAAK,MAAM,MAAM,KAAA;CAC9B;CAEA,IAAI,OAAgB;EAElB,IAAI,CAAC,KAAK,OAAO,aACf,KAAK,kBAAkB;EAEzB,MAAM,EAAE,QAAQ,KAAK;EACrB,IAAI,QAAQ,KAAA,GACV,MAAM,IAAI,MAAM,4BAA4B,MAAM;EAEpD,IAAI,KAAK,QAAQ,KAAK;EACtB,KAAKC,cAAc;CACrB;CAEA,YAAY,OAAgB;EAC1B,KAAK,IAAI,KAAK;CAChB;CAGA,MAAM,yBAAwC,CAAC;CAC/C,qBAA2B,CAAC;;CAG5B,IAAI,YAAoB;EACtB,OAAO,OAAO,QAAQC,sBAAAA,cAAcC,uBAAAA,YAAY,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,QAC5D,CAAC,SAAU,KAAK,OAAe,SAAS,IAC3C,CAAC,CAAC,EAAE,CAAC;CACP;CAEA,IAAI,aAAa;EACf,OAAO,KAAKF;CACd;CAEA,WAAmB;EACjB,OAAO,2BAA2B,KAAK,OAAO,eAAe,KAAK,UAAU;CAC9E;CAEA,MAAc,MAAyC;EACrD,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,KAAK,kBAAkB;EACvB,OAAO,KAAK,cAAc,KAAK,KAAK,IAAI,KAAK,MAAM,GAAG,IAAI;CAC5D;CAEA,cAAsB,QAAe,MAAyC;EAC5E,OAAO,MAAM,gBAAgB,QAAQ,WAAW,KAAA,KAAa,CAAC,OAAO,kBAAkB,SAAU,KAAA;CACnG;CAEA,oBAA4B;EAE1B,IAAI,KAAK,UACP;EAEF,cAAA,KAAK,GAAG,KAAK,OAAO,GAAG,KAAK,UAAU,gBAAgB;CACxD;CAEA,CAACG,kCAAAA,aAAgB;CACjB,CAACC,kCAAAA,aAAgB;CACjB,CAACC,mCAAAA,cAAiB;AACpB"}

package/build/relations/CustomReference.d.cts

@@ -0,0 +1,76 @@
+import { AbstractRelationImpl } from "./AbstractRelationImpl.cjs";
+import { RelationT, RelationU } from "./RelationSymbols.cjs";
+import { ReferenceN } from "./ReferenceSymbols.cjs";
+import { Reference } from "./Reference.cjs";
+import { LoadHint } from "../loading/loadHints.cjs";
+import "../index.cjs";
+import { IdOf, TaggedId } from "../EntityManager.cjs";
+import { Entity } from "../Entity.cjs";
+//#region src/relations/CustomReference.d.ts
+/** An alias for creating `CustomReference`s. */
+declare function hasCustomReference<T extends Entity, U extends Entity, N extends never | undefined>(opts: CustomReferenceOpts<T, U, N>): CustomReference<T, U, N>;
+type CustomReferenceOpts<T extends Entity, U extends Entity, N extends never | undefined> = {
+  load: (entity: T, opts: {
+    forceReload?: boolean;
+  }) => Promise<unknown>;
+  get: (entity: T) => U | N;
+  set?: (entity: T, other: U) => void;
+  /** Whether the reference is loaded, even w/o an explicit `.load` call, i.e. for DeepNew test instances. */
+  isLoaded: (entity: T) => boolean;
+  /**
+   * A load hint that can be used to speculatively traverse the dependencies of this reference.  Currently
+   * only used by em.importEntity and can be omitted if the reference isn't used with it.
+   */
+  loadHint?: ((entity: T) => LoadHint<T>) | LoadHint<T>;
+};
+/**
+ * Allows user-defined references that will work in `populate` / preload hints.
+ *
+ * This works because Joist's `populate`/preloading is not based on creating giant SQL joins,
+ * but instead by just walking "1 dataloader per level". Given this, we don't really care
+ * what happens at each "level" of resolution, as long as: a) it's a promise, and b) the
+ * caller uses dataloader to be batch friendly.
+ *
+ * This `CustomReference` API is fairly low-level; users should more likely prefer higher-level
+ * abstractions like `hasOneThrough`, which are built on `CustomReference.
+ */
+declare class CustomReference<T extends Entity, U extends Entity, N extends never | undefined> extends AbstractRelationImpl<T, U> implements Reference<T, U, N> {
+  #private;
+  private opts;
+  private loadPromise;
+  constructor(entity: T, opts: CustomReferenceOpts<T, U, N>);
+  get get(): U | N;
+  get getWithDeleted(): U | N;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get loadHint(): LoadHint<T> | undefined;
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<U | N>;
+  get isPreloaded(): boolean;
+  preload(): void;
+  get id(): IdOf<U>;
+  get idMaybe(): IdOf<U> | undefined;
+  get idTaggedMaybe(): TaggedId | undefined;
+  get idUntagged(): string;
+  get idUntaggedMaybe(): string | undefined;
+  get isSet(): boolean;
+  set(value: U): void;
+  setFromOpts(value: U): void;
+  cleanupOnEntityDeleted(): Promise<void>;
+  maybeCascadeDelete(): void;
+  /** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */
+  get fieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  private doGet;
+  private filterDeleted;
+  private ensureNewOrLoaded;
+  [RelationT]: T;
+  [RelationU]: U;
+  [ReferenceN]: N;
+}
+//#endregion
+export { CustomReference, CustomReferenceOpts, hasCustomReference };
+//# sourceMappingURL=CustomReference.d.cts.map

package/build/relations/CustomReference.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomReference.d.cts","names":[],"sources":["../../src/relations/CustomReference.ts"],"mappings":";;;;;;;;;;iBASgB,mBAAmB,UAAU,QAAQ,UAAU,QAAQ,6BACrE,MAAM,oBAAoB,GAAG,GAAG,KAC/B,gBAAgB,GAAG,GAAG;KAMb,oBAAoB,UAAU,QAAQ,UAAU,QAAQ;EAGlE,OAAO,QAAQ,GAAG;IAAQ;QAA4B;EACtD,MAAM,QAAQ,MAAM,IAAI;EACxB,OAAO,QAAQ,GAAG,OAAO;;EAEzB,WAAW,QAAQ;;;;;EAKnB,aAAa,QAAQ,MAAM,SAAS,MAAM,SAAS;;;;;;;;;;;;;cAcxC,gBAAgB,UAAU,QAAQ,UAAU,QAAQ,qCACvD,qBAAqB,GAAG,cACrB,UAAU,GAAG,GAAG;;UAWjB;UAPF;EAKR,YACE,QAAQ,GACA,MAAM,oBAAoB,GAAG,GAAG;MAKtC,OAAO,IAAI;MAIX,kBAAkB,IAAI;MAItB;EAOJ;MAII,YAAY,SAAS;EAQnB,KAAK;IAAQ;IAAuB;MAA+B,QAAQ,IAAI;MAejF;EAIJ;MAII,MAAM,KAAK;MAIX,WAAW,KAAK;MAIhB,iBAAiB;MAIjB;MAIA;MAIA;EAMJ,IAAI,OAAO;EAaX,YAAY,OAAO;EAKb,0BAA0B;EAChC;;MAGI;MAMA;EAIJ;UAIQ;UAMA;UAIA;GAQP,YAAY;GACZ,YAAY;GACZ,aAAa"}

package/build/relations/CustomReference.d.mts

@@ -0,0 +1,76 @@
+import { AbstractRelationImpl } from "./AbstractRelationImpl.mjs";
+import { RelationT, RelationU } from "./RelationSymbols.mjs";
+import { ReferenceN } from "./ReferenceSymbols.mjs";
+import { Reference } from "./Reference.mjs";
+import { LoadHint } from "../loading/loadHints.mjs";
+import "../index.mjs";
+import { IdOf, TaggedId } from "../EntityManager.mjs";
+import { Entity } from "../Entity.mjs";
+//#region src/relations/CustomReference.d.ts
+/** An alias for creating `CustomReference`s. */
+declare function hasCustomReference<T extends Entity, U extends Entity, N extends never | undefined>(opts: CustomReferenceOpts<T, U, N>): CustomReference<T, U, N>;
+type CustomReferenceOpts<T extends Entity, U extends Entity, N extends never | undefined> = {
+  load: (entity: T, opts: {
+    forceReload?: boolean;
+  }) => Promise<unknown>;
+  get: (entity: T) => U | N;
+  set?: (entity: T, other: U) => void;
+  /** Whether the reference is loaded, even w/o an explicit `.load` call, i.e. for DeepNew test instances. */
+  isLoaded: (entity: T) => boolean;
+  /**
+   * A load hint that can be used to speculatively traverse the dependencies of this reference.  Currently
+   * only used by em.importEntity and can be omitted if the reference isn't used with it.
+   */
+  loadHint?: ((entity: T) => LoadHint<T>) | LoadHint<T>;
+};
+/**
+ * Allows user-defined references that will work in `populate` / preload hints.
+ *
+ * This works because Joist's `populate`/preloading is not based on creating giant SQL joins,
+ * but instead by just walking "1 dataloader per level". Given this, we don't really care
+ * what happens at each "level" of resolution, as long as: a) it's a promise, and b) the
+ * caller uses dataloader to be batch friendly.
+ *
+ * This `CustomReference` API is fairly low-level; users should more likely prefer higher-level
+ * abstractions like `hasOneThrough`, which are built on `CustomReference.
+ */
+declare class CustomReference<T extends Entity, U extends Entity, N extends never | undefined> extends AbstractRelationImpl<T, U> implements Reference<T, U, N> {
+  #private;
+  private opts;
+  private loadPromise;
+  constructor(entity: T, opts: CustomReferenceOpts<T, U, N>);
+  get get(): U | N;
+  get getWithDeleted(): U | N;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get loadHint(): LoadHint<T> | undefined;
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<U | N>;
+  get isPreloaded(): boolean;
+  preload(): void;
+  get id(): IdOf<U>;
+  get idMaybe(): IdOf<U> | undefined;
+  get idTaggedMaybe(): TaggedId | undefined;
+  get idUntagged(): string;
+  get idUntaggedMaybe(): string | undefined;
+  get isSet(): boolean;
+  set(value: U): void;
+  setFromOpts(value: U): void;
+  cleanupOnEntityDeleted(): Promise<void>;
+  maybeCascadeDelete(): void;
+  /** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */
+  get fieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  private doGet;
+  private filterDeleted;
+  private ensureNewOrLoaded;
+  [RelationT]: T;
+  [RelationU]: U;
+  [ReferenceN]: N;
+}
+//#endregion
+export { CustomReference, CustomReferenceOpts, hasCustomReference };
+//# sourceMappingURL=CustomReference.d.mts.map

package/build/relations/CustomReference.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomReference.d.mts","names":[],"sources":["../../src/relations/CustomReference.ts"],"mappings":";;;;;;;;;;iBASgB,mBAAmB,UAAU,QAAQ,UAAU,QAAQ,6BACrE,MAAM,oBAAoB,GAAG,GAAG,KAC/B,gBAAgB,GAAG,GAAG;KAMb,oBAAoB,UAAU,QAAQ,UAAU,QAAQ;EAGlE,OAAO,QAAQ,GAAG;IAAQ;QAA4B;EACtD,MAAM,QAAQ,MAAM,IAAI;EACxB,OAAO,QAAQ,GAAG,OAAO;;EAEzB,WAAW,QAAQ;;;;;EAKnB,aAAa,QAAQ,MAAM,SAAS,MAAM,SAAS;;;;;;;;;;;;;cAcxC,gBAAgB,UAAU,QAAQ,UAAU,QAAQ,qCACvD,qBAAqB,GAAG,cACrB,UAAU,GAAG,GAAG;;UAWjB;UAPF;EAKR,YACE,QAAQ,GACA,MAAM,oBAAoB,GAAG,GAAG;MAKtC,OAAO,IAAI;MAIX,kBAAkB,IAAI;MAItB;EAOJ;MAII,YAAY,SAAS;EAQnB,KAAK;IAAQ;IAAuB;MAA+B,QAAQ,IAAI;MAejF;EAIJ;MAII,MAAM,KAAK;MAIX,WAAW,KAAK;MAIhB,iBAAiB;MAIjB;MAIA;MAIA;EAMJ,IAAI,OAAO;EAaX,YAAY,OAAO;EAKb,0BAA0B;EAChC;;MAGI;MAMA;EAIJ;UAIQ;UAMA;UAIA;GAQP,YAAY;GACZ,YAAY;GACZ,aAAa"}

package/build/relations/CustomReference.js

@@ -1,152 +1,140 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomReference = void 0;
-exports.hasCustomReference = hasCustomReference;
-const EntityManager_1 = require("../EntityManager");
-const index_1 = require("../index");
-const newEntity_1 = require("../newEntity");
-const AbstractRelationImpl_1 = require("./AbstractRelationImpl");
-const Reference_1 = require("./Reference");
-const Relation_1 = require("./Relation");
+import { AbstractRelationImpl } from "./AbstractRelationImpl.js";
+import { RelationT, RelationU } from "./RelationSymbols.js";
+import { ReferenceN } from "./ReferenceSymbols.js";
+import { fail } from "../utils.js";
+import { lazyField } from "../newEntity.js";
+import { getProperties } from "../getProperties.js";
+import { getMetadata } from "../EntityMetadata.js";
+import { ensureNotDeleted } from "../index.js";
+import { getEmInternalApi } from "../EntityManager.js";
+import "../Entity.js";
+//#region src/relations/CustomReference.ts
 /** An alias for creating `CustomReference`s. */
 function hasCustomReference(opts) {
-    return (0, newEntity_1.lazyField)((entity) => {
-        return new CustomReference(entity, opts);
-    });
+	return lazyField((entity) => {
+		return new CustomReference(entity, opts);
+	});
 }
 /**
- * Allows user-defined references that will work in `populate` / preload hints.
- *
- * This works because Joist's `populate`/preloading is not based on creating giant SQL joins,
- * but instead by just walking "1 dataloader per level". Given this, we don't really care
- * what happens at each "level" of resolution, as long as: a) it's a promise, and b) the
- * caller uses dataloader to be batch friendly.
- *
- * This `CustomReference` API is fairly low-level; users should more likely prefer higher-level
- * abstractions like `hasOneThrough`, which are built on `CustomReference.
- */
-class CustomReference extends AbstractRelationImpl_1.AbstractRelationImpl {
-    opts;
-    // We keep both a promise+loaded flag and not an actual `this.loaded = await load` because
-    // the value can become stale; we want to each `.get` call to repeatedly evaluate the latest value.
-    loadPromise;
-    #hasBeenSet = false;
-    #isLoaded;
-    #loadHint;
-    constructor(entity, opts) {
-        super(entity);
-        this.opts = opts;
-    }
-    get get() {
-        return this.doGet({ withDeleted: false });
-    }
-    get getWithDeleted() {
-        return this.doGet({ withDeleted: true });
-    }
-    get isLoaded() {
-        if (this.#isLoaded !== undefined)
-            return this.#isLoaded;
-        (0, EntityManager_1.getEmInternalApi)(this.entity.em).isLoadedCache.addNaive(this);
-        this.#isLoaded = this.opts.isLoaded(this.entity);
-        return this.#isLoaded;
-    }
-    resetIsLoaded() {
-        this.#isLoaded = undefined;
-    }
-    get loadHint() {
-        if (this.#loadHint === undefined && this.opts.loadHint !== undefined) {
-            const { loadHint } = this.opts;
-            this.#loadHint = typeof loadHint === "function" ? loadHint(this.entity) : loadHint;
-        }
-        return this.#loadHint;
-    }
-    async load(opts = {}) {
-        (0, index_1.ensureNotDeleted)(this.entity, "pending");
-        if (!this.isLoaded || opts.forceReload) {
-            if (this.loadPromise === undefined) {
-                this.loadPromise = this.opts.load(this.entity, opts);
-                await this.loadPromise;
-                this.loadPromise = undefined;
-                this.#isLoaded = true;
-            }
-            else {
-                await this.loadPromise;
-            }
-        }
-        return this.doGet(opts);
-    }
-    get isPreloaded() {
-        return false;
-    }
-    preload() {
-        throw new Error("Not implemented");
-    }
-    get id() {
-        return (0, index_1.fail)(`CustomReference cannot resolve 'id'`);
-    }
-    get idMaybe() {
-        return (0, index_1.fail)(`CustomReference cannot resolve 'idMaybe'`);
-    }
-    get idTaggedMaybe() {
-        return (0, index_1.fail)(`CustomReference cannot resolve 'idTaggedMaybe'`);
-    }
-    get idUntagged() {
-        return (0, index_1.fail)(`CustomReference cannot resolve 'idUntagged'`);
-    }
-    get idUntaggedMaybe() {
-        return (0, index_1.fail)(`CustomReference cannot resolve 'idUntaggedMaybe'`);
-    }
-    get isSet() {
-        this.ensureNewOrLoaded();
-        const { get } = this.opts;
-        return get(this.entity) !== undefined;
-    }
-    set(value) {
-        // We allow setting CustomReferences on new entities w/o being loaded
-        if (!this.entity.isNewEntity) {
-            this.ensureNewOrLoaded();
-        }
-        const { set } = this.opts;
-        if (set === undefined) {
-            throw new Error(`'set' not implemented on ${this}`);
-        }
-        set(this.entity, value);
-        this.#hasBeenSet = true;
-    }
-    setFromOpts(value) {
-        this.set(value);
-    }
-    // these callbacks should be no-ops as they ought to be handled by the underlying relations
-    async cleanupOnEntityDeleted() { }
-    maybeCascadeDelete() { }
-    /** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */
-    get fieldName() {
-        return Object.entries((0, index_1.getProperties)((0, index_1.getMetadata)(this.entity))).filter(([key]) => this.entity[key] === this)[0][0];
-    }
-    get hasBeenSet() {
-        return this.#hasBeenSet;
-    }
-    toString() {
-        return `CustomReference(entity: ${this.entity}, fieldName: ${this.fieldName})`;
-    }
-    doGet(opts) {
-        (0, index_1.ensureNotDeleted)(this.entity, "pending");
-        this.ensureNewOrLoaded();
-        return this.filterDeleted(this.opts.get(this.entity), opts);
-    }
-    filterDeleted(entity, opts) {
-        return opts?.withDeleted === true || entity === undefined || !entity.isDeletedEntity ? entity : undefined;
-    }
-    ensureNewOrLoaded() {
-        // This should only be callable in the type system if we've already resolved this to an instance
-        if (this.isLoaded) {
-            return;
-        }
-        (0, index_1.fail)(`${this.entity}.${this.fieldName} was not loaded`);
-    }
-    [Relation_1.RelationT] = null;
-    [Relation_1.RelationU] = null;
-    [Reference_1.ReferenceN] = null;
-}
-exports.CustomReference = CustomReference;
+* Allows user-defined references that will work in `populate` / preload hints.
+*
+* This works because Joist's `populate`/preloading is not based on creating giant SQL joins,
+* but instead by just walking "1 dataloader per level". Given this, we don't really care
+* what happens at each "level" of resolution, as long as: a) it's a promise, and b) the
+* caller uses dataloader to be batch friendly.
+*
+* This `CustomReference` API is fairly low-level; users should more likely prefer higher-level
+* abstractions like `hasOneThrough`, which are built on `CustomReference.
+*/
+var CustomReference = class extends AbstractRelationImpl {
+	opts;
+	loadPromise;
+	#hasBeenSet = false;
+	#isLoaded;
+	#loadHint;
+	constructor(entity, opts) {
+		super(entity);
+		this.opts = opts;
+	}
+	get get() {
+		return this.doGet({ withDeleted: false });
+	}
+	get getWithDeleted() {
+		return this.doGet({ withDeleted: true });
+	}
+	get isLoaded() {
+		if (this.#isLoaded !== void 0) return this.#isLoaded;
+		getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);
+		this.#isLoaded = this.opts.isLoaded(this.entity);
+		return this.#isLoaded;
+	}
+	resetIsLoaded() {
+		this.#isLoaded = void 0;
+	}
+	get loadHint() {
+		if (this.#loadHint === void 0 && this.opts.loadHint !== void 0) {
+			const { loadHint } = this.opts;
+			this.#loadHint = typeof loadHint === "function" ? loadHint(this.entity) : loadHint;
+		}
+		return this.#loadHint;
+	}
+	async load(opts = {}) {
+		ensureNotDeleted(this.entity, "pending");
+		if (!this.isLoaded || opts.forceReload) {
+			if (this.loadPromise === void 0) {
+				this.loadPromise = this.opts.load(this.entity, opts);
+				await this.loadPromise;
+				this.loadPromise = void 0;
+				this.#isLoaded = true;
+			} else await this.loadPromise;
+		}
+		return this.doGet(opts);
+	}
+	get isPreloaded() {
+		return false;
+	}
+	preload() {
+		throw new Error("Not implemented");
+	}
+	get id() {
+		return fail(`CustomReference cannot resolve 'id'`);
+	}
+	get idMaybe() {
+		return fail(`CustomReference cannot resolve 'idMaybe'`);
+	}
+	get idTaggedMaybe() {
+		return fail(`CustomReference cannot resolve 'idTaggedMaybe'`);
+	}
+	get idUntagged() {
+		return fail(`CustomReference cannot resolve 'idUntagged'`);
+	}
+	get idUntaggedMaybe() {
+		return fail(`CustomReference cannot resolve 'idUntaggedMaybe'`);
+	}
+	get isSet() {
+		this.ensureNewOrLoaded();
+		const { get } = this.opts;
+		return get(this.entity) !== void 0;
+	}
+	set(value) {
+		if (!this.entity.isNewEntity) this.ensureNewOrLoaded();
+		const { set } = this.opts;
+		if (set === void 0) throw new Error(`'set' not implemented on ${this}`);
+		set(this.entity, value);
+		this.#hasBeenSet = true;
+	}
+	setFromOpts(value) {
+		this.set(value);
+	}
+	async cleanupOnEntityDeleted() {}
+	maybeCascadeDelete() {}
+	/** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */
+	get fieldName() {
+		return Object.entries(getProperties(getMetadata(this.entity))).filter(([key]) => this.entity[key] === this)[0][0];
+	}
+	get hasBeenSet() {
+		return this.#hasBeenSet;
+	}
+	toString() {
+		return `CustomReference(entity: ${this.entity}, fieldName: ${this.fieldName})`;
+	}
+	doGet(opts) {
+		ensureNotDeleted(this.entity, "pending");
+		this.ensureNewOrLoaded();
+		return this.filterDeleted(this.opts.get(this.entity), opts);
+	}
+	filterDeleted(entity, opts) {
+		return opts?.withDeleted === true || entity === void 0 || !entity.isDeletedEntity ? entity : void 0;
+	}
+	ensureNewOrLoaded() {
+		if (this.isLoaded) return;
+		fail(`${this.entity}.${this.fieldName} was not loaded`);
+	}
+	[RelationT] = null;
+	[RelationU] = null;
+	[ReferenceN] = null;
+};
+//#endregion
+export { CustomReference, hasCustomReference };
+
 //# sourceMappingURL=CustomReference.js.map

package/build/relations/CustomReference.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomReference.js","sourceRoot":"","sources":["../../src/relations/CustomReference.ts"],"names":[],"mappings":";;;AASA,gDAMC;AAdD,oDAAoE;AACpE,oCAAmG;AACnG,4CAAyC;AACzC,iEAA8D;AAC9D,2CAAyC;AACzC,yCAAkD;AAElD,gDAAgD;AAChD,SAAgB,kBAAkB,CAChC,IAAkC;IAElC,OAAO,IAAA,qBAAS,EAAC,CAAC,MAAS,EAAE,EAAE;QAC7B,OAAO,IAAI,eAAe,CAAU,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC;AAiBD;;;;;;;;;;GAUG;AACH,MAAa,eACX,SAAQ,2CAA0B;IAYxB;IATV,0FAA0F;IAC1F,mGAAmG;IAC3F,WAAW,CAA+B;IAClD,WAAW,GAAG,KAAK,CAAC;IACpB,SAAS,CAAsB;IAC/B,SAAS,CAA0B;IAEnC,YACE,MAAS,EACD,IAAkC;QAE1C,KAAK,CAAC,MAAM,CAAC,CAAC;QAFN,SAAI,GAAJ,IAAI,CAA8B;IAG5C,CAAC;IAED,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxD,IAAA,gCAAgB,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACrE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrF,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAyD,EAAE;QACpE,IAAA,wBAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACrD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACvB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;gBAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,WAAW,CAAC;YACzB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAA,YAAI,EAAC,qCAAqC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAA,YAAI,EAAC,0CAA0C,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,YAAI,EAAC,gDAAgD,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAA,YAAI,EAAC,6CAA6C,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAA,YAAI,EAAC,kDAAkD,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,KAAK;QACP,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;IACxC,CAAC;IAED,GAAG,CAAC,KAAQ;QACV,qEAAqE;QACrE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,WAAW,CAAC,KAAQ;QAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,sBAAsB,KAAmB,CAAC;IAChD,kBAAkB,KAAU,CAAC;IAE7B,0GAA0G;IAC1G,IAAI,SAAS;QACX,OAAO,MAAM,CAAC,OAAO,CAAC,IAAA,qBAAa,EAAC,IAAA,mBAAW,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CACnE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAE,IAAI,CAAC,MAAc,CAAC,GAAG,CAAC,KAAK,IAAI,CAC9C,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACV,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,QAAQ;QACN,OAAO,2BAA2B,IAAI,CAAC,MAAM,gBAAgB,IAAI,CAAC,SAAS,GAAG,CAAC;IACjF,CAAC;IAEO,KAAK,CAAC,IAAgC;QAC5C,IAAA,wBAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAEO,aAAa,CAAC,MAAa,EAAE,IAAgC;QACnE,OAAO,IAAI,EAAE,WAAW,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,SAAe,CAAC;IACnH,CAAC;IAEO,iBAAiB;QACvB,gGAAgG;QAChG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QACD,IAAA,YAAI,EAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,iBAAiB,CAAC,CAAC;IAC1D,CAAC;IAED,CAAC,oBAAS,CAAC,GAAM,IAAK,CAAC;IACvB,CAAC,oBAAS,CAAC,GAAM,IAAK,CAAC;IACvB,CAAC,sBAAU,CAAC,GAAM,IAAK,CAAC;CACzB;AAvJD,0CAuJC"}
+{"version":3,"file":"CustomReference.js","names":["#isLoaded","#loadHint","#hasBeenSet"],"sources":["../../src/relations/CustomReference.ts"],"sourcesContent":["import { type Entity } from \"src/Entity.ts\";\nimport { type IdOf, type TaggedId, getEmInternalApi } from \"src/EntityManager.ts\";\nimport { type LoadHint, type Reference, ensureNotDeleted, fail, getMetadata, getProperties } from \"src/index.ts\";\nimport { lazyField } from \"src/newEntity.ts\";\nimport { AbstractRelationImpl } from \"src/relations/AbstractRelationImpl.ts\";\nimport { ReferenceN } from \"src/relations/ReferenceSymbols.ts\";\nimport { RelationT, RelationU } from \"src/relations/RelationSymbols.ts\";\n\n/** An alias for creating `CustomReference`s. */\nexport function hasCustomReference<T extends Entity, U extends Entity, N extends never | undefined>(\n  opts: CustomReferenceOpts<T, U, N>,\n): CustomReference<T, U, N> {\n  return lazyField((entity: T) => {\n    return new CustomReference<T, U, N>(entity, opts);\n  });\n}\n\nexport type CustomReferenceOpts<T extends Entity, U extends Entity, N extends never | undefined> = {\n  // We purposefully don't capture the return value of `load` b/c we want `get` to re-calc from `entity`\n  // each time it's invoked so that it reflects any changed values.\n  load: (entity: T, opts: { forceReload?: boolean }) => Promise<unknown>;\n  get: (entity: T) => U | N;\n  set?: (entity: T, other: U) => void;\n  /** Whether the reference is loaded, even w/o an explicit `.load` call, i.e. for DeepNew test instances. */\n  isLoaded: (entity: T) => boolean;\n  /**\n   * A load hint that can be used to speculatively traverse the dependencies of this reference.  Currently\n   * only used by em.importEntity and can be omitted if the reference isn't used with it.\n   */\n  loadHint?: ((entity: T) => LoadHint<T>) | LoadHint<T>;\n};\n\n/**\n * Allows user-defined references that will work in `populate` / preload hints.\n *\n * This works because Joist's `populate`/preloading is not based on creating giant SQL joins,\n * but instead by just walking \"1 dataloader per level\". Given this, we don't really care\n * what happens at each \"level\" of resolution, as long as: a) it's a promise, and b) the\n * caller uses dataloader to be batch friendly.\n *\n * This `CustomReference` API is fairly low-level; users should more likely prefer higher-level\n * abstractions like `hasOneThrough`, which are built on `CustomReference.\n */\nexport class CustomReference<T extends Entity, U extends Entity, N extends never | undefined>\n  extends AbstractRelationImpl<T, U>\n  implements Reference<T, U, N>\n{\n  // We keep both a promise+loaded flag and not an actual `this.loaded = await load` because\n  // the value can become stale; we want to each `.get` call to repeatedly evaluate the latest value.\n  private loadPromise: Promise<unknown> | undefined;\n  #hasBeenSet = false;\n  #isLoaded: boolean | undefined;\n  #loadHint: LoadHint<T> | undefined;\n\n  constructor(\n    entity: T,\n    private opts: CustomReferenceOpts<T, U, N>,\n  ) {\n    super(entity);\n  }\n\n  get get(): U | N {\n    return this.doGet({ withDeleted: false });\n  }\n\n  get getWithDeleted(): U | N {\n    return this.doGet({ withDeleted: true });\n  }\n\n  get isLoaded(): boolean {\n    if (this.#isLoaded !== undefined) return this.#isLoaded;\n    getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);\n    this.#isLoaded = this.opts.isLoaded(this.entity);\n    return this.#isLoaded;\n  }\n\n  resetIsLoaded(): void {\n    this.#isLoaded = undefined;\n  }\n\n  get loadHint(): LoadHint<T> | undefined {\n    if (this.#loadHint === undefined && this.opts.loadHint !== undefined) {\n      const { loadHint } = this.opts;\n      this.#loadHint = typeof loadHint === \"function\" ? loadHint(this.entity) : loadHint;\n    }\n    return this.#loadHint;\n  }\n\n  async load(opts: { withDeleted?: boolean; forceReload?: boolean } = {}): Promise<U | N> {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded || opts.forceReload) {\n      if (this.loadPromise === undefined) {\n        this.loadPromise = this.opts.load(this.entity, opts);\n        await this.loadPromise;\n        this.loadPromise = undefined;\n        this.#isLoaded = true;\n      } else {\n        await this.loadPromise;\n      }\n    }\n    return this.doGet(opts);\n  }\n\n  get isPreloaded(): boolean {\n    return false;\n  }\n\n  preload(): void {\n    throw new Error(\"Not implemented\");\n  }\n\n  get id(): IdOf<U> {\n    return fail(`CustomReference cannot resolve 'id'`);\n  }\n\n  get idMaybe(): IdOf<U> | undefined {\n    return fail(`CustomReference cannot resolve 'idMaybe'`);\n  }\n\n  get idTaggedMaybe(): TaggedId | undefined {\n    return fail(`CustomReference cannot resolve 'idTaggedMaybe'`);\n  }\n\n  get idUntagged(): string {\n    return fail(`CustomReference cannot resolve 'idUntagged'`);\n  }\n\n  get idUntaggedMaybe(): string | undefined {\n    return fail(`CustomReference cannot resolve 'idUntaggedMaybe'`);\n  }\n\n  get isSet(): boolean {\n    this.ensureNewOrLoaded();\n    const { get } = this.opts;\n    return get(this.entity) !== undefined;\n  }\n\n  set(value: U): void {\n    // We allow setting CustomReferences on new entities w/o being loaded\n    if (!this.entity.isNewEntity) {\n      this.ensureNewOrLoaded();\n    }\n    const { set } = this.opts;\n    if (set === undefined) {\n      throw new Error(`'set' not implemented on ${this}`);\n    }\n    set(this.entity, value);\n    this.#hasBeenSet = true;\n  }\n\n  setFromOpts(value: U): void {\n    this.set(value);\n  }\n\n  // these callbacks should be no-ops as they ought to be handled by the underlying relations\n  async cleanupOnEntityDeleted(): Promise<void> {}\n  maybeCascadeDelete(): void {}\n\n  /** Finds this CustomReferences field name by looking in the entity for the key that we're assigned to. */\n  get fieldName(): string {\n    return Object.entries(getProperties(getMetadata(this.entity))).filter(\n      ([key]) => (this.entity as any)[key] === this,\n    )[0][0];\n  }\n\n  get hasBeenSet() {\n    return this.#hasBeenSet;\n  }\n\n  toString(): string {\n    return `CustomReference(entity: ${this.entity}, fieldName: ${this.fieldName})`;\n  }\n\n  private doGet(opts?: { withDeleted?: boolean }): U | N {\n    ensureNotDeleted(this.entity, \"pending\");\n    this.ensureNewOrLoaded();\n    return this.filterDeleted(this.opts.get(this.entity), opts);\n  }\n\n  private filterDeleted(entity: U | N, opts?: { withDeleted?: boolean }): U | N {\n    return opts?.withDeleted === true || entity === undefined || !entity.isDeletedEntity ? entity : (undefined as N);\n  }\n\n  private ensureNewOrLoaded() {\n    // This should only be callable in the type system if we've already resolved this to an instance\n    if (this.isLoaded) {\n      return;\n    }\n    fail(`${this.entity}.${this.fieldName} was not loaded`);\n  }\n\n  [RelationT]: T = null!;\n  [RelationU]: U = null!;\n  [ReferenceN]: N = null!;\n}\n"],"mappings":";;;;;;;;;;;;AASA,SAAgB,mBACd,MAC0B;CAC1B,OAAO,WAAW,WAAc;EAC9B,OAAO,IAAI,gBAAyB,QAAQ,IAAI;CAClD,CAAC;AACH;;;;;;;;;;;;AA4BA,IAAa,kBAAb,cACU,qBAEV;CAUY;CAPV;CACA,cAAc;CACd;CACA;CAEA,YACE,QACA,MACA;EACA,MAAM,MAAM;EAFJ,KAAA,OAAA;CAGV;CAEA,IAAI,MAAa;EACf,OAAO,KAAK,MAAM,EAAE,aAAa,MAAM,CAAC;CAC1C;CAEA,IAAI,iBAAwB;EAC1B,OAAO,KAAK,MAAM,EAAE,aAAa,KAAK,CAAC;CACzC;CAEA,IAAI,WAAoB;EACtB,IAAI,KAAKA,cAAc,KAAA,GAAW,OAAO,KAAKA;EAC9C,iBAAiB,KAAK,OAAO,EAAE,CAAC,CAAC,cAAc,SAAS,IAAI;EAC5D,KAAKA,YAAY,KAAK,KAAK,SAAS,KAAK,MAAM;EAC/C,OAAO,KAAKA;CACd;CAEA,gBAAsB;EACpB,KAAKA,YAAY,KAAA;CACnB;CAEA,IAAI,WAAoC;EACtC,IAAI,KAAKC,cAAc,KAAA,KAAa,KAAK,KAAK,aAAa,KAAA,GAAW;GACpE,MAAM,EAAE,aAAa,KAAK;GAC1B,KAAKA,YAAY,OAAO,aAAa,aAAa,SAAS,KAAK,MAAM,IAAI;EAC5E;EACA,OAAO,KAAKA;CACd;CAEA,MAAM,KAAK,OAAyD,CAAC,GAAmB;EACtF,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,YAAY,KAAK,aAAa;GACtC,IAAI,KAAK,gBAAgB,KAAA,GAAW;IAClC,KAAK,cAAc,KAAK,KAAK,KAAK,KAAK,QAAQ,IAAI;IACnD,MAAM,KAAK;IACX,KAAK,cAAc,KAAA;IACnB,KAAKD,YAAY;GACnB,OACE,MAAM,KAAK;EAEf;EACA,OAAO,KAAK,MAAM,IAAI;CACxB;CAEA,IAAI,cAAuB;EACzB,OAAO;CACT;CAEA,UAAgB;EACd,MAAM,IAAI,MAAM,iBAAiB;CACnC;CAEA,IAAI,KAAc;EAChB,OAAO,KAAK,qCAAqC;CACnD;CAEA,IAAI,UAA+B;EACjC,OAAO,KAAK,0CAA0C;CACxD;CAEA,IAAI,gBAAsC;EACxC,OAAO,KAAK,gDAAgD;CAC9D;CAEA,IAAI,aAAqB;EACvB,OAAO,KAAK,6CAA6C;CAC3D;CAEA,IAAI,kBAAsC;EACxC,OAAO,KAAK,kDAAkD;CAChE;CAEA,IAAI,QAAiB;EACnB,KAAK,kBAAkB;EACvB,MAAM,EAAE,QAAQ,KAAK;EACrB,OAAO,IAAI,KAAK,MAAM,MAAM,KAAA;CAC9B;CAEA,IAAI,OAAgB;EAElB,IAAI,CAAC,KAAK,OAAO,aACf,KAAK,kBAAkB;EAEzB,MAAM,EAAE,QAAQ,KAAK;EACrB,IAAI,QAAQ,KAAA,GACV,MAAM,IAAI,MAAM,4BAA4B,MAAM;EAEpD,IAAI,KAAK,QAAQ,KAAK;EACtB,KAAKE,cAAc;CACrB;CAEA,YAAY,OAAgB;EAC1B,KAAK,IAAI,KAAK;CAChB;CAGA,MAAM,yBAAwC,CAAC;CAC/C,qBAA2B,CAAC;;CAG5B,IAAI,YAAoB;EACtB,OAAO,OAAO,QAAQ,cAAc,YAAY,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,QAC5D,CAAC,SAAU,KAAK,OAAe,SAAS,IAC3C,CAAC,CAAC,EAAE,CAAC;CACP;CAEA,IAAI,aAAa;EACf,OAAO,KAAKA;CACd;CAEA,WAAmB;EACjB,OAAO,2BAA2B,KAAK,OAAO,eAAe,KAAK,UAAU;CAC9E;CAEA,MAAc,MAAyC;EACrD,iBAAiB,KAAK,QAAQ,SAAS;EACvC,KAAK,kBAAkB;EACvB,OAAO,KAAK,cAAc,KAAK,KAAK,IAAI,KAAK,MAAM,GAAG,IAAI;CAC5D;CAEA,cAAsB,QAAe,MAAyC;EAC5E,OAAO,MAAM,gBAAgB,QAAQ,WAAW,KAAA,KAAa,CAAC,OAAO,kBAAkB,SAAU,KAAA;CACnG;CAEA,oBAA4B;EAE1B,IAAI,KAAK,UACP;EAEF,KAAK,GAAG,KAAK,OAAO,GAAG,KAAK,UAAU,gBAAgB;CACxD;CAEA,CAAC,aAAgB;CACjB,CAAC,aAAgB;CACjB,CAAC,cAAiB;AACpB"}