@xata.io/client 0.23.1 → 0.23.2

package/.turbo/turbo-add-version.log

@@ -1,4 +1,4 @@
 
-> @xata.io/client@0.23.1 add-version /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.23.2 add-version /home/runner/work/client-ts/client-ts/packages/client
 > node ../../scripts/add-version-file.mjs
 

package/.turbo/turbo-build.log

@@ -1,13 +1,13 @@
 
-> @xata.io/client@0.23.1 build /home/runner/work/client-ts/client-ts/packages/client
+> @xata.io/client@0.23.2 build /home/runner/work/client-ts/client-ts/packages/client
 > rimraf dist && rollup -c
 
 
 src/index.ts → dist/index.cjs...
-created dist/index.cjs in 1.2s
+created dist/index.cjs in 1s
 
 src/index.ts → dist/index.mjs...
-created dist/index.mjs in 865ms
+created dist/index.mjs in 851ms
 
 src/index.ts → dist/index.d.ts...
-created dist/index.d.ts in 5.6s
+created dist/index.d.ts in 5.7s

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @xata.io/client
 
+## 0.23.2
+
+### Patch Changes
+
+- [#939](https://github.com/xataio/client-ts/pull/939) [`c477c177`](https://github.com/xataio/client-ts/commit/c477c17795c01cbf945be413217944a5a38655a5) Thanks [@SferaDev](https://github.com/SferaDev)! - Add deploy preview branch env variable loading
+
+- [#945](https://github.com/xataio/client-ts/pull/945) [`ecdc6553`](https://github.com/xataio/client-ts/commit/ecdc6553d4628289e88953ab6296b80f60e8f757) Thanks [@xata-bot](https://github.com/xata-bot)! - Add new types
+
 ## 0.23.1
 
 ### Patch Changes

package/dist/index.cjs

@@ -93,7 +93,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
+        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) {
@@ -104,7 +107,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")
+        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,7 +119,10 @@ function getEnvironment() {
     apiKey: getGlobalApiKey(),
     databaseURL: getGlobalDatabaseURL(),
     branch: getGlobalBranch(),
-    envBranch: void 0
+    deployPreview: void 0,
+    deployPreviewBranch: void 0,
+    vercelGitCommitRef: void 0,
+    vercelGitRepoOwner: void 0
   };
 }
 function getEnableBrowserVariable() {
@@ -174,8 +183,30 @@ function getAPIKey() {
 }
 function getBranch() {
   try {
-    const { branch, envBranch } = getEnvironment();
-    return branch ?? envBranch;
+    const { branch } = getEnvironment();
+    return branch ?? "main";
+  } catch (err) {
+    return void 0;
+  }
+}
+function buildPreviewBranchName({ org, branch }) {
+  return `preview-${org}-${branch}`;
+}
+function getPreviewBranch() {
+  try {
+    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;
   }
@@ -461,7 +492,7 @@ function defaultOnOpen(response) {
   }
 }
 
-const VERSION = "0.23.1";
+const VERSION = "0.23.2";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -3640,7 +3671,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;
@@ -3653,6 +3683,28 @@ 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.`
+      );
+    } else {
+      console.log(`Using branch ${branch}`);
+    }
     return {
       fetch,
       databaseURL,
@@ -3812,6 +3864,7 @@ exports.applyBranchSchemaEdit = applyBranchSchemaEdit;
 exports.askTable = askTable;
 exports.branchTransaction = branchTransaction;
 exports.buildClient = buildClient;
+exports.buildPreviewBranchName = buildPreviewBranchName;
 exports.buildProviderString = buildProviderString;
 exports.buildWorkerRunner = buildWorkerRunner;
 exports.bulkInsertTableRecords = bulkInsertTableRecords;
@@ -3860,6 +3913,7 @@ exports.getGitBranchesMapping = getGitBranchesMapping;
 exports.getHostUrl = getHostUrl;
 exports.getMigrationRequest = getMigrationRequest;
 exports.getMigrationRequestIsMerged = getMigrationRequestIsMerged;
+exports.getPreviewBranch = getPreviewBranch;
 exports.getRecord = getRecord;
 exports.getTableColumns = getTableColumns;
 exports.getTableSchema = getTableSchema;