@opencampus/ocid-connect-js 1.2.3 → 1.2.6

package/README.md

@@ -59,6 +59,8 @@ Opts Property
 | --- | --- |
 | redirectUri | URL to return after the login process is completed |
 | referralCode | Unique identifiers assigned to partners for tracking during OCID account's registration. |
+| domain | Domain to store cookie. Leave it blank to tell the browser to use the current domain |
+| sameSite | Specify the SameSite behavior when using cookie as storage. When `true` - SameSite: strict; when `false` - SameSite: None, when not set - default SameSite behavior browser dependent |
 
 Setup LoginCallBack to handle flow's result
 
@@ -104,15 +106,21 @@ export default function CustomLoadingComponent ()
 />
 ```
 
-Use useOCAuth hook to read credentials info
+1. useOCAuth is a hook that provides credentials (authentication information)
+2. Before using any information from this hook, we need to check isInitialized flag
+3. This is because there's a setup/initialization period where the SDK (software development kit) is getting ready
+
+Here's an example of how it would work:
 
 ```js
 import { useOCAuth } from '@opencampus/ocid-connect-js';
 
 const UserTokenPage = (props) => {
-    const { authState, ocAuth, OCId, ethAddress } = useOCAuth();
+    const { isInitialized, authState, ocAuth, OCId, ethAddress } = useOCAuth();
 
-    if (authState.error !== undefined) {
+    if (!isInitialized) {
+        return <div>Loading...</div>;
+    } else if (authState.error !== undefined) {
         return <div>Error: {authState.error.message}</div>;
     } else {
         return (
@@ -283,10 +291,6 @@ import { useOCAuth } from '@opencampus/ocid-connect-js';
 export default function Home() {
   const { authState, ocAuth } = useOCAuth();
 
-  useEffect(() => {
-    console.log(authState);
-  }, [authState]); // Now it will log whenever authState changes
-
   if (authState.error) {
     return <div>Error: {authState.error.message}</div>;
   }