@opencampus/ocid-connect-js 1.1.1 → 1.2.0

package/README.md

@@ -34,6 +34,7 @@ import { OCConnect } from '@opencampus/ocid-connect-js';
 
 const opts = {
     redirectUri: 'http://localhost:3001/redirect',
+    referralCode: 'PARTNER6'
 }
 
 return (
@@ -57,6 +58,7 @@ Opts Property
 | Property | Description |
 | --- | --- |
 | redirectUri | URL to return after the login process is completed |
+| referralCode | Unique identifiers assigned to partners for tracking during OCID account's registration. |
 
 Setup LoginCallBack to handle flow's result
 
@@ -176,6 +178,7 @@ export default function RootLayout({
 }) {
   const opts = {
     redirectUri: 'http://localhost:3000/redirect', // Adjust this URL
+    referralCode: 'PARTNER6', // Assign partner code
   };
 
   return (
@@ -349,6 +352,7 @@ The login flow adhere with PKCE standard. The following params will be prepared
 | scope | only support 'openid' at the moment |
 | code_challenge | adhere with PKCE standard |
 | code_challenge_method | Only S256 is supported at the moment |
+| ref | Unique identifiers assigned to partners for tracking during user registration |
 
 Sample usage to handle login response
 

package/dist/ocid-connect-js.js

@@ -541,18 +541,22 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 
 
 var OCAuthCore = /*#__PURE__*/function () {
-  function OCAuthCore(loginEndpoint, redirectUri, transactionManager, tokenManager) {
+  function OCAuthCore(loginEndpoint, redirectUri, transactionManager, tokenManager, referralCode, logoutEndPoint) {
     _classCallCheck(this, OCAuthCore);
     _defineProperty(this, "tokenManager", void 0);
     _defineProperty(this, "authInfoManager", void 0);
     _defineProperty(this, "transactionManager", void 0);
     _defineProperty(this, "redirectUri", void 0);
     _defineProperty(this, "loginEndPoint", void 0);
+    _defineProperty(this, "logoutEndPoint", void 0);
+    _defineProperty(this, "referralCode", void 0);
     this.transactionManager = transactionManager;
     this.tokenManager = tokenManager;
     this.authInfoManager = new _lib_AuthInfoManager__WEBPACK_IMPORTED_MODULE_0__["default"]();
     this.loginEndPoint = loginEndpoint;
+    this.logoutEndPoint = logoutEndPoint;
     this.redirectUri = redirectUri;
+    this.referralCode = referralCode;
     this.syncAuthInfo();
   }
   return _createClass(OCAuthCore, [{
@@ -562,30 +566,53 @@ var OCAuthCore = /*#__PURE__*/function () {
       this.tokenManager.clear();
     }
   }, {
-    key: "signInWithRedirect",
+    key: "logout",
     value: function () {
-      var _signInWithRedirect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(params) {
-        var paramsClone, signinParams, meta, requestUrl;
+      var _logout = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+        var requestUrl;
         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:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function logout() {
+        return _logout.apply(this, arguments);
+      }
+      return logout;
+    }()
+  }, {
+    key: "signInWithRedirect",
+    value: function () {
+      var _signInWithRedirect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(params) {
+        var paramsClone, signinParams, meta, requestUrl;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
               // we use ONLY code flow with PKCE, so lacks a lot of options
               // available in other OAuth SDKs.
               paramsClone = Object.assign({}, params);
               paramsClone.redirectUri = this.redirectUri;
-              _context.next = 4;
+              _context2.next = 4;
               return Object(_utils__WEBPACK_IMPORTED_MODULE_4__["prepareTokenParams"])(paramsClone);
             case 4:
-              signinParams = _context.sent;
+              signinParams = _context2.sent;
               meta = Object(_utils__WEBPACK_IMPORTED_MODULE_4__["createPkceMeta"])(signinParams);
               this.transactionManager.save(meta);
+              signinParams.referralCode = this.referralCode;
               requestUrl = Object(_endpoints__WEBPACK_IMPORTED_MODULE_5__["buildAuthEndpointUrl"])(signinParams, this.loginEndPoint);
               window.location.assign(requestUrl);
-            case 9:
+            case 10:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this);
+        }, _callee2, this);
       }));
       function signInWithRedirect(_x) {
         return _signInWithRedirect.apply(this, arguments);
@@ -595,38 +622,38 @@ var OCAuthCore = /*#__PURE__*/function () {
   }, {
     key: "handleLoginRedirect",
     value: function () {
-      var _handleLoginRedirect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+      var _handleLoginRedirect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
         var urlParams, meta, codeVerifier;
-        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
               urlParams = Object(_utils__WEBPACK_IMPORTED_MODULE_4__["parseUrl"])(); // Again we only handle PKCE code flow
               if (!urlParams.code) {
-                _context2.next = 13;
+                _context3.next = 13;
                 break;
               }
               meta = this.transactionManager.getTransactionMeta();
               codeVerifier = meta.codeVerifier;
               if (!codeVerifier) {
-                _context2.next = 12;
+                _context3.next = 12;
                 break;
               }
-              _context2.next = 7;
+              _context3.next = 7;
               return this.tokenManager.exchangeTokenFromCode(urlParams.code, codeVerifier);
             case 7:
               // clear transaction meta, coz it's completed
               this.transactionManager.clear();
               this.syncAuthInfo();
-              return _context2.abrupt("return", this.getAuthState());
+              return _context3.abrupt("return", this.getAuthState());
             case 12:
               throw new _utils_errors__WEBPACK_IMPORTED_MODULE_6__["AuthError"]('codeVerifier not found, cannot complete flow');
             case 13:
-              return _context2.abrupt("return", {});
+              return _context3.abrupt("return", {});
             case 14:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
-        }, _callee2, this);
+        }, _callee3, this);
       }));
       function handleLoginRedirect() {
         return _handleLoginRedirect.apply(this, arguments);
@@ -690,15 +717,18 @@ var OCAuthLive = /*#__PURE__*/function (_OCAuthCore2) {
     _classCallCheck(this, OCAuthLive);
     var overrideTokenEndpoint = opts.tokenEndPoint,
       overrideLoginEndpoint = opts.loginEndPoint,
+      overrideLogoutEndpoint = opts.logoutEndPoint,
       overridePublicKey = opts.publicKey,
-      redirectUri = opts.redirectUri;
+      redirectUri = opts.redirectUri,
+      referralCode = opts.referralCode;
     var tokenEndpoint = overrideTokenEndpoint || 'https://api.login.opencampus.xyz/auth/token';
     var loginEndpoint = overrideLoginEndpoint || 'https://api.login.opencampus.xyz/auth/login';
+    var logoutEndpoint = overrideLogoutEndpoint || 'https://api.login.opencampus.xyz/auth/logout';
     var publicKey = overridePublicKey || LIVE_PUBLIC_KEY;
     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]);
+    return _callSuper(this, OCAuthLive, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
   }
   _inherits(OCAuthLive, _OCAuthCore2);
   return _createClass(OCAuthLive);
@@ -709,15 +739,18 @@ var OCAuthSandbox = /*#__PURE__*/function (_OCAuthCore3) {
     _classCallCheck(this, OCAuthSandbox);
     var overrideTokenEndpoint = opts.tokenEndPoint,
       overrideLoginEndpoint = opts.loginEndPoint,
+      overrideLogoutEndpoint = opts.logoutEndPoint,
       overridePublicKey = opts.publicKey,
-      redirectUri = opts.redirectUri;
+      redirectUri = opts.redirectUri,
+      referralCode = opts.referralCode;
     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';
     var publicKey = overridePublicKey || SANDBOX_PUBLIC_KEY;
     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]);
+    return _callSuper(this, OCAuthSandbox, [loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
   }
   _inherits(OCAuthSandbox, _OCAuthCore3);
   return _createClass(OCAuthSandbox);
@@ -1691,13 +1724,17 @@ var CookieStorageProvider = /*#__PURE__*/function () {
     value: function setItem(key, value) {
       return js_cookie__WEBPACK_IMPORTED_MODULE_0___default.a.set(key, value, {
         expires: 365,
+        path: '/',
         domain: this.domain
       });
     }
   }, {
     key: "removeItem",
     value: function removeItem(key) {
-      return js_cookie__WEBPACK_IMPORTED_MODULE_0___default.a.remove(key);
+      return js_cookie__WEBPACK_IMPORTED_MODULE_0___default.a.remove(key, {
+        path: '/',
+        domain: this.domain
+      });
     }
   }]);
 }();
@@ -1901,6 +1938,11 @@ var buildAuthEndpointUrl = function buildAuthEndpointUrl(signInParams, loginEndP
   if (signInParams.state !== undefined) {
     loginUrl.searchParams.append('state', signInParams.state);
   }
+
+  // reference data for register workflow
+  if (signInParams.referralCode) {
+    loginUrl.searchParams.append('ref', signInParams.referralCode);
+  }
   return loginUrl.href;
 };