@trimble-oss/trimble-id-react 0.0.4-rc.2 → 0.1.0-rc.1

package/README.md

@@ -114,6 +114,7 @@ Type of persistence you want the user and token to be store
    * **localStorage** - This persistent doesn't have expiration date
    * **sessionStorage** - This one is cleared when the page session ends
 
+> **_NOTE:_** localStorage and sessionStorage will be removed in future releases due to security concerns. Using localStorage and sessionStorage for storing sensitive information poses several security risks, including vulnerability to XSS attacks, lack of secure attributes, persistent storage, and session hijacking. Please plan to use in-memory option. 
 
 ### useAuth
 Use the `useAuth` hook in your components to access authentication state (`isLoading`, `isAuthenticated`, `user`, `error`) and authentication methods (`loginWithRedirect` and `logout`):
@@ -160,6 +161,15 @@ const {getAccessTokenSilently}= useAuth()
 var access_token = await getAccessTokenSilently()
 ```
 
+### getTokens
+
+Gets the token details from cache. 
+
+```tsx
+const {getTokens}= useAuth()
+var tokenResponse : TokenResponse = await getTokens()
+```
+
 ### user
 
 Information of the user in session

package/dist/TIDClient/TIDClient.d.ts

@@ -1,6 +1,6 @@
 import { BearerTokenHttpClientProvider } from '@trimble-oss/trimble-id';
 import { PersistentStore } from './storage/cache-storage/CacheManager';
-import { AuthState, TIDUser } from './interfaces';
+import { AuthState, TIDUser, TokenResponse } from './interfaces';
 interface TIDClientConfig {
     /**
      * The URL for the Trimble Identity OpenID well known configuration endpoint
@@ -165,6 +165,14 @@ export declare class TIDClient {
      * @throws {TokenExpiredException} Will throw an exception if the user token expired
      */
     getAccessTokenSilently(): Promise<string>;
+    /**
+     * Retrieves token details from the cache, including the access token, ID token, and expiration time.
+     * If the token already expired, will try to refresh it using the refresh token.
+     * @return {Promise<TokenResponse>} Token response
+     * @throws {TokenNotFoundException} Will throw an exception if there are no tokens in cache
+     * @throws {TokenExpiredException} Will throw an exception if the user token expired
+     */
+    getTokens(): Promise<TokenResponse>;
     /**
      * Redirect the user to TID using the browser
      * @param {LogoutOptions} options - Custom configuration for teh redirection

package/dist/TIDClient/interfaces.d.ts

@@ -25,7 +25,20 @@ export interface TIDAuthToken {
     /** The custom state transferred in the last signin */
     state: any;
 }
+/**
+ * Represents the token response like access_token, id_token, and expires_at.
+ */
+export interface TokenResponse {
+    /** The id_token returned from the OIDC provider */
+    id_token: string;
+    /** The access token returned from the OIDC provider. */
+    access_token: string;
+    /** The expires at returned from the OIDC provider */
+    expires_at: number;
+}
 export interface TIDUser {
+    /** User or application UUID */
+    id?: string;
     /** End-User's full name */
     name?: string;
     /** Given name(s) or first name(s) of the End-User */

package/dist/TIDProvider/TIDContext.d.ts

@@ -1,5 +1,5 @@
 import { TIDAuthState } from './state';
-import { AuthState } from '../TIDClient';
+import { AuthState, TokenResponse } from '../TIDClient';
 export interface LoginWithRedirectOptions {
     /**
      * Function called when the user redirection is occurring
@@ -53,6 +53,13 @@ export interface TIDContextState extends TIDAuthState {
      * @throws {TokenExpiredException} Will throw an if the user token expired
      */
     getAccessTokenSilently: () => Promise<string>;
+    /**
+     * Gets the token details from cache.
+     * @return {Promise<TokenResponse>} token response
+     * @throws {TokenNotFoundException} Will throw an exception there are no tokens in cache
+     * @throws {TokenExpiredException} Will throw an if the user token expired
+     */
+    getTokens: () => Promise<TokenResponse>;
     /**
      * Redirect the user to TID using the browser
      * @param {LoginWithRedirectOptions} options - Custom configuration for teh redirection

package/dist/TIDProvider/reducer.d.ts

@@ -11,6 +11,9 @@ type Action = {
 } | {
     type: 'GET_ACCESS_TOKEN_COMPLETE';
     user?: TIDUser;
+} | {
+    type: 'GET_TOKENS_COMPLETE';
+    user?: TIDUser;
 } | {
     type: 'HANDLE_CALLBACK_COMPLETE';
     user?: TIDUser;

package/dist/TIDProvider/useAuth.d.ts

@@ -4,6 +4,7 @@ import { TIDContextState } from './TIDContext';
  * Functions and properties available:
  * * handleCallback
  * * getAccessTokenSilently
+ * * getTokens
  * * loginWithRedirect
  * * logout
  * * isAuthenticated

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { TIDClient } from './TIDClient';
 export { TIDContext, useAuth, TIDProvider } from './TIDProvider';
 export { AuthenticationGuard } from './AuthenticationGuard/AuthenticationGuard';
+export type { TokenResponse } from './TIDClient';
 export type { PersistentStore } from './TIDClient';