Linting update

perki · perki · commit d75b4fce77e6 · 2026-02-03T19:26:10.000+01:00
diff --git a/components/pryv-monitor/src/Monitor.js b/components/pryv-monitor/src/Monitor.js
@@ -22,6 +22,7 @@ class Monitor extends EventEmitter {
    */
   constructor (apiEndpointOrConnection, eventsGetScope = {}) {
     super();
+    // @ts-ignore - pryv is set at runtime by extendPryvMonitor
     if (!Monitor.pryv) {
       throw new Error('package \'@pryv/monitor\' must loaded after package \'pryv\'');
     }
@@ -33,9 +34,11 @@ class Monitor extends EventEmitter {
     };
     Object.assign(this.eventsGetScope, eventsGetScope);
 
+    // @ts-ignore - pryv is set at runtime
     if (apiEndpointOrConnection instanceof Monitor.pryv.Connection) {
       this.connection = apiEndpointOrConnection;
     } else {
+      // @ts-ignore - pryv is set at runtime
       this.connection = new Monitor.pryv.Connection(apiEndpointOrConnection);
     }
     this.states = {
@@ -160,17 +163,11 @@ class Monitor extends EventEmitter {
     return this.states.started;
   }
 
-  /**
-   * Initialize the updateMethods with this Monitor
-   * @callback Monitor~UpdateMethod
-   * @param {Monitor} setMonitor
-   */
-
   /**
    * @private
-   * Called my UpdateMethod to share cross references
+   * Called by UpdateMethod to share cross references
    * Set a custom update method
-   * @param {Monitor~UpdateMethod} updateMethod - the auto-update method
+   * @param {Object} updateMethod - the auto-update method
    * @returns {Monitor} this
    */
   addUpdateMethod (updateMethod) {
diff --git a/components/pryv-monitor/src/UpdateMethod/Socket.js b/components/pryv-monitor/src/UpdateMethod/Socket.js
@@ -15,9 +15,11 @@ const Changes = require('../lib/Changes');
 class Socket extends UpdateMethod {
   async ready () {
     if (this.socket) return;
+    // @ts-ignore - socket is added by @pryv/socket.io extension
     if (!this.monitor.connection.socket) {
       throw new Error('You should load package @pryv/socket.io to use monitor with websockets');
     }
+    // @ts-ignore - socket is added by @pryv/socket.io extension
     this.socket = await this.monitor.connection.socket.open();
     this.socket.on('eventsChanged', () => { this.monitor.updateEvents(); });
     this.socket.on('streamsChanged', () => { this.monitor.updateStreams(); });
diff --git a/components/pryv-monitor/src/UpdateMethod/UpdateMethod.js b/components/pryv-monitor/src/UpdateMethod/UpdateMethod.js
@@ -19,7 +19,9 @@ class UpdateMethod {
       throw new Error('An update Method can be assigned to one monitor only');
     }
     this.monitor = monitor;
+    // @ts-ignore - Changes.READY and Changes.STOP are valid event names
     monitor.on(Changes.READY, this.ready.bind(this));
+    // @ts-ignore
     monitor.on(Changes.STOP, this.stop.bind(this));
     if (monitor.started) {
       this.ready();
diff --git a/components/pryv-monitor/src/lib/Changes.js b/components/pryv-monitor/src/lib/Changes.js
@@ -5,7 +5,7 @@
 /**
  * Enum trigger messages
  * @readonly
- * @enum {pryv.Monitor.Changes}
+ * @enum {string}
  */
 const Changes = {
   EVENT: 'event',
diff --git a/components/pryv-monitor/src/lib/updateStreams.js b/components/pryv-monitor/src/lib/updateStreams.js
@@ -7,7 +7,7 @@ const Changes = require('./Changes');
 module.exports = async function _updateStreams (monitor) {
   try {
     const result = await monitor.connection.get('streams');
-    if (!result.streams) { throw new Error('Invalid response ' + JSON.streams(result)); }
+    if (!result.streams) { throw new Error('Invalid response ' + JSON.stringify(result)); }
     monitor.emit(Changes.STREAMS, result.streams);
   } catch (e) {
     monitor.emit(Changes.ERROR, e);
diff --git a/components/pryv-socket.io/src/SocketIO.js b/components/pryv-socket.io/src/SocketIO.js
@@ -40,6 +40,7 @@ class SocketIO extends EventEmitter {
       this.connection.username()
         .then(username => {
           const socketEndpoint = this.connection.endpoint + username + '?auth=' + this.connection.token;
+          // @ts-ignore - io is callable in socket.io-client
           this._io = io(socketEndpoint, { forceNew: true });
 
           // handle failure
@@ -87,11 +88,13 @@ class SocketIO extends EventEmitter {
    * @param {Function} listener - The callback function
    * @returns {SocketIO} this
    */
+  // @ts-ignore - overriding EventEmitter.on with restricted signature
   on (eventName, listener) {
     checkOpen(this);
     if (EVENTS.indexOf(eventName) < 0) {
       throw new Error('Unkown event [' + eventName + ']. Allowed events are: ' + EVENTS);
     }
+    // @ts-ignore
     return super.on(eventName, listener);
   }
 
diff --git a/components/pryv/src/Auth/AuthController.js b/components/pryv/src/Auth/AuthController.js
@@ -74,6 +74,7 @@ class AuthController {
     }
 
     if (loginButton != null && loginButton.finishAuthProcessAfterRedirection != null) {
+      // @ts-ignore - this is a valid AuthController
       await loginButton.finishAuthProcessAfterRedirection(this);
     }
 
@@ -159,18 +160,22 @@ class AuthController {
 
   /**
    * Start the authentication request and polling process
-   * @returns {Promise<AuthRequestResponse>} Promise resolving to the auth request response
+   * @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 { 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) {
@@ -187,14 +192,18 @@ 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;
       }
diff --git a/components/pryv/src/Auth/index.js b/components/pryv/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);
diff --git a/components/pryv/src/Browser/CookieUtils.js b/components/pryv/src/Browser/CookieUtils.js
@@ -32,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';
diff --git a/components/pryv/src/Browser/LoginButton.js b/components/pryv/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;
     }
   }
@@ -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 +
diff --git a/components/pryv/src/Connection.js b/components/pryv/src/Connection.js
@@ -59,9 +59,11 @@ class Connection {
     const accessInfo = await this.accessInfo();
     if (accessInfo.error) {
       const err = new Error('Failed fetching accessinfo: ' + accessInfo.error.message);
+      // @ts-ignore - custom error property
       err.innerObject = accessInfo.error;
       throw err;
     }
+    // @ts-ignore - username is always a string
     return accessInfo.user.username;
   }
 
@@ -114,6 +116,7 @@ class Connection {
           params
         )} >> Result: ${JSON.stringify(innerObject)}"`
       );
+      // @ts-ignore - custom error property
       error.innerObject = innerObject;
       throw error;
     }
@@ -314,7 +317,7 @@ class Connection {
       fields,
       points
     });
-    if (!res.status === 'ok') {
+    if (res.status !== 'ok') {
       throw new Error('Failed loading serie: ' + JSON.stringify(res.status));
     }
     return res;
@@ -365,14 +368,15 @@ class Connection {
 
   /**
    * Create an event from a Buffer
-   * @param {Event} event
+   * @param {Object} event
    * @param {Buffer|Blob} bufferData - Buffer for node, Blob for browser
-   * @param {string} fileName
+   * @param {string} filename
    */
   async createEventWithFileFromBuffer (event, bufferData, filename) {
     const mimeType = getMimeType(getExtname(filename));
     const fileBlob = bufferData instanceof Blob
       ? bufferData
+      // @ts-ignore - Buffer is valid for Blob in Node.js
       : new Blob([bufferData], { type: mimeType });
 
     const formData = new FormData();
diff --git a/components/pryv/src/Service.js b/components/pryv/src/Service.js
@@ -52,7 +52,7 @@ class Service {
    *  - name of a platform
    *    `const serviceName = await service.info().name`
    * @see ServiceInfo For details on available properties.
-   * @param {boolean?} forceFetch If true, will force fetching service info.
+   * @param {boolean} [forceFetch] If true, will force fetching service info.
    * @returns {Promise<ServiceInfo>} Promise to Service info Object
    */
   async info (forceFetch) {
@@ -63,6 +63,7 @@ class Service {
         baseServiceInfo = body;
       }
       Object.assign(baseServiceInfo, this._pryvServiceCustomizations);
+      // @ts-ignore - baseServiceInfo is populated from body or customizations
       this.setServiceInfo(baseServiceInfo);
     }
     return this._serviceInfo;
@@ -107,8 +108,8 @@ class Service {
 
   /**
    * Return assets property content
-   * @param {boolean?} forceFetch If true, will force fetching service info.
-   * @returns {Promise<ServiceAssets>} Promise to ServiceAssets
+   * @param {boolean} [forceFetch] If true, will force fetching service info.
+   * @returns {Promise<ServiceAssets|null>} Promise to ServiceAssets
    */
   async assets (forceFetch) {
     if (!forceFetch && this._assets) {
@@ -214,5 +215,7 @@ const Connection = require('./Connection');
  * @property {string} terms The terms and conditions, in plain text or the URL displaying them.
  * @property {string} eventTypes The URL of the list of validated event types.
  * @property {Object} [assets] Holder for service specific Assets (icons, css, ...)
- * @property {String} [assets.definitions] URL to json object with assets definitions
+ * @property {string} [assets.definitions] URL to json object with assets definitions
+ * @property {Object} [features] Platform feature flags
+ * @property {boolean} [features.noHF] True if HF data is not supported
  */
diff --git a/components/pryv/src/ServiceAssets.js b/components/pryv/src/ServiceAssets.js
@@ -16,8 +16,8 @@ const utils = require('./utils.js');
 class ServiceAssets {
   /**
    * Private => use ServiceAssets.setup()
-   * @param { object} assets The content of service/info.assets properties.
-   * @param { string } pryvServiceAssetsSourceUrl Url point to assets of the service of a Pryv platform: https://api.pryv.com/reference/#service-info property `assets.src`
+   * @param {Object} assets The content of service/info.assets properties.
+   * @param {string} assetsURL Url point to assets of the service of a Pryv platform
    */
   constructor (assets, assetsURL) {
     this._assets = assets;
@@ -85,6 +85,8 @@ class ServiceAssets {
    * Set service Favicon to Web Page
    */
   setFavicon () {
+    /** @type {HTMLLinkElement} */
+    // @ts-ignore - querySelector returns Element but we know it's HTMLLinkElement
     const link = document.querySelector("link[rel*='icon']") || document.createElement('link');
     link.type = 'image/x-icon';
     link.rel = 'shortcut icon';
@@ -155,8 +157,10 @@ function loadCSS (url) {
   \*/
 
 function relPathToAbs (baseUrlString, sRelPath) {
+  /** @type {Location|HTMLAnchorElement} */
   var baseLocation = location;
   if (baseUrlString) {
+    // @ts-ignore - HTMLAnchorElement has compatible URL properties
     baseLocation = document.createElement('a');
     baseLocation.href = baseUrlString;
   }
diff --git a/components/pryv/src/globals.d.ts b/components/pryv/src/globals.d.ts
@@ -0,0 +1,72 @@
+/**
+ * Global type declarations for JSDoc references in JavaScript files.
+ * These types are re-exported from the 'pryv' module for use in @param, @returns, etc.
+ */
+
+import type * as PryvModule from 'pryv';
+
+declare global {
+  // API types
+  type APIEndpoint = string;
+  type TokenAndEndpoint = PryvModule.TokenAndAPIEndpoint;
+
+  // Core classes (for JSDoc @param {Connection} etc.)
+  interface Connection extends PryvModule.Connection {
+    socket?: any;
+    _chunkedBatchCall?: any;
+  }
+  type Service = PryvModule.Service;
+  type ServiceInfo = PryvModule.ServiceInfo;
+  type ServiceAssets = PryvModule.ServiceAssets;
+
+  // Auth types
+  type AuthController = PryvModule.AuthController;
+  type AuthSettings = PryvModule.AuthSettings;
+  type AuthRequestResponse = PryvModule.AuthRequestResponse;
+  type CustomLoginButton = PryvModule.CustomLoginButton;
+  interface LoginButton extends PryvModule.LoginButton {
+    loginButtonText?: HTMLElement;
+  }
+
+  // Data types
+  type AccessInfo = PryvModule.AccessInfo & { error?: PryvModule.Error };
+  type HFSeriesAddResult = PryvModule.HFSeriesAddResult;
+  type APICall = PryvModule.APICall;
+  type Event = PryvModule.Event;
+  type Stream = PryvModule.Stream;
+
+  // Method call type for socket.io
+  type MethodCall = PryvModule.APICall;
+
+  // Monitor types
+  type Monitor = PryvModule.Monitor;
+  type MonitorScope = PryvModule.MonitorScope;
+
+  // SocketIO type
+  type SocketIO = PryvModule.SocketIO;
+
+  // Namespace for JSDoc like @type {pryv.Service}
+  namespace pryv {
+    export type Service = PryvModule.Service;
+    export type Connection = PryvModule.Connection;
+    export type Monitor = PryvModule.Monitor;
+    export type ServiceInfo = PryvModule.ServiceInfo;
+    export type ServiceAssets = PryvModule.ServiceAssets;
+    export type AuthController = PryvModule.AuthController;
+    export type Event = PryvModule.Event;
+    export type Stream = PryvModule.Stream;
+    export type ItemDeletion = PryvModule.ItemDeletion;
+  }
+
+  // Browser namespace for JSDoc
+  namespace Browser {
+    export type LoginButton = PryvModule.LoginButton;
+  }
+
+  // Extended Error type with innerObject property
+  interface Error {
+    innerObject?: any;
+  }
+}
+
+export {};
diff --git a/components/pryv/src/index.d.ts b/components/pryv/src/index.d.ts
diff --git a/components/pryv/src/lib/getEventStreamed.js b/components/pryv/src/lib/getEventStreamed.js
diff --git a/components/pryv/src/utils.js b/components/pryv/src/utils.js
diff --git a/tsconfig.json b/tsconfig.json
