@xata.io/client 0.0.0-beta.4e4e7fc → 0.0.0-beta.50e1cc9

package/dist/api/client.d.ts

@@ -40,6 +40,8 @@ declare class WorkspaceApi {
     updateWorkspaceMemberRole(workspaceId: Schemas.WorkspaceID, userId: Schemas.UserID, role: Schemas.Role): Promise<void>;
     removeWorkspaceMember(workspaceId: Schemas.WorkspaceID, userId: Schemas.UserID): Promise<void>;
     inviteWorkspaceMember(workspaceId: Schemas.WorkspaceID, email: string, role: Schemas.Role): Promise<Schemas.WorkspaceInvite>;
+    cancelWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteId: Schemas.InviteID): Promise<void>;
+    resendWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteId: Schemas.InviteID): Promise<void>;
     acceptWorkspaceMemberInvite(workspaceId: Schemas.WorkspaceID, inviteKey: Schemas.InviteKey): Promise<void>;
 }
 declare class DatabaseApi {

package/dist/api/client.js

@@ -107,6 +107,12 @@ class WorkspaceApi {
     inviteWorkspaceMember(workspaceId, email, role) {
         return components_1.operationsByTag.workspaces.inviteWorkspaceMember(Object.assign({ pathParams: { workspaceId }, body: { email, role } }, this.extraProps));
     }
+    cancelWorkspaceMemberInvite(workspaceId, inviteId) {
+        return components_1.operationsByTag.workspaces.cancelWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteId } }, this.extraProps));
+    }
+    resendWorkspaceMemberInvite(workspaceId, inviteId) {
+        return components_1.operationsByTag.workspaces.resendWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteId } }, this.extraProps));
+    }
     acceptWorkspaceMemberInvite(workspaceId, inviteKey) {
         return components_1.operationsByTag.workspaces.acceptWorkspaceMemberInvite(Object.assign({ pathParams: { workspaceId, inviteKey } }, this.extraProps));
     }

package/dist/api/components.d.ts

@@ -161,6 +161,28 @@ export declare type InviteWorkspaceMemberVariables = {
  * Invite some user to join the workspace with the given role
  */
 export declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<Schemas.WorkspaceInvite>;
+export declare type CancelWorkspaceMemberInvitePathParams = {
+    workspaceId: Schemas.WorkspaceID;
+    inviteId: Schemas.InviteID;
+};
+export declare type CancelWorkspaceMemberInviteVariables = {
+    pathParams: CancelWorkspaceMemberInvitePathParams;
+} & FetcherExtraProps;
+/**
+ * This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
+ */
+export declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
+export declare type ResendWorkspaceMemberInvitePathParams = {
+    workspaceId: Schemas.WorkspaceID;
+    inviteId: Schemas.InviteID;
+};
+export declare type ResendWorkspaceMemberInviteVariables = {
+    pathParams: ResendWorkspaceMemberInvitePathParams;
+} & FetcherExtraProps;
+/**
+ * This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
+ */
+export declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
 export declare type AcceptWorkspaceMemberInvitePathParams = {
     workspaceId: Schemas.WorkspaceID;
     inviteKey: Schemas.InviteKey;
@@ -1371,6 +1393,8 @@ export declare const operationsByTag: {
         updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
         removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
         inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<Schemas.WorkspaceInvite>;
+        cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
+        resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
         acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
     };
     database: {

package/dist/api/components.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.operationsByTag = exports.searchBranch = exports.queryTable = exports.bulkInsertTableRecords = exports.getRecord = exports.deleteRecord = exports.upsertRecordWithID = exports.updateRecordWithID = exports.insertRecordWithID = exports.insertRecord = exports.updateColumn = exports.deleteColumn = exports.getColumn = exports.addTableColumn = exports.getTableColumns = exports.setTableSchema = exports.getTableSchema = exports.updateTable = exports.deleteTable = exports.createTable = exports.getBranchStats = exports.getBranchMigrationPlan = exports.executeBranchMigrationPlan = exports.getBranchMigrationHistory = exports.getBranchMetadata = exports.updateBranchMetadata = exports.deleteBranch = exports.createBranch = exports.getBranchDetails = exports.deleteDatabase = exports.createDatabase = exports.getBranchList = exports.getDatabaseList = exports.acceptWorkspaceMemberInvite = exports.inviteWorkspaceMember = exports.removeWorkspaceMember = exports.updateWorkspaceMemberRole = exports.getWorkspaceMembersList = exports.deleteWorkspace = exports.updateWorkspace = exports.getWorkspace = exports.getWorkspacesList = exports.createWorkspace = exports.deleteUserAPIKey = exports.createUserAPIKey = exports.getUserAPIKeys = exports.deleteUser = exports.updateUser = exports.getUser = void 0;
+exports.searchBranch = exports.queryTable = exports.bulkInsertTableRecords = exports.getRecord = exports.deleteRecord = exports.upsertRecordWithID = exports.updateRecordWithID = exports.insertRecordWithID = exports.insertRecord = exports.updateColumn = exports.deleteColumn = exports.getColumn = exports.addTableColumn = exports.getTableColumns = exports.setTableSchema = exports.getTableSchema = exports.updateTable = exports.deleteTable = exports.createTable = exports.getBranchStats = exports.getBranchMigrationPlan = exports.executeBranchMigrationPlan = exports.getBranchMigrationHistory = exports.getBranchMetadata = exports.updateBranchMetadata = exports.deleteBranch = exports.createBranch = exports.getBranchDetails = exports.deleteDatabase = exports.createDatabase = exports.getBranchList = exports.getDatabaseList = exports.acceptWorkspaceMemberInvite = exports.resendWorkspaceMemberInvite = exports.cancelWorkspaceMemberInvite = exports.inviteWorkspaceMember = exports.removeWorkspaceMember = exports.updateWorkspaceMemberRole = exports.getWorkspaceMembersList = exports.deleteWorkspace = exports.updateWorkspace = exports.getWorkspace = exports.getWorkspacesList = exports.createWorkspace = exports.deleteUserAPIKey = exports.createUserAPIKey = exports.getUserAPIKeys = exports.deleteUser = exports.updateUser = exports.getUser = void 0;
+exports.operationsByTag = void 0;
 /**
  * Generated by @openapi-codegen
  *
@@ -82,6 +83,16 @@ exports.removeWorkspaceMember = removeWorkspaceMember;
  */
 const inviteWorkspaceMember = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/workspaces/{workspaceId}/invites', method: 'post' }, variables));
 exports.inviteWorkspaceMember = inviteWorkspaceMember;
+/**
+ * This operation provides a way to cancel invites by deleting them. Already accepted invites cannot be deleted.
+ */
+const cancelWorkspaceMemberInvite = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/workspaces/{workspaceId}/invites/{inviteId}', method: 'delete' }, variables));
+exports.cancelWorkspaceMemberInvite = cancelWorkspaceMemberInvite;
+/**
+ * This operation provides a way to resend an Invite notification. Invite notifications can only be sent for Invites not yet accepted.
+ */
+const resendWorkspaceMemberInvite = (variables) => (0, fetcher_1.fetch)(Object.assign({ url: '/workspaces/{workspaceId}/invites/{inviteId}/resend', method: 'post' }, variables));
+exports.resendWorkspaceMemberInvite = resendWorkspaceMemberInvite;
 /**
  * Accept the invitation to join a workspace. If the operation succeeds the user will be a member of the workspace
  */
@@ -947,6 +958,8 @@ exports.operationsByTag = {
         updateWorkspaceMemberRole: exports.updateWorkspaceMemberRole,
         removeWorkspaceMember: exports.removeWorkspaceMember,
         inviteWorkspaceMember: exports.inviteWorkspaceMember,
+        cancelWorkspaceMemberInvite: exports.cancelWorkspaceMemberInvite,
+        resendWorkspaceMemberInvite: exports.resendWorkspaceMemberInvite,
         acceptWorkspaceMemberInvite: exports.acceptWorkspaceMemberInvite
     },
     database: { getDatabaseList: exports.getDatabaseList, createDatabase: exports.createDatabase, deleteDatabase: exports.deleteDatabase },

package/dist/api/parameters.d.ts

@@ -5,6 +5,7 @@
  */
 import type * as Schemas from './schemas';
 export declare type APIKeyNameParam = Schemas.APIKeyName;
+export declare type InviteIDParam = Schemas.InviteID;
 export declare type InviteKeyParam = Schemas.InviteKey;
 export declare type UserIDParam = Schemas.UserID;
 export declare type WorkspaceIDParam = Schemas.WorkspaceID;

package/dist/schema/operators.d.ts

@@ -1,21 +1,72 @@
 import { Constraint } from './filters';
 declare type ComparableType = number | Date;
+/**
+ * Operator to restrict results to only values that are greater than the given value.
+ */
 export declare const gt: <T extends ComparableType>(value: T) => Constraint<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) => Constraint<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) => Constraint<T>;
+/**
+ * Operator to restrict results to only values that are lower than the given value.
+ */
 export declare const lt: <T extends ComparableType>(value: T) => Constraint<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) => Constraint<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) => Constraint<T>;
+/**
+ * Operator to restrict results to only values that are not null.
+ */
 export declare const exists: (column: string) => Constraint<string>;
+/**
+ * Operator to restrict results to only values that are null.
+ */
 export declare const notExists: (column: string) => Constraint<string>;
+/**
+ * Operator to restrict results to only values that start with the given prefix.
+ */
 export declare const startsWith: (value: string) => Constraint<string>;
+/**
+ * Operator to restrict results to only values that end with the given suffix.
+ */
 export declare const endsWith: (value: string) => Constraint<string>;
+/**
+ * Operator to restrict results to only values that match the given pattern.
+ */
 export declare const pattern: (value: string) => Constraint<string>;
+/**
+ * Operator to restrict results to only values that are equal to the given value.
+ */
 export declare const is: <T>(value: T) => Constraint<T>;
+/**
+ * Operator to restrict results to only values that are not equal to the given value.
+ */
 export declare const isNot: <T>(value: T) => Constraint<T>;
+/**
+ * Operator to restrict results to only values that contain the given value.
+ */
 export declare const contains: <T>(value: T) => Constraint<T>;
+/**
+ * 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 {};

package/dist/schema/operators.js

@@ -1,39 +1,90 @@
 "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;
+/**
+ * Operator to restrict results to only values that are greater than the given value.
+ */
 const gt = (value) => ({ $gt: value });
 exports.gt = gt;
+/**
+ * Operator to restrict results to only values that are greater than or equal to the given value.
+ */
 const ge = (value) => ({ $ge: value });
 exports.ge = ge;
+/**
+ * Operator to restrict results to only values that are greater than or equal to the given value.
+ */
 const gte = (value) => ({ $ge: value });
 exports.gte = gte;
+/**
+ * Operator to restrict results to only values that are lower than the given value.
+ */
 const lt = (value) => ({ $lt: value });
 exports.lt = lt;
+/**
+ * Operator to restrict results to only values that are lower than or equal to the given value.
+ */
 const lte = (value) => ({ $le: value });
 exports.lte = lte;
+/**
+ * Operator to restrict results to only values that are lower than or equal to the given value.
+ */
 const le = (value) => ({ $le: value });
 exports.le = le;
+/**
+ * Operator to restrict results to only values that are not null.
+ */
 const exists = (column) => ({ $exists: column });
 exports.exists = exists;
+/**
+ * Operator to restrict results to only values that are null.
+ */
 const notExists = (column) => ({ $notExists: column });
 exports.notExists = notExists;
+/**
+ * Operator to restrict results to only values that start with the given prefix.
+ */
 const startsWith = (value) => ({ $startsWith: value });
 exports.startsWith = startsWith;
+/**
+ * Operator to restrict results to only values that end with the given suffix.
+ */
 const endsWith = (value) => ({ $endsWith: value });
 exports.endsWith = endsWith;
+/**
+ * Operator to restrict results to only values that match the given pattern.
+ */
 const pattern = (value) => ({ $pattern: value });
 exports.pattern = pattern;
+/**
+ * Operator to restrict results to only values that are equal to the given value.
+ */
 const is = (value) => ({ $is: value });
 exports.is = is;
+/**
+ * Operator to restrict results to only values that are not equal to the given value.
+ */
 const isNot = (value) => ({ $isNot: value });
 exports.isNot = isNot;
+/**
+ * Operator to restrict results to only values that contain the given value.
+ */
 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 });

package/dist/schema/pagination.d.ts

@@ -15,15 +15,53 @@ export interface Paginable<T extends XataRecord, R extends XataRecord = T> {
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
     hasNextPage(): boolean;
 }
+/**
+ * A Page contains a set of results from a query plus metadata about the retrieved
+ * set of values such as the cursor, required to retrieve additional records.
+ */
 export declare class Page<T extends XataRecord, R extends XataRecord> implements Paginable<T, R> {
     #private;
+    /**
+     * Page metadata, required to retrieve additional records.
+     */
     readonly meta: PaginationQueryMeta;
+    /**
+     * The set of results for this page.
+     */
     readonly records: R[];
     constructor(query: Query<T, R>, meta: PaginationQueryMeta, records?: R[]);
+    /**
+     * Retrieves the next page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The next page or results.
+     */
     nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    /**
+     * Retrieves the previous page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The previous page or results.
+     */
     previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    /**
+     * Retrieves the first page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The first page or results.
+     */
     firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    /**
+     * Retrieves the last page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The last page or results.
+     */
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    /**
+     * Shortcut method to check if there will be additional results if the next page of results is retrieved.
+     * @returns Whether or not there will be additional results in the next page of results.
+     */
     hasNextPage(): boolean;
 }
 export declare type CursorNavigationOptions = {

package/dist/schema/pagination.js

@@ -22,6 +22,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Page_query;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Page = void 0;
+/**
+ * A Page contains a set of results from a query plus metadata about the retrieved
+ * set of values such as the cursor, required to retrieve additional records.
+ */
 class Page {
     constructor(query, meta, records = []) {
         _Page_query.set(this, void 0);
@@ -29,27 +33,55 @@ class Page {
         this.meta = meta;
         this.records = records;
     }
+    /**
+     * Retrieves the next page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The next page or results.
+     */
     nextPage(size, offset) {
         return __awaiter(this, void 0, void 0, function* () {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, after: this.meta.page.cursor } });
         });
     }
+    /**
+     * Retrieves the previous page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The previous page or results.
+     */
     previousPage(size, offset) {
         return __awaiter(this, void 0, void 0, function* () {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, before: this.meta.page.cursor } });
         });
     }
+    /**
+     * Retrieves the first page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The first page or results.
+     */
     firstPage(size, offset) {
         return __awaiter(this, void 0, void 0, function* () {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, first: this.meta.page.cursor } });
         });
     }
+    /**
+     * Retrieves the last page of results.
+     * @param size Maximum number of results to be retrieved.
+     * @param offset Number of results to skip when retrieving the results.
+     * @returns The last page or results.
+     */
     lastPage(size, offset) {
         return __awaiter(this, void 0, void 0, function* () {
             return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
         });
     }
     // TODO: We need to add something on the backend if we want a hasPreviousPage
+    /**
+     * Shortcut method to check if there will be additional results if the next page of results is retrieved.
+     * @returns Whether or not there will be additional results in the next page of results.
+     */
     hasNextPage() {
         return this.meta.page.more;
     }

package/dist/schema/query.d.ts

@@ -14,25 +14,94 @@ export declare type QueryTableOptions = {
     page?: PageConfig;
     columns?: ColumnsFilter;
 };
+/**
+ * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
+ *
+ * Query objects are immutable. Any method that adds more constraints or options to the query will return
+ * a new Query object containing the both the previous and the new constraints and options.
+ */
 export declare class Query<T extends XataRecord, R extends XataRecord = T> implements Paginable<T, R> {
     #private;
     readonly meta: PaginationQueryMeta;
     readonly records: R[];
     constructor(repository: Repository<T> | null, table: string, data: Partial<QueryTableOptions>, parent?: Partial<QueryTableOptions>);
     getQueryOptions(): QueryTableOptions;
+    /**
+     * Builds a new query object representing a logical OR between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     any(...queries: Query<T, R>[]): Query<T, R>;
+    /**
+     * Builds a new query object representing a logical AND between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     all(...queries: Query<T, R>[]): Query<T, R>;
+    /**
+     * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     not(...queries: Query<T, R>[]): Query<T, R>;
+    /**
+     * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     none(...queries: Query<T, R>[]): Query<T, R>;
+    /**
+     * Builds a new query object adding one or more constraints. Examples:
+     *
+     * ```
+     * query.filter("columnName", columnValue)
+     * query.filter({
+     *   "columnName": columnValue
+     * })
+     * query.filter({
+     *   "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
+     * })
+     * ```
+     *
+     * @param constraints
+     * @returns A new Query object.
+     */
     filter(constraints: FilterConstraints<T>): Query<T, R>;
-    filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
+    filter<F extends keyof Selectable<T>>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
+    /**
+     * Builds a new query with a new sort option.
+     * @param column The column name.
+     * @param direction The direction. Either ascending or descending.
+     * @returns A new Query object.
+     */
     sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
+    /**
+     * Builds a new query specifying the set of columns to be returned in the query response.
+     * @param columns Array of column names to be returned by the query.
+     * @returns A new Query object.
+     */
     select<K extends SelectableColumn<T>>(columns: K[]): Query<T, Select<T, K>>;
-    getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, typeof options extends {
+        columns: SelectableColumn<T>[];
+    } ? Select<T, typeof options['columns'][number]> : R>>;
     [Symbol.asyncIterator](): AsyncIterableIterator<R>;
     getIterator(chunk: number, options?: Omit<QueryOptions<T>, 'page'>): AsyncGenerator<R[]>;
-    getMany<Options extends QueryOptions<T>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R)[]>;
-    getOne<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R) | null>;
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
+    getMany<Options extends QueryOptions<T>>(options?: Options): Promise<(typeof options extends {
+        columns: SelectableColumn<T>[];
+    } ? Select<T, typeof options['columns'][number]> : R)[]>;
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
+    getOne<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options extends {
+        columns: SelectableColumn<T>[];
+    } ? Select<T, typeof options['columns'][number]> : R) | null>;
     /**async deleteAll(): Promise<number> {
       // TODO: Return number of affected rows
       return 0;

package/dist/schema/query.js

@@ -42,6 +42,12 @@ var _Query_table, _Query_repository, _Query_data;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Query = void 0;
 const lang_1 = require("../util/lang");
+/**
+ * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
+ *
+ * Query objects are immutable. Any method that adds more constraints or options to the query will return
+ * a new Query object containing the both the previous and the new constraints and options.
+ */
 class Query {
     constructor(repository, table, data, parent) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
@@ -76,18 +82,38 @@ class Query {
     getQueryOptions() {
         return __classPrivateFieldGet(this, _Query_data, "f");
     }
+    /**
+     * Builds a new query object representing a logical OR between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     any(...queries) {
         const $any = queries.map((query) => query.getQueryOptions().filter);
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $any } }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
+    /**
+     * Builds a new query object representing a logical AND between the given subqueries.
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     all(...queries) {
         const $all = queries.map((query) => query.getQueryOptions().filter);
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
+    /**
+     * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     not(...queries) {
         const $not = queries.map((query) => query.getQueryOptions().filter);
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $not } }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
+    /**
+     * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
+     * @param queries An array of subqueries.
+     * @returns A new Query object.
+     */
     none(...queries) {
         const $none = queries.map((query) => query.getQueryOptions().filter);
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $none } }, __classPrivateFieldGet(this, _Query_data, "f"));
@@ -105,17 +131,26 @@ class Query {
             return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
         }
     }
+    /**
+     * Builds a new query with a new sort option.
+     * @param column The column name.
+     * @param direction The direction. Either ascending or descending.
+     * @returns A new Query object.
+     */
     sort(column, direction) {
         const sort = Object.assign(Object.assign({}, __classPrivateFieldGet(this, _Query_data, "f").sort), { [column]: direction });
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { sort }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
+    /**
+     * Builds a new query specifying the set of columns to be returned in the query response.
+     * @param columns Array of column names to be returned by the query.
+     * @returns A new Query object.
+     */
     select(columns) {
         return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { columns }, __classPrivateFieldGet(this, _Query_data, "f"));
     }
     getPaginated(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
-        });
+        return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
     }
     [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
         return __asyncGenerator(this, arguments, function* _a() {
@@ -147,12 +182,22 @@ class Query {
             }
         });
     }
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getMany(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const { records } = yield this.getPaginated(options);
             return records;
         });
     }
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
     getOne(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
@@ -164,24 +209,16 @@ class Query {
       return 0;
     }**/
     nextPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
+        return this.firstPage(size, offset);
     }
     previousPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firstPage(size, offset);
-        });
+        return this.firstPage(size, offset);
     }
     firstPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getPaginated({ page: { size, offset } });
-        });
+        return this.getPaginated({ page: { size, offset } });
     }
     lastPage(size, offset) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getPaginated({ page: { size, offset, before: 'end' } });
-        });
+        return this.getPaginated({ page: { size, offset, before: 'end' } });
     }
     hasNextPage() {
         return this.meta.page.more;

package/dist/schema/record.d.ts

@@ -1,10 +1,36 @@
 import { Selectable } from './selection';
+/**
+ * Represents a persisted record from the database.
+ */
 export interface XataRecord {
+    /**
+     * Unique id of this record.
+     */
     id: string;
+    /**
+     * Metadata of this record.
+     */
     xata: {
+        /**
+         * Number that is increased every time the record is updated.
+         */
         version: number;
     };
+    /**
+     * Retrieves a refreshed copy of the current record from the database.
+     */
     read(): Promise<this>;
+    /**
+     * Performs a partial update of the current record. On success a new object is
+     * returned and the current object is not mutated.
+     * @param data The columns and their values that have to be updated.
+     * @returns A new record containing the latest values for all the columns of the current record.
+     */
     update(data: Partial<Selectable<this>>): Promise<this>;
+    /**
+     * Performs a deletion of the current record in the database.
+     *
+     * @throws If the record was already deleted or if an error happened while performing the deletion.
+     */
     delete(): Promise<void>;
 }

package/dist/schema/repository.d.ts

@@ -4,14 +4,52 @@ import { Query, QueryOptions } from './query';
 import { XataRecord } from './record';
 import { Selectable, SelectableColumn, Select } from './selection';
 export declare type Links = Record<string, Array<string[]>>;
+/**
+ * Common interface for performing operations on a table.
+ */
 export declare abstract class Repository<T extends XataRecord> extends Query<T> {
+    /**
+     * Creates a record in the table.
+     * @param object Object containing the column names with their values to be stored in the table.
+     * @returns The full persisted record.
+     */
     abstract create(object: Selectable<T>): Promise<T>;
+    /**
+     * Creates multiple records in the table.
+     * @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: Selectable<T>[]): Promise<T[]>;
+    /**
+     * 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<T | null>;
+    /**
+     * 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.
+     * @returns The full persisted record.
+     */
     abstract update(id: string, object: Partial<Selectable<T>>): Promise<T>;
+    /**
+     * Updates or creates a single record. If a record exists with the given id,
+     * it will be update, otherwise a new record will be created.
+     * @param id A unique id.
+     * @param object The column names and the values to be persisted.
+     * @returns The full persisted record.
+     */
     abstract upsert(id: string, object: Selectable<T>): Promise<T>;
+    /**
+     * 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 query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    abstract query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options extends {
+        columns: SelectableColumn<T>[];
+    } ? Select<T, typeof options['columns'][number]> : R>>;
 }
 export declare class RestRepository<T extends XataRecord> extends Repository<T> {
     #private;
@@ -22,7 +60,9 @@ export declare class RestRepository<T extends XataRecord> extends Repository<T>
     update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
     upsert(recordId: string, object: Selectable<T>): Promise<T>;
     delete(recordId: string): Promise<void>;
-    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options?: Options): Promise<Page<T, typeof options extends {
+        columns: SelectableColumn<T>[];
+    } ? Select<T, typeof options['columns'][number]> : R>>;
 }
 interface RepositoryFactory {
     createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
@@ -35,9 +75,18 @@ declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchS
 declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
 declare type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
 export declare type XataClientOptions = {
+    /**
+     * Fetch implementation. This option is only required if the runtime does not include a fetch implementation
+     * available in the global scope. If you are running your code on Deno or Cloudflare workers for example,
+     * you won't need to provide a specific fetch implementation. But for most versions of Node.js you'll need
+     * to provide one. Such as cross-fetch, node-fetch or isomorphic-fetch.
+     */
     fetch?: FetchImpl;
     databaseURL?: string;
     branch: BranchStrategyOption;
+    /**
+     * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
+     */
     apiKey: string;
     repositoryFactory?: RepositoryFactory;
 };
@@ -45,7 +94,7 @@ export declare class BaseClient<D extends 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>;
 }

package/dist/schema/repository.js

@@ -33,6 +33,9 @@ const api_1 = require("../api");
 const filters_1 = require("./filters");
 const pagination_1 = require("./pagination");
 const query_1 = require("./query");
+/**
+ * Common interface for performing operations on a table.
+ */
 class Repository extends query_1.Query {
 }
 exports.Repository = Repository;
@@ -121,7 +124,7 @@ class RestRepository extends Repository {
             yield (0, api_1.deleteRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
         });
     }
-    query(query, options) {
+    query(query, options = {}) {
         var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             const data = query.getQueryOptions();
@@ -165,7 +168,7 @@ class RestRespositoryFactory {
 }
 exports.RestRespositoryFactory = RestRespositoryFactory;
 class BaseClient {
-    constructor(options, links) {
+    constructor(options, links = {}) {
         _BaseClient_links.set(this, void 0);
         _BaseClient_branch.set(this, void 0);
         if (!options.databaseURL || !options.apiKey || !options.branch) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.4e4e7fc",
+  "version": "0.0.0-beta.50e1cc9",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,5 +20,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "4e4e7fc8f16c42c25a78e1094ab8bc2202f4b0fe"
+  "gitHead": "50e1cc94906232f6a384f222d482b0f871cfecb6"
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "lib": ["dom", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": ["src"]
+}