joist-core 2.3.0 → 2.4.0

package/build/relations/RecursiveCollection.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecursiveCollection.cjs","names":["lazyField","AbstractRelationImpl","getMetadata","RelationT","RelationU","#fieldName","#m2oName","#otherFieldName","#loaded","#loadPromise","recursiveParentsBatchLoader","appendStack","RecursiveCycleError","isReference","isLoadedReference","#o2mName","recursiveChildrenBatchLoader","isCollection","isLoadedCollection","isOneToOneReference","isLoadedOneToOneReference","#m2mName","recursiveM2mBatchLoader","fail"],"sources":["../../src/relations/RecursiveCollection.ts"],"sourcesContent":["import { recursiveChildrenBatchLoader } from \"src/batchloaders/recursiveChildrenBatchLoader.ts\";\nimport { recursiveM2mBatchLoader } from \"src/batchloaders/recursiveM2mBatchLoader.ts\";\nimport { recursiveParentsBatchLoader } from \"src/batchloaders/recursiveParentsBatchLoader.ts\";\nimport {\n  type Entity,\n  type EntityMetadata,\n  type ManyToManyField,\n  type Reference,\n  type Relation,\n  appendStack,\n  ensureNotDeleted,\n  fail,\n  getEmInternalApi,\n  getMetadata,\n  isCollection,\n  isLoadedCollection,\n  isLoadedOneToOneReference,\n  isLoadedReference,\n  isOneToOneReference,\n  isReference,\n} from \"src/index.ts\";\nimport type { IsLoadedCachable } from \"src/loading/IsLoadedCache.ts\";\nimport { lazyField } from \"src/newEntity.ts\";\nimport { AbstractRelationImpl } from \"src/relations/AbstractRelationImpl.ts\";\nimport { type ReadOnlyCollection } from \"src/relations/ReadOnlyCollection.ts\";\nimport { RecursiveCycleError } from \"src/relations/RecursiveCycleError.ts\";\nimport { RelationT, RelationU } from \"src/relations/RelationSymbols.ts\";\n\nexport { RecursiveCycleError };\n\n/**\n * An alias for creating `RecursiveParentsCollectionImpl`s.\n *\n * I.e. for `Author.mentor` (m2o fk), we can return `Author.mentorsRecursive` recursively looking up.\n */\nexport function hasRecursiveParents<T extends Entity, U extends Entity>(\n  m2oName: keyof T & string, // i.e. `author.mentor`\n  otherFieldName: keyof T & string, // i.e. `author.menteesRecursive`\n): ReadOnlyCollection<T, U> {\n  return lazyField((entity: T, fieldName) => {\n    return new RecursiveParentsCollectionImpl(entity, fieldName as keyof T & string, m2oName, otherFieldName);\n  });\n}\n\n/**\n * An alias for creating `RecursiveChildrenCollectionImpl`s.\n *\n * I.e. for `Author.mentees` (o2m), we can return `Author.menteesRecursive` recursively looking down.\n */\nexport function hasRecursiveChildren<T extends Entity, U extends Entity>(\n  o2mName: keyof T & string, // i.e. `author.mentees`\n  otherFieldName: keyof T & string, // i.e. `author.mentorsRecursive`\n): ReadOnlyCollection<T, U> {\n  return lazyField((entity: T, fieldName) => {\n    return new RecursiveChildrenCollectionImpl(entity, fieldName as keyof T & string, o2mName, otherFieldName);\n  });\n}\n\n/**\n * An alias for creating `RecursiveM2mCollectionImpl`s.\n *\n * I.e. for `User.parents` (m2m), we can return `User.parentsRecursive` recursively looking up through the m2m.\n * Or for `User.children` (m2m), we can return `User.childrenRecursive` recursively looking down.\n */\nexport function hasRecursiveM2m<T extends Entity, U extends Entity>(\n  m2mName: keyof T & string, // i.e. `user.parents` or `user.children`\n  otherFieldName: keyof T & string, // i.e. `user.childrenRecursive` or `user.parentsRecursive`\n): ReadOnlyCollection<T, U> {\n  return lazyField((entity: T, fieldName) => {\n    return new RecursiveM2mCollectionImpl(entity, fieldName as keyof T & string, m2mName, otherFieldName);\n  });\n}\n\n/**\n * A base class for the common methods between the parent & children recursive collections.\n *\n * We could probably move some of this into AbstractRelationImpl?\n */\nabstract class AbstractRecursiveCollectionImpl<T extends Entity, U extends Entity> extends AbstractRelationImpl<\n  T,\n  U[]\n> {\n  abstract fieldName: string;\n\n  get get(): U[] {\n    return this.filterDeleted(this.doGet(), { withDeleted: false });\n  }\n\n  get getWithDeleted(): U[] {\n    return this.filterDeleted(this.doGet(), { withDeleted: true });\n  }\n\n  setFromOpts(): void {\n    throw new Error(\"Method not implemented.\");\n  }\n\n  set(): void {\n    throw new Error(\"Method not implemented.\");\n  }\n\n  get isPreloaded(): boolean {\n    return false;\n  }\n\n  preload(): void {\n    throw new Error(\"Method not implemented.\");\n  }\n\n  cleanupOnEntityDeleted(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  maybeCascadeDelete(): void {}\n\n  get meta(): EntityMetadata {\n    return getMetadata(this.entity);\n  }\n\n  abstract doGet(): U[];\n\n  /** Removes pending-hard-delete or soft-deleted entities, unless explicitly asked for. */\n  protected filterDeleted(entities: U[], opts?: { withDeleted?: boolean }): U[] {\n    return opts?.withDeleted === true\n      ? [...entities]\n      : entities.filter((e) => !e.isDeletedEntity && !(e as any).isSoftDeletedEntity);\n  }\n\n  [RelationT]: T = null!;\n  [RelationU]: U = null!;\n}\n\nexport class RecursiveParentsCollectionImpl<T extends Entity, U extends Entity>\n  extends AbstractRecursiveCollectionImpl<T, U>\n  implements ReadOnlyCollection<T, U>, IsLoadedCachable\n{\n  readonly #fieldName: keyof T & string;\n  readonly #m2oName: keyof T & string;\n  readonly #otherFieldName: keyof T & string;\n  #loaded: boolean | undefined = undefined;\n  #loadPromise: Promise<void> | undefined;\n\n  constructor(entity: T, fieldName: keyof T & string, m2oName: keyof T & string, otherFieldName: keyof T & string) {\n    super(entity);\n    this.#fieldName = fieldName;\n    this.#m2oName = m2oName;\n    this.#otherFieldName = otherFieldName;\n  }\n\n  // opts is an internal parameter\n  async load(opts: { withDeleted?: boolean; forceReload?: boolean } = {}): Promise<readonly U[]> {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded || opts.forceReload) {\n      if (opts.forceReload) {\n        this.#loaded = undefined;\n      }\n      // If we have `[grandchild, newlyCreatedParent, existingGrandparent, ...more...]`, skip up to the\n      // `existingGrandparent`, because if we `.load(entity)` (i.e. where we are the `grandchild`) then\n      // recursiveParentsBatchLoader will try CTE query up from `grandchild[parent]`, but since that will\n      // be `newlyCreatedParent`, it doesn't have an id yet.\n      const entityToLoad = opts.forceReload ? this.entity : this.findUnloadedReference()?.entity;\n      if (entityToLoad && !entityToLoad.isNewEntity) {\n        await (this.#loadPromise ??= recursiveParentsBatchLoader(this.entity.em, this)\n          .load(entityToLoad)\n          .catch(function load(err) {\n            throw appendStack(err, new Error());\n          })\n          .finally(() => {\n            this.#loadPromise = undefined;\n          }));\n        // See if there are any WIP changes, i.e. new parents, that the ^ SQL query didn't know to load.\n        // We don't have to `while` loop this, because if parent itself has WIP changes above it, then\n        // its own `RecursiveParentsCollectionImpl.load` will load it, before returning to this method.\n        const unloadedParent = this.findUnloadedReference();\n        if (unloadedParent) {\n          await recursiveParentsBatchLoader(this.entity.em, this)\n            .load(unloadedParent.entity)\n            .catch(function load(err) {\n              throw appendStack(err, new Error());\n            });\n        }\n      }\n      this.#loaded = true;\n    }\n    return this.filterDeleted(this.doGet(), opts);\n  }\n\n  get isLoaded(): boolean {\n    if (this.#loaded !== undefined) return this.#loaded;\n    this.#loaded = this.findUnloadedReference() === undefined;\n    getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);\n    return this.#loaded;\n  }\n\n  resetIsLoaded(): void {\n    this.#loaded = undefined;\n  }\n\n  get fieldName(): string {\n    return this.#fieldName;\n  }\n\n  get m2oFieldName(): string {\n    return this.#m2oName;\n  }\n\n  get otherFieldName(): string {\n    return this.#otherFieldName;\n  }\n\n  get hasBeenSet(): boolean {\n    return false;\n  }\n\n  toString(): string {\n    return `RecursiveParentsCollectionImpl(entity: ${this.entity}, fieldName: ${this.fieldName})`;\n  }\n\n  doGet(): U[] {\n    ensureNotDeleted(this.entity, \"pending\");\n    const unloaded = this.findUnloadedReference();\n    if (unloaded) {\n      throw new Error(this.toString() + `.get was called but ${unloaded} was not loaded`);\n    }\n    const parents: U[] = [];\n    const visited = new Set<U>();\n    for (\n      let current = getLoadedReference(this.entity[this.#m2oName]);\n      current !== undefined;\n      current = getLoadedReference(current[this.#m2oName])\n    ) {\n      parents.push(current);\n      if (visited.has(current)) throw new RecursiveCycleError(this, [...visited, current]);\n      visited.add(current);\n    }\n    return parents;\n  }\n\n  private findUnloadedReference(): Reference<any, any, any> | undefined {\n    const visited = new Set<any>();\n    for (let current = this.entity; current !== undefined; current = getLoadedReference(current[this.#m2oName])) {\n      const relation = current[this.#m2oName];\n      if (isReference(relation) && !isLoadedReference(relation)) return relation;\n      if (visited.has(current)) throw new RecursiveCycleError(this, [...visited, current]);\n      visited.add(current);\n    }\n    return undefined;\n  }\n}\n\nexport class RecursiveChildrenCollectionImpl<T extends Entity, U extends Entity>\n  extends AbstractRecursiveCollectionImpl<T, U>\n  implements ReadOnlyCollection<T, U>, IsLoadedCachable\n{\n  readonly #fieldName: keyof T & string;\n  readonly #o2mName: keyof T & string;\n  readonly #otherFieldName: keyof T & string;\n  #loaded: boolean | undefined = undefined;\n  #loadPromise: Promise<void> | undefined;\n\n  constructor(entity: T, fieldName: keyof T & string, o2mName: keyof T & string, otherFieldName: keyof T & string) {\n    super(entity);\n    this.#fieldName = fieldName;\n    this.#o2mName = o2mName;\n    this.#otherFieldName = otherFieldName;\n  }\n\n  // opts is an internal parameter\n  async load(opts: { withDeleted?: boolean; forceReload?: boolean } = {}): Promise<readonly U[]> {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded || opts.forceReload) {\n      if (opts.forceReload) {\n        this.#loaded = undefined;\n      }\n      if (!this.entity.isNewEntity) {\n        await (this.#loadPromise ??= recursiveChildrenBatchLoader(this.entity.em, this)\n          .load(this.entity)\n          .catch(function load(err) {\n            throw appendStack(err, new Error());\n          })\n          .finally(() => {\n            this.#loadPromise = undefined;\n          }));\n      }\n      const unloaded = this.findUnloadedCollections();\n      if (unloaded.length > 0) {\n        // Go through the entities own `fooRecursive` collection so that it's marked as loaded.\n        // We don't have to `while` loop this, because if they children themselves have any WIP\n        // changes, then their own `RecursiveChildrenCollectionImpl.load` will load them.\n        await Promise.all(unloaded.map((r) => (r.entity as any)[this.fieldName].load(opts)));\n      }\n      this.#loaded = true;\n    }\n    return this.filterDeleted(this.doGet(), opts);\n  }\n\n  get isLoaded(): boolean {\n    if (this.#loaded !== undefined) return this.#loaded;\n    this.#loaded = this.findUnloadedCollections().length === 0;\n    getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);\n    return this.#loaded;\n  }\n\n  resetIsLoaded(): void {\n    this.#loaded = undefined;\n  }\n\n  get fieldName(): string {\n    return this.#fieldName;\n  }\n\n  get o2mFieldName(): string {\n    return this.#o2mName;\n  }\n\n  get otherFieldName(): string {\n    return this.#otherFieldName;\n  }\n\n  get hasBeenSet(): boolean {\n    return false;\n  }\n\n  toString(): string {\n    return `RecursiveChildrenCollectionImpl(entity: ${this.entity}, fieldName: ${this.fieldName})`;\n  }\n\n  doGet(): U[] {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded) {\n      throw new Error(this.toString() + `.get was called but when not loaded`);\n    }\n    const children: U[] = [];\n    const visited = new Set<any>();\n    // Use a node+path combo to know which path caused the cycle\n    const todo: { relation: any; path: U[] }[] = [{ relation: this.entity[this.#o2mName], path: [this.entity as any] }];\n    while (todo.length > 0) {\n      const { relation, path } = todo.pop()!;\n      if (visited.has(relation)) throw new RecursiveCycleError(this, path);\n      visited.add(relation);\n      for (const child of getLoadedCollection(relation)) {\n        children.push(child);\n        todo.push({ relation: child[this.#o2mName], path: [...path, child] });\n      }\n    }\n    return children;\n  }\n\n  /** Finds any children/downstream o2m collections or o2o references. */\n  private findUnloadedCollections(): Relation<any, any>[] {\n    const visited = new Set<any>();\n    const unloaded: Relation<any, any>[] = [];\n    const todo: { relation: any; path: U[] }[] = [{ relation: this.entity[this.#o2mName], path: [this.entity as any] }];\n    while (todo.length > 0) {\n      const { relation, path } = todo.pop()!;\n      if (visited.has(relation)) throw new RecursiveCycleError(this, path);\n      visited.add(relation);\n      if (isCollection(relation) && !isLoadedCollection(relation)) {\n        unloaded.push(relation);\n      } else if (isOneToOneReference(relation) && !isLoadedOneToOneReference(relation)) {\n        unloaded.push(relation);\n      } else {\n        for (const child of getLoadedCollection(relation)) {\n          todo.push({ relation: child[this.#o2mName], path: [...path, child] });\n        }\n      }\n    }\n    return unloaded;\n  }\n}\n\nexport class RecursiveM2mCollectionImpl<T extends Entity, U extends Entity>\n  extends AbstractRecursiveCollectionImpl<T, U>\n  implements ReadOnlyCollection<T, U>, IsLoadedCachable\n{\n  readonly #fieldName: keyof T & string;\n  readonly #m2mName: keyof T & string;\n  readonly #otherFieldName: keyof T & string;\n  #loaded: boolean | undefined = undefined;\n  #loadPromise: Promise<void> | undefined;\n\n  constructor(entity: T, fieldName: keyof T & string, m2mName: keyof T & string, otherFieldName: keyof T & string) {\n    super(entity);\n    this.#fieldName = fieldName;\n    this.#m2mName = m2mName;\n    this.#otherFieldName = otherFieldName;\n  }\n\n  // opts is an internal parameter\n  async load(opts: { withDeleted?: boolean; forceReload?: boolean } = {}): Promise<readonly U[]> {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded || opts.forceReload) {\n      if (opts.forceReload) {\n        this.#loaded = undefined;\n      }\n      if (!this.entity.isNewEntity) {\n        await (this.#loadPromise ??= recursiveM2mBatchLoader(this.entity.em, this)\n          .load(this.entity)\n          .catch(function load(err: any) {\n            throw appendStack(err, new Error());\n          })\n          .finally(() => {\n            this.#loadPromise = undefined;\n          }));\n      }\n      const unloaded = this.findUnloadedCollections();\n      if (unloaded.length > 0) {\n        // Go through the entity's own `fooRecursive` collection so that it's marked as loaded.\n        await Promise.all(unloaded.map((r) => (r.entity as any)[this.fieldName].load(opts)));\n      }\n      this.#loaded = true;\n    }\n    return this.filterDeleted(this.doGet(), opts);\n  }\n\n  get isLoaded(): boolean {\n    if (this.#loaded !== undefined) return this.#loaded;\n    this.#loaded = this.findUnloadedCollections().length === 0;\n    getEmInternalApi(this.entity.em).isLoadedCache.addNaive(this);\n    return this.#loaded;\n  }\n\n  resetIsLoaded(): void {\n    this.#loaded = undefined;\n  }\n\n  get fieldName(): string {\n    return this.#fieldName;\n  }\n\n  get m2mFieldName(): string {\n    return this.#m2mName;\n  }\n\n  get otherFieldName(): string {\n    return this.#otherFieldName;\n  }\n\n  get m2mField(): ManyToManyField {\n    return this.meta.allFields[this.#m2mName] as ManyToManyField;\n  }\n\n  get hasBeenSet(): boolean {\n    return false;\n  }\n\n  toString(): string {\n    return `RecursiveM2mCollectionImpl(entity: ${this.entity}, fieldName: ${this.fieldName})`;\n  }\n\n  doGet(): U[] {\n    ensureNotDeleted(this.entity, \"pending\");\n    if (!this.isLoaded) {\n      throw new Error(this.toString() + `.get was called but when not loaded`);\n    }\n    const results: U[] = [];\n    // Track by entity to handle diamonds (same entity reachable via multiple paths)\n    const visited = new Set<any>();\n    visited.add(this.entity);\n    const todo: { entity: any; path: U[] }[] = [{ entity: this.entity, path: [this.entity as any] }];\n    while (todo.length > 0) {\n      const { entity: current, path } = todo.pop()!;\n      for (const other of getLoadedCollection(current[this.#m2mName])) {\n        if (visited.has(other)) {\n          // If we're reaching an entity we've already visited, and it's this.entity, that's a cycle\n          if (other === this.entity) throw new RecursiveCycleError(this, [...path, other]);\n          // Otherwise it's a diamond (reachable via multiple paths) — skip\n          continue;\n        }\n        visited.add(other);\n        results.push(other);\n        todo.push({ entity: other, path: [...path, other] });\n      }\n    }\n    return results;\n  }\n\n  /** Finds any m2m collections that are not yet loaded in the recursive tree. */\n  private findUnloadedCollections(): Relation<any, any>[] {\n    const visited = new Set<any>();\n    visited.add(this.entity);\n    const unloaded: Relation<any, any>[] = [];\n    const todo: { entity: any; path: U[] }[] = [{ entity: this.entity, path: [this.entity as any] }];\n    while (todo.length > 0) {\n      const { entity: current, path } = todo.pop()!;\n      const relation = current[this.#m2mName];\n      if (isCollection(relation) && !isLoadedCollection(relation)) {\n        unloaded.push(relation);\n      } else {\n        for (const other of getLoadedCollection(relation)) {\n          if (visited.has(other)) {\n            if (other === this.entity) throw new RecursiveCycleError(this, [...path, other]);\n            continue;\n          }\n          visited.add(other);\n          todo.push({ entity: other, path: [...path, other] });\n        }\n      }\n    }\n    return unloaded;\n  }\n}\n\nfunction getLoadedReference(relation: any): any {\n  return isLoadedReference(relation) ? relation.get : fail(`${relation} was not loaded`);\n}\n\nfunction getLoadedCollection(relation: any): any {\n  return isLoadedCollection(relation)\n    ? relation.get\n    : isLoadedOneToOneReference(relation)\n      ? relation.get\n        ? [relation.get]\n        : []\n      : fail(`${relation} was not loaded`);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAmCA,SAAgB,oBACd,SACA,gBAC0B;CAC1B,OAAOA,kBAAAA,WAAW,QAAW,cAAc;EACzC,OAAO,IAAI,+BAA+B,QAAQ,WAA+B,SAAS,cAAc;CAC1G,CAAC;AACH;;;;;;AAOA,SAAgB,qBACd,SACA,gBAC0B;CAC1B,OAAOA,kBAAAA,WAAW,QAAW,cAAc;EACzC,OAAO,IAAI,gCAAgC,QAAQ,WAA+B,SAAS,cAAc;CAC3G,CAAC;AACH;;;;;;;AAQA,SAAgB,gBACd,SACA,gBAC0B;CAC1B,OAAOA,kBAAAA,WAAW,QAAW,cAAc;EACzC,OAAO,IAAI,2BAA2B,QAAQ,WAA+B,SAAS,cAAc;CACtG,CAAC;AACH;;;;;;AAOA,IAAe,kCAAf,cAA2FC,uCAAAA,qBAGzF;CAGA,IAAI,MAAW;EACb,OAAO,KAAK,cAAc,KAAK,MAAM,GAAG,EAAE,aAAa,MAAM,CAAC;CAChE;CAEA,IAAI,iBAAsB;EACxB,OAAO,KAAK,cAAc,KAAK,MAAM,GAAG,EAAE,aAAa,KAAK,CAAC;CAC/D;CAEA,cAAoB;EAClB,MAAM,IAAI,MAAM,yBAAyB;CAC3C;CAEA,MAAY;EACV,MAAM,IAAI,MAAM,yBAAyB;CAC3C;CAEA,IAAI,cAAuB;EACzB,OAAO;CACT;CAEA,UAAgB;EACd,MAAM,IAAI,MAAM,yBAAyB;CAC3C;CAEA,yBAAwC;EACtC,OAAO,QAAQ,QAAQ;CACzB;CAEA,qBAA2B,CAAC;CAE5B,IAAI,OAAuB;EACzB,OAAOC,uBAAAA,YAAY,KAAK,MAAM;CAChC;;CAKA,cAAwB,UAAe,MAAuC;EAC5E,OAAO,MAAM,gBAAgB,OACzB,CAAC,GAAG,QAAQ,IACZ,SAAS,QAAQ,MAAM,CAAC,EAAE,mBAAmB,CAAE,EAAU,mBAAmB;CAClF;CAEA,CAACC,kCAAAA,aAAgB;CACjB,CAACC,kCAAAA,aAAgB;AACnB;AAEA,IAAa,iCAAb,cACU,gCAEV;CACE;CACA;CACA;CACA,UAA+B,KAAA;CAC/B;CAEA,YAAY,QAAW,WAA6B,SAA2B,gBAAkC;EAC/G,MAAM,MAAM;EACZ,KAAKC,aAAa;EAClB,KAAKC,WAAW;EAChB,KAAKC,kBAAkB;CACzB;CAGA,MAAM,KAAK,OAAyD,CAAC,GAA0B;EAC7F,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,YAAY,KAAK,aAAa;GACtC,IAAI,KAAK,aACP,KAAKC,UAAU,KAAA;GAMjB,MAAM,eAAe,KAAK,cAAc,KAAK,SAAS,KAAK,sBAAsB,CAAC,EAAE;GACpF,IAAI,gBAAgB,CAAC,aAAa,aAAa;IAC7C,OAAO,KAAKC,iBAAiBC,iDAAAA,4BAA4B,KAAK,OAAO,IAAI,IAAI,CAAC,CAC3E,KAAK,YAAY,CAAC,CAClB,MAAM,SAAS,KAAK,KAAK;KACxB,MAAMC,sBAAAA,YAAY,qBAAK,IAAI,MAAM,CAAC;IACpC,CAAC,CAAC,CACD,cAAc;KACb,KAAKF,eAAe,KAAA;IACtB,CAAC;IAIH,MAAM,iBAAiB,KAAK,sBAAsB;IAClD,IAAI,gBACF,MAAMC,iDAAAA,4BAA4B,KAAK,OAAO,IAAI,IAAI,CAAC,CACpD,KAAK,eAAe,MAAM,CAAC,CAC3B,MAAM,SAAS,KAAK,KAAK;KACxB,MAAMC,sBAAAA,YAAY,qBAAK,IAAI,MAAM,CAAC;IACpC,CAAC;GAEP;GACA,KAAKH,UAAU;EACjB;EACA,OAAO,KAAK,cAAc,KAAK,MAAM,GAAG,IAAI;CAC9C;CAEA,IAAI,WAAoB;EACtB,IAAI,KAAKA,YAAY,KAAA,GAAW,OAAO,KAAKA;EAC5C,KAAKA,UAAU,KAAK,sBAAsB,MAAM,KAAA;EAChD,sBAAA,iBAAiB,KAAK,OAAO,EAAE,CAAC,CAAC,cAAc,SAAS,IAAI;EAC5D,OAAO,KAAKA;CACd;CAEA,gBAAsB;EACpB,KAAKA,UAAU,KAAA;CACjB;CAEA,IAAI,YAAoB;EACtB,OAAO,KAAKH;CACd;CAEA,IAAI,eAAuB;EACzB,OAAO,KAAKC;CACd;CAEA,IAAI,iBAAyB;EAC3B,OAAO,KAAKC;CACd;CAEA,IAAI,aAAsB;EACxB,OAAO;CACT;CAEA,WAAmB;EACjB,OAAO,0CAA0C,KAAK,OAAO,eAAe,KAAK,UAAU;CAC7F;CAEA,QAAa;EACX,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,MAAM,WAAW,KAAK,sBAAsB;EAC5C,IAAI,UACF,MAAM,IAAI,MAAM,KAAK,SAAS,IAAI,uBAAuB,SAAS,gBAAgB;EAEpF,MAAM,UAAe,CAAC;EACtB,MAAM,0BAAU,IAAI,IAAO;EAC3B,KACE,IAAI,UAAU,mBAAmB,KAAK,OAAO,KAAKD,SAAS,GAC3D,YAAY,KAAA,GACZ,UAAU,mBAAmB,QAAQ,KAAKA,SAAS,GACnD;GACA,QAAQ,KAAK,OAAO;GACpB,IAAI,QAAQ,IAAI,OAAO,GAAG,MAAM,IAAIM,sCAAAA,oBAAoB,MAAM,CAAC,GAAG,SAAS,OAAO,CAAC;GACnF,QAAQ,IAAI,OAAO;EACrB;EACA,OAAO;CACT;CAEA,wBAAsE;EACpE,MAAM,0BAAU,IAAI,IAAS;EAC7B,KAAK,IAAI,UAAU,KAAK,QAAQ,YAAY,KAAA,GAAW,UAAU,mBAAmB,QAAQ,KAAKN,SAAS,GAAG;GAC3G,MAAM,WAAW,QAAQ,KAAKA;GAC9B,IAAIO,4BAAAA,YAAY,QAAQ,KAAK,CAACC,4BAAAA,kBAAkB,QAAQ,GAAG,OAAO;GAClE,IAAI,QAAQ,IAAI,OAAO,GAAG,MAAM,IAAIF,sCAAAA,oBAAoB,MAAM,CAAC,GAAG,SAAS,OAAO,CAAC;GACnF,QAAQ,IAAI,OAAO;EACrB;CAEF;AACF;AAEA,IAAa,kCAAb,cACU,gCAEV;CACE;CACA;CACA;CACA,UAA+B,KAAA;CAC/B;CAEA,YAAY,QAAW,WAA6B,SAA2B,gBAAkC;EAC/G,MAAM,MAAM;EACZ,KAAKP,aAAa;EAClB,KAAKU,WAAW;EAChB,KAAKR,kBAAkB;CACzB;CAGA,MAAM,KAAK,OAAyD,CAAC,GAA0B;EAC7F,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,YAAY,KAAK,aAAa;GACtC,IAAI,KAAK,aACP,KAAKC,UAAU,KAAA;GAEjB,IAAI,CAAC,KAAK,OAAO,aACf,OAAO,KAAKC,iBAAiBO,kDAAAA,6BAA6B,KAAK,OAAO,IAAI,IAAI,CAAC,CAC5E,KAAK,KAAK,MAAM,CAAC,CACjB,MAAM,SAAS,KAAK,KAAK;IACxB,MAAML,sBAAAA,YAAY,qBAAK,IAAI,MAAM,CAAC;GACpC,CAAC,CAAC,CACD,cAAc;IACb,KAAKF,eAAe,KAAA;GACtB,CAAC;GAEL,MAAM,WAAW,KAAK,wBAAwB;GAC9C,IAAI,SAAS,SAAS,GAIpB,MAAM,QAAQ,IAAI,SAAS,KAAK,MAAO,EAAE,OAAe,KAAK,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC;GAErF,KAAKD,UAAU;EACjB;EACA,OAAO,KAAK,cAAc,KAAK,MAAM,GAAG,IAAI;CAC9C;CAEA,IAAI,WAAoB;EACtB,IAAI,KAAKA,YAAY,KAAA,GAAW,OAAO,KAAKA;EAC5C,KAAKA,UAAU,KAAK,wBAAwB,CAAC,CAAC,WAAW;EACzD,sBAAA,iBAAiB,KAAK,OAAO,EAAE,CAAC,CAAC,cAAc,SAAS,IAAI;EAC5D,OAAO,KAAKA;CACd;CAEA,gBAAsB;EACpB,KAAKA,UAAU,KAAA;CACjB;CAEA,IAAI,YAAoB;EACtB,OAAO,KAAKH;CACd;CAEA,IAAI,eAAuB;EACzB,OAAO,KAAKU;CACd;CAEA,IAAI,iBAAyB;EAC3B,OAAO,KAAKR;CACd;CAEA,IAAI,aAAsB;EACxB,OAAO;CACT;CAEA,WAAmB;EACjB,OAAO,2CAA2C,KAAK,OAAO,eAAe,KAAK,UAAU;CAC9F;CAEA,QAAa;EACX,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,UACR,MAAM,IAAI,MAAM,KAAK,SAAS,IAAI,qCAAqC;EAEzE,MAAM,WAAgB,CAAC;EACvB,MAAM,0BAAU,IAAI,IAAS;EAE7B,MAAM,OAAuC,CAAC;GAAE,UAAU,KAAK,OAAO,KAAKQ;GAAW,MAAM,CAAC,KAAK,MAAa;EAAE,CAAC;EAClH,OAAO,KAAK,SAAS,GAAG;GACtB,MAAM,EAAE,UAAU,SAAS,KAAK,IAAI;GACpC,IAAI,QAAQ,IAAI,QAAQ,GAAG,MAAM,IAAIH,sCAAAA,oBAAoB,MAAM,IAAI;GACnE,QAAQ,IAAI,QAAQ;GACpB,KAAK,MAAM,SAAS,oBAAoB,QAAQ,GAAG;IACjD,SAAS,KAAK,KAAK;IACnB,KAAK,KAAK;KAAE,UAAU,MAAM,KAAKG;KAAW,MAAM,CAAC,GAAG,MAAM,KAAK;IAAE,CAAC;GACtE;EACF;EACA,OAAO;CACT;;CAGA,0BAAwD;EACtD,MAAM,0BAAU,IAAI,IAAS;EAC7B,MAAM,WAAiC,CAAC;EACxC,MAAM,OAAuC,CAAC;GAAE,UAAU,KAAK,OAAO,KAAKA;GAAW,MAAM,CAAC,KAAK,MAAa;EAAE,CAAC;EAClH,OAAO,KAAK,SAAS,GAAG;GACtB,MAAM,EAAE,UAAU,SAAS,KAAK,IAAI;GACpC,IAAI,QAAQ,IAAI,QAAQ,GAAG,MAAM,IAAIH,sCAAAA,oBAAoB,MAAM,IAAI;GACnE,QAAQ,IAAI,QAAQ;GACpB,IAAIK,6BAAAA,aAAa,QAAQ,KAAK,CAACC,6BAAAA,mBAAmB,QAAQ,GACxD,SAAS,KAAK,QAAQ;QACjB,IAAIC,oCAAAA,oBAAoB,QAAQ,KAAK,CAACC,oCAAAA,0BAA0B,QAAQ,GAC7E,SAAS,KAAK,QAAQ;QAEtB,KAAK,MAAM,SAAS,oBAAoB,QAAQ,GAC9C,KAAK,KAAK;IAAE,UAAU,MAAM,KAAKL;IAAW,MAAM,CAAC,GAAG,MAAM,KAAK;GAAE,CAAC;EAG1E;EACA,OAAO;CACT;AACF;AAEA,IAAa,6BAAb,cACU,gCAEV;CACE;CACA;CACA;CACA,UAA+B,KAAA;CAC/B;CAEA,YAAY,QAAW,WAA6B,SAA2B,gBAAkC;EAC/G,MAAM,MAAM;EACZ,KAAKV,aAAa;EAClB,KAAKgB,WAAW;EAChB,KAAKd,kBAAkB;CACzB;CAGA,MAAM,KAAK,OAAyD,CAAC,GAA0B;EAC7F,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,YAAY,KAAK,aAAa;GACtC,IAAI,KAAK,aACP,KAAKC,UAAU,KAAA;GAEjB,IAAI,CAAC,KAAK,OAAO,aACf,OAAO,KAAKC,iBAAiBa,6CAAAA,wBAAwB,KAAK,OAAO,IAAI,IAAI,CAAC,CACvE,KAAK,KAAK,MAAM,CAAC,CACjB,MAAM,SAAS,KAAK,KAAU;IAC7B,MAAMX,sBAAAA,YAAY,qBAAK,IAAI,MAAM,CAAC;GACpC,CAAC,CAAC,CACD,cAAc;IACb,KAAKF,eAAe,KAAA;GACtB,CAAC;GAEL,MAAM,WAAW,KAAK,wBAAwB;GAC9C,IAAI,SAAS,SAAS,GAEpB,MAAM,QAAQ,IAAI,SAAS,KAAK,MAAO,EAAE,OAAe,KAAK,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC;GAErF,KAAKD,UAAU;EACjB;EACA,OAAO,KAAK,cAAc,KAAK,MAAM,GAAG,IAAI;CAC9C;CAEA,IAAI,WAAoB;EACtB,IAAI,KAAKA,YAAY,KAAA,GAAW,OAAO,KAAKA;EAC5C,KAAKA,UAAU,KAAK,wBAAwB,CAAC,CAAC,WAAW;EACzD,sBAAA,iBAAiB,KAAK,OAAO,EAAE,CAAC,CAAC,cAAc,SAAS,IAAI;EAC5D,OAAO,KAAKA;CACd;CAEA,gBAAsB;EACpB,KAAKA,UAAU,KAAA;CACjB;CAEA,IAAI,YAAoB;EACtB,OAAO,KAAKH;CACd;CAEA,IAAI,eAAuB;EACzB,OAAO,KAAKgB;CACd;CAEA,IAAI,iBAAyB;EAC3B,OAAO,KAAKd;CACd;CAEA,IAAI,WAA4B;EAC9B,OAAO,KAAK,KAAK,UAAU,KAAKc;CAClC;CAEA,IAAI,aAAsB;EACxB,OAAO;CACT;CAEA,WAAmB;EACjB,OAAO,sCAAsC,KAAK,OAAO,eAAe,KAAK,UAAU;CACzF;CAEA,QAAa;EACX,cAAA,iBAAiB,KAAK,QAAQ,SAAS;EACvC,IAAI,CAAC,KAAK,UACR,MAAM,IAAI,MAAM,KAAK,SAAS,IAAI,qCAAqC;EAEzE,MAAM,UAAe,CAAC;EAEtB,MAAM,0BAAU,IAAI,IAAS;EAC7B,QAAQ,IAAI,KAAK,MAAM;EACvB,MAAM,OAAqC,CAAC;GAAE,QAAQ,KAAK;GAAQ,MAAM,CAAC,KAAK,MAAa;EAAE,CAAC;EAC/F,OAAO,KAAK,SAAS,GAAG;GACtB,MAAM,EAAE,QAAQ,SAAS,SAAS,KAAK,IAAI;GAC3C,KAAK,MAAM,SAAS,oBAAoB,QAAQ,KAAKA,SAAS,GAAG;IAC/D,IAAI,QAAQ,IAAI,KAAK,GAAG;KAEtB,IAAI,UAAU,KAAK,QAAQ,MAAM,IAAIT,sCAAAA,oBAAoB,MAAM,CAAC,GAAG,MAAM,KAAK,CAAC;KAE/E;IACF;IACA,QAAQ,IAAI,KAAK;IACjB,QAAQ,KAAK,KAAK;IAClB,KAAK,KAAK;KAAE,QAAQ;KAAO,MAAM,CAAC,GAAG,MAAM,KAAK;IAAE,CAAC;GACrD;EACF;EACA,OAAO;CACT;;CAGA,0BAAwD;EACtD,MAAM,0BAAU,IAAI,IAAS;EAC7B,QAAQ,IAAI,KAAK,MAAM;EACvB,MAAM,WAAiC,CAAC;EACxC,MAAM,OAAqC,CAAC;GAAE,QAAQ,KAAK;GAAQ,MAAM,CAAC,KAAK,MAAa;EAAE,CAAC;EAC/F,OAAO,KAAK,SAAS,GAAG;GACtB,MAAM,EAAE,QAAQ,SAAS,SAAS,KAAK,IAAI;GAC3C,MAAM,WAAW,QAAQ,KAAKS;GAC9B,IAAIJ,6BAAAA,aAAa,QAAQ,KAAK,CAACC,6BAAAA,mBAAmB,QAAQ,GACxD,SAAS,KAAK,QAAQ;QAEtB,KAAK,MAAM,SAAS,oBAAoB,QAAQ,GAAG;IACjD,IAAI,QAAQ,IAAI,KAAK,GAAG;KACtB,IAAI,UAAU,KAAK,QAAQ,MAAM,IAAIN,sCAAAA,oBAAoB,MAAM,CAAC,GAAG,MAAM,KAAK,CAAC;KAC/E;IACF;IACA,QAAQ,IAAI,KAAK;IACjB,KAAK,KAAK;KAAE,QAAQ;KAAO,MAAM,CAAC,GAAG,MAAM,KAAK;IAAE,CAAC;GACrD;EAEJ;EACA,OAAO;CACT;AACF;AAEA,SAAS,mBAAmB,UAAoB;CAC9C,OAAOE,4BAAAA,kBAAkB,QAAQ,IAAI,SAAS,MAAMS,cAAAA,KAAK,GAAG,SAAS,gBAAgB;AACvF;AAEA,SAAS,oBAAoB,UAAoB;CAC/C,OAAOL,6BAAAA,mBAAmB,QAAQ,IAC9B,SAAS,MACTE,oCAAAA,0BAA0B,QAAQ,IAChC,SAAS,MACP,CAAC,SAAS,GAAG,IACb,CAAC,IACHG,cAAAA,KAAK,GAAG,SAAS,gBAAgB;AACzC"}

package/build/relations/RecursiveCollection.d.cts

@@ -0,0 +1,112 @@
+import { AbstractRelationImpl } from "./AbstractRelationImpl.cjs";
+import { RelationT, RelationU } from "./RelationSymbols.cjs";
+import { IsLoadedCachable } from "../loading/IsLoadedCache.cjs";
+import { ReadOnlyCollection } from "./ReadOnlyCollection.cjs";
+import { RecursiveCycleError } from "./RecursiveCycleError.cjs";
+import { EntityMetadata, ManyToManyField } from "../EntityMetadata.cjs";
+import "../index.cjs";
+import { Entity } from "../Entity.cjs";
+//#region src/relations/RecursiveCollection.d.ts
+/**
+ * An alias for creating `RecursiveParentsCollectionImpl`s.
+ *
+ * I.e. for `Author.mentor` (m2o fk), we can return `Author.mentorsRecursive` recursively looking up.
+ */
+declare function hasRecursiveParents<T extends Entity, U extends Entity>(m2oName: keyof T & string // i.e. `author.mentor`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * An alias for creating `RecursiveChildrenCollectionImpl`s.
+ *
+ * I.e. for `Author.mentees` (o2m), we can return `Author.menteesRecursive` recursively looking down.
+ */
+declare function hasRecursiveChildren<T extends Entity, U extends Entity>(o2mName: keyof T & string // i.e. `author.mentees`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * An alias for creating `RecursiveM2mCollectionImpl`s.
+ *
+ * I.e. for `User.parents` (m2m), we can return `User.parentsRecursive` recursively looking up through the m2m.
+ * Or for `User.children` (m2m), we can return `User.childrenRecursive` recursively looking down.
+ */
+declare function hasRecursiveM2m<T extends Entity, U extends Entity>(m2mName: keyof T & string // i.e. `user.parents` or `user.children`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * A base class for the common methods between the parent & children recursive collections.
+ *
+ * We could probably move some of this into AbstractRelationImpl?
+ */
+declare abstract class AbstractRecursiveCollectionImpl<T extends Entity, U extends Entity> extends AbstractRelationImpl<T, U[]> {
+  abstract fieldName: string;
+  get get(): U[];
+  get getWithDeleted(): U[];
+  setFromOpts(): void;
+  set(): void;
+  get isPreloaded(): boolean;
+  preload(): void;
+  cleanupOnEntityDeleted(): Promise<void>;
+  maybeCascadeDelete(): void;
+  get meta(): EntityMetadata;
+  abstract doGet(): U[];
+  /** Removes pending-hard-delete or soft-deleted entities, unless explicitly asked for. */
+  protected filterDeleted(entities: U[], opts?: {
+    withDeleted?: boolean;
+  }): U[];
+  [RelationT]: T;
+  [RelationU]: U;
+}
+declare class RecursiveParentsCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, m2oName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get m2oFieldName(): string;
+  get otherFieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  private findUnloadedReference;
+}
+declare class RecursiveChildrenCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, o2mName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get o2mFieldName(): string;
+  get otherFieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  /** Finds any children/downstream o2m collections or o2o references. */
+  private findUnloadedCollections;
+}
+declare class RecursiveM2mCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, m2mName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get m2mFieldName(): string;
+  get otherFieldName(): string;
+  get m2mField(): ManyToManyField;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  /** Finds any m2m collections that are not yet loaded in the recursive tree. */
+  private findUnloadedCollections;
+}
+//#endregion
+export { RecursiveChildrenCollectionImpl, RecursiveCycleError, RecursiveM2mCollectionImpl, RecursiveParentsCollectionImpl, hasRecursiveChildren, hasRecursiveM2m, hasRecursiveParents };
+//# sourceMappingURL=RecursiveCollection.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RecursiveCollection.d.cts","names":[],"sources":["../../src/relations/RecursiveCollection.ts"],"mappings":";;;;;;;;;;;;;;iBAmCgB,oBAAoB,UAAU,QAAQ,UAAU,QAC9D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;iBAWT,qBAAqB,UAAU,QAAQ,UAAU,QAC/D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;;iBAYT,gBAAgB,UAAU,QAAQ,UAAU,QAC1D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;uBAWV,gCAAgC,UAAU,QAAQ,UAAU,gBAAgB,qBACzF,GACA;WAES;MAEL,OAAO;MAIP,kBAAkB;EAItB;EAIA;MAII;EAIJ;EAIA,0BAA0B;EAI1B;MAEI,QAAQ;WAIH,SAAS;;YAGR,cAAc,UAAU,KAAK;IAAS;MAA0B;GAMzE,YAAY;GACZ,YAAY;;cAGF,+BAA+B,UAAU,QAAQ,UAAU,gBAC9D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MAqCtF;EAOJ;MAII;MAIA;MAIA;MAIA;EAIJ;EAIA,SAAS;UAoBD;;cAYG,gCAAgC,UAAU,QAAQ,UAAU,gBAC/D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MA4BtF;EAOJ;MAII;MAIA;MAIA;MAIA;EAIJ;EAIA,SAAS;;UAsBD;;cAsBG,2BAA2B,UAAU,QAAQ,UAAU,gBAC1D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MA0BtF;EAOJ;MAII;MAIA;MAIA;MAIA,YAAY;MAIZ;EAIJ;EAIA,SAAS;;UA4BD"}

package/build/relations/RecursiveCollection.d.mts

@@ -0,0 +1,112 @@
+import { AbstractRelationImpl } from "./AbstractRelationImpl.mjs";
+import { RelationT, RelationU } from "./RelationSymbols.mjs";
+import { IsLoadedCachable } from "../loading/IsLoadedCache.mjs";
+import { ReadOnlyCollection } from "./ReadOnlyCollection.mjs";
+import { RecursiveCycleError } from "./RecursiveCycleError.mjs";
+import { EntityMetadata, ManyToManyField } from "../EntityMetadata.mjs";
+import "../index.mjs";
+import { Entity } from "../Entity.mjs";
+//#region src/relations/RecursiveCollection.d.ts
+/**
+ * An alias for creating `RecursiveParentsCollectionImpl`s.
+ *
+ * I.e. for `Author.mentor` (m2o fk), we can return `Author.mentorsRecursive` recursively looking up.
+ */
+declare function hasRecursiveParents<T extends Entity, U extends Entity>(m2oName: keyof T & string // i.e. `author.mentor`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * An alias for creating `RecursiveChildrenCollectionImpl`s.
+ *
+ * I.e. for `Author.mentees` (o2m), we can return `Author.menteesRecursive` recursively looking down.
+ */
+declare function hasRecursiveChildren<T extends Entity, U extends Entity>(o2mName: keyof T & string // i.e. `author.mentees`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * An alias for creating `RecursiveM2mCollectionImpl`s.
+ *
+ * I.e. for `User.parents` (m2m), we can return `User.parentsRecursive` recursively looking up through the m2m.
+ * Or for `User.children` (m2m), we can return `User.childrenRecursive` recursively looking down.
+ */
+declare function hasRecursiveM2m<T extends Entity, U extends Entity>(m2mName: keyof T & string // i.e. `user.parents` or `user.children`
+, otherFieldName: keyof T & string): ReadOnlyCollection<T, U>;
+/**
+ * A base class for the common methods between the parent & children recursive collections.
+ *
+ * We could probably move some of this into AbstractRelationImpl?
+ */
+declare abstract class AbstractRecursiveCollectionImpl<T extends Entity, U extends Entity> extends AbstractRelationImpl<T, U[]> {
+  abstract fieldName: string;
+  get get(): U[];
+  get getWithDeleted(): U[];
+  setFromOpts(): void;
+  set(): void;
+  get isPreloaded(): boolean;
+  preload(): void;
+  cleanupOnEntityDeleted(): Promise<void>;
+  maybeCascadeDelete(): void;
+  get meta(): EntityMetadata;
+  abstract doGet(): U[];
+  /** Removes pending-hard-delete or soft-deleted entities, unless explicitly asked for. */
+  protected filterDeleted(entities: U[], opts?: {
+    withDeleted?: boolean;
+  }): U[];
+  [RelationT]: T;
+  [RelationU]: U;
+}
+declare class RecursiveParentsCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, m2oName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get m2oFieldName(): string;
+  get otherFieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  private findUnloadedReference;
+}
+declare class RecursiveChildrenCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, o2mName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get o2mFieldName(): string;
+  get otherFieldName(): string;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  /** Finds any children/downstream o2m collections or o2o references. */
+  private findUnloadedCollections;
+}
+declare class RecursiveM2mCollectionImpl<T extends Entity, U extends Entity> extends AbstractRecursiveCollectionImpl<T, U> implements ReadOnlyCollection<T, U>, IsLoadedCachable {
+  #private;
+  constructor(entity: T, fieldName: keyof T & string, m2mName: keyof T & string, otherFieldName: keyof T & string);
+  load(opts?: {
+    withDeleted?: boolean;
+    forceReload?: boolean;
+  }): Promise<readonly U[]>;
+  get isLoaded(): boolean;
+  resetIsLoaded(): void;
+  get fieldName(): string;
+  get m2mFieldName(): string;
+  get otherFieldName(): string;
+  get m2mField(): ManyToManyField;
+  get hasBeenSet(): boolean;
+  toString(): string;
+  doGet(): U[];
+  /** Finds any m2m collections that are not yet loaded in the recursive tree. */
+  private findUnloadedCollections;
+}
+//#endregion
+export { RecursiveChildrenCollectionImpl, RecursiveCycleError, RecursiveM2mCollectionImpl, RecursiveParentsCollectionImpl, hasRecursiveChildren, hasRecursiveM2m, hasRecursiveParents };
+//# sourceMappingURL=RecursiveCollection.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RecursiveCollection.d.mts","names":[],"sources":["../../src/relations/RecursiveCollection.ts"],"mappings":";;;;;;;;;;;;;;iBAmCgB,oBAAoB,UAAU,QAAQ,UAAU,QAC9D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;iBAWT,qBAAqB,UAAU,QAAQ,UAAU,QAC/D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;;iBAYT,gBAAgB,UAAU,QAAQ,UAAU,QAC1D,eAAe;EACf,sBAAsB,aACrB,mBAAmB,GAAG;;;;;;uBAWV,gCAAgC,UAAU,QAAQ,UAAU,gBAAgB,qBACzF,GACA;WAES;MAEL,OAAO;MAIP,kBAAkB;EAItB;EAIA;MAII;EAIJ;EAIA,0BAA0B;EAI1B;MAEI,QAAQ;WAIH,SAAS;;YAGR,cAAc,UAAU,KAAK;IAAS;MAA0B;GAMzE,YAAY;GACZ,YAAY;;cAGF,+BAA+B,UAAU,QAAQ,UAAU,gBAC9D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MAqCtF;EAOJ;MAII;MAIA;MAIA;MAIA;EAIJ;EAIA,SAAS;UAoBD;;cAYG,gCAAgC,UAAU,QAAQ,UAAU,gBAC/D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MA4BtF;EAOJ;MAII;MAIA;MAIA;MAIA;EAIJ;EAIA,SAAS;;UAsBD;;cAsBG,2BAA2B,UAAU,QAAQ,UAAU,gBAC1D,gCAAgC,GAAG,cAChC,mBAAmB,GAAG,IAAI;;EAQrC,YAAY,QAAQ,GAAG,iBAAiB,YAAY,eAAe,YAAY,sBAAsB;EAQ/F,KAAK;IAAQ;IAAuB;MAA+B,iBAAiB;MA0BtF;EAOJ;MAII;MAIA;MAIA;MAIA,YAAY;MAIZ;EAIJ;EAIA,SAAS;;UA4BD"}