@opencampus/ocid-connect-js 1.2.2 → 1.2.5

package/README.md

@@ -104,15 +104,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 +289,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>;
   }

package/dist/ocid-connect-js.js

@@ -358,6 +358,7 @@ var LoginCallBack = function LoginCallBack(_ref) {
     customErrorComponent = _ref.customErrorComponent,
     customLoadingComponent = _ref.customLoadingComponent;
   var _useOCAuth = Object(_OCContext__WEBPACK_IMPORTED_MODULE_1__["useOCAuth"])(),
+    isInitialized = _useOCAuth.isInitialized,
     ocAuth = _useOCAuth.ocAuth,
     authState = _useOCAuth.authState,
     setAuthError = _useOCAuth.setAuthError;
@@ -399,7 +400,7 @@ var LoginCallBack = function LoginCallBack(_ref) {
       handleLogin();
     }
   }, [ocAuth]);
-  if (authState.error !== undefined && !errorCallback) {
+  if (isInitialized && authState.error !== undefined && !errorCallback) {
     return customErrorComponent ? customErrorComponent : /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_0___default.a.createElement("div", null, "Error Logging in: ", authState.error.message);
   } else {
     return customLoadingComponent ? customLoadingComponent : /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_0___default.a.createElement("div", null, /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_0___default.a.createElement("h3", null, "Loading ......"));
@@ -439,7 +440,7 @@ var OCConnect = function OCConnect(_ref) {
   var children = _ref.children,
     opts = _ref.opts,
     sandboxMode = _ref.sandboxMode;
-  var _useState = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])({}),
+  var _useState = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])(),
     _useState2 = _slicedToArray(_useState, 2),
     ocAuth = _useState2[0],
     setOcAuth = _useState2[1];
@@ -451,16 +452,18 @@ var OCConnect = function OCConnect(_ref) {
     _useState6 = _slicedToArray(_useState5, 2),
     ethAddress = _useState6[0],
     setEthAddress = _useState6[1];
-  var _useState7 = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])({
-      isAuthenticated: false
-    }),
+  var _useState7 = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])(),
     _useState8 = _slicedToArray(_useState7, 2),
     authState = _useState8[0],
     setAuthState = _useState8[1];
-  var _useState9 = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])(null),
+  var _useState9 = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])(false),
     _useState10 = _slicedToArray(_useState9, 2),
-    authError = _useState10[0],
-    setAuthError = _useState10[1];
+    isInitialized = _useState10[0],
+    setIsInitialized = _useState10[1];
+  var _useState11 = Object(react__WEBPACK_IMPORTED_MODULE_0__["useState"])(null),
+    _useState12 = _slicedToArray(_useState11, 2),
+    authError = _useState12[0],
+    setAuthError = _useState12[1];
   var updateAuthState = function updateAuthState(authState) {
     setAuthState(authState);
     setOCId(authState.OCId);
@@ -472,9 +475,10 @@ var OCConnect = function OCConnect(_ref) {
     var authSdk = sandboxMode ? new _sdk_auth__WEBPACK_IMPORTED_MODULE_2__["OCAuthSandbox"](opts) : new _sdk_auth__WEBPACK_IMPORTED_MODULE_2__["OCAuthLive"](opts);
     updateAuthState(authSdk.getAuthState());
     setOcAuth(authSdk);
+    setIsInitialized(true);
   }, []);
   Object(react__WEBPACK_IMPORTED_MODULE_0__["useEffect"])(function () {
-    if (ocAuth.authInfoManager) {
+    if (ocAuth && ocAuth.authInfoManager) {
       // reactively recieve update on the authstate change
       ocAuth.authInfoManager.subscribe(updateAuthState);
       return function () {
@@ -489,6 +493,7 @@ var OCConnect = function OCConnect(_ref) {
       ocAuth: ocAuth,
       authState: authState,
       authError: authError,
+      isInitialized: isInitialized,
       setAuthError: setAuthError
     }
   }, children);
@@ -572,21 +577,24 @@ var OCAuthCore = /*#__PURE__*/function () {
   }, {
     key: "logout",
     value: function () {
-      var _logout = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-        var requestUrl;
+      var _logout = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(logoutReturnTo) {
+        var url;
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               this.clearStorage();
-              requestUrl = this.logoutEndPoint;
-              window.location.assign(requestUrl);
-            case 3:
+              url = new URL(this.logoutEndPoint);
+              if (logoutReturnTo) {
+                url.searchParams.append('returnTo', logoutReturnTo);
+              }
+              window.location.assign(url.toString());
+            case 4:
             case "end":
               return _context.stop();
           }
         }, _callee, this);
       }));
-      function logout() {
+      function logout(_x) {
         return _logout.apply(this, arguments);
       }
       return logout;
@@ -618,7 +626,7 @@ var OCAuthCore = /*#__PURE__*/function () {
           }
         }, _callee2, this);
       }));
-      function signInWithRedirect(_x) {
+      function signInWithRedirect(_x2) {
         return _signInWithRedirect.apply(this, arguments);
       }
       return signInWithRedirect;
@@ -679,7 +687,7 @@ var OCAuthCore = /*#__PURE__*/function () {
         var _this$getParsedIdToke = this.getParsedIdToken(),
           edu_username = _this$getParsedIdToke.edu_username,
           eth_address = _this$getParsedIdToke.eth_address;
-        this.authInfoManager.setAuthState(this.getAccessToken(), this.getIdToken(), edu_username, eth_address, this.isAuthenticated());
+        this.authInfoManager.setAuthState(this.getAccessToken(), this.getIdToken(), edu_username, eth_address, true);
       }
     }
   }, {
@@ -757,7 +765,7 @@ var OCAuthLive = /*#__PURE__*/function (_OCAuthCore2) {
     var storageClass = Object(_lib_StorageManager__WEBPACK_IMPORTED_MODULE_3__["getStorageClass"])(opts);
     var pkceTransactionManager = new _lib_TransactionManager__WEBPACK_IMPORTED_MODULE_2__["default"](storageClass);
     var tokenManager = new _lib_TokenManager__WEBPACK_IMPORTED_MODULE_1__["default"](storageClass, tokenEndpoint, publicKey);
-    return _callSuper(this, OCAuthLive, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
+    return _callSuper(this, OCAuthLive, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint, false]);
   }
   _inherits(OCAuthLive, _OCAuthCore2);
   return _createClass(OCAuthLive);
@@ -771,7 +779,8 @@ var OCAuthSandbox = /*#__PURE__*/function (_OCAuthCore3) {
       overrideLogoutEndpoint = opts.logoutEndPoint,
       overridePublicKey = opts.publicKey,
       redirectUri = opts.redirectUri,
-      referralCode = opts.referralCode;
+      referralCode = opts.referralCode,
+      mode = opts.mode;
     var tokenEndpoint = overrideTokenEndpoint || 'https://api.login.sandbox.opencampus.xyz/auth/token';
     var loginEndpoint = overrideLoginEndpoint || 'https://api.login.sandbox.opencampus.xyz/auth/login';
     var logoutEndpoint = overrideLogoutEndpoint || 'https://api.login.sandbox.opencampus.xyz/auth/logout';
@@ -779,7 +788,7 @@ var OCAuthSandbox = /*#__PURE__*/function (_OCAuthCore3) {
     var storageClass = Object(_lib_StorageManager__WEBPACK_IMPORTED_MODULE_3__["getStorageClass"])(opts);
     var pkceTransactionManager = new _lib_TransactionManager__WEBPACK_IMPORTED_MODULE_2__["default"](storageClass);
     var tokenManager = new _lib_TokenManager__WEBPACK_IMPORTED_MODULE_1__["default"](storageClass, tokenEndpoint, publicKey);
-    return _callSuper(this, OCAuthSandbox, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
+    return _callSuper(this, OCAuthSandbox, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint, true]);
   }
   _inherits(OCAuthSandbox, _OCAuthCore3);
   return _createClass(OCAuthSandbox);
@@ -839,7 +848,10 @@ var AuthInfoManager = /*#__PURE__*/function () {
   }, {
     key: "clear",
     value: function clear() {
-      this._authState = null;
+      this._authState = {
+        isAuthenticated: false
+      };
+      this._emitter.emit(EVENT_AUTH_STATE_CHANGE, this._authState);
     }
   }, {
     key: "subscribe",