joist-core 2.3.0-next.7 → 2.3.0-next.71

package/build/Aliases.d.mts

@@ -0,0 +1,115 @@
+import { FieldsOf } from "./typeMap.mjs";
+import { EntityMetadata, Field } from "./EntityMetadata.mjs";
+import { IdOf, MaybeAbstractEntityConstructor, TaggedId } from "./EntityManager.mjs";
+import { Entity } from "./Entity.mjs";
+import { ExpressionCondition } from "./EntityFilter.mjs";
+//#region src/Aliases.d.ts
+/** Creates an alias for complex domain filtering in `em.find`. */
+declare function alias<T extends Entity>(cstr: MaybeAbstractEntityConstructor<T>): Alias<T>;
+/** Creates multiple aliases for complex filtering. */
+declare function aliases<T extends readonly MaybeAbstractEntityConstructor<any>[]>(...types: T): { [P in keyof T]: T[P] extends MaybeAbstractEntityConstructor<infer E extends Entity> ? Alias<E> : never; };
+declare const aliasMgmt: unique symbol;
+declare const aliasColumn: unique symbol;
+/** The identity and original entity metadata of an `em.find` alias. */
+interface AliasMgmt {
+  tableName: string;
+  meta: EntityMetadata;
+}
+/** Keeps domain aliases covariant in their entity type. */
+interface AliasBrand<T> extends AliasMgmt {
+  readonly __entity: T;
+}
+/**
+ * Domain field predicates, deliberately separate from SQL table expressions.
+ *
+ * An Alias names a place in an em.find relationship tree, not a fixed SQL table occurrence.
+ * I.e. with `a = alias(Author)`, `{ author: { as: a } }` binds `a` to the Book's Author;
+ * binding it under `{ author: { mentor: { as: a } } }` instead makes it the Author's mentor.
+ * The find parser builds those joins and knows which entity metadata and SQL name apply there,
+ * including any inheritance joins. The Alias cannot know that when `a.firstName.eq(name)` is created.
+ *
+ * DeferredAlias therefore resolves each predicate to a fresh column/raw condition using that parse's
+ * binding. The resolved condition records the SQL aliases it reads, including both sides of a
+ * cross-alias comparison. Join pruning uses those references to retain the joins the filter needs.
+ * An undefined predicate is skipped, so it does not keep an otherwise-unused join alive; explicit
+ * keepAliases and other query dependencies can still retain that join.
+ *
+ * Table expressions solve a different problem: their sources are supplied directly in from/join,
+ * so they render through ExprContext rather than asking the find parser to bind a relationship path.
+ * Neither path stores a resolved SQL name on the reusable handle or predicate.
+ */
+type Alias<T extends Entity> = {
+  readonly [aliasMgmt]: AliasBrand<T>;
+} & { [P in keyof FieldsOf<T>]: P extends "id" ? EntityAlias<T> : FieldsOf<T>[P] extends {
+  kind: "primitive" | "enum";
+  type: infer V;
+  nullable: infer N;
+} ? PrimitiveAlias<V, N extends undefined ? null : never> : FieldsOf<T>[P] extends {
+  kind: "m2o";
+  type: infer U extends Entity;
+  nullable: infer N;
+} ? EntityAlias<U, N extends undefined ? null : never> : FieldsOf<T>[P] extends {
+  kind: "poly";
+  type: infer U extends Entity;
+} ? PolyAlias<U> : never; };
+/** A domain column accepted on the other side of a cross-alias comparison. */
+interface AliasColumn<V> {
+  readonly [aliasColumn]: V;
+}
+interface PrimitiveAlias<V, N extends null | never = never> extends AliasColumn<V | N> {
+  eq(value: V | N | AliasColumn<V | null> | undefined): ExpressionCondition;
+  ne(value: V | N | AliasColumn<V | null> | undefined): ExpressionCondition;
+  in(values: readonly (V | null)[] | undefined): ExpressionCondition;
+  nin(values: readonly (V | null)[] | undefined): ExpressionCondition;
+  gt(value: V | AliasColumn<V | null> | undefined): ExpressionCondition;
+  gte(value: V | AliasColumn<V | null> | undefined): ExpressionCondition;
+  lt(value: V | AliasColumn<V | null> | undefined): ExpressionCondition;
+  lte(value: V | AliasColumn<V | null> | undefined): ExpressionCondition;
+  like(value: V | undefined): ExpressionCondition;
+  ilike(value: V | undefined): ExpressionCondition;
+  search(value: V | undefined): ExpressionCondition;
+  between(v1: V | undefined, v2: V | undefined): ExpressionCondition;
+  contains(value: string | V | AliasColumn<V | null> | N | undefined): ExpressionCondition;
+  ncontains(value: string | V | AliasColumn<V | null> | N | undefined): ExpressionCondition;
+  overlaps(value: V | AliasColumn<V | null> | N | undefined): ExpressionCondition;
+  noverlaps(value: V | AliasColumn<V | null> | N | undefined): ExpressionCondition;
+  /** Adds a parameterized JSON path existence condition using `@?`. */
+  pathExists(jsonPath: string | undefined): ExpressionCondition;
+  /** Adds a parameterized JSON path predicate condition using `@@`. */
+  pathIsTrue(jsonPath: string | undefined): ExpressionCondition;
+  /** Adds an operator and expression with knex-style placeholders, without the column name. */
+  raw(exp: string, bindings: readonly unknown[] | undefined): ExpressionCondition;
+}
+interface EntityAlias<T, N extends null | never = never> extends AliasColumn<IdOf<T> | N> {
+  eq(value: T | IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  ne(value: T | IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  in(values: readonly (T | IdOf<T> | null)[] | null | undefined): ExpressionCondition;
+  nin(values: readonly (T | IdOf<T> | null)[] | null | undefined): ExpressionCondition;
+  gt(value: IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  gte(value: IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  lt(value: IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  lte(value: IdOf<T> | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  raw(exp: string, bindings: readonly unknown[] | undefined): ExpressionCondition;
+}
+interface PolyAlias<T extends Entity> {
+  eq(value: T | TaggedId | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  ne(value: T | TaggedId | AliasColumn<IdOf<T> | null> | null | undefined): ExpressionCondition;
+  in(values: readonly (T | TaggedId)[] | undefined): ExpressionCondition;
+}
+/** Returns the runtime identity bound by the find parser. */
+declare function getAliasMgmt(alias: {
+  readonly [aliasMgmt]: AliasMgmt;
+}): AliasMgmt;
+/** Returns the original metadata, preserving STI subtype identity. */
+declare function getAliasMetadata<T extends Entity>(alias: Alias<T>): EntityMetadata<T>;
+/** Creates domain predicates lazily from entity field metadata. */
+declare function newAliasProxy<T extends Entity>(cstr: MaybeAbstractEntityConstructor<T>): Alias<T>;
+/** Recognizes only domain aliases, not physical tables. */
+declare function isAlias(value: unknown): value is Alias<Entity>;
+/** Adjusts a field's SQL alias when a base alias is bound to a CTI subtype in the join tree. */
+declare function getMaybeCtiAlias(meta: EntityMetadata, field: Field & {
+  aliasSuffix: string;
+}, newMeta: EntityMetadata, newAlias: string): string;
+//#endregion
+export { Alias, AliasBrand, AliasColumn, AliasMgmt, EntityAlias, PolyAlias, PrimitiveAlias, alias, aliasMgmt, aliases, getAliasMetadata, getAliasMgmt, getMaybeCtiAlias, isAlias, newAliasProxy };
+//# sourceMappingURL=Aliases.d.mts.map

package/build/Aliases.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Aliases.d.mts","names":[],"sources":["../src/Aliases.ts"],"mappings":";;;;;;;iBAwBgB,MAAM,UAAU,QAAQ,MAAM,+BAA+B,KAAK,MAAM;;iBAKxE,QAAQ,mBAAmB,0CACtC,OAAO,OACN,WAAW,IAAI,EAAE,WAAW,qCAAqC,UAAU,UAAU,MAAM;cAIpF;cACP;;UAGW;EACf;EACA,MAAM;;;UAIS,WAAW,WAAW;WAC5B,UAAU;;;;;;;;;;;;;;;;;;;;;KAsBT,MAAM,UAAU;YAAsB,YAAY,WAAW;OACtE,WAAW,SAAS,KAAK,iBACtB,YAAY,KACZ,SAAS,GAAG;EAAa;EAA4B,YAAY;EAAG,gBAAgB;IAClF,eAAe,GAAG,sCAClB,SAAS,GAAG;EAAa;EAAa,YAAY,UAAU;EAAQ,gBAAgB;IAClF,YAAY,GAAG,sCACf,SAAS,GAAG;EAAa;EAAc,YAAY,UAAU;IAC3D,UAAU;;UAKL,YAAY;YACjB,cAAc;;UAGT,eAAe,GAAG,wCAAwC,YAAY,IAAI;EACzF,GAAG,OAAO,IAAI,IAAI,YAAY,wBAAwB;EACtD,GAAG,OAAO,IAAI,IAAI,YAAY,wBAAwB;EACtD,GAAG,kBAAkB,0BAA0B;EAC/C,IAAI,kBAAkB,0BAA0B;EAChD,GAAG,OAAO,IAAI,YAAY,wBAAwB;EAClD,IAAI,OAAO,IAAI,YAAY,wBAAwB;EACnD,GAAG,OAAO,IAAI,YAAY,wBAAwB;EAClD,IAAI,OAAO,IAAI,YAAY,wBAAwB;EACnD,KAAK,OAAO,gBAAgB;EAC5B,MAAM,OAAO,gBAAgB;EAC7B,OAAO,OAAO,gBAAgB;EAC9B,QAAQ,IAAI,eAAe,IAAI,gBAAgB;EAE/C,SAAS,gBAAgB,IAAI,YAAY,YAAY,gBAAgB;EACrE,UAAU,gBAAgB,IAAI,YAAY,YAAY,gBAAgB;EACtE,SAAS,OAAO,IAAI,YAAY,YAAY,gBAAgB;EAC5D,UAAU,OAAO,IAAI,YAAY,YAAY,gBAAgB;;EAE7D,WAAW,+BAA+B;;EAE1C,WAAW,+BAA+B;;EAE1C,IAAI,aAAa,2CAA2C;;UAG7C,YAAY,GAAG,wCAAwC,YAAY,KAAK,KAAK;EAC5F,GAAG,OAAO,IAAI,KAAK,KAAK,YAAY,KAAK,gCAAgC;EACzE,GAAG,OAAO,IAAI,KAAK,KAAK,YAAY,KAAK,gCAAgC;EAEzE,GAAG,kBAAkB,IAAI,KAAK,kCAAkC;EAChE,IAAI,kBAAkB,IAAI,KAAK,kCAAkC;EACjE,GAAG,OAAO,KAAK,KAAK,YAAY,KAAK,gCAAgC;EACrE,IAAI,OAAO,KAAK,KAAK,YAAY,KAAK,gCAAgC;EACtE,GAAG,OAAO,KAAK,KAAK,YAAY,KAAK,gCAAgC;EACrE,IAAI,OAAO,KAAK,KAAK,YAAY,KAAK,gCAAgC;EACtE,IAAI,aAAa,2CAA2C;;UAG7C,UAAU,UAAU;EACnC,GAAG,OAAO,IAAI,WAAW,YAAY,KAAK,gCAAgC;EAC1E,GAAG,OAAO,IAAI,WAAW,YAAY,KAAK,gCAAgC;EAC1E,GAAG,kBAAkB,IAAI,0BAA0B;;;iBAIrC,aAAa;YAAmB,YAAY;IAAc;;iBAK1D,iBAAiB,UAAU,QAAQ,OAAO,MAAM,KAAK,eAAe;;iBAKpE,cAAc,UAAU,QAAQ,MAAM,+BAA+B,KAAK,MAAM;;iBAqBhF,QAAQ,iBAAiB,SAAS,MAAM;;iBAiMxC,iBACd,MAAM,gBACN,OAAO;EAAU;GACjB,SAAS,gBACT"}