@xata.io/client 0.25.2 → 0.26.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/dist/index.d.ts CHANGED
@@ -159,6 +159,7 @@ type OAuthClientPublicDetails = {
159
159
  icon?: string;
160
160
  clientId: string;
161
161
  };
162
+ type OAuthClientID = string;
162
163
  type OAuthAccessToken = {
163
164
  token: string;
164
165
  scopes: string[];
@@ -528,6 +529,26 @@ type GetUserOAuthClientsVariables = ControlPlaneFetcherExtraProps;
528
529
  * Retrieve the list of OAuth Clients that a user has authorized
529
530
  */
530
531
  declare const getUserOAuthClients: (variables: GetUserOAuthClientsVariables, signal?: AbortSignal) => Promise<GetUserOAuthClientsResponse>;
532
+ type DeleteUserOAuthClientPathParams = {
533
+ clientId: OAuthClientID;
534
+ };
535
+ type DeleteUserOAuthClientError = ErrorWrapper$1<{
536
+ status: 400;
537
+ payload: BadRequestError$1;
538
+ } | {
539
+ status: 401;
540
+ payload: AuthError$1;
541
+ } | {
542
+ status: 404;
543
+ payload: SimpleError$1;
544
+ }>;
545
+ type DeleteUserOAuthClientVariables = {
546
+ pathParams: DeleteUserOAuthClientPathParams;
547
+ } & ControlPlaneFetcherExtraProps;
548
+ /**
549
+ * Delete the oauth client for the user and revoke all access
550
+ */
551
+ declare const deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal) => Promise<undefined>;
531
552
  type GetUserOAuthAccessTokensError = ErrorWrapper$1<{
532
553
  status: 400;
533
554
  payload: BadRequestError$1;
@@ -1361,7 +1382,7 @@ type ColumnFile = {
1361
1382
  };
1362
1383
  type Column = {
1363
1384
  name: string;
1364
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file';
1385
+ type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'json';
1365
1386
  link?: ColumnLink;
1366
1387
  vector?: ColumnVector;
1367
1388
  file?: ColumnFile;
@@ -6023,9 +6044,12 @@ declare const operationsByTag: {
6023
6044
  sql: {
6024
6045
  sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<SQLResponse>;
6025
6046
  };
6026
- authOther: {
6047
+ oAuth: {
6027
6048
  getAuthorizationCode: (variables: GetAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6028
6049
  grantAuthorizationCode: (variables: GrantAuthorizationCodeVariables, signal?: AbortSignal | undefined) => Promise<AuthorizationCodeResponse>;
6050
+ getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
6051
+ deleteUserOAuthClient: (variables: DeleteUserOAuthClientVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6052
+ getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
6029
6053
  deleteOAuthAccessToken: (variables: DeleteOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6030
6054
  updateOAuthAccessToken: (variables: UpdateOAuthAccessTokenVariables, signal?: AbortSignal | undefined) => Promise<OAuthAccessToken>;
6031
6055
  };
@@ -6038,8 +6062,6 @@ declare const operationsByTag: {
6038
6062
  getUserAPIKeys: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserAPIKeysResponse>;
6039
6063
  createUserAPIKey: (variables: CreateUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<CreateUserAPIKeyResponse>;
6040
6064
  deleteUserAPIKey: (variables: DeleteUserAPIKeyVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
6041
- getUserOAuthClients: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthClientsResponse>;
6042
- getUserOAuthAccessTokens: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetUserOAuthAccessTokensResponse>;
6043
6065
  };
6044
6066
  workspaces: {
6045
6067
  getWorkspacesList: (variables: ControlPlaneFetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetWorkspacesListResponse>;
@@ -6107,26 +6129,7 @@ type responses_ServiceUnavailableError = ServiceUnavailableError;
6107
6129
  type responses_SimpleError = SimpleError;
6108
6130
  type responses_SummarizeResponse = SummarizeResponse;
6109
6131
  declare namespace responses {
6110
- export {
6111
- responses_AggResponse as AggResponse,
6112
- responses_AuthError as AuthError,
6113
- responses_BadRequestError as BadRequestError,
6114
- responses_BranchMigrationPlan as BranchMigrationPlan,
6115
- responses_BulkError as BulkError,
6116
- responses_BulkInsertResponse as BulkInsertResponse,
6117
- responses_PutFileResponse as PutFileResponse,
6118
- responses_QueryResponse as QueryResponse,
6119
- responses_RateLimitError as RateLimitError,
6120
- responses_RecordResponse as RecordResponse,
6121
- responses_RecordUpdateResponse as RecordUpdateResponse,
6122
- responses_SQLResponse as SQLResponse,
6123
- responses_SchemaCompareResponse as SchemaCompareResponse,
6124
- responses_SchemaUpdateResponse as SchemaUpdateResponse,
6125
- responses_SearchResponse as SearchResponse,
6126
- responses_ServiceUnavailableError as ServiceUnavailableError,
6127
- responses_SimpleError as SimpleError,
6128
- responses_SummarizeResponse as SummarizeResponse,
6129
- };
6132
+ export type { responses_AggResponse as AggResponse, responses_AuthError as AuthError, responses_BadRequestError as BadRequestError, responses_BranchMigrationPlan as BranchMigrationPlan, responses_BulkError as BulkError, responses_BulkInsertResponse as BulkInsertResponse, responses_PutFileResponse as PutFileResponse, responses_QueryResponse as QueryResponse, responses_RateLimitError as RateLimitError, responses_RecordResponse as RecordResponse, responses_RecordUpdateResponse as RecordUpdateResponse, responses_SQLResponse as SQLResponse, responses_SchemaCompareResponse as SchemaCompareResponse, responses_SchemaUpdateResponse as SchemaUpdateResponse, responses_SearchResponse as SearchResponse, responses_ServiceUnavailableError as ServiceUnavailableError, responses_SimpleError as SimpleError, responses_SummarizeResponse as SummarizeResponse };
6130
6133
  }
6131
6134
 
6132
6135
  type schemas_APIKeyName = APIKeyName;
@@ -6203,6 +6206,7 @@ type schemas_MigrationTableOp = MigrationTableOp;
6203
6206
  type schemas_MinAgg = MinAgg;
6204
6207
  type schemas_NumericHistogramAgg = NumericHistogramAgg;
6205
6208
  type schemas_OAuthAccessToken = OAuthAccessToken;
6209
+ type schemas_OAuthClientID = OAuthClientID;
6206
6210
  type schemas_OAuthClientPublicDetails = OAuthClientPublicDetails;
6207
6211
  type schemas_OAuthResponseType = OAuthResponseType;
6208
6212
  type schemas_OAuthScope = OAuthScope;
@@ -6259,143 +6263,7 @@ type schemas_WorkspaceMember = WorkspaceMember;
6259
6263
  type schemas_WorkspaceMembers = WorkspaceMembers;
6260
6264
  type schemas_WorkspaceMeta = WorkspaceMeta;
6261
6265
  declare namespace schemas {
6262
- export {
6263
- schemas_APIKeyName as APIKeyName,
6264
- schemas_AccessToken as AccessToken,
6265
- schemas_AggExpression as AggExpression,
6266
- schemas_AggExpressionMap as AggExpressionMap,
6267
- AggResponse$1 as AggResponse,
6268
- schemas_AuthorizationCodeRequest as AuthorizationCodeRequest,
6269
- schemas_AuthorizationCodeResponse as AuthorizationCodeResponse,
6270
- schemas_AverageAgg as AverageAgg,
6271
- schemas_BoosterExpression as BoosterExpression,
6272
- schemas_Branch as Branch,
6273
- schemas_BranchMetadata as BranchMetadata,
6274
- schemas_BranchMigration as BranchMigration,
6275
- schemas_BranchName as BranchName,
6276
- schemas_BranchOp as BranchOp,
6277
- schemas_BranchWithCopyID as BranchWithCopyID,
6278
- schemas_Column as Column,
6279
- schemas_ColumnFile as ColumnFile,
6280
- schemas_ColumnLink as ColumnLink,
6281
- schemas_ColumnMigration as ColumnMigration,
6282
- schemas_ColumnName as ColumnName,
6283
- schemas_ColumnOpAdd as ColumnOpAdd,
6284
- schemas_ColumnOpRemove as ColumnOpRemove,
6285
- schemas_ColumnOpRename as ColumnOpRename,
6286
- schemas_ColumnVector as ColumnVector,
6287
- schemas_ColumnsProjection as ColumnsProjection,
6288
- schemas_Commit as Commit,
6289
- schemas_CountAgg as CountAgg,
6290
- schemas_DBBranch as DBBranch,
6291
- schemas_DBBranchName as DBBranchName,
6292
- schemas_DBName as DBName,
6293
- schemas_DataInputRecord as DataInputRecord,
6294
- schemas_DatabaseGithubSettings as DatabaseGithubSettings,
6295
- schemas_DatabaseMetadata as DatabaseMetadata,
6296
- DateBooster$1 as DateBooster,
6297
- schemas_DateHistogramAgg as DateHistogramAgg,
6298
- schemas_DateTime as DateTime,
6299
- schemas_FileAccessID as FileAccessID,
6300
- schemas_FileItemID as FileItemID,
6301
- schemas_FileName as FileName,
6302
- schemas_FileResponse as FileResponse,
6303
- schemas_FileSignature as FileSignature,
6304
- schemas_FilterColumn as FilterColumn,
6305
- schemas_FilterColumnIncludes as FilterColumnIncludes,
6306
- schemas_FilterExpression as FilterExpression,
6307
- schemas_FilterList as FilterList,
6308
- schemas_FilterPredicate as FilterPredicate,
6309
- schemas_FilterPredicateOp as FilterPredicateOp,
6310
- schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
6311
- schemas_FilterRangeValue as FilterRangeValue,
6312
- schemas_FilterValue as FilterValue,
6313
- schemas_FuzzinessExpression as FuzzinessExpression,
6314
- schemas_HighlightExpression as HighlightExpression,
6315
- schemas_InputFile as InputFile,
6316
- schemas_InputFileArray as InputFileArray,
6317
- schemas_InputFileEntry as InputFileEntry,
6318
- schemas_InviteID as InviteID,
6319
- schemas_InviteKey as InviteKey,
6320
- schemas_ListBranchesResponse as ListBranchesResponse,
6321
- schemas_ListDatabasesResponse as ListDatabasesResponse,
6322
- schemas_ListGitBranchesResponse as ListGitBranchesResponse,
6323
- schemas_ListRegionsResponse as ListRegionsResponse,
6324
- schemas_MaxAgg as MaxAgg,
6325
- schemas_MediaType as MediaType,
6326
- schemas_MetricsDatapoint as MetricsDatapoint,
6327
- schemas_MetricsLatency as MetricsLatency,
6328
- schemas_Migration as Migration,
6329
- schemas_MigrationColumnOp as MigrationColumnOp,
6330
- schemas_MigrationObject as MigrationObject,
6331
- schemas_MigrationOp as MigrationOp,
6332
- schemas_MigrationRequest as MigrationRequest,
6333
- schemas_MigrationRequestNumber as MigrationRequestNumber,
6334
- schemas_MigrationStatus as MigrationStatus,
6335
- schemas_MigrationTableOp as MigrationTableOp,
6336
- schemas_MinAgg as MinAgg,
6337
- NumericBooster$1 as NumericBooster,
6338
- schemas_NumericHistogramAgg as NumericHistogramAgg,
6339
- schemas_OAuthAccessToken as OAuthAccessToken,
6340
- schemas_OAuthClientPublicDetails as OAuthClientPublicDetails,
6341
- schemas_OAuthResponseType as OAuthResponseType,
6342
- schemas_OAuthScope as OAuthScope,
6343
- schemas_ObjectValue as ObjectValue,
6344
- schemas_PageConfig as PageConfig,
6345
- schemas_PrefixExpression as PrefixExpression,
6346
- schemas_ProjectionConfig as ProjectionConfig,
6347
- schemas_QueryColumnsProjection as QueryColumnsProjection,
6348
- schemas_RecordID as RecordID,
6349
- schemas_RecordMeta as RecordMeta,
6350
- schemas_RecordsMetadata as RecordsMetadata,
6351
- schemas_Region as Region,
6352
- schemas_RevLink as RevLink,
6353
- schemas_Role as Role,
6354
- schemas_SQLRecord as SQLRecord,
6355
- schemas_Schema as Schema,
6356
- schemas_SchemaEditScript as SchemaEditScript,
6357
- schemas_SearchPageConfig as SearchPageConfig,
6358
- schemas_SortExpression as SortExpression,
6359
- schemas_SortOrder as SortOrder,
6360
- schemas_StartedFromMetadata as StartedFromMetadata,
6361
- schemas_SumAgg as SumAgg,
6362
- schemas_SummaryExpression as SummaryExpression,
6363
- schemas_SummaryExpressionList as SummaryExpressionList,
6364
- schemas_Table as Table,
6365
- schemas_TableMigration as TableMigration,
6366
- schemas_TableName as TableName,
6367
- schemas_TableOpAdd as TableOpAdd,
6368
- schemas_TableOpRemove as TableOpRemove,
6369
- schemas_TableOpRename as TableOpRename,
6370
- schemas_TableRename as TableRename,
6371
- schemas_TargetExpression as TargetExpression,
6372
- schemas_TopValuesAgg as TopValuesAgg,
6373
- schemas_TransactionDeleteOp as TransactionDeleteOp,
6374
- schemas_TransactionError as TransactionError,
6375
- schemas_TransactionFailure as TransactionFailure,
6376
- schemas_TransactionGetOp as TransactionGetOp,
6377
- schemas_TransactionInsertOp as TransactionInsertOp,
6378
- TransactionOperation$1 as TransactionOperation,
6379
- schemas_TransactionResultColumns as TransactionResultColumns,
6380
- schemas_TransactionResultDelete as TransactionResultDelete,
6381
- schemas_TransactionResultGet as TransactionResultGet,
6382
- schemas_TransactionResultInsert as TransactionResultInsert,
6383
- schemas_TransactionResultUpdate as TransactionResultUpdate,
6384
- schemas_TransactionSuccess as TransactionSuccess,
6385
- schemas_TransactionUpdateOp as TransactionUpdateOp,
6386
- schemas_UniqueCountAgg as UniqueCountAgg,
6387
- schemas_User as User,
6388
- schemas_UserID as UserID,
6389
- schemas_UserWithID as UserWithID,
6390
- ValueBooster$1 as ValueBooster,
6391
- schemas_Workspace as Workspace,
6392
- schemas_WorkspaceID as WorkspaceID,
6393
- schemas_WorkspaceInvite as WorkspaceInvite,
6394
- schemas_WorkspaceMember as WorkspaceMember,
6395
- schemas_WorkspaceMembers as WorkspaceMembers,
6396
- schemas_WorkspaceMeta as WorkspaceMeta,
6397
- XataRecord$1 as XataRecord,
6398
- };
6266
+ export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchMetadata as BranchMetadata, schemas_BranchMigration as BranchMigration, schemas_BranchName as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, schemas_DBName as DBName, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, schemas_MigrationStatus as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, XataRecord$1 as XataRecord };
6399
6267
  }
6400
6268
 
6401
6269
  type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
@@ -7299,7 +7167,7 @@ interface ImageTransformations {
7299
7167
  */
7300
7168
  width?: number;
7301
7169
  }
7302
- declare function transformImage(url: string | undefined, transformations: ImageTransformations[]): string | undefined;
7170
+ declare function transformImage(url: string | undefined, ...transformations: ImageTransformations[]): string | undefined;
7303
7171
 
7304
7172
  type XataFileEditableFields = Partial<Pick<XataArrayFile, keyof InputFileEntry>>;
7305
7173
  declare class XataFile {
@@ -7391,7 +7259,7 @@ type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${in
7391
7259
  } : unknown;
7392
7260
  type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
7393
7261
 
7394
- declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file"];
7262
+ declare const RecordColumnTypes: readonly ["bool", "int", "float", "string", "text", "email", "multiple", "link", "object", "datetime", "vector", "file[]", "file", "json"];
7395
7263
  type Identifier = string;
7396
7264
  /**
7397
7265
  * Represents an identifiable record from the database.
@@ -9315,6 +9183,20 @@ declare class FilesPlugin<Schemas extends Record<string, XataRecord>> extends Xa
9315
9183
  build(pluginOptions: XataPluginOptions): FilesPluginResult<Schemas>;
9316
9184
  }
9317
9185
 
9186
+ type SQLQueryParams<T = any[]> = {
9187
+ statement: string;
9188
+ params?: T;
9189
+ consistency?: 'strong' | 'eventual';
9190
+ };
9191
+ type SQLQuery = TemplateStringsArray | SQLQueryParams | string;
9192
+ type SQLPluginResult = <T>(query: SQLQuery, ...parameters: any[]) => Promise<{
9193
+ records: T[];
9194
+ warning?: string;
9195
+ }>;
9196
+ declare class SQLPlugin extends XataPlugin {
9197
+ build(pluginOptions: XataPluginOptions): SQLPluginResult;
9198
+ }
9199
+
9318
9200
  type TransactionOperation<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
9319
9201
  insert: Values<{
9320
9202
  [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
@@ -9415,6 +9297,7 @@ interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
9415
9297
  db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
9416
9298
  search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
9417
9299
  transactions: Awaited<ReturnType<TransactionPlugin<Schemas>['build']>>;
9300
+ sql: Awaited<ReturnType<SQLPlugin['build']>>;
9418
9301
  files: Awaited<ReturnType<FilesPlugin<Schemas>['build']>>;
9419
9302
  }, keyof Plugins> & {
9420
9303
  [Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
@@ -9539,4 +9422,4 @@ declare class XataError extends Error {
9539
9422
  constructor(message: string, status: number);
9540
9423
  }
9541
9424
 
9542
- export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableSessionError, AskTableSessionPathParams, AskTableSessionRequestBody, AskTableSessionResponse, AskTableSessionVariables, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BinaryFile, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteFileError, DeleteFileItemError, DeleteFileItemPathParams, DeleteFileItemVariables, DeleteFilePathParams, DeleteFileVariables, DeleteOAuthAccessTokenError, DeleteOAuthAccessTokenPathParams, DeleteOAuthAccessTokenVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, DownloadDestination, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, FileAccessError, FileAccessPathParams, FileAccessQueryParams, FileAccessVariables, FilesPlugin, FilesPluginResult, GetAuthorizationCodeError, GetAuthorizationCodeQueryParams, GetAuthorizationCodeVariables, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetFileError, GetFileItemError, GetFileItemPathParams, GetFileItemVariables, GetFilePathParams, GetFileVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserOAuthAccessTokensError, GetUserOAuthAccessTokensResponse, GetUserOAuthAccessTokensVariables, GetUserOAuthClientsError, GetUserOAuthClientsResponse, GetUserOAuthClientsVariables, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, GrantAuthorizationCodeError, GrantAuthorizationCodeVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, JSONData, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, PutFileError, PutFileItemError, PutFileItemPathParams, PutFileItemVariables, PutFilePathParams, PutFileVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RecordColumnTypes, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, RenameDatabaseError, RenameDatabasePathParams, RenameDatabaseRequestBody, RenameDatabaseVariables, 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, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateOAuthAccessTokenError, UpdateOAuthAccessTokenPathParams, UpdateOAuthAccessTokenRequestBody, UpdateOAuthAccessTokenVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UploadDestination, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataArrayFile, XataError, XataFile, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
9425
+ export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
package/dist/index.mjs CHANGED
@@ -527,7 +527,7 @@ function defaultOnOpen(response) {
527
527
  }
528
528
  }
529
529
 
530
- const VERSION = "0.25.2";
530
+ const VERSION = "0.26.0";
531
531
 
532
532
  var __defProp$7 = Object.defineProperty;
533
533
  var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -1098,6 +1098,12 @@ const getUserOAuthClients = (variables, signal) => controlPlaneFetch({
1098
1098
  ...variables,
1099
1099
  signal
1100
1100
  });
1101
+ const deleteUserOAuthClient = (variables, signal) => controlPlaneFetch({
1102
+ url: "/user/oauth/clients/{clientId}",
1103
+ method: "delete",
1104
+ ...variables,
1105
+ signal
1106
+ });
1101
1107
  const getUserOAuthAccessTokens = (variables, signal) => controlPlaneFetch({
1102
1108
  url: "/user/oauth/tokens",
1103
1109
  method: "get",
@@ -1180,9 +1186,17 @@ const listRegions = (variables, signal) => controlPlaneFetch({
1180
1186
  signal
1181
1187
  });
1182
1188
  const operationsByTag$1 = {
1183
- authOther: { getAuthorizationCode, grantAuthorizationCode, deleteOAuthAccessToken, updateOAuthAccessToken },
1189
+ oAuth: {
1190
+ getAuthorizationCode,
1191
+ grantAuthorizationCode,
1192
+ getUserOAuthClients,
1193
+ deleteUserOAuthClient,
1194
+ getUserOAuthAccessTokens,
1195
+ deleteOAuthAccessToken,
1196
+ updateOAuthAccessToken
1197
+ },
1184
1198
  users: { getUser, updateUser, deleteUser },
1185
- authentication: { getUserAPIKeys, createUserAPIKey, deleteUserAPIKey, getUserOAuthClients, getUserOAuthAccessTokens },
1199
+ authentication: { getUserAPIKeys, createUserAPIKey, deleteUserAPIKey },
1186
1200
  workspaces: {
1187
1201
  getWorkspacesList,
1188
1202
  createWorkspace,
@@ -2664,7 +2678,7 @@ function buildTransformString(transformations) {
2664
2678
  })
2665
2679
  ).join(",");
2666
2680
  }
2667
- function transformImage(url, transformations) {
2681
+ function transformImage(url, ...transformations) {
2668
2682
  if (!isDefined(url))
2669
2683
  return void 0;
2670
2684
  const transformationsString = buildTransformString(transformations);
@@ -2805,8 +2819,8 @@ class XataFile {
2805
2819
  }
2806
2820
  transform(...options) {
2807
2821
  return {
2808
- url: transformImage(this.url, options),
2809
- signedUrl: transformImage(this.signedUrl, options)
2822
+ url: transformImage(this.url, ...options),
2823
+ signedUrl: transformImage(this.signedUrl, ...options)
2810
2824
  };
2811
2825
  }
2812
2826
  }
@@ -3302,7 +3316,8 @@ const RecordColumnTypes = [
3302
3316
  "datetime",
3303
3317
  "vector",
3304
3318
  "file[]",
3305
- "file"
3319
+ "file",
3320
+ "json"
3306
3321
  ];
3307
3322
  function isIdentifiable(x) {
3308
3323
  return isObject(x) && isString(x?.id);
@@ -4388,6 +4403,78 @@ getSchemaTables_fn = async function(pluginOptions) {
4388
4403
  return schema.tables;
4389
4404
  };
4390
4405
 
4406
+ function escapeElement(elementRepresentation) {
4407
+ const escaped = elementRepresentation.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
4408
+ return '"' + escaped + '"';
4409
+ }
4410
+ function arrayString(val) {
4411
+ let result = "{";
4412
+ for (let i = 0; i < val.length; i++) {
4413
+ if (i > 0) {
4414
+ result = result + ",";
4415
+ }
4416
+ if (val[i] === null || typeof val[i] === "undefined") {
4417
+ result = result + "NULL";
4418
+ } else if (Array.isArray(val[i])) {
4419
+ result = result + arrayString(val[i]);
4420
+ } else if (val[i] instanceof Buffer) {
4421
+ result += "\\\\x" + val[i].toString("hex");
4422
+ } else {
4423
+ result += escapeElement(prepareValue(val[i]));
4424
+ }
4425
+ }
4426
+ result = result + "}";
4427
+ return result;
4428
+ }
4429
+ function prepareValue(value) {
4430
+ if (!isDefined(value))
4431
+ return null;
4432
+ if (value instanceof Date) {
4433
+ return value.toISOString();
4434
+ }
4435
+ if (Array.isArray(value)) {
4436
+ return arrayString(value);
4437
+ }
4438
+ if (isObject(value)) {
4439
+ return JSON.stringify(value);
4440
+ }
4441
+ try {
4442
+ return value.toString();
4443
+ } catch (e) {
4444
+ return value;
4445
+ }
4446
+ }
4447
+ function prepareParams(param1, param2) {
4448
+ if (isString(param1)) {
4449
+ return { statement: param1, params: param2?.map((value) => prepareValue(value)) };
4450
+ }
4451
+ if (isStringArray(param1)) {
4452
+ const statement = param1.reduce((acc, curr, index) => {
4453
+ return acc + curr + (index < (param2?.length ?? 0) ? "$" + (index + 1) : "");
4454
+ }, "");
4455
+ return { statement, params: param2?.map((value) => prepareValue(value)) };
4456
+ }
4457
+ if (isObject(param1)) {
4458
+ const { statement, params, consistency } = param1;
4459
+ return { statement, params: params?.map((value) => prepareValue(value)), consistency };
4460
+ }
4461
+ throw new Error("Invalid query");
4462
+ }
4463
+
4464
+ class SQLPlugin extends XataPlugin {
4465
+ build(pluginOptions) {
4466
+ return async (param1, ...param2) => {
4467
+ const { statement, params, consistency } = prepareParams(param1, param2);
4468
+ const { records, warning } = await sqlQuery({
4469
+ pathParams: { workspace: "{workspaceId}", dbBranchName: "{dbBranch}", region: "{region}" },
4470
+ body: { statement, params, consistency },
4471
+ ...pluginOptions
4472
+ });
4473
+ return { records, warning };
4474
+ };
4475
+ }
4476
+ }
4477
+
4391
4478
  class TransactionPlugin extends XataPlugin {
4392
4479
  build(pluginOptions) {
4393
4480
  return {
@@ -4441,6 +4528,7 @@ const buildClient = (plugins) => {
4441
4528
  __publicField$2(this, "db");
4442
4529
  __publicField$2(this, "search");
4443
4530
  __publicField$2(this, "transactions");
4531
+ __publicField$2(this, "sql");
4444
4532
  __publicField$2(this, "files");
4445
4533
  const safeOptions = __privateMethod(this, _parseOptions, parseOptions_fn).call(this, options);
4446
4534
  __privateSet(this, _options, safeOptions);
@@ -4452,10 +4540,12 @@ const buildClient = (plugins) => {
4452
4540
  const db = new SchemaPlugin(schemaTables).build(pluginOptions);
4453
4541
  const search = new SearchPlugin(db, schemaTables).build(pluginOptions);
4454
4542
  const transactions = new TransactionPlugin().build(pluginOptions);
4543
+ const sql = new SQLPlugin().build(pluginOptions);
4455
4544
  const files = new FilesPlugin().build(pluginOptions);
4456
4545
  this.db = db;
4457
4546
  this.search = search;
4458
4547
  this.transactions = transactions;
4548
+ this.sql = sql;
4459
4549
  this.files = files;
4460
4550
  for (const [key, namespace] of Object.entries(plugins ?? {})) {
4461
4551
  if (namespace === void 0)
@@ -4655,5 +4745,5 @@ class XataError extends Error {
4655
4745
  }
4656
4746
  }
4657
4747
 
4658
- export { BaseClient, FetcherError, FilesPlugin, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, RecordColumnTypes, Repository, RestRepository, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataFile, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
4748
+ export { BaseClient, FetcherError, FilesPlugin, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Query, RecordArray, RecordColumnTypes, Repository, RestRepository, SQLPlugin, SchemaPlugin, SearchPlugin, Serializer, SimpleCache, XataApiClient, XataApiPlugin, XataError, XataFile, XataPlugin, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
4659
4749
  //# sourceMappingURL=index.mjs.map