@sanity/sdk-react 2.1.2 → 2.2.0

package/dist/index.d.ts

@@ -2107,30 +2107,38 @@ declare type UseProject = {
  */
 export declare const useProject: UseProject
 
-declare 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
+ */
+declare type UseProjects = <TIncludeMembers extends boolean = false>(options?: {
+  organizationId?: string
+  includeMembers?: TIncludeMembers
+}) => TIncludeMembers extends true ? SanityProject_2[] : 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
  */

package/dist/index.js

@@ -11,7 +11,7 @@ import { pick } from "lodash-es";
 const SanityInstanceContext = createContext(null), useSanityInstance = (config) => {
   const $ = c(3), instance = useContext(SanityInstanceContext);
   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>.`);
+    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 component.`);
   if (!config)
     return instance;
   let t0;
@@ -19,7 +19,7 @@ const SanityInstanceContext = createContext(null), useSanityInstance = (config)
   const match = t0;
   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.`);
   return match;
 };
 function createStateSourceHook(options) {
@@ -1017,7 +1017,7 @@ function useDocumentPreview(t0) {
     ref,
     ...docHandle
   } = t0, $[0] = t0, $[1] = docHandle, $[2] = ref) : (docHandle = $[1], ref = $[2]);
-  const instance = useSanityInstance();
+  const instance = useSanityInstance(docHandle);
   let t1;
   $[3] !== docHandle || $[4] !== instance ? (t1 = getPreviewState(instance, docHandle), $[3] = docHandle, $[4] = instance, $[5] = t1) : t1 = $[5];
   const stateSource = t1;
@@ -1058,7 +1058,7 @@ function useDocumentProjection(t0) {
     projection,
     ...docHandle
   } = t0, $[0] = t0, $[1] = docHandle, $[2] = projection, $[3] = ref) : (docHandle = $[1], projection = $[2], ref = $[3]);
-  const instance = useSanityInstance();
+  const instance = useSanityInstance(docHandle);
   let stateSource, t1;
   if ($[4] !== docHandle || $[5] !== instance || $[6] !== projection ? (stateSource = getProjectionState(instance, {
     ...docHandle,
@@ -1096,9 +1096,8 @@ const useProject = createStateSourceHook({
   suspender: resolveProject,
   getConfig: identity
 }), useProjects = createStateSourceHook({
-  // remove `undefined` since we're suspending when that is the case
   getState: getProjectsState,
-  shouldSuspend: (instance) => getProjectsState(instance).getCurrent() === void 0,
+  shouldSuspend: (instance, options) => getProjectsState(instance, options).getCurrent() === void 0,
   suspender: resolveProjects
 }), useActiveReleases = createStateSourceHook({
   getState: getActiveReleasesState,
@@ -1159,7 +1158,7 @@ function useUsers(options) {
     loadMore
   };
 }
-var version = "2.1.2";
+var version = "2.2.0";
 function getEnv(key) {
   if (typeof import.meta < "u" && import.meta.env)
     return import.meta.env[key];