@xata.io/client 0.23.3 → 0.23.4

package/dist/index.d.ts

@@ -1293,7 +1293,7 @@ type FilterColumnIncludes = {
     $includesNone?: FilterPredicate;
 };
 type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
-type SortOrder = 'asc' | 'desc';
+type SortOrder = 'asc' | 'desc' | 'random';
 type SortExpression = string[] | {
     [key: string]: SortOrder;
 } | {
@@ -4611,6 +4611,37 @@ type QueryTableVariables = {
  * }
  * ```
  *
+ * It is also possible to sort results randomly:
+ *
+ * ```json
+ * POST /db/demo:main/tables/table/query
+ * {
+ *   "sort": {
+ *     "*": "random"
+ *   }
+ * }
+ * ```
+ *
+ * Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
+ *
+ * A random sort can be combined with an ascending or descending sort on a specific column:
+ *
+ * ```json
+ * POST /db/demo:main/tables/table/query
+ * {
+ *   "sort": [
+ *     {
+ *       "name": "desc"
+ *     },
+ *     {
+ *       "*": "random"
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * This will sort on the `name` column, breaking ties randomly.
+ *
  * ### Pagination
  *
  * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
@@ -6794,11 +6825,18 @@ type AskResult = {
 };
 
 type SortDirection = 'asc' | 'desc';
-type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
+type RandomFilter = {
+    '*': 'random';
+};
+type RandomFilterExtended = {
+    column: '*';
+    direction: 'random';
+};
+type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = RandomFilterExtended | {
     column: Columns;
     direction?: SortDirection;
 };
-type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
+type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
 type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
     [Key in Columns]: {
         [K in Key]: SortDirection;
@@ -6930,7 +6968,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @param direction The direction. Either ascending or descending.
      * @returns A new Query object.
      */
-    sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
+    sort<F extends ColumnsByValue<Record, any>>(column: F, direction: SortDirection): Query<Record, Result>;
+    sort(column: '*', direction: 'random'): Query<Record, Result>;
+    sort<F extends ColumnsByValue<Record, any>>(column: F): Query<Record, Result>;
     /**
      * Builds a new query specifying the set of columns to be returned in the query response.
      * @param columns Array of column names to be returned by the query.
@@ -6956,7 +6996,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @param options Pagination options
      * @returns A page of results
      */
-    getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
+    getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
     /**
      * Get results in an iterator
      *
@@ -6987,7 +7027,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      */
     getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
-    }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
+    }>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
     /**
      * Performs the query in the database and returns a set of results.
      * @returns An array of records from the database.
@@ -6998,7 +7038,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
-    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
+    getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
     /**
      * Performs the query in the database and returns a set of results.
      * @param options Additional options to be used when performing the query.
@@ -7019,7 +7059,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      */
     getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
-    }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
+    }>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
     /**
      * Performs the query in the database and returns all the results.
      * Warning: If there are a large number of results, this method can have performance implications.
@@ -7039,7 +7079,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @param options Additional options to be used when performing the query.
      * @returns The first record that matches the query, or null if no record matched the query.
      */
-    getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
+    getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
     /**
      * Performs the query in the database and returns the first result.
      * @param options Additional options to be used when performing the query.
@@ -7058,7 +7098,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns The first record that matches the query, or null if no record matched the query.
      * @throws if there are no results.
      */
-    getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
+    getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
     /**
      * Performs the query in the database and returns the first result.
      * @param options Additional options to be used when performing the query.

package/dist/index.mjs

@@ -490,7 +490,7 @@ function defaultOnOpen(response) {
   }
 }
 
-const VERSION = "0.23.3";
+const VERSION = "0.23.4";
 
 class ErrorWithCause extends Error {
   constructor(message, options) {
@@ -2609,7 +2609,11 @@ function isSortFilterString(value) {
   return isString(value);
 }
 function isSortFilterBase(filter) {
-  return isObject(filter) && Object.values(filter).every((value) => value === "asc" || value === "desc");
+  return isObject(filter) && Object.entries(filter).every(([key, value]) => {
+    if (key === "*")
+      return value === "random";
+    return value === "asc" || value === "desc";
+  });
 }
 function isSortFilterObject(filter) {
   return isObject(filter) && !isSortFilterBase(filter) && filter.column !== void 0;