kysely-hydrate 0.7.0 → 0.7.2

package/dist/index.d.mts

@@ -38,7 +38,8 @@ interface TypeErrorMessage<E extends string> {
  * - Produces readable error messages for invalid narrowing
  */
 type NarrowPartial<O$1, T> = DrainOuterGeneric<T extends object ? { [K in keyof O$1 & string]: K extends keyof T ? T[K] extends k.NotNull ? Exclude<O$1[K], null> : T[K] extends O$1[K] ? T[K] : TypeErrorMessage<`$narrowType() call failed: passed type does not exist in '${K}'s type union`> : O$1[K] } : never>;
-type Extend<A, B> = Flatten<keyof A & keyof B extends never ? A & B : { [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never }>;
+type Extend<A, B> = Flatten<RawExtend<A, B>>;
+type RawExtend<A, B> = keyof A & keyof B extends never ? A & B : { [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never };
 type ExtendWith<T, K$1 extends PropertyKey, V> = Flatten<K$1 & keyof T extends never ? T & { [_ in K$1]: V } : Omit<T, K$1> & { [_ in K$1]: V }>;
 /**
  * Ensures that U is a strict subset of T - all keys in U must exist in T
@@ -582,13 +583,18 @@ interface TQuerySet {
    * The final shape of the hydrated output row.
    */
   HydratedOutput: any;
+  /**
+   * Keys that have been omitted from the output. Tracked separately so they
+   * can be preserved through base query changes (e.g., .insert(), .update()).
+   */
+  OmittedKeys: PropertyKey;
 }
 interface TSelectQuerySet extends TQuerySet {
   BaseQuery: TSelectQuery;
 }
 type QuerySetFor<T extends TQuerySet> = T["IsMapped"] extends true ? MappedQuerySet<T> : QuerySet<T>;
 type TInput<T extends TQuerySet> = T["JoinedQuery"]["O"];
-type TOutput<T extends TQuerySet> = Flatten<T["HydratedOutput"]>;
+type TOutput<T extends TQuerySet> = T["HydratedOutput"];
 interface TMapped<in out T extends TQuerySet, in out Output> {
   DB: T["DB"];
   IsMapped: true;
@@ -598,6 +604,7 @@ interface TMapped<in out T extends TQuerySet, in out Output> {
   JoinedQuery: T["JoinedQuery"];
   OrderableColumns: T["OrderableColumns"];
   HydratedOutput: Output;
+  OmittedKeys: T["OmittedKeys"];
 }
 interface TJoinedQueryWithBaseQuery<in out BaseAlias extends string, in out JoinedQuery extends TQuery, in out BaseQuery extends TQuery> {
   Type: "Select";
@@ -614,7 +621,8 @@ interface TWithBaseQuery<in out T extends TQuerySet, in out BaseQuery extends TQ
   Collections: T["Collections"];
   JoinedQuery: TJoinedQueryWithBaseQuery<T["BaseAlias"], T["JoinedQuery"], BaseQuery>;
   OrderableColumns: T["OrderableColumns"] | (keyof BaseQuery["O"] & string);
-  HydratedOutput: Extend<BaseQuery["O"], TOutput<T>>;
+  HydratedOutput: Flatten<Omit<RawExtend<BaseQuery["O"], T["HydratedOutput"]>, T["OmittedKeys"]>>;
+  OmittedKeys: T["OmittedKeys"];
 }
 interface TWithOutput<in out T extends TQuerySet, in out Output> {
   DB: T["DB"];
@@ -625,6 +633,7 @@ interface TWithOutput<in out T extends TQuerySet, in out Output> {
   JoinedQuery: T["JoinedQuery"];
   OrderableColumns: T["OrderableColumns"];
   HydratedOutput: Output;
+  OmittedKeys: T["OmittedKeys"];
 }
 interface TWithExtendedOutput<in out T extends TQuerySet, in out Output> {
   DB: T["DB"];
@@ -635,6 +644,18 @@ interface TWithExtendedOutput<in out T extends TQuerySet, in out Output> {
   JoinedQuery: T["JoinedQuery"];
   OrderableColumns: T["OrderableColumns"];
   HydratedOutput: Extend<T["HydratedOutput"], Output>;
+  OmittedKeys: T["OmittedKeys"];
+}
+interface TWithOmit<in out T extends TQuerySet, in out K$1 extends PropertyKey> {
+  DB: T["DB"];
+  IsMapped: T["IsMapped"];
+  BaseAlias: T["BaseAlias"];
+  BaseQuery: T["BaseQuery"];
+  Collections: T["Collections"];
+  JoinedQuery: T["JoinedQuery"];
+  OrderableColumns: T["OrderableColumns"];
+  HydratedOutput: Flatten<Omit<T["HydratedOutput"], K$1>>;
+  OmittedKeys: T["OmittedKeys"] | K$1;
 }
 type NarrowOutput<T extends TQuerySet, Narrow> = NarrowPartial<T["HydratedOutput"], Narrow>;
 interface InitialJoinedQuery<in out DB$1, in out BaseAlias extends string, in out BaseO> {
@@ -686,7 +707,12 @@ type InferOutput<Q extends {
   _generics: {
     HydratedOutput: infer O;
   } | undefined;
-} ? Flatten<O> : never;
+} ? O : never;
+/**
+ * Given a TQuerySet, return a QuerySet or MappedQuerySet depending on whether the query set has
+ * been mapped (indicated by T["IsMapped"]).
+ */
+type MaybeMappedQuerySet<T extends TQuerySet> = T["IsMapped"] extends true ? MappedQuerySet<T> : QuerySet<T>;
 /**
  * A query set that has been mapped with a transformation function.
  *
@@ -1220,7 +1246,7 @@ interface MappedQuerySet<in out T extends TQuerySet> extends k.Compilable, k.Ope
    * This method call doesn't change the SQL in any way. This method simply
    * returns a copy of this query set with a new output type.
    */
-  $castTo<NewOutput>(): MappedQuerySet<TWithOutput<T, NewOutput>>;
+  $castTo<NewOutput>(): MaybeMappedQuerySet<TWithOutput<T, NewOutput>>;
   /**
    * Narrows (parts of) the output type of the query.
    *
@@ -1229,7 +1255,7 @@ interface MappedQuerySet<in out T extends TQuerySet> extends k.Compilable, k.Ope
    *
    * See {@link k.SelectQueryBuilder.$narrowType} for more information.
    */
-  $narrowType<Narrow>(): MappedQuerySet<TWithOutput<T, NarrowOutput<T, Narrow>>>;
+  $narrowType<Narrow>(): MaybeMappedQuerySet<TWithOutput<T, NarrowOutput<T, Narrow>>>;
   /**
    * Asserts that query's output row type equals the given type `T`.
    *
@@ -1246,7 +1272,7 @@ interface MappedQuerySet<in out T extends TQuerySet> extends k.Compilable, k.Ope
    *
    * See {@link k.SelectQueryBuilder.$assertType} for more information.
    */
-  $assertType<NewOutput extends TOutput<T>>(): TOutput<T> extends NewOutput ? MappedQuerySet<TWithOutput<T, NewOutput>> : TypeErrorMessage<"$assertType() call failed: The type passed in is not equal to the output type of the query.">;
+  $assertType<NewOutput extends TOutput<T>>(): TOutput<T> extends NewOutput ? MaybeMappedQuerySet<TWithOutput<T, NewOutput>> : TypeErrorMessage<"$assertType() call failed: The type passed in is not equal to the output type of the query.">;
   /**
    * Switches the base query to an `INSERT` statement.
    *
@@ -1280,15 +1306,15 @@ interface MappedQuerySet<in out T extends TQuerySet> extends k.Compilable, k.Ope
    * @param iqb - An insert query builder or factory function.
    * @returns A new QuerySet with the insert query as the base.
    */
-  insert<IQB extends k.InsertQueryBuilder<any, any, T["BaseQuery"]["O"]>>(iqb: InsertQueryBuilderOrFactory<T["DB"], IQB>): QuerySet<TWithBaseQuery<T, InferTInsertQuery<IQB>>>;
+  insert<IQB extends k.InsertQueryBuilder<any, any, T["BaseQuery"]["O"]>>(iqb: InsertQueryBuilderOrFactory<T["DB"], IQB>): MaybeMappedQuerySet<TWithBaseQuery<T, InferTInsertQuery<IQB>>>;
   /**
    * Like {@link insert}, but switches to an `UPDATE` statement.
    */
-  update<IQB extends k.UpdateQueryBuilder<any, any, any, T["BaseQuery"]["O"]>>(iqb: UpdateQueryBuilderOrFactory<T["DB"], IQB>): QuerySet<TWithBaseQuery<T, InferTUpdateQuery<IQB>>>;
+  update<IQB extends k.UpdateQueryBuilder<any, any, any, T["BaseQuery"]["O"]>>(uqb: UpdateQueryBuilderOrFactory<T["DB"], IQB>): MaybeMappedQuerySet<TWithBaseQuery<T, InferTUpdateQuery<IQB>>>;
   /**
    * Like {@link insert}, but switches to a `DELETE` statement.
    */
-  delete<IQB extends k.DeleteQueryBuilder<any, any, T["BaseQuery"]["O"]>>(iqb: DeleteQueryBuilderOrFactory<T["DB"], IQB>): QuerySet<TWithBaseQuery<T, InferTDeleteQuery<IQB>>>;
+  delete<IQB extends k.DeleteQueryBuilder<any, any, T["BaseQuery"]["O"]>>(dqb: DeleteQueryBuilderOrFactory<T["DB"], IQB>): MaybeMappedQuerySet<TWithBaseQuery<T, InferTDeleteQuery<IQB>>>;
 }
 /**
  * A query set that supports nested joins and automatic hydration.
@@ -1305,39 +1331,6 @@ interface MappedQuerySet<in out T extends TQuerySet> extends k.Compilable, k.Ope
  * @template T - The query set's type parameters.
  */
 interface QuerySet<in out T extends TQuerySet> extends MappedQuerySet<T> {
-  /**
-   * Changes the output type of the query.
-   *
-   * This method call doesn't change the SQL in any way. This method simply
-   * returns a copy of this query set with a new output type.
-   */
-  $castTo<NewOutput>(): QuerySet<TWithOutput<T, NewOutput>>;
-  /**
-   * Narrows (parts of) the output type of the query.
-   *
-   * This method call doesn't change the SQL in any way. This method simply
-   * returns a copy of this query set with a narrowed output type.
-   *
-   * See {@link k.SelectQueryBuilder.$narrowType} for more information.
-   */
-  $narrowType<Narrow>(): QuerySet<TWithOutput<T, NarrowOutput<T, Narrow>>>;
-  /**
-   * Asserts that query's output row type equals the given type `T`.
-   *
-   * This method can be used to simplify excessively complex types to make
-   * TypeScript happy and faster.
-   *
-   * It's also useful as a type guard to ensure a query set matches an expected
-   * shape, similar to annotating a function's return type. For example,
-   * `.$assertType<UserDto>()` will produce a type error if the query's output
-   * doesn't match `UserDto`.
-   *
-   * Using this method doesn't reduce type safety at all. You have to pass in
-   * a type that is structurally equal to the current type.
-   *
-   * See {@link k.SelectQueryBuilder.$assertType} for more information.
-   */
-  $assertType<NewOutput extends TOutput<T>>(): TOutput<T> extends NewOutput ? QuerySet<TWithOutput<T, NewOutput>> : TypeErrorMessage<"$assertType() call failed: The type passed in is not equal to the output type of the query.">;
   /**
    * Configures extra computed fields to add to the hydrated output.
    * Each extra is a function that receives the full row (with prefixed columns
@@ -1409,7 +1402,7 @@ interface QuerySet<in out T extends TQuerySet> extends MappedQuerySet<T> {
    * @param keys - Field names to omit from the output.
    * @returns A new HydratedQueryBuilder with the fields omitted.
    */
-  omit<K$1 extends keyof TInput<T>>(keys: readonly K$1[]): QuerySet<TWithOutput<T, Omit<TOutput<T>, K$1>>>;
+  omit<K$1 extends keyof TInput<T>>(keys: readonly K$1[]): QuerySet<TWithOmit<T, K$1>>;
   /**
    * Extends this query builder's hydration configuration with another Hydrator.
    * The other Hydrator's configuration takes precedence in case of conflicts.
@@ -2310,6 +2303,7 @@ interface TQuerySetWithAttach<in out T extends TQuerySet, in out Key extends str
   }>;
   OrderableColumns: T["OrderableColumns"];
   HydratedOutput: ExtendWith<T["HydratedOutput"], Key, AttachedOutputMap<FetchFnReturn>[Type]>;
+  OmittedKeys: T["OmittedKeys"];
 }
 interface QuerySetWithAttach<in out T extends TQuerySet, in out Key extends string, in out Type extends TAttachType, in out FetchFnReturn extends SomeFetchFnReturn> extends QuerySet<TQuerySetWithAttach<T, Key, Type, FetchFnReturn>> {}
 type NestedQuerySetOrFactory<T extends TQuerySet, Alias extends string, TNested extends TSelectQuerySet> = MappedQuerySet<TNested> | JoinBuilderCallback<T, Alias, TNested>;
@@ -2355,6 +2349,7 @@ type TQuerySetWithJoin<T extends TQuerySet, Key extends string, Type extends TJo
   JoinedQuery: JoinedQueryMap<T, Key, TNested>[Type];
   OrderableColumns: TOrderableColumnsWithJoin<T, Key, Type, TNested>;
   HydratedOutput: ExtendWith<T["HydratedOutput"], Key, JoinHydratedRowMap<TNested>[Type]>;
+  OmittedKeys: T["OmittedKeys"];
 }>;
 interface QuerySetWithJoin<in out T extends TQuerySet, in out Key extends string, in out Type extends TJoinType, in out TNested extends TSelectQuerySet> extends QuerySet<TQuerySetWithJoin<T, Key, Type, TNested>> {}
 interface InitialQuerySet<in out DB$1, in out BaseAlias extends string, in out BaseQuery extends TQuery> extends QuerySet<{
@@ -2365,7 +2360,8 @@ interface InitialQuerySet<in out DB$1, in out BaseAlias extends string, in out B
   Collections: {};
   JoinedQuery: InitialJoinedQuery<BaseQuery["DB"], BaseAlias, BaseQuery["O"]>;
   OrderableColumns: keyof BaseQuery["O"] & string;
-  HydratedOutput: BaseQuery["O"];
+  HydratedOutput: Flatten<BaseQuery["O"]>;
+  OmittedKeys: never;
 }> {}
 interface SelectCreator<DB$1> {
   selectFrom: k.QueryCreator<DB$1>["selectFrom"];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "kysely-hydrate",
-	"version": "0.7.0",
+	"version": "0.7.2",
 	"description": "Explicit ORM-style queries with Kysely",
 	"homepage": "https://github.com/GiacoCorsiglia/kysely-hydrate#readme",
 	"bugs": {