pryv 2.4.7 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "2.4.7",
+  "version": "3.0.0",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",
@@ -18,7 +18,8 @@
   "author": "Pryv S.A. <info@pryv.com> (https://pryv.com)",
   "main": "src/index.js",
   "types": "src/index.d.ts",
-  "dependencies": {
-    "superagent": "^9.0.0"
+  "dependencies": {},
+  "engines": {
+    "node": ">=20.0.0"
   }
 }

package/src/Auth/AuthController.js

@@ -7,13 +7,15 @@ const AuthStates = require('./AuthStates');
 const Messages = require('./LoginMessages');
 
 /**
- * @private
+ * Controller for authentication flow
+ * @memberof pryv.Auth
  */
 class AuthController {
   /**
-   *
-   * @param {*} settings
-   * @param {*} service
+   * Create an AuthController
+   * @param {AuthSettings} settings - Authentication settings
+   * @param {Service} service - Pryv service instance
+   * @param {CustomLoginButton} loginButton - Login button implementation
    */
   constructor (settings, service, loginButton) {
     this.settings = settings;
@@ -50,9 +52,8 @@ class AuthController {
   }
 
   /**
-   * async function to call right after instanciating object
-   *
-   * @returns {Service}
+   * Initialize the auth controller. Call this right after instantiation.
+   * @returns {Promise<Service>} Promise resolving to the Service instance
    */
   async init () {
     this.serviceInfo = this.service.infoSync();
@@ -73,6 +74,7 @@ class AuthController {
     }
 
     if (loginButton != null && loginButton.finishAuthProcessAfterRedirection != null) {
+      // @ts-ignore - this is a valid AuthController
       await loginButton.finishAuthProcessAfterRedirection(this);
     }
 
@@ -87,7 +89,8 @@ class AuthController {
   }
 
   /**
-   * Triggered when button is pressed
+   * Handle button click - triggers appropriate action based on current state
+   * @returns {Promise<void>}
    */
   async handleClick () {
     if (isAuthorized.call(this)) {
@@ -113,11 +116,12 @@ class AuthController {
   }
 
   /**
-   * Used only to retrieve returnUrl in browser environments
-   *
-   * @param {*} returnURL
-   * @param {*} windowLocationForTest
-   * @param {*} navigatorForTests
+   * Compute the return URL for authentication redirect.
+   * Used only in browser environments.
+   * @param {string} [returnURL] - The return URL setting ('auto#', 'self#', or custom URL)
+   * @param {string} [windowLocationForTest] - Mock window.location.href for testing
+   * @param {string|Navigator} [navigatorForTests] - Mock navigator for testing
+   * @returns {string|boolean} The computed return URL, or false if using popup mode
    */
   getReturnURL (
     returnURL,
@@ -154,17 +158,30 @@ class AuthController {
     }
   }
 
+  /**
+   * Start the authentication request and polling process
+   * @returns {Promise<void>}
+   * @see https://pryv.github.io/reference/#auth-request
+   */
   async startAuthRequest () {
+    // @ts-ignore - postAccess uses .call(this) for context
     this.state = await postAccess.call(this);
 
     await doPolling.call(this);
 
+    /** @this {AuthController} */
     async function postAccess () {
       try {
-        const res = await utils.superagent
-          .post(this.serviceInfo.access)
-          .send(this.settings.authRequest);
-        return res.body;
+        const { response, body } = await utils.fetchPost(
+          // @ts-ignore - this is bound via .call()
+          this.serviceInfo.access,
+          // @ts-ignore - this is bound via .call()
+          this.settings.authRequest
+        );
+        if (!response.ok) {
+          throw new Error('Access request failed: ' + JSON.stringify(body));
+        }
+        return body;
       } catch (e) {
         this.state = {
           status: AuthStates.ERROR,
@@ -175,31 +192,31 @@ class AuthController {
       }
     }
 
+    /** @this {AuthController} */
     async function doPolling () {
-      if (this.state.status !== AuthStates.NEED_SIGNIN) {
+      // @ts-ignore - this is bound via .call()
+      if (this.state?.status !== AuthStates.NEED_SIGNIN) {
         return;
       }
-      const pollResponse = await pollAccess(this.state.poll);
+      // @ts-ignore - this is bound via .call()
+      const pollResponse = await pollAccess(this.state?.poll);
 
       if (pollResponse.status === AuthStates.NEED_SIGNIN) {
-        setTimeout(await doPolling.bind(this), this.state.poll_rate_ms);
+        // @ts-ignore - this is bound via .call()
+        setTimeout(await doPolling.bind(this), this.state?.poll_rate_ms);
       } else {
         this.state = pollResponse;
       }
 
       async function pollAccess (pollUrl) {
         try {
-          const res = await utils.superagent.get(pollUrl);
-          return res.body;
-        } catch (e) {
-          if (e.response &&
-              e.response.status === 403 &&
-              e.response.body &&
-              e.response.body.status === 'REFUSED') {
+          const { response, body } = await utils.fetchGet(pollUrl);
+          if (response.status === 403 && body?.status === 'REFUSED') {
             return { status: AuthStates.INITIALIZED };
-          } else {
-            return { status: AuthStates.ERROR, message: 'Error while polling for auth request', error: e };
           }
+          return body;
+        } catch (e) {
+          return { status: AuthStates.ERROR, message: 'Error while polling for auth request', error: e };
         }
       }
     }

package/src/Auth/index.js

@@ -29,11 +29,11 @@ module.exports = {
  * @param {string | boolean} settings.authRequest.returnURL : false, // set this if you don't want a popup
  * @param {string} [settings.authRequest.referer] To track registration source
  * @param {string} settings.spanButtonID set and <span> id in DOM to insert default login button or null for custom
- * @param {Browser.AuthStateChangeHandler} settings.onStateChange
- * @param {string} [settings.returnURL=auto#]  Set to "self#" to disable popup and force using the same page. Set a custom url when process is finished (specific use cases). Should always end by # ? or &
+ * @param {Function} settings.onStateChange
+ * @param {string} [settings.returnURL] Set to "self#" to disable popup and force using the same page
  * @param {string} serviceInfoUrl
  * @param {Object} [serviceCustomizations] override properties of serviceInfoUrl
- * @returns {pryv.Service}
+ * @returns {Promise<Service>}
  */
 async function setupAuth (settings, serviceInfoUrl, serviceCustomizations, HumanInteraction = LoginButton) {
   const service = new Service(serviceInfoUrl, serviceCustomizations);

package/src/Browser/CookieUtils.js

@@ -18,9 +18,10 @@ module.exports = {
 /**
   * Set a local cookie
   * @memberof pryv.Browser.CookieUtils
+  * @template T
   * @param {string} cookieKey - The key for the cookie
-  * @param {mixed} value - The Value
-  * @param {number} expireInDays - Expiration date in days from now
+  * @param {T} value - The value (will be JSON stringified)
+  * @param {number} [expireInDays=365] - Expiration date in days from now
   */
 function set (cookieKey, value, expireInDays) {
   if (!utils.isBrowser()) return;
@@ -31,7 +32,7 @@ function set (cookieKey, value, expireInDays) {
   myDate.setDate(myDate.getDate() + expireInDays);
   let cookieStr = encodeURIComponent(cookieKey) + '=' +
     encodeURIComponent(JSON.stringify(value)) +
-    ';expires=' + myDate.toGMTString() +
+    ';expires=' + myDate.toUTCString() +
     ';domain=.' + hostName + ';path=' + path;
   // do not add SameSite when removing a cookie
   if (expireInDays >= 0) cookieStr += ';SameSite=Strict';
@@ -41,7 +42,9 @@ function set (cookieKey, value, expireInDays) {
 /**
  * Return the value of a local cookie
  * @memberof pryv.Browser.CookieUtils
- * @param cookieKey - The key
+ * @template T
+ * @param {string} cookieKey - The key
+ * @returns {T|undefined} The parsed cookie value or undefined if not found
  */
 function get (cookieKey) {
   const name = encodeURIComponent(cookieKey);
@@ -54,7 +57,7 @@ function get (cookieKey) {
 /**
  * Delete a local cookie
  * @memberof pryv.Browser.CookieUtils
- * @param cookieKey - The key
+ * @param {string} cookieKey - The key
  */
 function del (cookieKey) {
   set(cookieKey, { deleted: true }, -1);

package/src/Browser/LoginButton.js

@@ -28,6 +28,7 @@ class LoginButton {
     setupButton(this);
     this.languageCode = this.authSettings.authRequest.languageCode || 'en';
     this.messages = Messages(this.languageCode);
+    // @ts-ignore - loginButtonText is set by setupButton
     if (this.loginButtonText) {
       await loadAssets(this);
     }
@@ -84,7 +85,9 @@ class LoginButton {
       default:
         console.log('WARNING Unhandled state for Login: ' + state.status);
     }
+    // @ts-ignore - loginButtonText is set by setupButton
     if (this.loginButtonText) {
+      // @ts-ignore
       this.loginButtonText.innerHTML = this.text;
     }
   }
@@ -114,8 +117,8 @@ class LoginButton {
     const pollUrl = retrievePollUrl(url);
     if (pollUrl !== null) {
       try {
-        const res = await utils.superagent.get(pollUrl);
-        authController.state = res.body;
+        const { body } = await utils.fetchGet(pollUrl);
+        authController.state = body;
       } catch (e) {
         authController.state = {
           status: AuthStates.ERROR,
@@ -148,8 +151,8 @@ async function startLoginScreen (loginButton, authUrl) {
   const outerHeight = typeof window.outerHeight !== 'undefined' ? window.outerHeight : (document.body.clientHeight - 22);
   const width = 400;
   const height = 620;
-  const left = parseInt(screenX + ((outerWidth - width) / 2), 10);
-  const top = parseInt(screenY + ((outerHeight - height) / 2.5), 10);
+  const left = Math.floor(screenX + ((outerWidth - width) / 2));
+  const top = Math.floor(screenY + ((outerHeight - height) / 2.5));
   const features = (
     'width=' + width +
     ',height=' + height +