@xata.io/client 0.0.0-alpha.vfde9dcf → 0.0.0-alpha.vfe4ae98
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 +80 -0
- package/README.md +271 -1
- package/Usage.md +395 -0
- package/dist/index.cjs +206 -105
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +316 -63
- package/dist/index.mjs +206 -106
- package/dist/index.mjs.map +1 -1
- package/package.json +7 -3
package/dist/index.d.ts
CHANGED
@@ -6,6 +6,9 @@ declare type FetchImpl = (url: string, init?: {
|
|
6
6
|
ok: boolean;
|
7
7
|
status: number;
|
8
8
|
json(): Promise<any>;
|
9
|
+
headers?: {
|
10
|
+
get(name: string): string | null;
|
11
|
+
};
|
9
12
|
}>;
|
10
13
|
declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Record<string, string>) => string;
|
11
14
|
declare type FetcherExtraProps = {
|
@@ -279,6 +282,10 @@ declare type SortOrder = 'asc' | 'desc';
|
|
279
282
|
* @minimum 0
|
280
283
|
*/
|
281
284
|
declare type FuzzinessExpression = number;
|
285
|
+
/**
|
286
|
+
* 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.
|
287
|
+
*/
|
288
|
+
declare type PrefixExpression = 'phrase' | 'disabled';
|
282
289
|
/**
|
283
290
|
* @minProperties 1
|
284
291
|
*/
|
@@ -292,6 +299,10 @@ declare type FilterExpression = {
|
|
292
299
|
} & {
|
293
300
|
[key: string]: FilterColumn;
|
294
301
|
};
|
302
|
+
declare type HighlightExpression = {
|
303
|
+
enabled?: boolean;
|
304
|
+
encodeHTML?: boolean;
|
305
|
+
};
|
295
306
|
declare type FilterList = FilterExpression | FilterExpression[];
|
296
307
|
declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
297
308
|
/**
|
@@ -377,6 +388,11 @@ declare type XataRecord$1 = {
|
|
377
388
|
xata: {
|
378
389
|
version: number;
|
379
390
|
table?: string;
|
391
|
+
highlight?: {
|
392
|
+
[key: string]: string[] | {
|
393
|
+
[key: string]: any;
|
394
|
+
};
|
395
|
+
};
|
380
396
|
warnings?: string[];
|
381
397
|
};
|
382
398
|
} & {
|
@@ -421,7 +437,9 @@ type schemas_ColumnMigration = ColumnMigration;
|
|
421
437
|
type schemas_SortExpression = SortExpression;
|
422
438
|
type schemas_SortOrder = SortOrder;
|
423
439
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
440
|
+
type schemas_PrefixExpression = PrefixExpression;
|
424
441
|
type schemas_FilterExpression = FilterExpression;
|
442
|
+
type schemas_HighlightExpression = HighlightExpression;
|
425
443
|
type schemas_FilterList = FilterList;
|
426
444
|
type schemas_FilterColumn = FilterColumn;
|
427
445
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
@@ -475,7 +493,9 @@ declare namespace schemas {
|
|
475
493
|
schemas_SortExpression as SortExpression,
|
476
494
|
schemas_SortOrder as SortOrder,
|
477
495
|
schemas_FuzzinessExpression as FuzzinessExpression,
|
496
|
+
schemas_PrefixExpression as PrefixExpression,
|
478
497
|
schemas_FilterExpression as FilterExpression,
|
498
|
+
schemas_HighlightExpression as HighlightExpression,
|
479
499
|
schemas_FilterList as FilterList,
|
480
500
|
schemas_FilterColumn as FilterColumn,
|
481
501
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
@@ -2611,7 +2631,9 @@ declare type SearchTableError = ErrorWrapper<{
|
|
2611
2631
|
declare type SearchTableRequestBody = {
|
2612
2632
|
query: string;
|
2613
2633
|
fuzziness?: FuzzinessExpression;
|
2634
|
+
prefix?: PrefixExpression;
|
2614
2635
|
filter?: FilterExpression;
|
2636
|
+
highlight?: HighlightExpression;
|
2615
2637
|
};
|
2616
2638
|
declare type SearchTableVariables = {
|
2617
2639
|
body: SearchTableRequestBody;
|
@@ -2640,9 +2662,13 @@ declare type SearchBranchError = ErrorWrapper<{
|
|
2640
2662
|
payload: SimpleError;
|
2641
2663
|
}>;
|
2642
2664
|
declare type SearchBranchRequestBody = {
|
2643
|
-
tables?: string
|
2665
|
+
tables?: (string | {
|
2666
|
+
table: string;
|
2667
|
+
filter?: FilterExpression;
|
2668
|
+
})[];
|
2644
2669
|
query: string;
|
2645
2670
|
fuzziness?: FuzzinessExpression;
|
2671
|
+
highlight?: HighlightExpression;
|
2646
2672
|
};
|
2647
2673
|
declare type SearchBranchVariables = {
|
2648
2674
|
body: SearchBranchRequestBody;
|
@@ -2782,7 +2808,7 @@ declare class DatabaseApi {
|
|
2782
2808
|
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
2783
2809
|
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
2784
2810
|
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
2785
|
-
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch
|
2811
|
+
resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch?: string, fallbackBranch?: string): Promise<ResolveBranchResponse>;
|
2786
2812
|
}
|
2787
2813
|
declare class BranchApi {
|
2788
2814
|
private extraProps;
|
@@ -2851,14 +2877,14 @@ declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id'
|
|
2851
2877
|
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
|
2852
2878
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
|
2853
2879
|
}>>;
|
2854
|
-
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<O[K] extends
|
2855
|
-
V: ValueAtColumn<
|
2856
|
-
} : never
|
2880
|
+
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> ? {
|
2881
|
+
V: ValueAtColumn<Item, V>;
|
2882
|
+
} : never : O[K] : never> : never : never;
|
2857
2883
|
declare type MAX_RECURSION = 5;
|
2858
2884
|
declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
2859
|
-
[K in DataProps<O>]:
|
2860
|
-
If<IsObject<
|
2861
|
-
K
|
2885
|
+
[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
|
2886
|
+
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
|
2887
|
+
K>> : never;
|
2862
2888
|
}>, never>;
|
2863
2889
|
declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
2864
2890
|
declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
@@ -2885,16 +2911,11 @@ interface BaseData {
|
|
2885
2911
|
/**
|
2886
2912
|
* Represents a persisted record from the database.
|
2887
2913
|
*/
|
2888
|
-
interface XataRecord extends Identifiable {
|
2914
|
+
interface XataRecord<ExtraMetadata extends Record<string, unknown> = Record<string, unknown>> extends Identifiable {
|
2889
2915
|
/**
|
2890
|
-
*
|
2916
|
+
* Get metadata of this record.
|
2891
2917
|
*/
|
2892
|
-
|
2893
|
-
/**
|
2894
|
-
* Number that is increased every time the record is updated.
|
2895
|
-
*/
|
2896
|
-
version: number;
|
2897
|
-
};
|
2918
|
+
getMetadata(): XataRecordMetadata & ExtraMetadata;
|
2898
2919
|
/**
|
2899
2920
|
* Retrieves a refreshed copy of the current record from the database.
|
2900
2921
|
*/
|
@@ -2902,7 +2923,7 @@ interface XataRecord extends Identifiable {
|
|
2902
2923
|
/**
|
2903
2924
|
* Performs a partial update of the current record. On success a new object is
|
2904
2925
|
* returned and the current object is not mutated.
|
2905
|
-
* @param
|
2926
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
2906
2927
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2907
2928
|
*/
|
2908
2929
|
update(partialUpdate: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<Readonly<SelectedPick<this, ['*']>>>;
|
@@ -2921,19 +2942,26 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
|
|
2921
2942
|
/**
|
2922
2943
|
* Performs a partial update of the current record. On success a new object is
|
2923
2944
|
* returned and the current object is not mutated.
|
2924
|
-
* @param
|
2945
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
2925
2946
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2926
2947
|
*/
|
2927
2948
|
update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
2928
2949
|
};
|
2950
|
+
declare type XataRecordMetadata = {
|
2951
|
+
/**
|
2952
|
+
* Number that is increased every time the record is updated.
|
2953
|
+
*/
|
2954
|
+
version: number;
|
2955
|
+
warnings?: string[];
|
2956
|
+
};
|
2929
2957
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
2930
2958
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
2931
2959
|
declare type EditableData<O extends BaseData> = {
|
2932
2960
|
[K in keyof O]: O[K] extends XataRecord ? {
|
2933
2961
|
id: string;
|
2934
|
-
} : NonNullable<O[K]> extends XataRecord ? {
|
2962
|
+
} | string : NonNullable<O[K]> extends XataRecord ? {
|
2935
2963
|
id: string;
|
2936
|
-
} | null | undefined : O[K];
|
2964
|
+
} | string | null | undefined : O[K];
|
2937
2965
|
};
|
2938
2966
|
|
2939
2967
|
/**
|
@@ -3009,8 +3037,8 @@ declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T e
|
|
3009
3037
|
],
|
3010
3038
|
}
|
3011
3039
|
*/
|
3012
|
-
declare type AggregatorFilter<
|
3013
|
-
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<
|
3040
|
+
declare type AggregatorFilter<T> = {
|
3041
|
+
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<T>>;
|
3014
3042
|
};
|
3015
3043
|
/**
|
3016
3044
|
* Existance filter
|
@@ -3025,10 +3053,10 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
|
|
3025
3053
|
* Injects the Api filters on nested properties
|
3026
3054
|
* Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
|
3027
3055
|
*/
|
3028
|
-
declare type NestedApiFilter<T> =
|
3056
|
+
declare type NestedApiFilter<T> = {
|
3029
3057
|
[key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
|
3030
|
-
}
|
3031
|
-
declare type Filter<
|
3058
|
+
};
|
3059
|
+
declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
|
3032
3060
|
|
3033
3061
|
declare type SortDirection = 'asc' | 'desc';
|
3034
3062
|
declare type SortFilterExtended<T extends XataRecord> = {
|
@@ -3064,8 +3092,8 @@ declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryO
|
|
3064
3092
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
3065
3093
|
#private;
|
3066
3094
|
readonly meta: PaginationQueryMeta;
|
3067
|
-
readonly records: Result
|
3068
|
-
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>,
|
3095
|
+
readonly records: RecordArray<Result>;
|
3096
|
+
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
|
3069
3097
|
getQueryOptions(): QueryOptions<Record>;
|
3070
3098
|
key(): string;
|
3071
3099
|
/**
|
@@ -3097,18 +3125,28 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3097
3125
|
*
|
3098
3126
|
* ```
|
3099
3127
|
* query.filter("columnName", columnValue)
|
3100
|
-
* query.filter(
|
3101
|
-
*
|
3102
|
-
*
|
3128
|
+
* query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
|
3129
|
+
* ```
|
3130
|
+
*
|
3131
|
+
* @param column The name of the column to filter.
|
3132
|
+
* @param value The value to filter.
|
3133
|
+
* @returns A new Query object.
|
3134
|
+
*/
|
3135
|
+
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3136
|
+
/**
|
3137
|
+
* Builds a new query object adding one or more constraints. Examples:
|
3138
|
+
*
|
3139
|
+
* ```
|
3140
|
+
* query.filter({ "columnName": columnValue })
|
3103
3141
|
* query.filter({
|
3104
3142
|
* "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
|
3105
3143
|
* })
|
3106
3144
|
* ```
|
3107
3145
|
*
|
3146
|
+
* @param filters A filter object
|
3108
3147
|
* @returns A new Query object.
|
3109
3148
|
*/
|
3110
3149
|
filter(filters: Filter<Record>): Query<Record, Result>;
|
3111
|
-
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3112
3150
|
/**
|
3113
3151
|
* Builds a new query with a new sort option.
|
3114
3152
|
* @param column The column name.
|
@@ -3122,56 +3160,148 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3122
3160
|
* @returns A new Query object.
|
3123
3161
|
*/
|
3124
3162
|
select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
|
3163
|
+
/**
|
3164
|
+
* Get paginated results
|
3165
|
+
*
|
3166
|
+
* @returns A page of results
|
3167
|
+
*/
|
3125
3168
|
getPaginated(): Promise<Page<Record, Result>>;
|
3169
|
+
/**
|
3170
|
+
* Get paginated results
|
3171
|
+
*
|
3172
|
+
* @param options Pagination options
|
3173
|
+
* @returns A page of results
|
3174
|
+
*/
|
3126
3175
|
getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
|
3176
|
+
/**
|
3177
|
+
* Get paginated results
|
3178
|
+
*
|
3179
|
+
* @param options Pagination options
|
3180
|
+
* @returns A page of results
|
3181
|
+
*/
|
3127
3182
|
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
3183
|
+
/**
|
3184
|
+
* Get results in an iterator
|
3185
|
+
*
|
3186
|
+
* @async
|
3187
|
+
* @returns Async interable of results
|
3188
|
+
*/
|
3128
3189
|
[Symbol.asyncIterator](): AsyncIterableIterator<Result>;
|
3190
|
+
/**
|
3191
|
+
* Build an iterator of results
|
3192
|
+
*
|
3193
|
+
* @returns Async generator of results array
|
3194
|
+
*/
|
3129
3195
|
getIterator(): AsyncGenerator<Result[]>;
|
3196
|
+
/**
|
3197
|
+
* Build an iterator of results
|
3198
|
+
*
|
3199
|
+
* @param options Pagination options with batchSize
|
3200
|
+
* @returns Async generator of results array
|
3201
|
+
*/
|
3130
3202
|
getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3131
3203
|
batchSize?: number;
|
3132
3204
|
}): AsyncGenerator<Result[]>;
|
3205
|
+
/**
|
3206
|
+
* Build an iterator of results
|
3207
|
+
*
|
3208
|
+
* @param options Pagination options with batchSize
|
3209
|
+
* @returns Async generator of results array
|
3210
|
+
*/
|
3133
3211
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3134
3212
|
batchSize?: number;
|
3135
3213
|
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
3214
|
+
/**
|
3215
|
+
* Performs the query in the database and returns a set of results.
|
3216
|
+
* @returns An array of records from the database.
|
3217
|
+
*/
|
3218
|
+
getMany(): Promise<RecordArray<Result>>;
|
3219
|
+
/**
|
3220
|
+
* Performs the query in the database and returns a set of results.
|
3221
|
+
* @param options Additional options to be used when performing the query.
|
3222
|
+
* @returns An array of records from the database.
|
3223
|
+
*/
|
3224
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
3136
3225
|
/**
|
3137
3226
|
* Performs the query in the database and returns a set of results.
|
3138
3227
|
* @param options Additional options to be used when performing the query.
|
3139
3228
|
* @returns An array of records from the database.
|
3140
3229
|
*/
|
3141
|
-
getMany(): Promise<Result
|
3142
|
-
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
|
3143
|
-
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3230
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<RecordArray<Result>>;
|
3144
3231
|
/**
|
3145
3232
|
* Performs the query in the database and returns all the results.
|
3146
3233
|
* Warning: If there are a large number of results, this method can have performance implications.
|
3147
|
-
* @param options Additional options to be used when performing the query.
|
3148
3234
|
* @returns An array of records from the database.
|
3149
3235
|
*/
|
3150
3236
|
getAll(): Promise<Result[]>;
|
3151
|
-
|
3152
|
-
|
3153
|
-
|
3237
|
+
/**
|
3238
|
+
* Performs the query in the database and returns all the results.
|
3239
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3240
|
+
* @param options Additional options to be used when performing the query.
|
3241
|
+
* @returns An array of records from the database.
|
3242
|
+
*/
|
3154
3243
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3155
3244
|
batchSize?: number;
|
3156
3245
|
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3157
3246
|
/**
|
3158
|
-
* Performs the query in the database and returns the
|
3247
|
+
* Performs the query in the database and returns all the results.
|
3248
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3159
3249
|
* @param options Additional options to be used when performing the query.
|
3250
|
+
* @returns An array of records from the database.
|
3251
|
+
*/
|
3252
|
+
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3253
|
+
batchSize?: number;
|
3254
|
+
}): Promise<Result[]>;
|
3255
|
+
/**
|
3256
|
+
* Performs the query in the database and returns the first result.
|
3160
3257
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3161
3258
|
*/
|
3162
3259
|
getFirst(): Promise<Result | null>;
|
3163
|
-
|
3260
|
+
/**
|
3261
|
+
* Performs the query in the database and returns the first result.
|
3262
|
+
* @param options Additional options to be used when performing the query.
|
3263
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3264
|
+
*/
|
3164
3265
|
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
3266
|
+
/**
|
3267
|
+
* Performs the query in the database and returns the first result.
|
3268
|
+
* @param options Additional options to be used when performing the query.
|
3269
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3270
|
+
*/
|
3271
|
+
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
3165
3272
|
/**
|
3166
3273
|
* Builds a new query object adding a cache TTL in milliseconds.
|
3167
3274
|
* @param ttl The cache TTL in milliseconds.
|
3168
3275
|
* @returns A new Query object.
|
3169
3276
|
*/
|
3170
3277
|
cache(ttl: number): Query<Record, Result>;
|
3278
|
+
/**
|
3279
|
+
* Retrieve next page of records
|
3280
|
+
*
|
3281
|
+
* @returns A new page object.
|
3282
|
+
*/
|
3171
3283
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3284
|
+
/**
|
3285
|
+
* Retrieve previous page of records
|
3286
|
+
*
|
3287
|
+
* @returns A new page object
|
3288
|
+
*/
|
3172
3289
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3290
|
+
/**
|
3291
|
+
* Retrieve first page of records
|
3292
|
+
*
|
3293
|
+
* @returns A new page object
|
3294
|
+
*/
|
3173
3295
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3296
|
+
/**
|
3297
|
+
* Retrieve last page of records
|
3298
|
+
*
|
3299
|
+
* @returns A new page object
|
3300
|
+
*/
|
3174
3301
|
lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3302
|
+
/**
|
3303
|
+
* @returns Boolean indicating if there is a next page
|
3304
|
+
*/
|
3175
3305
|
hasNextPage(): boolean;
|
3176
3306
|
}
|
3177
3307
|
|
@@ -3183,7 +3313,7 @@ declare type PaginationQueryMeta = {
|
|
3183
3313
|
};
|
3184
3314
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
3185
3315
|
meta: PaginationQueryMeta;
|
3186
|
-
records: Result
|
3316
|
+
records: RecordArray<Result>;
|
3187
3317
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3188
3318
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3189
3319
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -3203,7 +3333,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
3203
3333
|
/**
|
3204
3334
|
* The set of results for this page.
|
3205
3335
|
*/
|
3206
|
-
readonly records: Result
|
3336
|
+
readonly records: RecordArray<Result>;
|
3207
3337
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
3208
3338
|
/**
|
3209
3339
|
* Retrieves the next page of results.
|
@@ -3252,10 +3382,43 @@ declare type OffsetNavigationOptions = {
|
|
3252
3382
|
offset?: number;
|
3253
3383
|
};
|
3254
3384
|
declare const PAGINATION_MAX_SIZE = 200;
|
3255
|
-
declare const PAGINATION_DEFAULT_SIZE =
|
3385
|
+
declare const PAGINATION_DEFAULT_SIZE = 20;
|
3256
3386
|
declare const PAGINATION_MAX_OFFSET = 800;
|
3257
3387
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
3258
3388
|
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
3389
|
+
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
3390
|
+
#private;
|
3391
|
+
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
3392
|
+
static parseConstructorParams(...args: any[]): any[];
|
3393
|
+
/**
|
3394
|
+
* Retrieve next page of records
|
3395
|
+
*
|
3396
|
+
* @returns A new array of objects
|
3397
|
+
*/
|
3398
|
+
nextPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3399
|
+
/**
|
3400
|
+
* Retrieve previous page of records
|
3401
|
+
*
|
3402
|
+
* @returns A new array of objects
|
3403
|
+
*/
|
3404
|
+
previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3405
|
+
/**
|
3406
|
+
* Retrieve first page of records
|
3407
|
+
*
|
3408
|
+
* @returns A new array of objects
|
3409
|
+
*/
|
3410
|
+
firstPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3411
|
+
/**
|
3412
|
+
* Retrieve last page of records
|
3413
|
+
*
|
3414
|
+
* @returns A new array of objects
|
3415
|
+
*/
|
3416
|
+
lastPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3417
|
+
/**
|
3418
|
+
* @returns Boolean indicating if there is a next page
|
3419
|
+
*/
|
3420
|
+
hasNextPage(): boolean;
|
3421
|
+
}
|
3259
3422
|
|
3260
3423
|
/**
|
3261
3424
|
* Common interface for performing operations on a table.
|
@@ -3281,6 +3444,24 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3281
3444
|
* @returns The persisted record for the given id or null if the record could not be found.
|
3282
3445
|
*/
|
3283
3446
|
abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3447
|
+
/**
|
3448
|
+
* Queries multiple records from the table given their unique id.
|
3449
|
+
* @param ids The unique ids array.
|
3450
|
+
* @returns The persisted records for the given ids (if a record could not be found it is not returned).
|
3451
|
+
*/
|
3452
|
+
abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3453
|
+
/**
|
3454
|
+
* Queries a single record from the table by the id in the object.
|
3455
|
+
* @param object Object containing the id of the record.
|
3456
|
+
* @returns The persisted record for the given id or null if the record could not be found.
|
3457
|
+
*/
|
3458
|
+
abstract read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3459
|
+
/**
|
3460
|
+
* Queries multiple records from the table by the ids in the objects.
|
3461
|
+
* @param objects Array of objects containing the ids of the records.
|
3462
|
+
* @returns The persisted records for the given ids (if a record could not be found it is not returned).
|
3463
|
+
*/
|
3464
|
+
abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3284
3465
|
/**
|
3285
3466
|
* Partially update a single record.
|
3286
3467
|
* @param object An object with its id and the columns to be updated.
|
@@ -3353,7 +3534,8 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3353
3534
|
* @returns The found records.
|
3354
3535
|
*/
|
3355
3536
|
abstract search(query: string, options?: {
|
3356
|
-
fuzziness?:
|
3537
|
+
fuzziness?: FuzzinessExpression;
|
3538
|
+
highlight?: HighlightExpression;
|
3357
3539
|
filter?: Filter<Record>;
|
3358
3540
|
}): Promise<SelectedPick<Record, ['*']>[]>;
|
3359
3541
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
@@ -3365,11 +3547,15 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
|
|
3365
3547
|
table: string;
|
3366
3548
|
db: SchemaPluginResult<any>;
|
3367
3549
|
pluginOptions: XataPluginOptions;
|
3550
|
+
schemaTables?: Table[];
|
3368
3551
|
});
|
3369
|
-
create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3370
|
-
create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']
|
3371
|
-
create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']
|
3552
|
+
create(object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3553
|
+
create(recordId: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
3554
|
+
create(objects: EditableData<Data>[]): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
3372
3555
|
read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
|
3556
|
+
read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3557
|
+
read(object: Identifiable): Promise<SelectedPick<Record, ['*']> | null>;
|
3558
|
+
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3373
3559
|
update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
|
3374
3560
|
update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
|
3375
3561
|
update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
|
@@ -3378,12 +3564,66 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
|
|
3378
3564
|
createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
|
3379
3565
|
delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
|
3380
3566
|
search(query: string, options?: {
|
3381
|
-
fuzziness?:
|
3567
|
+
fuzziness?: FuzzinessExpression;
|
3568
|
+
highlight?: HighlightExpression;
|
3382
3569
|
filter?: Filter<Record>;
|
3383
3570
|
}): Promise<SelectedPick<Record, ['*']>[]>;
|
3384
3571
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3385
3572
|
}
|
3386
3573
|
|
3574
|
+
declare type BaseSchema = {
|
3575
|
+
name: string;
|
3576
|
+
columns: readonly ({
|
3577
|
+
name: string;
|
3578
|
+
type: Column['type'];
|
3579
|
+
} | {
|
3580
|
+
name: string;
|
3581
|
+
type: 'link';
|
3582
|
+
link: {
|
3583
|
+
table: string;
|
3584
|
+
};
|
3585
|
+
} | {
|
3586
|
+
name: string;
|
3587
|
+
type: 'object';
|
3588
|
+
columns: {
|
3589
|
+
name: string;
|
3590
|
+
type: string;
|
3591
|
+
}[];
|
3592
|
+
})[];
|
3593
|
+
};
|
3594
|
+
declare type SchemaInference<T extends readonly BaseSchema[]> = T extends never[] ? Record<string, Record<string, any>> : T extends readonly unknown[] ? T[number] extends {
|
3595
|
+
name: string;
|
3596
|
+
columns: readonly unknown[];
|
3597
|
+
} ? {
|
3598
|
+
[K in T[number]['name']]: TableType<T[number], K>;
|
3599
|
+
} : never : never;
|
3600
|
+
declare type TableType<Tables, TableName> = Tables & {
|
3601
|
+
name: TableName;
|
3602
|
+
} extends infer Table ? Table extends {
|
3603
|
+
name: string;
|
3604
|
+
columns: infer Columns;
|
3605
|
+
} ? Columns extends readonly unknown[] ? Columns[number] extends {
|
3606
|
+
name: string;
|
3607
|
+
type: string;
|
3608
|
+
} ? {
|
3609
|
+
[K in Columns[number]['name']]?: PropertyType<Tables, Columns[number], K>;
|
3610
|
+
} & XataRecord : never : never : never : never;
|
3611
|
+
declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
|
3612
|
+
name: PropertyName;
|
3613
|
+
} extends infer Property ? Property extends {
|
3614
|
+
name: string;
|
3615
|
+
type: infer Type;
|
3616
|
+
link?: {
|
3617
|
+
table: infer LinkedTable;
|
3618
|
+
};
|
3619
|
+
columns?: infer ObjectColumns;
|
3620
|
+
} ? (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 {
|
3621
|
+
name: string;
|
3622
|
+
type: string;
|
3623
|
+
} ? {
|
3624
|
+
[K in ObjectColumns[number]['name']]: PropertyType<Tables, ObjectColumns[number], K>;
|
3625
|
+
} : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never) | null : never : never;
|
3626
|
+
|
3387
3627
|
/**
|
3388
3628
|
* Operator to restrict results to only values that are greater than the given value.
|
3389
3629
|
*/
|
@@ -3467,37 +3707,50 @@ declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
3467
3707
|
};
|
3468
3708
|
declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3469
3709
|
#private;
|
3470
|
-
|
3471
|
-
constructor(tableNames?: string[] | undefined);
|
3710
|
+
constructor(schemaTables?: Schemas.Table[]);
|
3472
3711
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
3473
3712
|
}
|
3474
3713
|
|
3475
3714
|
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3476
|
-
fuzziness?:
|
3477
|
-
|
3715
|
+
fuzziness?: FuzzinessExpression;
|
3716
|
+
highlight?: HighlightExpression;
|
3717
|
+
tables?: Array<Tables | Values<{
|
3718
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
3719
|
+
table: Model;
|
3720
|
+
filter?: Filter<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3721
|
+
};
|
3722
|
+
}>>;
|
3478
3723
|
};
|
3479
3724
|
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3480
3725
|
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3481
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']
|
3726
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
3482
3727
|
table: Model;
|
3483
3728
|
record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3484
3729
|
};
|
3485
3730
|
}>[]>;
|
3486
3731
|
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3487
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']
|
3732
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
|
3488
3733
|
}>;
|
3489
3734
|
};
|
3490
3735
|
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3491
3736
|
#private;
|
3492
3737
|
private db;
|
3493
|
-
constructor(db: SchemaPluginResult<Schemas
|
3738
|
+
constructor(db: SchemaPluginResult<Schemas>, schemaTables?: Schemas.Table[]);
|
3494
3739
|
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3495
3740
|
}
|
3496
|
-
declare type SearchXataRecord = XataRecord
|
3497
|
-
|
3498
|
-
|
3741
|
+
declare type SearchXataRecord = XataRecord<SearchExtraProperties>;
|
3742
|
+
declare type SearchExtraProperties = {
|
3743
|
+
table: string;
|
3744
|
+
highlight?: {
|
3745
|
+
[key: string]: string[] | {
|
3746
|
+
[key: string]: any;
|
3747
|
+
};
|
3499
3748
|
};
|
3500
3749
|
};
|
3750
|
+
declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
|
3751
|
+
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 {
|
3752
|
+
table: infer Table;
|
3753
|
+
} ? ReturnTable<Table, Tables> : never;
|
3501
3754
|
|
3502
3755
|
declare type BranchStrategyValue = string | undefined | null;
|
3503
3756
|
declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
|
@@ -3513,15 +3766,15 @@ declare type BaseClientOptions = {
|
|
3513
3766
|
};
|
3514
3767
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
3515
3768
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
3516
|
-
new <
|
3517
|
-
db: Awaited<ReturnType<SchemaPlugin<
|
3518
|
-
search: Awaited<ReturnType<SearchPlugin<
|
3769
|
+
new <T extends readonly BaseSchema[]>(options?: Partial<BaseClientOptions>, schemaTables?: T): Omit<{
|
3770
|
+
db: Awaited<ReturnType<SchemaPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
3771
|
+
search: Awaited<ReturnType<SearchPlugin<SchemaInference<NonNullable<typeof schemaTables>>>['build']>>;
|
3519
3772
|
}, keyof Plugins> & {
|
3520
3773
|
[Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
|
3521
3774
|
};
|
3522
3775
|
}
|
3523
3776
|
declare const BaseClient_base: ClientConstructor<{}>;
|
3524
|
-
declare class BaseClient extends BaseClient_base<
|
3777
|
+
declare class BaseClient extends BaseClient_base<[]> {
|
3525
3778
|
}
|
3526
3779
|
|
3527
3780
|
declare type BranchResolutionOptions = {
|
@@ -3540,4 +3793,4 @@ declare class XataError extends Error {
|
|
3540
3793
|
constructor(message: string, status: number);
|
3541
3794
|
}
|
3542
3795
|
|
3543
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, 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, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, 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, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, 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, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
|
3796
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, 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, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, 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, InsertRecordResponse, 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, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, 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, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
|