@sanity/sdk-react 0.0.0-alpha.15 → 0.0.0-alpha.17

package/dist/hooks.d.ts

@@ -7,18 +7,21 @@ import {CurrentUser} from '@sanity/sdk'
 import {DocumentAction} from '@sanity/sdk'
 import {DocumentEvent} from '@sanity/sdk'
 import {DocumentHandle} from '@sanity/sdk'
-import {DocumentListOptions} from '@sanity/sdk'
 import {FrameMessage} from '@sanity/sdk'
 import {JsonMatch} from '@sanity/sdk'
 import {JsonMatchPath} from '@sanity/sdk'
 import {Observable} from 'rxjs'
 import {PermissionsResult} from '@sanity/sdk'
 import {PreviewValue} from '@sanity/sdk'
+import {QueryOptions} from '@sanity/sdk'
 import {Requester} from 'get-it'
+import {ResourceId} from '@sanity/sdk'
 import {ResourceType} from '@sanity/sdk'
 import {SanityDocument} from '@sanity/types'
 import {SanityInstance} from '@sanity/sdk'
+import {SanityProject as SanityProject_2} from '@sanity/sdk'
 import {SanityUser as SanityUser_2} from '@sanity/sdk'
+import {SortOrderingItem} from '@sanity/types'
 import {ValidProjection} from '@sanity/sdk'
 import {WindowMessage} from '@sanity/sdk'
 
@@ -306,14 +309,14 @@ declare interface ClientConfig {
   /**
    * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
    * @remarks
-   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
   apiHost?: string
   /**
      @remarks
-     * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+     * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
      */
   apiVersion?: string
   proxy?: string
@@ -582,7 +585,7 @@ declare class DatasetsClient {
 }
 
 /** @public */
-declare type DatasetsResponse = {
+export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
   createdAt: string
@@ -655,24 +658,6 @@ declare type DisconnectEvent = {
 
 export {DocumentHandle}
 
-/**
- * @public
- * A live collection of {@link DocumentHandle}s, along with metadata about the collection and a function for loading more of them.
- * @category Types
- */
-export declare interface DocumentHandleCollection {
-  /** Retrieve more documents matching the provided options */
-  loadMore: () => void
-  /** The retrieved document handles of the documents matching the provided options */
-  results: DocumentHandle[]
-  /** Whether a retrieval of documents is in flight */
-  isPending: boolean
-  /** Whether more documents exist that match the provided options than have been retrieved */
-  hasMore: boolean
-  /** The total number of documents in the collection */
-  count: number
-}
-
 /**
  * Modifies an existing draft document.
  * It applies the given patch to the document referenced by draftId.
@@ -803,6 +788,60 @@ declare type IdentifiedSanityDocumentStub<T extends Record<string, Any> = Record
   _id: string
 } & SanityDocumentStub
 
+/**
+ * Return value from the useInfiniteList hook
+ *
+ * @beta
+ * @category Types
+ */
+export declare interface InfiniteList {
+  /**
+   * Array of document handles for the current batch
+   */
+  data: DocumentHandle[]
+  /**
+   * Whether there are more items available to load
+   */
+  hasMore: boolean
+  /**
+   * Total count of items matching the query
+   */
+  count: number
+  /**
+   * Whether a query is currently in progress
+   */
+  isPending: boolean
+  /**
+   * Function to load the next batch of results
+   */
+  loadMore: () => void
+}
+
+/**
+ * Configuration options for the useInfiniteList hook
+ *
+ * @beta
+ * @category Types
+ */
+export declare interface InfiniteListOptions extends QueryOptions {
+  /**
+   * GROQ filter expression to apply to the query
+   */
+  filter?: string
+  /**
+   * Number of items to load per batch (defaults to 25)
+   */
+  batchSize?: number
+  /**
+   * Sorting configuration for the results
+   */
+  orderings?: SortOrderingItem[]
+  /**
+   * Text search query to filter results
+   */
+  search?: string
+}
+
 /** @public */
 declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
@@ -917,7 +956,7 @@ declare interface ListenOptions {
   includePreviousRevision?: boolean
   /**
    * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
-   * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
+   * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
    * If you need events from drafts and versions, set this to `true`.
    * Note: Keep in mind that additional document variants may be introduced in the future, so it's
    * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -1928,6 +1967,109 @@ declare type OpenEvent = {
   type: 'open'
 }
 
+/**
+ * Return value from the usePaginatedList hook
+ *
+ * @beta
+ * @category Types
+ */
+export declare interface PaginatedList {
+  /**
+   * Array of document handles for the current page
+   */
+  data: DocumentHandle[]
+  /**
+   * Whether a query is currently in progress
+   */
+  isPending: boolean
+  /**
+   * Number of items displayed per page
+   */
+  pageSize: number
+  /**
+   * Current page number (1-indexed)
+   */
+  currentPage: number
+  /**
+   * Total number of pages available
+   */
+  totalPages: number
+  /**
+   * Starting index of the current page (0-indexed)
+   */
+  startIndex: number
+  /**
+   * Ending index of the current page (exclusive, 0-indexed)
+   */
+  endIndex: number
+  /**
+   * Total count of items matching the query
+   */
+  count: number
+  /**
+   * Navigate to the first page
+   */
+  firstPage: () => void
+  /**
+   * Whether there is a first page available to navigate to
+   */
+  hasFirstPage: boolean
+  /**
+   * Navigate to the previous page
+   */
+  previousPage: () => void
+  /**
+   * Whether there is a previous page available to navigate to
+   */
+  hasPreviousPage: boolean
+  /**
+   * Navigate to the next page
+   */
+  nextPage: () => void
+  /**
+   * Whether there is a next page available to navigate to
+   */
+  hasNextPage: boolean
+  /**
+   * Navigate to the last page
+   */
+  lastPage: () => void
+  /**
+   * Whether there is a last page available to navigate to
+   */
+  hasLastPage: boolean
+  /**
+   * Navigate to a specific page number
+   * @param pageNumber - The page number to navigate to (1-indexed)
+   */
+  goToPage: (pageNumber: number) => void
+}
+
+/**
+ * Configuration options for the usePaginatedList hook
+ *
+ * @beta
+ * @category Types
+ */
+export declare interface PaginatedListOptions extends QueryOptions {
+  /**
+   * GROQ filter expression to apply to the query
+   */
+  filter?: string
+  /**
+   * Number of items to display per page (defaults to 25)
+   */
+  pageSize?: number
+  /**
+   * Sorting configuration for the results
+   */
+  orderings?: SortOrderingItem[]
+  /**
+   * Text search query to filter results
+   */
+  search?: string
+}
+
 /** @public */
 declare class Patch extends BasePatch {
   #private
@@ -2035,6 +2177,12 @@ declare class ProjectsClient {
   getById(projectId: string): Promise<SanityProject>
 }
 
+/**
+ * @public
+ * @category Types
+ */
+export declare type ProjectWithoutMembers = Omit<SanityProject, 'members'>
+
 /**
  * Publishes a draft document.
  * If a published version of the document already exists this is replaced by the current draft document.
@@ -2824,7 +2972,7 @@ declare interface SanityImagePalette {
 }
 
 /** @public */
-declare interface SanityProject {
+export declare interface SanityProject {
   id: string
   displayName: string
   /**
@@ -2852,7 +3000,7 @@ declare interface SanityProject {
 }
 
 /** @public */
-declare interface SanityProjectMember {
+export declare interface SanityProjectMember {
   id: string
   role: string
   isRobot: boolean
@@ -2876,10 +3024,6 @@ declare interface SanityUser {
   isCurrentUser: boolean
 }
 
-declare interface SearchOptions extends DocumentListOptions {
-  query?: string
-}
-
 /** @internal */
 declare interface SingleActionResult {
   transactionId: string
@@ -2895,6 +3039,8 @@ declare interface SingleMutationResult {
   }[]
 }
 
+export {SortOrderingItem}
+
 /** @public */
 declare type StackablePerspective = ('published' | 'drafts' | string) & {}
 
@@ -3156,6 +3302,7 @@ declare interface UploadClientConfig {
  * Provides a callback for applying one or more actions to a document.
  *
  * @category Documents
+ * @param resourceId - The resource ID of the document to apply actions to. If not provided, the document will use the default resource.
  * @returns A function that takes one more more {@link DocumentAction}s and returns a promise that resolves to an {@link ActionsResult}.
  * @example Publish or unpublish a document
  * ```
@@ -3193,7 +3340,9 @@ declare interface UploadClientConfig {
  * )
  * ```
  */
-export declare function useApplyActions(): <TDocument extends SanityDocument>(
+export declare function useApplyActions(
+  resourceId?: ResourceId,
+): <TDocument extends SanityDocument>(
   action: DocumentAction<TDocument> | DocumentAction<TDocument>[],
   options?: ApplyActionsOptions,
 ) => Promise<ActionsResult<TDocument>>
@@ -3254,7 +3403,7 @@ export declare const useAuthToken: () => string | null
  *
  * @public
  */
-export declare const useClient: (options: ClientOptions) => SanityClient
+export declare const useClient: (e: ClientOptions) => SanityClient
 
 declare type UseCurrentUser = {
   /**
@@ -3286,8 +3435,33 @@ declare type UseCurrentUser = {
  */
 export declare const useCurrentUser: UseCurrentUser
 
+declare type UseDatasets = {
+  /**
+   *
+   * Returns metadata for each dataset in your organization.
+   *
+   * @category Datasets
+   * @returns The metadata for your organization's datasets
+   *
+   * @example
+   * ```tsx
+   * const datasets = useDatasets()
+   *
+   * return (
+   *   <select>
+   *     {datasets.map((dataset) => (
+   *       <option key={dataset.name}>{dataset.name}</option>
+   *     ))}
+   *   </select>
+   * )
+   * ```
+   *
+   */
+  (): DatasetsResponse
+}
+
 /** @public */
-export declare const useDatasets: () => DatasetsResponse
+export declare const useDatasets: UseDatasets
 
 /**
  * @beta
@@ -3295,7 +3469,8 @@ export declare const useDatasets: () => DatasetsResponse
  * ## useDocument(doc, path)
  * Read and subscribe to nested values in a document
  * @category Documents
- * @param doc - The document to read state from
+ * @param doc - The document to read state from. If you pass a `DocumentHandle` with a `resourceId` in the DocumentResourceId format (`document:projectId.dataset:documentId`)
+ * the document will be read from the specified Sanity project and dataset that is included in the handle. If no `resourceId` is provided, the default project and dataset from your `SanityApp` configuration will be used.
  * @param path - The path to the nested value to read from
  * @returns The value at the specified path
  * @example
@@ -3366,6 +3541,8 @@ export declare function useDocument<TDocument extends SanityDocument>(
  *
  * @category Documents
  * @param handler - The event handler to register.
+ * @param doc - The document to subscribe to events for. If you pass a `DocumentHandle` with a `resourceId` (in the format of `document:projectId.dataset:documentId`)
+ * the document will be read from the specified Sanity project and dataset that is included in the handle. If no `resourceId` is provided, the default project and dataset from your `SanityApp` configuration will be used.
  * @example
  * ```
  * import {useDocumentEvent} from '@sanity/sdk-react'
@@ -3385,71 +3562,13 @@ export declare function useDocumentEvent(
   doc: DocumentHandle,
 ): void
 
-/**
- * @public
- *
- * Retrieves and provides access to a live collection of {@link DocumentHandle}s, with an optional filter and sort applied.
- * The returned document handles are canonical — that is, they refer to the document in its current state, whether draft, published, or within a release or perspective.
- * Because the returned document handle collection is live, the results will update in real time until the component invoking the hook is unmounted.
- *
- * @remarks
- * {@link DocumentHandle}s are used by many other hooks (such as {@link usePreview}, {@link useDocument}, and {@link useEditDocument})
- * to work with documents in various ways without the entire document needing to be fetched upfront.
- *
- * @category Documents
- * @param options - Options for narrowing and sorting the document collection
- * @returns The collection of document handles matching the provided options (if any), as well as properties describing the collection and a function to load more.
- *
- * @example Retrieving document handles for all documents of type 'movie'
- * ```
- * const { results, isPending } = useDocuments({ filter: '_type == "movie"' })
- *
- * return (
- *   <div>
- *     <h1>Movies</h1>
- *     {results && (
- *       <ul>
- *         {results.map(movie => (<li key={movie._id}>…</li>))}
- *       </ul>
- *     )}
- *     {isPending && <div>Loading movies…</div>}
- *   </div>
- * )
- * ```
- *
- * @example Retrieving document handles for all movies released since 1980, sorted by director’s last name
- * ```
- * const { results } = useDocuments({
- *   filter: '_type == "movie" && releaseDate >= "1980-01-01"',
- *   sort: [
- *     {
- *       // Expand the `director` reference field with the dereferencing operator `->`
- *       field: 'director->lastName',
- *       sort: 'asc',
- *     },
- *   ],
- * })
- *
- * return (
- *   <div>
- *      <h1>Movies released since 1980</h1>
- *      {results && (
- *        <ol>
- *          {results.map(movie => (<li key={movie._id}>…</li>))}
- *        </ol>
- *     )}
- *   </div>
- * )
- * ```
- */
-export declare function useDocuments(options?: DocumentListOptions): DocumentHandleCollection
-
 declare type UseDocumentSyncStatus = {
   /**
    * Exposes the document’s sync status between local and remote document states.
    *
    * @category Documents
-   * @param doc - The document handle to get sync status for
+   * @param doc - The document handle to get sync status for. If you pass a `DocumentHandle` with a `resourceId` (in the format of `document:projectId.dataset:documentId`)
+   * the document will be read from the specified Sanity project and dataset that is included in the handle. If no `resourceId` is provided, the default project and dataset from your `SanityApp` configuration will be used.
    * @returns `true` if local changes are synced with remote, `false` if the changes are not synced, and `undefined` if the document is not found
    * @example Disable a Save button when there are no changes to sync
    * ```
@@ -3529,7 +3648,8 @@ export declare function useEditDocument<
  *
  * ## useEditDocument(doc)
  * Edit an entire document
- * @param doc - The document to be edited; either as a document handle or the document’s ID a string
+ * @param doc - The document to be edited; either as a document handle or the document’s ID a string. If you pass a `DocumentHandle` with a `resourceId` (in the format of `document:projectId.dataset:documentId`)
+ * the document will be read from the specified Sanity project and dataset that is included in the handle. If no `resourceId` is provided, the default project and dataset from your `SanityApp` configuration will be used.
  * @returns A function to update the document state. Accepts either a new document state, or an updater function that exposes the previous document state and returns the new document state.
  * @example
  * ```
@@ -3661,6 +3781,49 @@ export declare const useHandleCallback: () => (
   locationHref?: string | undefined,
 ) => Promise<string | false>
 
+/**
+ * Retrieves batches of {@link DocumentHandle}s, narrowed by optional filters, text searches, and custom ordering,
+ * with infinite scrolling support. The number of document handles returned per batch is customizable,
+ * and additional batches can be loaded using the supplied `loadMore` function.
+ *
+ * @beta
+ * @category Documents
+ * @param options - Configuration options for the infinite list
+ * @returns An object containing the list of document handles, the loading state, the total count of retrived document handles, and a function to load more
+ * @example
+ * ```tsx
+ * const {data, hasMore, isPending, loadMore} = useInfiniteList({
+ *   filter: '_type == "post"',
+ *   search: searchTerm,
+ *   batchSize: 10,
+ *   orderings: [{field: '_createdAt', direction: 'desc'}]
+ * })
+ *
+ * return (
+ *   <div>
+ *     Total documents: {count}
+ *     <ol>
+ *       {data.map((doc) => (
+ *         <li key={doc._id}>
+ *           <MyDocumentComponent doc={doc} />
+ *         </li>
+ *       ))}
+ *     </ol>
+ *     {hasMore && <button onClick={loadMore}>Load More</button>}
+ *   </div>
+ * )
+ * ```
+ *
+ */
+export declare function useInfiniteList({
+  batchSize,
+  params,
+  search,
+  filter,
+  orderings,
+  ...options
+}: InfiniteListOptions): InfiniteList
+
 /**
  * @internal
  * A React hook that retrieves the available authentication provider URLs for login.
@@ -3709,6 +3872,59 @@ export declare function useLoginUrls(): AuthProvider[]
  */
 export declare const useLogOut: () => () => Promise<void>
 
+/**
+ * Retrieves pages of {@link DocumentHandle}s, narrowed by optional filters, text searches, and custom ordering,
+ * with support for traditional paginated interfaces. The number of document handles returned per page is customizable,
+ * while page navigation is handled via the included navigation functions.
+ *
+ * @beta
+ * @category Documents
+ * @param options - Configuration options for the paginated list
+ * @returns An object containing the current page of document handles, the loading and pagination state, and navigation functions
+ * @example
+ * ```tsx
+ * const {
+ *   data,
+ *   isPending,
+ *   currentPage,
+ *   totalPages,
+ *   nextPage,
+ *   previousPage,
+ *   hasNextPage,
+ *   hasPreviousPage
+ * } = usePaginatedList({
+ *   filter: '_type == "post"',
+ *   search: searchTerm,
+ *   pageSize: 10,
+ *   orderings: [{field: '_createdAt', direction: 'desc'}]
+ * })
+ *
+ * return (
+ *   <>
+ *     <table>
+ *       {data.map(doc => (
+ *         <MyTableRowComponent key={doc._id} doc={doc} />
+ *       ))}
+ *     </table>
+ *     <>
+ *       {hasPreviousPage && <button onClick={previousPage}>Previous</button>}
+ *       {currentPage} / {totalPages}
+ *       {hasNextPage && <button onClick={nextPage}>Next</button>}
+ *     </>
+ *   </>
+ * )
+ * ```
+ *
+ */
+export declare function usePaginatedList({
+  filter,
+  pageSize,
+  params,
+  orderings,
+  search,
+  ...options
+}?: PaginatedListOptions): PaginatedList
+
 /**
  *
  * @beta
@@ -3820,8 +4036,32 @@ export declare interface UsePreviewResults {
   isPending: boolean
 }
 
+declare type UseProject = {
+  /**
+   *
+   * Returns metadata for a given project
+   *
+   * @category Projects
+   * @param projectId - The ID of the project to retrieve metadata for
+   * @returns The metadata for the project
+   * @example
+   * ```tsx
+   *  function ProjectMetadata({ projectId }: { projectId: string }) {
+   *    const project = useProject(projectId)
+   *
+   *    return (
+   *      <figure style={{ backgroundColor: project.metadata.color || 'lavender'}}>
+   *        <h1>{project.displayName}</h1>
+   *      </figure>
+   *    )
+   *  }
+   * ```
+   */
+  (projectId: string): SanityProject_2
+}
+
 /** @public */
-export declare const useProject: (projectId: string) => SanityProject
+export declare const useProject: UseProject
 
 /**
  * @beta
@@ -3856,15 +4096,15 @@ export declare const useProject: (projectId: string) => SanityProject
  * }
  * ```
  *
- * @example Combining with useDocuments to render a collection with specific fields
+ * @example Combining with useInfiniteList to render a collection with specific fields
  * ```
  * // DocumentList.jsx
- * const { results, isPending } = useDocuments({ filter: '_type == "article"' })
+ * const { data } = useInfiniteList({ filter: '_type == "article"' })
  * return (
  *   <div>
  *     <h1>Articles</h1>
  *     <ul>
- *       {isPending ? 'Loading…' : results.map(article => (
+ *       {data.map(article => (
  *         <li key={article._id}>
  *           <Suspense fallback='Loading…'>
  *             <ProjectionComponent
@@ -3895,8 +4135,83 @@ declare interface UseProjectionResults<TResult extends object> {
   isPending: boolean
 }
 
+declare type UseProjects = {
+  /**
+   *
+   * Returns metadata for each project in your organization.
+   *
+   * @category Projects
+   * @returns An array of metadata (minus the projects’ members) for each project in your organization
+   * @example
+   * ```tsx
+   * const projects = useProjects()
+   *
+   * return (
+   *   <select>
+   *     {projects.map((project) => (
+   *       <option key={project.id}>{project.displayName}</option>
+   *     ))}
+   *   </select>
+   * )
+   * ```
+   */
+  (): ProjectWithoutMembers[]
+}
+
 /** @public */
-export declare const useProjects: () => Omit<SanityProject, 'members'>[]
+export declare const useProjects: UseProjects
+
+/**
+ * Executes GROQ queries against a Sanity dataset.
+ *
+ * This hook provides a convenient way to fetch and subscribe to real-time updates
+ * for your Sanity content. Changes made to the dataset’s content will trigger
+ * automatic updates.
+ *
+ * @remarks
+ * The returned `isPending` flag indicates when a React transition is in progress,
+ * which can be used to show loading states for query changes.
+ *
+ * @beta
+ * @category GROQ
+ * @param query - GROQ query string to execute
+ * @param options - Optional configuration for the query
+ * @returns Object containing the query result and a pending state flag
+ *
+ * @example Basic usage
+ * ```tsx
+ * const {data, isPending} = useQuery<Movie[]>('*[_type == "movie"]')
+ * ```
+ *
+ * @example Using parameters
+ * ```tsx
+ * // With parameters
+ * const {data} = useQuery<Movie>('*[_type == "movie" && _id == $id][0]', {
+ *   params: { id: 'movie-123' }
+ * })
+ * ```
+ *
+ * @example With a loading state for transitions
+ * ```tsx
+ * const {data, isPending} = useQuery<Movie[]>('*[_type == "movie"]')
+ * return (
+ *   <div>
+ *     {isPending && <div>Updating...</div>}
+ *     <ul>
+ *       {data.map(movie => <li key={movie._id}>{movie.title}</li>)}
+ *     </ul>
+ *   </div>
+ * )
+ * ```
+ *
+ */
+export declare function useQuery<T>(
+  query: string,
+  options?: QueryOptions,
+): {
+  data: T
+  isPending: boolean
+}
 
 /** @public */
 declare class UsersClient {
@@ -3919,54 +4234,11 @@ declare class UsersClient {
  * @returns The current Sanity instance
  * @example
  * ```tsx
- * const instance = useSanityInstance('abc123:production')
+ * const instance = useSanityInstance('abc123.production')
  * ```
  */
 export declare const useSanityInstance: (resourceId?: string) => SanityInstance
 
-/**
- * @public
- * Hook for searching documents using full-text search.
- *
- * @param options - The options for the search.
- * @example
- * ```tsx
- * function SearchResults() {
- *   const [query, setQuery] = useState('')
- *   const {results, isPending} = useSearch({
- *     filter: '_type == "book"',
- *     query,
- *     sort: [{field: '_createdAt', direction: 'desc'}]
- *   })
- *
- *   return (
- *     <div>
- *       <input
- *         type="search"
- *         value={query}
- *         onChange={(e) => setQuery(e.target.value)}
- *         placeholder="Search books..."
- *       />
- *       {isPending ? (
- *         <div>Searching...</div>
- *       ) : (
- *         <ul>
- *           {results.map((doc) => (
- *             <li key={doc._id}>{doc._id}</li>
- *           ))}
- *         </ul>
- *       )}
- *     </div>
- *   )
- * }
- * ```
- */
-export declare function useSearch({
-  query,
-  filter: additionalFilter,
-  ...options
-}?: SearchOptions): DocumentHandleCollection
-
 /**
  *
  * @public
@@ -4003,7 +4275,7 @@ export declare function useUsers(params: UseUsersParams): UseUsersResult
 
 /**
  * @public
- * @category Users
+ * @category Types
  */
 export declare interface UseUsersParams {
   /**
@@ -4022,7 +4294,7 @@ export declare interface UseUsersParams {
 
 /**
  * @public
- * @category Users
+ * @category Types
  */
 export declare interface UseUsersResult {
   /**