@xata.io/client 0.1.4 → 0.3.0

package/dist/index.js

@@ -1,330 +1,20 @@
 "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());
-    });
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.Query = 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;
-const gt = (value) => ({ $gt: value });
-exports.gt = gt;
-const ge = (value) => ({ $ge: value });
-exports.ge = ge;
-const gte = (value) => ({ $ge: value });
-exports.gte = gte;
-const lt = (value) => ({ $lt: value });
-exports.lt = lt;
-const lte = (value) => ({ $le: value });
-exports.lte = lte;
-const le = (value) => ({ $le: value });
-exports.le = le;
-const exists = (column) => ({ $exists: column });
-exports.exists = exists;
-const notExists = (column) => ({ $notExists: column });
-exports.notExists = notExists;
-const startsWith = (value) => ({ $startsWith: value });
-exports.startsWith = startsWith;
-const endsWith = (value) => ({ $endsWith: value });
-exports.endsWith = endsWith;
-const pattern = (value) => ({ $pattern: value });
-exports.pattern = pattern;
-const is = (value) => ({ $is: value });
-exports.is = is;
-const isNot = (value) => ({ $isNot: value });
-exports.isNot = isNot;
-const contains = (value) => ({ $contains: value });
-exports.contains = contains;
-// TODO: these can only be applied to columns of type "multiple"
-const includes = (value) => ({ $includes: value });
-exports.includes = includes;
-const includesSubstring = (value) => ({ $includesSubstring: value });
-exports.includesSubstring = includesSubstring;
-const includesPattern = (value) => ({ $includesPattern: value });
-exports.includesPattern = includesPattern;
-const includesAll = (value) => ({ $includesAll: value });
-exports.includesAll = includesAll;
-class Query {
-    constructor(repository, table, data, parent) {
-        if (repository) {
-            this.repository = repository;
-        }
-        else {
-            this.repository = this;
-        }
-        this.table = table;
-        // For some reason Object.assign(this, parent) didn't work in this case
-        // so doing all this manually:
-        this.$any = parent === null || parent === void 0 ? void 0 : parent.$any;
-        this.$all = parent === null || parent === void 0 ? void 0 : parent.$all;
-        this.$not = parent === null || parent === void 0 ? void 0 : parent.$not;
-        this.$none = parent === null || parent === void 0 ? void 0 : parent.$none;
-        this.$sort = parent === null || parent === void 0 ? void 0 : parent.$sort;
-        Object.assign(this, data);
-        // These bindings are used to support deconstructing
-        // const { any, not, filter, sort } = xata.users.query()
-        this.any = this.any.bind(this);
-        this.all = this.all.bind(this);
-        this.not = this.not.bind(this);
-        this.filter = this.filter.bind(this);
-        this.sort = this.sort.bind(this);
-        this.none = this.none.bind(this);
-        Object.defineProperty(this, 'table', { enumerable: false });
-        Object.defineProperty(this, 'repository', { enumerable: false });
-    }
-    any(...queries) {
-        return new Query(this.repository, this.table, {
-            $any: (this.$any || []).concat(queries)
-        }, this);
-    }
-    all(...queries) {
-        return new Query(this.repository, this.table, {
-            $all: (this.$all || []).concat(queries)
-        }, this);
-    }
-    not(...queries) {
-        return new Query(this.repository, this.table, {
-            $not: (this.$not || []).concat(queries)
-        }, this);
-    }
-    none(...queries) {
-        return new Query(this.repository, this.table, {
-            $none: (this.$none || []).concat(queries)
-        }, this);
-    }
-    filter(a, b) {
-        if (arguments.length === 1) {
-            const constraints = a;
-            const queries = [];
-            for (const [column, constraint] of Object.entries(constraints)) {
-                queries.push({ [column]: constraint });
-            }
-            return new Query(this.repository, this.table, {
-                $all: (this.$all || []).concat(queries)
-            }, this);
-        }
-        else {
-            const column = a;
-            const value = b;
-            return new Query(this.repository, this.table, {
-                $all: (this.$all || []).concat({ [column]: value })
-            }, this);
-        }
-    }
-    sort(column, direction) {
-        const sort = Object.assign(Object.assign({}, this.$sort), { [column]: direction });
-        const q = new Query(this.repository, this.table, {
-            $sort: sort
-        }, this);
-        return q;
-    }
-    // TODO: pagination. Maybe implement different methods for different type of paginations
-    // and one to simply get the first records returned by the query with no pagination.
-    getMany(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: use options
-            return this.repository.query(this);
-        });
-    }
-    getOne(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: use options
-            const arr = yield this.getMany(); // TODO, limit to 1
-            return arr[0] || null;
-        });
-    }
-    deleteAll() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Return number of affected rows
-            return 0;
-        });
-    }
-    include(columns) {
-        // TODO
-        return this;
-    }
-}
-exports.Query = Query;
-class Repository extends Query {
-    select(...columns) {
-        return new Query(this.repository, this.table, {});
-    }
-}
-exports.Repository = Repository;
-class RestRepository extends Repository {
-    constructor(client, table) {
-        super(null, table, {});
-        this.client = client;
-        const { fetch } = client.options;
-        if (fetch) {
-            this.fetch = fetch;
-        }
-        else if (typeof window === 'object') {
-            this.fetch = window.fetch;
-        }
-        else if (typeof require === 'function') {
-            try {
-                this.fetch = require('node-fetch');
-            }
-            catch (err) {
-                try {
-                    this.fetch = require('cross-fetch');
-                }
-                catch (err) {
-                    throw new Error('No fetch implementation found. Please provide one in the constructor');
-                }
-            }
-        }
-        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 } = this.client.options;
-            const resp = yield this.fetch(`${databaseURL}${path}`, {
-                method,
-                headers: {
-                    Accept: '*/*',
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${this.client.options.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;
-            return resp.json();
-        });
-    }
-    select(...columns) {
-        return new Query(this.repository, this.table, {});
-    }
-    create(object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const body = Object.assign({}, object);
-            for (const key of Object.keys(body)) {
-                const value = body[key];
-                if (value && typeof value === 'object' && typeof value._id === 'string') {
-                    body[key] = value._id;
-                }
-            }
-            const obj = yield this.request('POST', `/tables/${this.table}/data`, body);
-            return this.client.initObject(this.table, obj);
-        });
-    }
-    read(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const obj = yield this.request('GET', `/tables/${this.table}/data/${id}`);
-                return this.client.initObject(this.table, obj);
-            }
-            catch (err) {
-                if (err.status === 404)
-                    return null;
-                throw err;
-            }
-        });
-    }
-    update(id, object) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const obj = yield this.request('PUT', `/tables/${this.table}/data/${id}`, object);
-            return this.client.initObject(this.table, obj);
-        });
-    }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.request('DELETE', `/tables/${this.table}/data/${id}`);
-        });
-    }
-    query(query) {
-        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: query.$sort
-            };
-            const result = yield this.request('POST', `/tables/${this.table}/query`, body);
-            return result.records.map((record) => this.client.initObject(this.table, record));
-        });
-    }
-}
-exports.RestRepository = RestRepository;
-class RestRespositoryFactory {
-    createRepository(client, table) {
-        return new RestRepository(client, table);
-    }
-}
-exports.RestRespositoryFactory = RestRespositoryFactory;
-class BaseClient {
-    constructor(options, links) {
-        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.startsWith('_'))) {
-                    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;
-    }
-}
-exports.BaseClient = BaseClient;
+exports.XataError = void 0;
 class XataError extends Error {
     constructor(message, status) {
         super(message);
@@ -332,3 +22,5 @@ class XataError extends Error {
     }
 }
 exports.XataError = XataError;
+__exportStar(require("./api"), exports);
+__exportStar(require("./schema"), exports);

package/dist/schema/filters.d.ts

@@ -0,0 +1,20 @@
+export declare type SortDirection = 'asc' | 'desc';
+export declare type SortFilterExtended<T> = {
+    column: keyof 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 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>[]): {
+    [key: string]: SortDirection;
+} | undefined;
+export declare type Constraint<T> = {
+    [key in FilterOperator]?: T;
+};
+export declare type DeepConstraint<T> = T extends Record<string, any> ? {
+    [key in keyof T]?: T[key] | DeepConstraint<T[key]>;
+} : Constraint<T>;
+export declare type FilterConstraints<T> = {
+    [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | DeepConstraint<T[key]>;
+};

package/dist/schema/filters.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSortFilter = exports.isSortFilterObject = void 0;
+function isSortFilterObject(filter) {
+    return typeof filter === 'object' && filter.column !== undefined;
+}
+exports.isSortFilterObject = isSortFilterObject;
+function buildSortFilter(filter) {
+    if (!filter)
+        return undefined;
+    const filters = Array.isArray(filter) ? filter : [filter];
+    return filters.reduce((acc, item) => {
+        if (typeof item === 'string') {
+            return Object.assign(Object.assign({}, acc), { [item]: 'asc' });
+        }
+        else if (isSortFilterObject(item)) {
+            return Object.assign(Object.assign({}, acc), { [item.column]: item.direction });
+        }
+        else {
+            return acc;
+        }
+    }, {});
+}
+exports.buildSortFilter = buildSortFilter;

package/dist/schema/index.d.ts

@@ -0,0 +1,5 @@
+export * from './operators';
+export type { XataRecord } from './record';
+export { Repository, RestRepository, RestRespositoryFactory, BaseClient } from './repository';
+export type { XataClientOptions } from './repository';
+export { Query } from './query';

package/dist/schema/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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.Query = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
+__exportStar(require("./operators"), exports);
+var repository_1 = require("./repository");
+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; } });
+Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
+var query_1 = require("./query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });

package/dist/schema/operators.d.ts

@@ -0,0 +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

@@ -0,0 +1,91 @@
+"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 });
+exports.includesAll = includesAll;

package/dist/schema/pagination.d.ts

@@ -0,0 +1,79 @@
+import { XataRecord } from '..';
+import { Query } from './query';
+export declare type PaginationQueryMeta = {
+    page: {
+        cursor: string;
+        more: boolean;
+    };
+};
+export interface Paginable<T extends XataRecord, R extends XataRecord = T> {
+    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>>;
+    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 = {
+    first?: string;
+} | {
+    last?: string;
+} | {
+    after?: string;
+    before?: string;
+};
+export declare type OffsetNavigationOptions = {
+    size?: number;
+    offset?: number;
+};
+export declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;