added PryvError

Author: Perki

components/pryv/src/Connection.js

@@ -5,6 +5,7 @@
 const utils = require('./utils.js');
 const jsonParser = require('./lib/json-parser');
 const libGetEventStreamed = require('./lib/getEventStreamed');
+const PryvError = require('./lib/PryvError');
 
 /**
  * @class Connection
@@ -58,10 +59,10 @@ class Connection {
   async username () {
     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;
+      throw new PryvError(
+        'Failed fetching accessinfo: ' + accessInfo.error.message,
+        accessInfo.error
+      );
     }
     // @ts-ignore - username is always a string
     return accessInfo.user.username;
@@ -110,15 +111,13 @@ class Connection {
       result[0].error ||
       (expectedKey != null && result[0][expectedKey] == null)
     ) {
-      const innerObject = result[0]?.error || result;
-      const error = new Error(
+      const innerError = result[0]?.error || result;
+      throw new PryvError(
         `Error for api method: "${method}" with params: ${JSON.stringify(
           params
-        )} >> Result: ${JSON.stringify(innerObject)}"`
+        )} >> Result: ${JSON.stringify(innerError)}"`,
+        innerError
       );
-      // @ts-ignore - custom error property
-      error.innerObject = innerObject;
-      throw error;
     }
     if (expectedKey != null) return result[0][expectedKey];
     return result[0];

components/pryv/src/globals.d.ts

@@ -63,9 +63,13 @@ declare global {
     export type LoginButton = PryvModule.LoginButton;
   }
 
-  // Extended Error type with innerObject property
-  interface Error {
-    innerObject?: any;
+  /**
+   * Custom error class for Pryv library errors
+   */
+  class PryvError extends Error {
+    constructor(message: string, innerError?: Error | object);
+    name: 'PryvError';
+    innerError?: Error | object;
   }
 }
 

components/pryv/src/index.d.ts

@@ -164,6 +164,16 @@ declare module 'pryv' {
     subErrors?: Error[];
   };
 
+  /**
+   * Custom error class for Pryv library errors.
+   * Includes an innerError property for wrapping underlying errors.
+   */
+  export class PryvError extends globalThis.Error {
+    constructor(message: string, innerError?: globalThis.Error | object);
+    name: 'PryvError';
+    innerError?: globalThis.Error | object;
+  }
+
   export type StreamsQuery = {
     any?: Identifier[];
     all?: Identifier[];
@@ -991,6 +1001,7 @@ declare module 'pryv' {
       cleanURLFromPrYvParams(url: string): string;
       getQueryParamsFromURL(url: string): KeyValue;
     };
+    PryvError: typeof PryvError;
     version: version;
   };
 

components/pryv/src/index.js

@@ -9,12 +9,14 @@
  * @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 some utils for HTTP calls and tools to manipulate Pryv's API endpoints
+ * @property {pryv.PryvError} PryvError - Custom error class with innerError support
  */
 module.exports = {
   Service: require('./Service'),
   Connection: require('./Connection'),
   Auth: require('./Auth'),
   Browser: require('./Browser'),
   utils: require('./utils'),
+  PryvError: require('./lib/PryvError'),
   version: require('../package.json').version
 };

components/pryv/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 innerError property for wrapping underlying errors.
+ * @extends Error
+ */
+class PryvError extends Error {
+  /**
+   * Create a PryvError
+   * @param {string} message - Error message
+   * @param {Error|Object} [innerError] - The underlying error or object that caused this error
+   */
+  constructor (message, innerError) {
+    super(message);
+    this.name = 'PryvError';
+    /** @type {Error|Object|undefined} */
+    this.innerError = innerError;
+
+    // Maintains proper stack trace for where error was thrown (only in V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, PryvError);
+    }
+  }
+}
+
+module.exports = PryvError;