@xata.io/client 0.0.0-alpha.vf9f8d99 → 0.0.0-alpha.vfa37ea7

package/dist/index.mjs

@@ -91,8 +91,10 @@ function getEnvironment() {
         apiKey: process.env.XATA_API_KEY ?? getGlobalApiKey(),
         databaseURL: process.env.XATA_DATABASE_URL ?? getGlobalDatabaseURL(),
         branch: process.env.XATA_BRANCH ?? getGlobalBranch(),
-        envBranch: process.env.VERCEL_GIT_COMMIT_REF ?? process.env.CF_PAGES_BRANCH ?? process.env.BRANCH,
-        fallbackBranch: process.env.XATA_FALLBACK_BRANCH ?? getGlobalFallbackBranch()
+        deployPreview: process.env.XATA_PREVIEW,
+        deployPreviewBranch: process.env.XATA_PREVIEW_BRANCH,
+        vercelGitCommitRef: process.env.VERCEL_GIT_COMMIT_REF,
+        vercelGitRepoOwner: process.env.VERCEL_GIT_REPO_OWNER
       };
     }
   } catch (err) {
@@ -103,8 +105,10 @@ function getEnvironment() {
         apiKey: Deno.env.get("XATA_API_KEY") ?? getGlobalApiKey(),
         databaseURL: Deno.env.get("XATA_DATABASE_URL") ?? getGlobalDatabaseURL(),
         branch: Deno.env.get("XATA_BRANCH") ?? getGlobalBranch(),
-        envBranch: Deno.env.get("VERCEL_GIT_COMMIT_REF") ?? Deno.env.get("CF_PAGES_BRANCH") ?? Deno.env.get("BRANCH"),
-        fallbackBranch: Deno.env.get("XATA_FALLBACK_BRANCH") ?? getGlobalFallbackBranch()
+        deployPreview: Deno.env.get("XATA_PREVIEW"),
+        deployPreviewBranch: Deno.env.get("XATA_PREVIEW_BRANCH"),
+        vercelGitCommitRef: Deno.env.get("VERCEL_GIT_COMMIT_REF"),
+        vercelGitRepoOwner: Deno.env.get("VERCEL_GIT_REPO_OWNER")
       };
     }
   } catch (err) {
@@ -113,8 +117,10 @@ function getEnvironment() {
     apiKey: getGlobalApiKey(),
     databaseURL: getGlobalDatabaseURL(),
     branch: getGlobalBranch(),
-    envBranch: void 0,
-    fallbackBranch: getGlobalFallbackBranch()
+    deployPreview: void 0,
+    deployPreviewBranch: void 0,
+    vercelGitCommitRef: void 0,
+    vercelGitRepoOwner: void 0
   };
 }
 function getEnableBrowserVariable() {
@@ -157,34 +163,48 @@ function getGlobalBranch() {
     return void 0;
   }
 }
-function getGlobalFallbackBranch() {
+function getDatabaseURL() {
   try {
-    return XATA_FALLBACK_BRANCH;
+    const { databaseURL } = getEnvironment();
+    return databaseURL;
   } catch (err) {
     return void 0;
   }
 }
-function getDatabaseURL() {
+function getAPIKey() {
   try {
-    const { databaseURL } = getEnvironment();
-    return databaseURL;
+    const { apiKey } = getEnvironment();
+    return apiKey;
   } catch (err) {
     return void 0;
   }
 }
 function getBranch() {
   try {
-    const { branch, envBranch } = getEnvironment();
-    return branch ?? envBranch;
+    const { branch } = getEnvironment();
+    return branch ?? "main";
   } catch (err) {
     return void 0;
   }
 }
-
-function getAPIKey() {
+function buildPreviewBranchName({ org, branch }) {
+  return `preview-${org}-${branch}`;
+}
+function getPreviewBranch() {
   try {
-    const { apiKey } = getEnvironment();
-    return apiKey;
+    const { deployPreview, deployPreviewBranch, vercelGitCommitRef, vercelGitRepoOwner } = getEnvironment();
+    if (deployPreviewBranch)
+      return deployPreviewBranch;
+    switch (deployPreview) {
+      case "vercel": {
+        if (!vercelGitCommitRef || !vercelGitRepoOwner) {
+          console.warn("XATA_PREVIEW=vercel but VERCEL_GIT_COMMIT_REF or VERCEL_GIT_REPO_OWNER is not valid");
+          return void 0;
+        }
+        return buildPreviewBranchName({ org: vercelGitRepoOwner, branch: vercelGitCommitRef });
+      }
+    }
+    return void 0;
   } catch (err) {
     return void 0;
   }
@@ -244,7 +264,7 @@ class ApiRequestPool {
     return __privateGet$8(this, _fetch);
   }
   request(url, options) {
-    const start = new Date();
+    const start = /* @__PURE__ */ new Date();
     const fetch2 = this.getFetch();
     const runRequest = async (stalled = false) => {
       const response = await fetch2(url, options);
@@ -254,7 +274,7 @@ class ApiRequestPool {
         return await runRequest(true);
       }
       if (stalled) {
-        const stalledTime = new Date().getTime() - start.getTime();
+        const stalledTime = (/* @__PURE__ */ new Date()).getTime() - start.getTime();
         console.warn(`A request to Xata hit your workspace limits, was retried and stalled for ${stalledTime}ms`);
       }
       return response;
@@ -297,7 +317,180 @@ function generateUUID() {
   });
 }
 
-const VERSION = "0.22.3";
+async function getBytes(stream, onChunk) {
+  const reader = stream.getReader();
+  let result;
+  while (!(result = await reader.read()).done) {
+    onChunk(result.value);
+  }
+}
+function getLines(onLine) {
+  let buffer;
+  let position;
+  let fieldLength;
+  let discardTrailingNewline = false;
+  return function onChunk(arr) {
+    if (buffer === void 0) {
+      buffer = arr;
+      position = 0;
+      fieldLength = -1;
+    } else {
+      buffer = concat(buffer, arr);
+    }
+    const bufLength = buffer.length;
+    let lineStart = 0;
+    while (position < bufLength) {
+      if (discardTrailingNewline) {
+        if (buffer[position] === 10 /* NewLine */) {
+          lineStart = ++position;
+        }
+        discardTrailingNewline = false;
+      }
+      let lineEnd = -1;
+      for (; position < bufLength && lineEnd === -1; ++position) {
+        switch (buffer[position]) {
+          case 58 /* Colon */:
+            if (fieldLength === -1) {
+              fieldLength = position - lineStart;
+            }
+            break;
+          case 13 /* CarriageReturn */:
+            discardTrailingNewline = true;
+          case 10 /* NewLine */:
+            lineEnd = position;
+            break;
+        }
+      }
+      if (lineEnd === -1) {
+        break;
+      }
+      onLine(buffer.subarray(lineStart, lineEnd), fieldLength);
+      lineStart = position;
+      fieldLength = -1;
+    }
+    if (lineStart === bufLength) {
+      buffer = void 0;
+    } else if (lineStart !== 0) {
+      buffer = buffer.subarray(lineStart);
+      position -= lineStart;
+    }
+  };
+}
+function getMessages(onId, onRetry, onMessage) {
+  let message = newMessage();
+  const decoder = new TextDecoder();
+  return function onLine(line, fieldLength) {
+    if (line.length === 0) {
+      onMessage?.(message);
+      message = newMessage();
+    } else if (fieldLength > 0) {
+      const field = decoder.decode(line.subarray(0, fieldLength));
+      const valueOffset = fieldLength + (line[fieldLength + 1] === 32 /* Space */ ? 2 : 1);
+      const value = decoder.decode(line.subarray(valueOffset));
+      switch (field) {
+        case "data":
+          message.data = message.data ? message.data + "\n" + value : value;
+          break;
+        case "event":
+          message.event = value;
+          break;
+        case "id":
+          onId(message.id = value);
+          break;
+        case "retry":
+          const retry = parseInt(value, 10);
+          if (!isNaN(retry)) {
+            onRetry(message.retry = retry);
+          }
+          break;
+      }
+    }
+  };
+}
+function concat(a, b) {
+  const res = new Uint8Array(a.length + b.length);
+  res.set(a);
+  res.set(b, a.length);
+  return res;
+}
+function newMessage() {
+  return {
+    data: "",
+    event: "",
+    id: "",
+    retry: void 0
+  };
+}
+const EventStreamContentType = "text/event-stream";
+const LastEventId = "last-event-id";
+function fetchEventSource(input, {
+  signal: inputSignal,
+  headers: inputHeaders,
+  onopen: inputOnOpen,
+  onmessage,
+  onclose,
+  onerror,
+  fetch: inputFetch,
+  ...rest
+}) {
+  return new Promise((resolve, reject) => {
+    const headers = { ...inputHeaders };
+    if (!headers.accept) {
+      headers.accept = EventStreamContentType;
+    }
+    let curRequestController;
+    function dispose() {
+      curRequestController.abort();
+    }
+    inputSignal?.addEventListener("abort", () => {
+      dispose();
+      resolve();
+    });
+    const fetchImpl = inputFetch ?? fetch;
+    const onopen = inputOnOpen ?? defaultOnOpen;
+    async function create() {
+      curRequestController = new AbortController();
+      try {
+        const response = await fetchImpl(input, {
+          ...rest,
+          headers,
+          signal: curRequestController.signal
+        });
+        await onopen(response);
+        await getBytes(
+          response.body,
+          getLines(
+            getMessages(
+              (id) => {
+                if (id) {
+                  headers[LastEventId] = id;
+                } else {
+                  delete headers[LastEventId];
+                }
+              },
+              (_retry) => {
+              },
+              onmessage
+            )
+          )
+        );
+        onclose?.();
+        dispose();
+        resolve();
+      } catch (err) {
+      }
+    }
+    create();
+  });
+}
+function defaultOnOpen(response) {
+  const contentType = response.headers?.get("content-type");
+  if (!contentType?.startsWith(EventStreamContentType)) {
+    throw new Error(`Expected content-type to be ${EventStreamContentType}, Actual: ${contentType}`);
+  }
+}
+
+const VERSION = "0.24.0";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -456,6 +649,59 @@ async function fetch$1({
     { [TraceAttributes.HTTP_METHOD]: method.toUpperCase(), [TraceAttributes.HTTP_ROUTE]: path }
   );
 }
+function fetchSSERequest({
+  url: path,
+  method,
+  body,
+  headers: customHeaders,
+  pathParams,
+  queryParams,
+  fetch: fetch2,
+  apiKey,
+  endpoint,
+  apiUrl,
+  workspacesApiUrl,
+  onMessage,
+  onError,
+  onClose,
+  signal,
+  clientID,
+  sessionID,
+  clientName,
+  xataAgentExtra
+}) {
+  const baseUrl = buildBaseUrl({ endpoint, path, workspacesApiUrl, pathParams, apiUrl });
+  const fullUrl = resolveUrl(baseUrl, queryParams, pathParams);
+  const url = fullUrl.includes("localhost") ? fullUrl.replace(/^[^.]+\./, "http://") : fullUrl;
+  void fetchEventSource(url, {
+    method,
+    body: JSON.stringify(body),
+    fetch: fetch2,
+    signal,
+    headers: {
+      "X-Xata-Client-ID": clientID ?? defaultClientID,
+      "X-Xata-Session-ID": sessionID ?? generateUUID(),
+      "X-Xata-Agent": compact([
+        ["client", "TS_SDK"],
+        ["version", VERSION],
+        isDefined(clientName) ? ["service", clientName] : void 0,
+        ...Object.entries(xataAgentExtra ?? {})
+      ]).map(([key, value]) => `${key}=${value}`).join("; "),
+      ...customHeaders,
+      Authorization: `Bearer ${apiKey}`,
+      "Content-Type": "application/json"
+    },
+    onmessage(ev) {
+      onMessage?.(JSON.parse(ev.data));
+    },
+    onerror(ev) {
+      onError?.(JSON.parse(ev.data));
+    },
+    onclose() {
+      onClose?.();
+    }
+  });
+}
 function parseUrl(url) {
   try {
     const { host, protocol } = new URL(url);
@@ -486,6 +732,12 @@ const deleteBranch = (variables, signal) => dataPlaneFetch({
   ...variables,
   signal
 });
+const copyBranch = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/copy",
+  method: "post",
+  ...variables,
+  signal
+});
 const updateBranchMetadata = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/metadata",
   method: "put",
@@ -535,6 +787,7 @@ const compareBranchSchemas = (variables, signal) => dataPlaneFetch({ url: "/db/{
 const updateBranchSchema = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/schema/update", method: "post", ...variables, signal });
 const previewBranchSchemaEdit = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/schema/preview", method: "post", ...variables, signal });
 const applyBranchSchemaEdit = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/schema/apply", method: "post", ...variables, signal });
+const pushBranchMigrations = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/schema/push", method: "post", ...variables, signal });
 const createTable = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/tables/{tableName}",
   method: "put",
@@ -579,6 +832,42 @@ const deleteColumn = (variables, signal) => dataPlaneFetch({
 });
 const branchTransaction = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/transaction", method: "post", ...variables, signal });
 const insertRecord = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/data", method: "post", ...variables, signal });
+const getFileItem = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file/{fileId}",
+  method: "get",
+  ...variables,
+  signal
+});
+const putFileItem = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file/{fileId}",
+  method: "put",
+  ...variables,
+  signal
+});
+const deleteFileItem = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file/{fileId}",
+  method: "delete",
+  ...variables,
+  signal
+});
+const getFile = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file",
+  method: "get",
+  ...variables,
+  signal
+});
+const putFile = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file",
+  method: "put",
+  ...variables,
+  signal
+});
+const deleteFile = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}/column/{columnName}/file",
+  method: "delete",
+  ...variables,
+  signal
+});
 const getRecord = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/tables/{tableName}/data/{recordId}",
   method: "get",
@@ -608,6 +897,12 @@ const searchTable = (variables, signal) => dataPlaneFetch({
   ...variables,
   signal
 });
+const sqlQuery = (variables, signal) => dataPlaneFetch({
+  url: "/db/{dbBranchName}/sql",
+  method: "post",
+  ...variables,
+  signal
+});
 const vectorSearchTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/vectorSearch", method: "post", ...variables, signal });
 const askTable = (variables, signal) => dataPlaneFetch({
   url: "/db/{dbBranchName}/tables/{tableName}/ask",
@@ -617,12 +912,19 @@ const askTable = (variables, signal) => dataPlaneFetch({
 });
 const summarizeTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/summarize", method: "post", ...variables, signal });
 const aggregateTable = (variables, signal) => dataPlaneFetch({ url: "/db/{dbBranchName}/tables/{tableName}/aggregate", method: "post", ...variables, signal });
+const fileAccess = (variables, signal) => dataPlaneFetch({
+  url: "/file/{fileId}",
+  method: "get",
+  ...variables,
+  signal
+});
 const operationsByTag$2 = {
   branch: {
     getBranchList,
     getBranchDetails,
     createBranch,
     deleteBranch,
+    copyBranch,
     updateBranchMetadata,
     getBranchMetadata,
     getBranchStats,
@@ -640,7 +942,8 @@ const operationsByTag$2 = {
     compareBranchSchemas,
     updateBranchSchema,
     previewBranchSchemaEdit,
-    applyBranchSchemaEdit
+    applyBranchSchemaEdit,
+    pushBranchMigrations
   },
   migrationRequests: {
     queryMigrationRequests,
@@ -674,10 +977,12 @@ const operationsByTag$2 = {
     deleteRecord,
     bulkInsertTableRecords
   },
+  files: { getFileItem, putFileItem, deleteFileItem, getFile, putFile, deleteFile, fileAccess },
   searchAndFilter: {
     queryTable,
     searchBranch,
     searchTable,
+    sqlQuery,
     vectorSearchTable,
     askTable,
     summarizeTable,
@@ -781,6 +1086,7 @@ const deleteDatabase = (variables, signal) => controlPlaneFetch({
 });
 const getDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "get", ...variables, signal });
 const updateDatabaseMetadata = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}", method: "patch", ...variables, signal });
+const renameDatabase = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/rename", method: "post", ...variables, signal });
 const getDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "get", ...variables, signal });
 const updateDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "put", ...variables, signal });
 const deleteDatabaseGithubSettings = (variables, signal) => controlPlaneFetch({ url: "/workspaces/{workspaceId}/dbs/{dbName}/github", method: "delete", ...variables, signal });
@@ -816,6 +1122,7 @@ const operationsByTag$1 = {
     deleteDatabase,
     getDatabaseMetadata,
     updateDatabaseMetadata,
+    renameDatabase,
     getDatabaseGithubSettings,
     updateDatabaseGithubSettings,
     deleteDatabaseGithubSettings,
@@ -841,6 +1148,10 @@ const providers = {
   staging: {
     main: "https://api.staging-xata.dev",
     workspaces: "https://{workspaceId}.{region}.staging-xata.dev"
+  },
+  dev: {
+    main: "https://api.dev-xata.dev",
+    workspaces: "https://{workspaceId}.{region}.dev-xata.dev"
   }
 };
 function isHostProviderAlias(alias) {
@@ -858,6 +1169,11 @@ function parseProviderString(provider = "production") {
     return null;
   return { main, workspaces };
 }
+function buildProviderString(provider) {
+  if (isHostProviderAlias(provider))
+    return provider;
+  return `${provider.main},${provider.workspaces}`;
+}
 function parseWorkspacesUrlParts(url) {
   if (!isString(url))
     return null;
@@ -962,6 +1278,11 @@ class XataApiClient {
       __privateGet$7(this, _namespaces).records = new RecordsApi(__privateGet$7(this, _extraProps));
     return __privateGet$7(this, _namespaces).records;
   }
+  get files() {
+    if (!__privateGet$7(this, _namespaces).files)
+      __privateGet$7(this, _namespaces).files = new FilesApi(__privateGet$7(this, _extraProps));
+    return __privateGet$7(this, _namespaces).files;
+  }
   get searchAndFilter() {
     if (!__privateGet$7(this, _namespaces).searchAndFilter)
       __privateGet$7(this, _namespaces).searchAndFilter = new SearchAndFilterApi(__privateGet$7(this, _extraProps));
@@ -1170,6 +1491,20 @@ class BranchApi {
       ...this.extraProps
     });
   }
+  copyBranch({
+    workspace,
+    region,
+    database,
+    branch,
+    destinationBranch,
+    limit
+  }) {
+    return operationsByTag.branch.copyBranch({
+      pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+      body: { destinationBranch, limit },
+      ...this.extraProps
+    });
+  }
   updateBranchMetadata({
     workspace,
     region,
@@ -1525,6 +1860,164 @@ class RecordsApi {
     });
   }
 }
+class FilesApi {
+  constructor(extraProps) {
+    this.extraProps = extraProps;
+  }
+  getFileItem({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column,
+    fileId
+  }) {
+    return operationsByTag.files.getFileItem({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column,
+        fileId
+      },
+      ...this.extraProps
+    });
+  }
+  putFileItem({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column,
+    fileId,
+    file
+  }) {
+    return operationsByTag.files.putFileItem({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column,
+        fileId
+      },
+      // @ts-ignore
+      body: file,
+      ...this.extraProps
+    });
+  }
+  deleteFileItem({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column,
+    fileId
+  }) {
+    return operationsByTag.files.deleteFileItem({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column,
+        fileId
+      },
+      ...this.extraProps
+    });
+  }
+  getFile({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column
+  }) {
+    return operationsByTag.files.getFile({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column
+      },
+      ...this.extraProps
+    });
+  }
+  putFile({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column,
+    file
+  }) {
+    return operationsByTag.files.putFile({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column
+      },
+      body: file,
+      ...this.extraProps
+    });
+  }
+  deleteFile({
+    workspace,
+    region,
+    database,
+    branch,
+    table,
+    record,
+    column
+  }) {
+    return operationsByTag.files.deleteFile({
+      pathParams: {
+        workspace,
+        region,
+        dbBranchName: `${database}:${branch}`,
+        tableName: table,
+        recordId: record,
+        columnName: column
+      },
+      ...this.extraProps
+    });
+  }
+  fileAccess({
+    workspace,
+    region,
+    fileId,
+    verify
+  }) {
+    return operationsByTag.files.fileAccess({
+      pathParams: {
+        workspace,
+        region,
+        fileId
+      },
+      queryParams: { verify },
+      ...this.extraProps
+    });
+  }
+}
 class SearchAndFilterApi {
   constructor(extraProps) {
     this.extraProps = extraProps;
@@ -1608,17 +2101,11 @@ class SearchAndFilterApi {
     database,
     branch,
     table,
-    question,
-    fuzziness,
-    target,
-    prefix,
-    filter,
-    boosters,
-    rules
+    options
   }) {
     return operationsByTag.searchAndFilter.askTable({
       pathParams: { workspace, region, dbBranchName: `${database}:${branch}`, tableName: table },
-      body: { question, fuzziness, target, prefix, filter, boosters, rules },
+      body: { ...options },
       ...this.extraProps
     });
   }
@@ -1886,6 +2373,19 @@ class MigrationsApi {
       ...this.extraProps
     });
   }
+  pushBranchMigrations({
+    workspace,
+    region,
+    database,
+    branch,
+    migrations
+  }) {
+    return operationsByTag.migrations.pushBranchMigrations({
+      pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+      body: { migrations },
+      ...this.extraProps
+    });
+  }
 }
 class DatabaseApi {
   constructor(extraProps) {
@@ -1937,6 +2437,17 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
+  renameDatabase({
+    workspace,
+    database,
+    newName
+  }) {
+    return operationsByTag.databases.renameDatabase({
+      pathParams: { workspaceId: workspace, dbName: database },
+      body: { newName },
+      ...this.extraProps
+    });
+  }
   getDatabaseGithubSettings({
     workspace,
     database
@@ -2016,18 +2527,46 @@ class Page {
     this.meta = meta;
     this.records = new RecordArray(this, records);
   }
+  /**
+   * Retrieves the next page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The next page or results.
+   */
   async nextPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, after: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the previous page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The previous page or results.
+   */
   async previousPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, before: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the start page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The start page or results.
+   */
   async startPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, start: this.meta.page.cursor } });
   }
+  /**
+   * Retrieves the end page of results.
+   * @param size Maximum number of results to be retrieved.
+   * @param offset Number of results to skip when retrieving the results.
+   * @returns The end page or results.
+   */
   async endPage(size, offset) {
     return __privateGet$6(this, _query).getPaginated({ pagination: { size, offset, end: this.meta.page.cursor } });
   }
+  /**
+   * Shortcut method to check if there will be additional results if the next page of results is retrieved.
+   * @returns Whether or not there will be additional results in the next page of results.
+   */
   hasNextPage() {
     return this.meta.page.more;
   }
@@ -2068,22 +2607,45 @@ const _RecordArray = class extends Array {
   map(callbackfn, thisArg) {
     return this.toArray().map(callbackfn, thisArg);
   }
+  /**
+   * Retrieve next page of records
+   *
+   * @returns A new array of objects
+   */
   async nextPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).nextPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve previous page of records
+   *
+   * @returns A new array of objects
+   */
   async previousPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).previousPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve start page of records
+   *
+   * @returns A new array of objects
+   */
   async startPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).startPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * Retrieve end page of records
+   *
+   * @returns A new array of objects
+   */
   async endPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).endPage(size, offset);
     return new _RecordArray(newPage);
   }
+  /**
+   * @returns Boolean indicating if there is a next page
+   */
   hasNextPage() {
     return __privateGet$6(this, _page).meta.page.more;
   }
@@ -2120,7 +2682,8 @@ const _Query = class {
     __privateAdd$5(this, _table$1, void 0);
     __privateAdd$5(this, _repository, void 0);
     __privateAdd$5(this, _data, { filter: {} });
-    this.meta = { page: { cursor: "start", more: true } };
+    // Implements pagination
+    this.meta = { page: { cursor: "start", more: true, size: PAGINATION_DEFAULT_SIZE } };
     this.records = new RecordArray(this, []);
     __privateSet$5(this, _table$1, table);
     if (repository) {
@@ -2157,18 +2720,38 @@ const _Query = class {
     const key = JSON.stringify({ columns, filter, sort, pagination });
     return toBase64(key);
   }
+  /**
+   * Builds a new query object representing a logical OR between the given subqueries.
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   any(...queries) {
     const $any = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $any } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical AND between the given subqueries.
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   all(...queries) {
     const $all = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   not(...queries) {
     const $not = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $not } }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
+   * @param queries An array of subqueries.
+   * @returns A new Query object.
+   */
   none(...queries) {
     const $none = queries.map((query) => query.getQueryOptions().filter ?? {});
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $none } }, __privateGet$5(this, _data));
@@ -2191,6 +2774,11 @@ const _Query = class {
     const sort = [...originalSort, { column, direction }];
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { sort }, __privateGet$5(this, _data));
   }
+  /**
+   * Builds a new query specifying the set of columns to be returned in the query response.
+   * @param columns Array of column names to be returned by the query.
+   * @returns A new Query object.
+   */
   select(columns) {
     return new _Query(
       __privateGet$5(this, _repository),
@@ -2203,6 +2791,12 @@ const _Query = class {
     const query = new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), options, __privateGet$5(this, _data));
     return __privateGet$5(this, _repository).query(query);
   }
+  /**
+   * Get results in an iterator
+   *
+   * @async
+   * @returns Async interable of results
+   */
   async *[Symbol.asyncIterator]() {
     for await (const [record] of this.getIterator({ batchSize: 1 })) {
       yield record;
@@ -2263,21 +2857,49 @@ const _Query = class {
     );
     return __privateGet$5(this, _repository).summarizeTable(query, summaries, summariesFilter);
   }
+  /**
+   * Builds a new query object adding a cache TTL in milliseconds.
+   * @param ttl The cache TTL in milliseconds.
+   * @returns A new Query object.
+   */
   cache(ttl) {
     return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { cache: ttl }, __privateGet$5(this, _data));
   }
+  /**
+   * Retrieve next page of records
+   *
+   * @returns A new page object.
+   */
   nextPage(size, offset) {
     return this.startPage(size, offset);
   }
+  /**
+   * Retrieve previous page of records
+   *
+   * @returns A new page object
+   */
   previousPage(size, offset) {
     return this.startPage(size, offset);
   }
+  /**
+   * Retrieve start page of records
+   *
+   * @returns A new page object
+   */
   startPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset } });
   }
+  /**
+   * Retrieve last page of records
+   *
+   * @returns A new page object
+   */
   endPage(size, offset) {
     return this.getPaginated({ pagination: { size, offset, before: "end" } });
   }
+  /**
+   * @returns Boolean indicating if there is a next page
+   */
   hasNextPage() {
     return this.meta.page.more;
   }
@@ -2317,7 +2939,11 @@ function isSortFilterString(value) {
   return isString(value);
 }
 function isSortFilterBase(filter) {
-  return isObject(filter) && Object.values(filter).every((value) => value === "asc" || value === "desc");
+  return isObject(filter) && Object.entries(filter).every(([key, value]) => {
+    if (key === "*")
+      return value === "random";
+    return value === "asc" || value === "desc";
+  });
 }
 function isSortFilterObject(filter) {
   return isObject(filter) && !isSortFilterBase(filter) && filter.column !== void 0;
@@ -2750,6 +3376,34 @@ class RestRepository extends Query {
       return result;
     });
   }
+  ask(question, options) {
+    const params = {
+      pathParams: {
+        workspace: "{workspaceId}",
+        dbBranchName: "{dbBranch}",
+        region: "{region}",
+        tableName: __privateGet$4(this, _table)
+      },
+      body: {
+        question,
+        ...options
+      },
+      ...__privateGet$4(this, _getFetchProps).call(this)
+    };
+    if (options?.onMessage) {
+      fetchSSERequest({
+        endpoint: "dataPlane",
+        url: "/db/{dbBranchName}/tables/{tableName}/ask",
+        method: "POST",
+        onMessage: (message) => {
+          options.onMessage?.({ answer: message.text, records: message.records });
+        },
+        ...params
+      });
+    } else {
+      return askTable(params);
+    }
+  }
 }
 _table = new WeakMap();
 _getFetchProps = new WeakMap();
@@ -2935,15 +3589,16 @@ deleteRecords_fn = async function(recordIds) {
 };
 _setCacheQuery = new WeakSet();
 setCacheQuery_fn = async function(query, meta, records) {
-  await __privateGet$4(this, _cache).set(`query_${__privateGet$4(this, _table)}:${query.key()}`, { date: new Date(), meta, records });
+  await __privateGet$4(this, _cache)?.set(`query_${__privateGet$4(this, _table)}:${query.key()}`, { date: /* @__PURE__ */ new Date(), meta, records });
 };
 _getCacheQuery = new WeakSet();
 getCacheQuery_fn = async function(query) {
   const key = `query_${__privateGet$4(this, _table)}:${query.key()}`;
-  const result = await __privateGet$4(this, _cache).get(key);
+  const result = await __privateGet$4(this, _cache)?.get(key);
   if (!result)
     return null;
-  const { cache: ttl = __privateGet$4(this, _cache).defaultQueryTTL } = query.getQueryOptions();
+  const defaultTTL = __privateGet$4(this, _cache)?.defaultQueryTTL ?? -1;
+  const { cache: ttl = defaultTTL } = query.getQueryOptions();
   if (ttl < 0)
     return null;
   const hasExpired = result.date.getTime() + ttl < Date.now();
@@ -3018,6 +3673,8 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
     }
   }
   const record = { ...data };
+  const serializable = { xata, ...transformObjectLinks(data) };
+  const metadata = xata !== void 0 ? { ...xata, createdAt: new Date(xata.createdAt), updatedAt: new Date(xata.updatedAt) } : void 0;
   record.read = function(columns2) {
     return db[table].read(record["id"], columns2);
   };
@@ -3034,16 +3691,17 @@ const initObject = (db, schemaTables, table, object, selectedColumns) => {
   record.delete = function() {
     return db[table].delete(record["id"]);
   };
+  record.xata = metadata;
   record.getMetadata = function() {
-    return xata;
+    return metadata;
   };
   record.toSerializable = function() {
-    return JSON.parse(JSON.stringify(transformObjectLinks(data)));
+    return JSON.parse(JSON.stringify(serializable));
   };
   record.toString = function() {
-    return JSON.stringify(transformObjectLinks(data));
+    return JSON.stringify(transformObjectLinks(serializable));
   };
-  for (const prop of ["read", "update", "replace", "delete", "getMetadata", "toSerializable", "toString"]) {
+  for (const prop of ["read", "update", "replace", "delete", "xata", "getMetadata", "toSerializable", "toString"]) {
     Object.defineProperty(record, prop, { enumerable: false });
   }
   Object.freeze(record);
@@ -3260,6 +3918,7 @@ search_fn = async function(query, options, pluginOptions) {
   const { tables, fuzziness, highlight, prefix, page } = options ?? {};
   const { records } = await searchBranch({
     pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", region: "{region}" },
+    // @ts-ignore https://github.com/xataio/client-ts/issues/313
     body: { tables, query, fuzziness, prefix, highlight, page },
     ...pluginOptions
   });
@@ -3325,7 +3984,8 @@ const buildClient = (plugins) => {
       __privateSet(this, _options, safeOptions);
       const pluginOptions = {
         ...__privateMethod(this, _getFetchProps, getFetchProps_fn).call(this, safeOptions),
-        cache: safeOptions.cache
+        cache: safeOptions.cache,
+        host: safeOptions.host
       };
       const db = new SchemaPlugin(schemaTables).build(pluginOptions);
       const search = new SearchPlugin(db, schemaTables).build(pluginOptions);
@@ -3336,14 +3996,7 @@ const buildClient = (plugins) => {
       for (const [key, namespace] of Object.entries(plugins ?? {})) {
         if (namespace === void 0)
           continue;
-        const result = namespace.build(pluginOptions);
-        if (result instanceof Promise) {
-          void result.then((namespace2) => {
-            this[key] = namespace2;
-          });
-        } else {
-          this[key] = result;
-        }
+        this[key] = namespace.build(pluginOptions);
       }
     }
     async getConfig() {
@@ -3361,7 +4014,6 @@ const buildClient = (plugins) => {
     }
     const fetch = getFetchImplementation(options?.fetch);
     const databaseURL = options?.databaseURL || getDatabaseURL();
-    const branch = options?.branch || getBranch() || "main";
     const apiKey = options?.apiKey || getAPIKey();
     const cache = options?.cache ?? new SimpleCache({ defaultQueryTTL: 0 });
     const trace = options?.trace ?? defaultTrace;
@@ -3374,6 +4026,26 @@ const buildClient = (plugins) => {
     if (!databaseURL) {
       throw new Error("Option databaseURL is required");
     }
+    const envBranch = getBranch();
+    const previewBranch = getPreviewBranch();
+    const branch = options?.branch || previewBranch || envBranch || "main";
+    if (!!previewBranch && branch !== previewBranch) {
+      console.warn(
+        `Ignoring preview branch ${previewBranch} because branch option was passed to the client constructor with value ${branch}`
+      );
+    } else if (!!envBranch && branch !== envBranch) {
+      console.warn(
+        `Ignoring branch ${envBranch} because branch option was passed to the client constructor with value ${branch}`
+      );
+    } else if (!!previewBranch && !!envBranch && previewBranch !== envBranch) {
+      console.warn(
+        `Ignoring preview branch ${previewBranch} and branch ${envBranch} because branch option was passed to the client constructor with value ${branch}`
+      );
+    } else if (!previewBranch && !envBranch && options?.branch === void 0) {
+      console.warn(
+        `No branch was passed to the client constructor. Using default branch ${branch}. You can set the branch with the environment variable XATA_BRANCH or by passing the branch option to the client constructor.`
+      );
+    }
     return {
       fetch,
       databaseURL,
@@ -3401,6 +4073,7 @@ const buildClient = (plugins) => {
       fetch,
       apiKey,
       apiUrl: "",
+      // Instead of using workspace and dbBranch, we inject a probably CNAME'd URL
       workspacesApiUrl: (path, params) => {
         const hasBranch = params.dbBranchName ?? params.branch;
         const newPath = path.replace(/^\/db\/[^/]+/, hasBranch !== void 0 ? `:${branch}` : "");
@@ -3505,5 +4178,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, FetcherError, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
+export { BaseClient, FetcherError, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
 //# sourceMappingURL=index.mjs.map