@sanity/sdk-react 2.1.2 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk-react",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "private": false,
   "description": "Sanity SDK React toolkit for Content OS",
   "keywords": [
@@ -42,7 +42,7 @@
   "browserslist": "extends @sanity/browserslist-config",
   "prettier": "@sanity/prettier-config",
   "dependencies": {
-    "@sanity/client": "^7.2.1",
+    "@sanity/client": "^7.10.0",
     "@sanity/message-protocol": "^0.12.0",
     "@sanity/types": "^3.83.0",
     "@types/lodash-es": "^4.17.12",
@@ -51,7 +51,7 @@
     "react-compiler-runtime": "19.1.0-rc.2",
     "react-error-boundary": "^5.0.0",
     "rxjs": "^7.8.2",
-    "@sanity/sdk": "2.1.2"
+    "@sanity/sdk": "2.2.0"
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.5",
@@ -76,9 +76,9 @@
     "vitest": "^3.1.2",
     "@repo/config-eslint": "0.0.0",
     "@repo/config-test": "0.0.1",
-    "@repo/package.config": "0.0.1",
     "@repo/package.bundle": "3.82.0",
-    "@repo/tsconfig": "0.0.1"
+    "@repo/tsconfig": "0.0.1",
+    "@repo/package.config": "0.0.1"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",

package/src/hooks/context/useSanityInstance.ts

@@ -62,7 +62,7 @@ export const useSanityInstance = (config?: SanityConfig): SanityInstance => {
 
   if (!instance) {
     throw new Error(
-      `SanityInstance context not found. ${config ? `Requested config: ${JSON.stringify(config, null, 2)}. ` : ''}Please ensure that your component is wrapped in a <ResourceProvider> or a <SanityApp>.`,
+      `SanityInstance context not found. ${config ? `Requested config: ${JSON.stringify(config, null, 2)}. ` : ''}Please ensure that your component is wrapped in a ResourceProvider or a SanityApp component.`,
     )
   }
 
@@ -72,7 +72,7 @@ export const useSanityInstance = (config?: SanityConfig): SanityInstance => {
   if (!match) {
     throw new Error(
       `Could not find a matching Sanity instance for the requested configuration: ${JSON.stringify(config, null, 2)}.
-Please ensure there is a <ResourceProvider> with a matching configuration in the component hierarchy.`,
+Please ensure there is a ResourceProvider component with a matching configuration in the component hierarchy.`,
     )
   }
 

package/src/hooks/preview/useDocumentPreview.tsx

@@ -83,7 +83,7 @@ export function useDocumentPreview({
   ref,
   ...docHandle
 }: useDocumentPreviewOptions): useDocumentPreviewResults {
-  const instance = useSanityInstance()
+  const instance = useSanityInstance(docHandle)
   const stateSource = getPreviewState(instance, docHandle)
 
   // Create subscribe function for useSyncExternalStore

package/src/hooks/projection/useDocumentProjection.ts

@@ -181,7 +181,7 @@ export function useDocumentProjection<TData extends object>({
   projection,
   ...docHandle
 }: useDocumentProjectionOptions): useDocumentProjectionResults<TData> {
-  const instance = useSanityInstance()
+  const instance = useSanityInstance(docHandle)
   const stateSource = getProjectionState<TData>(instance, {...docHandle, projection})
 
   if (stateSource.getCurrent()?.data === null) {

package/src/hooks/projects/useProjects.test.ts

@@ -59,12 +59,12 @@ describe('useProjects', () => {
     // Mock instance for the test call
     const mockInstance = {} as SanityInstance // Use specific type
 
-    // Call the shouldSuspend function
-    const result = shouldSuspend(mockInstance)
+    // Call the shouldSuspend function with both required parameters
+    const result = shouldSuspend(mockInstance, undefined) // Pass undefined for options
 
     // Assert that getProjectsState was called with the correct arguments
     const mockGetProjectsState = getProjectsState as ReturnType<typeof vi.fn>
-    expect(mockGetProjectsState).toHaveBeenCalledWith(mockInstance)
+    expect(mockGetProjectsState).toHaveBeenCalledWith(mockInstance, undefined)
 
     // Assert that getCurrent was called on the result of getProjectsState
     expect(mockGetProjectsState.mock.results.length).toBeGreaterThan(0)
@@ -74,4 +74,39 @@ describe('useProjects', () => {
     // Assert the result of shouldSuspend based on the mocked getCurrent value
     expect(result).toBe(true) // Since getCurrent is mocked to return undefined
   })
+
+  it('should call createStateSourceHook with correct getState function signature', async () => {
+    await import('./useProjects')
+
+    const mockCreateStateSourceHook = createStateSourceHook as ReturnType<typeof vi.fn>
+    expect(mockCreateStateSourceHook).toHaveBeenCalled()
+
+    const createStateSourceHookArgs = mockCreateStateSourceHook.mock.calls[0][0]
+    const getState = createStateSourceHookArgs.getState
+
+    // Test that getState can handle the new options parameter
+    const mockInstance = {} as SanityInstance
+    const mockOptions = {organizationId: 'org123', includeMembers: false}
+
+    // This should not throw
+    expect(() => getState(mockInstance, mockOptions)).not.toThrow()
+  })
+
+  it('should handle different parameter combinations in shouldSuspend', async () => {
+    await import('./useProjects')
+
+    const mockCreateStateSourceHook = createStateSourceHook as ReturnType<typeof vi.fn>
+    const createStateSourceHookArgs = mockCreateStateSourceHook.mock.calls[0][0]
+    const shouldSuspend = createStateSourceHookArgs.shouldSuspend
+
+    const mockInstance = {} as SanityInstance
+
+    // Test with different options
+    expect(() => shouldSuspend(mockInstance, undefined)).not.toThrow()
+    expect(() => shouldSuspend(mockInstance, {organizationId: 'org123'})).not.toThrow()
+    expect(() => shouldSuspend(mockInstance, {includeMembers: false})).not.toThrow()
+    expect(() =>
+      shouldSuspend(mockInstance, {organizationId: 'org123', includeMembers: false}),
+    ).not.toThrow()
+  })
 })

package/src/hooks/projects/useProjects.ts

@@ -10,36 +10,47 @@ import {createStateSourceHook} from '../helpers/createStateSourceHook'
  */
 export type ProjectWithoutMembers = Omit<SanityProject, 'members'>
 
-type UseProjects = {
-  /**
-   *
-   * Returns metadata for each project you have access to.
-   *
-   * @category Projects
-   * @returns An array of metadata (minus the projects’ members) for each project
-   * @example
-   * ```tsx
-   * const projects = useProjects()
-   *
-   * return (
-   *   <select>
-   *     {projects.map((project) => (
-   *       <option key={project.id}>{project.displayName}</option>
-   *     ))}
-   *   </select>
-   * )
-   * ```
-   */
-  (): ProjectWithoutMembers[]
-}
+/**
+ * @public
+ * @category Types
+ */
+type UseProjects = <TIncludeMembers extends boolean = false>(options?: {
+  organizationId?: string
+  includeMembers?: TIncludeMembers
+}) => TIncludeMembers extends true ? SanityProject[] : ProjectWithoutMembers[]
 
 /**
+ * Returns metadata for each project you have access to.
+ *
+ * @category Projects
+ * @param options - Configuration options
+ * @returns An array of project metadata. If includeMembers is true, returns full SanityProject objects. Otherwise, returns ProjectWithoutMembers objects.
+ * @example
+ * ```tsx
+ * const projects = useProjects()
+ *
+ * return (
+ *   <select>
+ *     {projects.map((project) => (
+ *       <option key={project.id}>{project.displayName}</option>
+ *     ))}
+ *   </select>
+ * )
+ * ```
+ * @example
+ * ```tsx
+ * const projectsWithMembers = useProjects({ includeMembers: true })
+ * const projectsWithoutMembers = useProjects({ includeMembers: false })
+ * ```
  * @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[]>,
-  shouldSuspend: (instance) => getProjectsState(instance).getCurrent() === undefined,
+  getState: getProjectsState as (
+    instance: SanityInstance,
+    options?: {organizationId?: string; includeMembers?: boolean},
+  ) => StateSource<SanityProject[] | ProjectWithoutMembers[]>,
+  shouldSuspend: (instance, options) =>
+    getProjectsState(instance, options).getCurrent() === undefined,
   suspender: resolveProjects,
-})
+}) as UseProjects