@opencampus/ocid-connect-js 2.0.3 → 2.0.5

package/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [v2.0.5] - 2025-11-06
+### Changed
+- Add option to send email to login process.
+
+## [v2.0.3] - 2025-04-29
+### Changed
+- Allow overriding state in LoginButton
+
+## [v2.0.2] - 2025-04-28
+### Changed
+- Update for React v19
+
+## [v2.0.1] - 2025-04-03
+### Changed
+- Add optional storage key override to allow overlap cookie domain to distinguish their own storage states.
+
+## [v2.0.0] - 2025-03-28
+### Changed
+- Authentication Client Id.
+- New updated spinner while waiting for token exchange.
+
+## [v1.2.3] - 2024-11-04
+### Changed
+- Add logoutReturnTo as an optional parameter to logout method so users can instruct OC Service to return to a designation url after logging out.
+
+## [v1.2.2] - 2024-10-16
+### Changed
+- Add new properties to OCAuthCore:
+    - OCId
+    - ethAddress
+    - State parameters (from signup process)
+
+## [v1.2.1] - 2024-10-03
+### Changed
+- Add methods to access parsed data from idToken and accessToken
+
+## [v1.2.0] - 2024-09-22
+### Added
+- Add logout function to instruct OC to log user out of OC Service
+
+## [v1.1.2] - 2024-08-28
+### Changed
+- Add option to send referral code to registration process.
+- Referral code is used in OpenCampus for bonus points.
+
+## [v1.1.0] - 2024-08-22
+### Added
+- Improved cross-domain storage handling
+- Implemented cookie-based storage option:
+  - Added `storageType: 'cookie'` option
+  - Added `cookieDomain` configuration for domain specification
+
+## [v1.0.1] - 2024-08-06
+### Added
+- Initial release

package/README.md

@@ -15,6 +15,10 @@ You **do not need a Client ID when testing integration in Sandbox mode**. Sandbo
 
 > If you were onboarded to live integration before Apr 2025 and did not have an Open Campus Developer Account, you would **need to** use the V1.x SDK. Please get in touch with your Open Campus point of contact to get your Open Campus Developer Account and migrate to the V2 SDK. Thanks!
 
+## Remark for sandbox mode
+
+If your OCID is signed up through sandbox mode, your OCID will not be properly initialized in our system until you log in to https://id.sandbox.opencampus.xyz/.
+
 ## Setup
 
 **yarn**

package/dist/ocid-connect-js.js

@@ -430,8 +430,8 @@ var LoginCallBack = function LoginCallBack(_ref) {
 __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(3);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(react__WEBPACK_IMPORTED_MODULE_0__);
-/* harmony import */ var _OCSpinner_css__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(7);
-/* harmony import */ var _OCSpinner_css__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(_OCSpinner_css__WEBPACK_IMPORTED_MODULE_1__);
+/* harmony import */ var _OCSpinner_module_css__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(7);
+/* harmony import */ var _OCSpinner_module_css__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(_OCSpinner_module_css__WEBPACK_IMPORTED_MODULE_1__);
 /*!
  * Copyright 2024-Present Animoca Brands Corporation Ltd.
  *
@@ -1114,7 +1114,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 
 
 var OCAuthCore = /*#__PURE__*/function () {
-  function OCAuthCore(clientId, loginEndpoint, redirectUri, transactionManager, tokenManager, referralCode, logoutEndPoint) {
+  function OCAuthCore(clientId, loginEndpoint, redirectUri, transactionManager, tokenManager, referralCode, logoutEndPoint, emailPlaceholder) {
     _classCallCheck(this, OCAuthCore);
     _defineProperty(this, "clientId", void 0);
     _defineProperty(this, "tokenManager", void 0);
@@ -1124,6 +1124,7 @@ var OCAuthCore = /*#__PURE__*/function () {
     _defineProperty(this, "loginEndPoint", void 0);
     _defineProperty(this, "logoutEndPoint", void 0);
     _defineProperty(this, "referralCode", void 0);
+    _defineProperty(this, "emailPlaceholder", void 0);
     if (!clientId) {
       throw new _utils_errors__WEBPACK_IMPORTED_MODULE_6__["InvalidParamsError"]('clientId is not defined');
     }
@@ -1134,6 +1135,7 @@ var OCAuthCore = /*#__PURE__*/function () {
     this.logoutEndPoint = logoutEndPoint;
     this.redirectUri = redirectUri;
     this.referralCode = referralCode;
+    this.emailPlaceholder = emailPlaceholder;
     this.clientId = clientId;
     this.syncAuthInfo();
   }
@@ -1188,9 +1190,10 @@ var OCAuthCore = /*#__PURE__*/function () {
               meta = Object(_utils__WEBPACK_IMPORTED_MODULE_4__["createPkceMeta"])(signinParams);
               this.transactionManager.save(meta);
               signinParams.referralCode = this.referralCode;
+              signinParams.emailPlaceholder = this.emailPlaceholder;
               requestUrl = Object(_endpoints__WEBPACK_IMPORTED_MODULE_5__["buildAuthEndpointUrl"])(signinParams, this.loginEndPoint);
               window.location.assign(requestUrl);
-            case 11:
+            case 12:
             case "end":
               return _context2.stop();
           }
@@ -1328,7 +1331,8 @@ var OCAuthLive = /*#__PURE__*/function (_OCAuthCore2) {
       overridePublicKey = opts.publicKey,
       redirectUri = opts.redirectUri,
       referralCode = opts.referralCode,
-      clientId = opts.clientId;
+      clientId = opts.clientId,
+      emailPlaceholder = opts.emailPlaceholder;
     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';
@@ -1336,7 +1340,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, [clientId, loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
+    return _callSuper(this, OCAuthLive, [clientId, loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint, emailPlaceholder]);
   }
   _inherits(OCAuthLive, _OCAuthCore2);
   return _createClass(OCAuthLive);
@@ -1350,7 +1354,8 @@ var OCAuthSandbox = /*#__PURE__*/function (_OCAuthCore3) {
       overrideLogoutEndpoint = opts.logoutEndPoint,
       overridePublicKey = opts.publicKey,
       redirectUri = opts.redirectUri,
-      referralCode = opts.referralCode;
+      referralCode = opts.referralCode,
+      emailPlaceholder = opts.emailPlaceholder;
     var clientId = opts.clientId || 'sandbox';
     var tokenEndpoint = overrideTokenEndpoint || 'https://api.login.sandbox.opencampus.xyz/auth/token';
     var loginEndpoint = overrideLoginEndpoint || 'https://api.login.sandbox.opencampus.xyz/auth/login';
@@ -1359,7 +1364,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, [clientId, loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint]);
+    return _callSuper(this, OCAuthSandbox, [clientId, loginEndpoint, redirectUri, pkceTransactionManager, tokenManager, referralCode, logoutEndpoint, emailPlaceholder]);
   }
   _inherits(OCAuthSandbox, _OCAuthCore3);
   return _createClass(OCAuthSandbox);
@@ -2684,6 +2689,11 @@ var buildAuthEndpointUrl = function buildAuthEndpointUrl(signInParams, loginEndP
   if (signInParams.referralCode) {
     loginUrl.searchParams.append('ref', signInParams.referralCode);
   }
+
+  // email data for register workflow
+  if (signInParams.emailPlaceholder) {
+    loginUrl.searchParams.append('emailPlaceholder', signInParams.emailPlaceholder);
+  }
   return loginUrl.href;
 };