@xata.io/client 0.17.0 → 0.17.1

package/dist/index.mjs

@@ -2,13 +2,11 @@ const defaultTrace = async (_name, fn, _options) => {
   return await fn({
     setAttributes: () => {
       return;
-    },
-    onError: () => {
-      return;
     }
   });
 };
 const TraceAttributes = {
+  KIND: "xata.trace.kind",
   VERSION: "xata.sdk.version",
   TABLE: "xata.table",
   HTTP_REQUEST_ID: "http.request_id",
@@ -152,7 +150,7 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
-const VERSION = "0.17.0";
+const VERSION = "0.17.1";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -203,7 +201,10 @@ const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
   }, {});
   const query = new URLSearchParams(cleanQueryParams).toString();
   const queryString = query.length > 0 ? `?${query}` : "";
-  return url.replace(/\{\w*\}/g, (key) => pathParams[key.slice(1, -1)]) + queryString;
+  const cleanPathParams = Object.entries(pathParams).reduce((acc, [key, value]) => {
+    return { ...acc, [key]: encodeURIComponent(String(value ?? "")).replace("%3A", ":") };
+  }, {});
+  return url.replace(/\{\w*\}/g, (key) => cleanPathParams[key.slice(1, -1)]) + queryString;
 };
 function buildBaseUrl({
   path,
@@ -211,10 +212,10 @@ function buildBaseUrl({
   apiUrl,
   pathParams
 }) {
-  if (!pathParams?.workspace)
+  if (pathParams?.workspace === void 0)
     return `${apiUrl}${path}`;
   const url = typeof workspacesApiUrl === "string" ? `${workspacesApiUrl}${path}` : workspacesApiUrl(path, pathParams);
-  return url.replace("{workspaceId}", pathParams.workspace);
+  return url.replace("{workspaceId}", String(pathParams.workspace));
 }
 function hostHeader(url) {
   const pattern = /.*:\/\/(?<host>[^/]+).*/;
@@ -236,7 +237,7 @@ async function fetch$1({
 }) {
   return trace(
     `${method.toUpperCase()} ${path}`,
-    async ({ setAttributes, onError }) => {
+    async ({ setAttributes }) => {
       const baseUrl = buildBaseUrl({ path, workspacesApiUrl, pathParams, apiUrl });
       const fullUrl = resolveUrl(baseUrl, queryParams, pathParams);
       const url = fullUrl.includes("localhost") ? fullUrl.replace(/^[^.]+\./, "http://") : fullUrl;
@@ -261,6 +262,7 @@ async function fetch$1({
       const { host, protocol } = parseUrl(response.url);
       const requestId = response.headers?.get("x-request-id") ?? void 0;
       setAttributes({
+        [TraceAttributes.KIND]: "http",
         [TraceAttributes.HTTP_REQUEST_ID]: requestId,
         [TraceAttributes.HTTP_STATUS_CODE]: response.status,
         [TraceAttributes.HTTP_HOST]: host,
@@ -273,9 +275,7 @@ async function fetch$1({
         }
         throw new FetcherError(response.status, jsonResponse, requestId);
       } catch (error) {
-        const fetcherError = new FetcherError(response.status, error, requestId);
-        onError(fetcherError.message);
-        throw fetcherError;
+        throw new FetcherError(response.status, error, requestId);
       }
     },
     { [TraceAttributes.HTTP_METHOD]: method.toUpperCase(), [TraceAttributes.HTTP_ROUTE]: path }
@@ -394,6 +394,22 @@ const resolveBranch = (variables) => fetch$1({
   method: "get",
   ...variables
 });
+const listMigrationRequests = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations/list", method: "post", ...variables });
+const createMigrationRequest = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations", method: "post", ...variables });
+const getMigrationRequest = (variables) => fetch$1({
+  url: "/dbs/{dbName}/migrations/{mrNumber}",
+  method: "get",
+  ...variables
+});
+const updateMigrationRequest = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations/{mrNumber}", method: "patch", ...variables });
+const listMigrationRequestsCommits = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations/{mrNumber}/commits", method: "post", ...variables });
+const compareMigrationRequest = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations/{mrNumber}/compare", method: "post", ...variables });
+const getMigrationRequestIsMerged = (variables) => fetch$1({ url: "/dbs/{dbName}/migrations/{mrNumber}/merge", method: "get", ...variables });
+const mergeMigrationRequest = (variables) => fetch$1({
+  url: "/dbs/{dbName}/migrations/{mrNumber}/merge",
+  method: "post",
+  ...variables
+});
 const getBranchDetails = (variables) => fetch$1({
   url: "/db/{dbBranchName}",
   method: "get",
@@ -418,6 +434,16 @@ const getBranchMetadata = (variables) => fetch$1({
 const getBranchMigrationHistory = (variables) => fetch$1({ url: "/db/{dbBranchName}/migrations", method: "get", ...variables });
 const executeBranchMigrationPlan = (variables) => fetch$1({ url: "/db/{dbBranchName}/migrations/execute", method: "post", ...variables });
 const getBranchMigrationPlan = (variables) => fetch$1({ url: "/db/{dbBranchName}/migrations/plan", method: "post", ...variables });
+const compareBranchWithUserSchema = (variables) => fetch$1({ url: "/db/{dbBranchName}/schema/compare", method: "post", ...variables });
+const compareBranchSchemas = (variables) => fetch$1({ url: "/db/{dbBranchName}/schema/compare/{branchName}", method: "post", ...variables });
+const updateBranchSchema = (variables) => fetch$1({
+  url: "/db/{dbBranchName}/schema/update",
+  method: "post",
+  ...variables
+});
+const previewBranchSchemaEdit = (variables) => fetch$1({ url: "/db/{dbBranchName}/schema/preview", method: "post", ...variables });
+const applyBranchSchemaEdit = (variables) => fetch$1({ url: "/db/{dbBranchName}/schema/apply", method: "post", ...variables });
+const getBranchSchemaHistory = (variables) => fetch$1({ url: "/db/{dbBranchName}/schema/history", method: "post", ...variables });
 const getBranchStats = (variables) => fetch$1({
   url: "/db/{dbBranchName}/stats",
   method: "get",
@@ -537,10 +563,28 @@ const operationsByTag = {
     deleteBranch,
     updateBranchMetadata,
     getBranchMetadata,
+    getBranchStats
+  },
+  migrationRequests: {
+    listMigrationRequests,
+    createMigrationRequest,
+    getMigrationRequest,
+    updateMigrationRequest,
+    listMigrationRequestsCommits,
+    compareMigrationRequest,
+    getMigrationRequestIsMerged,
+    mergeMigrationRequest
+  },
+  branchSchema: {
     getBranchMigrationHistory,
     executeBranchMigrationPlan,
     getBranchMigrationPlan,
-    getBranchStats
+    compareBranchWithUserSchema,
+    compareBranchSchemas,
+    updateBranchSchema,
+    previewBranchSchemaEdit,
+    applyBranchSchemaEdit,
+    getBranchSchemaHistory
   },
   table: {
     createTable,
@@ -569,9 +613,9 @@ const operationsByTag = {
 };
 
 function getHostUrl(provider, type) {
-  if (isValidAlias(provider)) {
+  if (isHostProviderAlias(provider)) {
     return providers[provider][type];
-  } else if (isValidBuilder(provider)) {
+  } else if (isHostProviderBuilder(provider)) {
     return provider[type];
   }
   throw new Error("Invalid API provider");
@@ -586,10 +630,10 @@ const providers = {
     workspaces: "https://{workspaceId}.staging.xatabase.co"
   }
 };
-function isValidAlias(alias) {
+function isHostProviderAlias(alias) {
   return isString(alias) && Object.keys(providers).includes(alias);
 }
-function isValidBuilder(builder) {
+function isHostProviderBuilder(builder) {
   return isObject(builder) && isString(builder.main) && isString(builder.workspaces);
 }
 
@@ -660,6 +704,16 @@ class XataApiClient {
       __privateGet$7(this, _namespaces).records = new RecordsApi(__privateGet$7(this, _extraProps));
     return __privateGet$7(this, _namespaces).records;
   }
+  get migrationRequests() {
+    if (!__privateGet$7(this, _namespaces).migrationRequests)
+      __privateGet$7(this, _namespaces).migrationRequests = new MigrationRequestsApi(__privateGet$7(this, _extraProps));
+    return __privateGet$7(this, _namespaces).migrationRequests;
+  }
+  get branchSchema() {
+    if (!__privateGet$7(this, _namespaces).branchSchema)
+      __privateGet$7(this, _namespaces).branchSchema = new BranchSchemaApi(__privateGet$7(this, _extraProps));
+    return __privateGet$7(this, _namespaces).branchSchema;
+  }
 }
 _extraProps = new WeakMap();
 _namespaces = new WeakMap();
@@ -876,27 +930,6 @@ class BranchApi {
       ...this.extraProps
     });
   }
-  getBranchMigrationHistory(workspace, database, branch, options = {}) {
-    return operationsByTag.branch.getBranchMigrationHistory({
-      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
-      body: options,
-      ...this.extraProps
-    });
-  }
-  executeBranchMigrationPlan(workspace, database, branch, migrationPlan) {
-    return operationsByTag.branch.executeBranchMigrationPlan({
-      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
-      body: migrationPlan,
-      ...this.extraProps
-    });
-  }
-  getBranchMigrationPlan(workspace, database, branch, schema) {
-    return operationsByTag.branch.getBranchMigrationPlan({
-      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
-      body: schema,
-      ...this.extraProps
-    });
-  }
   getBranchStats(workspace, database, branch) {
     return operationsByTag.branch.getBranchStats({
       pathParams: { workspace, dbBranchName: `${database}:${branch}` },
@@ -1053,6 +1086,131 @@ class RecordsApi {
     });
   }
 }
+class MigrationRequestsApi {
+  constructor(extraProps) {
+    this.extraProps = extraProps;
+  }
+  listMigrationRequests(workspace, database, options = {}) {
+    return operationsByTag.migrationRequests.listMigrationRequests({
+      pathParams: { workspace, dbName: database },
+      body: options,
+      ...this.extraProps
+    });
+  }
+  createMigrationRequest(workspace, database, options) {
+    return operationsByTag.migrationRequests.createMigrationRequest({
+      pathParams: { workspace, dbName: database },
+      body: options,
+      ...this.extraProps
+    });
+  }
+  getMigrationRequest(workspace, database, migrationRequest) {
+    return operationsByTag.migrationRequests.getMigrationRequest({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      ...this.extraProps
+    });
+  }
+  updateMigrationRequest(workspace, database, migrationRequest, options) {
+    return operationsByTag.migrationRequests.updateMigrationRequest({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      body: options,
+      ...this.extraProps
+    });
+  }
+  listMigrationRequestsCommits(workspace, database, migrationRequest, options = {}) {
+    return operationsByTag.migrationRequests.listMigrationRequestsCommits({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      body: options,
+      ...this.extraProps
+    });
+  }
+  compareMigrationRequest(workspace, database, migrationRequest) {
+    return operationsByTag.migrationRequests.compareMigrationRequest({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      ...this.extraProps
+    });
+  }
+  getMigrationRequestIsMerged(workspace, database, migrationRequest) {
+    return operationsByTag.migrationRequests.getMigrationRequestIsMerged({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      ...this.extraProps
+    });
+  }
+  mergeMigrationRequest(workspace, database, migrationRequest) {
+    return operationsByTag.migrationRequests.mergeMigrationRequest({
+      pathParams: { workspace, dbName: database, mrNumber: migrationRequest },
+      ...this.extraProps
+    });
+  }
+}
+class BranchSchemaApi {
+  constructor(extraProps) {
+    this.extraProps = extraProps;
+  }
+  getBranchMigrationHistory(workspace, database, branch, options = {}) {
+    return operationsByTag.branchSchema.getBranchMigrationHistory({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: options,
+      ...this.extraProps
+    });
+  }
+  executeBranchMigrationPlan(workspace, database, branch, migrationPlan) {
+    return operationsByTag.branchSchema.executeBranchMigrationPlan({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: migrationPlan,
+      ...this.extraProps
+    });
+  }
+  getBranchMigrationPlan(workspace, database, branch, schema) {
+    return operationsByTag.branchSchema.getBranchMigrationPlan({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: schema,
+      ...this.extraProps
+    });
+  }
+  compareBranchWithUserSchema(workspace, database, branch, schema) {
+    return operationsByTag.branchSchema.compareBranchWithUserSchema({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: { schema },
+      ...this.extraProps
+    });
+  }
+  compareBranchSchemas(workspace, database, branch, branchName, schema) {
+    return operationsByTag.branchSchema.compareBranchSchemas({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}`, branchName },
+      body: { schema },
+      ...this.extraProps
+    });
+  }
+  updateBranchSchema(workspace, database, branch, migration) {
+    return operationsByTag.branchSchema.updateBranchSchema({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: migration,
+      ...this.extraProps
+    });
+  }
+  previewBranchSchemaEdit(workspace, database, branch, migration) {
+    return operationsByTag.branchSchema.previewBranchSchemaEdit({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: migration,
+      ...this.extraProps
+    });
+  }
+  applyBranchSchemaEdit(workspace, database, branch, edits) {
+    return operationsByTag.branchSchema.applyBranchSchemaEdit({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: { edits },
+      ...this.extraProps
+    });
+  }
+  getBranchSchemaHistory(workspace, database, branch, options = {}) {
+    return operationsByTag.branchSchema.getBranchSchemaHistory({
+      pathParams: { workspace, dbBranchName: `${database}:${branch}` },
+      body: options,
+      ...this.extraProps
+    });
+  }
+}
 
 class XataApiPlugin {
   async build(options) {
@@ -1236,14 +1394,22 @@ const _Query = class {
   }
   filter(a, b) {
     if (arguments.length === 1) {
-      const constraints = Object.entries(a).map(([column, constraint]) => ({ [column]: constraint }));
+      const constraints = Object.entries(a ?? {}).map(([column, constraint]) => ({ [column]: constraint }));
       const $all = compact([__privateGet$5(this, _data).filter?.$all].flat().concat(constraints));
       return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
     } else {
-      const $all = compact([__privateGet$5(this, _data).filter?.$all].flat().concat([{ [a]: b }]));
+      const constraints = isDefined(a) && isDefined(b) ? [{ [a]: this.defaultFilter(a, b) }] : void 0;
+      const $all = compact([__privateGet$5(this, _data).filter?.$all].flat().concat(constraints));
       return new _Query(__privateGet$5(this, _repository), __privateGet$5(this, _table$1), { filter: { $all } }, __privateGet$5(this, _data));
     }
   }
+  defaultFilter(column, value) {
+    const columnType = __privateGet$5(this, _table$1).schema?.columns.find(({ name }) => name === column)?.type;
+    if (columnType === "multiple" && (isString(value) || isStringArray(value))) {
+      return { $includes: value };
+    }
+    return value;
+  }
   sort(column, direction = "asc") {
     const originalSort = [__privateGet$5(this, _data).sort ?? []].flat();
     const sort = [...originalSort, { column, direction }];
@@ -1385,7 +1551,11 @@ class Repository extends Query {
 }
 class RestRepository extends Query {
   constructor(options) {
-    super(null, options.table, {});
+    super(
+      null,
+      { name: options.table, schema: options.schemaTables?.find((table) => table.name === options.table) },
+      {}
+    );
     __privateAdd$4(this, _insertRecordWithoutId);
     __privateAdd$4(this, _insertRecordWithId);
     __privateAdd$4(this, _bulkInsertTableRecords);
@@ -1411,6 +1581,7 @@ class RestRepository extends Query {
       return trace(name, fn, {
         ...options2,
         [TraceAttributes.TABLE]: __privateGet$4(this, _table),
+        [TraceAttributes.KIND]: "sdk-operation",
         [TraceAttributes.VERSION]: VERSION
       });
     });
@@ -1571,7 +1742,7 @@ class RestRepository extends Query {
         return new Page(query, cacheQuery.meta, cacheQuery.records);
       const data = query.getQueryOptions();
       const body = {
-        filter: Object.values(data.filter ?? {}).some(Boolean) ? data.filter : void 0,
+        filter: cleanFilter(data.filter),
         sort: data.sort !== void 0 ? buildSortFilter(data.sort) : void 0,
         page: data.pagination,
         columns: data.columns
@@ -1789,6 +1960,12 @@ function extractId(value) {
     return value.id;
   return void 0;
 }
+function cleanFilter(filter) {
+  if (!filter)
+    return void 0;
+  const values = Object.values(filter).filter(Boolean).filter((value) => Array.isArray(value) ? value.length > 0 : true);
+  return values.length > 0 ? filter : void 0;
+}
 
 var __accessCheck$3 = (obj, member, msg) => {
   if (!member.has(obj))
@@ -2161,7 +2338,7 @@ const buildClient = (plugins) => {
       apiUrl: "",
       workspacesApiUrl: (path, params) => {
         const hasBranch = params.dbBranchName ?? params.branch;
-        const newPath = path.replace(/^\/db\/[^/]+/, hasBranch ? `:${branchValue}` : "");
+        const newPath = path.replace(/^\/db\/[^/]+/, hasBranch !== void 0 ? `:${branchValue}` : "");
         return databaseURL + newPath;
       },
       trace
@@ -2276,5 +2453,5 @@ class XataError extends Error {
   }
 }
 
-export { BaseClient, 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, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
+export { BaseClient, 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, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateBranchSchema, updateColumn, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
 //# sourceMappingURL=index.mjs.map