/**
 * Does the very simple job of retrieving the current user data
 * 
 * @module
 */

import React, { useContext } from "react";
import { TokenContext } from "../../internal/providers/token-provider";

/**
 * The user data retriever props provide a children function
 * that should be passed to give the id and the role
 */
interface IUserDataRetrieverProps {
  children: (arg: {
    id: string;
    role: string;
    token: string;
  }) => React.ReactNode;
}

/**
 * Provides the current user data, aka id and role, of the logged in user,
 * id might be null, and role can be the GUEST_METAROLE in such case
 * 
 * If you need more information about the user you should use the item definition
 * provider under this data retriever, aka ModuleProvider for users, ItemProvider for
 * user, forId the id used here; then you might read things like email and username
 *
 * 
 * @param props the data retriver props
 * @returns a react element
 */
export default function UserDataRetriever(props: IUserDataRetrieverProps) {
  return (
    <TokenContext.Consumer>
      {
        (value) => {
          return props.children({
            id: value.id,
            role: value.role,
            token: value.token,
          });
        }
      }
    </TokenContext.Consumer>
  );
}

export function useUserDataRetriever() {
  const value = useContext(TokenContext);

  return {
    id: value.id,
    role: value.role,
    token: value.token,
  };
}