wealthica-sdk-js 0.0.17 → 0.0.19

package/README.md

@@ -165,7 +165,7 @@ token = await user.getToken(); // fetches and returns a new token
 token = await user.getToken({ minimumLifeTime: 600 }); // fetches and returns another new token
 ```
 
-#### user.getConnectData({ provider, redirectURI, state, lang, theme, providersPerLine })
+#### user.getConnectData({ provider, redirectURI, state, lang, theme, providersPerLine, webhookURI })
 
 This method returns a Wealthica Connect URL and authentication token for user to connect an institution.
 
@@ -192,6 +192,7 @@ const { url, token } = await user.getConnectData({
   theme: 'light', // optional (light | dark), 'light' by default
   providersPerLine: 1, // optional (1 | 2), 2 by default
   features: 'feature1,feature2', // optional, a comma-separated list of features. undefined by default
+  webhookURI: 'YOUR_WEBHOOK_URI', // optional, URL to receive webhook notifications (must be HTTPS)
 });
 // {
 //   url: "https://connect.wealthica.com/connect/coinbase?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&origin=YOUR_SITE_ORIGIN&state=YOUR_APP_STATE&lang=en&theme=light&providersPerLine=2",
@@ -227,7 +228,7 @@ const user2 = wealthica.login('USER_ID_2');
 const { url: url2, token } = await user2.getConnectData();
 ```
 
-#### user.connect({ provider, providers, institutionId, lang, theme, providersPerLine, features, origin })
+#### user.connect({ provider, providers, institutionId, lang, theme, providersPerLine, features, origin, webhookURI })
 
 This method starts the Wealthica Connect process inside your webpage/app for user to connect their institution.
 
@@ -238,6 +239,7 @@ This method accepts the same parameters as `user.getConnectData()` except for `r
 ```javascript
 user.connect({
   // additional options
+  webhookURI: 'YOUR_WEBHOOK_URI', // optional, URL to receive webhook notifications (must be HTTPS)
 }).onConnection((institution, data) => {
   console.log('provider', data.provider);
   // Send the institution to your server
@@ -249,7 +251,7 @@ user.connect({
 });
 ```
 
-#### user.reconnect(institutionId)
+#### user.reconnect(institutionId, { lang, theme, features, origin, webhookURI })
 
 This method starts the Wealthica Connect process to re-connect an existing institution that has expired/revoked credentials.
 
@@ -258,6 +260,7 @@ Connection response are provided via callbacks.
 ```javascript
 user.reconnect('INSTITUTION_ID', {
   // additional options
+  webhookURI: 'YOUR_WEBHOOK_URI', // optional, URL to receive webhook notifications (must be HTTPS)
 }).onConnection(((institution, data) => {
   console.log('provider', data.provider);
   // Send the institution to your server
@@ -269,6 +272,49 @@ user.reconnect('INSTITUTION_ID', {
 });
 ```
 
+### Feature Flags
+
+The `features` parameter accepts a comma-separated list of feature flags to enable specific behaviors in the Connect widget.
+
+#### Available Feature Flags
+
+**`quick_retry`** *(Available from v0.0.19+)*
+
+Enables a quick retry option when temporary connection failures occur (e.g., timeout, temporary API issues).
+
+- **Default:** Disabled
+- **Behavior:** When enabled, users see a retry button instead of automatic widget closure after temporary failures
+- **Retry Limit:** One retry attempt per session
+
+**Usage Example:**
+
+```javascript
+// Enable quick retry feature
+user.connect({
+  provider: 'td',
+  features: 'quick_retry',
+  // ... other options
+}).onConnection((institution) => {
+  console.log('Connected:', institution);
+}).onError((error) => {
+  console.error('Error:', error);
+}).onEvent((name, data) => {
+  // Listen for retry events
+  if (name === 'RETRY_ATTEMPT') {
+    console.log('User is retrying connection');
+  }
+  if (name === 'RETRY_DECLINED') {
+    console.log('User declined to retry');
+  }
+});
+
+// Enable multiple features
+user.connect({
+  features: 'quick_retry,another_feature',
+  // ... other options
+});
+```
+
 ### User APIs
 
 These methods return user data and thus require a Wealthica Connect SDK User instance. They automatically fetch a new token if necessary so you would not be bothered with tokens logic.

package/dist/wealthica.d.ts

@@ -96,6 +96,10 @@ type ConnectDataOptions = {
   redirectURI: string;
   providers: Array<string> | undefined;
   providerGroups: Array<string> | undefined;
+  theme: string;
+  providersPerLine: number | string;
+  features: string;
+  webhookURI: string;
 }
 
 type ConnectData = {

package/dist/wealthica.es5.d.ts

@@ -96,6 +96,10 @@ type ConnectDataOptions = {
   redirectURI: string;
   providers: Array<string> | undefined;
   providerGroups: Array<string> | undefined;
+  theme: string;
+  providersPerLine: number | string;
+  features: string;
+  webhookURI: string;
 }
 
 type ConnectData = {

package/dist/wealthica.es5.js

@@ -6000,6 +6000,7 @@ var API = /*#__PURE__*/function () {
     this._onWidgetMessage = this._onMessage.bind(this);
     this._widgetOpened = false;
     this._widgetActive = false;
+    this._features = null;
   }
   _createClass(API, [{
     key: "_init",
@@ -6208,9 +6209,11 @@ var API = /*#__PURE__*/function () {
           theme,
           providersPerLine,
           features,
+          webhookURI,
           _this$config5,
           clientId,
           connectURL,
+          _url,
           token,
           query,
           queryString,
@@ -6221,13 +6224,32 @@ var API = /*#__PURE__*/function () {
             switch (_context4.prev = _context4.next) {
               case 0:
                 options = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
-                provider = options.provider, institutionId = options.institutionId, state = options.state, _options$origin = options.origin, origin = _options$origin === void 0 ? this.isBrowser ? window.location.origin : undefined : _options$origin, lang = options.lang, _options$redirectURI = options.redirectURI, redirectURI = _options$redirectURI === void 0 ? this.config.redirectURI : _options$redirectURI, providers = options.providers, _options$providerGrou = options.providerGroups, providerGroups = _options$providerGrou === void 0 ? ['core'] : _options$providerGrou, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features;
-                _this$config5 = this.config, clientId = _this$config5.clientId, connectURL = _this$config5.connectURL; // Get a token with at least 10 minutes left
-                _context4.next = 5;
+                provider = options.provider, institutionId = options.institutionId, state = options.state, _options$origin = options.origin, origin = _options$origin === void 0 ? this.isBrowser ? window.location.origin : undefined : _options$origin, lang = options.lang, _options$redirectURI = options.redirectURI, redirectURI = _options$redirectURI === void 0 ? this.config.redirectURI : _options$redirectURI, providers = options.providers, _options$providerGrou = options.providerGroups, providerGroups = _options$providerGrou === void 0 ? ['core'] : _options$providerGrou, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, webhookURI = options.webhookURI;
+                _this$config5 = this.config, clientId = _this$config5.clientId, connectURL = _this$config5.connectURL; // Validate webhookURI if provided
+                if (!webhookURI) {
+                  _context4.next = 13;
+                  break;
+                }
+                _context4.prev = 4;
+                _url = new URL(webhookURI);
+                if (!(_url.protocol !== 'https:')) {
+                  _context4.next = 8;
+                  break;
+                }
+                throw new Error('Webhook URI must use HTTPS protocol');
+              case 8:
+                _context4.next = 13;
+                break;
+              case 10:
+                _context4.prev = 10;
+                _context4.t0 = _context4["catch"](4);
+                throw new Error("Invalid webhook URI: ".concat(_context4.t0.message));
+              case 13:
+                _context4.next = 15;
                 return this.getToken({
                   minimumLifetime: 600
                 });
-              case 5:
+              case 15:
                 token = _context4.sent;
                 query = {
                   client_id: clientId,
@@ -6240,7 +6262,8 @@ var API = /*#__PURE__*/function () {
                   provider_groups: providerGroups.join(','),
                   theme: ['light', 'dark'].includes(theme) ? theme : 'light',
                   providers_per_line: providersPerLine && ['1', '2'].includes(providersPerLine.toString()) ? providersPerLine.toString() : '2',
-                  features: features
+                  features: features,
+                  webhook_uri: webhookURI
                 }; // Cleanup blank params
                 Object.keys(query).forEach(function (key) {
                   return [undefined, null, ''].includes(query[key]) && delete query[key];
@@ -6254,12 +6277,12 @@ var API = /*#__PURE__*/function () {
                   url: "".concat(url, "?").concat(queryString),
                   token: token
                 });
-              case 12:
+              case 22:
               case "end":
                 return _context4.stop();
             }
           }
-        }, _callee4, this);
+        }, _callee4, this, [[4, 10]]);
       }));
       function getConnectData() {
         return _getConnectData.apply(this, arguments);
@@ -6313,15 +6336,16 @@ var API = /*#__PURE__*/function () {
       var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       if (!this.isBrowser) throw new Error('Only supported in Browser.');
       _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
-        var provider, providers, providerGroups, institutionId, lang, theme, providersPerLine, features, connectionType, origin, _yield$_this$getConne, url, token;
+        var provider, providers, providerGroups, institutionId, lang, theme, providersPerLine, features, connectionType, origin, webhookURI, _yield$_this$getConne, url, token;
         return regeneratorRuntime.wrap(function _callee5$(_context5) {
           while (1) {
             switch (_context5.prev = _context5.next) {
               case 0:
                 _context5.prev = 0;
                 _this._widgetOpened = true;
-                provider = options.provider, providers = options.providers, providerGroups = options.providerGroups, institutionId = options.institutionId, lang = options.lang, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, connectionType = options.connectionType, origin = options.origin;
-                _context5.next = 5;
+                provider = options.provider, providers = options.providers, providerGroups = options.providerGroups, institutionId = options.institutionId, lang = options.lang, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, connectionType = options.connectionType, origin = options.origin, webhookURI = options.webhookURI; // Store features for timeout calculation
+                _this._features = features;
+                _context5.next = 6;
                 return _this.getConnectData({
                   provider: provider,
                   providers: providers,
@@ -6331,9 +6355,10 @@ var API = /*#__PURE__*/function () {
                   theme: theme,
                   providersPerLine: providersPerLine,
                   features: features,
-                  origin: origin
+                  origin: origin,
+                  webhookURI: webhookURI
                 });
-              case 5:
+              case 6:
                 _yield$_this$getConne = _context5.sent;
                 url = _yield$_this$getConne.url;
                 token = _yield$_this$getConne.token;
@@ -6355,18 +6380,18 @@ var API = /*#__PURE__*/function () {
                 _this._widgetActive = true;
                 _this._addListeners();
                 _this._addWatchers();
-                _context5.next = 19;
+                _context5.next = 20;
                 break;
-              case 16:
-                _context5.prev = 16;
+              case 17:
+                _context5.prev = 17;
                 _context5.t0 = _context5["catch"](0);
-                _this._closeWidgetWithError(500, 'Connection refused');
-              case 19:
+                _this._closeWidgetWithError(500, _context5.t0.message || 'Connection refused');
+              case 20:
               case "end":
                 return _context5.stop();
             }
           }
-        }, _callee5, null, [[0, 16]]);
+        }, _callee5, null, [[0, 17]]);
       }))();
     }
   }, {
@@ -6422,10 +6447,16 @@ var API = /*#__PURE__*/function () {
     key: "_addWatchers",
     value: function _addWatchers() {
       var _this2 = this;
-      // Watch for widget timeout (10 minutes)
+      // Determine timeout based on features
+      var hasQuickRetry = this._features && this._features.split(',').map(function (f) {
+        return f.trim();
+      }).includes('quick_retry');
+      var timeoutMinutes = hasQuickRetry ? 30 : 10;
+
+      // Watch for widget timeout
       var timeoutWatcher = setTimeout(function () {
         _this2._closeWidgetWithError(400, 'Connection timeout');
-      }, 10 * 60 * 1000);
+      }, timeoutMinutes * 60 * 1000);
 
       // Watch for widget status (whether closed by user or successfully finished) and clean it up
       var doneWatcher = setInterval(function () {

package/dist/wealthica.js

@@ -5990,6 +5990,7 @@ var API = /*#__PURE__*/function () {
     this._onWidgetMessage = this._onMessage.bind(this);
     this._widgetOpened = false;
     this._widgetActive = false;
+    this._features = null;
   }
   _createClass(API, [{
     key: "_init",
@@ -6198,9 +6199,11 @@ var API = /*#__PURE__*/function () {
           theme,
           providersPerLine,
           features,
+          webhookURI,
           _this$config5,
           clientId,
           connectURL,
+          _url,
           token,
           query,
           queryString,
@@ -6211,13 +6214,32 @@ var API = /*#__PURE__*/function () {
             switch (_context4.prev = _context4.next) {
               case 0:
                 options = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
-                provider = options.provider, institutionId = options.institutionId, state = options.state, _options$origin = options.origin, origin = _options$origin === void 0 ? this.isBrowser ? window.location.origin : undefined : _options$origin, lang = options.lang, _options$redirectURI = options.redirectURI, redirectURI = _options$redirectURI === void 0 ? this.config.redirectURI : _options$redirectURI, providers = options.providers, _options$providerGrou = options.providerGroups, providerGroups = _options$providerGrou === void 0 ? ['core'] : _options$providerGrou, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features;
-                _this$config5 = this.config, clientId = _this$config5.clientId, connectURL = _this$config5.connectURL; // Get a token with at least 10 minutes left
-                _context4.next = 5;
+                provider = options.provider, institutionId = options.institutionId, state = options.state, _options$origin = options.origin, origin = _options$origin === void 0 ? this.isBrowser ? window.location.origin : undefined : _options$origin, lang = options.lang, _options$redirectURI = options.redirectURI, redirectURI = _options$redirectURI === void 0 ? this.config.redirectURI : _options$redirectURI, providers = options.providers, _options$providerGrou = options.providerGroups, providerGroups = _options$providerGrou === void 0 ? ['core'] : _options$providerGrou, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, webhookURI = options.webhookURI;
+                _this$config5 = this.config, clientId = _this$config5.clientId, connectURL = _this$config5.connectURL; // Validate webhookURI if provided
+                if (!webhookURI) {
+                  _context4.next = 13;
+                  break;
+                }
+                _context4.prev = 4;
+                _url = new URL(webhookURI);
+                if (!(_url.protocol !== 'https:')) {
+                  _context4.next = 8;
+                  break;
+                }
+                throw new Error('Webhook URI must use HTTPS protocol');
+              case 8:
+                _context4.next = 13;
+                break;
+              case 10:
+                _context4.prev = 10;
+                _context4.t0 = _context4["catch"](4);
+                throw new Error("Invalid webhook URI: ".concat(_context4.t0.message));
+              case 13:
+                _context4.next = 15;
                 return this.getToken({
                   minimumLifetime: 600
                 });
-              case 5:
+              case 15:
                 token = _context4.sent;
                 query = {
                   client_id: clientId,
@@ -6230,7 +6252,8 @@ var API = /*#__PURE__*/function () {
                   provider_groups: providerGroups.join(','),
                   theme: ['light', 'dark'].includes(theme) ? theme : 'light',
                   providers_per_line: providersPerLine && ['1', '2'].includes(providersPerLine.toString()) ? providersPerLine.toString() : '2',
-                  features: features
+                  features: features,
+                  webhook_uri: webhookURI
                 }; // Cleanup blank params
                 Object.keys(query).forEach(function (key) {
                   return [undefined, null, ''].includes(query[key]) && delete query[key];
@@ -6244,12 +6267,12 @@ var API = /*#__PURE__*/function () {
                   url: "".concat(url, "?").concat(queryString),
                   token: token
                 });
-              case 12:
+              case 22:
               case "end":
                 return _context4.stop();
             }
           }
-        }, _callee4, this);
+        }, _callee4, this, [[4, 10]]);
       }));
       function getConnectData() {
         return _getConnectData.apply(this, arguments);
@@ -6303,15 +6326,16 @@ var API = /*#__PURE__*/function () {
       var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       if (!this.isBrowser) throw new Error('Only supported in Browser.');
       _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
-        var provider, providers, providerGroups, institutionId, lang, theme, providersPerLine, features, connectionType, origin, _yield$_this$getConne, url, token;
+        var provider, providers, providerGroups, institutionId, lang, theme, providersPerLine, features, connectionType, origin, webhookURI, _yield$_this$getConne, url, token;
         return regeneratorRuntime.wrap(function _callee5$(_context5) {
           while (1) {
             switch (_context5.prev = _context5.next) {
               case 0:
                 _context5.prev = 0;
                 _this._widgetOpened = true;
-                provider = options.provider, providers = options.providers, providerGroups = options.providerGroups, institutionId = options.institutionId, lang = options.lang, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, connectionType = options.connectionType, origin = options.origin;
-                _context5.next = 5;
+                provider = options.provider, providers = options.providers, providerGroups = options.providerGroups, institutionId = options.institutionId, lang = options.lang, theme = options.theme, providersPerLine = options.providersPerLine, features = options.features, connectionType = options.connectionType, origin = options.origin, webhookURI = options.webhookURI; // Store features for timeout calculation
+                _this._features = features;
+                _context5.next = 6;
                 return _this.getConnectData({
                   provider: provider,
                   providers: providers,
@@ -6321,9 +6345,10 @@ var API = /*#__PURE__*/function () {
                   theme: theme,
                   providersPerLine: providersPerLine,
                   features: features,
-                  origin: origin
+                  origin: origin,
+                  webhookURI: webhookURI
                 });
-              case 5:
+              case 6:
                 _yield$_this$getConne = _context5.sent;
                 url = _yield$_this$getConne.url;
                 token = _yield$_this$getConne.token;
@@ -6345,18 +6370,18 @@ var API = /*#__PURE__*/function () {
                 _this._widgetActive = true;
                 _this._addListeners();
                 _this._addWatchers();
-                _context5.next = 19;
+                _context5.next = 20;
                 break;
-              case 16:
-                _context5.prev = 16;
+              case 17:
+                _context5.prev = 17;
                 _context5.t0 = _context5["catch"](0);
-                _this._closeWidgetWithError(500, 'Connection refused');
-              case 19:
+                _this._closeWidgetWithError(500, _context5.t0.message || 'Connection refused');
+              case 20:
               case "end":
                 return _context5.stop();
             }
           }
-        }, _callee5, null, [[0, 16]]);
+        }, _callee5, null, [[0, 17]]);
       }))();
     }
   }, {
@@ -6412,10 +6437,16 @@ var API = /*#__PURE__*/function () {
     key: "_addWatchers",
     value: function _addWatchers() {
       var _this2 = this;
-      // Watch for widget timeout (10 minutes)
+      // Determine timeout based on features
+      var hasQuickRetry = this._features && this._features.split(',').map(function (f) {
+        return f.trim();
+      }).includes('quick_retry');
+      var timeoutMinutes = hasQuickRetry ? 30 : 10;
+
+      // Watch for widget timeout
       var timeoutWatcher = setTimeout(function () {
         _this2._closeWidgetWithError(400, 'Connection timeout');
-      }, 10 * 60 * 1000);
+      }, timeoutMinutes * 60 * 1000);
 
       // Watch for widget status (whether closed by user or successfully finished) and clean it up
       var doneWatcher = setInterval(function () {

package/dist/wealthica.min.d.ts

@@ -96,6 +96,10 @@ type ConnectDataOptions = {
   redirectURI: string;
   providers: Array<string> | undefined;
   providerGroups: Array<string> | undefined;
+  theme: string;
+  providersPerLine: number | string;
+  features: string;
+  webhookURI: string;
 }
 
 type ConnectData = {