@imapps/web-utils 2.6.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# @imapps/web-utils
|
|
2
|
+
|
|
3
|
+
Shared React auth layer for IM Apps frontends. Built with tsup to ESM + CJS (`build/`).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
bun add @imapps/web-utils
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Peer deps: `react >= 18`, `react-router-dom >= 6`.
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
Everything is re-exported from `src/auth`:
|
|
16
|
+
|
|
17
|
+
| Area | Exports |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| contexts | `AuthConfigProvider` / `useAuthConfig`, `AuthProvider`, `UserContext` |
|
|
20
|
+
| components | `ProtectedRoute` |
|
|
21
|
+
| hooks | `useAuthRedirect`, `useTokenInitialization`, `useTokenRefresh` |
|
|
22
|
+
| utils | `decodeJWT`, `extractUserFromToken`, `isTokenExpired`, `getTokenExpirationTime`, `getStorageItem`, `clearRefreshTokenCookie`, ... |
|
|
23
|
+
| types | `AuthConfig` and related types |
|
|
24
|
+
|
|
25
|
+
`AuthConfigProvider` defaults: `storageType: 'localStorage'`, `accessTokenKey: 'accessToken'`, `refreshTokenCookieName: 'refreshToken'`, endpoints `refresh: '/refresh'`, `logout: '/logout'` (see `src/auth/contexts/AuthConfigContext.tsx`).
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { AuthConfigProvider, AuthProvider, ProtectedRoute } from '@imapps/web-utils';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Note: older docs (`CLAUDE.md`, previous README) describe `cn`, `isBrowser`, `clamp` helpers; these are not exported by the current source.
|
|
32
|
+
|
|
33
|
+
## Develop
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
bun run build # tsup
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
No test script is defined for this package.
|
|
40
|
+
|
|
41
|
+
Consumers (from `package.json` scan): `packages/web` of shoppingo, mixtape, jewellery-catalogue.
|