@sanity/sdk-react 1.0.0 → 2.0.0

package/dist/index.d.ts

@@ -17,6 +17,7 @@ import {FrameMessage} from '@sanity/sdk'
 import {GetUsersOptions} from '@sanity/sdk'
 import {JsonMatch} from '@sanity/sdk'
 import {MediaResource} from '@sanity/message-protocol'
+import {PathChangeMessage} from '@sanity/message-protocol'
 import {PerspectiveHandle} from '@sanity/sdk'
 import {PreviewValue} from '@sanity/sdk'
 import {ProjectHandle} from '@sanity/sdk'
@@ -784,6 +785,53 @@ declare type UseCurrentUser = {
  */
 export declare const useCurrentUser: UseCurrentUser
 
+/**
+ * @public
+ *
+ * A helper hook designed to be injected into routing components for apps within the Dashboard.
+ * While the Dashboard can usually handle navigation, there are special cases when you
+ * are already within a target app, and need to navigate to another route inside of that app.
+ *
+ * For example, your user might "favorite" a document inside of your application.
+ * If they click on the Dashboard favorites item in the sidebar, and are already within your application,
+ * there needs to be some way for the dashboard to signal to your application to reroute to where that document was favorited.
+ *
+ * This hook is intended to receive those messages, and takes a function to route to the correct path.
+ *
+ * @param navigateFn - Function to handle navigation; should accept:
+ * - `path`: a string, which will be a relative path (for example, 'my-route')
+ * - `type`: 'push', 'replace', or 'pop', which will be the type of navigation to perform
+ *
+ * @example
+ * ```tsx
+ * import {useDashboardNavigate} from '@sanity/sdk-react'
+ * import {BrowserRouter, useNavigate} from 'react-router'
+ * import {Suspense} from 'react'
+ *
+ * function DashboardNavigationHandler() {
+ *   const navigate = useNavigate()
+ *   useDashboardNavigate(({path, type}) => {
+ *     navigate(path, {replace: type === 'replace'})
+ *   })
+ *   return null
+ * }
+ *
+ * // Wrap the component with Suspense since the hook may suspend
+ * function MyApp() {
+ *   return (
+ *     <BrowserRouter>
+ *       <Suspense>
+ *         <DashboardNavigationHandler />
+ *       </Suspense>
+ *     </BrowserRouter>
+ *   )
+ * }
+ * ```
+ */
+export declare function useDashboardNavigate(
+  navigateFn: (options: PathChangeMessage['data']) => void,
+): void
+
 /**
  * @public
  *
@@ -1754,20 +1802,18 @@ export declare const useLogOut: () => () => Promise<void>
  * - `favorite` - Function to add document to favorites
  * - `unfavorite` - Function to remove document from favorites
  * - `isFavorited` - Boolean indicating if document is currently favorited
- * - `isConnected` - Boolean indicating if connection to Dashboard UI is established
  *
  * @example
  * ```tsx
  * function FavoriteButton(props: DocumentActionProps) {
  *   const {documentId, documentType} = props
- *   const {favorite, unfavorite, isFavorited, isConnected} = useManageFavorite({
+ *   const {favorite, unfavorite, isFavorited} = useManageFavorite({
  *     documentId,
  *     documentType
  *   })
  *
  *   return (
  *     <Button
- *       disabled={!isConnected}
  *       onClick={() => isFavorited ? unfavorite() : favorite()}
  *       text={isFavorited ? 'Remove from favorites' : 'Add to favorites'}
  *     />
@@ -1828,7 +1874,6 @@ declare interface UseManageFavoriteProps extends DocumentHandle {
  * studios with the same projectId and dataset
  * @returns An object containing:
  * - `navigateToStudioDocument` - Function that when called will navigate to the studio document
- * - `isConnected` - Boolean indicating if connection to Dashboard is established
  *
  * @example
  * ```tsx
@@ -1837,10 +1882,9 @@ declare interface UseManageFavoriteProps extends DocumentHandle {
  * import {Suspense} from 'react'
  *
  * function NavigateButton({documentHandle}: {documentHandle: DocumentHandle}) {
- *   const {navigateToStudioDocument, isConnected} = useNavigateToStudioDocument(documentHandle)
+ *   const {navigateToStudioDocument} = useNavigateToStudioDocument(documentHandle)
  *   return (
  *     <Button
- *       disabled={!isConnected}
  *       onClick={navigateToStudioDocument}
  *       text="Navigate to Studio Document"
  *     />
@@ -2176,7 +2220,6 @@ export declare function useQuery<TData>(options: QueryOptions): {
  * @param documentHandle - The document handle containing document ID and type, like `{_id: '123', _type: 'book'}`
  * @returns An object containing:
  * - `recordEvent` - Function to record document interactions
- * - `isConnected` - Boolean indicating if connection to Studio is established
  *
  * @example
  * ```tsx
@@ -2186,7 +2229,7 @@ export declare function useQuery<TData>(options: QueryOptions): {
  *
  * function RecordEventButton(props: DocumentActionProps) {
  *   const {documentId, documentType, resourceType, resourceId} = props
- *   const {recordEvent, isConnected} = useRecordDocumentHistoryEvent({
+ *   const {recordEvent} = useRecordDocumentHistoryEvent({
  *     documentId,
  *     documentType,
  *     resourceType,
@@ -2194,7 +2237,6 @@ export declare function useQuery<TData>(options: QueryOptions): {
  *   })
  *   return (
  *     <Button
- *       disabled={!isConnected}
  *       onClick={() => recordEvent('viewed')}
  *       text="Viewed"
  *     />

package/dist/index.js

@@ -377,6 +377,19 @@ function useWindowConnection(t0) {
 function _temp$3(unsubscribe) {
   return unsubscribe();
 }
+function useDashboardNavigate(navigateFn) {
+  const $ = c(2);
+  let t0;
+  $[0] !== navigateFn ? (t0 = {
+    name: SDK_NODE_NAME,
+    connectTo: SDK_CHANNEL_NAME,
+    onMessage: {
+      "dashboard/v1/history/change-path": (data) => {
+        navigateFn(data);
+      }
+    }
+  }, $[0] = navigateFn, $[1] = t0) : t0 = $[1], useWindowConnection(t0);
+}
 function useManageFavorite({
   documentId,
   documentType,
@@ -1046,7 +1059,7 @@ function useUsers(options) {
     loadMore
   };
 }
-var version = "1.0.0";
+var version = "2.0.0";
 function getEnv(key) {
   if (typeof import.meta < "u" && import.meta.env)
     return import.meta.env[key];
@@ -1068,6 +1081,7 @@ export {
   useAuthToken,
   useClient,
   useCurrentUser,
+  useDashboardNavigate,
   useDashboardOrganizationId,
   useDatasets,
   useDocument,