@xata.io/client 0.1.3 → 0.1.4

package/dist/index.d.ts

@@ -23,8 +23,11 @@ export declare type Include<T> = {
     [key in keyof T as T[key] extends XataRecord ? key : never]?: boolean | Array<keyof Selectable<T[key]>>;
 };
 declare type SortDirection = 'asc' | 'desc';
-declare type Operator = '$gt' | '$lt' | '$ge' | '$le' | '$exists' | '$notExists' | '$endsWith' | '$startsWith' | '$pattern' | '$isNot' | '$contains' | '$includes' | '$includesSubstring' | '$includesPattern' | '$includesAll';
+declare type Operator = '$gt' | '$lt' | '$ge' | '$le' | '$exists' | '$notExists' | '$endsWith' | '$startsWith' | '$pattern' | '$is' | '$isNot' | '$contains' | '$includes' | '$includesSubstring' | '$includesPattern' | '$includesAll';
 declare type Constraint<T> = Partial<Record<Operator, T>>;
+declare type DeepConstraint<T> = T extends Record<string, any> ? {
+    [key in keyof T]?: T[key] | DeepConstraint<T[key]>;
+} : Constraint<T>;
 declare type ComparableType = number | Date;
 export declare const gt: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
 export declare const ge: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
@@ -37,6 +40,7 @@ export declare const notExists: (column: string) => Constraint<string>;
 export declare const startsWith: (value: string) => Constraint<string>;
 export declare const endsWith: (value: string) => Constraint<string>;
 export declare const pattern: (value: string) => Constraint<string>;
+export declare const is: <T>(value: T) => Partial<Record<Operator, T>>;
 export declare const isNot: <T>(value: T) => Partial<Record<Operator, T>>;
 export declare const contains: <T>(value: T) => Partial<Record<Operator, T>>;
 export declare const includes: (value: string) => Constraint<string>;
@@ -44,7 +48,7 @@ export declare const includesSubstring: (value: string) => Constraint<string>;
 export declare const includesPattern: (value: string) => Constraint<string>;
 export declare const includesAll: (value: string) => Constraint<string>;
 declare type FilterConstraints<T> = {
-    [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | Constraint<T[key]>;
+    [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | DeepConstraint<T[key]>;
 };
 declare type BulkQueryOptions<T> = {
     filter?: FilterConstraints<T>;
@@ -68,7 +72,7 @@ export declare class Query<T, R = T> {
     not(...queries: Query<T, R>[]): Query<T, R>;
     none(...queries: Query<T, R>[]): Query<T, R>;
     filter(constraints: FilterConstraints<T>): Query<T, R>;
-    filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | Constraint<T[F]>): Query<T, R>;
+    filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
     sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
     getMany(options?: BulkQueryOptions<T>): Promise<R[]>;
     getOne(options?: BulkQueryOptions<T>): Promise<R | null>;

package/dist/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.Query = exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
+exports.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.Query = exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
 const gt = (value) => ({ $gt: value });
 exports.gt = gt;
 const ge = (value) => ({ $ge: value });
@@ -32,14 +32,11 @@ const endsWith = (value) => ({ $endsWith: value });
 exports.endsWith = endsWith;
 const pattern = (value) => ({ $pattern: value });
 exports.pattern = pattern;
+const is = (value) => ({ $is: value });
+exports.is = is;
 const isNot = (value) => ({ $isNot: value });
 exports.isNot = isNot;
-const contains = (value) => {
-    // if (Array.isArray(value)) {
-    //   return { $all: value.map(item => ({ $contains: item as string })) }
-    // }
-    return { $contains: value };
-};
+const contains = (value) => ({ $contains: value });
 exports.contains = contains;
 // TODO: these can only be applied to columns of type "multiple"
 const includes = (value) => ({ $includes: value });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/src/index.ts

@@ -43,6 +43,7 @@ type Operator =
   | '$endsWith'
   | '$startsWith'
   | '$pattern'
+  | '$is'
   | '$isNot'
   | '$contains'
   | '$includes'
@@ -52,7 +53,13 @@ type Operator =
 
 // TODO: restrict constraints depending on type?
 // E.g. startsWith cannot be used with numbers
-type Constraint<T> = Partial<Record<Operator, T>>; // | {$all: Record<'$contains', string>[]};
+type Constraint<T> = Partial<Record<Operator, T>>;
+
+type DeepConstraint<T> = T extends Record<string, any>
+  ? {
+      [key in keyof T]?: T[key] | DeepConstraint<T[key]>;
+    }
+  : Constraint<T>;
 
 type ComparableType = number | Date;
 
@@ -67,13 +74,9 @@ export const notExists = (column: string): Constraint<string> => ({ $notExists:
 export const startsWith = (value: string): Constraint<string> => ({ $startsWith: value });
 export const endsWith = (value: string): Constraint<string> => ({ $endsWith: value });
 export const pattern = (value: string): Constraint<string> => ({ $pattern: value });
+export const is = <T>(value: T): Constraint<T> => ({ $is: value });
 export const isNot = <T>(value: T): Constraint<T> => ({ $isNot: value });
-export const contains = <T>(value: T): Constraint<T> => {
-  // if (Array.isArray(value)) {
-  //   return { $all: value.map(item => ({ $contains: item as string })) }
-  // }
-  return { $contains: value };
-};
+export const contains = <T>(value: T): Constraint<T> => ({ $contains: value });
 
 // TODO: these can only be applied to columns of type "multiple"
 export const includes = (value: string): Constraint<string> => ({ $includes: value });
@@ -82,7 +85,7 @@ export const includesPattern = (value: string): Constraint<string> => ({ $includ
 export const includesAll = (value: string): Constraint<string> => ({ $includesAll: value });
 
 type FilterConstraints<T> = {
-  [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | Constraint<T[key]>;
+  [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | DeepConstraint<T[key]>;
 };
 
 type BulkQueryOptions<T> = {
@@ -182,7 +185,7 @@ export class Query<T, R = T> {
   }
 
   filter(constraints: FilterConstraints<T>): Query<T, R>;
-  filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | Constraint<T[F]>): Query<T, R>;
+  filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
   filter(a: any, b?: any): Query<T, R> {
     if (arguments.length === 1) {
       const constraints = a as FilterConstraints<T>;