import { useContext } from "react";

import { AuthContext } from "@contexts/auth";
import { IAuthContext } from "../../../interfaces";
import { useQuery, UseQueryResult, UseQueryOptions } from "react-query";

/**
 * `usePermissions` calls the `getPermissions` method from the {@link https://refine.dev/docs/api-references/providers/auth-provider `authProvider`} under the hood.
 *
 * @see {@link https://refine.dev/docs/api-references/hooks/auth/usePermissions} for more details.
 *
 * @typeParam TData - Result data of the query
 *
 */
export const usePermissions = <TData = any>(
    options?: UseQueryOptions<TData>,
): UseQueryResult<TData, unknown> => {
    const { getPermissions } = useContext<IAuthContext>(AuthContext);

    const queryResponse = useQuery<TData>(
        "usePermissions",
        getPermissions,
        options,
    );

    return queryResponse;
};