@trimble-oss/trimble-id-react 0.1.1 → 1.0.0-rc.2

package/README.md

@@ -16,7 +16,7 @@ npm install @trimble-oss/trimble-id-react
 
 ### Configure Trimble Identity
 
-Create a new application in the [Trimble Developer Console](https://developer.console.trimble.com) portal and configure the following settings:
+Create a new application in the [Trimble Developer Console](https://console.trimble.com) portal and configure the following settings:
 
 To register your application in Trimble Developer Console:
 
@@ -75,14 +75,13 @@ After wrapping your app with the TIDProvider, you have to configure the TID cred
         redirectUrl: "http://localhost:3000/callback",
         logoutRedirectUrl: "http://localhost:3000/logout-callback",
         scopes: ['test']
-    },
-    persistentOptions: {
-      persistentStore: "localStorage"
-  }
+    }
   })} onRedirectCallback={handleRedirect}>
     <Component/>
 </TIDProvider>
 ```
+> **_NOTE:_** Tokens are stored in the browser's memory, as it is considered the most secure option.
+
 **2.** You can send the properties directly
 
 ```tsx
@@ -92,7 +91,6 @@ After wrapping your app with the TIDProvider, you have to configure the TID cred
     redirectUrl={"http://localhost:3000/callback"}
     logoutRedirectUrl={"http://localhost:3000/logout-callback"}
     scopes={['test']}
-    persistentStore ={"localStorage"}
     onRedirectCallback={handleRedirect}>
         <Component/>
 </TIDProvider>
@@ -108,14 +106,12 @@ Production: https://id.trimble.com/.well-known/openid-configuration  <br />
 * **logoutRedirectUrl** : The URL to which Trimble Identity should redirect after successfully logout a user
 * **scopes** :  The type of credentials you want (openID, or application_name)
 
-### 2. PersistentOptions configuration
-Type of persistence you want the user and token to be store
-   * **in-memory** - This one will only persist will the user stays in the page. By default, persistence will be in-memory.
-   * **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. 
+> **_NOTE:_** 
+> 
+> As of version 1.0.0, PersistentOptions have been removed. By default, the SDK now supports in-memory token storage. Using localStorage and sessionStorage for storing sensitive information poses several security risks, including vulnerability to XSS attacks, lack of secure attributes and session hijacking. 
 
+> When you upgrade to version 1.x, storage options will no longer be available, resulting in a breaking change. For those using an older version of the SDK (i.e., <1.x), it is highly recommended to use the default in-memory storage to avoid any security issues.
 ### useAuth
 Use the `useAuth` hook in your components to access authentication state (`isLoading`, `isAuthenticated`, `user`, `error`) and authentication methods (`loginWithRedirect` and `logout`):
 
@@ -126,7 +122,6 @@ Redirect the user to TID using the browser
 ```tsx
 const {loginWithRedirect}= useAuth()
 await loginWithRedirect()
-
 ```
 
 ### logout
@@ -193,9 +188,8 @@ var error = error.message
 It renders a component if the user is authenticated, otherwise redirects the user to the login page. It can be used to protect private components. If the user is not authenticated, they will be redirected to the login page.
 
 ```tsx
-<AuthenticationGuard renderComponent={() => <MyPrivateComponent/>}/>
+<AuthenticationGuard renderComponent={<MyPrivateComponent/>}/>
 ```
-
 > **_NOTE:_** Refer samples for better understanding.
 
 ## Sample Code

package/dist/TIDClient/TIDClient.d.ts

@@ -1,5 +1,4 @@
 import { BearerTokenHttpClientProvider } from '@trimble-oss/trimble-id';
-import { PersistentStore } from './storage/cache-storage/CacheManager';
 import { AuthState, TIDUser, TokenResponse } from './interfaces';
 interface TIDClientConfig {
     /**
@@ -38,19 +37,6 @@ interface LoginWithRedirectOptions {
      */
     onRedirect?: (url: string) => void;
 }
-interface PersistentOptions {
-    /**
-     * Type of persistent store you want the user and token to be stored
-     *
-     * in-memory - This one will only persist will the user stays in the page
-     *
-     * localStorage - This persistent doesn't have expiration date
-     *
-     * sessionStorage - This one is cleared when the page session ends
-     * @type {PersistentStore}
-     */
-    persistentStore: PersistentStore;
-}
 interface LogoutOptions {
     /**
      * Function called when the user redirection is occurring
@@ -77,11 +63,6 @@ export interface TIDClientOptions {
      * @type {TIDClientConfig}
      */
     config: TIDClientConfig;
-    /**
-     * Persistent options configuration
-     * @type {PersistentOptions}
-     */
-    persistentOptions?: PersistentOptions;
 }
 export declare class TIDClient {
     /**

package/dist/TIDClient/index.d.ts

@@ -1,5 +1,3 @@
-import { PersistentStore as PS } from './storage/cache-storage/CacheManager';
 export * from './interfaces';
 export * from './TIDClient';
 export * from './utils';
-export type PersistentStore = PS;

package/dist/TIDClient/interfaces.d.ts

@@ -45,58 +45,18 @@ export interface TIDUser {
     given_name?: string;
     /** Surname(s) or last name(s) of the End-User */
     family_name?: string;
-    /** Middle name(s) of the End-User */
-    middle_name?: string;
-    /** Casual name of the End-User that may or may not be the same as the given_name. */
-    nickname?: string;
-    /** Shorthand name that the End-User wishes to be referred to at the RP, such as janedoe or j.doe. */
-    preferred_username?: string;
-    /** URL of the End-User's profile page */
-    profile?: string;
     /** URL of the End-User's profile picture */
     picture?: string;
-    /** URL of the End-User's Web page or blog */
-    website?: string;
     /** End-User's preferred e-mail address */
     email?: string;
     /** True if the End-User's e-mail address has been verified; otherwise false. */
     email_verified?: boolean;
-    /** End-User's gender. Values defined by this specification are female and male. */
-    gender?: string;
-    /** End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format */
-    birthdate?: string;
-    /** String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. */
-    zoneinfo?: string;
-    /** End-User's locale, represented as a BCP47 [RFC5646] language tag. */
-    locale?: string;
-    /** End-User's preferred telephone number. */
-    phone_number?: string;
-    /** True if the End-User's phone number has been verified; otherwise false. */
-    phone_number_verified?: boolean;
-    /** object    End-User's preferred address in JSON [RFC4627] */
-    address?: OidcAddress;
-    /** Time the End-User's information was last updated. */
-    updated_at?: number;
-}
-interface OidcAddress {
-    /** Full mailing address, formatted for display or use on a mailing label */
-    formatted?: string;
-    /** Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information */
-    street_address?: string;
-    /** City or locality component */
-    locality?: string;
-    /** State, province, prefecture, or region component */
-    region?: string;
-    /** Zip code or postal code component */
-    postal_code?: string;
-    /** Country name component */
-    country?: string;
 }
 export interface TIDJWTUser {
     /**
      * The issuer of a token
      * Prod: https://id.trimble.com
-     * Stage: https://state.id.trimblecloud.com
+     * Stage: https://stage.id.trimblecloud.com
      * @type {string}
      */
     iss: string;
@@ -216,4 +176,3 @@ export interface TIDJWTUser {
 export interface AuthState {
     authState: any;
 }
-export {};

package/dist/TIDClient/storage/cache-storage/CacheManager.d.ts

@@ -1,45 +1,12 @@
 import { TIDAuthToken, TIDUser } from '../../interfaces';
-export type PersistentStore = 'in-memory' | 'localStorage' | 'sessionStorage';
-export interface CacheManagerOptions {
-    /**
-     * Client id of the application created in trimble developer console
-     * @type {string}
-     */
-    clientId: string;
-    /**
-     * Type persistent you want the user and token to be store
-     * in-memory - This one will only persist will the user stays in the page
-     * localStorage - This persistent doesn't have expiration date
-     * sessionStorage - This one is cleared when the page session ends
-     * @type {PersistentStore}
-     */
-    persistentStore: PersistentStore;
-}
 /** Class to manage the store types */
 export declare class CacheManager {
-    /**
-     * Type persistent you want the user and token to be store
-     * in-memory - This one will only persist will the user stays in the page
-     * localStorage - This persistent doesn't have expiration date
-     * sessionStorage - This one is cleared when the page session ends
-     * @type {PersistentStore}
-     */
-    private readonly persistentStore;
     /**
      * Cache option selected
      * @type {CacheStorage}
      */
     private readonly cacheStorage;
-    /**
-     * The cache key represents the keys for storing and retrieving user and token from auth
-     * @type {CacheKey}
-     */
-    private readonly cacheKey;
-    /**
-     * Create a cache manager to extract or save the user, and token
-     * @param {CacheManagerOptions} options - Configuration for the managing the caching
-     */
-    constructor(options: CacheManagerOptions);
+    constructor();
     /**
      * Store token in cache
      * @param {TIDAuthToken} token - Token that you want to store in cache

package/dist/TIDProvider/TIDProvider.d.ts

@@ -1,5 +1,5 @@
 import React, { PropsWithChildren } from 'react';
-import { TIDClient, PersistentStore, AuthState } from '../TIDClient';
+import { TIDClient, AuthState } from '../TIDClient';
 export interface TIDProviderProps extends PropsWithChildren {
     /**
      * The URL for the Trimble Identity OpenID well known configuration endpoint
@@ -28,14 +28,6 @@ export interface TIDProviderProps extends PropsWithChildren {
      * @type {string[]}
      */
     scopes?: string[];
-    /**
-     * Type persistent you want the user and token to be store
-     * in-memory - This one will only persist will the user stays in the page
-     * localStorage - This persistent doesn't have expiration date
-     * sessionStorage - This one is cleared when the page session ends
-     * @type {PersistentStore}
-     */
-    persistentStore?: PersistentStore;
     /**
      * TID client instance. You can send an instance of the TID Client
      * if you want to handle the initialization yourself

package/dist/index.d.ts

@@ -2,4 +2,3 @@ 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';