@xata.io/client 0.18.1 → 0.18.2

package/dist/index.d.ts

@@ -478,6 +478,23 @@ declare type FuzzinessExpression = number;
  * If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
  */
 declare type PrefixExpression = 'phrase' | 'disabled';
+/**
+ * The target expression is used to filter the search results by the target columns.
+ */
+declare type TargetExpression = (string | {
+    /**
+     * The name of the column.
+     */
+    column: string;
+    /**
+     * The weight of the column.
+     *
+     * @default 1
+     * @maximum 10
+     * @minimum 1
+     */
+    weight?: number;
+})[];
 /**
  * @minProperties 1
  */
@@ -816,6 +833,7 @@ type schemas_SortExpression = SortExpression;
 type schemas_SortOrder = SortOrder;
 type schemas_FuzzinessExpression = FuzzinessExpression;
 type schemas_PrefixExpression = PrefixExpression;
+type schemas_TargetExpression = TargetExpression;
 type schemas_FilterExpression = FilterExpression;
 type schemas_SummaryExpressionList = SummaryExpressionList;
 type schemas_SummaryExpression = SummaryExpression;
@@ -891,6 +909,7 @@ declare namespace schemas {
     schemas_SortOrder as SortOrder,
     schemas_FuzzinessExpression as FuzzinessExpression,
     schemas_PrefixExpression as PrefixExpression,
+    schemas_TargetExpression as TargetExpression,
     schemas_FilterExpression as FilterExpression,
     schemas_SummaryExpressionList as SummaryExpressionList,
     schemas_SummaryExpression as SummaryExpression,
@@ -974,6 +993,7 @@ declare type SummarizeResponse = {
 };
 declare type SearchResponse = {
     records: XataRecord$1[];
+    warning?: string;
 };
 /**
  * @example {"migrationID":"mig_c7m19ilcefoebpqj12p0"}
@@ -3825,8 +3845,8 @@ declare type QueryTableVariables = {
  *
  * ### Pagination
  *
- * We offer cursor pagination and offset pagination. The offset pagination is limited
- * in the amount of data it can retrieve, so we recommend the cursor pagination if you have more than 1000 records.
+ * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
+ * cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
  *
  * Example of size + offset pagination:
  *
@@ -3955,6 +3975,7 @@ declare type SearchTableRequestBody = {
      */
     query: string;
     fuzziness?: FuzzinessExpression;
+    target?: TargetExpression;
     prefix?: PrefixExpression;
     filter?: FilterExpression;
     highlight?: HighlightExpression;
@@ -3999,6 +4020,7 @@ declare type SearchBranchRequestBody = {
          */
         table: string;
         filter?: FilterExpression;
+        target?: TargetExpression;
         boosters?: BoosterExpression[];
     })[];
     /**
@@ -4560,6 +4582,21 @@ declare type Boosters<O extends XataRecord> = Values<{
     } : never;
 }>;
 
+declare type TargetColumn<T extends XataRecord> = SelectableColumn<T> | {
+    /**
+     * The name of the column.
+     */
+    column: SelectableColumn<T>;
+    /**
+     * The weight of the column.
+     *
+     * @default 1
+     * @maximum 10
+     * @minimum 1
+     */
+    weight?: number;
+};
+
 declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
     fuzziness?: FuzzinessExpression;
     prefix?: PrefixExpression;
@@ -4567,6 +4604,7 @@ declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables exte
     tables?: Array<Tables | Values<{
         [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
             table: Model;
+            target?: TargetColumn<Schemas[Model] & XataRecord>[];
             filter?: Filter<SelectedPick<Schemas[Model] & XataRecord, ['*']>>;
             boosters?: Boosters<Schemas[Model] & XataRecord>[];
         };

package/dist/index.mjs

@@ -150,7 +150,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.18.1";
+const VERSION = "0.18.2";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {