@lowdefy/errors 0.0.0-experimental-20260202125814

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,92 @@
1
+ /*
2
+ Copyright 2020-2024 Lowdefy, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ */ /**
16
+ * Base error class for configuration errors (invalid YAML, schema violations, validation errors).
17
+ *
18
+ * This is the environment-agnostic base class. For environment-specific behavior:
19
+ * - Build-time: Use @lowdefy/errors/build (sync resolution via keyMap/refMap)
20
+ * - Server-side: Use @lowdefy/errors/server (re-exports base)
21
+ * - Client-side: Use @lowdefy/errors/client (async resolution via API)
22
+ *
23
+ * @example
24
+ * // Simple string (for plugins - configKey added by interface layer)
25
+ * throw new ConfigError('Invalid block type');
26
+ *
27
+ * @example
28
+ * // With options
29
+ * throw new ConfigError({
30
+ * message: 'Invalid block type',
31
+ * configKey: block['~k'],
32
+ * location: { source: 'pages/home.yaml:42', link: '/path/to/pages/home.yaml:42' }
33
+ * });
34
+ */ let ConfigError = class ConfigError extends Error {
35
+ /**
36
+ * Serializes the error for transport (e.g., client to server).
37
+ * @returns {Object} Serialized error data with type marker
38
+ */ serialize() {
39
+ return {
40
+ '~err': 'ConfigError',
41
+ message: this.message,
42
+ configKey: this.configKey
43
+ };
44
+ }
45
+ /**
46
+ * Deserializes error data back into a ConfigError.
47
+ * @param {Object} data - Serialized error data
48
+ * @returns {ConfigError}
49
+ */ static deserialize(data) {
50
+ return new ConfigError({
51
+ message: data.message,
52
+ configKey: data.configKey
53
+ });
54
+ }
55
+ /**
56
+ * Creates a ConfigError instance with formatted message.
57
+ * @param {string|Object} messageOrParams - Error message string, or params object
58
+ * @param {string} [messageOrParams.message] - The error message (if object)
59
+ * @param {Error} [messageOrParams.error] - Original error to wrap (extracts message/configKey/stack)
60
+ * @param {string} [messageOrParams.configKey] - Config key (~k) for location resolution
61
+ * @param {Object} [messageOrParams.location] - Pre-resolved location { source, link, config }
62
+ * @param {string} [messageOrParams.checkSlug] - The build check that triggered this error
63
+ */ constructor(messageOrParams){
64
+ // Support both string and object parameter
65
+ const isString = typeof messageOrParams === 'string';
66
+ const error = isString ? null : messageOrParams.error;
67
+ const message = isString ? messageOrParams : messageOrParams.message ?? error?.message;
68
+ const configKey = isString ? null : messageOrParams.configKey ?? error?.configKey;
69
+ const location = isString ? null : messageOrParams.location;
70
+ const checkSlug = isString ? undefined : messageOrParams.checkSlug;
71
+ const received = isString ? undefined : messageOrParams.received;
72
+ const operatorLocation = isString ? null : messageOrParams.operatorLocation;
73
+ // Message without prefix - logger uses error.name for display
74
+ super(message);
75
+ this.name = 'ConfigError';
76
+ this.configKey = configKey ?? null;
77
+ this.checkSlug = checkSlug;
78
+ // For logger formatting
79
+ this.received = received;
80
+ this.operatorLocation = operatorLocation;
81
+ // Location info (can be set via constructor or subclass)
82
+ this.source = location?.source ?? null;
83
+ this.link = location?.link ?? null;
84
+ this.config = location?.config ?? null;
85
+ this.resolved = !!location;
86
+ // Preserve original error's stack if wrapping
87
+ if (error?.stack) {
88
+ this.stack = error.stack;
89
+ }
90
+ }
91
+ };
92
+ export default ConfigError;
@@ -0,0 +1,37 @@
1
+ /*
2
+ Copyright 2020-2024 Lowdefy, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ */ /**
16
+ * Base configuration warning class.
17
+ *
18
+ * This is the environment-agnostic base class. For environment-specific behavior:
19
+ * - Build-time: Use @lowdefy/errors/build (prodError flag, suppression logic)
20
+ * - Server-side: Use @lowdefy/errors/server (re-exports base)
21
+ * - Client-side: Use @lowdefy/errors/client (re-exports base)
22
+ *
23
+ * @example
24
+ * const warning = new ConfigWarning({ message: 'Deprecated feature used', source: 'config.yaml:10' });
25
+ * console.warn(warning.message);
26
+ */ let ConfigWarning = class ConfigWarning {
27
+ /**
28
+ * @param {Object} params
29
+ * @param {string} params.message - The warning message
30
+ * @param {string} [params.source] - Source file:line
31
+ */ constructor({ message, source }){
32
+ // Message without prefix - logger uses class name for display
33
+ this.message = message;
34
+ this.source = source ?? null;
35
+ }
36
+ };
37
+ export default ConfigWarning;
@@ -0,0 +1,65 @@
1
+ /*
2
+ Copyright 2020-2024 Lowdefy, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ */ /**
16
+ * Error class for internal Lowdefy errors (bugs, unexpected conditions).
17
+ *
18
+ * Use this for unexpected runtime errors, not for config validation errors.
19
+ * ConfigError should be used for user-facing config issues.
20
+ *
21
+ * @example
22
+ * // Create a new error
23
+ * throw new LowdefyError('Unexpected condition');
24
+ *
25
+ * @example
26
+ * // At top-level catch, log the error with stack
27
+ * } catch (err) {
28
+ * console.error(err.message);
29
+ * console.error(err.stack);
30
+ * }
31
+ */ let LowdefyError = class LowdefyError extends Error {
32
+ /**
33
+ * Serializes the error for transport (e.g., client to server).
34
+ * @returns {Object} Serialized error data with type marker
35
+ */ serialize() {
36
+ return {
37
+ '~err': 'LowdefyError',
38
+ message: this.message,
39
+ stack: this.stack
40
+ };
41
+ }
42
+ /**
43
+ * Deserializes error data back into a LowdefyError.
44
+ * @param {Object} data - Serialized error data
45
+ * @returns {LowdefyError}
46
+ */ static deserialize(data) {
47
+ const error = new LowdefyError(data.message);
48
+ if (data.stack) {
49
+ error.stack = data.stack;
50
+ }
51
+ return error;
52
+ }
53
+ /**
54
+ * Creates a LowdefyError instance.
55
+ * @param {string} message - The error message
56
+ * @param {Object} [options]
57
+ * @param {Error} [options.cause] - The original error that caused this
58
+ */ constructor(message, options = {}){
59
+ // Message without prefix - logger uses error.name for display
60
+ super(message, options);
61
+ this.name = 'LowdefyError';
62
+ this.configKey = null;
63
+ }
64
+ };
65
+ export default LowdefyError;
@@ -0,0 +1,109 @@
1
+ /*
2
+ Copyright 2020-2024 Lowdefy, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ */ /**
16
+ * Error class for plugin failures (operators, actions, blocks, connections, requests).
17
+ *
18
+ * Plugins throw plain Error objects with simple messages.
19
+ * The plugin interface layer catches these and wraps them in PluginError
20
+ * with additional context (received values, location, plugin type).
21
+ *
22
+ * @example
23
+ * // In operator parser (plugin interface layer):
24
+ * try {
25
+ * return operator({ params });
26
+ * } catch (error) {
27
+ * if (error instanceof ConfigError) throw error;
28
+ * throw new PluginError({
29
+ * error,
30
+ * pluginType: 'operator',
31
+ * pluginName: '_if',
32
+ * received: params,
33
+ * location: 'blocks.0.properties.visible',
34
+ * configKey: block['~k'],
35
+ * });
36
+ * }
37
+ * // error.message = "[Plugin Error] _if requires boolean test. Received: {...} at blocks.0.properties.visible."
38
+ */ let PluginError = class PluginError extends Error {
39
+ /**
40
+ * Serializes the error for transport (e.g., client to server).
41
+ * @returns {Object} Serialized error data with type marker
42
+ */ serialize() {
43
+ return {
44
+ '~err': 'PluginError',
45
+ message: this.message,
46
+ pluginType: this.pluginType,
47
+ pluginName: this.pluginName,
48
+ location: this.location,
49
+ configKey: this.configKey,
50
+ stack: this.stack
51
+ };
52
+ }
53
+ /**
54
+ * Deserializes error data back into a PluginError.
55
+ * Note: message already contains location/received, so we don't pass them
56
+ * to avoid double-formatting.
57
+ * @param {Object} data - Serialized error data
58
+ * @returns {PluginError}
59
+ */ static deserialize(data) {
60
+ const error = new PluginError({
61
+ error: new Error(data.message),
62
+ pluginType: data.pluginType,
63
+ pluginName: data.pluginName,
64
+ configKey: data.configKey
65
+ });
66
+ // Set location separately to preserve it without re-formatting message
67
+ error.location = data.location;
68
+ if (data.stack) {
69
+ error.stack = data.stack;
70
+ }
71
+ return error;
72
+ }
73
+ /**
74
+ * Creates a PluginError instance with formatted message.
75
+ * @param {Object} params
76
+ * @param {Error} params.error - The original error thrown by the plugin
77
+ * @param {string} [params.pluginType] - Type of plugin (operator, action, block, request, connection)
78
+ * @param {string} [params.pluginName] - Name of the plugin (e.g., '_if', 'SetState')
79
+ * @param {*} [params.received] - The input that caused the error
80
+ * @param {string} [params.location] - Where in the config the error occurred
81
+ * @param {string} [params.configKey] - Config key (~k) for location resolution
82
+ */ constructor({ error, message, pluginType, pluginName, received, location, configKey }){
83
+ // Store raw message - logger formats received value
84
+ // Accept either error object or direct message string
85
+ const rawMessage = message ?? error?.message;
86
+ let formattedMessage = rawMessage;
87
+ if (location) {
88
+ formattedMessage += ` at ${location}.`;
89
+ }
90
+ super(formattedMessage, {
91
+ cause: error
92
+ });
93
+ this.name = 'PluginError';
94
+ this.pluginType = pluginType;
95
+ this.pluginName = pluginName;
96
+ this.rawMessage = rawMessage; // Original message without location
97
+ this.received = received;
98
+ this.location = location;
99
+ this.configKey = error?.configKey ?? configKey ?? null;
100
+ // Location info (set by server-side resolution)
101
+ this.source = null;
102
+ this.config = null;
103
+ this.link = null;
104
+ if (error?.stack) {
105
+ this.stack = error.stack;
106
+ }
107
+ }
108
+ };
109
+ export default PluginError;
@@ -0,0 +1,157 @@
1
+ /*
2
+ Copyright 2020-2024 Lowdefy, Inc
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this file except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+ */ /**
16
+ * Network error codes that indicate service issues (not config problems).
17
+ */ const SERVICE_ERROR_CODES = new Set([
18
+ 'ECONNREFUSED',
19
+ 'ENOTFOUND',
20
+ 'ETIMEDOUT',
21
+ 'ECONNRESET',
22
+ 'ECONNABORTED',
23
+ 'EHOSTUNREACH',
24
+ 'ENETUNREACH',
25
+ 'EPIPE',
26
+ 'EAI_AGAIN',
27
+ 'CERT_HAS_EXPIRED',
28
+ 'UNABLE_TO_VERIFY_LEAF_SIGNATURE',
29
+ 'DEPTH_ZERO_SELF_SIGNED_CERT'
30
+ ]);
31
+ /**
32
+ * Error class for external service failures (network, timeout, database, 5xx).
33
+ *
34
+ * ServiceError represents infrastructure/service issues that are NOT caused by
35
+ * invalid configuration. These errors should not include config location info
36
+ * since the config is correct - the external service is the problem.
37
+ *
38
+ * The message is formatted in the constructor - no format() method needed.
39
+ *
40
+ * @example
41
+ * // In request handler:
42
+ * try {
43
+ * return await fetch(url);
44
+ * } catch (error) {
45
+ * if (ServiceError.isServiceError(error)) {
46
+ * throw ServiceError.from(error, 'MongoDB');
47
+ * }
48
+ * throw new PluginError({ error, ... });
49
+ * }
50
+ * // error.message = "[Service Error] MongoDB: Connection refused. The service may be down..."
51
+ */ let ServiceError = class ServiceError extends Error {
52
+ /**
53
+ * Checks if an error is a service error (network issues, timeouts, 5xx).
54
+ * @param {Error} error - The error to check
55
+ * @returns {boolean} True if this is a service error
56
+ */ static isServiceError(error) {
57
+ if (!error) return false;
58
+ // Check error code
59
+ if (error.code && SERVICE_ERROR_CODES.has(error.code)) {
60
+ return true;
61
+ }
62
+ // Check HTTP status codes (5xx = server error)
63
+ const statusCode = error.statusCode ?? error.status ?? error.response?.status;
64
+ if (statusCode && statusCode >= 500 && statusCode < 600) {
65
+ return true;
66
+ }
67
+ // Check for common service error messages
68
+ const message = error.message?.toLowerCase() ?? '';
69
+ if (message.includes('network') || message.includes('timeout') || message.includes('connection refused') || message.includes('dns lookup failed') || message.includes('socket hang up') || message.includes('certificate') || message.includes('unavailable')) {
70
+ return true;
71
+ }
72
+ return false;
73
+ }
74
+ /**
75
+ * Enhances an error message with more helpful context.
76
+ * @param {Error} error - The original error
77
+ * @returns {string} Enhanced error message
78
+ */ static enhanceMessage(error) {
79
+ const code = error.code;
80
+ const statusCode = error.statusCode ?? error.status ?? error.response?.status;
81
+ if (code === 'ECONNREFUSED') {
82
+ return `Connection refused. The service may be down or the address may be incorrect. ${error.message}`;
83
+ }
84
+ if (code === 'ENOTFOUND') {
85
+ return `DNS lookup failed. The hostname could not be resolved. ${error.message}`;
86
+ }
87
+ if (code === 'ETIMEDOUT') {
88
+ return `Connection timed out. The service may be slow or unreachable. ${error.message}`;
89
+ }
90
+ if (code === 'ECONNRESET') {
91
+ return `Connection reset by the server. ${error.message}`;
92
+ }
93
+ if (statusCode && statusCode >= 500) {
94
+ return `Server returned error ${statusCode}. ${error.message}`;
95
+ }
96
+ return error.message;
97
+ }
98
+ /**
99
+ * Serializes the error for transport (e.g., client to server).
100
+ * @returns {Object} Serialized error data with type marker
101
+ */ serialize() {
102
+ return {
103
+ '~err': 'ServiceError',
104
+ message: this.message,
105
+ service: this.service,
106
+ code: this.code,
107
+ statusCode: this.statusCode
108
+ };
109
+ }
110
+ /**
111
+ * Deserializes error data back into a ServiceError.
112
+ * Note: message already contains service prefix, so we don't pass service
113
+ * to avoid double-prefixing.
114
+ * @param {Object} data - Serialized error data
115
+ * @returns {ServiceError}
116
+ */ static deserialize(data) {
117
+ const error = new ServiceError({
118
+ message: data.message,
119
+ code: data.code,
120
+ statusCode: data.statusCode
121
+ });
122
+ // Set service separately to preserve it without re-prefixing the message
123
+ error.service = data.service;
124
+ return error;
125
+ }
126
+ /**
127
+ * Creates a ServiceError instance with formatted message.
128
+ * @param {Object} params
129
+ * @param {string} [params.message] - The error message (required if no error)
130
+ * @param {Error} [params.error] - Original error to wrap (auto-enhances message)
131
+ * @param {string} [params.service] - Name of the service that failed
132
+ * @param {string} [params.code] - Error code (e.g., 'ECONNREFUSED')
133
+ * @param {number} [params.statusCode] - HTTP status code if applicable
134
+ * @param {string} [params.configKey] - Config key for location resolution
135
+ */ constructor({ message, error, service, code, statusCode, configKey }){
136
+ // Extract info from wrapped error if provided
137
+ const errorCode = code ?? error?.code;
138
+ const errorStatusCode = statusCode ?? error?.statusCode ?? error?.status ?? error?.response?.status;
139
+ // Use provided message, or enhance wrapped error's message
140
+ const baseMessage = message ?? (error ? ServiceError.enhanceMessage(error) : 'Service error');
141
+ // Message without prefix - logger uses error.name for display
142
+ // Include service in message if provided
143
+ const formattedMessage = service ? `${service}: ${baseMessage}` : baseMessage;
144
+ super(formattedMessage, {
145
+ cause: error
146
+ });
147
+ this.name = 'ServiceError';
148
+ this.service = service;
149
+ this.code = errorCode;
150
+ this.statusCode = errorStatusCode;
151
+ this.configKey = configKey ?? null;
152
+ if (error?.stack) {
153
+ this.stack = error.stack;
154
+ }
155
+ }
156
+ };
157
+ export default ServiceError;