newpaper-api

Auth Context and API Integration README

Overview

This project provides a React context and set of hooks to manage authentication in your React applications. It facilitates API requests with Bearer token authentication, session handling, and login redirection. The context also supports custom hooks for GET, POST, PATCH, and DELETE requests.

Table of Contents

• Auth Context and API Integration README
  • Overview
  • Table of Contents
  • Installation
    • Install necessary packages:
  • Usage
    • 1. AuthProvider
      • Example:
    • 2. LoginButton
      • Example:
      • a. useAuthSession
  • 3. API Hooks
    • b. useGet
    • c. usePost
    • d. usePatch
    • e. useDelete
  • Utility Functions
    • 1. openLogin
    • 2. getBToken
    • 3. isTokenExpired
  • Error Handling
  • Examples
    • Using useGet to Fetch Data
    • Using usePost to Submit Data
    • Handling Login Session
  • License

Installation

To integrate this into your React project, copy the provided code into your project and ensure the necessary dependencies are installed.

Install necessary packages:

npm install newpaper-api

Usage

1. AuthProvider

This provider manages authentication state and provides the loginPageUrl and apiBaseUrl to the components that consume this context. Wrap your App Components with {children} like so :

Example:

import { AuthProvider } from "newpaper-api";

<AuthProvider
  loginPageUrl="https://login.example.com"
  apiBaseUrl="https://api.example.com"
>
  <YourAppComponents />
</AuthProvider>;

2. LoginButton

The LoginButton component provides a pre-built button for redirecting users to the login page.

Example:

a. useAuthSession

This hook tells us if the user should log or not.

import { LoginButton, useAuthSession } from "newpaper-api";

// Your Component
const { shouldLogin } = useAuthSession();

{
  shouldLogin && <LoginButton />;
}
{
  !shouldLogin && <AppContent />;
}

3. API Hooks

b. useGet

This hook makes a GET request with the Bearer token automatically included in the request header.

const { data, loading, error, refetch } = useGet({
  path: "/data-endpoint",
  options: { queryString: "?param=value" },
});

c. usePost

The usePost hook is for sending POST requests. It returns a submit function to be called with the request body.

const { loading, error, submit } = usePost({ path: "/submit-data" });

submit({ key: "value" }, (response) => {
  console.log("Success", response);
});

d. usePatch

Use this hook for making PATCH requests.

const { loading, error, submit } = usePatch({ path: "/update-data" });

submit({ updateKey: "newValue" }, (response) => {
  console.log("Update Success", response);
});

e. useDelete

Use this hook for making DELETE requests.

const { loading, error, submit } = useDelete({ path: "/delete-data" });

submit({}, (response) => {
  console.log("Deleted", response);
});

Utility Functions

1. openLogin

This function opens a login popup to redirect users to the authentication page.

openLogin({ loginPageUrl: "https://login.example.com" });

2. getBToken

Retrieves the Bearer token (bearer_token) from the URL query parameters.

const token = getBToken();

3. isTokenExpired

Checks if a JWT token has expired.

const expired = isTokenExpired(token);
if (expired) {
  // Redirect user to login
}

Error Handling

Each hook (useGet, usePost, usePatch, and useDelete) returns an error state, which contains any errors encountered during the request. This should be handled in your UI, typically by showing an error message.

if (error) {
  console.error(error.message);
}

Examples

Using useGet to Fetch Data

const { data, loading, error, refetch } = useGet({ path: "/user/profile" });

if (loading) {
  return <p>Loading...</p>;
}

if (error) {
  return <p>Error: {error.message}</p>;
}

return <div>{data?.name}</div>;

Using usePost to Submit Data

const { submit, loading, error } = usePost({ path: "/user/register" });

const handleRegister = () => {
  submit({ username: "newUser" }, (data) => {
    console.log("Registration success:", data);
  });
};

return (
  <div>
    <button onClick={handleRegister} disabled={loading}>
      Register
    </button>
    {error && <p>Error: {error.message}</p>}
  </div>
);

Handling Login Session

const { shouldLogin } = useAuthSession();

if (shouldLogin) {
  openLogin({ loginPageUrl: "https://login.example.com" });
}

License

This project is licensed under the MIT License.