@xata.io/client 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -268,6 +268,17 @@ declare type SortExpression = string[] | {
     [key: string]: SortOrder;
 }[];
 declare type SortOrder = 'asc' | 'desc';
+/**
+ * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
+ * distance is the number of one charcter changes needed to make two strings equal. The default is 1, meaning that single
+ * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
+ * to allow two typos in a word.
+ *
+ * @default 1
+ * @maximum 2
+ * @minimum 0
+ */
+declare type FuzzinessExpression = number;
 /**
  * @minProperties 1
  */
@@ -281,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;
 /**
@@ -366,6 +381,11 @@ declare type XataRecord$1 = {
     xata: {
         version: number;
         table?: string;
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
         warnings?: string[];
     };
 } & {
@@ -409,7 +429,9 @@ type schemas_TableMigration = TableMigration;
 type schemas_ColumnMigration = ColumnMigration;
 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;
@@ -462,7 +484,9 @@ declare namespace schemas {
     schemas_ColumnMigration as ColumnMigration,
     schemas_SortExpression as SortExpression,
     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,
@@ -1151,14 +1175,15 @@ declare type ResolveBranchVariables = {
 } & FetcherExtraProps;
 /**
  * In order to resolve the database branch, the following algorithm is used:
- * * if the `gitBranch` is found in the [git branches mapping](), the associated Xata branch is returned
+ * * if the `gitBranch` was provided and is found in the [git branches mapping](/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
  * * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
- * * else, return the default branch of the DB (currently `main` or the first branch)
+ * * else, if `fallbackBranch` is provided and a branch with that name exists, return it
+ * * else, return the default branch of the DB (`main` or the first branch)
  *
  * Example call:
  *
  * ```json
- * // GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test?fallbackBranch=tsg
+ * // GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test&fallbackBranch=tsg
  * ```
  *
  * Example response:
@@ -1458,8 +1483,9 @@ declare type UpdateTableVariables = {
  *
  * In the example below, we rename a table from “users” to “people”:
  *
- * ```jsx
- * PATCH /db/test:main/tables/users
+ * ```json
+ * // PATCH /db/test:main/tables/users
+ *
  * {
  *   "name": "people"
  * }
@@ -1867,7 +1893,7 @@ declare type QueryTableVariables = {
  * {
  *   "columns": [...],
  *   "filter": {
- *     "$all": [...]
+ *     "$all": [...],
  *     "$any": [...]
  *     ...
  *   },
@@ -2005,7 +2031,7 @@ declare type QueryTableVariables = {
  * {
  *   "name": "Kilian",
  *   "address": {
- *     "street": "New street",
+ *     "street": "New street"
  *   }
  * }
  * ```
@@ -2014,10 +2040,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.name"
- *   ]
+ *   "columns": ["*", "team.name"]
  * }
  * ```
  *
@@ -2035,7 +2058,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team"
  *   }
@@ -2046,10 +2069,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.*"
- *   ]
+ *   "columns": ["*", "team.*"]
  * }
  * ```
  *
@@ -2067,7 +2087,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team",
  *     "code": "A1",
@@ -2117,7 +2137,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "name": "r2",
+ *     "name": "r2"
  *   }
  * }
  * ```
@@ -2139,7 +2159,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.plan": "free",
+ *     "settings.plan": "free"
  *   }
  * }
  * ```
@@ -2149,8 +2169,8 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "settings": {
  *       "plan": "free"
- *     },
- *   },
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2159,8 +2179,8 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": {"$any": ["free", "paid"]}
- *   },
+ *     "settings.plan": { "$any": ["free", "paid"] }
+ *   }
  * }
  * ```
  *
@@ -2169,9 +2189,9 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.dark": true,
- *       "settings.plan": "free",
- *   },
+ *     "settings.dark": true,
+ *     "settings.plan": "free"
+ *   }
  * }
  * ```
  *
@@ -2182,11 +2202,11 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "$any": {
- *         "settings.dark": true,
- *         "settings.plan": "free"
- *       }
- *   },
+ *     "$any": {
+ *       "settings.dark": true,
+ *       "settings.plan": "free"
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2197,10 +2217,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$any": [
  *       {
- *         "name": "r1",
+ *         "name": "r1"
  *       },
  *       {
- *         "name": "r2",
+ *         "name": "r2"
  *       }
  *     ]
  *   }
@@ -2212,7 +2232,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$exists": "settings",
+ *     "$exists": "settings"
  *   }
  * }
  * ```
@@ -2224,10 +2244,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$all": [
  *       {
- *         "$exists": "settings",
+ *         "$exists": "settings"
  *       },
  *       {
- *         "$exists": "name",
+ *         "$exists": "name"
  *       }
  *     ]
  *   }
@@ -2239,7 +2259,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$notExists": "settings",
+ *     "$notExists": "settings"
  *   }
  * }
  * ```
@@ -2266,22 +2286,28 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$pattern": "v*alue*"
+ *       "$pattern": "v*alu?"
  *     }
  *   }
  * }
  * ```
  *
+ * The `$pattern` operator accepts two wildcard characters:
+ * * `*` matches zero or more characters
+ * * `?` matches exactly one character
+ *
+ * If you want to match a string that contains a wildcard character, you can escape them using a backslash (`\`). You can escape a backslash by usign another backslash.
+ *
  * We could also have `$endsWith` and `$startsWith` operators:
  *
  * ```json
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$endsWith": ".gz"
+ *       "$endsWith": ".gz"
  *     },
  *     "<column_name>": {
- *         "$startsWith": "tmp-"
+ *       "$startsWith": "tmp-"
  *     }
  *   }
  * }
@@ -2292,10 +2318,10 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "<column_name>": {
- *         "$ge": 0,
- *         "$lt": 100
- *       }
+ *     "<column_name>": {
+ *       "$ge": 0,
+ *       "$lt": 100
+ *     }
  *   }
  * }
  * ```
@@ -2313,7 +2339,6 @@ declare type QueryTableVariables = {
  * ```
  * The supported operators are `$gt`, `$lt`, `$ge`, `$le`.
  *
- *
  * #### Negations
  *
  * A general `$not` operator can inverse any operation.
@@ -2338,15 +2363,21 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "$not": {
- *       "$any": [{
- *         "<column_name1>": "value1"
- *       }, {
- *         "$all": [{
- *           "<column_name2>": "value2"
- *         }, {
- *           "<column_name3>": "value3"
- *         }]
- *       }]
+ *       "$any": [
+ *         {
+ *           "<column_name1>": "value1"
+ *         },
+ *         {
+ *           "$all": [
+ *             {
+ *               "<column_name2>": "value2"
+ *             },
+ *             {
+ *               "<column_name3>": "value3"
+ *             }
+ *           ]
+ *         }
+ *       ]
  *     }
  *   }
  * }
@@ -2401,8 +2432,8 @@ declare type QueryTableVariables = {
  *     "<array name>": {
  *       "$includes": {
  *         "$all": [
- *           {"$contains": "label"},
- *           {"$not": {"$endsWith": "-debug"}}
+ *           { "$contains": "label" },
+ *           { "$not": { "$endsWith": "-debug" } }
  *         ]
  *       }
  *     }
@@ -2422,9 +2453,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "settings.labels": {
- *       "$includesAll": [
- *         {"$contains": "label"},
- *       ]
+ *       "$includesAll": [{ "$contains": "label" }]
  *     }
  *   }
  * }
@@ -2472,7 +2501,6 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- *
  * ### Pagination
  *
  * We offer cursor pagination and offset pagination. The offset pagination is limited
@@ -2538,8 +2566,8 @@ declare type QueryTableVariables = {
  * can be queried by update `page.after` to the returned cursor while keeping the
  * `page.before` cursor from the first range query.
  *
- * The `filter` , `columns`,  `sort` , and `page.size` configuration will be
- * encoded with the cursor.  The pagination request will be invalid if
+ * The `filter` , `columns`, `sort` , and `page.size` configuration will be
+ * encoded with the cursor. The pagination request will be invalid if
  * `filter` or `sort` is set. The columns returned and page size can be changed
  * anytime by passing the `columns` or `page.size` settings to the next query.
  *
@@ -2576,6 +2604,39 @@ declare type QueryTableVariables = {
  * ```
  */
 declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
+declare type SearchTablePathParams = {
+    dbBranchName: DBBranchName;
+    tableName: TableName;
+    workspace: string;
+};
+declare type SearchTableError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+} | {
+    status: 404;
+    payload: SimpleError;
+}>;
+declare type SearchTableRequestBody = {
+    query: string;
+    fuzziness?: FuzzinessExpression;
+    filter?: FilterExpression;
+    highlight?: HighlightExpression;
+};
+declare type SearchTableVariables = {
+    body: SearchTableRequestBody;
+    pathParams: SearchTablePathParams;
+} & FetcherExtraProps;
+/**
+ * Run a free text search operation in a particular table.
+ *
+ * The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
+ * * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
+ * * filtering on columns of type `multiple` is currently unsupported
+ */
+declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
 declare type SearchBranchPathParams = {
     dbBranchName: DBBranchName;
     workspace: string;
@@ -2591,9 +2652,13 @@ declare type SearchBranchError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SearchBranchRequestBody = {
-    tables?: string[];
+    tables?: (string | {
+        table: string;
+        filter?: FilterExpression;
+    })[];
     query: string;
-    fuzziness?: number;
+    fuzziness?: FuzzinessExpression;
+    highlight?: HighlightExpression;
 };
 declare type SearchBranchVariables = {
     body: SearchBranchRequestBody;
@@ -2668,6 +2733,7 @@ declare const operationsByTag: {
         getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
         bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertTableRecordsResponse>;
         queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
+        searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
         searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
     };
 };
@@ -2773,6 +2839,7 @@ declare class RecordsApi {
     getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordRequestBody): Promise<XataRecord$1>;
     bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[]): Promise<BulkInsertTableRecordsResponse>;
     queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
+    searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
     searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
 }
 
@@ -2800,24 +2867,25 @@ 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<RemoveNullable<O[K]> extends Record<string, any> ? V extends SelectableColumn<RemoveNullable<O[K]>> ? {
+    V: ValueAtColumn<RemoveNullable<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
-    If<IsObject<NonNullable<O[K]>>, NonNullable<O[K]> extends XataRecord ? SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<NonNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
+    [K in DataProps<O>]: If<IsArray<RemoveNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
+    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
     K>>;
 }>, never>;
 declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
 declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
-    [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
+    [K in N]: M extends SelectableColumn<RemoveNullable<O[K]>> ? RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M>> : unknown;
 } : unknown : Key extends DataProps<O> ? {
-    [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
+    [K in Key]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<RemoveNullable<O[K]>, ['*']>> : O[K];
 } : Key extends '*' ? {
-    [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
+    [K in StringKeys<O>]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<RemoveNullable<O[K]>>> : O[K];
 } : unknown;
-declare type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
+declare type RemoveNullable<T> = T extends null | undefined ? never : T;
+declare type ForwardNullable<T, R> = T extends RemoveNullable<T> ? R : R | null;
 
 /**
  * Represents an identifiable record from the database.
@@ -2958,8 +3026,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
@@ -2974,10 +3042,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> = {
@@ -3014,7 +3082,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;
     /**
@@ -3056,8 +3124,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.
@@ -3204,6 +3272,7 @@ declare const PAGINATION_MAX_SIZE = 200;
 declare const PAGINATION_DEFAULT_SIZE = 200;
 declare const PAGINATION_MAX_OFFSET = 800;
 declare const PAGINATION_DEFAULT_OFFSET = 0;
+declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
 
 /**
  * Common interface for performing operations on a table.
@@ -3229,6 +3298,12 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
      * @returns The persisted record for the given id or null if the record could not be found.
      */
     abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
+    /**
+     * Queries multiple records from the table given their unique id.
+     * @param ids The unique ids array.
+     * @returns The persisted records for the given ids (if a record could not be found it is not returned).
+     */
+    abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     /**
      * Partially update a single record.
      * @param object An object with its id and the columns to be updated.
@@ -3301,7 +3376,9 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
      * @returns The found records.
      */
     abstract search(query: string, options?: {
-        fuzziness?: number;
+        fuzziness?: FuzzinessExpression;
+        highlight?: HighlightExpression;
+        filter?: Filter<Record>;
     }): Promise<SelectedPick<Record, ['*']>[]>;
     abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
@@ -3317,6 +3394,7 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
+    read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
     update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
@@ -3325,7 +3403,9 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
     createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
     search(query: string, options?: {
-        fuzziness?: number;
+        fuzziness?: FuzzinessExpression;
+        highlight?: HighlightExpression;
+        filter?: Filter<Record>;
     }): Promise<SelectedPick<Record, ['*']>[]>;
     query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
@@ -3419,18 +3499,24 @@ declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends Xat
 }
 
 declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
-    fuzziness?: number;
-    tables?: Tables[];
+    fuzziness?: FuzzinessExpression;
+    highlight?: HighlightExpression;
+    tables?: Array<Tables | Values<{
+        [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
+            table: Model;
+            filter?: Filter<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
+        };
+    }>>;
 };
 declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
     all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
-        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]: {
+        [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
             table: Model;
             record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
         };
     }>[]>;
     byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
-        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
+        [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
     }>;
 };
 declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
@@ -3441,9 +3527,18 @@ declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends Xat
 }
 declare type SearchXataRecord = XataRecord & {
     xata: {
-        table: string;
+        table?: string;
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
     };
 };
+declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
+declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
+    table: infer Table;
+} ? ReturnTable<Table, Tables> : never;
 
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
@@ -3486,4 +3581,4 @@ declare class XataError extends Error {
     constructor(message: string, status: number);
 }
 
-export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
+export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };