@xata.io/client 0.0.0-alpha.vfde9dcf → 0.0.0-alpha.vfee45b2

package/dist/index.d.ts

@@ -292,6 +292,10 @@ declare type FilterExpression = {
 } & {
     [key: string]: FilterColumn;
 };
+declare type HighlightExpression = {
+    enabled?: boolean;
+    encodeHTML?: boolean;
+};
 declare type FilterList = FilterExpression | FilterExpression[];
 declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
 /**
@@ -377,6 +381,11 @@ declare type XataRecord$1 = {
     xata: {
         version: number;
         table?: string;
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
         warnings?: string[];
     };
 } & {
@@ -422,6 +431,7 @@ type schemas_SortExpression = SortExpression;
 type schemas_SortOrder = SortOrder;
 type schemas_FuzzinessExpression = FuzzinessExpression;
 type schemas_FilterExpression = FilterExpression;
+type schemas_HighlightExpression = HighlightExpression;
 type schemas_FilterList = FilterList;
 type schemas_FilterColumn = FilterColumn;
 type schemas_FilterColumnIncludes = FilterColumnIncludes;
@@ -476,6 +486,7 @@ declare namespace schemas {
     schemas_SortOrder as SortOrder,
     schemas_FuzzinessExpression as FuzzinessExpression,
     schemas_FilterExpression as FilterExpression,
+    schemas_HighlightExpression as HighlightExpression,
     schemas_FilterList as FilterList,
     schemas_FilterColumn as FilterColumn,
     schemas_FilterColumnIncludes as FilterColumnIncludes,
@@ -2612,6 +2623,7 @@ declare type SearchTableRequestBody = {
     query: string;
     fuzziness?: FuzzinessExpression;
     filter?: FilterExpression;
+    highlight?: HighlightExpression;
 };
 declare type SearchTableVariables = {
     body: SearchTableRequestBody;
@@ -2640,9 +2652,13 @@ declare type SearchBranchError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SearchBranchRequestBody = {
-    tables?: string[];
+    tables?: (string | {
+        table: string;
+        filter?: FilterExpression;
+    })[];
     query: string;
     fuzziness?: FuzzinessExpression;
+    highlight?: HighlightExpression;
 };
 declare type SearchBranchVariables = {
     body: SearchBranchRequestBody;
@@ -2851,9 +2867,9 @@ declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id'
 declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
     [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
 }>>;
-declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<O[K] extends XataRecord ? (V extends SelectableColumn<O[K]> ? {
-    V: ValueAtColumn<O[K], V>;
-} : never) : O[K]> : never : never;
+declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends Record<string, any> ? V extends SelectableColumn<NonNullable<O[K]>> ? {
+    V: ValueAtColumn<NonNullable<O[K]>, V>;
+} : never : O[K]> : never : never;
 declare type MAX_RECURSION = 5;
 declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
     [K in DataProps<O>]: If<IsArray<NonNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
@@ -3009,8 +3025,8 @@ declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T e
     ],
 }
 */
-declare type AggregatorFilter<Record> = {
-    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<Record>>;
+declare type AggregatorFilter<T> = {
+    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<T>>;
 };
 /**
  * Existance filter
@@ -3025,10 +3041,10 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
  * Injects the Api filters on nested properties
  * Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
  */
-declare type NestedApiFilter<T> = T extends Record<string, any> ? {
+declare type NestedApiFilter<T> = {
     [key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
-} : PropertyFilter<T>;
-declare type Filter<Record> = BaseApiFilter<Record> | NestedApiFilter<Record>;
+};
+declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
 
 declare type SortDirection = 'asc' | 'desc';
 declare type SortFilterExtended<T extends XataRecord> = {
@@ -3065,7 +3081,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
     #private;
     readonly meta: PaginationQueryMeta;
     readonly records: Result[];
-    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, parent?: Partial<QueryOptions<Record>>);
+    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
     getQueryOptions(): QueryOptions<Record>;
     key(): string;
     /**
@@ -3107,8 +3123,8 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      *
      * @returns A new Query object.
      */
-    filter(filters: Filter<Record>): Query<Record, Result>;
     filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    filter(filters: Filter<Record>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.

package/dist/index.mjs

@@ -73,7 +73,12 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-class FetcherError extends Error {
+class ErrorWithCause extends Error {
+  constructor(message, options) {
+    super(message, options);
+  }
+}
+class FetcherError extends ErrorWithCause {
   constructor(status, data) {
     super(getMessage(data));
     this.status = status;
@@ -990,7 +995,7 @@ var __privateSet$4 = (obj, member, value, setter) => {
 };
 var _table$1, _repository, _data;
 const _Query = class {
-  constructor(repository, table, data, parent) {
+  constructor(repository, table, data, rawParent) {
     __privateAdd$5(this, _table$1, void 0);
     __privateAdd$5(this, _repository, void 0);
     __privateAdd$5(this, _data, { filter: {} });
@@ -1002,6 +1007,7 @@ const _Query = class {
     } else {
       __privateSet$4(this, _repository, this);
     }
+    const parent = cleanParent(data, rawParent);
     __privateGet$5(this, _data).filter = data.filter ?? parent?.filter ?? {};
     __privateGet$5(this, _data).filter.$any = data.filter?.$any ?? parent?.filter?.$any;
     __privateGet$5(this, _data).filter.$all = data.filter?.$all ?? parent?.filter?.$all;
@@ -1121,6 +1127,12 @@ let Query = _Query;
 _table$1 = new WeakMap();
 _repository = new WeakMap();
 _data = new WeakMap();
+function cleanParent(data, parent) {
+  if (isCursorPaginationOptions(data.pagination)) {
+    return { ...parent, sorting: void 0, filter: void 0 };
+  }
+  return parent;
+}
 
 function isIdentifiable(x) {
   return isObject(x) && isString(x?.id);
@@ -1328,12 +1340,9 @@ class RestRepository extends Query {
     if (cacheQuery)
       return new Page(query, cacheQuery.meta, cacheQuery.records);
     const data = query.getQueryOptions();
-    const filter = Object.values(data.filter ?? {}).some(Boolean) ? data.filter : void 0;
-    const sort = data.sort !== void 0 ? buildSortFilter(data.sort) : void 0;
-    const isCursorPagination = isCursorPaginationOptions(data.pagination);
     const body = {
-      filter: isCursorPagination ? void 0 : filter,
-      sort: isCursorPagination ? void 0 : sort,
+      filter: Object.values(data.filter ?? {}).some(Boolean) ? data.filter : void 0,
+      sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
       page: data.pagination,
       columns: data.columns
     };