@xata.io/client 0.18.1 → 0.18.3

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,
@@ -970,10 +989,11 @@ declare type QueryResponse = {
     meta: RecordsMetadata;
 };
 declare type SummarizeResponse = {
-    summary: Record<string, any>[];
+    summaries: Record<string, any>[];
 };
 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.3";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -1690,7 +1690,7 @@ class RestRepository extends Query {
             ...fetchProps
           });
           const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-          return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+          return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
         } catch (e) {
           if (isObject(e) && e.status === 404) {
             return null;
@@ -1836,7 +1836,7 @@ class RestRepository extends Query {
         ...fetchProps
       });
       const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-      return records.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item));
+      return records.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item, ["*"]));
     });
   }
   async query(query) {
@@ -1858,7 +1858,9 @@ class RestRepository extends Query {
         ...fetchProps
       });
       const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-      const records = objects.map((record) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), record));
+      const records = objects.map(
+        (record) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), record, data.columns ?? ["*"])
+      );
       await __privateMethod$2(this, _setCacheQuery, setCacheQuery_fn).call(this, query, meta, records);
       return new Page(query, meta, records);
     });
@@ -1885,7 +1887,7 @@ insertRecordWithoutId_fn = async function(object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
 };
 _insertRecordWithId = new WeakSet();
 insertRecordWithId_fn = async function(recordId, object, columns = ["*"]) {
@@ -1903,7 +1905,7 @@ insertRecordWithId_fn = async function(recordId, object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
 };
 _bulkInsertTableRecords = new WeakSet();
 bulkInsertTableRecords_fn = async function(objects, columns = ["*"]) {
@@ -1919,7 +1921,7 @@ bulkInsertTableRecords_fn = async function(objects, columns = ["*"]) {
     throw new Error("Request included columns but server didn't include them");
   }
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return response.records?.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item));
+  return response.records?.map((item) => initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), item, columns));
 };
 _updateRecordWithID = new WeakSet();
 updateRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
@@ -1933,7 +1935,7 @@ updateRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
       ...fetchProps
     });
     const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-    return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+    return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
   } catch (e) {
     if (isObject(e) && e.status === 404) {
       return null;
@@ -1951,7 +1953,7 @@ upsertRecordWithID_fn = async function(recordId, object, columns = ["*"]) {
     ...fetchProps
   });
   const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+  return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
 };
 _deleteRecord = new WeakSet();
 deleteRecord_fn = async function(recordId, columns = ["*"]) {
@@ -1963,7 +1965,7 @@ deleteRecord_fn = async function(recordId, columns = ["*"]) {
       ...fetchProps
     });
     const schemaTables = await __privateMethod$2(this, _getSchemaTables$1, getSchemaTables_fn$1).call(this);
-    return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response);
+    return initObject(__privateGet$4(this, _db), schemaTables, __privateGet$4(this, _table), response, columns);
   } catch (e) {
     if (isObject(e) && e.status === 404) {
       return null;
@@ -2006,7 +2008,7 @@ const transformObjectLinks = (object) => {
     return { ...acc, [key]: isIdentifiable(value) ? value.id : value };
   }, {});
 };
-const initObject = (db, schemaTables, table, object) => {
+const initObject = (db, schemaTables, table, object, selectedColumns) => {
   const result = {};
   const { xata, ...rest } = object ?? {};
   Object.assign(result, rest);
@@ -2014,6 +2016,8 @@ const initObject = (db, schemaTables, table, object) => {
   if (!columns)
     console.error(`Table ${table} not found in schema`);
   for (const column of columns ?? []) {
+    if (!isValidColumn(selectedColumns, column))
+      continue;
     const value = result[column.name];
     switch (column.type) {
       case "datetime": {
@@ -2030,7 +2034,17 @@ const initObject = (db, schemaTables, table, object) => {
         if (!linkTable) {
           console.error(`Failed to parse link for field ${column.name}`);
         } else if (isObject(value)) {
-          result[column.name] = initObject(db, schemaTables, linkTable, value);
+          const selectedLinkColumns = selectedColumns.reduce((acc, item) => {
+            if (item === column.name) {
+              return [...acc, "*"];
+            }
+            if (item.startsWith(`${column.name}.`)) {
+              const [, ...path] = item.split(".");
+              return [...acc, path.join(".")];
+            }
+            return acc;
+          }, []);
+          result[column.name] = initObject(db, schemaTables, linkTable, value, selectedLinkColumns);
         } else {
           result[column.name] = null;
         }
@@ -2078,6 +2092,15 @@ function cleanFilter(filter) {
   const values = Object.values(filter).filter(Boolean).filter((value) => Array.isArray(value) ? value.length > 0 : true);
   return values.length > 0 ? filter : void 0;
 }
+function isValidColumn(columns, column) {
+  if (columns.includes("*"))
+    return true;
+  if (column.type === "link") {
+    const linkColumns = columns.filter((item) => item.startsWith(column.name));
+    return linkColumns.length > 0;
+  }
+  return columns.includes(column.name);
+}
 
 var __accessCheck$3 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -2243,7 +2266,7 @@ class SearchPlugin extends XataPlugin {
         const schemaTables = await __privateMethod$1(this, _getSchemaTables, getSchemaTables_fn).call(this, getFetchProps);
         return records.map((record) => {
           const { table = "orphan" } = record.xata;
-          return { table, record: initObject(this.db, schemaTables, table, record) };
+          return { table, record: initObject(this.db, schemaTables, table, record, ["*"]) };
         });
       },
       byTable: async (query, options = {}) => {
@@ -2252,7 +2275,7 @@ class SearchPlugin extends XataPlugin {
         return records.reduce((acc, record) => {
           const { table = "orphan" } = record.xata;
           const items = acc[table] ?? [];
-          const item = initObject(this.db, schemaTables, table, record);
+          const item = initObject(this.db, schemaTables, table, record, ["*"]);
           return { ...acc, [table]: [...items, item] };
         }, {});
       }