@xata.io/client 0.13.0 → 0.13.3

package/dist/index.d.ts

@@ -6,6 +6,9 @@ declare type FetchImpl = (url: string, init?: {
     ok: boolean;
     status: number;
     json(): Promise<any>;
+    headers?: {
+        get(name: string): string | null;
+    };
 }>;
 declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
 declare type FetcherExtraProps = {
@@ -2798,7 +2801,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;
@@ -2867,25 +2870,24 @@ declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id'
 declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
     [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
 }>>;
-declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<RemoveNullable<O[K]> extends Record<string, any> ? V extends SelectableColumn<RemoveNullable<O[K]>> ? {
-    V: ValueAtColumn<RemoveNullable<O[K]>, V>;
-} : never : O[K]> : never : never;
+declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
+    V: ValueAtColumn<Item, V>;
+} : never : O[K] : never> : never : never;
 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
-    K>>;
+    [K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
+    If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
+    K>> : never;
 }>, never>;
 declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
 declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
-    [K in N]: M extends SelectableColumn<RemoveNullable<O[K]>> ? RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M>> : unknown;
+    [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
 } : unknown : Key extends DataProps<O> ? {
-    [K in Key]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<RemoveNullable<O[K]>, ['*']>> : O[K];
+    [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
 } : Key extends '*' ? {
-    [K in StringKeys<O>]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<RemoveNullable<O[K]>>> : O[K];
+    [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
 } : unknown;
-declare type RemoveNullable<T> = T extends null | undefined ? never : T;
-declare type ForwardNullable<T, R> = T extends RemoveNullable<T> ? R : R | null;
+declare type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
 
 /**
  * Represents an identifiable record from the database.
@@ -2950,9 +2952,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];
 };
 
 /**
@@ -3380,6 +3382,7 @@ declare function isCursorPaginationOptions(options: Record<string, unknown> | un
 declare class RecordArray<Result extends XataRecord> extends Array<Result> {
     #private;
     constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
+    static parseConstructorParams(...args: any[]): any[];
     /**
      * Retrieve next page of records
      *
@@ -3440,6 +3443,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 +3546,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

@@ -17,7 +17,8 @@ function toBase64(value) {
   try {
     return btoa(value);
   } catch (err) {
-    return Buffer.from(value).toString("base64");
+    const buf = Buffer;
+    return buf.from(value).toString("base64");
   }
 }
 
@@ -73,21 +74,28 @@ function getFetchImplementation(userFetch) {
   return fetchImpl;
 }
 
+const VERSION = "0.13.3";
+
 class ErrorWithCause extends Error {
   constructor(message, options) {
     super(message, options);
   }
 }
 class FetcherError extends ErrorWithCause {
-  constructor(status, data) {
+  constructor(status, data, requestId) {
     super(getMessage(data));
     this.status = status;
     this.errors = isBulkError(data) ? data.errors : void 0;
+    this.requestId = requestId;
     if (data instanceof Error) {
       this.stack = data.stack;
       this.cause = data.cause;
     }
   }
+  toString() {
+    const error = super.toString();
+    return `[${this.status}] (${this.requestId ?? "Unknown"}): ${error}`;
+  }
 }
 function isBulkError(error) {
   return isObject(error) && Array.isArray(error.errors);
@@ -110,7 +118,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 +163,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}`
@@ -158,14 +172,15 @@ async function fetch$1({
   if (response.status === 204) {
     return {};
   }
+  const requestId = response.headers?.get("x-request-id") ?? void 0;
   try {
     const jsonResponse = await response.json();
     if (response.ok) {
       return jsonResponse;
     }
-    throw new FetcherError(response.status, jsonResponse);
+    throw new FetcherError(response.status, jsonResponse, requestId);
   } catch (error) {
-    throw new FetcherError(response.status, error);
+    throw new FetcherError(response.status, error, requestId);
   }
 }
 
@@ -689,10 +704,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
     });
   }
@@ -976,10 +991,20 @@ function isCursorPaginationOptions(options) {
 }
 const _RecordArray = class extends Array {
   constructor(page, overrideRecords) {
-    super(...overrideRecords ?? page.records);
+    super(..._RecordArray.parseConstructorParams(page, overrideRecords));
     __privateAdd$6(this, _page, void 0);
     __privateSet$5(this, _page, page);
   }
+  static parseConstructorParams(...args) {
+    if (args.length === 1 && typeof args[0] === "number") {
+      return new Array(args[0]);
+    }
+    if (args.length <= 2 && isObject(args[0]?.meta) && Array.isArray(args[1] ?? [])) {
+      const result = args[1] ?? args[0].records ?? [];
+      return new Array(...result);
+    }
+    return new Array(...args);
+  }
   async nextPage(size, offset) {
     const newPage = await __privateGet$6(this, _page).nextPage(size, offset);
     return new _RecordArray(newPage);
@@ -1250,9 +1275,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 +1324,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 +1507,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 +1911,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)