Package authenticator

Unify authentication between clients and the authentication service.

---

Installation

⚠️ Warning: Even though the package is public, GitHub registry requires you to have a Personal Access Token with repo and read:packages scopes to pull it in your project. See this issue for more information.

Create a .npmrc file in the root of your project if it doesn't exist, and make sure it contains the following:

@a-novel:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${YOUR_PERSONAL_ACCESS_TOKEN}

Then, install the package using pnpm:

# pnpm config set auto-install-peers true
#  Or
# pnpm config set auto-install-peers true --location project
pnpm add @a-novel/package-authenticator

Requirements

You need to import material symbols in your app.

<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined" rel="stylesheet" />

Also create the following mui.d.ts file (make sure it is included in your tsconfig.json):

import type { AgoraUIButtonPropsVariant } from "@a-novel/package-ui/mui";

import "@mui/material";

declare module "@mui/material" {
  //eslint-disable-next-line @typescript-eslint/no-empty-object-type
  interface ButtonPropsVariantOverrides extends AgoraUIButtonPropsVariant {}
}