@xata.io/client 0.0.0-alpha.vf3081bb → 0.0.0-alpha.vf3111df
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.
- package/CHANGELOG.md +98 -0
- package/README.md +43 -35
- package/Usage.md +449 -0
- package/dist/index.cjs +645 -380
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +648 -160
- package/dist/index.mjs +622 -381
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -4
package/dist/index.d.ts
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
declare type AttributeDictionary = Record<string, string | number | boolean | undefined>;
|
2
|
+
declare type TraceFunction = <T>(name: string, fn: (options: {
|
3
|
+
setAttributes: (attrs: AttributeDictionary) => void;
|
4
|
+
onError: (message: string) => void;
|
5
|
+
}) => T, options?: AttributeDictionary) => Promise<T>;
|
6
|
+
|
1
7
|
declare type FetchImpl = (url: string, init?: {
|
2
8
|
body?: string;
|
3
9
|
headers?: Record<string, string>;
|
@@ -5,7 +11,11 @@ declare type FetchImpl = (url: string, init?: {
|
|
5
11
|
}) => Promise<{
|
6
12
|
ok: boolean;
|
7
13
|
status: number;
|
14
|
+
url: string;
|
8
15
|
json(): Promise<any>;
|
16
|
+
headers?: {
|
17
|
+
get(name: string): string | null;
|
18
|
+
};
|
9
19
|
}>;
|
10
20
|
declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
|
11
21
|
declare type FetcherExtraProps = {
|
@@ -13,6 +23,7 @@ declare type FetcherExtraProps = {
|
|
13
23
|
workspacesApiUrl: string | WorkspaceApiUrlBuilder;
|
14
24
|
fetchImpl: FetchImpl;
|
15
25
|
apiKey: string;
|
26
|
+
trace: TraceFunction;
|
16
27
|
};
|
17
28
|
declare type ErrorWrapper<TError> = TError | {
|
18
29
|
status: 'unknown';
|
@@ -20,7 +31,6 @@ declare type ErrorWrapper<TError> = TError | {
|
|
20
31
|
};
|
21
32
|
|
22
33
|
interface CacheImpl {
|
23
|
-
cacheRecords: boolean;
|
24
34
|
defaultQueryTTL: number;
|
25
35
|
getAll(): Promise<Record<string, unknown>>;
|
26
36
|
get: <T>(key: string) => Promise<T | null>;
|
@@ -30,13 +40,11 @@ interface CacheImpl {
|
|
30
40
|
}
|
31
41
|
interface SimpleCacheOptions {
|
32
42
|
max?: number;
|
33
|
-
cacheRecords?: boolean;
|
34
43
|
defaultQueryTTL?: number;
|
35
44
|
}
|
36
45
|
declare class SimpleCache implements CacheImpl {
|
37
46
|
#private;
|
38
47
|
capacity: number;
|
39
|
-
cacheRecords: boolean;
|
40
48
|
defaultQueryTTL: number;
|
41
49
|
constructor(options?: SimpleCacheOptions);
|
42
50
|
getAll(): Promise<Record<string, unknown>>;
|
@@ -52,6 +60,7 @@ declare abstract class XataPlugin {
|
|
52
60
|
declare type XataPluginOptions = {
|
53
61
|
getFetchProps: () => Promise<FetcherExtraProps>;
|
54
62
|
cache: CacheImpl;
|
63
|
+
trace?: TraceFunction;
|
55
64
|
};
|
56
65
|
|
57
66
|
/**
|
@@ -122,16 +131,20 @@ declare type WorkspaceMembers = {
|
|
122
131
|
* @pattern ^ik_[a-zA-Z0-9]+
|
123
132
|
*/
|
124
133
|
declare type InviteKey = string;
|
134
|
+
/**
|
135
|
+
* Metadata of databases
|
136
|
+
*/
|
137
|
+
declare type DatabaseMetadata = {
|
138
|
+
name: string;
|
139
|
+
displayName: string;
|
140
|
+
createdAt: DateTime;
|
141
|
+
numberOfBranches: number;
|
142
|
+
ui?: {
|
143
|
+
color?: string;
|
144
|
+
};
|
145
|
+
};
|
125
146
|
declare type ListDatabasesResponse = {
|
126
|
-
databases?:
|
127
|
-
name: string;
|
128
|
-
displayName: string;
|
129
|
-
createdAt: DateTime;
|
130
|
-
numberOfBranches: number;
|
131
|
-
ui?: {
|
132
|
-
color?: string;
|
133
|
-
};
|
134
|
-
}[];
|
147
|
+
databases?: DatabaseMetadata[];
|
135
148
|
};
|
136
149
|
declare type ListBranchesResponse = {
|
137
150
|
databaseName: string;
|
@@ -279,6 +292,10 @@ declare type SortOrder = 'asc' | 'desc';
|
|
279
292
|
* @minimum 0
|
280
293
|
*/
|
281
294
|
declare type FuzzinessExpression = number;
|
295
|
+
/**
|
296
|
+
* If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
|
297
|
+
*/
|
298
|
+
declare type PrefixExpression = 'phrase' | 'disabled';
|
282
299
|
/**
|
283
300
|
* @minProperties 1
|
284
301
|
*/
|
@@ -296,6 +313,44 @@ declare type HighlightExpression = {
|
|
296
313
|
enabled?: boolean;
|
297
314
|
encodeHTML?: boolean;
|
298
315
|
};
|
316
|
+
/**
|
317
|
+
* Booster Expression
|
318
|
+
*
|
319
|
+
* @x-go-type xata.BoosterExpression
|
320
|
+
*/
|
321
|
+
declare type BoosterExpression = {
|
322
|
+
valueBooster?: ValueBooster$1;
|
323
|
+
} | {
|
324
|
+
numericBooster?: NumericBooster$1;
|
325
|
+
} | {
|
326
|
+
dateBooster?: DateBooster$1;
|
327
|
+
};
|
328
|
+
/**
|
329
|
+
* Boost records with a particular value for a column.
|
330
|
+
*/
|
331
|
+
declare type ValueBooster$1 = {
|
332
|
+
column: string;
|
333
|
+
value: string | number | boolean;
|
334
|
+
factor: number;
|
335
|
+
};
|
336
|
+
/**
|
337
|
+
* Boost records based on the value of a numeric column.
|
338
|
+
*/
|
339
|
+
declare type NumericBooster$1 = {
|
340
|
+
column: string;
|
341
|
+
factor: number;
|
342
|
+
};
|
343
|
+
/**
|
344
|
+
* Boost records based on the value of a datetime column. It is configured via "origin", "scale", and "decay". The further away from the "origin",
|
345
|
+
* the more the score is decayed. The decay function uses an exponential function. For example if origin is "now", and scale is 10 days and decay is 0.5, it
|
346
|
+
* should be interpreted as: a record with a date 10 days before/after origin will score 2 times less than a record with the date at origin.
|
347
|
+
*/
|
348
|
+
declare type DateBooster$1 = {
|
349
|
+
column: string;
|
350
|
+
origin?: string;
|
351
|
+
scale: string;
|
352
|
+
decay: number;
|
353
|
+
};
|
299
354
|
declare type FilterList = FilterExpression | FilterExpression[];
|
300
355
|
declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
301
356
|
/**
|
@@ -352,7 +407,24 @@ declare type PageConfig = {
|
|
352
407
|
size?: number;
|
353
408
|
offset?: number;
|
354
409
|
};
|
355
|
-
declare type
|
410
|
+
declare type ColumnsProjection = string[];
|
411
|
+
/**
|
412
|
+
* Xata Table Record Metadata
|
413
|
+
*/
|
414
|
+
declare type RecordMeta = {
|
415
|
+
id: RecordID;
|
416
|
+
xata: {
|
417
|
+
version: number;
|
418
|
+
table?: string;
|
419
|
+
highlight?: {
|
420
|
+
[key: string]: string[] | {
|
421
|
+
[key: string]: any;
|
422
|
+
};
|
423
|
+
};
|
424
|
+
score?: number;
|
425
|
+
warnings?: string[];
|
426
|
+
};
|
427
|
+
};
|
356
428
|
/**
|
357
429
|
* @pattern [a-zA-Z0-9_-~:]+
|
358
430
|
*/
|
@@ -374,21 +446,9 @@ declare type RecordsMetadata = {
|
|
374
446
|
};
|
375
447
|
};
|
376
448
|
/**
|
377
|
-
* Xata Table Record
|
449
|
+
* Xata Table Record Metadata
|
378
450
|
*/
|
379
|
-
declare type XataRecord$1 = {
|
380
|
-
id: RecordID;
|
381
|
-
xata: {
|
382
|
-
version: number;
|
383
|
-
table?: string;
|
384
|
-
highlight?: {
|
385
|
-
[key: string]: string[] | {
|
386
|
-
[key: string]: any;
|
387
|
-
};
|
388
|
-
};
|
389
|
-
warnings?: string[];
|
390
|
-
};
|
391
|
-
} & {
|
451
|
+
declare type XataRecord$1 = RecordMeta & {
|
392
452
|
[key: string]: any;
|
393
453
|
};
|
394
454
|
|
@@ -406,6 +466,7 @@ type schemas_InviteID = InviteID;
|
|
406
466
|
type schemas_WorkspaceInvite = WorkspaceInvite;
|
407
467
|
type schemas_WorkspaceMembers = WorkspaceMembers;
|
408
468
|
type schemas_InviteKey = InviteKey;
|
469
|
+
type schemas_DatabaseMetadata = DatabaseMetadata;
|
409
470
|
type schemas_ListDatabasesResponse = ListDatabasesResponse;
|
410
471
|
type schemas_ListBranchesResponse = ListBranchesResponse;
|
411
472
|
type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
|
@@ -430,8 +491,10 @@ type schemas_ColumnMigration = ColumnMigration;
|
|
430
491
|
type schemas_SortExpression = SortExpression;
|
431
492
|
type schemas_SortOrder = SortOrder;
|
432
493
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
494
|
+
type schemas_PrefixExpression = PrefixExpression;
|
433
495
|
type schemas_FilterExpression = FilterExpression;
|
434
496
|
type schemas_HighlightExpression = HighlightExpression;
|
497
|
+
type schemas_BoosterExpression = BoosterExpression;
|
435
498
|
type schemas_FilterList = FilterList;
|
436
499
|
type schemas_FilterColumn = FilterColumn;
|
437
500
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
@@ -441,7 +504,8 @@ type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
|
|
441
504
|
type schemas_FilterRangeValue = FilterRangeValue;
|
442
505
|
type schemas_FilterValue = FilterValue;
|
443
506
|
type schemas_PageConfig = PageConfig;
|
444
|
-
type
|
507
|
+
type schemas_ColumnsProjection = ColumnsProjection;
|
508
|
+
type schemas_RecordMeta = RecordMeta;
|
445
509
|
type schemas_RecordID = RecordID;
|
446
510
|
type schemas_TableRename = TableRename;
|
447
511
|
type schemas_RecordsMetadata = RecordsMetadata;
|
@@ -461,6 +525,7 @@ declare namespace schemas {
|
|
461
525
|
schemas_WorkspaceInvite as WorkspaceInvite,
|
462
526
|
schemas_WorkspaceMembers as WorkspaceMembers,
|
463
527
|
schemas_InviteKey as InviteKey,
|
528
|
+
schemas_DatabaseMetadata as DatabaseMetadata,
|
464
529
|
schemas_ListDatabasesResponse as ListDatabasesResponse,
|
465
530
|
schemas_ListBranchesResponse as ListBranchesResponse,
|
466
531
|
schemas_ListGitBranchesResponse as ListGitBranchesResponse,
|
@@ -485,8 +550,13 @@ declare namespace schemas {
|
|
485
550
|
schemas_SortExpression as SortExpression,
|
486
551
|
schemas_SortOrder as SortOrder,
|
487
552
|
schemas_FuzzinessExpression as FuzzinessExpression,
|
553
|
+
schemas_PrefixExpression as PrefixExpression,
|
488
554
|
schemas_FilterExpression as FilterExpression,
|
489
555
|
schemas_HighlightExpression as HighlightExpression,
|
556
|
+
schemas_BoosterExpression as BoosterExpression,
|
557
|
+
ValueBooster$1 as ValueBooster,
|
558
|
+
NumericBooster$1 as NumericBooster,
|
559
|
+
DateBooster$1 as DateBooster,
|
490
560
|
schemas_FilterList as FilterList,
|
491
561
|
schemas_FilterColumn as FilterColumn,
|
492
562
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
@@ -496,7 +566,8 @@ declare namespace schemas {
|
|
496
566
|
schemas_FilterRangeValue as FilterRangeValue,
|
497
567
|
schemas_FilterValue as FilterValue,
|
498
568
|
schemas_PageConfig as PageConfig,
|
499
|
-
|
569
|
+
schemas_ColumnsProjection as ColumnsProjection,
|
570
|
+
schemas_RecordMeta as RecordMeta,
|
500
571
|
schemas_RecordID as RecordID,
|
501
572
|
schemas_TableRename as TableRename,
|
502
573
|
schemas_RecordsMetadata as RecordsMetadata,
|
@@ -531,11 +602,17 @@ declare type BulkError = {
|
|
531
602
|
status?: number;
|
532
603
|
}[];
|
533
604
|
};
|
605
|
+
declare type BulkInsertResponse = {
|
606
|
+
recordIDs: string[];
|
607
|
+
} | {
|
608
|
+
records: XataRecord$1[];
|
609
|
+
};
|
534
610
|
declare type BranchMigrationPlan = {
|
535
611
|
version: number;
|
536
612
|
migration: BranchMigration;
|
537
613
|
};
|
538
|
-
declare type
|
614
|
+
declare type RecordResponse = XataRecord$1;
|
615
|
+
declare type RecordUpdateResponse = XataRecord$1 | {
|
539
616
|
id: string;
|
540
617
|
xata: {
|
541
618
|
version: number;
|
@@ -559,7 +636,9 @@ type responses_SimpleError = SimpleError;
|
|
559
636
|
type responses_BadRequestError = BadRequestError;
|
560
637
|
type responses_AuthError = AuthError;
|
561
638
|
type responses_BulkError = BulkError;
|
639
|
+
type responses_BulkInsertResponse = BulkInsertResponse;
|
562
640
|
type responses_BranchMigrationPlan = BranchMigrationPlan;
|
641
|
+
type responses_RecordResponse = RecordResponse;
|
563
642
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
564
643
|
type responses_QueryResponse = QueryResponse;
|
565
644
|
type responses_SearchResponse = SearchResponse;
|
@@ -570,7 +649,9 @@ declare namespace responses {
|
|
570
649
|
responses_BadRequestError as BadRequestError,
|
571
650
|
responses_AuthError as AuthError,
|
572
651
|
responses_BulkError as BulkError,
|
652
|
+
responses_BulkInsertResponse as BulkInsertResponse,
|
573
653
|
responses_BranchMigrationPlan as BranchMigrationPlan,
|
654
|
+
responses_RecordResponse as RecordResponse,
|
574
655
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
575
656
|
responses_QueryResponse as QueryResponse,
|
576
657
|
responses_SearchResponse as SearchResponse,
|
@@ -876,6 +957,9 @@ declare type InviteWorkspaceMemberError = ErrorWrapper<{
|
|
876
957
|
} | {
|
877
958
|
status: 404;
|
878
959
|
payload: SimpleError;
|
960
|
+
} | {
|
961
|
+
status: 409;
|
962
|
+
payload: SimpleError;
|
879
963
|
}>;
|
880
964
|
declare type InviteWorkspaceMemberRequestBody = {
|
881
965
|
email: string;
|
@@ -889,6 +973,34 @@ declare type InviteWorkspaceMemberVariables = {
|
|
889
973
|
* Invite some user to join the workspace with the given role
|
890
974
|
*/
|
891
975
|
declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
976
|
+
declare type UpdateWorkspaceMemberInvitePathParams = {
|
977
|
+
workspaceId: WorkspaceID;
|
978
|
+
inviteId: InviteID;
|
979
|
+
};
|
980
|
+
declare type UpdateWorkspaceMemberInviteError = ErrorWrapper<{
|
981
|
+
status: 400;
|
982
|
+
payload: BadRequestError;
|
983
|
+
} | {
|
984
|
+
status: 401;
|
985
|
+
payload: AuthError;
|
986
|
+
} | {
|
987
|
+
status: 404;
|
988
|
+
payload: SimpleError;
|
989
|
+
} | {
|
990
|
+
status: 422;
|
991
|
+
payload: SimpleError;
|
992
|
+
}>;
|
993
|
+
declare type UpdateWorkspaceMemberInviteRequestBody = {
|
994
|
+
role: Role;
|
995
|
+
};
|
996
|
+
declare type UpdateWorkspaceMemberInviteVariables = {
|
997
|
+
body: UpdateWorkspaceMemberInviteRequestBody;
|
998
|
+
pathParams: UpdateWorkspaceMemberInvitePathParams;
|
999
|
+
} & FetcherExtraProps;
|
1000
|
+
/**
|
1001
|
+
* This operation provides a way to update an existing invite. Updates are performed in-place; they do not change the invite link, the expiry time, nor do they re-notify the recipient of the invite.
|
1002
|
+
*/
|
1003
|
+
declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
892
1004
|
declare type CancelWorkspaceMemberInvitePathParams = {
|
893
1005
|
workspaceId: WorkspaceID;
|
894
1006
|
inviteId: InviteID;
|
@@ -1042,6 +1154,27 @@ declare type DeleteDatabaseVariables = {
|
|
1042
1154
|
* Delete a database and all of its branches and tables permanently.
|
1043
1155
|
*/
|
1044
1156
|
declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
1157
|
+
declare type GetDatabaseMetadataPathParams = {
|
1158
|
+
dbName: DBName;
|
1159
|
+
workspace: string;
|
1160
|
+
};
|
1161
|
+
declare type GetDatabaseMetadataError = ErrorWrapper<{
|
1162
|
+
status: 400;
|
1163
|
+
payload: BadRequestError;
|
1164
|
+
} | {
|
1165
|
+
status: 401;
|
1166
|
+
payload: AuthError;
|
1167
|
+
} | {
|
1168
|
+
status: 404;
|
1169
|
+
payload: SimpleError;
|
1170
|
+
}>;
|
1171
|
+
declare type GetDatabaseMetadataVariables = {
|
1172
|
+
pathParams: GetDatabaseMetadataPathParams;
|
1173
|
+
} & FetcherExtraProps;
|
1174
|
+
/**
|
1175
|
+
* Retrieve metadata of the given database
|
1176
|
+
*/
|
1177
|
+
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1045
1178
|
declare type GetGitBranchesMappingPathParams = {
|
1046
1179
|
dbName: DBName;
|
1047
1180
|
workspace: string;
|
@@ -1234,6 +1367,10 @@ declare type CreateBranchError = ErrorWrapper<{
|
|
1234
1367
|
status: 404;
|
1235
1368
|
payload: SimpleError;
|
1236
1369
|
}>;
|
1370
|
+
declare type CreateBranchResponse = {
|
1371
|
+
databaseName: string;
|
1372
|
+
branchName: string;
|
1373
|
+
};
|
1237
1374
|
declare type CreateBranchRequestBody = {
|
1238
1375
|
from?: string;
|
1239
1376
|
metadata?: BranchMetadata;
|
@@ -1243,7 +1380,7 @@ declare type CreateBranchVariables = {
|
|
1243
1380
|
pathParams: CreateBranchPathParams;
|
1244
1381
|
queryParams?: CreateBranchQueryParams;
|
1245
1382
|
} & FetcherExtraProps;
|
1246
|
-
declare const createBranch: (variables: CreateBranchVariables) => Promise<
|
1383
|
+
declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
1247
1384
|
declare type DeleteBranchPathParams = {
|
1248
1385
|
dbBranchName: DBBranchName;
|
1249
1386
|
workspace: string;
|
@@ -1430,13 +1567,17 @@ declare type CreateTableError = ErrorWrapper<{
|
|
1430
1567
|
status: 422;
|
1431
1568
|
payload: SimpleError;
|
1432
1569
|
}>;
|
1570
|
+
declare type CreateTableResponse = {
|
1571
|
+
branchName: string;
|
1572
|
+
tableName: string;
|
1573
|
+
};
|
1433
1574
|
declare type CreateTableVariables = {
|
1434
1575
|
pathParams: CreateTablePathParams;
|
1435
1576
|
} & FetcherExtraProps;
|
1436
1577
|
/**
|
1437
1578
|
* Creates a new table with the given name. Returns 422 if a table with the same name already exists.
|
1438
1579
|
*/
|
1439
|
-
declare const createTable: (variables: CreateTableVariables) => Promise<
|
1580
|
+
declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
1440
1581
|
declare type DeleteTablePathParams = {
|
1441
1582
|
dbBranchName: DBBranchName;
|
1442
1583
|
tableName: TableName;
|
@@ -1669,6 +1810,9 @@ declare type InsertRecordPathParams = {
|
|
1669
1810
|
tableName: TableName;
|
1670
1811
|
workspace: string;
|
1671
1812
|
};
|
1813
|
+
declare type InsertRecordQueryParams = {
|
1814
|
+
columns?: ColumnsProjection;
|
1815
|
+
};
|
1672
1816
|
declare type InsertRecordError = ErrorWrapper<{
|
1673
1817
|
status: 400;
|
1674
1818
|
payload: BadRequestError;
|
@@ -1679,20 +1823,15 @@ declare type InsertRecordError = ErrorWrapper<{
|
|
1679
1823
|
status: 404;
|
1680
1824
|
payload: SimpleError;
|
1681
1825
|
}>;
|
1682
|
-
declare type InsertRecordResponse = {
|
1683
|
-
id: string;
|
1684
|
-
xata: {
|
1685
|
-
version: number;
|
1686
|
-
};
|
1687
|
-
};
|
1688
1826
|
declare type InsertRecordVariables = {
|
1689
1827
|
body?: Record<string, any>;
|
1690
1828
|
pathParams: InsertRecordPathParams;
|
1829
|
+
queryParams?: InsertRecordQueryParams;
|
1691
1830
|
} & FetcherExtraProps;
|
1692
1831
|
/**
|
1693
1832
|
* Insert a new Record into the Table
|
1694
1833
|
*/
|
1695
|
-
declare const insertRecord: (variables: InsertRecordVariables) => Promise<
|
1834
|
+
declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
1696
1835
|
declare type InsertRecordWithIDPathParams = {
|
1697
1836
|
dbBranchName: DBBranchName;
|
1698
1837
|
tableName: TableName;
|
@@ -1700,6 +1839,7 @@ declare type InsertRecordWithIDPathParams = {
|
|
1700
1839
|
workspace: string;
|
1701
1840
|
};
|
1702
1841
|
declare type InsertRecordWithIDQueryParams = {
|
1842
|
+
columns?: ColumnsProjection;
|
1703
1843
|
createOnly?: boolean;
|
1704
1844
|
ifVersion?: number;
|
1705
1845
|
};
|
@@ -1732,6 +1872,7 @@ declare type UpdateRecordWithIDPathParams = {
|
|
1732
1872
|
workspace: string;
|
1733
1873
|
};
|
1734
1874
|
declare type UpdateRecordWithIDQueryParams = {
|
1875
|
+
columns?: ColumnsProjection;
|
1735
1876
|
ifVersion?: number;
|
1736
1877
|
};
|
1737
1878
|
declare type UpdateRecordWithIDError = ErrorWrapper<{
|
@@ -1760,6 +1901,7 @@ declare type UpsertRecordWithIDPathParams = {
|
|
1760
1901
|
workspace: string;
|
1761
1902
|
};
|
1762
1903
|
declare type UpsertRecordWithIDQueryParams = {
|
1904
|
+
columns?: ColumnsProjection;
|
1763
1905
|
ifVersion?: number;
|
1764
1906
|
};
|
1765
1907
|
declare type UpsertRecordWithIDError = ErrorWrapper<{
|
@@ -1787,6 +1929,9 @@ declare type DeleteRecordPathParams = {
|
|
1787
1929
|
recordId: RecordID;
|
1788
1930
|
workspace: string;
|
1789
1931
|
};
|
1932
|
+
declare type DeleteRecordQueryParams = {
|
1933
|
+
columns?: ColumnsProjection;
|
1934
|
+
};
|
1790
1935
|
declare type DeleteRecordError = ErrorWrapper<{
|
1791
1936
|
status: 400;
|
1792
1937
|
payload: BadRequestError;
|
@@ -1799,14 +1944,18 @@ declare type DeleteRecordError = ErrorWrapper<{
|
|
1799
1944
|
}>;
|
1800
1945
|
declare type DeleteRecordVariables = {
|
1801
1946
|
pathParams: DeleteRecordPathParams;
|
1947
|
+
queryParams?: DeleteRecordQueryParams;
|
1802
1948
|
} & FetcherExtraProps;
|
1803
|
-
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<
|
1949
|
+
declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
1804
1950
|
declare type GetRecordPathParams = {
|
1805
1951
|
dbBranchName: DBBranchName;
|
1806
1952
|
tableName: TableName;
|
1807
1953
|
recordId: RecordID;
|
1808
1954
|
workspace: string;
|
1809
1955
|
};
|
1956
|
+
declare type GetRecordQueryParams = {
|
1957
|
+
columns?: ColumnsProjection;
|
1958
|
+
};
|
1810
1959
|
declare type GetRecordError = ErrorWrapper<{
|
1811
1960
|
status: 400;
|
1812
1961
|
payload: BadRequestError;
|
@@ -1817,12 +1966,9 @@ declare type GetRecordError = ErrorWrapper<{
|
|
1817
1966
|
status: 404;
|
1818
1967
|
payload: SimpleError;
|
1819
1968
|
}>;
|
1820
|
-
declare type GetRecordRequestBody = {
|
1821
|
-
columns?: ColumnsFilter;
|
1822
|
-
};
|
1823
1969
|
declare type GetRecordVariables = {
|
1824
|
-
body?: GetRecordRequestBody;
|
1825
1970
|
pathParams: GetRecordPathParams;
|
1971
|
+
queryParams?: GetRecordQueryParams;
|
1826
1972
|
} & FetcherExtraProps;
|
1827
1973
|
/**
|
1828
1974
|
* Retrieve record by ID
|
@@ -1833,6 +1979,9 @@ declare type BulkInsertTableRecordsPathParams = {
|
|
1833
1979
|
tableName: TableName;
|
1834
1980
|
workspace: string;
|
1835
1981
|
};
|
1982
|
+
declare type BulkInsertTableRecordsQueryParams = {
|
1983
|
+
columns?: ColumnsProjection;
|
1984
|
+
};
|
1836
1985
|
declare type BulkInsertTableRecordsError = ErrorWrapper<{
|
1837
1986
|
status: 400;
|
1838
1987
|
payload: BulkError;
|
@@ -1842,21 +1991,22 @@ declare type BulkInsertTableRecordsError = ErrorWrapper<{
|
|
1842
1991
|
} | {
|
1843
1992
|
status: 404;
|
1844
1993
|
payload: SimpleError;
|
1994
|
+
} | {
|
1995
|
+
status: 422;
|
1996
|
+
payload: SimpleError;
|
1845
1997
|
}>;
|
1846
|
-
declare type BulkInsertTableRecordsResponse = {
|
1847
|
-
recordIDs: string[];
|
1848
|
-
};
|
1849
1998
|
declare type BulkInsertTableRecordsRequestBody = {
|
1850
1999
|
records: Record<string, any>[];
|
1851
2000
|
};
|
1852
2001
|
declare type BulkInsertTableRecordsVariables = {
|
1853
2002
|
body: BulkInsertTableRecordsRequestBody;
|
1854
2003
|
pathParams: BulkInsertTableRecordsPathParams;
|
2004
|
+
queryParams?: BulkInsertTableRecordsQueryParams;
|
1855
2005
|
} & FetcherExtraProps;
|
1856
2006
|
/**
|
1857
2007
|
* Bulk insert records
|
1858
2008
|
*/
|
1859
|
-
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<
|
2009
|
+
declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
1860
2010
|
declare type QueryTablePathParams = {
|
1861
2011
|
dbBranchName: DBBranchName;
|
1862
2012
|
tableName: TableName;
|
@@ -1876,7 +2026,7 @@ declare type QueryTableRequestBody = {
|
|
1876
2026
|
filter?: FilterExpression;
|
1877
2027
|
sort?: SortExpression;
|
1878
2028
|
page?: PageConfig;
|
1879
|
-
columns?:
|
2029
|
+
columns?: ColumnsProjection;
|
1880
2030
|
};
|
1881
2031
|
declare type QueryTableVariables = {
|
1882
2032
|
body?: QueryTableRequestBody;
|
@@ -2622,8 +2772,10 @@ declare type SearchTableError = ErrorWrapper<{
|
|
2622
2772
|
declare type SearchTableRequestBody = {
|
2623
2773
|
query: string;
|
2624
2774
|
fuzziness?: FuzzinessExpression;
|
2775
|
+
prefix?: PrefixExpression;
|
2625
2776
|
filter?: FilterExpression;
|
2626
2777
|
highlight?: HighlightExpression;
|
2778
|
+
boosters?: BoosterExpression[];
|
2627
2779
|
};
|
2628
2780
|
declare type SearchTableVariables = {
|
2629
2781
|
body: SearchTableRequestBody;
|
@@ -2655,6 +2807,7 @@ declare type SearchBranchRequestBody = {
|
|
2655
2807
|
tables?: (string | {
|
2656
2808
|
table: string;
|
2657
2809
|
filter?: FilterExpression;
|
2810
|
+
boosters?: BoosterExpression[];
|
2658
2811
|
})[];
|
2659
2812
|
query: string;
|
2660
2813
|
fuzziness?: FuzzinessExpression;
|
@@ -2687,6 +2840,7 @@ declare const operationsByTag: {
|
|
2687
2840
|
updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
|
2688
2841
|
removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
|
2689
2842
|
inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
|
2843
|
+
updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
|
2690
2844
|
cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
|
2691
2845
|
resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
|
2692
2846
|
acceptWorkspaceMemberInvite: (variables: AcceptWorkspaceMemberInviteVariables) => Promise<undefined>;
|
@@ -2695,6 +2849,7 @@ declare const operationsByTag: {
|
|
2695
2849
|
getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
|
2696
2850
|
createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
2697
2851
|
deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
2852
|
+
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
2698
2853
|
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
2699
2854
|
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
2700
2855
|
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
@@ -2703,7 +2858,7 @@ declare const operationsByTag: {
|
|
2703
2858
|
branch: {
|
2704
2859
|
getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
|
2705
2860
|
getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
|
2706
|
-
createBranch: (variables: CreateBranchVariables) => Promise<
|
2861
|
+
createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
|
2707
2862
|
deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
|
2708
2863
|
updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
|
2709
2864
|
getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
|
@@ -2713,7 +2868,7 @@ declare const operationsByTag: {
|
|
2713
2868
|
getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
|
2714
2869
|
};
|
2715
2870
|
table: {
|
2716
|
-
createTable: (variables: CreateTableVariables) => Promise<
|
2871
|
+
createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
|
2717
2872
|
deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
|
2718
2873
|
updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
|
2719
2874
|
getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
|
@@ -2725,13 +2880,13 @@ declare const operationsByTag: {
|
|
2725
2880
|
updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
|
2726
2881
|
};
|
2727
2882
|
records: {
|
2728
|
-
insertRecord: (variables: InsertRecordVariables) => Promise<
|
2883
|
+
insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
|
2729
2884
|
insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2730
2885
|
updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2731
2886
|
upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
|
2732
|
-
deleteRecord: (variables: DeleteRecordVariables) => Promise<
|
2887
|
+
deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
|
2733
2888
|
getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
2734
|
-
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<
|
2889
|
+
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
|
2735
2890
|
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
2736
2891
|
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
2737
2892
|
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
@@ -2749,6 +2904,7 @@ interface XataApiClientOptions {
|
|
2749
2904
|
fetch?: FetchImpl;
|
2750
2905
|
apiKey?: string;
|
2751
2906
|
host?: HostProvider;
|
2907
|
+
trace?: TraceFunction;
|
2752
2908
|
}
|
2753
2909
|
/**
|
2754
2910
|
* @deprecated Use XataApiPlugin instead
|
@@ -2785,6 +2941,7 @@ declare class WorkspaceApi {
|
|
2785
2941
|
updateWorkspaceMemberRole(workspaceId: WorkspaceID, userId: UserID, role: Role): Promise<void>;
|
2786
2942
|
removeWorkspaceMember(workspaceId: WorkspaceID, userId: UserID): Promise<void>;
|
2787
2943
|
inviteWorkspaceMember(workspaceId: WorkspaceID, email: string, role: Role): Promise<WorkspaceInvite>;
|
2944
|
+
updateWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID, role: Role): Promise<WorkspaceInvite>;
|
2788
2945
|
cancelWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
2789
2946
|
resendWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteId: InviteID): Promise<void>;
|
2790
2947
|
acceptWorkspaceMemberInvite(workspaceId: WorkspaceID, inviteKey: InviteKey): Promise<void>;
|
@@ -2795,17 +2952,18 @@ declare class DatabaseApi {
|
|
2795
2952
|
getDatabaseList(workspace: WorkspaceID): Promise<ListDatabasesResponse>;
|
2796
2953
|
createDatabase(workspace: WorkspaceID, dbName: DBName, options?: CreateDatabaseRequestBody): Promise<CreateDatabaseResponse>;
|
2797
2954
|
deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
|
2955
|
+
getDatabaseMetadata(workspace: WorkspaceID, dbName: DBName): Promise<DatabaseMetadata>;
|
2798
2956
|
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
2799
2957
|
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
2800
2958
|
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
2801
|
-
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch
|
2959
|
+
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
|
2802
2960
|
}
|
2803
2961
|
declare class BranchApi {
|
2804
2962
|
private extraProps;
|
2805
2963
|
constructor(extraProps: FetcherExtraProps);
|
2806
2964
|
getBranchList(workspace: WorkspaceID, dbName: DBName): Promise<ListBranchesResponse>;
|
2807
2965
|
getBranchDetails(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<DBBranch>;
|
2808
|
-
createBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, from?: string, options?: CreateBranchRequestBody): Promise<
|
2966
|
+
createBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, from?: string, options?: CreateBranchRequestBody): Promise<CreateBranchResponse>;
|
2809
2967
|
deleteBranch(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<void>;
|
2810
2968
|
updateBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName, metadata?: BranchMetadata): Promise<void>;
|
2811
2969
|
getBranchMetadata(workspace: WorkspaceID, database: DBName, branch: BranchName): Promise<BranchMetadata>;
|
@@ -2817,7 +2975,7 @@ declare class BranchApi {
|
|
2817
2975
|
declare class TableApi {
|
2818
2976
|
private extraProps;
|
2819
2977
|
constructor(extraProps: FetcherExtraProps);
|
2820
|
-
createTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<
|
2978
|
+
createTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<CreateTableResponse>;
|
2821
2979
|
deleteTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<void>;
|
2822
2980
|
updateTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, options: UpdateTableRequestBody): Promise<void>;
|
2823
2981
|
getTableSchema(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName): Promise<GetTableSchemaResponse>;
|
@@ -2831,13 +2989,13 @@ declare class TableApi {
|
|
2831
2989
|
declare class RecordsApi {
|
2832
2990
|
private extraProps;
|
2833
2991
|
constructor(extraProps: FetcherExtraProps);
|
2834
|
-
insertRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, record: Record<string, any
|
2992
|
+
insertRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, record: Record<string, any>, options?: InsertRecordQueryParams): Promise<RecordUpdateResponse>;
|
2835
2993
|
insertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: InsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2836
2994
|
updateRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpdateRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2837
2995
|
upsertRecordWithID(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, record: Record<string, any>, options?: UpsertRecordWithIDQueryParams): Promise<RecordUpdateResponse>;
|
2838
|
-
deleteRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID): Promise<
|
2839
|
-
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?:
|
2840
|
-
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[]): Promise<
|
2996
|
+
deleteRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: DeleteRecordQueryParams): Promise<RecordUpdateResponse>;
|
2997
|
+
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordQueryParams): Promise<XataRecord$1>;
|
2998
|
+
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[], options?: BulkInsertTableRecordsQueryParams): Promise<BulkInsertResponse>;
|
2841
2999
|
queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
|
2842
3000
|
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
2843
3001
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
@@ -2853,39 +3011,39 @@ declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) ex
|
|
2853
3011
|
declare type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
2854
3012
|
declare type IsObject<T> = T extends Record<string, any> ? true : false;
|
2855
3013
|
declare type IsArray<T> = T extends Array<any> ? true : false;
|
2856
|
-
declare type NonEmptyArray<T> = T[] & {
|
2857
|
-
0: T;
|
2858
|
-
};
|
2859
3014
|
declare type RequiredBy<T, K extends keyof T> = T & {
|
2860
3015
|
[P in K]-?: NonNullable<T[P]>;
|
2861
3016
|
};
|
2862
3017
|
declare type GetArrayInnerType<T extends readonly any[]> = T[number];
|
2863
3018
|
declare type SingleOrArray<T> = T | T[];
|
2864
3019
|
declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
3020
|
+
declare type Without<T, U> = {
|
3021
|
+
[P in Exclude<keyof T, keyof U>]?: never;
|
3022
|
+
};
|
3023
|
+
declare type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
2865
3024
|
|
2866
3025
|
declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
|
2867
|
-
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
|
2868
|
-
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord
|
3026
|
+
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord<O> & UnionToIntersection<Values<{
|
3027
|
+
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord<O>;
|
2869
3028
|
}>>;
|
2870
|
-
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<
|
2871
|
-
V: ValueAtColumn<
|
2872
|
-
} : never : O[K]> : never : never;
|
3029
|
+
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
|
3030
|
+
V: ValueAtColumn<Item, V>;
|
3031
|
+
} : never : O[K] : never> : never : never;
|
2873
3032
|
declare type MAX_RECURSION = 5;
|
2874
3033
|
declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
2875
|
-
[K in DataProps<O>]:
|
2876
|
-
If<IsObject<
|
2877
|
-
K
|
3034
|
+
[K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
|
3035
|
+
If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
|
3036
|
+
K>> : never;
|
2878
3037
|
}>, never>;
|
2879
3038
|
declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
2880
3039
|
declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
2881
|
-
[K in N]: M extends SelectableColumn<
|
3040
|
+
[K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
|
2882
3041
|
} : unknown : Key extends DataProps<O> ? {
|
2883
|
-
[K in Key]:
|
3042
|
+
[K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
|
2884
3043
|
} : Key extends '*' ? {
|
2885
|
-
[K in StringKeys<O>]:
|
3044
|
+
[K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
|
2886
3045
|
} : unknown;
|
2887
|
-
declare type
|
2888
|
-
declare type ForwardNullable<T, R> = T extends RemoveNullable<T> ? R : R | null;
|
3046
|
+
declare type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
|
2889
3047
|
|
2890
3048
|
/**
|
2891
3049
|
* Represents an identifiable record from the database.
|
@@ -2902,22 +3060,37 @@ interface BaseData {
|
|
2902
3060
|
/**
|
2903
3061
|
* Represents a persisted record from the database.
|
2904
3062
|
*/
|
2905
|
-
interface XataRecord<
|
3063
|
+
interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> extends Identifiable {
|
2906
3064
|
/**
|
2907
3065
|
* Get metadata of this record.
|
2908
3066
|
*/
|
2909
|
-
getMetadata(): XataRecordMetadata
|
3067
|
+
getMetadata(): XataRecordMetadata;
|
3068
|
+
/**
|
3069
|
+
* Retrieves a refreshed copy of the current record from the database.
|
3070
|
+
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
3071
|
+
* @returns The persisted record with the selected columns.
|
3072
|
+
*/
|
3073
|
+
read<K extends SelectableColumn<OriginalRecord>>(columns: K[]): Promise<Readonly<SelectedPick<OriginalRecord, typeof columns>> | null>;
|
2910
3074
|
/**
|
2911
3075
|
* Retrieves a refreshed copy of the current record from the database.
|
3076
|
+
* @returns The persisted record with all first level properties.
|
2912
3077
|
*/
|
2913
|
-
read(): Promise<Readonly<SelectedPick<
|
3078
|
+
read(): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>> | null>;
|
2914
3079
|
/**
|
2915
3080
|
* Performs a partial update of the current record. On success a new object is
|
2916
3081
|
* returned and the current object is not mutated.
|
2917
3082
|
* @param partialUpdate The columns and their values that have to be updated.
|
2918
|
-
* @
|
3083
|
+
* @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
|
3084
|
+
* @returns The persisted record with the selected columns.
|
3085
|
+
*/
|
3086
|
+
update<K extends SelectableColumn<OriginalRecord>>(partialUpdate: Partial<EditableData<Omit<OriginalRecord, keyof XataRecord>>>, columns: K[]): Promise<Readonly<SelectedPick<OriginalRecord, typeof columns>>>;
|
3087
|
+
/**
|
3088
|
+
* Performs a partial update of the current record. On success a new object is
|
3089
|
+
* returned and the current object is not mutated.
|
3090
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
3091
|
+
* @returns The persisted record with all first level properties.
|
2919
3092
|
*/
|
2920
|
-
update(partialUpdate: Partial<EditableData<Omit<
|
3093
|
+
update(partialUpdate: Partial<EditableData<Omit<OriginalRecord, keyof XataRecord>>>): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>>>;
|
2921
3094
|
/**
|
2922
3095
|
* Performs a deletion of the current record in the database.
|
2923
3096
|
*
|
@@ -2929,14 +3102,20 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
|
|
2929
3102
|
/**
|
2930
3103
|
* Retrieves a refreshed copy of the current record from the database.
|
2931
3104
|
*/
|
2932
|
-
read(): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3105
|
+
read<K extends SelectableColumn<Record>>(columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>> | null>;
|
2933
3106
|
/**
|
2934
3107
|
* Performs a partial update of the current record. On success a new object is
|
2935
3108
|
* returned and the current object is not mutated.
|
2936
3109
|
* @param partialUpdate The columns and their values that have to be updated.
|
2937
3110
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2938
3111
|
*/
|
2939
|
-
update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord
|
3112
|
+
update<K extends SelectableColumn<Record>>(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>, columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>>>;
|
3113
|
+
/**
|
3114
|
+
* Performs a deletion of the current record in the database.
|
3115
|
+
*
|
3116
|
+
* @throws If the record was already deleted or if an error happened while performing the deletion.
|
3117
|
+
*/
|
3118
|
+
delete(): Promise<void>;
|
2940
3119
|
};
|
2941
3120
|
declare type XataRecordMetadata = {
|
2942
3121
|
/**
|
@@ -2950,9 +3129,9 @@ declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>
|
|
2950
3129
|
declare type EditableData<O extends BaseData> = {
|
2951
3130
|
[K in keyof O]: O[K] extends XataRecord ? {
|
2952
3131
|
id: string;
|
2953
|
-
} : NonNullable<O[K]> extends XataRecord ? {
|
3132
|
+
} | string : NonNullable<O[K]> extends XataRecord ? {
|
2954
3133
|
id: string;
|
2955
|
-
} | null | undefined : O[K];
|
3134
|
+
} | string | null | undefined : O[K];
|
2956
3135
|
};
|
2957
3136
|
|
2958
3137
|
/**
|
@@ -3049,6 +3228,84 @@ declare type NestedApiFilter<T> = {
|
|
3049
3228
|
};
|
3050
3229
|
declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
|
3051
3230
|
|
3231
|
+
declare type DateBooster = {
|
3232
|
+
origin?: string;
|
3233
|
+
scale: string;
|
3234
|
+
decay: number;
|
3235
|
+
};
|
3236
|
+
declare type NumericBooster = {
|
3237
|
+
factor: number;
|
3238
|
+
};
|
3239
|
+
declare type ValueBooster<T extends string | number | boolean> = {
|
3240
|
+
value: T;
|
3241
|
+
factor: number;
|
3242
|
+
};
|
3243
|
+
declare type Boosters<O extends XataRecord> = Values<{
|
3244
|
+
[K in SelectableColumn<O>]: NonNullable<ValueAtColumn<O, K>> extends Date ? {
|
3245
|
+
dateBooster: {
|
3246
|
+
column: K;
|
3247
|
+
} & DateBooster;
|
3248
|
+
} : NonNullable<ValueAtColumn<O, K>> extends number ? ExclusiveOr<{
|
3249
|
+
numericBooster?: {
|
3250
|
+
column: K;
|
3251
|
+
} & NumericBooster;
|
3252
|
+
}, {
|
3253
|
+
valueBooster?: {
|
3254
|
+
column: K;
|
3255
|
+
} & ValueBooster<number>;
|
3256
|
+
}> : NonNullable<ValueAtColumn<O, K>> extends string | boolean ? {
|
3257
|
+
valueBooster: {
|
3258
|
+
column: K;
|
3259
|
+
} & ValueBooster<NonNullable<ValueAtColumn<O, K>>>;
|
3260
|
+
} : never;
|
3261
|
+
}>;
|
3262
|
+
|
3263
|
+
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3264
|
+
fuzziness?: FuzzinessExpression;
|
3265
|
+
prefix?: PrefixExpression;
|
3266
|
+
highlight?: HighlightExpression;
|
3267
|
+
tables?: Array<Tables | Values<{
|
3268
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
3269
|
+
table: Model;
|
3270
|
+
filter?: Filter<SelectedPick<Schemas[Model] & XataRecord, ['*']>>;
|
3271
|
+
boosters?: Boosters<Schemas[Model] & XataRecord>[];
|
3272
|
+
};
|
3273
|
+
}>>;
|
3274
|
+
};
|
3275
|
+
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3276
|
+
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3277
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
3278
|
+
table: Model;
|
3279
|
+
record: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>>;
|
3280
|
+
};
|
3281
|
+
}>[]>;
|
3282
|
+
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3283
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SearchXataRecord<SelectedPick<Schemas[Model] & XataRecord, ['*']>>[]>;
|
3284
|
+
}>;
|
3285
|
+
};
|
3286
|
+
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3287
|
+
#private;
|
3288
|
+
private db;
|
3289
|
+
constructor(db: SchemaPluginResult<Schemas>, schemaTables?: Schemas.Table[]);
|
3290
|
+
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3291
|
+
}
|
3292
|
+
declare type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
|
3293
|
+
getMetadata: () => XataRecordMetadata & SearchExtraProperties;
|
3294
|
+
};
|
3295
|
+
declare type SearchExtraProperties = {
|
3296
|
+
table: string;
|
3297
|
+
highlight?: {
|
3298
|
+
[key: string]: string[] | {
|
3299
|
+
[key: string]: any;
|
3300
|
+
};
|
3301
|
+
};
|
3302
|
+
score?: number;
|
3303
|
+
};
|
3304
|
+
declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
|
3305
|
+
declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
|
3306
|
+
table: infer Table;
|
3307
|
+
} ? ReturnTable<Table, Tables> : never;
|
3308
|
+
|
3052
3309
|
declare type SortDirection = 'asc' | 'desc';
|
3053
3310
|
declare type SortFilterExtended<T extends XataRecord> = {
|
3054
3311
|
column: SelectableColumn<T>;
|
@@ -3060,7 +3317,7 @@ declare type SortFilterBase<T extends XataRecord> = {
|
|
3060
3317
|
};
|
3061
3318
|
|
3062
3319
|
declare type BaseOptions<T extends XataRecord> = {
|
3063
|
-
columns?:
|
3320
|
+
columns?: SelectableColumn<T>[];
|
3064
3321
|
cache?: number;
|
3065
3322
|
};
|
3066
3323
|
declare type CursorQueryOptions = {
|
@@ -3144,13 +3401,13 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3144
3401
|
* @param direction The direction. Either ascending or descending.
|
3145
3402
|
* @returns A new Query object.
|
3146
3403
|
*/
|
3147
|
-
sort<F extends SelectableColumn<Record>>(column: F, direction
|
3404
|
+
sort<F extends SelectableColumn<Record>>(column: F, direction?: SortDirection): Query<Record, Result>;
|
3148
3405
|
/**
|
3149
3406
|
* Builds a new query specifying the set of columns to be returned in the query response.
|
3150
3407
|
* @param columns Array of column names to be returned by the query.
|
3151
3408
|
* @returns A new Query object.
|
3152
3409
|
*/
|
3153
|
-
select<K extends SelectableColumn<Record>>(columns:
|
3410
|
+
select<K extends SelectableColumn<Record>>(columns: K[]): Query<Record, SelectedPick<Record, K[]>>;
|
3154
3411
|
/**
|
3155
3412
|
* Get paginated results
|
3156
3413
|
*
|
@@ -3212,13 +3469,13 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3212
3469
|
* @param options Additional options to be used when performing the query.
|
3213
3470
|
* @returns An array of records from the database.
|
3214
3471
|
*/
|
3215
|
-
getMany
|
3472
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
3216
3473
|
/**
|
3217
3474
|
* Performs the query in the database and returns a set of results.
|
3218
3475
|
* @param options Additional options to be used when performing the query.
|
3219
3476
|
* @returns An array of records from the database.
|
3220
3477
|
*/
|
3221
|
-
getMany
|
3478
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<RecordArray<Result>>;
|
3222
3479
|
/**
|
3223
3480
|
* Performs the query in the database and returns all the results.
|
3224
3481
|
* Warning: If there are a large number of results, this method can have performance implications.
|
@@ -3231,18 +3488,18 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3231
3488
|
* @param options Additional options to be used when performing the query.
|
3232
3489
|
* @returns An array of records from the database.
|
3233
3490
|
*/
|
3234
|
-
getAll
|
3491
|
+
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3235
3492
|
batchSize?: number;
|
3236
|
-
}): Promise<
|
3493
|
+
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3237
3494
|
/**
|
3238
3495
|
* Performs the query in the database and returns all the results.
|
3239
3496
|
* Warning: If there are a large number of results, this method can have performance implications.
|
3240
3497
|
* @param options Additional options to be used when performing the query.
|
3241
3498
|
* @returns An array of records from the database.
|
3242
3499
|
*/
|
3243
|
-
getAll
|
3500
|
+
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3244
3501
|
batchSize?: number;
|
3245
|
-
}
|
3502
|
+
}): Promise<Result[]>;
|
3246
3503
|
/**
|
3247
3504
|
* Performs the query in the database and returns the first result.
|
3248
3505
|
* @returns The first record that matches the query, or null if no record matched the query.
|
@@ -3253,13 +3510,13 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3253
3510
|
* @param options Additional options to be used when performing the query.
|
3254
3511
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3255
3512
|
*/
|
3256
|
-
getFirst
|
3513
|
+
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
3257
3514
|
/**
|
3258
3515
|
* Performs the query in the database and returns the first result.
|
3259
3516
|
* @param options Additional options to be used when performing the query.
|
3260
3517
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3261
3518
|
*/
|
3262
|
-
getFirst
|
3519
|
+
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
3263
3520
|
/**
|
3264
3521
|
* Builds a new query object adding a cache TTL in milliseconds.
|
3265
3522
|
* @param ttl The cache TTL in milliseconds.
|
@@ -3380,6 +3637,9 @@ declare function isCursorPaginationOptions(options: Record<string, unknown> | un
|
|
3380
3637
|
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
3381
3638
|
#private;
|
3382
3639
|
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
3640
|
+
static parseConstructorParams(...args: any[]): any[];
|
3641
|
+
toArray(): Result[];
|
3642
|
+
map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
|
3383
3643
|
/**
|
3384
3644
|
* Retrieve next page of records
|
3385
3645
|
*
|
@@ -3414,20 +3674,43 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
|
3414
3674
|
* Common interface for performing operations on a table.
|
3415
3675
|
*/
|
3416
3676
|
declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, Readonly<SelectedPick<Record, ['*']>>> {
|
3417
|
-
abstract create(object: EditableData<Data> & Partial<Identifiable
|
3677
|
+
abstract create<K extends SelectableColumn<Record>>(object: Omit<EditableData<Data>, 'id'> & Partial<Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3678
|
+
abstract create(object: Omit<EditableData<Data>, 'id'> & Partial<Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3679
|
+
/**
|
3680
|
+
* Creates a single record in the table with a unique id.
|
3681
|
+
* @param id The unique id.
|
3682
|
+
* @param object Object containing the column names with their values to be stored in the table.
|
3683
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3684
|
+
* @returns The full persisted record.
|
3685
|
+
*/
|
3686
|
+
abstract create<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Data>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3418
3687
|
/**
|
3419
3688
|
* Creates a single record in the table with a unique id.
|
3420
3689
|
* @param id The unique id.
|
3421
3690
|
* @param object Object containing the column names with their values to be stored in the table.
|
3422
3691
|
* @returns The full persisted record.
|
3423
3692
|
*/
|
3424
|
-
abstract create(id: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3693
|
+
abstract create(id: string, object: Omit<EditableData<Data>, 'id'>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3425
3694
|
/**
|
3426
3695
|
* Creates multiple records in the table.
|
3427
3696
|
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3428
|
-
* @
|
3697
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3698
|
+
* @returns Array of the persisted records in order.
|
3699
|
+
*/
|
3700
|
+
abstract create<K extends SelectableColumn<Record>>(objects: Array<Omit<EditableData<Data>, 'id'> & Partial<Identifiable>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3701
|
+
/**
|
3702
|
+
* Creates multiple records in the table.
|
3703
|
+
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3704
|
+
* @returns Array of the persisted records in order.
|
3429
3705
|
*/
|
3430
|
-
abstract create(objects: Array<EditableData<Data> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3706
|
+
abstract create(objects: Array<Omit<EditableData<Data>, 'id'> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3707
|
+
/**
|
3708
|
+
* Queries a single record from the table given its unique id.
|
3709
|
+
* @param id The unique id.
|
3710
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3711
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3712
|
+
*/
|
3713
|
+
abstract read<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
3431
3714
|
/**
|
3432
3715
|
* Queries a single record from the table given its unique id.
|
3433
3716
|
* @param id The unique id.
|
@@ -3437,15 +3720,63 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3437
3720
|
/**
|
3438
3721
|
* Queries multiple records from the table given their unique id.
|
3439
3722
|
* @param ids The unique ids array.
|
3440
|
-
* @
|
3723
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3724
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3725
|
+
*/
|
3726
|
+
abstract read<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
3727
|
+
/**
|
3728
|
+
* Queries multiple records from the table given their unique id.
|
3729
|
+
* @param ids The unique ids array.
|
3730
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3731
|
+
*/
|
3732
|
+
abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
3733
|
+
/**
|
3734
|
+
* Queries a single record from the table by the id in the object.
|
3735
|
+
* @param object Object containing the id of the record.
|
3736
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3737
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3738
|
+
*/
|
3739
|
+
abstract read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
3740
|
+
/**
|
3741
|
+
* Queries a single record from the table by the id in the object.
|
3742
|
+
* @param object Object containing the id of the record.
|
3743
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3744
|
+
*/
|
3745
|
+
abstract read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3746
|
+
/**
|
3747
|
+
* Queries multiple records from the table by the ids in the objects.
|
3748
|
+
* @param objects Array of objects containing the ids of the records.
|
3749
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3750
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3751
|
+
*/
|
3752
|
+
abstract read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
3753
|
+
/**
|
3754
|
+
* Queries multiple records from the table by the ids in the objects.
|
3755
|
+
* @param objects Array of objects containing the ids of the records.
|
3756
|
+
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
3757
|
+
*/
|
3758
|
+
abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
3759
|
+
/**
|
3760
|
+
* Partially update a single record.
|
3761
|
+
* @param object An object with its id and the columns to be updated.
|
3762
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3763
|
+
* @returns The full persisted record.
|
3441
3764
|
*/
|
3442
|
-
abstract
|
3765
|
+
abstract update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Data>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3443
3766
|
/**
|
3444
3767
|
* Partially update a single record.
|
3445
3768
|
* @param object An object with its id and the columns to be updated.
|
3446
3769
|
* @returns The full persisted record.
|
3447
3770
|
*/
|
3448
3771
|
abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3772
|
+
/**
|
3773
|
+
* Partially update a single record given its unique id.
|
3774
|
+
* @param id The unique id.
|
3775
|
+
* @param object The column names and their values that have to be updated.
|
3776
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3777
|
+
* @returns The full persisted record.
|
3778
|
+
*/
|
3779
|
+
abstract update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Data>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3449
3780
|
/**
|
3450
3781
|
* Partially update a single record given its unique id.
|
3451
3782
|
* @param id The unique id.
|
@@ -3456,9 +3787,24 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3456
3787
|
/**
|
3457
3788
|
* Partially updates multiple records.
|
3458
3789
|
* @param objects An array of objects with their ids and columns to be updated.
|
3459
|
-
* @
|
3790
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3791
|
+
* @returns Array of the persisted records in order.
|
3792
|
+
*/
|
3793
|
+
abstract update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Data>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3794
|
+
/**
|
3795
|
+
* Partially updates multiple records.
|
3796
|
+
* @param objects An array of objects with their ids and columns to be updated.
|
3797
|
+
* @returns Array of the persisted records in order.
|
3460
3798
|
*/
|
3461
3799
|
abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3800
|
+
/**
|
3801
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3802
|
+
* it will be update, otherwise a new record will be created.
|
3803
|
+
* @param object Object containing the column names with their values to be persisted in the table.
|
3804
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3805
|
+
* @returns The full persisted record.
|
3806
|
+
*/
|
3807
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Data> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3462
3808
|
/**
|
3463
3809
|
* Creates or updates a single record. If a record exists with the given id,
|
3464
3810
|
* it will be update, otherwise a new record will be created.
|
@@ -3466,6 +3812,15 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3466
3812
|
* @returns The full persisted record.
|
3467
3813
|
*/
|
3468
3814
|
abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3815
|
+
/**
|
3816
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3817
|
+
* it will be update, otherwise a new record will be created.
|
3818
|
+
* @param id A unique id.
|
3819
|
+
* @param object The column names and the values to be persisted.
|
3820
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3821
|
+
* @returns The full persisted record.
|
3822
|
+
*/
|
3823
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Data>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3469
3824
|
/**
|
3470
3825
|
* Creates or updates a single record. If a record exists with the given id,
|
3471
3826
|
* it will be update, otherwise a new record will be created.
|
@@ -3473,7 +3828,15 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3473
3828
|
* @param object The column names and the values to be persisted.
|
3474
3829
|
* @returns The full persisted record.
|
3475
3830
|
*/
|
3476
|
-
abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3831
|
+
abstract createOrUpdate(id: string, object: Omit<EditableData<Data>, 'id'>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3832
|
+
/**
|
3833
|
+
* Creates or updates a single record. If a record exists with the given id,
|
3834
|
+
* it will be update, otherwise a new record will be created.
|
3835
|
+
* @param objects Array of objects with the column names and the values to be stored in the table.
|
3836
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
3837
|
+
* @returns Array of the persisted records.
|
3838
|
+
*/
|
3839
|
+
abstract createOrUpdate<K extends SelectableColumn<Record>>(objects: Array<EditableData<Data> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3477
3840
|
/**
|
3478
3841
|
* Creates or updates a single record. If a record exists with the given id,
|
3479
3842
|
* it will be update, otherwise a new record will be created.
|
@@ -3513,39 +3876,111 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3513
3876
|
*/
|
3514
3877
|
abstract search(query: string, options?: {
|
3515
3878
|
fuzziness?: FuzzinessExpression;
|
3879
|
+
prefix?: PrefixExpression;
|
3516
3880
|
highlight?: HighlightExpression;
|
3517
3881
|
filter?: Filter<Record>;
|
3518
|
-
|
3882
|
+
boosters?: Boosters<Record>[];
|
3883
|
+
}): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
|
3519
3884
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3520
3885
|
}
|
3521
3886
|
declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Data, Record> {
|
3522
3887
|
#private;
|
3523
|
-
db: SchemaPluginResult<any>;
|
3524
3888
|
constructor(options: {
|
3525
3889
|
table: string;
|
3526
3890
|
db: SchemaPluginResult<any>;
|
3527
3891
|
pluginOptions: XataPluginOptions;
|
3892
|
+
schemaTables?: Table[];
|
3528
3893
|
});
|
3529
|
-
create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3530
|
-
create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3531
|
-
create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']
|
3532
|
-
|
3894
|
+
create(object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3895
|
+
create(recordId: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3896
|
+
create(objects: EditableData<Data>[]): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3897
|
+
create<K extends SelectableColumn<Record>>(object: EditableData<Data>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3898
|
+
create<K extends SelectableColumn<Record>>(recordId: string, object: EditableData<Data>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
3899
|
+
create<K extends SelectableColumn<Record>>(objects: EditableData<Data>[], columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
3900
|
+
read(recordId: string): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3533
3901
|
read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3902
|
+
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
3903
|
+
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3904
|
+
read<K extends SelectableColumn<Record>>(recordId: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
3905
|
+
read<K extends SelectableColumn<Record>>(recordIds: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
3906
|
+
read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
3907
|
+
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
3534
3908
|
update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
|
3535
3909
|
update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
|
3536
3910
|
update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
|
3911
|
+
update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Data>> & Identifiable, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3912
|
+
update<K extends SelectableColumn<Record>>(recordId: string, object: Partial<EditableData<Data>>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3913
|
+
update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Data>> & Identifiable>, columns: K[]): Promise<SelectedPick<Record, typeof columns>[]>;
|
3537
3914
|
createOrUpdate(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
|
3538
3915
|
createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
|
3539
3916
|
createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
|
3917
|
+
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Data>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3918
|
+
createOrUpdate<K extends SelectableColumn<Record>>(recordId: string, object: EditableData<Data>, columns: K[]): Promise<SelectedPick<Record, typeof columns>>;
|
3919
|
+
createOrUpdate<K extends SelectableColumn<Record>>(objects: EditableData<Data>[], columns: K[]): Promise<SelectedPick<Record, typeof columns>[]>;
|
3540
3920
|
delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
|
3541
3921
|
search(query: string, options?: {
|
3542
3922
|
fuzziness?: FuzzinessExpression;
|
3923
|
+
prefix?: PrefixExpression;
|
3543
3924
|
highlight?: HighlightExpression;
|
3544
3925
|
filter?: Filter<Record>;
|
3545
|
-
|
3926
|
+
boosters?: Boosters<Record>[];
|
3927
|
+
}): Promise<any>;
|
3546
3928
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3547
3929
|
}
|
3548
3930
|
|
3931
|
+
declare type BaseSchema = {
|
3932
|
+
name: string;
|
3933
|
+
columns: readonly ({
|
3934
|
+
name: string;
|
3935
|
+
type: Column['type'];
|
3936
|
+
} | {
|
3937
|
+
name: string;
|
3938
|
+
type: 'link';
|
3939
|
+
link: {
|
3940
|
+
table: string;
|
3941
|
+
};
|
3942
|
+
} | {
|
3943
|
+
name: string;
|
3944
|
+
type: 'object';
|
3945
|
+
columns: {
|
3946
|
+
name: string;
|
3947
|
+
type: string;
|
3948
|
+
}[];
|
3949
|
+
})[];
|
3950
|
+
};
|
3951
|
+
declare type SchemaInference<T extends readonly BaseSchema[]> = T extends never[] ? Record<string, Record<string, any>> : T extends readonly unknown[] ? T[number] extends {
|
3952
|
+
name: string;
|
3953
|
+
columns: readonly unknown[];
|
3954
|
+
} ? {
|
3955
|
+
[K in T[number]['name']]: TableType<T[number], K>;
|
3956
|
+
} : never : never;
|
3957
|
+
declare type TableType<Tables, TableName> = Tables & {
|
3958
|
+
name: TableName;
|
3959
|
+
} extends infer Table ? Table extends {
|
3960
|
+
name: string;
|
3961
|
+
columns: infer Columns;
|
3962
|
+
} ? Columns extends readonly unknown[] ? Columns[number] extends {
|
3963
|
+
name: string;
|
3964
|
+
type: string;
|
3965
|
+
} ? Identifiable & {
|
3966
|
+
[K in Columns[number]['name']]?: PropertyType<Tables, Columns[number], K>;
|
3967
|
+
} : never : never : never : never;
|
3968
|
+
declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
|
3969
|
+
name: PropertyName;
|
3970
|
+
} extends infer Property ? Property extends {
|
3971
|
+
name: string;
|
3972
|
+
type: infer Type;
|
3973
|
+
link?: {
|
3974
|
+
table: infer LinkedTable;
|
3975
|
+
};
|
3976
|
+
columns?: infer ObjectColumns;
|
3977
|
+
} ? (Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
3978
|
+
name: string;
|
3979
|
+
type: string;
|
3980
|
+
} ? {
|
3981
|
+
[K in ObjectColumns[number]['name']]?: PropertyType<Tables, ObjectColumns[number], K>;
|
3982
|
+
} : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never) | null : never : never;
|
3983
|
+
|
3549
3984
|
/**
|
3550
3985
|
* Operator to restrict results to only values that are greater than the given value.
|
3551
3986
|
*/
|
@@ -3629,52 +4064,10 @@ declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
3629
4064
|
};
|
3630
4065
|
declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3631
4066
|
#private;
|
3632
|
-
|
3633
|
-
constructor(tableNames?: string[] | undefined);
|
4067
|
+
constructor(schemaTables?: Schemas.Table[]);
|
3634
4068
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
3635
4069
|
}
|
3636
4070
|
|
3637
|
-
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3638
|
-
fuzziness?: FuzzinessExpression;
|
3639
|
-
highlight?: HighlightExpression;
|
3640
|
-
tables?: Array<Tables | Values<{
|
3641
|
-
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
3642
|
-
table: Model;
|
3643
|
-
filter?: Filter<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3644
|
-
};
|
3645
|
-
}>>;
|
3646
|
-
};
|
3647
|
-
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3648
|
-
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3649
|
-
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
3650
|
-
table: Model;
|
3651
|
-
record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3652
|
-
};
|
3653
|
-
}>[]>;
|
3654
|
-
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3655
|
-
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
|
3656
|
-
}>;
|
3657
|
-
};
|
3658
|
-
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3659
|
-
#private;
|
3660
|
-
private db;
|
3661
|
-
constructor(db: SchemaPluginResult<Schemas>);
|
3662
|
-
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3663
|
-
}
|
3664
|
-
declare type SearchXataRecord = XataRecord<SearchExtraProperties>;
|
3665
|
-
declare type SearchExtraProperties = {
|
3666
|
-
table: string;
|
3667
|
-
highlight?: {
|
3668
|
-
[key: string]: string[] | {
|
3669
|
-
[key: string]: any;
|
3670
|
-
};
|
3671
|
-
};
|
3672
|
-
};
|
3673
|
-
declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
|
3674
|
-
declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
|
3675
|
-
table: infer Table;
|
3676
|
-
} ? ReturnTable<Table, Tables> : never;
|
3677
|
-
|
3678
4071
|
declare type BranchStrategyValue = string | undefined | null;
|
3679
4072
|
declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
|
3680
4073
|
declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
|
@@ -3686,19 +4079,34 @@ declare type BaseClientOptions = {
|
|
3686
4079
|
databaseURL?: string;
|
3687
4080
|
branch?: BranchStrategyOption;
|
3688
4081
|
cache?: CacheImpl;
|
4082
|
+
trace?: TraceFunction;
|
3689
4083
|
};
|
3690
4084
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
3691
4085
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
3692
|
-
new <
|
3693
|
-
db: Awaited<ReturnType<SchemaPlugin<
|
3694
|
-
search: Awaited<ReturnType<SearchPlugin<
|
4086
|
+
new <T extends readonly BaseSchema[]>(options?: Partial<BaseClientOptions>, schemaTables?: T): Omit<{
|
4087
|
+
db: Awaited<ReturnType<SchemaPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
4088
|
+
search: Awaited<ReturnType<SearchPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
3695
4089
|
}, keyof Plugins> & {
|
3696
4090
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
4091
|
+
} & {
|
4092
|
+
getConfig(): Promise<{
|
4093
|
+
databaseURL: string;
|
4094
|
+
branch: string;
|
4095
|
+
}>;
|
3697
4096
|
};
|
3698
4097
|
}
|
3699
4098
|
declare const BaseClient_base: ClientConstructor<{}>;
|
3700
|
-
declare class BaseClient extends BaseClient_base<
|
4099
|
+
declare class BaseClient extends BaseClient_base<[]> {
|
4100
|
+
}
|
4101
|
+
|
4102
|
+
declare class Serializer {
|
4103
|
+
classes: Record<string, any>;
|
4104
|
+
add(clazz: any): void;
|
4105
|
+
toJSON<T>(data: T): string;
|
4106
|
+
fromJSON<T>(json: string): T;
|
3701
4107
|
}
|
4108
|
+
declare const serialize: <T>(data: T) => string;
|
4109
|
+
declare const deserialize: <T>(json: string) => T;
|
3702
4110
|
|
3703
4111
|
declare type BranchResolutionOptions = {
|
3704
4112
|
databaseURL?: string;
|
@@ -3711,9 +4119,89 @@ declare function getDatabaseURL(): string | undefined;
|
|
3711
4119
|
|
3712
4120
|
declare function getAPIKey(): string | undefined;
|
3713
4121
|
|
4122
|
+
interface Body {
|
4123
|
+
arrayBuffer(): Promise<ArrayBuffer>;
|
4124
|
+
blob(): Promise<Blob>;
|
4125
|
+
formData(): Promise<FormData>;
|
4126
|
+
json(): Promise<any>;
|
4127
|
+
text(): Promise<string>;
|
4128
|
+
}
|
4129
|
+
interface Blob {
|
4130
|
+
readonly size: number;
|
4131
|
+
readonly type: string;
|
4132
|
+
arrayBuffer(): Promise<ArrayBuffer>;
|
4133
|
+
slice(start?: number, end?: number, contentType?: string): Blob;
|
4134
|
+
text(): Promise<string>;
|
4135
|
+
}
|
4136
|
+
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
4137
|
+
interface File extends Blob {
|
4138
|
+
readonly lastModified: number;
|
4139
|
+
readonly name: string;
|
4140
|
+
readonly webkitRelativePath: string;
|
4141
|
+
}
|
4142
|
+
declare type FormDataEntryValue = File | string;
|
4143
|
+
/** Provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using the XMLHttpRequest.send() method. It uses the same format a form would use if the encoding type were set to "multipart/form-data". */
|
4144
|
+
interface FormData {
|
4145
|
+
append(name: string, value: string | Blob, fileName?: string): void;
|
4146
|
+
delete(name: string): void;
|
4147
|
+
get(name: string): FormDataEntryValue | null;
|
4148
|
+
getAll(name: string): FormDataEntryValue[];
|
4149
|
+
has(name: string): boolean;
|
4150
|
+
set(name: string, value: string | Blob, fileName?: string): void;
|
4151
|
+
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
4152
|
+
}
|
4153
|
+
/** This Fetch API interface allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing. A Headers object has an associated header list, which is initially empty and consists of zero or more name and value pairs. You can add to this using methods like append() (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence. */
|
4154
|
+
interface Headers {
|
4155
|
+
append(name: string, value: string): void;
|
4156
|
+
delete(name: string): void;
|
4157
|
+
get(name: string): string | null;
|
4158
|
+
has(name: string): boolean;
|
4159
|
+
set(name: string, value: string): void;
|
4160
|
+
forEach(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
|
4161
|
+
}
|
4162
|
+
interface Request extends Body {
|
4163
|
+
/** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. */
|
4164
|
+
readonly cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
|
4165
|
+
/** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. */
|
4166
|
+
readonly credentials: 'include' | 'omit' | 'same-origin';
|
4167
|
+
/** Returns the kind of resource requested by request, e.g., "document" or "script". */
|
4168
|
+
readonly destination: '' | 'audio' | 'audioworklet' | 'document' | 'embed' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'sharedworker' | 'style' | 'track' | 'video' | 'worker' | 'xslt';
|
4169
|
+
/** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. */
|
4170
|
+
readonly headers: Headers;
|
4171
|
+
/** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
|
4172
|
+
readonly integrity: string;
|
4173
|
+
/** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
|
4174
|
+
readonly keepalive: boolean;
|
4175
|
+
/** Returns request's HTTP method, which is "GET" by default. */
|
4176
|
+
readonly method: string;
|
4177
|
+
/** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. */
|
4178
|
+
readonly mode: 'cors' | 'navigate' | 'no-cors' | 'same-origin';
|
4179
|
+
/** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. */
|
4180
|
+
readonly redirect: 'error' | 'follow' | 'manual';
|
4181
|
+
/** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. */
|
4182
|
+
readonly referrer: string;
|
4183
|
+
/** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. */
|
4184
|
+
readonly referrerPolicy: '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
|
4185
|
+
/** Returns the URL of request as a string. */
|
4186
|
+
readonly url: string;
|
4187
|
+
clone(): Request;
|
4188
|
+
}
|
4189
|
+
|
4190
|
+
declare type XataWorkerContext<XataClient> = {
|
4191
|
+
xata: XataClient;
|
4192
|
+
request: Request;
|
4193
|
+
env: Record<string, string | undefined>;
|
4194
|
+
};
|
4195
|
+
declare type RemoveFirst<T> = T extends [any, ...infer U] ? U : never;
|
4196
|
+
declare type WorkerRunnerConfig = {
|
4197
|
+
workspace: string;
|
4198
|
+
worker: string;
|
4199
|
+
};
|
4200
|
+
declare function buildWorkerRunner<XataClient>(config: WorkerRunnerConfig): <WorkerFunction extends (ctx: XataWorkerContext<XataClient>, ...args: any[]) => any>(name: string, _worker: WorkerFunction) => (...args: RemoveFirst<Parameters<WorkerFunction>>) => Promise<Awaited<ReturnType<WorkerFunction>>>;
|
4201
|
+
|
3714
4202
|
declare class XataError extends Error {
|
3715
4203
|
readonly status: number;
|
3716
4204
|
constructor(message: string, status: number);
|
3717
4205
|
}
|
3718
4206
|
|
3719
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams,
|
4207
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|