@xata.io/client 0.0.0-beta.64a31a3 → 0.0.0-beta.68cefba

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,5 @@
1
1
  export * from './operators';
2
+ export type { XataRecord } from './record';
3
+ export { Repository, RestRepository, RestRespositoryFactory, BaseClient } from './repository';
4
+ export type { XataClientOptions } from './repository';
5
+ export { Query } from './query';
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -10,4 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
10
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11
15
  };
12
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.Query = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
13
18
  __exportStar(require("./operators"), exports);
19
+ var repository_1 = require("./repository");
20
+ Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });
21
+ Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_1.RestRepository; } });
22
+ Object.defineProperty(exports, "RestRespositoryFactory", { enumerable: true, get: function () { return repository_1.RestRespositoryFactory; } });
23
+ Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
24
+ var query_1 = require("./query");
25
+ Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return query_1.Query; } });
@@ -1,21 +1,72 @@
1
1
  import { Constraint } from './filters';
2
2
  declare type ComparableType = number | Date;
3
+ /**
4
+ * Operator to restrict results to only values that are greater than the given value.
5
+ */
3
6
  export declare const gt: <T extends ComparableType>(value: T) => Constraint<T>;
7
+ /**
8
+ * Operator to restrict results to only values that are greater than or equal to the given value.
9
+ */
4
10
  export declare const ge: <T extends ComparableType>(value: T) => Constraint<T>;
11
+ /**
12
+ * Operator to restrict results to only values that are greater than or equal to the given value.
13
+ */
5
14
  export declare const gte: <T extends ComparableType>(value: T) => Constraint<T>;
15
+ /**
16
+ * Operator to restrict results to only values that are lower than the given value.
17
+ */
6
18
  export declare const lt: <T extends ComparableType>(value: T) => Constraint<T>;
19
+ /**
20
+ * Operator to restrict results to only values that are lower than or equal to the given value.
21
+ */
7
22
  export declare const lte: <T extends ComparableType>(value: T) => Constraint<T>;
23
+ /**
24
+ * Operator to restrict results to only values that are lower than or equal to the given value.
25
+ */
8
26
  export declare const le: <T extends ComparableType>(value: T) => Constraint<T>;
27
+ /**
28
+ * Operator to restrict results to only values that are not null.
29
+ */
9
30
  export declare const exists: (column: string) => Constraint<string>;
31
+ /**
32
+ * Operator to restrict results to only values that are null.
33
+ */
10
34
  export declare const notExists: (column: string) => Constraint<string>;
35
+ /**
36
+ * Operator to restrict results to only values that start with the given prefix.
37
+ */
11
38
  export declare const startsWith: (value: string) => Constraint<string>;
39
+ /**
40
+ * Operator to restrict results to only values that end with the given suffix.
41
+ */
12
42
  export declare const endsWith: (value: string) => Constraint<string>;
43
+ /**
44
+ * Operator to restrict results to only values that match the given pattern.
45
+ */
13
46
  export declare const pattern: (value: string) => Constraint<string>;
47
+ /**
48
+ * Operator to restrict results to only values that are equal to the given value.
49
+ */
14
50
  export declare const is: <T>(value: T) => Constraint<T>;
51
+ /**
52
+ * Operator to restrict results to only values that are not equal to the given value.
53
+ */
15
54
  export declare const isNot: <T>(value: T) => Constraint<T>;
55
+ /**
56
+ * Operator to restrict results to only values that contain the given value.
57
+ */
16
58
  export declare const contains: <T>(value: T) => Constraint<T>;
59
+ /**
60
+ * Operator to restrict results to only arrays that include the given value.
61
+ */
17
62
  export declare const includes: (value: string) => Constraint<string>;
63
+ /**
64
+ * Operator to restrict results to only arrays that include a value matching the given substring.
65
+ */
18
66
  export declare const includesSubstring: (value: string) => Constraint<string>;
67
+ /**
68
+ * Operator to restrict results to only arrays that include a value matching the given pattern.
69
+ */
19
70
  export declare const includesPattern: (value: string) => Constraint<string>;
20
71
  export declare const includesAll: (value: string) => Constraint<string>;
21
72
  export {};
@@ -1,39 +1,90 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  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;
4
+ /**
5
+ * Operator to restrict results to only values that are greater than the given value.
6
+ */
4
7
  const gt = (value) => ({ $gt: value });
5
8
  exports.gt = gt;
9
+ /**
10
+ * Operator to restrict results to only values that are greater than or equal to the given value.
11
+ */
6
12
  const ge = (value) => ({ $ge: value });
7
13
  exports.ge = ge;
14
+ /**
15
+ * Operator to restrict results to only values that are greater than or equal to the given value.
16
+ */
8
17
  const gte = (value) => ({ $ge: value });
9
18
  exports.gte = gte;
19
+ /**
20
+ * Operator to restrict results to only values that are lower than the given value.
21
+ */
10
22
  const lt = (value) => ({ $lt: value });
11
23
  exports.lt = lt;
24
+ /**
25
+ * Operator to restrict results to only values that are lower than or equal to the given value.
26
+ */
12
27
  const lte = (value) => ({ $le: value });
13
28
  exports.lte = lte;
29
+ /**
30
+ * Operator to restrict results to only values that are lower than or equal to the given value.
31
+ */
14
32
  const le = (value) => ({ $le: value });
15
33
  exports.le = le;
34
+ /**
35
+ * Operator to restrict results to only values that are not null.
36
+ */
16
37
  const exists = (column) => ({ $exists: column });
17
38
  exports.exists = exists;
39
+ /**
40
+ * Operator to restrict results to only values that are null.
41
+ */
18
42
  const notExists = (column) => ({ $notExists: column });
19
43
  exports.notExists = notExists;
44
+ /**
45
+ * Operator to restrict results to only values that start with the given prefix.
46
+ */
20
47
  const startsWith = (value) => ({ $startsWith: value });
21
48
  exports.startsWith = startsWith;
49
+ /**
50
+ * Operator to restrict results to only values that end with the given suffix.
51
+ */
22
52
  const endsWith = (value) => ({ $endsWith: value });
23
53
  exports.endsWith = endsWith;
54
+ /**
55
+ * Operator to restrict results to only values that match the given pattern.
56
+ */
24
57
  const pattern = (value) => ({ $pattern: value });
25
58
  exports.pattern = pattern;
59
+ /**
60
+ * Operator to restrict results to only values that are equal to the given value.
61
+ */
26
62
  const is = (value) => ({ $is: value });
27
63
  exports.is = is;
64
+ /**
65
+ * Operator to restrict results to only values that are not equal to the given value.
66
+ */
28
67
  const isNot = (value) => ({ $isNot: value });
29
68
  exports.isNot = isNot;
69
+ /**
70
+ * Operator to restrict results to only values that contain the given value.
71
+ */
30
72
  const contains = (value) => ({ $contains: value });
31
73
  exports.contains = contains;
32
74
  // TODO: these can only be applied to columns of type "multiple"
75
+ /**
76
+ * Operator to restrict results to only arrays that include the given value.
77
+ */
33
78
  const includes = (value) => ({ $includes: value });
34
79
  exports.includes = includes;
80
+ /**
81
+ * Operator to restrict results to only arrays that include a value matching the given substring.
82
+ */
35
83
  const includesSubstring = (value) => ({ $includesSubstring: value });
36
84
  exports.includesSubstring = includesSubstring;
85
+ /**
86
+ * Operator to restrict results to only arrays that include a value matching the given pattern.
87
+ */
37
88
  const includesPattern = (value) => ({ $includesPattern: value });
38
89
  exports.includesPattern = includesPattern;
39
90
  const includesAll = (value) => ({ $includesAll: value });
@@ -15,15 +15,53 @@ export interface Paginable<T extends XataRecord, R extends XataRecord = T> {
15
15
  lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
16
16
  hasNextPage(): boolean;
17
17
  }
18
+ /**
19
+ * A Page contains a set of results from a query plus metadata about the retrieved
20
+ * set of values such as the cursor, required to retrieve additional records.
21
+ */
18
22
  export declare class Page<T extends XataRecord, R extends XataRecord> implements Paginable<T, R> {
19
23
  #private;
24
+ /**
25
+ * Page metadata, required to retrieve additional records.
26
+ */
20
27
  readonly meta: PaginationQueryMeta;
28
+ /**
29
+ * The set of results for this page.
30
+ */
21
31
  readonly records: R[];
22
32
  constructor(query: Query<T, R>, meta: PaginationQueryMeta, records?: R[]);
33
+ /**
34
+ * Retrieves the next page of results.
35
+ * @param size Maximum number of results to be retrieved.
36
+ * @param offset Number of results to skip when retrieving the results.
37
+ * @returns The next page or results.
38
+ */
23
39
  nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
40
+ /**
41
+ * Retrieves the previous page of results.
42
+ * @param size Maximum number of results to be retrieved.
43
+ * @param offset Number of results to skip when retrieving the results.
44
+ * @returns The previous page or results.
45
+ */
24
46
  previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
47
+ /**
48
+ * Retrieves the first page of results.
49
+ * @param size Maximum number of results to be retrieved.
50
+ * @param offset Number of results to skip when retrieving the results.
51
+ * @returns The first page or results.
52
+ */
25
53
  firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
54
+ /**
55
+ * Retrieves the last page of results.
56
+ * @param size Maximum number of results to be retrieved.
57
+ * @param offset Number of results to skip when retrieving the results.
58
+ * @returns The last page or results.
59
+ */
26
60
  lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
61
+ /**
62
+ * Shortcut method to check if there will be additional results if the next page of results is retrieved.
63
+ * @returns Whether or not there will be additional results in the next page of results.
64
+ */
27
65
  hasNextPage(): boolean;
28
66
  }
29
67
  export declare type CursorNavigationOptions = {
@@ -22,6 +22,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
22
22
  var _Page_query;
23
23
  Object.defineProperty(exports, "__esModule", { value: true });
24
24
  exports.Page = void 0;
25
+ /**
26
+ * A Page contains a set of results from a query plus metadata about the retrieved
27
+ * set of values such as the cursor, required to retrieve additional records.
28
+ */
25
29
  class Page {
26
30
  constructor(query, meta, records = []) {
27
31
  _Page_query.set(this, void 0);
@@ -29,27 +33,55 @@ class Page {
29
33
  this.meta = meta;
30
34
  this.records = records;
31
35
  }
36
+ /**
37
+ * Retrieves the next page of results.
38
+ * @param size Maximum number of results to be retrieved.
39
+ * @param offset Number of results to skip when retrieving the results.
40
+ * @returns The next page or results.
41
+ */
32
42
  nextPage(size, offset) {
33
43
  return __awaiter(this, void 0, void 0, function* () {
34
44
  return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, after: this.meta.page.cursor } });
35
45
  });
36
46
  }
47
+ /**
48
+ * Retrieves the previous page of results.
49
+ * @param size Maximum number of results to be retrieved.
50
+ * @param offset Number of results to skip when retrieving the results.
51
+ * @returns The previous page or results.
52
+ */
37
53
  previousPage(size, offset) {
38
54
  return __awaiter(this, void 0, void 0, function* () {
39
55
  return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, before: this.meta.page.cursor } });
40
56
  });
41
57
  }
58
+ /**
59
+ * Retrieves the first page of results.
60
+ * @param size Maximum number of results to be retrieved.
61
+ * @param offset Number of results to skip when retrieving the results.
62
+ * @returns The first page or results.
63
+ */
42
64
  firstPage(size, offset) {
43
65
  return __awaiter(this, void 0, void 0, function* () {
44
66
  return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, first: this.meta.page.cursor } });
45
67
  });
46
68
  }
69
+ /**
70
+ * Retrieves the last page of results.
71
+ * @param size Maximum number of results to be retrieved.
72
+ * @param offset Number of results to skip when retrieving the results.
73
+ * @returns The last page or results.
74
+ */
47
75
  lastPage(size, offset) {
48
76
  return __awaiter(this, void 0, void 0, function* () {
49
77
  return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
50
78
  });
51
79
  }
52
80
  // TODO: We need to add something on the backend if we want a hasPreviousPage
81
+ /**
82
+ * Shortcut method to check if there will be additional results if the next page of results is retrieved.
83
+ * @returns Whether or not there will be additional results in the next page of results.
84
+ */
53
85
  hasNextPage() {
54
86
  return this.meta.page.more;
55
87
  }
@@ -3,7 +3,7 @@ import { FilterExpression, SortExpression, PageConfig, ColumnsFilter } from '../
3
3
  import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
4
4
  import { PaginationOptions, Page, Paginable, PaginationQueryMeta } from './pagination';
5
5
  import { Selectable, SelectableColumn, Select } from './selection';
6
- export declare type QueryOptions<T> = {
6
+ export declare type QueryOptions<T extends XataRecord> = {
7
7
  page?: PaginationOptions;
8
8
  columns?: Extract<keyof Selectable<T>, string>[];
9
9
  sort?: SortFilter<T> | SortFilter<T>[];
@@ -14,25 +14,94 @@ export declare type QueryTableOptions = {
14
14
  page?: PageConfig;
15
15
  columns?: ColumnsFilter;
16
16
  };
17
+ /**
18
+ * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
19
+ *
20
+ * Query objects are immutable. Any method that adds more constraints or options to the query will return
21
+ * a new Query object containing the both the previous and the new constraints and options.
22
+ */
17
23
  export declare class Query<T extends XataRecord, R extends XataRecord = T> implements Paginable<T, R> {
18
24
  #private;
19
25
  readonly meta: PaginationQueryMeta;
20
26
  readonly records: R[];
21
27
  constructor(repository: Repository<T> | null, table: string, data: Partial<QueryTableOptions>, parent?: Partial<QueryTableOptions>);
22
28
  getQueryOptions(): QueryTableOptions;
29
+ /**
30
+ * Builds a new query object representing a logical OR between the given subqueries.
31
+ * @param queries An array of subqueries.
32
+ * @returns A new Query object.
33
+ */
23
34
  any(...queries: Query<T, R>[]): Query<T, R>;
35
+ /**
36
+ * Builds a new query object representing a logical AND between the given subqueries.
37
+ * @param queries An array of subqueries.
38
+ * @returns A new Query object.
39
+ */
24
40
  all(...queries: Query<T, R>[]): Query<T, R>;
41
+ /**
42
+ * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
43
+ * @param queries An array of subqueries.
44
+ * @returns A new Query object.
45
+ */
25
46
  not(...queries: Query<T, R>[]): Query<T, R>;
47
+ /**
48
+ * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
49
+ * @param queries An array of subqueries.
50
+ * @returns A new Query object.
51
+ */
26
52
  none(...queries: Query<T, R>[]): Query<T, R>;
53
+ /**
54
+ * Builds a new query object adding one or more constraints. Examples:
55
+ *
56
+ * ```
57
+ * query.filter("columnName", columnValue)
58
+ * query.filter({
59
+ * "columnName": columnValue
60
+ * })
61
+ * query.filter({
62
+ * "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
63
+ * })
64
+ * ```
65
+ *
66
+ * @param constraints
67
+ * @returns A new Query object.
68
+ */
27
69
  filter(constraints: FilterConstraints<T>): Query<T, R>;
28
- filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
70
+ filter<F extends keyof Selectable<T>>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
71
+ /**
72
+ * Builds a new query with a new sort option.
73
+ * @param column The column name.
74
+ * @param direction The direction. Either ascending or descending.
75
+ * @returns A new Query object.
76
+ */
29
77
  sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
78
+ /**
79
+ * Builds a new query specifying the set of columns to be returned in the query response.
80
+ * @param columns Array of column names to be returned by the query.
81
+ * @returns A new Query object.
82
+ */
30
83
  select<K extends SelectableColumn<T>>(columns: K[]): Query<T, Select<T, K>>;
31
- getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
84
+ getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, typeof options extends {
85
+ columns: SelectableColumn<T>[];
86
+ } ? Select<T, typeof options['columns'][number]> : R>>;
32
87
  [Symbol.asyncIterator](): AsyncIterableIterator<R>;
33
88
  getIterator(chunk: number, options?: Omit<QueryOptions<T>, 'page'>): AsyncGenerator<R[]>;
34
- getMany<Options extends QueryOptions<T>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R)[]>;
35
- getOne<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R) | null>;
89
+ /**
90
+ * Performs the query in the database and returns a set of results.
91
+ * @param options Additional options to be used when performing the query.
92
+ * @returns An array of records from the database.
93
+ */
94
+ getMany<Options extends QueryOptions<T>>(options?: Options): Promise<(typeof options extends {
95
+ columns: SelectableColumn<T>[];
96
+ } ? Select<T, typeof options['columns'][number]> : R)[]>;
97
+ /**
98
+ * Performs the query in the database and returns the first result.
99
+ * @param options Additional options to be used when performing the query.
100
+ * @returns The first record that matches the query, or null if no record matched the query.
101
+ */
102
+ getOne<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options extends {
103
+ columns: SelectableColumn<T>[];
104
+ } ? Select<T, typeof options['columns'][number]> : R) | null>;
36
105
  /**async deleteAll(): Promise<number> {
37
106
  // TODO: Return number of affected rows
38
107
  return 0;
@@ -42,6 +42,12 @@ var _Query_table, _Query_repository, _Query_data;
42
42
  Object.defineProperty(exports, "__esModule", { value: true });
43
43
  exports.Query = void 0;
44
44
  const lang_1 = require("../util/lang");
45
+ /**
46
+ * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
47
+ *
48
+ * Query objects are immutable. Any method that adds more constraints or options to the query will return
49
+ * a new Query object containing the both the previous and the new constraints and options.
50
+ */
45
51
  class Query {
46
52
  constructor(repository, table, data, parent) {
47
53
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
@@ -76,20 +82,40 @@ class Query {
76
82
  getQueryOptions() {
77
83
  return __classPrivateFieldGet(this, _Query_data, "f");
78
84
  }
85
+ /**
86
+ * Builds a new query object representing a logical OR between the given subqueries.
87
+ * @param queries An array of subqueries.
88
+ * @returns A new Query object.
89
+ */
79
90
  any(...queries) {
80
- const $any = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$any)).flat();
91
+ const $any = queries.map((query) => query.getQueryOptions().filter);
81
92
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $any } }, __classPrivateFieldGet(this, _Query_data, "f"));
82
93
  }
94
+ /**
95
+ * Builds a new query object representing a logical AND between the given subqueries.
96
+ * @param queries An array of subqueries.
97
+ * @returns A new Query object.
98
+ */
83
99
  all(...queries) {
84
- const $all = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$all)).flat();
100
+ const $all = queries.map((query) => query.getQueryOptions().filter);
85
101
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
86
102
  }
103
+ /**
104
+ * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
105
+ * @param queries An array of subqueries.
106
+ * @returns A new Query object.
107
+ */
87
108
  not(...queries) {
88
- const $not = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$not)).flat();
109
+ const $not = queries.map((query) => query.getQueryOptions().filter);
89
110
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $not } }, __classPrivateFieldGet(this, _Query_data, "f"));
90
111
  }
112
+ /**
113
+ * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
114
+ * @param queries An array of subqueries.
115
+ * @returns A new Query object.
116
+ */
91
117
  none(...queries) {
92
- const $none = (0, lang_1.compact)(queries.map((query) => query.getQueryOptions().filter.$none)).flat();
118
+ const $none = queries.map((query) => query.getQueryOptions().filter);
93
119
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $none } }, __classPrivateFieldGet(this, _Query_data, "f"));
94
120
  }
95
121
  filter(a, b) {
@@ -105,17 +131,26 @@ class Query {
105
131
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
106
132
  }
107
133
  }
134
+ /**
135
+ * Builds a new query with a new sort option.
136
+ * @param column The column name.
137
+ * @param direction The direction. Either ascending or descending.
138
+ * @returns A new Query object.
139
+ */
108
140
  sort(column, direction) {
109
141
  const sort = Object.assign(Object.assign({}, __classPrivateFieldGet(this, _Query_data, "f").sort), { [column]: direction });
110
142
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { sort }, __classPrivateFieldGet(this, _Query_data, "f"));
111
143
  }
144
+ /**
145
+ * Builds a new query specifying the set of columns to be returned in the query response.
146
+ * @param columns Array of column names to be returned by the query.
147
+ * @returns A new Query object.
148
+ */
112
149
  select(columns) {
113
150
  return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { columns }, __classPrivateFieldGet(this, _Query_data, "f"));
114
151
  }
115
152
  getPaginated(options = {}) {
116
- return __awaiter(this, void 0, void 0, function* () {
117
- return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
118
- });
153
+ return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
119
154
  }
120
155
  [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
121
156
  return __asyncGenerator(this, arguments, function* _a() {
@@ -147,12 +182,22 @@ class Query {
147
182
  }
148
183
  });
149
184
  }
185
+ /**
186
+ * Performs the query in the database and returns a set of results.
187
+ * @param options Additional options to be used when performing the query.
188
+ * @returns An array of records from the database.
189
+ */
150
190
  getMany(options = {}) {
151
191
  return __awaiter(this, void 0, void 0, function* () {
152
192
  const { records } = yield this.getPaginated(options);
153
193
  return records;
154
194
  });
155
195
  }
196
+ /**
197
+ * Performs the query in the database and returns the first result.
198
+ * @param options Additional options to be used when performing the query.
199
+ * @returns The first record that matches the query, or null if no record matched the query.
200
+ */
156
201
  getOne(options = {}) {
157
202
  return __awaiter(this, void 0, void 0, function* () {
158
203
  const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
@@ -164,24 +209,16 @@ class Query {
164
209
  return 0;
165
210
  }**/
166
211
  nextPage(size, offset) {
167
- return __awaiter(this, void 0, void 0, function* () {
168
- return this.firstPage(size, offset);
169
- });
212
+ return this.firstPage(size, offset);
170
213
  }
171
214
  previousPage(size, offset) {
172
- return __awaiter(this, void 0, void 0, function* () {
173
- return this.firstPage(size, offset);
174
- });
215
+ return this.firstPage(size, offset);
175
216
  }
176
217
  firstPage(size, offset) {
177
- return __awaiter(this, void 0, void 0, function* () {
178
- return this.getPaginated({ page: { size, offset } });
179
- });
218
+ return this.getPaginated({ page: { size, offset } });
180
219
  }
181
220
  lastPage(size, offset) {
182
- return __awaiter(this, void 0, void 0, function* () {
183
- return this.getPaginated({ page: { size, offset, before: 'end' } });
184
- });
221
+ return this.getPaginated({ page: { size, offset, before: 'end' } });
185
222
  }
186
223
  hasNextPage() {
187
224
  return this.meta.page.more;
@@ -0,0 +1,36 @@
1
+ import { Selectable } from './selection';
2
+ /**
3
+ * Represents a persisted record from the database.
4
+ */
5
+ export interface XataRecord {
6
+ /**
7
+ * Unique id of this record.
8
+ */
9
+ id: string;
10
+ /**
11
+ * Metadata of this record.
12
+ */
13
+ xata: {
14
+ /**
15
+ * Number that is increased every time the record is updated.
16
+ */
17
+ version: number;
18
+ };
19
+ /**
20
+ * Retrieves a refreshed copy of the current record from the database.
21
+ */
22
+ read(): Promise<this>;
23
+ /**
24
+ * Performs a partial update of the current record. On success a new object is
25
+ * returned and the current object is not mutated.
26
+ * @param data The columns and their values that have to be updated.
27
+ * @returns A new record containing the latest values for all the columns of the current record.
28
+ */
29
+ update(data: Partial<Selectable<this>>): Promise<this>;
30
+ /**
31
+ * Performs a deletion of the current record in the database.
32
+ *
33
+ * @throws If the record was already deleted or if an error happened while performing the deletion.
34
+ */
35
+ delete(): Promise<void>;
36
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });