@xata.io/client 0.10.2 → 0.13.0

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,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 infer Column ? Column extends string ? K | `${K}.${Column}` : never : 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.
@@ -2885,16 +2902,11 @@ interface BaseData {
 /**
  * Represents a persisted record from the database.
  */
-interface XataRecord extends Identifiable {
+interface XataRecord<ExtraMetadata extends Record<string, unknown> = Record<string, unknown>> extends Identifiable {
     /**
-     * Metadata of this record.
+     * Get metadata of this record.
      */
-    xata: {
-        /**
-         * Number that is increased every time the record is updated.
-         */
-        version: number;
-    };
+    getMetadata(): XataRecordMetadata & ExtraMetadata;
     /**
      * Retrieves a refreshed copy of the current record from the database.
      */
@@ -2902,7 +2914,7 @@ interface XataRecord extends Identifiable {
     /**
      * Performs a partial update of the current record. On success a new object is
      * returned and the current object is not mutated.
-     * @param data The columns and their values that have to be updated.
+     * @param partialUpdate The columns and their values that have to be updated.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
     update(partialUpdate: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<Readonly<SelectedPick<this, ['*']>>>;
@@ -2921,11 +2933,18 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
     /**
      * Performs a partial update of the current record. On success a new object is
      * returned and the current object is not mutated.
-     * @param data The columns and their values that have to be updated.
+     * @param partialUpdate The columns and their values that have to be updated.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
     update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
 };
+declare type XataRecordMetadata = {
+    /**
+     * Number that is increased every time the record is updated.
+     */
+    version: number;
+    warnings?: string[];
+};
 declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
 declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
 declare type EditableData<O extends BaseData> = {
@@ -3009,8 +3028,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 +3044,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> = {
@@ -3064,8 +3083,8 @@ declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryO
 declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
     #private;
     readonly meta: PaginationQueryMeta;
-    readonly records: Result[];
-    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, parent?: Partial<QueryOptions<Record>>);
+    readonly records: RecordArray<Result>;
+    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
     getQueryOptions(): QueryOptions<Record>;
     key(): string;
     /**
@@ -3097,18 +3116,28 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      *
      * ```
      * query.filter("columnName", columnValue)
-     * query.filter({
-     *   "columnName": columnValue
-     * })
+     * query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
+     * ```
+     *
+     * @param column The name of the column to filter.
+     * @param value The value to filter.
+     * @returns A new Query object.
+     */
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    /**
+     * Builds a new query object adding one or more constraints. Examples:
+     *
+     * ```
+     * query.filter({ "columnName": columnValue })
      * query.filter({
      *   "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
      * })
      * ```
      *
+     * @param filters A filter object
      * @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>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.
@@ -3122,45 +3151,114 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
+    /**
+     * Get paginated results
+     *
+     * @returns A page of results
+     */
     getPaginated(): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
     getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
     getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
+    /**
+     * Get results in an iterator
+     *
+     * @async
+     * @returns Async interable of results
+     */
     [Symbol.asyncIterator](): AsyncIterableIterator<Result>;
+    /**
+     * Build an iterator of results
+     *
+     * @returns Async generator of results array
+     */
     getIterator(): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
     getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
         batchSize?: number;
     }): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
     getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
     }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @returns An array of records from the database.
+     */
+    getMany(): Promise<RecordArray<Result>>;
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
+    getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<RecordArray<Result>>;
     /**
      * Performs the query in the database and returns a set of results.
      * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
-    getMany(): Promise<Result[]>;
-    getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
-    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
+    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
     /**
      * Performs the query in the database and returns all the results.
      * Warning: If there are a large number of results, this method can have performance implications.
-     * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
     getAll(): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
         batchSize?: number;
     }): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
     }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns the first result.
-     * @param options Additional options to be used when performing the query.
      * @returns The first record that matches the query, or null if no record matched the query.
      */
     getFirst(): Promise<Result | null>;
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
     getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
     getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
     /**
      * Builds a new query object adding a cache TTL in milliseconds.
@@ -3168,10 +3266,33 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     cache(ttl: number): Query<Record, Result>;
+    /**
+     * Retrieve next page of records
+     *
+     * @returns A new page object.
+     */
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve previous page of records
+     *
+     * @returns A new page object
+     */
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve first page of records
+     *
+     * @returns A new page object
+     */
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve last page of records
+     *
+     * @returns A new page object
+     */
     lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * @returns Boolean indicating if there is a next page
+     */
     hasNextPage(): boolean;
 }
 
@@ -3183,7 +3304,7 @@ declare type PaginationQueryMeta = {
 };
 interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
     meta: PaginationQueryMeta;
-    records: Result[];
+    records: RecordArray<Result>;
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
@@ -3203,7 +3324,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
     /**
      * The set of results for this page.
      */
-    readonly records: Result[];
+    readonly records: RecordArray<Result>;
     constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
     /**
      * Retrieves the next page of results.
@@ -3252,9 +3373,42 @@ declare type OffsetNavigationOptions = {
     offset?: number;
 };
 declare const PAGINATION_MAX_SIZE = 200;
-declare const PAGINATION_DEFAULT_SIZE = 200;
+declare const PAGINATION_DEFAULT_SIZE = 20;
 declare const PAGINATION_MAX_OFFSET = 800;
 declare const PAGINATION_DEFAULT_OFFSET = 0;
+declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
+declare class RecordArray<Result extends XataRecord> extends Array<Result> {
+    #private;
+    constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
+    /**
+     * Retrieve next page of records
+     *
+     * @returns A new array of objects
+     */
+    nextPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
+    /**
+     * Retrieve previous page of records
+     *
+     * @returns A new array of objects
+     */
+    previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
+    /**
+     * Retrieve first page of records
+     *
+     * @returns A new array of objects
+     */
+    firstPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
+    /**
+     * Retrieve last page of records
+     *
+     * @returns A new array of objects
+     */
+    lastPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
+    /**
+     * @returns Boolean indicating if there is a next page
+     */
+    hasNextPage(): boolean;
+}
 
 /**
  * Common interface for performing operations on a table.
@@ -3280,6 +3434,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.
@@ -3352,7 +3512,8 @@ 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>>;
@@ -3369,6 +3530,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, ['*']>[]>;
@@ -3377,7 +3539,8 @@ 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>>;
@@ -3472,18 +3635,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 {
@@ -3492,11 +3661,19 @@ declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends Xat
     constructor(db: SchemaPluginResult<Schemas>);
     build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
 }
-declare type SearchXataRecord = XataRecord & {
-    xata: {
-        table: string;
+declare type SearchXataRecord = XataRecord<SearchExtraProperties>;
+declare type SearchExtraProperties = {
+    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>;
@@ -3539,4 +3716,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, 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, 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 };
+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, RecordArray, 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 };