docs: regenerate API documentation

github-actions[bot] · github-actions[bot] · commit e177a357601c · 2026-06-30T17:28:46.000Z
diff --git a/docs/reference/type-aliases/ApplyJoinOptionalityToMergedSchema.md b/docs/reference/type-aliases/ApplyJoinOptionalityToMergedSchema.md
@@ -9,7 +9,7 @@ title: ApplyJoinOptionalityToMergedSchema
 type ApplyJoinOptionalityToMergedSchema<TExistingSchema, TNewSchema, TJoinType, TFromSourceNames> = { [K in keyof TExistingSchema]: K extends TFromSourceNames ? TJoinType extends "right" | "full" ? TExistingSchema[K] | undefined : TExistingSchema[K] : TExistingSchema[K] } & { [K in keyof TNewSchema]: TJoinType extends "left" | "full" ? TNewSchema[K] | undefined : TNewSchema[K] };
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:929](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L929)
+Defined in: [packages/db/src/query/builder/types.ts:984](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L984)
 
 ApplyJoinOptionalityToMergedSchema - Applies optionality rules when merging schemas
 
diff --git a/docs/reference/type-aliases/FunctionalHavingRow.md b/docs/reference/type-aliases/FunctionalHavingRow.md
@@ -9,7 +9,7 @@ title: FunctionalHavingRow
 type FunctionalHavingRow<TContext> = TContext["schema"] & TContext["hasResult"] extends true ? object : object;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:589](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L589)
+Defined in: [packages/db/src/query/builder/types.ts:640](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L640)
 
 FunctionalHavingRow - Type for the row parameter in functional having callbacks
 
diff --git a/docs/reference/type-aliases/GetResult.md b/docs/reference/type-aliases/GetResult.md
@@ -9,7 +9,7 @@ title: GetResult
 type GetResult<TContext> = Prettify<ResultValue<TContext>>;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:1043](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1043)
+Defined in: [packages/db/src/query/builder/types.ts:1098](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1098)
 
 ## Type Parameters
 
diff --git a/docs/reference/type-aliases/GroupByCallback.md b/docs/reference/type-aliases/GroupByCallback.md
@@ -9,7 +9,7 @@ title: GroupByCallback
 type GroupByCallback<TContext> = (refs) => any;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:552](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L552)
+Defined in: [packages/db/src/query/builder/types.ts:603](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L603)
 
 GroupByCallback - Type for groupBy clause callback functions
 
diff --git a/docs/reference/type-aliases/InferResultType.md b/docs/reference/type-aliases/InferResultType.md
@@ -9,7 +9,7 @@ title: InferResultType
 type InferResultType<TContext> = TContext extends SingleResult ? GetResult<TContext> | undefined : GetResult<TContext>[];
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:955](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L955)
+Defined in: [packages/db/src/query/builder/types.ts:1010](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1010)
 
 Utility type to infer the query result size (single row or an array)
 
diff --git a/docs/reference/type-aliases/JoinOnCallback.md b/docs/reference/type-aliases/JoinOnCallback.md
@@ -9,7 +9,7 @@ title: JoinOnCallback
 type JoinOnCallback<TContext> = (refs) => any;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:568](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L568)
+Defined in: [packages/db/src/query/builder/types.ts:619](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L619)
 
 JoinOnCallback - Type for join condition callback functions
 
diff --git a/docs/reference/type-aliases/MergeContextForJoinCallback.md b/docs/reference/type-aliases/MergeContextForJoinCallback.md
@@ -9,7 +9,7 @@ title: MergeContextForJoinCallback
 type MergeContextForJoinCallback<TContext, TNewSchema> = object & PreserveHasResultFlag<TContext["hasResult"]> & PreserveUnionFromFlag<TContext["hasUnionFrom"]> & PreserveFromSourceNames<TContext["fromSourceNames"]>;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:1200](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1200)
+Defined in: [packages/db/src/query/builder/types.ts:1255](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1255)
 
 MergeContextForJoinCallback - Special context for join condition callbacks
 
diff --git a/docs/reference/type-aliases/MergeContextWithJoinType.md b/docs/reference/type-aliases/MergeContextWithJoinType.md
@@ -9,7 +9,7 @@ title: MergeContextWithJoinType
 type MergeContextWithJoinType<TContext, TNewSchema, TJoinType> = object & PreserveSingleResultFlag<TContext["singleResult"]> & PreserveHasResultFlag<TContext["hasResult"]> & PreserveUnionFromFlag<TContext["hasUnionFrom"]> & PreserveFromSourceNames<TContext["fromSourceNames"]>;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:871](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L871)
+Defined in: [packages/db/src/query/builder/types.ts:926](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L926)
 
 MergeContextWithJoinType - Creates a new context after a join operation
 
diff --git a/docs/reference/type-aliases/OrderByCallback.md b/docs/reference/type-aliases/OrderByCallback.md
@@ -9,7 +9,7 @@ title: OrderByCallback
 type OrderByCallback<TContext> = (refs) => any;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:516](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L516)
+Defined in: [packages/db/src/query/builder/types.ts:567](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L567)
 
 OrderByCallback - Type for orderBy clause callback functions
 
diff --git a/docs/reference/type-aliases/Prettify.md b/docs/reference/type-aliases/Prettify.md
@@ -9,7 +9,7 @@ title: Prettify
 type Prettify<T> = { [K in keyof T]: T[K] } & object;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:1242](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1242)
+Defined in: [packages/db/src/query/builder/types.ts:1297](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1297)
 
 Prettify - Utility type for clean IDE display
 
diff --git a/docs/reference/type-aliases/Ref.md b/docs/reference/type-aliases/Ref.md
@@ -6,10 +6,10 @@ title: Ref
 # Type Alias: Ref\<T, Nullable\>
 
 ```ts
-type Ref<T, Nullable> = { [K in keyof T]: IsNonExactOptional<T[K]> extends true ? IsNonExactNullable<T[K]> extends true ? IsPlainObject<NonNullable<T[K]>> extends true ? Ref<NonNullable<T[K]>, Nullable> | undefined : RefLeaf<NonNullable<T[K]>, Nullable> | undefined : IsPlainObject<NonUndefined<T[K]>> extends true ? Ref<NonUndefined<T[K]>, Nullable> | undefined : RefLeaf<NonUndefined<T[K]>, Nullable> | undefined : IsNonExactNullable<T[K]> extends true ? IsPlainObject<NonNull<T[K]>> extends true ? Ref<NonNull<T[K]>, Nullable> | null : RefLeaf<NonNull<T[K]>, Nullable> | null : IsPlainObject<T[K]> extends true ? Ref<T[K], Nullable> : RefLeaf<T[K], Nullable> } & RefLeaf<T, Nullable> & VirtualPropsRef;
+type Ref<T, Nullable> = T extends unknown ? RefBranch<T, Nullable> : never;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:773](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L773)
+Defined in: [packages/db/src/query/builder/types.ts:824](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L824)
 
 Ref - The user-facing ref interface for the query builder
 
diff --git a/docs/reference/type-aliases/RefsForContext.md b/docs/reference/type-aliases/RefsForContext.md
@@ -9,7 +9,7 @@ title: RefsForContext
 type RefsForContext<TContext> = { [K in KeysOfUnion<RefsSchemaForContext<TContext>>]: IsNonExactOptional<ValueOfUnion<RefsSchemaForContext<TContext>, K>> extends true ? IsNonExactNullable<ValueOfUnion<RefsSchemaForContext<TContext>, K>> extends true ? RefForContextValue<NonNullable<ValueOfUnion<RefsSchemaForContext<TContext>, K>>, true> : RefForContextValue<NonUndefined<ValueOfUnion<RefsSchemaForContext<TContext>, K>>, true> : IsNonExactNullable<ValueOfUnion<RefsSchemaForContext<TContext>, K>> extends true ? RefForContextValue<NonNull<ValueOfUnion<RefsSchemaForContext<TContext>, K>>, true> : RefForContextValue<ValueOfUnion<RefsSchemaForContext<TContext>, K>> } & TContext["hasResult"] extends true ? object : object;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:623](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L623)
+Defined in: [packages/db/src/query/builder/types.ts:674](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L674)
 
 ## Type Parameters
 
diff --git a/docs/reference/type-aliases/WithResult.md b/docs/reference/type-aliases/WithResult.md
@@ -9,7 +9,7 @@ title: WithResult
 type WithResult<TContext, TResult> = Prettify<Omit<TContext, "result" | "hasResult"> & object>;
 ```
 
-Defined in: [packages/db/src/query/builder/types.ts:1232](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1232)
+Defined in: [packages/db/src/query/builder/types.ts:1287](https://github.com/TanStack/db/blob/main/packages/db/src/query/builder/types.ts#L1287)
 
 WithResult - Updates a context with a new result type after select()
 
