Accessing currentUser in V3 studio.

[dwkns]

Inspired by this article. What is the equivalent of this in the v3 Studio?

import userStore from "part:@sanity/base/user";

userStore.getCurrentUser().then((user) => {
  console.log(`[currentUser]:`, user );
})

Bonus points for a Typescript answer (if that is any different).

[kmelve]

For Structure Builder specifically, you can do something like this in v3:

import {ConfigContext, createConfig} from 'sanity'
import {deskTool, StructureBuilder} from 'sanity/desk'
import {schemaTypes} from './schemas'

export default createConfig({
  name: 'default',
  title: 'sanity-v3-structure-builder',

  projectId: 'your-projectId',
  dataset: 'your-dataset',
  plugins: [
    deskTool({
      structure: (S: StructureBuilder, context: ConfigContext) => {
        const {projectId, dataset, schema, currentUser, client} = context
        const {id, name, email, profileImage, provider, roles} = currentUser
		if(!currentUser) {
			return S.list().title('User missing')
		}

        // your logic

        return S.defaults()
      },
    }),
  ],
  schema: {
    types: schemaTypes,
  },
})

Let us know if this solves your problem or not!

[ghost]

In part, yes. But we also get the currentUser in a deploy button...

const DeployButton = () => {

  const [currentUser, setCurrentUser] = useState([]);

  useEffect(() => {
    async function getCurrentSanityUser() {
      try {
        const currentUser = await userStore.getCurrentUser()
        const roleNames = currentUser.roles.map(role => role.name)
        let hasDeloyPermissions =  (roleNames.includes('administrator') || roleNames.includes('deploy')) ? true : false
       
        setCurrentUser({
          name: currentUser.name,
          email: currentUser.email,
          hasDeloyPermissions: hasDeloyPermissions,
          permissions: roleNames
        });

      } catch (err) {
        console.log(err);
      }
    }
    getCurrentSanityUser();
  }, []);

  return (
   // do stuff with currentUser
  )
}

[snorrees]

In components you should be able to use the useCurrentUser hook directly:

import { useCurrentUser } from "sanity";

function MyComponent() {
  const user = useCurrentUser()
  return /* JSX*/
}

In the context of structureBuilder that will not work however, since the code runs outside of the React component tree, hence the suggestion by Knut.

[ghost]

I understand. This is exactly what I need.
So while everything is working as expected, I am getting some errors in VS Code with:

// ./structure.ts
import {StructureBuilder} from 'sanity/desk'
import {ConfigContext} from 'sanity'

export const structure = (S: StructureBuilder, context: ConfigContext) => {
  const {projectId, dataset, schema, currentUser, client} = context
  const {id, name, email, profileImage, provider, roles} = currentUser
  console.log(`[currentUser]:`, currentUser);
 
  return S.list().title(currentUser.name).items(S.documentTypeListItems())
}

id does exist on currentUser and currentUser is not null.
This may well be my ignorance of Typescript?

[snorrees]

You are right; TypeScript is informing us that currentUser can be null, and null cannot be destructed.

Instead use the currentUser?.id to access properties, or use an if-check, for example:

export const structure = (S: StructureBuilder, context: ConfigContext) => {
  const {projectId, dataset, schema, currentUser, client} = context
  if(!currentUser) {
     return S.list().title('User missing')
  }
  
  //because we returned from the function when currentUser is null,
  // TypeScript has automatically narrowed the type from CurrentUser | null to CurrentUser, and we can now destruct the object
  const {id, name, email, profileImage, provider, roles} = currentUser 
  return S.list().title(currentUser.name).items(S.documentTypeListItems())
}