@xata.io/client 0.0.0-beta.f12621e → 0.0.0-beta.f46df88

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -9,262 +13,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-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());
-    });
-};
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
-const filters_1 = require("./schema/filters");
-const pagination_1 = require("./schema/pagination");
-const query_1 = require("./schema/query");
-const errors_1 = require("./util/errors");
-class Repository extends query_1.Query {
-    select(columns) {
-        return new query_1.Query(this.repository, this.table, { columns });
-    }
-}
-exports.Repository = Repository;
-class RestRepository extends Repository {
-    constructor(client, table) {
-        super(null, table, {});
-        this.client = client;
-        const doWeHaveFetch = typeof fetch !== 'undefined';
-        const isInjectedFetchProblematic = !this.client.options.fetch;
-        if (doWeHaveFetch) {
-            this.fetch = fetch;
-        }
-        else if (isInjectedFetchProblematic) {
-            throw new Error(errors_1.errors.falsyFetchImplementation);
-        }
-        else {
-            this.fetch = this.client.options.fetch;
-        }
-        Object.defineProperty(this, 'client', { enumerable: false });
-        Object.defineProperty(this, 'fetch', { enumerable: false });
-        Object.defineProperty(this, 'hostname', { enumerable: false });
-    }
-    request(method, path, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { databaseURL, apiKey } = this.client.options;
-            const branch = yield this.client.getBranch();
-            const fetchImpl = this.fetch;
-            const resp = yield fetchImpl(`${databaseURL}:${branch}${path}`, {
-                method,
-                headers: {
-                    Accept: '*/*',
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${apiKey}`
-                },
-                body: JSON.stringify(body)
-            });
-            if (!resp.ok) {
-                try {
-                    const json = yield resp.json();
-                    const message = json.message;
-                    if (typeof message === 'string') {
-                        throw new XataError(message, resp.status);
-                    }
-                }
-                catch (err) {
-                    if (err instanceof XataError)
-                        throw err;
-                    // Ignore errors for other reasons.
-                    // For example if the response's body cannot be parsed as JSON
-                }
-                throw new XataError(resp.statusText, resp.status);
-            }
-            if (resp.status === 204)
-                return undefined;
-            return resp.json();
-        });
-    }
-    select(columns) {
-        return new query_1.Query(this.repository, this.table, { columns });
-    }
-    create(object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const record = transformObjectLinks(object);
-            const response = yield this.request('POST', `/tables/${this.table}/data`, record);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            const finalObject = yield this.read(response.id);
-            if (!finalObject) {
-                throw new Error('The server failed to save the record');
-            }
-            return finalObject;
-        });
-    }
-    createMany(objects) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const records = objects.map((object) => transformObjectLinks(object));
-            const response = yield this.request('POST', `/tables/${this.table}/bulk`, { records });
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            // TODO: Use filer.$any() to get all the records
-            const finalObjects = yield Promise.all(response.recordIDs.map((id) => this.read(id)));
-            if (finalObjects.some((object) => !object)) {
-                throw new Error('The server failed to save the record');
-            }
-            return finalObjects;
-        });
-    }
-    read(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.request('GET', `/tables/${this.table}/data/${id}`);
-                if (!response)
-                    return null;
-                return this.client.initObject(this.table, response);
-            }
-            catch (err) {
-                if (err.status === 404)
-                    return null;
-                throw err;
-            }
-        });
-    }
-    update(id, object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.request('PUT', `/tables/${this.table}/data/${id}`, object);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            // TODO: Review this, not sure we are properly initializing the object
-            return this.client.initObject(this.table, response);
-        });
-    }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.request('DELETE', `/tables/${this.table}/data/${id}`);
-        });
-    }
-    _runQuery(query, options) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const filter = {
-                $any: query.$any,
-                $all: query.$all,
-                $not: query.$not,
-                $none: query.$none
-            };
-            const body = {
-                filter: Object.values(filter).some(Boolean) ? filter : undefined,
-                sort: (_a = (0, filters_1.buildSortFilter)(options === null || options === void 0 ? void 0 : options.sort)) !== null && _a !== void 0 ? _a : query.$sort,
-                page: options === null || options === void 0 ? void 0 : options.page,
-                columns: (_b = options === null || options === void 0 ? void 0 : options.columns) !== null && _b !== void 0 ? _b : query.columns
-            };
-            const response = yield this.request('POST', `/tables/${this.table}/query`, body);
-            if (!response) {
-                throw new Error("The server didn't return any data for the query");
-            }
-            const { meta, records: objects } = response;
-            const records = objects.map((record) => this.client.initObject(this.table, record));
-            // TODO: We should properly type this any
-            return new pagination_1.Page(query, meta, records);
-        });
-    }
-}
-exports.RestRepository = RestRepository;
-class RestRespositoryFactory {
-    createRepository(client, table) {
-        return new RestRepository(client, table);
-    }
-}
-exports.RestRespositoryFactory = RestRespositoryFactory;
-class BaseClient {
-    constructor(options, links) {
-        if (!options.databaseURL || !options.apiKey || !options.branch) {
-            throw new Error('Options databaseURL, apiKey and branch are required');
-        }
-        this.options = options;
-        this.links = links;
-    }
-    initObject(table, object) {
-        const o = {};
-        Object.assign(o, object);
-        const tableLinks = this.links[table] || [];
-        for (const link of tableLinks) {
-            const [field, linkTable] = link;
-            const value = o[field];
-            if (value && typeof value === 'object') {
-                const { id } = value;
-                if (Object.keys(value).find((col) => col === 'id')) {
-                    o[field] = this.initObject(linkTable, value);
-                }
-                else if (id) {
-                    o[field] = {
-                        id,
-                        get: () => {
-                            this.db[linkTable].read(id);
-                        }
-                    };
-                }
-            }
-        }
-        const db = this.db;
-        o.read = function () {
-            return db[table].read(o['id']);
-        };
-        o.update = function (data) {
-            return db[table].update(o['id'], data);
-        };
-        o.delete = function () {
-            return db[table].delete(o['id']);
-        };
-        for (const prop of ['read', 'update', 'delete']) {
-            Object.defineProperty(o, prop, { enumerable: false });
-        }
-        // TODO: links and rev links
-        Object.freeze(o);
-        return o;
-    }
-    getBranch() {
-        var e_1, _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.branch)
-                return this.branch;
-            const { branch: param } = this.options;
-            const strategies = Array.isArray(param) ? [...param] : [param];
-            const evaluateBranch = (strategy) => __awaiter(this, void 0, void 0, function* () {
-                return isBranchStrategyBuilder(strategy) ? yield strategy() : strategy;
-            });
-            try {
-                for (var strategies_1 = __asyncValues(strategies), strategies_1_1; strategies_1_1 = yield strategies_1.next(), !strategies_1_1.done;) {
-                    const strategy = strategies_1_1.value;
-                    const branch = yield evaluateBranch(strategy);
-                    if (branch) {
-                        this.branch = branch;
-                        return branch;
-                    }
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) yield _a.call(strategies_1);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            throw new Error('Unable to resolve branch value');
-        });
-    }
-}
-exports.BaseClient = BaseClient;
+exports.XataError = void 0;
 class XataError extends Error {
     constructor(message, status) {
         super(message);
@@ -272,16 +22,5 @@ class XataError extends Error {
     }
 }
 exports.XataError = XataError;
-const isBranchStrategyBuilder = (strategy) => {
-    return typeof strategy === 'function';
-};
-// TODO: We can find a better implementation for links
-const transformObjectLinks = (object) => {
-    return Object.entries(object).reduce((acc, [key, value]) => {
-        if (value && typeof value === 'object' && typeof value.id === 'string') {
-            return Object.assign(Object.assign({}, acc), { [key]: value.id });
-        }
-        return Object.assign(Object.assign({}, acc), { [key]: value });
-    }, {});
-};
+__exportStar(require("./api"), exports);
 __exportStar(require("./schema"), exports);

package/dist/schema/filters.d.ts

@@ -1,12 +1,14 @@
+import { XataRecord } from './record';
+import { SelectableColumn } from './selection';
 export declare type SortDirection = 'asc' | 'desc';
-export declare type SortFilterExtended<T> = {
-    column: keyof T;
+export declare type SortFilterExtended<T extends XataRecord> = {
+    column: SelectableColumn<T>;
     direction?: SortDirection;
 };
-export declare type SortFilter<T> = SortFilterExtended<T> | keyof T;
-export declare function isSortFilterObject<T>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
+export declare type SortFilter<T extends XataRecord> = SelectableColumn<T> | SortFilterExtended<T>;
+export declare function isSortFilterObject<T extends XataRecord>(filter: SortFilter<T>): filter is SortFilterExtended<T>;
 export declare type FilterOperator = '$gt' | '$lt' | '$ge' | '$le' | '$exists' | '$notExists' | '$endsWith' | '$startsWith' | '$pattern' | '$is' | '$isNot' | '$contains' | '$includes' | '$includesSubstring' | '$includesPattern' | '$includesAll';
-export declare function buildSortFilter<T>(filter?: SortFilter<T> | SortFilter<T>[]): {
+export declare function buildSortFilter<T extends XataRecord>(filter?: SortFilter<T> | SortFilter<T>[]): {
     [key: string]: SortDirection;
 } | undefined;
 export declare type Constraint<T> = {

package/dist/schema/filters.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildSortFilter = exports.isSortFilterObject = void 0;
+const lang_1 = require("../util/lang");
 function isSortFilterObject(filter) {
-    return typeof filter === 'object' && filter.column !== undefined;
+    return (0, lang_1.isObject)(filter) && filter.column !== undefined;
 }
 exports.isSortFilterObject = isSortFilterObject;
 function buildSortFilter(filter) {

package/dist/schema/index.d.ts

@@ -1 +1,7 @@
 export * from './operators';
+export * from './pagination';
+export { Query } from './query';
+export { isIdentifiable, isXataRecord } from './record';
+export type { Identifiable, XataRecord } from './record';
+export { BaseClient, Repository, RestRepository, RestRespositoryFactory } from './repository';
+export type { XataClientOptions } from './repository';

package/dist/schema/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,4 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.BaseClient = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
 __exportStar(require("./operators"), exports);
+__exportStar(require("./pagination"), exports);
+var query_1 = require("./query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });
+var record_1 = require("./record");
+Object.defineProperty(exports, "isIdentifiable", { enumerable: true, get: function () { return record_1.isIdentifiable; } });
+Object.defineProperty(exports, "isXataRecord", { enumerable: true, get: function () { return record_1.isXataRecord; } });
+var repository_1 = require("./repository");
+Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
+Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });
+Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_1.RestRepository; } });
+Object.defineProperty(exports, "RestRespositoryFactory", { enumerable: true, get: function () { return repository_1.RestRespositoryFactory; } });

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

@@ -1,30 +1,67 @@
-import { XataRecord } from '..';
 import { Query } from './query';
+import { XataRecord } from './record';
 export declare type PaginationQueryMeta = {
     page: {
         cursor: string;
         more: boolean;
     };
 };
-export interface BasePage<T extends XataRecord, R extends XataRecord> {
-    query: Query<T, R>;
+export interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
     meta: PaginationQueryMeta;
-    records: R[];
-    nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    records: Result[];
+    nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     hasNextPage(): boolean;
 }
-export declare class Page<T extends XataRecord, R extends XataRecord> implements BasePage<T, R> {
-    readonly query: Query<T, R>;
+/**
+ * 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<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
+    #private;
+    /**
+     * Page metadata, required to retrieve additional records.
+     */
     readonly meta: PaginationQueryMeta;
-    readonly records: R[];
-    constructor(query: Query<T, R>, meta: PaginationQueryMeta, records?: R[]);
-    nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
-    lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
+    /**
+     * The set of results for this page.
+     */
+    readonly records: Result[];
+    constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
+    /**
+     * 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<Record, Result>>;
+    /**
+     * 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<Record, Result>>;
+    /**
+     * 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<Record, Result>>;
+    /**
+     * 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<Record, Result>>;
+    /**
+     * 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 = {
@@ -40,3 +77,7 @@ export declare type OffsetNavigationOptions = {
     offset?: number;
 };
 export declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
+export declare const PAGINATION_MAX_SIZE = 200;
+export declare const PAGINATION_DEFAULT_SIZE = 200;
+export declare const PAGINATION_MAX_OFFSET = 800;
+export declare const PAGINATION_DEFAULT_OFFSET = 0;