@xata.io/client 0.9.1 → 0.10.0
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 +18 -0
- package/dist/index.cjs +205 -147
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +34 -25
- package/dist/index.mjs +205 -147
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
@@ -2794,7 +2794,7 @@ declare type RequiredBy<T, K extends keyof T> = T & {
|
|
2794
2794
|
};
|
2795
2795
|
declare type GetArrayInnerType<T extends readonly any[]> = T[number];
|
2796
2796
|
declare type SingleOrArray<T> = T | T[];
|
2797
|
-
declare type
|
2797
|
+
declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
2798
2798
|
|
2799
2799
|
declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
|
2800
2800
|
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
|
@@ -2989,13 +2989,21 @@ declare type SortFilterBase<T extends XataRecord> = {
|
|
2989
2989
|
[Key in StringKeys<T>]: SortDirection;
|
2990
2990
|
};
|
2991
2991
|
|
2992
|
-
declare type
|
2993
|
-
page?: PaginationOptions;
|
2992
|
+
declare type BaseOptions<T extends XataRecord> = {
|
2994
2993
|
columns?: NonEmptyArray<SelectableColumn<T>>;
|
2994
|
+
cache?: number;
|
2995
|
+
};
|
2996
|
+
declare type CursorQueryOptions = {
|
2997
|
+
pagination?: CursorNavigationOptions & OffsetNavigationOptions;
|
2998
|
+
filter?: never;
|
2999
|
+
sort?: never;
|
3000
|
+
};
|
3001
|
+
declare type OffsetQueryOptions<T extends XataRecord> = {
|
3002
|
+
pagination?: OffsetNavigationOptions;
|
2995
3003
|
filter?: FilterExpression;
|
2996
3004
|
sort?: SortFilter<T> | SortFilter<T>[];
|
2997
|
-
cache?: number;
|
2998
3005
|
};
|
3006
|
+
declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions | OffsetQueryOptions<T>);
|
2999
3007
|
/**
|
3000
3008
|
* Query objects contain the information of all filters, sorting, etc. to be included in the database query.
|
3001
3009
|
*
|
@@ -3064,19 +3072,23 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3064
3072
|
*/
|
3065
3073
|
select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
|
3066
3074
|
getPaginated(): Promise<Page<Record, Result>>;
|
3067
|
-
getPaginated(options:
|
3075
|
+
getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
|
3068
3076
|
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
3069
3077
|
[Symbol.asyncIterator](): AsyncIterableIterator<Result>;
|
3070
|
-
getIterator(
|
3071
|
-
getIterator(
|
3072
|
-
|
3078
|
+
getIterator(): AsyncGenerator<Result[]>;
|
3079
|
+
getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3080
|
+
batchSize?: number;
|
3081
|
+
}): AsyncGenerator<Result[]>;
|
3082
|
+
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3083
|
+
batchSize?: number;
|
3084
|
+
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
3073
3085
|
/**
|
3074
3086
|
* Performs the query in the database and returns a set of results.
|
3075
3087
|
* @param options Additional options to be used when performing the query.
|
3076
3088
|
* @returns An array of records from the database.
|
3077
3089
|
*/
|
3078
3090
|
getMany(): Promise<Result[]>;
|
3079
|
-
getMany(options:
|
3091
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
|
3080
3092
|
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3081
3093
|
/**
|
3082
3094
|
* Performs the query in the database and returns all the results.
|
@@ -3084,17 +3096,21 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3084
3096
|
* @param options Additional options to be used when performing the query.
|
3085
3097
|
* @returns An array of records from the database.
|
3086
3098
|
*/
|
3087
|
-
getAll(
|
3088
|
-
getAll(
|
3089
|
-
|
3099
|
+
getAll(): Promise<Result[]>;
|
3100
|
+
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3101
|
+
batchSize?: number;
|
3102
|
+
}): Promise<Result[]>;
|
3103
|
+
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3104
|
+
batchSize?: number;
|
3105
|
+
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3090
3106
|
/**
|
3091
3107
|
* Performs the query in the database and returns the first result.
|
3092
3108
|
* @param options Additional options to be used when performing the query.
|
3093
3109
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3094
3110
|
*/
|
3095
3111
|
getFirst(): Promise<Result | null>;
|
3096
|
-
getFirst(options:
|
3097
|
-
getFirst<Options extends RequiredBy<
|
3112
|
+
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
3113
|
+
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
3098
3114
|
/**
|
3099
3115
|
* Builds a new query object adding a cache TTL in milliseconds.
|
3100
3116
|
* @param ttl The cache TTL in milliseconds.
|
@@ -3184,14 +3200,11 @@ declare type OffsetNavigationOptions = {
|
|
3184
3200
|
size?: number;
|
3185
3201
|
offset?: number;
|
3186
3202
|
};
|
3187
|
-
declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
|
3188
3203
|
declare const PAGINATION_MAX_SIZE = 200;
|
3189
3204
|
declare const PAGINATION_DEFAULT_SIZE = 200;
|
3190
3205
|
declare const PAGINATION_MAX_OFFSET = 800;
|
3191
3206
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
3192
3207
|
|
3193
|
-
declare type TableLink = string[];
|
3194
|
-
declare type LinkDictionary = Dictionary<TableLink[]>;
|
3195
3208
|
/**
|
3196
3209
|
* Common interface for performing operations on a table.
|
3197
3210
|
*/
|
@@ -3297,7 +3310,6 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
|
|
3297
3310
|
db: SchemaPluginResult<any>;
|
3298
3311
|
constructor(options: {
|
3299
3312
|
table: string;
|
3300
|
-
links?: LinkDictionary;
|
3301
3313
|
db: SchemaPluginResult<any>;
|
3302
3314
|
pluginOptions: XataPluginOptions;
|
3303
3315
|
});
|
@@ -3393,7 +3405,6 @@ declare const includesAny: <T>(value: T) => ArrayFilter<T>;
|
|
3393
3405
|
|
3394
3406
|
declare type SchemaDefinition = {
|
3395
3407
|
table: string;
|
3396
|
-
links?: LinkDictionary;
|
3397
3408
|
};
|
3398
3409
|
declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
|
3399
3410
|
[Key in keyof Schemas]: Repository<Schemas[Key]>;
|
@@ -3402,9 +3413,8 @@ declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
3402
3413
|
};
|
3403
3414
|
declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3404
3415
|
#private;
|
3405
|
-
private links?;
|
3406
3416
|
private tableNames?;
|
3407
|
-
constructor(
|
3417
|
+
constructor(tableNames?: string[] | undefined);
|
3408
3418
|
build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
|
3409
3419
|
}
|
3410
3420
|
|
@@ -3426,8 +3436,7 @@ declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
|
3426
3436
|
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
3427
3437
|
#private;
|
3428
3438
|
private db;
|
3429
|
-
|
3430
|
-
constructor(db: SchemaPluginResult<Schemas>, links: LinkDictionary);
|
3439
|
+
constructor(db: SchemaPluginResult<Schemas>);
|
3431
3440
|
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3432
3441
|
}
|
3433
3442
|
declare type SearchXataRecord = XataRecord & {
|
@@ -3450,7 +3459,7 @@ declare type BaseClientOptions = {
|
|
3450
3459
|
};
|
3451
3460
|
declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
|
3452
3461
|
interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
|
3453
|
-
new <Schemas extends Record<string, BaseData> = {}>(options?: Partial<BaseClientOptions>,
|
3462
|
+
new <Schemas extends Record<string, BaseData> = {}>(options?: Partial<BaseClientOptions>, tables?: string[]): Omit<{
|
3454
3463
|
db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
|
3455
3464
|
search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
|
3456
3465
|
}, keyof Plugins> & {
|
@@ -3477,4 +3486,4 @@ declare class XataError extends Error {
|
|
3477
3486
|
constructor(message: string, status: number);
|
3478
3487
|
}
|
3479
3488
|
|
3480
|
-
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,
|
3489
|
+
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, 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, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
|