export the new isUndefined and isNull query builder functions (#515)

Author: samwillis

.changeset/fast-humans-pick.md

@@ -0,0 +1,5 @@
+---
+"@tanstack/db": patch
+---
+
+export the new `isUndefined` and `isNull` query builder functions

packages/db/src/query/builder/functions.ts

@@ -230,20 +230,10 @@ export function isUndefined(value: ExpressionLike): BasicExpression<boolean> {
   return new Func(`isUndefined`, [toExpression(value)])
 }
 
-export function isNotUndefined(
-  value: ExpressionLike
-): BasicExpression<boolean> {
-  return new Func(`isNotUndefined`, [toExpression(value)])
-}
-
 export function isNull(value: ExpressionLike): BasicExpression<boolean> {
   return new Func(`isNull`, [toExpression(value)])
 }
 
-export function isNotNull(value: ExpressionLike): BasicExpression<boolean> {
-  return new Func(`isNotNull`, [toExpression(value)])
-}
-
 export function inArray(
   value: ExpressionLike,
   array: ExpressionLike

packages/db/src/query/compiler/evaluators.ts

@@ -345,27 +345,13 @@ function compileFunction(func: Func, isSingleRow: boolean): (data: any) => any {
         return value === undefined
       }
     }
-    case `isNotUndefined`: {
-      const arg = compiledArgs[0]!
-      return (data) => {
-        const value = arg(data)
-        return value !== undefined
-      }
-    }
     case `isNull`: {
       const arg = compiledArgs[0]!
       return (data) => {
         const value = arg(data)
         return value === null
       }
     }
-    case `isNotNull`: {
-      const arg = compiledArgs[0]!
-      return (data) => {
-        const value = arg(data)
-        return value !== null
-      }
-    }
 
     default:
       throw new UnknownFunctionError(func.name)

packages/db/src/query/index.ts

@@ -25,6 +25,8 @@ export {
   inArray,
   like,
   ilike,
+  isUndefined,
+  isNull,
   // Functions
   upper,
   lower,

packages/db/tests/query/group-by.test.ts

@@ -9,10 +9,11 @@ import {
   eq,
   gt,
   gte,
-  isNotUndefined,
+  isUndefined,
   lt,
   max,
   min,
+  not,
   or,
   sum,
 } from "../../src/query/builder/functions.js"
@@ -1097,7 +1098,7 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ orders: ordersCollection })
-              .where(({ orders }) => isNotUndefined(orders.customer))
+              .where(({ orders }) => not(isUndefined(orders.customer)))
               .groupBy(({ orders }) => orders.customer?.tier)
               .select(({ orders }) => ({
                 tier: orders.customer?.tier,
@@ -1127,7 +1128,7 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ orders: ordersCollection })
-              .where(({ orders }) => isNotUndefined(orders.customer?.address))
+              .where(({ orders }) => not(isUndefined(orders.customer?.address)))
               .groupBy(({ orders }) => orders.customer?.address.state)
               .select(({ orders }) => ({
                 state: orders.customer?.address.state,
@@ -1156,7 +1157,7 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ orders: ordersCollection })
-              .where(({ orders }) => isNotUndefined(orders.shipping))
+              .where(({ orders }) => not(isUndefined(orders.shipping)))
               .groupBy(({ orders }) => orders.shipping?.method)
               .select(({ orders }) => ({
                 method: orders.shipping?.method,
@@ -1191,8 +1192,8 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
               .from({ orders: ordersCollection })
               .where(({ orders }) =>
                 and(
-                  isNotUndefined(orders.customer),
-                  isNotUndefined(orders.shipping)
+                  not(isUndefined(orders.customer)),
+                  not(isUndefined(orders.shipping))
                 )
               )
               .groupBy(({ orders }) => orders.customer?.tier)
@@ -1231,7 +1232,7 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
             q
               .from({ orders: ordersCollection })
               .where(({ orders }) =>
-                isNotUndefined(orders.customer?.preferences)
+                not(isUndefined(orders.customer?.preferences))
               )
               .groupBy(({ orders }) => orders.customer?.preferences.newsletter)
               .select(({ orders }) => ({
@@ -1267,10 +1268,10 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
             q
               .from({ orders: ordersCollection })
               .groupBy(({ orders }) =>
-                isNotUndefined(orders.shipping?.tracking)
+                not(isUndefined(orders.shipping?.tracking))
               )
               .select(({ orders }) => ({
-                tracking_status: isNotUndefined(orders.shipping?.tracking),
+                tracking_status: not(isUndefined(orders.shipping?.tracking)),
                 order_count: count(orders.id),
                 total_amount: sum(orders.amount),
               })),
@@ -1295,7 +1296,7 @@ function createGroupByTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ orders: ordersCollection })
-              .where(({ orders }) => isNotUndefined(orders.customer))
+              .where(({ orders }) => not(isUndefined(orders.customer)))
               .groupBy(({ orders }) => orders.customer?.tier)
               .select(({ orders }) => ({
                 tier: orders.customer?.tier,

packages/db/tests/query/order-by.test.ts

@@ -5,8 +5,9 @@ import { createLiveQueryCollection } from "../../src/query/live-query-collection
 import {
   eq,
   gt,
-  isNotUndefined,
+  isUndefined,
   max,
+  not,
 } from "../../src/query/builder/functions.js"
 
 type Person = {
@@ -1709,7 +1710,7 @@ function createOrderByTests(autoIndex: `off` | `eager`): void {
         const collection = createLiveQueryCollection((q) =>
           q
             .from({ persons: personsCollection })
-            .where(({ persons }) => isNotUndefined(persons.address))
+            .where(({ persons }) => not(isUndefined(persons.address)))
             .orderBy(({ persons }) => persons.address?.coordinates.lat, `asc`)
             .select(({ persons }) => ({
               id: persons.id,

packages/db/tests/query/where.test.ts

@@ -11,8 +11,8 @@ import {
   gt,
   gte,
   inArray,
-  isNotNull,
-  isNotUndefined,
+  isNull,
+  isUndefined,
   length,
   like,
   lower,
@@ -1440,7 +1440,7 @@ function createWhereTests(autoIndex: `off` | `eager`): void {
               .select(({ emp }) => ({
                 id: emp.id,
                 name: emp.name,
-                hasAddress: isNotNull(emp.contact?.address),
+                hasAddress: not(isNull(emp.contact?.address)),
               })),
         })
 
@@ -1455,7 +1455,7 @@ function createWhereTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ emp: employeesCollection })
-              .where(({ emp }) => isNotUndefined(emp.profile))
+              .where(({ emp }) => not(isUndefined(emp.profile)))
               .select(({ emp }) => ({
                 id: emp.id,
                 name: emp.name,
@@ -1528,7 +1528,7 @@ function createWhereTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ emp: employeesCollection })
-              .where(({ emp }) => isNotUndefined(emp.contact?.emergency))
+              .where(({ emp }) => not(isUndefined(emp.contact?.emergency)))
               .select(({ emp }) => ({
                 id: emp.id,
                 name: emp.name,
@@ -1617,7 +1617,7 @@ function createWhereTests(autoIndex: `off` | `eager`): void {
           query: (q) =>
             q
               .from({ emp: employeesCollection })
-              .where(({ emp }) => isNotUndefined(emp.profile?.skills))
+              .where(({ emp }) => not(isUndefined(emp.profile?.skills)))
               .select(({ emp }) => ({
                 id: emp.id,
                 name: emp.name,