feat!: rename usePermissions → useDocumentPermissions (#365)

* feat!: rename usePermissions → useDocumentPermissions

Author: ryanbonial

apps/kitchensink-react/src/DocumentCollection/DocumentEditorRoute.tsx

@@ -13,9 +13,9 @@ import {
   useApplyDocumentActions,
   useDocument,
   useDocumentEvent,
+  useDocumentPermissions,
   useDocumentSyncStatus,
   useEditDocument,
-  usePermissions,
 } from '@sanity/sdk-react'
 import {SanityDocument} from '@sanity/types'
 import {Box, Button, TextInput, Tooltip} from '@sanity/ui'
@@ -38,20 +38,20 @@ function Editor() {
   const synced = useDocumentSyncStatus(doc)
   const apply = useApplyDocumentActions()
 
-  const canEdit = usePermissions(editDocument(doc))
-  const canCreate = usePermissions(createDocument(doc))
-  const canPublish = usePermissions(publishDocument(doc))
-  const canDelete = usePermissions(deleteDocument(doc))
-  const canUnpublish = usePermissions(unpublishDocument(doc))
-  const canDiscard = usePermissions(discardDocument(doc))
+  const canEdit = useDocumentPermissions(editDocument(doc))
+  const canCreate = useDocumentPermissions(createDocument(doc))
+  const canPublish = useDocumentPermissions(publishDocument(doc))
+  const canDelete = useDocumentPermissions(deleteDocument(doc))
+  const canUnpublish = useDocumentPermissions(unpublishDocument(doc))
+  const canDiscard = useDocumentPermissions(discardDocument(doc))
 
   const name = useDocument(doc, 'name') ?? ''
   const setName = useEditDocument(doc, 'name')
 
   const [value, setValue] = useState('')
 
   const changeNameToValue = editDocument(patch(doc._id, at('name', set(value))))
-  const canChangeNameToValue = usePermissions(changeNameToValue)
+  const canChangeNameToValue = useDocumentPermissions(changeNameToValue)
 
   const document = useDocument(doc)
   const setDocument = useEditDocument(doc)

packages/core/src/_exports/index.ts

@@ -85,7 +85,7 @@ export {
   type JsonMatchPath,
 } from '../document/patchOperations'
 export {type DocumentResourceId, getResourceId, type ResourceId} from '../document/patchOperations'
-export {type PermissionDeniedReason, type PermissionsResult} from '../document/permissions'
+export {type DocumentPermissionsResult, type PermissionDeniedReason} from '../document/permissions'
 export {createSanityInstance} from '../instance/sanityInstance'
 export type {SanityConfig, SanityInstance, SdkIdentity} from '../instance/types'
 export {getPreviewState, type GetPreviewStateOptions} from '../preview/getPreviewState'

packages/core/src/document/permissions.ts

@@ -135,7 +135,7 @@ export interface PermissionDeniedReason {
 }
 
 /** @beta */
-export type PermissionsResult =
+export type DocumentPermissionsResult =
   | {
       allowed: false
       message: string
@@ -151,7 +151,7 @@ export const calculatePermissions = createSelector(
     grants: Record<Grant, ExprNode> | undefined,
     documents: DocumentSet | undefined,
     actions: DocumentAction[] | undefined,
-  ): PermissionsResult | undefined => {
+  ): DocumentPermissionsResult | undefined => {
     if (!documents) return undefined
     if (!grants) return undefined
     if (!actions) return undefined

packages/react/src/_exports/index.ts

@@ -32,9 +32,9 @@ export {useDatasets} from '../hooks/datasets/useDatasets'
 export {useApplyDocumentActions} from '../hooks/document/useApplyDocumentActions'
 export {useDocument} from '../hooks/document/useDocument'
 export {useDocumentEvent} from '../hooks/document/useDocumentEvent'
+export {useDocumentPermissions} from '../hooks/document/useDocumentPermissions'
 export {useDocumentSyncStatus} from '../hooks/document/useDocumentSyncStatus'
 export {useEditDocument} from '../hooks/document/useEditDocument'
-export {usePermissions} from '../hooks/document/usePermissions'
 export {
   type DocumentsOptions,
   type DocumentsResponse,

packages/react/src/hooks/document/usePermissions.ts renamed to packages/react/src/hooks/document/useDocumentPermissions.ts

@@ -1,8 +1,8 @@
 import {
   type DocumentAction,
+  type DocumentPermissionsResult,
   getPermissionsState,
   getResourceId,
-  type PermissionsResult,
 } from '@sanity/sdk'
 import {useCallback, useMemo, useSyncExternalStore} from 'react'
 import {filter, firstValueFrom} from 'rxjs'
@@ -21,11 +21,11 @@ import {useSanityInstance} from '../context/useSanityInstance'
  *
  * @example Checking for permission to publish a document
  * ```ts
- * import {usePermissions, useApplyDocumentActions} from '@sanity/sdk-react'
+ * import {useDocumentPermissions, useApplyDocumentActions} from '@sanity/sdk-react'
  * import {publishDocument} from '@sanity/sdk'
  *
  * export function PublishButton({doc}: {doc: DocumentHandle}) {
- *   const publishPermissions = usePermissions(publishDocument(doc))
+ *   const publishPermissions = useDocumentPermissions(publishDocument(doc))
  *   const applyAction = useApplyDocumentActions()
  *
  *   return (
@@ -47,7 +47,9 @@ import {useSanityInstance} from '../context/useSanityInstance'
  * }
  * ```
  */
-export function usePermissions(actions: DocumentAction | DocumentAction[]): PermissionsResult {
+export function useDocumentPermissions(
+  actions: DocumentAction | DocumentAction[],
+): DocumentPermissionsResult {
   // if actions is an array, we need to check each action to see if the resourceId is the same
   if (Array.isArray(actions)) {
     const resourceIds = actions.map((action) => action.resourceId)
@@ -78,5 +80,5 @@ export function usePermissions(actions: DocumentAction | DocumentAction[]): Perm
     [actions, instance],
   )
 
-  return useSyncExternalStore(subscribe, getCurrent) as PermissionsResult
+  return useSyncExternalStore(subscribe, getCurrent) as DocumentPermissionsResult
 }