@xata.io/client 0.0.0-alpha.fd777ef → 0.0.0-beta.09bfef8

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @xata.io/client
 
+## 0.7.0
+
+### Minor Changes
+
+- 6ce5512: Add bulk operations for all methods
+- 2a1fa4f: Introduced automatic branch resolution mechanism
+
+### Patch Changes
+
+- d033f3a: Improve column selection output type with non-nullable columns
+- b1e92db: Include stack trace with errors
+- deed570: Improve sorting with multiple properties
+- 80b5417: Improve filtering types
+
 ## 0.6.0
 
 ### Minor Changes

package/dist/api/client.d.ts

@@ -5,7 +5,7 @@ import type * as Responses from './responses';
 import type * as Schemas from './schemas';
 export interface XataApiClientOptions {
     fetch?: FetchImpl;
-    apiKey: string;
+    apiKey?: string;
     host?: HostProvider;
 }
 export declare class XataApiClient {

package/dist/api/client.js

@@ -13,24 +13,24 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _XataApiClient_extraProps;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XataApiClient = void 0;
+const config_1 = require("../schema/config");
+const fetch_1 = require("../util/fetch");
 const components_1 = require("./components");
 const providers_1 = require("./providers");
 class XataApiClient {
     constructor(options) {
         var _a, _b;
         _XataApiClient_extraProps.set(this, void 0);
-        const globalFetch = typeof fetch !== 'undefined' ? fetch : undefined;
-        const fetchImpl = (_a = options.fetch) !== null && _a !== void 0 ? _a : globalFetch;
-        if (!fetchImpl) {
-            /** @todo add a link after docs exist */
-            throw new Error(`The \`fetch\` option passed to the Xata client is resolving to a falsy value and may not be correctly imported.`);
+        const provider = (_a = options.host) !== null && _a !== void 0 ? _a : 'production';
+        const apiKey = (_b = options === null || options === void 0 ? void 0 : options.apiKey) !== null && _b !== void 0 ? _b : (0, config_1.getAPIKey)();
+        if (!apiKey) {
+            throw new Error('Could not resolve a valid apiKey');
         }
-        const provider = (_b = options.host) !== null && _b !== void 0 ? _b : 'production';
         __classPrivateFieldSet(this, _XataApiClient_extraProps, {
             apiUrl: (0, providers_1.getHostUrl)(provider, 'main'),
             workspacesApiUrl: (0, providers_1.getHostUrl)(provider, 'workspaces'),
-            fetchImpl,
-            apiKey: options.apiKey
+            fetchImpl: (0, fetch_1.getFetchImplementation)(options.fetch),
+            apiKey
         }, "f");
     }
     get user() {

package/dist/api/fetcher.d.ts

@@ -23,3 +23,18 @@ export declare type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> =
     pathParams?: TPathParams;
 };
 export declare function fetch<TData, TBody extends Record<string, unknown> | undefined, THeaders extends Record<string, unknown>, TQueryParams extends Record<string, unknown>, TPathParams extends Record<string, string>>({ url: path, method, body, headers, pathParams, queryParams, fetchImpl, apiKey, apiUrl, workspacesApiUrl }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> & FetcherExtraProps): Promise<TData>;
+export declare class FetcherError extends Error {
+    status: number;
+    errors: Array<{
+        status: number;
+        message?: string;
+    }> | undefined;
+    constructor(data: {
+        message: string;
+        status: number;
+        errors?: Array<{
+            status: number;
+            message?: string;
+        }>;
+    }, parent?: Error);
+}

package/dist/api/fetcher.js

@@ -9,9 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetch = void 0;
-/* eslint-disable @typescript-eslint/no-throw-literal */
-/* eslint-disable @typescript-eslint/ban-types */
+exports.FetcherError = exports.fetch = void 0;
 const lang_1 = require("../util/lang");
 const resolveUrl = (url, queryParams = {}, pathParams = {}) => {
     const query = new URLSearchParams(queryParams).toString();
@@ -54,20 +52,28 @@ function fetch({ url: path, method, body, headers, pathParams, queryParams, fetc
                 return jsonResponse;
             }
             const { message = 'Unknown error', errors } = jsonResponse;
-            throw withStatus({ message, errors }, response.status);
+            throw new FetcherError({ message, status: response.status, errors });
         }
-        catch (e) {
-            if (isError(e)) {
-                throw withStatus(e, response.status);
-            }
-            else {
-                throw withStatus({ message: 'Network response was not ok' }, response.status);
-            }
+        catch (error) {
+            const message = hasMessage(error) ? error.message : 'Unknown network error';
+            const parent = error instanceof Error ? error : undefined;
+            throw new FetcherError({ message, status: response.status }, parent);
         }
     });
 }
 exports.fetch = fetch;
-const isError = (error) => {
+const hasMessage = (error) => {
     return (0, lang_1.isObject)(error) && (0, lang_1.isString)(error.message);
 };
-const withStatus = (error, status) => (0, lang_1.compactObject)(Object.assign(Object.assign({}, error), { status }));
+class FetcherError extends Error {
+    constructor(data, parent) {
+        super(data.message);
+        this.status = data.status;
+        this.errors = data.errors;
+        if (parent) {
+            this.stack = parent.stack;
+            this.cause = parent.cause;
+        }
+    }
+}
+exports.FetcherError = FetcherError;

package/dist/schema/config.d.ts

@@ -0,0 +1,4 @@
+import { FetcherExtraProps } from '../api/fetcher';
+export declare function getBranch(fetchProps: Omit<FetcherExtraProps, 'workspacesApiUrl'>): Promise<string | undefined>;
+export declare function getDatabaseUrl(): string | undefined;
+export declare function getAPIKey(): string | undefined;

package/dist/schema/config.js

@@ -0,0 +1,83 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAPIKey = exports.getDatabaseUrl = exports.getBranch = void 0;
+const api_1 = require("../api");
+const environment_1 = require("../util/environment");
+const lang_1 = require("../util/lang");
+const envBranchNames = [
+    'XATA_BRANCH',
+    'VERCEL_GIT_COMMIT_REF',
+    'CF_PAGES_BRANCH',
+    'BRANCH' // Netlify. Putting it the last one because it is more ambiguous
+];
+function getBranch(fetchProps) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const env = getBranchByEnvVariable();
+        if (env)
+            return env;
+        const branch = yield (0, environment_1.getGitBranch)();
+        if (!branch)
+            return undefined;
+        // TODO: in the future, call /resolve endpoint
+        // For now, call API to see if the branch exists. If not, use a default value.
+        const [protocol, , host, , database] = fetchProps.apiUrl.split('/');
+        const [workspace] = host.split('.');
+        const dbBranchName = `${database}:${branch}`;
+        try {
+            yield (0, api_1.getBranchDetails)(Object.assign(Object.assign({}, fetchProps), { workspacesApiUrl: `${protocol}//${host}`, pathParams: {
+                    dbBranchName,
+                    workspace
+                } }));
+        }
+        catch (err) {
+            if ((0, lang_1.isObject)(err) && err.status === 404)
+                return 'main';
+            throw err;
+        }
+        return branch;
+    });
+}
+exports.getBranch = getBranch;
+function getBranchByEnvVariable() {
+    for (const name of envBranchNames) {
+        const value = (0, environment_1.getEnvVariable)(name);
+        if (value) {
+            return value;
+        }
+    }
+    try {
+        return XATA_BRANCH;
+    }
+    catch (err) {
+        // Ignore ReferenceError. Only CloudFlare workers set env variables as global variables
+    }
+}
+function getDatabaseUrl() {
+    var _a;
+    try {
+        return (_a = (0, environment_1.getEnvVariable)('XATA_DATABASE_URL')) !== null && _a !== void 0 ? _a : XATA_DATABASE_URL;
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.getDatabaseUrl = getDatabaseUrl;
+function getAPIKey() {
+    var _a;
+    try {
+        return (_a = (0, environment_1.getEnvVariable)('XATA_API_KEY')) !== null && _a !== void 0 ? _a : XATA_API_KEY;
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.getAPIKey = getAPIKey;

package/dist/schema/filters.d.ts

@@ -19,9 +19,9 @@ import { SelectableColumn, ValueAtColumn } from './selection';
 }
 */
 declare type PropertyAccessFilter<Record> = {
-    [key in SelectableColumn<Record>]?: Partial<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
+    [key in SelectableColumn<Record>]?: NestedApiFilter<ValueAtColumn<Record, key>> | PropertyFilter<ValueAtColumn<Record, key>>;
 };
-declare type PropertyFilter<T> = T | {
+export declare type PropertyFilter<T> = T | {
     $is: T;
 } | {
     $isNot: T;
@@ -35,17 +35,21 @@ declare type IncludesFilter<T> = PropertyFilter<T> | {
         $not: IncludesFilter<T>;
     }>;
 };
-declare type ValueTypeFilters<T> = T | T extends string ? {
+export declare type StringTypeFilter = {
     [key in '$contains' | '$pattern' | '$startsWith' | '$endsWith']?: string;
-} : T extends number ? {
-    [key in '$gt' | '$lt' | '$ge' | '$le']?: number;
-} : T extends Array<infer T> ? {
+};
+export declare type ComparableType = number | Date;
+export declare type ComparableTypeFilter<T extends ComparableType> = {
+    [key in '$gt' | '$lt' | '$ge' | '$le']?: T;
+};
+export declare type ArrayFilter<T> = {
     [key in '$includes']?: SingleOrArray<PropertyFilter<T> | ValueTypeFilters<T>> | IncludesFilter<T>;
 } | {
     [key in '$includesAll' | '$includesNone' | '$includesAny']?: T | Array<PropertyFilter<T> | {
         $not: PropertyFilter<T>;
     }>;
-} : never;
+};
+declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T extends number ? ComparableTypeFilter<number> : T extends Date ? ComparableTypeFilter<Date> : T extends Array<infer T> ? ArrayFilter<T> : never;
 /**
  * AggregatorFilter
  * Example:
@@ -70,13 +74,13 @@ declare type ValueTypeFilters<T> = T | T extends string ? {
 }
 */
 declare type AggregatorFilter<Record> = {
-    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<FilterObject<Record>>;
+    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<Record>>;
 };
 /**
  * Existance filter
  * Example: { filter: { $exists: "settings" } }
  */
-declare type ExistanceFilter<Record> = {
+export declare type ExistanceFilter<Record> = {
     [key in '$exists' | '$notExists']?: SelectableColumn<Record>;
 };
 declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFilter<Record> | ExistanceFilter<Record>;
@@ -86,7 +90,7 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
  * Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
  */
 declare type NestedApiFilter<T> = T extends Record<string, any> ? {
-    [key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<FilterObject<T[key]>> : T[key];
-} : T;
-export declare type FilterObject<Record> = BaseApiFilter<Record> | NestedApiFilter<Record>;
+    [key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
+} : PropertyFilter<T>;
+export declare type Filter<Record> = BaseApiFilter<Record> | NestedApiFilter<Record>;
 export {};

package/dist/schema/operators.d.ts

@@ -1,72 +1,62 @@
-declare type Constraint<T> = any;
-declare type ComparableType = number | Date;
+import { ArrayFilter, ComparableType, ComparableTypeFilter, ExistanceFilter, PropertyFilter, StringTypeFilter } from './filters';
+import { SelectableColumn } from './selection';
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
-export declare const gt: <T extends ComparableType>(value: T) => any;
+export declare const gt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const ge: <T extends ComparableType>(value: T) => any;
+export declare const ge: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const gte: <T extends ComparableType>(value: T) => any;
+export declare const gte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than the given value.
  */
-export declare const lt: <T extends ComparableType>(value: T) => any;
+export declare const lt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const lte: <T extends ComparableType>(value: T) => any;
+export declare const lte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const le: <T extends ComparableType>(value: T) => any;
+export declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are not null.
  */
-export declare const exists: (column: string) => Constraint<string>;
+export declare const exists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that are null.
  */
-export declare const notExists: (column: string) => Constraint<string>;
+export declare const notExists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that start with the given prefix.
  */
-export declare const startsWith: (value: string) => Constraint<string>;
+export declare const startsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that end with the given suffix.
  */
-export declare const endsWith: (value: string) => Constraint<string>;
+export declare const endsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that match the given pattern.
  */
-export declare const pattern: (value: string) => Constraint<string>;
+export declare const pattern: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that are equal to the given value.
  */
-export declare const is: <T>(value: T) => any;
+export declare const is: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that are not equal to the given value.
  */
-export declare const isNot: <T>(value: T) => any;
+export declare const isNot: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that contain the given value.
  */
-export declare const contains: <T>(value: T) => any;
+export declare const contains: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only arrays that include the given value.
  */
-export declare const includes: (value: string) => Constraint<string>;
-/**
- * Operator to restrict results to only arrays that include a value matching the given substring.
- */
-export declare const includesSubstring: (value: string) => Constraint<string>;
-/**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
- */
-export declare const includesPattern: (value: string) => Constraint<string>;
-export declare const includesAll: (value: string) => Constraint<string>;
-export {};
+export declare const includes: <T>(value: T) => ArrayFilter<T>;

package/dist/schema/operators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
+exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
@@ -71,21 +71,8 @@ exports.isNot = isNot;
  */
 const contains = (value) => ({ $contains: value });
 exports.contains = contains;
-// TODO: these can only be applied to columns of type "multiple"
 /**
  * Operator to restrict results to only arrays that include the given value.
  */
 const includes = (value) => ({ $includes: value });
 exports.includes = includes;
-/**
- * Operator to restrict results to only arrays that include a value matching the given substring.
- */
-const includesSubstring = (value) => ({ $includesSubstring: value });
-exports.includesSubstring = includesSubstring;
-/**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
- */
-const includesPattern = (value) => ({ $includesPattern: value });
-exports.includesPattern = includesPattern;
-const includesAll = (value) => ({ $includesAll: value });
-exports.includesAll = includesAll;

package/dist/schema/query.d.ts

@@ -1,6 +1,6 @@
 import { FilterExpression } from '../api/schemas';
 import { NonEmptyArray, RequiredBy } from '../util/types';
-import { FilterObject } from './filters';
+import { Filter } from './filters';
 import { Page, Paginable, PaginationOptions, PaginationQueryMeta } from './pagination';
 import { XataRecord } from './record';
 import { Repository } from './repository';
@@ -63,8 +63,8 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord
      *
      * @returns A new Query object.
      */
-    filter(filters: FilterObject<Record>): Query<Record, Result>;
-    filter<F extends SelectableColumn<Record>>(column: F, value: FilterObject<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    filter(filters: Filter<Record>): Query<Record, Result>;
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.

package/dist/schema/repository.d.ts

@@ -21,20 +21,39 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @param objects Array of objects with the column names and the values to be stored in the table.
      * @returns Array of the persisted records.
      */
-    abstract createMany(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    abstract create(objects: Array<EditableData<Data> & Partial<Identifiable>>): Promise<SelectedPick<Record, ['*']>[]>;
     /**
      * Queries a single record from the table given its unique id.
      * @param id The unique id.
      * @returns The persisted record for the given id or null if the record could not be found.
      */
     abstract read(id: string): Promise<SelectedPick<Record, ['*']> | null>;
+    /**
+     * Partially update a single record.
+     * @param object An object with its id and the columns to be updated.
+     * @returns The full persisted record.
+     */
+    abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     /**
      * Partially update a single record given its unique id.
      * @param id The unique id.
-     * @param object The column names and their values that have to be updatd.
+     * @param object The column names and their values that have to be updated.
      * @returns The full persisted record.
      */
     abstract update(id: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Partially updates multiple records.
+     * @param objects An array of objects with their ids and columns to be updated.
+     * @returns Array of the persisted records.
+     */
+    abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param object Object containing the column names with their values to be persisted in the table.
+     * @returns The full persisted record.
+     */
+    abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     /**
      * Creates or updates a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
@@ -43,12 +62,37 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @returns The full persisted record.
      */
     abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    /**
+     * Creates or updates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param objects Array of objects with the column names and the values to be stored in the table.
+     * @returns Array of the persisted records.
+     */
+    abstract createOrUpdate(objects: Array<EditableData<Data> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
     /**
      * Deletes a record given its unique id.
      * @param id The unique id.
      * @throws If the record could not be found or there was an error while performing the deletion.
      */
-    abstract delete(id: string): void;
+    abstract delete(id: string): Promise<void>;
+    /**
+     * Deletes a record given its unique id.
+     * @param id An object with a unique id.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(id: Identifiable): Promise<void>;
+    /**
+     * Deletes a record given a list of unique ids.
+     * @param ids The array of unique ids.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(ids: string[]): Promise<void>;
+    /**
+     * Deletes a record given a list of unique ids.
+     * @param ids An array of objects with unique ids.
+     * @throws If the record could not be found or there was an error while performing the deletion.
+     */
+    abstract delete(ids: Identifiable[]): Promise<void>;
     abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
 export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
@@ -56,11 +100,15 @@ export declare class RestRepository<Data extends BaseData, Record extends XataRe
     constructor(client: BaseClient<any>, table: string);
     create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
-    createMany(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
+    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, ['*']>[]>;
+    createOrUpdate(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
-    delete(recordId: string): Promise<void>;
+    createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
+    delete(recordId: string | Identifiable | Array<string | Identifiable>): Promise<void>;
     query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
 interface RepositoryFactory {
@@ -82,18 +130,18 @@ export declare type XataClientOptions = {
      */
     fetch?: FetchImpl;
     databaseURL?: string;
-    branch: BranchStrategyOption;
+    branch?: BranchStrategyOption;
     /**
      * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
      */
-    apiKey: string;
+    apiKey?: string;
     repositoryFactory?: RepositoryFactory;
 };
 export declare class BaseClient<D extends Record<string, Repository<any>> = Record<string, Repository<any>>> {
     #private;
     options: XataClientOptions;
     db: D;
-    constructor(options: XataClientOptions, links?: Links);
+    constructor(options?: XataClientOptions, links?: Links);
     initObject<T>(table: string, object: object): T;
     getBranch(): Promise<string>;
 }