pryv 2.4.6 → 3.0.0

package/src/globals.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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;
+  }
+
+  /**
+   * Custom error class for Pryv library errors
+   */
+  class PryvError extends Error {
+    constructor(message: string, innerObject?: Error | object);
+    name: 'PryvError';
+    innerObject?: Error | object;
+  }
+}
+
+export {};

package/src/index.d.ts

@@ -1,6 +1,19 @@
 declare module 'pryv' {
   type Timestamp = number;
   type Identifier = string;
+
+  /**
+   * Common metadata returned by all API responses
+   * @see https://api.pryv.com/reference/#in-method-results
+   */
+  export type ApiMeta = {
+    /** API version in format {major}.{minor}.{revision} */
+    apiVersion: string;
+    /** Current server time as Unix timestamp in seconds */
+    serverTime: Timestamp;
+    /** Serial that changes when core or register is updated */
+    serial: string;
+  };
   export type PermissionLevel = 'read' | 'contribute' | 'manage' | 'create-only';
   export type KeyValue = { [key: string]: string | number };
 
@@ -104,7 +117,16 @@ declare module 'pryv' {
   export type HFSeries = {
     format: 'flatJSON';
     fields: string[];
-    points: Array<number | string>;
+    points: Array<Array<number | string>>;
+  };
+
+  /**
+   * Response from adding data points to an HF series event
+   * @see https://api.pryv.com/reference/#add-hf-series-data-points
+   */
+  export type HFSeriesAddResult = {
+    status: 'ok';
+    meta: ApiMeta;
   };
 
   type Run = {
@@ -142,6 +164,16 @@ declare module 'pryv' {
     subErrors?: Error[];
   };
 
+  /**
+   * Custom error class for Pryv library errors.
+   * Includes an innerObject property for wrapping underlying errors.
+   */
+  export class PryvError extends globalThis.Error {
+    constructor(message: string, innerObject?: globalThis.Error | object);
+    name: 'PryvError';
+    innerObject?: globalThis.Error | object;
+  }
+
   export type StreamsQuery = {
     any?: Identifier[];
     all?: Identifier[];
@@ -530,18 +562,14 @@ declare module 'pryv' {
     APICallMethods[K]['res'] & PossibleError;
 
   export type APICallResultHandler<K extends keyof APICallMethods> = (
-    result: APICallResult<K>,
+    result: APICallResult<K>, apicall: APICall<K>
   ) => Promise<any>;
   export type StreamedEventsHandler = (event: Event) => void;
 
   export type StreamedEventsResult = {
     eventsCount?: number;
     eventsDeletionsCount?: number;
-    meta: {
-      apiVersion: string;
-      serverTime: number;
-      serial: string;
-    };
+    meta: ApiMeta;
   };
 
   export type EventFileCreationParams = Partial<
@@ -604,21 +632,30 @@ declare module 'pryv' {
       filename: string,
     ): Promise<EventAPICallRes>;
     addPointsToHFEvent(
-      id: Identifier,
+      eventId: Identifier,
       fields: string[],
-      values: Array<string | number>,
-    ): Promise<any>;
+      points: Array<Array<number | string>>,
+    ): Promise<HFSeriesAddResult>;
     accessInfo(): Promise<AccessInfo>;
-    revoke(throwOnFail?: boolean, usingConnection?: Connection)
+    revoke(throwOnFail?: boolean, usingConnection?: Connection): Promise<any>;
     readonly deltaTime: number;
     readonly apiEndpoint: string;
+    readonly token: string | null;
+    readonly endpoint: string;
+    options: { chunkSize: number };
 
     post(
       path: string,
       data: Object | any[],
-      queryParams: Object,
     ): Promise<Object | Object[]>;
-    get(path: string, queryParams: Object): Promise<Object | Object[]>;
+    get(path: string, queryParams?: Object): Promise<Object | Object[]>;
+
+    /** @internal */
+    _chunkedBatchCall(
+      apiCalls: APICall[],
+      progress?: APICallProgressHandler,
+      httpHandler?: (batch: any[]) => Promise<any>
+    ): Promise<any[]>;
   }
 
   export type serviceCustomizations = {
@@ -637,11 +674,15 @@ declare module 'pryv' {
     support: string;
     terms: string;
     eventTypes: string;
-    version: string;
-    assets: {
+    version?: string;
+    assets?: {
       definitions: string;
     };
-    serial: string;
+    serial?: string;
+    features?: {
+      noHF?: boolean;
+      [key: string]: any;
+    };
   };
 
   export type AssetsConfig = {
@@ -684,7 +725,7 @@ declare module 'pryv' {
     setServiceInfo(serviceInfo: Partial<ServiceInfo>): void;
     assets(forceFetch?: boolean): Promise<ServiceAssets | null>;
     infoSync(): ServiceInfo | null;
-    apiEndpointFor(username: string, token: string): Promise<string>;
+    apiEndpointFor(username: string, token?: string): Promise<string>;
     login(
       username: string,
       password: string,
@@ -694,6 +735,12 @@ declare module 'pryv' {
 
     supportsHF(): Promise<boolean>;
     isDnsLess(): Promise<boolean>;
+
+    static buildAPIEndpoint(
+      serviceInfo: ServiceInfo,
+      username: string,
+      token?: string,
+    ): string;
   }
 
   export type AuthRequestedPermission = {
@@ -703,24 +750,30 @@ declare module 'pryv' {
   };
 
   export type States =
+    | 'ERROR'
     | 'LOADING'
     | 'INITIALIZED'
     | 'NEED_SIGNIN'
     | 'ACCEPTED'
-    | 'SIGNOUT';
+    | 'SIGNOUT'
+    | 'REFUSED';
 
   export type StateChangeTypes = {
+    ERROR: {
+      message?: string;
+      error?: Error | unknown;
+    };
     LOADING: {};
     INITIALIZED: {
       serviceInfo: ServiceInfo;
     };
     NEED_SIGNIN: {
       authUrl: string;
-      clientData: any;
-      code: number;
+      clientData?: KeyValue;
+      code?: number;
       key: string;
       lang: string;
-      oauthState: any;
+      oauthState?: string;
       poll: string;
       poll_rate_ms: number;
       requestedPermissions: Array<{
@@ -729,16 +782,21 @@ declare module 'pryv' {
         defaultName: string;
       }>;
       requestingAppId: string;
-      returnUrl: any;
-      serviceInfo: ServiceInfo;
+      returnUrl?: string | null;
+      serviceInfo?: ServiceInfo;
     };
     ACCEPTED: {
-      serviceInfo: ServiceInfo;
+      serviceInfo?: ServiceInfo;
       apiEndpoint: string;
       username: string;
-      token: string;
+      token?: string;
     };
     SIGNOUT: {};
+    REFUSED: {
+      reasonID?: string;
+      message?: string;
+      serviceInfo?: ServiceInfo;
+    };
   };
 
   export type StateChange<K extends States> = StateChangeTypes[K] & {
@@ -746,6 +804,26 @@ declare module 'pryv' {
     status: K;
   };
 
+  /**
+   * Response from auth-request POST endpoint
+   * @see https://pryv.github.io/reference/#auth-request
+   */
+  export type AuthRequestResponse = {
+    status: 'NEED_SIGNIN';
+    authUrl: string;
+    /** @deprecated Use authUrl instead */
+    url?: string;
+    key: string;
+    poll: string;
+    poll_rate_ms: number;
+    requestingAppId: string;
+    requestedPermissions: AuthRequestedPermission[];
+    lang?: string;
+    returnURL?: string;
+    clientData?: KeyValue;
+    serviceInfo?: ServiceInfo;
+  };
+
   export type AuthSettings = {
     spanButtonID?: string;
     onStateChange?: (state: StateChange<States>) => void;
@@ -756,15 +834,23 @@ declare module 'pryv' {
       requestedPermissions: AuthRequestedPermission[];
       returnUrl?: string | boolean;
       referer?: string;
-      clientData?: Object;
+      clientData?: KeyValue;
+      deviceName?: string;
+      expireAfter?: number;
+      serviceInfo?: Partial<ServiceInfo>;
     };
   };
 
+  export type LoginButtonConstructor = new (
+    authSettings: AuthSettings,
+    service: Service,
+  ) => CustomLoginButton;
+
   export type SetupAuth = (
     settings: AuthSettings,
     serviceInfoUrl: string,
     serviceCustomizations?: serviceCustomizations,
-    humanInteraction?: any,
+    humanInteraction?: LoginButtonConstructor,
   ) => Promise<Service>;
 
   export type AuthStates = {
@@ -780,16 +866,44 @@ declare module 'pryv' {
   type AuthStatePayload = {
     status: AuthStates[keyof AuthStates];
     message?: string;
+    error?: Error | unknown;
   };
 
+  export type StoredAuthorizationData = {
+    apiEndpoint: string;
+    username: string;
+  } | null;
+
   export type CustomLoginButton = {
     init?: () => Promise<Service>;
-    getAuthorizationData(): any;
+    getAuthorizationData(): StoredAuthorizationData;
     onStateChange(state: AuthStatePayload): Promise<void>;
     onClick(): void;
-    saveAuthorizationData?: (authData: any) => void;
+    saveAuthorizationData?: (authData: StoredAuthorizationData) => void;
     deleteAuthorizationData?: () => Promise<void>;
     finishAuthProcessAfterRedirection?: (authController: AuthController) => Promise<void>;
+  };
+
+  export class LoginButton implements CustomLoginButton {
+    constructor(authSettings: AuthSettings, service: Service);
+    auth: AuthController;
+    authSettings: AuthSettings;
+    service: Service;
+    serviceInfo: ServiceInfo;
+    languageCode: string;
+    messages: KeyValue;
+    text: string;
+    popup?: Window | null;
+    loginButtonSpan?: HTMLElement;
+    loginButtonText?: HTMLElement;
+
+    init(): Promise<Service>;
+    onClick(): void;
+    onStateChange(state: AuthStatePayload): Promise<void>;
+    getAuthorizationData(): StoredAuthorizationData;
+    saveAuthorizationData(authData: StoredAuthorizationData): void;
+    deleteAuthorizationData(): Promise<void>;
+    finishAuthProcessAfterRedirection(authController: AuthController): Promise<void>;
   }
 
   export class AuthController {
@@ -798,15 +912,24 @@ declare module 'pryv' {
       service: Service,
       loginButton: CustomLoginButton,
     );
+    settings: AuthSettings;
+    service: Service;
+    serviceInfo: ServiceInfo | null;
+    assets: ServiceAssets | null;
+    loginButton: CustomLoginButton;
+    languageCode: string;
+    messages: KeyValue;
+    stateChangeListeners: Array<(state: AuthStatePayload) => void>;
+
     init(): Promise<Service>;
     stopAuthRequest(msg: string): void;
     handleClick(): Promise<void>;
     getReturnURL(
-      returnURL: string,
+      returnURL?: string,
       windowLocationForTest?: string,
       navigatorForTests?: string,
     ): string | boolean;
-    startAuthRequest(): Promise<any>;
+    startAuthRequest(): Promise<AuthRequestResponse>;
     set state(newState: AuthStatePayload);
     get state(): AuthStatePayload;
   }
@@ -814,16 +937,16 @@ declare module 'pryv' {
   export const Auth: {
     setupAuth: SetupAuth;
     AuthStates: AuthStates;
-    AuthController: AuthController;
+    AuthController: typeof AuthController;
   }
 
   export type getServiceInfoFromURL = (url: string) => string;
 
   export const Browser: {
-    LoginButton: CustomLoginButton;
+    LoginButton: typeof LoginButton;
     CookieUtils: {
-      set(cookieKey: string, value: any, expireInDays: number): void;
-      get(cookieKey: string): any;
+      set<T = unknown>(cookieKey: string, value: T, expireInDays?: number): void;
+      get<T = unknown>(cookieKey: string): T | undefined;
       del(cookieKey: string): void;
     };
     AuthStates: AuthStates;
@@ -840,9 +963,13 @@ declare module 'pryv' {
     isBrowser(): boolean;
     extractTokenAndAPIEndpoint(apiEndpoint: string): TokenAndAPIEndpoint;
     buildAPIEndpoint(tokenAndAPI: TokenAndAPIEndpoint): string;
-    browserIsMobileOrTablet(navigator: string): boolean;
+    browserIsMobileOrTablet(navigator?: string | Navigator): boolean;
     cleanURLFromPrYvParams(url: string): string;
     getQueryParamsFromURL(url: string): KeyValue;
+    /** @deprecated Use extractTokenAndAPIEndpoint instead */
+    extractTokenAndApiEndpoint(apiEndpoint: string): TokenAndAPIEndpoint;
+    /** @deprecated Use buildAPIEndpoint instead */
+    buildPryvApiEndpoint(tokenAndAPI: TokenAndAPIEndpoint): string;
   }
 
   type version = string;
@@ -856,10 +983,10 @@ declare module 'pryv' {
       AuthController: typeof AuthController;
     };
     Browser: {
-      LoginButton: CustomLoginButton;
+      LoginButton: typeof LoginButton;
       CookieUtils: {
-        set(cookieKey: string, value: any, expireInDays: number): void;
-        get(cookieKey: string): any;
+        set<T = unknown>(cookieKey: string, value: T, expireInDays?: number): void;
+        get<T = unknown>(cookieKey: string): T | undefined;
         del(cookieKey: string): void;
       };
       AuthStates: AuthStates;
@@ -870,10 +997,11 @@ declare module 'pryv' {
       isBrowser(): boolean;
       extractTokenAndAPIEndpoint(apiEndpoint: string): TokenAndAPIEndpoint;
       buildAPIEndpoint(tokenAndAPI: TokenAndAPIEndpoint): string;
-      browserIsMobileOrTablet(navigator: string): boolean;
+      browserIsMobileOrTablet(navigator?: string | Navigator): boolean;
       cleanURLFromPrYvParams(url: string): string;
       getQueryParamsFromURL(url: string): KeyValue;
     };
+    PryvError: typeof PryvError;
     version: version;
   };
 

package/src/index.js

@@ -8,7 +8,8 @@
  * @property {pryv.Service} Service - To interact with Pryv.io at a "Platform level"
  * @property {pryv.Connection} Connection - To interact with an individual's (user) data set
  * @property {pryv.Browser} Browser - Browser Tools - Access request helpers and visuals (button)
- * @property {pryv.utils} utils - Exposes **superagent** for HTTP calls and tools to manipulate Pryv's API endpoints
+ * @property {pryv.utils} utils - Exposes some utils for HTTP calls and tools to manipulate Pryv's API endpoints
+ * @property {pryv.PryvError} PryvError - Custom error class with innerObject support
  */
 module.exports = {
   Service: require('./Service'),
@@ -16,5 +17,6 @@ module.exports = {
   Auth: require('./Auth'),
   Browser: require('./Browser'),
   utils: require('./utils'),
+  PryvError: require('./lib/PryvError'),
   version: require('../package.json').version
 };

package/src/lib/PryvError.js

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+
+/**
+ * Custom error class for Pryv library errors.
+ * Includes an innerObject property for wrapping underlying errors.
+ * @extends Error
+ */
+class PryvError extends Error {
+  /**
+   * Create a PryvError
+   * @param {string} message - Error message
+   * @param {Error|Object} [innerObject] - The underlying error or object that caused this error
+   */
+  constructor (message, innerObject) {
+    super(message);
+    this.name = 'PryvError';
+    /** @type {Error|Object|undefined} */
+    this.innerObject = innerObject;
+
+    // Maintains proper stack trace for where error was thrown (only in V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, PryvError);
+    }
+  }
+}
+
+module.exports = PryvError;

package/src/lib/{browser-getEventStreamed.js → getEventStreamed.js}

@@ -6,12 +6,6 @@
 
 module.exports = getEventStreamed;
 
-/**
- * @private
- * Replacement for getEventStreamed for Browser
- * To be used as long as superagent does not propose it.
- *
- */
 async function getEventStreamed (conn, queryParam, parser) {
   /**
    * Holds Parser's settings
@@ -49,7 +43,7 @@ async function getEventStreamed (conn, queryParam, parser) {
 
   // ------------   fetch ------------------- //
   const url = new URL(conn.endpoint + 'events');
-  url.search = new URLSearchParams(queryParam);
+  url.search = new URLSearchParams(queryParam).toString();
   const fetchParams = { method: 'GET', headers: { Accept: 'application/json' } };
   if (conn.token) fetchParams.headers.Authorization = conn.token;
 
@@ -74,6 +68,7 @@ async function getEventStreamed (conn, queryParam, parser) {
     headers: {}
   };
   // add headers to result
+  // @ts-ignore - Headers.entries() exists in modern environments
   for (const pair of response.headers.entries()) {
     result.headers[pair[0]] = pair[1];
   }

package/src/lib/json-parser.js

@@ -6,8 +6,7 @@
 const EVENTMARKERS = ['"events":[', '"eventDeletions":['];
 
 /**
- * Customize superagent parser
- * Work on 'node.js' and use by browser-getEventStreamed
+ * Stremed JSON parser for events
  */
 module.exports = function (foreachEvent, includeDeletions) {
   let eventOrEventDeletions = 0; // start with event

package/src/utils.js

@@ -7,17 +7,61 @@ const regexSchemaAndPath = /(.+):\/\/(.+)/gm;
 
 /**
  * Utilities to access Pryv API.
- * Exposes superagent and methods to manipulate API endpoints
  * @memberof pryv
  * @namespace pryv.utils
  */
 const utils = module.exports = {
   /**
-   * Exposes superagent https://visionmedia.github.io/superagent/
-   * @memberof pryv.utils
-   * @property {Superagent} superagent
+   * Perform a GET request and parse JSON response
+   * @param {string} url - URL to fetch
+   * @param {Object} [queryParams={}] - Query parameters to append
+   * @param {Object} [headers={}] - Additional headers
+   * @returns {Promise<{response: Response, body: Object}>} Promise resolving to response and parsed body
+   */
+  async fetchGet (url, queryParams = {}, headers = {}) {
+    let queryStr = '';
+    if (queryParams && Object.keys(queryParams).length > 0) {
+      queryStr = '?' + new URLSearchParams(queryParams).toString();
+    }
+    const myHeaders = Object.assign({ Accept: 'application/json' }, headers);
+    const response = await fetch(url + queryStr, { headers: myHeaders });
+    const body = await response.json();
+    return { response, body };
+  },
+
+  /**
+   * Perform a GET request and return text response
+   * @param {string} url - URL to fetch
+   * @param {Object} [headers={}] - Additional headers
+   * @returns {Promise<{response: Response, text: string}>} Promise resolving to response and text body
+   */
+  async fetchGetText (url, headers = {}) {
+    const myHeaders = Object.assign({ Accept: 'text/html' }, headers);
+    const response = await fetch(url, { headers: myHeaders });
+    const text = await response.text();
+    return { response, text };
+  },
+
+  /**
+   * Perform a POST request with JSON data
+   * @param {string} url - URL to post to
+   * @param {Object} [data] - Data to send as JSON
+   * @param {Object} [headers={}] - Additional headers
+   * @returns {Promise<{response: Response, body: Object}>} Promise resolving to response and parsed body
    */
-  superagent: require('superagent'),
+  async fetchPost (url, data, headers = {}) {
+    const myHeaders = Object.assign({
+      Accept: 'application/json',
+      'Content-Type': 'application/json'
+    }, headers);
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: myHeaders,
+      body: JSON.stringify(data)
+    });
+    const body = await response.json();
+    return { response, body };
+  },
 
   /**
    * Returns true is run in a browser
@@ -83,28 +127,45 @@ const utils = module.exports = {
   },
 
   /**
-   *
-   * @param {Object} [navigatorForTests] mock navigator var only for testing purposes
+   * Check if the browser is running on a mobile device or tablet
+   * @memberof pryv.utils
+   * @param {string|Navigator} [navigator] - Navigator object or user agent string (for testing)
+   * @returns {boolean} True if mobile or tablet
    */
   browserIsMobileOrTablet: function (navigator) {
     if (navigator == null) {
       return false;
     }
     let check = false;
+    // @ts-ignore - navigator is Navigator when not null
     // eslint-disable-next-line no-useless-escape
     (function (a) { if (/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(a) || /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0, 4))) check = true; })(navigator.userAgent || navigator.vendor || navigator.opera);
     return check;
   },
 
+  /**
+   * Remove Pryv-specific query parameters from URL
+   * @memberof pryv.utils
+   * @param {string} url - URL to clean
+   * @returns {string} URL without prYv* parameters
+   */
   cleanURLFromPrYvParams: function (url) {
     const PRYV_REGEXP = /[?#&]+prYv([^=&]+)=([^&]*)/g;
     return url.replace(PRYV_REGEXP, '');
   },
 
+  /**
+   * Extract query parameters from a URL
+   * @memberof pryv.utils
+   * @param {string} url - URL to parse
+   * @returns {Object.<string, string>} Object with key-value pairs of query parameters
+   */
   getQueryParamsFromURL: function (url) {
+    /** @type {Object.<string, string>} */
     const vars = {};
     const QUERY_REGEXP = /[?#&]+([^=&]+)=([^&]*)/g;
     url.replace(QUERY_REGEXP,
+      // @ts-ignore - replace callback is used for side effects
       function (m, key, value) {
         vars[key] = decodeURIComponent(value);
       });