dauth-context-react 2.2.0 → 2.4.0

package/README.md

@@ -1,6 +1,6 @@
 # dauth-context-react
 
-React context provider and hook for token-based authentication with the [DAuth](https://dauth.ovh) service. Provides `DauthProvider` and `useDauth()` hook for seamless integration of DAuth tenant authentication into React applications.
+React context provider and hook for token-based authentication with the [Dauth](https://dauth.ovh) service. Provides `DauthProvider` and `useDauth()` hook for seamless integration of Dauth tenant authentication into React applications.
 
 ## Installation
 
@@ -71,7 +71,7 @@ function MyComponent() {
 
 | Prop | Type | Description |
 |---|---|---|
-| `domainName` | `string` | Your DAuth domain name (used for API routing and tenant resolution) |
+| `domainName` | `string` | Your Dauth domain name (used for API routing and tenant resolution) |
 | `tsk` | `string` | Tenant Secret Key for JWT verification |
 | `children` | `React.ReactNode` | Child components |
 
@@ -85,11 +85,11 @@ Returns the current authentication state and action methods:
 | `domain` | `IDauthDomainState` | Domain configuration (name, loginRedirect, allowedOrigins) |
 | `isLoading` | `boolean` | `true` while initial auth check is in progress |
 | `isAuthenticated` | `boolean` | `true` if user is authenticated |
-| `loginWithRedirect` | `() => void` | Redirects to the DAuth tenant sign-in page |
+| `loginWithRedirect` | `() => void` | Redirects to the Dauth tenant sign-in page |
 | `logout` | `() => void` | Clears token and resets auth state |
 | `getAccessToken` | `() => Promise<string>` | Returns a fresh access token (refreshes if needed) |
 | `updateUser` | `(fields: Partial<IDauthUser>) => Promise<boolean>` | Updates user profile fields |
-| `updateUserWithRedirect` | `() => void` | Redirects to the DAuth user update page |
+| `updateUserWithRedirect` | `() => void` | Redirects to the Dauth user update page |
 | `sendEmailVerification` | `() => Promise<boolean>` | Sends a verification email to the user |
 | `sendEmailVerificationStatus` | `{ status: IActionStatus, isLoading: boolean }` | Status of the email verification request |
 
@@ -119,7 +119,7 @@ interface IDauthUser {
 
 ## Real-World Integration Example
 
-This is the pattern used in `easymediacloud-frontend-react`, which delegates all user authentication to dauth.
+This is the pattern used in `easymediacloud-frontend-react`, which delegates all user authentication to Dauth.
 
 ### 1. Provider hierarchy in `App.tsx`
 

package/dist/{interfaces.d.ts → index.d.mts}

@@ -1,49 +1,71 @@
-export interface IDauthUser {
-    _id: string;
-    name: string;
-    lastname: string;
-    nickname: string;
-    email: string;
-    isVerified: boolean;
-    language: string;
-    avatar: {
-        id: string;
-        url: string;
-    };
-    role: string;
-    telPrefix: string;
-    telSuffix: string;
-    birthDate?: Date;
-    country?: string;
-    metadata?: Record<string, unknown>;
-    createdAt: Date;
-    updatedAt: Date;
-    lastLogin: Date;
-}
-export interface IDauthDomainState {
-    name: string;
-    loginRedirect: string;
-    allowedOrigins: string[];
-}
-export interface IDauthState {
-    user: IDauthUser;
-    domain: IDauthDomainState;
-    isLoading: boolean;
-    isAuthenticated: boolean;
-    loginWithRedirect: () => void;
-    logout: () => void;
-    getAccessToken: () => Promise<string>;
-    updateUser: (fields: Partial<IDauthUser>) => Promise<boolean>;
-    updateUserWithRedirect: () => void;
-    sendEmailVerificationStatus: {
-        status: IActionStatus;
-        isLoading: boolean;
-    };
-    sendEmailVerification: () => Promise<boolean>;
-    deleteAccount: () => Promise<boolean>;
-}
-export interface IActionStatus {
-    type: TStatusTypes;
-    message: string;
-}
-export declare type TStatusTypes = 'success' | 'error' | 'info' | 'warning';
+import React$1 from 'react';
+
+interface IDauthUser {
+    _id: string;
+    name: string;
+    lastname: string;
+    nickname: string;
+    email: string;
+    isVerified: boolean;
+    language: string;
+    avatar: {
+        id: string;
+        url: string;
+    };
+    role: string;
+    telPrefix: string;
+    telSuffix: string;
+    birthDate?: Date;
+    country?: string;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+    lastLogin: Date;
+}
+interface IDauthDomainEnvironment {
+    name: string;
+    loginRedirect: string;
+}
+interface IDauthDomainState {
+    name: string;
+    environments?: IDauthDomainEnvironment[];
+    loginRedirect: string;
+    allowedOrigins: string[];
+}
+interface IDauthState {
+    user: IDauthUser;
+    domain: IDauthDomainState;
+    isLoading: boolean;
+    isAuthenticated: boolean;
+    loginWithRedirect: () => void;
+    logout: () => void;
+    getAccessToken: () => Promise<string>;
+    updateUser: (fields: Partial<IDauthUser>) => Promise<boolean>;
+    updateUserWithRedirect: () => void;
+    sendEmailVerificationStatus: {
+        status: IActionStatus;
+        isLoading: boolean;
+    };
+    sendEmailVerification: () => Promise<boolean>;
+    deleteAccount: () => Promise<boolean>;
+}
+interface IActionStatus {
+    type: TStatusTypes;
+    message: string;
+}
+type TStatusTypes = 'success' | 'error' | 'info' | 'warning';
+interface IDauthProviderProps {
+    domainName: string;
+    children: React.ReactNode;
+    storageKey?: {
+        accessToken?: string;
+        refreshToken?: string;
+    };
+    onError?: (error: Error) => void;
+    env?: string;
+}
+
+declare const DauthProvider: React$1.FC<IDauthProviderProps>;
+declare const useDauth: () => IDauthState;
+
+export { DauthProvider, type IDauthProviderProps, useDauth };

package/dist/index.d.ts

@@ -1,8 +1,71 @@
-import React from 'react';
-interface DauthProviderProps {
-    domainName: string;
-    children: React.ReactNode;
-}
-export declare const DauthProvider: React.FC<DauthProviderProps>;
-export declare const useDauth: () => import("./interfaces").IDauthState;
-export {};
+import React$1 from 'react';
+
+interface IDauthUser {
+    _id: string;
+    name: string;
+    lastname: string;
+    nickname: string;
+    email: string;
+    isVerified: boolean;
+    language: string;
+    avatar: {
+        id: string;
+        url: string;
+    };
+    role: string;
+    telPrefix: string;
+    telSuffix: string;
+    birthDate?: Date;
+    country?: string;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+    lastLogin: Date;
+}
+interface IDauthDomainEnvironment {
+    name: string;
+    loginRedirect: string;
+}
+interface IDauthDomainState {
+    name: string;
+    environments?: IDauthDomainEnvironment[];
+    loginRedirect: string;
+    allowedOrigins: string[];
+}
+interface IDauthState {
+    user: IDauthUser;
+    domain: IDauthDomainState;
+    isLoading: boolean;
+    isAuthenticated: boolean;
+    loginWithRedirect: () => void;
+    logout: () => void;
+    getAccessToken: () => Promise<string>;
+    updateUser: (fields: Partial<IDauthUser>) => Promise<boolean>;
+    updateUserWithRedirect: () => void;
+    sendEmailVerificationStatus: {
+        status: IActionStatus;
+        isLoading: boolean;
+    };
+    sendEmailVerification: () => Promise<boolean>;
+    deleteAccount: () => Promise<boolean>;
+}
+interface IActionStatus {
+    type: TStatusTypes;
+    message: string;
+}
+type TStatusTypes = 'success' | 'error' | 'info' | 'warning';
+interface IDauthProviderProps {
+    domainName: string;
+    children: React.ReactNode;
+    storageKey?: {
+        accessToken?: string;
+        refreshToken?: string;
+    };
+    onError?: (error: Error) => void;
+    env?: string;
+}
+
+declare const DauthProvider: React$1.FC<IDauthProviderProps>;
+declare const useDauth: () => IDauthState;
+
+export { DauthProvider, type IDauthProviderProps, useDauth };