@sanity/sdk-react 0.0.0-alpha.20 → 0.0.0-alpha.21

package/src/hooks/{infiniteList/useInfiniteList.ts → documents/useDocuments.ts}

@@ -11,18 +11,18 @@ const DEFAULT_PERSPECTIVE = 'drafts'
  * Result structure returned from the infinite list query
  * @internal
  */
-interface InfiniteListQueryResult {
+interface UseDocumentsQueryResult {
   count: number
   data: DocumentHandle[]
 }
 
 /**
- * Configuration options for the useInfiniteList hook
+ * Configuration options for the useDocuments hook
  *
  * @beta
  * @category Types
  */
-export interface InfiniteListOptions extends QueryOptions {
+export interface DocumentsOptions extends QueryOptions {
   /**
    * GROQ filter expression to apply to the query
    */
@@ -42,12 +42,12 @@ export interface InfiniteListOptions extends QueryOptions {
 }
 
 /**
- * Return value from the useInfiniteList hook
+ * Return value from the useDocuments hook
  *
  * @beta
  * @category Types
  */
-export interface InfiniteList {
+export interface DocumentsResponse {
   /**
    * Array of document handles for the current batch
    */
@@ -78,10 +78,10 @@ export interface InfiniteList {
  * @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
+ * @returns An object containing the list of document handles, the loading state, the total count of retrieved document handles, and a function to load more
  * @example
  * ```tsx
- * const {data, hasMore, isPending, loadMore} = useInfiniteList({
+ * const {data, hasMore, isPending, loadMore} = useDocuments({
  *   filter: '_type == "post"',
  *   search: searchTerm,
  *   batchSize: 10,
@@ -104,14 +104,14 @@ export interface InfiniteList {
  * ```
  *
  */
-export function useInfiniteList({
+export function useDocuments({
   batchSize = DEFAULT_BATCH_SIZE,
   params,
   search,
   filter,
   orderings,
   ...options
-}: InfiniteListOptions): InfiniteList {
+}: DocumentsOptions): DocumentsResponse {
   const perspective = options.perspective ?? DEFAULT_PERSPECTIVE
   const [limit, setLimit] = useState(batchSize)
 
@@ -155,7 +155,7 @@ export function useInfiniteList({
   const {
     data: {count, data},
     isPending,
-  } = useQuery<InfiniteListQueryResult>(`{"count":${countQuery},"data":${dataQuery}}`, {
+  } = useQuery<UseDocumentsQueryResult>(`{"count":${countQuery},"data":${dataQuery}}`, {
     ...options,
     params,
     perspective,

package/src/hooks/{paginatedList/usePaginatedList.test.tsx → paginatedDocuments/usePaginatedDocuments.test.tsx}

@@ -3,11 +3,11 @@ import {describe, vi} from 'vitest'
 
 import {evaluateSync, parse} from '../_synchronous-groq-js.mjs'
 import {useQuery} from '../query/useQuery'
-import {usePaginatedList} from './usePaginatedList'
+import {usePaginatedDocuments} from './usePaginatedDocuments'
 
 vi.mock('../query/useQuery')
 
-describe('usePaginatedList', () => {
+describe('usePaginatedDocuments', () => {
   beforeEach(() => {
     const dataset = [
       {
@@ -76,14 +76,14 @@ describe('usePaginatedList', () => {
 
   it('should respect custom page size', () => {
     const customPageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize: customPageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize: customPageSize}))
 
     expect(result.current.pageSize).toBe(customPageSize)
     expect(result.current.data.length).toBeLessThanOrEqual(customPageSize)
   })
 
   it('should filter by document type', () => {
-    const {result} = renderHook(() => usePaginatedList({filter: '_type == "movie"'}))
+    const {result} = renderHook(() => usePaginatedDocuments({filter: '_type == "movie"'}))
 
     expect(result.current.data.every((doc) => doc._type === 'movie')).toBe(true)
     expect(result.current.count).toBe(5) // 5 movies in the dataset
@@ -91,7 +91,7 @@ describe('usePaginatedList', () => {
 
   // groq-js doesn't support search filters yet
   it.skip('should apply search filter', () => {
-    const {result} = renderHook(() => usePaginatedList({search: 'inter'}))
+    const {result} = renderHook(() => usePaginatedDocuments({search: 'inter'}))
 
     // Should match "Interstellar"
     expect(result.current.data.some((doc) => doc._id === 'movie3')).toBe(true)
@@ -99,7 +99,7 @@ describe('usePaginatedList', () => {
 
   it('should apply ordering', () => {
     const {result} = renderHook(() =>
-      usePaginatedList({
+      usePaginatedDocuments({
         filter: '_type == "movie"',
         orderings: [{field: 'releaseYear', direction: 'desc'}],
       }),
@@ -111,7 +111,7 @@ describe('usePaginatedList', () => {
 
   it('should calculate pagination values correctly', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     expect(result.current.currentPage).toBe(1)
     expect(result.current.totalPages).toBe(3) // 6 items with page size 2
@@ -122,7 +122,7 @@ describe('usePaginatedList', () => {
 
   it('should navigate to next page', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     expect(result.current.currentPage).toBe(1)
     expect(result.current.data.length).toBe(pageSize)
@@ -138,7 +138,7 @@ describe('usePaginatedList', () => {
 
   it('should navigate to previous page', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     // Go to page 2 first
     act(() => {
@@ -158,7 +158,7 @@ describe('usePaginatedList', () => {
 
   it('should navigate to first page', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     // Go to last page first
     act(() => {
@@ -178,7 +178,7 @@ describe('usePaginatedList', () => {
 
   it('should navigate to last page', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     act(() => {
       result.current.lastPage()
@@ -190,7 +190,7 @@ describe('usePaginatedList', () => {
 
   it('should navigate to specific page', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
 
     act(() => {
       result.current.goToPage(2) // Go to page 2
@@ -215,7 +215,7 @@ describe('usePaginatedList', () => {
 
   it('should set page availability flags correctly', () => {
     const pageSize = 2
-    const {result} = renderHook(() => usePaginatedList({pageSize}))
+    const {result} = renderHook(() => usePaginatedDocuments({pageSize}))
     // On first page
     expect(result.current.hasFirstPage).toBe(false)
     expect(result.current.hasPreviousPage).toBe(false)
@@ -241,7 +241,7 @@ describe('usePaginatedList', () => {
 
   // New test case for resetting the current page when filter changes
   it('should reset current page when filter changes', () => {
-    const {result, rerender} = renderHook((props) => usePaginatedList(props), {
+    const {result, rerender} = renderHook((props) => usePaginatedDocuments(props), {
       initialProps: {pageSize: 2, filter: ''},
     })
     // Initially, current page should be 1

package/src/hooks/{paginatedList/usePaginatedList.ts → paginatedDocuments/usePaginatedDocuments.ts}

@@ -7,12 +7,12 @@ import {useQuery} from '../query/useQuery'
 const DEFAULT_PERSPECTIVE = 'drafts'
 
 /**
- * Configuration options for the usePaginatedList hook
+ * Configuration options for the usePaginatedDocuments hook
  *
  * @beta
  * @category Types
  */
-export interface PaginatedListOptions extends QueryOptions {
+export interface PaginatedDocumentsOptions extends QueryOptions {
   /**
    * GROQ filter expression to apply to the query
    */
@@ -32,12 +32,12 @@ export interface PaginatedListOptions extends QueryOptions {
 }
 
 /**
- * Return value from the usePaginatedList hook
+ * Return value from the usePaginatedDocuments hook
  *
  * @beta
  * @category Types
  */
-export interface PaginatedList {
+export interface PaginatedDocumentsResponse {
   /**
    * Array of document handles for the current page
    */
@@ -136,7 +136,7 @@ export interface PaginatedList {
  *   previousPage,
  *   hasNextPage,
  *   hasPreviousPage
- * } = usePaginatedList({
+ * } = usePaginatedDocuments({
  *   filter: '_type == "post"',
  *   search: searchTerm,
  *   pageSize: 10,
@@ -160,14 +160,14 @@ export interface PaginatedList {
  * ```
  *
  */
-export function usePaginatedList({
+export function usePaginatedDocuments({
   filter = '',
   pageSize = 25,
   params = {},
   orderings,
   search,
   ...options
-}: PaginatedListOptions = {}): PaginatedList {
+}: PaginatedDocumentsOptions = {}): PaginatedDocumentsResponse {
   const [pageIndex, setPageIndex] = useState(0)
   const key = JSON.stringify({filter, search, params, orderings, pageSize})
   // Reset the pageIndex to 0 whenever any query parameters (filter, search,

package/src/hooks/preview/usePreview.tsx

@@ -51,12 +51,12 @@ export interface UsePreviewResults {
  * }
  *
  * // DocumentList.jsx
- * const { data, isPending } = useDocuments({ filter: '_type == "movie"' })
+ * const { data } = useDocuments({ filter: '_type == "movie"' })
  * return (
  *   <div>
  *     <h1>Movies</h1>
  *     <ul>
- *       {isPending ? 'Loading…' : data.map(movie => (
+ *       {data.map(movie => (
  *         <li key={movie._id}>
  *           <Suspense fallback='Loading…'>
  *             <PreviewComponent document={movie} />

package/src/hooks/projection/useProjection.ts

@@ -65,10 +65,10 @@ export interface UseProjectionResults<TResult extends object> {
  * }
  * ```
  *
- * @example Combining with useInfiniteList to render a collection with specific fields
+ * @example Combining with useDocuments to render a collection with specific fields
  * ```
  * // DocumentList.jsx
- * const { data } = useInfiniteList({ filter: '_type == "article"' })
+ * const { data } = useDocuments({ filter: '_type == "article"' })
  * return (
  *   <div>
  *     <h1>Books</h1>

package/src/hooks/projects/useProject.ts

@@ -32,7 +32,10 @@ type UseProject = {
   (projectId: string): SanityProject
 }
 
-/** @public */
+/**
+ * @public
+ * @function
+ */
 export const useProject: UseProject = createStateSourceHook({
   // remove `undefined` since we're suspending when that is the case
   getState: getProjectState as (

package/src/hooks/projects/useProjects.ts

@@ -6,16 +6,17 @@ import {createStateSourceHook} from '../helpers/createStateSourceHook'
 /**
  * @public
  * @category Types
+ * @interface
  */
 export type ProjectWithoutMembers = Omit<SanityProject, 'members'>
 
 type UseProjects = {
   /**
    *
-   * Returns metadata for each project in your organization.
+   * Returns metadata for each project you have access to.
    *
    * @category Projects
-   * @returns An array of metadata (minus the projects’ members) for each project in your organization
+   * @returns An array of metadata (minus the projects’ members) for each project
    * @example
    * ```tsx
    * const projects = useProjects()
@@ -32,7 +33,10 @@ type UseProjects = {
   (): ProjectWithoutMembers[]
 }
 
-/** @public */
+/**
+ * @public
+ * @function
+ */
 export const useProjects: UseProjects = createStateSourceHook({
   // remove `undefined` since we're suspending when that is the case
   getState: getProjectsState as (instance: SanityInstance) => StateSource<ProjectWithoutMembers[]>,

package/src/hooks/auth/useHandleCallback.test.tsx

@@ -1,16 +0,0 @@
-import {handleCallback} from '@sanity/sdk'
-import {identity} from 'rxjs'
-import {describe, it} from 'vitest'
-
-import {createCallbackHook} from '../helpers/createCallbackHook'
-
-vi.mock('../helpers/createCallbackHook', () => ({createCallbackHook: vi.fn(identity)}))
-vi.mock('@sanity/sdk', () => ({handleCallback: vi.fn()}))
-
-describe('useHandleCallback', () => {
-  it('calls `createCallbackHook` with `handleCallback`', async () => {
-    const {useHandleCallback} = await import('./useHandleCallback')
-    expect(createCallbackHook).toHaveBeenCalledWith(handleCallback)
-    expect(useHandleCallback).toBe(handleCallback)
-  })
-})

package/src/hooks/document/useApplyActions.test.ts

@@ -1,25 +0,0 @@
-import {applyActions, createDocument, type ResourceId} from '@sanity/sdk'
-import {describe, it} from 'vitest'
-
-import {createCallbackHook} from '../helpers/createCallbackHook'
-
-vi.mock('../helpers/createCallbackHook', () => ({
-  createCallbackHook: vi.fn((cb) => () => cb),
-}))
-vi.mock('@sanity/sdk', async (importOriginal) => {
-  const original = await importOriginal<typeof import('@sanity/sdk')>()
-  return {...original, applyActions: vi.fn()}
-})
-
-describe('useApplyActions', () => {
-  it('calls `createCallbackHook` with `applyActions`', async () => {
-    const {useApplyActions} = await import('./useApplyActions')
-    const resourceId: ResourceId = 'project1.dataset1'
-    expect(createCallbackHook).not.toHaveBeenCalled()
-
-    expect(applyActions).not.toHaveBeenCalled()
-    const apply = useApplyActions(resourceId)
-    apply(createDocument({_type: 'author'}))
-    expect(applyActions).toHaveBeenCalledWith(createDocument({_type: 'author'}))
-  })
-})