@sanity/sdk-react 2.1.0 → 2.1.2-cors-check.0

package/dist/index.d.ts

@@ -14,6 +14,7 @@ import {DocumentPermissionsResult} from '@sanity/sdk'
 import {FallbackProps} from 'react-error-boundary'
 import {FavoriteStatusResponse} from '@sanity/sdk'
 import {FrameMessage} from '@sanity/sdk'
+import {GetUserOptions} from '@sanity/sdk'
 import {GetUsersOptions} from '@sanity/sdk'
 import {JsonMatch} from '@sanity/sdk'
 import {MediaResource} from '@sanity/message-protocol'
@@ -40,6 +41,7 @@ import {SanityQueryResult} from 'groq'
 import {SanityUser} from '@sanity/sdk'
 import {SortOrderingItem} from '@sanity/types'
 import {StudioResource} from '@sanity/message-protocol'
+import {UserPresence} from '@sanity/sdk'
 import {ValidProjection} from '@sanity/sdk'
 import {WindowMessage} from '@sanity/sdk'
 
@@ -2067,6 +2069,14 @@ declare type UsePerspective = {
  */
 export declare const usePerspective: UsePerspective
 
+/**
+ * A hook for subscribing to presence information for the current project.
+ * @public
+ */
+export declare function usePresence(): {
+  locations: UserPresence[]
+}
+
 declare type UseProject = {
   /**
    *
@@ -2097,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
  */
@@ -2291,6 +2309,21 @@ declare interface UseRecordDocumentHistoryEventProps extends DocumentHandle {
   schemaName?: string
 }
 
+/**
+ * @public
+ * @category Types
+ */
+export declare interface UserResult {
+  /**
+   * The user data fetched, or undefined if not found.
+   */
+  data: SanityUser | undefined
+  /**
+   * Whether a user request is currently in progress
+   */
+  isPending: boolean
+}
+
 /**
  * @public
  * @category Types
@@ -2406,6 +2439,40 @@ export declare const useSanityInstance: (config?: SanityConfig) => SanityInstanc
  */
 export declare function useStudioWorkspacesByProjectIdDataset(): StudioWorkspacesResult
 
+/**
+ *
+ * @public
+ *
+ * Retrieves a single user by ID for a given resource (either a project or an organization).
+ *
+ * @category Users
+ * @param options - The user ID, resource type, project ID, or organization ID
+ * @returns The user data and loading state
+ *
+ * @example
+ * ```
+ * const { data, isPending } = useUser({
+ *   userId: 'gabc123',
+ *   resourceType: 'project',
+ *   projectId: 'my-project-id',
+ * })
+ *
+ * return (
+ *   <div>
+ *     {isPending && <p>Loading...</p>}
+ *     {data && (
+ *       <figure>
+ *         <img src={data.profile.imageUrl} alt='' />
+ *         <figcaption>{data.profile.displayName}</figcaption>
+ *         <address>{data.profile.email}</address>
+ *       </figure>
+ *     )}
+ *   </div>
+ * )
+ * ```
+ */
+export declare function useUser(options: GetUserOptions): UserResult
+
 /**
  *
  * @public

package/dist/index.js

@@ -1,6 +1,6 @@
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
 import { c } from "react-compiler-runtime";
-import { getAuthState, getNodeState, getIsInDashboardState, setAuthToken, AuthStateType, getLoginUrlState, observeOrganizationVerificationState, handleAuthCallback, logout, createSanityInstance, getTokenState, getCurrentUserState, getDashboardOrganizationId, getClientState, getOrCreateController, getOrCreateChannel, releaseChannel, getFavoritesState, resolveFavoritesState, resolveDatasets, getDatasetsState, applyDocumentActions, resolveDocument, getDocumentState, subscribeDocumentEvents, getPermissionsState, getDocumentSyncStatus, editDocument, getQueryKey, parseQueryKey, getQueryState, resolveQuery, createGroqSearchFilter, getPreviewState, resolvePreview, getProjectionState, resolveProjection, resolveProject, getProjectState, resolveProjects, getProjectsState, getActiveReleasesState, getPerspectiveState, getUsersKey, parseUsersKey, getUsersState, resolveUsers, loadMoreUsers } from "@sanity/sdk";
+import { getAuthState, getNodeState, getIsInDashboardState, setAuthToken, AuthStateType, getLoginUrlState, observeOrganizationVerificationState, handleAuthCallback, logout, createSanityInstance, getTokenState, getCurrentUserState, getDashboardOrganizationId, getClientState, getOrCreateController, getOrCreateChannel, releaseChannel, getFavoritesState, resolveFavoritesState, resolveDatasets, getDatasetsState, applyDocumentActions, resolveDocument, getDocumentState, subscribeDocumentEvents, getPermissionsState, getDocumentSyncStatus, editDocument, getQueryKey, parseQueryKey, getQueryState, resolveQuery, createGroqSearchFilter, getPresence, getPreviewState, resolvePreview, getProjectionState, resolveProjection, resolveProject, getProjectState, resolveProjects, getProjectsState, getActiveReleasesState, getPerspectiveState, getUsersKey, parseUsersKey, getUsersState, resolveUsers, loadMoreUsers } from "@sanity/sdk";
 export * from "@sanity/sdk";
 import { createContext, useContext, useSyncExternalStore, useRef, useEffect, useState, Suspense, useMemo, useCallback, useInsertionEffect, useTransition } from "react";
 import { ErrorBoundary } from "react-error-boundary";
@@ -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) {
@@ -351,7 +351,7 @@ function SDKProvider({
 }
 const REDIRECT_URL = "https://sanity.io/welcome";
 function SanityApp(t0) {
-  const $ = c(13);
+  const $ = c(15);
   let children, fallback, props, t1;
   $[0] !== t0 ? ({
     children,
@@ -362,14 +362,14 @@ function SanityApp(t0) {
   let t2;
   $[5] !== t1 ? (t2 = t1 === void 0 ? [] : t1, $[5] = t1, $[6] = t2) : t2 = $[6];
   const config = t2;
-  let t3;
-  $[7] === Symbol.for("react.memo_cache_sentinel") ? (t3 = [], $[7] = t3) : t3 = $[7], useEffect(_temp2$1, t3);
-  let t4;
-  return $[8] !== children || $[9] !== config || $[10] !== fallback || $[11] !== props ? (t4 = /* @__PURE__ */ jsx(SDKProvider, { ...props, fallback, config, children }), $[8] = children, $[9] = config, $[10] = fallback, $[11] = props, $[12] = t4) : t4 = $[12], t4;
-}
-function _temp2$1() {
-  let timeout;
-  return !isInIframe() && !isLocalUrl(window) && (timeout = setTimeout(_temp$4, 1e3)), () => clearTimeout(timeout);
+  let t3, t4;
+  $[7] !== config ? (t3 = () => {
+    let timeout;
+    const primaryConfig = Array.isArray(config) ? config[0] : config;
+    return !isInIframe() && !isLocalUrl(window) && !primaryConfig?.studioMode?.enabled && (timeout = setTimeout(_temp$4, 1e3)), () => clearTimeout(timeout);
+  }, t4 = [config], $[7] = config, $[8] = t3, $[9] = t4) : (t3 = $[8], t4 = $[9]), useEffect(t3, t4);
+  let t5;
+  return $[10] !== children || $[11] !== config || $[12] !== fallback || $[13] !== props ? (t5 = /* @__PURE__ */ jsx(SDKProvider, { ...props, fallback, config, children }), $[10] = children, $[11] = config, $[12] = fallback, $[13] = props, $[14] = t5) : t5 = $[14], t5;
 }
 function _temp$4() {
   console.warn("Redirecting to core", REDIRECT_URL), window.location.replace(REDIRECT_URL);
@@ -992,6 +992,24 @@ function _temp2(str) {
 function _temp(i) {
   return typeof i == "string";
 }
+function usePresence() {
+  const $ = c(11), sanityInstance = useSanityInstance();
+  let t0, t1;
+  $[0] !== sanityInstance ? (t1 = getPresence(sanityInstance), $[0] = sanityInstance, $[1] = t1) : t1 = $[1], t0 = t1;
+  const source = t0;
+  let t2;
+  $[2] !== source ? (t2 = (callback) => source.subscribe(callback), $[2] = source, $[3] = t2) : t2 = $[3];
+  const subscribe = t2;
+  let t3, t4;
+  $[4] !== source ? (t3 = () => source.getCurrent(), t4 = () => source.getCurrent(), $[4] = source, $[5] = t3, $[6] = t4) : (t3 = $[5], t4 = $[6]);
+  const locations = useSyncExternalStore(subscribe, t3, t4);
+  let t5;
+  $[7] !== locations ? (t5 = locations || [], $[7] = locations, $[8] = t5) : t5 = $[8];
+  let t6;
+  return $[9] !== t5 ? (t6 = {
+    locations: t5
+  }, $[9] = t5, $[10] = t6) : t6 = $[10], t6;
+}
 function useDocumentPreview(t0) {
   const $ = c(13);
   let docHandle, ref;
@@ -999,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;
@@ -1040,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,
@@ -1078,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,
@@ -1091,6 +1108,27 @@ const useProject = createStateSourceHook({
   shouldSuspend: (instance, options) => getPerspectiveState(instance, options).getCurrent() === void 0,
   suspender: (instance, _options) => firstValueFrom(getActiveReleasesState(instance).observable.pipe(filter(Boolean)))
 });
+function useUser(options) {
+  const instance = useSanityInstance(options), [isPending, startTransition] = useTransition(), key = getUsersKey(instance, options), [deferredKey, setDeferredKey] = useState(key), deferred = useMemo(() => parseUsersKey(deferredKey), [deferredKey]), [ref, setRef] = useState(new AbortController());
+  useEffect(() => {
+    key !== deferredKey && startTransition(() => {
+      ref.signal.aborted || (ref.abort(), setRef(new AbortController())), setDeferredKey(key);
+    });
+  }, [deferredKey, key, ref]);
+  const {
+    getCurrent,
+    subscribe
+  } = useMemo(() => getUsersState(instance, deferred), [instance, deferred]);
+  if (getCurrent() === void 0)
+    throw resolveUsers(instance, {
+      ...deferred,
+      signal: ref.signal
+    });
+  return {
+    data: useSyncExternalStore(subscribe, getCurrent)?.data[0],
+    isPending
+  };
+}
 function useUsers(options) {
   const instance = useSanityInstance(options), [isPending, startTransition] = useTransition(), key = getUsersKey(instance, options), [deferredKey, setDeferredKey] = useState(key), deferred = useMemo(() => parseUsersKey(deferredKey), [deferredKey]), [ref, setRef] = useState(new AbortController());
   useEffect(() => {
@@ -1120,7 +1158,7 @@ function useUsers(options) {
     loadMore
   };
 }
-var version = "2.1.0";
+var version = "2.1.2-cors-check.0";
 function getEnv(key) {
   if (typeof import.meta < "u" && import.meta.env)
     return import.meta.env[key];
@@ -1162,12 +1200,14 @@ export {
   useNavigateToStudioDocument,
   usePaginatedDocuments,
   usePerspective,
+  usePresence,
   useProject,
   useProjects,
   useQuery,
   useRecordDocumentHistoryEvent,
   useSanityInstance,
   useStudioWorkspacesByProjectIdDataset,
+  useUser,
   useUsers,
   useVerifyOrgProjects,
   useWindowConnection