@datarailsshared/dr_renderer 1.4.10 → 1.4.12

package/src/errors.js

@@ -0,0 +1,174 @@
+/**
+ * Enum for dr renderer error codes.
+ * @readonly
+ * @enum {number}
+ */
+const RendererErrorCodes = {
+    NoDataError: 1,
+    TooMuchDataError: 3,
+    DataConflictError: 5,
+    GaugeConfigurationError: 6,
+    GenericRenderingError: 7,
+    GenericComputationalError: 8
+};
+
+/**
+ * Base error class for all renderer-related errors.
+ * @class BaseRendererError
+ * @extends Error
+ */
+class BaseRendererError extends Error {
+    /**
+     * Error code for identification purposes
+     * @type {number}
+     */
+    code = 0;
+    
+    /**
+     * Human-readable error title
+     * @type {string}
+     */
+    title = '';
+    
+    /**
+     * Additional options or context for the error
+     * @type {Object}
+     */
+    options = {};
+
+    /**
+     * Creates a new BaseRendererError instance.
+     * @param {Object} config - Error configuration object
+     * @param {number} config.code - Unique error code
+     * @param {string} config.title - Error title/message
+     * @param {Object} [config.options={}] - Additional error options or context
+     */
+    constructor({ code, title, options }) {
+        super();
+        this.code = code;
+        this.title = title;
+        this.options = options || {};
+    }
+}
+
+/**
+ * Error thrown when no data is available.
+ * @class NoDataError
+ * @extends BaseRendererError
+ */
+class NoDataError extends BaseRendererError {
+    /**
+     * Creates a new NoDataError instance.
+     * This error is thrown when a widget or component has no available data.
+     */
+    constructor() {
+        super({
+            code: RendererErrorCodes.NoDataError,
+            title: 'No Data Available',
+        });
+    }
+}
+
+/**
+ * Error thrown when there is too much data to render efficiently.
+ * @class TooMuchDataError
+ * @extends BaseRendererError
+ */
+class TooMuchDataError extends BaseRendererError {
+    /**
+     * Creates a new TooMuchDataError instance.
+     * This error is thrown when the dataset exceeds the renderer's capacity
+     * and requires the user to edit the widget.
+     */
+    constructor() {
+        super({
+            code: RendererErrorCodes.TooMuchDataError,
+            title: 'There is too much data. Please edit this widget',
+        });
+    }
+}
+
+/**
+ * Error thrown when there are conflicts in the data being processed.
+ * @class DataConflictError
+ * @extends BaseRendererError
+ */
+class DataConflictError extends BaseRendererError {
+    /**
+     * Creates a new DataConflictError instance.
+     * @param {Object} [options] - Additional context about the data conflict.
+     */
+    constructor(options) {
+        super({
+            code: RendererErrorCodes.DataConflictError,
+            title: 'Data Conflict',
+            options
+        });
+    }
+}
+
+/**
+ * Error thrown when a gauge chart is missing required info.
+ * @class GaugeConfigurationError
+ * @extends BaseRendererError
+ */
+class GaugeConfigurationError extends BaseRendererError {
+    /**
+     * Creates a new GaugeConfigurationError instance.
+     */
+    constructor() {
+        super({
+            code: RendererErrorCodes.GaugeConfigurationError,
+            title: 'Please configure goal and needle',
+        });
+    }
+}
+
+/**
+ * Generic error for rendering failures in PivotTable components.
+ * @class GenericRenderingError
+ * @extends BaseRendererError
+ */
+class GenericRenderingError extends BaseRendererError {
+    /**
+     * Creates a new GenericRenderingError instance.
+     * This error is thrown when an unexpected error occurs during
+     * the rendering process of PivotTable results.
+     */
+    constructor() {
+        super({
+            code: RendererErrorCodes.GenericRenderingError,
+            title: 'An error occurred rendering the PivotTable results.',
+        });
+    }
+}
+
+/**
+ * Generic error for computational failures in PivotTable components.
+ * @class GenericComputationalError
+ * @extends BaseRendererError
+ */
+class GenericComputationalError extends BaseRendererError {
+    /**
+     * Creates a new GenericComputationalError instance.
+     * This error is thrown when an unexpected error occurs during
+     * the computation process of PivotTable results.
+     */
+    constructor() {
+        super({
+            code: RendererErrorCodes.GenericComputationalError,
+            title: 'An error occurred computing the PivotTable results.',
+        });
+    }
+}
+
+module.exports = {
+    RendererErrorCodes,
+    BaseRendererError,
+    TooMuchDataError,
+    NoDataError,
+    DataConflictError,
+    GaugeConfigurationError,
+    GenericRenderingError,
+    GenericComputationalError
+};