@xata.io/client 0.0.0-alpha.vfd68d20 → 0.0.0-alpha.vfda8f2e

package/dist/index.d.ts

@@ -36,12 +36,13 @@ declare type XataPluginOptions = {
     trace?: TraceFunction;
 };
 
-declare type FetchImpl = (url: string, init?: {
+declare type RequestInit = {
     body?: string;
     headers?: Record<string, string>;
     method?: string;
     signal?: any;
-}) => Promise<{
+};
+declare type Response = {
     ok: boolean;
     status: number;
     url: string;
@@ -49,7 +50,9 @@ declare type FetchImpl = (url: string, init?: {
     headers?: {
         get(name: string): string | null;
     };
-}>;
+};
+declare type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
+
 declare type WorkspaceApiUrlBuilder = (path: string, pathParams: Partial<Record<string, string | number>>) => string;
 declare type FetcherExtraProps = {
     endpoint: 'controlPlane' | 'dataPlane';
@@ -1686,18 +1689,16 @@ declare type AggResponse$1 = (number | null) | {
  * A transaction operation
  */
 declare type TransactionOperation = {
-    insert: TransactionInsert;
+    insert: TransactionInsertOp;
 } | {
-    update: TransactionUpdate;
+    update: TransactionUpdateOp;
 } | {
-    ['delete']: TransactionDelete;
+    ['delete']: TransactionDeleteOp;
 };
 /**
  * Insert operation
- *
- * @x-go-type TxOperation
  */
-declare type TransactionInsert = {
+declare type TransactionInsertOp = {
     /**
      * The table name
      */
@@ -1726,10 +1727,8 @@ declare type TransactionInsert = {
 };
 /**
  * Update operation
- *
- * @x-go-type TxOperation
  */
-declare type TransactionUpdate = {
+declare type TransactionUpdateOp = {
     /**
      * The table name
      */
@@ -1752,10 +1751,8 @@ declare type TransactionUpdate = {
 };
 /**
  * A delete operation. The transaction will continue if no record matches the ID.
- *
- * @x-go-type TxOperation
  */
-declare type TransactionDelete = {
+declare type TransactionDeleteOp = {
     /**
      * The table name
      */
@@ -1766,6 +1763,10 @@ declare type TransactionDelete = {
  * A result from an insert operation.
  */
 declare type TransactionResultInsert = {
+    /**
+     * The type of operation who's result is being returned.
+     */
+    operation: 'insert';
     /**
      * The number of affected rows
      */
@@ -1777,7 +1778,11 @@ declare type TransactionResultInsert = {
  */
 declare type TransactionResultUpdate = {
     /**
-     * The number of affected rows
+     * The type of operation who's result is being returned.
+     */
+    operation: 'update';
+    /**
+     * The number of updated rows
      */
     rows: number;
     id: RecordID;
@@ -1787,12 +1792,18 @@ declare type TransactionResultUpdate = {
  */
 declare type TransactionResultDelete = {
     /**
-     * The number of affected rows
+     * The type of operation who's result is being returned.
+     */
+    operation: 'delete';
+    /**
+     * The number of deleted rows
      */
     rows: number;
 };
 /**
  * An error message from a failing transaction operation
+ *
+ * @x-go-type xata.ErrTxOp
  */
 declare type TransactionError = {
     /**
@@ -1881,18 +1892,18 @@ declare type SearchResponse = {
     warning?: string;
 };
 /**
- * @x-go-type TxResponse
+ * @x-go-type TxSuccess
  */
-declare type TransactionSucceeded = {
+declare type TransactionSuccess = {
     /**
      * An ordered array of results from the submitted operations that were executed
      */
     results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
 };
 /**
- * @x-go-type TxResponse
+ * @x-go-type TxFailure
  */
-declare type TransactionFailed = {
+declare type TransactionFailure = {
     /**
      * An array of errors from the submitted operations.
      */
@@ -2569,7 +2580,7 @@ declare type BranchTransactionPathParams = {
 };
 declare type BranchTransactionError = ErrorWrapper<{
     status: 400;
-    payload: TransactionFailed;
+    payload: TransactionFailure;
 } | {
     status: 401;
     payload: AuthError;
@@ -2584,7 +2595,7 @@ declare type BranchTransactionVariables = {
     body: BranchTransactionRequestBody;
     pathParams: BranchTransactionPathParams;
 } & DataPlaneFetcherExtraProps;
-declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSucceeded>;
+declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
 declare type QueryMigrationRequestsPathParams = {
     /**
      * The Database Name
@@ -4268,20 +4279,25 @@ declare type QueryTableVariables = {
  *
  * #### Working with arrays
  *
- * To test that an array contains a value, use `$includes`.
+ * To test that an array contains a value, use `$includesAny`.
  *
  * ```json
  * {
  *   "filter": {
  *     "<array_name>": {
- *       "$includes": "value"
+ *       "$includesAny": "value"
  *     }
  *   }
  * }
  * ```
  *
- * The `$includes` operator accepts a custom predicate that will check if any
- * array values matches the predicate. For example a complex predicate can include
+ * ##### `includesAny`
+ *
+ * The `$includesAny` operator accepts a custom predicate that will check if
+ * any value in the array column matches the predicate. The `$includes` operator is a
+ * synonym for the `$includesAny` operator.
+ *
+ * For example a complex predicate can include
  * the `$all` , `$contains` and `$endsWith` operators:
  *
  * ```json
@@ -4299,11 +4315,26 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- * The `$includes` all operator succeeds if any column in the array matches the
- * predicate. The `$includesAll` operator succeeds if all array items match the
- * predicate. The `$includesNone` operator succeeds if no array item matches the
- * predicate. The `$includes` operator is a synonym for the `$includesAny`
- * operator.
+ * ##### `includesNone`
+ *
+ * The `$includesNone` operator succeeds if no array item matches the
+ * predicate.
+ *
+ * ```json
+ * {
+ *   "filter": {
+ *     "settings.labels": {
+ *       "$includesNone": [{ "$contains": "label" }]
+ *     }
+ *   }
+ * }
+ * ```
+ * The above matches if none of the array values contain the string "label".
+ *
+ * ##### `includesAll`
+ *
+ * The `$includesAll` operator succeeds if all array items match the
+ * predicate.
  *
  * Here is an example of using the `$includesAll` operator:
  *
@@ -4317,7 +4348,7 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- * The above matches if all label values contain the string "labels".
+ * The above matches if all array values contain the string "label".
  *
  * ### Sorting
  *
@@ -4733,7 +4764,7 @@ declare const operationsByTag: {
         resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
     };
     records: {
-        branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSucceeded>;
+        branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
         insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
         getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
         insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
@@ -4855,8 +4886,8 @@ type responses_SchemaUpdateResponse = SchemaUpdateResponse;
 type responses_SummarizeResponse = SummarizeResponse;
 type responses_AggResponse = AggResponse;
 type responses_SearchResponse = SearchResponse;
-type responses_TransactionSucceeded = TransactionSucceeded;
-type responses_TransactionFailed = TransactionFailed;
+type responses_TransactionSuccess = TransactionSuccess;
+type responses_TransactionFailure = TransactionFailure;
 declare namespace responses {
   export {
     responses_AuthError as AuthError,
@@ -4873,8 +4904,8 @@ declare namespace responses {
     responses_SummarizeResponse as SummarizeResponse,
     responses_AggResponse as AggResponse,
     responses_SearchResponse as SearchResponse,
-    responses_TransactionSucceeded as TransactionSucceeded,
-    responses_TransactionFailed as TransactionFailed,
+    responses_TransactionSuccess as TransactionSuccess,
+    responses_TransactionFailure as TransactionFailure,
   };
 }
 
@@ -4953,9 +4984,9 @@ type schemas_RecordID = RecordID;
 type schemas_TableRename = TableRename;
 type schemas_RecordsMetadata = RecordsMetadata;
 type schemas_TransactionOperation = TransactionOperation;
-type schemas_TransactionInsert = TransactionInsert;
-type schemas_TransactionUpdate = TransactionUpdate;
-type schemas_TransactionDelete = TransactionDelete;
+type schemas_TransactionInsertOp = TransactionInsertOp;
+type schemas_TransactionUpdateOp = TransactionUpdateOp;
+type schemas_TransactionDeleteOp = TransactionDeleteOp;
 type schemas_TransactionResultInsert = TransactionResultInsert;
 type schemas_TransactionResultUpdate = TransactionResultUpdate;
 type schemas_TransactionResultDelete = TransactionResultDelete;
@@ -5058,9 +5089,9 @@ declare namespace schemas {
     schemas_RecordsMetadata as RecordsMetadata,
     AggResponse$1 as AggResponse,
     schemas_TransactionOperation as TransactionOperation,
-    schemas_TransactionInsert as TransactionInsert,
-    schemas_TransactionUpdate as TransactionUpdate,
-    schemas_TransactionDelete as TransactionDelete,
+    schemas_TransactionInsertOp as TransactionInsertOp,
+    schemas_TransactionUpdateOp as TransactionUpdateOp,
+    schemas_TransactionDeleteOp as TransactionDeleteOp,
     schemas_TransactionResultInsert as TransactionResultInsert,
     schemas_TransactionResultUpdate as TransactionResultUpdate,
     schemas_TransactionResultDelete as TransactionResultDelete,
@@ -5411,6 +5442,13 @@ declare class RecordsApi {
         records: Record<string, any>[];
         columns?: ColumnsProjection;
     }): Promise<BulkInsertResponse>;
+    branchTransaction({ workspace, region, database, branch, operations }: {
+        workspace: WorkspaceID;
+        region: string;
+        database: DBName;
+        branch: BranchName;
+        operations: TransactionOperation[];
+    }): Promise<TransactionSuccess>;
 }
 declare class SearchAndFilterApi {
     private extraProps;