@xata.io/client 0.13.0 → 0.13.1

package/dist/index.d.ts

@@ -2798,7 +2798,7 @@ declare class DatabaseApi {
     getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
     addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
     removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
-    resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<ResolveBranchResponse>;
+    resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
 }
 declare class BranchApi {
     private extraProps;
@@ -2873,7 +2873,7 @@ declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? V
 declare type MAX_RECURSION = 5;
 declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
     [K in DataProps<O>]: If<IsArray<RemoveNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
-    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
+    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : RemoveNullable<O[K]> extends Date ? K : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
     K>>;
 }>, never>;
 declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
@@ -2950,9 +2950,9 @@ declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>
 declare type EditableData<O extends BaseData> = {
     [K in keyof O]: O[K] extends XataRecord ? {
         id: string;
-    } : NonNullable<O[K]> extends XataRecord ? {
+    } | string : NonNullable<O[K]> extends XataRecord ? {
         id: string;
-    } | null | undefined : O[K];
+    } | string | null | undefined : O[K];
 };
 
 /**
@@ -3440,6 +3440,18 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
      * @returns The persisted records for the given ids (if a record could not be found it is not returned).
      */
     abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
+    /**
+     * Queries a single record from the table by the id in the object.
+     * @param object Object containing the id of the record.
+     * @returns The persisted record for the given id or null if the record could not be found.
+     */
+    abstract read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
+    /**
+     * Queries multiple records from the table by the ids in the objects.
+     * @param objects Array of objects containing the ids of the records.
+     * @returns The persisted records for the given ids (if a record could not be found it is not returned).
+     */
+    abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     /**
      * Partially update a single record.
      * @param object An object with its id and the columns to be updated.
@@ -3531,6 +3543,8 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
     create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
     read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
+    read(object: Identifiable): Promise<SelectedPick<Record, ['*']> | null>;
+    read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
     update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;

package/dist/index.mjs

@@ -73,6 +73,8 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
+const VERSION = "0.13.1";
+
 class ErrorWithCause extends Error {
   constructor(message, options) {
     super(message, options);
@@ -110,7 +112,12 @@ function getMessage(data) {
 }
 
 const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
-  const query = new URLSearchParams(queryParams).toString();
+  const cleanQueryParams = Object.entries(queryParams).reduce((acc, [key, value]) => {
+    if (value === void 0 || value === null)
+      return acc;
+    return { ...acc, [key]: value };
+  }, {});
+  const query = new URLSearchParams(cleanQueryParams).toString();
   const queryString = query.length > 0 ? `?${query}` : "";
   return url.replace(/\{\w*\}/g, (key) => pathParams[key.slice(1, -1)]) + queryString;
 };
@@ -150,6 +157,7 @@ async function fetch$1({
     body: body ? JSON.stringify(body) : void 0,
     headers: {
       "Content-Type": "application/json",
+      "User-Agent": `Xata client-ts/${VERSION}`,
       ...headers,
       ...hostHeader(fullUrl),
       Authorization: `Bearer ${apiKey}`
@@ -689,10 +697,10 @@ class DatabaseApi {
       ...this.extraProps
     });
   }
-  resolveBranch(workspace, dbName, gitBranch) {
+  resolveBranch(workspace, dbName, gitBranch, fallbackBranch) {
     return operationsByTag.database.resolveBranch({
       pathParams: { workspace, dbName },
-      queryParams: { gitBranch },
+      queryParams: { gitBranch, fallbackBranch },
       ...this.extraProps
     });
   }
@@ -1250,9 +1258,29 @@ class RestRepository extends Query {
     if (Array.isArray(a)) {
       if (a.length === 0)
         return [];
-      const records = await __privateMethod$2(this, _bulkInsertTableRecords, bulkInsertTableRecords_fn).call(this, a);
-      await Promise.all(records.map((record) => __privateMethod$2(this, _setCacheRecord, setCacheRecord_fn).call(this, record)));
-      return records;
+      const [itemsWithoutIds, itemsWithIds, order] = a.reduce(([accWithoutIds, accWithIds, accOrder], item) => {
+        const condition = isString(item.id);
+        accOrder.push(condition);
+        if (condition) {
+          accWithIds.push(item);
+        } else {
+          accWithoutIds.push(item);
+        }
+        return [accWithoutIds, accWithIds, accOrder];
+      }, [[], [], []]);
+      const recordsWithoutId = await __privateMethod$2(this, _bulkInsertTableRecords, bulkInsertTableRecords_fn).call(this, itemsWithoutIds);
+      await Promise.all(recordsWithoutId.map((record) => __privateMethod$2(this, _setCacheRecord, setCacheRecord_fn).call(this, record)));
+      if (itemsWithIds.length > 100) {
+        console.warn("Bulk create operation with id is not optimized in the Xata API yet, this request might be slow");
+      }
+      const recordsWithId = await Promise.all(itemsWithIds.map((object) => this.create(object)));
+      return order.map((condition) => {
+        if (condition) {
+          return recordsWithId.shift();
+        } else {
+          return recordsWithoutId.shift();
+        }
+      }).filter((record) => !!record);
     }
     if (isString(a) && isObject(b)) {
       if (a === "")
@@ -1279,16 +1307,18 @@ class RestRepository extends Query {
     if (Array.isArray(a)) {
       if (a.length === 0)
         return [];
-      return this.getAll({ filter: { id: { $any: a } } });
+      const ids = a.map((item) => isString(item) ? item : item.id).filter((id2) => isString(id2));
+      return this.getAll({ filter: { id: { $any: ids } } });
     }
-    if (isString(a)) {
-      const cacheRecord = await __privateMethod$2(this, _getCacheRecord, getCacheRecord_fn).call(this, a);
+    const id = isString(a) ? a : a.id;
+    if (isString(id)) {
+      const cacheRecord = await __privateMethod$2(this, _getCacheRecord, getCacheRecord_fn).call(this, id);
       if (cacheRecord)
         return cacheRecord;
       const fetchProps = await __privateGet$4(this, _getFetchProps).call(this);
       try {
         const response = await getRecord({
-          pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table), recordId: a },
+          pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", tableName: __privateGet$4(this, _table), recordId: id },
           ...fetchProps
         });
         const schema = await __privateMethod$2(this, _getSchema$1, getSchema_fn$1).call(this);
@@ -1460,7 +1490,7 @@ bulkInsertTableRecords_fn = async function(objects) {
     body: { records },
     ...fetchProps
   });
-  const finalObjects = await this.any(...response.recordIDs.map((id) => this.filter("id", id))).getAll();
+  const finalObjects = await this.read(response.recordIDs);
   if (finalObjects.length !== objects.length) {
     throw new Error("The server failed to save some records");
   }
@@ -1864,10 +1894,7 @@ async function getDatabaseBranch(branch, options) {
       apiUrl: databaseURL,
       fetchImpl: getFetchImplementation(options?.fetchImpl),
       workspacesApiUrl: `${protocol}//${host}`,
-      pathParams: {
-        dbBranchName,
-        workspace
-      }
+      pathParams: { dbBranchName, workspace }
     });
   } catch (err) {
     if (isObject(err) && err.status === 404)