@xata.io/client 0.0.0-beta.c9e08d0 → 0.0.0-beta.ca9389a

package/dist/schema/filters.spec.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const vitest_1 = require("vitest");
+// Single column with implicit is
+const singleColumnWithImplicitIs = { name: 'r2' };
+// Single column with explicit is
+const singleColumnWithExplicitIs = { name: { $is: 'r2' } };
+// Is string
+const isString = { string: 'string' };
+// Is true
+const isTrue = { boolean: true };
+// Is false
+const isFalse = { boolean: false };
+// Is pos int
+const isPosInt = { number: 1234567 };
+// Is neg int
+const isNegInt = { number: -42 };
+// Is float
+const isFloat = { number: 3.14 };
+//  with dots
+const withDots = { 'settings.plan': 'free' };
+// Nested columns
+const nestedColumns = { settings: { plan: 'free' } };
+// Nested columns array
+const nestedColumnsArray = { settings: [{ dark: false }, { plan: 'free' }] };
+// Nested columns any
+const nestedColumnsAny = { settings: { $any: [{ plan: 'free' }, { plan: 'trial' }] } };
+// Nested columns any value
+const nestedColumnsAnyValue = { settings: { plan: { $any: ['free', 'trial'] } } };
+// Or with $any
+const orWithAny = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Multiple columns implicit and
+const multipleColumnsImplicitAnd = { 'settings.dark': true, 'settings.plan': 'free' };
+// Explicit $all with multi-key filter list
+const explicitAllWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $all with filter list
+const explicitAllWithFilterList = {
+    $all: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// Explicit $any with multi-key filter list
+const explicitAnyWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $any with filter list
+const explicitAnyWithFilterList = {
+    $any: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// $any with multiple values
+const anyWithMultipleValues = { number: { $any: [1, 2, 3] } };
+// $none with multiple values
+const noneWithMultipleValues = { number: { $none: [1, 2, 3] } };
+// Exists filter
+const existsFilter = { $exists: 'test' };
+// Not exists filter
+const notExistsFilter = { $notExists: 'test' };
+// Exists with all
+const existsWithAll = { $all: [{ $exists: 'settings' }, { $exists: 'name' }] };
+// Nest any with not
+const nestAnyWithNot = { $not: { $any: { 'settings.dark': true, 'settings.plan': 'free' } } };
+// Mix $all and $any with extra keys
+const mixAllAndAnyWithExtraKeys = {
+    $all: { $any: { 'settings.dark': false, 'settings.plan': 'free' }, name: 'r1' }
+};
+// Range query with less first
+const rangeQueryWithLessFirst = { age: { $lt: 30, $ge: 20 } };
+// Range query with greater first
+const rangeQueryWithGreaterFirst = { age: { $ge: 20, $lt: 30 } };
+// Ordered op
+const orderedOp = { age: { $lt: 30 } };
+// Simple includes
+const simpleIncludes = { labels: { $includes: 'test' } };
+// Simple includes with op
+const simpleIncludesWithOp = { labels: { $includes: { $contains: 'test' } } };
+// Simple includes multiple
+const simpleIncludesMultiple = { labels: { $includes: ['a', 'b', 'c'] } };
+// Simple includes multiple with op
+const simpleIncludesMultipleWithOp = {
+    labels: { $includes: [{ $is: 'a' }, { $is: 'b' }, { $is: 'c' }] }
+};
+// Includes with many comparisons
+const includesWithManyComparisons = {
+    labels: { $includes: { $all: [{ $contains: 'a' }, { $contains: 'b' }] } }
+};
+// Simple includes multiple op and value
+const simpleIncludesMultipleOpAndValue = { labels: { $includes: [{ $contains: 'a' }, 'b'] } };
+// Includes with mode and array of filters
+const includesWithModeAndArrayOfFilters = {
+    labels: { $includesNone: [{ $contains: 'test' }, 'abc', { $endsWith: 'bad' }] }
+};
+// Includes with mix of any and all in predicate position
+const includesWithMixOfAnyAndAllInPredicatePosition = {
+    labels: { $includes: { $any: { $all: [{ $startsWith: 'test' }, { $contains: 'x' }], $any: ['a', 'b'] } } }
+};
+// Simple $includesany
+const simpleIncludesAny = { labels: { $includesAny: 'test' } };
+// Simple $includesall
+const simpleIncludesAll = { labels: { $includesAll: 'test' } };
+// Simple $includesnone
+const simpleIncludesNone = { labels: { $includesNone: 'test' } };
+// Exists value must be string not int
+// @ts-expect-error
+const existsValueMustBeStringNotInt = { $exists: 42 };
+// Exists value must be string not objct
+// @ts-expect-error
+const existsValueMustBeStringNotObject = { $exists: { field: 'settings.unknown' } };
+// Filter by one column
+const filterByOneColumn = { name: 'r1' };
+// Filter with the $is operator
+const filterWithTheIsOperator = { name: { $is: 'r1' } };
+// Filter with dot notation
+const filterWithDotNotation = { 'settings.plan': 'free' };
+// Filter with nested object
+const filterWithNestedObject = { 'settings.plan': { $is: 'free' } };
+// Filter with $any operation
+const filterWithAnyOperation = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Filter with and operations
+const filterWithAndOperations = { 'settings.dark': true, 'settings.plan': 'free' };
+// Filter with both and and any operations
+const filterWithBothAndAndAnyOperations = {
+    $any: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Filter with both and and any operations in array
+const filterWithBothAndAndAnyOperationsInArray = { $any: [{ name: 'r1' }, { name: 'r2' }] };
+// Filter with exists operation
+const filterWithExistsOperation = { $exists: 'settings' };
+// Filter with exists, and and any operations
+const filterWithExistsAndAndAnyOperations = {
+    $all: [{ $exists: 'settings' }, { $exists: 'name' }]
+};
+// Filter with not exists operation
+const filterWithNotExistsOperation = { $notExists: 'settings' };
+// Filter with partial match
+const filterWithPartialMatch = { name: { $contains: 'value' } };
+// Filter with pattern operator
+const filterWithPatternOperator = { name: { $pattern: 'value' } };
+// Filter with $startsWith and $endsWith operators
+const filterWithStartsWithAndEndsWithOperators = {
+    name: { $startsWith: 'value', $endsWith: 'value' }
+};
+// Filter with numeric ranges
+const filterWithNumericRanges = { age: { $lt: 30, $ge: 20 } };
+// Filter with negations
+const filterWithNegations = { $not: { name: 'r1' } };
+// Filter with complex negations
+const filterWithComplexNegations = { $not: { $any: [{ name: 'r1' }, { name: 'r2' }] } };
+// Filter with arrays complex negations
+const filterWithArraysComplexNegations = {
+    labels: {
+        $includes: {
+            $all: [{ $contains: 'label' }, { $not: { $endsWith: '-debug' } }]
+        }
+    }
+};
+// Filters with $includesAll
+const filtersWithIncludesAll = {
+    'settings.labels': {
+        $includesAll: [{ $contains: 'label' }]
+    }
+};
+// Filter with invalid property type
+// @ts-expect-error
+const filterWithInvalidPropertyType = { name: 42 };
+// Filter with invalid dot notation property type
+// @ts-expect-error
+const filterWithInvalidNestedPropertyType = { 'settings.plan': 42 };
+// Filter with invalid nested object property type
+// @ts-expect-error
+const filterWithInvalidNestedObjectPropertyType = { settings: { plan: 42 } };
+// Filter with invalid property $is type
+// @ts-expect-error
+const filterWithInvalidOperator = { name: { $is: 42 } };
+(0, vitest_1.test)('fake test', () => {
+    // This is a fake test to make sure that the type definitions in this file are working
+});

package/dist/schema/index.d.ts

@@ -0,0 +1,21 @@
+import { Namespace, NamespaceBuildOptions } from '../namespace';
+import { BaseData } from './record';
+import { LinkDictionary, Repository } from './repository';
+export * from './operators';
+export * from './pagination';
+export { Query } from './query';
+export { isIdentifiable, isXataRecord } from './record';
+export type { Identifiable, XataRecord } from './record';
+export { Repository, RestRepository } from './repository';
+export declare type SchemaDefinition = {
+    table: string;
+    links?: LinkDictionary;
+};
+export declare type SchemaNamespaceResult<Schemas extends Record<string, BaseData>> = {
+    [Key in keyof Schemas]: Repository<Schemas[Key]>;
+};
+export declare class SchemaNamespace<Schemas extends Record<string, BaseData>> extends Namespace {
+    private links?;
+    constructor(links?: LinkDictionary | undefined);
+    build(options: NamespaceBuildOptions): SchemaNamespaceResult<Schemas>;
+}

package/dist/schema/index.js

@@ -0,0 +1,49 @@
+"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.SchemaNamespace = exports.RestRepository = exports.Repository = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
+const namespace_1 = require("../namespace");
+const lang_1 = require("../util/lang");
+const repository_1 = require("./repository");
+__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_2 = require("./repository");
+Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_2.Repository; } });
+Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_2.RestRepository; } });
+class SchemaNamespace extends namespace_1.Namespace {
+    constructor(links) {
+        super();
+        this.links = links;
+    }
+    build(options) {
+        const { getFetchProps } = options;
+        const links = this.links;
+        const schemaNamespace = new Proxy({}, {
+            get: (_target, table) => {
+                if (!(0, lang_1.isString)(table))
+                    throw new Error('Invalid table name');
+                return new repository_1.RestRepository({ schemaNamespace, getFetchProps, table, links });
+            }
+        });
+        return schemaNamespace;
+    }
+}
+exports.SchemaNamespace = SchemaNamespace;

package/dist/schema/operators.d.ts

@@ -0,0 +1,74 @@
+import { ArrayFilter, ComparableType, ComparableTypeFilter, ExistanceFilter, PropertyFilter, StringTypeFilter } from './filters';
+import { SelectableColumn } from './selection';
+/**
+ * Operator to restrict results to only values that are greater than the given value.
+ */
+export declare const gt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are greater than or equal to the given value.
+ */
+export declare const ge: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are greater than or equal to the given value.
+ */
+export declare const gte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are lower than the given value.
+ */
+export declare const lt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are lower than or equal to the given value.
+ */
+export declare const lte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are lower than or equal to the given value.
+ */
+export declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
+/**
+ * Operator to restrict results to only values that are not null.
+ */
+export declare const exists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
+/**
+ * Operator to restrict results to only values that are null.
+ */
+export declare const notExists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
+/**
+ * Operator to restrict results to only values that start with the given prefix.
+ */
+export declare const startsWith: (value: string) => StringTypeFilter;
+/**
+ * Operator to restrict results to only values that end with the given suffix.
+ */
+export declare const endsWith: (value: string) => StringTypeFilter;
+/**
+ * Operator to restrict results to only values that match the given pattern.
+ */
+export declare const pattern: (value: string) => StringTypeFilter;
+/**
+ * Operator to restrict results to only values that are equal to the given value.
+ */
+export declare const is: <T>(value: T) => PropertyFilter<T>;
+/**
+ * Operator to restrict results to only values that are not equal to the given value.
+ */
+export declare const isNot: <T>(value: T) => PropertyFilter<T>;
+/**
+ * Operator to restrict results to only values that contain the given value.
+ */
+export declare const contains: (value: string) => StringTypeFilter;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+export declare const includes: <T>(value: T) => ArrayFilter<T>;
+/**
+ * Operator to restrict results if all array items match the predicate.
+ */
+export declare const includesAll: <T>(value: T) => ArrayFilter<T>;
+/**
+ * Operator to restrict results if none array items match the predicate.
+ */
+export declare const includesNone: <T>(value: T) => ArrayFilter<T>;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+export declare const includesAny: <T>(value: T) => ArrayFilter<T>;

package/dist/schema/operators.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.includesAny = exports.includesNone = exports.includesAll = 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;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+const includes = (value) => ({ $includes: value });
+exports.includes = includes;
+/**
+ * Operator to restrict results if all array items match the predicate.
+ */
+const includesAll = (value) => ({ $includesAll: value });
+exports.includesAll = includesAll;
+/**
+ * Operator to restrict results if none array items match the predicate.
+ */
+const includesNone = (value) => ({ $includesNone: value });
+exports.includesNone = includesNone;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+const includesAny = (value) => ({ $includesAny: value });
+exports.includesAny = includesAny;

package/dist/schema/pagination.d.ts

@@ -0,0 +1,83 @@
+import { Query } from './query';
+import { XataRecord } from './record';
+export declare type PaginationQueryMeta = {
+    page: {
+        cursor: string;
+        more: boolean;
+    };
+};
+export interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
+    meta: PaginationQueryMeta;
+    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;
+}
+/**
+ * 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;
+    /**
+     * 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 = {
+    first?: string;
+} | {
+    last?: string;
+} | {
+    after?: string;
+    before?: string;
+};
+export declare type OffsetNavigationOptions = {
+    size?: number;
+    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;

package/dist/schema/pagination.js

@@ -0,0 +1,93 @@
+"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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Page_query;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAGINATION_DEFAULT_OFFSET = exports.PAGINATION_MAX_OFFSET = exports.PAGINATION_DEFAULT_SIZE = exports.PAGINATION_MAX_SIZE = 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);
+        __classPrivateFieldSet(this, _Page_query, query, "f");
+        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 } });
+        });
+    }
+    /**
+     * 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;
+    }
+}
+exports.Page = Page;
+_Page_query = new WeakMap();
+exports.PAGINATION_MAX_SIZE = 200;
+exports.PAGINATION_DEFAULT_SIZE = 200;
+exports.PAGINATION_MAX_OFFSET = 800;
+exports.PAGINATION_DEFAULT_OFFSET = 0;