@xata.io/client 0.0.0-beta.18f8d57 → 0.0.0-beta.4e4e7fc

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.
Files changed (41) hide show
  1. package/dist/api/client.d.ts +93 -0
  2. package/dist/api/client.js +229 -0
  3. package/dist/api/components.d.ts +1416 -0
  4. package/dist/api/components.js +988 -0
  5. package/dist/api/fetcher.d.ts +25 -0
  6. package/dist/api/fetcher.js +78 -0
  7. package/dist/api/index.d.ts +7 -0
  8. package/dist/api/index.js +21 -0
  9. package/dist/api/parameters.d.ts +15 -0
  10. package/dist/api/parameters.js +2 -0
  11. package/dist/api/providers.d.ts +8 -0
  12. package/dist/api/providers.js +29 -0
  13. package/dist/api/responses.d.ts +44 -0
  14. package/dist/api/responses.js +2 -0
  15. package/dist/api/schemas.d.ts +311 -0
  16. package/dist/api/schemas.js +2 -0
  17. package/dist/index.d.ts +2 -182
  18. package/dist/index.js +16 -499
  19. package/dist/schema/filters.d.ts +20 -0
  20. package/dist/schema/filters.js +24 -0
  21. package/dist/schema/index.d.ts +5 -0
  22. package/dist/schema/index.js +25 -0
  23. package/dist/schema/operators.d.ts +21 -0
  24. package/dist/schema/operators.js +40 -0
  25. package/dist/schema/pagination.d.ts +41 -0
  26. package/dist/schema/pagination.js +58 -0
  27. package/dist/schema/query.d.ts +45 -0
  28. package/dist/schema/query.js +190 -0
  29. package/dist/schema/record.d.ts +10 -0
  30. package/dist/schema/record.js +2 -0
  31. package/dist/schema/repository.d.ts +52 -0
  32. package/dist/schema/repository.js +260 -0
  33. package/dist/schema/selection.d.ts +14 -0
  34. package/dist/schema/selection.js +2 -0
  35. package/dist/util/lang.d.ts +2 -0
  36. package/dist/util/lang.js +10 -0
  37. package/dist/util/types.d.ts +3 -0
  38. package/dist/util/types.js +2 -0
  39. package/package.json +2 -2
  40. package/dist/util/errors.d.ts +0 -3
  41. package/dist/util/errors.js +0 -9
@@ -0,0 +1,41 @@
1
+ import { XataRecord } from '..';
2
+ import { Query } from './query';
3
+ export declare type PaginationQueryMeta = {
4
+ page: {
5
+ cursor: string;
6
+ more: boolean;
7
+ };
8
+ };
9
+ export interface Paginable<T extends XataRecord, R extends XataRecord = T> {
10
+ meta: PaginationQueryMeta;
11
+ records: R[];
12
+ nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
13
+ previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
14
+ firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
15
+ lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
16
+ hasNextPage(): boolean;
17
+ }
18
+ export declare class Page<T extends XataRecord, R extends XataRecord> implements Paginable<T, R> {
19
+ #private;
20
+ readonly meta: PaginationQueryMeta;
21
+ readonly records: R[];
22
+ constructor(query: Query<T, R>, meta: PaginationQueryMeta, records?: R[]);
23
+ nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
24
+ previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
25
+ firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
26
+ lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
27
+ hasNextPage(): boolean;
28
+ }
29
+ export declare type CursorNavigationOptions = {
30
+ first?: string;
31
+ } | {
32
+ last?: string;
33
+ } | {
34
+ after?: string;
35
+ before?: string;
36
+ };
37
+ export declare type OffsetNavigationOptions = {
38
+ size?: number;
39
+ offset?: number;
40
+ };
41
+ export declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
+ if (kind === "m") throw new TypeError("Private method is not writable");
13
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
+ 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");
15
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
+ };
17
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
18
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
19
+ 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");
20
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
+ };
22
+ var _Page_query;
23
+ Object.defineProperty(exports, "__esModule", { value: true });
24
+ exports.Page = void 0;
25
+ class Page {
26
+ constructor(query, meta, records = []) {
27
+ _Page_query.set(this, void 0);
28
+ __classPrivateFieldSet(this, _Page_query, query, "f");
29
+ this.meta = meta;
30
+ this.records = records;
31
+ }
32
+ nextPage(size, offset) {
33
+ return __awaiter(this, void 0, void 0, function* () {
34
+ return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, after: this.meta.page.cursor } });
35
+ });
36
+ }
37
+ previousPage(size, offset) {
38
+ return __awaiter(this, void 0, void 0, function* () {
39
+ return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, before: this.meta.page.cursor } });
40
+ });
41
+ }
42
+ firstPage(size, offset) {
43
+ return __awaiter(this, void 0, void 0, function* () {
44
+ return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, first: this.meta.page.cursor } });
45
+ });
46
+ }
47
+ lastPage(size, offset) {
48
+ return __awaiter(this, void 0, void 0, function* () {
49
+ return __classPrivateFieldGet(this, _Page_query, "f").getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
50
+ });
51
+ }
52
+ // TODO: We need to add something on the backend if we want a hasPreviousPage
53
+ hasNextPage() {
54
+ return this.meta.page.more;
55
+ }
56
+ }
57
+ exports.Page = Page;
58
+ _Page_query = new WeakMap();
@@ -0,0 +1,45 @@
1
+ import { XataRecord, Repository } from '..';
2
+ import { FilterExpression, SortExpression, PageConfig, ColumnsFilter } from '../api/schemas';
3
+ import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
4
+ import { PaginationOptions, Page, Paginable, PaginationQueryMeta } from './pagination';
5
+ import { Selectable, SelectableColumn, Select } from './selection';
6
+ export declare type QueryOptions<T extends XataRecord> = {
7
+ page?: PaginationOptions;
8
+ columns?: Extract<keyof Selectable<T>, string>[];
9
+ sort?: SortFilter<T> | SortFilter<T>[];
10
+ };
11
+ export declare type QueryTableOptions = {
12
+ filter: FilterExpression;
13
+ sort?: SortExpression;
14
+ page?: PageConfig;
15
+ columns?: ColumnsFilter;
16
+ };
17
+ export declare class Query<T extends XataRecord, R extends XataRecord = T> implements Paginable<T, R> {
18
+ #private;
19
+ readonly meta: PaginationQueryMeta;
20
+ readonly records: R[];
21
+ constructor(repository: Repository<T> | null, table: string, data: Partial<QueryTableOptions>, parent?: Partial<QueryTableOptions>);
22
+ getQueryOptions(): QueryTableOptions;
23
+ any(...queries: Query<T, R>[]): Query<T, R>;
24
+ all(...queries: Query<T, R>[]): Query<T, R>;
25
+ not(...queries: Query<T, R>[]): Query<T, R>;
26
+ none(...queries: Query<T, R>[]): Query<T, R>;
27
+ 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>;
29
+ sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
30
+ 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>>;
32
+ [Symbol.asyncIterator](): AsyncIterableIterator<R>;
33
+ 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>;
36
+ /**async deleteAll(): Promise<number> {
37
+ // TODO: Return number of affected rows
38
+ return 0;
39
+ }**/
40
+ nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
41
+ previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
42
+ firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
43
+ lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
44
+ hasNextPage(): boolean;
45
+ }
@@ -0,0 +1,190 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
+ if (kind === "m") throw new TypeError("Private method is not writable");
13
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
+ 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");
15
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
+ };
17
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
18
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
19
+ 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");
20
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
+ };
22
+ var __asyncValues = (this && this.__asyncValues) || function (o) {
23
+ if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
24
+ var m = o[Symbol.asyncIterator], i;
25
+ 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);
26
+ 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); }); }; }
27
+ function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
28
+ };
29
+ var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
30
+ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
31
+ if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
32
+ var g = generator.apply(thisArg, _arguments || []), i, q = [];
33
+ return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
34
+ function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
35
+ function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
36
+ function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
37
+ function fulfill(value) { resume("next", value); }
38
+ function reject(value) { resume("throw", value); }
39
+ function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
40
+ };
41
+ var _Query_table, _Query_repository, _Query_data;
42
+ Object.defineProperty(exports, "__esModule", { value: true });
43
+ exports.Query = void 0;
44
+ const lang_1 = require("../util/lang");
45
+ class Query {
46
+ constructor(repository, table, data, parent) {
47
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
48
+ _Query_table.set(this, void 0);
49
+ _Query_repository.set(this, void 0);
50
+ _Query_data.set(this, { filter: {} });
51
+ // Implements pagination
52
+ this.meta = { page: { cursor: 'start', more: true } };
53
+ this.records = [];
54
+ __classPrivateFieldSet(this, _Query_table, table, "f");
55
+ if (repository) {
56
+ __classPrivateFieldSet(this, _Query_repository, repository, "f");
57
+ }
58
+ else {
59
+ __classPrivateFieldSet(this, _Query_repository, this, "f");
60
+ }
61
+ __classPrivateFieldGet(this, _Query_data, "f").filter.$any = (_b = (_a = data.filter) === null || _a === void 0 ? void 0 : _a.$any) !== null && _b !== void 0 ? _b : (_c = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _c === void 0 ? void 0 : _c.$any;
62
+ __classPrivateFieldGet(this, _Query_data, "f").filter.$all = (_e = (_d = data.filter) === null || _d === void 0 ? void 0 : _d.$all) !== null && _e !== void 0 ? _e : (_f = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _f === void 0 ? void 0 : _f.$all;
63
+ __classPrivateFieldGet(this, _Query_data, "f").filter.$not = (_h = (_g = data.filter) === null || _g === void 0 ? void 0 : _g.$not) !== null && _h !== void 0 ? _h : (_j = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _j === void 0 ? void 0 : _j.$not;
64
+ __classPrivateFieldGet(this, _Query_data, "f").filter.$none = (_l = (_k = data.filter) === null || _k === void 0 ? void 0 : _k.$none) !== null && _l !== void 0 ? _l : (_m = parent === null || parent === void 0 ? void 0 : parent.filter) === null || _m === void 0 ? void 0 : _m.$none;
65
+ __classPrivateFieldGet(this, _Query_data, "f").sort = (_o = data.sort) !== null && _o !== void 0 ? _o : parent === null || parent === void 0 ? void 0 : parent.sort;
66
+ __classPrivateFieldGet(this, _Query_data, "f").columns = (_q = (_p = data.columns) !== null && _p !== void 0 ? _p : parent === null || parent === void 0 ? void 0 : parent.columns) !== null && _q !== void 0 ? _q : ['*'];
67
+ this.any = this.any.bind(this);
68
+ this.all = this.all.bind(this);
69
+ this.not = this.not.bind(this);
70
+ this.filter = this.filter.bind(this);
71
+ this.sort = this.sort.bind(this);
72
+ this.none = this.none.bind(this);
73
+ Object.defineProperty(this, 'table', { enumerable: false });
74
+ Object.defineProperty(this, 'repository', { enumerable: false });
75
+ }
76
+ getQueryOptions() {
77
+ return __classPrivateFieldGet(this, _Query_data, "f");
78
+ }
79
+ any(...queries) {
80
+ const $any = queries.map((query) => query.getQueryOptions().filter);
81
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $any } }, __classPrivateFieldGet(this, _Query_data, "f"));
82
+ }
83
+ all(...queries) {
84
+ const $all = queries.map((query) => query.getQueryOptions().filter);
85
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
86
+ }
87
+ not(...queries) {
88
+ const $not = queries.map((query) => query.getQueryOptions().filter);
89
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $not } }, __classPrivateFieldGet(this, _Query_data, "f"));
90
+ }
91
+ none(...queries) {
92
+ const $none = queries.map((query) => query.getQueryOptions().filter);
93
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $none } }, __classPrivateFieldGet(this, _Query_data, "f"));
94
+ }
95
+ filter(a, b) {
96
+ if (arguments.length === 1) {
97
+ const constraints = Object.entries(a).map(([column, constraint]) => ({ [column]: constraint }));
98
+ const $all = (0, lang_1.compact)([__classPrivateFieldGet(this, _Query_data, "f").filter.$all].flat().concat(constraints));
99
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
100
+ }
101
+ else {
102
+ const column = a;
103
+ const value = b;
104
+ const $all = (0, lang_1.compact)([__classPrivateFieldGet(this, _Query_data, "f").filter.$all].flat().concat({ [column]: value }));
105
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { filter: { $all } }, __classPrivateFieldGet(this, _Query_data, "f"));
106
+ }
107
+ }
108
+ sort(column, direction) {
109
+ const sort = Object.assign(Object.assign({}, __classPrivateFieldGet(this, _Query_data, "f").sort), { [column]: direction });
110
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { sort }, __classPrivateFieldGet(this, _Query_data, "f"));
111
+ }
112
+ select(columns) {
113
+ return new Query(__classPrivateFieldGet(this, _Query_repository, "f"), __classPrivateFieldGet(this, _Query_table, "f"), { columns }, __classPrivateFieldGet(this, _Query_data, "f"));
114
+ }
115
+ getPaginated(options = {}) {
116
+ return __awaiter(this, void 0, void 0, function* () {
117
+ return __classPrivateFieldGet(this, _Query_repository, "f").query(this, options);
118
+ });
119
+ }
120
+ [(_Query_table = new WeakMap(), _Query_repository = new WeakMap(), _Query_data = new WeakMap(), Symbol.asyncIterator)]() {
121
+ return __asyncGenerator(this, arguments, function* _a() {
122
+ var e_1, _b;
123
+ try {
124
+ for (var _c = __asyncValues(this.getIterator(1)), _d; _d = yield __await(_c.next()), !_d.done;) {
125
+ const [record] = _d.value;
126
+ yield yield __await(record);
127
+ }
128
+ }
129
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
130
+ finally {
131
+ try {
132
+ if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
133
+ }
134
+ finally { if (e_1) throw e_1.error; }
135
+ }
136
+ });
137
+ }
138
+ getIterator(chunk, options = {}) {
139
+ return __asyncGenerator(this, arguments, function* getIterator_1() {
140
+ let offset = 0;
141
+ let end = false;
142
+ while (!end) {
143
+ const { records, meta } = yield __await(this.getPaginated(Object.assign(Object.assign({}, options), { page: { size: chunk, offset } })));
144
+ yield yield __await(records);
145
+ offset += chunk;
146
+ end = !meta.page.more;
147
+ }
148
+ });
149
+ }
150
+ getMany(options = {}) {
151
+ return __awaiter(this, void 0, void 0, function* () {
152
+ const { records } = yield this.getPaginated(options);
153
+ return records;
154
+ });
155
+ }
156
+ getOne(options = {}) {
157
+ return __awaiter(this, void 0, void 0, function* () {
158
+ const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
159
+ return records[0] || null;
160
+ });
161
+ }
162
+ /**async deleteAll(): Promise<number> {
163
+ // TODO: Return number of affected rows
164
+ return 0;
165
+ }**/
166
+ nextPage(size, offset) {
167
+ return __awaiter(this, void 0, void 0, function* () {
168
+ return this.firstPage(size, offset);
169
+ });
170
+ }
171
+ previousPage(size, offset) {
172
+ return __awaiter(this, void 0, void 0, function* () {
173
+ return this.firstPage(size, offset);
174
+ });
175
+ }
176
+ firstPage(size, offset) {
177
+ return __awaiter(this, void 0, void 0, function* () {
178
+ return this.getPaginated({ page: { size, offset } });
179
+ });
180
+ }
181
+ lastPage(size, offset) {
182
+ return __awaiter(this, void 0, void 0, function* () {
183
+ return this.getPaginated({ page: { size, offset, before: 'end' } });
184
+ });
185
+ }
186
+ hasNextPage() {
187
+ return this.meta.page.more;
188
+ }
189
+ }
190
+ exports.Query = Query;
@@ -0,0 +1,10 @@
1
+ import { Selectable } from './selection';
2
+ export interface XataRecord {
3
+ id: string;
4
+ xata: {
5
+ version: number;
6
+ };
7
+ read(): Promise<this>;
8
+ update(data: Partial<Selectable<this>>): Promise<this>;
9
+ delete(): Promise<void>;
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,52 @@
1
+ import { FetchImpl } from '../api/fetcher';
2
+ import { Page } from './pagination';
3
+ import { Query, QueryOptions } from './query';
4
+ import { XataRecord } from './record';
5
+ import { Selectable, SelectableColumn, Select } from './selection';
6
+ export declare type Links = Record<string, Array<string[]>>;
7
+ export declare abstract class Repository<T extends XataRecord> extends Query<T> {
8
+ abstract create(object: Selectable<T>): Promise<T>;
9
+ abstract createMany(objects: Selectable<T>[]): Promise<T[]>;
10
+ abstract read(id: string): Promise<T | null>;
11
+ abstract update(id: string, object: Partial<Selectable<T>>): Promise<T>;
12
+ abstract upsert(id: string, object: Selectable<T>): Promise<T>;
13
+ abstract delete(id: string): void;
14
+ abstract query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
15
+ }
16
+ export declare class RestRepository<T extends XataRecord> extends Repository<T> {
17
+ #private;
18
+ constructor(client: BaseClient<any>, table: string);
19
+ create(object: Selectable<T>): Promise<T>;
20
+ createMany(objects: T[]): Promise<T[]>;
21
+ read(recordId: string): Promise<T | null>;
22
+ update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
23
+ upsert(recordId: string, object: Selectable<T>): Promise<T>;
24
+ delete(recordId: string): Promise<void>;
25
+ query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
26
+ }
27
+ interface RepositoryFactory {
28
+ createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
29
+ }
30
+ export declare class RestRespositoryFactory implements RepositoryFactory {
31
+ createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
32
+ }
33
+ declare type BranchStrategyValue = string | undefined | null;
34
+ declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
35
+ declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
36
+ declare type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
37
+ export declare type XataClientOptions = {
38
+ fetch?: FetchImpl;
39
+ databaseURL?: string;
40
+ branch: BranchStrategyOption;
41
+ apiKey: string;
42
+ repositoryFactory?: RepositoryFactory;
43
+ };
44
+ export declare class BaseClient<D extends Record<string, Repository<any>>> {
45
+ #private;
46
+ options: XataClientOptions;
47
+ db: D;
48
+ constructor(options: XataClientOptions, links: Links);
49
+ initObject<T>(table: string, object: object): T;
50
+ getBranch(): Promise<string>;
51
+ }
52
+ export {};